API Endpoint & JSON functions
|
Endpoint |
| /erpservices/Documents/CreateCmrDocument |
| 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). |
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 CMR |
| 3 | displayLayout | {boolean} | True/false | When generating a document (when 'DoPrintWhenValid' is set to 'true'), the 'DisplayLayout' property will determine whether the generated document will contain a layout or not. When the layout is not included, the generated document will only contain the textual data. |
| 4 | numberOfPages | {integer} | {int32} | Gets or sets the number of pages which will be printed. |
| 5 | displayDocumentNu mber | {boolean} | {true/false} | Gets or sets the display document number. |
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 CMR 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 CMR document. |
Stap 4: Vervoerder
| Nr | JSON Element | Type | Spec | Description |
| 1 | transporter addressDescription | {string} | {1-305} | Consignee (Section 16 on CMR document) Max 6 lines of 50 characters per line |
Stap 5: Opvolgende vervoerder
| Nr | JSON Element | Type | Spec | Description |
| 1 | succeedingTransporter addressDescription | {string} | {1-305} | A description of the address. Maximum 6 lines with 50 characters per line separated by \\n. Section 2 of the CMR document. |
Stap 6: Goederen
| Nr | JSON Element | Type | Spec | Description |
| 1 | columnWidth | {int32} | {} | "A table cell can span multiple columns. The ColumnWidth determines how many columns a cell spans. There are 7 columns, you can combine boxes, but no more than 7 columns in total may be filled. Give these empty columns the value “columnWidth”: 0. |
| 1 | goodsItemRows rowNumber | Integer | Max 15 | Article rows on documents Maximum of 15 lines |
| 2 | CmrGoodsItemRow. brandsAndNumbers. Tekst | {string} | {1-100} | Marks and Numbers |
| 3 | CmrGoodsItemRow. brandsAndNumbers. packagingQuantity | {string} | {1-100} | Quantity of packaging Field is string to allow freedom of input |
| 4 | packagingType | {string} | {1-100} | Package Type (boxes, cartons, pallets, etc) |
| 5 | origin | {string} | {1-100} | ‘Aard der goederen’ or origin of goods |
| 6 | statisticalNumber | {string} | {1-100} | Commodity / HS Code |
| 7 | brutoWeight | {string} | {1-100} | Grossweight Field is string to allow freedom of input |
| 8 | volume | {string} | {1-100} | Volume Field is string to allow freedom of input |
Stap 7: Algemeen
| Nr | JSON Element goodsItemRows |
Type | Spec | Description |
| 1 | addedDocuments | {string} | {1-203} | Added documents (for example EX-A , invoice, packinglist, etc) section 5 on CMR document Max 4 lines of 50 characters per line |
| 2 | commentsConsignor | {string} | {1-407} | section 18 on CMR document Max 8 lines of 50 characters per line |
| 3 | instructionsConsignor | {string} | {1-500} | section 13 on CMR document Max 10 lines of 50 characters per line |
| 4 | specialAgreements | {string} | {1-407} | section 19 on CMR document Max 8 lines of 50 characters per line |
| 5 |
incoTermsCode |
{string} | {3} | Incoterm code (CIF, CFR, DAP, EXW, etc) |
| 6 | incoTermsLocation | {string} | {1-35} | Location of incoterm |
| 7 | Refund. Currency |
{string} | {1-100} | Currency code (EUR, USD, etc) |
| 8 | Refund. Amount |
{string} | {1-100} | Redund amount (in specified currency) |
| 9 | signatureConsignor | {string} | {1-197} | section 22 on CMR document Max 6 lines of 32 characters per line |
| 10 | signatureConsignee | {string} | {1-197} | section 23 on CMR document Max 6 lines of 32 characters per line |
| 11 | signingLocation | {string} | {1-30} | section 21 on CMR document |
| 12 | signingDate | {date} | Example: 2024-09-10 | section 21 on CMR document |
Stap 8: Locaties
| Nr | JSON Element goodsItemRows |
Type | Spec | Description |
| 1 | locationOfDeliveryOfGoods | {string} | {1-203} | The location where the goods are delivered. Maximum of 4 lines with 50 characters per line\nseparated by \\n. Section 3 of the CMR document. Max 4 lines of 50 characters per line |
| 2 | locationOfTakingOverGoods | {string} | {1-407} | The location where the goods are taken over. Maximum of 4 lines with 50 characters per line\nseparated by \\n. Section 4 of the CMR document. Max 4 lines of 50 characters per line |
| 3 | dateOfTakingOverGoods | {date} | Example: 2024-09-10 | The date of taking over goods. Section 4 of the CMR document. |