dentsu aegis network data dictionary for ......eu secondary data dictionary for economic operators,...

Dentsu Aegis Network

DATA DICTIONARY FOR ECONOMIC OPERATORS v1.1

This document details the Data Dictionary for EU Secondary Repository and Router.

EU Secondary Data Dictionary For Economic Operators, Version 1.1 2 / 80

Summary of changes

Date Version Done by Comment

17.01.2019 0.1 Dentsu Aegis Network Internal Draft

05.02.2019 0.2 Dentsu Aegis Network First Draft shared with stakeholders

21.02.2019 1.0 Dentsu Aegis Network First release

11.03.2019 1.1 Dentsu Aegis Network Minor changes

Distribution

Date Version Submitted to

05.02.2019 0.2 Mail to stakeholder

21.02.2019 1.0 Published

11.03.2019 1.1 Published


Legal Notice

The document shall be used for Implementing Regulation (EU) 2018/574 implementation

purposes only.

The document shall not be modified, truncated nor published.

Any logos or drawings related to the Dentsu Aegis are trademarks, registered trademarks or

official marks of Dentsu Aegis Network.


Table of Contents

1 INTRODUCTION ................................................................................................................... 6

2 DATA DESCRIPTION ............................................................................................................. 7

2.1 DATA TYPES ...............................................................................................................................7 2.2 PRIORITY TYPES ..........................................................................................................................9 2.3 CARDINALITY TYPES ..................................................................................................................10 2.4 MINIMUM DATA MODEL .............................................................................................................10

2.4.1 Event .................................................................................................................................11 2.4.2 Product .............................................................................................................................12 2.4.3 TobaccoProductItem .........................................................................................................13 2.4.4 UniqueIdentifier .................................................................................................................15

2.5 REGISTERED ENTITIES ................................................................................................................16 2.5.1 EconomicOperator ............................................................................................................16 2.5.2 Facility ...............................................................................................................................17 2.5.3 ManufacturingMachine ......................................................................................................18

2.6 MASTER DATA TYPES ................................................................................................................19 2.6.1 Country .............................................................................................................................19 2.6.2 DeactivationReasonType ...................................................................................................24 2.6.3 EventState .........................................................................................................................24 2.6.4 EventType .........................................................................................................................25 2.6.5 FacilityType .......................................................................................................................27 2.6.6 InvoiceType .......................................................................................................................27 2.6.7 NotificationType ................................................................................................................27 2.6.8 PaymentType ....................................................................................................................27 2.6.9 RecallReasonType .............................................................................................................28 2.6.10 RegisterStatus ..............................................................................................................28 2.6.11 TobaccoProductType ....................................................................................................28 2.6.12 TransportMode .............................................................................................................28 2.6.13 UniqueIdentifierState .....................................................................................................29 2.6.14 UniqueIdentifierType .....................................................................................................29

3 MESSAGES ........................................................................................................................ 30

3.1 MESSAGE TYPES TO BE EXCHANGED ...........................................................................................30 3.1.1 Optional II2MN II2DW interfaces........................................................................................31 3.1.2 Message and endpoints ....................................................................................................31

3.2 COMMON SCHEMA ELEMENTS ....................................................................................................31 3.2.1 Basic information block concerning the request ................................................................31 3.2.2 Basic information block concerning the response ..............................................................32 3.2.3 Common Error codes ........................................................................................................32

3.3 IDENTIFIER CODES FOR ECONOMIC OPERATORS, FACILITIES AND MACHINES MESSAGES ......................32 3.3.1 REO - (1.1) Registration of an Economic operator .............................................................32 3.3.2 REOD - Data Registration of an Economic operator ..........................................................34 3.3.3 CEO – (1.2) Correction for an economic operator identifier code ......................................38 3.3.4 DEO – (1.3) De-registration of economic operator identifier code. .....................................40 3.3.5 RFAD – (1.4) Request for a facility identifier code ..............................................................42 3.3.6 CFA – (1.5) Correction of information concerning the facility identifier code ......................44 3.3.7 DFA – (1.6) De-registration of facility identifier code ..........................................................47

3.4 UNIQUE IDENTIFIERS MESSAGES .................................................................................................49 3.4.1 ISU – (2.1) Request for unit level UIs .................................................................................49 3.4.2 IRU – Message to report the issuance of serial numbers at unit packet level .....................51 3.4.3 ISA – (2.2) Request for aggregated level UIs .....................................................................53 3.4.4 IRA – Request for reporting the issuance of serial numbers at aggregated level ................54 3.4.5 IDA – (2.3) Request for deactivation of UIs ........................................................................56 3.4.6 EUA – (3.1) Application of unit level UIs on unit packets ....................................................58 3.4.7 EPA – (3.2) Application of aggregated level UIs on aggregated packaging ........................59


3.4.8 EDP – (3.3) Dispatch of tobacco products from a facility ...................................................61 3.4.9 ERP – (3.4) Arrival of tobacco products at a facility ...........................................................64 3.4.10 ETL – (3.5) Trans-loading ..............................................................................................65 3.4.11 EUD – (3.6) Disaggregation of aggregated level UIs .....................................................67 3.4.12 EVR – (3.7) Report the delivery carried out with a vending van to retail outlet ...............69

3.5 TRANSACTIONAL EVENTS ...........................................................................................................71 3.5.1 EIV – (4.1) Issuing of the invoice ........................................................................................71 3.5.2 EPO – (4.2) Issuing of the order number ...........................................................................73 3.5.3 EPR – (4.3) Receipt of the payment ...................................................................................75

3.6 RECALL ...................................................................................................................................77 3.6.1 RCL – (5.0) Recalls of requests, operational and transactional messages .........................77

4 LIST OF ERROR CODES ...................................................................................................... 79

4.1 SECURITY ERRORS ....................................................................................................................79 4.2 PROCESSING ERRORS ...............................................................................................................79 4.3 VALIDATION ERRORS .................................................................................................................79


1 Introduction This document defines a data dictionary for Dentsu Tracking System. It will include information

about data base entities and flows, authentication, operational and transactional methods,

security edge case, router definition, error messages, registration process and an overall

connection diagram.

Note: For the description of the Repositories system components, architecture, processes, data

flows, list of interfaces and messages, see the List of Specifications document.


2 Data description 2.1 Data types

There are some types used along the document, which need to be defined.

Data Type Description Type Example or regular

expression

ARC Administrative Reference Code (ARC) or any

successive code adopted under the Excise

Movement and Control System (EMCS)

Text(30) 15GB0123456789ABCDEF0'

aUI Aggregated level unique identifier coded with:

either The invariant set of ISO646:1991 and

composed of four blocks: (a) ID issuer's prefix

in accordance with ISO15459-2:2015, (b)

serialization element in the format established

by the ID issuer, (c) tobacco facility identifier

code following the Data Type: FID and (d)

timestamp following the Data Type: Time(s) or

The invariant set of ISO646:1991 forming a

code structured in accordance with

ISO15459-1:2014 or ISO15459-4:2014 (or

their latest equivalent))

Text(100)

Boolean Boolean value Boolean • 0 (false/disabled)

• 1 (true/enabled)

Component A data type defined in the data dictionary Aggregation

Country Country name coded with ISO-3166-1:2013

alpha-2 (or its latest equivalent)

Text(2) 'DE'

Currency Currency name coded with ISO 4217:2015 (or

its latest equivalent)

Text(3) 'EUR'

Date A UTC data in text corresponding to the

following format: YYYY-MM-DD

Text(10) E.g. '2017-03-31'

Decimal Number values, decimal allowed Decimal E.g. '1' or '22.2' or '333.33'

Email Maximum 80 characters Text(80) ^['_a-z0-9-]+(\.['_a-z0-

9]+)*@[a-z0-9]+(\.[a-z0-

9]+)*\.(([a-z]{2,3}))$

EOID Economic operator identifier code

corresponding to the format established by ID

Text(50)


issuer coded with the invariant set of

ISO646:1991

EDOI starts with the alphanumeric characters

that constitute the ID issuer identification code,

followed by alphanumeric sequence which is

unique within the code pool of the ID issuer.

FID Tobacco facility identifier code corresponding

to the format established by ID issuer coded

with the invariant set of ISO646:1991

Text(50)

Integer Rounded number values, no decimal numbers Integer E.g. '1' or '22' or '333'

IIID ID Issuer code in line with the issuing agency

codes of ISO/IEC 15459

Text(35) E.g. ‘FTR’

ITU Individual transport unit code (e.g. SSCC)

generated in accordance with ISO15459-

1:2014 (or its latest equivalent)

'00791234560000000018'

List Must be only one of the values present in the

'Values' column

MID Machine identifier code corresponding to the

format established by ID Issuer coded with the

invariant set of ISO646:1991

Text(50)

MRN Movement Reference Number (MRN) is a

unique customs registration number. It

contains 18 digits and is composed of the

following elements: (a) last two digits of the

year of formal acceptance of export movement

(YY), (b) country name coded with ISO3166-

1:2013 alpha-2 (or its latest equivalent) of the

Member State to which the declaration was

sent, (c) unique identifier for entry/import per

year and country, and (d) check digit.

Text(18) '19IT9876AB88901235'

PN Product number – numeric identifier used in

the EUCEG system to identify product

presentations (e.g. GTIN (Global Trade

Identification Number) of the product)

Text(30) '00012345600012'

SEED Excise number composed of: (a) country name

coded with ISO-3166-1:2013 alpha-2 (or its

latest equivalent) (e.g. 'LU') and (b) eleven

alphanumeric characters, if needed, padded to

the left with zeroes (e.g. '00000987ABC').

Text(13) LU00000987ABC'


Serial Number corresponding with the invariant set of

ISO646:1991 used for serialisation

SSCC SSCC-18 container code generated in line

with ISO6346:1995 (or its latest equivalent)

Text(20) 00791234560000000018

Text (X) Alphanumeric values coded with ISO8859-

15:1999 limited to X characters

E.g. 'Abcd' or

'123455588845'

Time(s) UTC (Coordinated Universal Time) time in the

following format: YYMMDDhh

Text(8) '19071619'

Time(L) UTC (Coordinated Universal Time) time in the

following format: YYYY-MM-DDThh:mm:ssZ

Text(34) E.g. '2020-03-31T23:16:45Z'

TPID Tobacco Product Identifier (TP-ID) – numeric

identifier used in the EU-CEG system in the

format: NNNNN-NNNNNNN

Text(14) 02565-16-00230'

upUI(L) Unit packet level unique identifier coded with

the invariant set of ISO646:1991 and

composed of three blocks: (a) ID Issuer's

prefix in line with ISO154592:2015, (b) middle

block in the format established by ID Issuer

and (c) timestamp following the Data Type:

Time(s)

upUI(s) Unit packet level unique identifier coded with

the invariant set of ISO646:1991 and

composed of two blocks: (a) ID Issuer's prefix

in line with ISO154592:2015 and (b)

serialisation element in the format established

by ID issuer (i.e. UI made visible in the human

readable format on the unit packets)

2.2 Priority types

Type Explanation

Mandatory

(M)

The variable must be completed.

Optional

(O)

The variable is for optional fields which could be

filled depending on the record status or type.


2.3 Cardinality types

Type Explanation

Simple (S) Single value

Multiple

(M)

Multiple values

2.4 Minimum Data model

The minimal data model describes the contents, format, and structure of a database and the

relationship between its different elements.

Note: the Minimum Data Model may be extended.


2.4.1 Event

Field Description Data Type Mandatory Comments

Id (PK) Internal identification number of

this event

Integer M

StateID The state of the event EventState

ID

M EventState

Type

TypeID The type of the event EventType ID M EventType

Type

EventDateTime Date and Time when the event

occurs

Time(L) M

Content Full content of the event. Component M

Aggrigation

ParentId

EventIdChildrenIds

Event

Event_ID (PK)

StateIDTypeIDEventDateTimeUniqueIdentifiers

AggrigationVersion

EventIdParentId

EnonomicOperator

Id

CodeCreatedOnLastUpdatedOnRegisterStatusIssuerRegisteredNameAlternativeNameAddress

VATNumber

Country

HasVATNumberEmail

TaxNumberHasExciseNumberExciseNumberIsOnBehalfOfOnBehalfOf

Facility

Id

EconomicOperatorIdCodeCreatedOnLastUpdatedOnRegisterStatusIssuerIssuerCountryFacilityTypeOtherTypeHasTaxStatusHasExciseNumberExciseNumberIsOnBehalfOfOnBehalfOf

ManufacturingMachine

Id

FacilityIdCodeCreatedOnLastUpdatedOnStatusIssuerProducerModelSerialNumberCapacity

Product

Id

OptimizedIdProductTypeOtherTypeBrandDescriptionIdentifier

ProductItem

Id

ProductIdManufacturerIdImporterIdManufacturingMachineIdFacilityIdQuantityIntendedMarketIsCrossBorderIntendedRouteIsImportManufacturingDateSerialShortIdentifier

UniqueIdentifier

Id

ParentId

Type

ProductItemIdState

ProvidedOn

GenerationRequestedOn

ComplianceForApplication

AnticipatedUsageOn

ComplianceAggregationVersionsEvents

TP_ID

IssuerNotificationTime


2.4.2 Product

Field Description Data

Type

Mandatory Comments

Id (PK) Internal identification

number. This number is

generated by the ID Issuer

Text(4) M

TP_ID Tobacco Product Identifier

(TP-ID) – numeric identifier

used in the EU-CEG

system in the format:

NNNNN-NNNNNNN

TPID M

ProductType Type of tobacco product Integer M TobaccoProductType

Type

OtherType Description of other type

of tobacco product

Text M, if Product_Type =

11 (other tobacco

product)

Brand Brand of tobacco product Text(100) M

Description The description of the

tobacco product

Text(100)

Identifier Additional identifier used

to refer to the product

(e.g. GTIN or other

identification number

provided by the

manufacturer)

Text(20)


2.4.3 TobaccoProductItem


Id (PK) The

identification

code (i.e.

unique

identifier) of the

product item as

required by

Article 15(2)

upUI(L) M

ProductId (FK) The

identification

code of the

product

Product Id M

ManufacturerId (FK) Identifier of the

manufacturer

of this tobacco

product

MID M

ImporterId (FK) The identifier of

the importer

into the Union,

if applicable

EOID

ManufacturingMachine_Id

(FK)

The identifier of

the

manufacturing

machine

ManufacturingMachine

MID

M

FacilityId (FK) The identifier of

the

manufacturing

facility. This

date is the one

used for

requesting the

issuance of

codes.

Facility FID M

IntendedMarket Intended

country of retail

sale

Country M

IsCrossBorder Indication if the

product is

intended to be

moved across

country

boarders with

terrestrial

transport

Boolean M 0 – No

1 – Yes


IntendedRoute The first

country of

terrestrial

transport after

the product

leaves the

Member State

of

manufacturing

or the Member

State of

importation

Country M, if

Intended_Route1

= 1

IsImport Indication if the

product is

imported into

the EU

Boolean M 0 – No

1 – Yes

ManufacturingDate Date of

manufacturing.

This date is the

one used for

requesting the

issuance of

codes

Time(s) M

Serial Serial number

provided by the

ID Issuer

Serial M

ShortIdentifier Short unique

identifier

upUI(s)


2.4.4 UniqueIdentifier


ID (PK) Unique

identifier of

the unit

packets or

aggregated

packaging

level

Text(50) M

State The state of

the unique

identifier

UniqueIdentifierState

ID

M UniqueIdentifierState

Type

Type The type of

the unique

identifier

UniqueIdentifierType

ID

M UniqueIdentifierType

Type

GenerationRequestedOn Date and

Time when

the

generation

was

requested

Time (L) M

AnticipatedUsageOn Date and

Time when

the

generator

intends to

use it

Time (L) M

IssuerNotificationTime Date and

Time when

the

generation

was notified

to the

storage

Time(L) M

ParentId The

identifier of

the parent

element that

contains this

item

UniqueIdentifier ID O


2.5 Registered entities

2.5.1 EconomicOperator


Type

Mandatory Comments

Id (PK) Economic operator identifier

code. This number shall be

unique at EU level.

EOID M

Code Confirmation code in

response to the registration

request. It is generated by

the ID Issuer solution.

Text(20) M

CreatedOn Timestamp when the

registration has been

accomplished

Time(L) M

LastUpdatedOn Timestamp of the last

change on the register

Time(L)

RegisterStatus Status of the registration Integer M RegisterStatus Type

Issuer Identification number of the

ID Issuer solution that has

processed the registration

IIID M

RegisteredName Economic operator's

registered name

Text(100) M

AlternativeName Economic operator's

alternative or abridged

name

Text(100)

Address Economic operator's

address – street name,

house number, postal code,

city

Text(300) M

Country Economic operator's country

of registration

Country M Country Type

Email Economic operator's email

address; used to inform

about registration process,

incl. subsequent changes

and other required

correspondence

Email M

HasVATNumber Indication of the VAT

registration status

Boolean M 0 – No VAT

registration

1 – VAT number

exists

VATNumber Economic operator's VAT

number

Text(20) M, if VAT_R = 1


TaxNumber Economic operator's tax

registration number

Text(20) M, if VAT_R = 0

HasExciseNumber Indication if the economic

operator has an excise

number issued by the

competent authority for the

purpose of identification of

persons/premises

Boolean M 0 – No SEED

number

ExciseNumber Economic operator's excise

number issued by the



persons/premises

SEED M, if

EO_ExciseNumber1

= 1

IsOnBehalfOf Indication if the registration

is made on behalf of a retail

outlet operator not involved

otherwise in the tobacco

trade

Boolean M

OnBehalfOf Identifier of the economic

operator that acts on behalf

of a retail outlet operator not

involved otherwise in the

tobacco trade

EOID M, if Reg_3RD = 1

2.5.2 Facility


Type

Mandatory Comments

Id (PK) Facility identifier code FID M

EconomicOperatorId

(FK)

The identification number of the

economic operator that owns this

facility

EOID M

Code Confirmation code in response to

the registration request. It is


solution.

Text(20) M

CreatedOn Timestamp when the registration

has been accomplished

Time(L) M

LastUpdatedOn Timestamp of the last change on

the register

Time(L)

RegisterStatus Status of the registration Integer M RegisterStatus

Type

Issuer Identification number of the ID

Issuer solution that has processed

the registration

IIID M

Issuer Facility address – street name,

house number, postal code and

city

Text M


Country Facility country Country M Country Type

FacilityType Type of facility Integer M FacilityType

Type

OtherType Description of other facility type Text M, if F_Type = 4

HasTaxStatus Indication if a part of the facility

has a tax (excise) warehouse

status

Boolean M 0 – No

1 – Yes

HasExciseNumber Indication if the facility has an

excise number issued by the



persons/premises

Boolean M 0 – No SEED

number

ExciseNumber Facility's excise number issued by

the competent authority for the


persons/premises

SEED M, if F_Excis

eNumber1 = 1

IsOnBehalfOf Indication if the registration is

made on behalf of a retail outlet

operator not involved otherwise in

the tobacco trade

Boolean M 0 – No

1 – Yes

(possible only if

F_Type = 3)

OnBehalfOf Identifier of the economic operator

that acts on behalf of the retail

outlet operator not involved

otherwise in the tobacco trade

EOID M, if Reg_3RD =

1

2.5.3 ManufacturingMachine


Type

Mandatory Comments

Id (PK) The identification number of the

manufacturing machine. This

number is issued by the ID

Issuer solution, which shall

ensure that the combination of

M_ID, F_ID and EO_ID is

unique at EU level.

MID M

FacilityId The identification number of the

facility that owns this machine

FID M

Code Confirmation code in response

to the registration request. It is


solution

Text(20) M

CreatedOn Timestamp when the

registration has been

accomplished

Time(L) M

LastUpdatedOn Timestamp of the last change

on the register

Time(L)

Status Status of the registration Integer M RegisterStatus

Type


Issuer Identification number of the ID

Issuer solution that has

processed the registration

IIID M

Producer Machine producer Text(20) M

Model Machine model Text(20) M

SerialNumber Machine serial number Text(20) M

Capacity Maximum capacity over 24hour

production cycle expressed in

unit packets

Integer M

2.6 Master Data Types

2.6.1 Country

Code Value

AD Andorra

AE United Arab Emirates

AF Afghanistan

AG Antigua and Barbuda

AI Anguilla

AL Albania

AM Armenia

AO Angola

AQ Antarctica

AR Argentina

AS American Samoa

AT Austria

AU Australia

AW Aruba

AX Åland Islands

AZ Azerbaijan

BA Bosnia and Herzegovina

BB Barbados

BD Bangladesh

BE Belgium

BF Burkina Faso

BG Bulgaria

BH Bahrain

BI Burundi

BJ Benin

BL Saint Barthélemy

BM Bermuda

BN Brunei Darussalam

BO Bolivia (Plurinational State of)

BQ Bonaire, Sint Eustatius and Saba

BR Brazil

BS Bahamas


BT Bhutan

BV Bouvet Island

BW Botswana

BY Belarus

BZ Belize

CA Canada

CC Cocos (Keeling) Islands

CD Congo, Democratic Republic of the

CF Central African Republic

CG Congo

CH Switzerland

CI Côte d'Ivoire

CK Cook Islands

CL Chile

CM Cameroon

CN China

CO Colombia

CR Costa Rica

CU Cuba

CV Cabo Verde

CW Curaçao

CX Christmas Island

CY Cyprus

