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"
}

Property	Type	Mandatory	Description
accountNumber	String	M	SPOT internal account number. This is used to associate the invoice with the company or office
name1	String	M
name2	String	O
name3	String	O
street	String	M
city	String	M
zipCode	String	M
countryCode	String	M	ISO country code (ISO 3166-1 Alpha-2).
vatId	String	C	Only available & mandatory for InvoicingRecipient & InvoicingParty
taxNumber	String	C	Only available & mandatory for InvoicingRecipient & InvoicingParty
commercialRegisterNumber	String	C	Only available & mandatory for InvoicingRecipient & InvoicingParty

InvoicingContainers

JSON XML

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

Property	Type	Mandatory	Description
containerNumber	String	O	ISO 6346 container number. Required when container references are provided.
containerDimensionCode	String	O	ISO 6346 container dimension Code. Mandatory for SEA FCL. e.g. 22GP, 45HC.
packageQuantity	Integer	O	Package quantity
packageTypeCode	String	O	SPOT package type code (Package type code list)
descriptionOfGoods	String	O	Goods description on container level
grossWeight	BigDecimal	O	Weight of goods
measureOfWeight	String	O	Measure of weight in kg
volume	BigDecimal	O	Volume of goods
measureOfVolume	String	O	Measure of volume in m³

InvoicingCargoDetails

JSON XML

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

Property	Type	Mandatory	Description
cargoDescription	String	O	Cargo description overall per position
grossWeight	BigDecimal	O	Gross weight of goods per position
chargeableWeight	BigDecimal	O	Chargeable weight of goods per position
measureOfWeight	String	O	Measure of weight in kg
volume	BigDecimal	O	Volume of goods per position
measureOfVolume	String	O	Measure of volume in m³

Property	Type	Mandatory	Description
invoiceHeader	InvoiceHeader	M	Header of invoice.
invoicePositions	Array[InvoicePosition]	M	Positions of invoice.
invoiceFooter	InvoiceFooter	M	Footer of invoice.

InvoiceHeader

JSON XML

"...": {
	"clientCustomerNumber": "164825",
	"clientEmailAddress": "test@customermail.com",
	"clientEmailAddresses":{
      "clientEmailAddress": 
			[
            "test1@company.com",
            "test2@company.com",
            "test3@company.com"
           ]},
	"invoiceDate": {...},
	"invoiceNumber": "2011406",
	"shipper": {...},
	"consignee": {...},
	"documents": [{...}]
}

Property	Type	Length	Mandatory	Description
clientCustomerNumber	String	20	O	Customer's optional reference number.
clientEmailAddresses	Array[ClientEmailAddress]		O	Customer's email address for confirmations from tax authority
invoiceDate	ApiDate	10	M	Date of the invoice, time is not used.
invoiceNumber	String	8	M	Invoice number.
shipper	CustomsParty		M	Shipper.
consignee	CustomsParty		M	Consignee.
documents	Array[CustomsDocuments]		M	Documents for customs declaration.

InvoicePosition

JSON XML

"...": {
		"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": [{...}]
	}

Property	Type	Length	Mandatory	Description
itemCode	String	30	M	Item code.
itemDescription	String	60	M	Description of item.
customsTariffNumber	String	10	M	Customs tariff code.
deliveryNoteNumber	String	20	O	Delivery note number.
quantity	BigDecimal	13,2	M	Quantity of regular unit of measure items.
measureOfQuantity	String	4	O	Regular measure of quantity for position item. (e.g. litres, meters, kilograms, etc.) According to the authority's guideline and field "customsTariffNumber".
specialQuantity	BigDecimal	16,3	C	Quantity of special unit of measure items.
specialMeasureOfQuantity	String	4	O	Special customs measure of quantity for position item. According to the authority's guideline and field "customsTariffNumber".
totalPrice	BigDecimal	16,2	M	Total price of position.
netWeight	BigDecimal	11,2	O	Weight of item (i.e. for each position) in KG w/o packaging.
procedureCode	String	4	O	Procedure code for the customs process
additionalProcedureCode	String	3	O	Additional code for detailed specification of the process
countryOfOrigin	String	2	O	Country of origin for the customs position
documents	Array[CustomsDocuments]		C	Documents for customs declaration.

InvoiceFooter

JSON XML

"...": {
	"freightCosts": 45.66,
	"currencyCode": "EUR",
	"invoiceNumber": 196.25
}

Property	Type	Length	Mandatory	Description
freightCosts	BigDecimal	10,3	O	Deductible costs of freight can be provided if necessary. If this field is left empty, the amount "0" is assumed.
currencyCode	String	3	M	ISO 4217 three letter currency code.
invoiceTotal	BigDecimal	16,2	M	Grand total of invoice.

Packaging

JSON XML

"...": {
	"packageType": "PK",
	"grossWeight": "196.25",
	"packagesTotal": 15
}

Property	Type	Length	Mandatory	Description
packageType	String	3	O	Packaging units of the article. This value needs to be always "PK".
grossWeight	BigDecimal	11,3	C	Total weight of all articles in KG with packaging.
packagesTotal	Integer	7	M	Total packages of invoice.

CustomsParty

JSON XML

"...": {
	"partyCode": 654684,
	"name": "",
	"address": "Teststreet 20",
	"city": "Vienna",
	"zipCode": "1010",
	"countryCode": "AT"
}

Property	Type	Length	Mandatory	Description
partyCode	Integer	20	O	Customer account number, can be retrieved from operational business contact
name	String	70	M
address	String	35	M
city	String	35	M
zipCode	String	9	O
countryCode	String	2	M	ISO country code (ISO 3166-1 Alpha-2).

CustomsDocuments

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

JSON XML

"...": {
	"documentType": "N325",
	"referenceNumber": "a12345678"
}

Property	Type	Length	Mandatory	Description
documentType	String	4	M	A list of all document types can be found HERE (opens in a new tab) available. E.g. "N325" starting at page 164
referenceNumber	String	20	M	Reference for each document must be provided here.

ClientEmailAddress

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

JSON XML

"...": {
            "clientEmailAddress": 
			[
              "test1@company.com",
              "test2@company.com",
              "test3@company.com"
            ]
}

Property	Type	Length	Mandatory	Description
clientEmailAddress	String	60	M	Client Email address

Invoice Transport Common Objects