Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Body

application/json

A landed cost draft: its charges and the receipts they are split across when it is posted.

reference
string
required

The reference that names the landed cost, up to 64 characters.

Maximum string length: 64
basis
enum<string>
required

How the charges are split across the receipts: quantity, value or weight. Weight comes from each item's weight in kilograms.

Available options:
quantity,
value,
weight
charges
object[]
required

The charges, from 1 to 10.

Required array length: 1 - 10 elements
receipts
string<uuid>[]
required

The IDs of the stock movements that received the goods, from 1 to 20, each only once. Each must bring stock in and not be reversed. Transfers, moves, status changes, reversals and cost movements can't be used.

Required array length: 1 - 20 elements

The ID of one receiving stock movement.

note
string | null

A note kept with the landed cost, up to 1000 characters.

Maximum string length: 1000

Response

LandedCostResource

data
LandedCostResource · object
required

A landed cost document: charges such as freight and duty, split across the receipts they belong to.