Common Objects - EDI Portal Spotworx

Customs Common Objects

Create declarations in our customs system.

CustomsDeclaration

"...": {
	"accountId": 9999,
	"orderId": "I-12345678909",
	"deliveryTerm": {...},
	"customsBorder":"AT600000",
	"eoriNumber": "",
	"invoice": {...},
	"packaging":  {...}
}

Property	Type	Length	Mandatory	Description
accountId	Integer	8	M	Will be provided by us. Identification for each customer (i.e. exporter).
orderId	String	20	M	Unique identifier for invoice.
deliveryTerm	DeliveryTerm		M	3-letter Incoterms® code.
customsBorder	String	8	O	Customs border (exit) identifier corresponding to EC_10000 codelist.
eoriNumber	String	17	O	EORI number.
invoice	Invoice		M	Main invoice part.
packaging	Packaging		M	Packaging of invoice.

Invoice

JSON XML

"...": {
	"invoiceHeader": {...},
	"invoicePositions": [{...}],
	"invoiceFooter": {...}
}

Property	Type	Mandatory	Description
invoiceHeader	InvoiceHeader	M	Header of invoice.
invoicePosition	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": [{...}],
	"transportIdentification": {...}
}

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,
		"totalPrice": 185.20,
		"netWeight": 2.48,
		"procedureCode": 1000,
		"additionalProcedureCode": 000,
		"countryOfOrigin": "AT"
	}

Property	Type	Length	Mandatory	Description
itemCode	String	30	M	Item code.
itemDescription	String	30	M	Description of item.
customsTariffNumber	String	10	M	Customs tariff code.
deliveryNoteNumber	String	20	O	Delivery note number.
quantity	BigDecimal	13	M	Quantity of items. The unit (e.g. litres, meters, kilograms, etc.) is implied by the field "customsTariffNumber" according to authority's guideline.
totalPrice	BigDecimal	16	M	Total price of position.
netWeight	BigDecimal	10	O	Weight of item (i.e. for each position) in KG w/o packaging.
procedureCode	String	4	O	Procedure code for the customs process. NC_36000 standard.
additionalProcedureCode	String	3	O	Additional code for detailed specification of the procedure. NC_37000 standard.
countryOfOrigin	String	2	O	Country of origin for position

InvoiceFooter

JSON XML

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

Property	Type	Length	Mandatory	Description
freightCosts	BigDecimal	10	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		M	Grand total of invoice.

Packaging

JSON XML

"...": [{
	"packageType": "PK",
	"grossWeight": 196.25,
	"packagesTotal": 15,
	"packageReference": "1232344"
}]

Property	Type	Length	Mandatory	Description
packageType	string	20	M	Packaging units of the article. This value needs to be always "PK".
grossWeight	BigDecimal	10	C	Total weight of all articles in KG with packaging.
packagesTotal	BigDecimal	8	M	Total packages of invoice.
packageReference	String	42	O	Packaging identification. E.g. MAWB

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 on this PAGE (opens in a new tab). Download the Current Report (Aktueller Report) PDF document available under the Code lists (Codelisten) section.
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.

TransportIdentification

Transport Identification

JSON XML

"...":{
	"transportTypeAtDeparture": "3",
    "transportIdentityAtDeparture": "LKW",
    "transportNationalityAtDeparture": "AT",
    "transportTypeCrossingBorder": "3",
    "transportIdentityCrossingBorder": "LKW",
    "transportNationalityCrossingBorder": "AT"
}

Property	Type	Length	Mandatory	Description
transportTypeAtDeparture	String	2	M	Type of means of transport at departure. NC_20000 one letter code , like valid values: 3 (LKW), 4 (AIR), etc.
transportIdentityAtDeparture	String	27	M	Identity of means of transport at departure. In case of `LKW` the licence plate number.
transportNationalityAtDeparture	String	2	M	Nationality of means of transport at departure, e.g. `AT`.
transportTypeCrossingBorder	String	2	M	Type of means of transport crossing border. NC_20000 one letter code , like valid values: 3 (LKW), 4 (AIR), etc.
transportIdentityCrossingBorder	String	27	M	Identity of means of transport crossing border. In case of `LKW` the licence plate number.
transportNationalityCrossingBorder	String	2	M	Nationality of means of transport crossing border, e.g. `DE`.

Reimport Customs Declaration Purchase Order