Invoice
RECEIVE Invoice
messageType: Invoice
{
"messageHeader": {...},
"invoice": {...}
}Sample files:
The sample files provided are based on real invoices where parties and references have been changed for privacy reasons.
You can also get into contact with our Integration Competence Center and we will provide you with real examples based on your shipments.
| Property | Type | Mandatory | Description |
|---|---|---|---|
| messageHeader | MessageHeader | M | Message Header information |
| invoice | Invoice | M | Invoice information |
Invoice
"...": {
"invoiceHeader": {...},
"invoicePositions": [{...}]
}| Property | Type | Mandatory | Description |
|---|---|---|---|
| invoiceHeader | InvoiceHeader | M | Invoice header information |
| invoicePositions | Array[InvoicePositions] | M | Invoice positions information |
InvoiceHeader
"...": {
"invoiceNumber": "AUT 606350/2022",
"invoicingParty": {...},
"invoiceRecipient": {...},
"invoiceNetValue": 19362.00,
"invoiceVatValue": 0.00,
"invoiceGrossValue": 19362.00,
"invoiceCurrencyCode": "EUR",
"localNetValue": 19362.00,
"localVatValue": 0.00,
"localGrossValue": 19362.00,
"localCurrencyCode": "EUR",
"localExchangeRate": 1.00,
"voucherType": "invoice",
"collectiveInvoice": false,
"invoiceDate": "2022-01-28",
"issueDate": "2022-01-28",
"periodOfPayment": 60,
"dueDateOfPayment": "2022-02-10"
}| Property | Type | Mandatory | Description |
|---|---|---|---|
| invoiceNumber | String | M | Invoice or creditNote number. E.g. AUT 999999/2022. |
| invoicingParty | InvoicingParty | M | Party that is issueing the invoice |
| invoiceRecipient | InvoicingParty | M | Party receiving the invoice |
| invoiceNetValue | BigDecimal | M | Net value in document currency |
| invoiceVatValue | BigDecimal | M | Vat value in document currency |
| invoiceGrossValue | BigDecimal | M | Gross value in document currency |
| invoiceCurrencyCode | string | M | Currency code in document currency |
| localNetValue | BigDecimal | M | Net amount in local currency |
| localVatValue | BigDecimal | M | VAT amount in local currency |
| localGrossValue | BigDecimal | M | Gross value in local currency |
| localCurrencyCode | string | M | Currency code in local currency |
| localExchangeRate | BigDecimal | M | Exchange rate local |
| voucherType | string | M | Information about the document type. Valid values: invoice, creditNote, storno |
| referencedInvoiceNumber | String | C | Mandatory for credit note, debit note, storno. Identifies the original invoice |
| collectiveInvoice | Boolean | M | Collective invoice confirmation. Collective invoice contains multiple invoice positions based on collected shipments |
| invoiceDate | ApiDate | M | Document creation date |
| issueDate | ApiDate | M | Document issue date |
| periodOfPayment | Integer | M | Period of payment in days |
| dueDateOfPayment | ApiDate | M | Due date of payment |
InvoicePositions
"...": {
"sequenceNumber": 1,
"positionInvoiceNumber": "AUT 606350/2022",
"positionReference": "111111",
"spotId": "111111111",
"customerReference": "test",
"serviceDateFrom": "2022-01-28",
"positionNetValue": 19362.00,
"positionVatValue": 0.00,
"positionGrossValue": 19362.00,
"positionCurrencyCode": "EUR",
"positionLocalNetValue": 19362.00,
"positionLocalVatValue": 0.00,
"positionLocalGrossValue": 19362.00,
"positionLocalCurrencyCode": "EUR",
"positionLocalExchangeRate": 1.00,
"positionDescription": "SPOT-ID: 111111111",
"costBreakdownLines": [{...}],
"orderNumbers": [...],
"shipmentDetails": [{...}],
"freeTexts": [...],
"accountingTexts": [...]
}| Property | Type | Mandatory | Description |
|---|---|---|---|
| sequenceNumber | Integer | M | Invoice position iteration. Starts with 1. |
| positionInvoiceNumber | String | M | Invoice number |
| positionReference | String | M | Position number |
| spotId | String | M | Shipment number in SPOT |
| customerReference | String | M | Customer order reference |
| serviceDateFrom | Date | M | Date on which services rendered |
| positionNetValue | BigDecimal | M | Net value |
| positionVatValue | BigDecimal | M | Vat value |
| positionGrossValue | BigDecimal | M | Gross value |
| positionCurrencyCode | String | M | Currency code |
| positionLocalNetValue | BigDecimal | M | Local net value |
| positionLocalVatValue | BigDecimal | M | Local vat value |
| positionLocalGrossValue | BigDecimal | M | Local gross value |
| positionLocalCurrencyCode | String | M | Local currency code |
| positionLocalExchangeRate | BigDecimal | M | Local exchange rate |
| positionDescription | String | M | SPOT-ID (Shipment number) |
| costBreakdownLines | Array[CostBreakdownLines] | M | Additional cost breakdown lines |
| orderNumbers | Array[String] | O | Customer order numbers |
| shipmentDetails | Array[ShipmentDetails] | M | Additional shipment details |
| freeTexts | Array[String] | O | Additional free text |
| accountingTexts | Array[String] | M | Additional bank and payment terms details |
CostBreakdownLines
"...": {
"lineIndex": 1,
"costType": "10",
"costTypeText": "Air Freight",
"netAmount": 20.00,
"grossAmount": 25.00,
"vatAmount": 5.00,
"vatPercentage": 25.00
}| Property | Type | Mandatory | Description |
|---|---|---|---|
| lineIndex | Integer | M | Position line iteration. Starts with 1. |
| costType | String | M | Position line type code identifier |
| costTypeText | String | M | Posiition line short description |
| netAmount | BigDecimal | M | Net value |
| grossAmount | BigDecimal | M | Gross value |
| vatAmount | BigDecimal | M | VAT amount |
| vatPercentage | BigDecimal | M | VAT percentage |
ShipmentDetails
"...": {
"deliveryTermCode": "CIF",
"mainModality": "SEA",
"mainCategory": "FCL",
"shipper": {...},
"consignee": {...},
"mawb": "XXXXX4444444444",
"hawb": "XXXX33333333333",
"mbl": "XXXXX6666666666",
"hbl": "XXXX2222222222222",
"vesselName": "Okee Alicia",
"portOfLoading": "DEHAM",
"portOfDischarge": "HAIFA",
"etd": "2022-06-04",
"eta": "2022-06-04",
"containers": [{...}],
"containerNumbers": [...],
"cargoDetails": [{...}]
}| Property | Type | Mandatory | Description |
|---|---|---|---|
| deliveryTermCode | String | M | 3-letter Incoterms® code. (List of Incoterms®). |
| mainModality | String | M | Modality of transport. Valid values: AIR, SEA, ROAD, RAIL |
| mainCategory | String | M | Defines the subtype of the transport modality. Mandatory for SEA & ROAD. Valid values for ROAD: FTL, LTL, GROUPAGE. Valid values for SEA: FCL, LCL, REEFER |
| shipper | InvoicingParty | M | Shipper |
| consignee | InvoicingParty | M | Consignee |
| mawb | String | O | Master-AWB number |
| hawb | String | O | House-AWB number |
| mbl | String | O | Master-BoL number |
| hbl | String | O | House-BoL number |
| vesselName | String | O | Name of carrier vessel |
| portOfLoading | String | O | UNLOCODE 5-letter location code. |
| portOfDischarge | String | O | UNLOCODE 5-letter location code. |
| etd | String | O | Estimated / Expected Time of Departure |
| eta | String | O | Estimated / Expected Time of Arrival |
| containers | InvoicingContainers | O | Containers details |
| containerNumbers | [Array]String | O | List of all available container numbers |
| cargoDetails | InvoicingCargoDetails | O | Overall cargo description |