Technische opbouw van de JSON

Download - Shipments.json
Download - Deliverys.json

Inleiding

Met Shipments.JSON levert een ERP-systeem logistieke gegevens van een Zending aan bij Stratech Shipment. De Zending vormt het centrale exportdossier. Binnen dit dossier kunnen Leveringen, documenten, aangiften, taken en andere gegevens uit het exportproces samenkomen.

Een Zending kan zonder Leveringen of met één of meer Leveringen worden aangeleverd. Een Levering beschrijft wat daadwerkelijk wordt geleverd. Als de Leveringen tijdens de import al bij de Zending bekend zijn, kunnen deze in shipment.deliveries worden opgenomen.

Stratech Shipment gebruikt de aangeleverde logistieke gegevens om te bepalen welke documenten, certificaten en aangiften relevant zijn. De Dossiers API moet daarbij niet worden gezien als een rechtstreekse documentgenerator. De aangeleverde JSON vormt de logistieke basis voor het verdere exportproces.

Let op: deze documentatie beschrijft een Proof of Concept van de koppeling. De JSON-structuur, veldnamen, gegevenstypen en verwerking kunnen tijdens de verdere ontwikkeling worden aangepast. Aan deze beschrijving kunnen nog geen definitieve implementatie- of compatibiliteitsafspraken worden ontleend.

Basisstructuur

Het JSON-bericht bestaat op het hoogste niveau uit:

shipmentReferenceId: de technische referentie van de Zending;
shipment: het object met de inhoudelijke gegevens van de Zending.

Wanneer Leveringen direct met de Zending worden aangeleverd, staan deze in de array shipment.deliveries.

{
    "shipmentReferenceId": "string",
    "shipment": {
        "shipmentNumber": "string",
        "deliveries": [{
                "deliveryReferenceId": "string",
                "delivery": {
                    "deliveryNumber": "string",
                    "goodsItem": []
                }
            }
        ]
    }
}

Een Zending kan binnen de POC ook zonder Leveringen worden aangeleverd. De uiteindelijke afspraak over het weglaten van deliveries of het aanleveren van een lege array moet nog worden vastgesteld.

Leeswijzer

Term	Betekenis
`string`	Tekstwaarde. Codes, datums en tijden worden in JSON ook als string aangeleverd.
`number`	Numerieke waarde, eventueel met decimalen.
`integer`	Geheel getal.
`boolean`	Waarde `true` of `false`.
`object`	Samengesteld JSON-object met onderliggende velden.
`array`	Verzameling van nul, één of meer waarden of objecten.

De waarden in het POC-bestand, zoals "string", willekeurige codes en grote numerieke waarden, zijn bedoeld om het gegevenstype of de beschikbare ruimte te illustreren. Deze waarden vormen geen gevalideerde codelijst of definitieve beperking.

Rootvelden

JSON-pad	Type	Omschrijving
`shipmentReferenceId`	string	Technische referentie waarmee het aanleverende ERP-systeem de Zending identificeert.
`shipment`	object	Bevat de inhoudelijke gegevens van de Zending.

Technische referentie en bedrijfsnummer

Voor een Zending worden in de POC twee identificaties gebruikt:

JSON-pad	Omschrijving
`shipmentReferenceId`	Technische integratiereferentie waarmee het ERP-systeem naar de Zending verwijst.
`shipment.shipmentNumber`	Bedrijfsnummer waarmee de Zending functioneel kan worden herkend.

De definitieve regels voor uniciteit, maximale lengte, toegestane tekens, hoofdlettergevoeligheid en hergebruik van deze waarden moeten nog worden vastgesteld.

Zending: Algemene Zendinggegevens

JSON-pad	Type	Omschrijving
`shipment.shipmentNumber`	string	Bedrijfsnummer van de Zending.
`shipment.userFullName`	string	Volledige naam van de gebruiker die bij de Zending wordt vastgelegd.
`shipment.communicationLanguageAtDeparture`	string	Taalcode voor de communicatie bij vertrek.
`shipment.destinationCountry`	string	Landcode van het land van bestemming.
`shipment.bookingReferenceNumber`	string	Referentienummer van de boeking.
`shipment.terminal`	string	Terminal die bij de Zending hoort.
`shipment.exitOfficeCode`	string	Code van het kantoor van uitgang.
`shipment.dateOfDispatch`	string	Datum van vertrek. Het POC-voorbeeld gebruikt de notatie `YYYY-MM-DD`.
`shipment.timeOfDispatch`	string	Tijdstip van vertrek. Het POC-voorbeeld bevat een tijd met milliseconden en `Z`.
`shipment.totalGrossWeight`	number	Totaal brutogewicht van de Zending. De gewichtseenheid is nog niet vastgelegd.
`shipment.divergentTotalPackagesAmount`	integer	Afwijkend totaal aantal verpakkingen. De precieze toepassing moet nog worden vastgesteld.
`shipment.isContainerShipment`	boolean	Geeft aan of de Zending als containerzending wordt behandeld.
`shipment.deliveries`	array	Leveringen die samen met de Zending worden aangeleverd.

