Supply Chain · Freight Forwarding
Customs Declarations
The customs entry, held as its own document because it has its own number, its own dates, its own duty and its own way of going wrong.
/api/scm/customs-declarationsPublished as /api/v1/customs-declarationsDownload specification (OpenAPI 3.1) Screen: Customs Declarations
Overview
| Package | Supply Chain |
|---|---|
| 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 Supply Chain › Customs Declarations 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 | scm.customs_declarations · 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
10 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/scm/customs-declarationsList customs declarations
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",
"declaration_no": "DEC-000001",
"forwarding_shipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"freight_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"declaration_type": "text",
"customs_office": "text",
"country": "US",
"entry_no": "ENT-000001",
"mrn": "text",
"broker_name": "Example",
"broker_supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"declared_value": "1250.00",
"currency": "USD"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/customs-declarations?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/customs-declarations/{id}Read one customs declaration
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",
"declaration_no": "DEC-000001",
"forwarding_shipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"freight_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"declaration_type": "text",
"customs_office": "text",
"country": "US",
"entry_no": "ENT-000001",
"mrn": "text",
"broker_name": "Example",
"broker_supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"declared_value": "1250.00",
"currency": "USD"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/customs-declarations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/customs-declarationsCreate a customs declaration
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
forwarding_shipment_id | uuid | No | Shipment |
freight_order_id | uuid | No | Freight order |
declaration_type | text | No | Type |
customs_office | text | No | Customs office |
country | text | No | Country |
entry_no | text | No | Entry number |
mrn | text | No | Movement reference number |
broker_name | text | No | Broker |
broker_supplier_id | uuid | No | Broker (supplier) |
declared_value | numeric | No | Declared value |
currency | text | No | Currency |
exchange_rate | numeric | No | Exchange rate |
customs_value | numeric | No | Customs value |
duty_amount | numeric | No | Duty |
vat_amount | numeric | No | VAT |
excise_amount | numeric | No | Excise |
other_charges | numeric | No | Other charges |
total_payable | numeric | No | Total payable |
submitted_at | timestamp with time zone | No | Submitted |
cleared_at | timestamp with time zone | No | Cleared |
inspection_required | boolean | No | Inspection required |
inspection_type | text | No | Inspection type |
hold_reason | text | No | Held because — Where a clearance actually stalls, in one field. |
notes | text | No | Notes |
Sample body
{
"forwarding_shipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"freight_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"declaration_type": "text",
"customs_office": "text"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"declaration_no": "DEC-000001",
"forwarding_shipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"freight_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"declaration_type": "text",
"customs_office": "text",
"country": "US",
"entry_no": "ENT-000001",
"mrn": "text",
"broker_name": "Example",
"broker_supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"declared_value": "1250.00",
"currency": "USD"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/customs-declarations" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"forwarding_shipment_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","freight_order_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","declaration_type":"text","customs_office":"text"}'PUT/api/scm/customs-declarations/{id}Change a customs declaration
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 |
|---|---|---|---|
forwarding_shipment_id | uuid | No | Shipment |
freight_order_id | uuid | No | Freight order |
declaration_type | text | No | Type |
customs_office | text | No | Customs office |
country | text | No | Country |
entry_no | text | No | Entry number |
mrn | text | No | Movement reference number |
broker_name | text | No | Broker |
broker_supplier_id | uuid | No | Broker (supplier) |
declared_value | numeric | No | Declared value |
currency | text | No | Currency |
exchange_rate | numeric | No | Exchange rate |
customs_value | numeric | No | Customs value |
duty_amount | numeric | No | Duty |
vat_amount | numeric | No | VAT |
excise_amount | numeric | No | Excise |
other_charges | numeric | No | Other charges |
total_payable | numeric | No | Total payable |
submitted_at | timestamp with time zone | No | Submitted |
cleared_at | timestamp with time zone | No | Cleared |
inspection_required | boolean | No | Inspection required |
inspection_type | text | No | Inspection type |
hold_reason | text | No | Held because — Where a clearance actually stalls, in one field. |
notes | text | No | Notes |
Sample body
{
"forwarding_shipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"freight_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"declaration_no": "DEC-000001",
"forwarding_shipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"freight_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"declaration_type": "text",
"customs_office": "text",
"country": "US",
"entry_no": "ENT-000001",
"mrn": "text",
"broker_name": "Example",
"broker_supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"declared_value": "1250.00",
"currency": "USD"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/customs-declarations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"forwarding_shipment_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","freight_order_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/scm/customs-declarations/{id}Delete a customs declaration
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/scm/customs-declarations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/customs-declarations/{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/scm/customs-declarations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'GET/api/scm/customs-declarations/{parentId}/linesLines
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/scm/customs-declarations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/customs-declarations/{parentId}/linesLines
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/scm/customs-declarations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
-H "Authorization: Bearer $TOKEN"PUT/api/scm/customs-declarations/{parentId}/lines/{lineId}Lines
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/scm/customs-declarations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/scm/customs-declarations/{parentId}/lines/{lineId}Lines
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/scm/customs-declarations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a customs declaration, 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 |
declaration_no | text | read only | Declaration no |
forwarding_shipment_id | uuid | read, write | Shipment |
freight_order_id | uuid | read, write | Freight order |
declaration_type | text | read, write | Type |
customs_office | text | read, write | Customs office |
country | text | read, write | Country |
entry_no | text | read, write | Entry number |
mrn | text | read, write | Movement reference number |
broker_name | text | read, write | Broker |
broker_supplier_id | uuid | read, write | Broker (supplier) |
declared_value | numeric | read, write | Declared value |
currency | text | read, write | Currency |
exchange_rate | numeric | read, write | Exchange rate |
customs_value | numeric | read, write | Customs value |
duty_amount | numeric | read, write | Duty |
vat_amount | numeric | read, write | VAT |
excise_amount | numeric | read, write | Excise |
other_charges | numeric | read, write | Other charges |
total_payable | numeric | read, write | Total payable |
submitted_at | timestamp with time zone | read, write | Submitted |
cleared_at | timestamp with time zone | read, write | Cleared |
inspection_required | boolean | read, write | Inspection required |
inspection_type | text | read, write | Inspection type |
hold_reason | text | read, write | Held because — Where a clearance actually stalls, in one field. |
status | text | read only | Status |
notes | text | read, write | Notes |
created_at | timestamp with time zone | read only | Created at |
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 |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
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 Supply Chain › Customs Declarations 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.