Create Landed Cost Item

POST /inventory/landed-cost-items

Group: Inventory › Landed Cost Items · Operation ID: createLandedCostItem

Creates a landed cost item. The item or account it selects on must not already be configured.

Configures a charge as a landed cost item. From now on, approved vendor bill lines matching this row's selector may be capitalized onto received stock.

Name a selector. itemId catches a charge billed as a service item, and accountId catches one coded straight to an account. At least one is required. The underlying record allows a row with neither, and such a row would match nothing ever after.

One selector, one row. Configuring the same item or account twice is refused with DUPLICATE, because two matching rows would give one vendor bill line two allocation modes, and which one won would depend on query order. Change the existing row instead.

The response is the new landed cost item's id. Read it back with GET inventory/landed-cost-items/:id.

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.

Request body

Required, application/json: createLandedCostItemInput.

Field Type Required Description
itemId string no The service item to select on, a freight, handling or insurance item, not the goods themselves. Required unless accountId is given, and both may be given. See id on GET inventory/items/:id.
accountId string no The GL account to select on. Required unless itemId is given, and both may be given. See id on GET accounting/accounts/:id.
allocationMode string yes How a charge caught by this row is spread over the receipt lines it lands on. Accepted values: 'Equal', 'Quantity', 'LineTotal', 'Weight', 'Volume'. 'Weight' and 'Volume' require every item on the receipt to carry the measurement, and a missing weight, or an incomplete length, width or height, fails the allocation rather than falling back to an even split.
costingElementTypeId string no The costing element type carried onto the inventory revaluation the landed cost commit raises, so the added cost lands in the right bucket of the cost breakdown. There is no endpoint for it.
active boolean no Whether the row is in force. Defaults to true.

Example:

{
  "itemId": "3d81e07c-95a2-4f63-b1c8-27e5a94d0b36",
  "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "allocationMode": "Weight",
  "costingElementTypeId": "c4a90e21-7b35-4d18-9e02-6f13a85c7d40",
  "active": true
}

Response

200 Success

Under data (createLandedCostItemOutput):

Field Type Required Description
id string yes The unique identifier for the created landed cost item.

Response headers

Errors

Code Status
NO_SELECTOR 400
REFERENCE_NOT_FOUND 400
UNKNOWN_ALLOCATION_MODE 400
DUPLICATE 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses