{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/portbase/main/json-schema/portbase-import-consignment-schema.json", "title": "ImportConsignment", "description": "All information related to the import consignment and further handling of the consignment.", "x-generated": "2026-10-18", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/portbase-vessel-visit-openapi.yml#/components/schemas/ImportConsignment", "required": [ "cancelled", "consignmentMasterLevel", "filing", "status", "type" ], "type": "object", "allOf": [ { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.common.ApiConsignment" }, { "type": "object", "properties": { "arrivalTime": { "type": [ "string", "null" ], "format": "date-time" }, "bulkDischarges": { "type": "array", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiBulkDischarge" } }, "cancelled": { "type": "boolean" }, "consignmentMasterLevel": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiConsignmentMasterLevel" }, "dischargedContainers": { "uniqueItems": true, "type": "array", "description": "List of containers in this consignment that have been discharged", "items": { "type": [ "string", "null" ], "description": "List of containers in this consignment that have been discharged" } }, "filing": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.filing.ApiFiling" }, "functionalReferenceId": { "type": [ "string", "null" ], "description": "Functional Reference Id that is sent to Dutch customs in order to link the consignment to inspection\nmessages (CNI/RNI messages) from Dutch customs.\nThe functional reference id is also called LRN (Local Reference Number).\n" }, "status": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiConsignmentStatus" }, "transhipment": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.transhipments.ApiTranshipment" } } } ], "$defs": { "com.portbase.bezoekschip.common.api.common.visit.Country": { "title": "Country", "required": [ "code" ], "type": "object", "properties": { "code": { "minLength": 1, "type": "string" }, "name": { "type": [ "string", "null" ] } } }, "com.portbase.bezoekschip.common.api.consignments.enums.CL116": { "title": "CL116", "type": "string", "description": " Transport charges method of payment:\n A Payment in cash\n B Payment by credit card\n C Payment by cheque\n D Other (e.g. direct debit to cash account)\n H Electronic funds transfer\n Y Account holder with carrier\n Z Not pre-paid\n", "enum": [ "A", "B", "C", "D", "H", "Y", "Z" ] }, "com.portbase.bezoekschip.common.api.consignments.enums.CL701": { "title": "CL701", "type": "string", "description": "Additional information code (Declaration):\n\n N10600 Consignee Unknown\n\n N10900 ENS lodged together with customs declaration for low value consignments\n", "enum": [ "N10600", "N10900" ] }, "com.portbase.bezoekschip.common.api.consignments.enums.CL703": { "title": "CL703", "type": "string", "description": " Additional information type:\n R1\tRFI request\n R2\tRFI response\n R4\tRFS response\n C1\tControl recommendation\n C2\tControl results\n S1\tInconsistency\n", "enum": [ "R1", "R2", "R4", "C1", "C2", "S1" ] }, "com.portbase.bezoekschip.common.api.consignments.enums.CL704": { "title": "CL704", "type": "string", "description": " Additional Supply Chain Actor Role Code:\n CS Consolidator\n FW Freight Forwarder\n WH Warehouse Keeper\n", "enum": [ "CS", "FW", "WH" ] }, "com.portbase.bezoekschip.common.api.consignments.enums.CL704GoodsItem": { "title": "CL704GoodsItem", "type": "string", "description": " Additional Supply Chain Actor Role Code:\n MF Manufacturer\n", "enum": [ "MF" ] }, "com.portbase.bezoekschip.common.api.consignments.enums.CL707": { "title": "CL707", "type": "string", "description": " Communication means type:\n EM Electronic mail\n TE Telephone\n", "enum": [ "EM", "TE" ] }, "com.portbase.bezoekschip.common.api.consignments.enums.CL711": { "title": "CL711", "type": "string", "description": " Container supplier type code:\n N1 Shipper supplied\n N2 Carrier supplied\n", "enum": [ "N1", "N2" ] }, "com.portbase.bezoekschip.common.api.consignments.enums.CL723": { "title": "CL723", "type": "string", "description": " Functional Error Codes:\n 12\tIncorrect (code) value\n 13\tMissing\n 14\tValue not supported in this position (code value constraint)\n 15\tNot supported in this position\n 19\tInvalid decimal notation\n 26\tDuplicate detected\n 35\tToo many repetitions\n 37\tInvalid type characters\n 38\tMissing digit in front of decimal sign\n 39\tElement too long (length constraint)\n 40\tElement too short (length constraint)\n 70\tInvalid Means of Transport Identification Number\n 71\tHouse consignment in a wrong state\n 72\tENS filing in a wrong state\n 80\tUnknown Transport Document Reference\n 81\tDuplicate Transport Document Reference\n 90\tUnknown MRN\n 91\tDuplicate MRN\n 92\tMessage out of sequence\n 93\tInvalid MRN\n 94\tDuplicate LRN\n 95\tUniqueness Error\n 96\tIncorrect entity reference\n 97\tNot found\n 98\tUnknown reference\n 100\tNot satisfactory data quality\n 101\tIt is not possible to add new goods items or house consignments via an ENS filing amendment\n 102\tNot allowed Unicode character\n 103\tThe date and time of arrival cannot be earlier than the date and time of departure\n 104\tElement cannot be amended\n", "enum": [ "N12", "N13", "N14", "N15", "N19", "N26", "N35", "N37", "N38", "N39", "N40", "N70", "N71", "N72", "N80", "N81", "N90", "N91", "N92", "N93", "N94", "N95", "N96", "N97", "N98", "N100", "N101", "N102", "N103", "N104" ] }, "com.portbase.bezoekschip.common.api.consignments.enums.CL735": { "title": "CL735", "type": "string", "description": " Referral request type:\n AMD\tRequest to amend ENS filing\nRFI\tRequest for information\nRFS\tRequest for HRCM screening\n", "enum": [ "AMD", "RFI", "RFS" ] }, "com.portbase.bezoekschip.common.api.consignments.enums.CL750": { "title": "CL750", "type": "string", "description": " Type of Identification of Means of Transport:\n N10\tIMO Ship Identification Number\n N20\tWagon Number\n N21\tTrain Number\n N30\tRegistration Number of the Road Vehicle\n N31\tRegistration Number of the Road Trailer\n N41\tRegistration Number of the Aircraft\n N80\tEuropean Vessel Identification Number (ENI Code)\n", "enum": [ "N10", "N20", "N21", "N30", "N31", "N41", "N80" ] }, "com.portbase.bezoekschip.common.api.consignments.enums.CL752": { "title": "CL752", "type": "string", "description": " Additional information code (Subset):\n A00\tAmendment is not possible\n A10\tAmend Consignor name\n A20\tAmend Consignor address\n A30\tAmend Consignee name\n A40\tAmend Consignee address\n A50\tAmend number of packages\n A60\tAmend description of goods\n A70\tAmend gross mass\n B00\tAdditional information cannot be provided\n B01\tAdditional information is provided\n B10\tProvide phone number and e-mail address(es) of Consignor\n B20\tProvide phone number and e-mail address(es) of Consignee\n C00\tPLACI data element is not confirmed\n C01\tPLACI data element is confirmed\n C10\tConfirm PLACI data elements\n D00\tNo documents can be provided\n D01\tDocuments are provided\n D02\tAdditional information provided\n D10\tProvide all available documents\n S00\tHRCM screening not performed\n S01\tHRCM screening performed\n S10\tProvide information whether HRCM screening has taken place\n", "enum": [ "A00", "A10", "A20", "A30", "A40", "A50", "A60", "A70", "B00", "B01", "B10", "B20", "C00", "C01", "C10", "D00", "D01", "D02", "D10", "S00", "S01", "S10" ] }, "com.portbase.bezoekschip.common.api.consignments.enums.CL754": { "title": "CL754", "type": "string", "description": " Transport document type:\n C624\tForm 302\n C625\tRhine Manifest\n C664\tCN22 declaration according to Article 237 of the Regulation (ECC) No 2454/93\n C665\tCN23 declaration according to Article 237 of the Regulation (ECC) No 2454/93\n N703\tHouse waybill\n N704\tMaster bill of lading\n N705\tBill of lading\n N714\tHouse bill of lading\n N720\tConsignment note CIM\n N722\tRoad list - SMGS\n N730\tRoad consignment note\n N740\tAir waybill\n N741\tMaster airwaybill\n N750\tMovement by post including parcel post\n N760\tMultimodal / combined transport document\n", "enum": [ "C624", "C625", "C664", "C665", "N703", "N704", "N705", "N714", "N720", "N722", "N730", "N740", "N741", "N750", "N760" ] }, "com.portbase.bezoekschip.common.api.consignments.enums.EnsTransportDocumentType": { "title": "EnsTransportDocumentType", "type": "string", "description": "In case of a TSD that only contains a consignment on master level, this value should indicate the ENS transport document type.\nUsed by Dutch customs to look up at the correct level in the ENS and required when sending using filingType = 'TSD'\n\nN704 Bill of lading Master Level: Goods, equipment and parties are declared at master level \n\nN705 Straight bill of lading: Goods, equipment and parties are declared at house level \n\n", "enum": [ "N704", "N705" ] }, "com.portbase.bezoekschip.common.api.consignments.enums.FilingType": { "title": "FilingType", "type": "string", "description": "F10 Straight bill of lading for single filing. \n\nF11 Master and house bill of lading for single filing \n\nF12 Master bill of lading for multiple filing. \n\nF13 Straight bill of lading for multiple filing. \n\nF50 Road mode of transport filing. \n\nTSD Temporary Storage Declaration. \n\nNONE No declaration to customs.\n", "enum": [ "F10", "F11", "F12", "F13", "F50", "TSD", "NONE" ] }, "com.portbase.bezoekschip.common.api.consignments.enums.TransportConditionCode": { "title": "TransportConditionCode", "type": "string", "description": " Used in the Port Community System of Portbase.\n\n Code for the contractual condition for the transport of the container cargo,\n indicating whether the carrier is only responsible for the main carriage or also for the pre and/or on-carriage, e.g. door-to-door, pier-to-pier.\n\n 27 Door-to-door : The carrier is responsible for the intermodal carriage of cargo including both the pre-carriage and the on- carriage.\n 28 Door-to-pier : The carrier is responsible for the intermodal carriage of cargo including the pre-carriage, but excluding the on-carriage.\n 29 Pier-to-door : The carrier is responsible for the intermodal carriage of cargo including the on-carriage, but excluding the pre-carriage.\n 30 Pier-to-pier : The carrier of intermodal cargo is only responsible for the main carriage.\n", "enum": [ "DOOR_TO_DOOR", "DOOR_TO_PIER", "PIER_TO_DOOR", "PIER_TO_PIER" ] }, "com.portbase.bezoekschip.common.api.consignments.status.EnsPointer": { "title": "EnsPointer", "required": [ "messageElementPath" ], "type": [ "object", "null" ], "properties": { "messageElementPath": { "maxLength": 512, "minLength": 0, "type": "string" } } }, "com.portbase.bezoekschip.common.api.consignments.status.TemporaryStorageError": { "title": "TemporaryStorageError", "type": [ "object", "null" ], "properties": { "description": { "type": [ "string", "null" ] }, "code": { "type": [ "string", "null" ] }, "sequenceNumber": { "type": [ "string", "null" ] }, "tag": { "type": [ "string", "null" ] } } }, "com.portbase.bezoekschip.common.api.external.common.ApiConsignment": { "title": "Consignment", "required": [ "type" ], "type": [ "object", "null" ], "properties": { "type": { "type": "string", "enum": [ "Import", "Export" ] } }, "description": "State of the consignment" }, "com.portbase.bezoekschip.common.api.external.consignments.ApiActiveBorderTransportMeans": { "title": "ActiveBorderTransportMeans", "required": [ "estimatedDateAndTimeOfArrival", "identificationNumber", "itinerary", "nationality", "typeOfIdentification", "typeOfMeansOfTransport" ], "type": "object", "properties": { "identificationNumber": { "maxLength": 35, "minLength": 0, "type": "string", "description": "The identification of the vehicle crossing the Union's external frontier. In case of a vessel the IMO number " }, "typeOfMeansOfTransport": { "type": "string", "description": "Code for type of Means of Transport as published in UNECE CEFACT Trade Facilitation Recommendation No. 28 unece.org" }, "typeOfIdentification": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.consignments.enums.CL750" }, "nationality": { "maxLength": 2, "minLength": 2, "type": "string", "description": "The country under whose flag the means of transport is registered, as published in ISO 3166.\n" }, "actualDateAndTimeOfDeparture": { "type": [ "string", "null" ], "description": "Local date and time of departure from where the goods were loaded onto the active means\nof transport which will carry them into the Union.\n", "format": "date-time" }, "estimatedDateAndTimeOfDeparture": { "type": [ "string", "null" ], "description": "Scheduled local date and time of departure from the place where the goods were loaded onto\nthe active means of transport which will carry them into the Union.\n", "format": "date-time" }, "estimatedDateAndTimeOfArrival": { "type": "string", "description": "Scheduled local date and time where the active means of transport arrives in the Union\nat the first port.\n", "format": "date-time" }, "itinerary": { "maxItems": 99, "minItems": 2, "type": "array", "description": "The countries of routing of the activeBorderTransportMeans.\nFirst country in the sequence must be the same as the place of loading.\nLast country in the sequence must be the same as the place of unloading.\nNOTE: When passing through Northern Ireland use country code \"IE\"\n", "items": { "maxLength": 2, "minLength": 2, "type": [ "string", "null" ], "description": "The countries of routing of the activeBorderTransportMeans.\nFirst country in the sequence must be the same as the place of loading.\nLast country in the sequence must be the same as the place of unloading.\nNOTE: When passing through Northern Ireland use country code \"IE\"\n" } } }, "description": "The active means of transport, crossing the Union's external frontier." }, "com.portbase.bezoekschip.common.api.external.consignments.ApiAdditionalInformation": { "title": "AdditionalInformation", "type": [ "object", "null" ], "properties": { "code": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.consignments.enums.CL701" }, "text": { "maxLength": 512, "minLength": 0, "type": [ "string", "null" ], "description": "Any information provided by the declarant that may deem useful\nfor the release for free circulation of the item concerned.\n" } }, "description": "Special request to government from declarant to take or not to take action." }, "com.portbase.bezoekschip.common.api.external.consignments.ApiAdditionalSupplyChainActor": { "title": "AdditionalSupplyChainActor", "required": [ "identificationNumber", "type" ], "type": [ "object", "null" ], "properties": { "identificationNumber": { "maxLength": 17, "minLength": 0, "type": "string", "description": "The EORI number or third country unique identification number shall be\ndeclared when such number was assigned to the party.\n" }, "type": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.consignments.enums.CL704" }, "warehouseAuthorisationNumber": { "type": [ "string", "null" ], "description": "Enter the authorisation number of the warehouse keeper when the type is 'WH'\n" } }, "description": " A party in the supply chain having obtained a trusted trader certificate but\n otherwise not being identified in the declarations.\n" }, "com.portbase.bezoekschip.common.api.external.consignments.ApiAddress": { "title": "Address", "required": [ "city", "country" ], "type": "object", "properties": { "city": { "maxLength": 35, "minLength": 0, "type": "string", "description": "Enter the city name of the party’s address." }, "country": { "maxLength": 2, "minLength": 2, "type": "string", "description": "Enter the code of the country." }, "subDivision": { "maxLength": 35, "minLength": 0, "type": [ "string", "null" ], "description": "Enter a specific region or province." }, "street": { "maxLength": 70, "minLength": 0, "type": [ "string", "null" ], "description": "Enter the name of the street." }, "postCode": { "maxLength": 17, "minLength": 0, "type": [ "string", "null" ], "description": "When the country provides a postal code, this field is required.\nEnter the relevant postcode for the related address particulars.\n" }, "additionalLine": { "maxLength": 70, "minLength": 0, "type": [ "string", "null" ], "description": "Enter aditional the name of the street." }, "number": { "maxLength": 35, "minLength": 0, "type": [ "string", "null" ], "description": "Enter number of the address." }, "poBox": { "maxLength": 70, "minLength": 0, "type": [ "string", "null" ], "description": "Enter poBox." } }, "description": "Address\nEither the street and number of poBox should be filled.\n" }, "com.portbase.bezoekschip.common.api.external.consignments.ApiBorderTransportMeans": { "title": "BorderTransportMeans", "required": [ "identificationNumber", "typeOfIdentification", "typeOfMeansOfTransport" ], "type": [ "object", "null" ], "properties": { "identificationNumber": { "maxLength": 35, "minLength": 0, "type": "string", "description": "The identity of the means of transport crossing the Union's external frontier." }, "typeOfIdentification": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.consignments.enums.CL750" }, "typeOfMeansOfTransport": { "type": "string", "description": "Code for type of Means of Transport as published in UNECE CEFACT Trade Facilitation Recommendation No. 28 unece.org" }, "nationality": { "maxLength": 2, "minLength": 2, "type": [ "string", "null" ], "description": "The country under whose flag the means of transport is registered, as published in ISO 3166" } }, "description": " The passive means of transport that is being transported by the active means of transport.\n It must be used for all stuffed cargo which is not stuffed in a container such as unaccompanied\n as well as accompanied transport of trailers, swap bodies, chassis. It must also\n be used for vehicles.\n" }, "com.portbase.bezoekschip.common.api.external.consignments.ApiBulkAuthorization": { "title": "BulkAuthorization", "required": [ "fullName", "shortName" ], "type": [ "object", "null" ], "properties": { "fullName": { "minLength": 1, "type": "string", "description": "The full name of the organisation" }, "shortName": { "minLength": 1, "type": "string", "description": "The short name of the organisation" }, "iamConnectedId": { "type": [ "string", "null" ], "description": "The IAM Connected id of the organisation" } } }, "com.portbase.bezoekschip.common.api.external.consignments.ApiBulkDischarge": { "title": "BulkDischarge", "required": [ "grossWeight", "itemNumber" ], "type": [ "object", "null" ], "properties": { "terminalOrganisationShortName": { "type": [ "string", "null" ], "description": "Portbase short name of the organisation associated with the terminal" }, "itemNumber": { "type": "integer", "description": "The number of the item the discharge is referring to.", "format": "int32" }, "grossWeight": { "minimum": 0, "type": "number", "description": "The gross weight." } }, "description": "Discharge of bulk goods." }, "com.portbase.bezoekschip.common.api.external.consignments.ApiBuyer": { "title": "Buyer", "required": [ "address", "name" ], "type": "object", "properties": { "identificationNumber": { "maxLength": 17, "minLength": 0, "type": [ "string", "null" ], "description": "The EORI number or third country unique identification number shall\nbe declared when such number was assigned to the party.\n" }, "name": { "maxLength": 70, "minLength": 0, "type": "string", "description": "Enter the full name and where applicable the legal form of the party.\n" }, "address": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiAddress" }, "communications": { "maxItems": 9, "minItems": 0, "type": "array", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiCommunication" } } }, "description": "The buyer is the last known entity to whom the goods are sold or agreed to be sold.\nIf the goods are to be imported otherwise than in pursuance of a purchase,\nthe details of the owner of the goods shall be provided.\n" }, "com.portbase.bezoekschip.common.api.external.consignments.ApiCargoCurrency": { "title": "CargoCurrency", "required": [ "description", "unCode" ], "type": "object", "properties": { "unCode": { "minLength": 1, "type": "string" }, "description": { "minLength": 1, "type": "string" } } }, "com.portbase.bezoekschip.common.api.external.consignments.ApiCargoPackageType": { "title": "CargoPackageType", "required": [ "bulk", "code", "name" ], "type": "object", "properties": { "code": { "minLength": 1, "type": "string" }, "name": { "minLength": 1, "type": "string" }, "bulk": { "type": "boolean" } }, "description": "Package type as published in UNECE CEFACT Trade Facilitation Recommendation No. 21\nunece.org\n" }, "com.portbase.bezoekschip.common.api.external.consignments.ApiCarrier": { "title": "Carrier", "required": [ "address", "identificationNumber", "name" ], "type": [ "object", "null" ], "properties": { "identificationNumber": { "maxLength": 17, "minLength": 0, "type": "string", "description": "The EORI number or third country unique identification number shall be declared when such number was assigned to the party." }, "scacCode": { "maxLength": 4, "minLength": 0, "type": [ "string", "null" ], "description": "The identifier of the carrier, issued by the US" }, "smdgCode": { "maxLength": 3, "minLength": 0, "type": [ "string", "null" ], "description": "The identifier of the carrier, issued by the SMDG" }, "name": { "maxLength": 70, "minLength": 0, "type": "string" }, "address": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiAddress" }, "communications": { "maxItems": 9, "minItems": 0, "type": "array", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiCommunication" } } } }, "com.portbase.bezoekschip.common.api.external.consignments.ApiCommodity": { "title": "Commodity", "required": [ "commodityCode", "descriptionOfGoods" ], "type": "object", "properties": { "descriptionOfGoods": { "maxLength": 512, "minLength": 0, "type": "string" }, "cusCode": { "type": [ "string", "null" ], "description": "The Customs Union and Statistics (CUS) number is the identifier assigned within the\nEuropean Customs Inventory of Chemical Substances (ECICS) to mainly chemical substances\nand preparations. See unece.org\n" }, "commodityCode": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiCommodityCode" }, "dangerInformation": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiDangerInformation" } }, "description": "Details about the properties of the goods" }, "com.portbase.bezoekschip.common.api.external.consignments.ApiCommodityCode": { "title": "CommodityCode", "required": [ "harmonizedSystemSubHeadingCode" ], "type": "object", "properties": { "harmonizedSystemSubHeadingCode": { "maxLength": 6, "minLength": 6, "type": "string", "description": "The Harmonized System is a standardized numerical method of classifying traded products.\nIt is used by customs authorities around the world to identify products when\nassessing duties and taxes and for gathering statistics.\nSee ec.europa.eu\n" }, "combinedNomenclatureCode": { "maxLength": 2, "minLength": 2, "type": [ "string", "null" ], "description": "Enter the two additional digits of the Combined nomenclature code." } }, "description": "Classification of the good item as published in TARIC. The TARIC\n(Integrated Tariff of the European Communities) database uses a classification\nsystem known as the Combined Nomenclature (CN) to categorize goods.\n" }, "com.portbase.bezoekschip.common.api.external.consignments.ApiCommunication": { "title": "Communication", "required": [ "identifier", "type" ], "type": [ "object", "null" ], "properties": { "type": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.consignments.enums.CL707" }, "identifier": { "maxLength": 512, "minLength": 1, "type": "string", "description": "Enter a telephone number or e-mail address where customs can address further enquiries.\nWhen 'COMMUNICATION/Type' is 'TE' the 'COMMUNICATION/Identifier' has to have an international phone number\nformat as defined in the ITU-T recommendation E.123 (02/2001).\nThe format must be compliant with the pattern \"^\\+(?:[0-9] ?){6,14}[0-9]$”.\n" } }, "description": "Means of communication" }, "com.portbase.bezoekschip.common.api.external.consignments.ApiConsignee": { "title": "Consignee", "required": [ "address", "name" ], "type": [ "object", "null" ], "properties": { "identificationNumber": { "maxLength": 17, "minLength": 0, "type": [ "string", "null" ], "description": "The EORI number or third country unique identification number shall\nbe declared when such number was assigned to the party.\n" }, "name": { "maxLength": 70, "minLength": 0, "type": "string", "description": "Enter the full name and where applicable the legal form of the party.\n" }, "address": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiAddress" }, "communications": { "maxItems": 9, "minItems": 0, "type": "array", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiCommunication" } } }, "description": "The party to which goods are consigned" }, "com.portbase.bezoekschip.common.api.external.consignments.ApiConsignmentHouseLevel": { "title": "ConsignmentHouseLevel", "required": [ "consignmentNumber", "consignor", "totalGrossMass", "transportCharges" ], "type": [ "object", "null" ], "properties": { "consignmentNumber": { "maxLength": 70, "minLength": 1, "type": "string", "description": "The transport document number of the Bill of Lading" }, "totalGrossMass": { "type": "number", "description": "The total gross mass is the weight of goods of the whole consignment\nincluding packaging, but excluding the carrier's equipment for the declaration.\n\nEnter the total gross mass, expressed in kilograms, of the goods concerned by the relevant consignment,\nas indicated on the master level transport document. The gross mass is the aggregate mass of the goods\nwith all their packing, excluding containers and other transport equipment.\n" }, "placeOfAcceptance": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiPlaceOfAcceptance" }, "supportingDocuments": { "maxItems": 99, "minItems": 0, "type": "array", "description": "Details related to additional documents or certificates produced in support of the declaration.", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiSupportingDocument" } }, "additionalInformation": { "maxItems": 99, "minItems": 0, "type": "array", "description": "Special request to government from declarant to take or not to take action.", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiAdditionalInformation" } }, "additionalSupplyChainActor": { "maxItems": 99, "minItems": 0, "type": "array", "description": " A party in the supply chain having obtained a trusted trader certificate but\n otherwise not being identified in the declarations.\n", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiAdditionalSupplyChainActor" } }, "consignee": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiConsignee" }, "consignor": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiConsignor" }, "goodsItems": { "maxItems": 9999999, "minItems": 0, "type": "array", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiGoodsItem" } }, "transportCharges": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiTransportCharges" }, "placeOfDelivery": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiPlaceOfDelivery" }, "goodsShipment": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiGoodsShipment" }, "notifyParty": { "type": "array", "description": "The party that is to be notified by the carrier or shipping agent once the shipment arrives\nat its destination or reaches a certain point in transit.\nThis notification typically includes information about the arrival of the shipment,\nits status, and any necessary instructions for further handling or delivery.\n", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiNotifyParty" } }, "previousDocument": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiPreviousDocument" }, "traderAssignedReference": { "maxLength": 35, "minLength": 0, "type": [ "string", "null" ], "description": "This entry concerns the unique commercial reference number assigned by the\nperson concerned to the consignment in question.\nIt may take the form of WCO (ISO 15459) codes or equialent.\nIt provides access to underlying commercial data of interest to customs.\n" }, "passiveBorderTransportMeans": { "maxItems": 99, "minItems": 0, "type": "array", "description": " The passive means of transport that is being transported by the active means of transport.\n It must be used for all stuffed cargo which is not stuffed in a container such as unaccompanied\n as well as accompanied transport of trailers, swap bodies, chassis. It must also\n be used for vehicles.\n", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiBorderTransportMeans" } }, "itinerary": { "maxItems": 99, "minItems": 2, "type": "array", "description": "The countries of routing of the consignment.\nMust contain countries of place of Acceptance and place of Delivery.\n", "items": { "maxLength": 2, "minLength": 2, "type": [ "string", "null" ], "description": "The countries of routing of the consignment.\nMust contain countries of place of Acceptance and place of Delivery.\n" } }, "supplementaryDeclarant": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiSupplementaryDeclarant" } }, "description": "The bill of lading that covers specific portions of the shipment within the master bill of lading and is issued by a freight forwarder" }, "com.portbase.bezoekschip.common.api.external.consignments.ApiConsignmentMasterLevel": { "title": "Consignment", "required": [ "activeBorderTransportMeans", "carrier", "consignmentNumber", "placeOfAcceptance", "placeOfLoading", "placeOfUnloading", "totalGrossMass" ], "type": "object", "properties": { "consignmentNumber": { "maxLength": 70, "minLength": 1, "type": "string", "description": "The transport document number of the Bill of Lading" }, "activeBorderTransportMeans": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiActiveBorderTransportMeans" }, "voyageNumber": { "maxLength": 17, "minLength": 0, "type": [ "string", "null" ], "description": "The voyage number or an indication (e.g. a date of sail) of the seagoing vessel\nas issued by the shipowner/agent of the main transport in which the goods is to be /has been shipped.\nUsed for own reference and usage in the Port Community System of Portbase\n" }, "carrier": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiCarrier" }, "placeOfLoading": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiPlaceOfLoading" }, "placeOfUnloading": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiPlaceOfUnloading" }, "dischargeTerminal": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiTerminal" }, "totalGrossMass": { "type": "number", "description": "The total gross mass is the weight of goods of the whole consignment\nincluding packaging, but excluding the carrier's equipment for the declaration.\n\nEnter the total gross mass, expressed in kilograms, of the goods concerned by the relevant consignment,\nas indicated on the master level transport document. The gross mass is the aggregate mass of the goods\nwith all their packing, excluding containers and other transport equipment.\n" }, "placeOfAcceptance": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiPlaceOfAcceptance" }, "supportingDocuments": { "maxItems": 99, "minItems": 0, "type": "array", "description": "Details related to additional documents or certificates produced in support of the declaration.", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiSupportingDocument" } }, "additionalInformation": { "maxItems": 99, "minItems": 0, "type": "array", "description": "Special request to government from declarant to take or not to take action.", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiAdditionalInformation" } }, "additionalSupplyChainActor": { "maxItems": 99, "minItems": 0, "type": "array", "description": " A party in the supply chain having obtained a trusted trader certificate but\n otherwise not being identified in the declarations.\n", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiAdditionalSupplyChainActor" } }, "consignmentHouseLevel": { "maxItems": 99999, "minItems": 1, "type": "array", "description": "A house bill of lading is the document issued by a freight forwarder or a non-vessel operating common\ncarrier (NVOCC) to a shipper to acknowledge receipt of their items for shipment.\n", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiConsignmentHouseLevel" } }, "consignee": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiConsignee" }, "consignor": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiConsignor" }, "goodsItems": { "maxItems": 9999999, "minItems": 0, "type": "array", "description": "Details of an item in a consignment", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiGoodsItem" } }, "transportCharges": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiTransportCharges" }, "exchangeRate": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiExchangeRate" }, "placeOfDelivery": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiPlaceOfDelivery" }, "notifyParty": { "type": "array", "description": "The party that is to be notified by the carrier or shipping agent once the shipment arrives\nat its destination or reaches a certain point in transit.\nThis notification typically includes information about the arrival of the shipment,\nits status, and any necessary instructions for further handling or delivery.\n", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiNotifyParty" } }, "previousDocument": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiPreviousDocument" }, "transportEquipment": { "maxItems": 9999, "minItems": 0, "type": "array", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiTransportEquipment" } }, "traderAssignedReference": { "maxLength": 35, "minLength": 0, "type": [ "string", "null" ], "description": "This entry concerns the unique commercial reference number assigned by the\nperson concerned to the consignment in question.\nIt may take the form of WCO (ISO 15459) codes or equialent.\nIt provides access to underlying commercial data of interest to customs.\n" }, "supplementaryDeclarant": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiSupplementaryDeclarant" }, "transportConditionCode": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.consignments.enums.TransportConditionCode" }, "customsProcess": { "type": [ "string", "null" ], "description": "Used in the Temporary storage declaration (TS) to Dutch customs.\n", "enum": [ "SEA_IN_SEA_OUT", "MILITARY", "EMPTY_RETURN_PACKAGING" ] }, "customsStatus": { "type": [ "string", "null" ], "description": " Used in the Temporary storage declaration (TS) to Dutch customs\n\n EU_COMMUNITY_GOODS C Goods transported as EU Community goods \n\n EU_COMMUNITY_GOODS_IN_TRANSHIPMENT N27 EU community goods in transhipment \n\n EU_EMPTY_RETURN_PACKAGING NP EU empty return packaging \n\n EU_PROCEDURE_T T EU Customs procedure T (goods transported under T1 and/or T2 documentation) \n\n EU_PROCEDURE_T1 T1 EU Customs procedure T1 (goods transported under T1 documentation) \n\n EU_PROCEDURE_T2 T2 EU Customs procedure T2 (goods transported under T2 documentation) \n\n EU_PROCEDURE_T2F T2F EU Customs procedure T2F (goods transported under T2 documentation between special fiscal territory and other customs territory, see Article 188 DA EU) \n\n GOODS_FROM_EVA_COUNTRIES TV Goods from European Free Trade Association (EFTA) countries\n", "enum": [ "EU_COMMUNITY_GOODS", "EU_COMMUNITY_GOODS_IN_TRANSHIPMENT", "EU_EMPTY_RETURN_PACKAGING", "EU_PROCEDURE_T", "EU_PROCEDURE_T1", "EU_PROCEDURE_T2", "EU_PROCEDURE_T2F", "GOODS_FROM_EVA_COUNTRIES" ] }, "bulkAuthorisations": { "type": "array", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiBulkAuthorization" } } }, "description": "The bill of lading that covers the entire shipment and is issued by the carrier" }, "com.portbase.bezoekschip.common.api.external.consignments.ApiConsignor": { "title": "Consignor", "required": [ "address", "name" ], "type": [ "object", "null" ], "properties": { "identificationNumber": { "maxLength": 17, "minLength": 0, "type": [ "string", "null" ], "description": "The EORI number or third country unique identification number shall\nbe declared when such number was assigned to the party.\n" }, "name": { "maxLength": 70, "minLength": 0, "type": "string", "description": "Enter the full name and where applicable the legal form of the party.\n" }, "address": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiAddress" }, "communications": { "maxItems": 9, "minItems": 0, "type": "array", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiCommunication" } } }, "description": "The party which consigns or sends goods" }, "com.portbase.bezoekschip.common.api.external.consignments.ApiDangerInformation": { "title": "DangerInformation", "required": [ "unCode" ], "type": [ "object", "null" ], "properties": { "name": { "type": [ "string", "null" ], "description": "The technical name of the dangerous good" }, "unCode": { "maxLength": 4, "minLength": 0, "type": "string", "description": "The United Nations Dangerous Goods identifier (UNDG) is the serial number assigned within the United Nations\nto substances and articles contained in a list of the dangerous goods most commonly carried." }, "hazardClass": { "type": [ "string", "null" ], "description": "The IMO hazard class of the dangerous good" }, "packingGroup": { "type": [ "string", "null" ], "description": "Indication of the level of danger", "enum": [ "MINOR_DANGER", "MEDIUM_DANGER", "GREAT_DANGER" ] }, "flashPoint": { "type": [ "number", "null" ], "description": "The temperature in degrees Celsius at which a good will give off enough flammable vapour to be ignited. According IMDG Code DG Class 3 or subsidiary risk of Class 3" } }, "description": "Details about the properties of the goods" }, "com.portbase.bezoekschip.common.api.external.consignments.ApiDeclarant": { "title": "Declarant", "required": [ "name", "shortName" ], "type": "object", "properties": { "identificationNumber": { "maxLength": 17, "minLength": 0, "type": [ "string", "null" ], "description": "The EORI number or third country unique identification number shall\nbe declared when such number was assigned to the party.\n" }, "name": { "maxLength": 70, "minLength": 0, "type": "string", "description": "Enter the full name and where applicable the legal form of the party.\n" }, "shortName": { "minLength": 1, "type": "string", "description": "The short name.\n" }, "scacCode": { "type": [ "string", "null" ], "description": "The SCAC code.\n" }, "iamConnectedId": { "type": [ "string", "null" ], "description": "The portbase internal id.\n" }, "eoriNumber": { "type": [ "string", "null" ], "description": "The EORI number, issued by Customs.\n" } }, "description": "The party which consigns or sends goods" }, "com.portbase.bezoekschip.common.api.external.consignments.ApiExchangeRate": { "title": "ExchangeRate", "required": [ "currency", "rate" ], "type": [ "object", "null" ], "properties": { "rate": { "minimum": 0, "type": "number" }, "currency": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiCargoCurrency" } }, "description": "The exchange rate" }, "com.portbase.bezoekschip.common.api.external.consignments.ApiGoodsItem": { "title": "GoodsItem", "required": [ "commodity", "goodsItemNumber", "grossWeight", "outerPackaging" ], "type": [ "object", "null" ], "properties": { "goodsItemNumber": { "type": "integer", "description": "Number of the item contained in each consignment where there is more than one item of goods.\nMust be numbered in a sequential fashion.\n", "format": "int32" }, "commodity": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiCommodity" }, "grossWeight": { "type": "number", "description": "The total weight of the goods in kilograms, including package weight, excluding container weight..\n" }, "netWeight": { "type": [ "number", "null" ], "description": "The total weight of the goods in kilograms, excluding package weight, excluding container weight." }, "outerPackaging": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiPackaging" }, "innerPackaging": { "maxItems": 98, "minItems": 0, "type": "array", "description": "The packaging used to contain and protect individual items or products within a larger package\n", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiPackaging" } }, "minimumTemperature": { "type": [ "number", "null" ], "description": "The minimum temperature (degrees C)" }, "maximumTemperature": { "type": [ "number", "null" ], "description": "The maximum temperature (degrees C)" }, "additionalSupplyChainActor": { "maxItems": 99, "minItems": 0, "type": "array", "description": " A party in the supply chain having obtained a trusted trader certificate but\n otherwise not being identified in the declarations.\n", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiGoodsItemAdditionalSupplyChainActor" } }, "placements": { "maxItems": 9999, "minItems": 0, "type": "array", "description": "Details related to placements of goods inside containers. This information is required for containerized cargo.", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiGoodsPlacement" } }, "supportingDocuments": { "maxItems": 99, "minItems": 0, "type": "array", "description": "Details related to additional documents or certificates produced in support of the declaration.", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiSupportingDocument" } }, "additionalInformation": { "maxItems": 99, "minItems": 0, "type": "array", "description": "Special request to government from declarant to take or not to take action.", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiGoodsItemAdditionalInformation" } } }, "description": "Details of an item in a consignment" }, "com.portbase.bezoekschip.common.api.external.consignments.ApiGoodsItemAdditionalInformation": { "title": "GoodsItemAdditionalInformation", "type": [ "object", "null" ], "properties": { "text": { "maxLength": 512, "minLength": 0, "type": [ "string", "null" ], "description": "Any information provided by the declarant that may deem useful\nfor the release for free circulation of the item concerned.\n" } }, "description": "Special request to government from declarant to take or not to take action." }, "com.portbase.bezoekschip.common.api.external.consignments.ApiGoodsItemAdditionalSupplyChainActor": { "title": "GoodsItemAdditionalSupplyChainActor", "required": [ "identificationNumber", "type" ], "type": [ "object", "null" ], "properties": { "identificationNumber": { "maxLength": 17, "minLength": 0, "type": "string", "description": "The EORI number or third country unique identification number shall be\ndeclared when such number was assigned to the party.\n" }, "type": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.consignments.enums.CL704GoodsItem" } }, "description": " A party in the supply chain having obtained a trusted trader certificate but\n otherwise not being identified in the declarations.\n" }, "com.portbase.bezoekschip.common.api.external.consignments.ApiGoodsPlacement": { "title": "GoodsPlacement", "required": [ "containerIdentificationNumber" ], "type": [ "object", "null" ], "properties": { "containerIdentificationNumber": { "maxLength": 17, "minLength": 0, "type": "string" }, "numberOfOuterPackages": { "minimum": 0, "type": [ "integer", "null" ], "format": "int32" }, "grossWeight": { "type": [ "number", "null" ], "description": "The gross weight of the cargo in kilograms, including package weight, excluding container weight." } }, "description": "Details related to placements of goods inside containers. This information is required for containerized cargo." }, "com.portbase.bezoekschip.common.api.external.consignments.ApiGoodsShipment": { "title": "GoodsShipment", "required": [ "buyer", "seller" ], "type": [ "object", "null" ], "properties": { "buyer": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiBuyer" }, "seller": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiSeller" } }, "description": "Required when the place of delivery is located in the EU.\n" }, "com.portbase.bezoekschip.common.api.external.consignments.ApiNotifyParty": { "title": "NotifyParty", "required": [ "address", "name" ], "type": [ "object", "null" ], "properties": { "identificationNumber": { "maxLength": 17, "minLength": 0, "type": [ "string", "null" ], "description": "The EORI number or third country unique identification number shall\nbe declared when such number was assigned to the party.\n" }, "name": { "maxLength": 70, "minLength": 0, "type": "string", "description": "Enter the full name and where applicable the legal form of the party.\n" }, "address": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiAddress" }, "communications": { "maxItems": 9, "minItems": 0, "type": "array", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiCommunication" } } }, "description": "The party that is to be notified by the carrier or shipping agent once the shipment arrives\nat its destination or reaches a certain point in transit.\nThis notification typically includes information about the arrival of the shipment,\nits status, and any necessary instructions for further handling or delivery.\n" }, "com.portbase.bezoekschip.common.api.external.consignments.ApiOversize": { "title": "Oversize", "type": [ "object", "null" ], "properties": { "overlength": { "type": [ "number", "null" ], "description": "The (sum of the) measurement(s) of the part(s) of the cargo protuberant at the front and/or the rear side of the container" }, "overheight": { "type": [ "number", "null" ], "description": "The (sum of the) measurement(s) of the part(s) of the cargo protuberant at the upperside of the container." }, "overwidth": { "type": [ "number", "null" ], "description": "The (sum of the) measurement(s) of the part(s) of the cargo protuberant at the left and/or the right side of the container (seen from the front of the container)" }, "remarks": { "type": [ "string", "null" ], "description": "Oversize remarks " } }, "description": "Oversize specification.\n" }, "com.portbase.bezoekschip.common.api.external.consignments.ApiPackaging": { "title": "Packaging", "required": [ "typeOfPackages" ], "type": [ "object", "null" ], "properties": { "typeOfPackages": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiCargoPackageType" }, "numberOfPackages": { "maximum": 99999999, "type": [ "integer", "null" ], "description": "The number of packages as self-contained units (packaged in such a way that\nthey cannot be divided without first undoing the packing) (edited)\n\nExcept for bulk goods (packageType is 'VQ', 'VG', 'VL', 'VY', 'VR', 'VS', 'VO', 'NE', 'NF', 'NG'), this is required\n", "format": "int32" }, "shippingMarks": { "type": "array", "description": "List of shipping marks.\nMarkings or labels placed on the packaging of goods to provide important information for handling,\nidentification, and tracking during shipping and transportation.\nThese marks serve various purposes and are typically applied using stencils,\nlabels, or printing directly on the packaging material.\n\nExcept for bulk goods (packageType is 'VQ', 'VG', 'VL', 'VY', 'VR', 'VS', 'VO', 'NE', 'NF', 'NG'), this is required\n", "items": { "type": [ "string", "null" ], "description": "List of shipping marks.\nMarkings or labels placed on the packaging of goods to provide important information for handling,\nidentification, and tracking during shipping and transportation.\nThese marks serve various purposes and are typically applied using stencils,\nlabels, or printing directly on the packaging material.\n\nExcept for bulk goods (packageType is 'VQ', 'VG', 'VL', 'VY', 'VR', 'VS', 'VO', 'NE', 'NF', 'NG'), this is required\n" } } }, "description": "The packaging used to contain and protect individual items or products within a larger package\n" }, "com.portbase.bezoekschip.common.api.external.consignments.ApiPlaceOfAcceptance": { "title": "PlaceOfAcceptance", "type": [ "object", "null" ], "properties": { "location": { "maxLength": 35, "minLength": 0, "type": [ "string", "null" ], "description": "Name of the location. When the unlo code is not provided this attribute is mandatory,else it is not used." }, "unloCode": { "maxLength": 17, "minLength": 0, "type": [ "string", "null" ], "description": "UNLOCODE list as published in unece.org" }, "countryCode": { "maxLength": 2, "minLength": 2, "type": [ "string", "null" ], "description": "The country of the location.\nWhen the unlo code is not provided this attribute is mandatory, else it is not used.\n" } }, "description": "The location where the goods are taken over from the consignor" }, "com.portbase.bezoekschip.common.api.external.consignments.ApiPlaceOfDelivery": { "title": "PlaceOfDelivery", "type": [ "object", "null" ], "properties": { "location": { "maxLength": 35, "minLength": 0, "type": [ "string", "null" ], "description": "Name of the location. When the unlo code is not provided this attribute is mandatory,else it is not used." }, "unloCode": { "maxLength": 17, "minLength": 0, "type": [ "string", "null" ], "description": "UNLOCODE list as published in unece.org" }, "countryCode": { "maxLength": 2, "minLength": 2, "type": [ "string", "null" ], "description": "The country of the location.\nWhen the unlo code is not provided this attribute is mandatory, else it is not used.\n" } }, "description": "The location at which the goods are to be received by the consignee." }, "com.portbase.bezoekschip.common.api.external.consignments.ApiPlaceOfLoading": { "title": "PlaceOfLoading", "required": [ "countryCode", "location", "unloCode" ], "type": [ "object", "null" ], "properties": { "location": { "maxLength": 17, "minLength": 0, "type": "string", "description": "Name of the location." }, "unloCode": { "maxLength": 17, "minLength": 0, "type": "string", "description": "UNLOCODE list published in unece.org" }, "countryCode": { "maxLength": 2, "minLength": 2, "type": "string", "description": "The country of the location.\n" } }, "description": "Place at which the goods (consignments) are loaded on to the active means of transport" }, "com.portbase.bezoekschip.common.api.external.consignments.ApiPlaceOfUnloading": { "title": "PlaceOfUnloading", "required": [ "countryCode", "location", "unloCode" ], "type": "object", "properties": { "location": { "maxLength": 35, "minLength": 0, "type": "string", "description": "Name of the location. When the unlo code is not provided this attribute is mandatory,else it is not used." }, "unloCode": { "maxLength": 17, "minLength": 0, "type": "string", "description": "UNLOCODE list as published in unece.org" }, "countryCode": { "maxLength": 2, "minLength": 2, "type": "string", "description": "The country of the location.\n" } }, "description": "Place at which the goods (consignments) are unloaded" }, "com.portbase.bezoekschip.common.api.external.consignments.ApiPreviousDocument": { "title": "PreviousDocument", "required": [ "referenceNumber", "type" ], "type": [ "object", "null" ], "properties": { "referenceNumber": { "maxLength": 70, "minLength": 0, "type": "string" }, "type": { "type": "string", "description": " C612 : T2F\n C620 : T2LF\n N355 : ENS\n N820 : AANG.DOUANEVERVOER,T\n N821 : T1\n N822 : T2\n N825 : T2L\n N952 : TIR\n N955 : ATA\n", "enum": [ "C612", "C620", "N355", "N820", "N821", "N822", "N825", "N952", "N955" ] }, "lineNumber": { "maximum": 99999, "type": [ "integer", "null" ], "format": "int32" }, "ensTransportDocumentType": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.consignments.enums.EnsTransportDocumentType" } } }, "com.portbase.bezoekschip.common.api.external.consignments.ApiSeller": { "title": "Seller", "required": [ "address", "name" ], "type": "object", "properties": { "identificationNumber": { "maxLength": 17, "minLength": 0, "type": [ "string", "null" ], "description": "The EORI number or third country unique identification number shall\nbe declared when such number was assigned to the party.\n" }, "name": { "maxLength": 70, "minLength": 0, "type": "string", "description": "Enter the full name and where applicable the legal form of the party.\n" }, "address": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiAddress" }, "communications": { "maxItems": 9, "minItems": 0, "type": "array", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiCommunication" } } }, "description": "The seller is the last known entity by whom the goods are sold or agreed to be sold to the buyer.\nIf the goods are to be imported otherwise than in pursuance of a purchase,\nthe details of the owner of the goods shall be provided.\n" }, "com.portbase.bezoekschip.common.api.external.consignments.ApiSizeType": { "title": "SizeType", "required": [ "code" ], "type": "object", "properties": { "code": { "maxLength": 4, "minLength": 4, "type": "string", "description": "The coded container's length, width, height, type and features, as published in ISO 6346." }, "name": { "type": [ "string", "null" ], "description": "The descriptive name of the size type of container as specified with the code." } }, "description": "The classification of the container's length, width, height, type and features.
Use a size type retrieved with find size types via the Reference Data API '[Find SizeTypes](#operation/_06_findSizeTypes)'." }, "com.portbase.bezoekschip.common.api.external.consignments.ApiSupplementaryDeclarant": { "title": "SupplementaryDeclarant", "required": [ "identificationNumber" ], "type": [ "object", "null" ], "properties": { "identificationNumber": { "type": "string", "description": "EORI number shall be declared." } }, "description": "This data group contains the information about the person issuing a transport contract as referred to in Article 112(1)\nfirst subparagraph or of the consignee referred to in Article 112(1) second subparagraph and in 113(1) and (2)\n(e.g., freight forwarder, postal operator), who submits the additional entry summary declaration particulars pursuant to Articles\n" }, "com.portbase.bezoekschip.common.api.external.consignments.ApiSupportingDocument": { "title": "SupportingDocument", "required": [ "referenceNumber", "type" ], "type": [ "object", "null" ], "properties": { "referenceNumber": { "maxLength": 70, "minLength": 0, "type": "string" }, "type": { "maxLength": 4, "minLength": 0, "type": "string", "description": "Document type (common) as published by Taxation and Customs Union\nec.europa.eu" } }, "description": "Details related to additional documents or certificates produced in support of the declaration." }, "com.portbase.bezoekschip.common.api.external.consignments.ApiTerminal": { "title": "Terminal", "required": [ "terminalCode", "terminalName" ], "type": [ "object", "null" ], "properties": { "terminalCode": { "maxLength": 17, "minLength": 0, "type": "string", "description": "N24 Locationcode NL - Single Window.\nSee www.belastingdienst.nl\n" }, "terminalName": { "minLength": 1, "type": "string", "description": "The name of the terminal" }, "organisationShortName": { "type": [ "string", "null" ], "description": "The short name of the organisation that contains the terminal" }, "organisationName": { "type": [ "string", "null" ], "description": "The name of the organisation that contains the terminal" } } }, "com.portbase.bezoekschip.common.api.external.consignments.ApiTransportCharges": { "title": "TransportCharges", "required": [ "methodOfPayment" ], "type": [ "object", "null" ], "properties": { "methodOfPayment": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.consignments.enums.CL116" } }, "description": "The costs associated with the movement of goods from one location to another" }, "com.portbase.bezoekschip.common.api.external.consignments.ApiTransportEquipment": { "title": "TransportEquipment", "required": [ "containerIdentificationNumber", "containerSizeAndType", "containerSupplierType", "empty" ], "type": [ "object", "null" ], "properties": { "containerIdentificationNumber": { "maxLength": 17, "minLength": 0, "type": "string" }, "containerSizeAndType": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiSizeType" }, "containerSupplierType": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.consignments.enums.CL711" }, "empty": { "type": "boolean" }, "tareWeight": { "type": [ "number", "null" ], "description": "The weight of the container without its content." }, "temperature": { "type": [ "number", "null" ] }, "oversize": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiOversize" }, "redeliveryAddress": { "type": [ "string", "null" ], "description": "The location where the container should be returned after it has been emptied of its contents.\nThis address is typically provided by the carrier or shipper. The redelivery address is essential\nfor efficient container management, as it ensures that empty containers are returned to the\nappropriate location for inspection, maintenance, and redistribution\n" }, "sealIdentifiers": { "maxItems": 99, "minItems": 0, "uniqueItems": true, "type": "array", "description": "The identifier of the seal affixed to a piece of transport equipment,\nused to secure an object and protect from unauthorized entry or tampering.\n", "items": { "maxLength": 20, "minLength": 0, "type": [ "string", "null" ], "description": "The identifier of the seal affixed to a piece of transport equipment,\nused to secure an object and protect from unauthorized entry or tampering.\n" } }, "bookingReference": { "type": [ "string", "null" ], "description": "The booking reference number of the equipment. For ferry shipments the booking reference number is mandatory.\n" }, "containerOperator": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiCarrier" } } }, "com.portbase.bezoekschip.common.api.external.consignments.filing.ApiCustomsOffice": { "title": "CustomsOffice", "required": [ "referenceNumber" ], "type": "object", "properties": { "referenceNumber": { "type": "string", "description": "Reference number as published by Taxation and Customs Union ec.europa.eu" } }, "description": "Details identifying the government agency office responsible for supervising the discharge of a Government procedure" }, "com.portbase.bezoekschip.common.api.external.consignments.filing.ApiFiling": { "title": "Filing", "required": [ "customsOfficeOfFirstEntry", "splitConsignment" ], "type": "object", "properties": { "crn": { "type": [ "string", "null" ], "description": "Call Reference Number of the visit.\nUsed to link the consignments to a port visit that is reported to Dutch customs via Portbase.\n" }, "declarant": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiDeclarant" }, "filingType": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.consignments.enums.FilingType" }, "straight": { "type": "boolean" }, "reEntryIndicator": { "type": [ "boolean", "null" ], "description": "This indicator is to be used when goods, for which ENS was already lodged upon their first entry\ninto the territory of the ICS2 countries, are again entering the territory of the ICS2 countries\nunder the same master transport document and not having left the means of transport (no transhipment).\n\nRequired for F10, F11, F12, F13 ENS filings.\n" }, "splitConsignment": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.filing.ApiSplitConsignment" }, "customsOfficeOfFirstEntry": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.filing.ApiCustomsOffice" } }, "description": "Details of the filing." }, "com.portbase.bezoekschip.common.api.external.consignments.filing.ApiSplitConsignment": { "title": "SplitConsignment", "required": [ "splitConsignmentIndicator" ], "type": "object", "properties": { "splitConsignmentIndicator": { "type": "boolean", "description": "Indicate if the consignment covered by the related transport document was split." }, "previousMRN": { "maxLength": 18, "minLength": 18, "type": [ "string", "null" ], "description": "Enter the MRN assigned to the ENS that was lodged first for the relevant consignment (master level)." } }, "description": "Indicate if the consignment covered by the related transport document was split." }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiAdditionalInformationRequest": { "title": "AdditionalInformationRequest", "required": [ "documentIssueTime", "responsibleMemberState" ], "type": [ "object", "null" ], "properties": { "documentIssueTime": { "type": "string", "description": "The time the additional information request was issued.\n", "format": "date-time" }, "responsibleMemberState": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.common.visit.Country" }, "representative": { "maxLength": 17, "minLength": 0, "type": [ "string", "null" ] }, "referralRequestDetails": { "maxItems": 999, "minItems": 0, "type": "array", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiAdditionalInformationRequestDetails" } } }, "description": "IE3Q02 - Additional information has been requested.\n" }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiAdditionalInformationRequestDetails": { "title": "AdditionalInformationRequestDetails", "required": [ "referralRequestReference", "requestType" ], "type": [ "object", "null" ], "properties": { "referralRequestReference": { "maxLength": 17, "minLength": 0, "type": "string" }, "requestType": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.consignments.enums.CL735" }, "transportDocumentHouse": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiTransportDocument" }, "transportDocumentMaster": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiTransportDocument" }, "supportingDocuments": { "maxItems": 99, "minItems": 0, "type": "array", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiSupportingDocument" } }, "additionalInformationList": { "maxItems": 99, "minItems": 0, "type": "array", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiRequestedAdditionalInformation" } }, "pointer": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.consignments.status.EnsPointer" } } }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiAdditionalInformationRequestNotification": { "title": "AdditionalInformationRequestNotification", "required": [ "documentIssueTime", "responsibleMemberState" ], "type": [ "object", "null" ], "properties": { "documentIssueTime": { "type": "string", "description": "The time the additional information request was issued.\n", "format": "date-time" }, "referralRequestDetails": { "maxItems": 999, "minItems": 0, "type": "array", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiAdditionalInformationRequestDetails" } }, "responsibleMemberState": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.common.visit.Country" } }, "description": "IE3N04 - Aditional information has been requested.\n" }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiAdditionalInformationRequestResponse": { "title": "AdditionalInformationRequestResponse", "type": [ "object", "null" ], "properties": { "additionalInformationResponse": { "maxItems": 999, "minItems": 0, "type": "array", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiAdditionalInformationResponse" } } }, "description": "IE3R02 - Response to the Additional Information Request.\n" }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiAdditionalInformationResponse": { "title": "AdditionalInformationResponse", "required": [ "referralRequestReference" ], "type": [ "object", "null" ], "properties": { "referralRequestReference": { "maxLength": 17, "minLength": 0, "type": "string" }, "additionalInformation": { "maxItems": 99, "minItems": 0, "type": "array", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiRequestedAdditionalInformation" } }, "binaryAttachment": { "maxItems": 9, "minItems": 0, "type": "array", "items": { "type": [ "string", "null" ] } }, "transportDocumentHouseLevel": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiTransportDocument" } } }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiAdvanceControlNotification": { "title": "AdvanceControlNotification", "required": [ "customsOfficeOfControl", "notificationDate", "representative" ], "type": [ "object", "null" ], "properties": { "notificationDate": { "type": "string", "description": "The time that the control notification was sent by the Shared Trader Interface (STI).\n", "format": "date-time" }, "scheduledControlDate": { "type": [ "string", "null" ], "description": "The time that the control was scheduled.\n", "format": "date-time" }, "controls": { "maxItems": 9999, "minItems": 1, "type": "array", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiControl" } }, "customsOfficeOfControl": { "type": "string" }, "representative": { "type": "string" } }, "description": "IE3N09 - An advance control notification is received. The advance control notification should be done before\n the goods arrive in the customs territory of the Union. This notification shall not be made if\n it may jeopardize the purpose of the inspection or its results. The decision to inform the Authorized\n Economic Operator (AEO) is a manual process based on the results of the Safety & Security risk analysis\n (which starts after the pre-loading risk analysis is completed) and is to be taken in discretion on a\n case by case basis. A general rule that the purpose of control would be jeopardized in any case\n cannot apply.\n" }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiAmendmentNotification": { "title": "AmendmentNotification", "required": [ "completionTime" ], "type": [ "object", "null" ], "properties": { "completionTime": { "type": "string", "description": "The time the amendment was completed at the Shared Trader Interface (STI).\n", "format": "date-time" } }, "description": "IE3N10 - The amended ENS filing is received, validated and registered by the ICS2 Shared Trader Interface (STI).\n" }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiArrivalRegistrationResponse": { "title": "ArrivalRegistrationResponse", "required": [ "registrationDate" ], "type": [ "object", "null" ], "properties": { "registrationDate": { "type": "string", "description": "The arrival time that was registered at the Shared Trader Interface (STI).\n", "format": "date-time" } }, "description": "IE3R04 - The arrival time has been registered.\n" }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiAssessmentCompleteNotification": { "title": "AssessmentCompleteNotification", "required": [ "completionTime" ], "type": [ "object", "null" ], "properties": { "completionTime": { "type": "string", "description": "IE3N03 - The time the assessment was completed at the Shared Trader Interface (STI).\n", "format": "date-time" } }, "description": "The risk assessment of an ENS filing is completed.\n" }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiClearanceGoodsItem": { "title": "ClearanceGoodsItem", "required": [ "itemNumber" ], "type": [ "object", "null" ], "properties": { "itemNumber": { "type": "integer", "format": "int32" }, "remainingWeight": { "minimum": 0, "type": [ "number", "null" ] }, "remainingPackages": { "type": [ "integer", "null" ], "format": "int32" } } }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiClearanceStatus": { "title": "ClearanceStatus", "type": [ "object", "null" ], "properties": { "expirySummary": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiClearanceStatusExpirySummary" }, "writtenOff": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiClearanceStatusWrittenOff" } }, "description": "Clearance status of Dutch customs.\n" }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiClearanceStatusExpirySummary": { "title": "ClearanceStatusExpirySummary", "required": [ "notificationTime" ], "type": [ "object", "null" ], "properties": { "notificationTime": { "type": "string", "description": "The time the clearance status expiry notifcation was sent.\n", "format": "date-time" }, "items": { "type": "array", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiClearanceGoodsItem" } } }, "description": "With this message the Dutch Customs will inform the authorised party of the Summary Declaration\nthat the legal period is almost expired and the obligation concerning the declaration\nhas not been totally fulfilled. Only the concerning consignments are mentioned including\nthe quantities that have not been fulfilled.\n" }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiClearanceStatusWrittenOff": { "title": "ClearanceStatusWrittenOff", "required": [ "notificationTime" ], "type": [ "object", "null" ], "properties": { "notificationTime": { "type": "string", "description": "The time the written off notificatio was sent.\n", "format": "date-time" } }, "description": "With this message the Dutch Customs will inform the authorised party of the Summary\nDeclaration that the non-community goods mentioned are assigned a Customs-approved\ntreatment or use. This notification does not imply (is not intended to be) a legal\ndischarge of the summary declaration. It is only an indication that for all the non-community\ngoods a treatment of use is initiated in the legal period of validity.\n" }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiConsignmentInvalidation": { "title": "ConsignmentInvalidation", "type": [ "object", "null" ], "properties": { "cancelled": { "type": "boolean" }, "completionTime": { "type": [ "string", "null" ], "description": "The time the invalidation was completed by the Shared Trader Interface (STI).\n", "format": "date-time" } }, "description": "IE3Q04 - An invalidation of the ENS is requested.\n" }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiConsignmentStatus": { "title": "ConsignmentStatus", "type": "object", "properties": { "filingStatusENS": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiFilingStatusENS" }, "filingStatusNA": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiFilingStatusNA" }, "filingStatusTemporaryStorage": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiFilingStatusTemporaryStorage" }, "assessmentCompleteNotification": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiAssessmentCompleteNotification" }, "ensNotCompleteNotification": { "type": "array", "description": "IE3N02 - One or more of the parties that are indicated as supplementary declarant have not yet filed.\n", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiEnsNotCompleteNotification" } }, "doNotLoadRequest": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiDoNotLoadRequest" }, "controlNotification": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiControlNotification" }, "advanceControlNotification": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiAdvanceControlNotification" }, "houseConsignmentInIncorrectStateNotification": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiHouseConsignmentIncorrectStateNotification" }, "ensPendingNotification": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiPendingNotification" }, "invalidationRequest": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiConsignmentInvalidation" }, "invalidationAcceptanceResponse": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiInvalidationAcceptance" }, "clearanceStatus": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiClearanceStatus" }, "additionalInformationRequest": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiAdditionalInformationRequest" }, "additionalInformationRequestResponse": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiAdditionalInformationRequestResponse" }, "additionalInformationRequestNotification": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiAdditionalInformationRequestNotification" }, "arrivalRegistrationResponse": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiArrivalRegistrationResponse" } } }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiControl": { "title": "Control", "type": [ "object", "null" ], "properties": { "examinationPlace": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiExaminationPlace" }, "controlSubject": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiControlSubject" } } }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiControlConsignment": { "title": "ControlConsignment", "type": "object", "properties": { "goodsItem": { "maxItems": 9999999, "minItems": 0, "type": "array", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiControlGoodsItem" } }, "consignmentHouseLevel": { "maxItems": 99999, "minItems": 0, "type": "array", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiControlConsignmentHouseLevel" } }, "packaging": { "maxItems": 99, "minItems": 0, "type": "array", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiControlPackaging" } }, "transportEquipment": { "maxItems": 9999, "minItems": 0, "type": "array", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiControlTransportEquipment" } } } }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiControlConsignmentHouseLevel": { "title": "ControlConsignmentHouseLevel", "type": [ "object", "null" ], "properties": { "goodsItem": { "maxItems": 9999, "minItems": 0, "type": "array", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiControlGoodsItem" } }, "passiveBorderTransportMeans": { "maxItems": 99, "minItems": 0, "type": "array", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiControlPassiveBorderTransportMeans" } }, "transportEquipment": { "maxItems": 9999, "minItems": 0, "type": "array", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiControlTransportEquipment" } } } }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiControlGoodsItem": { "title": "ControlGoodsItem", "type": [ "object", "null" ], "properties": { "goodsItemNumber": { "type": "integer", "format": "int32" }, "packaging": { "maxItems": 99, "minItems": 0, "type": "array", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiControlPackaging" } }, "passiveBorderTransportMeans": { "maxItems": 99, "minItems": 0, "type": "array", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiControlPassiveBorderTransportMeans" } }, "transportEquipment": { "maxItems": 9999, "minItems": 0, "type": "array", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiControlTransportEquipment" } } } }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiControlNotification": { "title": "ControlNotification", "required": [ "customsOfficeOfControl", "notificationDate" ], "type": [ "object", "null" ], "properties": { "notificationDate": { "type": "string", "description": "The time that the control notification was sent by the Shared Trader Interface (STI).\n", "format": "date-time" }, "scheduledControlDate": { "type": [ "string", "null" ], "description": "The time that the control was scheduled.\n", "format": "date-time" }, "controls": { "maxItems": 9999, "minItems": 1, "type": "array", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiControl" } }, "customsOfficeOfControl": { "type": "string" }, "representative": { "type": [ "string", "null" ] } }, "description": "IE3N08 - Control notification received. It is received after the arrival of the means of transport is\nprocessed by the ICS2 Shared Trader Interface (STI). The carrier will be forced to unload the\nselected goods in order to make them available to customs for controls, regardless of whether\nthe presentation of those goods was originally foreseen at this place or not.\n" }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiControlPackaging": { "title": "ControlPackaging", "required": [ "shippingMarks", "typeOfPackages" ], "type": [ "object", "null" ], "properties": { "shippingMarks": { "maxLength": 512, "minLength": 0, "type": "string" }, "typeOfPackages": { "maxLength": 2, "minLength": 0, "type": "string" } } }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiControlPassiveBorderTransportMeans": { "title": "ControlPassiveBorderTransportMeans", "required": [ "identificationNumber", "nationality", "typeOfIdentification" ], "type": [ "object", "null" ], "properties": { "identificationNumber": { "maxLength": 35, "minLength": 0, "type": "string" }, "typeOfIdentification": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.consignments.enums.CL750" }, "nationality": { "maxLength": 2, "minLength": 2, "type": "string", "description": "(CL718) ISO 3166 list of country codes as published in CS/RD2" } } }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiControlSubject": { "title": "ControlSubject", "required": [ "consignmentMasterLevel" ], "type": [ "object", "null" ], "properties": { "consignmentMasterLevel": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiControlConsignment" } } }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiControlTransportEquipment": { "title": "ControlTransportEquipment", "required": [ "containerIdentificationNumber" ], "type": [ "object", "null" ], "properties": { "containerIdentificationNumber": { "maxLength": 17, "minLength": 0, "type": "string" } } }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiDoNotLoadDetails": { "title": "DoNotLoadDetails", "type": "object", "properties": { "transportEquipment": { "maxItems": 9999, "minItems": 0, "type": "array", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiControlTransportEquipment" } }, "transportDocument": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiTransportDocument" } } }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiDoNotLoadRequest": { "title": "DoNotLoadRequest", "required": [ "doNotLoadDetails", "documentIssueDate" ], "type": [ "object", "null" ], "properties": { "documentIssueDate": { "type": "string", "format": "date-time" }, "responsibleMemberState": { "maxLength": 2, "minLength": 2, "type": [ "string", "null" ] }, "doNotLoadDetails": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiDoNotLoadDetails" } }, "description": "IE3Q01 - Do Not Load request received\n" }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiEnsError": { "title": "Error", "required": [ "pointer" ], "type": [ "object", "null" ], "properties": { "technicalErrorMessage": { "maxLength": 1024, "minLength": 1, "type": [ "string", "null" ] }, "description": { "maxLength": 512, "minLength": 1, "type": [ "string", "null" ] }, "humanReadableDescription": { "maxLength": 512, "minLength": 0, "type": [ "string", "null" ] }, "validationCode": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.consignments.enums.CL723" }, "pointer": { "type": "string" } } }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiEnsErrorNotification": { "title": "EnsErrorNotification", "required": [ "notificationTime" ], "type": [ "object", "null" ], "properties": { "notificationTime": { "type": "string", "description": "The time the error notification was sent by the Shared Trader Interface (STI).\n", "format": "date-time" }, "errors": { "type": "array", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiEnsError" } } }, "description": "IE3N99 - General validation error, validated and registered by the ICS2 Shared Trader Interface (STI).\n" }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiEnsFilingRegistration": { "title": "EnsFilingRegistration", "required": [ "mrn", "registrationTime" ], "type": [ "object", "null" ], "properties": { "mrn": { "minLength": 1, "type": "string" }, "registrationTime": { "type": "string", "description": "The time the ens filing was registered at the Shared Trader Interface (STI).\n", "format": "date-time" } }, "description": "IE3R01 - The ENS filing is received, validated and registered by the ICS2 Shared Trader Interface (STI). A MRN is assigned to the ENS filing.\n" }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiEnsLifecycleValidationError": { "title": "EnsLifecycleValidationError", "required": [ "validationCode" ], "type": [ "object", "null" ], "properties": { "description": { "maxLength": 512, "minLength": 1, "type": [ "string", "null" ] }, "humanReadableDescription": { "maxLength": 512, "minLength": 0, "type": [ "string", "null" ] }, "validationCode": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.consignments.enums.CL723" }, "pointer": { "type": [ "string", "null" ] } } }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiEnsLifecycleValidationErrorNotification": { "title": "EnsLifecycleValidationErrorNotification", "required": [ "notificationTime" ], "type": [ "object", "null" ], "properties": { "notificationTime": { "type": "string", "format": "date-time" }, "errors": { "maxItems": 99999, "minItems": 0, "type": "array", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiEnsLifecycleValidationError" } } }, "description": "IE3N01 - The ENS filing is in a incorrect state regarding the ENS lifecycle’s sequence of the process.\nE.g. whether an ENS filing refers to a journey of a means of transport which arrived already\nin the past, or the goods covered by the ENS filing were already presented to the customs\nand effectively the ENS cannot be filed for the same goods already presented, or ENS cannot\nbe amended or invalidated. For an ENS amendment, the state of the original ENS filing is must\nnot be 'presented' or at a state where, for example amendment of the ENS filing is not possible\nanymore (i.e. customs decided to perform controls, or trader notified by the customs that goods\nare to be controlled). For an invalidation request, the related ENS filing is required to be in\na state prior to the state 'presented'.\n" }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiEnsNotCompleteNotification": { "title": "EnsNotCompleteNotification", "required": [ "notificationDate" ], "type": [ "object", "null" ], "properties": { "notificationDate": { "type": "string", "description": "IE3N02 - The time the ens not complete notification was sent by the Shared Trader Interface (STI).\n", "format": "date-time" } }, "description": "IE3N02 - One or more of the parties that are indicated as supplementary declarant have not yet filed.\n" }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiExaminationPlace": { "title": "ExaminationPlace", "type": [ "object", "null" ], "properties": { "placeOfExamination": { "type": [ "string", "null" ] }, "referenceNumber": { "type": [ "string", "null" ] } } }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiFilingStatusENS": { "title": "FilingStatusENS", "required": [ "filingTime" ], "type": [ "object", "null" ], "properties": { "filingTime": { "type": "string", "description": "The time that the ENSfiling was sent to the Shared Trader Interface (STI).\n", "format": "date-time" }, "ensRegistrationResponse": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiEnsFilingRegistration" }, "amendmentNotification": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiAmendmentNotification" }, "ensErrorNotification": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiEnsErrorNotification" }, "lifecycleValidationErrorNotification": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiEnsLifecycleValidationErrorNotification" } }, "description": "The filing status of the ENS at the Shared Trader Interface (STI)\n" }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiFilingStatusNA": { "title": "FilingStatusNA", "required": [ "filingTime" ], "type": [ "object", "null" ], "properties": { "filingTime": { "type": "string", "description": "The time that the ENSfiling was sent to the Shared Trader Interface (STI).\n", "format": "date-time" }, "naRegistrationResponse": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiNaFilingRegistration" }, "naErrorNotification": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiEnsErrorNotification" } }, "description": "The filing status of the NA at the Shared Trader Interface (STI)\n" }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiFilingStatusTemporaryStorage": { "title": "FilingStatusTemporaryStorage", "required": [ "registrationTime" ], "type": [ "object", "null" ], "properties": { "registrationTime": { "type": "string", "description": "The time the temporary storage has been sent to the Dutch Handel en Transport Gateway (HTG).\n", "format": "date-time" }, "registrationResponse": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiTemporaryStorageFilingRegistration" }, "status": { "type": [ "string", "null" ], "enum": [ "DISABLED", "UNKNOWN", "PENDING", "ACCEPTED_WITH_RESERVES", "ACCEPTED", "REJECTED", "WITHDRAWN" ] } }, "description": "The filing status of the Temporary Storage declaration at the dutch Handel en Transport Gateway (HTG)\n" }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiHouseConsignmentIncorrectStateNotification": { "title": "HouseConsignmentIncorrectStateNotification", "required": [ "notificationTime" ], "type": [ "object", "null" ], "properties": { "notificationTime": { "type": "string", "description": "The time the Shared Trader INterface (STI) sent the notification that the house consignment\nis in incorrect state.\n", "format": "date-time" }, "houseTransportDocuments": { "maxItems": 99999, "minItems": 0, "type": "array", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiTransportDocument" } }, "personNotifyingTheArrival": { "type": [ "string", "null" ] }, "errors": { "maxItems": 99999, "minItems": 1, "type": "array", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.status.ApiEnsError" } } }, "description": "IE3N07 - One or more filed house consignments contain errors. This status is triggered after the arrival of the\nmeans of transport is processed by the ICS2 Shared Trader Interface (STI)\n" }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiInvalidationAcceptance": { "title": "InvalidationAcceptance", "required": [ "completionDate" ], "type": [ "object", "null" ], "properties": { "completionDate": { "type": "string", "format": "date-time" } }, "description": "IE3R07 - The invalidation of the ENS is accepted.\n" }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiNaFilingRegistration": { "title": "NaFilingRegistration", "required": [ "mrn", "registrationTime" ], "type": [ "object", "null" ], "properties": { "mrn": { "minLength": 1, "type": "string" }, "registrationTime": { "type": "string", "description": "The time the na filing was registered at the Shared Trader Interface (STI).\n", "format": "date-time" } }, "description": "IE3R04 - The NA filing is received, validated and registered by the ICS2 Shared Trader Interface (STI). A MRN is assigned to the NA filing.\n" }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiPendingNotification": { "title": "PendingNotification", "required": [ "notificationTime" ], "type": [ "object", "null" ], "properties": { "notificationTime": { "type": "string", "description": "The time the Shared Trader Interface sent the notification that a filing is still pending.\n", "format": "date-time" } }, "description": "IE3N11 - Timer to complete the linking of the partial ENS filings has expired. Both carrier and supplementary declarant receive this status message.\nA partial master filing triggers the start of the timer for linking it with the related house level filings. The time allocated for the linking of partial filings should allow sufficient time for the completion of the risk analysis according to the legally set deadlines. Those deadlines depend on the given ENS scenario (i.e. transport mode and situations that determine time-limits – see Articles 105, 106, 107 UCC-DA).\nFor ENS filings F10, F11, F12 and F13 the timer is set to 24h upon reception of the ENS filing in cases of Article 105 (a) UCC-DA.\nFor ENS filings F10, F11, F12 and F13 the timer is set to 4h upon reception of the ENS filing in cases of Article 105 (b) UCC-DA.\nFor ENS filings F10, F11, F12 and F13 the timer is set to 2h upon reception of the ENS filing in cases of Article 105 (c) UCC-DA (edited)\n" }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiRequestedAdditionalInformation": { "title": "RequestedAdditionalInformation", "type": [ "object", "null" ], "properties": { "code": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.consignments.enums.CL752" }, "text": { "maxLength": 512, "minLength": 0, "type": [ "string", "null" ] }, "type": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.consignments.enums.CL703" } } }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiTemporaryStorageFilingRegistration": { "title": "TemporaryStorageFilingRegistration", "required": [ "latestAcceptedTime" ], "type": [ "object", "null" ], "properties": { "latestAcceptedTime": { "type": "string", "description": "The time the temporary storage filing was registered at the Dutch Handel en Transport Gateway (HTG).\n", "format": "date-time" }, "latestNotificationTime": { "type": [ "string", "null" ], "format": "date-time" }, "errors": { "type": "array", "items": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.consignments.status.TemporaryStorageError" } }, "responseCode": { "type": [ "string", "null" ], "enum": [ "CODE_27", "CODE_44", "CODE_45", "CODE_50" ] }, "mrn": { "type": [ "string", "null" ], "description": "The movement reference number defined by Customs of the Temporary Storage declaration\n" } } }, "com.portbase.bezoekschip.common.api.external.consignments.status.ApiTransportDocument": { "title": "TransportDocument", "required": [ "documentNumber", "type" ], "type": [ "object", "null" ], "properties": { "documentNumber": { "maxLength": 70, "minLength": 0, "type": "string" }, "type": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.consignments.enums.CL754" } } }, "com.portbase.bezoekschip.common.api.external.consignments.transhipments.ApiMidStatus": { "title": "MidStatus", "required": [ "sent" ], "type": [ "object", "null" ], "properties": { "status": { "type": [ "string", "null" ], "enum": [ "DECLARED", "ACCEPTED", "REJECTED" ] }, "reason": { "type": [ "string", "null" ] }, "sent": { "type": "boolean" } } }, "com.portbase.bezoekschip.common.api.external.consignments.transhipments.ApiRenStatus": { "title": "RenStatus", "type": [ "object", "null" ], "properties": { "status": { "type": [ "string", "null" ], "enum": [ "DECLARED", "ACCEPTED", "REJECTED" ] }, "reason": { "type": [ "string", "null" ] } } }, "com.portbase.bezoekschip.common.api.external.consignments.transhipments.ApiTranshipment": { "title": "Transhipment", "required": [ "cancelled", "transhipmentDeclarant" ], "type": [ "object", "null" ], "properties": { "cancelled": { "type": "boolean" }, "midStatus": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.transhipments.ApiMidStatus" }, "renStatus": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.transhipments.ApiRenStatus" }, "mrn": { "type": [ "string", "null" ] }, "transhipmentDeclarant": { "$ref": "#/$defs/com.portbase.bezoekschip.common.api.external.consignments.ApiDeclarant" } } } } }