Afzender

Object: shipment.consignor

JSON-pad	Type	Omschrijving
`shipment.consignor`	object	Afzender van de Zending.
`shipment.consignor.code`	string	Code waarmee de afzender wordt geïdentificeerd.

Ontvanger

Object: shipment.consignee

JSON-pad	Type	Omschrijving
`shipment.consignee`	object	Ontvanger van de Zending.
`shipment.consignee.code`	string	Code van de ontvanger.
`shipment.consignee.oneTimeAddress`	object	Eenmalige adresgegevens van de ontvanger.
`shipment.consignee.oneTimeAddress.name`	string	Naam van de ontvanger.
`shipment.consignee.oneTimeAddress.streetName`	string	Straatnaam.
`shipment.consignee.oneTimeAddress.streetNumber`	string	Huis- of straatnummer.
`shipment.consignee.oneTimeAddress.postcode`	string	Postcode.
`shipment.consignee.oneTimeAddress.city`	string	Plaatsnaam.
`shipment.consignee.oneTimeAddress.country`	object	Land van het eenmalige adres.
`shipment.consignee.oneTimeAddress.country.code`	string	Landcode.
`shipment.consignee.oneTimeAddress.country.name`	string	Landnaam.
`shipment.consignee.oneTimeAddress.eoriNumber`	string	EORI-nummer van de ontvanger.

Vervoerder

Object: shipment.carrier

JSON-pad	Type	Omschrijving
`shipment.carrier`	object	Vervoerder van de Zending.
`shipment.carrier.code`	string	Code van de vervoerder.
`shipment.carrier.oneTimeAddress`	object	Eenmalige adresgegevens van de vervoerder.
`shipment.carrier.oneTimeAddress.name`	string	Naam van de vervoerder.
`shipment.carrier.oneTimeAddress.streetName`	string	Straatnaam.
`shipment.carrier.oneTimeAddress.streetNumber`	string	Huis- of straatnummer.
`shipment.carrier.oneTimeAddress.postcode`	string	Postcode.
`shipment.carrier.oneTimeAddress.city`	string	Plaatsnaam.
`shipment.carrier.oneTimeAddress.country`	object	Land van het eenmalige adres.
`shipment.carrier.oneTimeAddress.country.code`	string	Landcode.
`shipment.carrier.oneTimeAddress.country.name`	string	Landnaam.
`shipment.carrier.oneTimeAddress.eoriNumber`	string	EORI-nummer van de vervoerder.
`shipment.carrier.oneTimeAddress.vatNumber`	string	Btw-nummer van de vervoerder.

Garantsteller

JSON-pad	Type	Omschrijving
`shipment.guarantorType`	string	Type of code van de garantstelling of garantsteller.
`shipment.guarantor`	array	Verzameling garantstellers.
`shipment.guarantor[].code`	string	Code van de garantsteller.
`shipment.guarantor[].oneTimeAddress`	object	Eenmalige adresgegevens van de garantsteller.
`shipment.guarantor[].oneTimeAddress.name`	string	Naam van de garantsteller.
`shipment.guarantor[].oneTimeAddress.streetName`	string	Straatnaam.
`shipment.guarantor[].oneTimeAddress.streetNumber`	string	Huis- of straatnummer.
`shipment.guarantor[].oneTimeAddress.postcode`	string	Postcode.
`shipment.guarantor[].oneTimeAddress.city`	string	Plaatsnaam.
`shipment.guarantor[].oneTimeAddress.country.code`	string	Landcode.
`shipment.guarantor[].oneTimeAddress.country.name`	string	Landnaam.
`shipment.guarantor[].oneTimeAddress.exciseNumber`	string	Accijnsnummer van de garantsteller.
`shipment.guarantor[].oneTimeAddress.vatNumber`	string	Btw-nummer van de garantsteller.

Transportorganisator

Object: shipment.transportArranger

