29
DES209: DATA ELEMENT DEFINITIONS CROWN COPYRIGHT Filename: DES209_3 0.doc Page 1 of 29 Version: 3.0 DES209: Data Element Definitions Abstract This document is part of the Technical Interface Specification (TIS) for Direct Trader Input (DTI) to CHIEF and for Inventory systems. It defines the data elements used in the trade interface messages as specified in the related TIS documents. Origin/Author : John Walker Approved by : Glen Robe Date Approved : 22/10/2014 Status : Approved Prepared by: Capgemini UK PLC 1 Forge End Woking GU21 6DB Phone +44 (0)1483 786734

DES209: Data Element Definitions - gov.uk · DES209: DATA ELEMENT DEFINITIONS CROWN COPYRIGHT Filename: DES209_3 0.doc Page 7 of 29 Version: 3.0 Data Element Name SAD Format Notes

  • Upload
    others

  • View
    0

  • Download
    0

Embed Size (px)

Citation preview

Page 1: DES209: Data Element Definitions - gov.uk · DES209: DATA ELEMENT DEFINITIONS CROWN COPYRIGHT Filename: DES209_3 0.doc Page 7 of 29 Version: 3.0 Data Element Name SAD Format Notes

DES209: DATA ELEMENT DEFINITIONS

CROWN COPYRIGHT Filename: DES209_3 0.doc Page 1 of 29 Version: 3.0

DES209: Data Element Definitions

Abstract

This document is part of the Technical Interface Specification (TIS) for Direct Trader Input (DTI) to CHIEF and for Inventory systems. It defines the data elements used in the trade interface messages as specified in the related TIS documents.

Origin/Author : John Walker

Approved by : Glen Robe

Date Approved : 22/10/2014

Status : Approved

Prepared by:

Capgemini UK PLC

1 Forge End

Woking

GU21 6DB

Phone +44 (0)1483 786734

Page 2: DES209: Data Element Definitions - gov.uk · DES209: DATA ELEMENT DEFINITIONS CROWN COPYRIGHT Filename: DES209_3 0.doc Page 7 of 29 Version: 3.0 Data Element Name SAD Format Notes

DES209: DATA ELEMENT DEFINITIONS

CROWN COPYRIGHT Filename: DES209_3 0.doc Page 2 of 29 Version: 3.0

Contents

1. Introduction ..................................................................................................... 3

2. Data Elements ................................................................................................. 4

3. Glossary and References ............................................................................. 24

3.1 Glossary ................................................................................................................... 24

3.2 References ............................................................................................................... 24

Appendix A Declaration UCR/Part Check Letter Algorithm ............................... 26

Appendix B: Document Control ........................................................................ 28

Page 3: DES209: Data Element Definitions - gov.uk · DES209: DATA ELEMENT DEFINITIONS CROWN COPYRIGHT Filename: DES209_3 0.doc Page 7 of 29 Version: 3.0 Data Element Name SAD Format Notes

DES209: DATA ELEMENT DEFINITIONS

CROWN COPYRIGHT Filename: DES209_3 0.doc Page 3 of 29 Version: 3.0

1. Introduction

This document is part of the Technical Interface Specification (TIS) for Direct Trader Input (DTI) to CHIEF and for Inventory systems. It defines the data elements used in the trade interface messages as specified in the related TIS documents, namely:

The EDI Specification (see Reference [1]) which describes the approach to EDI adopted by CHIEF, in particular the interactive use of EDIFACT within a session. The document includes the definition of EDIFACT segments, data elements and code lists. It also defines the messages used to report errors and to acknowledge receipt of a message (i.e. CUSRES, CONTRL and UKCTRL).

Imports (see Reference [2]) which gives an overview of Imports and defines the various declaration messages and the response messages;

Exports (see Reference [3]) which gives an overview of Exports and defines the various declaration messages and the response messages;

Consignment and Movement Control (see Reference [4]) which details the interface for consolidating consignments (exports only) and for the inventory interface for controlling movements;

Requests and Reports (see Reference [5]) which defines reports and common facilities that apply to both import and export entries.

END OF SECTION 1

Page 4: DES209: Data Element Definitions - gov.uk · DES209: DATA ELEMENT DEFINITIONS CROWN COPYRIGHT Filename: DES209_3 0.doc Page 7 of 29 Version: 3.0 Data Element Name SAD Format Notes

DES209: DATA ELEMENT DEFINITIONS

CROWN COPYRIGHT Filename: DES209_3 0.doc Page 4 of 29 Version: 3.0

2. Data Elements

The table below defines (in alphabetical order) all the data elements that are used in the trade interface to CHIEF.

The declared elements are related to a SAD box, the rules for whose completion are given in Tariff Volume 3 (see Reference [7]). The descriptions and values in the table should be treated as an aide-memoir rather than definitive. It should be noted that all declared numbers are positive.

The format of the data elements is specified as:

<character set> <length> <decimal format> <repetition>

where:

<character set> A upper case alpha

AN upper case alpha and digits

N digits

n number (integer unless decimal format given)

s space character

t(n) specific text formats representing different ranges of allowable character sets. ‘n’ indicates the text format number, which can be 1 – 6. The text formats and their allowable character sets are shown below.

<length> length of the data item optionally preceded by “..” if the length is variable.

For a numeric element (‘n’) the length excludes any sign (note all declared values are positive so a sign is never required) and decimal point. There shall be at least one digit before and after a decimal point. Insignificant leading zeroes shall be suppressed.

For a character element (‘A’, ‘AN’, ‘N’, ‘t’) trailing spaces shall be suppressed and a data element consisting only of spaces is not allowed. Leading spaces are allowed but for some data elements they may be removed by CHIEF.

<decimal format> (Sn.p) where S indicates that the number can be negative (i.e. may be prefixed with a minus sign), n is maximum number of digits before the decimal point and p the maximum number after. Trailing zeroes following the decimal point and the decimal point need not be sent to CHIEF but are generated by CHIEF except when the maximum length of the element would be exceeded. In this case (see exchange rates) the decimal places are truncated to the maximum length.

<repetition> {n – m} where n is the minimum number of occurrences when the data element is specified and m is the maximum. The branching diagrams show segment occurrences and the message definitions show repeated data elements within a segment (e.g. lines of text in FTX).

Text Format 1: EDIFACT Level B character set. This consists of upper and lower case alphas, numeric digits, spaces and certain special characters.

Page 5: DES209: Data Element Definitions - gov.uk · DES209: DATA ELEMENT DEFINITIONS CROWN COPYRIGHT Filename: DES209_3 0.doc Page 7 of 29 Version: 3.0 Data Element Name SAD Format Notes

DES209: DATA ELEMENT DEFINITIONS

CROWN COPYRIGHT Filename: DES209_3 0.doc Page 5 of 29 Version: 3.0

A - Z, a - z, 0 – 9, space, full-stop, comma, hyphen, (, ), /, ', +, colon, =, ?, !, ", %, &, *, semi-colon, < and >.

Text Format 2: Character string of upper case alphas, numeric digits and spaces.

A - Z, 0 - 9 and space

Text Format 3: Character string of upper case alphas and spaces.

A - Z and space

Text Format 4: (Full) 96 character set. This consists of upper and lower case alphas, numeric digits, spaces and special characters.

A - Z, a - z, 0 - 9, space, full-stop, comma, hyphen, (, ), /, ', +, colon, =, ?, !, ", %, &, *, semi-colon, <, >, £, $, @, \, ^, _, {, }, [, ], ~, |, ¬, and `

Text Format 5: Character string of upper case alphas, numeric digits, hyphen and spaces.

A - Z, 0 - 9, hyphen and space

Text Format 6: Character string of upper case alphas, numeric digits, spaces and certain special characters.

A - Z, 0 - 9, space, full-stop, comma, hyphen, (, ), /, ', +, colon, =, ?, !, ", %, &, *, semi-colon, < and >

.Note that where ‘space’ is referred to in these text formats, it means embedded space character(s). Generally, leading and trailing spaces are allowed in fields unless the field is required to be filled by the User.

Note also that in several of the above character sets and text formats where lower case alphas are not listed as part of the character set, (e.g. ‘AN’ or ‘Text Format 6’), they are still accepted by CHIEF on input, but converted and stored by CHIEF as their upper case alpha equivalent.

Certain data elements have very individual permitted character sets For fields intended to contain a Unique Consignment Reference (UCR), the character set consists of upper case alphas, numeric digits plus characters ‘hyphen’, ‘/’, ‘colon’, ‘(‘ and ‘)’. Further CHIEF validation subsequently reduces the permitted character set to upper case alphas, numeric digits plus characters ‘hyphen‘, ‘(‘ and ‘)’ for Declaration UCRs. Note that lower case alphas are not accepted and converted to upper case. Additional validation rules to support the formats defined in the Tariff for both Master UCRs and Declaration UCRs restrict the use of specific characters to certain character positions within the field. The intention of this validation is to enforce the official data formats for Declaration and Master UCRs. Further details of these formats can be found in the Notes field for Data Elements ‘DECLN-UCR’ and ‘MASTER-UCR’ and in Reference [6].

Page 6: DES209: Data Element Definitions - gov.uk · DES209: DATA ELEMENT DEFINITIONS CROWN COPYRIGHT Filename: DES209_3 0.doc Page 7 of 29 Version: 3.0 Data Element Name SAD Format Notes

DES209: DATA ELEMENT DEFINITIONS

CROWN COPYRIGHT Filename: DES209_3 0.doc Page 6 of 29 Version: 3.0

Data Element Name SAD Format Notes

BOX

ACPTNC-DTM N12 The date-time (CCYYMMDDHHMM) of legal acceptance of an Entry. This element is used to declare the tax point on a Supplementary Declaration.

ACPTNC-EPS-ID A1 See ACPTNC-EPU-NO.

ACPTNC-EPU-NO N3 This field together with ACPTNC-EPS-ID identifies the Office of Import/Export or the intended office if the entry is still pre-lodged.

ACTION-CODE AN..3 Identifies the action taken with the message to which the CONTRL/UKCTRL applies. 1 Acknowledged – the message has been fully accepted and actioned. 3 The message has been partially accepted and actioned. 4 Rejected – the message has been fully rejected.

Note, CONTRL is currently only used to fully reject a CUSDEC for low level reasons. UKCTRL is still used as the response for reports and inventory messages.

ADD-ITEM-NO N..3 The sequence number of an added item within an Entry. Harmonised SAD declarations will not initially support more than 99 items. The definition of the element is changed so there will be no trade impact should the number be increased in the future.

AGENT-LOCN AN..12 The location specified in the start session parameters (see Reference [1]) for the client session in which the agent submitted the declaration. This is returned, along with the AGENT-ROLE, on a report for use by a CSP system in routeing the output to the required destination.

NB. For a CIE Entry this will contain the Customs Location of the session that inserted the Entry.

AGENT-ROLE AN..12 The role specified in the start session parameters (see Reference [1]) for the client session in which the agent submitted the declaration. This is returned, along with AGENT-LOCN, with any report associated with the Entry for use by a CSP system in routeing the output to the required destination.

NB. For a CIE Entry this will contain the Customs Role of the session that inserted the Entry.

As an Export Entry moves between locations it may be necessary for an authorised trader to supply movement details. The authorised trader who notifies arrival (at a non-inventory linked location) becomes the agent for the movement. The Inventory system interface enables an agent to be identified for a movement. The agent can display movement details and key elements of the declaration.

AMD-HDR-LABEL t(1)..35 Identifies the Header level data item being reported as having been amended – based on the SAD box title.

AMD-ITEM-LABEL t(1)..35 Identifies the Item level data item being reported as having been amended – based on the SAD box title.

ARR-MASTER-UCR See MASTER-UCR

The Master UCR by which a movement was arrived.

ATRPT-COST 62 n..12 (10.2) Air transport cost in the response currency (see RESPONSE-CRRN and REPORT-TYPE).

ATRPT-COST-AC 62 n..12 (10.2) Air transport cost as declared in the currency specified in FRGT-CHGE-CRRN.

BASE-CMDTY-CODE 33 N..8 or A3 Commodity code as declared for Exports. For an EXS only the first 4 digits need be declared. When deleting an item using the value “DEL”, the CPC item must also be specified and will be validated but otherwise ignored.

CARRIER-NAME t(1)..35 Name of carrier at the border.

CMDTY-CODE 33 N8 or A3 Commodity code as declared for Exports.

When deleting an item using the value “DEL”, the CPC item must also be specified and will be validated but otherwise ignored.

