Create a goods receipt

Módulo Procurement

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.

Requiere la capacidad procurement.receipt.write.
Alcances de OAuth: procurement.
Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: GoodsReceiptCreate

goodsReceipts.create: GoodsReceiptCreate
Campo	Tipo	Obligatorio	Descripción
purchase_order_id	string (uuid)	Sí	Identifier of the purchase order.
received_at	string (date-time)	No	When the goods arrived.
note	string \| null	No	Condition or exceptions noted.Restricciones: length 1 to 20000

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

Respuesta 201: GoodsReceipt

goodsReceipts.create: GoodsReceipt
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the goods receipt.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
purchase_order_id	string (uuid)	Sí	Identifier of the purchase order.
received_at	string (date-time)	Sí	When the goods arrived.
received_by	string (uuid) \| null	Sí	Identifier of the receiver.
note	string \| null	Sí	Condition or exceptions noted.Restricciones: 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."
}

Ejemplos de código

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."}'