Create a purchase order

Procurement module

POST/purchase-orderspurchaseOrders.create

A purchase order. Its creator cannot approve it; spend authority applies inside the approval RPC. Creates a purchase 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: PurchaseOrderCreate

purchaseOrders.create: PurchaseOrderCreate
Field	Type	Required	Description
project_id	string (uuid)	Yes	Identifier of the project.
vendor_id	string (uuid)	Yes	Identifier of the vendor.
currency_code	string	Yes	ISO 4217 currency code of every money field.Constraints: pattern ^[A-Z]{3}$
rfq_response_id	string (uuid) \| null	No	Identifier of the awarded RFQ response the order comes from.
delivery_due_on	string (date) \| null	No	Date the order is due to be delivered.
payment_terms_days	integer \| null	No	Days after invoice the order is payable (Net 30 is 30).Constraints: range 0 to any
tax_minor	integer (int64) \| null	No	Tax on the order. Integer minor units of the resource currency; null means unpriced, never zero.
shipping_minor	integer (int64) \| null	No	Shipping charged on the order. Integer minor units of the resource currency; null means unpriced, never zero.

{
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "vendor_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "currency_code": "USD",
  "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 201: PurchaseOrder

purchaseOrders.create: PurchaseOrder
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the purchase 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.
project_id	string (uuid)	Yes	Identifier of the project.
vendor_id	string (uuid)	Yes	Identifier of the vendor.
po_number	integer	Yes	Number from the project's display key sequence.Constraints: range 1 to any
currency_code	string	Yes	ISO 4217 currency code of every money field.Constraints: pattern ^[A-Z]{3}$
po_state	"Proposed" \| "Approved" \| "Sent" \| "Closed" \| "Canceled"	Yes	Purchase order state.
rfq_response_id	string (uuid) \| null	Yes	Identifier of the awarded RFQ response the order comes from.
delivery_due_on	string (date) \| null	Yes	Date the order is due to be delivered.
payment_terms_days	integer \| null	Yes	Days after invoice the order is payable (Net 30 is 30).Constraints: range 0 to any
tax_minor	integer (int64) \| null	Yes	Tax on the order. Integer minor units of the resource currency; null means unpriced, never zero.
shipping_minor	integer (int64) \| null	Yes	Shipping charged on the order. Integer minor units of the resource currency; null means unpriced, never zero.
sent_at	string (date-time) \| null	Yes	When the order moved to Sent (its issue date), from its transition ledger.
invoiced_minor	integer (int64) \| null	Yes	Subtotal 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_minor	integer (int64) \| null	Yes	Payments 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" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","vendor_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","currency_code":"USD","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 } = await xos.purchaseOrders.create({
    "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "vendor_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "currency_code": "USD",
    "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 = xos.purchase_orders.create({"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "vendor_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "currency_code": "USD", "rfq_response_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "delivery_due_on": "2026-10-08", "payment_terms_days": 30, "tax_minor": 4200, "shipping_minor": 15000})

xos purchase-orders create --data '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","vendor_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","currency_code":"USD","rfq_response_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","delivery_due_on":"2026-10-08","payment_terms_days":30,"tax_minor":4200,"shipping_minor":15000}'