XML Schema Documentation

Table of Contents

top

Schema Document Properties

Target Namespace None
Element and Attribute Namespaces
  • Global element and attribute declarations belong to this schema's target namespace.
  • By default, local element declarations belong to this schema's target namespace.
  • By default, local attribute declarations have no namespace.
Schema Composition

Declared Namespaces

Prefix Namespace
xs http://www.w3.org/2001/XMLSchema
xsi http://www.w3.org/2001/XMLSchema-instance
xml http://www.w3.org/XML/1998/namespace
Schema Component Representation
<xs:schema schemaLocation="http://www.w3.org/2001/XMLSchema http://www.w3.org/2001/XMLSchema.xsd" elementFormDefault="qualified">
<xs:include schemaLocation="customsTypes-v5.xsd"/>
...
</xs:schema>
top

Global Definitions

Complex Type: addressType

Super-types: None
Sub-types: None
Name addressType
Abstract no
XML Instance Representation
<...>
<name> token256 </name> [1]
Start Choice [1]
<street> token256 </street> [0..1]
<houseNumber> token9 </houseNumber> [0..1]
<poBox> token35 </poBox> [1]
End Choice
<city> cityType </city> [0..1]
<district> token35 </district> [0..1]
<state> stateType </state> [0..1] ?
<country> A2Type </country> [0..1] ?
<addressAddition> token35 </addressAddition> [0..1]
</...>
Schema Component Representation
<xs:complexType name="addressType">
<xs:sequence>
<xs:element name="name" type="token256"/>
<xs:choice>
<xs:sequence>
<xs:element name="street" type="token256" minOccurs="0"/>
<xs:element name="houseNumber" type="token9" minOccurs="0"/>
</xs:sequence>
<xs:element name="poBox" type="token35"/>
</xs:choice>
<xs:element name="city" type="cityType" minOccurs="0"/>
<xs:element name="district" type="token35" minOccurs="0"/>
<xs:element name="state" type="stateType" minOccurs="0"/>
<xs:element name="country" type="A2Type" minOccurs="0"/>
<xs:element name="addressAddition" type="token35" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: cityType

Super-types: xs:string < cityType (by extension)
Sub-types: None
Name cityType
Abstract no
XML Instance Representation
<...
zip="token256 [0..1]">
xs:string
</...>
Schema Component Representation
<xs:complexType name="cityType">
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute name="zip" type="token256"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
top

Complex Type: contactType

Super-types: None
Sub-types: None
Name contactType
Abstract no
XML Instance Representation
<...>
<name> token35 </name> [0..1]
<title> token35 </title> [0..1]
<phone> token35 </phone> [0..1]
<fax> token35 </fax> [0..1]
<email> token256 </email> [0..1]
</...>
Schema Component Representation
<xs:complexType name="contactType">
<xs:sequence>
<xs:element name="name" type="token35" minOccurs="0"/>
<xs:element name="title" type="token35" minOccurs="0"/>
<xs:element name="phone" type="token35" minOccurs="0"/>
<xs:element name="fax" type="token35" minOccurs="0"/>
<xs:element name="email" type="token256" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: containerType

Super-types: None
Sub-types: None
Name containerType
Abstract no
XML Instance Representation
<...>
<containerNumber> containerNoType </containerNumber> [0..1]
<seals> sealsType </seals> [0..1]
</...>
Schema Component Representation
<xs:complexType name="containerType">
<xs:sequence>
<xs:element name="containerNumber" type="containerNoType" minOccurs="0"/>
<xs:element name="seals" type="sealsType" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: customsDocType

Super-types: None
Sub-types: None
Name customsDocType
Abstract no
XML Instance Representation
<...>
Start Choice [1] ?
<kindOfDoc> customsKindOfDocType </kindOfDoc> [1] ?
<docCode> token8 </docCode> [0..1] ?
End Choice
<docDetails> docDetailType </docDetails> [0..1]
</...>
Schema Component Representation
<xs:complexType name="customsDocType">
<xs:sequence>
<xs:choice>
<xs:element name="kindOfDoc" type="customsKindOfDocType"/>
<xs:element name="docCode" type="token8" minOccurs="0"/>
</xs:choice>
<xs:element name="docDetails" type="docDetailType" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: customsProcessType

Super-types: None
Sub-types: None
Name customsProcessType
Abstract no
XML Instance Representation
<...>
<intoCountry> A2Type </intoCountry> [1] ?
<procedure> procedureType </procedure> [1]
<identification> identificationType </identification> [1] ?
</...>
Schema Component Representation
<xs:complexType name="customsProcessType">
<xs:sequence>
<xs:element name="intoCountry" type="A2Type"/>
<xs:element name="procedure" type="procedureType"/>
<xs:element name="identification" type="identificationType"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: defermentAccountDetailsType

Super-types: None
Sub-types: None
Name defermentAccountDetailsType
Abstract no
XML Instance Representation
<...>
<defermentType> nmtoken2 </defermentType> [0..1]
<accountPrefix> defermentAccountPrefix </accountPrefix> [0..1]
<accountNumber> nmtoken35 </accountNumber> [0..1]
<applicant> eoriNumberType </applicant> [0..1]
<authorisationNumber> nmtoken25 </authorisationNumber> [0..1]
</...>
Schema Component Representation
<xs:complexType name="defermentAccountDetailsType">
<xs:sequence>
<xs:element name="defermentType" type="nmtoken2" minOccurs="0"/>
<xs:element name="accountPrefix" type="defermentAccountPrefix" minOccurs="0"/>
<xs:element name="accountNumber" type="nmtoken35" minOccurs="0"/>
<xs:element name="applicant" type="eoriNumberType" minOccurs="0"/>
<xs:element name="authorisationNumber" type="nmtoken25" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: dimensionType

