invoice-main
Schema downloads
The JSON schema for this format can be downloaded here.
Use this link to download the strict schema, which will disallow unknown properties for as much as that is possible witin the schema language. Our internal processes simply ignore unknown properties but the strict schema can be usefull to notice typo's.
We will on occasion add new fields without notifying all recipients of the file. Therefore please do not use the strict schema for validation of files we send to you. If you want to validate our files at your end, the standard schema can be used. We will notify all recipients before doing a change in a file that would cause it to no longer match the standard schema.
root
| source |
[O] String
|
|
Source system or customer code. |
| messageId |
[O] String
|
|
Unique id for the message. |
| messageReference |
[O] String
|
|
Customer reference for the message. |
| messageType |
[O] String
|
|
Type name of the message. |
| messageRootId |
[O] String
|
|
Message id of the first message in a chain of messages. |
| timeStamp |
[O] String
|
Format: date-time
|
Date and time the message was generated. If time zone information is omitted, is UTC. |
invoices
| number |
[M] String
|
Max 12 char
|
Jan de Rijk reference for this invoice. |
| purchaseOrderNumber |
[O] String
|
|
Customer reference of the purchase order for this invoice. |
| downloadUrl |
[O] String
|
|
Url that can be used to download the image of the invoice. Access only given after specific customer request. |
| isCreditNoteForInvoiceNumber |
[O] String
|
Max 12 char
|
The invoice number of the invoice for which this is a credit note. |
| customer |
[M] Object
|
|
|
| specificationReportType |
[M] String
|
Max 20 char
Possible values:
"general"
"airCargo"
|
Relevant report for showing invoice specifications in the Jan de Rijk customer portal. |
| currencyCode |
[M] String
|
Max 3 char
|
Currency code for the invoice as per https://en.wikipedia.org/wiki/ISO_4217. |
| paymentTerm |
[M] Integer
|
|
Number of days until payment should be done. |
| invoiceDate |
[M] String
|
Format: date-time
|
Includes time zone indicator. |
| exchangeDate |
[O] String
|
Format: date-time
|
Includes time zone indicator. |
| legalEntity |
[M] Object
|
|
|
| exchangeRateFromEUR |
[M] Number
|
|
The exchange rate of the invoice in relation to Euros. Multiply this with an invoice currency amount to get Euros. |
| lines |
[M] Array of Object
|
|
|
| taxLines |
[M] Array of Object
|
|
|
| booked |
[O] Boolean
|
|
True if the invoice is to be booked in the Jan de Rijk financial system. |
| printed |
[O] Boolean
|
|
|
| manualTrigger |
[O] Boolean
|
|
|
| orders |
[O] Array of Object
|
|
|
invoices.customer
| code |
[M] String
|
Max 40 char
|
|
| number |
[M] String
|
Max 20 char
|
Jan de Rijk code for the customer. |
| name |
[O] String
|
|
|
| eanNumber |
[O] String
|
|
|
| chamberOfCommerceNumber |
[O] String
|
|
|
| dunsNumber |
[O] String
|
|
|
| website |
[O] String
|
|
|
| blocked |
[O] Boolean
|
|
|
| enabled |
[O] Boolean
|
|
|
| types |
[O] Array of String
|
|
|
| isInterCompany |
[M] Boolean
|
|
Boolean to figure out if the order belong to an intercompany. |
| address |
[O] Object
|
|
|
| financial |
[O] Object
|
|
|
| tax |
[O] Object
|
|
|
| sector |
[O] Object
|
|
|
| holdingParty |
[O] Object
|
|
|
| charter |
[O] Object
|
|
|
| contact |
[O] Object
|
|
|
invoices.customer.address
| locationCode |
[O] String
|
Max 5 char
|
Only to be used if the location is an airport, in whcih case it should be the IATA code. |
| name |
[O] String
|
Max 35 char
|
|
| name2 |
[O] String
|
Max 35 char
|
|
| name3 |
[O] String
|
Max 35 char
|
|
| line1 |
[M] String
|
Max 35 char
|
Street name and number. |
| line2 |
[O] String
|
Max 35 char
|
|
| line3 |
[O] String
|
Max 35 char
|
|
| city |
[O] String
|
Max 35 char
|
|
| postalCode |
[M] String
|
Max 10 char
|
|
| poBox |
[O] String
|
|
|
| countryCode |
[O] String
|
Max 2 char
Pattern: ^[A-Z]{2}$
|
ISO Alpha-2 (https://www.nationsonline.org/oneworld/country_code_list.htm) country code. |
| longitude |
[O] Number
|
|
|
| latitude |
[O] Number
|
|
|
invoices.customer.financial
| preferredCurrency |
[O] String
|
|
|
| iban |
[O] String
|
|
|
| bic |
[O] String
|
|
|
| paymentDays |
[O] Integer
|
|
|
invoices.customer.tax
| code |
[O] String
|
|
|
| countryCode |
[O] String
|
|
|
invoices.customer.sector
| number |
[O] String
|
|
|
| name |
[O] String
|
|
|
invoices.customer.holdingParty
| number |
[O] String
|
|
|
| name |
[O] String
|
|
|
| sector |
[O] Object
|
|
|
invoices.customer.holdingParty.sector
| number |
[O] String
|
|
|
| name |
[O] String
|
|
|
invoices.customer.charter
| permits |
[O] Array of String
|
|
|
| trackingProviderCode |
[O] String
|
|
|
| trackingId |
[O] String
|
|
|
| type |
[O] String
|
Possible values:
"normal"
null
|
|
| value |
[O] String
|
|
E-mail address. |
| type |
[O] String
|
Possible values:
"normal"
null
|
|
| value |
[O] String
|
|
Phone number. |
invoices.legalEntity
| code |
[M] String
|
Max 3 char
Pattern: ^[0-9]{3}$
|
The code of the Jan de Rijk legal entity handling the order. |
| relationCode |
[O] String
|
Max 40 char
|
|
| number |
[M] String
|
Max 20 char
|
Jan de Rijk code for the customer. |
| name |
[O] String
|
|
|
| eanNumber |
[O] String
|
|
|
| chamberOfCommerceNumber |
[O] String
|
|
|
| dunsNumber |
[O] String
|
|
|
| website |
[O] String
|
|
|
| blocked |
[O] Boolean
|
|
|
| enabled |
[O] Boolean
|
|
|
| types |
[O] Array of String
|
|
|
| isInterCompany |
[M] Boolean
|
|
Boolean to figure out if the order belong to an intercompany. |
| address |
[O] Object
|
|
|
| financial |
[O] Object
|
|
|
| tax |
[O] Object
|
|
|
| sector |
[O] Object
|
|
|
| holdingParty |
[O] Object
|
|
|
| charter |
[O] Object
|
|
|
| contact |
[O] Object
|
|
|
invoices.legalEntity.address
| locationCode |
[O] String
|
Max 5 char
|
Only to be used if the location is an airport, in whcih case it should be the IATA code. |
| name |
[O] String
|
Max 35 char
|
|
| name2 |
[O] String
|
Max 35 char
|
|
| name3 |
[O] String
|
Max 35 char
|
|
| line1 |
[M] String
|
Max 35 char
|
Street name and number. |
| line2 |
[O] String
|
Max 35 char
|
|
| line3 |
[O] String
|
Max 35 char
|
|
| city |
[O] String
|
Max 35 char
|
|
| postalCode |
[M] String
|
Max 10 char
|
|
| poBox |
[O] String
|
|
|
| countryCode |
[O] String
|
Max 2 char
Pattern: ^[A-Z]{2}$
|
ISO Alpha-2 (https://www.nationsonline.org/oneworld/country_code_list.htm) country code. |
| longitude |
[O] Number
|
|
|
| latitude |
[O] Number
|
|
|
invoices.legalEntity.financial
| preferredCurrency |
[O] String
|
|
|
| iban |
[O] String
|
|
|
| bic |
[O] String
|
|
|
| paymentDays |
[O] Integer
|
|
|
invoices.legalEntity.tax
| code |
[O] String
|
|
|
| countryCode |
[O] String
|
|
|
invoices.legalEntity.sector
| number |
[O] String
|
|
|
| name |
[O] String
|
|
|
invoices.legalEntity.holdingParty
| number |
[O] String
|
|
|
| name |
[O] String
|
|
|
| sector |
[O] Object
|
|
|
invoices.legalEntity.holdingParty.sector
| number |
[O] String
|
|
|
| name |
[O] String
|
|
|
invoices.legalEntity.charter
| permits |
[O] Array of String
|
|
|
| trackingProviderCode |
[O] String
|
|
|
| trackingId |
[O] String
|
|
|
| type |
[O] String
|
Possible values:
"normal"
|
|
| value |
[O] String
|
|
E-mail address. |
| type |
[O] String
|
Possible values:
"normal"
|
|
| value |
[O] String
|
|
Phone number. |
invoices.lines
| id |
[M] String
|
|
The id of the invoice line. Unique within the invoice. |
| chargeCode |
[O] String
|
|
Jan de Rijk code of the type of charges. |
| chargeCategory |
[O] String
|
Possible values:
null
"transport"
"secondDriver"
"extraStop"
"waitingTime"
"timeWindow"
"tollFerry"
"handling"
"customs"
"cool"
"adr"
"fuel"
"noShow"
Expand
Collapse
|
|
| sellingDate |
[M] String
|
Format: date-time
|
Includes time zone indicator. |
| description |
[O] String
|
|
|
| additionalDescriptions |
[O] Array of String
|
|
|
| amountLocalCurrency |
[M] Number
|
|
The amount in Euros. |
| amountForeignCurrency |
[M] Number
|
|
The amount in the currency of the invoice. |
| quantity |
[O] Number
|
|
The relevant quantity used to determine the amount. |
| shipmentNumber |
[O] String
|
Pattern: ^(([0-9]{12})|([0-9]{15}))$
|
The relevant Jan de Rijk shipment number. This refers to $.invoices.orders.shipments.number. Only filled in for shipment level charges. |
| orderNumber |
[M] String
|
Pattern: ^(([0-9]{12})|([0-9]{15}))$
|
The relevant Jan de Rijk order number. This refers to $.invoices.orders.number. |
invoices.taxLines
| id |
[M] String
|
|
Unique within the invoice. |
| taxAmountLocalCurrency |
[M] Number
|
|
Tax amount in Euros. |
| taxAmountForeignCurrency |
[M] Number
|
|
|
| baseAmountLocalCurrency |
[O] Number
|
|
Tax amount in Euros. |
| baseAmountForeignCurrency |
[O] Number
|
|
|
| invoiceLineIds |
[O] Array of String
|
|
|
| rate |
[O] Number
|
|
|
| vat |
[O] Object
|
|
VAT information |
| description |
[O] String
|
|
|
invoices.taxLines.vat
VAT information
| type |
[M] String
|
Possible values:
"free"
"low"
"high"
"deffered"
"unknown"
|
|
| typeCode |
[O] Number
|
|
|
| calculationMethodCode |
[O] Number
|
|
|
invoices.orders
Conditinally required properties
Some properties mentioned above are sometimes mandatory and sometimes optional or not available, note the [?]. These are the possible combinations of properties that can be used:
-
Standard shipment with department: departmentCode, originalLoading and finalUnloading.
-
or: Container export with department: departmentCode, containerPickUp, originalLoading and containerDropOff.
-
or: Container import with department: departmentCode, containerPickUp, finalUnloading and containerDropOff.
-
or: Standard shipment with product: product, originalLoading and finalUnloading.
-
or: Container export with product: product, containerPickUp, originalLoading and containerDropOff.
-
or: Container import with product: product, containerPickUp, finalUnloading and containerDropOff.
invoices.orders.customerData
invoices.orders.customer
| number |
[M] String
|
Max 40 char
|
|
| code |
[M] String
|
Max 20 char
|
Jan de Rijk code for the customer. |
| name |
[O] String
|
|
|
| isInterCompany |
[M] Boolean
|
Max 20 char
|
Boolean to figure out if the order belong to an intercompany. |
| eanNumber |
[O] String
|
|
EAN number of the customer. |
| address |
[O] Object
|
|
|
| remarks |
[O] String
|
|
|
invoices.orders.customer.address
| locationCode |
[O] String
|
Max 100 char
|
In case the location is an airport, this will be the IATA code. |
| locationName |
[O] String
|
|
|
| name1 |
[O] String
|
Max 100 char
|
|
| line1 |
[O] String
|
Max 100 char
|
Street name and number. |
| line2 |
[O] String
|
Max 100 char
|
Street name and number. |
| city |
[O] String
|
Max 100 char
|
|
| postalCode |
[M] String
|
Max 10 char
|
|
| countryName |
[O] String
|
Max 100 char
|
|
| countryCode |
[O] String
|
Max 2 char
Pattern: ^[A-Z]{2}$
|
ISO-2 country code. |
| longitude |
[O] Number
|
|
|
| latitude |
[O] Number
|
|
|
| phone |
[O] String
|
Max 100 char
|
|
| fax |
[O] String
|
Max 100 char
|
|
| mail |
[O] String
|
Max 100 char
|
|
invoices.orders.originalLoading
| party |
[M] Object
|
|
|
| dateTimes |
[M] Object
|
|
Date/time of relevant events. |
| milestones |
[O] Object
|
|
Actual date/time of relevant events. null if the event did not yet happen. |
| reference |
[O] String
|
|
|
invoices.orders.originalLoading.party
| name |
[O] String
|
|
|
| number |
[O] String
|
Max 6 char
Pattern: ^[0-9]{6}$
|
Jan de Rijk number of the existing party in Jan de Rijk system. |
| code |
[M] String
|
Max 20 char
|
Jan de Rijk code of the existing party in Jan de Rijk system. |
| address |
[M] Object
|
|
|
| remarks |
[O] String
|
|
|
| characteristics |
[O] Object
|
|
|
| allowedAssetTypes |
[O] Array of String
|
|
|
invoices.orders.originalLoading.party.address
| locationCode |
[O] String
|
Max 100 char
|
In case the location is an airport, this will be the IATA code. |
| locationName |
[O] String
|
|
|
| name1 |
[O] String
|
Max 100 char
|
|
| line1 |
[O] String
|
Max 100 char
|
Street name and number. |
| line2 |
[O] String
|
Max 100 char
|
Street name and number. |
| city |
[O] String
|
Max 100 char
|
|
| postalCode |
[M] String
|
Max 10 char
|
|
| countryName |
[O] String
|
Max 100 char
|
|
| countryCode |
[O] String
|
Max 2 char
Pattern: ^[A-Z]{2}$
|
ISO-2 country code. |
| longitude |
[O] Number
|
|
|
| latitude |
[O] Number
|
|
|
| phone |
[O] String
|
Max 100 char
|
|
| fax |
[O] String
|
Max 100 char
|
|
| mail |
[O] String
|
Max 100 char
|
|
invoices.orders.originalLoading.party.characteristics
| isDepot |
[O] Boolean
|
|
|
| keyAvailable |
[O] Boolean
|
|
|
invoices.orders.originalLoading.dateTimes
Date/time of relevant events.
| opening |
[O] String
|
Format: date-time
|
Includes time zone indicator. |
| closing |
[O] String
|
Format: date-time
|
Includes time zone indicator. |
invoices.orders.originalLoading.milestones
Actual date/time of relevant events. null if the event did not yet happen.
| start |
[O] String
|
Format: date-time
|
Includes time zone indicator. |
| end |
[O] String
|
Format: date-time
|
Includes time zone indicator. |
invoices.orders.finalUnloading
| party |
[M] Object
|
|
|
| dateTimes |
[M] Object
|
|
Date/time of relevant events. |
| milestones |
[O] Object
|
|
Actual date/time of relevant events. null if the event did not yet happen. |
| reference |
[O] String
|
|
|
invoices.orders.finalUnloading.party
| name |
[O] String
|
|
|
| number |
[O] String
|
Max 6 char
Pattern: ^[0-9]{6}$
|
Jan de Rijk number of the existing party in Jan de Rijk system. |
| code |
[M] String
|
Max 20 char
|
Jan de Rijk code of the existing party in Jan de Rijk system. |
| address |
[M] Object
|
|
|
| remarks |
[O] String
|
|
|
| characteristics |
[O] Object
|
|
|
| allowedAssetTypes |
[O] Array of String
|
|
|
invoices.orders.finalUnloading.party.address
| locationCode |
[O] String
|
Max 100 char
|
In case the location is an airport, this will be the IATA code. |
| locationName |
[O] String
|
|
|
| name1 |
[O] String
|
Max 100 char
|
|
| line1 |
[O] String
|
Max 100 char
|
Street name and number. |
| line2 |
[O] String
|
Max 100 char
|
Street name and number. |
| city |
[O] String
|
Max 100 char
|
|
| postalCode |
[M] String
|
Max 10 char
|
|
| countryName |
[O] String
|
Max 100 char
|
|
| countryCode |
[O] String
|
Max 2 char
Pattern: ^[A-Z]{2}$
|
ISO-2 country code. |
| longitude |
[O] Number
|
|
|
| latitude |
[O] Number
|
|
|
| phone |
[O] String
|
Max 100 char
|
|
| fax |
[O] String
|
Max 100 char
|
|
| mail |
[O] String
|
Max 100 char
|
|
invoices.orders.finalUnloading.party.characteristics
| isDepot |
[O] Boolean
|
|
|
| keyAvailable |
[O] Boolean
|
|
|
invoices.orders.finalUnloading.dateTimes
Date/time of relevant events.
| opening |
[O] String
|
Format: date-time
|
Includes time zone indicator. |
| closing |
[O] String
|
Format: date-time
|
Includes time zone indicator. |
| earlyPossible |
[O] Boolean
|
|
If true, Jan de Rijk can pick-up the cargo outside the time window. |
invoices.orders.finalUnloading.milestones
Actual date/time of relevant events. null if the event did not yet happen.
| start |
[O] String
|
Format: date-time
|
Includes time zone indicator. |
| end |
[O] String
|
Format: date-time
|
Includes time zone indicator. |
invoices.orders.containerPickUp
| party |
[M] Object
|
|
|
| dateTimes |
[M] Object
|
|
Date/time of relevant events. |
| milestones |
[O] Object
|
|
Actual date/time of relevant events. null if the event did not yet happen. |
| reference |
[O] String
|
|
|
invoices.orders.containerPickUp.party
| name |
[O] String
|
|
|
| number |
[O] String
|
Max 6 char
Pattern: ^[0-9]{6}$
|
Jan de Rijk number of the existing party in Jan de Rijk system. |
| code |
[M] String
|
Max 20 char
|
Jan de Rijk code of the existing party in Jan de Rijk system. |
| address |
[M] Object
|
|
|
| remarks |
[O] String
|
|
|
| characteristics |
[O] Object
|
|
|
| allowedAssetTypes |
[O] Array of String
|
|
|
invoices.orders.containerPickUp.party.address
| locationCode |
[O] String
|
Max 100 char
|
In case the location is an airport, this will be the IATA code. |
| locationName |
[O] String
|
|
|
| name1 |
[O] String
|
Max 100 char
|
|
| line1 |
[O] String
|
Max 100 char
|
Street name and number. |
| line2 |
[O] String
|
Max 100 char
|
Street name and number. |
| city |
[O] String
|
Max 100 char
|
|
| postalCode |
[M] String
|
Max 10 char
|
|
| countryName |
[O] String
|
Max 100 char
|
|
| countryCode |
[O] String
|
Max 2 char
Pattern: ^[A-Z]{2}$
|
ISO-2 country code. |
| longitude |
[O] Number
|
|
|
| latitude |
[O] Number
|
|
|
| phone |
[O] String
|
Max 100 char
|
|
| fax |
[O] String
|
Max 100 char
|
|
| mail |
[O] String
|
Max 100 char
|
|
invoices.orders.containerPickUp.party.characteristics
| isDepot |
[O] Boolean
|
|
|
| keyAvailable |
[O] Boolean
|
|
|
invoices.orders.containerPickUp.dateTimes
Date/time of relevant events.
| opening |
[O] String
|
Format: date-time
|
Includes time zone indicator. |
| closing |
[O] String
|
Format: date-time
|
Includes time zone indicator. |
invoices.orders.containerPickUp.milestones
Actual date/time of relevant events. null if the event did not yet happen.
| start |
[O] String
|
Format: date-time
|
Includes time zone indicator. |
| end |
[O] String
|
Format: date-time
|
Includes time zone indicator. |
invoices.orders.containerDropOff
| party |
[M] Object
|
|
|
| dateTimes |
[M] Object
|
|
Date/time of relevant events. |
| milestones |
[O] Object
|
|
Actual date/time of relevant events. null if the event did not yet happen. |
| reference |
[O] String
|
|
|
invoices.orders.containerDropOff.party
| name |
[O] String
|
|
|
| number |
[O] String
|
Max 6 char
Pattern: ^[0-9]{6}$
|
Jan de Rijk number of the existing party in Jan de Rijk system. |
| code |
[M] String
|
Max 20 char
|
Jan de Rijk code of the existing party in Jan de Rijk system. |
| address |
[M] Object
|
|
|
| remarks |
[O] String
|
|
|
| characteristics |
[O] Object
|
|
|
| allowedAssetTypes |
[O] Array of String
|
|
|
invoices.orders.containerDropOff.party.address
| locationCode |
[O] String
|
Max 100 char
|
In case the location is an airport, this will be the IATA code. |
| locationName |
[O] String
|
|
|
| name1 |
[O] String
|
Max 100 char
|
|
| line1 |
[O] String
|
Max 100 char
|
Street name and number. |
| line2 |
[O] String
|
Max 100 char
|
Street name and number. |
| city |
[O] String
|
Max 100 char
|
|
| postalCode |
[M] String
|
Max 10 char
|
|
| countryName |
[O] String
|
Max 100 char
|
|
| countryCode |
[O] String
|
Max 2 char
Pattern: ^[A-Z]{2}$
|
ISO-2 country code. |
| longitude |
[O] Number
|
|
|
| latitude |
[O] Number
|
|
|
| phone |
[O] String
|
Max 100 char
|
|
| fax |
[O] String
|
Max 100 char
|
|
| mail |
[O] String
|
Max 100 char
|
|
invoices.orders.containerDropOff.party.characteristics
| isDepot |
[O] Boolean
|
|
|
| keyAvailable |
[O] Boolean
|
|
|
invoices.orders.containerDropOff.dateTimes
Date/time of relevant events.
| opening |
[O] String
|
Format: date-time
|
Includes time zone indicator. |
| closing |
[O] String
|
Format: date-time
|
Includes time zone indicator. |
| earlyPossible |
[O] Boolean
|
|
If true, Jan de Rijk can pick-up the cargo outside the time window. |
invoices.orders.containerDropOff.milestones
Actual date/time of relevant events. null if the event did not yet happen.
| start |
[O] String
|
Format: date-time
|
Includes time zone indicator. |
| end |
[O] String
|
Format: date-time
|
Includes time zone indicator. |
invoices.orders.measurement
| grossWeight |
[O] Number
|
3 decimals
|
Kilograms. |
| netWeight |
[O] Number
|
3 decimals
|
Kilograms. |
| chargeableWeight |
[O] Number
|
3 decimals
|
Kilograms. |
| quantity |
[O] Number
|
|
|
| volume |
[O] Number
|
3 decimals
|
Cubic metres. |
| volumeWeight |
[O] Number
|
3 decimals
|
Kilograms. Usually only used for air freight. |
| loadIndex |
[O] Number
|
3 decimals
|
|
| palletPlaces |
[O] Number
|
3 decimals
|
|
invoices.orders.shipments
| number |
[M] String
|
Pattern: ^(([0-9]{12})|([0-9]{15}))$
|
Internal Jan de Rijk number for the original shipment of the customer. |
| reference |
[M] String
|
Max 30 char
|
Customer's reference for the shipment. This is the reference that would be used to refer to the order in any communication between the customer and Jan de Rijk. This reference also appears on invoices and status messages, and is searchable in JConnect. |
| handled |
[M] Boolean
|
|
Specifies if the shipment is handled. |
| source |
[O] String
|
Max 30 char
Possible values:
"edi"
"rpa"
"portal"
"manual"
"automatic"
null
Expand
Collapse
|
Source of the shipment data. |
| internal |
[M] Boolean
|
|
Specifies if it concerns an internal shipment. |
| forecast |
[O] Boolean
|
|
|
| requestedModalities |
[O] Array of String
|
|
|
| ecmr |
[O] Object
|
|
|
| lineService |
[M] Boolean
|
|
Specifies if the shipment is a line service shipment. |
| ediReference |
[O] String
|
|
Customer unique id for the shipment. |
| invoiceReference |
[O] String
|
|
Used as purchase shipment reference for invoicing and accounting. |
| cancelled |
[M] Boolean
|
|
Specifies if the shipment is cancelled. |
| transportInstructions |
[O] String
|
|
|
| documents |
[O] Array of Object
|
|
|
| knownCargo |
[O] Boolean
|
|
|
| route |
[O] Object
|
|
|
| planning |
[O] Object
|
|
|
| requirements |
[M] Object
|
|
Special requirements relating to the shipment. |
| security |
[O] Object
|
|
Can be used to specify security above the standard security level of TSR 01. The actual security level is explained in the SOP and arranged by the Jan de Rijk planning team. |
| airFreightExport |
[O] Boolean
|
|
Specifies if the cargo will be transferred to a plane (to be flown to a further destination) on unloading. |
| customerData |
[O] Object
|
|
|
| originalLoading |
[?] Object
|
|
|
| finalUnloading |
[?] Object
|
|
|
| containerPickUp |
[?] Object
|
|
|
| containerDropOff |
[?] Object
|
|
|
| neutralLoading |
[O] Object
|
|
|
| neutralUnloading |
[O] Object
|
|
|
| clearingIn |
[O] Object
|
|
|
| clearingOut |
[O] Object
|
|
|
| packageType |
[O] String
|
Possible values:
null
"pallet"
"colli"
"euroPallet"
"trailer"
"uld"
"container16Feet"
"container20Feet"
"container20FeetReefer"
"container40Feet"
"container45Feet"
"container45FeetHighCube"
"ake"
"containerCc"
"chepPallet"
"deciMeterLoadIndex"
"airplaneEngine"
"flowPallet"
"container40FeetHighCube"
"helicopter"
"halfPlanePlate"
"container40FeetReefer"
"ibc"
"kilograms"
"meterLoadIndex"
"otherPalletType"
"planePlate"
"rollContainer217LoadIndex"
"rollContainer240LoadIndex"
"rollContainer278LoadIndex"
"rollContainer373LoadIndex"
"rollContainer233LoadIndex"
"roadTrain"
"xx"
Expand
Collapse
|
|
| tariffType |
[O] String
|
Possible values:
null
"normal"
"adHoc"
"loadIndex"
"fullTruckLoad"
"trailer"
"extra"
"timeFrame2"
"timeFrame3"
"fast"
"timeFrame1"
"pallets"
"route1"
"grossWeight"
"lineHaul"
"route2"
"roundTrip"
"motorcar"
Expand
Collapse
|
Used when there are price agreements. Should be omitted (or null) unless a value was specifically agreed upon with the Jan de Rijk sales department. |
| tariffTypeName |
[O] String
|
|
|
| vehicle |
[O] Object
|
|
|
| pulledUnit |
[O] Object
|
|
|
| measurement |
[M] Object
|
|
|
| additionalCustomerReferences |
[O] Array of String
|
|
|
| goodsLines |
[M] Array of Object
|
|
|
| breakCode |
[O] String
|
|
An additional invoice code in case the customer wants to split the invoices by those codes. Meaning to be discussed with Jan de Rijk finance department. |
Conditinally required properties
Some properties mentioned above are sometimes mandatory and sometimes optional or not available, note the [?]. These are the possible combinations of properties that can be used:
-
Standard shipment: originalLoading and finalUnloading.
-
or: Container export: containerPickUp, originalLoading and containerDropOff.
-
or: Container import: containerPickUp, finalUnloading and containerDropOff.
invoices.orders.shipments.ecmr
| required |
[O] Boolean
|
|
|
| id |
[O] String
|
|
|
| provider |
[O] String
|
|
|
invoices.orders.shipments.documents
| type |
[O] String
|
|
|
| sequenceNumber |
[O] Integer
|
|
|
| number |
[O] String
|
|
|
invoices.orders.shipments.route
invoices.orders.shipments.planning
| characteristicCode |
[O] String
|
|
|
| characteristicName |
[O] String
|
|
|
invoices.orders.shipments.requirements
Special requirements relating to the shipment.
| description |
[O] String
|
|
|
| code |
[O] String
|
|
|
| freightUnitType |
[O] String
|
Possible values:
null
"mega"
"flatBox"
"box"
"isolation"
"tautliner"
"unspecified"
Expand
Collapse
|
|
| roadTrain |
[O] Boolean
|
|
This means LZV (longer truck). It can only be selected when it is agreed in the SOP for a certain line. |
| dangerousCargo |
[O] Boolean
|
|
|
| adrPoints |
[O] Integer
|
|
|
| urgent |
[O] Boolean
|
|
|
| heater |
[O] Boolean
|
|
|
| cooler |
[O] Boolean
|
|
|
| exclusive |
[O] Boolean
|
|
If true, Jan de Rijk won't have the possibility to co-load the cargo with other customers' cargo. Co-loading regulations are taken into account regardless. |
| maximumTemperature |
[O] Number
|
|
|
| minimumTemperature |
[O] Number
|
|
|
| palletSwap |
[O] Boolean
|
|
|
| pharmaceuticals |
[O] Boolean
|
|
It concerns pharmaceutical cargo, and all requirements for that apply. |
invoices.orders.shipments.security
Can be used to specify security above the standard security level of TSR 01. The actual security level is explained in the SOP and arranged by the Jan de Rijk planning team.
| secured |
[M] Boolean
|
|
|
| level |
[O] String
|
Possible values:
null
"TAPA1"
"TAPA2"
|
|
invoices.orders.shipments.customerData
invoices.orders.shipments.originalLoading
| party |
[M] Object
|
|
|
| reference |
[O] String
|
|
|
| dateTimes |
[M] Object
|
|
Date/time of relevant events. |
| milestones |
[O] Object
|
|
Actual date/time of relevant events. null if the event did not yet happen. |
invoices.orders.shipments.originalLoading.party
| name |
[O] String
|
|
|
| number |
[O] String
|
Max 6 char
Pattern: ^[0-9]{6}$
|
Jan de Rijk number of the existing party in Jan de Rijk system. |
| code |
[M] String
|
Max 20 char
|
Jan de Rijk code of the existing party in Jan de Rijk system. |
| address |
[M] Object
|
|
|
| remarks |
[O] String
|
|
|
| characteristics |
[O] Object
|
|
|
| allowedAssetTypes |
[O] Array of String
|
|
|
invoices.orders.shipments.originalLoading.party.address
| locationCode |
[O] String
|
Max 100 char
|
In case the location is an airport, this will be the IATA code. |
| locationName |
[O] String
|
|
|
| name1 |
[O] String
|
Max 100 char
|
|
| line1 |
[O] String
|
Max 100 char
|
Street name and number. |
| line2 |
[O] String
|
Max 100 char
|
Street name and number. |
| city |
[O] String
|
Max 100 char
|
|
| postalCode |
[M] String
|
Max 10 char
|
|
| countryName |
[O] String
|
Max 100 char
|
|
| countryCode |
[O] String
|
Max 2 char
Pattern: ^[A-Z]{2}$
|
ISO-2 country code. |
| longitude |
[O] Number
|
|
|
| latitude |
[O] Number
|
|
|
| phone |
[O] String
|
Max 100 char
|
|
| fax |
[O] String
|
Max 100 char
|
|
| mail |
[O] String
|
Max 100 char
|
|
invoices.orders.shipments.originalLoading.party.characteristics
| isDepot |
[O] Boolean
|
|
|
| keyAvailable |
[O] Boolean
|
|
|
invoices.orders.shipments.originalLoading.dateTimes
Date/time of relevant events.
| opening |
[O] String
|
Format: date-time
|
Includes time zone indicator. |
| closing |
[O] String
|
Format: date-time
|
Includes time zone indicator. |
invoices.orders.shipments.originalLoading.milestones
Actual date/time of relevant events. null if the event did not yet happen.
| start |
[O] String
|
Format: date-time
|
Includes time zone indicator. |
| end |
[O] String
|
Format: date-time
|
Includes time zone indicator. |
invoices.orders.shipments.finalUnloading
| party |
[M] Object
|
|
|
| dateTimes |
[M] Object
|
|
Date/time of relevant events. |
| milestones |
[O] Object
|
|
Actual date/time of relevant events. null if the event did not yet happen. |
| reference |
[O] String
|
|
|
invoices.orders.shipments.finalUnloading.party
| name |
[O] String
|
|
|
| number |
[O] String
|
Max 6 char
Pattern: ^[0-9]{6}$
|
Jan de Rijk number of the existing party in Jan de Rijk system. |
| code |
[M] String
|
Max 20 char
|
Jan de Rijk code of the existing party in Jan de Rijk system. |
| address |
[M] Object
|
|
|
| remarks |
[O] String
|
|
|
| characteristics |
[O] Object
|
|
|
| allowedAssetTypes |
[O] Array of String
|
|
|
invoices.orders.shipments.finalUnloading.party.address
| locationCode |
[O] String
|
Max 100 char
|
In case the location is an airport, this will be the IATA code. |
| locationName |
[O] String
|
|
|
| name1 |
[O] String
|
Max 100 char
|
|
| line1 |
[O] String
|
Max 100 char
|
Street name and number. |
| line2 |
[O] String
|
Max 100 char
|
Street name and number. |
| city |
[O] String
|
Max 100 char
|
|
| postalCode |
[M] String
|
Max 10 char
|
|
| countryName |
[O] String
|
Max 100 char
|
|
| countryCode |
[O] String
|
Max 2 char
Pattern: ^[A-Z]{2}$
|
ISO-2 country code. |
| longitude |
[O] Number
|
|
|
| latitude |
[O] Number
|
|
|
| phone |
[O] String
|
Max 100 char
|
|
| fax |
[O] String
|
Max 100 char
|
|
| mail |
[O] String
|
Max 100 char
|
|
invoices.orders.shipments.finalUnloading.party.characteristics
| isDepot |
[O] Boolean
|
|
|
| keyAvailable |
[O] Boolean
|
|
|
invoices.orders.shipments.finalUnloading.dateTimes
Date/time of relevant events.
| opening |
[O] String
|
Format: date-time
|
Includes time zone indicator. |
| closing |
[O] String
|
Format: date-time
|
Includes time zone indicator. |
| earlyPossible |
[O] Boolean
|
|
If true, Jan de Rijk can pick-up the cargo outside the time window. |
invoices.orders.shipments.finalUnloading.milestones
Actual date/time of relevant events. null if the event did not yet happen.
| start |
[O] String
|
Format: date-time
|
Includes time zone indicator. |
| end |
[O] String
|
Format: date-time
|
Includes time zone indicator. |
invoices.orders.shipments.containerPickUp
| party |
[M] Object
|
|
|
| reference |
[O] String
|
|
|
| dateTimes |
[M] Object
|
|
Date/time of relevant events. |
| milestones |
[O] Object
|
|
Actual date/time of relevant events. null if the event did not yet happen. |
invoices.orders.shipments.containerPickUp.party
| name |
[O] String
|
|
|
| number |
[O] String
|
Max 6 char
Pattern: ^[0-9]{6}$
|
Jan de Rijk number of the existing party in Jan de Rijk system. |
| code |
[M] String
|
Max 20 char
|
Jan de Rijk code of the existing party in Jan de Rijk system. |
| address |
[M] Object
|
|
|
| remarks |
[O] String
|
|
|
| characteristics |
[O] Object
|
|
|
| allowedAssetTypes |
[O] Array of String
|
|
|
invoices.orders.shipments.containerPickUp.party.address
| locationCode |
[O] String
|
Max 100 char
|
In case the location is an airport, this will be the IATA code. |
| locationName |
[O] String
|
|
|
| name1 |
[O] String
|
Max 100 char
|
|
| line1 |
[O] String
|
Max 100 char
|
Street name and number. |
| line2 |
[O] String
|
Max 100 char
|
Street name and number. |
| city |
[O] String
|
Max 100 char
|
|
| postalCode |
[M] String
|
Max 10 char
|
|
| countryName |
[O] String
|
Max 100 char
|
|
| countryCode |
[O] String
|
Max 2 char
Pattern: ^[A-Z]{2}$
|
ISO-2 country code. |
| longitude |
[O] Number
|
|
|
| latitude |
[O] Number
|
|
|
| phone |
[O] String
|
Max 100 char
|
|
| fax |
[O] String
|
Max 100 char
|
|
| mail |
[O] String
|
Max 100 char
|
|
invoices.orders.shipments.containerPickUp.party.characteristics
| isDepot |
[O] Boolean
|
|
|
| keyAvailable |
[O] Boolean
|
|
|
invoices.orders.shipments.containerPickUp.dateTimes
Date/time of relevant events.
| opening |
[O] String
|
Format: date-time
|
Includes time zone indicator. |
| closing |
[O] String
|
Format: date-time
|
Includes time zone indicator. |
invoices.orders.shipments.containerPickUp.milestones
Actual date/time of relevant events. null if the event did not yet happen.
| start |
[O] String
|
Format: date-time
|
Includes time zone indicator. |
| end |
[O] String
|
Format: date-time
|
Includes time zone indicator. |
invoices.orders.shipments.containerDropOff
| party |
[M] Object
|
|
|
| dateTimes |
[M] Object
|
|
Date/time of relevant events. |
| milestones |
[O] Object
|
|
Actual date/time of relevant events. null if the event did not yet happen. |
| reference |
[O] String
|
|
|
invoices.orders.shipments.containerDropOff.party
| name |
[O] String
|
|
|
| number |
[O] String
|
Max 6 char
Pattern: ^[0-9]{6}$
|
Jan de Rijk number of the existing party in Jan de Rijk system. |
| code |
[M] String
|
Max 20 char
|
Jan de Rijk code of the existing party in Jan de Rijk system. |
| address |
[M] Object
|
|
|
| remarks |
[O] String
|
|
|
| characteristics |
[O] Object
|
|
|
| allowedAssetTypes |
[O] Array of String
|
|
|
invoices.orders.shipments.containerDropOff.party.address
| locationCode |
[O] String
|
Max 100 char
|
In case the location is an airport, this will be the IATA code. |
| locationName |
[O] String
|
|
|
| name1 |
[O] String
|
Max 100 char
|
|
| line1 |
[O] String
|
Max 100 char
|
Street name and number. |
| line2 |
[O] String
|
Max 100 char
|
Street name and number. |
| city |
[O] String
|
Max 100 char
|
|
| postalCode |
[M] String
|
Max 10 char
|
|
| countryName |
[O] String
|
Max 100 char
|
|
| countryCode |
[O] String
|
Max 2 char
Pattern: ^[A-Z]{2}$
|
ISO-2 country code. |
| longitude |
[O] Number
|
|
|
| latitude |
[O] Number
|
|
|
| phone |
[O] String
|
Max 100 char
|
|
| fax |
[O] String
|
Max 100 char
|
|
| mail |
[O] String
|
Max 100 char
|
|
invoices.orders.shipments.containerDropOff.party.characteristics
| isDepot |
[O] Boolean
|
|
|
| keyAvailable |
[O] Boolean
|
|
|
invoices.orders.shipments.containerDropOff.dateTimes
Date/time of relevant events.
| opening |
[O] String
|
Format: date-time
|
Includes time zone indicator. |
| closing |
[O] String
|
Format: date-time
|
Includes time zone indicator. |
| earlyPossible |
[O] Boolean
|
|
If true, Jan de Rijk can pick-up the cargo outside the time window. |
invoices.orders.shipments.containerDropOff.milestones
Actual date/time of relevant events. null if the event did not yet happen.
| start |
[O] String
|
Format: date-time
|
Includes time zone indicator. |
| end |
[O] String
|
Format: date-time
|
Includes time zone indicator. |
invoices.orders.shipments.neutralLoading
invoices.orders.shipments.neutralLoading.party
| name |
[O] String
|
|
|
| number |
[O] String
|
Max 6 char
Pattern: ^[0-9]{6}$
|
Jan de Rijk number of the existing party in Jan de Rijk system. |
| code |
[M] String
|
Max 20 char
|
Jan de Rijk code of the existing party in Jan de Rijk system. |
| address |
[M] Object
|
|
|
| remarks |
[O] String
|
|
|
| characteristics |
[O] Object
|
|
|
| allowedAssetTypes |
[O] Array of String
|
|
|
invoices.orders.shipments.neutralLoading.party.address
| locationCode |
[O] String
|
Max 100 char
|
In case the location is an airport, this will be the IATA code. |
| locationName |
[O] String
|
|
|
| name1 |
[O] String
|
Max 100 char
|
|
| line1 |
[O] String
|
Max 100 char
|
Street name and number. |
| line2 |
[O] String
|
Max 100 char
|
Street name and number. |
| city |
[O] String
|
Max 100 char
|
|
| postalCode |
[M] String
|
Max 10 char
|
|
| countryName |
[O] String
|
Max 100 char
|
|
| countryCode |
[O] String
|
Max 2 char
Pattern: ^[A-Z]{2}$
|
ISO-2 country code. |
| longitude |
[O] Number
|
|
|
| latitude |
[O] Number
|
|
|
| phone |
[O] String
|
Max 100 char
|
|
| fax |
[O] String
|
Max 100 char
|
|
| mail |
[O] String
|
Max 100 char
|
|
invoices.orders.shipments.neutralLoading.party.characteristics
| isDepot |
[O] Boolean
|
|
|
| keyAvailable |
[O] Boolean
|
|
|
invoices.orders.shipments.neutralUnloading
invoices.orders.shipments.neutralUnloading.party
| name |
[O] String
|
|
|
| number |
[O] String
|
Max 6 char
Pattern: ^[0-9]{6}$
|
Jan de Rijk number of the existing party in Jan de Rijk system. |
| code |
[M] String
|
Max 20 char
|
Jan de Rijk code of the existing party in Jan de Rijk system. |
| address |
[M] Object
|
|
|
| remarks |
[O] String
|
|
|
| characteristics |
[O] Object
|
|
|
| allowedAssetTypes |
[O] Array of String
|
|
|
invoices.orders.shipments.neutralUnloading.party.address
| locationCode |
[O] String
|
Max 100 char
|
In case the location is an airport, this will be the IATA code. |
| locationName |
[O] String
|
|
|
| name1 |
[O] String
|
Max 100 char
|
|
| line1 |
[O] String
|
Max 100 char
|
Street name and number. |
| line2 |
[O] String
|
Max 100 char
|
Street name and number. |
| city |
[O] String
|
Max 100 char
|
|
| postalCode |
[M] String
|
Max 10 char
|
|
| countryName |
[O] String
|
Max 100 char
|
|
| countryCode |
[O] String
|
Max 2 char
Pattern: ^[A-Z]{2}$
|
ISO-2 country code. |
| longitude |
[O] Number
|
|
|
| latitude |
[O] Number
|
|
|
| phone |
[O] String
|
Max 100 char
|
|
| fax |
[O] String
|
Max 100 char
|
|
| mail |
[O] String
|
Max 100 char
|
|
invoices.orders.shipments.neutralUnloading.party.characteristics
| isDepot |
[O] Boolean
|
|
|
| keyAvailable |
[O] Boolean
|
|
|
invoices.orders.shipments.clearingIn
invoices.orders.shipments.clearingIn.party
| name |
[O] String
|
|
|
| number |
[O] String
|
Max 6 char
Pattern: ^[0-9]{6}$
|
Jan de Rijk number of the existing party in Jan de Rijk system. |
| code |
[M] String
|
Max 20 char
|
Jan de Rijk code of the existing party in Jan de Rijk system. |
| address |
[M] Object
|
|
|
| remarks |
[O] String
|
|
|
| characteristics |
[O] Object
|
|
|
| allowedAssetTypes |
[O] Array of String
|
|
|
invoices.orders.shipments.clearingIn.party.address
| locationCode |
[O] String
|
Max 100 char
|
In case the location is an airport, this will be the IATA code. |
| locationName |
[O] String
|
|
|
| name1 |
[O] String
|
Max 100 char
|
|
| line1 |
[O] String
|
Max 100 char
|
Street name and number. |
| line2 |
[O] String
|
Max 100 char
|
Street name and number. |
| city |
[O] String
|
Max 100 char
|
|
| postalCode |
[M] String
|
Max 10 char
|
|
| countryName |
[O] String
|
Max 100 char
|
|
| countryCode |
[O] String
|
Max 2 char
Pattern: ^[A-Z]{2}$
|
ISO-2 country code. |
| longitude |
[O] Number
|
|
|
| latitude |
[O] Number
|
|
|
| phone |
[O] String
|
Max 100 char
|
|
| fax |
[O] String
|
Max 100 char
|
|
| mail |
[O] String
|
Max 100 char
|
|
invoices.orders.shipments.clearingIn.party.characteristics
| isDepot |
[O] Boolean
|
|
|
| keyAvailable |
[O] Boolean
|
|
|
invoices.orders.shipments.clearingOut
invoices.orders.shipments.clearingOut.party
| name |
[O] String
|
|
|
| number |
[O] String
|
Max 6 char
Pattern: ^[0-9]{6}$
|
Jan de Rijk number of the existing party in Jan de Rijk system. |
| code |
[M] String
|
Max 20 char
|
Jan de Rijk code of the existing party in Jan de Rijk system. |
| address |
[M] Object
|
|
|
| remarks |
[O] String
|
|
|
| characteristics |
[O] Object
|
|
|
| allowedAssetTypes |
[O] Array of String
|
|
|
invoices.orders.shipments.clearingOut.party.address
| locationCode |
[O] String
|
Max 100 char
|
In case the location is an airport, this will be the IATA code. |
| locationName |
[O] String
|
|
|
| name1 |
[O] String
|
Max 100 char
|
|
| line1 |
[O] String
|
Max 100 char
|
Street name and number. |
| line2 |
[O] String
|
Max 100 char
|
Street name and number. |
| city |
[O] String
|
Max 100 char
|
|
| postalCode |
[M] String
|
Max 10 char
|
|
| countryName |
[O] String
|
Max 100 char
|
|
| countryCode |
[O] String
|
Max 2 char
Pattern: ^[A-Z]{2}$
|
ISO-2 country code. |
| longitude |
[O] Number
|
|
|
| latitude |
[O] Number
|
|
|
| phone |
[O] String
|
Max 100 char
|
|
| fax |
[O] String
|
Max 100 char
|
|
| mail |
[O] String
|
Max 100 char
|
|
invoices.orders.shipments.clearingOut.party.characteristics
| isDepot |
[O] Boolean
|
|
|
| keyAvailable |
[O] Boolean
|
|
|
invoices.orders.shipments.vehicle
| licensePlate |
[O] String
|
|
Refers to the license plate of the truck. |
invoices.orders.shipments.pulledUnit
| licensePlate |
[O] String
|
|
Refers to the license plate of the trailer. |
invoices.orders.shipments.measurement
| grossWeight |
[O] Number
|
3 decimals
|
Kilograms. |
| netWeight |
[O] Number
|
3 decimals
|
Kilograms. |
| chargeableWeight |
[O] Number
|
3 decimals
|
Kilograms. |
| quantity |
[O] Number
|
|
|
| volume |
[O] Number
|
3 decimals
|
Cubic metres. |
| volumeWeight |
[O] Number
|
3 decimals
|
Kilograms. Usually only used for air freight. |
| loadIndex |
[O] Number
|
3 decimals
|
|
| palletPlaces |
[O] Number
|
3 decimals
|
|
invoices.orders.shipments.goodsLines
| mark |
[O] String
|
Max 50 char
|
|
| packageType |
[O] String
|
Possible values:
null
"pallet"
"colli"
"euroPallet"
"trailer"
"uld"
"container16Feet"
"container20Feet"
"container20FeetReefer"
"container40Feet"
"container45Feet"
"container45FeetHighCube"
"ake"
"containerCc"
"chepPallet"
"deciMeterLoadIndex"
"airplaneEngine"
"flowPallet"
"container40FeetHighCube"
"helicopter"
"halfPlanePlate"
"container40FeetReefer"
"ibc"
"kilograms"
"meterLoadIndex"
"otherPalletType"
"planePlate"
"rollContainer217LoadIndex"
"rollContainer240LoadIndex"
"rollContainer278LoadIndex"
"rollContainer373LoadIndex"
"rollContainer233LoadIndex"
"roadTrain"
"xx"
Expand
Collapse
|
|
| measurement |
[M] Object
|
|
|
| goodsType |
[O] String
|
Possible values:
null
"airCargo"
"airCargoPalletized"
"carParts"
"general"
"empty"
"aluminium"
"beer"
"ceramics"
"cheese"
"chemicals"
"chocolate"
"cigarettes"
"computerParts"
"consumerElectronics"
"cosmetics"
"flowers"
"food"
"fruit"
"furniture"
"glass"
"householdArticles"
"lighting"
"machines"
"mail"
"meat"
"medicalEquipment"
"nickel"
"paint"
"paper"
"perishables"
"pharmaceuticals"
"plants"
"plastics"
"textile"
"tobacco"
"toys"
"vegetables"
"packingMaterials"
"wine"
"wood"
Expand
Collapse
|
|
| goodsDescription |
[O] String
|
Max 20 char
|
|
| dimensions |
[O] Object
|
|
|
| detailLines |
[O] Array of Object
|
|
Further breakdown of the goods. If this was not provided when the shipment was created, there will be a single detail line for each goods line. |
| dangerousGoods |
[O] Array of Object
|
|
|
invoices.orders.shipments.goodsLines.measurement
| grossWeight |
[O] Number
|
3 decimals
|
Kilograms. |
| netWeight |
[O] Number
|
3 decimals
|
Kilograms. |
| chargeableWeight |
[O] Number
|
3 decimals
|
Kilograms. |
| quantity |
[O] Number
|
|
|
| volume |
[O] Number
|
3 decimals
|
Cubic metres. |
| volumeWeight |
[O] Number
|
3 decimals
|
Kilograms. Usually only used for air freight. |
| loadIndex |
[O] Number
|
3 decimals
|
|
| palletPlaces |
[O] Number
|
3 decimals
|
|
invoices.orders.shipments.goodsLines.dimensions
| length |
[O] Number
|
3 decimals
|
Metres. |
| width |
[O] Number
|
3 decimals
|
Metres. |
| height |
[O] Number
|
3 decimals
|
Metres. |
invoices.orders.shipments.goodsLines.detailLines
| mark |
[O] String
|
Max 50 char
|
|
| packageType |
[O] String
|
Possible values:
null
"pallet"
"colli"
"euroPallet"
"trailer"
"uld"
"container16Feet"
"container20Feet"
"container20FeetReefer"
"container40Feet"
"container45Feet"
"container45FeetHighCube"
"ake"
"containerCc"
"chepPallet"
"deciMeterLoadIndex"
"airplaneEngine"
"flowPallet"
"container40FeetHighCube"
"helicopter"
"halfPlanePlate"
"container40FeetReefer"
"ibc"
"kilograms"
"meterLoadIndex"
"otherPalletType"
"planePlate"
"rollContainer217LoadIndex"
"rollContainer240LoadIndex"
"rollContainer278LoadIndex"
"rollContainer373LoadIndex"
"rollContainer233LoadIndex"
"roadTrain"
"xx"
Expand
Collapse
|
|
| measurement |
[M] Object
|
|
|
| goodsType |
[O] String
|
Possible values:
null
"airCargo"
"airCargoPalletized"
"carParts"
"general"
"empty"
"aluminium"
"beer"
"ceramics"
"cheese"
"chemicals"
"chocolate"
"cigarettes"
"computerParts"
"consumerElectronics"
"cosmetics"
"flowers"
"food"
"fruit"
"furniture"
"glass"
"householdArticles"
"lighting"
"machines"
"mail"
"meat"
"medicalEquipment"
"nickel"
"paint"
"paper"
"perishables"
"pharmaceuticals"
"plants"
"plastics"
"textile"
"tobacco"
"toys"
"vegetables"
"packingMaterials"
"wine"
"wood"
Expand
Collapse
|
|
| goodsDescription |
[O] String
|
Max 20 char
|
|
| id |
[O] String
|
|
Unique within the detail line. |
| awb |
[O] String
|
|
|
invoices.orders.shipments.goodsLines.detailLines.measurement
| grossWeight |
[O] Number
|
3 decimals
|
Kilograms. |
| netWeight |
[O] Number
|
3 decimals
|
Kilograms. |
| chargeableWeight |
[O] Number
|
3 decimals
|
Kilograms. |
| quantity |
[O] Number
|
|
|
| volume |
[O] Number
|
3 decimals
|
Cubic metres. |
| volumeWeight |
[O] Number
|
3 decimals
|
Kilograms. Usually only used for air freight. |
| loadIndex |
[O] Number
|
3 decimals
|
|
| palletPlaces |
[O] Number
|
3 decimals
|
|
invoices.orders.shipments.goodsLines.dangerousGoods
| code |
[M] String
|
Max 4 char
Pattern: ^[0-9]{1,4}$
|
UN code. |
| suffix |
[O] String
|
Max 3 char
Pattern: ^[0-9]{1,3}$
|
|
| tunnelCode |
[O] String
|
|
|