GET v1/admin/company/{id}/OrderHistory/OutstandingOrders?sort={sort}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id | integer |
Required |
|
sort |
A comma delimited list of columns to sort by. Field are sorted in ascending order by default. To have a field sort in descending order, preface it with the minus (-) sign. |
string |
Default value is |
Body Parameters
None.
Response Information
Resource Description
Collection of getOutstandingOrderHistoryOutputName | Description | Type | Additional information |
---|---|---|---|
OrderId |
The Id for this order |
integer |
None. |
OrderDate |
The Date of this order |
date |
None. |
OrderTotal |
The Total amount for this order |
decimal number |
None. |
OrderType |
The OrderType for this order |
string |
None. |
AmountDue |
The amount due for this order |
decimal number |
None. |
currencyTypeId |
The id of the currency being used on the order. |
integer |
None. |
currencySymbol |
The currency symbol for the order. |
string |
None. |
billToName |
The Bill to Person Name |
string |
None. |
billToId |
Bill to Person Id |
integer |
None. |
Response Formats
application/json, text/json
Sample:
[ { "OrderId": 1, "OrderDate": "2024-10-09T15:36:32.9516463+00:00", "OrderTotal": 3.0, "OrderType": "sample string 4", "AmountDue": 5.0, "currencyTypeId": 6, "currencySymbol": "sample string 7", "billToName": "sample string 8", "billToId": 9 }, { "OrderId": 1, "OrderDate": "2024-10-09T15:36:32.9516463+00:00", "OrderTotal": 3.0, "OrderType": "sample string 4", "AmountDue": 5.0, "currencyTypeId": 6, "currencySymbol": "sample string 7", "billToName": "sample string 8", "billToId": 9 } ]
text/html
Sample:
[{"OrderId":1,"OrderDate":"2024-10-09T15:36:32.9516463+00:00","OrderTotal":3.0,"OrderType":"sample string 4","AmountDue":5.0,"currencyTypeId":6,"currencySymbol":"sample string 7","billToName":"sample string 8","billToId":9},{"OrderId":1,"OrderDate":"2024-10-09T15:36:32.9516463+00:00","OrderTotal":3.0,"OrderType":"sample string 4","AmountDue":5.0,"currencyTypeId":6,"currencySymbol":"sample string 7","billToName":"sample string 8","billToId":9}]
application/xml, text/xml
Sample:
<ArrayOfv1_Admin_CompanyEndpointController.getOutstandingOrderHistoryOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aptify.Services.Generated.v1_Admin_CompanyEndpoint"> <v1_Admin_CompanyEndpointController.getOutstandingOrderHistoryOutput> <AmountDue>5</AmountDue> <OrderDate>2024-10-09T15:36:32.9516463+00:00</OrderDate> <OrderId>1</OrderId> <OrderTotal>3</OrderTotal> <OrderType>sample string 4</OrderType> <billToId>9</billToId> <billToName>sample string 8</billToName> <currencySymbol>sample string 7</currencySymbol> <currencyTypeId>6</currencyTypeId> </v1_Admin_CompanyEndpointController.getOutstandingOrderHistoryOutput> <v1_Admin_CompanyEndpointController.getOutstandingOrderHistoryOutput> <AmountDue>5</AmountDue> <OrderDate>2024-10-09T15:36:32.9516463+00:00</OrderDate> <OrderId>1</OrderId> <OrderTotal>3</OrderTotal> <OrderType>sample string 4</OrderType> <billToId>9</billToId> <billToName>sample string 8</billToName> <currencySymbol>sample string 7</currencySymbol> <currencyTypeId>6</currencyTypeId> </v1_Admin_CompanyEndpointController.getOutstandingOrderHistoryOutput> </ArrayOfv1_Admin_CompanyEndpointController.getOutstandingOrderHistoryOutput>