MDAS-MAPS Interface Specification
Žiniatinklio paslaugos specifikacija
Interface Specification (SPE) for
Tax Calculation and Validation System (MAPS)
Table of contents
1.Abbreviations
2.Introduction
3.Services used in external (trader’s) information system (EIS) and MAPS communication
4.MAPSService
4.1.MAPSServiceWSDL_v1r1
4.2.Messages
4.2.1.TaxCalculationAndValidation
4.2.1.1.Message data types
4.2.1.1.1.TaxCalculationAndValidation
4.2.1.1.2.ComplexTypeClass1
4.2.1.1.3.GoodsItem
4.2.1.1.4.Mass
4.2.1.1.5.Rate
4.2.1.1.6.Amount
4.2.1.1.7.ProducedDocument
4.2.1.1.8.SpecialMention
4.2.1.1.9.Qty
4.2.1.1.10.SupplementaryUnit
4.2.2.TaxCalculationAndValidationResponse
4.2.2.1.Message data types
4.2.2.1.1.TaxCalculationAndValidationResponse
4.2.2.1.2.ComplexTypeClass2
4.2.2.1.3.MAPS02
4.2.2.1.4.TotalAmount
4.2.2.1.5.Result
4.2.2.1.6.GoodsItemResult
4.2.2.1.7.Measure
4.2.2.1.8.Alert
4.2.2.1.9.Footnote
4.2.2.1.10.CalculationOfTax
4.2.2.1.11.Rate
4.3.PortTypes
4.3.1.MAPSService
4.4.Bindings
4.4.1.MAPSServiceBinding
4.5.Services
4.5.1.MAPSService_v1r1
5.Annexes
5.1.MAPSService_v1r1 WSDL
5.2.Examples of data queries
1. Abbreviations
Abbrevation / ExplanationEIS / External information system
ITVS / Integrated Tariff Management System
LRN / Local reference number
MAPS / Tax calculation and validation system
MRN / Movement Reference Number
SPE / Interface specification
VAT / Value added tax
WSDL / Web service description service
2. Introduction
The aim of this document is to provide definition for EIS-MAPS interface to all participants. As an attachment to the document are provided generated WSDL file described in the document content.
The document was prepared during implementation of tender No. 11B-266 „Development of the Integrated Tariff Management System”.
3. Services used in external (trader’s) information system (EIS) and MAPS communication
Communication between EIS and MAPS takes part through webservice MAPSService . EIS sends declaration information (webservice operation TaxCalculationAndValidation) and recieves tax calculation and validation response (webservice operation TaxCalculationAndValidationResponse) from MAPS system.
Communication between EIS and MAPS service is synchronous.
page 1/19
4. MAPSService
Picture 1 MAPSService
page 1/19
4.1. MAPSServiceWSDL_v1r1
Defined interfaces
MAPSService_v1r1
4.2. Messages
Picture 2 Messages
4.2.1. TaxCalculationAndValidation
Input parameter for TaxCalculationAndValidation request message
Picture 3 TaxCalculationAndValidation
4.2.1.1. Message data types
4.2.1.1.1. TaxCalculationAndValidation
Tax calculation and validation request element.
4.2.1.1.2. ComplexTypeClass1
Tax calculation and validation request sent to the MAPS system.
It is constructed base on import declaration or export declaration data.
Attributes
date
Type / dateDescription / If customs debt date is not declared, then this date is the date for which the calculation and validation is performed (current date, if declaration is not accepted yet, or declaration acceptance date).
If customs debt date is declared, then the usage of this date is under responsibility of MAPS.
customsDebtDate
Type / date [0..1]Description / Declared customs debt date. The usage of this date is under responsibility of MAPS
referenceNumber
Type / StringDescription / The reference number of the customs declaration. LRN if declaration is not accepted yet or MRN after acceptance.
typeOfDeclaration2
Type / String [0..1]Description / Type of declaration.
customsValueCurrency
Type / stringDescription / Customs value currency. This is statistical value currency declared on goods item level of the customs declaration (in each goods item this value is the same).
dialogLanguage
Type / stringDescription / Language code of free text data items which should be used in MAPS response ("LT" or "EN"). This data item can be declared by trader for customs declaration as dialog language with customs (if not default "LT" is used).
GoodsItem
Type / GoodsItem [1..999]4.2.1.1.3. GoodsItem
The goods item of tax calculation and validation request.
It is constructed base on goods item of import declaration or export declaration in office of export data.
Attributes
itemNumber
Type / integerDescription / Goods item number.
countryCode
Type / stringDescription / Country of origin code (import declaration) or country of destination code (export declaration - from header level if it is not declared on goods item level).
procedure
Type / stringDescription / Concatenation of requested and previous procedure codes.
additionalCommunityProcedure1
Type / string [0..1]Description / Additional community procedure first code.
additionalCommunityProcedure2
Type / string [0..1]Description / Additional community procedure second code.
additionalNationalProcedure
Type / string [0..1]Description / Additional national procedure code.
preference
Type / stringDescription / Preference code. If this data item is not declared "100" value should be used.
quota
Type / string [0..1]Description / Order number of tariff quota.
grossMass
Type / Mass [0..1]Description / Gross mass.
netMass
Type / MassDescription / Net mass.
customsValueAmount
Type / AmountDescription / Customs value amount (or statistical value amount if it is not declared).
additionalCostsVAT
Type / Amount [0..1]Description / Additional costs for VAT base (appropriate adjustment value).
rateOfCompensatoryInterest
Type / Rate [0..1]Description / Compensatory interest rate (for import only).
commodityCode
Type / stringDescription / Concatenation of combined nomenclature and taric codes.
taricFirstAdditionalCode
Type / string [0..1]Description / TARIC first additional code.
If this data item would be equal "0000" in declaration then it should set to empty value.
taricSecondAdditionalCode
Type / string [0..1]Description / TARIC second additional code.
If this data item would be equal "0000" in declaration then it should set to empty value.
nationalAdditionalCode
Type / string [0..1]Description / National additional code.
If this data item would be equal "0000" in declaration then it should set to empty value.
SupplementaryUnit
Type / SupplementaryUnit [0..9]ProducedDocument
Type / ProducedDocument [0..99]SpecialMention
Type / SpecialMention [0..99]4.2.1.1.4. Mass
Type restricted to decimal(11,3).
4.2.1.1.5. Rate
Type restricted to decimal(9,4).
4.2.1.1.6. Amount
Type restricted to decimal(15,2).
4.2.1.1.7. ProducedDocument
Produced document/Certificate.
Attributes
type
Type / stringDescription / Document type.
4.2.1.1.8. SpecialMention
Special mention.
Attributes
type
Type / stringDescription / Special mention type.
4.2.1.1.9. Qty
Type restricted to decimal(15,5).
4.2.1.1.10. SupplementaryUnit
Supplemantary unit data.
Attributes
unit
Type / stringDescription / Measurement unit code.
unitQualifier
Type / string [0..1]Description / Measurement unit qualifier code.
quantity
Type / QtyDescription / Quantity in supplemantary unit.
4.2.2. TaxCalculationAndValidationResponse
Response parameter for TaxCalculationAndValidation response message
Picture 4 TaxCalculationAndValidationResponse
4.2.2.1. Message data types
4.2.2.1.1. TaxCalculationAndValidationResponse
Response parameter for TaxCalculationAndValidation response message
4.2.2.1.2. ComplexTypeClass2
Attributes
MAPS02
Type / MAPS024.2.2.1.3. MAPS02
Tax calculation and validation response from MAPS system.
Attributes
referenceNumber
Type / stringDescription / The reference number of the customs declaration. The same as in the request.
grandTotalTaxesAmount
Type / TotalAmount [0..1]Description / Grand total taxes amount.
Result
Type / ResultGoodsItemResult
Type / GoodsItemResult [1..999]4.2.2.1.4. TotalAmount
Type restricted to decimal(15,2).
4.2.2.1.5. Result
Common structure for method results.
Attributes
ResultCode
Type / integerDescription / Result code. 1 - OK. Negative codes indicate serious problems
ResultDescription
Type / string [0..1]Description / Text information about source of the problem. Intended to support of debugging only. The best practice is to put information about source of error (exception description) in order to speed up problem resolution.
4.2.2.1.6. GoodsItemResult
The goods item of tax calculation and validation response.
Attributes
itemNumber
Type / integerDescription / Goods item number. The same as in the request.
commodityCode
Type / stringDescription / Concatenation of combined nomenclature and taric codes. The same as in the request.
totalItemTaxesAmount
Type / TotalAmount [0..1]Description / Total item taxes amount.
Measure
Type / Measure [0..*]Alert
Type / Alert [0..*]Footnote
Type / Footnote [0..*]4.2.2.1.7. Measure
Measure.
Attributes
type
Type / stringDescription / Measure type identifier.
hidden
Type / booleanDescription / Hidden flag..
CalculationOfTax
Type / CalculationOfTax [0..*]Alert
Type / Alert [0..*]Footnote
Type / Footnote [0..*]4.2.2.1.8. Alert
Alert.
Attributes
hidden
Type / booleanDescription / Hidden flag.
level
Type / stringDescription / Alert level (severity). Possible values: 1, 2, 3, 4, 5, 6.
1 - technical problem during request handling;
2 - calculation/validation stopped (errors found), declaration should be rejected;
3 - duties must be manually calculated;
4, 5, 6 - warning (should be investigated by customs officer).
code
Type / stringDescription / Additional code precising alert.
description
Type / stringDescription / Alert description.
4.2.2.1.9. Footnote
Footnote.
Attributes
id
Type / stringDescription / Footnote identifier.
4.2.2.1.10. CalculationOfTax
Tax calculation.
Attributes
typeOfTax
Type / stringDescription / Tax type code.
taxBase
Type / TotalAmountDescription / Tax base.
rateOfTax
Type / RateDescription / Tax rate.
amountOfTax
Type / TotalAmountDescription / Amount of tax.
4.2.2.1.11. Rate
Type restricted to decimal(9,4).
4.3. PortTypes
Picture 5 PortTypes
4.3.1. MAPSService
This service exposes operations accesible to EIS for tax calculation and validation operations in MAPS system. Information about all items is provided in the request. It is the synchronius service.
Operations
TaxCalculationAndValidation
Description / Method for sending declaration message to MAPS for tax calculation and validationParameters / TaxCalculationAndValidationRequest
Type / TaxCalculationAndValidation
Kind / in
TaxCalculationAndValidationResponse
Type / TaxCalculationAndValidationResponse
Kind / out
Return type
4.4. Bindings
Picture 6 Bindings
4.4.1. MAPSServiceBinding
TaxCalculationAndValidation service binding.
Operations
TaxCalculationAndValidation
Description / Method for sending declaration message to MAPS for tax calculation and validationParameters / TaxCalculationAndValidationRequest
Description / See corresponding data types.
Type / TaxCalculationAndValidation
Kind / in
TaxCalculationAndValidationResponse
Description / See corresponding data types.
Type / TaxCalculationAndValidationResponse
Kind / out
Return type
4.5. Services
Picture 7 MAPSService_v1r1
4.5.1. MAPSService_v1r1
This service exposes operations accesible to external system for tax calculation and validation operations in MAPS system. Information about all items is provided in the request. It is the synchronius service.
5. Annexes
5.1. MAPSService_v1r1 WSDL
5.2. Examples of data queries
Examples of data queries for Tax Calculation and Validation System (MAPS).
page 1/19