Commit an inventory revaluation

Operation ID: commitInventoryRevaluation

Group: Inventory › Inventory Revaluations

Open in the interactive reference

POST /inventory/inventory-revaluations/{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 inventory revaluation and creates its journal entry. The commit writes the cost adjustments and revalues the inventory levels. The journal entry records the difference in value. documentStatus becomes 'COMMITTED'.

Only a draft can be committed. The whole revaluation is checked first. If any check fails, the error lists every problem and nothing is written.

The revaluation must have lines. Batch quantities and serials must match their lines, and a costing element type must be set.

totalRevaluationAmount in the response is the total change in stock value, negative for a write-down.

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 revaluation you want to commit.

Response

200 Success

Under data (commitInventoryRevaluationOutput):

Field Type Required Description
id string yes The unique identifier for the revaluation. Example: "8e4b17c0-5d92-4a63-b0f7-1c8e35a029d4".
documentStatus string yes The status the revaluation is now in, read back from the document. Possible values: 'DRAFT', 'COMMITTED', 'CANCELLED'. Example: "COMMITTED".
journalEntryId string no The unique identifier for the journal entry the commit wrote. Absent when the posting reported none. See id on GET accounting/journal-entries/:id. Example: "3a91c74e-6b05-4d28-91f6-8c2e70a5d413".
totalRevaluationAmount decimal no What the document moved on the balance sheet, in the revaluation's currency. Negative for a write-down. Example: "-450".
warnings array<string> yes Non-fatal advisories from the posting. An empty array on a clean run. The commit succeeded regardless of what is listed here. Example: []. 
{
  "data": {
    "id": "8e4b17c0-5d92-4a63-b0f7-1c8e35a029d4",
    "documentStatus": "COMMITTED",
    "journalEntryId": "3a91c74e-6b05-4d28-91f6-8c2e70a5d413",
    "totalRevaluationAmount": "-450",
    "warnings": []
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Response headers

Errors

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

Statuses