GET Api/Invoice/GetHistory?invoice={invoice}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| invoice | string |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of 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. |
Response Formats
application/json, text/json
Sample:
[
{
"PaymentMethod": 1,
"PaymentRef": "sample string 1",
"Note": "sample string 2",
"SchoolID": "48ec578c-1230-46cf-bc36-ecae947d0e5a",
"SchoolName": "sample string 4",
"StudentID": "8eafc337-d0c4-42b3-b5ad-fad56a31dfe0",
"StudentName": "sample string 6",
"StudentNo": "sample string 7",
"InvoiceOn": "2026-06-06T03:41:43.6759004+04:00",
"DueOn": "2026-06-06T03:41:43.6759004+04:00",
"StartOn": "2026-06-06T03:41:43.6759004+04:00",
"EndOn": "2026-06-06T03:41:43.6759004+04:00",
"Description": "sample string 12",
"InvoiceNo": "sample string 13",
"InvoiceAmt": 14.1,
"ParentID": "2164a0a5-6055-423f-b775-90e816b2b592",
"InvoiceStatus": 1,
"Days": 16,
"Id": "793a7ec9-d5e8-460b-a617-fec24399f89e",
"UserName": "sample string 18",
"UserID": "7a68dfa7-047a-44eb-9bf1-07a367687a02",
"CreatedBy": "sample string 20",
"CreatedOn": "2026-06-06T03:41:43.6759004+04:00",
"ClientID": "e8e04281-db1a-461b-9fa3-08295334f52d",
"ClientName": "sample string 23",
"PartnerID": "e1c69c5f-7f4a-420c-8b75-bc24bca7f885",
"PartnerName": "sample string 25"
},
{
"PaymentMethod": 1,
"PaymentRef": "sample string 1",
"Note": "sample string 2",
"SchoolID": "48ec578c-1230-46cf-bc36-ecae947d0e5a",
"SchoolName": "sample string 4",
"StudentID": "8eafc337-d0c4-42b3-b5ad-fad56a31dfe0",
"StudentName": "sample string 6",
"StudentNo": "sample string 7",
"InvoiceOn": "2026-06-06T03:41:43.6759004+04:00",
"DueOn": "2026-06-06T03:41:43.6759004+04:00",
"StartOn": "2026-06-06T03:41:43.6759004+04:00",
"EndOn": "2026-06-06T03:41:43.6759004+04:00",
"Description": "sample string 12",
"InvoiceNo": "sample string 13",
"InvoiceAmt": 14.1,
"ParentID": "2164a0a5-6055-423f-b775-90e816b2b592",
"InvoiceStatus": 1,
"Days": 16,
"Id": "793a7ec9-d5e8-460b-a617-fec24399f89e",
"UserName": "sample string 18",
"UserID": "7a68dfa7-047a-44eb-9bf1-07a367687a02",
"CreatedBy": "sample string 20",
"CreatedOn": "2026-06-06T03:41:43.6759004+04:00",
"ClientID": "e8e04281-db1a-461b-9fa3-08295334f52d",
"ClientName": "sample string 23",
"PartnerID": "e1c69c5f-7f4a-420c-8b75-bc24bca7f885",
"PartnerName": "sample string 25"
}
]
application/xml, text/xml
Sample:
<ArrayOfInvoiceHistory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fleetroot.Entity">
<InvoiceHistory>
<ClientID>e8e04281-db1a-461b-9fa3-08295334f52d</ClientID>
<ClientName>sample string 23</ClientName>
<CreatedBy>sample string 20</CreatedBy>
<CreatedOn>2026-06-06T03:41:43.6759004+04:00</CreatedOn>
<Id>793a7ec9-d5e8-460b-a617-fec24399f89e</Id>
<PartnerID>e1c69c5f-7f4a-420c-8b75-bc24bca7f885</PartnerID>
<PartnerName>sample string 25</PartnerName>
<UserID>7a68dfa7-047a-44eb-9bf1-07a367687a02</UserID>
<UserName>sample string 18</UserName>
<Days>16</Days>
<Description>sample string 12</Description>
<DueOn>2026-06-06T03:41:43.6759004+04:00</DueOn>
<EndOn>2026-06-06T03:41:43.6759004+04:00</EndOn>
<InvoiceAmt>14.1</InvoiceAmt>
<InvoiceNo>sample string 13</InvoiceNo>
<InvoiceOn>2026-06-06T03:41:43.6759004+04:00</InvoiceOn>
<InvoiceStatus>Unpaid</InvoiceStatus>
<ParentID>2164a0a5-6055-423f-b775-90e816b2b592</ParentID>
<SchoolID>48ec578c-1230-46cf-bc36-ecae947d0e5a</SchoolID>
<SchoolName>sample string 4</SchoolName>
<StartOn>2026-06-06T03:41:43.6759004+04:00</StartOn>
<StudentID>8eafc337-d0c4-42b3-b5ad-fad56a31dfe0</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>
<InvoiceHistory>
<ClientID>e8e04281-db1a-461b-9fa3-08295334f52d</ClientID>
<ClientName>sample string 23</ClientName>
<CreatedBy>sample string 20</CreatedBy>
<CreatedOn>2026-06-06T03:41:43.6759004+04:00</CreatedOn>
<Id>793a7ec9-d5e8-460b-a617-fec24399f89e</Id>
<PartnerID>e1c69c5f-7f4a-420c-8b75-bc24bca7f885</PartnerID>
<PartnerName>sample string 25</PartnerName>
<UserID>7a68dfa7-047a-44eb-9bf1-07a367687a02</UserID>
<UserName>sample string 18</UserName>
<Days>16</Days>
<Description>sample string 12</Description>
<DueOn>2026-06-06T03:41:43.6759004+04:00</DueOn>
<EndOn>2026-06-06T03:41:43.6759004+04:00</EndOn>
<InvoiceAmt>14.1</InvoiceAmt>
<InvoiceNo>sample string 13</InvoiceNo>
<InvoiceOn>2026-06-06T03:41:43.6759004+04:00</InvoiceOn>
<InvoiceStatus>Unpaid</InvoiceStatus>
<ParentID>2164a0a5-6055-423f-b775-90e816b2b592</ParentID>
<SchoolID>48ec578c-1230-46cf-bc36-ecae947d0e5a</SchoolID>
<SchoolName>sample string 4</SchoolName>
<StartOn>2026-06-06T03:41:43.6759004+04:00</StartOn>
<StudentID>8eafc337-d0c4-42b3-b5ad-fad56a31dfe0</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>
</ArrayOfInvoiceHistory>