CZ Czechia

DE Germany

DJ Djibouti

DK Denmark

DM Dominica

DO Dominican Republic

DZ Algeria

EC Ecuador

EE Estonia

EG Egypt

EH Western Sahara

ER Eritrea

ES Spain

ET Ethiopia

FI Finland

FJ Fiji

FK Falkland Islands (Malvinas)

FM Micronesia (Federated States of)

FO Faroe Islands

FR France

GA Gabon

GB United Kingdom of Great Britain and Northern

Ireland

GD Grenada

GE Georgia

GF French Guiana

GG Guernsey


GH Ghana

GI Gibraltar

GL Greenland

GM Gambia

GN Guinea

GP Guadeloupe

GQ Equatorial Guinea

GR Greece

GS South Georgia and the South Sandwich Islands

GT Guatemala

GU Guam

GW Guinea-Bissau

GY Guyana

HK Hong Kong

HM Heard Island and McDonald Islands

HN Honduras

HR Croatia

HT Haiti

HU Hungary

ID Indonesia

IE Ireland

IL Israel

IM Isle of Man

IN India

IO British Indian Ocean Territory

IQ Iraq

IR Iran (Islamic Republic of)

IS Iceland

IT Italy

JE Jersey

JM Jamaica

JO Jordan

JP Japan

KE Kenya

KG Kyrgyzstan

KH Cambodia

KI Kiribati

KM Comoros

KN Saint Kitts and Nevis

KP Korea (Democratic People's Republic of)

KR Korea, Republic of

KW Kuwait

KY Cayman Islands

KZ Kazakhstan

LA Lao People's Democratic Republic

LB Lebanon

LC Saint Lucia

LI Liechtenstein

LK Sri Lanka

LR Liberia


LS Lesotho

LT Lithuania

LU Luxembourg

LV Latvia

LY Libya

MA Morocco

MC Monaco

MD Moldova, Republic of

ME Montenegro

MF Saint Martin (French part)

MG Madagascar

MH Marshall Islands

MK Macedonia, the former Yugoslav Republic of

ML Mali

MM Myanmar

MN Mongolia

MO Macao

MP Northern Mariana Islands

MQ Martinique

MR Mauritania

MS Montserrat

MT Malta

MU Mauritius

MV Maldives

MW Malawi

MX Mexico

MY Malaysia

MZ Mozambique

NA Namibia

NC New Caledonia

NE Niger

NF Norfolk Island

NG Nigeria

NI Nicaragua

NL Netherlands

NO Norway

NP Nepal

NR Nauru

NU Niue

NZ New Zealand

OM Oman

PA Panama

PE Peru

PF French Polynesia

PG Papua New Guinea

PH Philippines

PK Pakistan

PL Poland

PM Saint Pierre and Miquelon

PN Pitcairn


PR Puerto Rico

PS Palestine, State of

PT Portugal

PW Palau

PY Paraguay

QA Qatar

RE Réunion

RO Romania

RS Serbia

RU Russian Federation

RW Rwanda

SA Saudi Arabia

SB Solomon Islands

SC Seychelles

SD Sudan

SE Sweden

SG Singapore

SH Saint Helena, Ascension and Tristan da Cunha

SI Slovenia

SJ Svalbard and Jan Mayen

SK Slovakia

SL Sierra Leone

SM San Marino

SN Senegal

SO Somalia

SR Suriname

SS South Sudan

ST Sao Tome and Principe

SV El Salvador

SX Sint Maarten (Dutch part)

SY Syrian Arab Republic

SZ Eswatini

TC Turks and Caicos Islands

TD Chad

TF French Southern Territories

TG Togo

TH Thailand

TJ Tajikistan

TK Tokelau

TL Timor-Leste

TM Turkmenistan

TN Tunisia

TO Tonga

TR Turkey

TT Trinidad and Tobago

TV Tuvalu

TW Taiwan, Province of China

TZ Tanzania, United Republic of

UA Ukraine

UG Uganda


UM United States Minor Outlying Islands

US United States of America

UY Uruguay

UZ Uzbekistan

VA Holy See

VC Saint Vincent and the Grenadines

VE Venezuela (Bolivarian Republic of)

VG Virgin Islands (British)

VI Virgin Islands (U.S.)

VN Viet Nam

VU Vanuatu

WF Wallis and Futuna

WS Samoa

YE Yemen

YT Mayotte

ZA South Africa

ZM Zambia

ZW Zimbabwe

2.6.2 DeactivationReasonType

Value Name

1 Product destroyed

2 Product stolen

3 UI destroyed

4 UI stolen

5 UI unused

6 Other

2.6.3 EventState

Value Name Description

1 Received Initial state. The Data Acquisition component has just received

the event and stores it.

2 Valid The Data Processing component has verified that the format

and contents are correct.

3 Invalid The Data Processing component has found some issues

regarding the format or the contents. Event is promoted to

invalid for further analysis by the storage provider.

4 Routed The Data Processing component has routed (or copied)

successfully the event to the other Data Storage.

5 ConsolidationInProgress The Data Processing attempts to consolidate the information

included in the event, if possible.


6 Consolidated If the consolidation has been done, it is then promoted to

Consolidated.

7 Orphaned If the consolidation has not been possible because some prior

events were missing, it is promoted to Orphaned.

8 Cancelled Final state if the System receives a recall message regarding

this event.

2.6.4 EventType

Value Name REO Registration of an Economic operator

REOD Registration Data of an Economic operator

CEO Correction for an economic operator identifier code

DEO De-registration of economic operator identifier code

RFA Request for a facility identifier code

RFAD Data for a facility identifier code

CFA Correction of information concerning the facility identifier code

DFA De-registration of facility identifier code

RMA Request for a machine identifier code

RMAD Data for a machine identifier code

CMA Correction of information concerning the machine identifier code

DMA De-registration of machine identifier code

ICV Identifier code verification

ULO Flat file and registry File upload

PLO Partial Flat file and registry transmission

ISU Request for unit level UIs

IRU Response for unit level UIs

ISA Request for reporting the issuance of serial numbers at aggregated level

IRA Response for reporting the issuance of serial numbers at aggregated level

IDA Request for deactivation of UIs

EUA Application of unit level UIs on unit packets

EPA Application of aggregated level UIs on aggregated packaging

EDP Dispatch Event

ERP Reception event


ETL Trans-loading event

EUD Message to report an UID disaggregation

EVR Report the delivery carried out with a vending van to retail outlet

EIV Message to report an invoice

EPO Purchase order

EPR Payment record

RCL Recall messages

LUP Download Offline flat file

CTM Connectivity Test Messages


2.6.5 FacilityType

Value Name

1 Manufacturing site with warehouse

2 Standalone warehouse

3 First retail outlet

4 Other

2.6.6 InvoiceType

Value Name

1 Original

2 Correction

3 Other

2.6.7 NotificationType


1 Informative The notification only includes descriptive information, but not related to

any error or abnormal situation.

2 Warning The notification includes information about some alert or warning to be

considered.

3 Alarm The notification includes information about some alarm triggered by the

System.

4 InternalError The notification includes information about some error that has occurred

within the System.

5 Other The notification includes information about some other situation, not listed

above, that has occurred within the System.

2.6.8 PaymentType

Value Name

1 Bank transfer

2 Bank card

3 Cash

4 Other


2.6.9 RecallReasonType

Value Name

1 Reported event did not materialise

2 Message contained erroneous information

3 Other

2.6.10 RegisterStatus

Value Name

1 Registered

2 De-registered

2.6.11 TobaccoProductType

Value Name

1 Cigarette

2 Cigar

3 Cigarillo

4 Roll your own tobacco

5 Pipe tobacco

6 Waterpipe tobacco

7 Oral tobacco

8 Nasal tobacco

9 Chewing tobacco

10 Novel tobacco product

11 Other

2.6.12 TransportMode

Value Name

0 Other

1 Sea Transport

2 Rail transport

3 Road transport


4 Air transport

5 Postal consignment

6 Fixed transport installations

7 Inland waterway transport

2.6.13 UniqueIdentifierState


1 Generated Initial state of the unique identifier. The ID Issuer reports the issuance of some

codes and the Secondary repository creates a unique identifier record with the

initial state (i.e. Generated).

2 Activated The unique identifier, after being verified by the manufacturer, matches one

unique identifier stored in the Secondary repository under the status

“Generated”. Additionally, the information contained in the date element of

information matches the valid activation date for that unique identifier.

3 Deactivated The manufacturer reports the deactivation of that unique identifier. Other

cause of deactivation is when manufacturers tries to activate a unique

identifier whose date element of information does not match the valid

activation date for that unique identifier.

4 Expired The Secondary repository promotes to “Expired” the codes that have been

issued, but their activation has not been reported within a certain period of

time (i.e. expiration time).

5 Delivered The distributor or wholesaler reports that this tobacco product item has been

successfully dispatched to the final retailer.

2.6.14 UniqueIdentifierType


1 UnitPacket Unique identifier at unit packet level

2 AggregatedPackaging Unique identifier at aggregated packaging level


3 Messages 3.1 Message types to be exchanged Described in the Regulation Annex II “Key messages to be sent by the economic operators”

5 categories of messages, related to:

• Identifier codes for economic operators, facilities and machines

• Unique identifiers for unit level UIs and aggregated level UIs

• Recording and transmission of information on product movements

• Transactional events

• Recalls

The following table summarizes the messages.

Message Type

Annex II Reference

Message description

REO (1.1) Registration of an Economic operator

REOD Registration Data of an Economic operator

CEO (1.2) Correction for an economic operator identifier code

DEO (1.3) De-registration of economic operator identifier code

RFA (1.4) Request for a facility identifier code

RFAD Data for a facility identifier code

CFA (1.5) Correction of information concerning the facility identifier code

DFA (1.6) De-registration of facility identifier code

ISU (2.1) Request for unit level UIs

IRU Response for unit level UIs

IRA (2.2) Request for reporting the issuance of serial numbers at aggregated level

ISA Request for reporting the issuance of serial numbers at aggregated level

IDA (2.3) Request for deactivation of UIs

EUA (3.1) Application of unit level UIs on unit packets

EPA (3.2) Application of aggregated level UIs on aggregated packaging

EDP (3.3) Dispatch Event

ERP (3.4) Reception event

ETL (3.5) Trans-loading event

EUD (3.6) Message to report an UID disaggregation

EVR (3.7) Report the delivery carried out with a vending van to retail outlet

EIV (4.1) Message to report an invoice

EPO (4.2) Purchase order


EPR (4.3) Payment record

RCL (5.0) Recall messages

3.1.1 Optional II2MN II2DW interfaces

The ID Issuer defines the communication between the EO and the ID issuer corresponding to

interfaces II2MN and II2DW.

The proposed messages presented in this Data Dictionary are sample messages to illustrate the

overall flow of data from the EO to the Secondary repository. These messages should be

considered as a Guideline with no obligation of implementation.

All messages part of the II2MN and II2DW interfaces are marked as optional in this document.

3.1.2 Message and endpoints

Message support

Router Endpoints

Router The authentication endpoint

Router The resource endpoint IRU,IRA,IDA,EUA,EPA,EDP,ERP,ETL,EUD,EVR,

EIV,EPO,EPR,RCL

Router The flat file upload ULO, PLO

3.2 Common schema elements

3.2.1 Basic information block concerning the request

Basic information block concerning the request - schema

Field Description Data Type Cardinality Priority Values

Message_Type The identifier of the type of

message Text S M

See above types of

messages list

Code

The internal code of

acknowledgment of the message.

Used for recall too.

Text S M

RejectionData The failure data recorded in the

primary should the validation fail.

FalureData (See

below table) S O

This should only be

filled if the primary

validation fails.

RejectionData - schema


ResponseText The response of the primary Text S M

Errors

List of the errors. Array containing

Error_Code, Error_Descr,

InternalId

Test S M

If the secondary repository receives a message with this “RejectionData” non null, it will not

process the message and will instead record / audit the failure. This for later analysis, used to

find possible illicit trade.


3.2.2 Basic information block concerning the response

Basic information block concerning the response - schema


Message_Type The identifier of the type of message

that the response refers to Text S M

See above types of

messages list

Error Indicates the failure of the message

reception Boolean S M

0 – No

1- Yes

Errors Array containing Error_Code,

Error_Descr, InternalId Text S

M if Error =

1

System error

catalogue at Error!

Reference source not

found.

Code Unique identifier of the message.

Used for recall too. Text S M

Checksum The calculated checksum of the

data received Text S M

3.2.3 Common Error codes

HTTP

status

Error Code Error Description

401 SECURITY_INVALID_TOKEN Invalid security token

401 SECURITY_EXPIRED_TOKEN Expired security token

400 INVALID_REQUEST_FORMAT This error is returned when at least one of the

mandatory fields are missing.

400 INVALID_MESSAGE_TYPE When the field “Message_Type” is out of the

defined list.

400 INVALID_INPUT_FORMAT When the body of the message doesn’t

contain a valid JSON.

500 SYSTEM_ERROR Internal system error.

3.3 Identifier codes for economic operators, facilities and machines messages

3.3.1 REO - (1.1) Registration of an Economic operator

3.3.1.1 Description

Submit the information for the first registration of the economic operator. Please note that this

message is the REO message that is sent to the id issuer, but with the id issuer EO_ID added.

3.3.1.2 Description of the fields

registration of economic operator – request


BasicInfo_Req Block of basic information elements

Component << Basic

Information Request >>

S M Message_Type =

REO


EO_Name1 Economic operator's registered

name Text S M

EO_Name2 Economic operator's alternative or

abridged name Text S O

EO_Address Economic operator's address – street name, house number,

postal code, city

Text S M

EO_CountryReg Economic operator's country of

registration Country S M See Country

EO_Email Economic operator's email

address; used to inform about registration process,

incl. subsequent changes and other required correspondence

Text S M

VAT_R Indication of the VAT registration

status Boolean S M 0 –

No

VAT

registration

1 – VAT

number exists

VAT_N Economic operator's VAT number Text S M, if VAT_R = 1

TAX_N Economic operator's tax

registration number Text S M, if

VAT_R = 0

EO_ExciseNu

mber1 Indication if the economic operator

has an excise number issued by the

competent authority for the purpose of identification of

persons/premises

Boolean S M 0 – No SEED number

1 – SEED number exists

EO_ExciseNu

mber2 Economic operator's excise

number issued by the competent authority for the purpose of identification of

persons/premises

SEED S M, if EO_Excis

eNumber 1 = 1

OtherEOID_R Indication if the economic operator

has been allocated an identifier by another ID

Issuer

Boolean S M 0 – No

1 – Yes

OtherEOID_N Economic operator identifier codes

allocated by other ID Issuers EOID M M, if

OtherEOI D_R = 1

Reg_3RD Indication if the registration is made

on behalf of a retail outlet operator not otherwise

involved in the tobacco trade


1 – Yes

Reg_EOID Identifier of the economic operator

that acts on behalf of a retail outlet operator not

otherwise involved in the tobacco

trade

EOID S M, if Reg_3RD

= 1

EO_OtherID Optional identifier Text(50) S O


3.3.1.3 Response:


BasicInfo_Resp Block of basic information

elements

Component << Basic

Information Response >>

S M Message_Type = REO

3.3.1.4 Request sample

{

"EO_ID": "QCUKR+1AB020054",

"EO_Name1": "Example Legal Entity",

"EO_Name2": "",

"EO_Address": "59 Legal Street",

"EO_CountryReg": "DE" ,

"EO_Email": "[email protected]",

"VAT_R": true,

"VAT_N": "VATNumber 1",

"TAX_N": "Tax",

"EO_ExciseNumber1":true,

"EO_ExciseNumber2": "LA111FD",

"OtherEOID_R": true,

"OtherEOID_N": [ "" ],

"Reg_3RD": false,

"Reg_EOID": "",

"EO_OtherID ": "GLNSAMPLE",

"Message_Type": “REO”,

"Code": "873345b2-882f-4064-91f0-90669b46c30a"

"EO_OtherID": "XFG6GN5J5JG98VJKFHJKKJ"

}

3.3.1.5 Successful response sample

HTTP Status 202

{

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

"Message_Type": "REO",

"Error": false,

"Errors": null,

"Checksum": "DFG65H"

}

3.3.1.6 Error response sample

Processing errors HTTP

status

<< Common response code >>

400 ALREADY_EXISTS Indicated that the CRUD action in add a new

entity failed, as the item already exist. This is

when checking of the item id already exists.

3.3.2 REOD - Data Registration of an Economic operator


3.3.2.1 Description

The REOD message is the response to the REO message. This message can be issued in an

asynchronous manner and contains the EO_ID.


registration of economic operator – request



Component << Basic


S M Message_Type =

REOD

EO_ID Economic operator's registered ID EOID S M


name Text S M



EO_Address Economic operator's address – street name, house number,

postal code, city

Text S M

EO_CountryR eg Economic operator's country of


EO_Email Economic operator's email

address; used to inform about registration process,

incl. subsequent changes and other required correspondence

Text S M



No

VAT

registration

3 – VAT

number exists


TAX_N Economic operator's tax

registration number Text S M, if

VAT_R = 0

EO_ExciseNu




persons/premises



EO_ExciseNu

mber2 Economic operator's excise

number issued by the competent authority for the purpose of identification of

persons/premises


eNumber 1 = 1


has been allocated an identifier by another ID

Issuer


3 – Yes



OtherEOI D_R = 1






3 – Yes




trade


= 1

EO_OtherID Optional identifier Text(50) S O

EO_CODE Economic operator's confirmation

code provided in response to the registration of

economic operator

Text S M

3.3.2.3 Response:



elements

Component << Basic


S M Message_Type = REOD


{


"EO_Name1": "Example Legal Entity",

"EO_Name2": "",

"EO_Address": "59 Legal Street",

"EO_CountryReg": "DE" ,


"VAT_R": true,


"TAX_N": "Tax",

"EO_ExciseNumber1":true,




"Reg_3RD": false,

"Reg_EOID": "",

"EO_OtherID ": "GLNSAMPLE",

"Message_Type": “REO”,

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

"EO_Code": "873345b2-882f-4064-91f0-90669b46c30a"

"EO_OtherID": "XFG6GN5J5JG98VJKFHJKKJ"

}


HTTP Status 202

{

"Code": " 6854f9a6-a2b2-4c08-8000-0173f3c35567",

"Message_Type": "REOD",

"Error": false,

"Errors": null,


"Checksum": "G6HF5H"

}



status



3.3.3 CEO – (1.2) Correction for an economic operator identifier code

3.3.3.1 Description

Submit the information of an economic operator known to the repository in order to update 1 or

more properties. This information in entirety will over write the previous data held regarding the

master data of this economic operator. Links (for example dispatches) to / from this EO_ID will be

maintained.




Component << Basic


S M Message_Type =

CEO

EO_ID Economic operator identifier code EOID S M



economic operator

Text S M


name Text S M



EO_Address Economic operator's address – street name, postal code and city

Text S M

EO_CountryR eg Economic operator's country of


EO_Email Economic operator's email address

– used to inform about registration process, incl.

subsequent changes

Text S M



No

VAT

registration

1 – VAT

number exists


TAX_N Economic operator's tax registration

number Text S M, if

VAT_R = 0

EO_ExciseNu




persons/premises



EO_ExciseNu

mber2 Economic operator's excise number

issued by the competent authority for the purpose of identification of

persons/premises


eNumber 1 = 1



has been allocated an identifier by

another ID Issuer


1 – Yes



OtherEOI D_R = 1





1 – Yes




trade


= 1

3.3.3.3 Response:

correction of information concerning the economic operator – resp onse



elements

Component << Basic


S M Message_Type = CEO


{

"Message_Type": “CEO”,

"Code": "873345b2-882f-4064-91f0-90669b46c30a",


"EO_CODE": "FGT6H",

"EO_Name1": "registerationname",

"EO_Name2": "",

"EO_Address": "address 1",

"EO_CountryReg": 27,


"VAT_R": true,


"TAX_N": "Tax",

"EO_ExciseNumber1": true,




"Reg_3RD": false,

"Reg_EOID": ""

}



HTTP Status 202

{

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

"Message_Type": "CEO",

"Error": false,

"Errors": null,


}



status


3.3.4 DEO – (1.3) De-registration of economic operator identifier code.

3.3.4.1 Description

De-registers a previously known operator identifier for a given EO_ID


De-registration of economic operator – request



Component << Basic


S M Message_Type =

DEO




economic operator

Text S M





1 – Yes




trade


= 1


3.3.4.3 Response:

correction of information concerning the economic operator – resp onse



elements

Component << Basic


S M Message_Type = DEO


{


"EO_CODE": "EO1_CODE",

"Reg_3RD": false,

"Reg_EOID": "Machine Id A",

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

"Message_Type": "DEO",

}

}


HTTP Status 202

{

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

"Message_Type": "DEO",

"Error": false,

"Errors": null,


}



status



3.3.5 RFAD – (1.4) Request for a facility identifier code

3.3.5.1 Description

Add a previously unsent / registered facility. Defined as unseen by the existence of the facility id

in the repository.


Request:

Registration of facility – request



Component << Basic


S M Message_Type =

RFAD


F_ID Facility code from the RFA code

issuer call FID S M



economic operator

Text S M

F_Address Facility's address – street name,

house number, postal code and city

Text S M

F_Country Facility's country Country S M See Country

F_Type Type of facility Integer S M See FacilityType

F_Type_Other Description of other facility type Text S M, if F_Type = 4

F_Status Indication if a part of the facility has

a bonded warehouse status Boolean S M 0 – No

1 – Yes

F_ExciseNum

ber1 Indication if the facility has an



persons/premises

Boolean S M 0 – No SEED

number

1 – SEED

number exists

F_ExciseNum

ber2 Facility's excise number issued by

the competent authority for the purpose of

identification of persons/premises

SEED S M, if F_Excise Number1

= 1

OtherFID_R Indication if the facility has been

allocated an identifier by another ID

Issuer


1 – Yes

(possible only for

non-EU facilities)

OtherFID_N Facility identifier codes allocated by

other ID Issuers FID M M, if

OtherFID


_R = 1





1 – Yes (possible only

if F_Type = 3)




trade


= 1

3.3.5.3 Response

registration of facility – response



elements

Component << Basic


S M Message_Type = RFAD

F_ID Facility’s identifier

registered FID S

M if Error =

0


{

"EO_ID":"QCUKR+1AB020054",

"EO_CODE":"EO1_CODE",

"F_ID":"QCUKR<1AB020054000048",

"F_Address":"Machine Id A",

"F_Country":2,

"F_Type":”RFA2”,

"F_Type_Other":null,

"F_Status": false,

"F_ExciseNumber1": false,

"F_ExciseNumber2": null,

"OtherFID_R": false,

"OtherFID_N": [],

"Reg_3RD": false,

"Reg_EOID": null,

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

"Message_Type":"RFAD"

}



HTTP Status 202

{

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

"Message_Type": "RFAD",

"Error": false,

"Errors": null,


}



status


3.3.6 CFA – (1.5) Correction of information concerning the facility identifier code

3.3.6.1 Description

Submit the information of a facility known to the repository in order to update one or more

properties. This information in entirety will over write the previous data held regarding the master

data of this facility. Links (for example dispatches) to / from this F_ID will be maintained.


correction of information concerning the facility – request



Component << Basic


S M Message_Type =

CFA




economic operator

Text S M

F_ID Facility identifier code FID S M

F_Address Facility's address – street name,

postal code and city Text S M

F_Country Facility's country Country S M See Country

F_Type Type of facility Integer S M See FacilityType

F_Type_Other Description of other facility type Text S M, if F_Type = 4


F_Status Indication if a part of the facility has

a bonded warehouse status Boolean S M 0 – No

1 – Yes

F_ExciseNum

ber1 Indication if the facility has an



persons/premises

Boolean S M 0 – No SEED

number

1 – SEED

number exists

F_ExciseNum

ber2 Facility's excise number issued by

the competent authority for the purpose of

identification of persons/premises

SEED S M, if F_Excise Number1

= 1

OtherFID_R Indication if the facility has been

allocated an identifier by another ID

Issuer


1 – Yes

(possible only for

non-EU facilities)

OtherFID_N Facility identifier codes allocated by

other ID Issuers FID M M, if

OtherFID _R = 1





1 – Yes

(possible only if

F_Type = 3)




trade


= 1

3.3.6.3 Response

correction of information concerning the facility – response



elements

Component << Basic


S M Message_Type = CFA



{


"EO_CODE":"EO1_CODE",

"F_ID":"QCUKR<1AB020054000048",

"F_Address":"Address A",

"F_Country":2,

"F_Type":”CFA”,

"F_Type_Other":null,

"F_Status": false,

"F_ExciseNumber1": false,

"F_ExciseNumber2": null,

"OtherFID_R": false,

"OtherFID_N": [],

"Reg_3RD": false,

"Reg_EOID": null,

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

"Message_Type":"CFA"

}


HTTP Status 202

{

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

"Message_Type": "CFA",

"Error": false,

"Errors": null,


}



status



3.3.7 DFA – (1.6) De-registration of facility identifier code

3.3.7.1 Description

De-registers a previously known facility for a given F_ID


de-registration of facility – request



Component << Basic


S M Message_Type =

DFA




economic operator

Text S M


Reg_3RD Indication if the deregistration is

made on behalf of a retail outlet

operator not otherwise involved in

the tobacco trade


1 – Yes




trade


= 1

3.3.7.3 Response:

de-registration of facility – response



elements

Component << Basic


S M Message_Type = DFA


{


"EO_CODE": "DFA",

"F_ID":"QCUKR<1AB020054000048",

"Reg_3RD": false,

"Reg_EOID": null,

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

"Message_Type": "DFA"

}



HTTP Status 202

{

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

"Message_Type": "DFA",

"Error": false,

"Errors": null,


}



status



3.4 Unique identifiers Messages

3.4.1 ISU – (2.1) Request for unit level UIs

3.4.1.1 Description

Request for reporting the issuance of serial numbers at unit packet level


Request for unit level UIs – request


BasicInfo_Req Block of basic information

elements

Component << Basic

Information

Request >>

S M Message_Type =

ISU

Event_Time Intended time of event occurrence Time(s) S M

EO_ID Economic operator identifier code

of the submitting entity (either EU

manufacturer or EU importer)

EOID S M


Process_Type Indication if the production

process

involves machinery

Boolean S M 0 – No (only for

fully hand made

products)

1 – Yes

M_ID Machine identifier code MID S M

P_Type Type of tobacco product Integer S M See

TobaccoProductTyp

e

P_OtherType Description of other type of

tobacco product

Text S M, if

P_Type =

12 (other

tobacco

product)

P_CN Combined Nomenclature (CN)

code

Text S M, if

Intended

_Market

is an EU

country

P_weight Average gross weight of unit

packet, including packaging, in

grams with 0,1 gram accuracy

Decimal S M

P_Brand Brand of tobacco product Text S M

TP_ID The identification number of the

product used in the EU-CEG

system.

TPID S M, if

Intended_

Market is

an EU

country

TP_PN Tobacco product number

used in the EU-CEG system

PN S M, if

Intended_

Market is

an EU

country

Intended_Marke

t

Intended country of retail sale. Country S M

Intended_Route

1

Indication if the product is

intended to be moved across

country boarders with terrestrial

transport.


1 – Yes

Intended_Route

2

The first country of terrestrial

transport after the product leaves

the Member State of

Country S M, if

Intended_

Route1 = 1


Request for unit level UIs – request


manufacturing or the Member

State of importation.

Import Indication if the product is

imported into the EU


1 – Yes

Req_Quantity Requested quantity of unit packet

level UIs

Integer S M

P_OtherID Optional Product ID Text(20) S O

3.4.1.3 Response:

Request for unit level UIs – response



elements

Component <<

Basic

Information

Response >>

S M Message_Type =

IRU


{


"Event_Time" : "2018-08-23T07:32:20.7878086+00:00",

"F_ID": "QCUKR<1AB020054000049"

"Process_Type":false,

"M_ID":"Machine Id A",

"P_Type":2,

"P_OtherType":null,

"P_CN": "FG7H68FHF"

"P_Brand":"Product brand A",

"P_Weight":10.0,

"TP_ID":"1234",

"TP_PN":"1234",

"Intended_Market":"BG",

"Intended_Route1":true,

"Intended_Route2":"BG",

"Import":false,

"Req_Quantity":2,

"P_OtherID":"GTINSAMPLE",

"Code":"6854f9a6-a2b2-4c08-8000-0173f3c35567",

"Message_Type":"ISU"

}


HTTP Status 202

{

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

"Message_Type": "IRU",

"Error": false,

"Errors": null,


}




status


Error body sample {

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

"Message_Type": null,

"Error": true,

"Errors": [

{

"Error_InternalID": "yndkFz7TBEO706frD38hzA",

"Error_Code": "INVALID_REQUEST_FORMAT",

"Error_Descr": "The EconomicOperatorIdentifier field is required."

}

]

}

3.4.2 IRU – Message to report the issuance of serial numbers at unit packet level

3.4.2.1 Description

Request for reporting the issuance of serial numbers at unit packet level


request for reporting the issuance of serial numbers at unit packet level – request



elements

Component << Basic

Information

Request >>

S M Message_Type =

IRU



of the submitting entity (either EU

manufacturer or EU importer)

EOID S M


Process_Type Indication if the production

process

involves machinery

Boolean S M 0 – No (only for

fully hand made

products)

1 – Yes

M_ID Machine identifier code MID S M

P_Type Type of tobacco product Integer S M See

TobaccoProductTyp

e

P_OtherType Description of other type of

tobacco product

Text S M, if

P_Type =

12 (other

tobacco

product)

P_CN Combined Nomenclature (CN)

code

Text S O

P_Brand Brand of tobacco product Text S M

TP_ID The identification number of the

product used in the EU-CEG

system.

TPID S M, if

Intended_

Market is

an EU

country


request for reporting the issuance of serial numbers at unit packet level – request


TP_PN Tobacco product number used in

the EU-CEG system

PN S M, if

Intended_

Market is

an EU

country

Intended_Marke

t

Intended country of retail sale. Country S M

Intended_Route

1

Indication if the product is

intended to be moved across

country boarders with terrestrial

transport.


1 – Yes

Intended_Route

2

The first country of terrestrial

transport after the product leaves

the Member State of

manufacturing or the Member

State of importation.

Country S M, if

Intended_

Route1 = 1

Import Indication if the product is

imported into the EU


1 – Yes

Req_Quantity Requested quantity of unit packet

level UIs

Integer S M

P_OtherID Optional Product ID Text(20) S O

upUI List of unit packet level UIs issued upUI(s) M M

3.4.2.3 Response:

request for reporting the issuance of serial numbers at unit packet level – response



elements

Component <<

Basic

Information

Response >>

S M Message_Type =

IRU


{


"F_ID": "QCUKR<1AB020054000049",

"Event_Time" : "2018-08-23T07:32:20.7878086+00:00",

"Process_Type":false,

"M_ID":"Machine Id A",

"P_Type":2,

"P_OtherType":null,

"P_CN": "FG7H68FHF"

"P_Brand":"Product brand A",

"P_Weight":10.0,

"TP_ID":"1234",

"TP_PN":"1234",

"Intended_Market":"BG",

"Intended_Route1":true,

"Intended_Route2":"BG",

"Import":false,

"Req_Quantity":2,

"upUI":[<upUI>],

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

"Message_Type":"IRU"

}



HTTP Status 202

{

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

"Message_Type": "IRU",

"Error": false,

"Errors": null,


}



status


Error body sample {

"Code": null,

"Message_Type": null,

"Error": true,

"Errors": [

{

"Error_InternalID": "yndkFz7TBEO706frD38hzA",

"Error_Code": "INVALID_REQUEST_FORMAT",

"Error_Descr": "The EconomicOperatorIdentifier field is required."

}

]

}

3.4.3 ISA – (2.2) Request for aggregated level UIs

3.4.3.1 Description

Request for reporting the issuance of serial numbers at aggregated level