CMGP-CODE AN5 Commodity group code.

CNSGE-CITY 8 t(1)..35 Consignee’s address – city.

CNSGE-CNTRY 8 A2 Consignee’s address – country.

CNSGE-LNG 8 A2 Language in which the consignee’s name and address is written.

CNSGE-NAME 8 t(1)..35 Consignee’s name. For Imports. Required along with address elements unless a GB specific trader TURN is given in CNSGE-TID. On reports. This is the abbreviated name defined on CHIEF for a known trader (i.e. a GB CNSGE-TID except PR), or the name as declared for other traders, or “Other – 00200” if consignees are declared at item level.

CNSGE-POSTCODE 8 t(6)..9 Consignee’s address – postcode.

CNSGE-STREET 8 t(1)..35 Consignee’s address – street.

CNSGE-TID 8 AN..17 Consignee TID (see DECLT-TID). For bulk declarations the consignee is declared for each item (see I-CNSGE-TID). For Imports. When “GBPR” or not a GB trader id, name and address must be supplied. “GB888888811005” is declared for bulk when details of the individual consignees do not have to be supplied.

Page 7: DES209: Data Element Definitions - gov.uk · DES209: DATA ELEMENT DEFINITIONS CROWN COPYRIGHT Filename: DES209_3 0.doc Page 7 of 29 Version: 3.0 Data Element Name SAD Format Notes

DES209: DATA ELEMENT DEFINITIONS

CROWN COPYRIGHT Filename: DES209_3 0.doc Page 7 of 29 Version: 3.0

Data Element Name SAD Format Notes BOX

CNSGR-CITY 2 t(1)..35 Consignor’s address – city.

CNSGR-CNTRY 2 A2 Consignor’s address – country.

CNSGR-LNG 2 A2 Language in which the consignor’s name and address is written.

CNSGR-NAME 2 t(1)..35 Consignor’s name. For Exports. Required along with address elements unless a GB specific trader TURN is given in CNSGR-TID. Also required regardless of TID for a CAP Export refund claim. On reports. This is the abbreviated name defined on CHIEF for a known trader (i.e. a GB CNSGR-TID except GBPR and GBUNREG), or the name as declared for other traders, or “Other – 00200” if consignors are declared at item level.

CNSGR-POSTCODE 2 t(6)..9 Consignor’s address – postcode.

CNSGR-STREET 2 t(1)..35 Consignor’s address – street.

CNSGR-TID 2 AN..17 Consignor TID (see DECLT-TID). For bulk declarations the consignor is declared for each item (see I-CNSGR-TID). For Exports. When “GBPR”, “GBUNREG” or not a GB trader id, name and address must be supplied. “GB888888811005” is declared for bulk when details of the individual consignors do not have to be supplied (e.g. FPO MOU).

CNTR-NO 31 t(1)..17 Container numbers are declared for each item.

COMPONENT-NO N..3 The number of the component data element in the compound data element identified by ELEMENT-NO. The first component is number one.

CPC 37 AN7 The harmonised Customs Procedure code.

CRC N3 The result of processing an Inventory message by the CHIEF system.

For Imports: 000 = Success; 001 = Reprocessing Error/Failure; 002 = CIE Entry – arrival ignored; 003 = Entry Status is Errored; 004 = Entry being Updated; 005 = Entry already Finalised; 006 = Entry already Arrived; 007 = Historic version quoted.

For Exports result of processing an (anticipated) arrival: 000 = Success; 101 = Anticipated arrival noted, awaiting declaration(s); 102 = Arrival noted, awaiting valid declaration(s); 201 = Too many exceptions for a single EMR message (the MASTER-SOE and

MASTER-ROE returned are for the whole consolidation but the request should be repeated later for individual consignment details when more consignments in the consolidation may be permitted to progress);

202 = All consignments in Master UCR arrived but route and status details lost – please repeat the request a few times before calling the Helpdesk;

203 = Probable route details for Master UCR lost – please repeat the request a few times before calling the Helpdesk;

204 = Too many arrivals for one or more declarations in a consolidation of more than one declaration. The limits on the number of anticipated and actual arrivals are defined as system parameters (expected to be set to 500). The limit exists to detect faults in trade software. Since the master arrival has been accepted before the condition is detected during the background processing of the arrival, a CRC is returned with the declarations for which the limit is exceeded identified in the EMR by SOE “E” (ROE “0”). Note: the arrival notification is rejected if the arrival limit is exceeded for the UCR/part (master or declaration) being arrived.

CSTUN-NM t(1)..30 Name of a Customs Unit.

CUR-MASTER-UCR See MASTER-UCR

The current immediately superior Master UCR for a consignment at declaration or master level.

CURR-BASE-AMT 47b n..12 (10.2) The current tax base amount. See ITLN-BASE-AMT-DC.

CURR-BASE-QTY 47b n..12 (10.2) The current tax base quantity. See ITLN-BASE-QTY.

CURR-ENT-TOT-REV n..12 (10.2) The current accumulated revenue at Entry level for a MOP/TAX combination.

CURR-MOP-CODE 47e A1 The current method by which the revenue is to be paid or secured.

CURR-REV-AMT n..12 (10.2) The current amount of revenue due for a Tax Line on an Entry, either declared or calculated. The amount is zero when payment is waived.

CURR-TAX-RATE-ID 47c A..3 Specifies the current rate at which the revenue has been calculated.

CURR-TTY-CODE 47a AN3 Identifies the current category of revenue being declared.

CURR-TTY-OVR-CD 47c A3 Specifies a code identifying a current exception to the normal calculation of the associated revenue.

DAN N7 The (deferment approval) number of the deferment account. This data item is used when the DAN can have been declared as FIR-DAN or SCND-DAN.

Page 8: DES209: Data Element Definitions - gov.uk · DES209: DATA ELEMENT DEFINITIONS CROWN COPYRIGHT Filename: DES209_3 0.doc Page 7 of 29 Version: 3.0 Data Element Name SAD Format Notes

DES209: DATA ELEMENT DEFINITIONS

CROWN COPYRIGHT Filename: DES209_3 0.doc Page 8 of 29 Version: 3.0

Data Element Name SAD Format Notes BOX

DAN-PFX A1 Identifies whether the associated DAN identifies an account owned by the Declarant or the Consignee/Consignor and if a specific authority or the standing authority is to be used. This data item is used when the prefix can have been declared as FIR-DAN-PFX or SCND-DAN-PFX.

DAN-RAR AN1 A code identifying the reason for accounting rejection.

DAN-RAR-DESC t(1)..70 Text explanation of the ‘Reason for Accounting Rejection’ code used for information display purposes.

DATA-ERROR-CODE AN..3 Identifies an error in the associated element, segment or message. The values used by CHIEF are:

3 Message Identifier (S009 in UNH) not supported or not permitted to the client or end user.

4 Service segment missing/invalid. 5 Trailer count error (0074 in UNT). 6 Data segment missing/invalid. 8 Too many data elements. 9 Mandatory data element missing. 10 Data element attribute error. 51 Service closing. 52 Abort in server (failure in the application processing). 53 Transaction derived from the BGM message code is not supported. 54 Application has reported an error that does not specifically relate to any data in

the message. 55 Attempted security violation (e.g. transaction not permitted to role).

DATA-ERROR-TEXT t(1)..70 A descriptive text for the associated error.

DECLN-COUNT n..5 The number of Declaration movements associated with the anticipated or arrived Master movement. The count is returned in the EMR message(s) returned as a result of an (anticipated) arrival notification. The count is zero in other EMRs which are used to report changes to the Master ROE/SOE.

DECLN-CRRN 44h A3 Identifies the currency in which the declaration is made as either GBP (default) or EUR. In particular it is the currency in which ITEM-STAT-VAL-DC, ITLN-DECL-TAX-DC and ITLN-BASE-AMT-DC are declared. Other declared amounts have an associated currency code. The declared value is output on a SAD Copy 3 but otherwise responses and reports are in the UK Customs currency (i.e. GBP).

This element supports transition to euro but until then it only defines the currency in which the above amounts are declared. Should the euro be adopted it will also be the currency in which the declaration is to be handled during transition (see also REPORT-TYPE). It will be the currency in which calculated and converted amounts are output. Until then such amounts are in GBP and the exchange rate used for converting from EUR is output (see DECLN-EXCH).

DECLN-EXCH n..12 (6.8) The exchange rate used to convert amounts declared in the declaration currency (see DECLN-CRRN).

DECLN-MTHD A3 The Declaration Method: CIE – for a CIE Entry; DTI – for a DTI Entry.

For Imports, Inventory systems need to know the declaration method since the CSP is responsible for generating E0 and H3 reports for DTI entries.

DECLN-PART-NO 44h N..3A..1 This allows for many declarations covering the goods identified by the same UCR (see DECLN-UCR). The part number is up to 3 digits (N..3). The element may also contain a check letter (A1) covering the DECLN-UCR and any part number. The check letter algorithm is given in Annex A.

For Exports, where the goods are declared in parts, each part is explicitly identified by the DECLN-PART-NO when it is arrived or consolidated. See also MOVT-REF for identifying split movements.

There is no correspondence between the parts used in PSAs and those that may be used for the supplementary declarations. Thus, for example, supplementary declaration part 2 can cover parts 1 to 17 which departed from the same location on the same day.

Page 9: DES209: Data Element Definitions - gov.uk · DES209: DATA ELEMENT DEFINITIONS CROWN COPYRIGHT Filename: DES209_3 0.doc Page 7 of 29 Version: 3.0 Data Element Name SAD Format Notes

DES209: DATA ELEMENT DEFINITIONS

CROWN COPYRIGHT Filename: DES209_3 0.doc Page 9 of 29 Version: 3.0

Data Element Name SAD Format Notes BOX

DECLN-TYPE 1 A3 The first 2 characters are the type of declaration: “CO” – Special territory of the Community (Import or Export); “EU” – EFTA (Import or Export); “EX” – Export when not EU or COM; “IM” – Import when not EU or COM. Thus first 2 characters are as for current SAD (“COM” becomes “CO”). The third character identifies the entry type (Full Dec, SFD, PSA, Supp Dec) and whether the declaration is being pre-lodged or is for an arrived consignment (replacing GDS-ARR-DECLN). The current values do not clash with the new values (third character is space or “M”). For new SADs the third character must be valid for the MESSAGE-CODE. The values are: “A” – full declaration (IFD, IFW, EFD), arrived; “C” – non-transit simplified declaration (SFD, SDP PSA), arrived; “D” – full declaration (IFD, EFD), pre-lodged; “F” – non-transit simplified declaration (SFD, PSA), pre-lodged; “G” – (Transit) SFD, arrived; “H” – (Transit) SFD, pre-lodged; “J” – C21 (ICR, ECR), arrived; “K” – C21 (ICR, ECR), pre-lodged; “Y” – SDP supplementary declaration (including FSD); “Z” – LCP supplementary declaration. Only the first 2 characters are sent to ECS. Note, the underlying data item on CHIEF remains A..3 since it continues to be used for current SADs. Further values may be added to identify that the declaration includes pre-arrival/pre-departure security details.

DECLN-UCR 44h AN plus ‘-‘, ‘(‘ and ‘)’..35 (but see also Section 2).

This is a unique consignment reference for the goods covered by the declaration.

For ECS Safety and Security the DECLN-UCR satisfies the requirement for a transport document and should be output in Box 7 of the EAD.

The reference can be used to identify the Entry for amendment or cancellation. For Exports it can also be used for inventory linking.

The UCR may be generated by trade software or obtained from a trading partner. The value supplied on a declaration must conform to the structure specified in Tariff Volume 3 (see Reference [7]) which is currently:

yccx..x WCO recommendation for any country code other than GB. Further structure as agreed for that country.

yGBt..t-r..r WCO recommended structure extended for Declaration UCRs generated by UK traders.

yGBeee-mmdd-nnnnnnn

WCO recommended structure extended for Declaration UCRs based on the CHIEF Entry Reference.

Where:

y final digit of year when UCR generated; cc ISO country code; x..x reference as agreed for the country; t..t the first 9 characters or the full 12 characters of the TURN of either the

Consignor or the Declarant; r..r trader’s commercial reference; eee EPU number (EPU-NO); mmdd month and day from date of entry (DT-OF-ENT); nnnnnnn entry number and check character (ENT-NO); “GB”, “A”, “C”, “/”, “:” and “-” are literal values.

CHIEF rejects an initial Entry that has the same reference as an existing Entry unless it is a duplicate. This means the reference must be unique for at least the time that Entry information is held on CHIEF IES (up to 6 months). Ideally the reference should be unique for the audit period of 4 years. It is recommended that references be unique for 10 years (as for WCO recommendation).

