Data Schema
This page details the request and response data schemas for the ClearPort API.
We have made a NuGet package available for C# projects UKCustoms.Api.Models, which contains request and response schema classes.
For endpoints that require a request body, the data should be in JSON format.
CreateExportDataSchema
| Property | Data type | Required | Description |
|---|---|---|---|
| templateId | integer | ||
| linkedDeclarationId | integer | ||
| correlationId | string | ||
| externalSystemLink | string | ||
| category | string | Yes | |
| declarationType | string | ||
| specificCircumstanceIndicator | string | ||
| previousDocuments | array | ||
| ducr | string | ||
| rrs01 | boolean | ||
| rrs01Description | string | ||
| referenceNumber | string | ||
| lrn | boolean | ||
| warehouseType | string | ||
| warehouseId | string | ||
| exporter | NameAndAddressSchema | ||
| exporterContactId | integer | ||
| exporterAddressId | integer | ||
| exporterIdentificationNumber | string | The EORI of the exporter | |
| consignee | NameAndAddressSchema | ||
| consigneeContactId | integer | ||
| consigneeAddressId | integer | ||
| consigneeIdentificationNumber | string | The EORI of the consignee | |
| declarant | NameAndAddressSchema | ||
| declarantContactId | integer | ||
| declarantAddressId | integer | ||
| declarantIdentificationNumber | string | The EORI of the declarant | |
| representative | NameAndAddressSchema | ||
| representativeContactId | integer | ||
| representativeAddressId | integer | ||
| representativeIdentificationNumber | string | The EORI of the representative | |
| carrier | NameAndAddressSchema | ||
| carrierContactId | integer | ||
| carrierAddressId | integer | ||
| carrierIdentificationNumber | string | The EORI of the carrier | |
| holdersOfAuthorisation | array of HolderOfAuthorisationIdentificationNumberSchema | ||
| fr1 | boolean | ||
| fr1VATNumber | string | ||
| transportChargesMethodOfPayment | string | ||
| totalInvoice | decimal | ||
| totalInvoiceCrrencyCode | string | ||
| exchangeRate | decimal | ||
| countryOfDestination | string | ||
| customsOfficeOfExit | string | ||
| countryOfDispatch | string | ||
| countryOfRoutingCodes | array | ||
| locationOfGoods | string | ||
| customsOfficeOfPresentation | string | ||
| supervisingCustomsOffice | string | ||
| totalGrossMass | decimal | ||
| totalNetMass | decimal | ||
| totalPackages | integer | ||
| containerised | boolean | ||
| modeOfTransportAtBorder | integer | ||
| inlandModeOfTransport | integer | ||
| typeOfTransportAtDeparture | integer | ||
| identityOfTransportAtDeparture | string | ||
| containers | array | ||
| typeOfActiveMeansOfTransportAtBorder | integer | ||
| identityOfActiveMeansOfTransportAtBorder | string | ||
| nationalityOfActiveMeansOfTransportAtBorder | string | ||
| seals | array | ||
| guarantees | array | ||
| natureOfTransaction | string | ||
| items | array of ExportItemSchema | ||
| relatedNCTSDeparture | object |
CreateExportResponseSchema
| Property | Data type | Required | Description |
|---|---|---|---|
| success | boolean | Yes | |
| location | string | ||
| correlationId | string |
GetExportDataSchema
| Property | Data type | Required | Description |
|---|---|---|---|
| correlationId | string | yes | |
| status | boolean | yes | |
| mrn | boolean | ||
| lrn | boolean | ||
| ducr | boolean |
HolderOfAuthorisationIdentificationNumberSchema
| Property | Data type | Required | Description |
|---|---|---|---|
| authorisationTypeCode | string | ||
| identifier | string |
ExportItemSchema
| Property | Data type | Required | Description |
|---|---|---|---|
| procedure | string | ||
| additionalProcedures | string | ||
| previousDocuments | array of PreviousDocumentSchema | ||
| additionalInformation | array of AdditionalInformationSchema | ||
| documentsProduced | array of DocumentProducedSchema | ||
| referenceNumber | string | ||
| consignee | NameAndAddressSchema | ||
| consigneeIdentificationNumber | string | The EORI of the consignee | |
| consigneeContactId | integer | ||
| consigneeAddressId | string | ||
| additionalFiscalReferenceIdentificationNumbers | array of AdditionalFiscalReferenceIdentificationNumberSchema | ||
| transportChargesMethodOfPayment | string | ||
| countryOfDestination | string | ||
| countryOfOrigin | string | ||
| netMass | decimal | ||
| grossMass | decimal | ||
| supplementaryUnits | decimal | ||
| descriptionOfGoods | string | ||
| packages | array of PackageSchema | ||
| unDangerousGoodsCode | string | ||
| cusCodeForChemicals | string | ||
| commodityCode | string | ||
| taricAdditionalCodes | string | ||
| nationalAdditionalCodes | string | ||
| containerIdentificationNumbers | array of string | ||
| statisticalValue | decimal | ||
| statisticalValueCurrencyCode | string |
PreviousDocumentSchema
| Property | Data type | Required | Description |
|---|---|---|---|
| category | string | ||
| type | string | ||
| documentReference | string | ||
| goodsItemIdentifier | integer |
AdditionalInformationSchema
| Property | Data type | Required | Description |
|---|---|---|---|
| code | string | ||
| description | string |
DocumentProducedSchema
| Property | Data type | Required | Description |
|---|---|---|---|
| documentType | string | ||
| documentIdentifierAndPart | string | ||
| documentStatus | string | ||
| reason | string | ||
| issuingAuthorityName | string | ||
| dateOfValidity | date | ||
| measurementUnitAndQualifier | string | ||
| quantity | decimal |
NameAndAddressSchema
| Property | Data type | Required | Description |
|---|---|---|---|
| name | string | ||
| streetAndNumber | string | ||
| cityName | string | ||
| postcode | string | ||
| countryCode | string |
AdditionalFiscalReferenceIdentificationNumberSchema
| Property | Data type | Required | Description |
|---|---|---|---|
| roleCode | string | ||
| vatIdentificationNumber | string |
PackageSchema
| Property | Data type | Required | Description |
|---|---|---|---|
| type | string | ||
| number | string | ||
| shippingMarks | string |
CreateImportDataSchema
| Property | Data type | Required | Description |
|---|---|---|---|
| templateId | integer | ||
| linkedDeclarationId | integer | ||
| correlationId | string | ||
| externalSystemLink | string | ||
| category | string | Yes | |
| badge | string | ||
| csp | string | ||
| declarationType | string | ||
| referenceNumber | string | ||
| ducr | string | ||
| lrn | boolean | ||
| representativeStatusCode | integer | ||
| exporter | NameAndAddressSchema | ||
| exporterContactId | integer | ||
| exporterAddressId | integer | ||
| exporterIdentificationNumber | string | The EORI of the exporter | |
| importer | NameAndAddressSchema | ||
| importerContactId | integer | ||
| importerAddressId | integer | ||
| importerIdentificationNumber | string | The EORI of the importer | |
| declarant | NameAndAddressSchema | ||
| declarantContactId | integer | ||
| declarantAddressId | integer | ||
| declarantIdentificationNumber | string | The EORI of the declarant | |
| representative | NameAndAddressSchema | ||
| representativeContactId | integer | ||
| representativeAddressId | integer | ||
| representativeIdentificationNumber | string | The EORI of the representative | |
| seller | NameAndAddressSchema | ||
| sellerContactId | integer | ||
| sellerAddressId | integer | ||
| sellerIdentificationNumber | string | The EORI of the seller | |
| buyer | NameAndAddressSchema | ||
| buyerContactId | integer | ||
| buyerAddressId | integer | ||
| buyerIdentificationNumber | string | The EORI of the buyer | |
| dan1 | string | ||
| dan2 | string | ||
| pva | boolean | ||
| pvaVATNumber | string | ||
| cashAccountNumber | string | ||
| guarantees | array | ||
| holdersOfAuthorisation | array of HolderOfAuthorisationIdentificationNumberSchema | ||
| rrs01 | boolean | ||
| rrs01Description | string | ||
| countryOfDestination | string | ||
| countryOfDispatch | string | ||
| airportOfLoading | string | ||
| containerised | boolean | ||
| modeOfTransportAtBorder | integer | ||
| nationalityOfActiveMeansOfTransportAtBorder | string | ||
| inlandModeOfTransport | integer | ||
| identityOfTransportOnArrival | string | ||
| typeOfTransportOnArrival | string | ||
| containers | array | ||
| awb | string | ||
| mcr | string | ||
| hawb | string | ||
| bol | string | ||
| previousDocuments | array | ||
| warehouseType | string | ||
| warehouseId | string | ||
| customsOfficeOfPresentation | string | ||
| supervisingCustomsOffice | string | ||
| natureOfTransaction | string | ||
| deliveryTerms | string | ||
| deliveryTermsLocation | string | ||
| totalGrossMass | decimal | ||
| totalNetMass | decimal | ||
| totalPackages | integer | ||
| totalInvoice | decimal | ||
| totalInvoiceCrrencyCode | string | ||
| exchangeRate | decimal | ||
| items | array of ImportItemSchema | ||
| additionsAndDeductions | array of AdditionsAndDeductionsSchema | ||
| freightCharge | array | ||
| freightChargeCurrency | array | ||
| airTransportCharge | array | ||
| airTransportChargeCurrency | array | ||
| insuranceCharge | array | ||
| insuranceChargeCurrency | array | ||
| vatAdjustmentCharge | array | ||
| vatAdjustmentCurrency | array | ||
| apportionByValue | boolean |
CreateImportResponseSchema
| Property | Data type | Required | Description |
|---|---|---|---|
| success | boolean | Yes | |
| location | string | ||
| correlationId | string |
GetImportDataSchema
| Property | Data type | Required | Description |
|---|---|---|---|
| correlationId | string | yes | |
| status | boolean | yes | |
| mrn | boolean | ||
| lrn | boolean | ||
| ducr | boolean |
GetImportTaxDataSchema
| Property | Data type | Required | Description |
|---|---|---|---|
| mrn | string | yes | |
| hasTaxes | boolean | yes | |
| totalDuty | decimal | ||
| totalVAT | decimal | ||
| payableDuty | decimal | ||
| payableVAT | decimal | ||
| taxBreakdown | array of TaxBreakdownSchema |
TaxBreakdownSchema
| Property | Data type | Required | Description |
|---|---|---|---|
| type | string | ||
| totalAmount | decimal | ||
| payableAmount | decimal | ||
| dan | string | ||
| cdsCashAccount | string | ||
| pvavatnumber | string |
ImportItemSchema
| Property | Data type | Required | Description |
|---|---|---|---|
| commodityCode | string | ||
| taricAdditionalCodes | string | ||
| nationalAdditionalCodes | string | ||
| procedure | string | ||
| additionalProcedures | string | ||
| countryOfOrigin | string | ||
| countryOfPreferentialOrigin | string | ||
| preference | string | ||
| quotaNumber | string | ||
| descriptionOfGoods | string | ||
| cusCodeForChemicals | string | ||
| valuationMethod | integer | ||
| itemPrice | decimal | ||
| itemPriceCurrencyCode | string | ||
| value | decimal | ||
| valueCurrencyCode | string | ||
| statisticalValue | decimal | ||
| statisticalValueCurrencyCode | string | ||
| valuationIndicator_PartyRelationship | boolean | ||
| valuationIndicator_BuyerRestrictions | boolean | ||
| valuationIndicator_SaleOrPriceConditions | boolean | ||
| valuationIndicator_SaleProceeds | boolean | ||
| transportCostsToFinalDestination | string | ||
| transportCostsToFinalDestinationCurrencyCode | string | ||
| netMass | decimal | ||
| supplementaryUnits | decimal | ||
| grossMass | decimal | ||
| previousDocuments | array of PreviousDocumentSchema | ||
| additionalInformation | array of AdditionalInformationSchema | ||
| documentsProduced | array of DocumentProducedSchema | ||
| packages | array of PackageSchema | ||
| containerIdentificationNumbers | array of string | ||
| taxLines | array of TaxLineSchema | ||
| A00_PaymentMethod | string | ||
| B00_PaymentMethod | string | ||
| jobReference | string | ||
| exporterNameAndAddress | string | ||
| exporterIdentificationNumber | string | The EORI of the exporter | |
| sellerNameAndAddress | string | ||
| sellerIdentificationNumber | string | seller | |
| buyerNameAndAddress | string | ||
| buyerIdentificationNumber | string | The EORI of the buyer | |
| additionalSupplyChainActors | array of AdditionalSupplyChainActorSchema | ||
| additionalFiscalReferenceIdentificationNumbers | array of AdditionalFiscalReferenceIdentificationNumberSchema | ||
| additionsAndDeductions | array of AdditionsAndDeductionsSchema | ||
| countryOfDestinationCode | string | ||
| countryOfDispatchCode | string | ||
| natureOfTransaction | string |
TaxLineSchema
| Property | Data type | Required | Description |
|---|---|---|---|
| taxType | string | ||
| taxBase | TaxBaseSchema | ||
| payableAmount | decimal | ||
| payableAmountCurrencyCode | string | ||
| totalTaxes | decimal | ||
| totalTaxesCurrencyCode | string | ||
| methodOfPayment | string |
AdditionalSupplyChainActorSchema
| Property | Data type | Required | Description |
|---|---|---|---|
| roleCode | string | ||
| identifier | decimal |
AdditionsAndDeductionsSchema
| Property | Data type | Required | Description |
|---|---|---|---|
| code | string | ||
| amount | decimal | ||
| amountCurrency | string |
TaxBaseSchema
| Property | Data type | Required | Description |
|---|---|---|---|
| measurementUnit | string | ||
| quantity | decimal |
GetAirConsignmentsDataSchema
| Property | Data type | Required | Description |
|---|---|---|---|
| awb | string | ||
| hawb | string | ||
| split | string | ||
| mrn | string | ||
| customsEntryDate | datetime | ||
| jobReferenceNumber | string | ||
| numberOfPiecesReceived | integer | ||
| customsStatus | string |
CreateENSDataSchema
| Property | Data type | Required | Description |
|---|---|---|---|
| correlationId | string | Yes | Use this field to relate the submission to an identifier in your system |
| templateId | integer | Optionally specify a template | |
| submitIfValid | boolean | Automatically submit the declaration if it passes validation checks | |
| externalSystemLink | string | ||
| messageSenderEORI | string | ||
| messageSenderBranch | string | ||
| lrn | string | ||
| placeOfDeclaration | string | ||
| placeOfLoading | string | ||
| placeOfUnloading | string | ||
| commercialReferenceNumber | string | ||
| modeOfTransportAtBorder | string | ||
| identityOfMeansOfTransportAtBorder | string | ||
| nationalityOfMeansOfTransportAtBorder | string | ||
| conveyenceReferenceNumber | string | ||
| consignor | ENSPartySchema | ||
| consignee | ENSPartySchema | ||
| personLodgingDeclaration | ENSPartySchema | ||
| carrier | ENSPartySchema | ||
| notifyParty | ENSPartySchema | ||
| representative | ENSPartySchema | ||
| customsOfficeOfArrival | string | ||
| dateAndTimeOfArrival | datetime | ||
| customsOfficesOfSubsequentEntry | array of string | ||
| transportChargesMethodOfPayment | string | ||
| specialMentions | string | ||
| routingCountries | array of string | ||
| seals | array of string | ||
| goodsItems | array of ENSGoodsItemSchema |
ENSPartySchema
| Property | Data type | Required | Description |
|---|---|---|---|
| name | string | ||
| streetAndNumber | string | ||
| city | string | ||
| postcode | string | ||
| countryCode | string | ||
| eori | string |
ENSGoodsItemSchema
| Property | Data type | Required | Description |
|---|---|---|---|
| commodityCode | string | ||
| goodsDescription | string | ||
| commercialReferenceNumber | string | ||
| grossMass | string | ||
| unDangerousGoodsCode | string | ||
| identityOfMeansOfTransportAtBorder | string | ||
| nationalityOfMeansOfTransportAtBorder | string | ||
| placeOfLoading | string | ||
| placeOfUnloading | string | ||
| transportChargesMethodOfPayment | string | ||
| packages | array of ENSPackageSchema | ||
| producedDocuments | array of ENSProdcedDocumentSchema |
ENSPackageSchema
| Property | Data type | Required | Description |
|---|---|---|---|
| kind | string | ||
| numberOfPackages | integer | ||
| numberOfPieces | integer | ||
| marksAndNumbers | string |
ENSProdcedDocumentSchema
| Property | Data type | Required | Description |
|---|---|---|---|
| type | string | ||
| reference | string |
CreateENSResponseSchema
| Property | Data type | Required | Description |
|---|---|---|---|
| success | boolean | Yes | |
| location | string | ||
| correlationId | string |
GetENSDataSchema
| Property | Data type | Description |
|---|---|---|
| status | boolean | |
| mrn | string | |
| lrn | string |
CreateGVMSDataSchema
| Property | Data type | Description |
|---|---|---|
| correlationId | string | |
| submitIfValid | boolean | Automatically submit the declaration if it passes validation checks |
| direction | string | |
| haulierType | string | |
| isUnaccompanied | boolean | |
| vehicleRegNumber | string | |
| trailerRegistrationNumbers | array of string | |
| containerRegistrationNumbers | array of string | |
| routeId | string | see GVMS Routes |
| localDateTimeOfDeparture | string | |
| sAndSMasterRefNum | string | |
| customsDeclarations | array of GVMSCustomsDeclarationDataSchema | |
| transitDeclarations | array of GVMSTransitDeclarationDataSchema | |
| tirDeclarationDTO | array of GVMSTIRDeclarationDataSchema | |
| ataDeclarations | array of GVMSATADeclarationDataSchema | |
| eidrDeclarations | array of GVMSEIDRDeclarationDataSchema | |
| indirectExportDeclarations | array of GVMSIndirectExportDeclarationDataSchema | |
| emptyVehicle | boolean | |
| ownVehicle | boolean | |
| dbcGoods | string | |
| exemptedGoods | string |
GetGVMSDataSchema
| Property | Data type | Description |
|---|---|---|
| correlationId | string | |
| gmrId | string | |
| status | string | |
| direction | string | |
| haulierType | string | |
| isUnaccompanied | boolean | |
| vehicleRegNumber | string | |
| trailerRegistrationNumbers | array of string | |
| containerRegistrationNumbers | array of string | |
| routeId | string | see GVMS Routes |
| localDateTimeOfDeparture | string | |
| sAndSMasterRefNum | string | |
| customsDeclarations | array of GVMSCustomsDeclarationDataSchema | |
| transitDeclarations | array of GVMSTransitDeclarationDataSchema | |
| tirDeclarationDTO | array of GVMSTIRDeclarationDataSchema | |
| ataDeclarations | array of GVMSATADeclarationDataSchema | |
| eidrDeclarations | array of GVMSEIDRDeclarationDataSchema | |
| indirectExportDeclarations | array of GVMSIndirectExportDeclarationDataSchema | |
| emptyVehicle | boolean | |
| ownVehicle | boolean | |
| dbcGoods | string | |
| exemptedGoods | string |
GVMSCustomsDeclarationDataSchema
| Property | Data type | Description |
|---|---|---|
| customsDeclarationId | string | |
| customsDeclarationPartId | string | |
| sAndSMasterRefNum | string |
GVMSTransitDeclarationDataSchema
| Property | Data type | Description |
|---|---|---|
| transitDeclarationId | string | |
| isTSAD | bool | |
| sAndSMasterRefNum | string |
GVMSTIRDeclarationDataSchema
| Property | Data type | Description |
|---|---|---|
| tirCarnetId | string | |
| sAndSMasterRefNum | string |
GVMSATADeclarationDataSchema
| Property | Data type | Description |
|---|---|---|
| ataCarnetId | string | |
| sAndSMasterRefNum | string |
GVMSEIDRDeclarationDataSchema
| Property | Data type | Description |
|---|---|---|
| traderEORI | string | |
| sAndSMasterRefNum | string |
GVMSIndirectExportDeclarationDataSchema
| Property | Data type | Description |
|---|---|---|
| eadMasterRefNum | string |
CreateELODataSchema
| Property | Data type | Description |
|---|---|---|
| correlationId | string | |
| referenceNumber | string | |
| direction | string | Import or Export |
| vehicleStatus | string | Loaded or Empty |
| tirOrAta | boolean | |
| sanitaryOrPhytosanitary | boolean | |
| fishProducts | boolean | |
| jeton | string | |
| declarations | array of string | |
| submitIfValid | boolean |
GetELODataSchema
| Property | Data type | Description |
|---|---|---|
| correlationId | string | |
| referenceNumber | string | |
| direction | string | Import or Export |
| vehicleStatus | string | Loaded or Empty |
| tirOrAta | boolean | |
| sanitaryOrPhytosanitary | boolean | |
| fishProducts | boolean | |
| declarations | array of string | |
| submittedDateTime | datetime | |
| acceptedDateTime | datetime | |
| rejectedDateTime | datetime | |
| embarkedDateTime | datetime | |
| disembarkedDateTime | datetime | |
| closedDateTime | datetime | |
| pairedDateTime | datetime |