Commit a receipt

Operation ID: commitReceipt

Group: Inventory › Receipts

Open in the interactive reference

POST /inventory/receipts/{id}/commit

Retry-safe: A write that accepts Idempotency-Key: repeating a request with the same key replays the stored answer instead of executing twice.

Commits a draft receipt, bringing the stock in. It also creates a journal entry for the goods received but not yet invoiced by the vendor. The response gives the receipt's new status and, when a journal entry was created, its id in journalEntryId.

Only Inventory lines create inventory transactions. Service and Expense lines go only into that journal entry.

Every line's warehouse must belong to the receipt's legal entity. Otherwise the request fails with LOCATION_ENTITY_MISMATCH.

Other checks also run at commit. For example, all Inventory lines must use the same warehouse, a line received against a purchase order must not exceed that line's open quantity, account determination must find the general ledger accounts for the journal entry, and a batch- or serial-tracked line's batches or serials must add up to the line's quantity. If any of these checks fails, the request fails with POSTING_REJECTED and 'reason' gives the message.

A committed receipt can't be changed or deleted, and no endpoint cancels it. A purchase return has no endpoint. To record money back from the vendor, use POST accounting/vendor-credits.

Parameters

Name In Type Required Description
Api-Version header string · 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 of the receipt you want to commit. Every line's warehouse must belong to the receipt's legal entity, or the commit is refused.

Response

200 Success

Under data (commitReceiptOutput):

Field Type Required Description
id string yes The unique identifier for the receipt. Example: "6a1f30c9-4d82-4b57-9e60-83c25f0a71b4".
documentStatus string yes The status of the receipt after committing. Example: "COMMITTED".
journalEntryId string no The journal entry the commit posted, where it posted one. Example: "7c1b9a34-2e05-4d68-b930-5f8c6a1d2e07".
warnings array<string> yes Non-fatal advisories from the commit. An empty array on a clean run. The commit succeeded regardless of what is listed here. Example: []. 
{
  "data": {
    "id": "6a1f30c9-4d82-4b57-9e60-83c25f0a71b4",
    "documentStatus": "COMMITTED",
    "journalEntryId": "7c1b9a34-2e05-4d68-b930-5f8c6a1d2e07",
    "warnings": []
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Response headers

Errors

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

Statuses