Super-types: xs:decimal < dimensionType (by extension)
Sub-types: None
Name dimensionType
Abstract no
XML Instance Representation
<...
Unit="xs:string (value comes from list: {'MTR'|'CMT'|'MTQ'}) [1]">
xs:decimal
</...>
Schema Component Representation
<xs:complexType name="dimensionType">
<xs:simpleContent>
<xs:extension base="xs:decimal">
<xs:attribute name="Unit" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="MTR"/>
<xs:enumeration value="CMT"/>
<xs:enumeration value="MTQ"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
top

Complex Type: docDetailType

Super-types: None
Sub-types: None
Name docDetailType
Abstract no
XML Instance Representation
<...>
<docNo> token35 </docNo> [0..1]
<docQualifier> token3 </docQualifier> [0..1]
<docLine> xs:integer </docLine> [0..1]
<docDate> xs:date </docDate> [0..1]
<docValidUntil> xs:date </docValidUntil> [0..1]
<docAddition> token35 </docAddition> [0..1]
<docDetail> token12 </docDetail> [0..1] ?
<docCountry> A2Type </docCountry> [0..1]
<docIssuePlace> token35 </docIssuePlace> [0..1]
<docIsAvailable> xs:boolean </docIsAvailable> [0..1]
<docAmount> moneyAmountType </docAmount> [0..1] ?
<docLicenseValue> xs:integer </docLicenseValue> [0..1]
<docWriteOffAmount> dec3fractType </docWriteOffAmount> [0..1]
<docWriteOffUnit> A3Type </docWriteOffUnit> [0..1]
<docComplementaryUnit> A10Type </docComplementaryUnit> [0..1]
<docImage> xs:base64Binary </docImage> [0..1] ?
<docPDF> xs:base64Binary </docPDF> [0..1] ?
</...>
Schema Component Representation
<xs:complexType name="docDetailType">
<xs:sequence>
<xs:element name="docNo" type="token35" minOccurs="0"/>
<xs:element name="docQualifier" type="token3" minOccurs="0"/>
<xs:element name="docLine" type="xs:integer" minOccurs="0"/>
<xs:element name="docDate" type="xs:date" minOccurs="0"/>
<xs:element name="docValidUntil" type="xs:date" minOccurs="0"/>
<xs:element name="docAddition" type="token35" minOccurs="0"/>
<xs:element name="docDetail" type="token12" minOccurs="0"/>
<xs:element name="docCountry" type="A2Type" minOccurs="0"/>
<xs:element name="docIssuePlace" type="token35" minOccurs="0"/>
<xs:element name="docIsAvailable" type="xs:boolean" minOccurs="0"/>
<xs:element name="docAmount" type="moneyAmountType" minOccurs="0"/>
<xs:element name="docLicenseValue" type="xs:integer" minOccurs="0"/>
<xs:element name="docWriteOffAmount" type="dec3fractType" minOccurs="0"/>
<xs:element name="docWriteOffUnit" type="A3Type" minOccurs="0"/>
<xs:element name="docComplementaryUnit" type="A10Type" minOccurs="0"/>
<xs:element name="docImage" type="xs:base64Binary" minOccurs="0"/>
<xs:element name="docPDF" type="xs:base64Binary" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: eoriType

Super-types: None
Sub-types:
Name eoriType
Abstract no
XML Instance Representation
<...>
<EORINo> eoriNumberType </EORINo> [1]
<EORINl> eoriBranchIdType </EORINl> [0..1]
</...>
Schema Component Representation
<xs:complexType name="eoriType">
<xs:sequence>
<xs:element name="EORINo" type="eoriNumberType"/>
<xs:element name="EORINl" type="eoriBranchIdType" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: externalSystemType

Super-types: None
Sub-types: None
Name externalSystemType
Abstract no
Documentation The 3rd party system sending messages to Scope.
XML Instance Representation
<...>
<system> nmtoken35 </system> [1] ?
<subSystem> nmtoken35 </subSystem> [0..1] ?
</...>
Schema Component Representation
<xs:complexType name="externalSystemType">
<xs:sequence>
<xs:element name="system" type="nmtoken35"/>
<xs:element name="subSystem" type="nmtoken35" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: identificationType

Super-types: None
Sub-types: None
Name identificationType
Abstract no
Documentation SCI supports several way to identify if a procedure already exists and to apply an update. The different mappings describe if an update is possible and which types of identification are available. Scope might do one of the following, if the procedure already exists: - Update the existing procedure, if the procedure supports this. - Reject the message if the procedure does not support this. The customsReceipt message will report the outcome to the sender.
XML Instance Representation
<...>
<uniqueReference> token35 </uniqueReference> [0..1] ?
<mrn> mrnType </mrn> [0..1] ?
Start Sequence [0..1] ?
<lrn> nmtoken22 </lrn> [1]
<lrnOwner> lrnOwnerType </lrnOwner> [0..1] ?
End Sequence
<reference> token35 </reference> [0..1] ?
<manifest> manifestType </manifest> [0..1] ?
<searchReference> token35 </searchReference> [0..*]
</...>
Schema Component Representation
<xs:complexType name="identificationType">
<xs:sequence>
<xs:element name="uniqueReference" type="token35" minOccurs="0"/>
<xs:element name="mrn" type="mrnType" minOccurs="0"/>
<xs:sequence minOccurs="0">
<xs:element name="lrn" type="nmtoken22"/>
<xs:element name="lrnOwner" type="lrnOwnerType" minOccurs="0"/>
</xs:sequence>
<xs:element name="reference" type="token35" minOccurs="0"/>
<xs:element name="manifest" type="manifestType" minOccurs="0"/>
<xs:element name="searchReference" type="token35" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: incotermType