CHIEF restricts the use of a UCR to Imports or Exports. The same UCR can be used for an Export from one country and an Import to another. There can be a number of part declarations (see DECLN-PART-NO) when the goods identified by the UCR are sent separately or where multiple supplementary declarations are required (see DECLN-PART-NO).

When a DECLN-UCR is not supplied one is generated by CHIEF from the Entry Reference allocated by CHIEF.

The MRN allocated to an Export entry can be sent in the DECLN-UCR element as an alternative way of identifying the entry (e.g. for amendment). See also UCR.

DECLT-CITY 14 t(1)..35 Declarant’s address – city.

Page 10: DES209: Data Element Definitions - gov.uk · DES209: DATA ELEMENT DEFINITIONS CROWN COPYRIGHT Filename: DES209_3 0.doc Page 7 of 29 Version: 3.0 Data Element Name SAD Format Notes

DES209: DATA ELEMENT DEFINITIONS

CROWN COPYRIGHT Filename: DES209_3 0.doc Page 10 of 29 Version: 3.0

Data Element Name SAD Format Notes BOX

DECLT-CNTRY 14 A2 Declarant’s address – country.

DECLT-LNG 14 A2 Language in which the declarant’s name and address is written.

DECLT-NAME 14 t(1)..35 Declarant’s name.

DECLT-POSTCODE 14 t(6)..9 Declarant’s address – postcode.

DECLT-REP 14 N1 Declares the way in which the declarant is representing the Importer/Exporter: “1” – Declarant; “2” – Direct representative; “3” – Indirect representative. If there is only one consignee/consignor and the consignee/consignor is the declarant the value is “1”.

Otherwise a declarant is declared with a value dependent on the type of representation authority given by the consignee/consignor or all the consignees/consignors for bulk. Note, the underlying data item on CHIEF is AN1 since it continues to be used for current SADs (values “D” and “I”).

DECLT-STREET 14 t(1)..35 Declarant’s address – street.

DECLT-TID 14 AN..17 The Trader Identifier (TID) of the declarant. The declarant defaults to the Importer (CNSGE-TID) or Exporter (CNSGR-TID). TIDs start with a country code. GB identifiers are the current TURN including PR and UNREG. Name and address elements are declared for GBPR, GBUNREG and other member state trader codes.

DEF-TOT n..12 (10.2) The sum of revenue from all Tax Lines on an Entry which have a Method of Payment classified as Deferred.

DEL-ITEM-NO N..3 The sequence number of a deleted item within an Entry. Harmonised SAD declarations will not initially support more than 99 items. The definition of the element is changed so there will be no trade impact should the number be increased in the future.

DEST-CNTRY 17a A2 The code for the country to which the goods are destined.

DISP-CNTRY 15a A2 The code for the country from which the goods were originally dispatched (or exported).

DISPLAY-AT-DTM N12 For a display request identifies the date and time (CCYYMMDDHHMM) at which details of the Entry are to be returned.

DT-OF-ENT N8 This element is used when the entry date is used as part of the Entry Reference generated by CHIEF. Otherwise ENT-DTM is used for the date-time of the entry.

EC-SUPPLEMENT 33 AN4 First additional Taric Subdivision.

EC-SUPPLEMENT-2 33 AN4 Second additional Taric Subdivision.

ELEMENT-NO N..3 The number of the simple or composite data element in the segment identified by SEG-NO – the segment tag is element one; a value of zero indicates the element is indeterminate.

ENT-DTM N12 The date and time (CCYYMMDDHHMM) of the Entry. For DTI, it identifies when the Entry was first created on CHIEF. For CIE, it identifies when the SAD was lodged with Customs.

ENT-EPS-ID A1 EPS at the associated EPU (i.e. ENT-EPU-NO).

ENT-EPU-NO N3 EPU at which entry submitted. Part of the Customs Entry Reference.

ENT-MOP-CODE A1 The method by which the revenue is to be paid or secured.

ENT-NO AN7 The Entry number is a reference that is unique within an EPU and the date of Entry. It is allocated by CHIEF for DTI entries. The format is: For Imports: NNNNNNC For Exports: ANNNNNC where: C = check letter.

ENT-REF T22 Entry reference formatted for presentation in report headers, i.e. eee-bbbbbbb-dd/mm/ccyy where eee is ENT-EPU-NO; bbbbbbb is ENT-NO; dd/mm/ccyy is DT-OF-ENT.

ENTRY-TYPE N1 The same UCR and part number can be used on different types of declaration and for both Imports and Exports. For example, the parts of a Supplementary Export declaration are not expected to correspond to the PSA parts. This item is required when the declaration UCR(part) does not identify an entry unambiguously (e.g. PSA and Supplementary Declaration have the same reference). For the Export messages (cancellation request, query response and display) processing defaults to the Supplementary Declaration if there is a choice. Values are: 0 – Import frontier 1 – Import Supplementary 4 – Export pre-shipment 5 – Export supplementary

ENT-TAX-REV n..12 (10.2) The accumulated revenue at Entry level for a MOP/TAX combination.

Page 11: DES209: Data Element Definitions - gov.uk · DES209: DATA ELEMENT DEFINITIONS CROWN COPYRIGHT Filename: DES209_3 0.doc Page 7 of 29 Version: 3.0 Data Element Name SAD Format Notes

DES209: DATA ELEMENT DEFINITIONS

CROWN COPYRIGHT Filename: DES209_3 0.doc Page 11 of 29 Version: 3.0

Data Element Name SAD Format Notes BOX

ENT-TTY-CODE 47 AN3 Identifies the category of revenue for the accumulated totals returned for the entry.

ENT-TYPE AN..4 The type of Entry for presentation on reports. For Exports:

CRE C21 Clearance Request;

EXS Exit Summary Declaration;

FDE Full Declaration;

LCP LCP PSA;

LCW LCP Ex-warehouse PSA;

SDE Supplementary Declaration (non-SASP);

SASP SASP Supplementary Declaration;

SDP SDP PSA.

For Imports:

C21 C21 Clearance Request;

SAD Frontier Declaration (includes Simplified);

SDI Supplementary Declaration;

SDW Warehouse Supplementary Declaration;

SASP SASP Supplementary Declaration;

WRD Warehouse Removal.

ENT-VER-NO N..2 Identifies a version of the Entry. The version is incremented by a Trader amendment of the Entry and by Goods Arrival (by the trader or an Inventory system). For Exports a new version is created on arrival at the Office of Export but not for any subsequent locations the goods move through.

For the Inventory interface for Imports, messages relating to any version other than the latest are discarded. (The item is not included on the Exports interface.)

EPS-ID A1 Identifies the EPS at the associated EPU.

EPU-NO N3 For Imports, the EPU responsible for the Entry – normally only given as part of the Import Entry Number.

For Exports, depends on context as to whether it identifies the EPU responsible for the entry (associated with submitter), the Office of Export or the EPU for the goods location.

ERROR-CODE AN..8 Error code.

ERROR-MSG t(1)..512 Message identifying an error or an exception that the trader must resolve before the entry can progress.

ERROR-TXT t(1)..70 Descriptive text for the associated error.

EU-ARR-LOCN-CODE AN..17 First airport/port/border post of arrival in EU.

EXIT-OFFICE 29 AN8 The intended Office of Exit from the EU.

FARP-CODE 61 AN3 Identifies the foreign airport as required for CHIEF to calculate the air transport cost that can be included in the value for Customs duty.

FAS-EPU-NO N3 EPU at which the entry was submitted and which along with submitter’s TURN identifies the FAS account.

FAS-RAR AN1 A code identifying the reason for accounting rejection.

FAS-RAR-DESC t(1)..70 Text explanation of the ‘Reason for Accounting Rejection’ code used for information display purposes.

FAS-TURN AN..12 The TURN of the trader who owns the FAS account.

FIR-DAN 48 N7 The (deferment approval) number of the deferment account which is to be used for non-VAT revenue and for VAT revenue if no SCND-DAN is provided.

FIR-DAN-PFX 48 A1 Identifies whether FIR-DAN identifies an account owned by the Declarant or the Consignee/Consignor and if a specific authority or the standing authority is to be used. A – Declarant’s account; B – Consignee’s/Consignor’s account, specific authority; C – Consignee’s/Consignor’s account, standing authority; D – Consignee’s/Consignor’s account when the trader is not using a Declarant. Code D is not permitted if a SCND-DAN is specified.

FRGT-APRT-CODE 64 N1 The element defines whether apportionment is to be by gross mass or value. 1 – by gross mass If this element is not supplied apportionment is by value.

FRGT-CHGE 63 n..12 (10.2) Freight charge in the response currency (see RESPONSE-CRRN and REPORT-TYPE).

FRGT-CHGE-AC 63 n..12 (10.2) The total freight cost (i.e. it includes ATRPT-COST-AC when specified) in the currency specified in FRGT-CHGE-CRRN.

FRGT-CHGE-CRRN 63 A3 The code for the currency in which ATRPT-COST-AC and FRGT-CHGE-AC are declared.

FRGT-CHGE-EXCH 63 n..12 (6.8) The exchange rate applicable to Air (ATRPT-COST-AC) and Freight charges (FRGT-CHGE-AC) on an Import Entry.

GCON-TURN 44h AN..12 The TURN of the government contractor. Must be a GB TURN so not changed to be a TID (i.e. not prefixed with “GB”).

Page 12: DES209: Data Element Definitions - gov.uk · DES209: DATA ELEMENT DEFINITIONS CROWN COPYRIGHT Filename: DES209_3 0.doc Page 7 of 29 Version: 3.0 Data Element Name SAD Format Notes

DES209: DATA ELEMENT DEFINITIONS

CROWN COPYRIGHT Filename: DES209_3 0.doc Page 12 of 29 Version: 3.0

Data Element Name SAD Format Notes BOX

GDS-ARR-DECLN 21 A1 Goods Arrival Declaration as notified by an Inventory system: Y – goods have arrived;

N – goods have not arrived.

GDS-ARR-DTM N12 The date and time (CCYYMMDDHHMM) at which a movement arrived at a location as given by the Inventory system or defaulted by CHIEF. To allow for a difference between the CHIEF and trade system clocks, the arrival date-time can be a few minutes ahead of CHIEF time (currently 10 minutes).

GDS-ARR-DTM-INLD N12 The intended date-time into control at an LCP trader’s inland premises. The entry is automatically arrived at this date-time. The date-time can be amended while the declaration is pre-lodged.

GDS-DEP-DT N8 For a Supplementary Declaration this is the date the goods departed from the place of loading (GDS-LOCN-CODE) or the last day of the period for an aggregated declaration (e.g. a victuallers CAP refund claim).

For an S8 this is the date that an Office of Exit in another Member State notified that the goods were stopped (SOE “D”) or exited (SOE ”8”).

Otherwise it is the notified date of departure from the UK.

GDS-DEP-DTM-INLD N12 The intended departure date-time from an LCP trader’s inland premises. Unless there are Customs checks permission to progress will be given at this date-time. The date-time can be amended while the declaration is pre-lodged.

For a prefinance claim it is the intended date of ‘disposal’ into the warehouse or into processing. There is no equivalent to notifying departure for such declarations. Once permission to progress has been granted the declaration can be finalised.

GDS-DESC 31 t(1)..280 Description of the goods. The element is mapped to 2 elements in the IMD segment.

GDS-DESC-LNG 31 A2 Language in which GDS-DESC is written.

GDS-EPS-ID A1 See GDS-EPU-NO.

GDS-EPU-NO N3 The EPU/EPS responsible for the location of the goods. For a pre-lodgement this is the anticipated goods location if declared. If the entry is not at a particular GDS-LOCN-CODE (e.g. for a warehouse removal) it is the EPU/EPS of the entry.

For anS0 and for an S8 reporting that goods have exited or been stopped by another Member State, the element is set to “000”.

GDS-LOCN 30 A3 For Inventory system generated E0 and H3 reports, this element is the place where the declaration is being presented. For Exports, this element identifies the location of the goods when notifying the arrival and departure of movements. For departure from the UK the location is the place of loading.

GDS-LOCN-CODE 30 AN..17 The goods location code in UNLOCODE format with up to 12 character national suffix (as defined for ECS). For “GB” freight locations the suffix is the optional Shed Operator Identifier.

For Imports, this is the place where the goods are under Customs control.

