Create a PO change order
Procurement module
POST/po-change-orderspoChangeOrders.create
A change to an issued purchase order. Creates a PO change order. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
- Requires the capability procurement.po.write.
- OAuth scopes: procurement.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: PoChangeOrderCreate
| Field | Type | Required | Description |
|---|---|---|---|
| purchase_order_id | string (uuid) | Yes | Identifier of the purchase order. |
| description | string | Yes | What changes.Constraints: length 1 to 20000 |
| amount_delta_minor | integer (int64) | null | No | Change amount; null when unpriced. Integer minor units of the resource currency; null means unpriced, never zero. |
{
"purchase_order_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"description": "Add six deck sections.",
"amount_delta_minor": 27000
}Response 201: PoChangeOrder
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the po change order. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| purchase_order_id | string (uuid) | Yes | Identifier of the purchase order. |
| description | string | Yes | What changes.Constraints: length 1 to 20000 |
| amount_delta_minor | integer (int64) | null | Yes | Change amount; null when unpriced. Integer minor units of the resource currency; null means unpriced, never zero. |
| po_change_order_state | "Proposed" | "Approved" | "Rejected" | "Canceled" | Yes | PO 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" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"purchase_order_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","description":"Add six deck sections.","amount_delta_minor":27000}'const { data } = await xos.poChangeOrders.create({
"purchase_order_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"description": "Add six deck sections.",
"amount_delta_minor": 27000
});response = xos.po_change_orders.create({"purchase_order_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "description": "Add six deck sections.", "amount_delta_minor": 27000})xos po-change-orders create --data '{"purchase_order_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","description":"Add six deck sections.","amount_delta_minor":27000}'