Skip to content

Approve a purchase order

Procurement module

POST/purchase-orders/{id}/approvepurchaseOrders.approve

Records an approval through app.approve_purchase_order: finance.po.approve on the project, never by the order's creator (sod_po_creator), fully priced, within spend authority. Above the dual threshold the order stays Proposed until a second approver approves; a refusal returns 422 and names the rule. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

  • Requires the capability finance.po.approve.
  • OAuth scopes: finance.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 404, 409, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

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

Request body: PurchaseOrderApproveRequest

purchaseOrders.approve: PurchaseOrderApproveRequest
FieldTypeRequiredDescription
reasonstringYesWhy approve the order.Constraints: length 1 to 500
{
  "reason": "Within budget."
}

Response 200: PurchaseOrder

purchaseOrders.approve: 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 POST "$XOS_BASE_URL/purchase-orders/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/approve" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"reason":"Within budget."}'
const { data } = await xos.purchaseOrders.approve("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "reason": "Within budget."
  });
response = xos.purchase_orders.approve("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"reason": "Within budget."})
xos purchase-orders approve 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"reason":"Within budget."}'