TRANXACT.AI Help

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.

Type REST23 operationsBase path /api/accounting/landed-cost-vouchersPublished as /api/v1/landed-cost-vouchers

Download specification (OpenAPI 3.1) Screen: Landed Cost Vouchers

Overview

PackageAccounting
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tableacct.landed_cost_vouchers · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
voucher_datedateNoVoucher date — The date the journal is posted on.
voucher_kindtextNoKind — Actual: a charge somebody has billed. Estimated: accrued before the bill arrives.
Allowed: actual estimated
estimate_voucher_iduuidNoTrues up the estimate — The estimate this actual charge replaces. Its accrual is released and only the difference reaches stock.
supplier_iduuidNoBilled by (supplier)
carrier_iduuidNoCarrier
currencytextNoCurrency — Of the charges, when they do not say. Empty is the company’s own.
notestextNoNotes

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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
voucher_datedateNoVoucher date — The date the journal is posted on.
voucher_kindtextNoKind — Actual: a charge somebody has billed. Estimated: accrued before the bill arrives.
Allowed: actual estimated
estimate_voucher_iduuidNoTrues up the estimate — The estimate this actual charge replaces. Its accrual is released and only the difference reaches stock.
supplier_iduuidNoBilled by (supplier)
carrier_iduuidNoCarrier
currencytextNoCurrency — Of the charges, when they do not say. Empty is the company’s own.
notestextNoNotes

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

NameTypeDescription
idstring (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, post

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/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

NameTypeDescription
idstring (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_id

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/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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, date

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/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

NameTypeDescription
idstring (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, withLines

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/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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
voucher_notextread onlyVoucher no
voucher_datedateread, writeVoucher date — The date the journal is posted on.
voucher_kindtextread, writeKind — Actual: a charge somebody has billed. Estimated: accrued before the bill arrives.
Allowed: actual estimated
estimate_voucher_iduuidread, writeTrues up the estimate — The estimate this actual charge replaces. Its accrual is released and only the difference reaches stock.
supplier_iduuidread, writeBilled by (supplier)
carrier_iduuidread, writeCarrier
currencytextread, writeCurrency — Of the charges, when they do not say. Empty is the company’s own.
statustextread onlyStatus
total_chargesnumericread onlyTotal charges
to_inventorynumericread onlyTo inventory
to_cogsnumericread onlyTo cogs
to_expensenumericread onlyTo expense
accrual_releasednumericread onlyAccrual released
journal_iduuidread onlyJournal id
reversal_journal_iduuidread onlyReversal journal id
posted_attimestamp with time zoneread onlyPosted at
posted_byuuidread onlyPosted by
reversed_attimestamp with time zoneread onlyReversed at
reversal_reasontextread onlyReversal reason
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
estimated_receipt_iduuidread onlyEstimated receipt id
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Accounting › Landed Cost Vouchers for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.