request for reporting the issuance of serial numbers at aggregated level – request



Component << Basic


S M Message_Type = ISA


EO_ID Economic operator identifier code of

the submitting entity EOID S M



Req_Quantity Requested quantity of aggregated

level UIs Integer S M

3.4.3.3 Response:

request for reporting the issuance of serial numbers at aggregated level – response



elements

Component <<

Basic

Information

Response >>

S M Message_Type =

IRA


{


"Event_Time" : "2018-08-23T07:32:20.7878086+00:00",

"F_ID": "QCUKR<1AB020054000049",

"Req_Quantity": 2,

"Message_Type": "IRA",

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

}


HTTP Status 202

{

"Code": "873345b2-882f-4064-91f0-90669b46c30a",


"Error": false,

"Errors": null,


}



status


3.4.4 IRA – Request for reporting the issuance of serial numbers at aggregated level

3.4.4.1 Description

Request for reporting the issuance of serial numbers at aggregated level



request for reporting the issuance of serial numbers at aggregated level – request



Component << Basic


S M Message_Type = IRA

Event_Time Intended time of event occurrence Time(s)

S M




Req_Quantity Requested quantity of aggregated

level UIs Integer S M

aUI List of aggregated level UIs aUI M M

3.4.4.3 Response:

request for reporting the issuance of serial numbers at aggregated level – response



elements

Component <<

Basic

Information

Response >>

S M Message_Type =

IRA


{


"F_ID": "QCUKR<1AB020054000049",

"Event_Time" : "2018-08-23T07:32:20.7878086+00:00",

"Req_Quantity": 2,

"aUI": ["QCBDRa20wBnq5V300003172440841dTQM90",

"QCBDRa20wBnq5V300003172440841dTQM91" ],


"Code": "873345b2-882f-4064-91f0-90669b46c30a",

}


HTTP Status 202

{

"Code": "873345b2-882f-4064-91f0-90669b46c30a",


"Error": false,

"Errors": null,


}




status


3.4.5 IDA – (2.3) Request for deactivation of UIs

3.4.5.1 Description

Changes the status of the UIs list in the request to “deactivated”


request for the deactivation of UIs – request



elements

Component << Basic

Information

Request >>

S M Message_Type =

IDA



of the submitting entity

EOID S M

Deact_Type Deactivation of unit packet or

aggregated level UIs

Integer S M 1 – Unit pack level UIs

2 – Aggregated level

UIs

Deact_Reason1 Identification of the reason for

deactivation

Integer S M See

DeactivationReason

Type

Deact_Reason2 Description of other reason Text S M, if

Deact_Re

ason1 = 6

(other

reason)

Deact_Reason3 Additional description of the

reason

Text S O

Deact_upUI List of unit packet level UIs to be

deactivated

upUI(s) M M, if

Deact_Typ

e = 1

Deact_aUI List of aggregated level UIs to be

deactivated

aUI M M, if

Deact_Typ

e = 2

3.4.5.3 Response:

request for the deactivation of UIs – response



elements

Component <<

Basic

Information

Response >>

S M Message_Type =

IDA


{



"Event_Time" : "2018-08-23T07:32:20.7878086+00:00",

"Deact_Type": 1,

"Deact_Reason1": 1,

"Deact_Reason2": "reason one",

"Deact_Reason3": "reason two",

"Deact_upUI": [ "752a77aed2a34c47bc926a40bd2e6ef3" ],

"Deact_apUI": [ "752a77aed2a34c47bc926a40bd2e6ef3" ],

"Message_Type": "IDA",

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

}


HTTP Status 202

{

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

"Message_Type": "IDA",

"Error": false,

"Errors": null,


}



status



3.4.6 EUA – (3.1) Application of unit level UIs on unit packets

3.4.6.1 Description

Event notification when the code is applied / printed on unit packets.


upUI application event



elements

Component << Basic

Information

Request >>

S M Message_Type =

EUA




EOID S M


upUI_1 List of unit packet level UIs to be

recorded (full length)

upUI(L) M M

upUI_2 List of corresponding unit packet

level UIs to be recorded (as visible

in human readable format)

indicated in the same order as

upUI_1

upUI(s) M M

upUI_comme

nt

Comments by the reporting

entity

Text S O

3.4.6.3 Response:

upUI application event – response



elements

Component <<

Basic Information

Response >>

S M Message_Type = EUA


{


"F_ID": "QCUKR<1AB020054000049",

"Event_Time": "2018-08-23T07:32:20.7878086+00:00",

"upUI_1": [

"5cd2729e-6acc-4479-b67e-a26a84a6e88b19071619",

"752a77aed2a34c47bc926a40bd2e6ef319071619"

],

"upUI_2": [

"5cd2729e-6acc-4479-b67e-a26a84a6e88b",

"752a77aed2a34c47bc926a40bd2e6ef3"

],

"upUI_comment": "Comments",

"Message_Type": "EUA",

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

}



HTTP Status 202

{

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

"Message_Type": "EUA",

"Error": false,

"Errors": null,


}



status


3.4.7 EPA – (3.2) Application of aggregated level UIs on aggregated packaging

3.4.7.1 Description

Event notification when the code is applied / printed on an aggregation container. This also

records the items that are aggregated into this container.


Application of aggregated level UIs on aggregated packaging - request



elements

Component << Basic

Information

Request >>

S M Message_Type =

EPA



EOID S M


Event_Time Time of event occurrence Time(s) S M

aUI Aggregated level UI aUI S M

Aggregation_Ty

pe

Identification of aggregation type Integer S M 1 – aggregation of only

unit packet level UIs

2 – aggregation of only


3 – aggregation of both

unit packet and


Aggregated_UIs

1

List of unit packet level UIs

subject to aggregation

upUI(L) M M, if

Aggregatio

n_Type =

1 or 3

Aggregated_UIs

2

List of aggregated level UIs

subject to further aggregation

aUI M M, if

Aggregatio

n_Type =

2 or 3

aUI_commen

t


entity

Text S O


3.4.7.3 Response:

Application of aggregated level UIs on aggregated packaging – response



elements

Component <<

Basic Information

Response >>

S M Message_Type = EPA


{


"F_ID": "QCUKR<1AB020054000049",

"Event_Time": "2018-08-23T07:32:20.7878086+00:00",

"Aggregation_Type": "1",

"aUI" : "QCBDRa20wBnq5V300003172440841dTQM90",

"Aggregated_UIs1": ["DCBDRa20wBnq5V300003172440841dTQM9019071619",

"ACBDRa20wBnq5V300003172440841dTQM9019071619",

"BCBDRa20wBnq5V300003172440841dTQM9019071619",

"CCBDRa20wBnq5V300003172440841dTQM9019071619"],

"Aggregated_UIs2": ["QCBDRa20wBnq5V300003172440841dTQM90",

"QCBDRa20wBnq5V300003172440841dTQM90", "QCBDRa20wBnq5V300003172440841dTQM90",

"QCBDRa20wBnq5V300003172440841dTQM90" ],

"upUI_comment": "Comments",

"Message_Type": "EPA",

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

}


HTTP Status 202

{

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

"Message_Type": "EPA",

"Error": false,

"Errors": null,


}


Processing errors

HTTP

status



3.4.8 EDP – (3.3) Dispatch of tobacco products from a facility

3.4.8.1 Description

Record that the UIs listed in the call have been dispatched from the economic identifier.


Dispatch of tobacco products from a facility event



Component

<< Basic

Information

Request >>

S M Message_Type =

EDP



EOID S M

Event_Time Time of event occurrence Time (s) S M

F_ID Dispatch facility identifier code FID S M

Destination_ID1 Indication if the destination facility is

located on the EU territory and if it

is a vending machine (VM)

Integer S M 1 – Non EU dest.

2 – EU destination

other than VM –

fixed quantity

delivery

3 – EU VM(s)

4 – EU destination

other than VM –

delivery with VV

Destination_ID2 Destination facility identifier code FID S M, if

Destinatio

n_ID1 = 2

Destination_ID3 Destination facility identifier code(s)

– possible multiple vending

machines

FID M M, if

Destinatio

n_ID1 = 3

Destination_ID4 Destination id facility codes FID M M, if

Destinatio

n_ID1 = 4

Destination_ID5 Destination facility's full address:

street, house number, postal code,

city

Text S M, if

Destinatio

n_ID1 = 1

Transport_mode Mode of transport by which the

product leaves the facility, see:

Commission Regulation (EC) No

684/2009, Annex II, Code List 7

Integer S M See TransportMode

in section Error!

Reference source

not found.

Transport_vehicle Identification of the mode of

transport (i.e. number plates, train

number, plane/flight number, ship

name or other identification)

Text S M ‘n/a’ is permitted

value if

Transport_mode = 0

and product

movement takes

place between

adjacent facilities

and is delivered

manually

Transport_cont1 Indication if the transport is

containerised and uses an individual

transport unit code (e.g. SSCC)


1 – Yes

Transport_cont2 Individual transport unit code of the

container

ITU S M, if

Transport_

cont1 = 1

Transport_s1 Indication if the dispatch takes

place with the logistic/postal

operator who operates its own track

and trace system accepted by the

Member State of the dispatch

facility. Only for small quantities of

tobacco products (net weight of the

products dispatched below 10 kg)


1 – Yes


Dispatch of tobacco products from a facility event


destined for exports to third

countries

Transport_s2 The logistic operator's tracking

number

Text S M, if

Transport_

s1 = 1

EMCS Dispatch under the Excise

Movement and Control System

(EMCS)


1 – Yes

EMCS_ARC Administrative Reference Code

(ARC)

ARC S M, if

EMCS = 1

SAAD Dispatch with a simplified

accompanying document, see:

Commission Regulation (EEC) No

3649/92


1 – Yes

SAAD_number Reference number of the

declaration and/or authorization

which has to be given by the

competent authority in the Member

State of destination before the

movement starts

Text S M, if SAAD

= 1

Exp_Declaration Indication if the Movement

Reference Number (MRN) has been

issued by the customs office


1 – Yes

Exp_

DeclarationNumber

Movement Reference Number

(MRN)

MRN S M, if

Exp_Decla

ration = 1

UI_Type Identification of UI types in the

dispatch (recorded at the highest

level of available aggregation)

Integer S M 1 – only unit packet

level UIs

2 – only aggregated

level UIs

3 – both unit packet

and aggregated

level UIs

upUIs

List of unit packet level UIs subject

to the dispatch

upUI(L) M M, if

UI_Type =

1 or 3

aUIs List of aggregated level UIs subject

to the dispatch

aUI M M, if

UI_Type =

2 or 3

Dispatch_comment Comments by the reporting entity Text S O

3.4.8.3 Response:

Response:

Dispatch event – response



elements

Component <<

Basic Information

Response >>

S M Message_Type = EDP



