openapi: 3.2.0
info:
  title: BSM (TEST2) HTTP International Customs International Customs API
  description: Thank you for using our HTTP API documentation.
  version: '1.0'
servers:
- url: https://rz3.aeb.de/test2bsm/rest
security:
- SWAGGER_AUTH_KEY: []
- BASIC_AUTH: []
tags:
- name: International Customs API
  description: Interface overview for Customs Management
paths:
  /InternationalCustomsBFBean/acknowledgeGetChangedDeclarations:
    post:
      tags:
      - International Customs API
      summary: Acknowledge call of get changed declarations
      description: 'Acknowledge, that the result of calling {@link #getChangedDeclarations(ICGetChangedDeclarationsRequestDTO)} was processed.'
      operationId: acknowledgeGetChangedDeclarations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ICAcknowledgeGetChangedDeclarationsRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/ICAcknowledgeGetChangedDeclarationsRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ICAcknowledgeGetChangedDeclarationsResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/ICAcknowledgeGetChangedDeclarationsResponseDTO'
      security:
      - BASIC_AUTH: []
  /InternationalCustomsBFBean/addDeclarationAttachments:
    post:
      tags:
      - International Customs API
      summary: Add declaration attachments
      description: Add attachments (files) to declarations. The size of the files are limited to a configurable size (e.g. 20 MB)<br> This operation is deprecated, use createConsignment with attachments instead.
      operationId: addDeclarationAttachments
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ICAddDeclarationAttachmentsRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/ICAddDeclarationAttachmentsRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ICAddDeclarationAttachmentsResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/ICAddDeclarationAttachmentsResponseDTO'
      deprecated: true
      security:
      - BASIC_AUTH: []
  /InternationalCustomsBFBean/cancelConsignment:
    post:
      tags:
      - International Customs API
      summary: Cancel consignment
      description: 'Initiates a cancellation process for the requested consignment. <br> The consignment can be addressed via the consignment id from the client system (field ''consignmentIdClientSystem'') or via the businessObjectId which is the reference of the ICI system. If both fields are entered the businessObjectId will be used.<br> There are two possible outcomes: <ul> <li>Deletion of the consignment and all referenced declarations</li> <li>Invalidation of the consignment and all referenced declarations</li> </ul> If it is not possible to delete or invalidate nothing will be done.'
      operationId: cancelConsignment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ICCancelConsignmentRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/ICCancelConsignmentRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ICCancelConsignmentResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/ICCancelConsignmentResponseDTO'
      security:
      - BASIC_AUTH: []
  /InternationalCustomsBFBean/cancelConsignmentManifest:
    post:
      tags:
      - International Customs API
      summary: Cancel consignment manifest
      description: 'Initiates a cancellation process for the requested consignment manifest. <br> The consignment manifest can be addressed via the consignment id from the client system (field ''consignmentIdClientSystem'') or via the businessObjectId which is the reference of the ICI system. If both fields are entered the businessObjectId will be used.<br> There are two possible outcomes: <ul> <li>Deletion of the consignment manifest and all referenced declarations</li> <li>Invalidation of the consignment manifest and all referenced declarations</li> </ul> If it is not possible to delete or invalidate nothing will be done.'
      operationId: cancelConsignmentManifest
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ICCancelConsignmentRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/ICCancelConsignmentRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ICCancelConsignmentResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/ICCancelConsignmentResponseDTO'
      security:
      - BASIC_AUTH: []
  /InternationalCustomsBFBean/cancelDeclaration:
    post:
      tags:
      - International Customs API
      summary: Cancel declaration
      description: 'Initiates a cancellation process for the requested declaration. <br> There are two possible outcomes: <ul> <li>Deletion of the declaration</li> <li>Invalidation of the declaration</li> </ul> If it is not possible to delete or invalidate nothing will be done.'
      operationId: cancelDeclaration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ICCancelDeclarationRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/ICCancelDeclarationRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ICCancelDeclarationResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/ICCancelDeclarationResponseDTO'
      security:
      - BASIC_AUTH: []
  /InternationalCustomsBFBean/createConsignment:
    post:
      tags:
      - International Customs API
      summary: Create a consignment
      description: Creates a new consignment. If any fields on consignment or delivery level are empty which are mandatory an error message will be created and the creation stopped. Only if the mandatory fields are filled the consignment will be created and imported.
      operationId: createConsignment_1
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ICCreateConsignmentRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/ICCreateConsignmentRequestDTO'
      responses:
        default:
          description: The created consignment
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ICCreateConsignmentResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/ICCreateConsignmentResponseDTO'
      security:
      - BASIC_AUTH: []
  /InternationalCustomsBFBean/createConsignmentManifest:
    post:
      tags:
      - International Customs API
      summary: Create a consignment manifest
      description: Creates a consignment manifest. If any fields are empty which are mandatory an error message will be created and the creation stopped. Only if the mandatory fields are filled the consignment manifest will be created and imported.
      operationId: createConsignmentManifest
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ICCreateConsignmentManifestRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/ICCreateConsignmentManifestRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ICCreateConsignmentManifestResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/ICCreateConsignmentManifestResponseDTO'
      security:
      - BASIC_AUTH: []
  /InternationalCustomsBFBean/createDelivery:
    post:
      tags:
      - International Customs API
      summary: Create a delivery
      description: Creates a delivery. If any fields are empty which are mandatory an error message will be created and the creation stopped. Only if the mandatory fields are filled the delivery will be created and imported.
      operationId: createDelivery
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ICCreateDeliveryRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/ICCreateDeliveryRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ICCreateDeliveryResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/ICCreateDeliveryResponseDTO'
      security:
      - BASIC_AUTH: []
  /InternationalCustomsBFBean/getBrokerDeclarations:
    post:
      tags:
      - International Customs API
      summary: Get broker declarations
      description: Returns the broker declarations specified by the list of business object ids or consignmentIdClientSystem in the request. You may also specify the amount of broker declaration data returned by choosing from a set of scenarios.
      operationId: getBrokerDeclarations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ICGetBrokerDeclarationsRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/ICGetBrokerDeclarationsRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ICGetBrokerDeclarationsResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/ICGetBrokerDeclarationsResponseDTO'
      security:
      - BASIC_AUTH: []
  /InternationalCustomsBFBean/getChangedDeclarations:
    post:
      tags:
      - International Customs API
      summary: Get changed declarations
      description: 'Returns all changed (modified) declarations, which were not yet acknowledged.<br> Only declarations, for which the client system is subscribed, will be returned.<br> If the caller has processed the returned declarations, he should call {@link #acknowledgeGetChangedDeclarations(ICAcknowledgeGetChangedDeclarationsRequestDTO)} to acknowledge.'
      operationId: getChangedDeclarations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ICGetChangedDeclarationsRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/ICGetChangedDeclarationsRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ICGetChangedDeclarationsResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/ICGetChangedDeclarationsResponseDTO'
      security:
      - BASIC_AUTH: []
  /InternationalCustomsBFBean/getCodes:
    post:
      tags:
      - International Customs API
      summary: Get codes
      description: Returns a list of valid codes and its descriptions for the given request parameters. <br> Use the value "CODELISTS" for request parameter 'codeListCode' to get all possible values for this field.
      operationId: getCodes
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ICGetCodesRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/ICGetCodesRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ICGetCodesResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/ICGetCodesResponseDTO'
      security:
      - BASIC_AUTH: []
  /InternationalCustomsBFBean/getConsignmentsOfManifest:
    post:
      tags:
      - International Customs API
      summary: Get consignments of manifest
      description: Retrieves a list of business object ids of all consignments collected in the manifest.
      operationId: getConsignmentsOfManifest
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ICGetConsignmentsOfManifestRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/ICGetConsignmentsOfManifestRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ICGetConsignmentsOfManifestResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/ICGetConsignmentsOfManifestResponseDTO'
      security:
      - BASIC_AUTH: []
  /InternationalCustomsBFBean/getDeclarationAttachments:
    post:
      tags:
      - International Customs API
      summary: Get declaration attachments
      description: Gets one or more attachments from a declaration.
      operationId: getDeclarationAttachments
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ICGetDeclarationAttachmentsRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/ICGetDeclarationAttachmentsRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ICGetDeclarationAttachmentsResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/ICGetDeclarationAttachmentsResponseDTO'
      security:
      - BASIC_AUTH: []
  /InternationalCustomsBFBean/getDeclarations:
    post:
      tags:
      - International Customs API
      summary: Get declarations
      description: Returns the declarations specified by the list of business object ids in the request. You may also specify the amount of declaration data returned by choosing from a set of scenarios.
      operationId: getDeclarations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ICGetDeclarationsRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/ICGetDeclarationsRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ICGetDeclarationsResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/ICGetDeclarationsResponseDTO'
      security:
      - BASIC_AUTH: []
  /InternationalCustomsBFBean/sendDeclarations:
    post:
      tags:
      - International Customs API
      summary: Send declarations
      description: Sends declaration messages for the specified declarations to the respective customs systems. If the declarations are not ready for sending, an email notification is sent out, if configured.
      operationId: sendDeclarations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ICSendDeclarationMessageRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/ICSendDeclarationMessageRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ICSendDeclarationMessageResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/ICSendDeclarationMessageResponseDTO'
      security:
      - BASIC_AUTH: []
  /InternationalCustomsBFBean/setDeclarationAttachmentsStatus:
    post:
      tags:
      - International Customs API
      summary: Set declaration attachment status
      description: Sets the status of one or more attachments.
      operationId: setDeclarationAttachmentsStatus
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ICSetDeclarationAttachmentsStatusRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/ICSetDeclarationAttachmentsStatusRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ICSetDeclarationAttachmentsStatusResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/ICSetDeclarationAttachmentsStatusResponseDTO'
      security:
      - BASIC_AUTH: []