For Exports, a declaration can be pre-lodged for a particular location where the goods are expected to first come under Customs control. This enables the probable route to be returned to an authorised role (see H-ROE-ALWD). When pre-lodged for a location the goods can still first arrive elsewhere and this is reflected on the Entry. GDS-LOCN is used for the arrival and departure of movements (see Reference [4]). The location for which departure from the UK is notified is deemed to be the place of loading.

For an S8 reporting that goods have exited or been stopped by another Member State the element contains the actual Office of Exit.

For an S0 the element contains the currently declared Office of Exit.

For Supplementary Declarations, the Place of Loading/Unloading is declared here.

HDR-AI-STMT 44h AN5 Generic AI Statement structure at header level. EU defined statements begin with a digit and GB statements with an alphabetic character. The AI Statements to be declared are defined in the Tariff (see Reference [7]).

HDR-AI-STMT-LNG 44h A2 Language in which HDR-AI-STMT-TXT is written.

HDR-AI-STMT-TXT 44h t(1)..70 A single line of textual information associated with an HDR-AI-STMT.

HDR-CURR-CHARS t(1)..512 Used to report the current value of amended header character data.

HDR-CURR-INTGR n..9 Used to report the current value of an amended header integer element.

HDR-CURR-QTY n..14 (11.3) Used to report the current value of an amended header quantity element.

HDR-CURR-VAL n..12 (10.2) Used to report the current value of an amended header value element.

HDR-DOC-CODE 44h AN4 Identifies the document by the EU code (A1AN3) or national code (N1AN3). The documents to be declared are defined in the Tariff (see Reference [7]).

HDR-DOC-LNG 44h A2 Language in which HDR-DOC-REF is written.

HDR-DOC-PART 44h AN..5 Identifies a part of a document or qualifies the use of the document (e.g. CAP refund claim type).

HDR-DOC-QTY 44h n..14 (11.3) Quantity relating to the declaration.

HDR-DOC-REASON 44h t(1)..70 The reason for the status.

Page 13: DES209: Data Element Definitions - gov.uk · DES209: DATA ELEMENT DEFINITIONS CROWN COPYRIGHT Filename: DES209_3 0.doc Page 7 of 29 Version: 3.0 Data Element Name SAD Format Notes

DES209: DATA ELEMENT DEFINITIONS

CROWN COPYRIGHT Filename: DES209_3 0.doc Page 13 of 29 Version: 3.0

Data Element Name SAD Format Notes BOX

HDR-DOC-REF 44h t(6)..35 The document reference.

HDR-DOC-STATUS 44h AN2 The availability and reason for not supplying a document or the action to be taken with the document (see ITEM-DOC-STATUS).

HDR-PREV-CHARS t(1)..512 Used to report the previous value of amended header character data.

HDR-PREV-INTGR n..9 Used to report the previous value of an amended header integer element.

HDR-PREV-QTY n..14 (11.3) Used to report the previous value of an amended header quantity element.

HDR-PREV-VAL n..12 (10.2) Used to report the previous value of an amended header value element.

HMRC-ASG-CODE N3 The ‘Association Assigned Code’ allocated to the message type/subset by Customs is “109” followed by this data element.

H-ROE-ALWD A1 Defined for a Role on CHIEF to control whether the probable route can be returned to the submitting trader for a pre-lodged declaration: Y – probable route can be returned; N (default) – probable route cannot be returned.

I-CNSGE-CITY 8i t(1)..35 Consignee’s address – city.

I-CNSGE-CNTRY 8i A2 Consignee’s address – country.

I-CNSGE-LNG 8i A2 Language in which the consignee’s name and address is written.

I-CNSGE-NAME 8i t(1)..35 Consignee’s name. For Imports. Required along with address elements unless a GB specific trader TURN is given in I-CNSGE-TID.

I-CNSGE-POSTCODE 8i t(6)..9 Consignee’s address – postcode.

I-CNSGE-STREET 8i t(1)..35 Consignee’s address – street.

I-CNSGE-TID 8i AN..17 Consignee TID (see DECLT-TID). For Imports. When “GBPR” or not a GB trader id, name and address must be supplied.

I-CNSGR-CITY 2i t(1)..35 Consignor’s address – city.

I-CNSGR-CNTRY 2i A2 Consignor’s address – country.

I-CNSGR-LNG 2i A2 Language in which the consignor’s name and address is written.

I-CNSGR-NAME 2i t(1)..35 Consignor’s name. For Exports. Required along with address elements unless a GB specific trader TURN is given in I-CNSGR-TID. Also required regardless of TID for a CAP Export refund claim.

I-CNSGR-POSTCODE 2i t(6)..9 Consignor’s address – postcode.

I-CNSGR-STREET 2i t(1)..35 Consignor’s address – street.

I-CNSGR-TID 2i AN..17 Consignor TID (see DECLT-TID). For Exports. When “GBPR”, “GBUNREG” or not a GB trader id, name and address must be supplied.

ICS AN2 A code indicating the Customs status of the Entry. See CHIEF User Guide (Reference [2]) for Import and Export values.

For Exports the ICS should be treated as a qualifier for the status given in SOE – Inventory system processing should be based on the SOE rather than ICS.

IE-KEY N..8 A system generated unique identifier for an Entry which is for system internal use, except that it provides a means of retrieval for stored ‘errored’ entries which have never been accepted.

IMM-TOT n..12 (10.2) The sum of revenue from all Tax Lines on an Entry that have a Method of Payment classified as Immediate.

INS-AMT 66 n..12 (10.2) The amount of insurance paid to cover the transport of the goods in the response currency (see RESPONSE-CRRN and REPORT-TYPE).

INS-AMT-AC 66 n..12 (10.2) The amount of insurance paid to cover the transport of the goods in the currency specified in INS-AMT-CRRN.

INS-AMT-CRRN 66 A3 The code for the currency in which INS-AMT is declared.

INS-AMT-EXCH 66 n..12 (6.8) The exchange rate applicable to Insurance Charges (INS-AMT-AC) on an Import Entry.

INTD-ARR-DTM N12 Intended arrival date-time at EU-ARR-LOCN-CODE on a pre-arrival notification.

INV-CRRN 22 A3 The code for the currency in which INV-TOT-AC and ITEM-PRC-AC are declared or (for exports) specified to satisfy the currency of invoicing requirement.

INV-DAMT 65 n..12 (10.2) The amount of an allowable discount on the invoice total (INV-TOT-AC) in the response currency (see RESPONSE-CRRN and REPORT-TYPE).

INV-DAMT-AC 65 n..12 (10.2) Invoice discount amount in the currency specified in INV-DAMT-CRRN.

INV-DAMT-CRRN 65 A3 The code for the currency in which INV-DAMT-AC is declared.

INV-DAMT-EXCH 65 n..12 (6.8) The exchange rate applicable to the invoice discount amount (INV-DAMT-AC) on an Import Entry.

INV-DPCT 65 n..5 (3.2) The allowable discount percentage to 2 decimal places on the INV-TOT. The maximum percentage that can be specified is defined in the Tariff.

INV-EXCH 22 n..12 (6.8) The exchange rate applicable to the Invoice amount (INV-TOT-AC) on an Import Entry.

INV-TOT 22 n..12 (10.2) Invoice total in the response currency (see RESPONSE-CRRN and REPORT-TYPE).

INV-TOT-AC 22 n..12 (10.2) Invoice total in the currency specified in INV-CRRN.

Page 14: DES209: Data Element Definitions - gov.uk · DES209: DATA ELEMENT DEFINITIONS CROWN COPYRIGHT Filename: DES209_3 0.doc Page 7 of 29 Version: 3.0 Data Element Name SAD Format Notes

DES209: DATA ELEMENT DEFINITIONS

CROWN COPYRIGHT Filename: DES209_3 0.doc Page 14 of 29 Version: 3.0

Data Element Name SAD Format Notes BOX

INVY-CNSGT-REF 40 t(1)..25 For Inventory system generated E0 and H3 reports, this element is the Inventory system’s reference for an Import consignment. It is used to link the Entry to the consignment on the Inventory system interface for Imports. It is declared as part of the MASTER-UCR on an Import declaration. For Exports, see MASTER-UCR and MOVT-REF.

INVY-CNSGT-VER N..2 Identifies a version of the Consignment. Not used for Exports.

INVY-SYS-ID AN..4 Inventory System identification code. For Imports, the Inventory system is determined from the security parameters for the client session in which the declaration transaction occurs. For Exports, the Inventory system is determined from the context of the arrival message for a movement.

IRC N3 For Imports the IRC gives the result of matching by the Inventory system (not used for Exports since no data is matched).

IRC-DESC t(1)..70 Descriptive text supplied by the inventory system, associated with a non-success IRC value.

I-SPOFF-CITY 44 t(1)..35 Item Supervising Office address – city.

I-SPOFF-CNTRY 44 A2 Item Supervising Office address – country.

I-SPOFF-NAME 44 t(1)..35 Item Supervising Office name.

I-SPOFF-POSTCODE 44 t(6)..9 Item Supervising Office address – postcode.

I-SPOFF-STREET 44 t(1)..35 Item Supervising Office address – street.

ITEM-AI-STMT 44 AN5 Identifies an additional information statement. EU defined statements begin with a digit and GB statements with an alphabetic character. The AI Statements to be declared are defined in the Tariff (see Reference [7]).

ITEM-AI-STMT-LNG 44 A2 Language in which ITEM-AI-STMT-TXT is written.

ITEM-AI-STMT-TXT 44 t(1)..70 A single line of textual information associated with an ITEM-AI-STMT.

ITEM-CSTMS-VAL n..12 (10.2) The item value for Customs Duty used in revenue calculations.

ITEM-CURR-CHARS t(1)..512 Used to report the current value of amended item character data.

ITEM-CURR-INTGR n..9 Used to report the current value of an amended item integer element.

ITEM-CURR-QTY n..14 (11.3) Used to report the current value of an amended item quantity element.

ITEM-CURR-VAL n..12 (10.2) Used to report the current value of an amended item value element.

ITEM-DEST-CNTRY 17ai A2 The code for the destination country defined for an item.

ITEM-DISP-CNTRY 15ai A2 The code for the export or dispatch country defined for an item.

ITEM-DOC-CODE 44 AN4 Identifies the document by the EU code (A1AN3) or national code (N1AN3). The documents to be declared are defined in the Tariff (see Reference [7]).

ITEM-DOC-LNG 44 A2 Language in which ITEM-DOC-REF is written.

ITEM-DOC-PART 44 AN..5 Identifies a part of a document (e.g. a licence line).

ITEM-DOC-QTY 44 n..14 (11.3) Quantity relating to the declaration (e.g. of the amount for which a licence has been issued, the quantity of an ingredient, percentage for a SD code).

ITEM-DOC-REASON 44 t(1)..70 The reason for the status (e.g. claiming a waiver). This is currently stuffed into a DOC segment which only allows 70 characters.

ITEM-DOC-REF 44 t(6)..35 For licences, when an actual licence is not being declared, the element is used to identify the type of licence.

ITEM-DOC-STATUS 44 AN2 The availability and reason for not supplying a document or the action to be taken with the document (see Reference [7]).

ITEM-DUTY n..12 (10.2) The Customs Duty payable on the item.

ITEM-GROSS-MASS 35 n..14 (11.3) The gross mass in kilograms (to 3 decimal places) of the goods being declared by the item.

ITEM-LCNC-VAL n..12 (10.2) The calculated item value for licensing purposes.

ITEM-NET-MASS 38 n..14 (11.3) The net mass in kilograms of the associated goods. The quantity can be expressed up to three decimal places. When supplied it must be greater than zero.

ITEM-NO N..3 The sequence number of an item within an Entry. Harmonised SAD declarations will not initially support more than 99 items. The definition of the element is changed so there will be no trade impact should the number be increased in the future.

ITEM-ORIG-CNTRY 34a A2 The code for the country from which the goods originated.

ITEM-PRC 42 n..12 (10.2) The invoiced value of the item in the response currency (see RESPONSE-CRRN and REPORT-TYPE).

ITEM-PRC-AC 42 n..12 (10.2) The invoiced value of the item in the currency specified in INV-CRRN.

ITEM-PREV-CHARS t(1)..512 Used to report the previous value of amended item character data.

ITEM-PREV-INTGR n..9 Used to report the previous value of an amended item integer element.

ITEM-PREV-QTY n..14 (11.3) Used to report the previous value of an amended item quantity element.

ITEM-PREV-VAL n..12 (10.2) Used to report the previous value of an amended item value element.

