Landed Costs

GET /inventory/landed-costs

Group: Inventory › Landed Costs · Operation ID: landedCosts

Returns a list of landed costs. This endpoint returns the header fields only. Use POST inventory/landed-costs/search to also read the receipts, charges and allocation.

The landed cost collection. This endpoint returns the header fields only. The receipts, the charges and the allocation lines are arrays of objects, which the collection cannot express, so read one landed cost with GET inventory/landed-costs/:id or search with POST inventory/landed-costs/search, both of which return the whole thing.

The questions about a landed cost's contents belong to the search endpoint: which landed costs cover a given receipt, draw on a given vendor bill, or touch a given item. None of them can be asked here.

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
documentNumber — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
documentStatus — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
documentDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
entityId — 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, documentNumber, documentStatus, documentDate, entityId, lastModifiedDate
Selectable: id, documentNumber, documentStatus, documentDate, entityId, entityName, notes, active, createdDate, lastModifiedDate

Response

200 Success

Under data, an array of landedCostsRow:

Field	Type	Required	Description
`id`	string	no	The unique identifier for the landed cost.
`documentNumber`	string or null	no	The landed cost number, for example 'LC-1007'. Assigned when the landed cost is created.
`documentStatus`	string or null	no	The status of the landed cost. It is DRAFT while it is being built and COMMITTED once you commit it with POST inventory/landed-costs/:id/commit.
`documentDate`	string (date) or null	no	The date of the landed cost. Format YYYY-MM-DD.
`entityId`	string or null	no	The legal entity the landed cost belongs to. It decides the functional currency that every amount is in.
`entityName`	string or null	no	The name of that legal entity.
`notes`	string or null	no	Free text on the landed cost.
`active`	boolean or null	no	Whether the record is active.
`createdDate`	string (date-time) or null	no	The date and time the landed cost was created, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
`lastModifiedDate`	string (date-time) or null	no	The date and time the landed cost 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