JSON-pad	Type	Omschrijving
`shipment.transportArranger`	object	Partij die het transport organiseert.
`shipment.transportArranger.code`	string	Code van de transportorganisator.
`shipment.transportArranger.oneTimeAddress`	object	Eenmalige adresgegevens van de transportorganisator.
`shipment.transportArranger.oneTimeAddress.name`	string	Naam van de transportorganisator.
`shipment.transportArranger.oneTimeAddress.streetName`	string	Straatnaam.
`shipment.transportArranger.oneTimeAddress.streetNumber`	string	Huis- of straatnummer.
`shipment.transportArranger.oneTimeAddress.postcode`	string	Postcode.
`shipment.transportArranger.oneTimeAddress.city`	string	Plaatsnaam.
`shipment.transportArranger.oneTimeAddress.country.code`	string	Landcode.
`shipment.transportArranger.oneTimeAddress.country.name`	string	Landnaam.
`shipment.transportArranger.oneTimeAddress.vatNumber`	string	Btw-nummer van de transportorganisator.

Leveringscondities

Object: shipment.termsOfDelivery

JSON-pad	Type	Omschrijving
`shipment.termsOfDelivery`	object	Leverings- en transactiegegevens.
`shipment.termsOfDelivery.incoTerms`	object	Incoterms-gegevens.
`shipment.termsOfDelivery.incoTerms.code`	string	Incoterms-code.
`shipment.termsOfDelivery.incoTerms.countryCode`	string	Landcode die bij de leveringsconditie hoort.
`shipment.termsOfDelivery.incoTerms.place`	string	Plaats waarop de leveringsconditie betrekking heeft.
`shipment.termsOfDelivery.incoTerms.description`	string	Aanvullende omschrijving van de leveringsconditie.
`shipment.termsOfDelivery.paymentMethodCode`	string	Code van de betalingsmethode.
`shipment.termsOfDelivery.transactionNatureCode`	string	Code voor de aard van de transactie.

Transportdocumenten

Array: shipment.transportDocuments

JSON-pad	Type	Omschrijving
`shipment.transportDocuments`	array	Transportdocumenten of documentreferenties op zendingniveau.
`shipment.transportDocuments[].type`	string	Typecode van het transportdocument.
`shipment.transportDocuments[].identification`	string	Nummer of identificatie van het transportdocument.

Financiële gegevens

Object: shipment.financialData

JSON-pad	Type	Omschrijving
`shipment.financialData`	object	Financiële gegevens op zendingniveau.
`shipment.financialData.amountToBeCoveredCurrency`	string	Valutacode van het te dekken bedrag.
`shipment.financialData.amountToBeCovered`	number	Bedrag dat moet worden gedekt.
`shipment.financialData.refundCurrency`	string	Valutacode van het teruggaafbedrag.
`shipment.financialData.refundAmount`	number	Teruggaafbedrag.
`shipment.financialData.totalInvoiceAmount`	number	Totaal factuurbedrag van de Zending.
`shipment.financialData.totalInvoiceCurrency`	string	Valutacode van het totale factuurbedrag.

Transportmaterieel

Array: shipment.transportEquipment

JSON-pad	Type	Omschrijving
`shipment.transportEquipment`	array	Transportmaterieel dat bij de Zending hoort.
`shipment.transportEquipment[].sequenceNumber`	integer	Volgnummer van het transportmaterieel.
`shipment.transportEquipment[].containerNumber`	string	Containernummer.
`shipment.transportEquipment[].seals`	array	Verzegelingen van het transportmaterieel.
`shipment.transportEquipment[].seals[].sealNumber`	string	Nummer van de verzegeling.
`shipment.transportEquipment[].carrierType`	string	Code van het type drager.
`shipment.transportEquipment[].transportType`	string	Type transportmaterieel.
`shipment.transportEquipment[].equipmentGrossWeight`	number	Brutogewicht van het transportmaterieel.

Vervoermiddel bij vertrek

Object: shipment.departureTransportMeans

JSON-pad	Type	Omschrijving
`shipment.departureTransportMeans`	object	Vervoermiddel bij vertrek.
`shipment.departureTransportMeans.transportModeCode`	string	Code van de vervoerswijze.
`shipment.departureTransportMeans.transportIdentity`	array	Identificaties van het vervoermiddel bij vertrek.
`shipment.departureTransportMeans.transportIdentity[].type`	string	Type transportidentificatie.
`shipment.departureTransportMeans.transportIdentity[].identification`	string	Identificatie van het vervoermiddel.
`shipment.departureTransportMeans.transportIdentity[].nationality`	string	Nationaliteits- of landcode van het vervoermiddel.

Vervoermiddel bij de grens

Object: shipment.borderTransportMeans

