Transport
Invoicing
Invoice

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.

PropertyTypeMandatoryDescription
messageHeaderMessageHeaderMMessage Header information
invoiceInvoiceMInvoice information

Invoice

"...": {
  "invoiceHeader": {...},
  "invoicePositions": [{...}]
}
PropertyTypeMandatoryDescription
invoiceHeaderInvoiceHeaderMInvoice header information
invoicePositionsArray[InvoicePositions]MInvoice 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"
}
PropertyTypeMandatoryDescription
invoiceNumberStringMInvoice or creditNote number. E.g. AUT 999999/2022.
invoicingPartyInvoicingPartyMParty that is issueing the invoice
invoiceRecipientInvoicingPartyMParty receiving the invoice
invoiceNetValueBigDecimalMNet value in document currency
invoiceVatValueBigDecimalMVat value in document currency
invoiceGrossValueBigDecimalMGross value in document currency
invoiceCurrencyCodestringMCurrency code in document currency
localNetValueBigDecimalMNet amount in local currency
localVatValueBigDecimalMVAT amount in local currency
localGrossValueBigDecimalMGross value in local currency
localCurrencyCodestringMCurrency code in local currency
localExchangeRateBigDecimalMExchange rate local
voucherTypestringMInformation about the document type. Valid values: invoice, creditNote, storno
referencedInvoiceNumberStringCMandatory for credit note, debit note, storno. Identifies the original invoice
collectiveInvoiceBooleanMCollective invoice confirmation. Collective invoice contains multiple invoice positions based on collected shipments
invoiceDateApiDateMDocument creation date
issueDateApiDateMDocument issue date
periodOfPaymentIntegerMPeriod of payment in days
dueDateOfPaymentApiDateMDue 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": [...]
}
PropertyTypeMandatoryDescription
sequenceNumberIntegerMInvoice position iteration. Starts with 1.
positionInvoiceNumberStringMInvoice number
positionReferenceStringMPosition number
spotIdStringMShipment number in SPOT
customerReferenceStringMCustomer order reference
serviceDateFromDateMDate on which services rendered
positionNetValueBigDecimalMNet value
positionVatValueBigDecimalMVat value
positionGrossValueBigDecimalMGross value
positionCurrencyCodeStringMCurrency code
positionLocalNetValueBigDecimalMLocal net value
positionLocalVatValueBigDecimalMLocal vat value
positionLocalGrossValueBigDecimalMLocal gross value
positionLocalCurrencyCodeStringMLocal currency code
positionLocalExchangeRateBigDecimalMLocal exchange rate
positionDescriptionStringMSPOT-ID (Shipment number)
costBreakdownLinesArray[CostBreakdownLines]MAdditional cost breakdown lines
orderNumbersArray[String]OCustomer order numbers
shipmentDetailsArray[ShipmentDetails]MAdditional shipment details
freeTextsArray[String]OAdditional free text
accountingTextsArray[String]MAdditional 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
}
PropertyTypeMandatoryDescription
lineIndexIntegerMPosition line iteration. Starts with 1.
costTypeStringMPosition line type code identifier
costTypeTextStringMPosiition line short description
netAmountBigDecimalMNet value
grossAmountBigDecimalMGross value
vatAmountBigDecimalMVAT amount
vatPercentageBigDecimalMVAT 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": [{...}]
}
PropertyTypeMandatoryDescription
deliveryTermCodeStringM3-letter Incoterms® code. (List of Incoterms®).
mainModalityStringMModality of transport. Valid values: AIR, SEA, ROAD, RAIL
mainCategoryStringMDefines the subtype of the transport modality. Mandatory for SEA & ROAD. Valid values for ROAD: FTL, LTL, GROUPAGE. Valid values for SEA: FCL, LCL, REEFER
shipperInvoicingPartyMShipper
consigneeInvoicingPartyMConsignee
mawbStringOMaster-AWB number
hawbStringOHouse-AWB number
mblStringOMaster-BoL number
hblStringOHouse-BoL number
vesselNameStringOName of carrier vessel
portOfLoadingStringOUNLOCODE 5-letter location code.
portOfDischargeStringOUNLOCODE 5-letter location code.
etdStringOEstimated / Expected Time of Departure
etaStringOEstimated / Expected Time of Arrival
containersInvoicingContainersOContainers details
containerNumbers[Array]StringOList of all available container numbers
cargoDetailsInvoicingCargoDetailsOOverall cargo description