Package de.aeb.xnsg.expctrl.bf.v40

Class ECClearingDataDTO

java.lang.Object
de.aeb.xnsg.expctrl.bf.v40.ECClearingDataDTO
public class ECClearingDataDTO extends Object
Contains the detail data of an approval.

  • Field Details

    • atlasMrn

      public String atlasMrn
      Movement reference number (MRN) of export declaration.

      Maximum length: 40

    • customsOffice

      public String customsOffice
      The code of customs office that decrements the license.

      Maximum length: 40

    • customsAcceptanceDate

      public Date customsAcceptanceDate
      The date on which customs office accepts export declaration.

    • residualAmount

      public BigDecimal residualAmount
      This field is only used to report data back to the client system. Any value sent from the client system to Trade Compliance Management is ignored.

      Maximum length: 27
      Decimal digits: 7

    • residualValue

      public BigDecimal residualValue
      This field is only used to report data back to the client system. Any value sent from the client system to Trade Compliance Management is ignored.

      Maximum length: 15
      Decimal digits: 2

    • hasBsiApprovedGoods

      public Boolean hasBsiApprovedGoods
      Indicates whether the goods are approved by Federal Office for Information Security (BSI). Relevant for the reports about utilized general licenses (AG) that are sent to the BAFA about twice per year.

    • hasKWKGGoods

      public Boolean hasKWKGGoods
      Indicates if a license is required for the goods according to the German KWKG. Relevant for the reports about utilized general licenses (AG) that are sent to the BAFA about twice per year.

    • kwkgApplicationDate

      public Date kwkgApplicationDate
      The date of application for WWCA license.

    • kwkgLicenseNumber

      public String kwkgLicenseNumber
      The number of WWCA license

      Maximum length: 40

    • kwkgWeaponsListNumber

      public String kwkgWeaponsListNumber
      The number from war weapons list

      Maximum length: 20

    • kwkgPartialExport

      public Boolean kwkgPartialExport
      Indicates whether the complementary license is used to export a complete commodity or only parts of a commodity.

    • kwkgLicenseIssueDate

      public Date kwkgLicenseIssueDate
      The issue date of WWCA license. If the licensing authority has renewed the WWCA license, indicates the renewal date.

    • dateOfExport

      public Date dateOfExport
      The date of export

    • exportType

      public String exportType
      The type of export. Use the code 10 to indicate the final export of goods from section�A of the EU dual-use list. Otherwise, leave this field blank. Currently used only for collective export licenses.

    • exporter

      @Deprecated public ECPartnerDTO exporter
      Deprecated.
      As of 2016/05. Use partners instead.
      Information about the seller. If a partner is defined here, the field ECPartnerDTO.roleIdentCode will be ignored because the role is defined explicitly here.

    • receiver

      @Deprecated public ECPartnerDTO receiver
      Deprecated.
      As of 2016/05. Use partners instead.
      Information about the receiver. If a partner is defined here, the field ECPartnerDTO.roleIdentCode will be ignored because the role is defined explicitly here.

    • buyer

      @Deprecated public ECPartnerDTO buyer
      Deprecated.
      As of 2016/05. Use partners instead.
      Information about the buyer. If a partner is defined here, the field ECPartnerDTO.roleIdentCode will be ignored because the role is defined explicitly here.

    • endUser

      @Deprecated public ECPartnerDTO endUser
      Deprecated.
      As of 2016/05. Use partners instead.
      Information about the end user. If a partner is defined here, the field ECPartnerDTO.roleIdentCode will be ignored because the role is defined explicitly here.

    • partners

      public ECPartnerDTO[] partners
      Partners involved in this approval.
      This array may be used to define partners of the predefined standard roles or partners with other, configured roles.
      If there is at least one partner defined in the array, all other partners that can be defined explicitly in this DTO (like receiver, etc. will be ignored.
      Since:
      2016/05

    • endUse

      public String endUse
      End-uses of commodities. Please use a comma (,) to separate more than one end-use.

      Maximum length: 256

    • destinationCountry

      @Deprecated public String destinationCountry
      Deprecated.
      As of 2016/05. Use partners instead.
      The country of destination.

    • descriptionOfGoods1

      public String descriptionOfGoods1
      First line of description of commodity

      Maximum length: 40

    • descriptionOfGoods2

      public String descriptionOfGoods2
      Second line of description of commodity

      Maximum length: 40

    • descriptionOfGoods3

      public String descriptionOfGoods3
      Third line of description of commodity

      Maximum length: 40

    • descriptionOfGoods4

      public String descriptionOfGoods4
      Fourth line of description of commodity

      Maximum length: 40

    • commodityCode

      @Deprecated public String commodityCode
      Deprecated.
      As of 2016/05. Use productClassifications instead.
      The commodity code in statistical index of goods.
      max. length: 10

    • alNumber

      @Deprecated public String alNumber
      Deprecated.
      As of 2016/05. Use productClassifications instead.
      EU dual-use number of commodity.
      max. length: 12

    • productClassifications

      public ECClassificationDTO[] productClassifications
      The attributes of the transaction item, e.g. export control numbers, material number, commodity code and other relevant numbers for export control checks and license matching. Only attributes using an ident code of a goods attribute in master data are added to the approval, any other attributes are ignored.
      Since:
      2016/05

    • identitiesOfGoods

      public ECIdentityOfGoodsDTO[] identitiesOfGoods
      The identities of goods for this approval, e.g. serial numbers, lot numbers, etc.
      To ensure to use the same license for the same physical goods between different transactions (inbound, outbound, etc.), these identities may be used for license matching in addition to the product classifications.
      Since:
      2016/05

    • aggRegistrationNumber

      @Deprecated public String aggRegistrationNumber
      Deprecated.
      As of 2016/05.
      Registration number assigned by licensing authority to general license used for this approval.
      max. length: 8

    • manufacturerDescription

      public String manufacturerDescription
      Manufacturer of commodity.

      Maximum length: 25

    • atlasCertificateCode

      @Deprecated public String atlasCertificateCode
      Deprecated.
      As of 2016/05. Use ApprovalCustomsDataDTO.customsLicenseTypeCode instead.
      ATLAS code of document of license used.
      Since FP 08-2022: Only contains the document code for Germany (ATLAS).
      max. length: 40

    • atlasCertificateQualifier

      @Deprecated public String atlasCertificateQualifier
      Deprecated.
      As of 2016/05. Use ApprovalCustomsDataDTO.customsLicenseTypeCode instead.
      ATLAS qualifier of document of license used.
      Since FP 08-2022: Only contains the document code for Germany (ATLAS).
      max. length: 40

    • customsDocumentCode1

      public String customsDocumentCode1
      First code of customs document or certificate.
      Note: Since FP 08-2022 customs document codes are available for more than one country, but for the deprecated IExportControl40BF.getClearingForId(ECClearingReferenceDTO, ECParmsDTO) we return a code which has the best backward compatibility, which is the German document code, if available or for any other country, if no German code is available.

      Maximum length: 40

    • customsDocumentCode2

      public String customsDocumentCode2
      Second code of customs document or certificate.
      Note: Since FP 08-2022: See comment on customsDocumentCode1.

      Maximum length: 40

    • licenseIssueDate

      public Date licenseIssueDate
      This field is used to indicate the issue date. If the licensing authority has renewed the export authorization, indicates the renewal date.

    • licenseExpirationDate

      public Date licenseExpirationDate
      This field indicates the expiration date of the declared export authorization.

    • licenseIsoCode

      public String licenseIsoCode
      Two-letter ISO code of the jurisdiction for which license was issued.

      Example value: "DE" for a German license
      Maximum length: 2

    • atlasAdditionalData

      public String atlasAdditionalData
      "Supplement" field in the export declaration document. The declarant can use this field to provide additional information about the export declaration.

      Maximum length: 36

    • dateOfReturn

      public Date dateOfReturn
      The date of return for temporarily exported commodities.

    • referenceTransactionBafa

      public String referenceTransactionBafa
      The number of the initial license, with which the goods have been exported before.

      Maximum length: 256

    • transactionBafa

      @Deprecated public String transactionBafa
      Deprecated.
      As of 2016/05.
      The ELANK2 transaction number of license used.
      max. length: 256

    • typeOfGoods

      public String typeOfGoods
      Description of type of commodity.

      Maximum length: 45

    • orderNumber

      public String orderNumber
      The internal order number of seller for this delivery.

      Maximum length: 20

    • atlasReference

      public String atlasReference
      The "Reference" field in an export declaration document.

      Maximum length: 20

    • originalValue

      public BigDecimal originalValue
      The amount of money in the currency of the order.

    • originalValueCurrency

      public String originalValueCurrency
      The currency of field originalValue.

    • value

      public BigDecimal value
      The amount of money which should be used for depletion. Must be in the currency of the used license.

      Maximum length: 15
      Decimal digits: 2

    • valueCurrency

      public String valueCurrency
      The ISO code of the currency from the value. Must be the same currency as in the used license.

      Length: 3

    • valueBooked

      public BigDecimal valueBooked
      The part of the value, which was successful booked from the license or parent approval.
      Only filled in return values of the methods IExportControl40BF.getClearingForId(ECClearingReferenceDTO, ECParmsDTO) and IExportControl40BF.handleClearing(ECClearingRequestDTO, ECParmsDTO) . Ignored as parameter of IExportControl40BF.handleClearing(ECClearingRequestDTO, ECParmsDTO) .

      Maximum length: 15
      Decimal digits: 2
      Since:
      2016/05

    • valueBookedCurrency

      public String valueBookedCurrency
      The currency of the part of the value, which was successful booked from the license or parent approval.
      Only filled in return values of the methods IExportControl40BF.getClearingForId(ECClearingReferenceDTO, ECParmsDTO) and IExportControl40BF.handleClearing(ECClearingRequestDTO, ECParmsDTO) . Ignored as parameter of IExportControl40BF.handleClearing(ECClearingRequestDTO, ECParmsDTO) .

      Length: 3
      Since:
      2016/05

    • quantity

      public BigDecimal quantity
      The quantity which should be used for depletion. Must be in the unit of the used license.

      Maximum length: 27
      Decimal digits: 7

    • quantityUnit

      public String quantityUnit
      The unit of the quantity. Must be the same unit as in the used license.

      Length: 20

    • quantityBooked

      public BigDecimal quantityBooked
      The part of the quantity, which was successful booked from the license or parent approval.
      Only filled in return values of the methods IExportControl40BF.getClearingForId(ECClearingReferenceDTO, ECParmsDTO) and IExportControl40BF.handleClearing(ECClearingRequestDTO, ECParmsDTO) . Ignored as parameter of IExportControl40BF.handleClearing(ECClearingRequestDTO, ECParmsDTO) .

      Maximum length: 27
      Decimal digits: 7
      Since:
      2016/05

    • quantityBookedUnit

      public String quantityBookedUnit
      The quantity unit of the part of the quantity, which was successful booked from the license or parent approval.
      Only filled in return values of the methods IExportControl40BF.getClearingForId(ECClearingReferenceDTO, ECParmsDTO) and IExportControl40BF.handleClearing(ECClearingRequestDTO, ECParmsDTO) . Ignored as parameter of IExportControl40BF.handleClearing(ECClearingRequestDTO, ECParmsDTO) .

      Length: 20
      Since:
      2016/05

    • decisiveDate

      public Date decisiveDate
      The decisive date to handle the clearing.

    • customsClientTransactionRef

      public String customsClientTransactionRef
      Number of the transaction/document, from which the export declaration was created.

      Length: 25

    • qtyUnitLicenseAuthorityGermany

      public String qtyUnitLicenseAuthorityGermany
      The quantity unit used by the German license authority (BAFA).

      Length: 16
      Since:
      2023/11

  • Constructor Details

    • ECClearingDataDTO

      public ECClearingDataDTO()