Super-types: None
Sub-types: None
Name incotermType
Abstract no
XML Instance Representation
<...>
<incoterm> xs:string (length = 3) </incoterm> [1] ?
<incotermPlace> token100 </incotermPlace> [0..1]
<incotermCountry> A2Type </incotermCountry> [0..1]
<incotermUnlocode> nmtoken5 </incotermUnlocode> [0..1]
<incotermKey> incotermKeyType </incotermKey> [0..1]
<incotermAddition> token35 </incotermAddition> [0..1]
</...>
Schema Component Representation
<xs:complexType name="incotermType">
<xs:sequence>
<xs:element name="incoterm">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:length value="3"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="incotermPlace" type="token100" minOccurs="0"/>
<xs:element name="incotermCountry" type="A2Type" minOccurs="0"/>
<xs:element name="incotermUnlocode" type="nmtoken5" minOccurs="0"/>
<xs:element name="incotermKey" type="incotermKeyType" minOccurs="0"/>
<xs:element name="incotermAddition" type="token35" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: lrnOwnerType

Super-types: eoriType < lrnOwnerType (by extension)
Sub-types: None
Name lrnOwnerType
Abstract no
XML Instance Representation
<...>
<EORINo> eoriNumberType </EORINo> [1]
<EORINl> eoriBranchIdType </EORINl> [0..1]
<kind> lrnOwnerKindType </kind> [1]
</...>
Schema Component Representation
<xs:complexType name="lrnOwnerType">
<xs:complexContent>
<xs:extension base="eoriType">
<xs:sequence>
<xs:element name="kind" type="lrnOwnerKindType"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: manifestType

Super-types: None
Sub-types: None
Name manifestType
Abstract no
XML Instance Representation
<...>
<flightNumber> nmtoken8 </flightNumber> [1]
<date> xs:date </date> [1]
<origin> locationType </origin> [1]
<destination> locationType </destination> [0..1]
</...>
Schema Component Representation
<xs:complexType name="manifestType">
<xs:sequence>
<xs:element name="flightNumber" type="nmtoken8"/>
<xs:element name="date" type="xs:date"/>
<xs:element name="origin" type="locationType"/>
<xs:element name="destination" type="locationType" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: meansOfTransportType

Super-types: None
Sub-types: None
Name meansOfTransportType
Abstract no
XML Instance Representation
<...>
Start Choice [0..1]
<kind> meansOfTransportKindType </kind> [1]
<kindOfIdentification> meansOfTransportIdentificationType </kindOfIdentification> [1]
End Choice
<nationality> A2Type </nationality> [0..1]
<identification> token35 </identification> [0..1]
<intendedBorderOffice> customsOffice </intendedBorderOffice> [0..1]
</...>
Schema Component Representation
<xs:complexType name="meansOfTransportType">
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element name="kind" type="meansOfTransportKindType"/>
<xs:element name="kindOfIdentification" type="meansOfTransportIdentificationType"/>
</xs:choice>
<xs:element name="nationality" type="A2Type" minOccurs="0"/>
<xs:element name="identification" type="token35" minOccurs="0"/>
<xs:element name="intendedBorderOffice" type="customsOffice" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: packageDataType

Super-types: None
Sub-types: None
Name packageDataType
Abstract no
XML Instance Representation
<...>
<sequenceNumber> number1or2nonZeroType </sequenceNumber> [0..1]
<packageCode> AN2Type </packageCode> [0..1]
<packageNumber> int8Type </packageNumber> [0..1]
<packageSign> token70 </packageSign> [0..1] ?
<length> dimensionType </length> [0..1]
<width> dimensionType </width> [0..1]
<height> dimensionType </height> [0..1]
<stackable> xs:boolean </stackable> [0..1]
<stackHeight> xs:integer </stackHeight> [0..1] ?
<SLAC> xs:integer </SLAC> [0..1]
<description> token256 </description> [0..1]
<identification> token35 </identification> [0..1] ?
<ETD> xs:dateTime </ETD> [0..1]
<loadingPlace> locationType </loadingPlace> [0..1]
<type> n2Type </type> [0..1]
<country> A2Type </country> [0..1]
</...>
Schema Component Representation
<xs:complexType name="packageDataType">
<xs:sequence>
<xs:element name="sequenceNumber" type="number1or2nonZeroType" minOccurs="0"/>
<xs:element name="packageCode" type="AN2Type" minOccurs="0"/>
<xs:element name="packageNumber" type="int8Type" minOccurs="0"/>
<xs:element name="packageSign" type="token70" minOccurs="0"/>
<xs:element name="length" type="dimensionType" minOccurs="0"/>
<xs:element name="width" type="dimensionType" minOccurs="0"/>
<xs:element name="height" type="dimensionType" minOccurs="0"/>
<xs:element name="stackable" type="xs:boolean" minOccurs="0"/>
<xs:element name="stackHeight" type="xs:integer" minOccurs="0"/>
<xs:element name="SLAC" type="xs:integer" minOccurs="0"/>
<xs:element name="description" type="token256" minOccurs="0"/>
<xs:element name="identification" type="token35" minOccurs="0"/>
<xs:element name="ETD" type="xs:dateTime" minOccurs="0"/>
<xs:element name="loadingPlace" type="locationType" minOccurs="0"/>
<-- HEI201910 Added for AES Exit -->
<-- HEI201910 Added for AES Exit -->
<-- HEI201910 Added for AES Exit -->
<xs:element name="type" type="n2Type" minOccurs="0"/>
<xs:element name="country" type="A2Type" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: partiesType