JSON-pad	Type	Omschrijving
`shipment.borderTransportMeans`	object	Vervoermiddel bij grensoverschrijding.
`shipment.borderTransportMeans.transportModeCode`	string	Code van de vervoerswijze.
`shipment.borderTransportMeans.transportIdentity`	object	Identificatie van het vervoermiddel bij de grens.
`shipment.borderTransportMeans.transportIdentity.type`	string	Type transportidentificatie.
`shipment.borderTransportMeans.transportIdentity.identification`	string	Identificatie van het vervoermiddel.
`shipment.borderTransportMeans.transportIdentity.nationality`	string	Nationaliteits- of landcode van het vervoermiddel.

Route

Array: shipment.route

JSON-pad	Type	Omschrijving
`shipment.route`	array	Landen die onderdeel zijn van de route.
`shipment.route[].countryCode`	string	Landcode van een land in de route.

Goederenlocatie

Object: shipment.goodsLocation

JSON-pad	Type	Omschrijving
`shipment.goodsLocation`	object	Locatie waar de goederen zich bevinden.
`shipment.goodsLocation.locationCode`	string	Code van de goederenlocatie.
`shipment.goodsLocation.provinceName`	string	Naam van de provincie of regio.

Plaats van laden

Object: shipment.placeOfLoading

JSON-pad	Type	Omschrijving
`shipment.placeOfLoading`	object	Plaats waar de goederen worden geladen.
`shipment.placeOfLoading.unLoccode`	string	UN/LOCODE van de laadplaats.

Plaats van verzending

Object: shipment.placeOfDispatch

JSON-pad	Type	Omschrijving
`shipment.placeOfDispatch`	object	Plaats van waaruit de goederen worden verzonden.
`shipment.placeOfDispatch.locationCode`	string	Locatiecode van de plaats van verzending.

Afleverplaats

Object: shipment.deliveryPlace

JSON-pad	Type	Omschrijving
`shipment.deliveryPlace`	object	Plaats waar de goederen worden afgeleverd.
`shipment.deliveryPlace.locationCode`	string	Code van de afleverlocatie.
`shipment.deliveryPlace.oneTimeLocation`	object	Eenmalige afleverlocatie.
`shipment.deliveryPlace.oneTimeLocation.name`	string	Naam van de locatie.
`shipment.deliveryPlace.oneTimeLocation.streetName`	string	Straatnaam.
`shipment.deliveryPlace.oneTimeLocation.streetNumber`	string	Huis- of straatnummer.
`shipment.deliveryPlace.oneTimeLocation.postcode`	string	Postcode.
`shipment.deliveryPlace.oneTimeLocation.city`	string	Plaatsnaam.
`shipment.deliveryPlace.oneTimeLocation.country.code`	string	Landcode.
`shipment.deliveryPlace.oneTimeLocation.country.name`	string	Landnaam.
`shipment.deliveryPlace.oneTimeLocation.exciseNumber`	string	Accijnsnummer van de locatie.
`shipment.deliveryPlace.oneTimeLocation.identificationNumber`	string	Aanvullend identificatienummer van de locatie.

Leveringen

De Levering bevat vergelijkbare partijobjecten als de Zending.

Relatief veld	Type	Omschrijving
`consignor`	object	Afzender van de Levering.
`consignor.code`	string	Code van de afzender.
`consignee`	object	Ontvanger van de Levering.
`consignee.code`	string	Code van de ontvanger.
`consignee.oneTimeAddress`	object	Eenmalig adres van de ontvanger.
`carrier`	object	Vervoerder van de Levering.
`carrier.code`	string	Code van de vervoerder.
`carrier.oneTimeAddress`	object	Eenmalig adres van de vervoerder.
`guarantorType`	string	Type of code van de garantstelling of garantsteller.
`guarantor`	array	Garantstellers van de Levering.
`transportArranger`	object	Partij die het transport organiseert.

De adresobjecten bevatten, afhankelijk van de partij, velden zoals:

name;
streetName;
streetNumber;
postcode;
city;
country.code;
country.name;
eoriNumber;
exciseNumber;
vatNumber.

Niet ieder identificatienummer komt bij ieder partij- of adrestype voor

Leveringen binnen de Zending

De Leveringen die tijdens dezelfde import bij de Zending worden aangeleverd, staan in shipment.deliveries.

JSON-pad	Type	Omschrijving
`shipment.deliveries`	array	Leveringen die samen met de Zending worden geïmporteerd.
`shipment.deliveries[].deliveryReferenceId`	string	Technische integratiereferentie van de Levering.
`shipment.deliveries[].delivery`	object	Inhoudelijke gegevens van de Levering.

