Skip to main content

Transaction JSON


1. Transaction Header

JSON PathBusiness NameDescriptionMandatoryAllowed ValuesExample
sourceApplicationSource SystemUnique identifier of the source applicationYesATLAS, CTAATLAS
terminalTerminalUnique identifier of the terminalYes-ETT
referenceMovement ReferenceUnique local reference for the declaration requestYes-PR_ACTI_AC10007466
displayReferenceDisplay ReferenceDisplay value of the referenceNo-AC 007 466
taxCountryCustoms CountryCountry where tax is dueYesCMS Country CodesNL
cmsReferenceCMS ReferenceReference to an existing CMS transactionConditional-UUID
overrideCheckAlertOverride IndicatorOverride validation warningsNoY, NN
userIdUser IDUser invoking the transaction serviceNo-USER001
presentationDateTimePresentation Date TimeTransaction timestamp in UTCYesISO-86012026-05-30T20:59:17Z
normalProcedureNormal ProcedureApply Normal Customs ProcedureNoY, NN


2. Customs Product


customsProduct.customsValue.invoice

JSON PathDescriptionMandatory
referenceInvoice referenceConditional
amountInvoice valueConditional
currencyInvoice currencyConditional
incotermCodeApplicable IncotermConditional
elementsToInclude.freightCostsAmountFreight costsConditional
elementsToInclude.insuranceCostsAmountInsurance costsConditional


Allowed Incoterms

Value
CIF
FOB


Allowed Currencies

Value
USD
EUR


customsProduct.customsValue.marketValue

JSON PathDescription
amountMarket value of goods
currencyCurrency


customsProduct.commodity

JSON PathDescription
code10-digit TARIC code
descriptionCommercial product description
referenceExternal product reference


3. Activities

JSON PathDescriptionMandatory
activities.referenceActivity referenceYes
activities.displayReferenceDisplay referenceNo
activities.activityTypeActivity typeYes
activities.serviceTypeService typeConditional
activities.nominationReferenceNomination referenceConditional
activities.relatedReferenceRelated activity referenceConditional
activities.executedByExternalCustomsBrokerExternal broker indicatorNo


Activity Types

Allowed Values
MOVEMENT
SERVICE


Service Types

Allowed Values
IMPORT
REBRAND
RENAME
DEPARTURE
ADMINISTRATIVE_STOCK_TRANSFER
TAKE_IN
SHIFTING
COMMODITY_CODE_CORRECTION


4. Medium

JSON PathDescription
medium.typeSource / destination side of activity


Allowed Values

ValueMeaning
FROM_STORAGE_UNITSource storage location
TO_STORAGE_UNITDestination storage location
IN_STORAGE_UNITActivity within same storage unit


5. Storage Unit

JSON PathDescription
storageUnit.storageUnitReferenceStorage Unit Identifier


6. Visit Information

JSON PathDescription
visit.visitReferenceVisit identifier
visit.transportMeansReferenceVessel name / Truck registration
visit.transportMeansTypeCodeTransport means type
visit.transportMeansNationalityCodeNationality of transport means
visit.changedTransportArrangementChanged arrangement indicator


Transport Means Types

Value
RA
RO
VES
BAR
PI
TANK


7. Tank Information

JSON PathDescription
tank.tankNameTank name


8. Parcel Information

JSON PathDescription
parcels.referenceUnique parcel identifier
parcels.parentReferenceParent parcel
parcels.firstTimeArrivalFirst arrival under license
parcels.inwardProcessingFlagSubject to inward processing
parcels.commercialPolicyMeasureFlagCommercial Policy Measures applicable
parcels.exceptionDocumentException document
customsStatusCustoms status
unNumberDangerous Goods UN number


Flag Values

Value
Y
N


Customs Status Values

Value
BONDED
EXCISE
DOMESTIC


9. Parties


Customer

JSON Path
parties.customer.reference
parties.customer.name
parties.customer.language
parties.customer.eori
parties.customer.vatNumber
parties.customer.cbsCode
parties.customer.address.streetName
parties.customer.address.houseNumber
parties.customer.address.postalCode
parties.customer.address.cityName
parties.customer.address.countryCode


Consignee

JSON Path
parties.consignee.reference
parties.consignee.name
parties.consignee.language
parties.consignee.eori
parties.consignee.exciseNumber
parties.consignee.registeredConsigneeFlag
parties.consignee.monthlyStatementApproval
parties.consignee.cbsCode
parties.consignee.address.*


Consignor

JSON Path
parties.consignor.reference
parties.consignor.name
parties.consignor.language
parties.consignor.eori
parties.consignor.exciseNumber
parties.consignor.cbsCode
parties.consignor.address.*


Place Of Dispatch Trader

