v1

latestOpenAPI 3.1.02026-08-0458234268.6 KB

purchaseOrders

Retrieve a paginated list of purchase orders

Returns a paginated list of purchase orders, filterable by company, location, vendor, status, and date range.

get/purchase-orders

Query parameters

ottimate_company_idinteger

Filter by company ID

ottimate_location_idinteger

Filter by location ID

erp_vendor_idstring

Filter by ERP vendor ID (external vendor identifier)

status'pending_review' | 'approved' | 'rejected' | 'closed'

Filter by PO status

date_fromstring date

Filter by start date (YYYY-MM-DD)

date_tostring date

Filter by end date (YYYY-MM-DD)

expandstring

Comma-separated list of fields to expand. Supported values: items. When expand=items is used, date_from and date_to must both be provided and within a 30-day window.

external_idstring

Filter by external (ERP) purchase order ID

pageinteger

Page number (default 1)

limitinteger

Number of results per page (default 20)

Headers

Authorizationstring required

OAuth2 authentication flows. Auth server URLs will vary by environment

X-Api-Keystring required

API key for authentication

X-API-Versionstring

API version to use (optional, defaults to latest). Supported values: 1.0.0, 1.1.0.

Response

Successful response with paginated purchase order list

versionstring

countinteger

pageinteger

limitinteger