Create a goods receipt

Procurement module

POST/goods-receiptsgoodsReceipts.create

A goods receipt against a purchase order. Duplicate receipts are refused. Creates a goods receipt. 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.receipt.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: GoodsReceiptCreate

goodsReceipts.create: GoodsReceiptCreate
Field	Type	Required	Description
purchase_order_id	string (uuid)	Yes	Identifier of the purchase order.
received_at	string (date-time)	No	When the goods arrived.
note	string \| null	No	Condition or exceptions noted.Constraints: length 1 to 20000

{
  "purchase_order_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "received_at": "2026-10-08T14:30:00Z",
  "note": "Two cases dented."
}

Response 201: GoodsReceipt

goodsReceipts.create: GoodsReceipt
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the goods receipt.
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.
received_at	string (date-time)	Yes	When the goods arrived.
received_by	string (uuid) \| null	Yes	Identifier of the receiver.
note	string \| null	Yes	Condition or exceptions noted.Constraints: length 1 to 20000

{
  "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",
  "received_at": "2026-10-08T14:30:00Z",
  "received_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "note": "Two cases dented."
}

Code samples

curl -X POST "$XOS_BASE_URL/goods-receipts" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"purchase_order_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","received_at":"2026-10-08T14:30:00Z","note":"Two cases dented."}'

const { data } = await xos.goodsReceipts.create({
    "purchase_order_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "received_at": "2026-10-08T14:30:00Z",
    "note": "Two cases dented."
  });

response = xos.goods_receipts.create({"purchase_order_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "received_at": "2026-10-08T14:30:00Z", "note": "Two cases dented."})

xos goods-receipts create --data '{"purchase_order_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","received_at":"2026-10-08T14:30:00Z","note":"Two cases dented."}'