Page 15: DES209: Data Element Definitions - gov.uk · DES209: DATA ELEMENT DEFINITIONS CROWN COPYRIGHT Filename: DES209_3 0.doc Page 7 of 29 Version: 3.0 Data Element Name SAD Format Notes

DES209: DATA ELEMENT DEFINITIONS

CROWN COPYRIGHT Filename: DES209_3 0.doc Page 15 of 29 Version: 3.0

Data Element Name SAD Format Notes BOX

ITEM-PROC-INST AN..3 The following processing instruction codes are used to confirm that the data elements identified are correct as input overriding the corresponding CHIEF FEC challenge: “DST” for (ITEM-)DEST-CNTRY for CMDTY-CODE (Exports only); “ORG” for ITEM-ORIG-CNTRY for IE-CMDTY-CODE (Imports only); “QV1” for ITEM-NET-MASS and ITEM-STAT-VAL; “QV2” for ITEM-SUPP-UNITS and ITEM-STAT-VAL.

Note: It will be considered an error if a confirm instruction is supplied in cases where either no FEC check is applied or the data passes the FEC check, except in the following cases: - when a previously issued challenge, for an Entry committed to route F, no longer applies; - data previously Confirmed as correct remains unaltered.

ITEM-ROUTE-CNTRY A2 A country through which the goods have moved or are intended to move between the country of dispatch and the country of destination.

ITEM-STAT-VAL 46 n..12 (10.2) The Statistical Value of an Item in the response currency (see RESPONSE-CRRN and REPORT-TYPE). When the declared amount has been converted it is at the exchange rate given in DECLN-EXCH.

ITEM-STAT-VAL-DC 46 n..12 (10.2) The Statistical Value of an item in the declaration currency (see DECLN-CRRN).

For Imports, a value may only be supplied when required by the CPC. CHIEF calculates the value for most CPCs.

ITEM-SUPP-UNITS 41 n..14 (11.3) The quantity in terms of the second unit identified in the Tariff. The quantity can be expressed up to three decimal places. When supplied it must be greater than zero on an Export Entry. When supplied on an Import Entry it must also be greater than zero unless the CPC allows zero. Import CPCs that allow zero are held as Table Entries in Table CPCZ.

ITEM-THRD-QTY 44 n..14 (11.3) Specifies a ‘third quantity’ for the item if this is required by the Tariff, otherwise it should be omitted. The quantity can be expressed up to three decimal places. When supplied it must be greater than zero on an Export Entry. When supplied on an Import Entry it must also be greater than zero unless the CPC allows zero. Import CPCs that allow zero are held as Table Entries in Table CPCZ.

ITEM-VAL-ADJT 45 n..6 (3.3) The percentage adjustment to the invoiced price (ITEM-PRC-AC) notified to the trader by Customs.

ITEM-VAT n..12 (10.2) The VAT payable on the item.

ITEM-VAT-VAL n..12 (10.2) The calculated value of the item for VAT purposes. This is the sum of the Item value for Customs Duty, the value of chargeable revenue other than VAT, and some other incidental costs and expenses. Chargeable revenue includes revenue on all non-VAT tax lines and Potential duty when the CPC indicates this should be included (i.e. Potential duty incl = Y).

ITLN-BASE-AMT-DC 47b n..12 (10.2) The amount on which excise tax duty is based in the declaration currency (see DECLN-CRRN).

ITLN-BASE-QTY 47b n..14 (11.3) The composite quantity on which the tax or duty is based.

ITLN-CHGE-TAX 47d n..12 (10.2) The amount of revenue due for a Tax Line on an Entry in the response currency (see RESPONSE-CRRN and REPORT-TYPE). It is the declared amount when supplied by the trader and the calculated amount when returned by CHIEF in response, reports or display messages. The amount is zero when payment is waived.

ITLN-DECL-TAX-DC 47d n..12 (10.2) The declared amount of revenue due for a Tax Line on an Entry in the declaration currency (see DECLN-CRRN).

I-TRPT-CHGE-MOP A1 The transport charges method of payment as declared for an item. The same value must not be declared for all items.

LIABILITY-DTM N12 The date and time (CCYYMMDDHHMM) at which the liability for the use of a licence line occurred. This is the acceptance date-time for declared amount(s) or the date-time of the adjustment or contra transaction by Customs.

LI-CMDTY-CODE N..8 or N8sN2

Identifies the class of goods appropriate for the licence line. The class of goods can be identified by commodity code at 4 or more digits (normally 4, 6, 8 or taric level).

LI-CNTRL-BY A1 Identifies the method by which use of a licence line is controlled: ‘B’ – Both quantity and value; ‘O’ – Open (i.e. no limits); ‘Q’ – Quantity only; ‘V’ – Value only.

LI-CRRN-CODE A3 The code for the currency in which licence line values are expressed.

LI-END-DT N8 The date (CCYYMMDD) until which the licence is valid. New declarations for the licence will fail after this date but pending allocations can still be finalised and adjustments to existing uses made until all pending allocations have been finalised.

LI-IMP-EXP A1 Identifies whether the licence is for Import or Export use: ‘E’ – Export;

‘I’ – Import.

LI-LINE-NO N..5 The licence line number is declared as ITEM-DOC-PART. This item is still used for a licence usage request.

Page 16: DES209: Data Element Definitions - gov.uk · DES209: DATA ELEMENT DEFINITIONS CROWN COPYRIGHT Filename: DES209_3 0.doc Page 7 of 29 Version: 3.0 Data Element Name SAD Format Notes

DES209: DATA ELEMENT DEFINITIONS

CROWN COPYRIGHT Filename: DES209_3 0.doc Page 16 of 29 Version: 3.0

Data Element Name SAD Format Notes BOX

LI-OGD-UOQ-DESC t(1)..20 Name of the unit of quantity in which the licence line use is controlled. The name is as used by the other government department.

LI-QTY 44 n..14 (11.3) Licence or permit quantity used by the declaration in the units specified for the licence line.

LI-QTY-AVAIL n..14 (S11.3)

Quantity available for new declarations, in the units defined for the line. It should be noted that the quantity available can be negative as a result of an adjustment or an attribution for a Supplementary Declaration. If the allocation of the quantity is restricted for sub-periods then the quantity is the amount currently available for new declarations.

LI-QTY-ISSUED n..14 (11.3) Quantity issued, in the units defined for the line.

LI-QTY-PENDING n..14 (11.3) Quantity pending allocation for accepted declarations that are not yet finalised (clearance for Imports, departure for Exports), in the units defined for the line.

LI-QTY-USED n..14 (11.3) Quantity used by finalised (clearance for Imports, departure for Exports) declarations, in the units defined for the line.

LI-REF

t(1)..35 The licence reference is declared as ITEM-DOC-REF. This item is still used for a licence usage request.

LI-START-DT N8 The date (CCYYMMDD) from which the licence is valid. Declarations for the licence will fail before this date.

LI-STATUS A..2 Identifies the status of the Licence as a whole: ‘O’ Open (subject to start and end validity dates); ‘PS’ Pending Surrendered – licence has been surrendered but there may be pending

attributions and adjustments can still be made; ‘S’ Surrendered; ‘PE’ Pending Exhausted – licence has been exhausted but there may be pending

attributions and adjustments can still be made; ‘E’ Exhausted; ‘PC’ Pending Cancel – licence has been cancelled but there may be pending

attributions and adjustments can still be made; ‘C’ Cancelled; ‘PD’ Pending date expiry – it is after the expiry date but there may be pending

attributions, Supplementary Declarations can use the licence if the tax point is before expiry and adjustments can still be made;

‘D’ Date expired.

LI-STATUS-DECLN 44 A1 Controls use of the Licence or permit. The values allow the trader to indicate whether this use is a part allocation for the line or the final use of all licence lines. For a final use, depending on the issuing authority, the trader can specify that the licence is exhausted or surrender the remaining amounts. Details of which values can be declared for Imports and Exports are given in the Tariff Volume 3 (see Reference [7]). The values declared also depend on the form of the licence, as follows: Any:

‘A’ – actual licence/permit/certificate to be advised; Electronic:

‘P’ – Part attribution; ‘S’ – final, Surrender remaining amounts; ‘E’ – final, amounts are Exhausted; ‘L’ – ‘late’ declaration after the licence ‘completed’ on CHIEF; ‘Z’ – already attributed on simplified declaration.

Paper (attached/available): ‘Q’ – Part attribution; ‘T’ – final, Surrender remaining amounts;

‘F’ – final, amounts are Exhausted; ‘Y’ – already attributed on simplified declaration. Paper (held by trader):

‘R’ – Part attribution; ‘U’ – final, Surrender remaining amounts;

‘G – final, amounts are Exhausted; ‘Y’ – already attributed on simplified declaration. Paper (held by issuing authority):

‘I’ – Part attribution; ‘J’ – final, Surrender remaining amounts;

‘X’ – final, amounts are Exhausted; ‘Y’ – already attributed on simplified declaration.

LI-TDR-ID AN..12 The trader identity of a licence holder as allocated by the issuing authority (e.g. HDR-AI-STMT “RPTID”). This item is used for a licence usage request.

LI-TURN AN..12 The TURN of a licence holder. This item is used for a licence usage request. See also LI-TDR-ID.

LI-TYPE AN3 Identifies the type of Licence.

LI-UOQ-CODE N3 Code for the unit of quantity in which the licence line use is controlled.

LI-USAGE-CURR-IND A1 Identifies whether the usage record is current (‘Y’) for the entry or has been superseded (‘N’).

Page 17: DES209: Data Element Definitions - gov.uk · DES209: DATA ELEMENT DEFINITIONS CROWN COPYRIGHT Filename: DES209_3 0.doc Page 7 of 29 Version: 3.0 Data Element Name SAD Format Notes

DES209: DATA ELEMENT DEFINITIONS

CROWN COPYRIGHT Filename: DES209_3 0.doc Page 17 of 29 Version: 3.0

Data Element Name SAD Format Notes BOX

LI-USAGE-TYPE A1 Identifies the type of a usage. The types are: ‘A’ – Adjusted attribution by Customs; ‘C’ – Contra by Customs; ‘L’ – Late original attribution by Customs adjustment; ‘O’ – Original attribution for a finalised entry; ‘P’ – Pending attribution for an accepted entry that is not yet finalised.

LI-VAL n..12 (10.2) The value used by the declaration in the currency identified by LI-CRRN.

LI-VAL-AVAIL n..12 (10.2) Value in LI-CRRN available for new declarations. It should be noted that the value available can be negative as a result of an adjustment or an attribution for a Supplementary Declaration. If the allocation of the value is restricted for sub-periods then the value is the amount currently available for new declarations.

LI-VAL-ISSUED n..12 (10.2) Value in LI-CRRN issued for the licence line.

LI-VAL-PENDING n..12 (10.2) Value in LI-CRRN pending allocation for the licence line (i.e. for accepted declarations that are not yet finalised (clearance for Imports, departure for Exports)).

LI-VAL-USED n..12 (10.2) Value in LI-CRRN used by finalised (clearance for Imports, departure for Exports) declarations for the licence line.

MASTER-OPEN-IND A1 When set to “Y” the consolidation is open. When set to “N” the consolidation is shut.

Declarations cannot be made into a ‘shut’ master but changes to the consolidation can be made by association; this is restricted further following arrival to the agent/inventory system that notified the arrival.

MASTER-OPT A1 Determines the level at which entry details are returned as a result of a EAA or EAL for a consolidation and subsequent notification of changes to the route, status and some declared details of constituent consignments.

‘A’ (default) – returns route and status for all entries; ‘F’ – returns full details for all entries; ‘R’ – returns the most severe route for a consignment and the most significant status; ‘X’ – returns route and status details of consignments that are not ‘permitted to

progress’.

For option ‘R’, the Inventory system is only notified (by EMR) of changes to the most severe route for any consignment in the consolidation and when all consignments are permitted to progress.

For the other options (including ’X’), changes are notified (by ERS) for each consignment in the consolidation and an EMR with no consignment details is sent when the route/status of the consolidation changes.

Regardless of MASTER-OPT an ERS is always sent for a Declaration movement that has permission to progress if the declaration is cancelled.