Super-types: None
Sub-types:
Name partiesType
Abstract no
XML Instance Representation
<...>
Start Choice [0..1]
<scopePartner> scopePartnerAddressType </scopePartner> [1]
<address> addressType </address> [1]
End Choice
<typeOfPerson> typeOfPersonType </typeOfPerson> [0..1]
<contact> contactType </contact> [0..1]
<partyID> partyIdentifier </partyID> [0..1]
<reference> token35 </reference> [0..*] ?
<attentionText> token70 </attentionText> [0..1] ?
<taxId> token256 </taxId> [0..1] ?
<agentStatus> string3 </agentStatus> [0..1]
<certificate> partyCertificateType </certificate> [0..99]
<debtorNumberPD> nmtoken18 </debtorNumberPD> [0..1] ?
</...>
Schema Component Representation
<xs:complexType name="partiesType">
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element name="scopePartner" type="scopePartnerAddressType"/>
<xs:element name="address" type="addressType"/>
</xs:choice>
<xs:element name="typeOfPerson" type="typeOfPersonType" minOccurs="0"/>
<xs:element name="contact" type="contactType" minOccurs="0"/>
<xs:element name="partyID" type="partyIdentifier" minOccurs="0"/>
<xs:element name="reference" type="token35" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="attentionText" type="token70" minOccurs="0"/>
<xs:element name="taxId" type="token256" minOccurs="0"/>
<xs:element name="agentStatus" type="string3" minOccurs="0"/>
<xs:element name="certificate" type="partyCertificateType" minOccurs="0" maxOccurs="99"/>
<xs:element name="debtorNumberPD" type="nmtoken18" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: partyCertificateType

Super-types: None
Sub-types: None
Name partyCertificateType
Abstract no
XML Instance Representation
<...>
<certType> certTypeType </certType> [1]
<certNumber> token35 </certNumber> [1]
<certIssueDate> xs:date </certIssueDate> [0..1]
</...>
Schema Component Representation
<xs:complexType name="partyCertificateType">
<xs:sequence>
<xs:element name="certType" type="certTypeType"/>
<xs:element name="certNumber" type="token35"/>
<xs:element name="certIssueDate" type="xs:date" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: partyIdentifier

Super-types: None
Sub-types: None
Name partyIdentifier
Abstract no
Documentation The Party-ID delivered in the interface is meant to identify this one customer in this instance.
XML Instance Representation
<...>
<airlineCode> AN2Type </airlineCode> [0..1] ?
<customsID> nmtoken22 </customsID> [0..1]
<eori> eoriType </eori> [0..1]
<customsTCUI> string17 </customsTCUI> [0..1]
<scac> nmtoken4_4 </scac> [0..1]
</...>
Schema Component Representation
<xs:complexType name="partyIdentifier">
<xs:sequence>
<xs:element name="airlineCode" type="AN2Type" minOccurs="0"/>
<xs:element name="customsID" type="nmtoken22" minOccurs="0"/>
<xs:element name="eori" type="eoriType" minOccurs="0"/>
<xs:element name="customsTCUI" type="string17" minOccurs="0"/>
<xs:element name="scac" type="nmtoken4_4" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: scopePartnerAddressType

Super-types: scopePartnerType < scopePartnerAddressType (by extension)
Sub-types: None
Name scopePartnerAddressType
Abstract no
Documentation A address linked to a partner in Scope. If no address is given, the address from the master data in Scope will be used. Depending on the configuration partners can be created and updated.

Messages to Scope will be rejected, if the partner cannot be found in the master data and the configuration does not allow the creation of new partners.
XML Instance Representation
<...>
Start Choice [1]
<scopePartnerCode> token35 </scopePartnerCode> [1] ?
<urn> nmtoken128 </urn> [1] ?
<externalId> nmtoken128 </externalId> [1] ?
<eori> eoriType </eori> [1] ?
<customsID> nmtoken22 </customsID> [0..1] ?
End Choice
<address> addressType </address> [0..1]
</...>
Schema Component Representation
<xs:complexType name="scopePartnerAddressType">
<xs:complexContent>
<xs:extension base="scopePartnerType">
<xs:sequence>
<xs:element name="address" type="addressType" minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: scopePartnerType

Super-types: None
Sub-types:
Name scopePartnerType
Abstract no
Documentation Identifies a partner in Scope.
XML Instance Representation
<...>
Start Choice [1]
<scopePartnerCode> token35 </scopePartnerCode> [1] ?
<urn> nmtoken128 </urn> [1] ?
<externalId> nmtoken128 </externalId> [1] ?
<eori> eoriType </eori> [1] ?
<customsID> nmtoken22 </customsID> [0..1] ?
End Choice
</...>
Schema Component Representation
<xs:complexType name="scopePartnerType">
<xs:choice>
<xs:element name="scopePartnerCode" type="token35"/>
<xs:element name="urn" type="nmtoken128"/>
<xs:element name="externalId" type="nmtoken128"/>
<xs:element name="eori" type="eoriType"/>
<xs:element name="customsID" type="nmtoken22" minOccurs="0"/>
</xs:choice>
</xs:complexType>
top

Complex Type: scopeSystemType

Super-types: None
Sub-types: None
Name scopeSystemType
Abstract no
Documentation The Scope branch, described by its system, organization and branch. The branch is identified by the corresponding partner.
XML Instance Representation
<...>
<organization> organizationCodeType </organization> [1] ?
<branch> scopePartnerType </branch> [1] ?
</...>
Schema Component Representation
<xs:complexType name="scopeSystemType">
<xs:sequence>
<xs:element name="organization" type="organizationCodeType"/>
<xs:element name="branch" type="scopePartnerType"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: sealsType

