Returns a list of landed cost items.

GET /inventory/landed-cost-items

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

The landed cost item collection, everything configured as capitalizable.

Read this before building a landed cost. GET inventory/landed-costs/vendor-bill-lines returns only the charges that match a row here, so an empty collection explains an empty selector.

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`.

Query surface

id — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
itemId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
itemCode — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
accountId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
allocationMode — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
costingElementTypeId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
active — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
lastModifiedDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
Orderable: id, itemCode, accountNumber, allocationMode, active, lastModifiedDate
Selectable: id, itemId, itemCode, itemName, accountId, accountNumber, accountName, allocationMode, costingElementTypeId, costingElementTypeCode, costingElementTypeName, active, createdDate, lastModifiedDate

Response

200 Success

Under data, an array of landedCostItemsRow:

Field	Type	Required	Description
`id`	string	no	The unique identifier for the landed cost item.
`itemId`	string or null	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 or null	no	The short code of that item.
`itemName`	string or null	no	The name of that item.
`accountId`	string or null	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 or null	no	The number of that account.
`accountName`	string or null	no	The name of that account.
`allocationMode`	string or null	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 or null	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 or null	no	The code of that costing element type.
`costingElementTypeName`	string or null	no	The name of that costing element type.
`active`	boolean or null	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) or null	no	The date and time the row was created, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
`lastModifiedDate`	string (date-time) or null	no	The date and time the row last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Statuses

400 — Invalid request or business failure
401 — Missing or invalid access token
403 — Not authorized
404 — Not found
429 — Too many requests
500 — Internal server error