GET invoices/{accoundId}/current?session={session}&page={page}&count={count}
Returns customer unpaid invoices
Request
URL parameters
Name | Description | Type | Additionnal Information | Intro version |
---|---|---|---|---|
accoundId | Account unique identifier (customer or delivery address) | bigint | Required | |
session | Session identification. (Must be unique for the current session) | string | Length between 0 and 100 | |
page | Page number of list. | integer | ||
count | Number of orders to return per page | integer | Default value: 20 Value between 1 and 100 |
Response
InvoiceListResultName | Description | Type | Additionnal Information | Intro version |
---|---|---|---|---|
invoice | Order list | Collection of InvoiceList | ||
token | Token of this result's last entry. This token can be passed the next time you call this API to get the rest of the modified data | string | ||
count | Number of entries in this lot | integer | ||
queuecount | Number of remaining prices to recover | integer | ||
returncode | Return code: 0 for success | integer | ||
returnmsg | Return message | string | ||
warnings | Warnings (the instruction worked but you need to pay attention to warnings. May cause partial data loss (Truncation)) | Collection of string | ||
version | API version | string |
Return format
application/json, text/json, application/x-www-form-urlencoded
Sample:
{ "invoice": [ { "invoiceId": 1, "invoiceNo": "sample string 2", "invoiceDate": "2024-11-21", "invoiceAmount": 4.1, "invoiceBalance": 5.1, "dueDate": "2024-11-21", "orderId": 7, "orderNo": "sample string 8", "orderDate": "2024-11-21", "deliveryNo": "sample string 10", "deliveryDate": "2024-11-21", "shipName": "sample string 12", "shipPhone": "sample string 13", "shipAddress": { "address1": "sample string 1", "address2": "sample string 2", "city": "sample string 3", "province": "sample string 4", "country": "sample string 5", "postcode": "sample string 6" }, "status": "sample string 14", "shipCustNo": "sample string 15", "poNumber": "sample string 16", "downloadURL": "sample string 17", "term": { "Id": 1, "code": "sample string 2", "description": "sample string 3", "description_fr": "sample string 4", "description_en": "sample string 5" } }, { "invoiceId": 1, "invoiceNo": "sample string 2", "invoiceDate": "2024-11-21", "invoiceAmount": 4.1, "invoiceBalance": 5.1, "dueDate": "2024-11-21", "orderId": 7, "orderNo": "sample string 8", "orderDate": "2024-11-21", "deliveryNo": "sample string 10", "deliveryDate": "2024-11-21", "shipName": "sample string 12", "shipPhone": "sample string 13", "shipAddress": { "address1": "sample string 1", "address2": "sample string 2", "city": "sample string 3", "province": "sample string 4", "country": "sample string 5", "postcode": "sample string 6" }, "status": "sample string 14", "shipCustNo": "sample string 15", "poNumber": "sample string 16", "downloadURL": "sample string 17", "term": { "Id": 1, "code": "sample string 2", "description": "sample string 3", "description_fr": "sample string 4", "description_en": "sample string 5" } } ], "token": "sample string 1", "count": 2, "queuecount": 3, "returncode": 4, "returnmsg": "sample string 5", "warnings": [ "sample string 1", "sample string 2" ], "version": "sample string 6" }
application/xml, text/xml
Sample:
<result returncode="4" returnmsg="sample string 5" version="sample string 6" token="sample string 1" count="2" queuecount="3"> <warnings>sample string 1</warnings> <warnings>sample string 2</warnings> <invoice invoiceId="1" invoiceNo="sample string 2" invoiceDate="2024-11-21T04:17:51.3425498-05:00" invoiceAmount="4.1" invoiceBalance="5.1" dueDate="2024-11-21T04:17:51.3425498-05:00" orderId="7" orderNo="sample string 8" orderDate="2024-11-21T04:17:51.3425498-05:00" deliveryNo="sample string 10" deliveryDate="2024-11-21T04:17:51.3425498-05:00" shipName="sample string 12" shipPhone="sample string 13" status="sample string 14" shipCustNo="sample string 15" poNumber="sample string 16" downloadURL="sample string 17"> <shipAddress address1="sample string 1" address2="sample string 2" city="sample string 3" province="sample string 4" country="sample string 5" postcode="sample string 6" /> <term id="1" code="sample string 2" description="sample string 3" description_fr="sample string 4" description_en="sample string 5" /> </invoice> <invoice invoiceId="1" invoiceNo="sample string 2" invoiceDate="2024-11-21T04:17:51.3425498-05:00" invoiceAmount="4.1" invoiceBalance="5.1" dueDate="2024-11-21T04:17:51.3425498-05:00" orderId="7" orderNo="sample string 8" orderDate="2024-11-21T04:17:51.3425498-05:00" deliveryNo="sample string 10" deliveryDate="2024-11-21T04:17:51.3425498-05:00" shipName="sample string 12" shipPhone="sample string 13" status="sample string 14" shipCustNo="sample string 15" poNumber="sample string 16" downloadURL="sample string 17"> <shipAddress address1="sample string 1" address2="sample string 2" city="sample string 3" province="sample string 4" country="sample string 5" postcode="sample string 6" /> <term id="1" code="sample string 2" description="sample string 3" description_fr="sample string 4" description_en="sample string 5" /> </invoice> </result>