TRANXACT.AI Help

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.

Type REST10 operationsBase path /api/scm/customs-declarationsPublished as /api/v1/customs-declarations

Download specification (OpenAPI 3.1) Screen: Customs Declarations

Overview

PackageSupply Chain
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 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.
Tablescm.customs_declarations · 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

10 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/scm/customs-declarationsList customs declarations

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",
      "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

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",
  "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.

FieldTypeRequiredDescription
forwarding_shipment_iduuidNoShipment
freight_order_iduuidNoFreight order
declaration_typetextNoType
customs_officetextNoCustoms office
countrytextNoCountry
entry_notextNoEntry number
mrntextNoMovement reference number
broker_nametextNoBroker
broker_supplier_iduuidNoBroker (supplier)
declared_valuenumericNoDeclared value
currencytextNoCurrency
exchange_ratenumericNoExchange rate
customs_valuenumericNoCustoms value
duty_amountnumericNoDuty
vat_amountnumericNoVAT
excise_amountnumericNoExcise
other_chargesnumericNoOther charges
total_payablenumericNoTotal payable
submitted_attimestamp with time zoneNoSubmitted
cleared_attimestamp with time zoneNoCleared
inspection_requiredbooleanNoInspection required
inspection_typetextNoInspection type
hold_reasontextNoHeld because — Where a clearance actually stalls, in one field.
notestextNoNotes

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

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
forwarding_shipment_iduuidNoShipment
freight_order_iduuidNoFreight order
declaration_typetextNoType
customs_officetextNoCustoms office
countrytextNoCountry
entry_notextNoEntry number
mrntextNoMovement reference number
broker_nametextNoBroker
broker_supplier_iduuidNoBroker (supplier)
declared_valuenumericNoDeclared value
currencytextNoCurrency
exchange_ratenumericNoExchange rate
customs_valuenumericNoCustoms value
duty_amountnumericNoDuty
vat_amountnumericNoVAT
excise_amountnumericNoExcise
other_chargesnumericNoOther charges
total_payablenumericNoTotal payable
submitted_attimestamp with time zoneNoSubmitted
cleared_attimestamp with time zoneNoCleared
inspection_requiredbooleanNoInspection required
inspection_typetextNoInspection type
hold_reasontextNoHeld because — Where a clearance actually stalls, in one field.
notestextNoNotes

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

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/scm/customs-declarations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/customs-declarations/{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/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

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/scm/customs-declarations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/customs-declarations/{parentId}/linesLines

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/scm/customs-declarations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/scm/customs-declarations/{parentId}/lines/{lineId}Lines

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

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

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
declaration_notextread onlyDeclaration no
forwarding_shipment_iduuidread, writeShipment
freight_order_iduuidread, writeFreight order
declaration_typetextread, writeType
customs_officetextread, writeCustoms office
countrytextread, writeCountry
entry_notextread, writeEntry number
mrntextread, writeMovement reference number
broker_nametextread, writeBroker
broker_supplier_iduuidread, writeBroker (supplier)
declared_valuenumericread, writeDeclared value
currencytextread, writeCurrency
exchange_ratenumericread, writeExchange rate
customs_valuenumericread, writeCustoms value
duty_amountnumericread, writeDuty
vat_amountnumericread, writeVAT
excise_amountnumericread, writeExcise
other_chargesnumericread, writeOther charges
total_payablenumericread, writeTotal payable
submitted_attimestamp with time zoneread, writeSubmitted
cleared_attimestamp with time zoneread, writeCleared
inspection_requiredbooleanread, writeInspection required
inspection_typetextread, writeInspection type
hold_reasontextread, writeHeld because — Where a clearance actually stalls, in one field.
statustextread onlyStatus
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
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
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by

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 Supply Chain › Customs Declarations 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.