Download - EX-R 1 article (.json) Download - Multiple seals per container file (.json) Download - Security + Authorisation on article (.json) Download - MIG1_incl_Stratech_JSON_tags (.xlsx download)
API Endpoint & JSON functions
|
Endpoint |
| /erpservices /importdossier |
| JSON Element | Type | Spec | Description |
| applicationReferenceId | {string} | {1-255} | Your application reference id. Used to communicate about this specific item. Using unique values within your system is suggested but not required. |
| DoSubmitWhenValid | {boolean} | True/false | A value indicating whether to submit the declaration when it is valid (default = false). |
| DoNotSaveWhenInvalid | {boolean} | True/false | A boolean indicating whether not save the item when it is invalid for submission. (default \n= false, so by default invalid data will be saved |
Stap 1: Aangifte 1/2
| Nr | JSON Element | Type | Spec | Description |
| 1 | Aangiftevolgnummer (FRN) | {string} | The Functional Reference Number (FRN) of the declaration (Automatically generated) | |
| 2 | DossierNumber | {string} | {1-30} | Dossiernaam in Shipment (Order number, Delivery number, transport number, etc). |
| 3 | DeclarationData.bookingReferenceNumber | {string} | {1-255} | Gets or sets the booking reference number. Should only be set for port notification |
| 4 | DeclarationData.destinationCountry | {string} | {2-2} | The destination country code, format: ISO 3166 -1 alpha -2 |
| 5 | DeclarationData.declarationSymbol | {string} | {2-2} | The declaration symbol . |
| 6 | DeclarationData.declarationType | {string} | {1-1} | Gets the type of the declaration (CL042 / Declaration/type -2nd subdivision) |
| 7 | DeclarationData.governmentProcedure.currentCode | {string} | {1-2} | The current code (CL092) |
| 8 | DeclarationData.governmentProcedure.previousCode | {string} | {1-2} | The previous code (CL093) |
| 9 | DeclarationData.governmentProcedure.specialCode | {string} | {0-3} | Sets the special code (CL102) |
| 10 | DeclarationData.Security | {string} | {1} | Gets the security details |
| 11 | DeclarationData.specificCircumstances | {string} | {0-3} | Gets or sets the specific circumstances (CL296) |
Stap 1: Aangifte 2/2 (Containers
| Nr | JSON Element | Type | Spec | Description |
| 1 | DeclarationData.isContainerShipment | {boolean} | True/False | a value indicating whether this instance is container shipment |
| 2 | DeclarationData . transportEquipment . sequenceNumber |
{integer} | {0-999} | Gets or sets the transport equipment sequence numbers |
| 3 | DeclarationData . transportEquipment . Number |
{string} | {0-17} | The containersnumbers |
| 4 | DeclarationData . transportEquipment . Seals . sequenceNumber |
{integer} | {1-9999} | Gets or sets the sequence number of Seals |
| 5 | DeclarationData . transportEquipment . Seals . Number |
{string} | {0-20} | The seals Example Multiple seals per container "transportEquipment ": [{" sequenceNumber ": 1," number ": "containernumber "," seals ": [{" n umber ": "sealnumber1"} , {" n umber ": "sealnumber2"}]}], |
Stap 2: Afzender
| Nr | JSON Element | Type | Spec | Description |
| 1 | Consignor.internalCode | {string} | {1-450} | The internal code for identifying the address in the addressbook |
Stap 3: Geadresseerde
| Nr | JSON Element goodsItemRows | Type | Spec | Description |
| Consignee.internalCode | {string} | {1-450} | The internal code for identifying the address in the addressbook (optional) | |
| 1 | Consignee.Address.name | {string} | {1-35} | The name of the Consignee |
| 2 | Consignee.Address.streetAndNumber | {string} | {1-35} | The street and number . |
| 3 | Consignee.Address.zipcode | {string} | {1-35} | The zip code. |
| 4 | Consignee.Address.City | {string} | {1-35} | The Name of the City. |
| 5 | Consignee.Address.Country.code | {string} | {2-2} | The country code. |
| 6 | Consignee.Address.Country.name | {string} | {1-35} | The Name of the country. |
| 7 | Consignee.eoriNumber . | {string} | The eori number . |
Stap 4: Vergunningen
| Nr | JSON Element | Type | Spec | Description |
| 1 | Authorisations.identification | {string} | {1-35} | The identification |
| 2 | Authorisations.type | {string} | {4-4} | The type (CL605) |
| 3 | Authorisations.description | {string} | {1-255} | The description |
Stap 5: Transport 1/2
| Nr | JSON Element | Type | Spec | Description |
| 1 | declarationData.countryOfOrigin | {string} | {2-2} | The country of origin (CL008) |
| 2 | declarationData.departureTransportMeans.transportationType | {string} | {1-1} | The type of the transportation (CL018) |
| 3 | declarationData.departureTransportMeans.identification | {string} | {0-35} | The identification . |
| 4 | declarationData.departureTransportMeans.identificationType | {string} | {2-2} | The type of the identification (CL750) |
| 5 | declarationData.departureTransportMeans.registrationNationality | {string} | {2-2} | The registration nationality (CL165) |
| 6 | declarationData.departureTransportMeans.cargoTransportMeans.identification | {string} | {0-35} | The identification |
| 7 | declarationData.departureTransportMeans.cargoTransportMeans.identification | {string} | {1-1} | The type of the transportation (CL018) |
| 8 | declarationData.borderTransportMeans.registrationNationality | {string} | {2-2} | The registration nationality (CL165) |
| 9 | declarationData.borderTransportMeans.identification | {string} | {0-35} | The identification |
| 10 | declarationData.Warehouse.type | {string} | {1-1} | The type (CL099) |
| 11 | declarationData.Warehouse.licenseNumber | {string} | {0-35} | The license number |
Stap 5: Transport 2/2
| Nr | JSON Element | Type | Spec | Description |
| 1 | declarationData.goodsLocation.type | {string} | {1-305} | The type (CL347) |
| 2 | declarationData.goodsLocation.countryCode | {string} | {2-2} | The country code (CL248) |
| 3 | declarationData.goodsLocation.postalCode | {string} | {0-17} | The postal code |
| 4 | declarationData.goodsLocation.houseNumber | {string} | {0-35} | The house number |
| 5 | declarationData.declarationOfficeCode | {string} | {8-8} | The declaration office code (CL293) |
| 6 | declarationData.exitOfficeCode . | {string} | {8-8} | The exit office code (CL194) |
| 7 | declarationData.incoTerms.incoTermsCode | {string} | {3-3} | The inco terms (CL090) |
| 8 | declarationData.incoTerms.countryCode | {string} | {2-2} | The country code (CL199) |
| 9 | declarationData.incoTerms.locationName | {string} | {1-35} | The name of the location |
| 10 | declarationData.transactionNatureCode | {string} | {2-2} | The transaction nature code (CL091) |
| 11 | declarationData.paymentMethodCode | {string} | {1} | The payment method code (CL116) |
| 12 | declarationData.transportDocuments.typeCode | {string} | {4-4} | The type code (CL754) |
| 13 | declarationData.transportDocuments.identification | {string} | {0-70} | The identification |
| 14 | declarationData.carrieridentification | {string} | {1-999} | Gets or sets the identification. If this is set, the InternalCode will be ignored. |
| 15 | countryOfRoutingItineraries.countryOfRouting | {string} | {2-2} | The code of country of routing (CL008) |
Stap 6: Artikelen (Overview)
| Nr | JSON Element | Type | Spec | Description |
| 1 | declarationData.totalGrossWeight | number | 0 - 1000000000 0000000 |
The total gross weight . |
| 2 | declarationData.totalInvoiceCurrency | {string} | {3-3} | The total invoice currency . |
| 3 | declarationData.totalInvoiceAmount | number | 0 - 1000000000 0000000 |
The total invoice amount . |
| 4 | declarationData.divergentTotalPackagesAmount | integer | int32 | Gets or sets the divergent total packages amount. This number overrides the calculated number of packages. When used this number is printed on the accompanied document, the calculated amount is sent to customs. |
Stap 6: Artikelen 1/4
| Nr | JSON Element | Type | Spec | Description |
| 1 | declarationData.goodsItems.sequenceNumber | integer | 1-999 | The sequence number starting from 1 incremented by 1 for every item. |
| 2 | declarationData.goodsItems.goodsItemType.hsCode | {string} | {8-8} | The hs code. EU Combined Nomenclature length is 8 (TSP Code) |
| 3 | declarationData.goodsItems.goodsItemType.taricSubHeading | {string} | {2-2} | The taric sub heading. (TRC Code) |
| 4 | declarationData.goodsItems.goodsItemType. additionalTaricCode1 | {string} | {4-4} | The first additional taric code. (TRA Code) |
| 5 | declarationData.goodsItems.goodsItemType.additionalTaricCode2 | {string} | {4-4} | The second additional taric code. (TRA Code) |
| 6 | declarationData.goodsItems.goodsItemType.nac | {string} | {4-4} | The nac |
| 7 | declarationData.goodsItems.goodsItemType.cusCode | {string} | {9-9} | Gets or sets the cus code |
| 8 | declarationData.goodsItems.description | {string} | {0-512} | The description of the Commodity. |
| 9 | declarationData.goodsItems.stockKeepingUnit | {string} | {0-255} | The stock keeping unit (SKU) is only used within Stratech Shipment and is not sent to Customs.It can serve as a reference to a goods item template. If a matching template is found, its values are copied to the goods item, but only for empty properties. Existing values in the goods item are never overwritten.Since consignors can have different templates for the same SKU, the selected consignor determines which template is used. |
| 10 | declarationData.goodsItems.unitedNationsCode | {string} | {4-4} | The united nations code (UNCode ) |
| 11 | declarationData.goodsItems.categoryOrPostalNumber | {string} | {0-10} | The category or postal number. |
| 12 | declarationData.goodsItems.countryOfOrigin | {string} | {2-2} | The country of origin (CL008) |
| 13 | declarationData.goodsItems.transportEquipment | {string} | {0-17} | The container number set in the declaratiodata . Example First container: "transportEquipment ": [1], |
Stap 6: Artikelen 2/4
| Nr | JSON Element | Type | Spec | Description |
| 1 | declarationData.goodsItems.Packaging.typeCode | {string} | {2-2} | The type code (CL017). |
| 2 | declarationData.goodsItems.Packaging.quantity | integer | 1-99999999 | The quantity . |
| 3 | declarationData.goodsItems.Packaging.shippingMarks | {string} | {0-512} | The shipping marks . |
| 4 | declarationData.goodsItems.GoodsMeasure.grossWeight | number | 0-10000000000000000 | The gross weight . |
| 5 | declarationData.goodsItems.GoodsMeasure.netWeight | number | 0-10000000000000000 | The net weight . |
| 6 | declarationData.goodsItems.GoodsMeasure.supplementaryQuantity | number | 0-10000000000000000 | The supplementary quantity . |
| 7 | declarationData.goodsItems.statisticalValue | number | 0-10000000000000000 | The statistical value . |
| 8 | declarationData.goodsItems.statisticalValue.code | {string} | {5-5} | The code (CL239) |
| 9 | declarationData.goodsItems.statisticalValue | {string} | {0-512} | The description . |
Stap 6: Artikelen 3/4
| Nr | JSON Element | Type | Spec | Description |
| 1 | declarationData.goodsItems.Authorisations.type | {string} | {4-4} | The type (CL605) |
| 2 | declarationData.goodsItems.Authorisations.identification | {string} | {0-35} | The identification. |
| 3 | declarationData.goodsItems.Authorisations.authorisationHolderidentification | {string} | {0-17} | The identification. |
| 4 | declarationData .goodsItems.Authorisations.description | {string} | {0-255} | The description. (For your own administration) |
| 5 | declarationData.goodsItems.previousDocuments.documentTypeCode | {string} | {4-4} | The document type code (CL214) |
| 6 | declarationData.goodsItems.previousDocuments.documentIdentifier | {string} | {0-70} | The document identifier. |
| 7 | declarationData.goodsItems.previousDocuments.declarationLineNumber | {string} | {0-99999} | The declaration line number. |
Stap 6: Artikelen 4/4
| Nr | JSON Element | Type | Spec | Description |
| 1 | declarationData.goodsItems.additionalDocuments.additionalDocumentCode | {string} | {4-4} | The additional document code (CL213) |
| 2 | declarationData.goodsItems.additionalDocuments.documentNumber | {string} | {0-70} | The document number . |
| 3 | declarationData.goodsItems.additionalDocuments.lineNumber | integer | {0-999} | The line number . |
| 4 | declarationData.goodsItems.additionalDocuments.validityDate | {string} | date-time | The validity date. |
| 5 | declarationData.goodsItems.additionalDocuments.amount | {string} | {5-5} | The code (CL239) |
| 6 | declarationData.goodsItems.additionalDocuments.Quantity | {string} | {0-512} | The description . |
| 7 | declarationData.goodsItems.additionalReferences.typeCode | {string} | {4-4} | The type code (CL380 |
| 8 | declarationData.goodsItems.additionalReferences.identification | {string} | {0-70} | The identification . |