Skip to content

Approve a PO change order

Procurement module

POST/po-change-orders/{id}/approvepoChangeOrders.approve

Approves a priced, Proposed PO change order through app.decide_po_change_order under spend authority. Its requester cannot approve it; 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

poChangeOrders.approve: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the po change order.

Request body: PoChangeOrderApproveRequest

poChangeOrders.approve: PoChangeOrderApproveRequest
FieldTypeRequiredDescription
reasonstringYesWhy approve the change.Constraints: length 1 to 500
{
  "reason": "Within budget."
}

Response 200: PoChangeOrder

poChangeOrders.approve: PoChangeOrder
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the po change 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.
purchase_order_idstring (uuid)YesIdentifier of the purchase order.
descriptionstringYesWhat changes.Constraints: length 1 to 20000
amount_delta_minorinteger (int64) | nullYesChange amount; null when unpriced. Integer minor units of the resource currency; null means unpriced, never zero.
po_change_order_state"Proposed" | "Approved" | "Rejected" | "Canceled"YesPO change order state.
{
  "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",
  "purchase_order_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "description": "Add six deck sections.",
  "amount_delta_minor": 27000,
  "po_change_order_state": "Proposed"
}

Code samples

curl -X POST "$XOS_BASE_URL/po-change-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.poChangeOrders.approve("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "reason": "Within budget."
  });
response = xos.po_change_orders.approve("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"reason": "Within budget."})
xos po-change-orders approve 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"reason":"Within budget."}'