components:
  schemas:
    ICDeclarationItemTransitArrivalDTO:
      type: object
      properties:
        packages:
          type: array
          description: List of Packages.
          items:
            $ref: '#/components/schemas/ICDeclarationPackageDTO'
      description: Transit arrival specific extension data for a declaration item.
    ICDeclarationPackageDTO:
      type: object
      properties:
        sequenceNumber:
          maxLength: 5
          type: integer
          description: Sequence number of the item.
          format: int32
        numberOfPackages:
          maxLength: 8
          type: integer
          description: Number of packages
          format: int32
        typeCode:
          maxLength: 3
          type: string
          description: UN/ECE package type
        marks:
          maxLength: 512
          type: string
          description: Shipping marks
      description: DTO to hold data of a package for a declaration item.
    ICDeliveryExtensionDataDTO:
      type: object
      properties:
        exportBroker:
          $ref: '#/components/schemas/ICDeliveryBrokerDTO'
        importBroker:
          $ref: '#/components/schemas/ICDeliveryBrokerDTO'
        exportGB:
          $ref: '#/components/schemas/ICDeliveryEUDTO'
        importGB:
          $ref: '#/components/schemas/ICDeliveryEUDTO'
        transitGB:
          $ref: '#/components/schemas/ICDeliveryTransitEUDTO'
        ensXI:
          $ref: '#/components/schemas/ICDeliveryEUDTO'
        ensGB:
          $ref: '#/components/schemas/ICDeliveryEUDTO'
        exportNL:
          $ref: '#/components/schemas/ICDeliveryEUDTO'
        importNL:
          $ref: '#/components/schemas/ICDeliveryEUDTO'
        transitNL:
          $ref: '#/components/schemas/ICDeliveryTransitEUDTO'
        exportBE:
          $ref: '#/components/schemas/ICDeliveryEUDTO'
        importBE:
          $ref: '#/components/schemas/ICDeliveryEUDTO'
        transitBE:
          $ref: '#/components/schemas/ICDeliveryTransitEUDTO'
        ensBE:
          $ref: '#/components/schemas/ICDeliveryEUDTO'
        exportAT:
          $ref: '#/components/schemas/ICDeliveryEUDTO'
        exportDK:
          $ref: '#/components/schemas/ICDeliveryEUDTO'
        exportFR:
          $ref: '#/components/schemas/ICDeliveryEUDTO'
        ensFR:
          $ref: '#/components/schemas/ICDeliveryEUDTO'
        exportPL:
          $ref: '#/components/schemas/ICDeliveryEUDTO'
        exportSE:
          $ref: '#/components/schemas/ICDeliveryEUDTO'
        exportDE:
          $ref: '#/components/schemas/ICDeliveryExportDEDTO'
        importDE:
          $ref: '#/components/schemas/ICDeliveryImportDEDTO'
        transitDE:
          $ref: '#/components/schemas/ICDeliveryTransitEUDTO'
        exportUS:
          $ref: '#/components/schemas/ICDeliveryExportUSDTO'
        gvmsGB:
          $ref: '#/components/schemas/ICDeliveryGVMSGBDTO'
        ensIE:
          $ref: '#/components/schemas/ICDeliveryEUDTO'
        summaryDeclarationDE:
          $ref: '#/components/schemas/ICDeliverySummaryDeclarationDEDTO'
        exportCH:
          $ref: '#/components/schemas/ICDeliveryExportCHDTO'
        importCH:
          $ref: '#/components/schemas/ICDeliveryImportCHDTO'
        gmrCH:
          $ref: '#/components/schemas/ICDeliveryGMRCHDTO'
        transitCH:
          $ref: '#/components/schemas/ICDeliveryTransitEUDTO'
        consumerShipmentXI:
          $ref: '#/components/schemas/ICDeliveryConsumerShipmentXIDTO'
        ensSTI:
          $ref: '#/components/schemas/ICDeliverySTIDTO'
      description: DTO to hold delivery extension data for customs processes. Extension data is only required in some cases. Not all customs processes are supported.
    ICExtraFieldDTO:
      type: object
      properties:
        identCode:
          maxLength: 50
          type: string
          description: Code of the extra field.
        value:
          maxLength: 1000
          type: string
          description: Value of the extra field.
      description: Represents an extra field (or additional field). Extra fields must be configured in ICI and linked to the customs process.
    ICDeclarationExtensionDataDTO:
      type: object
      properties:
        exportCH:
          $ref: '#/components/schemas/ICDeclarationCHDTO'
        importCH:
          $ref: '#/components/schemas/ICDeclarationCHDTO'
        exportGB:
          $ref: '#/components/schemas/ICDeclarationGBDTO'
        importGB:
          $ref: '#/components/schemas/ICDeclarationGBDTO'
        exportBroker:
          $ref: '#/components/schemas/ICDeclarationBrokerDTO'
        importBroker:
          $ref: '#/components/schemas/ICDeclarationBrokerDTO'
        transitCH:
          $ref: '#/components/schemas/ICTransitDeclarationDTO'
        transitBE:
          $ref: '#/components/schemas/ICTransitDeclarationDTO'
        transitGB:
          $ref: '#/components/schemas/ICTransitDeclarationDTO'
        transitNL:
          $ref: '#/components/schemas/ICTransitDeclarationDTO'
        transitDE:
          $ref: '#/components/schemas/ICTransitDeclarationDTO'
      description: DTO to hold declaration extension data for customs processes. Not all customs processes are supported.
    ICCreateConsignmentResponseDTO:
      type: object
      properties:
        hasErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>An error usually means that the request could not be performed.</p><p>Error details are provided in the messages[] array.</p>
          example: false
        hasOnlyRetryableErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        hasWarnings:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        messages:
          type: array
          description: <p>Error or warning messages at the request level.</p><p>There may be additional messages[] arrays at lower data levels as specified in the documentation.</p>
          items:
            $ref: '#/components/schemas/ResponseMessageDTO'
        consignment:
          $ref: '#/components/schemas/ICConsignmentResultDTO'
      description: The response DTO after processing the request. Contains the resulting consignment DTO.
    ICDeliveryBrokerDTO:
      type: object
      properties:
        extraFields:
          type: array
          description: Extra fields for the delivery.
          items:
            $ref: '#/components/schemas/ICExtraFieldDTO'
      description: DTO to hold Broker extension data for a ICDeliveryDTO.
    ICAddDeclarationAttachmentsResponseDTO:
      type: object
      properties:
        hasErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>An error usually means that the request could not be performed.</p><p>Error details are provided in the messages[] array.</p>
          example: false
        hasOnlyRetryableErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        hasWarnings:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        messages:
          type: array
          description: <p>Error or warning messages at the request level.</p><p>There may be additional messages[] arrays at lower data levels as specified in the documentation.</p>
          items:
            $ref: '#/components/schemas/ResponseMessageDTO'
      description: Result data for the add-declaration-attachments operation.
    OutwardProcessingIdentificationMeansFieldDTO:
      type: object
      properties:
        type:
          maxLength: 1
          type: string
          description: Commodity code
        description:
          maxLength: 350
          type: string
          description: Description of identification means for type S
      description: Represents an identification means field for outward processing
    ICGetDeclarationsResponseDTO:
      type: object
      properties:
        hasErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>An error usually means that the request could not be performed.</p><p>Error details are provided in the messages[] array.</p>
          example: false
        hasOnlyRetryableErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        hasWarnings:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        messages:
          type: array
          description: <p>Error or warning messages at the request level.</p><p>There may be additional messages[] arrays at lower data levels as specified in the documentation.</p>
          items:
            $ref: '#/components/schemas/ResponseMessageDTO'
        declarations:
          type: array
          description: Data of the requested declarations.
          items:
            $ref: '#/components/schemas/ICDeclarationDTO'
      description: Response containing requested declarations.
    ICTransportEquipmentDTO:
      type: object
      properties:
        equipmentType:
          maxLength: 35
          type: string
          description: Specific equimpment type. <ul> <li>'CONTAINER' - Container number</li> <li>'TRAILER' - Trailer ID</li> </ul>
        identification:
          maxLength: 17
          type: string
          description: The equipment identification number, e.g. container number or trailer id.
        seals:
          type: array
          description: List of seals which belong to the transport equipment.
          items:
            $ref: '#/components/schemas/ICSealDTO'
      description: DTO to hold data of transport equipment.
    ICDeferredPaymentDTO:
      type: object
      properties:
        categoryCode:
          maxLength: 1
          type: string
          description: Deferment category code.
        typeCode:
          maxLength: 1
          type: string
          description: Deferment type code.
        deferralAccountNumber:
          maxLength: 7
          type: string
          description: Number of the deferment account.
      description: DTO to hold data for deferred payments.
    ICAcknowledgeGetChangedDeclarationsRequestDTO:
      type: object
      properties:
        clientSystemId:
          type: string
          description: '<p>Id of the sending client system.</p><p>e.g. Installation ID of the sending host or ERP system.</p><p>Maximum length: 20</p>'
          example: TEST_ID
        clientIdentCode:
          type: string
          description: '<p>Client identification code.</p><p>Maximum length: 10</p>'
          example: APITEST
        userName:
          type: string
          description: <p>User who initiated the request from the client system.</p><p>If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.</p><p>If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.</p><p>Actual authentication is handled separately via the request's headers, so no password is required in the request's data.</p>
          example: API_TEST
        resultLanguageIsoCodes:
          type: array
          description: <p>2-letter ISO codes of the languages in which texts will be returned.</p><p>English ('en') and German ('de') are typically supported by default. Other languages may be supported.</p><p>Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.</p>
          example:
          - en
          - de
          items:
            type: string
            description: <p>2-letter ISO codes of the languages in which texts will be returned.</p><p>English ('en') and German ('de') are typically supported by default. Other languages may be supported.</p><p>Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.</p>
            example: '["en","de"]'
        declarationTypeCode:
          type: string
          description: 'Type of declarations to acknowledge. Possible values: EXPDECL, IMPDECL, TRANSDECL, ENSDECL and GOODSMOVERECORD'
        syncId:
          maxLength: 20
          type: string
          description: Synchronization ID for acknowledging. Use the value received with synchronization ID for delta-transmission of the changed declarations response with the last call to return all changed (modified) declarations, which were not yet acknowledged to acknowledge the processing of the declarations.
      description: Request parameter for IInternationalCustomsBF#acknowledgeGetChangedDeclarations
    ICDeliveryTransitEUDTO:
      type: object
      properties:
        producedDocuments:
          type: array
          description: List of transport documents, supporting documents and additional references
          items:
            $ref: '#/components/schemas/ICProducedDocumentEUDTO'
        previousDocuments:
          type: array
          description: List of previous documents
          items:
            $ref: '#/components/schemas/ICPreviousDocumentDTO'
        guarantees:
          type: array
          description: List of guarantees
          items:
            $ref: '#/components/schemas/ICGuaranteeDTO'
      description: Holds delivery data that is specific to the EU NCTS / transit processes.
    ICDeliveryGMRCHDTO:
      type: object
      properties:
        producedDocuments:
          type: array
          description: List of produced documents.
          items:
            $ref: '#/components/schemas/ICProducedDocumentEUDTO'
        additionalOperations:
          type: array
          description: List of additional operations.
          items:
            $ref: '#/components/schemas/ICAdditionalOperationCHDTO'
        otherRecipients:
          type: array
          description: List of other recipients identification numbers.
          items:
            type: string
            description: List of other recipients identification numbers.
        emptyJourney:
          type: boolean
          description: Indicates the goods movement is an empty journey.
        additionalInformation:
          type: string
          description: Additional information for the goods movement.
        direction:
          type: string
          description: Direction of movement. Valid values are ENTRY and EXIT.
        voyageId:
          maxLength: 79
          type: string
          description: Voyage ID for the goods movement.
        loadingUnitContainerType:
          maxLength: 35
          type: string
          description: Loading unit container type for the goods movement.
        loadingUnitType:
          maxLength: 35
          type: string
          description: Loading unit type for the goods movement.<ul><li>'CONTAINER' for container</li><li>'RAIL_CARRIAGE' for trains</li><li>'SEMI_TRAILER' for semi-trailer</li><li>'SWAP_BODY' for swap bodies</li><li>'TRUCK' for trucks</li><li>'UNIT_LOAD_DEVICE' for unit load devices</li><li>'VESSEL' for vessels</li></ul>
        loadingUnitId:
          maxLength: 35
          type: string
          description: Loading unit identification for the goods movement.
      description: CH specific extension data for a goods movement record.
    ICLicenseDataDTO:
      type: object
      properties:
        licenses:
          type: array
          description: License data.
          items:
            $ref: '#/components/schemas/ICLicenseDTO'
      description: DTO to hold a list of an licenses.
    ICDeliverySummaryDeclarationDEDTO:
      type: object
      properties:
        previousDocument:
          $ref: '#/components/schemas/ICPreviousDocumentDTO'
        arrivalDate:
          $ref: '#/components/schemas/DateAndZoneDTO'
        presentationDate:
          $ref: '#/components/schemas/DateAndZoneDTO'
        containerQuantity:
          type: integer
          description: Amount of containers
          format: int32
      description: DTO to hold Summary Declaration DE specific extension data for a ICDeliveryDTO.
    ICAttachmentDTO:
      type: object
      properties:
        attachmentCode:
          maxLength: 250
          type: string
          description: Code of the attachment.<br> When adding external attachments the attachmentCode must be filled a with filename.
        customsProcess:
          maxLength: 20
          type: string
          description: <p>Specific customs process. <ul><li>'EXPORT_BE' - Export process for Belgium</li> <li>'EXPORT_SE' - Export process for Sweden</li> <li>'EXPORT_NL' - Export process for Netherlands</li> <li>'TRANSIT_NL' - Transit process for Netherlands</li> <li>... for full list see /InternationalCustomsBFBean/getCodes with codeListCode=CUSTOMS_PROCESS_TYPE</li></ul></p>
          example: EXPORT_BE
        data:
          type: string
          description: Attachment data.
          format: byte
        statusCode:
          maxLength: 20
          type: string
          description: Attachment status.<br> Only used when attachments are returned by ICI.
        description:
          maxLength: 250
          type: string
          description: Description of the document.<br> Only used when attachments are returned by ICI.
        revisionCount:
          maxLength: 10
          type: integer
          description: Count of the documents revision.<br> Only used when attachments are returned by ICI.
          format: int32
        mediaType:
          maxLength: 255
          type: string
          description: Media Type of the attachment.
      description: DTO to hold attachment data.
    ICSetDeclarationAttachmentsStatusResponseDTO:
      type: object
      properties:
        hasErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>An error usually means that the request could not be performed.</p><p>Error details are provided in the messages[] array.</p>
          example: false
        hasOnlyRetryableErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        hasWarnings:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        messages:
          type: array
          description: <p>Error or warning messages at the request level.</p><p>There may be additional messages[] arrays at lower data levels as specified in the documentation.</p>
          items:
            $ref: '#/components/schemas/ResponseMessageDTO'
      description: The response DTO after setting an attachment status.
    ICAdditionDeductionDTO:
      type: object
      properties:
        adjustmentType:
          maxLength: 35
          type: string
          description: 'Specific adjustment type: <ul><li>BROKER_COMMISSIONS - Broker commissions</li><li>AIR_FREIGHT_COSTS - Air freight costs</li><li>TRANSPORT - Transport costs</li><li>INSURANCE - Insurance costs</li><li>''... for full list see /InternationalCustomsBFBean/getCodes with codeListCode=ADJUSTMENT_TYPE</li></ul>'
          example: BROKER_COMMISSIONS
        value:
          $ref: '#/components/schemas/AmountOfMoneyDTO'
        customsProcess:
          maxLength: 20
          type: string
          description: <p>Specific customs process. <ul><li>'EXPORT_BE' - Export process for Belgium</li><li>'EXPORT_SE' - Export process for Sweden</li><li>'EXPORT_NL' - Export process for Netherlands</li><li>'TRANSIT_NL' - Transit process for Netherlands</li><li>... for full list see /InternationalCustomsBFBean/getCodes with codeListCode=CUSTOMS_PROCESS_TYPE</li></ul></p>
          example: EXPORT_BE
      description: DTO to hold data for additions and deductions to a base value.
    ICGetConsignmentsOfManifestResponseDTO:
      type: object
      properties:
        hasErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>An error usually means that the request could not be performed.</p><p>Error details are provided in the messages[] array.</p>
          example: false
        hasOnlyRetryableErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        hasWarnings:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        messages:
          type: array
          description: <p>Error or warning messages at the request level.</p><p>There may be additional messages[] arrays at lower data levels as specified in the documentation.</p>
          items:
            $ref: '#/components/schemas/ResponseMessageDTO'
        consignmentInfos:
          type: array
          description: Ids of the consignments that are linked to the manifest requested.
          items:
            $ref: '#/components/schemas/ICConsignmentInfoDTO'
      description: Response containing consignments of a manifest
    ICDeliveryItemExportDEDTO:
      type: object
      properties:
        transactionNatureCode:
          maxLength: 2
          type: string
          description: Code specifying the nature of transaction.
        producedDocuments:
          type: array
          description: List of produced documents. The number of items per documentType must not exceed 99.
          items:
            $ref: '#/components/schemas/ICProducedDocumentEUDTO'
        previousDocuments:
          type: array
          description: List of previous documents
          items:
            $ref: '#/components/schemas/ICPreviousDocumentDTO'
        preferentialData:
          $ref: '#/components/schemas/ICPreferentialDataEUDTO'
        originCountryRegionCode:
          maxLength: 4
          type: string
          description: ISO code of country region where the goods of this item originate from.
        templateName:
          type: string
          description: Item template name in AES
        terminationCustomsWarehouse:
          $ref: '#/components/schemas/ICCustomsWarehouseTerminationDEDTO'
        additionalInfoForCustoms:
          maxLength: 512
          type: string
          description: Additional information  for customs
      description: DTO to hold Export DE specific extension data for a ICDeliveryItemDTO.
    ICDeliveryItemDTO:
      type: object
      properties:
        itemIdClientSystem:
          maxLength: 255
          type: string
          description: ID of the item in ERP system.
        itemNumber:
          maxLength: 20
          type: string
          description: No. of item
        material:
          $ref: '#/components/schemas/ICMaterialDTO'
        materialNumber:
          type: string
          description: 'DEPRECATED: Use ICDeliveryItemDTO.material instead. Typically for internal use and not needed for customs declaration.'
          deprecated: true
        invoiceIdClientSystem:
          maxLength: 255
          type: string
          description: References to the invoice for further processing
        grossMass:
          $ref: '#/components/schemas/QuantityDTO'
        netMass:
          $ref: '#/components/schemas/QuantityDTO'
        netPrice:
          $ref: '#/components/schemas/AmountOfMoneyDTO'
        originCountryCode:
          maxLength: 2
          type: string
          description: ISO code of country where the goods of this item originate from.
        preferentialOriginCountryCode:
          maxLength: 2
          type: string
          description: ISO code of the preferential origin country.
        dispatchCountryCode:
          maxLength: 2
          type: string
          description: ISO code of the country from which the goods are originally dispatched/exported without any commercial transaction taken place in intermediate countries.
        destinationCountryCode:
          maxLength: 2
          type: string
          description: ISO code of the country at which the goods are destined
        isEligiblePreference:
          type: boolean
          description: Indicates if the item is eligible for preference
        statisticalValue:
          $ref: '#/components/schemas/AmountOfMoneyDTO'
        additionalAggregationKey:
          maxLength: 100
          type: string
          description: Additional aggregation key considered during transmutation
        additionalSplitCriteria:
          maxLength: 100
          type: string
          description: Additional split criteria considered during transmutation
        extension:
          $ref: '#/components/schemas/ICDeliveryItemExtensionDataDTO'
        freeTemplateCriteria:
          type: array
          description: List of ICFreeTemplateCriterion, including a string for the criterion and the corresponding customs process.
          items:
            $ref: '#/components/schemas/ICFreeTemplateCriterionDTO'
        clientSpecificFields:
          $ref: '#/components/schemas/ClientSpecificFieldsDTO'
        classifications:
          type: array
          description: List of classifications (e.g. commodity codes)
          items:
            $ref: '#/components/schemas/ICClassificationDTO'
        goodsDescription:
          type: array
          description: Description of goods in different languages (if available)
          items:
            $ref: '#/components/schemas/TextInLanguageDTO'
        parties:
          type: array
          description: List of parties, including their role within the consignment.
          items:
            $ref: '#/components/schemas/ICPartyDTO'
        costs:
          type: array
          description: A list of costs like freight cost, insurance or additonal cost for the delivery item
          items:
            $ref: '#/components/schemas/ICCostDTO'
        adjustments:
          type: array
          description: A list of additions and deductions to a base value for the delivery item
          items:
            $ref: '#/components/schemas/ICAdditionDeductionDTO'
        quantities:
          type: array
          description: A list of quantities, like item quantity, statisticalquantity...
          items:
            $ref: '#/components/schemas/ICQuantityDTO'
        additionalReferences:
          type: array
          description: List of additional references which belong to the delivery.
          items:
            $ref: '#/components/schemas/ICAdditionalReferenceDTO'
        customsProcedures:
          type: array
          description: List of customs procedure codes.
          items:
            $ref: '#/components/schemas/ICCustomsProcedureDTO'
        locations:
          type: array
          description: List of locations, including their role within the consignment.
          items:
            $ref: '#/components/schemas/ICLocationDTO'
        freeTemplateCriterion:
          maxLength: 50
          type: string
          description: 'DEPRECATED: Use freeTemplateCriteria.value instead. Free textual criterion which can be referenced in template selectors.'
        tradeTerms:
          $ref: '#/components/schemas/ICTradeTermsDTO'
        returns:
          $ref: '#/components/schemas/ICReturnsHandlingDTO'
        customsSpecialProcedures:
          $ref: '#/components/schemas/ICCustomsSpecialProceduresDTO'
        licenseData:
          $ref: '#/components/schemas/ICLicenseDataDTO'
      description: DTO to hold data of a delivery item.
    ICPackageDTO:
      type: object
      properties:
        packageIdClientSystem:
          maxLength: 255
          type: string
          description: ID of the package in the ERP system.
        quantity:
          maxLength: 8
          type: integer
          description: Number of packages
          format: int32
        typeCode:
          maxLength: 40
          type: string
          description: Client specific package type.
        typeUneceCode:
          maxLength: 3
          type: string
          description: Common valid UN/ECE package type.
        grossMass:
          $ref: '#/components/schemas/QuantityDTO'
        netMass:
          $ref: '#/components/schemas/QuantityDTO'
        marks:
          maxLength: 70
          type: string
          description: Shipping marks - deprecated use marksAndNumbers instead
        marksAndNumbers:
          $ref: '#/components/schemas/TextInLanguageDTO'
        seals:
          type: array
          description: List of seals which belong to the transport equipment.
          items:
            $ref: '#/components/schemas/ICSealDTO'
        packedItems:
          type: array
          description: Information about the items which are packed into this package.
          items:
            $ref: '#/components/schemas/ICPackedItemDTO'
      description: DTO to hold data of a package.
    ICManifestDeliveryExtensionGVMSBG:
      type: object
      properties:
        isUnaccompanied:
          type: boolean
          description: 'Indicates that the vehicle will not be accompanying the trailer(s) during the crossing. '
        plannedCrossingRouteId:
          maxLength: 200
          type: string
          description: ID of the crossing route.
        plannedCrossingDepartureDate:
          $ref: '#/components/schemas/DateAndZoneDTO'
      description: GB specific extension data for a goods movement record.
    ICDeliveryItemSTIDTO:
      type: object
      properties:
        transactionNatureCode:
          maxLength: 2
          type: string
          description: Code specifying the nature of transaction.
        producedDocuments:
          type: array
          description: List of produced documents
          items:
            $ref: '#/components/schemas/ICProducedDocumentEUDTO'
        previousDocuments:
          type: array
          description: List of previous documents
          items:
            $ref: '#/components/schemas/ICPreviousDocumentDTO'
        preferentialData:
          $ref: '#/components/schemas/ICPreferentialDataEUDTO'
        originCountryRegionCode:
          maxLength: 4
          type: string
          description: ISO code of country region where the goods of this item originate from.
        postalValue:
          $ref: '#/components/schemas/AmountOfMoneyDTO'
      description: DTO to hold STI specific extension data for a ICDeliveryItemDTO.
    ICCustomsIdentifcationDTO:
      type: object
      properties:
        identificationType:
          maxLength: 35
          type: string
          description: 'Specific identification type: <ul> <li>EORI - EORI number</li> <li>VAT - VAT number</li> <li>BRANCH - BRANCH number</li> <li>''... for full list see /InternationalCustomsBFBean/getCodes with codeListCode=CUSTOMS_IDENTIFICATION_TYPE</li> </ul>'
        identification:
          maxLength: 20
          type: string
          description: Customs id number.
      description: DTO to hold data for customs identification.
    ICDeliveryItemImportCHDTO:
      type: object
      description: DTO to hold CH specific extension data for a ICDeliveryItemDTO.
    ICWarehouseDTO:
      type: object
      properties:
        identification:
          maxLength: 35
          type: string
          description: Warehouse Identification.
        typeCode:
          maxLength: 1
          type: string
          description: Warehouse type.
        country:
          maxLength: 2
          type: string
          description: ' ISO code of the country at which warehouse is located.'
      description: DTO to hold data of customs warehouse.
    ICDeliveryItemExtensionDataDTO:
      type: object
      properties:
        exportAT:
          $ref: '#/components/schemas/ICDeliveryItemEUDTO'
        exportBE:
          $ref: '#/components/schemas/ICDeliveryItemEUDTO'
        importBE:
          $ref: '#/components/schemas/ICDeliveryItemEUDTO'
        transitBE:
          $ref: '#/components/schemas/ICDeliveryItemTransitEUDTO'
        ensBE:
          $ref: '#/components/schemas/ICDeliveryItemEUDTO'
        exportDK:
          $ref: '#/components/schemas/ICDeliveryItemEUDTO'
        exportFR:
          $ref: '#/components/schemas/ICDeliveryItemEUDTO'
        ensFR:
          $ref: '#/components/schemas/ICDeliveryItemEUDTO'
        ensXI:
          $ref: '#/components/schemas/ICDeliveryItemEUDTO'
        ensGB:
          $ref: '#/components/schemas/ICDeliveryItemEUDTO'
        exportGB:
          $ref: '#/components/schemas/ICDeliveryItemEUDTO'
        importGB:
          $ref: '#/components/schemas/ICDeliveryItemEUDTO'
        transitGB:
          $ref: '#/components/schemas/ICDeliveryItemTransitEUDTO'
        exportNL:
          $ref: '#/components/schemas/ICDeliveryItemEUDTO'
        importNL:
          $ref: '#/components/schemas/ICDeliveryItemEUDTO'
        transitNL:
          $ref: '#/components/schemas/ICDeliveryItemTransitEUDTO'
        exportPL:
          $ref: '#/components/schemas/ICDeliveryItemEUDTO'
        exportSE:
          $ref: '#/components/schemas/ICDeliveryItemEUDTO'
        exportBroker:
          $ref: '#/components/schemas/ICDeliveryItemBrokerDTO'
        importBroker:
          $ref: '#/components/schemas/ICDeliveryItemBrokerDTO'
        exportDE:
          $ref: '#/components/schemas/ICDeliveryItemExportDEDTO'
        importDE:
          $ref: '#/components/schemas/ICDeliveryItemImportDEDTO'
        transitDE:
          $ref: '#/components/schemas/ICDeliveryItemTransitEUDTO'
        exportUS:
          $ref: '#/components/schemas/ICDeliveryItemExportUSDTO'
        ensIE:
          $ref: '#/components/schemas/ICDeliveryItemEUDTO'
        exportCH:
          $ref: '#/components/schemas/ICDeliveryItemExportCHDTO'
        importCH:
          $ref: '#/components/schemas/ICDeliveryItemImportCHDTO'
        transitCH:
          $ref: '#/components/schemas/ICDeliveryItemTransitEUDTO'
        intrastatImportDE:
          $ref: '#/components/schemas/ICDeliveryItemIntrastatDEDTO'
        intrastatDispatchDE:
          $ref: '#/components/schemas/ICDeliveryItemIntrastatDEDTO'
        consumerShipmentXI:
          $ref: '#/components/schemas/ICDeliveryItemConsumerShipmentXIDTO'
        ensSTI:
          $ref: '#/components/schemas/ICDeliveryItemSTIDTO'
      description: DTO to hold delivery item extension data for customs processes. Extension data is only required in very rare cases. Not all customs processes are supported.
    ICFreeTemplateCriterionDTO:
      type: object
      properties:
        value:
          maxLength: 50
          type: string
          description: Free textual criterion which can be referenced in template selectors.
        customsProcess:
          maxLength: 20
          type: string
          description: <p>Specific customs process. <ul><li>'EXPORT_BE' - Export process for Belgium</li> <li>'EXPORT_SE' - Export process for Sweden</li> <li>'EXPORT_NL' - Export process for Netherlands</li> <li>'TRANSIT_NL' - Transit process for Netherlands</li> <li>... for full list see /InternationalCustomsBFBean/getCodes with codeListCode=CUSTOMS_PROCESS_TYPE</li></ul></p>
          example: EXPORT_BE
      description: DTO to hold data of a party.
    ICAdditionalDeliveryDataDTO:
      type: object
      properties:
        dispatchCountryCode:
          maxLength: 2
          type: string
          description: ISO code of the country from which the goods are originally dispatched/exported without any commercial transaction taken place in intermediate countries.
        destinationCountryCode:
          maxLength: 2
          type: string
          description: ISO code of the country at which the goods are destined.
        parties:
          type: array
          description: List of parties, including their role within the consignment.
          items:
            $ref: '#/components/schemas/ICPartyDTO'
        transportEquipments:
          type: array
          description: List of transport equipments (e.g. containers)
          items:
            $ref: '#/components/schemas/ICTransportEquipmentDTO'
        transportMeans:
          type: array
          description: List of transport means.
          items:
            $ref: '#/components/schemas/ICTransportMeansDTO'
        additionalReferences:
          type: array
          description: List of additional references.
          items:
            $ref: '#/components/schemas/ICAdditionalReferenceDTO'
        locations:
          type: array
          description: List of locations.
          items:
            $ref: '#/components/schemas/ICLocationDTO'
        customsOffices:
          type: array
          description: List of customs offices.
          items:
            $ref: '#/components/schemas/ICCustomsOfficeDTO'
        extension:
          $ref: '#/components/schemas/ICManifestDeliveryExtensionDataDTO'
      description: DTO to hold data of a delivery that augment the original delivery data.
    DateAndZoneDTO:
      type: object
      properties:
        dateInTimezone:
          type: string
          description: '<p>String representation of the date/time stamp in the format yyyy-MM-dd HH:mm:ss</p> <p>Length: 19</p>'
        timezone:
          type: string
          description: '<p>Time zone of the time stamp.</p> <p>Examples of valid time zones: "GMT+01:00" or "GMT-02:00".</p> <p>Maximum length: 50</p>'
      description: Date and timezone.
    ICDeliveryItemEUDTO:
      type: object
      properties:
        transactionNatureCode:
          maxLength: 2
          type: string
          description: Code specifying the nature of transaction.
        producedDocuments:
          type: array
          description: List of produced documents
          items:
            $ref: '#/components/schemas/ICProducedDocumentEUDTO'
        previousDocuments:
          type: array
          description: List of previous documents
          items:
            $ref: '#/components/schemas/ICPreviousDocumentDTO'
        preferentialData:
          $ref: '#/components/schemas/ICPreferentialDataEUDTO'
        originCountryRegionCode:
          maxLength: 4
          type: string
          description: ISO code of country region where the goods of this item originate from.
      description: DTO to hold EU specific extension data for a ICDeliveryItemDTO.
    ICCurrencyRateDTO:
      type: object
      properties:
        rate:
          type: number
          description: Rate value. <p> length=18, 6 </p>
        rateDate:
          $ref: '#/components/schemas/DateAndZoneDTO'
      description: DTO to hold data of currency rate.
    OutwardProcessingFieldDTO:
      type: object
      properties:
        authNumber:
          maxLength: 35
          type: string
          description: Outward processing authorisation number
        dateOfReImport:
          $ref: '#/components/schemas/DateAndZoneDTO'
        countriesOfReImport:
          type: array
          description: List of iso codes for countries of re-import
          items:
            type: string
            description: List of iso codes for countries of re-import
        products:
          type: array
          description: List of processed products
          items:
            $ref: '#/components/schemas/OutwardProcessingCommodityCodeFieldDTO'
        identities:
          type: array
          description: List of identification methods.
          items:
            $ref: '#/components/schemas/OutwardProcessingIdentificationMeansFieldDTO'
      description: Represents an outward processing field
    ICGetBrokerDeclarationsResponseDTO:
      type: object
      properties:
        hasErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>An error usually means that the request could not be performed.</p><p>Error details are provided in the messages[] array.</p>
          example: false
        hasOnlyRetryableErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        hasWarnings:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        messages:
          type: array
          description: <p>Error or warning messages at the request level.</p><p>There may be additional messages[] arrays at lower data levels as specified in the documentation.</p>
          items:
            $ref: '#/components/schemas/ResponseMessageDTO'
        instructions:
          type: array
          description: Data of the instructions which contain requested declarations.
          items:
            $ref: '#/components/schemas/ICBrokerInstructionDTO'
      description: Response containing requested declarations.
    ICAcknowledgeGetChangedDeclarationsResponseDTO:
      type: object
      properties:
        hasErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>An error usually means that the request could not be performed.</p><p>Error details are provided in the messages[] array.</p>
          example: false
        hasOnlyRetryableErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        hasWarnings:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        messages:
          type: array
          description: <p>Error or warning messages at the request level.</p><p>There may be additional messages[] arrays at lower data levels as specified in the documentation.</p>
          items:
            $ref: '#/components/schemas/ResponseMessageDTO'
      description: Response for IInternationalCustomsBF#acknowledgeGetChangedDeclarations
    ICCustomsControlMeasureDTO:
      type: object
      properties:
        type:
          maxLength: 35
          type: string
          description: <p>Type of control measures. <ul><li>'PHYSICAL_CONTROL' - Physical control</li> <li>'DOCUMENT_CONTROL' - Document control</li><li>For full list see /InternationalCustomsBFBean/getCodes with codeListCode=CUSTOMS_CONTROL_TYPE.</li></ul></p>
          example: PHYSICAL_CONTROL
        initiationDate:
          $ref: '#/components/schemas/DateAndZoneDTO'
        details:
          type: string
          description: Further details and/or information about control measures.
        isActive:
          type: boolean
          description: True, if the control measure is still active.
      description: DTO to hold information about control measures.
    ICGnssDTO:
      type: object
      properties:
        latitude:
          maxLength: 17
          type: string
          description: Latitude of the location in decimal degrees, using negative values for south.
        longitude:
          maxLength: 17
          type: string
          description: Longitude of the location in decimal degrees, using negative values for west.
      description: Global Navigation Satellite System data
    ICHouseConsignmentDTO:
      type: object
      properties:
        commercialReferenceNumber:
          type: string
          description: Internal identification of declaration.
        referencedItems:
          type: array
          description: Referenced item data.
          items:
            $ref: '#/components/schemas/ICReferencedItemDTO'
        parties:
          type: array
          description: List of involved parties.
          items:
            $ref: '#/components/schemas/ICPartyDTO'
        clientSpecificFields:
          $ref: '#/components/schemas/ClientSpecificFieldsDTO'
      description: Extension data for a house consignment.
    ICDeliveryItemTransitEUDTO:
      type: object
      properties:
        producedDocuments:
          type: array
          description: List of transport documents, supporting documents and additional references
          items:
            $ref: '#/components/schemas/ICProducedDocumentEUDTO'
        previousDocuments:
          type: array
          description: List of previous documents
          items:
            $ref: '#/components/schemas/ICPreviousDocumentDTO'
      description: Holds item data that is specific to the EU NCTS / transit processes.
    ICDeclarationItemCHDTO:
      type: object
      properties:
        customsSequenceNumber:
          maxLength: 5
          type: integer
          description: Customs sequence number of the item.
          format: int32
        selectionResultCode:
          maxLength: 1
          type: string
          description: Selection result.
        preliminaryDutyValuationRate:
          type: number
          description: Valuation rate. <p>length=7,2</p>
        dutyAssessmentCode:
          maxLength: 2
          type: string
          description: Assessment code for customs duty.
        isNetDuty:
          maxLength: 1
          type: string
          description: Net duty
        tareSupplement:
          type: number
          description: Tare supplement. <p>length=4,1</p>
        tareSupplementConfirmation:
          maxLength: 1
          type: string
          description: Confirmation code for tare supplement
        isEligiblePreference:
          maxLength: 1
          type: string
          description: Preferential flag.
        customsNetWeight:
          $ref: '#/components/schemas/QuantityDTO'
      description: CH specific extension data for a declaration item.
    ICQuantityDTO:
      type: object
      properties:
        quantityType:
          maxLength: 10
          type: string
          description: 'Specific quantity type: <ul> <li>ITEM - Item quantity</li> <li>CUSTOMS - Customs quantity</li> <li>EXCISE - Excise quantity</li> <li>STATISTICAL - Statistical quantity</li> <li>''... for full list see /InternationalCustomsBFBean/getCodes with codeListCode=QUANTITY_TYPE</li> </ul>'
        quantity:
          $ref: '#/components/schemas/QuantityDTO'
      description: DTO to hold data for quantity.
    ICGetChangedDeclarationsResponseDTO:
      type: object
      properties:
        hasErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>An error usually means that the request could not be performed.</p><p>Error details are provided in the messages[] array.</p>
          example: false
        hasOnlyRetryableErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        hasWarnings:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        messages:
          type: array
          description: <p>Error or warning messages at the request level.</p><p>There may be additional messages[] arrays at lower data levels as specified in the documentation.</p>
          items:
            $ref: '#/components/schemas/ResponseMessageDTO'
        declarations:
          type: array
          description: The next changed declarations.
          items:
            $ref: '#/components/schemas/ICDeclarationDTO'
        syncId:
          maxLength: 20
          type: string
          description: Synchronization ID for for acknowledging. Use this syncId in subsequent calls to IInternationalCustomsBF#acknowledgeGetChangedDeclarations to acknowledge the processing of the changed declarations. This syncId may be null if no declarations were found to synchronize.  In this case no call to IInternationalCustomsBF#acknowledgeGetChangedDeclarations is necessary.
        isComplete:
          type: boolean
          description: True, if the synchronization is complete and currently no further modified declarations are available. False if not. In this case, after acknowledging with IInternationalCustomsBF#acknowledgeGetChangedDeclarations, an immediate second call to  IInternationalCustomsBF#getChangedDeclarations would be sensible. Because a maximum of 10 declarations are returned with one call of IInternationalCustomsBF#getChangedDeclarations, the result may be incomplete.
      description: Response (result) for IInternationalCustomsBF#getChangedDeclarations.
    ICConsignmentDTO:
      required:
      - consignmentIdClientSystem
      - consignmentNumber
      type: object
      properties:
        consignmentIdClientSystem:
          maxLength: 255
          type: string
          description: Unique id of the consignment within the ERP system
        organizationUnitClientSystem:
          maxLength: 255
          type: string
          description: Additional criteria two separate different organisational units within one Engine's client.
        consignmentNumber:
          maxLength: 70
          type: string
          description: Reference number of the consignment.
        internalReference:
          maxLength: 255
          type: string
          description: Internal reference of the consignment.
        remark:
          maxLength: 1000
          type: string
          description: Optional textual remark
        profileCode:
          maxLength: 50
          type: string
          description: Ident code of the consignment profile which is configured in the Engine. The consignment profile manages mainly the transmutation.
        personInCharge:
          $ref: '#/components/schemas/ICPersonDTO'
        deliveries:
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/ICDeliveryDTO'
        costs:
          type: array
          description: A list of costs like freight cost, insurance or additonal cost for the consignment
          items:
            $ref: '#/components/schemas/ICCostDTO'
        adjustments:
          type: array
          description: A list of additions and deductions to a base value for the consignment
          items:
            $ref: '#/components/schemas/ICAdditionDeductionDTO'
        attachments:
          type: array
          description: List of attached documents.
          items:
            $ref: '#/components/schemas/ICAttachmentDTO'
        attachmentLinks:
          type: array
          description: List of corresponding links.
          items:
            $ref: '#/components/schemas/ICAttachmentLinkDTO'
      description: DTO to hold data of a consignment.
      xml:
        name: consignment
    ICCustomsSpecialProceduresDTO:
      type: object
      properties:
        referencesRemoval:
          type: array
          description: List of references to booking requests. Only relevant for removal bookings (outbound).
          items:
            $ref: '#/components/schemas/ICCustomsSpecialProceduresReferencesDTO'
        identitiesEntry:
          type: array
          description: 'List of identities (German: Nämlichkeiten) used for an inbound entry booking. Maximum length of an identity = 50.'
          items:
            type: string
            description: 'List of identities (German: Nämlichkeiten) used for an inbound entry booking. Maximum length of an identity = 50.'
      description: DTO to hold data for customs special procedures.
    OutwardProcessingCommodityCodeFieldDTO:
      type: object
      properties:
        commodityCode:
          maxLength: 8
          type: string
          description: Commodity code
        description:
          maxLength: 512
          type: string
          description: Description of the product
      description: Represents a commodity code field for outward processing
    ICDeliveryEUDTO:
      type: object
      properties:
        goodsLocation:
          $ref: '#/components/schemas/ICLocationDTO'
        expectedArrivalTime:
          $ref: '#/components/schemas/DateAndZoneDTO'
        expectedDepartureTime:
          $ref: '#/components/schemas/DateAndZoneDTO'
        deferredPayments:
          type: array
          description: Deferred payments.
          items:
            $ref: '#/components/schemas/ICDeferredPaymentDTO'
        departureAirportCode:
          pattern: ^[A-Z]{3}$
          type: string
          description: Code (IATA key) for the airport of departure
        producedDocuments:
          type: array
          description: List of produced documents
          items:
            $ref: '#/components/schemas/ICProducedDocumentEUDTO'
        previousDocuments:
          type: array
          description: List of previous documents
          items:
            $ref: '#/components/schemas/ICPreviousDocumentDTO'
      description: DTO to hold EU extension data for a ICDeliveryDTO.
    ICConsignmentManifestResultDTO:
      type: object
      properties:
        businessObjectId:
          maxLength: 20
          type: string
          description: The business object id of the manifest in the system.
        installationIdClientSystem:
          maxLength: 20
          type: string
          description: Id of the ERP system. Important so separate two different ERP systems within on Engine's client.
        decisiveDate:
          $ref: '#/components/schemas/DateAndZoneDTO'
        consManifestNumber:
          maxLength: 70
          type: string
          description: Reference number of the consignment.
      description: Data of the manifest created.
    ICGetConsignmentsOfManifestRequestDTO:
      type: object
      properties:
        clientSystemId:
          type: string
          description: '<p>Id of the sending client system.</p><p>e.g. Installation ID of the sending host or ERP system.</p><p>Maximum length: 20</p>'
          example: TEST_ID
        clientIdentCode:
          type: string
          description: '<p>Client identification code.</p><p>Maximum length: 10</p>'
          example: APITEST
        userName:
          type: string
          description: <p>User who initiated the request from the client system.</p><p>If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.</p><p>If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.</p><p>Actual authentication is handled separately via the request's headers, so no password is required in the request's data.</p>
          example: API_TEST
        resultLanguageIsoCodes:
          type: array
          description: <p>2-letter ISO codes of the languages in which texts will be returned.</p><p>English ('en') and German ('de') are typically supported by default. Other languages may be supported.</p><p>Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.</p>
          example:
          - en
          - de
          items:
            type: string
            description: <p>2-letter ISO codes of the languages in which texts will be returned.</p><p>English ('en') and German ('de') are typically supported by default. Other languages may be supported.</p><p>Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.</p>
            example: '["en","de"]'
        businessObjectId:
          maxLength: 50
          type: string
          description: The unique business object id of the desired consignment manifest. BusinessObjectId or consignmentIdClientSystem must be filled.
        consignmentIdClientSystem:
          maxLength: 255
          type: string
          description: The consignment manifest id of the ERP system of the client. BusinessObjectId or consignmentIdClientSystem must be filled.
      description: Body for requesting consignments of a manifest
    NamedGenericDataRecordDTO:
      type: object
      properties:
        name:
          type: string
          description: The name of this record, i.e. the role the record plays in the enclosing record.<br> When the same name is repeated in the context of the same parent record,  it is assumed that the parent defines this element as a repeatable (array) element.
        record:
          $ref: '#/components/schemas/GenericDataRecordDTO'
      description: A generic data record with a name.<br> Wrapper class to encapsulate subrecords with their name and with the ability to have explicit null records.
      example:
      - name: child
        record:
          fields: []
          subrecords: []
    AmountOfMoneyDTO:
      type: object
      properties:
        value:
          type: number
          description: The value of the amount of money. <p>length=15, scale=2</p>
        currencyIso:
          type: string
          description: The three letter ISO code of the currency of the amount of money. <p>length=3</p>
      description: An amount of money with a value and an currency ISO code.
    ICCreateConsignmentManifestRequestDTO:
      required:
      - manifest
      type: object
      properties:
        clientSystemId:
          type: string
          description: '<p>Id of the sending client system.</p><p>e.g. Installation ID of the sending host or ERP system.</p><p>Maximum length: 20</p>'
          example: TEST_ID
        clientIdentCode:
          type: string
          description: '<p>Client identification code.</p><p>Maximum length: 10</p>'
          example: APITEST
        userName:
          type: string
          description: <p>User who initiated the request from the client system.</p><p>If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.</p><p>If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.</p><p>Actual authentication is handled separately via the request's headers, so no password is required in the request's data.</p>
          example: API_TEST
        resultLanguageIsoCodes:
          type: array
          description: <p>2-letter ISO codes of the languages in which texts will be returned.</p><p>English ('en') and German ('de') are typically supported by default. Other languages may be supported.</p><p>Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.</p>
          example:
          - en
          - de
          items:
            type: string
            description: <p>2-letter ISO codes of the languages in which texts will be returned.</p><p>English ('en') and German ('de') are typically supported by default. Other languages may be supported.</p><p>Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.</p>
            example: '["en","de"]'
        manifest:
          $ref: '#/components/schemas/ICConsignmentManifestDTO'
      description: Body data for creating a consignment manifest.
    ICReturnsHandlingDTO:
      type: object
      properties:
        returnProcessItemId:
          maxLength: 50
          type: string
          description: Unique ID of the delivery item as an identification of the item through the whole return process.
        isReturn:
          type: boolean
          description: Indicates that the item is a return to an originally exported or imported good.
        refundEntity:
          maxLength: 50
          type: string
          description: ID of the refund entity, e.g. a (web) shop or retailer.
      description: DTO to hold data related to a returns process.
    ICBusinessObjectStatusDTO:
      type: object
      properties:
        statusCode:
          maxLength: 20
          type: string
          description: Status code. Use API call getCodes with codeListCode 'STATUS_TYPE' to discover all valid codes.
        progressCode:
          maxLength: 20
          type: string
          description: 'Progress code. Valid codes are: USER_ACTION, ERROR, WAITING, ACCEPTED and COMPLETE.'
        progressInformation:
          type: array
          description: Optional human readable information on the current progress e.g. what kind of user action is required. <p> length = 100 </p>
          items:
            $ref: '#/components/schemas/TextInLanguageDTO'
        variantCode:
          maxLength: 20
          type: string
          description: Variant code. Use API call getCodes with codeListCode 'DECLARATION_VARIANT_TYPE' to discover all valid codes.
      description: DTO to hold data of a status.
    ICSendDeclarationMessageRequestDTO:
      required:
      - customsProcessType
      type: object
      properties:
        clientSystemId:
          type: string
          description: '<p>Id of the sending client system.</p><p>e.g. Installation ID of the sending host or ERP system.</p><p>Maximum length: 20</p>'
          example: TEST_ID
        clientIdentCode:
          type: string
          description: '<p>Client identification code.</p><p>Maximum length: 10</p>'
          example: APITEST
        userName:
          type: string
          description: <p>User who initiated the request from the client system.</p><p>If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.</p><p>If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.</p><p>Actual authentication is handled separately via the request's headers, so no password is required in the request's data.</p>
          example: API_TEST
        resultLanguageIsoCodes:
          type: array
          description: <p>2-letter ISO codes of the languages in which texts will be returned.</p><p>English ('en') and German ('de') are typically supported by default. Other languages may be supported.</p><p>Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.</p>
          example:
          - en
          - de
          items:
            type: string
            description: <p>2-letter ISO codes of the languages in which texts will be returned.</p><p>English ('en') and German ('de') are typically supported by default. Other languages may be supported.</p><p>Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.</p>
            example: '["en","de"]'
        customsProcessType:
          $ref: '#/components/schemas/ICCustomsProcessTypeDTO'
        businessObjectIds:
          maxLength: 20
          type: array
          description: One or more unique business object ids of the desired declarations. Either the businessObjectIds or the consignmentIdClientSystem must be filled.
          items:
            maxLength: 20
            type: string
            description: One or more unique business object ids of the desired declarations. Either the businessObjectIds or the consignmentIdClientSystem must be filled.
        consignmentIdClientSystem:
          maxLength: 255
          type: string
          description: The consignment id of the ERP system of the client. Either the businessObjectId or the consignmentIdClientSystem must be filled.
        updateDecisiveDate:
          type: boolean
          description: If set to true, the decisive date of the declaration will be set to the current time before sending.
          example: true
      description: Body data containing references to declarations that shall be sent to customs.
    ICCodeDTO:
      type: object
      properties:
        code:
          maxLength: 50
          type: string
          description: The ident code value.
        descriptions:
          maxLength: 50
          type: array
          description: List of Human readable description of the code in the requested languages.
          items:
            $ref: '#/components/schemas/TextInLanguageDTO'
      description: The DTO object containing information of a code and its descriptions in given languages.
    ICCustomsWarehouseItemReferenceDEDTO:
      type: object
      properties:
        entryInATLAS:
          type: boolean
          description: Indicates that the referenced account was registered in the ATLAS IT procedure.
        customsRegistrationNumber:
          maxLength: 22
          type: string
          description: Customs registration number (ATLAS registration number or MRN) of access to customs warehouse source process to which the item of the termination refers.
        itemNumber:
          maxLength: 5
          type: integer
          description: Number of the item of the entry to the customs warehouse source procedure, to which the item of the termination refers.
          format: int32
        usualTreatment:
          type: boolean
          description: Indicates that the goods were subjected to usual treatment.
        additionalInformation:
          maxLength: 100
          type: string
          description: Additional information from the owner of the customs warehouse process on an item of the termination (e.g., on a usual treatment that was applied).
        commodityCode:
          maxLength: 11
          minLength: 11
          type: string
          description: Commodity code (11 digits) according to the german electronic customs tariff (EZT).
        removalQuantity:
          $ref: '#/components/schemas/QuantityDTO'
        removalQuantityAfterTreatment:
          $ref: '#/components/schemas/QuantityDTO'
      description: DTO to hold specific item reference data for a customs warehouse termination.
    ICDeliveryItemExportCHDTO:
      type: object
      properties:
        producedDocuments:
          type: array
          description: List of produced documents
          items:
            $ref: '#/components/schemas/ICProducedDocumentEUDTO'
        previousDocuments:
          type: array
          description: List of previous documents
          items:
            $ref: '#/components/schemas/ICPreviousDocumentDTO'
      description: DTO to hold CH specific extension data for a ICDeliveryItemDTO.
    ICAttachmentLinkDTO:
      type: object
      properties:
        name:
          maxLength: 50
          type: string
          description: The displayed name of the link.
        url:
          maxLength: 1000
          type: string
          description: URL
      description: DTO to hold link data.
    ICCustomsWarehouseTerminationDEDTO:
      type: object
      properties:
        authorisationNumber:
          maxLength: 35
          type: string
          description: Authorization number of the customs warehouse. Slashes allowed, will be removed automatically.
        items:
          type: array
          description: List of termination items
          items:
            $ref: '#/components/schemas/ICCustomsWarehouseItemReferenceDEDTO'
      description: Customs warehouse termination
    ICCustomsOfficeDTO:
      type: object
      properties:
        officeType:
          maxLength: 35
          type: string
          description: 'Specific office type: <ul> <li>ENTRY - Entry office</li> <li>EXIT - Exit office</li> <li>EXPORT - Export office</li> <li>TRANSIT - Transit office</li> <li>''... for full list see /InternationalCustomsBFBean/getCodes with codeListCode=CUSTOMS_OFFICE_TYPE</li> </ul>'
        sequenceNumber:
          maxLength: 2
          type: integer
          description: Sequence number of the customs office within the itinerary.
          format: int32
        officeCode:
          maxLength: 30
          type: string
          description: Code of the customs office.
      description: DTO to hold data for a customs office.
    ICAdditionalReferenceDTO:
      type: object
      properties:
        referenceType:
          maxLength: 20
          type: string
          description: 'Specific type of the reference: <ul> <li>PORT_BOOKING_NUMBER - Booking reference of a port notification</li> <li>EXPORT_REG_NUMBER - Registration number of a export declaration</li> <li>IMPORT_REG_NUMBER - Registration number of a import declaration</li> <li>TRANSIT_REG_NUMBER - Registration number of a transit declaration</li> <li>EMCS_ARC_NUMBER - Administrative reference code .</li> <li>''... for full list see /InternationalCustomsBFBean/getCodes with codeListCode=REFERENCE_TYPE </li>  </ul>'
        reference:
          maxLength: 50
          type: string
          description: The reference number.
        issueDate:
          $ref: '#/components/schemas/DateAndZoneDTO'
        itemNumber:
          type: integer
          description: Item number of the referenced declaration or business object.
          format: int32
        quantity:
          $ref: '#/components/schemas/QuantityDTO'
      description: DTO to hold data of a additional reference.
    ICCostDTO:
      type: object
      properties:
        costType:
          maxLength: 35
          type: string
          description: 'Specific cost type: <ul> <li>TRANSPORT - Transport costs</li> <li>INSURANCE - Insurance costs</li>> <li>ADDITIONAL - Additional costs</li> <li>''... for full list see /InternationalCustomsBFBean/getCodes with codeListCode=COST_TYPE</li> </ul>'
          example: TRANSPORT
        costTypeQualifier:
          maxLength: 35
          type: string
          description: 'Optional qualifier for cost type: <ul> <li>AIR_FREIGHT - Air freight costs</li> <li>INDIRECT_PAYMENT - Indirect payments</li> <li>''... for full list see /InternationalCustomsBFBean/getCodes with codeListCode=COST_TYPE_QUALIFIER</li> </ul>'
          example: INDIRECT_PAYMENT
        value:
          $ref: '#/components/schemas/AmountOfMoneyDTO'
        customsProcess:
          maxLength: 20
          type: string
          description: <p>Specific customs process. <ul><li>'EXPORT_BE' - Export process for Belgium</li> <li>'EXPORT_SE' - Export process for Sweden</li> <li>'EXPORT_NL' - Export process for Netherlands</li> <li>'TRANSIT_NL' - Transit process for Netherlands</li> <li>... for full list see /InternationalCustomsBFBean/getCodes with codeListCode=CUSTOMS_PROCESS_TYPE</li></ul></p>
          example: EXPORT_BE
      description: DTO to hold data for costs.
    ICGetChangedDeclarationsRequestDTO:
      type: object
      properties:
        clientSystemId:
          type: string
          description: '<p>Id of the sending client system.</p><p>e.g. Installation ID of the sending host or ERP system.</p><p>Maximum length: 20</p>'
          example: TEST_ID
        clientIdentCode:
          type: string
          description: '<p>Client identification code.</p><p>Maximum length: 10</p>'
          example: APITEST
        userName:
          type: string
          description: <p>User who initiated the request from the client system.</p><p>If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.</p><p>If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.</p><p>Actual authentication is handled separately via the request's headers, so no password is required in the request's data.</p>
          example: API_TEST
        resultLanguageIsoCodes:
          type: array
          description: <p>2-letter ISO codes of the languages in which texts will be returned.</p><p>English ('en') and German ('de') are typically supported by default. Other languages may be supported.</p><p>Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.</p>
          example:
          - en
          - de
          items:
            type: string
            description: <p>2-letter ISO codes of the languages in which texts will be returned.</p><p>English ('en') and German ('de') are typically supported by default. Other languages may be supported.</p><p>Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.</p>
            example: '["en","de"]'
        declarationTypeCode:
          type: string
          description: 'Type of declarations to get. The client system must be configured as subscriber to the change of that declaration type in ICI to receive changes. If no subscription is present, the call will fail. Possible values: EXPDECL, IMPDECL, TRANSDECL, ENSDECL and GOODSMOVERECORD'
        scenarios:
          type: array
          description: 'Scenarios defining the data to be included. If no scenario is given, BASE is assumed. Possible values: BASE - Some basic data, ATTACHMENTS - Documents (e.g. EAD), HEAD - Basic values and data from head level, ITEM - basic values head level data and item level data'
          items:
            type: string
            description: 'Scenarios defining the data to be included. If no scenario is given, BASE is assumed. Possible values: BASE - Some basic data, ATTACHMENTS - Documents (e.g. EAD), HEAD - Basic values and data from head level, ITEM - basic values head level data and item level data'
      description: Request parameter for IInternationalCustomsBF#getChangedDeclarations
    ICTransportMeansDTO:
      type: object
      properties:
        meansType:
          maxLength: 35
          type: string
          description: 'Specific means type: <ul> <li>BORDER - Transport means at border</li> <li>ARRIVAL - Transport means at arrival</li> <li>DEPARTURE - Transport means at departure</li> <li>''... for full list see /InternationalCustomsBFBean/getCodes with codeListCode=TRANSPORT_MEANS_TYPE</li> </ul>'
        transportModeCode:
          maxLength: 2
          type: string
          description: Mode of transport.
        transportMeansCode:
          maxLength: 2
          type: string
          description: Type of transport means
        identification:
          maxLength: 27
          type: string
          description: 'Identifier to identify the means of transport. Sea: ITU Standard or Lloyd''s number; Air: IATA aircraft ID; Road: national license plate; Rail: locomotive number'
        nationalityCode:
          maxLength: 2
          type: string
          description: ISO code of the nationality of the means of transport.
        customsOffice:
          $ref: '#/components/schemas/ICCustomsOfficeDTO'
      description: DTO to hold data for transport means.
    GenericDataRecordDTO:
      type: object
      properties:
        fields:
          type: array
          description: The fields of the record.
          items:
            $ref: '#/components/schemas/GenericDataFieldDTO'
        subrecords:
          type: array
          description: Subrecords of the record.
          example:
          - name: child
            record:
              fields: []
              subrecords: []
          items:
            $ref: '#/components/schemas/NamedGenericDataRecordDTO'
      description: A generic record of data.<br>Each field is qualified by name and type and has a value.
    ICAdditionalOperationCHDTO:
      type: object
      properties:
        referenceNumber:
          maxLength: 35
          type: string
          description: Reference number of the additional operation.
        additionalOperationType:
          maxLength: 2
          type: string
          description: Specific additional operation type.<ul><li>'10' for Carnet ATA</li><li>'20' for Carnet TIR</li><li>'30' for T2 corridor</li><li>'40' for AC corridor</li><li>'50' for Informal postponement</li><li>'60' for Shuttle service</li><li>'70' for Form-based procedures</li><li>'90' for Emergency procedures / others</li></ul>
        goodsDescription:
          maxLength: 512
          type: string
          description: Goods description of the additional operation.
        grossMass:
          $ref: '#/components/schemas/QuantityDTO'
        customsTariffNumber:
          maxLength: 9
          type: string
          description: Customs tariff number of the additonal operation.
        numberOfPackages:
          type: integer
          description: Number of packages of the additional operation.
          format: int32
      description: DTO to hold data for EU produced documents.
    ICManifestDeliveryExtensionICS:
      type: object
      properties:
        expectedArrivalTime:
          $ref: '#/components/schemas/DateAndZoneDTO'
      description: DTO to hold extension data for import control processes.
    ICGetCodesResponseDTO:
      type: object
      properties:
        hasErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>An error usually means that the request could not be performed.</p><p>Error details are provided in the messages[] array.</p>
          example: false
        hasOnlyRetryableErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        hasWarnings:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        messages:
          type: array
          description: <p>Error or warning messages at the request level.</p><p>There may be additional messages[] arrays at lower data levels as specified in the documentation.</p>
          items:
            $ref: '#/components/schemas/ResponseMessageDTO'
        codes:
          type: array
          description: List of possible codes.
          items:
            $ref: '#/components/schemas/ICCodeDTO'
      description: Response for the requested code list.
    ICDeliveryItemConsumerShipmentXIDTO:
      type: object
      properties:
        producedDocuments:
          type: array
          description: List of produced documents
          items:
            $ref: '#/components/schemas/ICProducedDocumentEUDTO'
      description: GB specific extension data for Consumer shipments XI.
    ICReferencedItemDTO:
      type: object
      properties:
        sequenceNumberDeclarationItem:
          type: integer
          description: The sequence number of the referenced item.
          format: int32
        sequenceNumberHouseConsignment:
          type: integer
          description: The sequence number within the house consignment.
          format: int32
      description: Referenced item data for a house consignment.
    ICAdditionalFiscalReferenceDTO:
      type: object
      properties:
        roleCode:
          maxLength: 3
          type: string
          description: Fiscal reference role code
        identifier:
          maxLength: 17
          type: string
          description: Fiscal reference identifier
      description: Data for additional fiscal references
    ICTransitDeclarationDTO:
      type: object
      properties:
        houseConsignments:
          type: array
          description: House consignments.
          items:
            $ref: '#/components/schemas/ICHouseConsignmentDTO'
      description: Extension data for a transit.
    ICAmountOfMoneyDTO:
      type: object
      properties:
        amountCode:
          maxLength: 50
          type: string
          description: 'Specific amount type: <ul> <li>CUSTOMS_VALUE - Customs value</li> <li>STATISTICAL_VALUE - Statistical value</li> <li>VAT_VALUE - VAT value</li> <li>''... for full list see /InternationalCustomsBFBean/getCodes with codeListCode=AMOUNT_OF_MONEY_TYPE or AMOUNT_OF_MONEY_TYPE_ITEM</li> </ul>'
        amount:
          $ref: '#/components/schemas/AmountOfMoneyDTO'
      description: DTO to hold data representing an amount.
    ICDeclarationItemSpecialProceduresDTO:
      type: object
      properties:
        references:
          type: array
          description: List of references to booking requests.
          items:
            $ref: '#/components/schemas/ICCustomsSpecialProceduresReferencesDTO'
      description: DTO to hold a declaration item's data for customs special procedures.
    ResponseMessageDTO:
      type: object
      properties:
        messageType:
          type: string
          description: '<p>Message type</p><p>If not stated otherwise, the possible types are:</p><ul><li>ERROR</li><li>WARNING</li><li>INFO</li></ul><p>Maximum length: 50</p>'
          example: WARNING
        messageIdentCode:
          type: string
          description: '<p>Optional identification code for further classification of the message type.</p><p>Maximum length: 50</p>'
          example: '5627'
        messageTexts:
          type: array
          description: <p>Detailed message texts in the requested languages.</p>
          items:
            $ref: '#/components/schemas/TextInLanguageDTO'
        indentationLevel:
          type: integer
          description: <p>The indentation level of the message.</p><p>'0' indicates a top level message.</p>
          format: int32
          example: 0
      description: Result messages like errors or warnings.
    ICPreferentialDataEUDTO:
      type: object
      properties:
        preferenceType:
          maxLength: 3
          type: string
          description: Preferential request code.
      description: DTO to hold data for preferential request (EU).
    ClientSpecificFieldsDTO:
      type: object
      properties:
        fields:
          type: array
          description: List of client specific fields (key/value pairs).<p>Fields need to be defined for the respective process/declaration, otherwise they will be ignored.</p>
          items:
            $ref: '#/components/schemas/ClientSpecificFieldDTO'
      description: Represents the container for client specific fields.
    ICCustomsBrokerDeclarationDTO:
      type: object
      properties:
        customsRegistrationNumber:
          maxLength: 35
          type: string
          description: ' Customs registration numbers (CRN/MRN).'
      description: DTO to hold data for customs broker declaration
    ICConsignmentResultDTO:
      type: object
      properties:
        businessObjectId:
          maxLength: 20
          type: string
          description: The business object id of the consignment in the system.
        installationIdClientSystem:
          maxLength: 20
          type: string
          description: Id of the ERP system. Important so separate two different ERP systems within on Engine's client.
        decisiveDate:
          $ref: '#/components/schemas/DateAndZoneDTO'
        consignmentNumber:
          maxLength: 70
          type: string
          description: Reference number of the consignment.
        deliveryNumber:
          maxLength: 70
          type: string
          description: Reference number of the delivery.
      description: The result DTO which contains the information to the consignment created on the system.
    ICPersonDTO:
      type: object
      properties:
        forename:
          maxLength: 20
          type: string
          description: Forename of the person in charge
        surname:
          maxLength: 30
          type: string
          description: Surname of the person in charge
        email:
          maxLength: 255
          type: string
          description: Email address of the person in charge
        phone:
          maxLength: 20
          type: string
          description: Phone number of the person in charge
        supplement:
          maxLength: 10
          type: string
          description: Phone number of the person in charge
        initials:
          maxLength: 20
          type: string
          description: Initials/login of the person in charge
        professionalTitle:
          maxLength: 35
          type: string
          description: Professional title of the person in charge
      description: DTO to hold data of a person.
    ICDeliverySumDecWriteOffInfoDEDTO:
      type: object
      properties:
        assignmentCriteria:
          type: string
          description: The assignment criteria for the summary declaration items.
        numberOfPackages:
          type: integer
          description: Number of packages to be written off.
          format: int32
      description: DTO to hold the write off data for summary declaration assignment.
    ICCustomsProcessTypeDTO:
      type: object
      properties:
        customsProcess:
          maxLength: 35
          type: string
          description: <p>Specific customs process. <ul><li>'EXPORT_BE' - Export process for Belgium</li> <li>'EXPORT_SE' - Export process for Sweden</li> <li>'EXPORT_NL' - Export process for Netherlands</li> <li>'TRANSIT_NL' - Transit process for Netherlands</li> <li>For full list see /InternationalCustomsBFBean/getCodes with codeListCode=CUSTOMS_PROCESS_TYPE.</li></ul></p>
          example: EXPORT_BROKER
        countrySetupIdentCode:
          maxLength: 2
          type: string
          description: <p>Country setup ident code for the customs process (Broker).</p><p>Only used in response DTOs (ICDeclarationDTO) </p>
          example: CN
      description: DTO to hold the customs process type.
    ICDeliveryConsumerShipmentXIDTO:
      type: object
      properties:
        producedDocuments:
          type: array
          description: List of produced documents
          items:
            $ref: '#/components/schemas/ICProducedDocumentEUDTO'
        qualifiesForReturn:
          type: boolean
          description: Indicator of whether the delivery qualifies for returns
        deliveryPlace:
          $ref: '#/components/schemas/ICLocationDTO'
      description: GB specific extension data for Consumer shipments items XI.
    ICDateDTO:
      type: object
      properties:
        dateCode:
          maxLength: 20
          type: string
          description: Code specifying the type of date.
        date:
          $ref: '#/components/schemas/DateAndZoneDTO'
      description: DTO to hold data representing an date with optional time.
    ICDeliveryExportCHDTO:
      type: object
      properties:
        producedDocuments:
          type: array
          description: List of produced documents
          items:
            $ref: '#/components/schemas/ICProducedDocumentEUDTO'
        previousDocuments:
          type: array
          description: List of previous documents
          items:
            $ref: '#/components/schemas/ICPreviousDocumentDTO'
        isFirstShipment:
          type: boolean
          description: Indicates that this is the first partial shipment.
        firstShipmentReference:
          maxLength: 18
          type: string
          description: Reference to the first partial shipment.
      description: DTO to hold CH extension data for a ICDeliveryDTO.
    ICGetCodesRequestDTO:
      required:
      - codeListCode
      - customsProcessType
      type: object
      properties:
        clientSystemId:
          type: string
          description: '<p>Id of the sending client system.</p><p>e.g. Installation ID of the sending host or ERP system.</p><p>Maximum length: 20</p>'
          example: TEST_ID
        clientIdentCode:
          type: string
          description: '<p>Client identification code.</p><p>Maximum length: 10</p>'
          example: APITEST
        userName:
          type: string
          description: <p>User who initiated the request from the client system.</p><p>If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.</p><p>If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.</p><p>Actual authentication is handled separately via the request's headers, so no password is required in the request's data.</p>
          example: API_TEST
        resultLanguageIsoCodes:
          type: array
          description: <p>2-letter ISO codes of the languages in which texts will be returned.</p><p>English ('en') and German ('de') are typically supported by default. Other languages may be supported.</p><p>Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.</p>
          example:
          - en
          - de
          items:
            type: string
            description: <p>2-letter ISO codes of the languages in which texts will be returned.</p><p>English ('en') and German ('de') are typically supported by default. Other languages may be supported.</p><p>Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.</p>
            example: '["en","de"]'
        customsProcess:
          maxLength: 20
          type: string
          description: The identification of the customs process.
          deprecated: true
        customsProcessType:
          $ref: '#/components/schemas/ICCustomsProcessTypeDTO'
        codeListCode:
          maxLength: 50
          type: string
          description: Ident code of the code list which will be returned. To retrieve a possible list of inputs use {@code CODELISTS} as input.
          example: CODELISTS
      description: Request for a desired code list.
    ICDeliverySTIDTO:
      type: object
      properties:
        goodsLocation:
          $ref: '#/components/schemas/ICLocationDTO'
        expectedArrivalTime:
          $ref: '#/components/schemas/DateAndZoneDTO'
        expectedDepartureTime:
          $ref: '#/components/schemas/DateAndZoneDTO'
        deferredPayments:
          type: array
          description: Deferred payments.
          items:
            $ref: '#/components/schemas/ICDeferredPaymentDTO'
        departureAirportCode:
          pattern: ^[A-Z]{3}$
          type: string
          description: Code (IATA key) for the airport of departure
        producedDocuments:
          type: array
          description: List of produced documents
          items:
            $ref: '#/components/schemas/ICProducedDocumentEUDTO'
        previousDocuments:
          type: array
          description: List of previous documents
          items:
            $ref: '#/components/schemas/ICPreviousDocumentDTO'
        actualDepartureTime:
          $ref: '#/components/schemas/DateAndZoneDTO'
        postalCharges:
          $ref: '#/components/schemas/AmountOfMoneyDTO'
      description: DTO to hold STI specific extension data for a ICDeliveryDTO.
    ICConsignmentForManifestDTO:
      required:
      - consignmentIdClientSystem
      type: object
      properties:
        consignmentIdClientSystem:
          maxLength: 255
          type: string
          description: Unique id of the consignment within the ERP system
      description: Data to reference an existing consignment.
    ICPreviousDocumentDTO:
      type: object
      properties:
        type:
          maxLength: 6
          type: string
          description: Code specifying the type of a previous document.
        category:
          maxLength: 1
          type: string
          description: Code specifying the type of a previous document.
        reference:
          maxLength: 70
          type: string
          description: Free text field for a document reference.
        complementaryInfo:
          maxLength: 70
          type: string
          description: Additional free text field.
        typeOfPackages:
          maxLength: 2
          type: string
          description: Type of packages.
        numberOfPackages:
          maxLength: 8
          type: integer
          description: Number of packages.
          format: int32
        measurementUnitAndQualifier:
          maxLength: 4
          type: string
          description: Measurement unit and qualifier.
        quantity:
          type: number
          description: Measurement unit and qualifier. <p>length=22, scale=6</p>
        goodsItemIdentifier:
          maxLength: 5
          type: integer
          description: Goodsitem identifier.
          format: int32
      description: DTO to hold data for previous documents.
    ICGetDeclarationsRequestDTO:
      type: object
      properties:
        clientSystemId:
          type: string
          description: '<p>Id of the sending client system.</p><p>e.g. Installation ID of the sending host or ERP system.</p><p>Maximum length: 20</p>'
          example: TEST_ID
        clientIdentCode:
          type: string
          description: '<p>Client identification code.</p><p>Maximum length: 10</p>'
          example: APITEST
        userName:
          type: string
          description: <p>User who initiated the request from the client system.</p><p>If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.</p><p>If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.</p><p>Actual authentication is handled separately via the request's headers, so no password is required in the request's data.</p>
          example: API_TEST
        resultLanguageIsoCodes:
          type: array
          description: <p>2-letter ISO codes of the languages in which texts will be returned.</p><p>English ('en') and German ('de') are typically supported by default. Other languages may be supported.</p><p>Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.</p>
          example:
          - en
          - de
          items:
            type: string
            description: <p>2-letter ISO codes of the languages in which texts will be returned.</p><p>English ('en') and German ('de') are typically supported by default. Other languages may be supported.</p><p>Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.</p>
            example: '["en","de"]'
        declarationTypeCode:
          type: string
          description: Type of declaration.
          enum:
          - EXPDECL
          - EXTDECL
          - IMPDECL
          - TRANSDECL
          - ENSDECL
          - SUMDECL
          - GOODSMOVERECORD
          - TRANSARR
          - CONSSHIP
        customsProcess:
          $ref: '#/components/schemas/ICCustomsProcessTypeDTO'
        businessObjectIds:
          type: array
          description: IDs of the declarations. Either the businessObjectIds or the consignmentIdClientSystem must be filled. If the consignmentIdClientSystem is filled the businessObjectsIds will be ignored. <p> length=20 </p>
          items:
            type: string
            description: IDs of the declarations. Either the businessObjectIds or the consignmentIdClientSystem must be filled. If the consignmentIdClientSystem is filled the businessObjectsIds will be ignored. <p> length=20 </p>
        consignmentIdClientSystem:
          type: string
          description: ConsignmentID of the client system of the declarations. Either the businessObjectIds or the consignmentIdClientSystem must be filled. If the consignmentIdClientSystem is filled the businessObjectsIds will be ignored. <p> length=255 </p>
        scenarios:
          type: array
          description: 'Scenarios defining the data to be included. If no scenario is given, BASE is assumed.<br> The simultaneous use of ATTACHMENTS and ALL_ATTACHMENTS_META_DATA is not possible. <p> Possible values: <ul> <li>BASE - Some basic data</li> <li>ATTACHMENTS - Documents (e.g. EAD)</li> <li>ALL_ATTACHMENTS_META_DATA - Documents (e.g. EAD), with Meta Data only</li> <li>HEAD - Basic values and data from head level</li> <li>ITEM - basic values head level data and item level data</li> </ul>'
          items:
            type: string
            description: 'Scenarios defining the data to be included. If no scenario is given, BASE is assumed.<br> The simultaneous use of ATTACHMENTS and ALL_ATTACHMENTS_META_DATA is not possible. <p> Possible values: <ul> <li>BASE - Some basic data</li> <li>ATTACHMENTS - Documents (e.g. EAD)</li> <li>ALL_ATTACHMENTS_META_DATA - Documents (e.g. EAD), with Meta Data only</li> <li>HEAD - Basic values and data from head level</li> <li>ITEM - basic values head level data and item level data</li> </ul>'
      description: Request for declaration data.
    ICCancelDeclarationResponseDTO:
      type: object
      properties:
        hasErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>An error usually means that the request could not be performed.</p><p>Error details are provided in the messages[] array.</p>
          example: false
        hasOnlyRetryableErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        hasWarnings:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        messages:
          type: array
          description: <p>Error or warning messages at the request level.</p><p>There may be additional messages[] arrays at lower data levels as specified in the documentation.</p>
          items:
            $ref: '#/components/schemas/ResponseMessageDTO'
        isSuccessful:
          type: boolean
          description: Identifier if the cancellation was successful or not.
      description: The response dto for cancellation of declarations.
    ICBrokerDeclarationDTO:
      type: object
      properties:
        declarationTypeCode:
          type: string
          description: Type of declaration.
          enum:
          - EXPORT
          - IMPORT
          - TRANSIT_DEPARTURE
          - ENSDECL
        localReference:
          maxLength: 35
          type: string
          description: Local unique reference number.
        customsRegistrationNumber:
          maxLength: 35
          type: string
          description: Registration number given by customs (e.g. MRN, CRN, ...)
        statusCode:
          type: string
          description: Current status code of the declaration.
        totalGrossMass:
          $ref: '#/components/schemas/QuantityDTO'
        totalNumberItems:
          type: integer
          description: Total number of items in the declaration.
          format: int32
        totalNumberPackages:
          type: integer
          description: Total number of packages in the declaration.
          format: int32
        additionalReferences:
          type: array
          description: Additional references of the customs declaration.
          items:
            $ref: '#/components/schemas/ICAdditionalReferenceDTO'
        declarationAmounts:
          type: array
          description: Amounts of the customs declaration.
          items:
            $ref: '#/components/schemas/ICAmountOfMoneyDTO'
        attachments:
          type: array
          description: List of attachments.<br/> Only contains attachments for which the attachment content is present in ICI (attachment contents will be deleted some time after archiving an attachment).
          items:
            $ref: '#/components/schemas/ICAttachmentDTO'
        controlMeasures:
          type: array
          description: List of information about control measures.
          items:
            $ref: '#/components/schemas/ICCustomsControlMeasureDTO'
      description: DTO to hold data for customs broker declaration
    ICDeliveryItemImportDEDTO:
      type: object
      properties:
        transactionNatureCode:
          maxLength: 2
          type: string
          description: Code specifying the nature of transaction.
        producedDocuments:
          type: array
          description: List of produced documents
          items:
            $ref: '#/components/schemas/ICProducedDocumentEUDTO'
        previousDocuments:
          type: array
          description: List of previous documents
          items:
            $ref: '#/components/schemas/ICPreviousDocumentDTO'
        preferentialData:
          $ref: '#/components/schemas/ICPreferentialDataEUDTO'
        originCountryRegionCode:
          maxLength: 4
          type: string
          description: ISO code of country region where the goods of this item originate from.
        articlePrice:
          $ref: '#/components/schemas/AmountOfMoneyDTO'
        invoicePrice:
          $ref: '#/components/schemas/AmountOfMoneyDTO'
        tobaccoRevenueStampNumber:
          type: string
          description: Tobacco revenue stamp number
        departureAirport:
          pattern: ^[A-Z]{3}$
          type: string
          description: Code (IATA key) for the airport of departure
        proportionateAirFreightInEU:
          $ref: '#/components/schemas/AmountOfMoneyDTO'
        proportionateAirFreightOutEU:
          $ref: '#/components/schemas/AmountOfMoneyDTO'
        additionalInfoForCustoms:
          maxLength: 512
          type: string
          description: 'Additional information  for customs - In case of normal declarations items this will be cut at 100 characters '
      description: DTO to hold Import DE specific extension data for a ICDeliveryItemDTO.
    GenericDataFieldDTO:
      type: object
      properties:
        name:
          type: string
          description: <p>Name of this field, i.e. the role the field plays in the enclosing record.</p>  <p>When the same name is repeated in the context of the same parent record,  it is assumed that the parent defines this element as a repeatable (array) element.</p>
        value:
          type: string
          description: <p>Value of the field.</p>  <p>The format follows the conventions of xml schema encoding, see <a href="http://www.w3.org/TR/xmlschema-2/">http://www.w3.org/TR/xmlschema-2/</a>.</p> <h3>Currently implemented formats:</h3>  <ul>  <li>string - the plain string</li> <li>int - digits base10, +-2^31</li> <li>long - digits base10, +-2^63</li> <li>decimal - +-123456.789</li> <li>boolean - the literals 'true' and 'false'</li> <li>dateTime - yyyy-MM-ddTHH:mm:ss</li> <li>base64Binary - binary data in base64 encoding</li> </ul>
        type:
          type: string
          description: <p>Data type of the field.</p> <p>This is not strictly necessary since the receiving entity should be able to infer the structure  with its own meta data; it may be used however for sanity checks.</p> <p>The format follows the conventions of xml schema encoding, see <a href=\"http://www.w3.org/TR/xmlschema-2/\">http://www.w3.org/TR/xmlschema-2/</a>.</p> <h3>Currently implemented formats:</h3>  <ul>  <li>string</li> <li>int</li> <li>long</li> <li>decimal</li> <li>boolean</li> <li>dateTime</li> <li>base64Binary</li> </ul>
      description: A field of a generic data record.
    ICConsignmentManifestDTO:
      required:
      - consManifestIdClientSystem
      - consManifestNumber
      type: object
      properties:
        consManifestIdClientSystem:
          maxLength: 255
          type: string
          description: Unique id of the consignment manifest within the ERP system
        organizationUnitClientSystem:
          maxLength: 255
          type: string
          description: Additional criteria two separate different organisational units within one Engine's client.
        consManifestNumber:
          maxLength: 70
          type: string
          description: Reference number of the consignment.
        internalReference:
          maxLength: 70
          type: string
          description: Internal reference of the manifest.
        remark:
          maxLength: 1000
          type: string
          description: Optional textual remark
        profileCode:
          maxLength: 50
          type: string
          description: Ident code of the consignment profile which is configured in the Engine. The consignment profile manages mainly the transmutation.
        personInCharge:
          $ref: '#/components/schemas/ICPersonDTO'
        consignments:
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/ICConsignmentForManifestDTO'
        costs:
          type: array
          description: A list of costs like freight cost, insurance or additonal cost for the consignment manifest
          items:
            $ref: '#/components/schemas/ICCostDTO'
        additionalDeliveryData:
          $ref: '#/components/schemas/ICAdditionalDeliveryDataDTO'
      description: Structure of a consignment manifest. Additional data for - and references to existing consignments.
    ICDeliveryResultDTO:
      type: object
      properties:
        businessObjectId:
          maxLength: 20
          type: string
          description: The business object id of the delivery in the system.
        installationIdClientSystem:
          maxLength: 20
          type: string
          description: Id of the ERP system. Important so separate two different ERP systems within on Engine's client.
        decisiveDate:
          $ref: '#/components/schemas/DateAndZoneDTO'
        deliveryNumber:
          maxLength: 70
          type: string
          description: Reference number of the delivery.
      description: The result DTO which contains the information to the delivery created on the system.
    ICCreateDeliveryResponseDTO:
      type: object
      properties:
        hasErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>An error usually means that the request could not be performed.</p><p>Error details are provided in the messages[] array.</p>
          example: false
        hasOnlyRetryableErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        hasWarnings:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        messages:
          type: array
          description: <p>Error or warning messages at the request level.</p><p>There may be additional messages[] arrays at lower data levels as specified in the documentation.</p>
          items:
            $ref: '#/components/schemas/ResponseMessageDTO'
        delivery:
          $ref: '#/components/schemas/ICDeliveryResultDTO'
      description: The response DTO after processing the request. Contains the resulting delivery information.
    ICInvoiceDTO:
      type: object
      properties:
        invoiceIdClientSystem:
          maxLength: 255
          type: string
          description: Unique id of the invoice within the ERP system
        invoiceNumber:
          maxLength: 70
          type: string
          description: Reference number of the invoice.
        invoiceDate:
          $ref: '#/components/schemas/DateAndZoneDTO'
        invoicePrice:
          $ref: '#/components/schemas/AmountOfMoneyDTO'
        invoicePriceRate:
          $ref: '#/components/schemas/ICCurrencyRateDTO'
      description: DTO to hold data of an invoice.
    ICDeclarationDTO:
      type: object
      properties:
        clientSystemId:
          maxLength: 20
          type: string
          description: Id of the sending client system.
        customsProcessCode:
          maxLength: 20
          type: string
          description: Customs process the object belongs to.
          deprecated: true
        customsProcess:
          $ref: '#/components/schemas/ICCustomsProcessTypeDTO'
        businessObjectId:
          maxLength: 10
          type: string
          description: ID of the declaration.
        declarationTypeCode:
          type: string
          description: 'Type of declaration. <p> Possible values: <ul> <li>EXPDECL</li> <li>IMPDECL</li> <li>TRANSDECL</li> </ul> <p> Since FP Nov. 2017. </p>'
        declarationProcedureTypeCode:
          type: string
          description: Type of declaration procedure. <p> Possible values differ between the customs processes.</p>
        isDeleted:
          type: boolean
          description: Indicates whether the object has been logically deleted.
        decisiveDate:
          $ref: '#/components/schemas/DateAndZoneDTO'
        localReference:
          maxLength: 35
          type: string
          description: Local unique reference number.
        customsRegistrationNumber:
          maxLength: 35
          type: string
          description: Registration number given by customs (e.g. MRN, CRN, ...)
        linkedProcessInfos:
          type: array
          description: <p>Registration numbers of linked processes.<p><p>Currently only supported for port notifications created in Customs Management.</p>
          items:
            $ref: '#/components/schemas/ICLinkedProcessInfoDTO'
        declarationVersion:
          maxLength: 10
          type: string
          description: The current version of the declaration. Only filled if supported by customs.
        commercialReferenceNumber:
          maxLength: 35
          type: string
          description: Commercial reference number.
        deliveryNumber:
          maxLength: 70
          type: string
          description: Reference number of the delivery.
        deliveryReferences:
          type: array
          description: Reference numbers of the declaration's deliveries.
          items:
            $ref: '#/components/schemas/ICDeliveryReferencesDTO'
        invoiceNumber:
          maxLength: 70
          type: string
          description: Reference number of the invoice.
        organizationUnitClientSystem:
          maxLength: 255
          type: string
          description: Additional criteria two separate different organizational units within one client.
        consignmentUid:
          maxLength: 20
          type: string
          description: The business object UID of the consignment.
        consignmentNumber:
          maxLength: 70
          type: string
          description: Reference number of the consignment.
        internalReference:
          maxLength: 255
          type: string
          description: Internal reference of the declaration.
        consignmentIdClientSystem:
          maxLength: 255
          type: string
          description: Unique id of the consignment within the ERP system
        status:
          $ref: '#/components/schemas/ICBusinessObjectStatusDTO'
        isValid:
          type: boolean
          description: True, if the business object is (still) valid. Else false.
        personInCharge:
          $ref: '#/components/schemas/ICPersonDTO'
        totalGrossMass:
          $ref: '#/components/schemas/QuantityDTO'
        totalNetMass:
          $ref: '#/components/schemas/QuantityDTO'
        totalInvoicePrice:
          $ref: '#/components/schemas/AmountOfMoneyDTO'
        totalNumberItems:
          type: integer
          description: Total number of items in the declaration.
          format: int32
        totalNumberPackages:
          maxLength: 9
          type: integer
          description: Total number of packages in the declaration.
          format: int32
        dispatchCountryCode:
          maxLength: 2
          type: string
          description: Country ISO code of the dispatch country.
        destinationCountryCode:
          maxLength: 2
          type: string
          description: Country ISO code of the destination country.
        additionalReference1:
          type: string
          description: Additional reference.
        representationStatusCode:
          type: string
          description: Representation.
        extension:
          $ref: '#/components/schemas/ICDeclarationExtensionDataDTO'
        parties:
          type: array
          description: List of involved parties.
          items:
            $ref: '#/components/schemas/ICPartyDTO'
        customsOffices:
          type: array
          description: List of involved customs offices.
          items:
            $ref: '#/components/schemas/ICCustomsOfficeDTO'
        amountsOfMoney:
          type: array
          description: List of amount of moneys.
          items:
            $ref: '#/components/schemas/ICAmountOfMoneyDTO'
        transportMeans:
          type: array
          description: List of involved transport means.
          items:
            $ref: '#/components/schemas/ICTransportMeansDTO'
        dates:
          type: array
          description: List of dates with times.
          items:
            $ref: '#/components/schemas/ICDateDTO'
        items:
          type: array
          description: List of items.
          items:
            $ref: '#/components/schemas/ICDeclarationItemDTO'
        attachments:
          type: array
          description: List of attachments.<br/> Only contains attachments for which the attachment content is present in ICI (attachment contents will be deleted some time after archiving an attachment).
          items:
            $ref: '#/components/schemas/ICAttachmentDTO'
        controlMeasures:
          type: array
          description: List of information about control measures.
          items:
            $ref: '#/components/schemas/ICCustomsControlMeasureDTO'
        guarantees:
          type: array
          description: List of information about guarantees.
          items:
            $ref: '#/components/schemas/ICGuaranteeDTO'
        clientSpecificFields:
          $ref: '#/components/schemas/ClientSpecificFieldsDTO'
      description: DTO to hold data of a declaration.
    ICManifestDeliveryExtensionSTI:
      type: object
      properties:
        expectedArrivalTime:
          $ref: '#/components/schemas/DateAndZoneDTO'
        expectedDepartureTime:
          $ref: '#/components/schemas/DateAndZoneDTO'
        actualDepartureTime:
          $ref: '#/components/schemas/DateAndZoneDTO'
      description: DTO to hold extension data for import control processes 2 (STI).
    ICPackedItemDTO:
      type: object
      properties:
        itemIdClientSystem:
          maxLength: 255
          type: string
          description: ID of the item in ERP system.
        packedQuantity:
          type: number
          description: Quantity of the referenced item packed in the current package. The quantity unit is implied by the item's quantity unit. <p> length=11,3 </p>
      description: DTO to hold data of a packed item.
    ICLicenseDTO:
      type: object
      properties:
        customsProcessCountryCode:
          maxLength: 2
          type: string
          description: The country of the customs process for which the applies, e.g. "US", "GB" or "DE". The special value "EU" is used for licenses which may be used for declarations in all EU countries.
        licenseTypeCode:
          maxLength: 81
          type: string
          description: ' A code for the customs system for the license type. E.g., for EU and GB, this is the concatenation of code/qualifier of a produced document for the license type.'
        licenseNumber:
          maxLength: 100
          type: string
          description: The license number or the ID of a license exception (US) or a common license (EU).
        licenseItemNumber:
          maxLength: 100
          type: string
          description: The license item number.
        licenseValidFromDate:
          $ref: '#/components/schemas/DateAndZoneDTO'
        licenseExpirationDate:
          $ref: '#/components/schemas/DateAndZoneDTO'
        holder:
          $ref: '#/components/schemas/ICPartyDTO'
        decrementValue:
          $ref: '#/components/schemas/AmountOfMoneyDTO'
        decrementQuantity:
          $ref: '#/components/schemas/QuantityDTO'
        extension:
          $ref: '#/components/schemas/GenericDataRecordDTO'
      description: DTO to hold data of an license for a transaction.
    ICDeclarationCHDTO:
      type: object
      properties:
        orderNumber:
          type: string
          description: The internal order number, length=50
        selectionResultCode:
          maxLength: 1
          type: string
          description: Selection result.
        customsStatusCodeCode:
          maxLength: 3
          type: string
          description: Customs status code.
        releaseStatus:
          maxLength: 1
          type: string
          description: Release status.
        materialCheckStatus:
          maxLength: 1
          type: string
          description: Material check status.
        items:
          type: array
          description: Additional item data
          items:
            $ref: '#/components/schemas/ICDeclarationItemCHDTO'
      description: CH specific extension data for a declaration.
    ICGetDeclarationAttachmentsRequestDTO:
      type: object
      properties:
        clientSystemId:
          type: string
          description: '<p>Id of the sending client system.</p><p>e.g. Installation ID of the sending host or ERP system.</p><p>Maximum length: 20</p>'
          example: TEST_ID
        clientIdentCode:
          type: string
          description: '<p>Client identification code.</p><p>Maximum length: 10</p>'
          example: APITEST
        userName:
          type: string
          description: <p>User who initiated the request from the client system.</p><p>If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.</p><p>If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.</p><p>Actual authentication is handled separately via the request's headers, so no password is required in the request's data.</p>
          example: API_TEST
        resultLanguageIsoCodes:
          type: array
          description: <p>2-letter ISO codes of the languages in which texts will be returned.</p><p>English ('en') and German ('de') are typically supported by default. Other languages may be supported.</p><p>Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.</p>
          example:
          - en
          - de
          items:
            type: string
            description: <p>2-letter ISO codes of the languages in which texts will be returned.</p><p>English ('en') and German ('de') are typically supported by default. Other languages may be supported.</p><p>Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.</p>
            example: '["en","de"]'
        customsProcess:
          $ref: '#/components/schemas/ICCustomsProcessTypeDTO'
        businessObjectId:
          type: string
          description: ID of the declaration. <p> length=20 </p>
        attachmentCodes:
          type: array
          description: Attachment codes.
          items:
            type: string
            description: Attachment codes.
      description: Request for declaration attachments.
    ICDeclarationGBDTO:
      type: object
      properties:
        declarationMethodCode:
          maxLength: 3
          type: string
          description: Declaration method code.
        declarationUniqueConsignmentReference:
          maxLength: 35
          type: string
          description: DUCR.
        ducrPartNumber:
          maxLength: 4
          type: string
          description: DUCR part number.
        masterUniqueConsignmentReference:
          maxLength: 35
          type: string
          description: MUCR.
        acaReference:
          maxLength: 12
          type: string
          description: ACA reference of the cargo report.
        entryProcessingUnit:
          maxLength: 3
          type: string
          description: CHIEF Entry EPU.
        entryNumber:
          maxLength: 7
          type: string
          description: CHIEF Entry Number.
        entryDate:
          $ref: '#/components/schemas/DateAndZoneDTO'
        departedDate:
          $ref: '#/components/schemas/DateAndZoneDTO'
        deferredPayments:
          type: array
          description: Deferred payments.
          items:
            $ref: '#/components/schemas/ICDeferredPaymentDTO'
        additionalFiscalReferences:
          type: array
          description: Additonal fiscal references
          items:
            $ref: '#/components/schemas/ICAdditionalFiscalReferenceDTO'
      description: GB specific extension data for a declaration.
    ICTradeTermsDTO:
      type: object
      properties:
        incotermCode:
          maxLength: 3
          type: string
          description: Code specifying the delivery or transport terms. See EDIFACT codes.
        country:
          type: string
          description: ISO code of the country of the point or port of departure, shipment or destination, as required under the applicable terms of delivery, e.g. Incoterm.
        place:
          maxLength: 256
          type: string
          description: Name of the point or port of departure, shipment or destination, as required under the applicable terms of delivery, e.g. Incoterm.
        placeCode:
          maxLength: 256
          type: string
          description: UN/LOCODE of the point or port of departure, shipment or destination, as required under the applicable terms of delivery, e.g. Incoterm.
        info:
          maxLength: 100
          type: string
          description: Additional information e.g. for type 'XXX'.
      description: DTO to hold data of trade terms.
    ICBrokerInstructionDTO:
      type: object
      properties:
        clientSystemId:
          maxLength: 20
          type: string
          description: Id of the sending client system.
        localReference:
          maxLength: 35
          type: string
          description: Local unique reference number.
        commercialReferenceNumber:
          maxLength: 35
          type: string
          description: Commercial reference number.
        businessObjectId:
          maxLength: 10
          type: string
          description: ID of the declaration.
        consignmentIdClientSystem:
          maxLength: 255
          type: string
          description: Unique id of the consignment within the ERP system
        consignmentNumber:
          maxLength: 70
          type: string
          description: Reference number of the consignment.
        deliveryReferences:
          type: array
          description: Reference numbers of the declaration's deliveries.
          items:
            $ref: '#/components/schemas/ICDeliveryReferencesDTO'
        status:
          $ref: '#/components/schemas/ICBusinessObjectStatusDTO'
        numberOfDeclarations:
          maxLength: 3
          type: integer
          description: Expected number of declarations
          format: int32
        attachments:
          type: array
          description: List of attachments.<br/> Only contains attachments for which the attachment content is present in ICI (attachment contents will be deleted some time after archiving an attachment).
          items:
            $ref: '#/components/schemas/ICAttachmentDTO'
        brokerDeclarations:
          type: array
          description: List of broker declarations
          items:
            $ref: '#/components/schemas/ICBrokerDeclarationDTO'
      description: DTO to hold data for customs broker instruction
    ICCancelConsignmentResponseDTO:
      type: object
      properties:
        hasErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>An error usually means that the request could not be performed.</p><p>Error details are provided in the messages[] array.</p>
          example: false
        hasOnlyRetryableErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        hasWarnings:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        messages:
          type: array
          description: <p>Error or warning messages at the request level.</p><p>There may be additional messages[] arrays at lower data levels as specified in the documentation.</p>
          items:
            $ref: '#/components/schemas/ResponseMessageDTO'
        isSuccessful:
          type: boolean
          description: Identifier if the cancellation was successful or not.
      description: The response dto of the cancellation of consignments or consignment manifests.
    ICSendDeclarationMessageResponseDTO:
      type: object
      properties:
        hasErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>An error usually means that the request could not be performed.</p><p>Error details are provided in the messages[] array.</p>
          example: false
        hasOnlyRetryableErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        hasWarnings:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        messages:
          type: array
          description: <p>Error or warning messages at the request level.</p><p>There may be additional messages[] arrays at lower data levels as specified in the documentation.</p>
          items:
            $ref: '#/components/schemas/ResponseMessageDTO'
      description: Result data for the send-declaration-message operation.
    ICGetBrokerDeclarationsRequestDTO:
      type: object
      properties:
        clientSystemId:
          type: string
          description: '<p>Id of the sending client system.</p><p>e.g. Installation ID of the sending host or ERP system.</p><p>Maximum length: 20</p>'
          example: TEST_ID
        clientIdentCode:
          type: string
          description: '<p>Client identification code.</p><p>Maximum length: 10</p>'
          example: APITEST
        userName:
          type: string
          description: <p>User who initiated the request from the client system.</p><p>If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.</p><p>If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.</p><p>Actual authentication is handled separately via the request's headers, so no password is required in the request's data.</p>
          example: API_TEST
        resultLanguageIsoCodes:
          type: array
          description: <p>2-letter ISO codes of the languages in which texts will be returned.</p><p>English ('en') and German ('de') are typically supported by default. Other languages may be supported.</p><p>Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.</p>
          example:
          - en
          - de
          items:
            type: string
            description: <p>2-letter ISO codes of the languages in which texts will be returned.</p><p>English ('en') and German ('de') are typically supported by default. Other languages may be supported.</p><p>Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.</p>
            example: '["en","de"]'
        instructionTypeCode:
          type: string
          description: 'Type of instruction. Possible values: EXPINST (Export instruction), IMPINST (Import instruction)'
          enum:
          - EXPINST
          - IMPINST
        businessObjectIds:
          type: array
          description: IDs of the instructions. Either the businessObjectIds or the consignmentIdClientSystem must be filled. If the consignmentIdClientSystem is filled the businessObjectsIds will be ignored. <p> length=20 </p>
          items:
            type: string
            description: IDs of the instructions. Either the businessObjectIds or the consignmentIdClientSystem must be filled. If the consignmentIdClientSystem is filled the businessObjectsIds will be ignored. <p> length=20 </p>
        consignmentIdClientSystem:
          maxLength: 255
          type: string
          description: ConsignmentID of the client system of the instructions. Either the businessObjectIds or the consignmentIdClientSystem must be filled. If the consignmentIdClientSystem is filled the businessObjectsIds will be ignored.
        scenarios:
          type: array
          items:
            type: string
            description: 'Scenarios defining the data to be included. If no scenario is given, BASE is assumed. Possible values: BASE (Some basic data), ATTACHMENTS (Documents, e.g. EAD)'
            enum:
            - BASE
            - ATTACHMENTS
      description: Request for broker declaration data.
    ICProducedDocumentBrokerDTO:
      type: object
      properties:
        typeCode:
          maxLength: 9
          type: string
          description: Code specifying the name of a document. Qualifier has to be separated with a "/".
        reference:
          maxLength: 35
          type: string
          description: Free text field for a document reference.
        informationDate:
          $ref: '#/components/schemas/DateAndZoneDTO'
        expiryDate:
          $ref: '#/components/schemas/DateAndZoneDTO'
        quantity:
          $ref: '#/components/schemas/QuantityDTO'
        amount:
          $ref: '#/components/schemas/AmountOfMoneyDTO'
        complementaryInfo:
          maxLength: 35
          type: string
          description: Additional free text field.
        statusCode:
          maxLength: 2
          type: string
          description: Code specifying the status of a document.
        detail:
          maxLength: 12
          type: string
          description: Provides detailed information on the document.
        issuingAuthorityName:
          maxLength: 70
          type: string
          description: Issuing authority name.
        documentLineItemNumber:
          maxLength: 5
          type: integer
          description: Document line item number.
          format: int32
      description: DTO to hold data for produced documents.
    ICManifestDeliveryExtensionDataDTO:
      type: object
      properties:
        ensXI:
          $ref: '#/components/schemas/ICManifestDeliveryExtensionICS'
        ensBE:
          $ref: '#/components/schemas/ICManifestDeliveryExtensionICS'
        ensFR:
          $ref: '#/components/schemas/ICManifestDeliveryExtensionICS'
        ensIE:
          $ref: '#/components/schemas/ICManifestDeliveryExtensionICS'
        ensGB:
          $ref: '#/components/schemas/ICManifestDeliveryExtensionICS'
        gvmsGB:
          $ref: '#/components/schemas/ICManifestDeliveryExtensionGVMSBG'
        ensSTI:
          $ref: '#/components/schemas/ICManifestDeliveryExtensionSTI'
      description: DTO to hold additional delivery extension data for customs processes. Extension data is only required in very rare cases. Not all customs processes are supported.
    ICDeliveryItemIntrastatDEDTO:
      type: object
      properties:
        transactionNatureCode:
          maxLength: 2
          type: string
          description: Nature of transaction
        invoicePrice:
          $ref: '#/components/schemas/AmountOfMoneyDTO'
        destinationCountryRegionCode:
          maxLength: 2
          type: string
          description: Destination region
        goodsMovementDate:
          $ref: '#/components/schemas/DateAndZoneDTO'
        originCountryRegionCode:
          maxLength: 2
          type: string
          description: Code specifying the origin region.
      description: DTO to hold Intrastat DE specific extension data for a ICDeliveryItemDTO.
    ICDeliveryImportDEDTO:
      type: object
      properties:
        producedDocuments:
          type: array
          description: List of produced documents
          items:
            $ref: '#/components/schemas/ICProducedDocumentEUDTO'
        sumDecWriteOffInfo:
          type: array
          description: List of write off data for summary declaration assignment
          items:
            $ref: '#/components/schemas/ICDeliverySumDecWriteOffInfoDEDTO'
        destinationCountryRegionCode:
          maxLength: 2
          type: string
          description: Country region code of destination (ATLAS code list A1270)
        departureAirport:
          pattern: ^[A-Z]{3}$
          type: string
          description: Code (IATA key) for the airport of departure
        proportionateAirFreightInEU:
          $ref: '#/components/schemas/AmountOfMoneyDTO'
        proportionateAirFreightOutEU:
          $ref: '#/components/schemas/AmountOfMoneyDTO'
        discount:
          $ref: '#/components/schemas/AmountOfMoneyDTO'
        discountPercent:
          type: number
          description: Discount in percent (cost distribution)
        cashDiscount:
          $ref: '#/components/schemas/AmountOfMoneyDTO'
        cashDiscountPercent:
          type: number
          description: Cash discount in percent (cost distribution)
        promilleInsurance:
          type: number
          description: Permill rate of the insurance premium for the transport insurance in relation to the invoice value (cost distribution)
        additionalInfoForCustoms:
          maxLength: 2000
          type: string
          description: Additional information for customs- In case of IMPOST this will be cut at 512 characters
      description: DTO to hold Import DE specific extension data for a ICDeliveryDTO.
    ICDeliveryReferencesDTO:
      type: object
      properties:
        deliveryIdClientSystem:
          maxLength: 255
          type: string
          description: Unique id of the delivery within the ERP system
        deliveryNumber:
          maxLength: 70
          type: string
          description: Reference number of the delivery.
      description: 'DTO to hold data of a delivery that has been transitioned into the declaration. '
    ICAddDeclarationAttachmentsRequestDTO:
      type: object
      properties:
        clientSystemId:
          type: string
          description: '<p>Id of the sending client system.</p><p>e.g. Installation ID of the sending host or ERP system.</p><p>Maximum length: 20</p>'
          example: TEST_ID
        clientIdentCode:
          type: string
          description: '<p>Client identification code.</p><p>Maximum length: 10</p>'
          example: APITEST
        userName:
          type: string
          description: <p>User who initiated the request from the client system.</p><p>If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.</p><p>If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.</p><p>Actual authentication is handled separately via the request's headers, so no password is required in the request's data.</p>
          example: API_TEST
        resultLanguageIsoCodes:
          type: array
          description: <p>2-letter ISO codes of the languages in which texts will be returned.</p><p>English ('en') and German ('de') are typically supported by default. Other languages may be supported.</p><p>Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.</p>
          example:
          - en
          - de
          items:
            type: string
            description: <p>2-letter ISO codes of the languages in which texts will be returned.</p><p>English ('en') and German ('de') are typically supported by default. Other languages may be supported.</p><p>Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.</p>
            example: '["en","de"]'
        businessObjectIds:
          maxLength: 20
          type: array
          description: One or more unique business object ids of the desired declarations. Either the businessObjectIds or the consignmentIdClientSystem must be filled.
          items:
            maxLength: 20
            type: string
            description: One or more unique business object ids of the desired declarations. Either the businessObjectIds or the consignmentIdClientSystem must be filled.
        consignmentIdClientSystem:
          maxLength: 255
          type: string
          description: The consignment id of the ERP system of the client. Either the businessObjectId or the consignmentIdClientSystem must be filled.
        mode:
          type: string
          description: 'Manages how the system should react if an attachment already exists. If empty ADD will be used.<p> Possible values: <ul> <li> ADD</li> <li> UPDATE</li> <li> SKIP</li> </ul> </p>'
        attachments:
          type: array
          description: List of attachments to add.
          items:
            $ref: '#/components/schemas/ICAttachmentDTO'
      description: Body data for adding one or more attachments to a declaration.
    TextInLanguageDTO:
      type: object
      properties:
        languageISOCode:
          type: string
          description: <p>2-letter ISO code of the language.</p><p>length=2</p>
          example: en
        text:
          type: string
          description: The translated text.
          example: Some free-form text
      description: A translated text in one of the specified languages.
    ICProducedDocumentEUDTO:
      type: object
      properties:
        documentType:
          maxLength: 25
          type: string
          description: Specific document type.<ul><li>'SUPPORTING' for produced documents (called supporting documents in current UCC)</li><li>'TRANSPORT' for transport documents</li><li>'ADDITIONAL_REFERENCE' for additional reference documents</li></ul>see also /InternationalCustomsBFBean/getCodes with codeListCode=PRODUCED_DOCUMENT_TYPE<p>this field might be omitted<ul><li>for customs systems that do not differentiate the three types. I.e. that have not yet implemented the current UCC. Transitions into customs processes that do not differentiate will ignore the type if filled.</li><li>if the document type is not known to the host system. In this case the transition into a customs process that differentiates the types will try to determine the document type based on the master data in the system.</li></ul>
          example: SUPPORTING
        typeCode:
          maxLength: 9
          type: string
          description: Code specifying the name of a document. Qualifier has to be separated with a "/".
        reference:
          maxLength: 70
          type: string
          description: Free text field for a document reference.
        informationDate:
          $ref: '#/components/schemas/DateAndZoneDTO'
        expiryDate:
          $ref: '#/components/schemas/DateAndZoneDTO'
        quantity:
          $ref: '#/components/schemas/QuantityDTO'
        amount:
          $ref: '#/components/schemas/AmountOfMoneyDTO'
        complementaryInfo:
          maxLength: 35
          type: string
          description: Additional free text field.
        statusCode:
          maxLength: 2
          type: string
          description: Code specifying the status of a document.
        documentPart:
          maxLength: 5
          type: string
          description: Identifies a part of a document (e.g. a licence line).
        detail:
          maxLength: 12
          type: string
          description: Provides detailed information on the document.
        atHand:
          type: boolean
          description: 'Provides detailed information on the document. '
        procedureSpecificDocumentCode:
          maxLength: 12
          type: string
          description: Different coding for the document required for reporting to customs.
        issuingAuthorityName:
          maxLength: 70
          type: string
          description: Issuing authority name.
        documentLineItemNumber:
          maxLength: 5
          type: integer
          description: Document line item number.
          format: int32
      description: DTO to hold data for EU produced documents.
    ICDeliveryItemExportUSDTO:
      type: object
      properties:
        licenseQualifier:
          maxLength: 1
          type: string
          description: Code specifying the license qualificator.
        licenseType:
          maxLength: 3
          type: string
          description: Code specifying the license type.
        licenseNumber:
          maxLength: 35
          type: string
          description: String representing the license number.
        licenseSymbol:
          maxLength: 2
          type: string
          description: Code specifying the license symbol.
        ddtcRegistration:
          maxLength: 35
          type: string
          description: String representing the DDTC registration number.
        commCodeQualifier:
          maxLength: 2
          type: string
          description: Code specifying the commodity code qualificator.
      description: DTO to hold US specific extension data for a ICDeliveryItemDTO.
    ICConsignmentInfoDTO:
      type: object
      properties:
        businessObjectId:
          type: string
          description: Unique business object id of the consignment.
        consignmentIdClientSystem:
          maxLength: 255
          type: string
          description: Original Id of the consignment issued by the ERP system
      description: Information about an existing consignment.
    ICSetDeclarationAttachmentsStatusRequestDTO:
      type: object
      properties:
        clientSystemId:
          type: string
          description: '<p>Id of the sending client system.</p><p>e.g. Installation ID of the sending host or ERP system.</p><p>Maximum length: 20</p>'
          example: TEST_ID
        clientIdentCode:
          type: string
          description: '<p>Client identification code.</p><p>Maximum length: 10</p>'
          example: APITEST
        userName:
          type: string
          description: <p>User who initiated the request from the client system.</p><p>If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.</p><p>If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.</p><p>Actual authentication is handled separately via the request's headers, so no password is required in the request's data.</p>
          example: API_TEST
        resultLanguageIsoCodes:
          type: array
          description: <p>2-letter ISO codes of the languages in which texts will be returned.</p><p>English ('en') and German ('de') are typically supported by default. Other languages may be supported.</p><p>Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.</p>
          example:
          - en
          - de
          items:
            type: string
            description: <p>2-letter ISO codes of the languages in which texts will be returned.</p><p>English ('en') and German ('de') are typically supported by default. Other languages may be supported.</p><p>Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.</p>
            example: '["en","de"]'
        customsProcess:
          $ref: '#/components/schemas/ICCustomsProcessTypeDTO'
        businessObjectIds:
          type: array
          description: One or more unique business object ids of the desired declarations. Either the businessObjectIds or the consignmentIdClientSystem must be filled. <p> length=20 </p>
          items:
            type: string
            description: One or more unique business object ids of the desired declarations. Either the businessObjectIds or the consignmentIdClientSystem must be filled. <p> length=20 </p>
        consignmentIdClientSystem:
          type: string
          description: The consignment id of the ERP system of the client. Either the businessObjectId or the consignmentIdClientSystem must be filled. <p> length=255 </p>
        attachmentCode:
          type: string
          description: Code of the attachment. <p> length=250 </p>
        statusCode:
          type: string
          description: 'The new status of the attachment. Supported values are: NEW, PRINTED. <p> length=20 </p>'
      description: The request DTO to set the status of an attachment.
    ICPartyDTO:
      type: object
      properties:
        partyType:
          maxLength: 40
          type: string
          description: Specific party type. <ul> <li>'DECLARANT' for Declarant of the declaration</li> <li>'EXPORTER' for Export of goods</li> <li>'AGENT' for Agent or representative</li> <li>'... for full list see /InternationalCustomsBFBean/getCodes with codeListCode=PARTY_TYPE </li> </ul>
          example: DECLARANT
        customsProcess:
          maxLength: 20
          type: string
          description: <p>Specific customs process. <ul><li>'EXPORT_BE' - Export process for Belgium</li> <li>'EXPORT_SE' - Export process for Sweden</li> <li>'EXPORT_NL' - Export process for Netherlands</li> <li>'TRANSIT_NL' - Transit process for Netherlands</li> <li>... for full list see /InternationalCustomsBFBean/getCodes with codeListCode=CUSTOMS_PROCESS_TYPE</li></ul></p>
          example: EXPORT_BE
        companyNumber:
          maxLength: 20
          type: string
          description: Internal ID which identifies a stored address. This could be an adress in the ICI master data entry or could be used in a partner system. Check special documentation about the use of this field in concrete contexts.
        name:
          maxLength: 120
          type: string
          description: Company name
        name2:
          maxLength: 120
          type: string
          description: Additional company name
        street:
          maxLength: 70
          type: string
          description: Street with number.
        street2:
          maxLength: 70
          type: string
          description: Additional street.
        city:
          maxLength: 35
          type: string
          description: City
        postCode:
          maxLength: 17
          type: string
          description: Postal code
        district:
          maxLength: 35
          type: string
          description: District within the city.
        country:
          maxLength: 2
          type: string
          description: Country Iso code
        countryRegionCode:
          maxLength: 5
          type: string
          description: Code of the region/state within the country.
        contact:
          $ref: '#/components/schemas/ICPersonDTO'
        initFromCompanyMasterFileData:
          type: boolean
          description: If true company data is taken from the company master data and overwrites the given DTO fields. A company is identified by the companyNumber. If not filled the field name is taken. For reasons of uniqueness it isrecommended to fill the field companyNumber.
        customsIds:
          type: array
          description: List of customs ids.
          items:
            $ref: '#/components/schemas/ICCustomsIdentifcationDTO'
      description: DTO to hold data of a party.
    ICLocationDTO:
      type: object
      properties:
        locationType:
          maxLength: 35
          type: string
          description: 'Specific location type: <ul> <li>LOADING_PLACE - Place of loading</li> <li>UNLOADING_PLACE - Place of unloading</li> <li>''... for full list see /InternationalCustomsBFBean/getCodes with codeListCode=LOCATION_TYPE</li> </ul>'
        code:
          maxLength: 35
          type: string
          description: Location code
        name:
          maxLength: 35
          type: string
          description: Location name
        street:
          type: string
          description: Street.  <p> length=70 </p> <p> For NL used as optional Address, length=22 </p>
        streetNumber:
          maxLength: 10
          type: string
          description: Street number
        city:
          maxLength: 35
          type: string
          description: City
        postCode:
          maxLength: 7
          type: string
          description: Postal code
        country:
          maxLength: 2
          type: string
          description: Country Iso code
        complement:
          maxLength: 4
          type: string
          description: Complementing data
        unLocode:
          maxLength: 17
          type: string
          description: UN/LOCODE
        type:
          maxLength: 1
          type: string
          description: Type of location, coded
        gnss:
          $ref: '#/components/schemas/ICGnssDTO'
        qualifierOfIdentification:
          maxLength: 1
          type: string
          description: Qualifier of identification
        authorisationNumber:
          maxLength: 35
          type: string
          description: Authorisation number
        contactPerson:
          $ref: '#/components/schemas/ICPersonDTO'
        customsProcess:
          maxLength: 20
          type: string
          description: <p>Specific customs process. <ul><li>'EXPORT_BE' - Export process for Belgium</li> <li>'EXPORT_SE' - Export process for Sweden</li> <li>'EXPORT_NL' - Export process for Netherlands</li> <li>'TRANSIT_NL' - Transit process for Netherlands</li> <li>... for full list see /InternationalCustomsBFBean/getCodes with codeListCode=CUSTOMS_PROCESS_TYPE</li></ul></p>
          example: EXPORT_BE
      description: DTO to hold data of a location.
    ICDeclarationBrokerDTO:
      type: object
      properties:
        customsBrokerDeclarations:
          type: array
          description: Customs broker declarations.
          items:
            $ref: '#/components/schemas/ICCustomsBrokerDeclarationDTO'
        numberOfValidDeclarations:
          type: integer
          description: Number of valid declarations
          format: int32
        numberOfCancelledDeclarations:
          type: integer
          description: Number of cancelled declarations
          format: int32
      description: Broker specific extension data for a declaration.
    ICDeclarationItemExtensionDataDTO:
      type: object
      properties:
        exportCH:
          $ref: '#/components/schemas/ICDeclarationItemCHDTO'
        importCH:
          $ref: '#/components/schemas/ICDeclarationItemCHDTO'
        transitArrivalBE:
          $ref: '#/components/schemas/ICDeclarationItemTransitArrivalDTO'
        transitArrivalCH:
          $ref: '#/components/schemas/ICDeclarationItemTransitArrivalDTO'
        transitArrivalGB:
          $ref: '#/components/schemas/ICDeclarationItemTransitArrivalDTO'
        transitArrivalNL:
          $ref: '#/components/schemas/ICDeclarationItemTransitArrivalDTO'
      description: DTO to hold declaration item extension data for customs processes. Not all customs processes are supported.
    ICDeliveryItemBrokerDTO:
      type: object
      properties:
        producedDocuments:
          type: array
          description: List of produced documents
          items:
            $ref: '#/components/schemas/ICProducedDocumentBrokerDTO'
        extraFields:
          type: array
          description: Extra fields for the delivery item.
          items:
            $ref: '#/components/schemas/ICExtraFieldDTO'
      description: DTO to hold Broker specific extension data for a ICDeliveryItemDTO}.
    ICCancelDeclarationRequestDTO:
      required:
      - businessObjectId
      - reason
      type: object
      properties:
        clientSystemId:
          type: string
          description: '<p>Id of the sending client system.</p><p>e.g. Installation ID of the sending host or ERP system.</p><p>Maximum length: 20</p>'
          example: TEST_ID
        clientIdentCode:
          type: string
          description: '<p>Client identification code.</p><p>Maximum length: 10</p>'
          example: APITEST
        userName:
          type: string
          description: <p>User who initiated the request from the client system.</p><p>If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.</p><p>If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.</p><p>Actual authentication is handled separately via the request's headers, so no password is required in the request's data.</p>
          example: API_TEST
        resultLanguageIsoCodes:
          type: array
          description: <p>2-letter ISO codes of the languages in which texts will be returned.</p><p>English ('en') and German ('de') are typically supported by default. Other languages may be supported.</p><p>Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.</p>
          example:
          - en
          - de
          items:
            type: string
            description: <p>2-letter ISO codes of the languages in which texts will be returned.</p><p>English ('en') and German ('de') are typically supported by default. Other languages may be supported.</p><p>Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.</p>
            example: '["en","de"]'
        businessObjectId:
          maxLength: 50
          type: string
          description: The unique business object id of the declaration which has to be cancelled.  This field is mandatory. <p> length=50 </p>
        reason:
          maxLength: 300
          type: string
          description: The reason for the cancellation. Must also be specified. <p> length=300 </p>
        reasonCode:
          maxLength: 3
          type: string
          description: The reason code for the cancellation. For list of possible reason codes see /InternationalCustomsBFBean/getCodes for CANCELLATION_REASON_CODE <br>This field is mandatory for Great Britain, Austria and Switzerland only. <p> max. length=3 </p>
        requestCancelAtCustoms:
          type: boolean
          description: ' Specifies that Customs Management may request a cancellation in the customs system with the given reason.Currently only supported by some customs processes.'
        customsProcess:
          $ref: '#/components/schemas/ICCustomsProcessTypeDTO'
      description: The request dto for the cancellation of declarations BF.
    ICDeliveryGVMSGBDTO:
      type: object
      properties:
        isUnaccompanied:
          type: boolean
          description: 'Indicates that the vehicle will not be accompanying the trailer(s) during the crossing. '
        plannedCrossingRouteId:
          maxLength: 200
          type: string
          description: ID of the crossing route.
        plannedCrossingDepartureDate:
          $ref: '#/components/schemas/DateAndZoneDTO'
      description: GB specific extension data for a goods movement record.
    ICCancelConsignmentRequestDTO:
      type: object
      properties:
        clientSystemId:
          type: string
          description: '<p>Id of the sending client system.</p><p>e.g. Installation ID of the sending host or ERP system.</p><p>Maximum length: 20</p>'
          example: TEST_ID
        clientIdentCode:
          type: string
          description: '<p>Client identification code.</p><p>Maximum length: 10</p>'
          example: APITEST
        userName:
          type: string
          description: <p>User who initiated the request from the client system.</p><p>If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.</p><p>If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.</p><p>Actual authentication is handled separately via the request's headers, so no password is required in the request's data.</p>
          example: API_TEST
        resultLanguageIsoCodes:
          type: array
          description: <p>2-letter ISO codes of the languages in which texts will be returned.</p><p>English ('en') and German ('de') are typically supported by default. Other languages may be supported.</p><p>Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.</p>
          example:
          - en
          - de
          items:
            type: string
            description: <p>2-letter ISO codes of the languages in which texts will be returned.</p><p>English ('en') and German ('de') are typically supported by default. Other languages may be supported.</p><p>Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.</p>
            example: '["en","de"]'
        businessObjectId:
          maxLength: 50
          type: string
          description: The unique business object id of the desired consignment or consignment manifest. BusinessObjectId or consignmentIdClientSystem must be filled.
        consignmentIdClientSystem:
          maxLength: 255
          type: string
          description: The consignment or consignment manifest id of the ERP system of the client. BusinessObjectId or consignmentIdClientSystem must be filled.
        reason:
          maxLength: 300
          type: string
          description: Mandatory field. The reason for the cancellation.
        reasonCode:
          maxLength: 3
          type: string
          description: The reason code for the cancellation. For list of possible reason codes see /InternationalCustomsBFBean/getCodes for CANCELLATION_REASON_CODE <br>This field is mandatory for Great Britain and Switzerland only. <p> max. length=3 </p>
        requestCancelAtCustoms:
          type: boolean
          description: Specifies that for declarations, linked to this consignment or consignment manifest, Customs Management may request a cancellation in the customs system with the given reason. Currently only supported by some customs processes.
      description: Body data for the cancellation of a consignment or consignment manifest.
    ICGetDeclarationAttachmentsResponseDTO:
      type: object
      properties:
        hasErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>An error usually means that the request could not be performed.</p><p>Error details are provided in the messages[] array.</p>
          example: false
        hasOnlyRetryableErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        hasWarnings:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        messages:
          type: array
          description: <p>Error or warning messages at the request level.</p><p>There may be additional messages[] arrays at lower data levels as specified in the documentation.</p>
          items:
            $ref: '#/components/schemas/ResponseMessageDTO'
        attachments:
          type: array
          description: Data of the requested attachments.
          items:
            $ref: '#/components/schemas/ICAttachmentDTO'
      description: Response containing requested attachments.
    ICDeclarationItemDTO:
      type: object
      properties:
        sequenceNumber:
          maxLength: 5
          type: integer
          description: Sequence number of the item.
          format: int32
        status:
          $ref: '#/components/schemas/ICBusinessObjectStatusDTO'
        grossMass:
          $ref: '#/components/schemas/QuantityDTO'
        netMass:
          $ref: '#/components/schemas/QuantityDTO'
        extension:
          $ref: '#/components/schemas/ICDeclarationItemExtensionDataDTO'
        clientSystemIds:
          type: array
          description: IDs of contained items from the sending client system.
          items:
            type: string
            description: IDs of contained items from the sending client system.
        goodsDescription:
          type: array
          description: Goods description in requested languages.
          items:
            $ref: '#/components/schemas/TextInLanguageDTO'
        classifications:
          type: array
          description: List of classifications.
          items:
            $ref: '#/components/schemas/ICClassificationDTO'
        quantities:
          type: array
          description: List of quantites.
          items:
            $ref: '#/components/schemas/ICQuantityDTO'
        amountsOfMoney:
          type: array
          description: List of amount of moneys.
          items:
            $ref: '#/components/schemas/ICAmountOfMoneyDTO'
        parties:
          type: array
          description: List of involved parties.
          items:
            $ref: '#/components/schemas/ICPartyDTO'
        customsProcedures:
          type: array
          description: List of customs procedure codes.
          items:
            $ref: '#/components/schemas/ICCustomsProcedureDTO'
        customsSpecialProcedures:
          $ref: '#/components/schemas/ICDeclarationItemSpecialProceduresDTO'
        clientSpecificFields:
          $ref: '#/components/schemas/ClientSpecificFieldsDTO'
      description: DTO to hold data of a declaration item.
    ICGuaranteeDTO:
      type: object
      properties:
        guaranteeType:
          maxLength: 1
          type: string
          description: Guarantee type
        otherGuaranteeReference:
          maxLength: 35
          type: string
          description: Reference for other type of guarantee
        guaranteeReferenceNumber:
          maxLength: 24
          type: string
          description: Guarantee reference number
        accessCode:
          maxLength: 4
          type: string
          description: Access code
        amountToBeCovered:
          $ref: '#/components/schemas/AmountOfMoneyDTO'
      description: DTO to hold data of a guarantee.
    ICDeliveryImportCHDTO:
      type: object
      description: DTO to hold CH import extension data for a ICDeliveryDTO.
    ICClassificationDTO:
      type: object
      properties:
        classificationType:
          maxLength: 35
          type: string
          description: 'Specific classification type: <ul> <li>COCOEXPORT - Commodity code export</li> <li>COCOIMPORT - Commodity code import</li> <li>UNDG - UNDG number</li> <li>ADDCODE1 - Additional code 1 of the commodity code</li> <li>ADDCODE2 - Additional code 2 of the commodity code</li> <li>''... for full list see /InternationalCustomsBFBean/getCodes with codeListCode=COMMODITY_CLASSIFICATION_TYPE</li> </ul>'
        classificationValue:
          maxLength: 35
          type: string
          description: E.g. the commodity code, depends on the type above.
        customsProcess:
          maxLength: 20
          type: string
          description: <p>Specific customs process. <ul><li>'EXPORT_BE' - Export process for Belgium</li> <li>'EXPORT_SE' - Export process for Sweden</li> <li>'EXPORT_NL' - Export process for Netherlands</li> <li>'TRANSIT_NL' - Transit process for Netherlands</li> <li>... for full list see /InternationalCustomsBFBean/getCodes with codeListCode=CUSTOMS_PROCESS_TYPE</li></ul></p>
          example: EXPORT_BE
      description: DTO to hold data for classification.
    QuantityDTO:
      type: object
      properties:
        value:
          multipleOf: 0.001
          maximum: 999999999999.999
          type: number
          description: The value of the quantity.
        unit:
          maxLength: 10
          type: string
          description: " \t\t\tIdentifier of the quantity unit. Use quantity units known from your AEB application or alternatively domain specific or legacy quantity codes, but not the UNECE code.\n \t\t\tFor UNECE unit codes use the 'uneceUnit' field, if supported.\n\n \t\t\tWeight unit codes:\n \t\t\t* kg - Kilogram\n         \t* gr - Gram\n         \t* t - Metric ton\n         \t* lb - Pound\n         \t* oz - Ounce\n\n         \tLength unit codes:\n         \t* m - Meter\n         \t* mm - Milimeter\n         \t* cm - Centimeter\n         \t* dm - Decimeter\n         \t* km - Kilometer\n         \t* ft - Foot\n         \t* in - Inch\n         \t* mi - Mile\n         \t* nm - Nanometer\n         \t* µm - Micrometer\n\n         \tVolume unit codes:\n         \t* ccm - Cubic centimeter\n         \t* cdm - Cubic decimeter\n         \t* m3 - Cubic meter\n         \t* ml - Milliliter\n         \t* cl - Centiliter\n         \t* hl - Hectoliter\n         \t* l - Liter\n         \t* cuin - Cubic inch\n         \t* cuft - Cubic foot\n\n         \tQuantity unit codes:\n         \t* St - Piece\n         \t* Paar - Pair\n\n         \tDensity unit codes:\n         \t* g/ccm - grams per cubic centimeter\n         \t* kg/m3 - kilogram per cubic meter\n\n         \tTime unit codes:\n         \t* h - Hour\n         \t* stu - Hour\n         \t* std - Hour\n         \t* oph - Operational hour\n         \t* s - Second\n         \t* min - Minute\n         \t* 15m - 15 mins\n         \t* d - Day\n         \t* tag - Day\n         \t* wch - Week\n         \t* mon - Month\n         \t* jhr - Year\n         \t* mis - Millisecond\n         \t* ms - Microsecond\n         \t* ns - Nanosecond\n         \t* ps - Picosecond\n\n         \tArea unit codes:\n \t\t\t* qm - Square meter\n         \t* qmm - Square millimeter\n         \t* qcm - Square centimeter\n         \t* qdm - Square decimeter\n"
          example: kg
        uneceUnit:
          maxLength: 3
          type: string
          description: " \t\t\tIdentifier of the quantity unit based on 'Recommendation No. 20 - Units of Measure used in International Trade'.<br/>\n \t\t\tThe #uneceUnit can be specified alternatively to #unit but is currently not supported by all AEB services. Please speak to your contact person at AEB if you are unsure whether #uneceUnit is supported or not.\n\n \t\t\tWeight unit codes:\n \t\t\t* `KGM` - Kilogram\n \t\t\t* `GRM` - Gram (10⁻³ kg)\n \t\t\t* `TNE` - Metric ton (10³ kg)\n \t\t\t* `LBR` - Pound (0,453 592 37 kg)\n \t\t\t* `ONZ` - Ounce (2,834 952 x 10⁻² kg)\n\n \t\t\tLength unit codes:\n \t\t\t* `MTR` - Meter\n \t\t\t* `CMT` - Centimeter (10⁻² m)\n \t\t\t* `MMT` - Millimeter (10⁻³ m)\n \t\t\t* `KMT` - Kilometer (10³ m)\n \t\t\t* `YRD` - Yard (0,914 4 m)\n \t\t\t* `FOT` - Foot (0,304 8 m)\n \t\t\t* `INH` - Inch (25,4 x 10⁻³ m)\n \t\t\t* `SMI` - Mile (statute mile) (1609,344 m)\n\n \t\t\tVolume unit codes:\n \t\t\t* `MTQ` - Cubic meter\n \t\t\t* `CMQ` - Cubic centimeter (10⁻⁶ m³)\n \t\t\t* `HLT` - Hectoliter (10⁻¹ m³)\n \t\t\t* `LTR` - Liter (10⁻³ m³)\n \t\t\t* `MLT` - Milliliter (10⁻⁶ m³)\n \t\t\t* `YDQ` - Cubic yard (0,764 555 m³)\n \t\t\t* `FTQ` - Cubic foot (2,831 685 x 10⁻² m³)\n \t\t\t* `INQ` - Cubic inch (16,387 064 x 10⁻⁶ m³)\n\n \t\t\tArea unit codes:\n \t\t\t* `MTK` - Square meter\n \t\t\t* `CMK` - Square centimeter (10⁻⁴ m²)\n \t\t\t* `MMK` - Square millimeter (10⁻⁶ m²)\n \t\t\t* `YDK` - Square yard (8.361 274 x 10⁻¹ m² )\n \t\t\t* `FTK` - Square foot (9,290 304 x 10⁻² m²)\n \t\t\t* `INK` - Square inch (6,451 6 x 10⁻⁴ m²)\n\n \t\t\tQuantity unit codes:\n \t\t\t* `NAR` - Number of articles\n \t\t\t* `NPR` - Number of pairs\n \t\t\t* `CEN` - A unit of count defining the number of units in multiples of 100\n \t\t\t* `MIL` - A unit of count defining the number of units in multiples of 1000\n"
          example: NAR
      description: A quantity with a value and a quantity unit. Quantity units are encoded by using AEB unit codes mainly based on the International System of Unit (e.g. 'Gram' is encoded by the code 'gr') or - if supported - UNECE unit codes (e.g. 'Gram' is encoded by the code 'GRM').<br>Recoding of the quantity unit code from capital letters to small letters (e.g. from 'LB' to 'lb') may be supported, depending on the AEB product.<br>The quantity unit type is specified by the usage context, i.e. if this quantity is a weight, a volume or similar.
    ICDeliveryDTO:
      required:
      - deliveryIdClientSystem
      - deliveryNumber
      type: object
      properties:
        deliveryIdClientSystem:
          maxLength: 255
          type: string
          description: Unique id of the delivery within the ERP system
        organizationUnitClientSystem:
          maxLength: 255
          type: string
          description: Additional criteria two separate different organisational units within one Engine's client.
        freeTemplateCriterion:
          maxLength: 50
          type: string
          description: 'DEPRECATED: Use freeTemplateCriteria.value instead. Free textual criterion which can be referenced in template selectors.'
        deliveryNumber:
          maxLength: 70
          type: string
          description: Reference number of the delivery.
        remark:
          maxLength: 1000
          type: string
          description: Optional textual remark
        totalGrossMass:
          $ref: '#/components/schemas/QuantityDTO'
        totalNetMass:
          $ref: '#/components/schemas/QuantityDTO'
        dispatchCountryCode:
          maxLength: 2
          type: string
          description: ISO code of the country from which the goods are originally dispatched/exported without any commercial transaction taken place in intermediate countries.
        destinationCountryCode:
          maxLength: 2
          type: string
          description: ISO code of the country at which the goods are destined
        decisiveDate:
          $ref: '#/components/schemas/DateAndZoneDTO'
        tradeTerms:
          $ref: '#/components/schemas/ICTradeTermsDTO'
        isContainerised:
          type: boolean
          description: Flags, if the delivery is shipped in a container.
        warehouse:
          $ref: '#/components/schemas/ICWarehouseDTO'
        freeTemplateCriteria:
          type: array
          description: List of ICFreeTemplateCriterion, including a string for the criterion and the corresponding customs process.
          items:
            $ref: '#/components/schemas/ICFreeTemplateCriterionDTO'
        clientSpecificFields:
          $ref: '#/components/schemas/ClientSpecificFieldsDTO'
        parties:
          type: array
          description: List of parties, including their role within the consignment.
          items:
            $ref: '#/components/schemas/ICPartyDTO'
        locations:
          type: array
          description: List of locations, including their role within the consignment.
          items:
            $ref: '#/components/schemas/ICLocationDTO'
        transportEquipments:
          type: array
          description: List of transport equipments (e.g. containers)
          items:
            $ref: '#/components/schemas/ICTransportEquipmentDTO'
        customsOffices:
          type: array
          description: List of customs offices.
          items:
            $ref: '#/components/schemas/ICCustomsOfficeDTO'
        transportMeans:
          type: array
          description: List of transport means.
          items:
            $ref: '#/components/schemas/ICTransportMeansDTO'
        itinerary:
          type: array
          description: List of countries of the itinerary.
          items:
            $ref: '#/components/schemas/ICRoutingCountryDTO'
        invoices:
          type: array
          description: List of invoices.
          items:
            $ref: '#/components/schemas/ICInvoiceDTO'
        items:
          type: array
          description: List of items.
          items:
            $ref: '#/components/schemas/ICDeliveryItemDTO'
        packages:
          type: array
          description: List of packages.
          items:
            $ref: '#/components/schemas/ICPackageDTO'
        extension:
          $ref: '#/components/schemas/ICDeliveryExtensionDataDTO'
        goodsDescription:
          type: array
          description: Description of goods in different languages. Each description can have a length of 512.
          items:
            $ref: '#/components/schemas/TextInLanguageDTO'
        additionalReferences:
          type: array
          description: List of additional references which belong to the delivery.
          items:
            $ref: '#/components/schemas/ICAdditionalReferenceDTO'
      description: DTO to hold data of a delivery.
    ICMaterialDTO:
      required:
      - materialId
      type: object
      properties:
        materialId:
          maxLength: 50
          type: string
          description: A persistent ID for identifying a material / good in the AEB Customs systems. If a link to the AEB Customs Inventory Management exists, the material ID also serves as a unique identifier for the goods to be booked into or out of the inventory.
          example: M-1000
      description: DTO to hold data of a material.
    ICCreateConsignmentManifestResponseDTO:
      type: object
      properties:
        hasErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>An error usually means that the request could not be performed.</p><p>Error details are provided in the messages[] array.</p>
          example: false
        hasOnlyRetryableErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        hasWarnings:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        messages:
          type: array
          description: <p>Error or warning messages at the request level.</p><p>There may be additional messages[] arrays at lower data levels as specified in the documentation.</p>
          items:
            $ref: '#/components/schemas/ResponseMessageDTO'
        manifest:
          $ref: '#/components/schemas/ICConsignmentManifestResultDTO'
      description: The response DTO after processing the request. Contains the resulting consignment DTO.
    ICCreateDeliveryRequestDTO:
      required:
      - delivery
      type: object
      properties:
        clientSystemId:
          type: string
          description: '<p>Id of the sending client system.</p><p>e.g. Installation ID of the sending host or ERP system.</p><p>Maximum length: 20</p>'
          example: TEST_ID
        clientIdentCode:
          type: string
          description: '<p>Client identification code.</p><p>Maximum length: 10</p>'
          example: APITEST
        userName:
          type: string
          description: <p>User who initiated the request from the client system.</p><p>If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.</p><p>If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.</p><p>Actual authentication is handled separately via the request's headers, so no password is required in the request's data.</p>
          example: API_TEST
        resultLanguageIsoCodes:
          type: array
          description: <p>2-letter ISO codes of the languages in which texts will be returned.</p><p>English ('en') and German ('de') are typically supported by default. Other languages may be supported.</p><p>Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.</p>
          example:
          - en
          - de
          items:
            type: string
            description: <p>2-letter ISO codes of the languages in which texts will be returned.</p><p>English ('en') and German ('de') are typically supported by default. Other languages may be supported.</p><p>Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.</p>
            example: '["en","de"]'
        delivery:
          $ref: '#/components/schemas/ICDeliveryDTO'
      description: The DTO for the request.
    ICCustomsProcedureDTO:
      type: object
      properties:
        customsProcedureType:
          maxLength: 35
          type: string
          description: "Specific types are: <ul> <li>EXPORTPROC - Customs procedure code export</li> <li>EXPORTPROCNAT - Customs national procedure code export</li> <li>EXPORTCPCGRP - Customs procedure code category/group export</li> <li>IMPORTPROC - Customs procedure code import</li> <li>IMPORTPROCNAT - Customs national procedure code import</li> <li>IMPORTCPCGRP - Customs procedure code category/group import</li>\t *  <li>'... for full list see /InternationalCustomsBFBean/getCodes with codeListCode=CUSTOMS_PROCEDURE_TYPE</li> </ul>"
        customsProcedureCode:
          maxLength: 20
          type: string
          description: The code depending on the type above.
      description: DTO to hold data for customs procedure codes
    ICLinkedProcessInfoDTO:
      type: object
      properties:
        processType:
          maxLength: 20
          type: string
          description: 'Specific type of process: <ul> <li>PORT_ANTWERP - C-Point system for port notifications. <li>PORT_ROTTERDAM - Prtbase system for port notifications. <li>''... for full list see /InternationalCustomsBFBean/getCodes with codeListCode=LINKED_PROCESS_TYPE </li>  </ul>'
        authoritySystemId:
          maxLength: 50
          type: string
          description: The id in the customs/port authority's system.
        issueDate:
          $ref: '#/components/schemas/DateAndZoneDTO'
      description: 'DTO to hold data of a customs process that is linked to the main declaration object. '
    ClientSpecificFieldDTO:
      type: object
      properties:
        identCode:
          maxLength: 50
          minLength: 1
          type: string
          description: Ident code of the custom field.
        value:
          maxLength: 100
          minLength: 1
          type: string
          description: <p>Value of the client specific field.</p><p>Supported data types:</p><ul><li>String</li><li>Boolean such as 'true' or 'false'</li><li>Decimal such as '10' or with additional precision '10.245'. The actual length and scale of the value depends on the field configuration, maximum length is 15 and maximum scale is 9. The scale will be set to the configured scale with half up rounding if the scale of the value exceeds the configured scale.</li><li>Date such as '2024-06-24'</li><li>DateTime in UTC such as '2024-06-24T10:15:30Z' or with additional precision up to nanoseconds such as '2024-06-24T10:15:30.999666333Z'</li><li>Time such as '10:15:30' or with additional precision up to nanoseconds such as '10:15:30.999666333'</li></ul><p>If the value cannot be parsed according to the configured data type, the value will be ignored and an error will be logged.</p>
        customsProcess:
          maxLength: 20
          type: string
          description: <p>Specific customs process. <ul><li>'EXPORT_BE' - Export process for Belgium</li> <li>'EXPORT_SE' - Export process for Sweden</li> <li>'EXPORT_NL' - Export process for Netherlands</li> <li>'TRANSIT_NL' - Transit process for Netherlands</li> <li>... for full list see /InternationalCustomsBFBean/getCodes with codeListCode=CUSTOMS_PROCESS_TYPE</li></ul></p>
          example: EXPORT_BE
      description: Represents a client specific declaration field. Client specific fields must be configured for the resulting declaration and are never intended to be used as actual fields which are send to customs. However this can be for example an additional criteria which is necessary for the customs process. The field can be used as a template criterion, used in filters and data extractions.
    ICSealDTO:
      type: object
      properties:
        identification:
          maxLength: 35
          type: string
          description: The seals number.
      description: DTO to hold data for a seal.
    ICCustomsSpecialProceduresReferencesDTO:
      required:
      - bookingRequestId
      type: object
      properties:
        bookingRequestId:
          maxLength: 64
          type: string
          description: Unique id of the booking request.
          example: BR-1000-ID
      description: DTO to hold references to a booking request.
    ICRoutingCountryDTO:
      type: object
      properties:
        sequenceNumber:
          maxLength: 2
          type: integer
          description: Sequence number of the country within the itinerary.
          format: int32
        countryCode:
          maxLength: 2
          type: string
          description: ISO code of the country
      description: DTO to hold data for a routing country.
    ICDeliveryExportDEDTO:
      type: object
      properties:
        goodsLocation:
          $ref: '#/components/schemas/ICLocationDTO'
        expectedArrivalTime:
          $ref: '#/components/schemas/DateAndZoneDTO'
        expectedDepartureTime:
          $ref: '#/components/schemas/DateAndZoneDTO'
        deferredPayments:
          type: array
          description: Deferred payments.
          items:
            $ref: '#/components/schemas/ICDeferredPaymentDTO'
        departureAirportCode:
          pattern: ^[A-Z]{3}$
          type: string
          description: Code (IATA key) for the airport of departure
        producedDocuments:
          type: array
          description: List of produced documents
          items:
            $ref: '#/components/schemas/ICProducedDocumentEUDTO'
        previousDocuments:
          type: array
          description: List of previous documents
          items:
            $ref: '#/components/schemas/ICPreviousDocumentDTO'
        templateName:
          type: string
          description: Head template name in AES
        presentationOfGoodsStartDate:
          $ref: '#/components/schemas/DateAndZoneDTO'
        presentationOfGoodsEndDate:
          $ref: '#/components/schemas/DateAndZoneDTO'
        outwardProcessing:
          $ref: '#/components/schemas/OutwardProcessingFieldDTO'
        additionalInfoForCustoms:
          maxLength: 512
          type: string
          description: Additional information for customs that will be used for type X0000.
      description: DTO to hold Export DE specific extension data for a ICDeliveryDTO.
    ICCreateConsignmentRequestDTO:
      required:
      - consignment
      type: object
      properties:
        clientSystemId:
          type: string
          description: '<p>Id of the sending client system.</p><p>e.g. Installation ID of the sending host or ERP system.</p><p>Maximum length: 20</p>'
          example: TEST_ID
        clientIdentCode:
          type: string
          description: '<p>Client identification code.</p><p>Maximum length: 10</p>'
          example: APITEST
        userName:
          type: string
          description: <p>User who initiated the request from the client system.</p><p>If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.</p><p>If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.</p><p>Actual authentication is handled separately via the request's headers, so no password is required in the request's data.</p>
          example: API_TEST
        resultLanguageIsoCodes:
          type: array
          description: <p>2-letter ISO codes of the languages in which texts will be returned.</p><p>English ('en') and German ('de') are typically supported by default. Other languages may be supported.</p><p>Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.</p>
          example:
          - en
          - de
          items:
            type: string
            description: <p>2-letter ISO codes of the languages in which texts will be returned.</p><p>English ('en') and German ('de') are typically supported by default. Other languages may be supported.</p><p>Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.</p>
            example: '["en","de"]'
        consignment:
          $ref: '#/components/schemas/ICConsignmentDTO'
      description: The DTO for the request.
    ICDeliveryExportUSDTO:
      type: object
      properties:
        carrierCode:
          maxLength: 4
          type: string
          description: Code specifying the carrier.
        consigneeRelatedIndicator:
          maxLength: 3
          type: string
          description: Code specifying the consignee related indicator.
        consigneeType:
          maxLength: 2
          type: string
          description: Code specifying the consignee type.
        expectedDepartureTime:
          $ref: '#/components/schemas/DateAndZoneDTO'
        exportationPort:
          maxLength: 4
          type: string
          description: Code specifying the exportation port.
        unladingPort:
          maxLength: 5
          type: string
          description: Code specifying the unlading port.
        originRegion:
          maxLength: 2
          type: string
          description: Code specifying the origin region.
        soldEnRouteIndicator:
          maxLength: 2
          type: string
          description: Code specifying the sold en route indicator.
        transportationReferenceNumber:
          maxLength: 30
          type: string
          description: Code specifying the transportation reference.
        inbondCode:
          maxLength: 2
          type: string
          description: Code specifying the in-bond status.
      description: DTO to hold Export US specific extension data for a ICDeliveryDTO.
  securitySchemes:
    SWAGGER_AUTH_KEY:
      type: apiKey
      name: X-XNSG_WEB_TOKEN
      in: header
    BASIC_AUTH:
      type: http
      scheme: basic
x-proxy-enabled: false