Super-types: None
Sub-types: None
Name sealsType
Abstract no
XML Instance Representation
<...>
<sealExemption> xs:boolean </sealExemption> [0..1]
<sealType> sealType </sealType> [0..1]
Start Choice [1]
<sealCount> xs:integer </sealCount> [1]
<seal> token20 </seal> [1..*]
End Choice
</...>
Schema Component Representation
<xs:complexType name="sealsType">
<xs:sequence>
<xs:element name="sealExemption" type="xs:boolean" minOccurs="0"/>
<xs:element name="sealType" type="sealType" minOccurs="0"/>
<xs:choice>
<xs:element name="sealCount" type="xs:integer"/>
<xs:element name="seal" type="token20" maxOccurs="unbounded"/>
</xs:choice>
<-- DHE-NCTS-NL -->
</xs:sequence>
</xs:complexType>
top

Complex Type: senderRecipientType

Super-types: None
Sub-types: None
Name senderRecipientType
Abstract no
XML Instance Representation
<...>
Start Choice [1]
<externalSystem> externalSystemType </externalSystem> [1] ?
<scope> scopeSystemType </scope> [1] ?
End Choice
</...>
Schema Component Representation
<xs:complexType name="senderRecipientType">
<xs:choice>
<xs:element name="externalSystem" type="externalSystemType"/>
<xs:element name="scope" type="scopeSystemType"/>
</xs:choice>
</xs:complexType>
top

Complex Type: supplyChainActorType

Super-types: partiesType < supplyChainActorType (by extension)
Sub-types: None
Name supplyChainActorType
Abstract no
XML Instance Representation
<...>
Start Choice [0..1]
<scopePartner> scopePartnerAddressType </scopePartner> [1]
<address> addressType </address> [1]
End Choice
<typeOfPerson> typeOfPersonType </typeOfPerson> [0..1]
<contact> contactType </contact> [0..1]
<partyID> partyIdentifier </partyID> [0..1]
<reference> token35 </reference> [0..*] ?
<attentionText> token70 </attentionText> [0..1] ?
<taxId> token256 </taxId> [0..1] ?
<agentStatus> string3 </agentStatus> [0..1]
<certificate> partyCertificateType </certificate> [0..99]
<debtorNumberPD> nmtoken18 </debtorNumberPD> [0..1] ?
<role> supplyChainActorRoleType </role> [0..1]
</...>
Schema Component Representation
<xs:complexType name="supplyChainActorType">
<xs:complexContent>
<xs:extension base="partiesType">
<xs:sequence>
<xs:element name="role" type="supplyChainActorRoleType" minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: transitCustomsOfficeType

Super-types: nmtoken8 < customsOffice (by restriction) < transitCustomsOfficeType (by extension)
Sub-types: None
Name transitCustomsOfficeType
Abstract no
XML Instance Representation
<...
arrivalDateAndTimeEstimated="xs:dateTime [0..1]">
customsOffice
</...>
Schema Component Representation
<xs:complexType name="transitCustomsOfficeType">
<xs:simpleContent>
<xs:extension base="customsOffice">
<xs:attribute name="arrivalDateAndTimeEstimated" type="xs:dateTime"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
top

Complex Type: weightType

Super-types: non-negative-decimal < weightType (by extension)
Sub-types: None
Name weightType
Abstract no
XML Instance Representation
<...
weightUnit="weightUnitType [1]">
non-negative-decimal
</...>
Schema Component Representation
<xs:complexType name="weightType">
<xs:simpleContent>
<xs:extension base="non-negative-decimal">
<xs:attribute name="weightUnit" type="weightUnitType" use="required"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
top

Simple Type: RegNo21Type

Super-types: xs:string < RegNo21Type (by restriction)
Sub-types: None
Name RegNo21Type
Content
  • Base XSD Type: string
  • length >= 21
Documentation used for all MRN Numbers from ATLAS.
Schema Component Representation
<xs:simpleType name="RegNo21Type">
<xs:restriction base="xs:string">
<xs:minLength value="21"/>
<xs:maxLength value="21"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: certTypeType

Super-types: token35 < certTypeType (by restriction)
Sub-types: None
Name certTypeType
Content
  • 'token35' super type was not found in this schema. Its facets could not be printed out.
  • value comes from list: {'AEO'|'KnownConsignor'|'KnownConsignee'|'KnownExporter'|'TrustedExporter'|'BWH-A'|'BWH-D'|'BWH-E'|'A9'|'S9'|'VV-ON'|'VV-FN'|'Custodian'|'CCL-EX'|'CCL-PV'|'SDE-EX'|'SDE-PV'|'OPO-PV'|'SpecialSeals'|'ReducedDataset'}