JSON Path
parties.placeOfDispatchTrader.reference
parties.placeOfDispatchTrader.name
parties.placeOfDispatchTrader.language
parties.placeOfDispatchTrader.eori
parties.placeOfDispatchTrader.referenceOfTaxWarehouse
parties.placeOfDispatchTrader.locationName
parties.placeOfDispatchTrader.cbsCode
parties.placeOfDispatchTrader.address.*


Delivery Place Trader

JSON Path
parties.deliveryPlaceTrader.reference
parties.deliveryPlaceTrader.name
parties.deliveryPlaceTrader.language
parties.deliveryPlaceTrader.eori
parties.deliveryPlaceTrader.referenceOfTaxWarehouse
parties.deliveryPlaceTrader.locationName
parties.deliveryPlaceTrader.cbsCode
parties.deliveryPlaceTrader.address.*


Exporter

JSON Path
parties.exporter.reference
parties.exporter.name
parties.exporter.language
parties.exporter.eori
parties.exporter.cbsCode
parties.exporter.address.*


Seller

JSON Path
parties.seller.reference
parties.seller.name
parties.seller.language
parties.seller.eori
parties.seller.cbsCode
parties.seller.address.*


10. Goods Location

JSON PathDescription
location.languageLocation language
location.address.streetNameStreet
location.address.houseNumberHouse number
location.address.postalCodePostal code
location.address.cityNameCity
location.address.countryCodeCountry
location.cbsCodeCBS code
location.locationNameLocation name


11. Country Information

JSON PathDescription
destinationCountryCodeDestination country
dispatchCountryCodeDispatch country


Exit Office

JSON PathDescription
exitOffice.referenceCMS reference
exitOffice.nameExit office name
exitOffice.idCustoms office code (CL294)


Origin

JSON PathDescription
origin.typeOrigin type
origin.countryCodeOrigin country


Origin Types

Value
PREFERENTIAL
NON-PREFERENTIAL


12. Commodity

JSON PathDescription
commodity.code10-digit TARIC code
commodity.descriptionCommercial description
commodity.referenceProduct reference


13. Cargo Documents

JSON PathDescription
cargoDocuments.typeDocument type
cargoDocuments.referenceDocument reference


Supported Document Types

Value
MANIFEST_INFO
B_L
AGRIM
AT_R
EUR_1
EUR_MED
INVOICE
ORIG_DECL
INF3
STAT_ON_ORIG
T2L_F
T2L
E_AD
T1
T2
EVIDENCE


14. Quantities

JSON PathDescription
quantities.typePLANNED or ACTUAL
quantities.kgvKilograms in vacuum
quantities.kgaKilograms in air
quantities.gmvKilograms in vacuum (decimal)
quantities.gmaKilograms in air (decimal)
quantities.l15Litres at 15°C
quantities.l20Litres at 20°C
quantities.ml5Litres (decimal precision)
quantities.alcPercAlcohol percentage


Quantity Types

Value
PLANNED
ACTUAL


15. Density

JSON PathDescription
density.valueDensity value
density.uomDensity reference basis


Density UOM

Value
D15
D1A


16. Compliance-Critical Fields

FieldCompliance Impact
commodity.codeDuty determination, restrictions and TARIC measures
customsStatusCustoms treatment
destinationCountryCodeDeclaration routing and reporting
dispatchCountryCodeOrigin and trade statistics
origin.countryCodePreference and duty calculation
customsValueCustoms valuation
parties.customer.eoriLegal declarant identification
cargoDocumentsSupporting evidence
quantities.*Tax and customs calculations
firstTimeArrivalImport declaration treatment
inwardProcessingFlagSpecial procedure determination


Structure Transaction JSON


