GET PurchaseOrder/GetPurchaseOrder?startDate={startDate}&endDate={endDate}&poNumFilter={poNumFilter}&lastModifiedOnOrAfterUtc={lastModifiedOnOrAfterUtc}&lastModifiedOnOrBeforeUtc={lastModifiedOnOrBeforeUtc}
Returns purchase order data.
Request Information
URI Parameters
| Name | Description | Type | Additional Information |
|---|---|---|---|
| startDate |
Start date of purchase orders to return. Format MM-dd-yyyy. (Optional) |
string |
Default value is string.Empty |
| endDate |
End date of purchase orders to return. Format MM-dd-yyyy. (Optional) |
string |
Default value is string.Empty |
| poNumFilter |
Purchase Order number to limit the response. (Optional) |
string |
Default value is string.Empty |
| lastModifiedOnOrAfterUtc |
Filter the list of purchase orders to those changed on or after the supplied UTC date and time (optional) - format = yyyy-MM-ddTHH:mm:ss |
string |
Default value is string.Empty |
| lastModifiedOnOrBeforeUtc |
Filter the list of purchase orders to those changed on or before the supplied UTC date and time (optional) - format = yyyy-MM-ddTHH:mm:ss |
string |
Default value is string.Empty |
Body Parameters
Response Information
Resource Description
Returns purchase order data.
AgvPurchaseOrder| Name | Description | Type | Additional Information |
|---|---|---|---|
| Status |
Status of the API call. |
string | |
| Message |
Message of the API call. |
string | |
| ErrorList |
List of errors from the API |
Collection of string | |
| WarningList |
List of warnings from the API |
Collection of string | |
| Count |
Count of how many Purchase Orders. |
string | |
| PurchaseOrderRecords |
JSON dictionary of PurchaseOrderRecords. |
Collection of clsAPIPurchaseOrder |
Response Formats
application/json, text/json
{
"Status": "sample string 1",
"Message": "sample string 2",
"ErrorList": [
"sample string 1",
"sample string 2"
],
"WarningList": [
"sample string 1",
"sample string 2"
],
"Count": "sample string 3",
"PurchaseOrderRecords": [
{
"VendorID": "sample string 1",
"PONumber": "sample string 2",
"PurchaseOrderRecordHeaderDetails": null,
"PurchaseOrderRecordLineItemDetails": [],
"PurchaseOrderRecordChargeDetails": []
},
{
"VendorID": "sample string 1",
"PONumber": "sample string 2",
"PurchaseOrderRecordHeaderDetails": null,
"PurchaseOrderRecordLineItemDetails": [],
"PurchaseOrderRecordChargeDetails": []
}
]
}