purchase orders list
GET {{baseUrl}}/purchase-orders
Returns a list of PurchaseOrder objects.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
created_after | string | If provided, will only return objects created after this datetime. | |
created_before | string | If provided, will only return objects created before this datetime. | |
cursor | string | The pagination cursor value. | |
expand | string | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | |
include_deleted_data | boolean | Whether to include data that was deleted in the third-party service. | |
include_remote_data | boolean | Whether to include the original data Merge fetched from the third-party to produce these models. | |
modified_after | string | If provided, will only return objects modified after this datetime. | |
modified_before | string | If provided, will only return objects modified before this datetime. | |
page_size | number | Number of results to return per page. | |
remote_id | string | The API provider's ID for the given object. | |
company_id | string | If provided, will only return purchase orders for this company. | |
issue_date_after | string | ||
issue_date_before | string |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-Account-Token | string | (Required) Token identifying the end user. | |
Accept | string |
RESPONSES
status: OK
{"next":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous":"cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results":[{"id":"0048ea5b-911e-4dff-9364-92070dea62ff","remote_id":"239741","status":"DELETED","issue_date":"1984-03-04T00:04:59.187Z","delivery_date":"2020-04-15T00:00:00Z","delivery_address":"urn:uuid:e8529f86-a89e-99a2-0a9d-eedec56e808e","total_amount":260,"currency":"CLF","line_items":[{"description":"Pickleball paddles","unit_price":25,"quantity":10,"item":"0958cbc6-6040-430a-848e-aafacbadf4ae"},{"description":"Pickleball Balls","unit_price":1,"quantity":10,"item":"249c9faa-3045-4a31-953b-8f22d3613301"}],"remote_created_at":"2020-03-31T00:00:00Z","remote_updated_at":"2020-03-31T00:00:00Z"},{"id":"0048ea5b-911e-4dff-9364-92070dea62ff","remote_id":"239741","status":"DRAFT","issue_date":"2012-11-30T12:43:10.729Z","delivery_date":"2020-04-15T00:00:00Z","delivery_address":"urn:uuid:bbbdc282-ed7d-f6d5-c120-b712507dab60","total_amount":260,"currency":"ESB","line_items":[{"description":"Pickleball paddles","unit_price":25,"quantity":10,"item":"0958cbc6-6040-430a-848e-aafacbadf4ae"},{"description":"Pickleball Balls","unit_price":1,"quantity":10,"item":"249c9faa-3045-4a31-953b-8f22d3613301"}],"remote_created_at":"2020-03-31T00:00:00Z","remote_updated_at":"2020-03-31T00:00:00Z"}]}