MESSAGE IMPLEMENTATION GUIDE
Transcript of MESSAGE IMPLEMENTATION GUIDE
MESSAGE IMPLEMENTATION GUIDE
IDMS – H7
2/38
DOCUMENT HISTORY
DOCUMENT INFORMATION Settings Value
Document Name Message Implementation Guide – IDMS H7
Project Name UCC H7
Document Author Sarah Vanobberghen
Document version 1.2.3
REVISION HISTORY Version Date Description Action page
0.1.0 12/10/2020 First draft I all
0.2.0 12/02/2021 draft I,R 14 - 36
0.2.1 05/03/2021 draft I 5
1.0.0 06/05/2021 final R 6; 10; 17-20; 28
1.1.0 01/06/2021 Final I 10-11
1.1.1 08/06/2021 Final I, R 8; 7; 9
1.2.0 16/06/2021 Final I, R 8; 11-12; 6; 7; 9; 13
1.2.1 24/06/2021 Final R 8; 12; 19
1.2.2 01/07/2021 Final I 7; 8; 9
1.2.3 06/07/2021 Final R 19-23
(* Action: I = Insert, R = Replace
APPROVALS Name Title
DISTRIBUTION Name Title
Bart Cieters Program Manager D&A
Sarah Vanobberghen Project Manager D&A / Business Analyst D&A
Isabelle Sandor Project Manager D&A / Business Analyst D&A
Wouter de Vlieger Business Analyst D&A
Franck Denoel Service Manager ICT
3/38
CONTENTS Message Implementation Guide .............................................................................................................. 1
Document History ................................................................................................................................ 2
Document Information ...................................................................................................................... 2
Revision history ................................................................................................................................ 2
Approvals ......................................................................................................................................... 2
Distribution ....................................................................................................................................... 2
Contents ............................................................................................................................................... 3
EO Notification gateway description .................................................................................................... 5
Introduction ....................................................................................................................................... 5
Involved parties ............................................................................................................................. 5
Mechanism ................................................................................................................................... 5
Preliminary steps .............................................................................................................................. 5
SENDER Get credentials from FODFIN ....................................................................................... 5
SENDER setup call-back URL ..................................................................................................... 6
Retrieve the access token ................................................................................................................ 6
Sending declaration .......................................................................................................................... 7
HTTP header ................................................................................................................................ 7
Header in the XML ........................................................................................................................ 8
Endpoint for IDMS ........................................................................................................................ 8
Workflow ....................................................................................................................................... 8
Synchronous aknowledgement response ..................................................................................... 9
Asynchronous call-back response (push) ..................................................................................... 9
Optional security check of the response..................................................................................... 10
Restrict IP addresses .............................................................................................................. 10
Check signature of the messages ........................................................................................... 10
Asynchronous call-back response (PULL) ................................................................................. 11
API to find the list of notification ids that matches .................................................................. 11
API to retrieve one notification ................................................................................................ 12
Endpoint for EONGATEWAY ..................................................................................................... 12
Process model graphics ..................................................................................................................... 13
Information model .............................................................................................................................. 13
Information model content and structure ........................................................................................ 13
IE001 (H7 - Customs declaration for Low value consignment) ................................................. 13
Business Rules and error reason ............................................................................................ 19
IE928........................................................................................................................................... 24
IE906 - Invalid declaration .......................................................................................................... 24
IE416 - Customs declaration rejection ........................................................................................ 24
IE428 - Customs declaration acceptance ................................................................................... 25
IE429H7 - Release for import ..................................................................................................... 26
4/38
IE451H7 - No release ................................................................................................................. 30
IE414 - Request Of Customs Declaration Invalidation (Invalidation REQUEST) ...................... 34
Business Rules and error reason ............................................................................................ 35
IE410 - Acceptance of Invalidation Request (Cancellation Acceptance) .................................. 35
Information model content and structure ................................................................................ 35
error code ....................................................................................................................................... 36
Information model description ........................................................................................................ 38
XSD ................................................................................................................................................ 38
XML (example) ............................................................................................................................... 38
5/38
EO NOTIFICATION GATEWAY DESCRIPTION
INTRODUCTION The EO Notification Gateway is an application dedicated to deliver asynchronously response messages
to Economical Operator (EO).
INVOLVED PARTIES Declarant: Declaration responsible. Required to have authorizations related to his activities
Sender: The Sender (or Communication Provider) represents the system sending the messages for the
lodging of declarations and notifications from Economic Operators to Customs Authorities. It can be the
declarant or a customs agency, potentially using a solution provided by a software house. He needs
appropriate credentials provided by FODFin and proper callback messages configuration.
Customs: Receive and validate customs declarations
MECHANISM There are two alternatives to receive a response from the EO Notification Gateway, 2a and 2b :
1. Sender system submits a declaration
2a. Response is pushed to sender system by the EO Notification Gateway
2b. Sender system pull response from the EO Notification Gateway
3. Web interface for Declarant to manage declaration.
PRELIMINARY STEPS The following procedures must be followed by the Sender to communicate with Customs systems.
SENDER GET CREDENTIALS FROM FODFIN Sender provides by email the following information to the Customs helpdesk
• Official name
• Usual name
• ECB number (EORI, BCE or KBO number)
• Business Contact Person
• Name
• Technical Contact Person
• Name
6/38
• Name of the project(s)/web service(s) to which the clients needs access.
Upon reception of that information, clients will receive credentials:
• credentials (client_id, client_secret) to be used when requesting an access token
• scope(s) that characterize the information that the client has been authorized to access
for each project. E.g. ‘customsb2b’
SENDER SETUP CALL-BACK URL
Sender administrator send to [email protected].:
• the Callback URL(s)
• System Name
• Secret
The “secret” is a simple character string that will be used to calculate the X-signature header of
messages sent to the callback URL (see Check signature of the messages here below for details).
RETRIEVE THE ACCESS TOKEN Once the sender system receives its credentials (clientId/secrets), it sends a declaration by this way:
a. Sender system request access token using their credentials
b. FEDIAM validates request and provides an access token (validity 24h)
c. Sender system sends declaration + access token to target MinFin Customs system
The following endpoints must be called to retrieve the access token:
Endpoint Production :
https://fediam.minfin.fgov.be/sso/oauth2/realms/root/realms/externalws/access_token
Endpoint Acceptance :
https://fediam-a.minfin.be/sso/oauth2/realms/root/realms/externalws/access_token
The access token can be obtained by performing a HTTP POST request to the token endpoint with the
following parameters:
7/38
Example of access token request:
POST /sso/oauth2/realms/root/realms/externalws/access_token?
grant_type=client_credentials&scope=customsb2b
HTTP/1.1
Host: fediam-a.minfin.be
Accept: application/json
Content-Type: application/x-www-form-urlencoded
Authorization: Basic aWFtdGVzdCA6SWFNX1Qzc3Q=
Example of response:
{
"scope":“customsb2b",
"access_token": "SlAJKGE26734V32hkKG",
“token_type”: “Bearer”,
"expires_in":86400 }
Remark: it is highly recommended to use the same token to submit multiple declarations. This
avoids successive authentication and improve a lot the performances. A caching mechanism must
be put in place at client side.
SENDING DECLARATION
HTTP HEADER The obtained Access Token must be sent in the Authorization header of all web service requests to the
project endpoint as a Bearer token.
Query String Parameters
grant_type Must be ‘client_credentials’
Scope Must contain ‘customsb2b’
Headers
Authorization Must be ‘Basic’ base64(client id:client
secret)
Content-Type Must be Content-Type application/x-
www-form-urlencoded
8/38
Example of declaration HTTP header:
POST /idms HTTP/1.1
Host: eservices.minfin.fgov.be
Accept: application/json
Content-Type: Content-Type application/x-www-form-urlencoded
Authorization: Bearer SlAJKGE26734V32hkKG
HEADER IN THE XML The message header in the Body must contains the following fields:
• <sender>: systemName@enterpriseNumber, systemName is used to route back the message
and is linked to the callback URL (the systemName is optional, if it is the case the default URL
callback URL will be used)
• <recipient>: target system, PN, TSD, IDMS, NCTS followed by country code. This field is used
for info only
• <messageTimestamp>: The timestamp in ISO-8601 format (YYYY-MM-
DDT:hh:mm:ss.SSSSSSSSSZ).
• <MessageId>: sender message universal unique id number (it must be suffixed by the domain
name of the company)
• <languageCode>: the language of feedback to sender. May be different that the one from
declaration
Example:
<messageHeader>
<sender>systema@BE5512345678</sender>
<recipient>IDMS@BE</recipient>
<messageTimestamp>2020-06-01T18:44:22.123456789Z</messageTimestamp>
<messageId>5e4875fef975-4232-2340-3564b0e100d0.example.com</messageId>
<languageCode>EN</languageCode>
</messageHeader>
ENDPOINT FOR IDMS
IDMS ACC: https://wsapi-a.minfin.be/IDMS/B2B/OAU/v1/b2b/declarations
https://wsapi-a.minfin.be/IDMS/B2B/OAU/v1/b2b/declarations/invalidate
IDMS PROD: https://wsapi.minfin.fgov.be/IDMS/B2B/OAU/v1/b2b/declarations
https://wsapi.minfin.fgov.be/IDMS/B2B/OAU/v1/b2b/declarations/invalidate
WORKFLOW The diagram below displays the core flow process of the communication between the sender system
and the customs backend.
9/38
1. The Sender system sends a declaration to the Customs backend.
2. The Customs backend sends directly (synchronously) the technical validation response.
3. In case the technical validation succeeds, the Customs backend system sends one or multiple
responses to the EO notification Gateway.
4. The notifications are either pushed asynchronously to the Economical operator or pulled by the
economical operator.
Remark: we recommend clients to use a maximum of 3 threads for sending declarations. This is
needed to avoid performance issues at server side.
SYNCHRONOUS AKNOWLEDGEMENT RESPONSE In case the input message is technically validated (XSD compliant), the traders will receive a
synchronous response containing the correlationID. Based on this id they can eventually pull the
asynchronous response messages (with business validation).
Example of synchronous response:
<IE928>
<correlationId>4f4d6d42-4ce3-4d42-b6fb-8db5edec989f</correlationId>
</IE928>
ASYNCHRONOUS CALL-BACK RESPONSE (PUSH) In case the traders chose to use the push mechanism, the EO Notification Gateway will push the
business response to the defined callback URL. Here is an example of such business response:
<?xml version="1.0" encoding="UTF-8"?>
<IE416>
<MessageHeader>
<Sender>IDMS</Sender>
<Recipient> system@BE0214596464</Recipient>
10/38
<MessageTimestamp>2021-06-14T15:25:06</MessageTimestamp>
<MessageId>1b983f3e-31b3-4aff-bf0a-504453450f81</MessageId>
<CorrelationId>9dea8dcd-7a09-460a-8c33-50609aeddbd0</CorrelationId>
<Language>EN</Language>
</MessageHeader>
<Declaration>
<Lrn>KA2VVMNA4VIQ3BN3ROMF9M</Lrn>
<BusinessRejectionType>415</BusinessRejectionType>
<RejectionDate>2021-06-14T15:25:06</RejectionDate>
</Declaration>
<FunctionalError>
<SequenceNumber>1</SequenceNumber>
<ErrorPointer>IE001.GoodsShipment.SupportingDocument[1].Type</ErrorPointer>
<ErrorCode>12</ErrorCode>
<ErrorReason>CL213</ErrorReason>
<Remarks />
</FunctionalError>
</IE416>
OPTIONAL SECURITY CHECK OF THE RESPONSE
Restrict IP addresses In order to guarantee the origin of the messages received, the sender system can put in place a firewall
that would only accept requests from the following IP addresses of the SPF :
193.191.216.74, 75, 76, 77
Check signature of the messages The messages sent by EONGW to sender system contain the following headers:
X-signature : the hash (using SHA-256) of the message based on the secret defined in
the EONGW configuration
X-Message-type : The message type (ex: IE416)
Correlation-id : the correlation id (unique for all the transaction, ex: 1d89d76d-
117b-4907-9879-29d6203ddecf)
The X-signature is calculated by using the secret defined in EONGW database associated to the
callbackURL. The following java algorithm can be used to check this signature:
@PostMapping
public String retrieveResponseFromEongw(@RequestHeader("X-signature") String
signatureHeader, @RequestBody String xmlContent) throws URISyntaxException {
String signature = generateSignature("your_secret", xmlContent.getBytes());
if(signature.equals(signatureHeader)) {
11/38
log.info("Signature successful");
} else {
log.error("Signature incorrect. Generated:" + signature + " - in header:"
+ signatureHeader);
}
return "Ok";
}
public String generateSignature(String secret, byte[] messageContent) {
String signature = null;
try {
MessageDigest messageDigest = MessageDigest.getInstance("SHA-256");
messageDigest.update(secret.getBytes());
messageDigest.update(messageContent);
byte[] signArray = messageDigest.digest();
signature="Sha256=" + new String(Base64.getEncoder()
.encodeToString(signArray));
} catch (NoSuchAlgorithmException e) {
log.error("Error in generating Signature");
}
return signature;
}
ASYNCHRONOUS CALL-BACK RESPONSE (PULL) Instead of getting messages with the push mechanism, sender systems can retrieve responses by
calling the API of EO Notification Gateway. The same token as the one used to send declarations to
IDMS can be used (the scope will remain : customsb2b).
Retrieving a message from EO Notification Gateway must be done in 2 steps. First we need to search
the notification ids that matches some parameters (like correlationId). Secondly we can retrieve the
message itself with the notification id got in the previous step.
API to find the list of notification ids that matches
GET /notifications¶meter=value
The parameters can be:
• correlationId : optional, the correlation identification number
• system: optional, matching ‘system name’ given when submitting the request (e.g.
systema)
• limit: optional, maximum number of notifications retrieved (default: 50, max:250)
• since_id: optional, notifications after the given notificationId
• sent : optional (default=false), if the message has been already sent
12/38
Response format will be the one defined in the content type of the Accept header (xml or json).
Example of response:
{notifications:
[ {href: "/notifications/1d89d76d-117b-4907-9879-29d6203ddecf},
{href: "/notifications/1d89d76d-117b-4907-9879-29d6203ddecf"}
]}
The ids retrieved can be used then to retrieve the response message with the following API:
API to retrieve one notification
GET /notifications/{notificationId}
Pull one message based on the notification id (notice that the notification id is NOT the correlation id).
Response is the actual xml or json message. The header will contain the following informations:
• The message type and its version (e.g. IE416v1.0)
• The correlationID
• The notificationID
Note: notifications will be stored in the EO Notification Gateway during 1 month
ENDPOINT FOR EONGATEWAY
Eongateway ACC: https://wsapi-a.minfin.be/EO/Notification/OAU/v1/b2b/eoNotifications
Eongateway Prod: https://wsapi.minfin.fgov.be/EO/Notification/OAU/v1/api/v1/b2b/eoNotifications
13/38
PROCESS MODEL GRAPHICS
INFORMATION MODEL
INFORMATION MODEL CONTENT AND STRUCTURE
IE001 (H7 - CUSTOMS DECLARATION FOR LOW VALUE CONSIGNMENT)
Occurs IDMS Name -
With Business
changes
IDMS XML Name Identification
Number
Format Businees
rules
IE001 - Customs
declaration for Low
value consignment
IE001
1..1 Message header MessageHeader Not defined in
EUCDM
/
1..1 Sender Sender Not defined in
EUCDM
an..35
1..1 Recipient Recipient Not defined in
EUCDM
an..35
1..1 Message timestamp MessageTimestamp Not defined in
EUCDM
Timestamp
1..1 Message id MessageId Not defined in
EUCDM
an..35
1..1 Language Language Not defined in
EUCDM
a2
1..1 Declaration Declaration Not defined in
EUCDM
/
14/38
1..1 LRN Lrn 12 09 an..22 BR_033
1..1 Additional
declaration type
AdditionalDeclarationType
11 02
0..1 Deferred payment DeferredPayment 12 10 an..35 BR_017
BR_038
1..1 Importer Importer 13 04 /
0..1 Name Name 016 an..70
0..1 Identification
number
IdentificationNumber 017 an..17 BR_008
BR_010
BR_029
BR_039
BR_043
BR_045
BR_054
BR_056
BR_057
BR_059
BR_060
0..1 Address Address 018 /
1..1 Street and number StreetAndNumber 019 an..70
1..1 Postcode Postcode 021 an..17
1..1 City City 022 an..35
1..1 Country Country 020 a2
1..1 Declarant Declarant 13 05 /
0..1 Name Name 016 an..70
0..1 Identification
number
IdentificationNumber 017 an..17 BR_002
BR_007
BR_010
BR_029
BR_039
BR_042
BR_043
BR_055
BR_056
BR_057
BR_058
0..1 Address Address 018 /
1..1 Street and number StreetAndNumber 019 an..70
1..1 Postcode Postcode 021 an..17
1..1 City City 022 an..35
1..1 Country Country 020 a2
0..9 Contact person ContactPerson 074 /
0..1 Name Name 016 an..70
0..1 Phone number PhoneNumber 075 an..35
0..1 E-mail address EMailAddress 076 an..256
0..1 Representative Representative 13 06 /
1..1 Identification
number
IdentificationNumber 017 an..17 BR_029
BR_051
BR_057
BR_061
1..1 Status Status 030 n1 BR_010
15/38
BR_015
BR_055
BR_056
BR_062
0..9 Contact person ContactPerson 074 /
0..1 Name Name 016 an..70
0..1 Phone number PhoneNumber 075 an..35
0..1 E-mail address EMailAddress 076 an..256
0..1 Phone number PhoneNumber 075 an..35
0..1 E-mail address EMailAddress 076 an..256
1..1 Goods Shipment GoodsShipment Not defined in
EUCDM
/
0..1 Exporter Exporter 13 01 / BR_025
BR_026
1..1 Name Name 016 an..70
1..1 Address Address 018
1..1 Street and number StreetAndNumber 019 an..70
1..1 Postcode Postcode 021 an..17
1..1 City City 022 an..35
1..1 Country Country 020 a2
0..9999 Previous document PreviousDocument 12 01 BR_004
BR_005
BR_024
1..1 Reference number ReferenceNumber 001 an..70
1..1 Type Type 002 an..4
1..99 Supporting
document
SupportingDocument 12 03
1..1 Reference number ReferenceNumber 001 an..70
1..1 Type Type 002 an4
0..99 Additional reference AdditionalReference 12 04 /
1..1 Reference number ReferenceNumber 001 an..70
1..1 Type Type 002 an4
0..99 Additional
information
AdditionalInformation 12 02 /
0..1 Code Code 008 an5
0..1 Text Text 009 an..512
0..99 Additional fiscal
reference
AdditionalFiscalReference 13 16 /
1..1 Role Role 031 an3 BR_027
BR_031
BR_032
BR_041
BR_049
BR_050
1..1 Vat identification
number
VatIdentificationNumber 034 an..17 BR_040
1..1 Consignment Consignment Not defined in
EUCDM
/
0..1 Reference number
UCR
ReferenceNumberUcr 12 08 an..35
1..1 Gross mass GrossMass 18 04 n..16,6 BR_020
16/38
BR_021
1..1 Location of goods LocationOfGoods 16 15 /
1..1 Type of location TypeOfLocation 045 a1
1..1 Qualifier of
identification
QualifierOfIdentification 046 a1
1..1 Un Locode UnLocode 036 an..17
0..1 Customs office CustomsOffice 047 /
1..1 Reference number ReferenceNumber 001 an8
0..1 GNSS Gnss 048 /
1..1 Latitude Latitude 049 an..17
1..1 Longitude Longitude 050 an..17
0..1 Economic operator EconomicOperator 051 /
1..1 Identification
number
IdentificationNumber 017 an..17
0..1 Authorisation
number
AuthorisationNumber 052 an..35
0..1 Additional identifier AdditionalIdentifier 053 an..4
0..1 Address Address 018 /
1..1 Street and number StreetAndNumber 019 an..70
1..1 Postcode Postcode 021 an..17
1..1 City City 022 an..35
1..1 Country Country 020 a2
0..1 Postcode Postcode 081 /
1..1 Postcode Postcode 021 an..17
1..1 House number HouseNumber 025 an..35
1..99 Transport document TransportDocument 12 05 / BR_022
1..1 Reference number ReferenceNumber 001 an..70
1..1 Type Type 002 an4
0..1 Transport and
insurance costs to
the destination
TransportCostsToTheDestination 14 15 / BR_019
1..1 Currency Currency [CurrencyCode in EU v6] 012 a3
1..1 Amount Amount 014 n..16,2
1..999 Goods shipment
item
GoodsShipmentItem Not defined in
EUCDM
/
1..1 Goods item number GoodsItemNumber 11 03 001 n..5
0..1 Reference number
UCR
ReferenceNumberUcr 12 08 001 an..35
1..99 Additional procedure AdditionalProcedure 11 10 001 an3 BR_003
BR_045
BR_047
BR_048
BR_049
BR_050
BR_054
BR_058
BR_059
BR_060
BR_061
BR_062
0..1 Exporter Exporter 13 01 / BR_025
17/38
BR_026
1..1 Name Name 016 an..70
1..1 Address Address 018 /
1..1 Street and number StreetAndNumber 019 an..70
1..1 Postcode Postcode 021 an..17
1..1 City City 022 an..35
1..1 Country Country 020 a2
1..1 Commodity Commodity Not defined in
EUCDM
/
1..1 Description of goods DescriptionOfGoods 18 05 an..512
1..1 Commodity code CommodityCode 18 09 /
1..1 Harmonized System
sub-heading code
HarmonizedSystemSubHeadingCode 056 an6..8
1..1 Goods measure GoodsMeasure Not defined in
EUCDM
/
1..1 Gross mass GrossMass 18 04 n..16,6 BR_034
0..1 Supplementary units SupplementryUnits 18 02 n..16,6
1..1 Intrinsic value IntrinsicValue 14 14 /
1..1 Currency code CurrencyCode 012 a3
1..1 Amount Amount 014 n..16,2 BR_018
BR_019
BR_047
0..1 Transport and
insurance costs to
the destination
TransportCostsToTheDestination 14 15 / BR_019
1..1 Currency code CurrencyCode 012 a3
1..1 Amount Amount 014 n..16,2
1..1 Duties and taxes DutiesAndTaxes 14 03 /
1..1 Method of payment MethodOfPayment 038 a1 BR_017
BR_028
BR_037
BR_038
BR_039
BR_041
BR_062
BR_063
0..99 Packaging Packaging 18 06 /
1..1 Number of packages NumberOfPackages 004 n..8 BR_022
BR_035
0..99 Previous document PreviousDocument 12 01 / BR_004
BR_005
BR_024
1..1 Reference number ReferenceNumber 001 an..70
1..1 Type Type 002 an..4
0..99 Supporting
document
SupportingDocument 12 03 /
1..1 Reference number ReferenceNumber 001 an..70
1..1 Type Type 002 an4
0..99 Additional reference AdditionalReference 12 04 /
1..1 Reference number ReferenceNumber 001 an..70
18/38
1..1 Type Type 002 an4
0..99 Additional
information
AdditionalInformation 12 02 /
0..1 Code Code 008 an5
0..1 Text Text 009 an..512
0..99 Transport document TransportDocument 12 05 / BR_036
1..1 Reference number ReferenceNumber 001 an..70
1..1 Type Type 002 an4
0..99 Additional fiscal
reference
AdditionalFiscalReference 13 16 /
1..1 Role Role 031 an3 BR_027
BR_031
BR_032
BR_041
BR_049
BR_050
1..1 Vat identification
number
VatIdentificationNumber 034 an..17 BR_040
19/38
Business Rules and error reason
Business
Rule ID
Business Rule
Name
Application Validation Rule Error reason
H7_BR_002 Country of Declarant
must be an allowed
country
The 020 Country of the 018 Adress of the 1305
Declarant must be in the country code list
CountryCodesCommunity (CL010) from CSRD2
H7BEC0001
H7_BR_003 Additional procedure
must be an allowed
value
Additional procedure (1110) of a goods shipment
Item must be equal to one of the following codes:
“C07”, “C08”, “F48” or “F49”
Only the 4 following combinations are allowed : C08
alone C07 alone C07 & F48 : C07 can be used with
F48 C07 & F49: C07 can be used with F49
H7BEC0007
H7_BR_004 The MRN of an ENS
as previous
document must be
format checked
If 002 Type of 1201 Previous document at Goods
Shipment OR Goods Item level = "355" Then 001
Reference Number of 1201 'Previous document'
must be a valid MRN for an ENS document. (see
format description of an MRN in 'STORY - Generate
MRN' so field 4 must refer to a ENS declaration = 'T')
H7BEC0003
H7_BR_005 The MRN of an TSD
as previous
document must be
format checked
If 002 Type of 1201 Previous document = 337 Then
001 Reference Number of 1201 'Previous
document' must be a valid MRN for an TSD
document. (see format description of an MRN in…,
so field 4 must refer to n TSD declaration 'U')
H7BEC0004
H7_BR_007 Name and address
are mandatory when
EORI number is
empty
IF 017 identification Number of the 1305 Declarant
= empty. THEN fields 016 Name and 018 Address
information of the 1305 Declarant must be filled in.
H7BEC0006
H7_BR_008 Name and address
are mandatory when
EORI number is
empty
IF 017 identification Number of the 1304 Importer =
empty.
THEN fields 016 Name and 018 Adress of the 1304
Importer must be filled in.
H7BEC0008
H7_BR_010 For direct
representation,
Representative must
be different from
Importer
IF 030 Status Code of the 1306 Representative = '2'
THEN 017 Identification Number of the 1306
Representative must be different from 017
Identification Number of the 1304 Importer and
1305 Declarant
H7BEC0010
H7_BR_015 Representative can
only be direct or
indirect
representation
030 Status Code of the 1306 Representative can
only contain the value '2' or '3'
H7BEC0015
H7_BR_017 Customer account
mandatory for
postponed payment
or FRCT
IF the Method of payment (038) of the Calculation of
Taxes (14 03) of a Goods Item IS equal to 'E' (Credit
Account) or 'P' (FRCT) Then ‘Deferred payment’ (12
10) of the H7 is mandatory
H7BEC0017
H7_BR_018 Value must be
greater than zero
The 014 Amount of the 1414 Value >0 H7BEC0018
H7_BR_019 The value in EUR
must be less or equal
to 150€
IF 012 Currency of the 1414 Value = 'EUR' for all
Goods Items THEN the count of 014 Amount of the
H7BEC0019
20/38
1414 Value from each Goods Item cannot be greater
than 150'
H7_BR_020 Total gross mass
validation
The sum of 1804 Gross mass of each Goods Item
must be at least the sum of the 1804 'Gross mass
(kg)' of the Consignment at Shipment level
H7BEC0020
H7_BR_021 Total Gross Mass not
negative
The 1804 Gross mass of the Consignment at header
(=declaration) level must be >0
H7BEC0021
H7_BR_022 Number of packages
is mandatory except
for postal
consignments.
IF 002 Type of the 1205 Transport document is not
"N750" at Goods Shipment level THEN 004 Number
of packages of the 1806 Packaging is mandatory.
H7BEC0022
H7_BR_024 Previous document
validation
If 1201 Previous document = 'empty' on header
level THEN 1201 Previous document is mandatory
for each Goods item
H7BEC0024
H7_BR_025 If exporter is present
on header level there
cannot be an
exporter added for an
item
IF 1301 Exporter = 'value' on Header level THEN
Exporter = 'empty' for each Goods Item.
H7BEC0025
H7_BR_026 If there is no exporter
on header level there
must be an exporter
for each article.
IF 1301 Exporter = 'empty' on Header level THEN
Exporter = 'value' for each Goods Item.
H7BEC0026
H7_BR_027 Additonal fiscal
reference role 'IOSS'
and deferral of VAT
can only be used on
header level. Not on
goods item level.
Only one buyer per
declaration
The Role (031) of any Additional Fiscal reference
(1316) of a Goods Item can NOT be equal to 'FR5' or
'FR7' or 'FR1'
H7BEC0027
H7_BR_028 For H7 Method of
payment must be
equal for each
GoodsItem
038 Method of Payment must be equal for each
Goods Items
H7BEC0028
H7_BR_029 BEPRIVATEPERSON
is not a valid EORI.
The Identification Number (017) of the Importer
(1304), Representative (1306) or Declarant (1305)
can not be equal to "BEPRIVATEPERSON".
H7BEC0029
H7_BR_031 Maximum one
occurence of Fiscal
Reference per role
allowed
The Role (031) of the Additional fiscal reference
(1316) must be unique at the Goods Shipment level.
H7BEC0031
H7_BR_032 No IOSS and VAT
deferral
If the role (031) of an Additional fiscal reference
(1316) on header level is equal to 'FR5', then there
cannot be another additional fiscal reference (1316)
with role (031) equal to 'FR7'
And If the role (031) of an Additional fiscal reference
(1316) on header level is equal to 'FR7', then there
cannot be another additional fiscal reference (1316)
with role (031) equal to 'FR5'
H7BEC0032
21/38
H7_BR_033 LRN must be unique
per declarant
The 1209 LRN of each Declaration must be unique
per declarant. (Based on 017 IdentificationNumber
of the 1305 Declarant)
H7BEC0033
H7_BR_034 Gross Mass of goods
item not negative
The 1804 Gross mass of each Goods Item must
must be >0
H7BEC0034
H7_BR_035 Number of packages
not negative
numberOfPackages (004) for each Packaging (18
06) of each GoodsItem must be >0
H7BEC0035
H7_BR_036 Postal consignments. 002 Type of the 1205 Transport document at Goods
Item level cannot be "N750".
H7BEC0036
H7_BR_037_A Deferral of VAT
related data
If the Role (031) of one of the Additional Fiscal
references (1316) at Goods Shipment (header) level
= "FR7"
THEN the 038 Method of Payment of the Duties and
Taxes of 1403 Calculation of Taxes = "G" For each
Goods Item
H7BEC0037
H7_BR_037_B Deferral of VAT
related data
If 038 Method of Payment of the Duties and Taxes
of 1403 Calculation of Taxes = "G" For each Goods
Item THEN The Role (031) of one of the Additional
Fiscal references (1316) at Goods Shipment (header)
level = "FR7"
H7BEC0047
H7_BR_038 Customer account
not needed for
anything but
postpone payment or
FRCT
IF the Method of payment (038) of the goods item
with goodsItemNumber (11 03) = '1' is >< from 'E'
(postponement of payment) and from 'P' (FRCT)
Then ‘Deferred payment’ (12 10) of the H7 is EMPTY
H7BEC0038
H7_BR_039 customer account
can only be used by
professionals
IF the 017 Identification Number of the 1304
Importer = Empty AND the 017 Identification
Number of the 1305 Declarant = Empty. AND the
030 Status of the 1306 Representative is NOT = "2"
THEN, The 038 Method of Payment of the Duties
and Taxes of the 1403 Calculation of Taxes can not
be = "E" or "P"
H7BEC0039
H7_BR_040 Format IOSS VAT ID IF 13 16 Additional Fiscal Reference has a 031 Role
with a value = "FR5" at header level
THEN The IOSS VAT Identification Number ="IM[0-
9]{10}"
H7BEC0040
H7_BR_041 No payment for IOSS
and Gift less than
45€
The 038 Method of Payment of the Duties and
Taxes of the 1403 Calculation of Taxes must be
empty when:
The 031 Role of the 13 16 Additional fiscal
references at Goods Shipment level is equal to ‘FR5’
The Additional procedure (11 10 001) of the Goods
Item is equal to ‘C08’
In all other cases the 038 Method of Payment of the
Duties and Taxes of the 1403 Calculation of Taxes is
mandatory.
H7BEC0041
H7_BR_042 Name and adress
empty if EORI
Declarant populated
IF 017 Identification No. of the 1305 Declarant is not
empty THEN 016 Name of the 1305 Declarant &
018 Address of the 1305 Declarant should be NULL
H7BEG0042
22/38
H7_BR_043 Name and adress
empty if EORI
Importer populated
IF 017 Identification No. of the 1304 Importer is not
empty THEN 016 Name of the 1304 Importer & 018
Adress of the 1304 Importer should be NULL
H7BEG0043
H7_BR_045 IOSS use IF the 1110 Additional procedure of a goods Item is
equal to F48 THEN the 017 Identification No. of the
1304 Importer must be empty THEN 016 Name of
the 1304 Importer & 018 Adress of the 1304
Importer should be filled in
H7BEC0045
H7_BR_047 Total price of gifts When the 012 Currency of the 1414 Value is Euro
for all goods items which have an 11 10 Additional
procedure equal to C08
Then the sum of "the 014 Amount of the 1414
Value" for all goods items with 1110 Additional
procedure equal to C08 must be less than or equal
to 45
H7BEC0053
H7_BR_048 Identical Additional
Procedures for all
shipment items.
Additional procedure (11 10) of all shipment Items
must be identical.
And if there is a shipment Item with more than one
allowed "Additional Procedure", all the other
shipment items must have the same combination.
H7BEC0054
H7_BR_049 Matching role &
additional procedure
If the Role (031) of the Additional fiscal reference
(1316) at goods shipment level equal to FR5, then
the additional procedure must be equal to "C07 &
F48"
H7BEC0049
H7_BR_050 Matching additional
procedure & role
If the additional procedure at goods shipment item
level is equal to "C07 & F48", then the Role (031) of
the Additional fiscal reference (1316) at goods
shipment level must be equal to FR5
H7BEC0050
H7_BR_051 EORI number is
mandatory for a
direct representative
If there is a direct representative in the declaration
(representative status =2), then the EORI number of
the representative must be filled in
H7BEC0051
H7_BR_054 Special arrangement
use
IF the 1110 Additional procedure of a goods Item is
equal to F49 THEN the 017 Identification No. of the
1304 Importer must be empty THEN 016 Name of
the 1304 Importer & 018 Adress of the 1304
Importer should be filled in
H7BEC0054
H7_BR_055 In case of indirect
representation, there
must always be a
declarant
If there is an indirect representative in the
declaration (representative status =3), then the
EORI number of the declarant must be filled in
H7BEC0055
H7_BR_056 In case of direct
representation or no
representation,
declarant is the same
as importer
If there is a direct representation (representative
status = 2) OR no representation (representative
status is empty), THEN the EORI number of the
declarant must be equal to the EORI number of the
importer
H7BEC0056
H7_BR_057 At least one EORI is
needed (Importer,
Declarant or
Representative)
when declaration is
sent through an
electronic message
IF the declaration is sent through an electronic
message then there is an EORI number either for the
Importer or for the Declarant or for the
Representative
H7BEC0057
23/38
H7_BR_058 The EORI of the
declarant is
mandatory for a
declaration with
special
arrangements.
If Additional procedure (11 10 001) of the Goods
Item with goodsItemNumber (11 03) = ‘1’ is equal to
‘F49’ then the IdentificationNumber (017) of the
Declarant (13 05) is required.
H7BEC0158
H7_BR_059 The EORI of the
importer must be
empty for a
declaration with
special arrangements
If Additional procedure (11 10 001) of the Goods
Item with goodsItemNumber (11 03) = ‘1’ is equal to
‘F49’ then the IdentificationNumber (017) of the
Importer (13 04) must be empty.
H7BEC0159
H7_BR_060 The country of the
importer must be
equal to 'BE' for a
declaration with
special
arrangements
If Additional procedure (11 10 001) of the Goods
Item with goodsItemNumber (11 03) = ‘1’ is equal to
‘F49’ then the Country (020) of the Importer (13 04)
must be equal to 'BE'.
H7BEC0160
H7_BR_061 The representative is
mandatory for a
declaration with
special arrangements
If Additional procedure (11 10 001) of the Goods
Item with goodsItemNumber (11 03) = ‘1’ is equal to
‘F49’ then a Representative (13 06) required
H7BEC0161
H7_BR_062 The status of the
representative must
be 3 for a declaration
with special
arrangements
If Additional procedure (11 10 001) of the Goods
Item with goodsItemNumber (11 03) = ‘1’ is equal to
‘F49’ then the Status (030) of the Representative
(13 06) must be equal to '3'..
H7BEC0162
H7_BR_063 The method of
payment must be
FRCT for a
declaration with
special arrangements
If Additional procedure (11 10 001) of the Goods
Item with goodsItemNumber (11 03) = ‘1’ is equal to
‘F49’ then the MethodOfPayment (038) of the
CalculationOfTaxes (14 03) must be equal to 'P'.
H7BEC0163
H7_BR_065 Additional declaration
type always A
The Additional declaration type must be A for H7
(without prelodge)
H7BEC0065
24/38
IE928
Occurs IDMS Name - With Business changes
IDMS XML Name Identification Number
Format
IE928
1..1 Correlation id CorrelationId an36
IE906 - INVALID DECLARATION
Occurs IDMS Name IDMS XML Name Identification
Number Format
IE906 - Invalid declaration IE906
1..1 Message header MessageHeader Not defined in EUCDM /
1..1 Sender Sender Not defined in EUCDM an..35
1..1 Recipient Recipient Not defined in EUCDM an..35
1..1 Message timestamp MessageTimestamp Not defined in EUCDM Timestamp
1..1 Message id MessageId Not defined in EUCDM an..36
1..1 Language Language Not defined in EUCDM a2
1..* Functionnal error FunctionnalError Not defined in EUCDM
0..1 Sequence number SequenceNumber Not defined in EUCDM n..5
1..1 Error pointer ErrorPointer Not defined in EUCDM an..512
1..1 Error code ErrorCode Not defined in EUCDM n2
1..1 Error reason ErrorReason Not defined in EUCDM an..10
1..1 Original Attribute Value OriginalAttributeValue Not defined in EUCDM an..512
IE416 - CUSTOMS DECLARATION REJECTION
Occurs IDMS Name IDMS XML Name Identification Number
Format
IE416 - Customs
declaration rejection
IE416
1..1 Message header MessageHeader /
1..1 Sender Sender an..35
1..1 Recipient Recipient an..35
1..1 Message timestamp MessageTimestamp Timestamp
1..1 Message id MessageId an..36
1..1 Correlation id CorrelationId an36
1..1 Language Language a2
1..1 Declaration
1..1 LRN Lrn an..22
1..1 Business rejection type RejectionMotivationText an3
1..1 Rejection date RejectionDate Timestamp
0..1 Rejection code RejectionCode n1
0..1 Rejection reason RejectionReason an..512
1..* Functionnal error FunctionnalError
1..1 Sequence number SequenceNumber n..5
0..1 Error pointer ErrorPointer an..512
1..1 Error code ErrorCode n2
0..1 Error reason ErrorReason an..10
0..1 Remarks Remarks an..512
25/38
IE428 - CUSTOMS DECLARATION ACCEPTANCE
Occurs IDMS Name IDMS XML Name Identification
Number Format
IE428 - Customs
declaration acceptance
IE428
1..1 Message header MessageHeader Not defined in
EUCDM
/
1..1 Sender Sender Not defined in
EUCDM
an..35
1..1 Recipient Recipient Not defined in
EUCDM
an..35
1..1 Message timestamp MessageTimestamp Not defined in
EUCDM
Timestamp
1..1 Message id MessageId Not defined in
EUCDM
an..36
1..1 Correlation id CorrelationId Not defined in
EUCDM
an36
1..1 Language Language Not defined in
EUCDM
a2
1..1 Declaration Declaration Not defined in
EUCDM
/
1..1 LRN Lrn 12 09 001 an..22
1..1 Movement reference
number
MovementReferenceNumber Not defined in
EUCDM
an..18
1..1 Date of acceptance DateOfAcceptance Not defined in
EUCDM
Timestamp
1..1 Declarant Declarant 13 05 /
0..1 Name Name 016 an..70
0..1 Identification number IdentificationNumber 017 an..17
0..1 Address Address 018 /
1..1 Street and number StreetAndNumber 019 an..70
1..1 Postcode Postcode 021 an..17
1..1 City City 022 an..35
1..1 Country Country 020 a2
0..1 Representative Representative 13 06 /
0..1 Identification number IdentificationNumber 017 an..17
1..1 Status Status 030 n1
1..1 Goods Shipment GoodsShipment Not defined in
EUCDM /
1..999 Goods shipment item GoodsShipmentItem
Not defined in
EUCDM
/
1..1 Goods item number GoodsItemNumber 11 03 001 n..5
1..1 Commodity Commodity
Not defined in
EUCDM
/
0..1 Calculation of taxes CalculationOfTaxes /
1..1 Total duties and taxes
amount TotalDutiesAndTaxesAmount
14 16 n..16,2
1..99 Duties and taxes DutiesAndTaxes 14 03 /
1..1 Tax type TaxType 039 an3
1..1 Payable tax amount PayableTaxAmount 042 n..16,2
26/38
1..1 Method of payment MethodOfPayment 038 a1
1..99 Tax base TaxBase 040 /
1..1 Tax rate TaxRate 041 n..17,3
1..1 Measurement unit and
qualifier MeasurementUnitAndQualifier
005 an..4
1..1 Quantity Quantity 006 n..16,6
1..1 Amount Amount 014 n..16,2
1..1 Tax amount TaxAmount 043 n..16,2
IE429H7 - RELEASE FOR IMPORT
Occurs IDMS Name - With
Business changes IDMS XML Name
Identification
Number Format
IE429H7 - Release
for import
IE429H7
1..1 Message header MessageHeader Not defined in
EUCDM
/
1..1 Sender Sender Not defined in
EUCDM
an..35
1..1 Recipient Recipient Not defined in
EUCDM
an..35
1..1 Message timestamp MessageTimestamp Not defined in
EUCDM
Timestamp
1..1 Message id MessageId Not defined in
EUCDM
an..35
1..1 Language Language Not defined in
EUCDM
a2
1..1 Declaration Declaration Not defined in
EUCDM
/
1..1 LRN Lrn 12 09 001 an..22
1..1 Movement reference
number MovementReferenceNumber
Not defined in
EUCDM an18
1..1 Additional
declaration type
AdditionalDeclarationType
11 02 001 a1
1..1 Date of acceptance DateOfAcceptance Not defined in
EUCDM
Timestamp
1..1 Date of release DateOfRelease Not defined in
EUCDM Timestamp
0..1 Deferred payment DeferredPayment 12 10 001 an..35
1..1 Importer Importer 13 04 /
0..1 Name Name 016 an..70
0..1 Identification number IdentificationNumber 017 an..17
0..1 Address Address 018 /
1..1 Street and number StreetAndNumber 019 an..70
1..1 Postcode Postcode 021 an..17
1..1 City City 022 an..35
1..1 Country Country 020 a2
1..1 Declarant Declarant 13 05 /
0..1 Name Name 016 an..70
0..1 Identification number IdentificationNumber 017 an..17
0..1 Address Address 018 /
27/38
1..1 Street and number StreetAndNumber 019 an..70
1..1 Postcode Postcode 021 an..17
1..1 City City 022 an..35
1..1 Country Country 020 a2
0..9 Contact person ContactPerson 074 /
0..1 Name Name 016 an..70
0..1 Phone number PhoneNumber 075 an..35
0..1 E-mail address EMailAddress 076 an..256
0..1 Representative Representative 13 06 /
0..1 Identification number IdentificationNumber 017 an..17
1..1 Status Status 030 n1
0..9 Contact person ContactPerson 074 /
0..1 Name Name 016 an..70
0..1 Phone number PhoneNumber 075 an..35
0..1 E-mail address EMailAddress 076 an..256
1..1 Goods Shipment GoodsShipment
Not defined in
EUCDM
/
0..1 Exporter Exporter 13 01 /
1..1 Name Name 016 an..70
1..1 Address Address 018
1..1 Street and number StreetAndNumber 019 an..70
1..1 Postcode Postcode 021 an..17
1..1 City City 022 an..35
1..1 Country Country 020 a2
0..9999 Previous document PreviousDocument 12 01 /
1..1 Reference number ReferenceNumber 001 an..70
1..1 Type Type 002 an..4
1..99 Supporting
document SupportingDocument
12 03 /
1..1 Reference number ReferenceNumber 001 an..70
1..1 Type Type 002 an4
0..99 Additional reference AdditionalReference 12 04 /
1..1 Reference number ReferenceNumber 001 an..70
1..1 Type Type 002 an4
0..99 Additional
information AdditionalInformation
12 02 /
0..1 Code Code 008 an5
0..1 Text Text 009 an..512
0..99 Additional fiscal
reference AdditionalFiscalReference
13 16 /
1..1 Role Role 031 an3
1..1 Vat identification
number VatIdentificationNumber
034 an..17
1..1 Consignment Consignment
Not defined in
EUCDM
/
0..1 Reference number
UCR ReferenceNumberUcr
12 08 001 an..35
1..1 Gross mass GrossMass 18 04 001 n..16,6
1..1 Location of goods LocationOfGoods 16 15 /
1..1 Type of location TypeOfLocation 045 a1
28/38
1..1 Qualifier of
identification QualifierOfIdentification
046 a1
1..1 Un Locode UnLocode 036 an..17
0..1 Customs office CustomsOffice 047 /
1..1 Reference number ReferenceNumber 001 an8
0..1 GNSS Gnss 048 /
1..1 Latitude Latitude 049 an..17
1..1 Longitude Longitude 050 an..17
0..1 Economic operator EconomicOperator 051 /
1..1 Identification number IdentificationNumber 017 an..17
0..1 Authorisation
number AuthorisationNumber
052 an..35
0..1 Additional identifier AdditionalIdentifier 053 an..4
0..1 Address Address 018 /
1..1 Street and number StreetAndNumber 019 an..70
1..1 Postcode Postcode 021 an..17
1..1 City City 022 an..35
1..1 Country Country 020 a2
0..1 Postcode Postcode 081 /
1..1 Postcode Postcode 021 an..17
1..99 Transport document TransportDocument 12 05 /
1..1 Reference number ReferenceNumber 001 an..70
1..1 Type Type 002 an4
0..1 Transport and
insurance costs to
the destination
TransportCostsToTheDestination
14 15 /
1..1 Currency Currency 012 a3
1..1 Amount Amount 014 n..16,2
1..999 Goods shipment item GoodsShipmentItem
Not defined in
EUCDM
/
1..1 Goods item number GoodsItemNumber 11 03 001 n..5
0..1 Reference number
UCR ReferenceNumberUcr
12 08 001 an..35
1..1 Additional procedure AdditionalProcedure 11 10 001 an3
0..1 Exporter Exporter 13 01 /
1..1 Name Name 016 an..70
1..1 Address Address 018 /
1..1 Street and number StreetAndNumber 019 an..70
1..1 Postcode Postcode 021 an..17
1..1 City City 022 an..35
1..1 Country Country 020 a2
1..1 Commodity Commodity
Not defined in
EUCDM
/
1..1 Description of goods DescriptionOfGoods 18 05 001 an..512
1..1 Commodity code CommodityCode 18 09 /
1..1 Harmonized System
sub-heading code HarmonizedSystemSubHeadingCode
056 an6..8
1..1 Goods measure GoodsMeasure
Not defined in
EUCDM
/
1..1 Gross mass GrossMass 18 04 001 n..16,6
0..1 Supplementary units SupplementryUnits 18 02 001 n..16,6
29/38
1..1 Intrinsic value IntrinsicValue 14 14 /
1..1 Currency code CurrencyCode 012 a3
1..1 Amount Amount 014 n..16,2
0..1 Transport and
insurance costs to
the destination
TransportCostsToTheDestination
14 15 /
1..1 Currency code CurrencyCode 012 a3
1..1 Amount Amount 014 n..16,2
0..1 Calculation of taxes CalculationOfTaxes /
1..1 Total duties and
taxes amount TotalDutiesAndTaxesAmount
14 16 n..16,2
1..99 Duties and taxes DutiesAndTaxes 14 03 /
1..1 Tax type TaxType 039 an3
1..1 Payable tax amount PayableTaxAmount 042 n..16,2
1..1 Method of payment MethodOfPayment 038 a1
1..99 Tax base TaxBase 040 /
1..1 Tax rate TaxRate 041 n..17,3
1..1 Measurement unit
and qualifier MeasurementUnitAndQualifier
005 an..4
1..1 Quantity Quantity 006 n..16,6
1..1 Amount Amount 014 n..16,2
1..1 Tax amount TaxAmount 043 n..16,2
0..99 Packaging Packaging 18 06 /
1..1 Number of packages NumberOfPackages 004 n..8
0..99 Previous document PreviousDocument 12 01 /
1..1 Reference number ReferenceNumber 001 an..70
1..1 Type Type 002 an..4
0..99 Supporting
document SupportingDocument
12 03 /
1..1 Reference number ReferenceNumber 001 an..70
1..1 Type Type 002 an4
0..99 Additional reference AdditionalReference 12 04 /
1..1 Reference number ReferenceNumber 001 an..70
1..1 Type Type 002 an4
0..99 Additional
information AdditionalInformation
12 02 /
0..1 Code Code 008 an5
0..1 Text Text 009 an..512
0..99 Transport document TransportDocument 12 05 /
1..1 Reference number ReferenceNumber 001 an..70
1..1 Type Type 002 an4
0..99 Additional fiscal
reference AdditionalFiscalReference
13 16 /
1..1 Role Role 031 an3
1..1 Vat identification
number VatIdentificationNumber
034 an..17
30/38
IE451H7 - NO RELEASE
Occurs
IDMS Name -
With Business
changes
IDMS XML Name Identification
Number Format
IE451H7 - No
release
IE451H7
1..1 Message header MessageHeader Not defined in
EUCDM
/
1..1 Sender Sender Not defined in
EUCDM
an..35
1..1 Recipient Recipient Not defined in
EUCDM
an..35
1..1 Message
timestamp
MessageTimestamp Not defined in
EUCDM
Timestamp
1..1 Message id MessageId Not defined in
EUCDM
an..35
1..1 Language Language Not defined in
EUCDM
a2
1..1 Declaration Declaration Not defined in
EUCDM
/
1..1 LRN Lrn 12 09 001 an..22
1..1 Movement
reference number MovementReferenceNumber
Not defined in
EUCDM an18
1..1 Additional
declaration type
AdditionalDeclarationType
11 02 001 a1
1..1 Rejection date RejectionDate
Not defined in
EUCDM
Timestamp
0..1 Deferred payment DeferredPayment 12 10 001 an..35
0..99 Control result ControlResult ControlResult /
1..1 Code Code Not defined in
EUCDM an2
1..1 Date Date Not defined in
EUCDM Timestamp
0..1 Remarks Remarks Not defined in
EUCDM an..512
1..1 Importer Importer 13 04 /
0..1 Name Name 016 an..70
0..1 Identification
number IdentificationNumber
017 an..17
0..1 Address Address 018 /
1..1 Street and number StreetAndNumber 019 an..70
1..1 Postcode Postcode 021 an..17
1..1 City City 022 an..35
1..1 Country Country 020 a2
1..1 Declarant Declarant 13 05 /
0..1 Name Name 016 an..70
0..1 Identification
number IdentificationNumber
017 an..17
0..1 Address Address 018 /
1..1 Street and number StreetAndNumber 019 an..70
31/38
1..1 Postcode Postcode 021 an..17
1..1 City City 022 an..35
1..1 Country Country 020 a2
0..9 Contact person ContactPerson 074 /
0..1 Name Name 016 an..70
0..1 Phone number PhoneNumber 075 an..35
0..1 E-mail address EMailAddress 076 an..256
0..1 Representative Representative 13 06 /
0..1 Identification
number IdentificationNumber
017 an..17
1..1 Status Status 030 n1
0..9 Contact person ContactPerson 074 /
0..1 Name Name 016 an..70
0..1 Phone number PhoneNumber 075 an..35
0..1 E-mail address EMailAddress 076 an..256
1..1 Goods Shipment GoodsShipment
Not defined in
EUCDM
/
0..1 Exporter Exporter 13 01 /
1..1 Name Name 016 an..70
1..1 Address Address 018
1..1 Street and number StreetAndNumber 019 an..70
1..1 Postcode Postcode 021 an..17
1..1 City City 022 an..35
1..1 Country Country 020 a2
0..9999 Previous document PreviousDocument 12 01 /
1..1 Reference number ReferenceNumber 001 an..70
1..1 Type Type 002 an..4
1..99 Supporting
document SupportingDocument
12 03 /
1..1 Reference number ReferenceNumber 001 an..70
1..1 Type Type 002 an4
0..99 Additional reference AdditionalReference 12 04 /
1..1 Reference number ReferenceNumber 001 an..70
1..1 Type Type 002 an4
0..99 Additional
information AdditionalInformation
12 02 /
0..1 Code Code 008 an5
0..1 Text Text 009 an..512
0..99 Additional fiscal
reference AdditionalFiscalReference
13 16 /
1..1 Role Role 031 an3
1..1 Vat identification
number VatIdentificationNumber
034 an..17
1..1 Consignment Consignment
Not defined in
EUCDM
/
0..1 Reference number
UCR ReferenceNumberUcr
12 08 001 an..35
1..1 Gross mass GrossMass 18 04 001 n..16,6
1..1 Location of goods LocationOfGoods 16 15 /
1..1 Type of location TypeOfLocation 045 a1
32/38
1..1 Qualifier of
identification QualifierOfIdentification
046 a1
1..1 Un Locode UnLocode 036 an..17
0..1 Customs office CustomsOffice 047 /
1..1 Reference number ReferenceNumber 001 an8
0..1 GNSS Gnss 048 /
1..1 Latitude Latitude 049 an..17
1..1 Longitude Longitude 050 an..17
0..1 Economic operator EconomicOperator 051 /
1..1 Identification
number IdentificationNumber
017 an..17
0..1 Authorisation
number AuthorisationNumber
052 an..35
0..1 Additional identifier AdditionalIdentifier 053 an..4
0..1 Address Address 018 /
1..1 Street and number StreetAndNumber 019 an..70
1..1 Postcode Postcode 021 an..17
1..1 City City 022 an..35
1..1 Country Country 020 a2
0..1 Postcode Postcode 081 /
1..1 Postcode Postcode 021 an..17
1..99 Transport
document TransportDocument
12 05 /
1..1 Reference number ReferenceNumber 001 an..70
1..1 Type Type 002 an4
0..1 Transport and
insurance costs to
the destination
TransportCostsToTheDestination
14 15 /
1..1 Currency Currency 012 a3
1..1 Amount Amount 014 n..16,2
1..999 Goods shipment
item GoodsShipmentItem
Not defined in
EUCDM
/
1..1 Goods item number GoodsItemNumber 11 03 001 n..5
0..1 Reference number
UCR ReferenceNumberUcr
12 08 001 an..35
1..1 Additional
procedure AdditionalProcedure
11 10 001 an3
0..1 Exporter Exporter 13 01 /
1..1 Name Name 016 an..70
1..1 Address Address 018 /
1..1 Street and number StreetAndNumber 019 an..70
1..1 Postcode Postcode 021 an..17
1..1 City City 022 an..35
1..1 Country Country 020 a2
1..1 Commodity Commodity
Not defined in
EUCDM
/
1..1 Description of
goods DescriptionOfGoods
18 05 001 an..512
1..1 Commodity code CommodityCode 18 09 /
33/38
1..1 Harmonized
System sub-
heading code
HarmonizedSystemSubHeadingCode
056 an6..8
1..1 Goods measure GoodsMeasure
Not defined in
EUCDM
/
1..1 Gross mass GrossMass 18 04 001 n..16,6
0..1 Supplementary
units SupplementryUnits
18 02 001 n..16,6
1..1 Intrinsic value IntrinsicValue 14 14 /
1..1 Currency code CurrencyCode 012 a3
1..1 Amount Amount 014 n..16,2
0..1 Transport and
insurance costs to
the destination
TransportCostsToTheDestination
14 15 /
1..1 Currency code CurrencyCode 012 a3
1..1 Amount Amount 014 n..16,2
0..1 Calculation of taxes CalculationOfTaxes /
1..1 Total duties and
taxes amount TotalDutiesAndTaxesAmount
14 16 n..16,2
1..99 Duties and taxes DutiesAndTaxes 14 03 /
1..1 Tax type TaxType 039 an3
1..1 Payable tax amount PayableTaxAmount 042 n..16,2
1..1 Method of payment MethodOfPayment 038 a1
1..99 Tax base TaxBase 040 /
1..1 Tax rate TaxRate 041 n..17,3
1..1 Measurement unit
and qualifier MeasurementUnitAndQualifier
005 an..4
1..1 Quantity Quantity 006 n..16,6
1..1 Amount Amount 014 n..16,2
1..1 Tax amount TaxAmount 043 n..16,2
0..99 Packaging Packaging 18 06 /
1..1 Number of
packages NumberOfPackages
004 n..8
0..99 Previous document PreviousDocument 12 01 /
1..1 Reference number ReferenceNumber 001 an..70
1..1 Type Type 002 an..4
0..99 Supporting
document SupportingDocument
12 03 /
1..1 Reference number ReferenceNumber 001 an..70
1..1 Type Type 002 an4
0..99 Additional reference AdditionalReference 12 04 /
1..1 Reference number ReferenceNumber 001 an..70
1..1 Type Type 002 an4
0..99 Additional
information AdditionalInformation
12 02 /
0..1 Code Code 008 an5
0..1 Text Text 009 an..512
0..99 Transport
document TransportDocument
12 05 /
1..1 Reference number ReferenceNumber 001 an..70
1..1 Type Type 002 an4
34/38
0..99 Additional fiscal
reference AdditionalFiscalReference
13 16 /
1..1 Role Role 031 an3
1..1 Vat identification
number VatIdentificationNumber
034 an..17
IE414 - REQUEST OF CUSTOMS DECLARATION INVALIDATION
(INVALIDATION REQUEST)
A invalidation request cannot be sent when the Financial treatment started , the declaration is awaiting
risk analysis or under control. A invalidation request cannot be sent when a invalidation has already
unaccepted.
Occurs
IDMS Name -
With Business
changes
IDMS XML Name Identification
Number Format
IE414 - Request Of
Customs
Declaration
Invalidation
(Invalidation
REQUEST)
IE414
1..1 Message header MessageHeader Not defined in
EUCDM
/
1..1 Sender Sender Not defined in
EUCDM
an..35
1..1 Recipient Recipient Not defined in
EUCDM
an..35
1..1 Message timestamp MessageTimestamp Not defined in
EUCDM
Timestamp
1..1 Message id MessageId Not defined in
EUCDM
an..36
1..1 Correlation id CorrelationId Not defined in
EUCDM
an36
1..1 Language Language Not defined in
EUCDM
a2
1..1 Invalidation Invalidation Not defined in
EUCDM
/
1..1 LRN Lrn 12 09 001 an..22
1..1 Movement
reference number
MovementReferenceNumber Not defined in
EUCDM
an..18
1..1 Invalidation reason InvalidationReason Not defined in
EUCDM
an..512
1..1 Invalidation request
date
InvalidationRequestDate Not defined in
EUCDM
an10
1..1 Declarant Declarant 13 05 /
0..1 Name Name 016 an..70
0..1 Identification
number IdentificationNumber
017 an..17
0..1 Address Address 018 /
1..1 Street and number StreetAndNumber 019 an..70
35/38
1..1 Postcode Postcode 021 an..17
1..1 City City 022 an..35
1..1 Country Country 020 a2
0..9 Contact person ContactPerson 074 /
0..1 Name Name 016 an..70
0..1 Phone number PhoneNumber 075 an..35
0..1 E-mail address EMailAddress 076 an..256
0..1 Representative Representative 13 06 /
0..1 Identification
number IdentificationNumber
017 an..17
1..1 Status Status 030 n1
0..9 Contact person ContactPerson 074 /
0..1 Name Name 016 an..70
0..1 Phone number PhoneNumber 075 an..35
0..1 E-mail address EMailAddress 076 an..256
Business Rules and error reason
Validation Name Application Validation Rule Error reason
Different declarant The system determines that the
Declarant (13 05) of the Request
for Invalidation is different from
the Declarant (13 05) of the
referred declaration
BEC0402
Different Representative The system determines that the
Representative (13 06) of the
Request for invalidation is
different from the Representative
(13 06) in the referred declaration.
BEC0403
missing MRN • The MRN was not mentioned. BEC0405
IE410 - ACCEPTANCE OF INVALIDATION REQUEST (CANCELLATION
ACCEPTANCE)
Information model content and structure
Occurs
IDMS Name -
With Business
changes
IDMS XML Name Identification
Number Format
IE410 - Acceptance
of Invalidation
Request
(Cancellation
Acceptance)
IE410
1..1 Message header MessageHeader Not defined in
EUCDM
/
1..1 Sender Sender Not defined in
EUCDM
an..35
1..1 Recipient Recipient Not defined in
EUCDM
an..35
36/38
1..1 Message timestamp MessageTimestamp Not defined in
EUCDM
Timestamp
1..1 Message id MessageId Not defined in
EUCDM
an..36
1..1 Correlation id CorrelationId Not defined in
EUCDM
an36
1..1 Language Language Not defined in
EUCDM
a2
1..1 Declaration Declaration Not defined in
EUCDM
/
1..1 LRN Lrn 12 09 001 an..22
1..1 Movement reference
number
MovementReferenceNumber Not defined in
EUCDM
an..18
1..1 Invalidation decision
date
InvalidationDecisionDate Not defined in
EUCDM
an10
1..1 Invalidation request
date
InvalidationRequestDate Not defined in
EUCDM
an10
1..1 Invalidation initiated
by customs
InvalidationInitiatedByCustoms Not defined in
EUCDM
n1
1..1 Invalidation reason InvalidationReason Not defined in
EUCDM
an..512
1..1 Declarant Declarant 13 05 /
0..1 Name Name 016 an..70
0..1 Identification number IdentificationNumber 017 an..17
0..1 Address Address 018 /
1..1 Street and number StreetAndNumber 019 an..70
1..1 Postcode Postcode 021 an..17
1..1 City City 022 an..35
1..1 Country Country 020 a2
0..9 Contact person ContactPerson 074 /
0..1 Name Name 016 an..70
0..1 Phone number PhoneNumber 075 an..35
0..1 E-mail address EMailAddress 076 an..256
0..1 Representative Representative 13 06 /
0..1 Identification number IdentificationNumber 017 an..17
1..1 Status Status 030 n1
0..9 Contact person ContactPerson 074 /
0..1 Name Name 016 an..70
0..1 Phone number PhoneNumber 075 an..35
0..1 E-mail address EMailAddress 076 an..256
ERROR CODE
Code Name EN Remark
12
Incorrect (code)
value
Value of an element in a message is outside the predefined domain or not
part of the applicable code list.
13 Missing
A mandatory/required element is missing in the received data, e.g. a required
element like the MRN for the Arrival Advice (C_ARR_ADV) is not present
37/38
14
Value not
supported in this
position (code value
constraint)
Notification that a recipient does not support use of the specific value of an
identified element in the position where it is used. This type of error refers to
the use of an improper code value for a specific element
15
Not supported in
this position
An element is not allowed to have a value due to the following two reasons:
- The element is not allowed to be present according to the FMS message
specification. - The element is not allowed to be present according to some
additional condition, e.g. if type of packages has the value 'UNPACKED' then
number of package cannot have a value (condition C60 of FTSS - AES [A4]
Appendix B ).
19
Invalid decimal
notation
The decimal notation is not according to the decimal formatting standards
UCI, UCM, UCD.
26 Duplicate detected
The same interchange is received again. Duplication is detected by reception
of an interchange reference that has already been received.
37
Invalid type
characters
Notification that one or more numeric characters were used in an alphabetic
element or that one or more alphabetic characters were used in a numeric
element.
38
Missing digit in
front of decimal
sign Notification that a decimal sign is not preceded by one or more digits.
39
Element too long
(length constraint)
Notification that the length of the element received exceeded the maximum
length specified.
40
Element too short
(length constraint)
Notification that the length of an element received is shorter than the
minimum length specified.
12 Name EN Remark
13
Incorrect (code)
value
Value of an element in a message is outside the predefined domain or not
part of the applicable code list.
14 Missing
A mandatory/required element is missing in the received data, e.g. a required
element like the MRN for the Arrival Advice (C_ARR_ADV) is not present
15
Value not
supported in this
position (code value
constraint)
Notification that a recipient does not support use of the specific value of an
identified element in the position where it is used. This type of error refers to
the use of an improper code value for a specific element
19
Not supported in
this position
An element is not allowed to have a value due to the following two reasons:
- The element is not allowed to be present according to the FMS message
specification. - The element is not allowed to be present according to some
additional condition, e.g. if type of packages has the value 'UNPACKED' then
number of package cannot have a value (condition C60 of FTSS - AES [A4]
Appendix B ).
26
Invalid decimal
notation
The decimal notation is not according to the decimal formatting standards
UCI, UCM, UCD.
37 Duplicate detected
The same interchange is received again. Duplication is detected by reception
of an interchange reference that has already been received.
38
Invalid type
characters
Notification that one or more numeric characters were used in an alphabetic
element or that one or more alphabetic characters were used in a numeric
element.
39
Missing digit in
front of decimal
sign Notification that a decimal sign is not preceded by one or more digits.
40
Element too long
(length constraint)
Notification that the length of the element received exceeded the maximum
length specified.
38/38
90 Unknown MRN
92
Message out of
sequence
93 Invalid MRN The structure of the MRN is not conform specifications.
99
national error
reason
INFORMATION MODEL DESCRIPTION For this point, please refer to the attached document.
XSD This chapter describes the technical message structure. The message is sent to IDMS via a Webservice
interface. This interface is described by the WSDL. This interface will process XML messages of which
an example can be found below. The format of the XML message is described by the XML Schema
(.xsd).
For the xsd, please refer to the attached IEMessage.zip
XML (EXAMPLE) For the xml, please refer to the attached xml.zip