Een Levering binnen een Zending heeft in verkorte vorm de volgende structuur:

{
    "deliveryReferenceId": "string",
    "delivery": {
        "deliveryNumber": "string",
        "goodsItem": []
    }
}

Algemene leveringsgegevens

Het basispad voor de velden in deze paragraaf is:

shipment.deliveries[].delivery

Relatief veld	Type	Omschrijving
`deliveryNumber`	string	Bedrijfsnummer van de Levering.
`dateOfDispatch`	string	Datum van vertrek.
`timeOfDispatch`	string	Tijdstip van vertrek.
`bookingReferenceNumber`	string	Boekingsreferentie van de Levering.
`totalGrossWeight`	number	Totaal brutogewicht van de Levering.
`divergentTotalPackagesAmount`	integer	Afwijkend totaal aantal verpakkingen.
`isContainerShipment`	boolean	Geeft aan of de Levering als containerzending wordt behandeld.
`goodsItem`	array	Goederenregels van de Levering.

Leveringscondities van de Levering

Relatief veld	Type	Omschrijving
`termsOfDelivery`	object	Leverings- en transactiegegevens.
`termsOfDelivery.incoTerms`	object	Incoterms-gegevens.
`termsOfDelivery.incoTerms.code`	string	Incoterms-code.
`termsOfDelivery.incoTerms.countryCode`	string	Landcode bij de leveringsconditie.
`termsOfDelivery.incoTerms.place`	string	Plaats bij de leveringsconditie.
`termsOfDelivery.incoTerms.description`	string	Aanvullende omschrijving.
`termsOfDelivery.paymentMethodCode`	string	Code van de betalingsmethode.
`termsOfDelivery.transactionNatureCode`	string	Code voor de aard van de transactie.

Transportdocumenten van de Levering

Relatief veld	Type	Omschrijving
`transportDocuments`	array	Transportdocumenten van de Levering.
`transportDocuments[].type`	string	Typecode van het transportdocument.
`transportDocuments[].identification`	string	Nummer of identificatie van het document.

Financiële gegevens van de Levering

Relatief veld	Type	Omschrijving
`financialData`	object	Financiële gegevens van de Levering.
`financialData.amountToBeCoveredCurrency`	string	Valutacode van het te dekken bedrag.
`financialData.amountToBeCovered`	number	Bedrag dat moet worden gedekt.
`financialData.refundCurrency`	string	Valutacode van het teruggaafbedrag.
`financialData.refundAmount`	number	Teruggaafbedrag.
`financialData.totalInvoiceAmount`	number	Totaal factuurbedrag.
`financialData.totalInvoiceCurrency`	string	Valutacode van het totale factuurbedrag.
`financialData.invoice`	array	Facturen die bij de Levering horen.
`financialData.invoice[].invoiceNumber`	string	Factuurnummer.
`financialData.invoice[].invoiceDate`	string	Factuurdatum. Het POC-voorbeeld gebruikt een datum-tijdnotatie met `Z`.

Transportmaterieel van de Levering

Relatief veld	Type	Omschrijving
`transportEquipment`	array	Verwijzingen naar transportmaterieel van de Zending.
`transportEquipment[].sequenceNumber`	integer	Volgnummer van het transportmaterieel.

De uitgebreide gegevens van het transportmaterieel, zoals het containernummer en de verzegelingen, staan op zendingniveau.

De POC bevestigt nog niet of sequenceNumber altijd naar een gelijk volgnummer in shipment.transportEquipment moet verwijzen.

Transport en locaties van de Levering

Relatief veld	Type	Omschrijving
`departureTransportMeans`	object	Vervoermiddel bij vertrek.
`departureTransportMeans.transportModeCode`	string	Code van de vervoerswijze.
`departureTransportMeans.transportIdentity`	array	Identificaties van het vervoermiddel.
`departureTransportMeans.transportIdentity[].type`	string	Type identificatie.
`departureTransportMeans.transportIdentity[].identification`	string	Identificatie van het vervoermiddel.
`departureTransportMeans.transportIdentity[].nationality`	string	Nationaliteits- of landcode.
`goodsLocation`	object	Locatie van de goederen.
`goodsLocation.locationCode`	string	Code van de goederenlocatie.
`goodsLocation.provinceName`	string	Provincie of regio.
`placeOfLoading`	object	Plaats van laden.
`placeOfLoading.unLoccode`	string	UN/LOCODE van de laadplaats.
`placeOfDispatch`	object	Plaats van verzending.
`placeOfDispatch.locationCode`	string	Locatiecode van de plaats van verzending.
`deliveryPlace`	object	Afleverplaats.
`deliveryPlace.locationCode`	string	Code van de afleverlocatie.
`deliveryPlace.oneTimeLocation`	object	Eenmalige afleverlocatie.

