v1

latestOpenAPI 3.1.02026-08-0458234268.6 KB

purchaseOrders

Create a single purchase order

Creates a new purchase order with the provided details. The po_number field is required and must be provided by the client (no auto-generation).

post/purchase-orders

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.

Idempotency-Keystring

Client-generated unique key (UUID/ULID recommended). JSON requests: the first 2xx response is cached for 24h and replayed on a same-key retry with a matching body; a different body returns 422. Non-JSON requests (e.g. file uploads): the key is single-use — any same-key retry returns 422 regardless of body. See Idempotency for full details.

Request body

ottimate_location_idinteger required

external_idstring

po_numberstring required

erp_vendor_idstring required

External vendor identifier from ERP system

erp_vendor_namestring

Vendor name from ERP system

datestring date required

total_amountnumber double required

taxnumber double

freightnumber double

miscellaneous_chargesnumber double

invoice_number_refstring

Invoice reference number

is_2_wayboolean

Whether this is a 2-way match PO

custom_fieldsPurchaseOrderCreateRequestCustomFields

Optional custom fields configured for this company's purchase orders

Response

Successfully created

idstring uuid required

external_idstring

po_numberstring

ottimate_location_idinteger

ottimate_company_idinteger

datestring date

erp_vendor_idstring

erp_vendor_namestring

total_amountnumber double

items_countinteger

created_datestring date-time

Creation timestamp. UTC ISO 8601, e.g. "2024-01-15T10:30:00Z".

custom_fieldsPurchaseOrderCreateResponseCustomFields

Optional custom fields configured for this company's purchase orders