Documentation Certificate Types: BWH-A - Bonded Warehouse Type A (ATLAS) BWH-D - Bonded Warehouse Type E (ATLAS) BWH-E - Bonded Warehouse Type E (ATLAS) A9 - Simplified Stocking into BWH (ATLAS) S9 - Simplified Declaration into BWH (ATLAS) VV-ON - Simplified Import, own account (ATLAS) VV-FN - Simplified Import, foreign account (ATLAS) CCL-EX -> Centralized Clearance Export (ATLAS) CCL-PV -> Centralized Clearance Outward Processing (ATLAS) SDE-EX -> Simplified Procedure Export (ATLAS) SDE-PV -> Simplified Procedure Outward Processing (ATLAS) OPO-PV -> Outward Processing (ATLAS)
Schema Component Representation
<xs:simpleType name="certTypeType">
<xs:restriction base="token35">
<xs:enumeration value="AEO"/>
<xs:enumeration value="KnownConsignor"/>
<xs:enumeration value="KnownConsignee"/>
<xs:enumeration value="KnownExporter"/>
<xs:enumeration value="TrustedExporter"/>
<xs:enumeration value="BWH-A"/>
<xs:enumeration value="BWH-D"/>
<xs:enumeration value="BWH-E"/>
<xs:enumeration value="A9"/>
<xs:enumeration value="S9"/>
<xs:enumeration value="VV-ON"/>
<xs:enumeration value="VV-FN"/>
<xs:enumeration value="Custodian"/>
<xs:enumeration value="CCL-EX"/>
<xs:enumeration value="CCL-PV"/>
<xs:enumeration value="SDE-EX"/>
<xs:enumeration value="SDE-PV"/>
<xs:enumeration value="OPO-PV"/>
<xs:enumeration value="SpecialSeals"/>
<xs:enumeration value="ReducedDataset"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: containerNoType

Super-types: token17 < containerNoType (by restriction)
Sub-types: None
Name containerNoType
Content
  • 'token17' super type was not found in this schema. Its facets could not be printed out.
Schema Component Representation
<xs:simpleType name="containerNoType">
<xs:restriction base="token17"/>
</xs:simpleType>
top

Simple Type: customsKindOfDocType

Super-types: token20 < customsKindOfDocType (by restriction)
Sub-types: None
Name customsKindOfDocType
Content
  • 'token20' super type was not found in this schema. Its facets could not be printed out.
  • value comes from list: {'CertificateOfOrigin'}
Schema Component Representation
<xs:simpleType name="customsKindOfDocType">
<xs:restriction base="token20">
<xs:enumeration value="CertificateOfOrigin"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: customsOffice

Super-types: nmtoken8 < customsOffice (by restriction)
Sub-types:
Name customsOffice
Content
  • 'nmtoken8' super type was not found in this schema. Its facets could not be printed out.
  • pattern = [A-Z][A-Z][A-Z0-9]{6}
  • length >= 8
Schema Component Representation
<xs:simpleType name="customsOffice">
<xs:restriction base="nmtoken8">
<xs:minLength value="8"/>
<xs:maxLength value="8"/>
<xs:pattern value="[A-Z][A-Z][A-Z0-9]{6}"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: dateAndOptionalTimeType

Super-types: None
Sub-types: None
Name dateAndOptionalTimeType
Content
  • Union of following types:
    • xs:date
    • xs:dateTime
Schema Component Representation
<xs:simpleType name="dateAndOptionalTimeType">
<xs:union memberTypes="xs:date xs:dateTime"/>
</xs:simpleType>
top

Simple Type: defermentAccountPrefix

Super-types: token2 < defermentAccountPrefix (by restriction)
Sub-types: None
Name defermentAccountPrefix
Content
  • 'token2' super type was not found in this schema. Its facets could not be printed out.
  • length >= 1
Documentation German Customs uses the Prefix to identify the authority where the account is managed. The code follows German license plates and may have the following values: B/C/CB/D/EF/F/FR/H/HB/HH/HR/K/KA/KI/KO/M/MD/MS/N/S/SB
Schema Component Representation
<xs:simpleType name="defermentAccountPrefix">
<xs:restriction base="token2">
<xs:minLength value="1"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: eoriBranchIdType

Super-types: xs:string < eoriBranchIdType (by restriction)
Sub-types: None
Name eoriBranchIdType
Content
  • Base XSD Type: string
  • pattern = [0-9]{4}
Schema Component Representation
<xs:simpleType name="eoriBranchIdType">
<xs:restriction base="xs:string">
<xs:pattern value="[0-9]{4}"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: eoriNumberType

Super-types: token17 < eoriNumberType (by restriction)
Sub-types: None
Name eoriNumberType
Content
  • 'token17' super type was not found in this schema. Its facets could not be printed out.
  • pattern = [A-Z]{2}[A-Z0-9\- ]{1,15}
Schema Component Representation
<xs:simpleType name="eoriNumberType">
<xs:restriction base="token17">
<xs:pattern value="[A-Z]{2}[A-Z0-9\- ]{1,15}"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: incotermKeyType

Super-types: xs:string < incotermKeyType (by restriction)
Sub-types: None
Name incotermKeyType
Content
  • Base XSD Type: string
  • value comes from list: {'1'|'3'}
Schema Component Representation
<xs:simpleType name="incotermKeyType">
<xs:restriction base="xs:string">
<xs:enumeration value="1"/>
<xs:enumeration value="3"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: lrnOwnerKindType

Super-types: nmtoken15 < lrnOwnerKindType (by restriction)
Sub-types: None
Name lrnOwnerKindType
Content
  • 'nmtoken15' super type was not found in this schema. Its facets could not be printed out.
  • value comes from list: {'DECLARANT'|'REPRESENTATIVE'}
Schema Component Representation
<xs:simpleType name="lrnOwnerKindType">
<xs:restriction base="nmtoken15">
<xs:enumeration value="DECLARANT"/>
<xs:enumeration value="REPRESENTATIVE"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: meansOfTransportIdentificationType

Super-types: nmtoken35 < meansOfTransportIdentificationType (by restriction)
Sub-types: None
Name meansOfTransportIdentificationType
Content
  • 'nmtoken35' super type was not found in this schema. Its facets could not be printed out.
  • value comes from list: {'IMOShipIdNo'|'SeaVesselName'|'WagonNo'|'TrainNo'|'RoadVehicleID'|'RoadTrailerID'|'IATAFlightNo'|'AircraftRegistrationID'|'VesselENICode'|'InlandWaterwaysVesselName'|'Unknown'}