Het object deliveryPlace.oneTimeLocation bevat in de POC:

name;
streetName;
streetNumber;
postcode;
city;
country.code;
country.name;
exciseNumber;
identificationNumber.

Goederenregels

De goederenregels van een Levering staan in:

shipment.deliveries[].delivery.goodsItem[]

Iedere positie in deze array beschrijft één goederenregel binnen de Levering.

Algemene goederenvelden

Relatief veld binnen `goodsItem[]`	Type	Omschrijving
`stockKeepingUnit`	string	Artikelnummer of voorraadidentificatie.
`hsCode`	string	HS-code van het goed.
`taricSubHeading`	string	TARIC-onderverdeling.
`additionalTaricCode1`	string	Eerste aanvullende TARIC-code.
`additionalTaricCode2`	string	Tweede aanvullende TARIC-code.
`nacCode`	string	NAC-code. De precieze betekenis en codelijst moeten nog worden vastgesteld.
`cusCode`	string	CUS-code.
`description`	string	Omschrijving van het goed.
`unitedNationsCode`	string	Code volgens een VN-classificatie. De specifieke codelijst moet nog worden vastgesteld.
`categoryOrPostalCode`	string	Categorie- of postcode. De toepassing moet nog worden vastgesteld.
`countryOfOrigin`	string	Landcode van het land van oorsprong.
`preferentialCountryOfOrigin`	string	Preferentieel land van oorsprong.
`productType`	string	Type product.
`goodsCustomsStatus`	string	Douanestatus van de goederen.
`statisticalValue`	number	Statistische waarde van het goed.
`productName`	string	Productnaam.
`codeCFT`	string	CFT-code. De betekenis en codelijst moeten nog worden vastgesteld.
`codeOCS`	string	OCS-code. De betekenis en codelijst moeten nog worden vastgesteld.
`descriptionOCS`	string	Omschrijving die bij de OCS-code hoort.
`sectorCode`	string	Sectorcode.

Hoeveelheden en eenheden

Measure

Relatief veld	Type	Omschrijving
`measure`	object	Hoeveelheids- en eenheidsgegevens van de goederenregel.
`measure.grossVolume`	number	Brutohoeveelheid of brutovolume.
`measure.netVolume`	number	Nettohoeveelheid of nettovolume.
`measure.unitCode`	string	Eenheidscode.

Supplementary

Relatief veld	Type	Omschrijving
`supplementary`	object	Aanvullende hoeveelheid.
`supplementary.quantity`	number	Aanvullende hoeveelheid.
`supplementary.unitCode`	string	Eenheidscode van de aanvullende hoeveelheid.

Chargeable unit

Relatief veld	Type	Omschrijving
`chargeableUnit`	object	Belastbare of heffingsgerelateerde hoeveelheid.
`chargeableUnit.quantity`	number	Hoeveelheid.
`chargeableUnit.unitCode`	string	Eenheidscode.

De functionele en technische verschillen tussen measure, supplementary en chargeableUnit moeten tijdens de verdere uitwerking van de koppeling worden vastgesteld.

Verpakkingen

Array: goodsItem[].packaging

Relatief veld	Type	Omschrijving
`packaging`	array	Verpakkingen van de goederenregel.
`packaging[].typeCode`	string	Code van het verpakkingstype.
`packaging[].quantity`	integer	Aantal verpakkingen.
`packaging[].shippingMarks`	string	Merken en nummers op de verpakking.

Datumreeksen

Array: goodsItem[].dateRanges

Relatief veld	Type	Omschrijving
`dateRanges`	array	Datumperioden die bij de goederenregel horen.
`dateRanges[].dateType`	string	Type datumperiode.
`dateRanges[].startDate`	string	Begindatum en -tijd van de periode.
`dateRanges[].endDate`	string	Einddatum en -tijd van de periode.

De mogelijke waarden voor dateType en de verwerking van een ontbrekende begin- of einddatum zijn nog niet uitgewerkt.

Producent en verpakker

Relatief veld	Type	Omschrijving
`producer`	object	Producent van het goed.
`producer.code`	string	Code van de producent.
`producer.identificationNumber`	string	Identificatienummer van de producent.
`packer`	object	Verpakker van het goed.
`packer.code`	string	Code van de verpakker.
`packer.identificationNumber`	string	Identificatienummer van de verpakker.

