Class diagram of the Instat message

Class diagram of the Instat Message

 
Description
Class diagram of the Instat message

This class diagram is based on the class diagram of the Intrastat system.   It shows the structure basis of the INSTAT EDI message.  The purpose of this model is to provide a basis for the definition of a DTD or an XML schema of the Intrastat declaration.
The main classes are Party, Address, INSTATEnvelope, Declaration and Item.
The classes contain only the attributes, which will be sent in the INSTAT message. Some attributes leave their classes defined for application purpose for classes defined for EDI message purpose. Function, CN8, InvoicedAmount, NatureOfTransaction, DeliveryTerms classes contain attributes for which the existence depends on the first attribute of the class.
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 ,
  • "anyURI": represents finite-length character sequences, which result in strings which are legal URIs according to [RFC 2396], as amended by [RFC 2732],
  • "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;
  • INSTATEnveloperoot 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 INSTAT message: INSTAT and Envelope;
  • INSRESEnvelope class and the attributes used only by the response to the Intrastat declaration are not included this class diagram; theses attributes are actionCode, errorCode and comment in INSTATEnvelopeclass, actionCode, errorCode, comment, lateIndicator, rTotalInvoicedAmount, rTotalStatisticalValue and rTotalNumberLines in Declaration class, errorCode and comment in Itemclass;
  • ContactPersonRole attributes of ContactPerson class are not sent in the INSTAT message;
  • DateTime class has been created with the date and time attributes; this class replaces dateTimeOfEnvelope attribute of INSTATclass and dateTimeOfDeclaration attribute of Declaration class;
  • Flow class is deleted, flowCode becomes an attribute of Declaration class, flowName is not sent in the INSTAT message;
  • DeclarationType class is deleted, declarationTypeCode becomes an attribute of Declaration class, declarationTypeName is not sent in the INSTAT message;
  • DeclarationCurrency class is deleted, currencyCode becomes an attribute of Declaration class, curencyName is not sent in the INSTAT message;
  • previousDeclarationId attribute becomes an attribute of Function class, functionName is not sent in the INSTAT message;
  • Region class is deleted, regionCode becomes an attribute of Item class, regionName is not sent in the INSTAT message;
  • PortAirportInlandPort class is deleted, portAirportInlandportCode Item class, portAirportInlandportName is not sent in the INSTAT message;
  • ModeOfTransport class is deleted, modeOfTransportCode becomes an attribute of Item class, modeOfTransportName is not sent in the INSTAT message;
  • StatisticalProcedure class is deleted, statisticalProcedureCode becomes an attribute of Item class, statProcedureName is not sent in the INSTAT message;
  • NatureOfTransaction class replaces NatureOfTransactionA and NatureOfTransactionB classes; NatureOfTransactionACode and NatureOfTransactionBCodeattributes become attributes of NatureOfTransaction class, NatureOfTransactionAName and NatureOfTransactionBName are not sent in the INSTAT message;
  • AdditionalGoodsCode class is deleted, additionalGoodsCode becomes an attribute of CN8 class, additionalGoodsName is not sent in the INSTAT message, CN8Description is not sent in the INSTAT message;
  • TODDetails, TODPlace, locationCode attributes become attributes of DeliveryTerms class, locationName is not sent in the INSTAT message, LocationID class is deleted;
  • Partner class is deleted, partnerId becomes an attribute of Item class, partnerName is not sent in the INSTAT message;
  • MemberStateConsDest class is deleted, ISOCountryCode becomes MSConsDestCode attribute in Item class, countryName is not sent in the INSTAT message;
  • countryOfOrigin class is deleted, ISOCountryCode becomes countryOfOriginCode attribute in Item class, countryName is not sent in the INSTAT message;
  • InvoicedAmount class is created; invoicedAmount and invoiceAmountInCurrency attributes move from Item class to only one attribute invoicedAmount in InvoicedAmount class;
  • Currency class is deleted, currencyName is not sent in the INSTAT message, currencyCode becomes an attribute of InvoicedAmount class.

 
Classes
Address
Address. This class contains the address attributes common to the PSI, TDP, Collecting Centre, CNA, Contact person like postal address, phone, fax, e-mail, URL.