Documentation Codes for the type of identification. The identification now does no longer require the type, but directly the ID - which includes the type. We do not use the numeric values of the codelist, as it might differ in different countries. Instead we use descriptors and translate them if needed.
Schema Component Representation
<xs:simpleType name="meansOfTransportIdentificationType">
<xs:restriction base="nmtoken35">
<xs:enumeration value="IMOShipIdNo"/>
<xs:enumeration value="SeaVesselName"/>
<xs:enumeration value="WagonNo"/>
<xs:enumeration value="TrainNo"/>
<xs:enumeration value="RoadVehicleID"/>
<xs:enumeration value="RoadTrailerID"/>
<xs:enumeration value="IATAFlightNo"/>
<xs:enumeration value="AircraftRegistrationID"/>
<xs:enumeration value="VesselENICode"/>
<xs:enumeration value="InlandWaterwaysVesselName"/>
<xs:enumeration value="Unknown"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: meansOfTransportKindType

Super-types: xs:string < meansOfTransportKindType (by restriction)
Sub-types: None
Name meansOfTransportKindType
Content
  • Base XSD Type: string
  • value comes from list: {'SeaShip'|'RailWagon'|'Car'|'CarWithTrailer'|'Truck'|'TruckWithTrailer'|'Semitrailer'|'Aircraft'|'Barge'|'SelfMoving'|'FixInstalled'|'Other'}
Documentation The Means Of Transport defines the real "device" on which the goods are transported (not to be mixed up with the "Transport Mode"). We do not use the numeric values of the codelist, as it might differ in different countries. Instead we use descriptors and translate them if needed.
Schema Component Representation
<xs:simpleType name="meansOfTransportKindType">
<xs:restriction base="xs:string">
<xs:enumeration value="SeaShip"/>
<xs:enumeration value="RailWagon"/>
<xs:enumeration value="Car"/>
<xs:enumeration value="CarWithTrailer"/>
<xs:enumeration value="Truck"/>
<xs:enumeration value="TruckWithTrailer"/>
<xs:enumeration value="Semitrailer"/>
<xs:enumeration value="Aircraft"/>
<xs:enumeration value="Barge"/>
<xs:enumeration value="SelfMoving"/>
<xs:enumeration value="FixInstalled"/>
<xs:enumeration value="Other"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: mrnType

Super-types: nmtoken18 < mrnType (by restriction)
Sub-types: None
Name mrnType
Content
  • 'nmtoken18' super type was not found in this schema. Its facets could not be printed out.
Documentation used for all MRN Numbers.
Schema Component Representation
<xs:simpleType name="mrnType">
<xs:restriction base="nmtoken18"/>
</xs:simpleType>
top

Simple Type: organizationCodeType

Super-types: nmtoken35 < organizationCodeType (by restriction)
Sub-types: None
Name organizationCodeType
Content
  • 'nmtoken35' super type was not found in this schema. Its facets could not be printed out.
  • pattern = [A-Z]{3}
Schema Component Representation
<xs:simpleType name="organizationCodeType">
<xs:restriction base="nmtoken35">
<xs:pattern value="[A-Z]{3}"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: procedureType

Super-types: xs:string < procedureType (by restriction)
Sub-types: None
Name procedureType
Content
  • Base XSD Type: string
  • value comes from list: {'ICSDeclaration'|'SmartTemporaryStorage'|'TemporaryStorage'|'Import'|'Export'|'transitOpen'|'transitArrival'|'warehouseTakeIn'|'warehouseTakeOut'|'inwardProcessing'|'clientPD'|'clientVWA'|'IPR'|'OPR'|'SupplementaryDeclaration'|'PLACI'}
Schema Component Representation
<xs:simpleType name="procedureType">
<xs:restriction base="xs:string">
<xs:enumeration value="ICSDeclaration"/>
<xs:enumeration value="SmartTemporaryStorage"/>
<xs:enumeration value="TemporaryStorage"/>
<xs:enumeration value="Import"/>
<xs:enumeration value="Export"/>
<xs:enumeration value="transitOpen"/>
<xs:enumeration value="transitArrival"/>
<xs:enumeration value="warehouseTakeIn"/>
<xs:enumeration value="warehouseTakeOut"/>
<xs:enumeration value="inwardProcessing"/>
<xs:enumeration value="clientPD"/>
<xs:enumeration value="clientVWA"/>
<xs:enumeration value="IPR"/>
<xs:enumeration value="OPR"/>
<xs:enumeration value="SupplementaryDeclaration"/>
<xs:enumeration value="PLACI"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: sealType

Super-types: xs:string < sealType (by restriction)
Sub-types: None
Name sealType
Content
  • Base XSD Type: string
  • value comes from list: {'P'|'R'}
Documentation Type of Seal, coded: "P": Package Seal "R": Room seal (when the vehicle doors are sealed)
Schema Component Representation
<xs:simpleType name="sealType">
<xs:restriction base="xs:string">
<xs:enumeration value="P"/>
<xs:enumeration value="R"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: supplyChainActorRoleType

Super-types: nmtoken2 < supplyChainActorRoleType (by restriction)
Sub-types: None
Name supplyChainActorRoleType
Content
  • 'nmtoken2' super type was not found in this schema. Its facets could not be printed out.
  • value comes from list: {'CS'|'FW'|'MF'|'WH'}
Schema Component Representation
<xs:simpleType name="supplyChainActorRoleType">
<xs:restriction base="nmtoken2">
<xs:enumeration value="CS"/>
<xs:enumeration value="FW"/>
<xs:enumeration value="MF"/>
<xs:enumeration value="WH"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: typeOfPersonType

