Skip to content

Update a purchase order

Procurement module

PATCH/purchase-orders/{id}purchaseOrders.update

A purchase order. Its creator cannot approve it; spend authority applies inside the approval RPC. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

  • Requires the capability procurement.po.write.
  • OAuth scopes: procurement.
  • Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
  • Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.

Path and query parameters

purchaseOrders.update: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the purchase order.

Request body: PurchaseOrderUpdate

purchaseOrders.update: PurchaseOrderUpdate
FieldTypeRequiredDescription
rfq_response_idstring (uuid) | nullNoIdentifier of the awarded RFQ response the order comes from.
delivery_due_onstring (date) | nullNoDate the order is due to be delivered.
payment_terms_daysinteger | nullNoDays after invoice the order is payable (Net 30 is 30).Constraints: range 0 to any
tax_minorinteger (int64) | nullNoTax on the order. Integer minor units of the resource currency; null means unpriced, never zero.
shipping_minorinteger (int64) | nullNoShipping charged on the order. Integer minor units of the resource currency; null means unpriced, never zero.
{
  "rfq_response_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "delivery_due_on": "2026-10-08",
  "payment_terms_days": 30,
  "tax_minor": 4200,
  "shipping_minor": 15000
}

Response 200: PurchaseOrder

purchaseOrders.update: PurchaseOrder
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the purchase order.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
project_idstring (uuid)YesIdentifier of the project.
vendor_idstring (uuid)YesIdentifier of the vendor.
po_numberintegerYesNumber from the project's display key sequence.Constraints: range 1 to any
currency_codestringYesISO 4217 currency code of every money field.Constraints: pattern ^[A-Z]{3}$
po_state"Proposed" | "Approved" | "Sent" | "Closed" | "Canceled"YesPurchase order state.
rfq_response_idstring (uuid) | nullYesIdentifier of the awarded RFQ response the order comes from.
delivery_due_onstring (date) | nullYesDate the order is due to be delivered.
payment_terms_daysinteger | nullYesDays after invoice the order is payable (Net 30 is 30).Constraints: range 0 to any
tax_minorinteger (int64) | nullYesTax on the order. Integer minor units of the resource currency; null means unpriced, never zero.
shipping_minorinteger (int64) | nullYesShipping charged on the order. Integer minor units of the resource currency; null means unpriced, never zero.
sent_atstring (date-time) | nullYesWhen the order moved to Sent (its issue date), from its transition ledger.
invoiced_minorinteger (int64) | nullYesSubtotal of the invoices matched to the order; null when none is matched or one is unpriced. Integer minor units of the resource currency; null means unpriced, never zero.
paid_minorinteger (int64) | nullYesPayments applied to the invoices matched to the order; null when none is matched. Integer minor units of the resource currency; null means unpriced, never zero.
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "vendor_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "po_number": 7,
  "currency_code": "USD",
  "po_state": "Proposed",
  "rfq_response_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "delivery_due_on": "2026-10-08",
  "payment_terms_days": 30,
  "tax_minor": 4200,
  "shipping_minor": 15000,
  "sent_at": "2026-10-08T14:30:00Z",
  "invoiced_minor": 1250000,
  "paid_minor": 600000
}

Code samples

curl -X PATCH "$XOS_BASE_URL/purchase-orders/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"rfq_response_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","delivery_due_on":"2026-10-08","payment_terms_days":30,"tax_minor":4200,"shipping_minor":15000}'
const { data, etag } = await xos.purchaseOrders.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "rfq_response_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "delivery_due_on": "2026-10-08",
    "payment_terms_days": 30,
    "tax_minor": 4200,
    "shipping_minor": 15000
  }, { ifMatch: etag });
response = xos.purchase_orders.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"rfq_response_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "delivery_due_on": "2026-10-08", "payment_terms_days": 30, "tax_minor": 4200, "shipping_minor": 15000}, if_match=etag)
xos purchase-orders update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"rfq_response_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","delivery_due_on":"2026-10-08","payment_terms_days":30,"tax_minor":4200,"shipping_minor":15000}' --if-match auto