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.

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
rss01	boolean
rss01Description	boolean
referenceNumber	string
lrn	boolean
warehouseType	string
warehouseId	string
exporter	NameAndAddressSchema
exporterContactId	integer
exporterAddressId	integer
exporterIdentificationNumber	string
consignee	NameAndAddressSchema
consigneeContactId	integer
consigneeAddressId	integer
consigneeIdentificationNumber	string
declarant	NameAndAddressSchema
declarantContactId	integer
declarantAddressId	integer
declarantIdentificationNumber	string
representative	NameAndAddressSchema
representativeContactId	integer
representativeAddressId	integer
representativeIdentificationNumber	string
carrier	NameAndAddressSchema
carrierContactId	integer
carrierAddressId	integer
carrierIdentificationNumber	string
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
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
importer	NameAndAddressSchema
importerContactId	integer
importerAddressId	integer
importerIdentificationNumber	string
declarant	NameAndAddressSchema
declarantContactId	integer
declarantAddressId	integer
declarantIdentificationNumber	string
representative	NameAndAddressSchema
representativeContactId	integer
representativeAddressId	integer
representativeIdentificationNumber	string
seller	NameAndAddressSchema
sellerContactId	integer
sellerAddressId	integer
sellerIdentificationNumber	string
buyer	NameAndAddressSchema
buyerContactId	integer
buyerAddressId	integer
buyerIdentificationNumber	string
dan1	string
dan2	string
pva	boolean
pvaVATNumber	string
cashAccountNumber	string
guarantees	array
holdersOfAuthorisation	array of HolderOfAuthorisationIdentificationNumberSchema
rss01	boolean
rss01Description	boolean
countryOfDestination	string
countryOfDispatch	string
airportOfLoading	string
containerised	boolean
modeOfTransportAtBorder	integer
nationalityOfActiveMeansOfTransportAtBorder	string
inlandModeOfTransport	integer
identityOfMeansOfTransportOnArrival	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
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

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
sellerNameAndAddress	string
sellerIdentificationNumber	string
buyerNameAndAddress	string
buyerIdentificationNumber	string
additionalSupplyChainActors	array of AdditionalSupplyChainActorSchema
additionalFiscalReferenceIdentificationNumbers	array of AdditionalFiscalReferenceIdentificationNumberSchema
additionAndDeductions	array of AdditionOrDeductionSchema
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

AdditionOrDeductionSchema

Property	Data type	Required	Description
roleCode	string
vatIdentificationNumber	decimal

TaxBaseSchema

Property	Data type	Required	Description
measurementUnit	string
quantity	decimal