Transport
Invoicing
Invoicing Common Objects

Invoicing Common Objects

InvoicingParty


"...": {
    "accountNumber": "11111",
    "name1": "CARGO-PARTNER",
    "name2": "string",
    "name3": "string",
    "street": "Teststreet 20",
    "city": "VIENNA",
    "zipCode": "1010",
    "countryCode": "AT",
    "vatId": "AT5222349705",
    "taxNumber": "3222339705",
    "commercialRegisterNumber": "322-233-9705"
}

PropertyTypeMandatoryDescription
accountNumberStringMSPOT internal account number. This is used to associate the invoice with the company or office
name1StringM
name2StringO
name3StringO
streetStringM
cityStringM
zipCodeStringM
countryCodeStringMISO country code (ISO 3166-1 Alpha-2).
vatIdStringCOnly available & mandatory for InvoicingRecipient & InvoicingParty
taxNumberStringCOnly available & mandatory for InvoicingRecipient & InvoicingParty
commercialRegisterNumberStringCOnly available & mandatory for InvoicingRecipient & InvoicingParty

InvoicingContainers


"...": {
    "containerNumber": "XXGU6079444",
    "containerDimensionCode": "40",
    "packageQuantity": 20,
    "packageTypeCode": "PAL",
    "descriptionOfGoods": "ANY PARTS",
    "grossWeight": 3195.590,
    "measureOfWeight": "kg",
    "volume": 25.008,
    "measureOfVolume": "m³"
}

PropertyTypeMandatoryDescription
containerNumberStringOISO 6346 container number. Required when container references are provided.
containerDimensionCodeStringOISO 6346 container dimension Code. Mandatory for SEA FCL. e.g. 22GP, 45HC.
packageQuantityIntegerOPackage quantity
packageTypeCodeStringOSPOT package type code (Package type code list)
descriptionOfGoodsStringOGoods description on container level
grossWeightBigDecimalOWeight of goods
measureOfWeightStringOMeasure of weight in kg
volumeBigDecimalOVolume of goods
measureOfVolumeStringOMeasure of volume in m³

InvoicingCargoDetails


"...": {
    "cargoDescription": "ANY DESCRITON OF THE CARGO",
    "grossWeight": 11409.49,
    "chargeableWeight": 11409.49,
    "measureOfWeight": "kg",
    "volume": 82.566,
    "measureOfVolume": "m³"
}

PropertyTypeMandatoryDescription
cargoDescriptionStringOCargo description overall per position
grossWeightBigDecimalOGross weight of goods per position
chargeableWeightBigDecimalOChargeable weight of goods per position
measureOfWeightStringOMeasure of weight in kg
volumeBigDecimalOVolume of goods per position
measureOfVolumeStringOMeasure of volume in m³

InvoiceHeader

"...": {
	"clientCustomerNumber": "164825",
	"clientEmailAddress": "test@customermail.com",
	"clientEmailAddresses":{
      "clientEmailAddress": 
			[
            "test1@company.com",
            "test2@company.com",
            "test3@company.com"
           ]},
	"invoiceDate": {...},
	"invoiceNumber": "2011406",
	"shipper": {...},
	"consignee": {...},
	"documents": [{...}]
}
PropertyTypeLengthMandatoryDescription
clientCustomerNumberString20OCustomer's optional reference number.
clientEmailAddressesArray[ClientEmailAddress]OCustomer's email address for confirmations from tax authority
invoiceDateApiDate10MDate of the invoice, time is not used.
invoiceNumberString8MInvoice number.
shipperCustomsPartyMShipper.
consigneeCustomsPartyMConsignee.
documentsArray[CustomsDocuments]MDocuments for customs declaration.

InvoicePosition

"...": {
		"itemCode": "1513",
		"itemDescription": "Printer",
		"customsTariffNumber": "8514684153",
		"deliveryNoteNumber": "11156",
		"quantity": 3,
		"measureOfQuantity": "LFM",
		"specialQuantity": 52.50,
		"specialMeasureOfQuantity": "qm",
		"totalPrice": 185.20,
		"netWeight": 2.48,
		"procedureCode": 1000,
		"additionalProcedureCode": 000,
		"countryOfOrigin": "AT",
		"documents": [{...}]
	}
PropertyTypeLengthMandatoryDescription
itemCodeString30MItem code.
itemDescriptionString60MDescription of item.
customsTariffNumberString10MCustoms tariff code.
deliveryNoteNumberString20ODelivery note number.
quantityBigDecimal13,2MQuantity of regular unit of measure items.
measureOfQuantityString4ORegular measure of quantity for position item. (e.g. litres, meters, kilograms, etc.) According to the authority's guideline and field "customsTariffNumber".
specialQuantityBigDecimal16,3CQuantity of special unit of measure items.
specialMeasureOfQuantityString4OSpecial customs measure of quantity for position item. According to the authority's guideline and field "customsTariffNumber".
totalPriceBigDecimal16,2MTotal price of position.
netWeightBigDecimal11,2OWeight of item (i.e. for each position) in KG w/o packaging.
procedureCodeString4OProcedure code for the customs process
additionalProcedureCodeString3OAdditional code for detailed specification of the process
countryOfOriginString2OCountry of origin for the customs position
documentsArray[CustomsDocuments]CDocuments for customs declaration.

InvoiceFooter

"...": {
	"freightCosts": 45.66,
	"currencyCode": "EUR",
	"invoiceNumber": 196.25
}
PropertyTypeLengthMandatoryDescription
freightCostsBigDecimal10,3ODeductible costs of freight can be provided if necessary. If this field is left empty, the amount "0" is assumed.
currencyCodeString3MISO 4217 three letter currency code.
invoiceTotalBigDecimal16,2MGrand total of invoice.

Packaging

"...": {
	"packageType": "PK",
	"grossWeight": "196.25",
	"packagesTotal": 15
}
PropertyTypeLengthMandatoryDescription
packageTypeString3OPackaging units of the article. This value needs to be always "PK".
grossWeightBigDecimal11,3CTotal weight of all articles in KG with packaging.
packagesTotalInteger7MTotal packages of invoice.

CustomsParty

"...": {
	"partyCode": 654684,
	"name": "",
	"address": "Teststreet 20",
	"city": "Vienna",
	"zipCode": "1010",
	"countryCode": "AT"
}
PropertyTypeLengthMandatoryDescription
partyCodeInteger20OCustomer account number, can be retrieved from operational business contact
nameString70M
addressString35M
cityString35M
zipCodeString9O
countryCodeString2MISO country code (ISO 3166-1 Alpha-2).

CustomsDocuments

A customs clearance requires documents. Here can you place which document will be used.

"...": {
	"documentType": "N325",
	"referenceNumber": "a12345678"
}
PropertyTypeLengthMandatoryDescription
documentTypeString4MA list of all document types can be found HERE (opens in a new tab) available. E.g. "N325" starting at page 164
referenceNumberString20MReference for each document must be provided here.

ClientEmailAddress

A customs clearance requires documents. Here can you place which document will be used.

"...": {
            "clientEmailAddress": 
			[
              "test1@company.com",
              "test2@company.com",
              "test3@company.com"
            ]
}
PropertyTypeLengthMandatoryDescription
clientEmailAddressString60MClient Email address