Public Attributes:

  • streetName [0..1]: string
    Name of the street.
  • streetNumber [0..1]: string
    Number identifying the position of a building on a street.
  • postalCode [0..1]: string
    Postal Code.
  • cityName [0..1]: string
    Name of the city.
  • countryName [0..1]: string
    Country name.
  • phoneNumber [0..1]: string
    Phone number.
  • faxNumber [0..1]: string
    Fax number.
  • e-mail [0..1]: string
    Electronic mail address.
  • URL [0..1]: URI
    Uniform Resource Locator.
CN8
Commodity code: eight-digit code of the appropriate subdivision in the version of the combined nomenclature in force at the time.

Public Attributes:

  • CN8Code : string - enumeration
    Eight-digit code of the combined nomenclature.
  • SUCode [0..1]: string
    Supplementary units code attached to the CN8 code (if any).
  • additionalGoodsCode [0..1]: string - enumeration
    Additional goods code associated with a CN8 code.
CollectingCentre
Data collection office designated by the Competent National Authorities.

Derived from Party

ContactPerson
Person to be contacted for the Intrastat declaration.

Public Attributes:

  • contactPersonName : string
    Name of the contact person for the Intrastat declaration.
DateTime
Date and time of creation of:
- the envelope,
- the declaration.
Public Attributes:
  • date : date
    Date.
  • time [0..1]: time
    Time.
Declaration
Intrastat declaration: Statistical declaration of intra-Community trade in goods.

Public Attributes:

  • declarationId : string
    Identification of the Intrastat declaration.
  • referencePeriod : 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: 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 return,(F),
- Simplfied return (1),
- Detailed return (2),
- Very detailed return (3).
  • flowCode : string - enumeration = {A, D}
    Code of the flow of the goods reported in the Intrastat declaration:
- Arrival
- Dispatch.
  • currencyCode : string - enumeration
    Currency code (including Euro).
  • firstLast [0..1]: string - enumeration = {F,L}
    Information indicating if the declaration is the first declaration of the PSI or the last declaration of the PSI.
  • totalNetMass [0..1]: integer
    Total quantity of goods in net mass.
  • totalInvoicedAmount [0..1]: decimal
    Total invoiced amount of the goods.
  • totalStatisticalValue [0..1]: decimal
    Total statistical value of the goods.
  • totalNumberLines [0..1]: integer
    Total number of lines of the declaration.
  • totalNumberDetailedLines [0..1]: integer
    Total number of detailed lines of the declaration before aggregation.
DeliveryTerms
Terms of delivery (TOD) for the goods.

Public Attributes:

  • TODCode : string - enumeration
    Code of the Delivery terms.
    The code list is {EXW, FCA, FAS, FOB, CFR, CIF, CPT, CIP, DAF, DES, DEQ, DDU, XXX} 
  • locationCode [0..1]: string - enumeration = {1,2,3}
    Code of the location of the delivery terms:
    -1: Place located in the territory of the MS concerned,
    -2: Place located in another MS,
    -3: Other (place located outside the Community).
  • TODPlace [0..1]: string
    Place of delivery terms.
  • TODDetails [0..1]: string
    Precise statement of the terms of delivery, if the TOD code is "XXX".
Function
Function of the declaration:
-Original (O),
-Replace (R),
-Delete (D),
-Modification (M),
-Nil return (N).

Public Attributes:

  • functionCode : string - enumeration = {O,R,D,M,N}
    Code of the function of the declaration.
  • previousDeclarationId [0..1]: string
    Identification of the declaration to be corrected.
INSTATEnvelope
Header for the submission of one or more Intrastat declarations. Root class corresponding with the first and the second elements of the generated INSTAT message: INSTAT and Envelope elements.

Public Attributes:

  • envelopeId : string
     Identification code of the envelope.
  • acknowledgementRequest [0..1]: boolean
     Request for acknowledgement of the receipt of the envelope.
  • authentication [0..1]: string
     Authentication code resulting from an authentication procedure (e.g. use of PSI password in France or electronic signature in Austria).
  • testIndicator [0..1]: boolean
     Code indicating if the submission is a test.
  • applicationReference [0..1]: string
     Application reference assigned by the CNA to the application, which must receive the message.
  • softwareUsed [0..1]: string
     Software used by the PSI or TDP for generating the declarations (e.g. IDEP/CN8).
  • numberOfDeclarations [0..1]: integer
     Number of declarations contained in the envelope (check). 