Transaction
├── sourceApplication
├── terminal
├── reference
├── displayReference
├── taxCountry
├── cmsReference
├── overrideCheckAlert
├── userId
├── presentationDateTime
├── normalProcedure
├── customsProduct
│   ├── customsValue
│   │   ├── invoice
│   │   │   ├── reference
│   │   │   ├── amount
│   │   │   ├── currency
│   │   │   ├── incotermCode
│   │   │   └── elementsToInclude
│   │   │       ├── freightCostsAmount
│   │   │       └── insuranceCostsAmount
│   │   │
│   │   └── marketValue
│   │       ├── amount
│   │       └── currency
│   │
│   └── commodity
│       ├── code
│       ├── description
│       └── reference
└── activities[]
    ├── reference
    ├── displayReference
    ├── activityType
    ├── serviceType
    ├── nominationReference
    ├── relatedReference
    ├── executedByExternalCustomsBroker
    │
    └── medium[]
        ├── type
        │
        ├── storageUnit
        │   ├── storageUnitReference
        │   │
        │   ├── visit
        │   │   ├── visitReference
        │   │   ├── transportMeansReference
        │   │   ├── transportMeansTypeCode
        │   │   ├── transportMeansNationalityCode
        │   │   └── changedTransportArrangement
        │   │
        │   └── tank
        │       └── tankName
        │
        └── parcels[]
            ├── reference
            ├── parentReference
            ├── firstTimeArrival
            ├── inwardProcessingFlag
            ├── commercialPolicyMeasureFlag
            ├── exceptionDocument
            │
            ├── parties
            │   │
            │   ├── customer
            │   │   ├── reference
            │   │   ├── name
            │   │   ├── language
            │   │   ├── eori
            │   │   ├── vatNumber
            │   │   ├── cbsCode
            │   │   └── address
            │   │       ├── cityName
            │   │       ├── countryCode
            │   │       ├── streetName
            │   │       ├── postalCode
            │   │       └── houseNumber
            │   │
            │   ├── consignee
            │   │   ├── reference
            │   │   ├── name
            │   │   ├── language
            │   │   ├── eori
            │   │   ├── exciseNumber
            │   │   ├── registeredConsigneeFlag
            │   │   ├── monthlyStatementApproval
            │   │   ├── cbsCode
            │   │   └── address
            │   │       ├── cityName
            │   │       ├── countryCode
            │   │       ├── streetName
            │   │       ├── postalCode
            │   │       └── houseNumber
            │   │
            │   ├── consignor
            │   │   ├── reference
            │   │   ├── name
            │   │   ├── language
            │   │   ├── eori
            │   │   ├── exciseNumber
            │   │   ├── cbsCode
            │   │   └── address
            │   │       ├── cityName
            │   │       ├── countryCode
            │   │       ├── streetName
            │   │       ├── postalCode
            │   │       └── houseNumber
            │   │
            │   ├── placeOfDispatchTrader
            │   │   ├── reference
            │   │   ├── name
            │   │   ├── language
            │   │   ├── eori
            │   │   ├── referenceOfTaxWarehouse
            │   │   ├── locationName
            │   │   ├── cbsCode
            │   │   └── address
            │   │       ├── cityName
            │   │       ├── countryCode
            │   │       ├── streetName
            │   │       ├── postalCode
            │   │       └── houseNumber
            │   │
            │   ├── deliveryPlaceTrader
            │   │   ├── reference
            │   │   ├── name
            │   │   ├── language
            │   │   ├── eori
            │   │   ├── referenceOfTaxWarehouse
            │   │   ├── locationName
            │   │   ├── cbsCode
            │   │   └── address
            │   │       ├── cityName
            │   │       ├── countryCode
            │   │       ├── streetName
            │   │       ├── postalCode
            │   │       └── houseNumber
            │   │
            │   ├── exporter
            │   │   ├── reference
            │   │   ├── name
            │   │   ├── language
            │   │   ├── eori
            │   │   ├── cbsCode
            │   │   └── address
            │   │       ├── cityName
            │   │       ├── countryCode
            │   │       ├── streetName
            │   │       ├── postalCode
            │   │       └── houseNumber
            │   │
            │   └── seller
            │       ├── reference
            │       ├── name
            │       ├── language
            │       ├── eori
            │       ├── cbsCode
            │       └── address
            │           ├── cityName
            │           ├── countryCode
            │           ├── streetName
            │           ├── postalCode
            │           └── houseNumber
            │
            ├── location
            │   ├── language
            │   ├── address
            │   │   ├── cityName
            │   │   ├── countryCode
            │   │   ├── streetName
            │   │   ├── postalCode
            │   │   └── houseNumber
            │   ├── cbsCode
            │   └── locationName
            │
            ├── destinationCountryCode
            ├── dispatchCountryCode
            │
            ├── exitOffice
            │   ├── reference
            │   ├── name
            │   └── id
            │
            ├── origin[]
            │   ├── type
            │   └── countryCode
            │
            ├── commodity
            │   ├── code
            │   ├── description
            │   └── reference
            │
            ├── customsValue
            │   └── marketValue
            │       ├── amount
            │       └── currency
            │
            ├── customsStatus
            │
            ├── cargoDocuments[]
            │   ├── type
            │   ├── reference
            │   └── quantities[]
            │       ├── kgv
            │       ├── l15
            │       └── mtv
            │
            ├── unNumber
            │
            ├── quantities[]
            │   ├── type
            │   ├── kgv
            │   ├── kga
            │   ├── gmv
            │   ├── gma
            │   ├── l15
            │   ├── l20
            │   ├── ml5
            │   └── alcPerc
            │
            └── density
                ├── value
                └── uom

This is the consolidated hierarchy using the CMS schema as the authoritative source and includes both the transaction-level customsProduct and the parcel-level customs/commodity structures.