1. Customs Declarations
  • Introduction
  • Getting Started
  • Authentication
  • Error Handling
  • Contact Support
  • Modaltrans API
    • Get Auth Token
      • Get Bearer Token
    • Accounting
      • Invoices
        • Retrieve an Invoice
        • List all Invoices
    • Customs
      • NCTS Declarations
        • List all NCTS Declarations
        • Retrieve an NCTS Declaration
        • Create an NCTS Declaration with XML Data
        • Create an Ens Declaration from JSON
        • Update an NCTS Declaration
        • Download an NCTS Declaration
        • List Timelines of NCTS Declaration
        • List Messages of NCTS Decalaration
      • Customs Declarations
        • List all Customs Declarations
          GET
        • Retrieve a Custom Declaration
          GET
        • Create a Customs Declaration
          POST
        • Update a Custom Declaration
          PATCH
        • Delete a Custom Declaration
          DELETE
        • Retrieve a Declaration History
          GET
        • Retrieve an MRN Status of Declaration
          GET
      • Declaration Requests
        • List all Declaration Orders
        • Retrieve a Declaration Request
        • Create a Declaration Request
        • Update a Declaration Request
        • Delete a Declaration Request
    • Logistics
      • Bookings
        • Retrieve a Booking
        • List all Bookings
        • Create a Booking
        • Update a Booking
      • Locations
        • List all Locations
        • Retrieve a Location
      • Positions
        • Update a Transport
      • Tracking
        • Available Shipping Lines
        • Retrieve a Tracking Data
        • Subscribe to Tracking
      • Shipments
        • Retrieve a Shipment
        • List All Shipments
        • Retrieve Financials of Shipment
        • List Contacts of the Shipment
        • Create a Shipment
        • Update a Shipment
    • Depot
      • Orders
        • Retrieve an Order
        • List all Orders
        • Create an Order
        • Update an Order
      • Products
        • Retrieve a Product
        • List all Products
        • Create a Product
        • Update a Product
        • List Product Stocks
      • Inventories
        • List all Inventories
    • Fleet Management
      • Drivers
        • Retrieve a Driver
        • Retrieve a Driver's Vehicle
        • List Driver Positions
        • Update a Driver
      • Vehicles
        • Retrieve a Vehicle
        • Update a Vehicle
      • Gps Service Controller
        • Create Gps Responses
      • Service Logs
        • List all Service Logs
        • Retrieve a Service Log
        • Create a Service Log
        • Delete a Service Log
        • Update a Service Log
      • Periodic Documents
        • Retrieve a Periodic Document
        • Update a Periodic Document
        • Create a Periodic Document
    • CRM
      • Companies
        • List all Companies
        • Retrieve a Company
        • Create a Company
        • Update a Company
        • Delete a Company
    • Timelines
      • Retrieve a Timeline
      • List Timelines
      • Create a Timeline
    • S3 Files
      • List all S3Files
      • Create an S3File
      • Delete an S3File
    • Notifications
      • List all Notifications
      • Update a Notification Status
    • User Details
      • List User Details
      • Update User Details
  1. Customs Declarations

Retrieve a Custom Declaration

Testing Env
https://demo.modaltrans.com
Testing Env
https://demo.modaltrans.com
GET
/api/v1/customs_declarations/{id}
Retrieves a Customs Declaration by its transaction ID.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
id
integer 
required
Transaction ID of the Customs Declaration you want to retrieve.
Example:
195602

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://demo.modaltrans.com/api/v1/customs_declarations/195602'

Responses

