GET api/Invoice
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Collection of InvoiceData| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| StopId | globally unique identifier |
Required |
|
| BillToCustomerId | globally unique identifier |
None. |
|
| RadiusInvoiceNumber | string |
Required |
|
| ClientInvoiceNumber | string |
None. |
|
| SalesTerritoryId | globally unique identifier |
None. |
|
| InvoiceType | integer |
Required |
|
| Status | integer |
Required |
|
| CurrentBalance | decimal number |
Required |
|
| TotalAmount | decimal number |
Required |
|
| BalanceOverdue | decimal number |
Required |
|
| TxnDate | date |
None. |
|
| DueDate | date |
None. |
|
| ConfirmationDate | date |
None. |
|
| TrackingNumber | string |
None. |
|
| PONumber | string |
None. |
|
| Identifier | string |
None. |
|
| SalesOrderIdentifier | string |
None. |
|
| Updated | date |
None. |
|
| DriverTerritoryId | globally unique identifier |
None. |
|
| ShipMethodId | string |
None. |
|
| IsDeleted | integer |
None. |
|
| RepNotes | string |
None. |
|
| ProcessNotes | string |
None. |
|
| ShipDate | date |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"Id": "746c86ac-52e6-425a-9280-3d7fecceea4b",
"StopId": "caa12d38-90c6-4d07-a5a6-1372b7bda0b9",
"BillToCustomerId": "4501c622-0a37-4834-9263-cc68e40cc2d2",
"RadiusInvoiceNumber": "sample string 2",
"ClientInvoiceNumber": "sample string 3",
"SalesTerritoryId": "d6feb3a9-6970-4e87-8d2d-d06be43fed5f",
"InvoiceType": 4,
"Status": 5,
"CurrentBalance": 6.0,
"TotalAmount": 7.0,
"BalanceOverdue": 8.0,
"TxnDate": "2025-10-26T02:42:20.9467246-04:00",
"DueDate": "2025-10-26T02:42:20.9467246-04:00",
"ConfirmationDate": "2025-10-26T02:42:20.9467246-04:00",
"TrackingNumber": "sample string 9",
"PONumber": "sample string 10",
"Identifier": "sample string 11",
"SalesOrderIdentifier": "sample string 12",
"Updated": "2025-10-26T02:42:20.9467246-04:00",
"DriverTerritoryId": "99d8c8f2-8442-4a2a-94fb-88e6dd183d26",
"ShipMethodId": "sample string 13",
"IsDeleted": 1,
"RepNotes": "sample string 14",
"ProcessNotes": "sample string 15",
"ShipDate": "2025-10-26T02:42:20.9467246-04:00"
},
{
"Id": "746c86ac-52e6-425a-9280-3d7fecceea4b",
"StopId": "caa12d38-90c6-4d07-a5a6-1372b7bda0b9",
"BillToCustomerId": "4501c622-0a37-4834-9263-cc68e40cc2d2",
"RadiusInvoiceNumber": "sample string 2",
"ClientInvoiceNumber": "sample string 3",
"SalesTerritoryId": "d6feb3a9-6970-4e87-8d2d-d06be43fed5f",
"InvoiceType": 4,
"Status": 5,
"CurrentBalance": 6.0,
"TotalAmount": 7.0,
"BalanceOverdue": 8.0,
"TxnDate": "2025-10-26T02:42:20.9467246-04:00",
"DueDate": "2025-10-26T02:42:20.9467246-04:00",
"ConfirmationDate": "2025-10-26T02:42:20.9467246-04:00",
"TrackingNumber": "sample string 9",
"PONumber": "sample string 10",
"Identifier": "sample string 11",
"SalesOrderIdentifier": "sample string 12",
"Updated": "2025-10-26T02:42:20.9467246-04:00",
"DriverTerritoryId": "99d8c8f2-8442-4a2a-94fb-88e6dd183d26",
"ShipMethodId": "sample string 13",
"IsDeleted": 1,
"RepNotes": "sample string 14",
"ProcessNotes": "sample string 15",
"ShipDate": "2025-10-26T02:42:20.9467246-04:00"
}
]
application/xml, text/xml
Sample:
<ArrayOfInvoiceData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IosWebApi.Models">
<InvoiceData>
<BalanceOverdue>8</BalanceOverdue>
<BillToCustomerId>4501c622-0a37-4834-9263-cc68e40cc2d2</BillToCustomerId>
<ClientInvoiceNumber>sample string 3</ClientInvoiceNumber>
<ConfirmationDate>2025-10-26T02:42:20.9467246-04:00</ConfirmationDate>
<CurrentBalance>6</CurrentBalance>
<DriverTerritoryId>99d8c8f2-8442-4a2a-94fb-88e6dd183d26</DriverTerritoryId>
<DueDate>2025-10-26T02:42:20.9467246-04:00</DueDate>
<Id>746c86ac-52e6-425a-9280-3d7fecceea4b</Id>
<Identifier>sample string 11</Identifier>
<InvoiceType>4</InvoiceType>
<IsDeleted>1</IsDeleted>
<PONumber>sample string 10</PONumber>
<ProcessNotes>sample string 15</ProcessNotes>
<RadiusInvoiceNumber>sample string 2</RadiusInvoiceNumber>
<RepNotes>sample string 14</RepNotes>
<SalesOrderIdentifier>sample string 12</SalesOrderIdentifier>
<SalesTerritoryId>d6feb3a9-6970-4e87-8d2d-d06be43fed5f</SalesTerritoryId>
<ShipDate>2025-10-26T02:42:20.9467246-04:00</ShipDate>
<ShipMethodId>sample string 13</ShipMethodId>
<Status>5</Status>
<StopId>caa12d38-90c6-4d07-a5a6-1372b7bda0b9</StopId>
<TotalAmount>7</TotalAmount>
<TrackingNumber>sample string 9</TrackingNumber>
<TxnDate>2025-10-26T02:42:20.9467246-04:00</TxnDate>
<Updated>2025-10-26T02:42:20.9467246-04:00</Updated>
</InvoiceData>
<InvoiceData>
<BalanceOverdue>8</BalanceOverdue>
<BillToCustomerId>4501c622-0a37-4834-9263-cc68e40cc2d2</BillToCustomerId>
<ClientInvoiceNumber>sample string 3</ClientInvoiceNumber>
<ConfirmationDate>2025-10-26T02:42:20.9467246-04:00</ConfirmationDate>
<CurrentBalance>6</CurrentBalance>
<DriverTerritoryId>99d8c8f2-8442-4a2a-94fb-88e6dd183d26</DriverTerritoryId>
<DueDate>2025-10-26T02:42:20.9467246-04:00</DueDate>
<Id>746c86ac-52e6-425a-9280-3d7fecceea4b</Id>
<Identifier>sample string 11</Identifier>
<InvoiceType>4</InvoiceType>
<IsDeleted>1</IsDeleted>
<PONumber>sample string 10</PONumber>
<ProcessNotes>sample string 15</ProcessNotes>
<RadiusInvoiceNumber>sample string 2</RadiusInvoiceNumber>
<RepNotes>sample string 14</RepNotes>
<SalesOrderIdentifier>sample string 12</SalesOrderIdentifier>
<SalesTerritoryId>d6feb3a9-6970-4e87-8d2d-d06be43fed5f</SalesTerritoryId>
<ShipDate>2025-10-26T02:42:20.9467246-04:00</ShipDate>
<ShipMethodId>sample string 13</ShipMethodId>
<Status>5</Status>
<StopId>caa12d38-90c6-4d07-a5a6-1372b7bda0b9</StopId>
<TotalAmount>7</TotalAmount>
<TrackingNumber>sample string 9</TrackingNumber>
<TxnDate>2025-10-26T02:42:20.9467246-04:00</TxnDate>
<Updated>2025-10-26T02:42:20.9467246-04:00</Updated>
</InvoiceData>
</ArrayOfInvoiceData>