POST api/v1/finance_PaymentTransaction/invoice

Request Information

URI Parameters

None.

Body Parameters

Finance_PaymentTransactionVM
NameDescriptionTypeAdditional information
paymentTransactionId

integer

None.

paymentReferenceNumber

string

None.

financeFeePaymentId

integer

None.

paymentChannelId

integer

None.

chartOfAccountId

integer

None.

generalLedgerAccountId

integer

None.

amount

decimal number

None.

paymentDate

date

None.

studentId

integer

None.

paymentStatusId

integer

None.

paymentTypeName

string

None.

paymentType

string

None.

paymentTypeId

integer

None.

academicSessionId

integer

None.

financialYearName

string

None.

description

string

None.

tenantId

integer

None.

createdBy

integer

None.

financeTransactionTypeId

integer

None.

paymentChannelName

string

None.

chartOfAccountName

string

None.

paymentStatusName

string

None.

academicSessionName

string

None.

isApproved

boolean

None.

name

string

None.

currencyId

integer

None.

approvalStatusId

integer

None.

isApprovedName

string

None.

endDate

date

None.

startDate

date

None.

paymentEvidenceId

integer

None.

fileName

string

None.

fileType

string

None.

fileExtention

string

None.

fileLink

string

None.

fileData

Collection of byte

None.

vat

decimal number

None.

studentReferenceNumber

string

None.

total

decimal number

None.

aggregateTotal

decimal number

None.

aggregateCount

integer

None.

depositorName

string

None.

isFeeWaiverApply

boolean

None.

discountedAmount

decimal number

None.

linkedId

string

None.

approvalComment

string

None.

phoneNumber

string

None.

amountPaid

decimal number

None.

admissionNumber

string

None.

programme

string

None.

transactionDate

date

None.

referenceNumber

string

None.

payentType

string

None.

bill

decimal number

None.

dueAmount

decimal number

None.

discount

decimal number

None.

paidAmount

decimal number

None.

balance

decimal number

None.

totalFee

decimal number

None.

Request Formats

application/json, text/json

Sample:
{
  "paymentTransactionId": 1,
  "paymentReferenceNumber": "sample string 2",
  "financeFeePaymentId": 1,
  "paymentChannelId": 1,
  "chartOfAccountId": 1,
  "generalLedgerAccountId": 1,
  "amount": 3.0,
  "paymentDate": "2024-11-24T09:41:50.8771436-08:00",
  "studentId": 1,
  "paymentStatusId": 1,
  "paymentTypeName": "sample string 4",
  "paymentType": "sample string 5",
  "paymentTypeId": 1,
  "academicSessionId": 1,
  "financialYearName": "sample string 6",
  "description": "sample string 7",
  "tenantId": 1,
  "createdBy": 8,
  "financeTransactionTypeId": 1,
  "paymentChannelName": "sample string 9",
  "chartOfAccountName": "sample string 10",
  "paymentStatusName": "sample string 11",
  "academicSessionName": "sample string 12",
  "isApproved": true,
  "name": "sample string 13",
  "currencyId": 1,
  "approvalStatusId": 1,
  "isApprovedName": "sample string 14",
  "endDate": "2024-11-24T09:41:50.8771436-08:00",
  "startDate": "2024-11-24T09:41:50.8771436-08:00",
  "paymentEvidenceId": 15,
  "fileName": "sample string 16",
  "fileType": "sample string 17",
  "fileExtention": "sample string 18",
  "fileLink": "sample string 19",
  "fileData": "QEA=",
  "vat": 1.0,
  "studentReferenceNumber": "sample string 20",
  "total": 1.0,
  "aggregateTotal": 1.0,
  "aggregateCount": 21,
  "depositorName": "sample string 22",
  "isFeeWaiverApply": true,
  "discountedAmount": 1.0,
  "linkedId": "sample string 24",
  "approvalComment": "sample string 25",
  "phoneNumber": "sample string 26",
  "amountPaid": 1.0,
  "admissionNumber": "sample string 27",
  "programme": "sample string 28",
  "transactionDate": "2024-11-24T09:41:50.8771436-08:00",
  "referenceNumber": "sample string 30",
  "payentType": "sample string 31",
  "bill": 32.0,
  "dueAmount": 33.0,
  "discount": 34.0,
  "paidAmount": 35.0,
  "balance": 36.0,
  "totalFee": 37.0
}

application/xml, text/xml

Sample:
<Finance_PaymentTransactionVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Data.TransferObject.ViewModel">
  <academicSessionId>1</academicSessionId>
  <academicSessionName>sample string 12</academicSessionName>
  <admissionNumber>sample string 27</admissionNumber>
  <aggregateCount>21</aggregateCount>
  <aggregateTotal>1</aggregateTotal>
  <amount>3</amount>
  <amountPaid>1</amountPaid>
  <approvalComment>sample string 25</approvalComment>
  <approvalStatusId>1</approvalStatusId>
  <balance>36</balance>
  <bill>32</bill>
  <chartOfAccountId>1</chartOfAccountId>
  <chartOfAccountName>sample string 10</chartOfAccountName>
  <createdBy>8</createdBy>
  <currencyId>1</currencyId>
  <depositorName>sample string 22</depositorName>
  <description>sample string 7</description>
  <discount>34</discount>
  <discountedAmount>1</discountedAmount>
  <dueAmount>33</dueAmount>
  <endDate>2024-11-24T09:41:50.8771436-08:00</endDate>
  <fileData>QEA=</fileData>
  <fileExtention>sample string 18</fileExtention>
  <fileLink>sample string 19</fileLink>
  <fileName>sample string 16</fileName>
  <fileType>sample string 17</fileType>
  <financeFeePaymentId>1</financeFeePaymentId>
  <financeTransactionTypeId>1</financeTransactionTypeId>
  <financialYearName>sample string 6</financialYearName>
  <generalLedgerAccountId>1</generalLedgerAccountId>
  <isApproved>true</isApproved>
  <isApprovedName>sample string 14</isApprovedName>
  <isFeeWaiverApply>true</isFeeWaiverApply>
  <linkedId>sample string 24</linkedId>
  <name>sample string 13</name>
  <paidAmount>35</paidAmount>
  <payentType>sample string 31</payentType>
  <paymentChannelId>1</paymentChannelId>
  <paymentChannelName>sample string 9</paymentChannelName>
  <paymentDate>2024-11-24T09:41:50.8771436-08:00</paymentDate>
  <paymentEvidenceId>15</paymentEvidenceId>
  <paymentReferenceNumber>sample string 2</paymentReferenceNumber>
  <paymentStatusId>1</paymentStatusId>
  <paymentStatusName>sample string 11</paymentStatusName>
  <paymentTransactionId>1</paymentTransactionId>
  <paymentType>sample string 5</paymentType>
  <paymentTypeId>1</paymentTypeId>
  <paymentTypeName>sample string 4</paymentTypeName>
  <phoneNumber>sample string 26</phoneNumber>
  <programme>sample string 28</programme>
  <referenceNumber>sample string 30</referenceNumber>
  <startDate>2024-11-24T09:41:50.8771436-08:00</startDate>
  <studentId>1</studentId>
  <studentReferenceNumber>sample string 20</studentReferenceNumber>
  <tenantId>1</tenantId>
  <total>1</total>
  <totalFee>37</totalFee>
  <transactionDate>2024-11-24T09:41:50.8771436-08:00</transactionDate>
  <vat>1</vat>
</Finance_PaymentTransactionVM>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.