Super-types: token22 < typeOfPersonType (by restriction)
Sub-types: None
Name typeOfPersonType
Content
  • 'token22' super type was not found in this schema. Its facets could not be printed out.
  • value comes from list: {'NATURAL_PERSON'|'LEGAL_PERSON'|'ASSOCIATION_OF_PERSONS'}
Schema Component Representation
<xs:simpleType name="typeOfPersonType">
<xs:restriction base="token22">
<xs:enumeration value="NATURAL_PERSON"/>
<xs:enumeration value="LEGAL_PERSON"/>
<xs:enumeration value="ASSOCIATION_OF_PERSONS"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: versionType

Super-types: nmtoken4 < versionType (by restriction)
Sub-types: None
Name versionType
Content
  • 'nmtoken4' super type was not found in this schema. Its facets could not be printed out.
  • pattern = 5\.\d*
Schema Component Representation
<xs:simpleType name="versionType">
<xs:restriction base="nmtoken4">
<xs:pattern value="5\.\d*"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: weightUnitType

Super-types: xs:string < weightUnitType (by restriction)
Sub-types: None
Name weightUnitType
Content
  • Base XSD Type: string
  • value comes from list: {'KGM'|'TON'|'LBS'}
Schema Component Representation
<xs:simpleType name="weightUnitType">
<xs:restriction base="xs:string">
<xs:enumeration value="KGM"/>
<xs:enumeration value="TON"/>
<xs:enumeration value="LBS"/>
</xs:restriction>
</xs:simpleType>
top

Legend

Complex Type:

Schema Component Type

AusAddress

Schema Component Name
Super-types: Address < AusAddress (by extension)
Sub-types:
  • QLDAddress (by restriction)
If this schema component is a type definition, its type hierarchy is shown in a gray-bordered box.
Name AusAddress
Abstract no
The table above displays the properties of this schema component.
XML Instance Representation
<... country="Australia">
<unitNo> string </unitNo> [0..1]
<houseNo> string </houseNo> [1]
<street> string </street> [1]
Start Choice[1]
<city> string </city> [1]
<town> string </town> [1]
End Choice
<state> AusStates </state> [1]
<postcode> string <<pattern = [1-9][0-9]{3}>> </postcode> [1]?
</...>

The XML Instance Representation table above shows the schema component's content as an XML instance.

Schema Component Representation
<complexTypename="AusAddress">
<complexContent>
<extensionbase="Address">
<sequence>
<elementname="state" type="AusStates"/>
<elementname="postcode">
<simpleType>
<restrictionbase="string">
<patternvalue="[1-9][0-9]{3}"/>
</restriction>
</simpleType>
</element>
</sequence>
<attributename="country" type="string" fixed="Australia"/>
</extension>
</complexContent>
</complexType>
The Schema Component Representation table above displays the underlying XML representation of the schema component. (Annotations are not shown.)
top

Glossary

Abstract (Applies to complex type definitions and element declarations). An abstract element or complex type cannot used to validate an element instance. If there is a reference to an abstract element, only element declarations that can substitute the abstract element can be used to validate the instance. For references to abstract type definitions, only derived types can be used.

All Model Group Child elements can be provided in any order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-all.

Choice Model Group Only one from the list of child elements and model groups can be provided in instances. See: http://www.w3.org/TR/xmlschema-1/#element-choice.

Collapse Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32). Then, collapse contiguous sequences of space characters into single space character, and remove leading and trailing space characters.

Disallowed Substitutions (Applies to element declarations). If substitution is specified, then substitution group members cannot be used in place of the given element declaration to validate element instances. If derivation methods, e.g. extension, restriction, are specified, then the given element declaration will not validate element instances that have types derived from the element declaration's type using the specified derivation methods. Normally, element instances can override their declaration's type by specifying an xsi:type attribute.

Key Constraint Like Uniqueness Constraint, but additionally requires that the specified value(s) must be provided. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Key Reference Constraint Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Model Group Groups together element content, specifying the order in which the element content can occur and the number of times the group of element content may be repeated. See: http://www.w3.org/TR/xmlschema-1/#Model_Groups.

Nillable (Applies to element declarations). If an element declaration is nillable, instances can use the xsi:nil attribute. The xsi:nil attribute is the boolean attribute, nil, from the http://www.w3.org/2001/XMLSchema-instance namespace. If an element instance has an xsi:nil attribute set to true, it can be left empty, even though its element declaration may have required content.

Notation A notation is used to identify the format of a piece of data. Values of elements and attributes that are of type, NOTATION, must come from the names of declared notations. See: http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations.

Preserve Whitespace Policy Preserve whitespaces exactly as they appear in instances.

Prohibited Derivations (Applies to type definitions). Derivation methods that cannot be used to create sub-types from a given type definition.

Prohibited Substitutions (Applies to complex type definitions). Prevents sub-types that have been derived using the specified derivation methods from validating element instances in place of the given type definition.

Replace Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32).

Sequence Model Group Child elements and model groups must be provided in the specified order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-sequence.

Substitution Group Elements that are members of a substitution group can be used wherever the head element of the substitution group is referenced.

Substitution Group Exclusions (Applies to element declarations). Prohibits element declarations from nominating themselves as being able to substitute a given element declaration, if they have types that are derived from the original element's type using the specified derivation methods.

Target Namespace The target namespace identifies the namespace that components in this schema belongs to. If no target namespace is provided, then the schema components do not belong to any namespace.

Uniqueness Constraint Ensures uniqueness of an element/attribute value, or a combination of values, within a specified scope. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

top