Commit Receipt

POST /inventory/receipts/{id}/commit

Group: Inventory › Receipts · Operation ID: commitReceipt

Commits the receipt with the given identifier, bringing the stock in and posting what is owed.

Commits one draft receipt: it posts the inventory transactions that bring the stock in and the accrual for what is now owed to the vendor. This is the step that moves stock and money. Before it, the receipt is a draft that can be edited or deleted. After it, neither. Only Inventory lines produce inventory transactions. Service and Expense lines go straight to the accrual. A committed receipt is corrected with a purchase return or a credit, not by editing it. Checks that the platform runs here, such as the warehouse accepting receipts, tracking rows adding up, and account determination resolving, arrive as POSTING_REJECTED with the platform's own message.

Open in the interactive reference

Parameters

Name	In	Type	Required	Description
`Api-Version`	header	`"v1"`	yes	The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version `v1`.
`Idempotency-Key`	header	string	no	An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with `400 IDEMPOTENCY_NOT_SUPPORTED` rather than silently ignored.
`id`	path	string	yes	The unique identifier for the receipt to commit.

Response

200 Success

Under data (commitReceiptOutput):

Field	Type	Required	Description
`id`	string	yes	The unique identifier for the receipt.
`documentStatus`	string	yes	The status of the receipt after committing.
`journalEntryId`	string	no	The journal entry the commit posted, where it posted one.
`warnings`	array of string	yes	Non-fatal advisories from the commit. An empty array on a clean run. The commit succeeded regardless of what is listed here.

Response headers

Idempotency-Replayed — Present and true only when this response replays a previously stored one for the same Idempotency-Key, rather than reflecting a live execution. Absent on a live response - never sent as false.

Errors

Code	Status
`NOT_FOUND`	400
`WRONG_STATUS`	400
`POSTING_REJECTED`	400
`IDEMPOTENCY_KEY_CONFLICT`	409
`IDEMPOTENCY_PAYLOAD_MISMATCH`	422

Statuses

400 — Invalid request or business failure. Codes: NOT_FOUND, WRONG_STATUS, POSTING_REJECTED
401 — Missing or invalid access token
403 — Not authorized
404 — Not found
409 — The Idempotency-Key is still being processed by another request.
422 — The Idempotency-Key was already used with a different request payload.
429 — Too many requests
500 — Internal server error