Commit a landed cost

Operation ID: commitLandedCost

Group: Inventory › Landed Costs

Open in the interactive reference

POST /inventory/landed-costs/{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 landed cost. The commit does these steps in one request:

  1. It checks that the landed cost has at least one receipt and one charge, that its receipts are still committed, and that no charge uses more than is left on its vendor bill line. If the check finds problems, the commit stops, creates no inventory revaluations, and returns all of the problems together.
  2. It creates inventory revaluations for the charges, at least one for each expense account and costing element type.
  3. It commits each inventory revaluation, which changes the cost of the stock.
  4. It records how much of each charge was allocated, in allocatedAmount.
  5. It marks the landed cost as committed. The response lists the inventory revaluations in revaluationIds.

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 landed cost you want to commit. Format: UUID.

Response

200 Success

Under data (commitLandedCostOutput):

Field Type Required Description
id string yes The unique identifier for the landed cost. Format: UUID. Example: "6d18b2f0-49c7-4a35-9e81-2f0c5a7d3b64".
documentStatus string yes The status of the landed cost after the commit. It is always 'COMMITTED'. Example: "COMMITTED".
totalChargeAmount decimal no The total of the selected charges, in the landed cost's currency. Example: "240".
revaluationIds array<string> yes The unique identifiers of the inventory revaluations that the commit created. Format: UUID. See id on GET inventory/inventory-revaluations/:id (getInventoryRevaluation). Example: ["f0a25c71-8d43-4e96-b2c8-51730e9a4d62"].
warnings array<string> yes Warnings from the inventory revaluations that the commit created. An empty array when there are none. The landed cost is committed even when there are warnings. Example: []. 
{
  "data": {
    "id": "6d18b2f0-49c7-4a35-9e81-2f0c5a7d3b64",
    "documentStatus": "COMMITTED",
    "totalChargeAmount": "240",
    "revaluationIds": [
      "f0a25c71-8d43-4e96-b2c8-51730e9a4d62"
    ],
    "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