Skip to main content

Receipt

A record of stock received against a purchase order. API keys only see committed receipts: stock that has been received and whose stock update in Shopify has finished. A receipt whose stock update failed stays uncommitted, and is not returned, until it is retried and succeeds.

uuidstring

The receipt's unique identifier. Use it in the receipt paths.

Example: 3f2a9c1e-2b3d-4c5e-8f6a-1b2c3d4e5f60
namestringnullable

The receipt's name in Bookkeep.

Example: Receipt 1
statusstring

Always committed for receipts returned to an API key.

Example: committed
received_atstring<date-time>nullable

When the stock was received.

Example: 2026-09-17T14:02:11.000Z
invoice_numberstringnullable

The supplier invoice number entered when the stock was received.

Example: INV-88213
voided_atstring<date-time>nullable

When the receipt was voided. Voided receipts are not returned to API keys, so this is null.

Example: null
void_reasonstringnullable

Why the receipt was voided. Null for the same reason as voided_at.

Example: null
created_atstring<date-time>
Example: 2026-09-17T14:02:11.000Z
updated_atstring<date-time>
Example: 2026-09-17T14:05:43.000Z
purchase_order object

Present only when include=purchase_order was requested.

uuidstring
Example: 9a1e3b7c-1e3d-4a3f-9f2e-9c6b6e2a2b11
sequence_idintegernullable

The purchase order number the merchant sees in Bookkeep.

Example: 1042
namestringnullable
Example: null
reference_numberstringnullable
Example: FALL-RESTOCK
destination_location_idstringnullable

The Shopify location the stock was delivered to (gid://shopify/Location/<id>).

Example: gid://shopify/Location/73986408603
destination_location_namestringnullable
Example: Main Warehouse
statusstring

The purchase order's status. See the Purchase Orders section for the values.

Example: received
Receipt
{
"uuid": "3f2a9c1e-2b3d-4c5e-8f6a-1b2c3d4e5f60",
"name": "Receipt 1",
"status": "committed",
"received_at": "2026-09-17T14:02:11.000Z",
"invoice_number": "INV-88213",
"voided_at": null,
"void_reason": null,
"created_at": "2026-09-17T14:02:11.000Z",
"updated_at": "2026-09-17T14:05:43.000Z",
"purchase_order": {
"uuid": "9a1e3b7c-1e3d-4a3f-9f2e-9c6b6e2a2b11",
"sequence_id": 1042,
"name": null,
"reference_number": "FALL-RESTOCK",
"destination_location_id": "gid://shopify/Location/73986408603",
"destination_location_name": "Main Warehouse",
"status": "received"
}
}