Serialized Form

  • Package de.aeb.xnsg.expctrl.af

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

    • Class de.aeb.xnsg.expctrl.bf.v40.ECAmountDTO

      class ECAmountDTO extends Object implements Serializable

      • Serialized Fields

        • currencyIso
          String currencyIso
          The three-letter ISO code of the currency of the amount of money.

          Example value: "EUR"
          Maximum length: 3
        • value
          BigDecimal value
          The value of the amount of money.

          Example value: "1000.00" Maximum length: 15
          Decimals digits: 2

    • Class de.aeb.xnsg.expctrl.bf.v40.ECAvailableLicenseDTO

      class ECAvailableLicenseDTO extends Object implements Serializable

      • Serialized Fields

        • availableLicensePositions
          ECLicensePositionDTO[] availableLicensePositions
          Contains the items within a non-general license which can be used for depletion. If license items exist, the user has to choose one of these to do the approval definition. Otherwise the approval will not be accepted.
        • internalReference
          String internalReference
          The internal identifier to reference the license.
        • isNotifyRequirementUncertain
          Boolean isNotifyRequirementUncertain
          Deprecated.
          As of 2013/05. Now always false is returned.
          true if the user has to decide whether the license has a notification requirement (Meldepflicht). In this case the user's decision has to be transmitted in the "handleClearing" web service.
        • isSuggestedLicense
          Boolean isSuggestedLicense
          If true, Trade Compliance Management suggests to use the license to release the item.
        • isUsableForAutoClearing
          Boolean isUsableForAutoClearing
          Indicates that the license can be used to automatically create an approval based on this license. By this, it is possible to release a transaction item with a restriction in a certain jurisdiction without the necessity to create an approval manually.
        • licenseCurrency
          String licenseCurrency
          Contains the currency ISO code of the license.

          Example value: "EUR"
        • licenseDescription
          ECLocalizedTextDTO[] licenseDescription
          The license description of the used license.
        • licenseId
          String licenseId
          The id of the license. The field is filled, depending on the origin of the license:
          In case of
          • a license from License Management, the internal id of the license is passed, e.g. 00000000000000231543.
          • a license from Export Controls, the license number of the license with leading prefix EC_ is passed, e.g. EC_EU001, EC_AGG09.
          • no license is required, NLR is passed.
          • referencing a license that does not exist in Trade Compliance Management, the field is empty (null).
          Since:
          2016/05
        • licenseNumber
          String licenseNumber
          The license number of the used license.
        • licenseType
          String licenseType
          Deprecated.
          As of 2016/05. If the applied license is specified by ECClearingDTO.licenseReference, there is no need to specify the license type explicitly (see ECClearingDTO.licenseType)
          The license type of the license. One of the following constants defined here:
          ECClearingDTO.licenseType
        • licenseTypeDescription
          ECLocalizedTextDTO[] licenseTypeDescription
          A textual description of the license type in different languages, i.e. in German and English.

    • Class de.aeb.xnsg.expctrl.bf.v40.ECClassificationDTO

      class ECClassificationDTO extends Object implements Serializable

      • Serialized Fields

        • classificationIdentCode
          String classificationIdentCode
          Identcode of the classification the ECClassificationDTO.classificationNumber belongs to.
          There are some predefined attributes and others may be configured.
          The following predefined attributes are supported:
        • classificationNumber
          String classificationNumber
          The value of the attribute, e.g. a export control number, material number, commodity code and other relevant numbers for export control checks and license matching.
          There are some predefined values with a special meaning:
          • For all attributes: "NOT_LISTED" indicating that an item is not listed on the goods list describing the classification.
          • For ECCNs: "EAR99" indicating that the item is an EAR99 product.
          Example value: "0A002"
        • productName
          String productName
          Deprecated.
          This field is deprecated, since it was never used and it is not planned to be used in the future. The feature of "self learning" master file data for products has been implemented in an extra product (Product Classification).
          Name of product.

    • Class de.aeb.xnsg.expctrl.bf.v40.ECClearingReferenceDTO

      class ECClearingReferenceDTO extends Object implements Serializable

    • Class de.aeb.xnsg.expctrl.bf.v40.ECCompletionStatusDTO

      class ECCompletionStatusDTO extends Object implements Serializable

    • Class de.aeb.xnsg.expctrl.bf.v40.ECCustomsInfoDTO

      class ECCustomsInfoDTO extends Object implements Serializable

    • Class de.aeb.xnsg.expctrl.bf.v40.ECCustomsInfoResultDTO

      class ECCustomsInfoResultDTO extends Object implements Serializable

      • Serialized Fields

        • errorText
          String errorText
          If there was an error in the processing of the request the error text will be stored here.

          Maximum length: unlimited
        • hadErrors
          Boolean hadErrors
          If there was an error in the processing of the request this flag will be true.

          Default value: false

    • Class de.aeb.xnsg.expctrl.bf.v40.ECIdentifierDTO

      class ECIdentifierDTO extends Object implements Serializable

      • Serialized Fields

        • description
          ECLocalizedTextDTO[] description
          A textual description of the identifier in different languages, i.e. in German and English.
        • identCode
          String identCode
          The unique identifier of the object identified by this DTO.

          Maximum length: 40

    • Class de.aeb.xnsg.expctrl.bf.v40.ECLicensePositionDTO

      class ECLicensePositionDTO extends Object implements Serializable

      • Serialized Fields

        • decrementType
          String decrementType
          Contains the decrement type of the license item. Possible values are:
          • QUANTITY
          • VALUE
          • QUANTITY_VALUE
        • isSuggestedPosition
          Boolean isSuggestedPosition
          Is true if Trade Compliance Management suggests to use the license item to release the item.
        • isUsableForAutoClearing
          Boolean isUsableForAutoClearing
          Indicates that the license item can be used to automatically create an approval based on this license item and its license. By this, it is possible to release a transaction item with a restriction in a certain jurisdiction without the necessity to create an approval manually.
        • licenseItemId
          String licenseItemId
          The id of the license item.
          Since:
          2016/05
        • name
          String name
          Contains the goods name of a license item.
        • positionNumber
          String positionNumber
          Contains the item number of an individual license.

          Maximum length: 100
        • positionQuantityUnit
          String positionQuantityUnit
          Contains the quantity unit of the item.

          Example value: "St" for "St�ck" (engl. piece)
        • positionValueCurrency
          String positionValueCurrency
          Contains the value currency of the item.

          Example value: "EUR"
        • residual
          BigDecimal residual
          Deprecated.
          As of SF 12/2012. Use field ECLicensePositionDTO.residualValue or ECLicensePositionDTO.residualQuantity instead.
          Contains the residual value or quantity, depending on the decrement type. In case of decrement type "quantity and value", quantity is returned.
        • residualQuantity
          BigDecimal residualQuantity
          Contains the currently available quantity for the transaction item, with respect to the transaction type. E.g. for transactions, which are movements from the company to the customer, this is the quantity currently available at the company. E.g. for transactions, which are movements from the supplier to the company, this is the quantity currently available at the supplier. null, if not relevant for the depletion method of the license item.
        • residualValue
          BigDecimal residualValue
          Only filled in responses to IExportControl40BF.proposeLicenses(LMProposeLicensesRequestDTO). Contains the currently available value for the transaction item, with respect to the transaction type. E.g. for transactions, which are movements from the company to the customer, this is the value currently available at the company. E.g. for transactions, which are movements from the supplier to the company, this is the value currently available at the supplier. null, if not relevant for the depletion method of the license item.

    • Class de.aeb.xnsg.expctrl.bf.v40.ECLocalizedTextDTO

      class ECLocalizedTextDTO extends Object implements Serializable

      • Serialized Fields

        • language
          String language
          The language of the text. Possible values:
          • de
          • en
          Length: 2
        • text
          String text
          The text in the language.

    • Class de.aeb.xnsg.expctrl.bf.v40.ECPartnerDTO

      class ECPartnerDTO extends Object implements Serializable

      • Serialized Fields

        • bafaID
          String bafaID
          Deprecated.
          As of 2013/09.
          bafa id of this company/person.
          Maximum length: 6
        • city
          String city
          Address - city.

          Example value: "Main City"
          Maximum length: 50
        • cityPobox
          String cityPobox
          City of the P.O. box.

          Example value: "PO City"
          Maximum length: 50
        • companyReference
          String companyReference
          Internal company number.

          Example value: "12"
          Maximum length: 20
        • countryIso
          String countryIso
          Address - country as two-letter ISO code

          Example value: "DE"
          Maximum length: 2
        • customsNumber
          String customsNumber
          German customs number of the company.

          Example value: "1234567"
          Maximum length: 7
        • district
          String district
          Address - district.

          Example value: "District of Main"
          Maximum length: 50
        • eoriNumber
          String eoriNumber
          The internationally unique identification number of the company assigned by customs. (EORI number - Economic Operators' Registration and Identification).

          Example value: "DE012345678912345"
          Maximum length: 17
        • establishmentNumber
          String establishmentNumber
          The number of the respective national office of a company. The EORI number and this identification number will replace the existing customs number.

          Example value: "0000"
          Maximum length: 4
        • isMilitary
          Boolean isMilitary
          Indicates that the company is associated with the armed forces of EC member country. Relevant for the reports about utilized general licenses (AG) that are sent to the BAFA about twice per year.
        • name1
          String name1
          Field 1 for full name of the company/person.

          Example value: "Paul"
          Maximum length: 40
        • name2
          String name2
          Field 2 for full name of the company/person.

          Example value: "Eugene"
          Maximum length: 40
        • name3
          String name3
          Field 3 for full name of the company/person.

          Example value: "Carl"
          Maximum length: 40
        • name4
          String name4
          Field 4 for full name of the company/person.

          Example value: "Miller"
          Maximum length: 40
        • poBox
          String poBox
          P.O. box.

          Example value: "121200"
          Maximum length: 50
        • postalCode
          String postalCode
          Address - postal code of the street address (not postal code of P.O. box).

          Example value: "12100"
          Maximum length: 20
        • postalCodePoBox
          String postalCodePoBox
          Postal code of the P.O. box.

          Example value: "21010"
          Maximum length: 20
        • roleIdentCode
          String roleIdentCode
          Mandatory field
          The ident code of the role of the partner in the transaction. This field is mandatory.

          There are some predefined identCodes and others may be configured.
          The following predefined role identCode's are supported:
          Since:
          2016/05
        • street
          String street
          Address - street and number.

          Example value: "Main street 10"
          Maximum length: 50
        • street2
          String street2
          Address - street 2 and number.

          Example value: "Second level"
          Maximum length: 50

    • Class de.aeb.xnsg.expctrl.bf.v40.ECPluginDTO

      class ECPluginDTO extends ECIdentifierDTO implements Serializable

    • Class de.aeb.xnsg.expctrl.bf.v40.ECUnfinalizeClearingRequestDTO

      class ECUnfinalizeClearingRequestDTO extends Object implements Serializable

      • Serialized Fields

        • uniqueClearingId
          String uniqueClearingId
          The mandatory, unique identifier of the approval to modify.

          Maximum length: 100
        • userComment
          String userComment
          A comment to be stored for the approval. It overwrites the existing comment of the approval.

          Maximum length: 3,000

    • Class de.aeb.xnsg.expctrl.bf.v40.ECUnfinalizeClearingResponseDTO

      class ECUnfinalizeClearingResponseDTO extends Object implements Serializable

      • Serialized Fields

        • errorText
          String errorText
          The error message, if there was an error while processing the request.

          Maximum length: unlimited
        • hadErrors
          Boolean hadErrors
          Indicates whether there was an error while processing the request.
        • userComment
          String userComment
          The comment stored for the approval.

          Maximum length: 3,000