Get a goods receipt
Procurement module
GET/goods-receipts/{id}goodsReceipts.get
A goods receipt against a purchase order. Duplicate receipts are refused. Returns one goods receipt with its `ETag`. A goods receipt the caller may not see returns 404.
- Requires the capability procurement.po.read.
- OAuth scopes: procurement.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the goods receipt. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Response 200: 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 GET "$XOS_BASE_URL/goods-receipts/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.goodsReceipts.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.goods_receipts.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos goods-receipts get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f