Returns the landed cost item with the given identifier.

GET /inventory/landed-cost-items/{id}

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

Returns one landed cost item whole. A row names a selector, itemId, accountId, or both, and an allocation mode. The selector is what an approved vendor bill line is matched against to decide whether it may be capitalized onto received stock.

This is the same item schema the collection and the search endpoint return.

The codes and names beside each id, itemCode, accountNumber, costingElementTypeName, are resolved at read time and are never stored on the row, so they follow the record they came from.

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.
id path string yes The unique identifier for the landed cost item to return.

Response

200 Success

Under data (getLandedCostItemOutput):

Field Type Required Description
id string yes The unique identifier for the landed cost item.
itemId string no The service item a vendor bill line must reference to be caught by this row. Absent when the row selects by account instead. See id on GET inventory/items/:id.
itemCode string no The short code of that item.
itemName string no The name of that item.
accountId string no The GL account a vendor bill line must post to to be caught by this row. Absent when the row selects by item instead. See id on GET accounting/accounts/:id.
accountNumber string no The number of that account.
accountName string no The name of that account.
allocationMode string no How a charge caught by this row is spread over the receipt lines it lands on. Possible values: 'Equal', 'Quantity', 'LineTotal', 'Weight', 'Volume'. 'Weight' and 'Volume' require every item on the receipt to carry the measurement, and a missing one fails the allocation rather than falling back to an even split. A landed cost may override this per vendor bill line.
costingElementTypeId string no The costing element type carried onto the inventory revaluation the landed cost commit raises. Absent when the row sets none. There is no endpoint for it.
costingElementTypeCode string no The code of that costing element type.
costingElementTypeName string no The name of that costing element type.
active boolean no Whether the row is in force. When false, the charges it used to catch are no longer eligible, and existing landed costs keep theirs.
createdDate string (date-time) no The date and time the row was created, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
lastModifiedDate string (date-time) no The date and time the row last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Errors

Code Status
NOT_FOUND 400

Statuses