{


"F_ID": "QCUKR<1AB020054000049",

"Event_Time": "2018-08-23T07:32:20.7878086+00:00",

"Destination_ID1": "1",

"Destination_ID2": "FacilityIdB",

"Destination_ID3": [ " FacilityIdB ", " FacilityIdB " ],

"Destination_ID4": [ " FacilityIdB” ],

"Destination_ID5": "FacilityIdA",

"Transport_vehicle": "1",

"Transport_cont1": true,

"Transport_cont2": "1",

"Transport_s1": true,

"Transport_s2": "1",

"EMCS": false,

"EMCS_ARC": null,

"SAAD": true,

"SAAD_number": 1,

"Exp_Declaration": true,

"Exp_DeclarationNumber": true,

"UI_Type": 1,

"upUIs": [ "5cd2729e6acc4479-b67e-a26a84a6e88b19071619",

"752a77aed2a34c47bc926a40bd2e6ef319071619" ],

"aUIs": [ "5cd2729e6acc4479b67ea26a84a6e88b",

"752a77aed2a34c47bc926a40bd2e6ef3" ],

"Dispatch_comment": "Comments",

"Message_Type": "EDP",

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

}


HTTP Status 202

{

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

"Message_Type": "EDP",

"Error": false,

"Errors": null,


}


Processing errors

HTTP

status



3.4.9 ERP – (3.4) Arrival of tobacco products at a facility

3.4.9.1 Description

Record that the UIs listed in the call have been received to an economic identifier.


Arrival of tobacco products at a facility



elements

Component <<

Basic Information

Request >>

S M Message_Type = ERP

EO_ID Economic operator identifier

code of the submitting entity

EOID S M

F_ID Arrival facility identifier code FID S M

Event_Time Time of event occurrence Times(s) S M

Product_Return Indication if the arriving products

are a return following complete

or partial non-delivery


1 – Yes

UI_Type Identification of UI types

received (recorded at the

highest level of available

aggregation)


level UIs


level UIs


and aggregated level

UIs

upUIs


received

upUI(L) M M, if

UI_Type

= 1 or 3

aUIs List of aggregated level UIs

received

aUI M M, if

UI_Type

= 2 or 3

Arrival_commen

t


entity

Text S O

3.4.9.3 Response:

Arrival of tobacco products at a facility– response



elements

Component <<

Basic Information

Response >>

S M Message_Type = ERP


{


"F_ID": "QCUKR<1AB020054000049",

"Event_Time": "2018-08-23T07:32:20.7878086+00:00",

"Product_Return": "true",

"UI_Type": "1",

"upUIs": [ "752a77aed2a34c47bc926a40bd2e6ef319071619",

"5cd2729e6acc4479b67ea26a84a6e88b19071619" ],

"aUIs": [ "752a77aed2a34c47bc926a40bd2e6ef3", "5cd2729e6acc4479-

b67ea26a84a6e88b" ],

"Arrival_comment": "Comments",

"Message_Type": "ERP",

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

}



HTTP Status 202

{

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

"Message_Type": "ERP",

"Error": false,

"Errors": null,


}



status


3.4.10 ETL – (3.5) Trans-loading

3.4.10.1 Description

Event to show that UIs have been moved from one transport mechanism to another.


Trans-loading event



elements

Component << Basic

Information

Request >>

S M Message_Type =

ETL



EOID S M


Destination_ID1 Indication if the destination facility

is located on the EU territory

Integer S M 0 – No

1 – Yes

Destination_ID2 Destination facility identifier code FID S M, if

Destinatio

n_ID

1 = 1

Destination_ID3 Destination facility's full address Text S M, if

Destinatio

n_ID

1 = 0

Transport_mod

e

Mode of transport to which the

product is trans-loaded, see:

Commission Regulation (EC) No

684/2009, Annex II, Code List 7

Integer S M See TransportMode

Transport_vehic

le

Identification of the vehicle (i.e.

number plates, train number,

plane/flight number, ship name or

other identification)

Text S M

Transport_cont

1

Indication if the transport is

containerised and uses an

individual transport unit code (e.g.

SSCC)


1 – Yes


Trans-loading event


Transport_cont

2

Individual transport unit code of

the container

ITU S M

EMCS Dispatch under the Excise

Movement and Control System

(EMCS)


1 – Yes

EMCS_ARC Administrative Reference Code

(ARC)

ARC S M, if

EMCS = 1

UI_Type Identification of UI types subject to

the trans-loading (recorded at the

highest level of available

aggregation)


level UIs


level UIs



UIs

upUIs


subject to the trans-loading

upUI(L) M M, if

UI_Type =

1 or 3


subject to the trans-loading

aUI M M, if

UI_Type =

2 or 3

Transloading_c

omment

Comments by the reporting entity Text S O

3.4.10.3 Response:

Trans-loading event – response



elements

Component <<

Basic Information

Response >>

S M Message_Type = ETL

3.4.10.4 Request sample {


"Event_Time": "2018-08-23T07:32:20.7878086+00:00",

"Destination_ID1": 1,

"Destination_ID2": "FGHZ7G",

"Destination_ID3": "",

"Transport_mode": 1,

"Transport_vehicle": 1,

"Transport_cont1": 1,

"Transport_cont2": "code",

"EMCS": 1,

"EMCS_ARC": "ref",

"UI_Type": 1,

"upUIs": [ "5cd2729e6acc4479-b67e-a26a84a6e88b19071619",

"652a77aed2a34c47bc926a40bd2e6ef319071619" ],

"aUIs": [ "5cd2729e6acc4479b67ea26a84a6e88c",

"752a77aed2a34c47bc926a40bd2e6efh" ],

"Transloading_comment": "Comments",

"Message_Type": "ETL",

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

}


HTTP Status 202


{

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

"Message_Type": "ETL",

"Error": false,

"Errors": null,


}



status


400 VALIDATION_FAILED This error is returned when at least one of the

mandatory fields are missing or another type

of validation failed.

3.4.11 EUD – (3.6) Disaggregation of aggregated level UIs


Event showing that an aggregation no longer exists.


aUI disaggregation event



Component << Basic


S M Message_Type =

EUD

EO_ID Economic operator's identifier EOID S M

F_ID Facility's identifier FID S M


aUI Aggregated level UI subject to

disaggregation aUI S M

disaUI_comm ent

Comments by the reporting entity Text S O

3.4.11.3 Response:

aUI disaggregation event– response




elements

Component << Basic


S M Message_Type = EUD


{


"F_ID": "QCUKR<1AB020054000049",

"Event_Time": "2018-08-23T07:32:20.7878086+00:00",

"aUI": "QCBDRa20wBnq5V300003172440841dTQM90",

"disaUI_comment": "Comments",

"Message_Type": "EUD",

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

}


HTTP Status 202

{

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

"Message_Type": "EUD",

"Error": false,

"Errors": null,


}



status



3.4.12 EVR – (3.7) Report the delivery carried out with a vending van to retail outlet


Event sent when UIs have been distributed via a van delivery.


Vending Van event



Component << Basic


S M Message_Type =

EVR



F_ID Facility identifier code of retail outlet FID S M


UI_Type Identification of UI types delivered

(recorded at the highest level of available

aggregation)

Integer S M 1 – only unit packet level UIs

2 – only


3 – both unit

packet and aggregated level

UIs

upUIs


delivered upUI(L) M M, if

UI_Type = 1 or 3


delivered aUI M M, if

UI_Type = 2 or 3

Delivery_com

ment Comments by the reporting entity Text S O

3.4.12.3 Response:

Vending Van event – response



elements

Component << Basic


S M Message_Type = EVR



{


"F_ID": "QCUKR<1AB020054000049",

"Event_Time": "2018-08-23T07:32:20.7878086+00:00",

"UI_Type": 1,

"upUIs": [ "752a77aed2a34c47bc926a40bd2e6ef419071619",

"5cd2729e6acc4479b67ea26a84a6e88c19071619" ],

"aUIs": [ "752a77aed2a34c47bc926a40bd2e6ef3", "8cd2729e-6acc-4479-b67e-

a26a84a6e88b" ],

"Delivery_comment": "Comments",

"Message_Type": 7,

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

}


HTTP Status 202

{

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

"Message_Type": "EVR",

"Error": false,

"Errors": null,


}



status



3.5 Transactional events

3.5.1 EIV – (4.1) Issuing of the invoice

3.5.1.1 Description.

Added invoice details to a UI.


Invoice reporting



Component

<< Basic

Information

Request >>

S M Message_Type =

EIV



EOID S M


Invoice_Type1 Type of the invoice Integer S M See InvoiceType

Invoice_Type2 Description of the other type of the

invoice

Text S M, if

Invoice_Ty

pe1 = 3

Invoice_Number Number of the invoice Text S M

Invoice_Date Date of the invoice Date S M

Invoice_Seller Identity of the seller EOID S M

Invoice_Buyer1 Identification if the buyer is located

in the EU


1 – Yes

Invoice_Buyer2 Identity of the buyer EOID S M, if

Invoice_Bu

yer1 = 1

Buyer_Name Buyer's registered legal name Text S M, if

Invoice_Bu

yer1 = 0

Buyer_Address Buyer's address – street name,

house number, postal code, city

Text S M, if

Invoice_Bu

yer1 = 0

Buyer_CountryReg Buyer's country of registration Country S M, if

Invoice_Bu

yer1 = 0

Buyer_TAX_N Buyer's tax registration number Text S M, if

Invoice_Bu

yer1 = 0

First_Seller_EU Identification if the invoice is issued

by the first seller in the EU, i.e. the

EU manufacturer or the importer,

and the product is destined for the

EU market


1 – Yes

Product_Items_1 List of TPIDs corresponding to the

product items listed on the invoice

TPID M M, if

First_Selle

r_EU = 1

Product_Items_2 List of product numbers

corresponding to the product items

listed on the invoice

(in the same order as

product_Items_1)

PN M M, if

First_Selle

r_EU = 1

Product_Price Net unit packet price per each pair

of TPID and product number (in the

same order as product_Items_1)

Decimal M M, if

First_Selle

r_EU = 1

Invoice_Net Total net amount of the invoice Decimal S M

Invoice_Currency Currency of the invoice Currency S M


Invoice reporting


UI_Type Identification of UI types covered by

the invoice (recorded at the highest

level of available aggregation)


level UIs


level UIs



UIs

upUIs

List of unit packet level UIs covered

by the invoice

upUI(L) M M, if

UI_Type =

1 or 3


covered by the invoice

aUI M M, if

UI_Type =

2 or 3

Invoice_comment Comments by the reporting entity Text S O

3.5.1.3 Response:

Invoice reporting– response



elements

Component <<

Basic Information

Response >>

S M Message_Type = EIV


{


"Event_Time": "2018-08-23T07:32:20.7878086+00:00",

"Invoice_Type1": 1,

"Invoice_Type2": "other type",

"Invoice_Number": "INV000001",

"Invoice_Date": "2018-08-23T07:32:20.7878086+00:00",

"Invoice_Seller": "SellerId",

"Invoice_Buyer1": false,

"Invoice_Buyer2": null,

"Buyer_Name": "Buyer1",

"Buyer_Address": "BuyerAddress",

"Buyer_CountryReg": "LU",

"Buyer_TAX_N": "TAX0001",

"First_Seller_EU": 1,

"Product_Items_1": [ "IRU_GOOD" ],

"Product_Items_2": [ "IRU_GOOD" ],

"Product_Price": [ "16.99", "19.99" ],

"Invoice_Net": 10099.99,

"Invoice_Currency": "EUR",

"UI_Type": 1,

"upUIs": [ "5cd2729e6acc4479b67ea26a84a6e88b19071619",

"752a77aed2a34c47bc926a40bd2e6ef319071619" ],

"aUIs": [ "5cd2729e-6acc-4479-b67e-a26a84a6e88b",

"752a77aed2a34c47bc926a40bd2e6ef3" ],

"Invoice_comment": "Comments",

"Message_Type": "EIV",

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

}


HTTP Status 202


{

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

"Message_Type": "EIV",

"Error": false,

"Errors": null,


}



status


3.5.2 EPO – (4.2) Issuing of the order number

3.5.2.1 Description

Adds a purchase order event to a UI.


Purchase order event



elements

Component << Basic

Information

Request >>

S M Message_Type =

EPO



EOID S M


Order_Number Number of the purchase order Text S M

Order_Date Date of the purchase order Date S M

UI_Type Identification of UI types covered

by the purchase order (recorded

at the highest level of available

aggregation)


level UIs


level UIs



UIs

upUIs


covered by the purchase order

upUI(L) M M, if

UI_Type =

1 or 3


covered by the purchase order

aUI M M, if

UI_Type =

2 or 3

Order_commen

t

Description of the reason for

delayed recording of the purchase

order

Text S O


3.5.2.3 Response:

Purchase order – response



elements

Component <<

Basic Information

Response >>

S M Message_Type = EPO


{


"Event_Time": "2018-08-23T07:32:20.7878086+00:00",

"Order_Number": "1234",

"Order_Date": "2018-08-23T07:32:20.7878086+00:00",

"UI_Type": 1,

"upUIs": [ "5cd2729e-6acc-4479-b67e-a26a84a6e88b19071619",

"752a77aed2a34c47bc926a40bd2e6ef319071619" ],


"752a77aed2a34c47bc926a40bd2e6ef3" ],

"Order_comment": "Comments",

"Message_Type": "EPO",

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

}


HTTP Status 202

{

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

"Message_Type": "EPO",

"Error": false,

"Errors": null,


}



status



3.5.3 EPR – (4.3) Receipt of the payment

3.5.3.1 Description

Adds a payment record event to a UI.


Payment record event



elements

Component << Basic

Information

Request >>

S M Message_Type =

EPR



EOID S M


Payment_Date Date of the payment receipt Date S M

Payment_Type Type of payment Integer S M See PaymentType

Payment_Amount Amount of the payment Decimal S M

Payment_Currency Currency of the payment Currency S M

Payment_Payer1 Identification if the payer is

located in the EU


1 – Yes

Payment_Payer2 Identity of the payer EOID S M, if

Payment_

Payer1 = 1

Payer_Name Payer's registered legal name Text S M, if

Payment_

Payer1= 0

Payer_Address Payer's address – street

name, house number, postal

code and city

Text S M, if

Payment_

Payer1= 0

Payer_CountryReg Payer's country of registration Country S M, if

Payment_

Payer1 = 0

Payer_TAX_N Payer's tax registration

number

Text S M, if

Payment_

Payer1 = 0

Payment_Recipient Identity of the recipient EIOD S M

Payment_Invoice Indication if the payment

corresponds to the existing

invoice


1 – Yes

Invoice_Paid Number of the invoice paid

with the payment

Text S M, if

Payment_I

nvoice = 1

UI_Type Identification of UI types

covered by the payment

(recorded at the highest level

of available aggregation)

Integer S M, if

Payment_I

nvoice = 0

1 – only unit packet

level UIs


level UIs



UIs

upUIs



upUI(L) M M, if AND

Payment_I

nvoice = 0

UI_Type =

1 or 3



aUI M M, if AND

Payment_I

nvoice = 0

UI_Type =

2 or 3

Payment_comment Comments by the reporting

entity

Text S O


3.5.3.3 Response:

Payment record – response



elements

Component <<

Basic Information

Response >>

S M Message_Type = EPR


{


"Event_Time": "2018-08-23T07:32:20.7878086+00:00",

"Payment_Date": "2018-08-23T07:32:20.7878086+00:00",

"Payment_Type": 1,

"InvoiceType": 1,

"UI_Type": 1,

"Payment_Amount": 1.99,

"Payment_Currency": "EUR",

"Payment_Payer1": true,

"Payment_Payer2": "PayerId",

"Payer_Name": "PayerNmae",

"Payer_Address": "Address",

"Payer_CountryReg": "UK",

"Payer_TAX_N": "TaxId",

"Payment_Recipient": "PaymentRecipient",

"Payment_Invoice": 1,

"Invoice_Paid": "test" ,

"upUIs": [ "5cd2729e-6acc-4479-b67e-a26a84a6e88b19071619",

"752a77aed2a34c47bc926a40bd2e6ef319071619" ],


"752a77aed2a34c47bc926a40bd2e6ef3" ],

"Payment_comment": "Comments",

"Message_Type": "EPR",

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

}


HTTP Status 202

{

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

"Message_Type": "EPR",

"Error": false,

"Errors": null,


}




status


3.6 Recall

3.6.1 RCL – (5.0) Recalls of requests, operational and transactional messages

3.6.1.1 Description

Given a recall id (“Code” in the return of any message) The caller can mark that event invalid.

This is possible for message types 2-1, 2-2, 3-1 to 3-7, 4-1, 4-2 and 4-3)