MASTER-ROE AN..2 The most severe route for the declarations covered by the MASTER-UCR supplied in an (anticipated) arrival message. Note that while the Master Route may become more severe if further declarations are associated with the consolidation, it doesn’t become less severe should declarations be disassociated from the consolidation, except possibly when the Master Route is ‘0’ (see following). Route severity, from lowest to highest, is 6,3,5,1,2,0. Note however that although ‘0’ (meaning route not yet established) is the most severe Route, it is also intended to be a temporary Route (for both declarations and Master UCRs). Thus, when the last declaration gains a non-temporary route (i.e. not ‘0’), the Master UCR should then be updated to the most severe route of the declarations and which is no longer ‘0’. If reprocessing of an entry on arrival fails it is treated as Route 0 (not H) as are any declarations currently on Route E or F. Should an (anticipated) arrival message refer to an as yet unknown MASTER-UCR, (and hence as yet no declarations), the Master Route will be set to ‘blank’. This is changed to one of the above values when the first declaration is associated with/declared into the consolidation.-

For MASTER-OPT “R” on arrival, the Inventory system is informed when the severity of the MASTER-ROE increases. Should the only consignment on that route be permitted to progress, the MASTER-ROE is not changed to reflect the highest severity of the remaining consignments that are not yet permitted to progress.

MASTER-SOE AN1 This item gives the major status of a consolidation (in particular ‘permitted to progress’). The MASTER-SOE values are defined to be sufficient for an Inventory to control the movement of the consolidation in conjunction with the MASTER-ROE. The values are:

“D” – departed inland (never sent in EMR); “0” – consolidation is ‘open’ (there may be more goods to be declared to CHIEF); “1” – consolidation subject to associated ROE; “7” – permitted to progress; “8” – departed from UK (never sent in EMR); “9” – consolidation seized/destroyed/released to Queens Warehouse.

Page 18: DES209: Data Element Definitions - gov.uk · DES209: DATA ELEMENT DEFINITIONS CROWN COPYRIGHT Filename: DES209_3 0.doc Page 7 of 29 Version: 3.0 Data Element Name SAD Format Notes

DES209: DATA ELEMENT DEFINITIONS

CROWN COPYRIGHT Filename: DES209_3 0.doc Page 18 of 29 Version: 3.0

Data Element Name SAD Format Notes BOX

MASTER-UCR 44h AN plus ‘-‘, ‘(‘, ‘)’, ‘/’ and ‘:’..35 (but see also Section 2).

The UCR for a consolidation of consignments at declaration and/or master level. A consolidation need only contain the goods covered by a single declaration allowing the MASTER-UCR to be the reference to the consignment as known to an Inventory system.

A Master UCR must conform to the structure specified in Tariff Volume 3 (see Reference [7]) which, for Exports, is currently:

GB/i..i-s..s Master UCR allocated or required by a CSP’s or a consolidator’s Inventory system.

GB/tttttttttttt-u..u Master UCR which is not a DEP or CSP inventory MUCR.

A:a..a Master UCR based on the Master Airwaybill number.

C:p..p Master UCR for courier traffic.

Where: i..i 3 or 4 character Inventory system identity allocated by Customs to a CSP or

a consolidator; s..s Inventory consignment reference of at least 5 characters (maximum of 25

for Imports); tttttttttttt the trader’s TURN; u..u trader reference of at least 1 character; a..a the Master Airwaybill number of 11 characters (3 alpha or 3 numeric

followed by exactly 8 numeric); p..p reference as agreed for courier traffic (3 alpha followed by at least 3

alphanumeric characters). “GB”, “A”, “C”, “/”, “:” and “-” are literal values.

For Imports the only Master UCR format that is currently supported is the Inventory Consignment Reference format (i.e. GB/i..i-s..s). It should be noted that for Imports CHIEF allows just the Inventory Consignment Reference to be supplied in this element when the associated Inventory system is defined for the submitting trader role. Note also, that while Imports allows embedded spaces to be declared within the Inventory Consignment Reference, it will not permit leading space(s). Thus ‘GB/CUK1-I C R’ is a valid format for Imports but ‘GB/CUK1- ICR’ is not.

On Export reports that relate to a particular movement it is the Master by which the movement was arrived. If the movement was not arrived by Master, it is the immediate Master for the entry if the entry is in a consolidation.

MESSAGE-CODE A..3 The MESSAGE-CODE in the BGM segment is used to identify the incoming EDIFACT message and hence the CHIEF transaction to be invoked.

MOP-CODE 47e A1 The method by which the revenue is to be paid or secured.

MOVT-NO N..8 The number of a movement by which an authorized user can access details.

MOVT-REF t(1)..25 Optionally used to identify a movement of goods at a location (GDS-LOCN-CODE) controlled by an inventory system (in many cases movements can be controlled by Declaration or Master UCR). A movement reference can be applied to the whole of a consignment or a split at either declaration or master level. The reference does not have to be unique for the consignment let alone universally.

For example, a MOVT-REF could identify a lorry that might make many trips moving splits of the consignment. CHIEF keeps an audit trail of split movements.

Departures are reported for the consignment not each movement. All movements currently at the location and permitted to progress are deemed to have departed.

CHIEF accepts many arrivals for the same MOVT-REF without requiring departure to have been notified or even that a previous movement with the same MOVT-REF has been permitted to progress. Where the same MOVT-REF is used for separate movements that are at the same location at the same time, the separate movements can be further identified by GDS-ARR-DTM.

MRN AN18 A Movement Reference Number (MRN) is a unique reference for a movement within the EU. A MRN identifies the declaration. A MRN is allocated by CHIEF for all export entries. A MRN is can be used as an alternative key to the declaration (see DECLN-UCR and UCR).

MSG-ASG-CODE AN..6 The message associated assigned code from the UNH segment of the message to which the response applies.

MSG-CNTR-AGNCY AN..2 The message controlling agency from the UNH segment of the message to which the response applies.

MSG-ERROR-CODE AN..3 Identifies why the message has been rejected as a whole. The values are as defined for DATA-ERROR-CODE.

Page 19: DES209: Data Element Definitions - gov.uk · DES209: DATA ELEMENT DEFINITIONS CROWN COPYRIGHT Filename: DES209_3 0.doc Page 7 of 29 Version: 3.0 Data Element Name SAD Format Notes

DES209: DATA ELEMENT DEFINITIONS

CROWN COPYRIGHT Filename: DES209_3 0.doc Page 19 of 29 Version: 3.0

Data Element Name SAD Format Notes BOX

MSG-FUNCTION N..2 Used to determine the purpose of the message as follows: for a declaration:

“9” (original) to be inserted; “5” (replace) to amend an existing entry; “1” (cancellation) to cancel an existing entry.

for a declaration response: “27” (not accepted) when there are errors; “29” (accepted without amendment) when accepted.

for a request for data: “13” (request).

for a response to a request: “11” (response).

for a report: “6” (confirmation).

MSG-MRN AN..14 The message reference number from the UNH/UNT segments of the message to which the response applies.

MSG-REL-NO AN..3 The message release number from the UNH segment of the message to which the response applies.

MSG-SYS-CAR t(1)..35 The message Common Access Reference from the UNH segment of the message to which the response applies.

MSG-TYPE AN..6 The message type from the UNH segment of the message to which the response applies.

MSG-VSN AN..3 The message type version from the UNH segment of the message to which the response applies.

NEXT-DTM N12 The date and time (CCYYMMDDHHMM) associated with the next record to be returned (e.g. the LIABILITY-DTM for a licence usage).

NEXT-PART-NO N..3A..1 Identifies the part associated with NEXT-UCR when displaying a Master Consignment or just the next part when displaying a Declaration Consignment.

NEXT-UCR See DECLN-UCR

Identifies the next consignment in a display response when there are more to be returned. In a display request it is the first consignment to be returned.

NOTIFY-CITY t(1)..35 Address of party to be notified – city.

NOTIFY-CNTRY A2 Address of party to be notified – country.

NOTIFY-NAME t(1)..35 Name of the party to be notified.

NOTIFY-POSTCODE t(6)..9 Address of party to be notified – postcode.

NOTIFY-STREET t(1)..35 Address of party to be notified – street.

NOTIFY-TID AN..17 Trader identifier for party to be notified.

OCD 67 n..12 (10.2) The amount of other charges or deductions (see box 45 CIF codes) to be taken into account in calculating the Customs value in the response currency (see RESPONSE-CRRN and REPORT-TYPE).

OCD-AC 67 n..12 (10.2) The amount of other charges or deductions (see box 45 CIF codes) to be taken into account in calculating the Customs value in the currency specified in OCD-CRRN.

OCD-CRRN 67 A3 The code for the currency in which OCD-AC is declared.

OCD-EXCH 67 n..12 (6.8) The exchange rate applicable to other charges or deductions (OCD) on an Import Entry.

P2P-DTM N12 Date-time (CCYYMMDDHHMM) on which permission to progress was granted.

PKG-COUNT 31 n..5 The number of packages or pieces of the kind identified by PKG-KIND. When PKG-KIND identifies bulk goods, PKG-COUNT must not be supplied.

PKG-KIND 31 AN2 The kind of package.

PKG-MARKS 31 t(1)..42 Marks to enable the packages of the given kind to be identified. The element is mapped to 2 elements in the PCI segment.

PKG-MARKS-LNG 31 A2 Language in which PKG-MARKS is written.

PLA-LDG-CODE AN..17 This is the place of loading for the export consignment. For Exports from UK, the place of loading is the goods location (GDS-LOCN) given by an Inventory system when notifying CHIEF of departure from the UK.

Not allowed for harmonised SAD but required for Imports and Exports Security/Initial declaration.

PLA-ULDG 27 A3 Identifies the (air)port at which the vessel (ship or aeroplane) is unloaded as reported on E0 and H3 generated by an Inventory system.

PLA-ULDG-CODE AN..17 Identifies the (air)port at which the vessel (ship or aeroplane) is (to be) unloaded.

Not allowed for new SAD but required by PLA-ULDG-CODE for Imports Security/Initial declaration.

PREFERENCE 36 N3 A Community code indicating whether a Preference is being claimed, and if so, what type.

PREM-CITY 44h t(1)..35 Approved premise address – city.

PREM-CNTRY 44h A2 Approved premise address – country.

Page 20: DES209: Data Element Definitions - gov.uk · DES209: DATA ELEMENT DEFINITIONS CROWN COPYRIGHT Filename: DES209_3 0.doc Page 7 of 29 Version: 3.0 Data Element Name SAD Format Notes

DES209: DATA ELEMENT DEFINITIONS

CROWN COPYRIGHT Filename: DES209_3 0.doc Page 20 of 29 Version: 3.0

Data Element Name SAD Format Notes BOX

PREM-ID 49 AN..17 The warehouse identifier with the following structure: <warehouse type> (a1) – warehouse type with new codes added for free zones and

non customs warehouses; <warehouse reference> (t..14) allocated to the warehouse on approval – if <country

code> is “GB” the warehouse reference must be on CHIEF; <country code> (a2) of the authorising MS – must be the country code for an EU

Member State.

PREM-NAME 44h t(1)..35 The name associated with an Approved premise. Approved premises include warehouses which are buildings approved by HMRC in which goods may be stored without payment of all or some of the charges to which they are liable.

PREM-POSTCODE 44h t(6)..9 Approved premise address – postcode.

PREM-STREET 44h t(1)..35 Approved premise address – street.

PREM-STREET2 t(1)..35 Street address line for displaying warehouse addresses currently defined on CHIEF.

PREM-STREET3 t(1)..35 Street address line for displaying warehouse addresses currently defined on CHIEF.

PREM-STREET4 t(1)..35 Street address line for displaying warehouse addresses currently defined on CHIEF.

PREV-BASE-AMT 47b n..12 (10.2) The current tax base amount. See ITLN-BASE-AMT-DC.

PREV-BASE-QTY 47b n..12 (10.2) The current tax base quantity. See ITLN-BASE-QTY.

PREV-DOC-CLASS 40 A1 This field identifies the class or kind of previous document being declared. “X” – summary declaration; “Y” – initial declaration (used for reference to SFD or PSA); “Z” – previous document.

PREV-DOC-LNG 40 A2 Language in which PREV-DOC-REF is written.

PREV-DOC-REF 40 t(1).. 35 Identifies a previous document.

PREV-DOC-TYPE 40 AN..6 The previous document type values (AN3) are in the UNTDID 1001 code list plus a few additional ones defined for EU. Other codes (AN..6) are used for ECS.

PREV-ENT-TOT-REV n..12 (10.2) The previous accumulated revenue at Entry level for a MOP/TAX combination.

PREV-MOP-CODE 47e A1 The previous method by which the revenue was to be paid or secured.

PREV-REV-AMT 47d n..12 (10.2) The previous amount of revenue due for a Tax Line on an Entry, either declared or calculated. The amount is zero when payment was waived.

