Skip to content

Create a receipt line

Procurement module

POST/receipt-linesreceiptLines.create

A received quantity against a PO line. Creates a receipt line. 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: ReceiptLineCreate

receiptLines.create: ReceiptLineCreate
FieldTypeRequiredDescription
goods_receipt_idstring (uuid)YesIdentifier of the goods receipt.
po_line_idstring (uuid)YesIdentifier of the PO line.
quantity_receivednumberYesQuantity received.
{
  "goods_receipt_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "po_line_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "quantity_received": 24
}

Response 201: ReceiptLine

receiptLines.create: ReceiptLine
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the receipt line.
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.
goods_receipt_idstring (uuid)YesIdentifier of the goods receipt.
po_line_idstring (uuid)YesIdentifier of the PO line.
quantity_receivednumberYesQuantity received.
{
  "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",
  "goods_receipt_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "po_line_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "quantity_received": 24
}

Code samples

curl -X POST "$XOS_BASE_URL/receipt-lines" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"goods_receipt_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","po_line_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","quantity_received":24}'
const { data } = await xos.receiptLines.create({
    "goods_receipt_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "po_line_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "quantity_received": 24
  });
response = xos.receipt_lines.create({"goods_receipt_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "po_line_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "quantity_received": 24})
xos receipt-lines create --data '{"goods_receipt_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","po_line_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","quantity_received":24}'