Class diagram of the Insres Message

This class diagram is based on the class diagram of the Intrastat system. It shows the structure basis of the INSRES EDI message. The purpose of this class diagram is to provide a basis for the definition of a DTD or an XML schema of INSRES/XML response to INSTAT/XML, the XML format of the Intrastat declaration.
This optional application response can be an acknowledgement of receipt, acceptance or rejection of INSTAT/XML at envelope or declaration level. Errors can be reported at envelope, declaration or item level.

The diagram shows only classes and attributes, which will be sent in INSRES message. Cardinalities of the associations change in order to describe a message and parts of this message.

Operations are not defined for the classes.

Attributes have a type defined in the W3C recommendation on XML schema. The following types of attributes are described:

• "string": represents a character string,
• "decimal": is a finite-length sequence of decimal digits (#x30-#x39) separated by a decimal indicator; an optional leading sign is allowed; if the sign is omitted, "+" is assumed.
• "integer": is represented by a finite-length sequence of decimal digits (#x30-#x39) with an optional leading sign; if the sign is omitted, "+" is assumed,
• "boolean": represents the set of literals {true, false},
• "date": is represented by CCYY-MM-DD where "CC" represents the century, "YY" the year, "MM" the month and "DD" the day [ISO 8601],
• "time": is represented by hh:mm:ss where "hh", "mm", "ss" represent hour, minute and second respectively [ISO 8601].

Code lists associated with attributes are represented by the stereotype "enumeration". Codes of small code lists are enumerated into brackets.

The main differences between this diagram and the class diagram of the Intrastat system are:

• "[0..1]" indicates that an attribute is optional;
• INSRESEnvelope root class is identified in a colour different from the other classes; this root class corresponds with the first and the second elements of the generated INSRES message: INSRES and Envelope;
• Party, CollectingCentre, TDP, PSI, INSRESEnvelope, INSTATEnvelope, Declaration, Item are the classes moving from the class diagram of the Intrastat system to the class diagram of the INSRES message; these classes contain only attributes relevant to the response;
• DateTimeclass has been created with the date and time attributes;this class replaces dateTimeOfEnvelope attribute of INSRESEnvelope class, dateTimeOfEnvelope attribute of INSTATEnvelope class and dateTimeOfDeclaration attribute of Declarationclass;
• Flow class is deleted, flowCode becomes an attribute of Declaration class, flowName is not sent in the INSRES message;
• DeclarationType class is deleted, declarationTypeCode becomes an attribute of Declaration class, declarationTypeName is not sent in the INSRES message.

Derived from Party

- INSTAT envelope,
- INSRES envelope,
- declaration

Public Attributes:

• date : date
  Date.
• time [0..1]: time
  Time.

Public Attributes:

• declarationId: string
  Identification of the Intrastat declaration.
• declarationActionCode [0..1]: string – enumeration = {AC,RE}
  Code indicating acceptance or rejection (the action taken) of the received Intrastat declaration.
• declarationErrorCode [0..1]: string - enumeration
  Code of the application error found in the received Intrastat declaration.
• declarationComment [0..1]: string
  Comment or description of the application error found in the received Intrastat declaration.
• lateIndicator [0..1]: boolean
  Indicates if the Intrastat declaration arrived late in the Collecting Centre.
• ReferencePeriod[0..1]: string
  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.

• declarationTypeCode [0..1]: string - enumeration= {F,1,2,3}
  Code of the declaration type.
  Depending on the MS, the statistical threshold ranges imply different types of declarations:

- Fiscal,(F),
- Simplfied return (1),
- Detailed return (2),
- Very detailed return (3).

• flowCode [0..1]: string –enumeration = {A, D}
  Code of the flow of the goods reported in the Intrastat declaration:

- A for Arrival,
- D for Dispatch.

• rTotalInvoicedAmount [0..1]: decimal
  Total invoiced value of the goods, for the received Intrastat declaration.
• rTotalStatisticalValue [0..1]: decimal
  Total statistical value of the goods, for the received Intrastat declaration.
• rTotalNumberLines [0..1]: integer
  Total number of lines of the received Intrastat declaration.

Public Attributes:

• envelopeId: string
  Identification code of the envelope.
• testIndicator [0..1]: boolean
  Code indicating if the submission is a test.

Public Attributes:

• envelopeId : string
  Identification code of the envelope.
• envelopeActionCode [0..1] : string - enumeration= {AR,AC,RE}
  Code indicating acknowledgement of receipt, acceptance or rejection (the action taken) of the envelope containing the received declarations.
• envelopeErrorCode [0..1] : string - enumeration
  Code of the application error found in the envelope containing the Intrastat declarations.
• envelopeComment [0..1] : string
  Comment or description of the application error found in the envelope containing the Intrastat declarations.

Public Attributes:

• ItemNumber: integer
  Serial item (or line) number.
• itemErrorCode [0..1]: string - enumeration
  Error code related to the item.
• itemComment [0..1]: string
  Comment or description of the application error found in the item of the received Intrastat declaration.

- the Collecting Centre which sends the INSRES envelope,
- either the PSI or the TDP receiving the INSRES envelope.

Public Attributes:

• PartyID: string
  Identification code of the Party, which can be:

-CCId: Identification code of the Collecting Centre,
-PSIId: Identification code of the PSI,
-TDPId: Identification code of the Declaring Third Party.

Derived from Party

Derived from Party

Top of page