POST Api/Invoice
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": "77897628-c1db-48d3-a162-c24f54a9e092",
"SchoolName": "sample string 4",
"StudentID": "ea0d2b8e-7064-4bcd-a30e-27accf28fa74",
"StudentName": "sample string 6",
"StudentNo": "sample string 7",
"InvoiceOn": "2026-06-06T03:35:14.9546052+04:00",
"DueOn": "2026-06-06T03:35:14.9546052+04:00",
"StartOn": "2026-06-06T03:35:14.9546052+04:00",
"EndOn": "2026-06-06T03:35:14.9546052+04:00",
"Description": "sample string 12",
"InvoiceNo": "sample string 13",
"InvoiceAmt": 14.1,
"ParentID": "e8de70f7-c558-45e0-9392-76c36382aa98",
"InvoiceStatus": 1,
"Days": 16,
"Id": "a9405e6f-7c92-41e3-a7d0-6e378ed67251",
"UserName": "sample string 18",
"UserID": "fcc322f5-7b1a-4e7a-b803-dda0a4f0b8bb",
"CreatedBy": "sample string 20",
"CreatedOn": "2026-06-06T03:35:14.9546052+04:00",
"ClientID": "03edcd2e-642b-4da0-bd2c-3cb8b6b8d2f8",
"ClientName": "sample string 23",
"PartnerID": "812f892f-9ffc-443d-944a-2d26607f273f",
"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>03edcd2e-642b-4da0-bd2c-3cb8b6b8d2f8</ClientID> <ClientName>sample string 23</ClientName> <CreatedBy>sample string 20</CreatedBy> <CreatedOn>2026-06-06T03:35:14.9546052+04:00</CreatedOn> <Id>a9405e6f-7c92-41e3-a7d0-6e378ed67251</Id> <PartnerID>812f892f-9ffc-443d-944a-2d26607f273f</PartnerID> <PartnerName>sample string 25</PartnerName> <UserID>fcc322f5-7b1a-4e7a-b803-dda0a4f0b8bb</UserID> <UserName>sample string 18</UserName> <Days>16</Days> <Description>sample string 12</Description> <DueOn>2026-06-06T03:35:14.9546052+04:00</DueOn> <EndOn>2026-06-06T03:35:14.9546052+04:00</EndOn> <InvoiceAmt>14.1</InvoiceAmt> <InvoiceNo>sample string 13</InvoiceNo> <InvoiceOn>2026-06-06T03:35:14.9546052+04:00</InvoiceOn> <InvoiceStatus>Unpaid</InvoiceStatus> <ParentID>e8de70f7-c558-45e0-9392-76c36382aa98</ParentID> <SchoolID>77897628-c1db-48d3-a162-c24f54a9e092</SchoolID> <SchoolName>sample string 4</SchoolName> <StartOn>2026-06-06T03:35:14.9546052+04:00</StartOn> <StudentID>ea0d2b8e-7064-4bcd-a30e-27accf28fa74</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": "5c0355ef-b1c3-40c4-ac04-b906dc4c5ca9",
"Value": "sample string 3",
"RecordOn": "2026-06-06T03:35:14.9702307+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>5c0355ef-b1c3-40c4-ac04-b906dc4c5ca9</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:35:14.9702307+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>