Sign in
purchaseOrders

Update an existing purchase order

Updates a purchase order. Note: status, po_number, external_id, erp_vendor_id, and ottimate_location_id cannot be changed. If status is included in the request, the request is rejected with a 400 error. If po_number, external_id, erp_vendor_id, or ottimate_location_id is included with a different value, the request succeeds but that field is silently ignored (no error, no change).

patch/purchase-orders/{id}

Path parameters

idstring required

The unique ID of the purchase order

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.

Request body

erp_vendor_namestring

Vendor name from ERP system

datestring date
total_amountnumber double
taxnumber double
freightnumber double
miscellaneous_chargesnumber double
invoice_number_refstring
is_2_wayboolean
custom_fieldsPurchaseOrdersIdPatchRequestBodyContentApplicationJsonSchemaCustomFields

Optional custom fields configured for this company's purchase orders. Provide field values, pass null, or omit the field entirely — passing {} (empty object) returns 400.

Response

Successfully updated

versionstring
idstring required
external_idstring
po_numberstring
status'pending' | 'open' | 'received' | 'closed' | 'flagged' | 'archived' | 'deleted' required
ottimate_location_idinteger
ottimate_company_idinteger
datestring date
erp_vendor_idstring
erp_vendor_namestring
total_amountnumber double
items_countinteger
last_modified_datestring date-time

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

Changes