Recall – request



elements

Component <<

Basic Information

Request >>

S M Message_Type = RCL



EOID S M

Recall_CODE Message recall code

provided to the message

sender in the

acknowledgement of the

original message to be

recalled

Text S M

Recall_Reason1 Reason for recalling the

original message

Integer S M See RecallReasonType

Recall_Reason2 Description of the reason

for recalling the original

message

Text S M, if

Recall_R

eason1

= 3

(other

reason)

Recall_Reason3 Any additional explanations

on the reason for recalling

the original message

Text S O

3.6.1.3 Response:

Recall – response



elements

Component <<

Basic Information

Response >>

S M Message_Type = RCL



{


"Recall_CODE":"6854f9a6-a2b2-4c08-8000-0173f3c35567",

"RecallReason1":1,

"RecallReason2":1,

"RecallReason3":"Comments",

"Message_Type":"RCL",

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

}


HTTP Status 202

{

"Code": "873345b2-882f-4064-91f0-90669b46c30a",

"Message_Type": "RCL",

"Error": false,

"Errors": null,


}



status


400 RECALL_TOO_LATE If the recall is performed after the 24

hours allowed since the original call.


4 List of Error Codes

4.1 Security errors HTTP

status

Error Code

401 Invalid security token

401 Expired security token

4.2 Processing errors HTTP

status

Error Code

400 FAILED_VALIDATION Generic validation error. Normally get more

detail as below.

400 REQUIRED_FIELD_FAILED_VALIDATION Mandatory fields is missing

400 MAX_LENGTH_ FAILED_VALIDATION Over max length of field.

400 INVALID_REQUEST_FORMAT No Type property added to message

400 INVALID_MESSAGE_TYPE When the field “Message_Type” is out of the

defined list.

400 UID_ALREADY_RECORDED Recall code in “Code” property has already

been used.

400 INVALID_INPUT_FORMAT When the body of the message doesn’t

contain a valid JSON.

500 SYSTEM_ERROR Internal system error. This internal error id

should be provided to Dentsu support if

required

4.3 Validation errors HTTP

status

Error Code

400 MULTIPLE_UID Multiple duplicate UI present in the messages

Related control: VAL_UI_MULT_MSG

400 UI_NOT_VALID UI validity – Exists without Timestamp in the

repository. (has never been applied).

When application of UI (with Timestamp)

occurs.

Related Control: VAL_UI_MULT_MSG

400 UIS_NOT_VALID UI(s) validity – One or more UIs without

Timestamp in the repository. (has never been

applied).

When application of UI (with Timestamp)

occurs.

Related Control: VAL_UI_MULT_MSG

400 UI_NOT_EXIST UI validity – Exists not in the repository. When

any message references UI

Related Control: VAL_UI_EXIST_TIME

400 EXCISE_NUMBER_NOT_VALID Seed type format wrong.


400 UI_EXPIRED Validation that the application or the

aggregation date doesn’t exceed the 6

months period after the code has been issued.

Related Control: VAL_UI_EXPIRY

400 UI_NOT_EXIST_OR_NOT_IN_STATE UI – UI is not applied after deactivation.

Or UID is not in correct state for activation

Related Control:

VAL_UI_ORD_REACTIVATION

400 SHIPMENT_WITHIN_24_HOURS "Within 24 hours prior to the occurrence of the

event” rule for dispatch and trans-loading

event messages is a strict rule and the system

shall reject non compliant messages.

Control is based on the “actual date –

Event_Time” time difference

Related Control: VAL_EVT_TIME

400 RECALL_AFTER_ONE_WORKING_DAY For requests of unit level or aggregated level

UIs (ISU, IRU, ISA, IRA), recalls can be

performed up to one working day after the

original message.

Related Control: VAL_EVT_RECALL

400 EIOD_NOT_EXIST_OR_ACTIVE Check if EOID, exists and is active

Related Control: VAL_ENT_EXIST_EOID

VAL_ENT_ACTIVE_EOID

400 FID_NOT_EXIST_OR_ACTIVE Check if FID, exists and is active

Related Controls:

VAL_ENT_EXIST_FID

VAL_ENT_ACTIVE_FID

400 MID_NOT_EXIST_OR_ACTIVE Check if MID, exists and is active

Related Controls:

VAL_ENT_EXIST_MID

VAL_ENT_ACTIVE_MID

400 FID_NOT_RELATED_TO_EOID Check if EOID FID relation

Related Control: VAL_ENT_REL_EOID_FID

400 CLAIM_VALIDATION_FAILED Caller is not allowed to call this method.

400 NON_COMPATIBLE_UIS Activation failed as ordered list of Uid with

timestamp, did not match short uids.

400 NOT_THE_SAME_NUMBER_OF_ITEMS Activation failed as number of of Uid with

timestamp, did not same number as short

uids.

dentsu aegis network data dictionary for ......eu secondary data dictionary for economic operators,...

Documents