Get Purchase Orders

get

https://public-api.spendesk.com/v1/purchase-orders

Allowed Scopes: experimental:purchase-order:read

Returns purchase orders. Purchase order data is cached for up to 2 hours. Changes made through the API are returned by subsequent reads; changes made in Spendesk can take up to 2 hours to appear.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

integer

≥ 1

Defaults to 1

Page number

pageSize

integer

1 to 30

Defaults to 30

Page size

withItems

boolean

Whether to include line items in the response

supplierIds

string | array

Filter by supplier IDs

status

string | array

Filter by purchase order status

companyIds

string | array

Filter by company IDs

createdFrom

string

^\d{4}-\d{2}-\d{2}$

Filter purchase orders created from this date (YYYY-MM-DD)

createdTo

string

^\d{4}-\d{2}-\d{2}$

Filter purchase orders created until this date (YYYY-MM-DD)

startDateFrom

string

^\d{4}-\d{2}-\d{2}$

Filter purchase orders with start date from this date (YYYY-MM-DD)

startDateTo

string

^\d{4}-\d{2}-\d{2}$

Filter purchase orders with start date until this date (YYYY-MM-DD)

endDateFrom

string

^\d{4}-\d{2}-\d{2}$

Filter purchase orders with end date from this date (YYYY-MM-DD)

endDateTo

string

^\d{4}-\d{2}-\d{2}$

Filter purchase orders with end date until this date (YYYY-MM-DD)

Headers

X-Company-Id

string

ID of the company the request acts on. Required with an organisation-level token; not needed with a company-level token.

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Default Response

400Bad request

401Unauthorized

403Forbidden

404Not Found

429Too Many Requests

500Internal Server Error