POST api/Invoice/GetInvoiceDetails
Gets all invoice details for a given order number.
Request Information
URI Parameters
None.
Body Parameters
GetInvoiceDetailsRequestModel| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId | integer |
None. |
|
| AuthToken | string |
None. |
|
| OrderIdList |
The SouthData order number that will be used to search for invoice details. Client Id is required and must be a positive number. |
Collection of integer |
Required |
Request Formats
application/json, text/json
Sample:
{
"UserId": 1,
"AuthToken": "sample string 2",
"OrderIdList": [
1,
2
]
}
application/xml, text/xml
Sample:
<GetInvoiceDetailsRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SouthDataAPI.Models">
<AuthToken>sample string 2</AuthToken>
<OrderIdList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</OrderIdList>
<UserId>1</UserId>
</GetInvoiceDetailsRequestModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
multipart/form-data
Sample:
Sample not available.
application/octet-stream
Sample:
Sample not available.
Response Information
Resource Description
Response model containing invoice details for the passed orders
GetInvoiceDetailsResponseModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientId | integer |
None. |
|
| InvoiceId | integer |
None. |
|
| OrderId | integer |
None. |
|
| ItemDate | date |
None. |
|
| Product | string |
None. |
|
| ProductType | string |
None. |
|
| Quantity | decimal number |
None. |
|
| Description | string |
None. |
|
| UnitPrice | decimal number |
None. |
|
| Total | decimal number |
None. |
Response Formats
application/json, text/json
Sample:
{
"ClientId": 1,
"InvoiceId": 2,
"OrderId": 3,
"ItemDate": "2026-02-11T04:06:48.2803134-05:00",
"Product": "sample string 4",
"ProductType": "sample string 5",
"Quantity": 1.1,
"Description": "sample string 6",
"UnitPrice": 1.0,
"Total": 1.0
}
application/xml, text/xml
Sample:
<GetInvoiceDetailsResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SouthDataAPI.Models"> <ClientId>1</ClientId> <Description>sample string 6</Description> <InvoiceId>2</InvoiceId> <ItemDate>2026-02-11T04:06:48.2803134-05:00</ItemDate> <OrderId>3</OrderId> <Product>sample string 4</Product> <ProductType>sample string 5</ProductType> <Quantity>1.1</Quantity> <Total>1</Total> <UnitPrice>1</UnitPrice> </GetInvoiceDetailsResponseModel>