🟢200OK
application/json
Body
array of:
id
integer 
required
ID of the customs declaration
reference
string 
required
Reference number of the customs declaration
doc_date
string 
required
Date of the document in YYYY-MM-DD format
status
string 
required
Status of the customs declaration
doc_type
string 
required
Type of document for the customs declaration
declaration_type
string 
required
Type of customs declaration
procedure_type
string 
required
Type of procedure used in the customs declaration
commercial_ref
string 
required
Commercial reference number
ducr
string 
required
Declaration UCR
mucr
string 
required
MUCR/Inventory UCN
csp_code
string 
required
Customs Service Provider (CSP) code
ducr_part
string 
required
Part of the DUCR if applicable
declarant_id
integer 
required
ID of the declarant
declarant_eori
string 
required
EORI number of the declarant
declarant_name
string 
required
Name of the declarant
declarant_address
string 
required
Address of the declarant
declarant_city_name
string 
required
City of the declarant
declarant_country_id
string 
required
Country ID of the declarant
declarant_postcode
string 
required
Post code of the declarant
declarant_rep
string 
required
Representative of the declarant
export_country_id
string 
required
Country ID of the export country
consignor_id
integer 
required
ID of the consignor
consignor_eori
string 
required
EORI number of the consignor
consignor_name
string 
required
Name of the consignor
consignor_address
string 
required
Address of the consignor
consignor_city_name
string 
required
City of the consignor
consignor_country_id
string 
required
Country ID of the consignor
consignor_postcode
string 
required
Postal code of the consignor
import_country_id
string 
required
Country ID of the import country
consignee_id
integer 
required
ID of the consignee
consignee_eori
string 
required
EORI number of the consignee
consignee_name
string 
required
Name of the consignee
consignee_address
string 
required
Address of the consignee
consignee_city_name
string 
required
City name of the consignee
consignee_country_id
string 
required
Country ID of the consignee
consignee_postcode
string 
required
Post code of the consignee
invoice_amount
string 
required
Invoice Amount
invoice_curr
string 
required
Currency of the invoice amount
origin_country_id
string 
required
Country ID of the origin country
customs_office_id
integer 
required
ID of the customs office
goods_location
string 
required
Customs Sub Place
goods_country_id
string 
required
Country ID customs sub place
cap_indicator
string 
required
CAP (Common Indicator
border_transport_type
string 
required
Type of transport at the border
border_vehicle_code
string 
required
Code/Plate Number of the border vehicle
border_vehicle_type
string 
required
Type of the border vehicle
border_vehicle_coun
string 
required
Country of the border vehicle
inland_transport_type
string 
required
Type of inland transport
inland_vehicle_code
string 
required
Code/Plate Number of the inland vehicle
inland_vehicle_coun
string 
required
Country of the inland vehicle
itinerary_countries
string 
required
Countries on the route
container_no
string 
required
Number of the container
seal_no
string 
required
Number of the seal
gvms_interested
boolean 
required
Indicates if the gvms completed
freight_amount
string 
required
Freight cost
freight_curr
string 
required
Currency of the freight cost
payment_method
string 
required
Method of payment
interna_remarks
string 
required
Internal remarks for the declaration
carrier_id
integer 
required
ID of the carrier
carrier_eori
string 
required
EORI number of the carrier
carrier_name
string 
required
Name of the carrier
carrier_address
string 
required
Address of the carrier
carrier_city_name
string 
required
City name of the carrier
carrier_country_id
string 
required
Country ID of the carrier
carrier_postcode
string 
required
Post code of the carrier
goods_count
integer 
required
Total count of goods
total_packages
integer 
required
Total number of packages
total_weight
number 
required
Total weight of the goods
lrn
string 
required
LRN Number
mrn
string 
required
MRN Number
mrn_date
string 
required
Date of the MRN
guid
string 
required
Declaration GUID
loading_id
integer 
required
ID of the loading point
tax_calc_status
string 
required
Status of the tax calculation
patron_id
integer 
required
ID of the patron
user_id
integer 
required
ID of the user
source_type
string 
required
Type of entry for the declaration
approved_at
string 
required
Approval timestamp for the declaration
approver_id
integer 
required
ID of the approver
access_token
string 
required
Access token for the declaration
declaration_version
integer 
required
Version number of the declaration
error_msg
string 
required
Error message
notes
string 
required
Additional notes for the declaration
trashed
boolean 
required
Indicates if the declaration is marked as trashed
created_at
string 
required
Timestamp when the declaration was created
updated_at
string 
required
Timestamp when the declaration was last updated
entry_number
string 
required
Entry number for the declaration
entry_date
string 
required
Entry date for the declaration
epu_code
string 
required
EPU code of the declaration
person_in_charge
string 
required
Person in charge of the declaration
stats_amount
string 
required
Statistical amount for the declaration
stats_curr
string 
required
Currency of the statistical amount
ancillary_charges
string 
required
Ancillary charges
warehouse_id
integer 
required
ID of the warehouse
registered_eori
integer 
required
Registered EORI number
contractor_eori
integer 
required
Contractor EORI number
inland_arrival_place
string 
required
Place of inland arrival
inland_departure_place
string 
required
Place of inland departure
premises_code
string 
required
Code of the premises
premises_name
string 
required
Name of the premises
first_dan_type
string 
required
First deferment type
first_dan_no
string 
required
First deferment number
second_dan_type
string 
required
Second deferment type
second_dan_no
string 
required
Second deferment number
insurance_amount
string 
required
Amount for insurance
other_amounts
string 
required
Other amounts
shed_code
string 
required
Code of the shed
airport_id
integer 
required
ID of the airport
apportment_indicator
string 
required
Freight Apportionment
premises_id
integer 
required
ID of the premises
ics_code
string 
required
ICS code
soe_code
string 
required
SOE code
roe_code
string 
required
ROE code
total_customs_amount
string 
required
Total customs amount
total_payable_duty
string 
required
Total payable duty
deferred_revenue
string 
required
Deferred revenue
immediate_revenue
string 
required
Immediate revenue
curr_rate
string 
required
Currency rate
amendment_reason
string 
required
Reason for amendment
supervising_office_id
integer 
required
ID of the supervising office
total_gross_weight
string 
required
Total gross weight of the goods
total_net_weight
string 
required
Total net weight of the goods
multiple_consignor
boolean 
required
Indicates if there are multiple consignors
multiple_consignee
boolean 
required
Indicates if there are multiple consignees
airfreight_cost
string 
required
Cost of airfreight
insurance_curr
string 
required
Currency of the insurance amount
insurance_curr_rate
number 
required
Currency rate for insurance
other_amounts_curr
string 
required
Currency of other amounts
other_amounts_curr_rate
number 
required
Currency rate for other amounts
vat_adjustment
string 
required
VAT adjustment amount
vat_adjustment_curr
string 
required
Currency of the VAT adjustment amount
discount_amount
string 
required
Discount amount
discount_curr
string 
required
Currency of the discount amount
discount_rate
string 
required
Rate of discount
total_payable_vat
string 
required
Total payable VAT
total_vat_value
string 
required
Total value of VAT
sum_of_revenue
string 
required
Sum of revenue
local_invoice_amount
string 
required
Local invoice amount
badge_id
integer 
required
ID of the badge
cargo_report_id
integer 
required
ID of the cargo report
query_msg
string 
required
Query message
freight_local_amount
number 
required
Local amount for freight
freight_curr_rate
number 
required
Currency rate for freight
insurance_local_amount
number 
required
Local amount for insurance
insurance_local_curr_rate
number 
required
Currency rate for local insurance
other_local_amount
number 
required
Local amount for other costs
other_local_curr_rate
number 
required
Currency rate for other local costs
vat_adjustment_local_amount
number 
required
Local amount for VAT adjustment
vat_adjustment_curr_rate
number 
required
Currency rate for VAT adjustment
fec_codes
string 
required
FEC codes
ern
string 
required
ERN
doc_mode
string 
required
Mode of the document
gvms_manifesto_id
integer 
required
ID of the GVMS Declaration
ducr_from
string 
required
DUCR source
is_template
boolean 
required
Indicates if the declaration is a template
entry_time
string 
required
Time of entry
warehouse_type
string 
required
Type of warehouse
dti_code
string 
required
DTI code
tenant_id
integer 
required
ID of the tenant
printable_dti_codes
string 
required
Printable DTI codes
bank_code
string 
required
Code of the bank
bank_ref_id
string 
required
Reference ID of the bank
dti_transaction_amount
number 
required
Transaction amount for DTI
service_code
string 
required
Code of the service
incoterm
string 
required
Incoterm used in the declaration
incoterm_location
string 
required
Location of the incoterm
trader_ref
string 
required
Trader reference
arrival_transport_type
string 
required
Type of Arrival transport
total_payable_other
string 
required
Total payable amount for other costs
s3files_count
integer 
required
Count of S3 files
clearance_entry_date
string 
required
Date of clearance entry
clearance_entry_time
string 
required
Time of clearance entry
payment_ref
string 
required
Payment reference
arrival_notification_date
string 
required
Date of arrival notification
search_key
string 
required
Search key for the declaration
additional_infos
string 
required
Additional information for the declaration
consignment_id
integer 
required
ID of the consignment
previous_mrn_no
string 
required
Previous MRN number
previous_mrn_date
string 
required
Date of the previous MRN
branch_id
integer 
required
ID of the branch
goods_arrival_date
string 
required
Date of goods arrival
is_dummy
boolean 
required
Indicates if the declaration is a dummy
owner_company_id
integer 
required
ID of the owner company
exlude_consignor
boolean 
required
Indicates if the consignor is excluded
exlude_consignee
boolean 
required
Indicates if the consignee is excluded
departure_date
string 
required
Date of departure
team_id
integer 
required
ID of the team
customer_id
integer 
required
ID of the customer
financial_status
string 
required
Financial status of the declaration
closed_date
string 
required
Date when the declaration was closed
debit_invoice_nos
string 
required
Debit invoice number
credit_invoice_nos
string 
required
Credit invoice number
notification_emails
string 
required
Notification emails for the declaration
Example
[
    {
        "id": 0,
        "reference": "string",
        "doc_date": "string",
        "status": "string",
        "doc_type": "string",
        "declaration_type": "string",
        "procedure_type": "string",
        "commercial_ref": "string",
        "ducr": "string",
        "mucr": "string",
        "csp_code": "string",
        "ducr_part": "string",
        "declarant_id": 0,
        "declarant_eori": "string",
        "declarant_name": "string",
        "declarant_address": "string",
        "declarant_city_name": "string",
        "declarant_country_id": "string",
        "declarant_postcode": "string",
        "declarant_rep": "string",
        "export_country_id": "string",
        "consignor_id": 0,
        "consignor_eori": "string",
        "consignor_name": "string",
        "consignor_address": "string",
        "consignor_city_name": "string",
        "consignor_country_id": "string",
        "consignor_postcode": "string",
        "import_country_id": "string",
        "consignee_id": 0,
        "consignee_eori": "string",
        "consignee_name": "string",
        "consignee_address": "string",
        "consignee_city_name": "string",
        "consignee_country_id": "string",
        "consignee_postcode": "string",
        "invoice_amount": "string",
        "invoice_curr": "string",
        "origin_country_id": "string",
        "customs_office_id": 0,
        "goods_location": "string",
        "goods_country_id": "string",
        "cap_indicator": "string",
        "border_transport_type": "string",
        "border_vehicle_code": "string",
        "border_vehicle_type": "string",
        "border_vehicle_coun": "string",
        "inland_transport_type": "string",
        "inland_vehicle_code": "string",
        "inland_vehicle_coun": "string",
        "itinerary_countries": "string",
        "container_no": "string",
        "seal_no": "string",
        "gvms_interested": true,
        "freight_amount": "string",
        "freight_curr": "string",
        "payment_method": "string",
        "interna_remarks": "string",
        "carrier_id": 0,
        "carrier_eori": "string",
        "carrier_name": "string",
        "carrier_address": "string",
        "carrier_city_name": "string",
        "carrier_country_id": "string",
        "carrier_postcode": "string",
        "goods_count": 0,
        "total_packages": 0,
        "total_weight": 0,
        "lrn": "string",
        "mrn": "string",
        "mrn_date": "string",
        "guid": "string",
        "loading_id": 0,
        "tax_calc_status": "string",
        "patron_id": 0,
        "user_id": 0,
        "source_type": "string",
        "approved_at": "string",
        "approver_id": 0,
        "access_token": "string",
        "declaration_version": 0,
        "error_msg": "string",
        "notes": "string",
        "trashed": true,
        "created_at": "string",
        "updated_at": "string",
        "entry_number": "string",
        "entry_date": "string",
        "epu_code": "string",
        "person_in_charge": "string",
        "stats_amount": "string",
        "stats_curr": "string",
        "ancillary_charges": "string",
        "warehouse_id": 0,
        "registered_eori": 0,
        "contractor_eori": 0,
        "inland_arrival_place": "string",
        "inland_departure_place": "string",
        "premises_code": "string",
        "premises_name": "string",
        "first_dan_type": "string",
        "first_dan_no": "string",
        "second_dan_type": "string",
        "second_dan_no": "string",
        "insurance_amount": "string",
        "other_amounts": "string",
        "shed_code": "string",
        "airport_id": 0,
        "apportment_indicator": "string",
        "premises_id": 0,
        "ics_code": "string",
        "soe_code": "string",
        "roe_code": "string",
        "total_customs_amount": "string",
        "total_payable_duty": "string",
        "deferred_revenue": "string",
        "immediate_revenue": "string",
        "curr_rate": "string",
        "amendment_reason": "string",
        "supervising_office_id": 0,
        "total_gross_weight": "string",
        "total_net_weight": "string",
        "multiple_consignor": true,
        "multiple_consignee": true,
        "airfreight_cost": "string",
        "insurance_curr": "string",
        "insurance_curr_rate": 0,
        "other_amounts_curr": "string",
        "other_amounts_curr_rate": 0,
        "vat_adjustment": "string",
        "vat_adjustment_curr": "string",
        "discount_amount": "string",
        "discount_curr": "string",
        "discount_rate": "string",
        "total_payable_vat": "string",
        "total_vat_value": "string",
        "sum_of_revenue": "string",
        "local_invoice_amount": "string",
        "badge_id": 0,
        "cargo_report_id": 0,
        "query_msg": "string",
        "freight_local_amount": 0,
        "freight_curr_rate": 0,
        "insurance_local_amount": 0,
        "insurance_local_curr_rate": 0,
        "other_local_amount": 0,
        "other_local_curr_rate": 0,
        "vat_adjustment_local_amount": 0,
        "vat_adjustment_curr_rate": 0,
        "fec_codes": "string",
        "ern": "string",
        "doc_mode": "string",
        "gvms_manifesto_id": 0,
        "ducr_from": "string",
        "is_template": true,
        "entry_time": "string",
        "warehouse_type": "string",
        "dti_code": "string",
        "tenant_id": 0,
        "printable_dti_codes": "string",
        "bank_code": "string",
        "bank_ref_id": "string",
        "dti_transaction_amount": 0,
        "service_code": "string",
        "incoterm": "string",
        "incoterm_location": "string",
        "trader_ref": "string",
        "arrival_transport_type": "string",
        "total_payable_other": "string",
        "s3files_count": 0,
        "clearance_entry_date": "string",
        "clearance_entry_time": "string",
        "payment_ref": "string",
        "arrival_notification_date": "string",
        "search_key": "string",
        "additional_infos": "string",
        "consignment_id": 0,
        "previous_mrn_no": "string",
        "previous_mrn_date": "string",
        "branch_id": 0,
        "goods_arrival_date": "string",
        "is_dummy": true,
        "owner_company_id": 0,
        "exlude_consignor": true,
        "exlude_consignee": true,
        "departure_date": "string",
        "team_id": 0,
        "customer_id": 0,
        "financial_status": "string",
        "closed_date": "string",
        "debit_invoice_nos": "string",
        "credit_invoice_nos": "string",
        "notification_emails": "string"
    }
]
🟠400Bad Request
🟠403Forbidden
🟠404Record Not Found
Modified at 2025-03-25 10:49:03
Previous
List all Customs Declarations
Next
Create a Customs Declaration
Built with