JSON Element API Endpoint & JSON functions
|
Endpoint |
| /erpservices/Documents/CreateAtrDocument |
| 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. |
| doNotSaveWhenInvalid | {boolean} | True/false | A boolean indicating whether not save the item when it is invalid for submission. (default = false, so by default invalid data will be saved). When “true,” it is especially recommended to be able to process/display feedback from the link in the ERP package, which is the reason why the data was not saved. |
| doPrintWhenValid | {boolean} | True/false | A value indicating whether to print the declaration when it is valid (default = false). |
| displayStamp | {boolean} | True/false | When generating a document (when 'DoPrintWhenValid' is set to 'true'), the 'DisplayStamp' property will\n determine whether the generated document will contain a stamp or not. |
Stap 1: Voorbereiden
| Nr | JSON Element | Type | Spec | Description |
| 1 | dossierNumber | {string} | {1-30} | Dossiernaam in Shipment (Order number, Delivery number, transport number, etc). |
| 2 | documentNumber | {string} | {1-20} | The unique number printed on the ATR |
| displayStamp | {boolean} | True/false | When generating a document (when 'DoPrintWhenValid' is set to 'true'), the 'DisplayStamp' property will determine whether the generated document will contain a stamp or not |
Stap 2: Afzender
| Nr | JSON Element | Type | Spec | Description |
| 1 | Consignor. addressDescription | {string} | {0-305} | A description of the address. Maximum 6 lines with 50 characters per line separated by \\n. Section 1 of the A.TR document |
| 2 | Consignor. authorisedExporterAuthorisation | {string} | {0-70} | The authorised exporter authorisation. Displayed on the stamp in section 12 of the A.TR document. |
Stap 3: Geadresseerde
| Nr | JSON Element | Type | Spec | Description |
| 1 | Consignee. addressDescription | {string} | {1-305} | "A description of the address. Maximum 6 lines with 50 characters per line separated by \\n. Section 2 of the A.TR document. |
Stap 4: Goederen
| Nr | JSON Element goodsItemRows | Type | Spec | Description |
| 1 | goodsItems. description | {string} | {0-120} | The description of the goodsitem. {Max 25 lines} |
| 2 | goodsItems. quantity | {string} | {1-100} | The quantity of the goodsitem. {Max 25 lines} |
Stap 5: Algemeen
| Nr | JSON Element | Type | Spec | Description |
| 1 | transportDocumentNumber | {string} | {0-20} | To be printed unique document number |
| 2 | transportDocumentDate | (date-time) | Example: 2024-10- 08T14:20:1 7.1575061+ 00:00 | Document Date (section 13 on document) |
| 3 | countryOfExportation | {string} | {0-30} | Country of Exportation (section 5 on document) |
| 4 | transportDetails | {string} | {0-407} | Data related to transportation (Section 7 on document) Maximum 7 lines with 50 characters per line separated by \\n. Section 1 of the A.TR document.) |
| 5 | remarks | {string} | {0-407} | Remarks (Section 8 on document) Maximum 7 lines with 50 characters per line separated by \\n. Section 1 of the A.TR document |
| 6 | signingLocation | {string} | {0-21} | Signing location (section 13 on document) |
| 7 | signingDate | (date-time) | Example: 2024-10- 08T14:20:1 7.1575061+ 00:00 | Signing date (section 13 on document) |
| 8 | signature | {string} | Signature (section 13 on document) Maximum 2 lines with 32 characters per line separated by \\n. Section 1 of the A.TR document |