Materialen

Array: goodsItem[].materials

Relatief veld	Type	Omschrijving
`materials`	array	Materialen waaruit het goed bestaat of die op het goed van toepassing zijn.
`materials[].description`	string	Omschrijving van het materiaal.
`materials[].measure`	object	Bruto- en nettohoeveelheid van het materiaal.
`materials[].measure.grossVolume`	number	Brutohoeveelheid of brutovolume.
`materials[].measure.netVolume`	number	Nettohoeveelheid of nettovolume.
`materials[].measure.unitCode`	string	Eenheidscode.
`materials[].chargeableUnit`	object	Belastbare hoeveelheid van het materiaal.
`materials[].chargeableUnit.quantity`	number	Hoeveelheid.
`materials[].chargeableUnit.unitCode`	string	Eenheidscode.
`materials[].dateRanges`	array	Datumperioden van het materiaal.
`materials[].dateRanges[].dateType`	string	Type datumperiode.
`materials[].dateRanges[].startDate`	string	Begindatum en -tijd.
`materials[].dateRanges[].endDate`	string	Einddatum en -tijd.
`materials[].productionPeriod`	string	Productieperiode. Het formaat moet nog worden vastgesteld.
`materials[].applicableProduct`	object	Product waarop het materiaal betrekking heeft.
`materials[].applicableProduct.productName`	string	Naam van het product.
`materials[].applicableProduct.description`	string	Omschrijving van het product.
`materials[].producer`	object	Producent van het materiaal.
`materials[].producer.code`	string	Code van de producent.
`materials[].producer.identificationNumber`	string	Identificatienummer van de producent.

Batches

Array: goodsItem[].batches

Relatief veld	Type	Omschrijving
`batches`	array	Productie- of goederenbatches.
`batches[].description`	string	Omschrijving van de batch.
`batches[].measure`	object	Bruto- en nettohoeveelheid van de batch.
`batches[].measure.grossVolume`	number	Brutohoeveelheid of brutovolume.
`batches[].measure.netVolume`	number	Nettohoeveelheid of nettovolume.
`batches[].measure.unitCode`	string	Eenheidscode.
`batches[].chargeableUnit`	object	Belastbare hoeveelheid van de batch.
`batches[].chargeableUnit.quantity`	number	Hoeveelheid.
`batches[].chargeableUnit.unitCode`	string	Eenheidscode.
`batches[].dateRanges`	array	Datumperioden van de batch.
`batches[].dateRanges[].dateType`	string	Type datumperiode.
`batches[].dateRanges[].startDate`	string	Begindatum en -tijd.
`batches[].dateRanges[].endDate`	string	Einddatum en -tijd.
`batches[].productionPeriod`	string	Productieperiode.
`batches[].productionBatchId`	string	Identificatie van de productiebatch.

Verwijzingen naar transportmaterieel

Array: goodsItem[].transportEquipment

Relatief veld	Type	Omschrijving
`transportEquipment`	array	Verwijzingen vanuit de goederenregel naar transportmaterieel.
`transportEquipment[].sequenceNumber`	integer	Volgnummer van het transportmaterieel.

Aanvullende documenten

Array: goodsItem[].additionalDocument

Relatief veld	Type	Omschrijving
`additionalDocument`	array	Aanvullende documenten of certificaten bij de goederenregel.
`additionalDocument[].type`	string	Typecode van het document.
`additionalDocument[].identification`	string	Nummer of identificatie van het document.
`additionalDocument[].lineNumber`	integer	Regelnummer waarop de documentreferentie betrekking heeft.
`additionalDocument[].validityDate`	string	Geldigheidsdatum van het document.
`additionalDocument[].amount`	object	Bedrag dat bij het document hoort.
`additionalDocument[].amount.code`	string	Valuta- of bedragcode.
`additionalDocument[].amount.value`	number	Bedrag.
`additionalDocument[].quantity`	object	Hoeveelheid die bij het document hoort.
`additionalDocument[].quantity.code`	string	Eenheidscode.
`additionalDocument[].quantity.value`	number	Hoeveelheid.

Voorgaande documenten

Array: goodsItem[].previousDocument

Relatief veld	Type	Omschrijving
`previousDocument`	array	Verwijzingen naar eerdere documenten of aangiften.
`previousDocument[].type`	string	Typecode van het voorgaande document.
`previousDocument[].identification`	string	Nummer of identificatie van het document.
`previousDocument[].declarationLineNumber`	integer	Regelnummer in de voorgaande aangifte.