InvoicedAmount
Invoiced amount of goods.

Public Attributes:

  • invoicedAmount: decimal
     Invoiced amount of goods:
- exclusive of VAT,
- in a currency different from the currency of the Member State in which the declaration is made.
  • currencyCode [0..1]: string - enumeration
     Currency code of the invoiced amount of goods in a currency different from the currency of the Member State in which the declaration is made.
Item
Item or line of the Intrastat declaration.

Public Attributes:

  • itemNumber : integer
    Serial item (or line) number.
  • goodsDescription [0..1]: string
    Description of the goods (CN8 or PSI description): Usual trade name of the goods.
  • MSConcDestCode [0..1] : string - enumeration
    ISO code of Member State of the European Union of consignment of destination of the goods.
  • countryOfOriginCode [0..1] : string - enumeration
    ISO code of the country where the goods originate for Intrastat purposes, when flow is arrival.
  • netMass [0..1]: integer
    Quantity of goods in net mass, net of all packaging.
  • quantityInSU [0..1]: integer
    Quantity of goods in supplementary units, in so far as the combined nomenclature provides for a supplementary unit of measurement for the goods in question.
  • statisticalValue [0..1]: decimal
    Statistical value of the goods.
  • invoiceNumber [0..1]: string
    Invoice number associated with the item.
  • partnerId [0..1]: string - enumeration
    Identification of the partner in one Member State of the European Union involved in the exchange of the goods (different from the Member State in which the declaration is made).
  • statisticalProcedureCode [0..1]: string - enumeration
    Code of the statistical procedure defined by the Member State in which the declaration is made.
  • modeOfTransportCode [0..1]: string - enumeration = {1,2,3,4,5,7,8,9}
    Code of the presumed mode of transport.
  • regionCode [0..1]: string - enumeration
    Code of the region of origin or destination of goods defined by the Member State in which the declaration is made.
  • portAirportInlandportCode [0..1]: string - enumeration
    Code of the port/airport/inland port of loading/unloading of goods defined by the Member State in which the declaration is made.
  • numberOfConsignments [0..1]: integer
    Number of consignments relating to the goods.
NatureOfTransaction  
Nature of transaction.

Public Attributes:

  • natureTransationACode : string - enumeration
    Code from column A of the table "Nature of transaction".
  • natureTransactionBCode [0..1]: string - enumeration
    Code from column B of the table "Nature of transaction", corresponding to A.
Party
Party means the entities involved in the exchange of the envelope containing the Intrastat declarations which are:
  • the Collecting Centre which will receive the envelope,
  • either the PSI sending the envelope,
  • or the TDP sending the envelope and 1 to n PSIs responsible of the declarations contained in the 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.
  • partyName [0..1]: string
    Name of the party which can be:
  • -CCName: Name of the Collecting Centre
    -PSIName: Name of the PSI,
    -TDPName: Name of the TDP.
PSI
Party responsible for providing statistical information in the Intrastat system.

Derived from Party

Public Attributes:

  • interchangeAgreementId [0..1]: string
    Identification code of the interchange agreement existing between the two parties.
  • password [0..1]: string
    Password to permit access to the CNA system. This would be specified in a prior interchange agreement between the parties.
TDP
Declaring Third Party submitting the Intrastat declarations on behalf of a PSI.

Derived from Party

Public Attributes:

  • interchangeAgreementId [0..1]: string
    Identification code of the interchange agreement existing between the two parties.
  • password [0..1]: string
    Password to permit access to the CNA system. This would be specified in a prior interchange agreement between the parties
  • postalCode [0..1]: string
    Postal Code.
  • cityName [0..1]: string
    Name of the city.
  • countryName [0..1]: string
    Country name.
  • phoneNumber [0..1]: string
    Phone number.
  • faxNumber [0..1]: string
    Fax number.
  • e-mail [0..1]: string
    Electronic mail address.
  • URL [0..1]: URI
    Uniform Resource Locator.

Top of page

Copyright © European Communities 2002