|
INSRES |
Function
Root element of INSRES, the XML document for exchanging responses related to
received Intrastat declarations.
Content/Type
| Element |
Occurrences |
| Envelope |
1 |
|
| . |
|
INSRES/Envelope |
|
One occurrence.
Function
Header for the submission of one or more responses to received Intrastat
declarations.
Content/Type
Envelope contains the following
elements in sequence
| Element |
Occurrences |
| EnvelopeId |
1 |
| DateTime |
1 |
| Party |
2 |
| testIndicator |
0 to
1 |
| INSTATEnvelope |
1 |
|
| . |
|
INSRES/Envelope/envelopeId |
|
One occurrence.
Function
Identification code of the envelope.
Content/Type
envelopeId has the type
"string".
Example
<envelopeId>RES111101</envelopeId>
|
| . |
|
INSRES/Envelope/DateTime |
|
One occurrence.
Function
Date and time of creation of the envelope.
Content/Type
DateTime contains the
following elements in sequence:
| Element |
Occurrences |
| date |
1 |
| time |
0
to 1 |
|
| . |
|
INSRES/Envelope/DateTime/date |
|
One occurrence.
Function
Date of creation of the envelope.
Content/Type
date has the type
"date", represented by CCYY-MM-DD.
Example
<date>2002-04-01</date>
|
| . |
|
INSRES/Envelope/DateTime/time |
|
One occurrence, depends if the Member
State requires this element.
Function
Time of creation of the envelope.
Content/Type
time has the type
"time" represented by hh:mm:ss.
Example
<time>13:34:05</time>
|
| . |
|
INSRES/Envelope/Party |
|
Two occurrences with attribute
PartyRole="sender" and "receiver" are mandatory.
Function
Party means the entities involved in the exchange of the envelope
containing the responses to received Intrastat declarations which are:
- the Collecting Centre ("CC", Data collection office designated
by the Competent National Authorities) which sends the response envelope,
- either the PSI (Party responsible for providing statistical information in
the Intrastat system) or the TDP (Declaring Third Party submitting the
Intrastat declarations on behalf of a PSI) receiving the response envelope.
This PSI or this TDP was "sender" of the envelope containing the
Intrastat declarations(s) to be acknowledged.
Content/Type
Party contains the following
element:
| Element |
Occurences |
| partyId |
1 |
Attributes
Party contains the following
mandatory attributes:
| Attribute |
Description |
Constraint |
Use |
| partyType |
Party has the
type "PSI", "TDP", or "CC". |
PSI|TDP|CC |
Required |
| partyRole |
Party
has the role "sender", "receiver". |
sender|receiver |
Required |
Description
The different following options are possible:
- partyType="CC", partyRole="sender"
Party is the Collecting Centre sending the response envelope.
- either partyType="TDP"
Party is TDP and receiver of the envelope for one or more responses to Intrastat declarations. This TDP was the sender of the Intrastat declarations to be acknowledged.
- or partyType="PSI"
Party is a PSI and receiver of the envelope for one or more responses to Intrastat declarations. This PSI was the sender of the Intrastat declarations to be acknowledged.
Example
<Party
partyType="CC" partyRole="sender">
|
| . |
| INSRES/Envelope/Party/partyId |
|
One occurrence.
Function
Identification code of the Party, which can be the:
- Collecting Centre,
- Provider of Statistical Information,
- Declaring Third Party.
Content/Type
partyId has the type "string".
Example
<partyId>FRAG35383264500001</partyId> |
| |
| INSRES/Envelope/testIndicator |
|
One occurrence, depends if the Member State requires
this element.
Function
Code indicating if the submission is a test.
Content/Type
testIndicator has the type "boolean" with the
value "true" because testIndicator is sent only for
indicating that the submission is a test.
Example
<testIndicator>true</testIndicator> |
| |
| INSRES/Envelope/INSTATEnvelope |
|
One occurrence.
Function
Received header for the submission of one or more
Intrastat declarations.
Content/Type
INSTATEnvelope contains the following elements in
sequence :
| Element |
Occurrences |
| EnvelopeId |
1 |
| DateTime |
0 to 1 |
| envelopeActionCode |
0 to
1 |
| envelopeErrorCode |
0 to
1 |
| envelopeComment |
0 to
1 |
| Declaration |
0 to
1 |
|
| |
| INSRES/Envelope/INSTATEnvelope/envelopeId |
|
One occurrence.
Function
Identification code of the received envelope containing
the Intrastat declarations.
Content/Type
envelopeId has the type
"string".
Example
<envelopeId>AA020401</envelopeId> |
| |
| INSRES/Envelope/INSTATEnvelope/DateTime |
|
One occurrence, depends if the Member State requires
this element.
Function
Date and time of creation of the received Intrastat
envelope. For more details, refer to DateTime element described as a
sub-element of Envelope. |
| |
| INSRES/Envelope/INSTATEnvelope/envelopeActionCode |
|
One occurrence, depends if the Member State requires
this element.
Function
Code indicating acknowledgement of receipt, acceptance or
rejection (the action taken) of the envelope containing the received
declarations.
Content/Type
envelopeActionCode has the type " string".
The different values of envelopeActionCode are the following:
| Value |
Description |
| AR |
Acknowledgement of receipt of the
envelope containing the Intrastat declarations |
| AC |
Acceptance of the envelope
containing the Intrastat declarations |
| RE |
Rejection of the envelope
containing the Intrastat declarations |
Example
<envelopeActionCode>AR</envelopeActionCode> |
| |
| INSRES/Envelope/INSTATEnvelope/envelopeErrorCode |
|
One occurrence, depends if the Member State requires
this element.
Function
Code of the application error found in the envelope
containing the Intrastat declarations.
Content/Type
envelopeErrorCode has the type " string".
The different values of envelopeErrorCode are defined by the
Member States.
Example
<envelopeErrorCode>ER01</envelopeErrorCode> |
| |
| INSRES/Envelope/INSTATEnvelope/envelopeComment |
|
One occurrence, depends if the Member State requires
this element.
Function
Comment or description of the application error found in
the envelope containing the Intrastat declarations.
Content/Type
envelopeComment has the type " string".
Example
<envelopeComment>Erroneous
PSI code</envelopeComment> |
| |
| INSRES/Envelope/INSTATEnvelope/Declaration |
|
One occurrence.
Function
Intrastat declaration to be responded.
Content/Type
Declaration contains the following elements in sequence:
|
Element |
Occurrences |
|
declarationId |
1 |
|
declarationActionCode |
0 to 1 |
|
declarationErrorCode |
0 to 1 |
|
declarationComment |
0 to 1 |
|
lateIndicator |
0 to 1 |
|
referencePeriod |
0 to 1 |
|
PSIId |
0 to 1 |
|
declarationTypeCode |
0 to 1 |
|
flowCode |
0 to 1 |
|
rTotalInvoicedAmount |
0 to 1 |
|
rTotalStatisticalValue |
0 to 1 |
|
rTotalNumberLines |
0 to 1 |
|
Item |
0 to n |
|
| |
| INSRES/Envelope/INSTATEnvelope/Declaration/declarationId |
|
One occurrence.
Function
Identification of the received Intrastat declaration.
Content/Type
declarationId has the type " string".
Example
<declarationId>000013</declarationId> |
| |
| INSRES/Envelope/INSTATEnvelope/Declaration/declarationActionCode |
|
One occurrence.
Function
Code indicating acceptance or rejection (the action
taken) of the received Intrastat declaration.
Content/Type
declarationActionCode has the type " string".
The different values of declarationActionCode are the following:
|
Value |
Description |
|
AC |
Acceptance of the Intrastat declaration |
|
RE |
Rejection of the Intrastat declaration |
Example
<declarationActionCode>AC</declarationActionCode> |
| |
| INSRES/Envelope/INSTATEnvelope/Declaration/declarationErrorCode |
|
One occurrence, depends if the Member State requires
this element.
Function
Code of the application error found in the received
Intrastat declaration.
Content/Type
declarationErrorCode has the type " string".
The different values of declarationErrorCode are defined by the
Member States.
Example
<declarationErrorCode>ER01</declarationErrorCode> |
| |
| INSRES/Envelope/INSTATEnvelope/Declaration/declarationComment |
|
One occurrence, depends if the Member State requires
this element.
Function
Comment or description of the application error found in
the received Intrastat declaration.
Content/Type
declarationComment has the type " string".
Example
<declarationComment>Erroneous
flow</declarationComment> |
| |
| INSRES/Envelope/INSTATEnvelope/Declaration/lateIndicator |
|
One occurrence, depends if the Member States requires
this element.
Function
Indicates if the Intrastat declaration arrived late in
the Collecting Centre.
Content/Type
lateIndicator has the has the type " boolean"
with the value "true" because lateIndicator is sent
only for indicating that the Intrastat declaration arrived late in the
Collecting Centre.
Example
<lateIndicator>true</lateIndicator> |
| |
| INSRES/Envelope/INSTATEnvelope/Declaration/referencePeriod |
|
One occurrence, depends if the Member State requires
this element.
Function
Reference period of the received Intrastat declaration.
Reference period is composed of:
- Periodicity: Monthly, quarterly or yearly,
- Year of the period,
- Period number:
- 1 to 12 for a monthly declaration,
- 1 to 4 for a quarterly declaration,
- Nothing for a yearly declaration.
Content/Type
referencePeriod has the type " string".
referencePeriod is represented by:
- CCYY-MM
for a monthly period, where "CC" represents
the century, "YY" the year, "MM" the month,
- CCYY-Q
for a quarterly period, where "CC" represents
the century, "YY" the year, "Q" the quarter with
values equal to 1, 2, 3 or 4,
- CCYY
for a yearly period, where "CC" represents the
century, "YY" the year.
Example
<referencePeriod>2002-03</referencePeriod> |
| |
| INSRES/Envelope/INSTATEnvelope/Declaration/PSIId |
|
One occurrence, depends if the Member State requires
this element.
Function
Identification code of the PSI associated with the
received Intrastat declaration.
Content/Type
PSIId has the type " string".
Example
<PSIId>FRAG35383264500001</PSIId> |
| |
| INSRES/Envelope/INSTATEnvelope/Declaration/declarationTypeCode |
|
One occurrence, depends if the Member State requires
this element.
Function
Type of the received Intrastat declaration.
Depending on the MS, the statistical threshold ranges imply different
types of declarations:
- Fiscal return,
- Simplified return,
- Detailed return,
- Very detailed return.
Content/Type
declarationTypeCode has the type " string".
The different values of declarationTypeCode are defined by the
Member States.
Example
<declarationTypeCode>1</declarationTypeCode> |
| |
| INSRES/Envelope/INSTATEnvelope/Declaration/flowCode |
|
One occurrence, depends if the Member State requires
this element.
Function
Flow of goods reported in the received Intrastat
declaration:
Content/Type
flowCode has the type " string".
The different values of flowCode are the following:
|
Value |
Description |
|
A |
Arrival of goods |
|
D |
Dispatch of goods |
Example
<flowCode>A</flowCode> |
| |
| INSRES/Envelope/INSTATEnvelope/Declaration/rTotalInvoicedAmount |
|
One occurrence, depends if the Member State requires
this element.
Function
Total invoiced amount of the goods, for the received
Intrastat declaration.
Content/Type
rTotalInvoicedAmount has the type " decimal".
Example
<rTotalInvoicedAmount>40000</rTotalInvoicedAmount> |
| |
| INSRES/Envelope/INSTATEnvelope/Declaration/rTotalStatisticalValue |
|
One occurrence, depends if the Member State requires
this element.
Function
Total statistical value of the goods, for the received
Intrastat declaration.
Content/Type
rTotalStatisticalValue has the type " decimal".
Example
<rTotalStatisticalValue>62000</rTotalStatisticalValue> |
| |
| INSRES/Envelope/INSTATEnvelope/Declaration
/rTotalNumberLines |
|
One occurrence, depends if the Member States requires
this element.
Function
Total number of lines of the received Intrastat
declaration.
Content/Type
rTotalNumberLines has the type " integer".
Example
<rTotalNumberLines>2</rTotalNumberLines> |
| |
| INSRES/Envelope/INSTATEnvelope/Declaration/Item |
|
Optional, 0 to n occurrences.
Function
Item or line of the Intrastat declaration to be
acknowledged.
Content/Type
Item contains the following elements in sequence:
|
Element |
Occurrences |
|
itemNumber |
1 |
|
itemErrorCode |
0 to 1 |
|
itemComment |
0 to 1 |
|
| |
| INSRES/Envelope/INSTATEnvelope/Declaration/Item/itemNumber |
|
One occurrence.
Function
Serial item (or line) number containing an error in the
received Intrastat declaration.
Content/Type
itemNumber has the type " integer".
Example
<itemNumber>1</itemNumber> |
| |
| INSRES/Envelope/INSTATEnvelope/Declaration/Item/itemErrorCode |
|
One occurrence, depends if the Member State requires
this element.
Function
Code of the application error found in the item of the
received Intrastat declaration.
Content/Type
itemErrorCode has the type " string".
The different values of itemErrorCode are defined by the Member
States.
Example
<itemErrorCode>ITEMERR026</itemErrorCode> |
| |
| INSRES/Envelope/INSTATEnvelope/Declaration/Item/itemComment |
|
One occurrence, depends if the Member State requires
this element.
Function
Comment or description of the application error found in
the item of the received Intrastat declaration.
Content/Type
itemComment has the type " string".
Example
<itemComment>Erroneous
CN8 code</itemComment> |