Aanvullende informatie

Array: goodsItem[].additionalInformation

Relatief veld	Type	Omschrijving
`additionalInformation`	array	Aanvullende informatie bij de goederenregel.
`additionalInformation[].type`	string	Typecode van de aanvullende informatie.
`additionalInformation[].description`	string	Omschrijving of tekst van de aanvullende informatie.

Aanvullende referenties

Array: goodsItem[].additionalReference

Relatief veld	Type	Omschrijving
`additionalReference`	array	Aanvullende referenties bij de goederenregel.
`additionalReference[].type`	string	Typecode van de referentie.
`additionalReference[].identification`	string	Identificatie of nummer van de referentie.

Accijnsproduct

Object: goodsItem[].exciseProduct

Relatief veld	Type	Omschrijving
`exciseProduct`	object	Accijnsgegevens van het product.
`exciseProduct.exciseProductCode`	string	Accijnsproductcode.
`exciseProduct.designationOfOrigin`	string	Oorsprongsbenaming.
`exciseProduct.brandNameOfProducts`	string	Merknaam van de producten.
`exciseProduct.fiscalMark`	string	Fiscaal merkteken.
`exciseProduct.maturationPeriodOrAgeOfProducts`	string	Rijpingsperiode of ouderdom van de producten.
`exciseProduct.sizeOfProducer`	number	Omvang van de producent. De meeteenheid moet nog worden vastgesteld.
`exciseProduct.alcoholicStrengthByVolumeInPercentage`	number	Alcoholpercentage naar volume.
`exciseProduct.degreePlato`	number	Graad Plato.
`exciseProduct.density`	number	Dichtheid. De eenheid moet nog worden vastgesteld.
`exciseProduct.independentSmallProducersDeclaration`	string	Verklaring voor zelfstandige kleine producenten.
`exciseProduct.wineProduct`	object	Aanvullende gegevens voor een wijnproduct.

Wijnproduct

Object: goodsItem[].exciseProduct.wineProduct

Relatief veld	Type	Omschrijving
`wineProduct`	object	Wijnspecifieke gegevens.
`wineProduct.wineProductCategory`	string	Code van de wijnproductcategorie.
`wineProduct.wineGrowingZoneCode`	string	Code van de wijnbouwzone.
`wineProduct.thirdCountryOfOrigin`	string	Landcode van het derde land van oorsprong.
`wineProduct.otherInformation`	string	Overige informatie over het wijnproduct.
`wineProduct.wineOperation`	array	Bewerkingen die op het wijnproduct zijn uitgevoerd.
`wineProduct.wineOperation[].wineOperationCode`	string	Code van de wijnbewerking.

Objecten en arrays

Een object bevat één samengestelde gegevensgroep. Voorbeelden zijn:

shipment;
consignor;
financialData;
goodsLocation;
deliveryPlace;
exciseProduct.

Een array bevat nul, één of meer waarden of objecten. Voorbeelden zijn:

shipment.deliveries;
shipment.guarantor;
shipment.transportDocuments;
shipment.transportEquipment;
shipment.route;
delivery.goodsItem;
goodsItem.packaging;
goodsItem.materials;
goodsItem.batches.

Een array wordt in JSON met vierkante haken aangeleverd. Dit geldt ook als de array één element bevat.

Samenvatting van de JSON-hiërarchie

Niveau	JSON-pad
Technische zendingreferentie	`shipmentReferenceId`
Zending	`shipment`
Leveringen	`shipment.deliveries[]`
Technische leveringsreferentie	`shipment.deliveries[].deliveryReferenceId`
Levering	`shipment.deliveries[].delivery`
Goederenregels	`shipment.deliveries[].delivery.goodsItem[]`
Verpakkingen	`shipment.deliveries[].delivery.goodsItem[].packaging[]`
Materialen	`shipment.deliveries[].delivery.goodsItem[].materials[]`
Batches	`shipment.deliveries[].delivery.goodsItem[].batches[]`
Aanvullende documenten	`shipment.deliveries[].delivery.goodsItem[].additionalDocument[]`
Accijnsproduct	`shipment.deliveries[].delivery.goodsItem[].exciseProduct`
Wijnproduct	`shipment.deliveries[].delivery.goodsItem[].exciseProduct.wineProduct`

De positie in deze hiërarchie bepaalt waar een veld in het JSON-bericht is opgenomen.
Omdat dit een POC betreft, kan deze hiërarchie tijdens de verdere ontwikkeling van de koppeling nog worden aangepast.