PREV-ROE AN..2 Route from which entry has been reselected.

PREV-TAX-RATE-ID 47c A..3 Specifies the previous rate at which the revenue has been calculated.

PREV-TTY-CODE 47a AN3 Identifies the previous category of revenue being declared.

PREV-TTY-OVR-CD 47c A3 Specifies a code identifying a previous exception to the normal calculation of the associated revenue.

PROC-INST AN..3 The following processing instruction codes are used to confirm that the data elements identified are correct as input overriding the corresponding CHIEF FEC challenge: “DSP” for DISP-CNTRY (Imports only; “DST” for DEST-CNTRY (Exports only); “FLG” for TRPT-CNTRY.

Note: It will be considered an error if a confirm instruction is supplied in cases where either no FEC check is applied or the data passes the FEC check, except in the following cases: - when a previously issued challenge, for an Entry committed to route F, no longer

applies; - data previously Confirmed as correct remains unaltered.

Other processing instructions are: “ACC” for an acceptance report as well as the CUSRES response to the CUSDEC

(see also REPORTS-CTRL); “PRG” for progress reports (Exports only); “RTF” for Route F required (must not be supplied for CCR/C21 or Supplementary

Declarations). When supplied, the Entry will be committed to route F when the declaration is valid and there are FEC challenges outstanding. Otherwise the initial Entry (or an update to an existing Entry) will not be committed while there are FEC challenges. FEC challenges are reported along with errors while the declaration remains invalid.

“ACC” and “PRG” are ignored on amendment. They must be specified on insert to have any effect. Note, for declarations at the HCI the reports required can be defined for the trader’s role as a session variable.

QTA-NO 39 N6 The Quota Order Number of the quota against which a claim for relief from Customs Duty is to be applied.

RCNSGE-TURN 44h AN..12 The TURN of the registered consignee responsible for the VAT. Must be a GB TURN so not changed to be a TID (i.e. not prefixed with “GB”).

RCNSGR-TURN 44h AN..12 The TURN of the registered consignor responsible for the VAT. Must be a GB TURN so not changed to be a TID (i.e. not prefixed with “GB”).

Page 21: DES209: Data Element Definitions - gov.uk · DES209: DATA ELEMENT DEFINITIONS CROWN COPYRIGHT Filename: DES209_3 0.doc Page 7 of 29 Version: 3.0 Data Element Name SAD Format Notes

DES209: DATA ELEMENT DEFINITIONS

CROWN COPYRIGHT Filename: DES209_3 0.doc Page 21 of 29 Version: 3.0

Data Element Name SAD Format Notes BOX

REASON t(1)..512 On input this element is used for the reason for amendment or cancellation, and the query response. In these cases there can be up to 5 occurrences of this data element. The REASON should be supplied as “arrival only” if the purpose of the amendment is solely to notify goods arrival. The response to a display entry request returns the reasons:

– for amendment (mandatory unless the purpose of the amendment is solely to notify goods arrival);

– for requesting cancellation; – for cancellation being refused by Customs; – in a query response when the Customs query does not require an amendment.

Many reasons can be returned for a display entry request. For each reason the first block identifies the date-time and type of action for which the reason was given.

REPORTS-CTRL A1 This is defined for a path to restrict the level of control over the production of acceptance report (H2/E2, P2/X2) messages that can be requested by the submitting trader (see PROC-INST “ACC”) and to identify an untrusted route. An untrusted route to CHIEF cannot be used for some declarations (e.g. CAP refund claims). Values are:

‘F’ – acceptance report messages are only produced if PROC-INST “ACC” is declared.

‘N’ (default) – acceptance report messages are always produced. ‘S’ – as ‘F’. ‘U’ – route is untrusted and full control is permitted as for ‘F’.

REPORTS-RQD A1 This element enables the agent notifying arrival of an export entry to request declaration progress reports for the entry and its subsequent movements by supplying either “B” or “O”. Note, if the arrival notification is for a consolidation, then setting REPORTS-RQD to “B” or “O” will request declaration progress reports for each of the entries in the consolidation.

Note, the submitting trader of an export entry can request declaration progress reports by declaring PROC-INST “PRG”.

Note, for arrivals input via the HCI, REPORTS-RQD can be defined for the user’s role as a session variable.

REPORT-TYPE t(1)..16 Identifies the Print Report Type optionally prefixed with the currency mark (“GBP” for sterling or “EUR” for euro) followed by a space. See also RESPONSE-CRRN.

REPR-CITY t(1)..35 Representative’s – city.

REPR-CNTRY A2 Representative’s address – country.

REPR-LNG A2 Language in which the representative’s name and address is written.

REPR-NAME t(1)..35 Representative’s name.

REPR-POSTCODE t(6)..9 Representative’s address – postcode.

REPR-STREET t(1)..35 Representative’s address – street.

REPR-TID AN..17 Representative’s TID.

REQUEST-CRRN A3 The currency in which amounts without an associated currency are required to be output in the response to a request message. Until a possible future release to support transition to euro amounts are output in the UK Customs currency (GBP) and this is the default value.

RESPONSE-CRRN A3 The currency in which amounts without an associated currency are output in a response message. Until a possible future release to support transition to euro amounts are output in the UK Customs currency (GBP) and this is the default value.

REV-PAYBL n..12 (10.2) The sum of revenue from all Tax Lines on an Entry.

ROE AN..2 The code for a route (of examination). See Reference [6] for further detail. For a pre-lodged entry route “H” is returned unless the trader is authorised to see the probable route in which case route “Hn” is returned where “n” is the probable route. “Hn” routes are returned to an Inventory system in response to an anticipated arrival (EAA). The second character is used for Imports to identify the government department/agency responsible for examining the goods and/or where the documentation for the declaration is to be presented (NCH, Frontier and/or Trading Standards).

ROUTE-CNTRY A2 A country through which the goods have moved or are intended to move between the country of dispatch and the country of destination.

SCND-DAN 48 N7 The (deferment approval) number of the deferment account which is to be used for VAT revenue. See also FIR-DAN.

SCND-DAN-PFX 48 A1 Identifies whether SCND-DAN identifies an account owned by the Declarant or the Importer and if a specific authority or the standing authority is to be used. A – Declarant’s account; B – Consignee’s account, specific authority; C – Consignee’s account, standing authority.

SCTY-AMT n..12 (10.2) The amount covered by a Security Guarantee.

SCTY-TURN AN..12 The TURN of the trader who owns the Security account.

SEAL-ID D t(1)..20 Seal identifier.

SEAL-ID-LNG D A2 Language in which SEAL-ID is written.

Page 22: DES209: Data Element Definitions - gov.uk · DES209: DATA ELEMENT DEFINITIONS CROWN COPYRIGHT Filename: DES209_3 0.doc Page 7 of 29 Version: 3.0 Data Element Name SAD Format Notes

DES209: DATA ELEMENT DEFINITIONS

CROWN COPYRIGHT Filename: DES209_3 0.doc Page 22 of 29 Version: 3.0

Data Element Name SAD Format Notes BOX

SEG-CNT n..6 The number of segments in the message including the UNH and UNT segments.

SEG-ERROR-CODE AN..3 Identifies the error in the associated segment. The error reported on a segment may also apply to data in other related segments (i.e. for cross field validation the error may only be reported on one of the segments involved). The values are as defined for DATA-ERROR-CODE.

SEG-NO N..5 The number of the segment in the received order of the message to which the error applies – the UNH segment is number one; a value of zero indicates the segment is indeterminate.

SEG-TAG A3 The EDIFACT segment tag (3 character name).

SHED-OP-ID 30 AN3 Identifies the transit shed. Transit shed codes identify the shed operator and hence the shed at the GDS-LOCN or WHSE-ID.

SOE AN1 This item gives the most significant status of an Entry or a movement (in particular ‘permitted to progress’). The ICS code gives more detailed information identifying the state and how it was achieved as is required for finer levels of control on CHIEF. An Inventory system can use the ICS values but the SOE values are defined to be sufficient for an Inventory to control the movement of the consignment in conjunction with the ROE which identifies whether the entry is pre-lodged (‘H’ prefix) or arrived at the current location:

“D” – Departed from location (not from UK or EU see “8”) or stopped by Office of Exit in another Member State;

“E” – Error detected by another government system or arrival limit exceeded; “R” – Reprocessing error on arrival; “X” – Anticipated movement cancelled as a result of disassociation; “0” – declaration not submitted to CHIEF (i.e. no Entry); “1” – consignment subject to associated ROE; “2” – detained; “3” – queried; “4” – subject to Custom approval (of amendment to CAP Refund entry or Trader

response to Customs query); “5” – cancellation requested; “6” – Accounting rejection; “7” – permitted to progress; “8” – departed from UK or exit from the EU notified by another Member State, or, for a

prefinance claim, disposal into a warehouse or into processing; “9” – declaration cancelled or movement seized/destroyed/released to Queens

Warehouse (see ICS code). Where the consignment is subject to more than one of the conditions (e.g. queried and detained) the highest value is reported.

SPOFF-CITY 44h t(1)..35 Supervising Office address – city. Also used for fifth line of Custom Unit addresses defined on CHIEF.

SPOFF-CNTRY 44h A2 Supervising Office address – country.

SPOFF-CODE N4 The Customs Unit code for the Supervising Office.

SPOFF-NAME 44h t(1)..35 Supervising Office name.

SPOFF-POSTCODE 44h t(6)..9 Supervising Office address – postcode.

SPOFF-STREET 44h t(1)..35 Supervising Office address – street. Also used for first line of Custom Unit addresses defined on CHIEF.

SPOFF-STREET2 44h t(1)..35 Street address line for displaying Custom Unit addresses defined on CHIEF.

SPOFF-STREET3 44h t(1)..35 Street address line for displaying Custom Unit addresses defined on CHIEF.

SPOFF-STREET4 44h t(1)..35 Street address line for displaying Custom Unit addresses defined on CHIEF.

SSCTY-LDGD-REF AN..9 The identifying reference of the standing security account.

SSCTY-RAR AN1 A code identifying the reason for accounting rejection.

SSCTY-RAR-DESC t(1)..70 Text explanation of the ‘Reason for Accounting Rejection’ code used for information display purposes.

STAT-VAL n..12 (10.2) The total Statistical value for the entry expressed in the response currency (see RESPONSE-CRRN and REPORT-TYPE).

SUBMIT-TURN AN..12 Identifies the trader that submitted the declaration to CHIEF. The TURN is determined from the CHIEF access security parameter definition for the role used to establish the session (see Reference [1]) in which the declaration transaction occurs. Also known as the submitting trader. For payment by FAS, along with the EPU associated with the trader role, it identifies the FAS Account.

SYS-CAR t(1)..35 A Common Access Reference supplied by the Client system which if present in the request message is returned unaltered in the response message.

SYS-DATE N6 The date (YYMMDD) of preparation of the report.

SYS-MRN AN..14 A system generated unique Message Reference Number.

SYS-TIME N4 The time (HHMM) of preparation of the report.

Page 23: DES209: Data Element Definitions - gov.uk · DES209: DATA ELEMENT DEFINITIONS CROWN COPYRIGHT Filename: DES209_3 0.doc Page 7 of 29 Version: 3.0 Data Element Name SAD Format Notes

DES209: DATA ELEMENT DEFINITIONS

CROWN COPYRIGHT Filename: DES209_3 0.doc Page 23 of 29 Version: 3.0

Data Element Name SAD Format Notes BOX

TARIC-CMDTY-CODE 33 N8 or N10 or N8sN2 or A3

The commodity code as declared for Imports – see also EC-SUPPLEMENT and EC-SUPPLEMENT-2. The code may have leading and trailing zeros.

When deleting an item using the value “DEL”, the CPC item must also be specified and will be validated but otherwise ignored.

TAX-AMT-DEF n..12 (10.2) The amount of deferred revenue for the Entry.

TAX-AMT-FAS n..12 (10.2) Total amount of FAS revenue for the Entry.

TAX-RATE-ID 47c A..3 Specifies the rate at which the revenue has been calculated.

TDR-OWN-REF-ENT 7 t(1)..21 This is a commercial reference supplied by the declarant. The Declaration UCR/part (DECLN-UCR/ DECLN-PART-NO) should be used as the main trader’s reference to the declaration.

TDR-OWN-REF-ENT is output on various reports produced by CHIEF and other government systems (e.g. deferment account statement).

TDR-PRES-DTM N12 The date and time (CCYYMMDDHHMM) by which the Entry documentation should be presented by a Trader to Customs.

TOT-CSTMS-VAL n..12 (10.2) The total value for Customs Duty.

TOT-DUTY n..12 (10.2) The total Customs Duty payable.

TOT-NET-MASS n..14 (11.3) Total net mass for the goods covered by a declaration.

TOT-PKGS 6 N..7 The total number of packages making up the consignment covered by the declaration. For bulk goods TOT-PKGS should be set to 1. There is no check between the number of packages declared for each item (see PKG-COUNT) and the total. This allows for goods declared as several items being in the same packages(s) and the level of packaging declared at the item level (e.g. boxes) being different to that at the header level (e.g. pallets). For Inventory linked Import declarations the total packages must match the consignment details held by the Inventory system.

TOT-VAT n..12 (10.2) The total VAT payable.

TOT-VAT-VAL n..12 (10.2) The total value for VAT.

TRPT-CHGE-MOP A1 The Method of Payment for the transport charges.

TRPT-CNTRY 21 A2 The country code for the nationality of the actual means of transport.

TRPT-ID 21 t(1)..27 Identifier for the vessel/flight in which the goods cross the border.

TRPT-ID-INLD 18 t(1)..27 Inland transport identity.

TRPT-ID-INLD-LNG 18 A2 Language in which TRPT-ID-INLD is written.

TRPT-MODE-CODE 25 N1 This is the actual mode of transport at the border.

TRPT-MODE-INLD 26 N1 The code for the Inland Mode of Transport. This is required only where Customs formalities are carried out away from the Community frontier.

TTY-CODE 47a AN3 Identifies the category of revenue being declared.

TTY-OVR-CODE 47c A3 Identifies an exception to the normal calculation of the associated revenue.

UCR See DECLN-UCR & MASTER-UCR

A unique consignment reference (UCR) which may identify either a consolidation (see MASTER-UCR) or a declaration (see DECLN-UCR).

For Export entries a declaration can also be identified by the latest MRN allocated to the entry. This applies to the request messages, arrival notifications and departure notifications but not to association (message code “EAC”).

UCR-PART-NO N..3A..1 See DECLN-PART-NO (used in UKCINV where part number occurs at two levels).

UNDG-CODE N4 UN Dangerous Goods code.

USER-REF AN..12 Identifies the user to which the report is destined. For Trade users it is the Agent’s Role.

VAL-ADJT-CODE 45 AN1 The type of valuation adjustment used.

VAL-MTHD-CODE 43 N1 A code identifying the valuation method used.

VAT-ADJT 68 n..12 (10.2) Additional costs that are included in VAT calculations expressed in the response currency (see RESPONSE-CRRN and REPORT-TYPE).

VAT-ADJT-AC 68 n..12 (10.2) VAT value adjustment in the currency specified in VAT-ADJT-CRRN.

VAT-ADJT-CRRN 68 A3 The code for the currency in which VAT-ADJT-AC is declared.

VAT-ADJT-EXCH 68 n..12 (6.8) The exchange rate applicable to VAT Adjustment (VAT-ADJT-AC) on an Import Entry.

END OF SECTION 2

Page 24: DES209: Data Element Definitions - gov.uk · DES209: DATA ELEMENT DEFINITIONS CROWN COPYRIGHT Filename: DES209_3 0.doc Page 7 of 29 Version: 3.0 Data Element Name SAD Format Notes

DES209: DATA ELEMENT DEFINITIONS

CROWN COPYRIGHT Filename: DES209_3 0.doc Page 24 of 29 Version: 3.0

3. Glossary and References

3.1 Glossary

See USM 102 – CHIEF GLOSSARY AND ABBREVIATIONS

3.2 References

RefNo.

Title Document reference

1. TIS : ELECTRONIC DATA INTERCHANGE (EDI) SPECIFICATION DES 150

2. TIS : EDI FOR IMPORTS DES 205

3. TIS : EDI FOR EXPORTS DES 208

4. TIS : EDI FOR CONSIGNMENT AND MOVEMENT CONTROL DES 242

5. TIS : EDI FOR REQUESTS AND REPORTS DES 222

6. COMMON ENTRY TRADE USER GUIDE USM 239

7. INTEGRATED TARIFF OF THE UNITED KINGDOM HMRC

END OF SECTION 3

Page 25: DES209: Data Element Definitions - gov.uk · DES209: DATA ELEMENT DEFINITIONS CROWN COPYRIGHT Filename: DES209_3 0.doc Page 7 of 29 Version: 3.0 Data Element Name SAD Format Notes

DES209: DATA ELEMENT DEFINITIONS

CROWN COPYRIGHT Filename: DES209_3 0.doc Page 25 of 29 Version: 3.0

APPENDICES

Page 26: DES209: Data Element Definitions - gov.uk · DES209: DATA ELEMENT DEFINITIONS CROWN COPYRIGHT Filename: DES209_3 0.doc Page 7 of 29 Version: 3.0 Data Element Name SAD Format Notes

DES209: DATA ELEMENT DEFINITIONS

CROWN COPYRIGHT Filename: DES209_3 0.doc Page 26 of 29 Version: 3.0

Appendix A Declaration UCR/Part Check Letter Algorithm

A checksum is generated for the Declaration UCR and (optional) part by multiplying a weight for each character with a weight for its position in the field(s). The UCR and part number are separately processed as variable length data elements, the former of 1-35 characters and the latter of 0-3 digits.

The ‘character weight’ is its offset (0 to 40) in the string:

0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ-/(:)

modulo 22 plus 1 (i.e. between 1 and 22), with the character order chosen to prevent characters that are readily confused from having the same weights – for example, ‘5’ has weight 6 whilst ‘S’ has weight 7.

The ‘position weight’ is the character offset in the UCR (0 to 34) or in the part number (0 to 2) modulo 22 plus 1.

[Note that the plus 1 for both position and character weights ensures that all characters input contribute to the final value.]

The check letter is generated from the product of these weights modulo 23, mapping the result directly to characters ABCDEFGHJKLMNPQRTUVWXYZ (e.g. 0 to A, 1 to B). Characters I, O and S are avoided as check letters since they are readily confused with the digits 1, 0 and 5.

The function below (written in C) may be used to determine the check letter from a UCR and optional part number. This can then be used either to check the value supplied in DECLN-PART-NO or to generate the value to be appended to DECLN-PART-NO for output.

The function is generally called twice, first for the UCR and then again for the part number. If the latter is null the second call may be omitted, and the result returned from the first call used.

The function validates the UCR for permitted characters and the part number for digits.

The code is independent of EBCDIC and ASCII, using local literal strings to decode or encode characters.

Page 27: DES209: Data Element Definitions - gov.uk · DES209: DATA ELEMENT DEFINITIONS CROWN COPYRIGHT Filename: DES209_3 0.doc Page 7 of 29 Version: 3.0 Data Element Name SAD Format Notes

DES209: DATA ELEMENT DEFINITIONS

CROWN COPYRIGHT Filename: DES209_3 0.doc Page 27 of 29 Version: 3.0

#include "string.h"

char generate_check_character

/*

The function is called twice – first with the UCR and then again with the part

number. The checksum accumulated by the first call is incremented by the result

of the second. The UCR can contain any valid character as defined in the TIS;

the part number can only contain digits. The optional result parameter can be

used to identify if an invalid character was found.

If there is no part number the function need not be called a second time and the

check character returned by the first call is correct. Alternatively it may be

called again with length set zero.

*/

(int part_number , /* 0 for UCR (first call),

1 for part number (second call) */

char * string , /* the characters to check */

int length , /* the number of characters in string */

int * result) /* validation result */

{ int i ;

static long checksum ; /* accumulated checksum */

static const char * allowed

= "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ-/(:)";

/* permitted characters in weight order */

static const char * encode

= "ABCDEFGHJKLMNPQRTUVWXYZ" ; /* check characters */

if (result) /* result parameter is optional */

* result = 0 ; /* initialize SUCCESS */

if ( ! part_number ) checksum = 0 ; /* initialize checksum */

/* for each char in string */

for (i = 0 ; i < length ; ++ i)

/* look for char in allowed string */

{ char * p = strchr (allowed , string [i]) ;

/* check found and valid */

/* (p is null if not found and for part_number must be a digit) */

if (p && (! part-number || p < allowed + 10))

checksum += (i % 22 + 1) * ((p - allowed) % 22 + 1) ;

else if (result) /* result parameter is optional */

* result = 1 ; /* invalid character */

}

return encode [checksum % 23] ; /* return encoded check */

}

END OF APPENDIX A

Page 28: DES209: Data Element Definitions - gov.uk · DES209: DATA ELEMENT DEFINITIONS CROWN COPYRIGHT Filename: DES209_3 0.doc Page 7 of 29 Version: 3.0 Data Element Name SAD Format Notes

DES209: DATA ELEMENT DEFINITIONS

CROWN COPYRIGHT Filename: DES209_3 0.doc Page 28 of 29 Version: 3.0

Appendix B: Document Control

Document Version History:

Version Date Comments

See Issue 1.7 for previous change history.

2.0 26/03/2009 Major changes to remove the pre-harmonised elements and definitions and replace them with the harmonised ones from DES 238 Issue 2.1.

Only significant changes from the definitions in DES 209 Issue 1.7 or DES 238 Issue 2.1 are sidelined.

The format of EC-SUPPLEMENT and EC-SUPPLEMENT2 changed from AN1N3 to AN4 to allow for the future use of fully alphanumeric codes.

The description of HDR-DOC-CODE and ITEM-DOC-CODE changed to reflect that EU document codes may in the future be A1AN3 rather than A1N3.

2.1 21/04/2009 Additional notes on currency of invoicing (INV-CRRN) specifying its use for Exports.

2.2 07/12/2009 Removed BT logo and BT specific details

2.3 05/04/2011 Changes in IES maintenance release 27 March 2011

EARS 13026048:

Update definition of SOE value of 4 to note that it can only apply to CAP Refund Export Entries.

EARS 13864569 & EARS 15218518:

MASTER-ROE. Update the order of Route severity to make ‘0’ the most severe Route. Also state that ‘0’ is a temporary Route that should eventually be replaced for both declarations and Master Movements.

[Note. application code changes for EARS 15218518 will be implemented in the IES maintenance release planned for July 2011].

2.4 02/06/2011 EARS 15218518:

Further additions to the description of MASTER-ROE.

2.5 25/10/2011 EARS 16838450:

Addition to the description of ITEM-VAT-VAL to also describe ‘chargeable revenue’.

2.6 15/03/2012 EARS 15261734:

Item PROC-INST. Amend description of ‘RTF’ to indicate for which Entry Types it doesn’t apply.

EARS 17786216

Update the descriptions for ITEM-NET-MASS, ITEM-SUPP-UNITS and ITEM-THRD-QTY.

Page 29: DES209: Data Element Definitions - gov.uk · DES209: DATA ELEMENT DEFINITIONS CROWN COPYRIGHT Filename: DES209_3 0.doc Page 7 of 29 Version: 3.0 Data Element Name SAD Format Notes

DES209: DATA ELEMENT DEFINITIONS

CROWN COPYRIGHT Filename: DES209_3 0.doc Page 29 of 29 Version: 3.0

Version Date Comments

2.7 18/10/2012 CR56

Increase in size of Previous Document Reference (PREV-DOC-REF) from current 20 characters to 35 characters.

CR66

Item ENT-TYPE. Add ‘SASP’ for Exports, replace ‘SEA’ by ‘SASP’ for Imports.

EARS 19787506 - Trade (AFSS) request for permitted character sets for text Data Items.

Text field formats added at the start of Section 2 and the appropriate format identified for text data items in the Table.

Updates as a result of internal review.

2.8 03/12/2013 Text field formats at the start of Section 2. Changes to the listing of the text field character sets to aid clarity, as requested informally at the Aspire/AFSS meeting of 16/10/2013.

EARS00020195753. Notes for Data Element REPORTS-RQD. Additional text pointing out that REPORTS-RQD can be specified on a Consolidation Arrival and some re-wording of existing text to increase accuracy and clarity.

3.0 22/08/2014

22/10/2014

CR85

Update notes for Data Element ROE to reference Trading Standards.

EARS 24398782

Notes for Data Element MASTER-UCR. Additional text explaining that the Inventory Consignment Reference part of Master-UCR for Imports allows embedded spaces but not leading space(s).

Approved

Document Review Record

DES209 Review Record

Document Reviewed By:

Name Responsibility

Glen Robe BT Change

Bernadette Holden BT Change

CSG Team CHIEF Development

Document Approved By:

Glen Robe

Source File Location

DES209

END OF DOCUMENT