Accounting · Landed Cost
Landed Cost Vouchers
Freight, duty, insurance and other charges spread onto the goods receipts they belong to. Add the receipts, enter the charges, preview the spread, then post: the share on stock still on hand raises its cost, the share on stock already issued goes to cost of goods sold.
/api/accounting/landed-cost-vouchersPublished as /api/v1/landed-cost-vouchersDownload specification (OpenAPI 3.1) Screen: Landed Cost Vouchers
Overview
| Package | Accounting |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold Accounting › Landed Cost Vouchers on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | acct.landed_cost_vouchers · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
23 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/accounting/landed-cost-vouchersList landed cost vouchers
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"voucher_no": "VOU-000001",
"voucher_date": "2026-10-30",
"voucher_kind": "actual",
"estimate_voucher_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"currency": "USD",
"status": "draft",
"total_charges": "1250.00",
"to_inventory": "1250.00",
"to_cogs": "1250.00",
"to_expense": "1250.00"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/accounting/landed-cost-vouchers?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/landed-cost-vouchers/{id}Read one landed cost vouchers
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"voucher_no": "VOU-000001",
"voucher_date": "2026-10-30",
"voucher_kind": "actual",
"estimate_voucher_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"currency": "USD",
"status": "draft",
"total_charges": "1250.00",
"to_inventory": "1250.00",
"to_cogs": "1250.00",
"to_expense": "1250.00"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/accounting/landed-cost-vouchers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/landed-cost-vouchersCreate a landed cost vouchers
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
voucher_date | date | No | Voucher date — The date the journal is posted on. |
voucher_kind | text | No | Kind — Actual: a charge somebody has billed. Estimated: accrued before the bill arrives. Allowed: actual estimated |
estimate_voucher_id | uuid | No | Trues up the estimate — The estimate this actual charge replaces. Its accrual is released and only the difference reaches stock. |
supplier_id | uuid | No | Billed by (supplier) |
carrier_id | uuid | No | Carrier |
currency | text | No | Currency — Of the charges, when they do not say. Empty is the company’s own. |
notes | text | No | Notes |
Sample body
{
"voucher_date": "2026-10-30",
"voucher_kind": "actual",
"estimate_voucher_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"voucher_no": "VOU-000001",
"voucher_date": "2026-10-30",
"voucher_kind": "actual",
"estimate_voucher_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"currency": "USD",
"status": "draft",
"total_charges": "1250.00",
"to_inventory": "1250.00",
"to_cogs": "1250.00",
"to_expense": "1250.00"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/landed-cost-vouchers" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"voucher_date":"2026-10-30","voucher_kind":"actual","estimate_voucher_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","supplier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/accounting/landed-cost-vouchers/{id}Change a landed cost vouchers
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
voucher_date | date | No | Voucher date — The date the journal is posted on. |
voucher_kind | text | No | Kind — Actual: a charge somebody has billed. Estimated: accrued before the bill arrives. Allowed: actual estimated |
estimate_voucher_id | uuid | No | Trues up the estimate — The estimate this actual charge replaces. Its accrual is released and only the difference reaches stock. |
supplier_id | uuid | No | Billed by (supplier) |
carrier_id | uuid | No | Carrier |
currency | text | No | Currency — Of the charges, when they do not say. Empty is the company’s own. |
notes | text | No | Notes |
Sample body
{
"voucher_date": "2026-10-30",
"voucher_kind": "actual"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"voucher_no": "VOU-000001",
"voucher_date": "2026-10-30",
"voucher_kind": "actual",
"estimate_voucher_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"currency": "USD",
"status": "draft",
"total_charges": "1250.00",
"to_inventory": "1250.00",
"to_cogs": "1250.00",
"to_expense": "1250.00"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/accounting/landed-cost-vouchers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"voucher_date":"2026-10-30","voucher_kind":"actual"}'DELETE/api/accounting/landed-cost-vouchers/{id}Delete a landed cost vouchers
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/accounting/landed-cost-vouchers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/landed-cost-vouchers/estimateEstimate
Request body
The keys this action reads (* = required; "one of" lists the only values):
receiptId*, receipt_id, postResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/landed-cost-vouchers/estimate" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"receiptId":"value","receipt_id":"value","post":"value"}'POST/api/accounting/landed-cost-vouchers/{id}/add-receiptAdd receipt
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
receiptId*, receipt_idResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/landed-cost-vouchers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/add-receipt" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"receiptId":"value","receipt_id":"value"}'POST/api/accounting/landed-cost-vouchers/{id}/previewPreview
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/landed-cost-vouchers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/preview" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/landed-cost-vouchers/{id}/postPost
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/landed-cost-vouchers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/post" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/landed-cost-vouchers/{id}/reverseReverse
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
reason, dateResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/landed-cost-vouchers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/reverse" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"reason":"value","date":"value"}'POST/api/accounting/landed-cost-vouchers/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/landed-cost-vouchers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'GET/api/accounting/landed-cost-vouchers/{parentId}/targetsTargets
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/accounting/landed-cost-vouchers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/targets" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/landed-cost-vouchers/{parentId}/targetsTargets
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/landed-cost-vouchers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/targets" \
-H "Authorization: Bearer $TOKEN"PUT/api/accounting/landed-cost-vouchers/{parentId}/targets/{lineId}Targets
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/accounting/landed-cost-vouchers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/targets/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/accounting/landed-cost-vouchers/{parentId}/targets/{lineId}Targets
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/accounting/landed-cost-vouchers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/targets/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/landed-cost-vouchers/{parentId}/chargesCharges
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/accounting/landed-cost-vouchers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/charges" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/landed-cost-vouchers/{parentId}/chargesCharges
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/landed-cost-vouchers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/charges" \
-H "Authorization: Bearer $TOKEN"PUT/api/accounting/landed-cost-vouchers/{parentId}/charges/{lineId}Charges
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/accounting/landed-cost-vouchers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/charges/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/accounting/landed-cost-vouchers/{parentId}/charges/{lineId}Charges
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/accounting/landed-cost-vouchers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/charges/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/accounting/landed-cost-vouchers/{parentId}/allocationAllocation
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/accounting/landed-cost-vouchers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/allocation" \
-H "Authorization: Bearer $TOKEN"POST/api/accounting/landed-cost-vouchers/{parentId}/allocationAllocation
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/accounting/landed-cost-vouchers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/allocation" \
-H "Authorization: Bearer $TOKEN"PUT/api/accounting/landed-cost-vouchers/{parentId}/allocation/{lineId}Allocation
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/accounting/landed-cost-vouchers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/allocation/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/accounting/landed-cost-vouchers/{parentId}/allocation/{lineId}Allocation
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/accounting/landed-cost-vouchers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/allocation/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a landed cost vouchers, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
voucher_no | text | read only | Voucher no |
voucher_date | date | read, write | Voucher date — The date the journal is posted on. |
voucher_kind | text | read, write | Kind — Actual: a charge somebody has billed. Estimated: accrued before the bill arrives. Allowed: actual estimated |
estimate_voucher_id | uuid | read, write | Trues up the estimate — The estimate this actual charge replaces. Its accrual is released and only the difference reaches stock. |
supplier_id | uuid | read, write | Billed by (supplier) |
carrier_id | uuid | read, write | Carrier |
currency | text | read, write | Currency — Of the charges, when they do not say. Empty is the company’s own. |
status | text | read only | Status |
total_charges | numeric | read only | Total charges |
to_inventory | numeric | read only | To inventory |
to_cogs | numeric | read only | To cogs |
to_expense | numeric | read only | To expense |
accrual_released | numeric | read only | Accrual released |
journal_id | uuid | read only | Journal id |
reversal_journal_id | uuid | read only | Reversal journal id |
posted_at | timestamp with time zone | read only | Posted at |
posted_by | uuid | read only | Posted by |
reversed_at | timestamp with time zone | read only | Reversed at |
reversal_reason | text | read only | Reversal reason |
notes | text | read, write | Notes |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
estimated_receipt_id | uuid | read only | Estimated receipt id |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Accounting › Landed Cost Vouchers for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.