GET /PurchaseOrders
Servers
- https://api.xero.com/api.xro/2.0
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
If-Modified-Since |
String | No |
Only records created or modified since this timestamp will be returned |
xero-tenant-id |
String | Yes |
Xero identifier for Tenant |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
page |
Integer | No |
To specify a page, append the page parameter to the URL e.g. ?page=1. If there are 100 records in the response you will need to check if there is any more data by fetching the next page e.g ?page=2 and continuing this process until no more results are returned. |
DateFrom |
String | No |
Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31 |
order |
String | No |
Order by an any element |
Status |
String | No |
Filter by purchase order status Possible values:
|
DateTo |
String | No |
Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31 |
pageSize |
Integer | No |
Number of records to retrieve per page |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.