POST Api/Invoice/MakePayment
Request Information
URI Parameters
None.
Body Parameters
InvoiceHistory| Name | Description | Type | Additional information |
|---|---|---|---|
| PaymentMethod | PaymentMethod |
None. |
|
| PaymentRef | string |
None. |
|
| Note | string |
None. |
|
| SchoolID | globally unique identifier |
None. |
|
| SchoolName | string |
None. |
|
| StudentID | globally unique identifier |
None. |
|
| StudentName | string |
None. |
|
| StudentNo | string |
None. |
|
| InvoiceOn | date |
None. |
|
| DueOn | date |
None. |
|
| StartOn | date |
None. |
|
| EndOn | date |
None. |
|
| Description | string |
None. |
|
| InvoiceNo | string |
None. |
|
| InvoiceAmt | decimal number |
None. |
|
| ParentID | globally unique identifier |
None. |
|
| InvoiceStatus | InvoiceStatus |
None. |
|
| Days | integer |
None. |
|
| Id | globally unique identifier |
None. |
|
| UserName | string |
None. |
|
| UserID | globally unique identifier |
None. |
|
| CreatedBy | string |
None. |
|
| CreatedOn | date |
None. |
|
| ClientID | globally unique identifier |
None. |
|
| ClientName | string |
None. |
|
| PartnerID | globally unique identifier |
None. |
|
| PartnerName | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"PaymentMethod": 1,
"PaymentRef": "sample string 1",
"Note": "sample string 2",
"SchoolID": "54731dde-4261-4a7b-a33b-dbdd6a3d9664",
"SchoolName": "sample string 4",
"StudentID": "05369967-056c-412f-a3b4-b71007251f0a",
"StudentName": "sample string 6",
"StudentNo": "sample string 7",
"InvoiceOn": "2026-06-06T03:38:53.8162714+04:00",
"DueOn": "2026-06-06T03:38:53.8162714+04:00",
"StartOn": "2026-06-06T03:38:53.8162714+04:00",
"EndOn": "2026-06-06T03:38:53.8162714+04:00",
"Description": "sample string 12",
"InvoiceNo": "sample string 13",
"InvoiceAmt": 14.1,
"ParentID": "d342ec1a-10c4-4c59-b862-bd25034cb3e6",
"InvoiceStatus": 1,
"Days": 16,
"Id": "eb41525d-8045-4f79-8f44-f5125affc137",
"UserName": "sample string 18",
"UserID": "de5a1a3f-eea1-472e-8d76-15ab388a743e",
"CreatedBy": "sample string 20",
"CreatedOn": "2026-06-06T03:38:53.8162714+04:00",
"ClientID": "0f340ff2-a5ca-4a25-aba7-2a7b40a1ce6a",
"ClientName": "sample string 23",
"PartnerID": "2cacbcb1-3208-401b-9775-7cdd24fd106d",
"PartnerName": "sample string 25"
}
application/xml, text/xml
Sample:
<InvoiceHistory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fleetroot.Entity"> <ClientID>0f340ff2-a5ca-4a25-aba7-2a7b40a1ce6a</ClientID> <ClientName>sample string 23</ClientName> <CreatedBy>sample string 20</CreatedBy> <CreatedOn>2026-06-06T03:38:53.8162714+04:00</CreatedOn> <Id>eb41525d-8045-4f79-8f44-f5125affc137</Id> <PartnerID>2cacbcb1-3208-401b-9775-7cdd24fd106d</PartnerID> <PartnerName>sample string 25</PartnerName> <UserID>de5a1a3f-eea1-472e-8d76-15ab388a743e</UserID> <UserName>sample string 18</UserName> <Days>16</Days> <Description>sample string 12</Description> <DueOn>2026-06-06T03:38:53.8162714+04:00</DueOn> <EndOn>2026-06-06T03:38:53.8162714+04:00</EndOn> <InvoiceAmt>14.1</InvoiceAmt> <InvoiceNo>sample string 13</InvoiceNo> <InvoiceOn>2026-06-06T03:38:53.8162714+04:00</InvoiceOn> <InvoiceStatus>Unpaid</InvoiceStatus> <ParentID>d342ec1a-10c4-4c59-b862-bd25034cb3e6</ParentID> <SchoolID>54731dde-4261-4a7b-a33b-dbdd6a3d9664</SchoolID> <SchoolName>sample string 4</SchoolName> <StartOn>2026-06-06T03:38:53.8162714+04:00</StartOn> <StudentID>05369967-056c-412f-a3b4-b71007251f0a</StudentID> <StudentName>sample string 6</StudentName> <StudentNo>sample string 7</StudentNo> <Note>sample string 2</Note> <PaymentMethod>Cash</PaymentMethod> <PaymentRef>sample string 1</PaymentRef> </InvoiceHistory>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Result| Name | Description | Type | Additional information |
|---|---|---|---|
| IsValid | boolean |
None. |
|
| Message | Collection of string |
None. |
|
| ResponseCodes | Collection of integer |
None. |
|
| Id | globally unique identifier |
None. |
|
| Value | string |
None. |
|
| RecordOn | date |
None. |
Response Formats
application/json, text/json
Sample:
{
"IsValid": true,
"Message": [
"sample string 1",
"sample string 2"
],
"ResponseCodes": [
1,
2
],
"Id": "7d4a58a5-dee9-4a4d-9a3d-3103f1aa465a",
"Value": "sample string 3",
"RecordOn": "2026-06-06T03:38:53.8162714+04:00"
}
application/xml, text/xml
Sample:
<Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fleetroot.Entity">
<Id>7d4a58a5-dee9-4a4d-9a3d-3103f1aa465a</Id>
<IsValid>true</IsValid>
<Message xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Message>
<RecordOn>2026-06-06T03:38:53.8162714+04:00</RecordOn>
<ResponseCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</ResponseCodes>
<Value>sample string 3</Value>
</Result>