openapi: 3.0.0
info:
  version: '5'
  title: Data Exchange API
  description: >-
    This API 1 provides services to upload, manipulate and download
    businesspartner data in the CDL Cloud.
servers:
  - description: Production
    url: https://api.cdq.com/data-exchange/rest
    x-cdq-soap-url: https://api.corporate-data-league.ch/data-exchange/soap/v5
security:
  - apiKey: []
tags:
  - name: Seed Updates
    description: >
      Manages operations such as creating, updating, or transforming Business
      Partner data to ensure that the information 

      is current and accurate.
  - name: Analytics
    description: >
      Provides functionalities for analyzing and processing Business Partner
      data, enabling users to gain insights and perform 

      various analytical operations on the data.
  - name: Business Partner Storages
    description: >
      Provides functionalities for creating, retrieving, updating and deleting
      Business Partner storage, as well as managing 

      associated data sources and data monitors.
  - name: Business Partners
    description: >
      Provides functionalities for creating, retrieving, updating, and deleting
      Business Partner records, as well as performing 

      various operations such as lookup and upsert.
  - name: Data Import
    description: >
      Provides functionalities for uploading external data and enabling users to
      enhance and update their Business Partner 

      records with new information.
  - name: Data Mapping
    description: >
      Provides functionalities for defining and managing data mappings, enabling
      users to transform and map raw data into 

      structured formats suitable for processing and analysis.
  - name: Data Monitors
    description: >
      Provides functionalities for creating, retrieving, updating and deleting
      data monitors.
  - name: Data Transformation
    description: |
      Provides functionalities for converting raw data into structured formats.
  - name: DNB Storages
    description: >
      Provides functionalities for creating, retrieving, updating and deleting
      DNB storage, as well as managing associated 

      data sources and data monitors.
  - name: Files
    description: |
      Provides functionalities for uploading, downloading and deleting files.
  - name: Data Mappers
    description: >
      Provides functionalities for transforming raw data into structured
      Business Partner data using predefined data mapper 

      definitions. This allows users to convert various data formats into a
      standardized format suitable for processing 

      and analysis.
  - name: Relations
    description: |
      Manages relationships between Business Partners.
paths:
  /storages/{storageId}:
    parameters:
      - name: storageId
        description: Unique ID of a Business Partner Storage.
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
    put:
      tags:
        - Business Partner Storages
      parameters: []
      summary: Update Storage
      description: Update a Business Partner Storage.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessPartnerStorageMetadataUpdate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnerStorageMetadata'
          description: OK
    delete:
      x-wsdl: true
      tags:
        - Business Partner Storages
      summary: Delete Storage
      description: Delete a Business Partner Storage.
      parameters: []
      responses:
        '200':
          description: OK
  /jobs/dnbimportjobs:
    post:
      x-wsdl: false
      tags:
        - DNB Storages
      summary: Start DNB Import Job
      description: >
        To start a D&B Import Job use the following request

        ```

        curl -X POST \
          --url 'https://api.corporate-data-league.ch/data-exchange/rest/jobs/dnbimportjobs?dnbUser=optional&dnbPassword=optional' \
          -u 'BasicAuthUserName:your_credentials'\
          -H 'Accept: application/json' \
          -F 'file=@your_file.csv'
        ```

        with using this sample file:

        ```

        DUNS

        305211311

        DNB:305211311

        ```

        The file can be a `csv` or `xlsx`. The file should contain only one
        column with the DUNS number.

        In the first row should the header `DUNS`. The DUNS number can be in
        following forms:

        - As CDQ-ID. Example or `DNB:305211311`

        - as raw DUNS `305211311`


        The DUNS consist of 9 digits. When the input DUNS does not consist of 9
        digits, leading zeros are added.
      parameters:
        - name: name
          description: Name of the job.
          in: query
          schema:
            $ref: '#/components/schemas/JobName'
            maxLength: 50
        - name: description
          description: Description of the job.
          in: query
          schema:
            $ref: '#/components/schemas/JobDescription'
            maxLength: 200
        - name: dnbUser
          in: query
          description: >-
            Optional, if credentials are available in user or organization
            settings.
          schema:
            type: string
            example: username
        - name: dnbPassword
          in: query
          description: >-
            Optional, if credentials are available in user or organization
            settings.
          schema:
            type: string
            example: password
        - name: featuresOn
          description: Feature to be activated.
          in: query
          required: false
          schema:
            type: array
            description: List of features to be activated.
            items:
              $ref: '#/components/schemas/DnbImportJobFeature'
        - name: dnbDataSource
          description: >-
            D&B product that should be downloaded from D&B and put into specific
            D&B storage.
          in: query
          schema:
            $ref: '#/components/schemas/DnbStorageTechnicalKeyParam'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DnbImportJob'
        '400':
          $ref: '#/components/responses/400_BadRequest'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              description: DNB Import Job Request
              properties:
                file:
                  type: string
                  format: binary
                  description: >-
                    XLSX or CSV file to be uploaded, containing mandatory DUNS
                    column (SOAP currently only supports CSV).
                  example: CH-import.csv
  /jobs/dnbimportjobs/{id}:
    get:
      x-wsdl: false
      tags:
        - DNB Storages
      summary: Poll DNB Import Job
      description: >
        After you have started a D&B import job, you will receive a job id in
        the response. ``` {
          "id" : "<ID>"
        } ```

        Use this ID to poll for the status of the job using this endpoint. Once
        the status is FINISHED, you can see the results in the D&B storage.
      parameters:
        - name: id
          in: path
          description: ID of the D&B import job.
          required: true
          schema:
            $ref: '#/components/schemas/JobId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DnbImportJob'
  /jobs/dnbcreatelodjobs:
    post:
      x-wsdl: false
      tags:
        - DNB Storages
      summary: Create LOD File
      description: >
        For all data mirrors configured for an organization read Business
        Partners identifiers with type DUNS_ID and create a List

        fd DUNS file. This file is used the initialization of the D&B Monitoring
        process
      parameters: []
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DnbLodJobRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DnbCreateLODJob'
        '400':
          $ref: '#/components/responses/400_BadRequest'
  /jobs/dnbcreatelodjobs/{id}:
    get:
      x-wsdl: false
      tags:
        - DNB Storages
      summary: Poll DNB LOD Job
      description: >
        After you have started a D&B LOD job, you will receive a job id in the
        response. ``` {
          "id" : "<ID>"
        } ```

        Use this ID to poll for the status of the job using this endpoint. Once
        the status is FINISHED, you can see the results in the attachments.
      parameters:
        - name: id
          in: path
          description: ID of the D&B Create LOD job.
          required: true
          schema:
            $ref: '#/components/schemas/JobId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DnbCreateLODJob'
  /v2/storages/{storageId}:
    parameters:
      - name: storageId
        description: Unique ID of a Business Partner Storage.
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
    get:
      tags:
        - Business Partner Storages
      parameters:
        - name: featuresOn
          in: query
          description: Features to be activated during reading the metadata.
          schema:
            type: array
            description: List of features.
            items:
              type: string
              description: List of features.
              example: WITH_COUNTRY_STATISTICS
              enum:
                - WITH_COUNTRY_STATISTICS
                - ONLY_ISO_COUNTRY_STATISTICS
              x-enumDescriptions:
                WITH_COUNTRY_STATISTICS: Recalculates and retrieves country statistics information.
                ONLY_ISO_COUNTRY_STATISTICS: Forces only valid ISO 3166-2 country codes.
        - name: dataSource
          in: query
          description: >-
            Data Source (name or ID) to be measured during calculating
            statistics. By default, all Data Sources are measured.
          schema:
            $ref: '#/components/schemas/BusinessPartnerDataSource'
      summary: Read Storage
      description: Read metadata of a storage.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnerStorageMetadata'
          description: OK
  /v2/datamonitors:
    get:
      parameters:
        - $ref: '#/components/parameters/startAfterQueryParam'
        - $ref: '#/components/parameters/limitQueryParam'
        - name: sort
          in: query
          description: >
            Defines the attributes to sort by. Supported attribute is
            'modifiedAt'. Sort direction can be specified in front of each 

            attribute. '+' means ascending, '-' means descending. If direction
            is not given default sort is ascending.
          schema:
            type: string
            description: >
              Defines the attributes to sort by. Supported attribute is
              'modifiedAt'. Sort direction can be specified in front of each 

              attribute. '+' means ascending, '-' means descending. If direction
              is not given default sort is ascending.
            default: '-modifiedAt'
            example: '-modifiedAt'
        - name: typeTechnicalKeys
          description: Business Partner type technical keys which should be filtered.
          in: query
          required: true
          schema:
            type: array
            description: List of Data Monitor type Technical Keys.
            items:
              $ref: '#/components/schemas/DataMonitorTypeTechnicalKeyEnum'
        - name: dataSourceId
          in: query
          required: false
          description: Filter by specified Data Source ID.
          schema:
            $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        - name: configurationId
          in: query
          required: false
          description: Filter by specified Configuration ID.
          schema:
            $ref: '#/components/schemas/ConfigurationId'
      tags:
        - Data Monitors
      summary: List Data Monitors by Type
      description: List all Data Monitors of a specific type across all storages.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataMonitorsPage'
          description: A page of Data Monitors matching the specified type.
  /v4/dnbstorages/dnbrecords:
    get:
      x-wsdl: false
      tags:
        - DNB Storages
      summary: List DNB Records
      description: Read a page of records from the D&B storage of your organization.
      parameters:
        - $ref: '#/components/parameters/startAfterQueryParam'
        - $ref: '#/components/parameters/limitQueryParam'
        - $ref: '#/components/parameters/dnbRecordsReadFeatureOnQueryParam'
        - $ref: '#/components/parameters/dnbRecordsReadFeatureOffQueryParam'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DnbRecordPage'
          description: OK
  /v4/dnbstorages/fetch:
    post:
      x-wsdl: false
      tags:
        - DNB Storages
      summary: Fetch DNB Record
      description: Fetch a D&B record by providing the DUNS.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FetchDnbRecordRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FetchDnbRecordResult'
          description: OK
  /v4/storages/{storageId}/businesspartners:
    parameters:
      - name: storageId
        description: Unique identifier of the Storage.
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
    get:
      x-wsdl: true
      tags:
        - Business Partners
      summary: List Business Partners
      description: Read a page of business partners from the storage.
      parameters:
        - $ref: '#/components/parameters/startAfterQueryParam'
        - $ref: '#/components/parameters/limitQueryParam'
        - name: dataSource
          in: query
          required: false
          description: >-
            Data Source (name or ID) to be measured during calculating
            statistics. By default, all Data Sources are measured.
          schema:
            type: array
            description: List of Data Sources.
            items:
              $ref: '#/components/schemas/BusinessPartnerDataSource'
        - name: countryCode
          description: >-
            Country code (ISO 3166-1 alpha-2) used to filter the result of
            business partners returned.
          in: query
          required: false
          schema:
            type: array
            description: List of country codes.
            items:
              $ref: '#/components/schemas/CountryShortName'
        - name: hasRawData
          description: >-
            Flag to filter result of business partners based on the existence of
            the record attribute (raw data).
          in: query
          required: false
          schema:
            type: boolean
            default: false
            example: 'false'
        - name: updateMonitoring
          description: >-
            Flag to filter business partners by the value of updateMonitoring
            attribute.
          in: query
          required: false
          schema:
            type: boolean
            example: 'true'
        - name: modifiedBefore
          description: >-
            Return entries which were modified before given data. The given date
            should support ISO-8601 representation.
          in: query
          required: false
          schema:
            type: string
            example: '2025-08-19T06:23:16Z'
        - name: modifiedAfter
          description: >-
            Return entries which were modified after given data. The given date
            should support ISO-8601 representation.
          in: query
          required: false
          schema:
            type: string
            example: '2025-08-19T06:23:16Z'
        - name: businessPartnerId
          description: Business Partner IDs which should be filtered.
          in: query
          required: false
          schema:
            type: array
            description: List of Business Partner IDs.
            items:
              $ref: '#/components/schemas/BusinessPartnerId'
        - name: externalId
          description: Business Partner externalIDs.
          in: query
          required: false
          schema:
            type: array
            description: List of Business Partner externalIDs.
            maxItems: 100
            items:
              $ref: '#/components/schemas/BusinessPartnerExternalId'
        - name: sharingStatus
          description: |
            Business Partner Sharing Status which should be filtered.

            Sharing Statuses which can be filtered out:
            * `UNDER_CONSIDERATION`
            * `UNDISCLOSED_RECORD`
            * `MISSING_INFORMATION_FOR_LINKAGE`
            * `ERRONEOUS_INFORMATION_FOR_LINKAGE`
            * `ERRONEOUS_RECORD`
            * `PENDING_LINKAGE_DECISION`
            * `PROCESS_ISSUE`
            * `SHARED_WITH_NO_MATCH`
            * `SHARED_WITH_CONFIDENT_MATCH`
            * `SHARED_WITH_NO_MATCH_BY_REVIEW`
            * `SHARED_BY_REVIEW`
          in: query
          required: false
          schema:
            type: array
            description: List of Business Partner Sharing Statuses.
            items:
              type: string
              description: Sharing Statuses which can be filtered out.
              example: UNDER_CONSIDERATION
        - name: featuresOn
          description: Features to be activated.
          in: query
          required: false
          schema:
            type: array
            description: List of features to be activated.
            items:
              $ref: '#/components/schemas/BusinessPartnersReadFeatureParam'
        - name: featuresOff
          description: Features to be deactivated.
          in: query
          schema:
            type: array
            description: List of features to be deactivated.
            items:
              $ref: '#/components/schemas/BusinessPartnersReadFeatureParam'
        - name: validationLogResultStatus
          description: Violation level of validation result.
          in: query
          required: false
          schema:
            type: array
            description: List of validation level statuses.
            items:
              $ref: '#/components/schemas/ValidationLevelParam'
        - name: validationSharingLogResultStatus
          description: Violation level of sharing validation result.
          in: query
          required: false
          schema:
            type: array
            description: List of validation level statuses.
            items:
              $ref: '#/components/schemas/ValidationLevelParam'
        - name: curationLogResultStatus
          description: Curation log of curation result.
          in: query
          required: false
          schema:
            type: array
            description: List of curation level statuses.
            items:
              $ref: '#/components/schemas/CurationLevelParam'
        - name: reviewStatus
          description: Review status used for filtering the result data.
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/ReviewStatusParam'
        - name: fromJobProcessedAt
          description: >-
            Returns the results which have one of the log result status ->
            jobProcessedAt after given date. The given date should support
            ISO-8601 representation.
          in: query
          required: false
          schema:
            type: string
            example: '2025-08-19T06:23:16Z'
        - name: toJobProcessedAt
          description: >-
            Returns the results which have one of the log result status ->
            jobProcessedAt before given date. The given date should support
            ISO-8601 representation.
          in: query
          required: false
          schema:
            type: string
            example: '2025-08-19T06:23:16Z'
        - name: fromTriggerProcessedAt
          description: >-
            Returns the results which have one of the log result status ->
            triggerProcessedAt after given date. The given date should support
            ISO-8601 representation.
          in: query
          required: false
          schema:
            type: string
            example: '2025-08-19T06:23:16Z'
        - name: toTriggerProcessedAt
          description: >-
            Returns the results which have one of the log result status ->
            triggerProcessedAt before given date. The given date should support
            ISO-8601 representation.
          in: query
          required: false
          schema:
            type: string
            example: '2025-08-19T06:23:16Z'
        - name: fromProcessedAt
          description: >-
            Returns the results which have one of the log result status ->
            processedAt after given date. The given date should support ISO-8601
            representation.
          in: query
          required: false
          schema:
            type: string
            example: '2025-08-19T06:23:16Z'
        - name: toProcessedAt
          description: >-
            Returns the results which have one of the log result status ->
            processedAt before given date. The given date should support
            ISO-8601 representation.
          in: query
          required: false
          schema:
            type: string
            example: '2025-08-19T06:23:16Z'
        - name: logResultTriggerType
          description: >-
            Trigger type used for filtering the result which should match with
            at least one of any log result status -> triggerType fields.
          in: query
          required: false
          schema:
            type: array
            description: List of trigger types.
            items:
              $ref: >-
                #/components/schemas/ProcessingLogResultStatusTriggerTypeTechnicalKeyParam
        - name: logResultTriggerProvenanceTechnicalKeys
          description: >-
            Provenance technical keys used for filtering the result which should
            match with at least one of any log result status -> triggerType
            fields.
          in: query
          required: false
          schema:
            type: array
            description: List of Provenance Technical Key.
            items:
              $ref: '#/components/schemas/ProvenanceTechnicalKey'
        - name: typeTechnicalKeys
          description: Business Partner type technical keys which should be filtered.
          in: query
          required: false
          schema:
            type: array
            description: List of Business Partner type Technical Keys.
            maxItems: 1
            items:
              $ref: '#/components/schemas/BusinessPartnerTypeTechnicalKeyParam'
        - name: tagValues
          description: >-
            Tag values that will be used to filter Business Partners. Values are
            connected with logical 'AND'.
          in: query
          required: false
          schema:
            type: array
            description: List of Tag Values.
            items:
              $ref: '#/components/schemas/TagValue'
        - name: tagTypeTechnicalKey
          description: >-
            Type Technical Key of tags that are provided in 'tagValues' query
            param.
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/TagTypeTechnicalKey'
        - name: curationProcessingStatus
          description: Curation's processing status technical key to filter by.
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/ProcessingStatusTechnicalKeyEnum'
        - name: validationProcessingStatus
          description: Validation's processing status technical key to filter by.
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/ProcessingStatusTechnicalKeyEnum'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnerPage'
          description: OK
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
    put:
      x-wsdl: true
      tags:
        - Business Partners
      summary: Upsert Business Partners
      description: >
        Upsert Business Partners in a Business Partner storage in batches.
        Maximum of 1000 Business Partners are allowed per batch.


        If no data source (via field: `dataSource`) is provided and the storage
        has only one, then this data source will be used/set. Other options are
        to provide an

        existing data source in the request, which will then be taken for all
        the Business Partner or to provide a data source for each Business
        Partner

        individually.


        In the following cases an API error will be thrown:
          1) given data source in the Request or the BusinessPartner is unknown
          2) no data source given and more than one data source is attached to the storage

        To start upserting Business Partners into a storage, use the following
        request.


        ```

        PUT
        https://api.corporate-data-league.ch/data-exchange/rest/v4/storages/{YOUR
        STORAGE ID}/businesspartners

        {
          "dataSource": "{YOUR DATA SOURCE}",
          "featuresOn": ["UPSERT_BY_EXTERNAL_ID"],
          "businessPartners": [
           {
             "externalId": "123",
             "record": "{\"MyId\":\"123\", \"City\":\"St. Gallen\"}"
           }]
        }

        ```


        The response is shown below.


        ```

        {
           "numberOfAccepted": "1",
           "numberOfFailed": "0",
        }


        ```


        Upserting Business Partners enables automated data transformation from
        the `record` field to the Business Partner model.

        It requires a Data Mapper Definition and assigned to
        `dataMapperDefinitionId` field

        of a data source Business Partner is being upserted to.


        `record` field requires stringified JSON. Characters: backslash `\` and
        double quote `"` must be escaped (respectively: `\\\\` and `\"`). Fields
        containing `.` are unallowed."


        To enable automated data transformation, one of the following features
        is required:

        - TRANSFORM_RECORD - synchronous transformation, limited for batch size
        <= 250,

        - ENABLE_ASYNC - asynchronous transformation. Enabled by default when
        TRANSFORM_RECORD is not requested.


        Automated data transformation can be executed together with the
        UPSERT_BY_EXTERNAL_ID feature,

        but it requires to provide external ID as a field `externalId` of a
        Business Partner,

        which is preserved during the transformation.


        If there is no name typed
        [LOCAL](https://meta.cdq.com/Business_partner/name/type/local) in
        `businessPartner.names`

        and exists any name with empty type or not filled `type.technicalKey`,
        it becomes name of type LOCAL.


        Warn: in order to support multiple data sources, include dataSource into
        the request, either

        in $.dataSource or $.businessPartners[*].dataSource. Otherwise, multiple
        data sources with no selection

        of data source will lead to "No DataSource was provided for the given
        Business Partners and the storage

        has more than one attached to it." exception.



        Limits


        Business Partner and Address fields have defined array size limits


        | Path | Max array size |

        |---|---|

        | $.businessPartners[*].names | 20 |

        | $.businessPartners[*].identifiers | 20 |

        | $.businessPartners[*].categories | 20 |

        | $.businessPartners[*].addresses | 20 |

        | $.businessPartners[*].relations | 20 |

        | $.businessPartners[*].types | 20 |

        | $.businessPartners[*].bankAccounts | 50 |

        | $.businessPartners[*].profile.websites | 20 |

        | $.businessPartners[*].profile.classifications | 20 |

        | $.businessPartners[*].profile.contactEmails | 20 |

        | $.businessPartners[*].profile.phoneNumbers | 20 |

        | $.businessPartners[*].addresses[*].contexts | 100 |

        | $.businessPartners[*].addresses[*].administrativeAreas | 20 |

        | $.businessPartners[*].addresses[*].postCodes | 20 |

        | $.businessPartners[*].addresses[*].localities | 20 |

        | $.businessPartners[*].addresses[*].thoroughfares | 20 |

        | $.businessPartners[*].addresses[*].premises | 20 |

        | $.businessPartners[*].addresses[*].postalDeliveryPoints | 20 |

        | $.businessPartners[*].addresses[*].types | 20 |
      parameters: []
      requestBody:
        description: Parameters for Business Partners Upsert.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessPartnersUpsertRequest'
            examples:
              Example1:
                summary: Single record update
                value:
                  dataSource: YOUR_DATASOURCE_ID
                  featuresOn:
                    - UPSERT_BY_EXTERNAL_ID
                  businessPartners:
                    - externalId: YOUR_EXTERNAL_ID
                      record: >-
                        {"Customer number":"YOUR_EXTERNAL_ID",
                        "Name":"COMPANY_NAME", "Country":"COUNTRY_CODE",
                        "City":"CITY", "Street":"STREET", "Postal
                        code":"POSTAL_CODE"}
              Example2:
                summary: Update the City of the Business Partner
                value:
                  dataSource: YOUR_DATASOURCE_ID
                  featuresOn:
                    - UPSERT_BY_EXTERNAL_ID
                  businessPartners:
                    - externalId: '123'
                      record: '{"MyId":"123", "City":"St. Gallen"}'
              Example3:
                summary: Full request example
                value:
                  dataSource: string
                  businessPartners:
                    - id: string
                      externalId: string
                      dataSource: string
                      disclosed: true
                      updateMonitoring: true
                      record: '{}'
                      additionalInformation:
                        - key: KEY
                          value: 1
                      names:
                        - type:
                            url: string
                            name: string
                            technicalKey: string
                          value: string
                          shortName: string
                          language:
                            name: German
                            technicalKey: DE
                      legalForm:
                        name: string
                        url: >-
                          https://meta.cdq.com/Business_partner/legal_form/technical_key/DE_9866
                        technicalKey: DE_9866
                        language:
                          name: German
                          technicalKey: DE
                        mainAbbreviation: string
                      identifiers:
                        - type:
                            url: string
                            name: string
                            technicalKey: string
                          value: string
                          issuingBody:
                            name: string
                            url: string
                            technicalKey: string
                          status:
                            name: string
                            technicalKey: string
                      categories:
                        - name: string
                          url: string
                          technicalKey: string
                      status:
                        type:
                          name: string
                          url: string
                          technicalKey: string
                        officialDenotation: string
                        validFrom: string
                        validUntil: string
                      profile:
                        minorityIndicator:
                          value: string
                        classifications:
                          - value: string
                            code: string
                            type:
                              name: string
                              url: string
                              technicalKey: string
                        phoneNumbers:
                          - countryPrefix: string
                            number: string
                            type:
                              name: string
                              url: string
                              technicalKey: string
                            value: string
                        websites:
                          - url: string
                            type:
                              name: string
                              url: string
                              technicalKey: string
                        contactEmails:
                          - value: string
                      relations:
                        - startedAt: 2019-08-31T16:47+00:00
                          endedAt: 2019-08-31T16:47+00:00
                          type:
                            name: Organizational Unit
                            technicalKey: BRANCH
                          class:
                            name: CDQ Hierarchy
                            technicalKey: BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY
                          startNode: FR.RC:5664645
                          startNodeDataSource: string
                          startNodeBusinessPartner:
                            names:
                              - {}
                            addresses:
                              - postCodes: []
                                localities: []
                                thoroughfares: []
                          endNode: FR.RC:5664645
                          endNodeDataSource: string
                          endNodeBusinessPartner:
                            names:
                              - {}
                            addresses:
                              - postCodes: []
                                localities: []
                                thoroughfares: []
                      types:
                        - name: string
                          url: string
                          technicalKey: string
                      addresses:
                        - id: string
                          externalId: string
                          cdqId: string
                          version:
                            language:
                              name: German
                              technicalKey: DE
                            characterSet:
                              name: International
                              technicalKey: INTERNATIONAL
                          identifyingName:
                            value: string
                          careOf:
                            value: string
                          contexts:
                            - value: string
                          country:
                            shortName: CH
                            value: Switzerland
                          administrativeAreas:
                            - value: string
                              shortName: string
                              type: {}
                              language: {}
                          postCodes:
                            - value: string
                              type: {}
                          localities:
                            - type: {}
                              shortName: string
                              value: string
                              language: {}
                          thoroughfares:
                            - type: {}
                              shortName: string
                              number: string
                              value: string
                              name: string
                              direction: string
                              language: {}
                          premises:
                            - value: string
                              shortName: string
                              number: string
                              type: {}
                              language: {}
                          postalDeliveryPoints:
                            - type: {}
                              shortName: string
                              number: string
                              value: string
                              language: {}
                          geographicCoordinates:
                            latitude: 0
                            longitude: 0
                          types:
                            - name: string
                              url: string
                              technicalKey: string
                      bankAccounts:
                        - internationalBankAccountIdentifier: string
                          internationalBankIdentifier: string
                          nationalBankAccountIdentifier: string
                          nationalBankIdentifier: string
                          countryCode: string
                  featuresOn:
                    - FEATURE_1
                  featuresOff:
                    - FEATURE_2
              Example4:
                summary: Disclose Business Partners by Upsert
                value:
                  dataSource: YOUR_DATASOURCE_ID
                  featuresOn:
                    - UPSERT_BY_EXTERNAL_ID
                  businessPartners:
                    - externalId: YOUR_EXTERNAL_ID
                      disclosed: true
                      record: >-
                        {"Customernumber":"YOUR_EXTERNAL_ID","Name":"COMPANY_NAME","Country":"COUNTRY_CODE","City":"CITY","Street":"STREET","Postalcode":"POSTAL_CODE"}
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnersUpsertResult'
  /v5/storages/{storageId}/businesspartners/updates:
    parameters:
      - $ref: '#/components/parameters/storageIdPathParam'
    get:
      x-wsdl: false
      tags:
        - Business Partners
      summary: List Business Partners Updates
      description: >
        The Read Business Partner Updates endpoint provides an updated Business
        Partner structure and comprehensive

        Business Partner information from the Reference Data Sources. By
        default, only the latest version of a Business Partner

        from a single data source is provided. However, it's possible to access
        all historical updates (up to 3 months) by enabling 

        the `FeaturesOn: FETCH_HISTORICAL_UPDATES` option.


        **Filtration**


        A list of updated Business Partners can be filtered in various ways,
        with tags being the most powerful and important.

        Tags combine concepts (e.g., `NAME_LOCAL`, `IDENTIFIER`, `LOCALITY`)
        with actions (e.g., `ADDED`, `MODIFIED`).

        There are two types of classification filters:


        1. summaryClassification: This filter provides Business Partners with a
        summary classification, which is determined by the highest
        classificationlevel among all Business Partner concepts.

        2. conceptClassification: This filter indicates the classification of a
        specific concept of the Business Partner (e.g., name, street, legal
        form).


        Filtration by tag and `conceptClassification` works in pairs and
        identifies Business Partners where, for example, the `LOCAL_NAME` was
        `MODIFIED`

        and this change was classified as `MAJOR`. When filtering by tag and
        `summaryClassification`, the endpoint returns all Business Partners

        where the specified tags were added to the summary and the general
        summary classification is, for example,

        IDENTIFIER_ADDED, + highest classification for all updates =`MINOR`.
        Additional filtering options include country, provenance, and external
        IDs.

        Providing the data source (or your mirror) in the request can enhance
        response speed.

        It's possible to check the total number of updates using featuresOn
        NUMBER_OF_TOTAL, but can slow down the response. 


        **Recommendations**


        We recommend periodically reading all Business Partners (at least once)
        to improve the efficiency of specific filtrations.
      parameters:
        - $ref: '#/components/parameters/startAfterQueryParam'
        - $ref: '#/components/parameters/limitQueryParam'
        - name: businessPartnerIds
          in: query
          description: >
            Only show updates for listed Business Partner IDs.

            When providing list of Business Partner IDs, limit is ignored to
            provide full page.
          required: false
          schema:
            type: array
            description: List of Business Partner IDs.
            maxItems: 100
            items:
              $ref: '#/components/schemas/BusinessPartnerId'
        - name: externalIds
          in: query
          description: >
            Filter updates by Business Partner externalId, limit is ignored to
            provide full page.

            When used with the businessPartnerIds parameter, 

            only business partners that have one of the specified externalIds
            AND one of the specified businessPartnerIds will be returned.
          required: false
          schema:
            type: array
            maxItems: 100
            items:
              $ref: '#/components/schemas/BusinessPartnerExternalId'
        - name: provenanceTechnicalKeys
          description: Show updates for selected provenances by technical keys.
          in: query
          required: false
          schema:
            type: array
            items:
              $ref: '#/components/schemas/ProvenanceTechnicalKey'
        - name: exceptProvenanceTechnicalKeys
          description: >
            Show updates for all provenances except provided by technical keys. 

            By default, includes ORGANIZATION if not present on
            provenanceTechnicalKeys list.
          in: query
          required: false
          schema:
            type: array
            items:
              $ref: '#/components/schemas/ProvenanceTechnicalKey'
        - $ref: '#/components/parameters/dataTransformationDefinitionId'
        - name: from
          description: >
            Only show updates which have been modified after this date (ISO
            8601).

            Default is to show the 'last seven days' and farthest in the past is
            'since three month'.
          in: query
          required: false
          schema:
            type: string
            example: '2025-08-19T06:23:16Z'
        - name: dataSources
          description: Filter by data sources (name or id).
          in: query
          required: false
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BusinessPartnerDataSource'
        - name: countryShortNames
          description: Filter by countries.
          in: query
          required: false
          schema:
            type: array
            items:
              $ref: '#/components/schemas/CountryShortName'
        - name: summaryClassifications
          description: Filter by provided summary classifications (logical OR).
          in: query
          required: false
          schema:
            type: array
            items:
              $ref: '#/components/schemas/UpdateClassificationTechnicalKeyEnum'
        - name: updateTags
          description: Filter by update summary tags.
          in: query
          required: false
          schema:
            type: array
            items:
              $ref: '#/components/schemas/UpdateTagEnum'
        - name: updateTagsProfiles
          description: Profiled filter by update summary tags.
          in: query
          required: false
          schema:
            type: array
            items:
              $ref: '#/components/schemas/UpdateTagsProfileEnum'
        - name: conceptClassifications
          description: |
            Filter by provided concept classifications (logical OR).
            When used with the updateTags parameter,
            only those updates are presented, that match
            together with respective tag.
          in: query
          required: false
          schema:
            type: array
            items:
              $ref: '#/components/schemas/UpdateClassificationTechnicalKeyEnum'
        - name: featuresOn
          in: query
          required: false
          description: >
            Features to be used during the read Business Partner updates:

            * `APPLY_CURATION_DECISIONS` - Applies curation decisions from
            Decision Log to Business Partners in
            `$.values[*].storageBusinessPartner` if any decisions found.
            Requires FETCH_STORAGE_BUSINESS_PARTNER feature. By default,
            deactivated.

            * `FETCH_HISTORICAL_UPDATES` - Include historical updates into
            results. By default, deactivated.

            * `FETCH_STORAGE_BUSINESS_PARTNER` - Fetch Business Partner from a
            storage and set in `$.values[*].storageBusinessPartner`. By default,
            deactivated.

            * `NUMBER_OF_TOTAL` - Allows to switch fetching the total number of
            records to improve performance. By default, deactivated.
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BusinessPartnerUpdatesFeatureParam'
        - name: featuresOff
          in: query
          required: false
          description: >
            Features to be used during the read Business Partner updates:

            * `APPLY_CURATION_DECISIONS` - Applies curation decisions from
            Decision Log to Business Partners in
            `$.values[*].storageBusinessPartner` if any decisions found.
            Requires FETCH_STORAGE_BUSINESS_PARTNER feature. By default,
            deactivated.

            * `FETCH_HISTORICAL_UPDATES` - Include historical updates into
            results. By default, deactivated.

            * `FETCH_STORAGE_BUSINESS_PARTNER` - Fetch Business Partner from a
            storage and set in `$.values[*].storageBusinessPartner`. By default,
            deactivated.

            * `NUMBER_OF_TOTAL` - Allows to switch fetching the total number of
            records to improve performance. By default, deactivated.
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BusinessPartnerUpdatesFeatureParam'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnerUpdatePage'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Bad Request
  /v5/storages/{storageId}/seedupdates/generate:
    parameters:
      - $ref: '#/components/parameters/storageIdPathParam'
    post:
      x-wsdl: false
      tags:
        - Seed Updates
      summary: Start Seed Updates Generate Job
      description: Start a Seed Updates Generate Job for the given storage.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SeedUpdateGenerateJobCreate'
            examples:
              example:
                summary: Seed Updates
                value:
                  referenceDataSource: BR_RF
                  dataSourceIds:
                    - 5e2874fb8d2a7400011acee1
                  externalIds:
                    - The ID managed in the customer's SAP systems.
                  businessPartnerIds:
                    - 63e635235c06b7396330fe40
                  countryShortName: CH
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SeedUpdateGenerateJob'
          description: OK
        '400':
          description: Bad Request
  /v5/storages/{storageId}/seedupdates/generate/{jobId}:
    parameters:
      - $ref: '#/components/parameters/storageIdPathParam'
      - $ref: '#/components/parameters/jobIdPathParam'
    get:
      x-wsdl: false
      tags:
        - Seed Updates
      summary: Poll Seed Updates Generate Job
      description: Poll a Seed Updates Generate Job for the given storage.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SeedUpdateGenerateJob'
          description: OK
        '400':
          description: Bad Request
  /storages/{storageId}/clear:
    parameters:
      - name: storageId
        description: Unique ID of a Business Partner Storage.
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
    post:
      x-wsdl: true
      tags:
        - Business Partner Storages
      summary: Clear Storage
      description: Remove all Business Partners from given Business Partner Storage.
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnersClearResult'
          description: OK
  /storages/{storageId}/datamonitors/{dataMonitorId}:
    parameters:
      - name: storageId
        description: Unique identifier of the Storage.
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
      - name: dataMonitorId
        description: Unique ID of a Data Monitor.
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/DataMonitorId'
    delete:
      parameters: []
      tags:
        - Data Monitors
      summary: Delete Data Monitor
      description: Delete a data monitor.
      responses:
        '200':
          description: OK
  /storages/{storageId}/datasources:
    parameters:
      - name: storageId
        description: Unique ID of Business Partner storage.
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
    put:
      deprecated: true
      tags:
        - Business Partner Storages
      summary: Update Data Sources
      description: >
        This endpoint is deprecated. Please use

        * [create data
        source](https://developer.cdq.com/reference-docs/data-exchange/V5/tag/Business-Partner-Storages/paths/~1storages~1%7BstorageId%7D~1datasources/post/)
        to create a new data source,

        * [update data
        source](https://developer.cdq.com/reference-docs/data-exchange/V1/tag/Business-Partner-Storages/paths/~1storages~1%7BstorageId%7D~1datasources~1%7BdataSourceId%7D/put/)
        to update existing data source,

        * [delete data
        source](https://developer.cdq.com/reference-docs/data-exchange/V1/tag/Business-Partner-Storages/paths/~1storages~1%7BstorageId%7D/delete/)
        to delete existing data source.


        Update all data sources of a given storage.


        * When a new data source without id is added to the list, it is created.
        In case data source is created within DATA_MIRROR and does not have
        `dataMapperDefinitionId` or `dataTransformationDefinitionId` filled,
        `dataMapperDefinitionId` is set to `default`.

        * When existing data source is provided on a list with id included, it
        is updated.

        * When data source identified by id is not included in a list, it is
        deleted with all its related Business Partners,

        data monitors and sharing scopes for that data source are adjusted (data
        source is removed from

        the data sources list of a resource and resource is removed if data
        source was the only one assigned).


        Note: all data sources that are expected to remain in the storage must
        be included on a list.


        Warn: If you have an integration with one data source, please check if

        data source id is included in the upsert request before adding a new
        data source.

        Otherwise, adding new data source may lead to upsert failures visible as
        bad request

        containing message "No DataSource was provided for the given Business
        Partners

        and the storage has more than one attached to it.".
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataSourceUpserts'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSourceUpsertsResult'
          description: OK
    post:
      parameters: []
      tags:
        - Business Partner Storages
      summary: Create Data Source
      description: >
        Create a new data source. Max 100 data sources are allowed.


        Warn: If you have an integration with one data source, please check if

        data source id is included in the upsert request before adding a new
        data source.

        Otherwise, adding new data source may lead to upsert failures visible as
        bad request

        containing message "No DataSource was provided for the given Business
        Partners

        and the storage has more than one attached to it.".


        In case data source is created within DATA_MIRROR and does not have
        `dataMapperDefinitionId`

        or `dataTransformationDefinitionId` filled, `dataMapperDefinitionId` is
        set to `default`.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataSourceCreate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSourceParam'
          description: OK
        '400':
          description: Bad Request
  /storages/{storageId}/datasources/{dataSourceId}:
    parameters:
      - name: storageId
        description: Unique ID of the Business Partner storage.
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
      - name: dataSourceId
        description: Filter by specified Data Source ID.
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
    put:
      tags:
        - Business Partner Storages
      summary: Update Data Source
      description: Update a Data Source.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataSourceUpdate'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSourceUpdateResult'
        '400':
          description: Bad Request
    delete:
      tags:
        - Business Partner Storages
      summary: Delete Data Source
      description: >
        Delete a data source and its dependencies:

        * Business Partners from a storage,

        * update monitors, data monitors and sharing scopes for that data source
        are adjusted (data source is removed from

        the data sources list of a resource and resource is removed if data
        source was the only one assigned).
      parameters: []
      responses:
        '200':
          description: OK
  /storages/{storageId}/datasources/{dataSourceId}/clear:
    parameters:
      - $ref: '#/components/parameters/storageId'
      - $ref: '#/components/parameters/dataSourceId'
    post:
      x-wsdl: true
      tags:
        - Business Partner Storages
      summary: Clear Data Source
      description: Clear all Business Partners of a data source.
      parameters: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnersDeleteResult'
  /storages/{storageId}/datasources/{dataSourceId}/copy:
    parameters:
      - $ref: '#/components/parameters/storageId'
      - $ref: '#/components/parameters/dataSourceId'
    post:
      tags:
        - Business Partner Storages
      summary: Copy Data Source
      description: Copy a data source between storages.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessPartnersCopyJobCreate'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnersCopyJob'
  /storages/{storageId}/datasources/{dataSourceId}/copy/{jobId}:
    parameters:
      - $ref: '#/components/parameters/storageId'
      - $ref: '#/components/parameters/dataSourceId'
      - name: jobId
        description: Unique identifier of a Job.
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/JobId'
    get:
      tags:
        - Business Partner Storages
      summary: Poll Copy Data Source Job Status
      description: Allows polling the status of copy data source job
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnersCopyJob'
  /storages/{storageId}/businesspartners/delete:
    post:
      x-wsdl: true
      tags:
        - Business Partners
      summary: Delete Business Partners
      description: >
        Delete batches of Business Partners by ID or a combination of DataSource
        and External ID. Maximum of 1000 Business Partners are allowed per
        batch.

        In case only a data source is provided in the request, all Business
        Partners related to this data source will be deleted, but the data
        source itself

        will not be deleted.
      parameters:
        - name: storageId
          description: Unique identifier of the Storage.
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/BusinessPartnerStorageId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessPartnersDeleteRequest'
            examples:
              Example1:
                summary: Delete Business Partner Based on External Id
                value:
                  dataSource: YOUR_DATASOURCE_ID
                  businessPartners:
                    - externalId: BP_EXTERNAL_ID
                  featuresOn:
                    - DELETE_BY_EXTERNAL_ID
              Example2:
                summary: Full request body
                value:
                  dataSource: string
                  businessPartners:
                    - id: string
                      externalId: string
                      dataSource: string
                  featuresOn:
                    - DELETE_BY_EXTERNAL_ID
        required: true
        description: cmd
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnersDeleteResult'
          description: OK
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /storages/{storageId}/businesspartners/toggleUpdateMonitoring:
    parameters:
      - name: storageId
        description: Unique identifier of the Storage.
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
    put:
      tags:
        - Business Partners
      summary: Toggle Business Partners Update Monitoring
      description: >
        To toggle update monitoring on multiple BusinessPartners, the permission
        can be changed

        via a list of Business Partners, identified by their ID.


        After the job is finished, the following actions are taken for Business
        Partners which match the businessPartnerIds criteria:

        * businessPartner.updateMonitoring fields takes a value of
        ToggleUpdateMonitoringJobRequest#enable

        * if enable is true then:
          * an attempt is taken to find Business Partner in all configured [update monitors for non-commercial reference data sources](https://developer.cdq.com/reference-docs/data-exchange/V5/tag/Data-Monitors/paths/~1v2~1storages~1%7BstorageId%7D~1datamonitors~1%7BdataMonitorId%7D/put/) and links are created if matches are found via defined [linkage strategies](https://meta.cdq.com/Feature/Business_Partner_Update_Monitoring)
          * if the storage has UPDATES feature activated, updates for linked Business Partners from non-commercial reference data sources are propagated to [Business Partner updates](https:/https://developer.cdq.com/reference-docs/data-exchange/V5/tag/Business-Partners/paths/~1v5~1storages~1%7BstorageId%7D~1businesspartners~1updates/get/)
        * if enable is false then:
          * all existing links of a Business Partner to Business Partners in non-commercial reference data sources are removed
          * updates are no more propagated for this Business Partner
          * linkage is not performed for any non-commercial reference data source

        For toggling a complete Data Source or for a certain Country of a Data
        Source,

        please go to [Start Toggle Update Monitoring
        Job](https://developer.cdq.com/reference-docs/data-exchange/V5/tag/Business-Partners/paths/~1jobs~1toggleUpdateMonitoringJobs/post/).
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ToggleUpdateMonitoringRequest'
        required: true
      responses:
        '204':
          description: OK
  /jobs/toggleUpdateMonitoringJobs:
    post:
      x-wsdl: false
      tags:
        - Business Partners
      summary: Start a Toggle Update Monitoring Job
      description: >
        To toggle update monitoring on multiple BusinessPartners, the permission
        can be changed in two ways:


        1. A complete Data Source identified by the parameter 'dataSourceId'

        2. Or for a certain Country of a Data Source. This requires both
        parameters 'dataSourceId' and 'countryShortName' to be set


        After the job is finished, the following actions are taken for Business
        Partners which match the dataSourceId and countryShortName criteria:

        * businessPartner.updateMonitoring fields takes a value of
        ToggleUpdateMonitoringJobRequest#enable

        * if enable is true then:
          * an attempt is taken to find Business Partner in all configured [update monitors for non-commercial reference data sources](https://developer.cdq.com/reference-docs/data-exchange/V5/tag/Data-Monitors/paths/~1v2~1storages~1%7BstorageId%7D~1datamonitors~1%7BdataMonitorId%7D/put/) and links are created if matches are found via defined [linkage strategies](https://meta.cdq.com/Feature/Business_Partner_Update_Monitoring)
          * if the storage has UPDATES feature activated, updates for linked Business Partners from non-commercial reference data sources are propagated to [Business Partner updates](https://developer.cdq.com/reference-docs/data-exchange/V5/tag/Business-Partners/paths/~1v5~1storages~1%7BstorageId%7D~1businesspartners~1updates/get/)
        * if enable is false then:
          * all existing links of a Business Partner to Business Partners in non-commercial reference data sources are removed
          * updates are no more propagated for this Business Partner
          * linkage is not performed for any non-commercial reference data source

        For toggling via a list of Business Partners, identified by their ID,
        please go to [Toggle Update Monitoring of Business
        Partners](https://developer.cdq.com/reference-docs/data-exchange/V5/tag/Business-Partners/paths/~1jobs~1toggleUpdateMonitoringJobs/post/).
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ToggleUpdateMonitoringJobRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ToggleUpdateMonitoringJob'
        '400':
          $ref: '#/components/responses/400_BadRequest'
  /jobs/toggleUpdateMonitoringJobs/{jobId}:
    get:
      x-wsdl: false
      tags:
        - Business Partners
      summary: Poll Toggle Update Monitoring Job
      description: Poll endpoint for a job created in POST `toggleUpdateMonitoringJobs`.
      parameters:
        - name: jobId
          description: Unique identifier of a job.
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/JobId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ToggleUpdateMonitoringJobResult'
  /updatemonitors/datasources:
    get:
      tags:
        - Business Partner Storages
      summary: List Update Monitors' Data Sources
      deprecated: true
      description: List all data sources available for update monitoring.
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateMonitorDataSourcesResult'
          description: OK
  /jobs/importjobs:
    post:
      x-wsdl: true
      tags:
        - Data Import
      summary: Start Import Job
      description: >
        To start importing a file into a storage, use the following request.


        ```

        POST
        https://api.corporate-data-league.ch/data-exchange/rest/jobs/importjobs
          ?file=@{YOUR FILE}
          ?storageId={YOUR STORAGE ID}
          ?dataSource={YOUR DATASOURCE ID}
        ```


        Fields (cells) in a file, that contain a special character (comma,
        semicolon, CR, LF, or double quote), must be "escaped" by enclosing them
        in double quotes. Header names can not contain any dot.


        In order to successfully perform file upload use file upload for `files`
        up to 10MB or Upload via Upload Request approach for `files` larger than
        10MB. `file` and `url` are not allowed to be present together.


        Use one of the below instructions for your case:

        1) File size < 10MB : [File
        Upload](https://developer.cdq.com/documentation/instructions/uploading-cvs-xls-data/)

        2) File size > 10MB : [Request
        Upload](https://developer.cdq.com/documentation/instructions/url-upload/)


        Including this sample CSV file in the default configuration.


        ```

        Customer Number;City

        123;St. Gallen

        ```


        Supported columns (matched by ignoring letter case) with their mappings
        are the following:


        | Column Name | Target Path in the latest Business Partner Model | Wiki
        Page of Attribute in CDQ Data Model |

        | ------- | -------- | -------- |

        | CUSTOMER NUMBER | $.externalId | [Business Partner External
        ID](https://meta.cdq.com/Business_partner/external_id) |

        | VENDOR NUMBER | $.externalId when `CUSTOMER NUMBER` is not available |
        [Business Partner External
        ID](https://meta.cdq.com/Business_partner/external_id) |

        | NAME | $.names\[0\].value, $.names\[0\].type.technicalKey =
        [LOCAL](https://meta.cdq.com/Business_partner/name/type/local) |
        [Business Partner Name
        Value](https://meta.cdq.com/Business_partner/name/value) |

        | TAX NUMBER 1 | $.identifiers\[identifierId\].value in identifierId of
        `TAX NUMBER 1 TYPE` if exists, otherwise, new identifier of
        [STCD1](https://meta.cdq.com/Data_source/SAP.FLAT/data_model/RECORD/STCD1)
        type mapping, applied for `COUNTRY` | [Identifier
        Value](https://meta.cdq.com/Business_partner/identifier/value) |

        | TAX NUMBER 1 TYPE | $.identifiers\[identifierId\].type | [Identifier
        Type](https://meta.cdq.com/Business_partner/identifier/type) |

        | TAX NUMBER 2 | $.identifiers\[identifierId\].value in identifierId of
        `TAX NUMBER 2 TYPE` if exists, otherwise, new identifier of
        [STCD2](https://meta.cdq.com/Data_source/SAP.FLAT/data_model/RECORD/STCD2)
        type mapping, applied for `COUNTRY` | [Identifier
        Value](https://meta.cdq.com/Business_partner/identifier/value) |

        | TAX NUMBER 2 TYPE | $.identifiers\[identifierId\].type | [Identifier
        Type](https://meta.cdq.com/Business_partner/identifier/type) |

        | TAX NUMBER 3 | $.identifiers\[identifierId\].value in identifierId of
        `TAX NUMBER 3 TYPE` if exists, otherwise, new identifier of
        [STCD3](https://meta.cdq.com/Data_source/SAP.FLAT/data_model/RECORD/STCD3)
        type mapping, applied for `COUNTRY` | [Identifier
        Value](https://meta.cdq.com/Business_partner/identifier/value) |

        | TAX NUMBER 3 TYPE | $.identifiers\[identifierId\].type | [Identifier
        Type](https://meta.cdq.com/Business_partner/identifier/type) |

        | TAX NUMBER 4 | $.identifiers\[identifierId\].value in identifierId of
        `TAX NUMBER 4 TYPE` if exists, otherwise, new identifier of
        [STCD4](https://meta.cdq.com/Data_source/SAP.FLAT/data_model/RECORD/STCD4)
        type mapping, applied for `COUNTRY` | [Identifier
        Value](https://meta.cdq.com/Business_partner/identifier/value) |

        | TAX NUMBER 4 TYPE | $.identifiers\[identifierId\].type | [Identifier
        Type](https://meta.cdq.com/Business_partner/identifier/type) |

        | TAX NUMBER 5 | $.identifiers\[identifierId\].value in identifierId of
        `TAX NUMBER 5 TYPE` if exists, otherwise, new identifier of
        [STCD5](https://meta.cdq.com/Data_source/SAP.FLAT/data_model/RECORD/STCD5)
        type mapping, applied for `COUNTRY` | [Identifier
        Value](https://meta.cdq.com/Business_partner/identifier/value) |

        | TAX NUMBER 5 TYPE | $.identifiers\[identifierId\].type | [Identifier
        Type](https://meta.cdq.com/Business_partner/identifier/type) |

        | VAT NUMBER | $.identifiers\[identifierId\].value in identifierId of
        `VAT NUMBER TYPE` if exists, otherwise, new identifier of
        [STCEG](https://meta.cdq.com/Data_source/SAP.FLAT/data_model/RECORD/STCEG)
        type mapping, applied for `COUNTRY` | [Identifier
        Value](https://meta.cdq.com/Business_partner/identifier/value) |

        | VAT NUMBER TYPE | $.identifiers\[identifierId\].type | [Identifier
        Type](https://meta.cdq.com/Business_partner/identifier/type) |

        | COUNTRY | address.country.(value, shortName) in $.addresses\[0\] (+ in
        $.addresses\[1\] when `PO BOX` exists for non-France) |
        [Country](https://meta.cdq.com/Address/country) |

        | REGION | address.administrativeAreas\[0\].value in $.addresses\[0\] (+
        in $.addresses\[1\] when `PO BOX` exists for non-France) |
        [Administrative Area
        Value](https://meta.cdq.com/Address/administrative_area/value) |

        | POSTAL CODE | address.postCodes\[0\].value in $.addresses\[0\] (+ in
        $.addresses\[1\] when `PO BOX` exists for non-France) | [Post Code
        Value](https://meta.cdq.com/Address/post_code/value) |

        | CITY | address.localities\[0\].value in $.addresses\[0\] (+ in
        $.addresses\[1\] when `PO BOX` exists for non-France) | [Locality
        Value](https://meta.cdq.com/Address/locality/value) |

        | STREET | address.thoroughfares\[0\].value | [Thoroughfare
        Value](https://meta.cdq.com/Address/thoroughfare/value) |

        | HOUSE NUMBER | address.thoroughfares\[0\].number | [Thoroughfare
        Number](https://meta.cdq.com/Address/thoroughfare/number) |

        | PO BOX | address.postalDeliveryPoints\[0\].value,
        address.postalDeliveryPoints\[0\].type.technicalKey =
        [POST_OFFICE_BOX](https://meta.cdq.com/Address/postal_delivery_point/type/post_office_box)
        in $.addresses\[0\] in
        [France](https://meta.cdq.com/Address/country/FR), in $.addresses\[1\]
        for non-France | https://meta.cdq.com/Business_partner/external_id |



        Alternatively, CUSTOM_DATA_MAPPER feature can be used to enable record
        transformation based on the Data Mapper Definition

        provided either via a `dataMapperDefinitionId` field or assigned to
        provided data source.


        Input file could contain customized columns naming effectively mapped to
        the Business Partner model via data mapper, shown in this sample CSV.


        ```

        MyId;Country;City;Name

        123;CH;St. Gallen;

        124;CH;;Quote "Example"

        "125";"CH";"";"""Quote """"Example""""  """

        ```


        Input file for CUSTOM_DATA_MAPPER feature can also contain only one
        `Record` column with a stringified JSON representation of a record.

        Based on the Data Mapper Definition, data is transformed to the Business
        Partner model.

        In case UPSERT_BY_EXTERNAL_ID feature is used, external ID value needs
        to be included:

        * in a column which name is provided via a `extenalIdColumn` request
        property

        * in the JSON representation in the attribute mapped to externalId via
        data mapper


        Below is the sample CSV file for `Record`-based configuration containing
        external ID column named MyId.


        ```

        MyId,Record

        123,"{""MyId"": ""123"", ""Country"": ""CH"", ""City"": ""St. Gallen""}"

        124,"{""MyId"": ""124"", ""Country"": ""CH"", ""Name"": ""Quote
        \""Example\""""}"

        125,"{""MyId"": ""125"", ""Country"": ""CH"", ""Name"": ""\""Quote
        \""\""Example\""\""  \""""}"

        ```


        The maximum number of columns is 512


        The response is shown below. Use the returned `id` to
        [poll](https://developer.cdq.com/reference-docs/data-exchange/V5/tag/Data-Import/paths/~1jobs~1importjobs~1%7BjobId%7D/get/)
        the import job status.


        ```

        {
            "id" : "{YOUR IMPORT JOB ID}"
            ...
        }

        ```


        These imports, in default import samples, lead to the following Business
        Partners in the storage. The imported rows are represented as
        stringified JSONs.


        ```

        {
           "id" : "{AUTO GENERATED}",
           "externalId" : "123",
           "dataSource": "{YOUR DATASOURCE ID}",
           "record" : "{ \"MyId\" : \"123\", \"Country\" : \"CH\", \"City\" : \"St. Gallen\" }",
           "addresses": [{
              "country": {
                 "shortName": "CH"
              },
              "localities": [{
                 "value": "St. Gallen"
              }]
           }],
           ...
        },

        {
           "id" : "{AUTO GENERATED}",
           "externalId" : "124",
           "dataSource": "{YOUR DATASOURCE ID}",
           "record" : "{ \"MyId\" : \"124\", \"Country\" : \"CH\", \"Name\" : \"Quote \\\"Example\\\"\" }",
           "names": [{
              "value": "Quote \"Example\""
              ...
           }],
           "addresses": [{
              "country": {
                 "shortName": "CH"
              }
           }],
           ...
        },

        {
           "id" : "{AUTO GENERATED}",
           "externalId" : "125",
           "dataSource": "{YOUR DATASOURCE ID}",
           "record" : "{ \"MyId\" : \"125\", \"Country\" : \"CH\", \"Name\" : \"\\\"Quote \\\"\\\"Example\\\"\\\"  \\\"\" }",
           "names": [{
              "value": "\"Quote \"\"Example\"\"  \""
              ...
           }],
           "addresses": [{
              "country": {
                 "shortName": "CH"
              }
           }],
           ...
        }

        ```


        Input file which first 100 data lines except header are corrupted is
        canceled without further processing.


        Importing data to Data Mirror requires using "UPSERT_BY_EXTERNAL_ID"
        feature. Otherwise, Bad Request is reported.
      parameters: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              description: Import Job Request
              properties:
                file:
                  description: >-
                    XLSX or CSV file to be uploaded (SOAP currently only
                    supports CSV). Supports up to 10MB of file size. For the
                    file size greater than 10MB use Upload via Upload Request
                    approach.
                  type: string
                  format: binary
                  example: CH-import.csv
                url:
                  type: string
                  description: >-
                    Url to file which will be used to import data from.
                    Recommended. The file can be uploaded via [File
                    Upload](https://developer.cdq.com/documentation/instructions/uploading-cvs-xls-data/)
                    passing through `url` from the result object.
                  example: customer-uploads/CH-import.csv
                storageId:
                  type: string
                  description: Target storage ID for this import.
                  example: 72d6900fce6b326088f5d9d91049e3e6
                dataSource:
                  $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
                externalIdColumn:
                  type: string
                  description: >-
                    The name of the column which will be mapped to external ID.
                    This is required if feature UPSERT_BY_EXTERNAL_ID is
                    activated.
                  example: BP_EXTERNAL_ID
                dataMapperDefinitionId:
                  type: string
                  description: >-
                    The ID of data mapper to be used to transform the data
                    before importing it. This or a data source is required if
                    feature CUSTOM_DATA_MAPPER is activated. Disabled when
                    CUSTOM_DATA_MAPPER feature is not provided in a request.
                  example: 6400955811c68a034bcef311
                featuresOn:
                  type: array
                  description: List of features to be activated.
                  items:
                    type: string
                    description: Feature to be used on during the Import Job.
                    example: UPSERT_BY_EXTERNAL_ID
                    enum:
                      - ACCEPT_EMPTY_VALUES
                      - UPSERT_BY_EXTERNAL_ID
                      - CUSTOM_DATA_MAPPER
                      - FULL_UPDATE
                      - LAB_USE_QUEUES
                      - LAB_USE_BACKPRESSURE
                    x-enumDescriptions:
                      ACCEPT_EMPTY_VALUES: >-
                        Allows to import empty values to record in Business
                        Partner.
                      UPSERT_BY_EXTERNAL_ID: >-
                        Updates a Business Partners identified by external ID
                        instead of an insert if the external ID is already
                        present in this storage. If this feature is selected,
                        `dataSource` and `externalIdColumn` are mandatory. When
                        selected, id must not be provided in a Business Partner.
                      CUSTOM_DATA_MAPPER: >-
                        Applies data transformation using data mapper identified
                        by `dataMapperDefinitionId` field or fetched from the
                        data source identified by `dataSource` field.
                      FULL_UPDATE: >-
                        Forces the job to delete existing records which are not
                        included in the import file. Records to be updated or to
                        be deleted are identified by external IDs, i.e. not by
                        the internal database IDs. To confirm this
                        understanding, UPSERT_BY_EXTERNAL_ID feature must be
                        activated in addition. When a FULL_UPDATE import job is
                        completed, new records from the import file are created,
                        existing ones are updated by keeping their internal
                        database IDs and their external IDs, and records which
                        are not provided by the file are deleted. If this
                        feature is selected, dataSource and
                        `UPSERT_BY_EXTERNAL_ID` feature are mandatory. Whenever
                        import errors occur then this action is not executed.
              required:
                - storageId
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportJob'
        '400':
          $ref: '#/components/responses/400_BadRequest'
  /jobs/importjobs/{jobId}:
    get:
      x-wsdl: true
      tags:
        - Data Import
      summary: Poll Import Job
      description: Allows polling the status of an Import Job.
      parameters:
        - $ref: '#/components/parameters/skippedStartAfterQueryParam'
        - name: jobId
          description: Unique identifier of a Job.
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/JobId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportJob'
  /technicalreports:
    post:
      x-wsdl: false
      summary: Build Technical Reports
      description: >-
        Validation of the request can be found in the description of
        TechnicalReportsRequest below.
      tags:
        - Analytics
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TechnicalReportsRequest'
        description: TechnicalReportsRequest
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TechnicalReports'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /technicalreports/{id}:
    get:
      x-wsdl: false
      summary: Poll Technical Reports
      description: >-
        Poll Technical Reports by id. The id is returned by the build Technical
        Reports request.
      tags:
        - Analytics
      parameters:
        - name: id
          in: path
          description: ID of the technical reports job.
          example: null
          required: true
          schema:
            $ref: '#/components/schemas/JobId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TechnicalReports'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /files/upload:
    post:
      tags:
        - Files
      summary: Request File Upload
      description: >-
        Create a file in the file storage using the url provided. Maximum
        allowed file size is 5GB.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FileUploadRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileUploadResult'
  /files:
    delete:
      tags:
        - Files
      summary: Request Files Delete
      description: Delete files in the customer-uploads directory using the provided urls.
      parameters:
        - name: url
          description: Url of the file to delete.
          in: query
          required: true
          schema:
            type: array
            description: List of urls to delete.
            minItems: 1
            items:
              type: string
              description: File to delete from customer-uploads/ directory.
              example: dq-chart.png or requestedDirectory/dq-chart.png
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileDeleteResponse'
  /files/resources:
    get:
      tags:
        - Files
      summary: List All Resources
      description: >-
        Returns list of all resources, which are available at the specific url
        path.
      parameters:
        - name: url
          in: query
          description: Path of requested directory for which resources should be listed.
          schema:
            type: string
            example: requestedDirectory/ or requestedDirectory/otherDirectory
        - name: startAfter
          in: query
          description: >-
            Continuation token. Encoded s3 path from which listing resources
            should be started.
          required: false
          schema:
            type: string
            example: >-
              1XUzntG%2FKE%2B5IN08GrJQgKin9OblLzlorehkIs1xlj46yyCktx%2FsZrQeTh2FvBKOLLB%2Fu%2F32Ow%2BRJfLUjMqi6gGGjsAQRPZ4u
        - name: limit
          in: query
          description: Allowed maximum elements.
          required: false
          schema:
            type: integer
            minimum: 1
            format: int32
            default: 300
            example: '200'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourcesListResult'
  /files/download:
    post:
      tags:
        - Files
      summary: Request File Download
      description: Download file from CDQ Cloud.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FileDownloadRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileDownloadResult'
  /datamapperdefinitions:
    post:
      tags:
        - Data Mapping
      summary: Create Data Mapper Definition
      description: >
        Create a Data Mapper Definition which is used to map data (i.e. in the
        format from the database) to the CDQ data model.


        Data mapper definition consists of:

        * `inputMapping` - definition how to map `businessPartner.record` to CDQ
        data model

        * `outputMapping` - definition how to map CDQ data model to the target
        model


        Business partner can be mapped via `businessPartnerAttributeMappings`.

        The following values of [attribute mapping
        rules](https://developer.cdq.com/reference-docs/data-exchange/V5/tag/Data-Mapping/paths/~1datamapperdefinitions/post/#tag/Data-Mapping/paths/~1datamapperdefinitions/post!path=inputMapping/businessPartnerAttributeMappings&t=request):


        - as targetAttributes for inputMapping

        - as sourceAttributes for outputMapping (please remember they are case
        sensitive)


        can be mapped to Business Partner attributes:


        - businessPartner.dataSource

        - businessPartner.externalId

        - businessPartner.disclosed - special attribute. When defined in a
        mapping, takes over the decision for disclosing records in data source
        this Data Mapper Definition is assigned to. When source attribute is
        mapped from record, the mapping takes the value. If the attribute is
        missing, disclosed is set to false.

        - businessPartner.names\[0-10\].value

        - businessPartner.names\[0-10\].shortName

        - businessPartner.names\[0-10\].language

        - businessPartner.names\[0-10\].type

        - businessPartner.names

        - businessPartner.legalForm.name

        - businessPartner.legalForm.categories\[0-4\].technicalKey

        - businessPartner.categories

        - businessPartner.identifiers\[0-49\].value

        - businessPartner.identifiers\[0-49\].type

        - businessPartner.identifiers\[0-49\].issuingBody.name

        - businessPartner.identifiers\[0-49\].issuingBody - mapped to
        issuingBody.technicalKey

        - businessPartner.identifiers\[0-49\].status

        - businessPartner.identifiers

        - businessPartner.externalContext.identifiers\[0-49\].value

        - businessPartner.externalContext.identifiers\[0-49\].type

        - businessPartner.externalContext.identifiers


        The index of typed concepts: names and identifiers, is not a final
        position of concept in the CDQ data model - this is a grouping indicator
        for a set of concept properties.


        In Names mapping, in case none of names is typed
        [LOCAL](https://meta.cdq.com/Business_partner/name/type/local)

        and exists any name with empty type or not filled type.technicalKey, it
        becomes name of type LOCAL.


        Addresses can be mapped via `addressesAttributeMappings`. Address
        receives `id` property coming from an index of the collection of
        AttributeMappingRules.

        The following values of [attribute mapping
        rules](https://developer.cdq.com/reference-docs/data-exchange/V5/tag/Data-Mapping/paths/~1datamapperdefinitions/post/#tag/Data-Mapping/paths/~1datamapperdefinitions/post!path=inputMapping/businessPartnerAttributeMappings&t=request)


        - as targetAttributes for inputMapping

        - as sourceAttributes for outputMapping


        can be mapped to address attributes:


        - address.externalId

        - address.version.language

        - address.version.characterSet

        - address.careOf.value

        - address.identifyingName.value

        - address.country.value

        - address.country.shortName

        - address.administrativeAreas

        - address.administrativeAreas\[0-4\].value

        - address.administrativeAreas\[0-4\].shortName

        - address.administrativeAreas\[0-4\].type

        - address.postCodes

        - address.postCodes\[0-4\].value

        - address.postCodes\[0-4\].type

        - address.localities

        - address.localities\[0-4\].value

        - address.localities\[0-4\].shortName

        - address.localities\[0-4\].type

        - address.thoroughfares

        - address.thoroughfares\[0-4\].value

        - address.thoroughfares\[0-4\].shortName

        - address.thoroughfares\[0-4\].number

        - address.thoroughfares\[0-4\].type

        - address.premises

        - address.premises\[0-4\].value

        - address.premises\[0-4\].shortName

        - address.premises\[0-4\].number

        - address.premises\[0-4\].type

        - address.postalDeliveryPoints

        - address.postalDeliveryPoints\[0-4\].value

        - address.postalDeliveryPoints\[0-4\].shortName

        - address.postalDeliveryPoints\[0-4\].number

        - address.postalDeliveryPoints\[0-4\].type

        - address.geographicCoordinates.latitude

        - address.geographicCoordinates.longitude

        - address.contexts

        - address.contexts\[0-4\]
      parameters: []
      requestBody:
        $ref: '#/components/requestBodies/DataMapperDefinitionRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataMapperDefinition'
    get:
      tags:
        - Data Mapping
      summary: List Data Mapper Definitions
      description: Read the Data Mapper Definition Page.
      parameters:
        - $ref: '#/components/parameters/labelsQueryParam'
        - $ref: '#/components/parameters/sharedWithOrganizationParam'
        - $ref: '#/components/parameters/pageQueryParam'
        - $ref: '#/components/parameters/pageSizeQueryParam'
        - name: sort
          in: query
          description: >
            Defines the attributes to sort by. Supported attributes are 'id' and
            'modifiedAt', separated by comma (,) and the sort direction in front
            of each 

            attribute. '+' means ascending, '-' means descending. If direction
            is not given default sort is ascending.
          schema:
            type: string
            example: '-modifiedAt'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataMapperDefinitionPage'
  /datamapperdefinitions/{id}:
    get:
      tags:
        - Data Mapping
      summary: Read Data Mapper Definition
      description: Read a Data Mapper Definition.
      parameters:
        - name: id
          description: Unique ID of the Data Mapper Definition.
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/DataMapperDefinitionId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataMapperDefinition'
    put:
      tags:
        - Data Mapping
      summary: Update Data Mapper Definition
      description: >-
        Update a Data Mapper Definition. For more information what are the
        allowed Data Mapper values, go to [creation
        endpoint](https://developer.cdq.com/reference-docs/data-exchange/V5/tag/Data-Mapping/paths/~1datamapperdefinitions/post/)
        description.
      parameters:
        - name: id
          description: Unique ID of the Data Mapper Definition.
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/DataMapperDefinitionId'
      requestBody:
        $ref: '#/components/requestBodies/DataMapperDefinitionRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataMapperDefinition'
    delete:
      tags:
        - Data Mapping
      summary: Delete Data Mapper Definition
      description: Delete chosen Data Mapper Definition.
      parameters:
        - name: id
          in: path
          description: Unique ID of the Data Mapper Definition.
          required: true
          schema:
            $ref: '#/components/schemas/DataMapperDefinitionId'
      responses:
        '200':
          description: OK
  /jobs/transformationjobs:
    post:
      tags:
        - Data Transformation
      summary: Start Transformation Job
      description: >-
        Starting a Transformation Job. In case any selected data source does not
        have a `dataMappingDefinition` an API error returned.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransformationJobRequest'
            examples:
              example1:
                summary: Transform HCP/HCO Business Partners
                value:
                  dataSourceId: YOUR_DATA_SOURCE_ID
                  storageId: YOUR_DATA_MIRROR_ID
                  featuresOn:
                    - UPSERT_CHANGES_ONLY
        description: cmd
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransformationJob'
        '400':
          $ref: '#/components/responses/400_BadRequest'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
  /jobs/transformationjobs/{id}:
    get:
      tags:
        - Data Transformation
      summary: Poll Transformation Job
      description: >
        After you have started a  transformation job, you will receive a job id
        in the response.

        ```

        {
          "id" : "<ID>"
        }

        ```


        Use this ID to poll for the status of the job using this endpoint. Once
        the status is FINISHED the transformation is done, and you are able to
        verify the result in your storage.
      parameters:
        - name: id
          in: path
          description: ID of the transformation job.
          required: true
          schema:
            $ref: '#/components/schemas/JobId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransformationJob'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /v2/storages:
    get:
      x-wsdl: true
      tags:
        - Business Partner Storages
      summary: List Storages
      description: List all storages to which user has access to.
      parameters:
        - $ref: '#/components/parameters/startAfterQueryParam'
        - $ref: '#/components/parameters/limitQueryParam'
        - name: label
          in: query
          description: >-
            Filter the result by the given label. Keep in mind that labels are
            case-sensitive.
          required: false
          schema:
            type: string
            example: My Storage
        - name: includeSharedStorages
          in: query
          description: >
            Optionally extend the result with metadata for storages that have
            been shared by other users of your organization.

            Alias for `INCLUDE_SHARED_STORAGES` feature.
          required: false
          schema:
            type: boolean
            default: false
            example: 'true'
        - name: sort
          in: query
          description: >
            Defines the attributes to sort by. Supported attributes are 'id',
            'name' and 'createdAt', separated by comma (,) and the

            sort direction in front of each attribute. '+' means ascending, '-'
            means descending. Default sort, if direction is not given, is
            ascending.
          required: false
          schema:
            type: string
            example: '-createdAt'
        - name: dataMapperDefinitionId
          in: query
          description: Filter the result and Data Sources by Data Mapper Definition ID.
          required: false
          schema:
            type: array
            description: List of Data Mapper Definition IDs.
            items:
              $ref: '#/components/schemas/DataMapperDefinitionId'
        - name: featuresOn
          in: query
          required: false
          description: Features to be activated.
          schema:
            type: array
            items:
              $ref: >-
                #/components/schemas/BusinessPartnerStorageMetadataPageReadFeatureParam
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnerStorageMetadataPage'
    post:
      tags:
        - Business Partner Storages
      summary: Create Storage
      description: >-
        If no data source is provided, a minimal data source (name=default and
        without mapping ID) is attached.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessPartnerStorageRequest'
            examples:
              Example:
                summary: Full example
                value:
                  name: string
                  dataMatchingDefinitionId: string
                  dataSources:
                    - dataSourceName: string
                      dataMapperDefinitionId: string
                  featuresOn:
                    - LOOKUP
                  sharedWithOrganization: false
                  labels:
                    - string
              Tutorial:
                summary: Create a storage
                value:
                  name: dataStorageExample
                  dataSources:
                    - dataSourceName: dataSourceExample
                      dataMapperDefinitionId: default
                  featuresOn:
                    - LOOKUP
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnerStorageMetadata'
        '400':
          $ref: '#/components/responses/400_BadRequest'
  /v2/storages/{storageId}/datamonitors:
    parameters:
      - name: storageId
        description: Unique identifier of the Storage.
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
    get:
      parameters:
        - $ref: '#/components/parameters/startAfterQueryParam'
        - $ref: '#/components/parameters/limitQueryParam'
        - name: sort
          in: query
          description: >
            Defines the attributes to sort by. Supported attribute is
            'modifiedAt'. Sort direction can be specified in front of each 

            attribute. '+' means ascending, '-' means descending. If direction
            is not given default sort is ascending.
          schema:
            type: string
            description: >
              Defines the attributes to sort by. Supported attribute is
              'modifiedAt'. Sort direction can be specified in front of each 

              attribute. '+' means ascending, '-' means descending. If direction
              is not given default sort is ascending.
            default: '-modifiedAt'
            example: '-modifiedAt'
        - name: typeTechnicalKeys
          description: Business Partner type technical keys which should be filtered.
          in: query
          required: false
          schema:
            type: array
            description: List of Data Monitor type Technical Keys.
            items:
              $ref: '#/components/schemas/DataMonitorTypeTechnicalKeyEnum'
        - name: dataSourceId
          in: query
          required: false
          description: Filter by specified Data Source ID.
          schema:
            $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        - name: configurationId
          in: query
          required: false
          description: Filter by specified Configuration ID.
          schema:
            $ref: '#/components/schemas/ConfigurationId'
      tags:
        - Data Monitors
      summary: List Data Monitors
      description: List all Data Monitors of the give storage.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataMonitorsPage'
          description: OK
    post:
      parameters: []
      tags:
        - Data Monitors
      summary: Create Data Monitor
      description: >
        Create a new data monitor.


        Data monitor is a concept for asynchronous processing of data curation
        and data validation.


        Data monitors should be unique by a pair: `dataSources` + `type`.


        Data monitor can be created only for DATA_MIRROR storage, having
        `sharedWithOrganization` set to true.


        Available execution types:
          * TRIGGER - causes reevaluation of data whenever CDQ Business Partner model of your data has changed
                      or whenever linked reference data has changed
          * JOB - reevaluates data every specified period of time.

        Note: creation of data monitor starts background process that is invoked
        for all

        Business Partners from data monitor scope.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataMonitorCreate'
            examples:
              dataMonitor:
                summary: Create an Data Monitor
                value:
                  technicalKey: YOUR_TECHNICAL_KEY
                  dataSources:
                    - id: YOUR_DATA_SOURCE
                  enabled: 'true'
                  configuration:
                    id: ID_OF_AUGMENTATION_CONFIGURATION
                  executions:
                    - type:
                        technicalKey: YOUR_TECHNICAL_KEY
              augmentationMonitor:
                summary: Create an Augmentation Monitor
                value:
                  technicalKey: AUGMENTATION
                  dataSources:
                    - id: YOUR_DATA_SOURCE
                  enabled: 'true'
                  configuration:
                    id: ID_OF_AUGMENTATION_CONFIGURATION
                  executions:
                    - type:
                        technicalKey: TRIGGER
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataMonitor'
          description: OK
  /v2/storages/{storageId}/datamonitors/{dataMonitorId}:
    parameters:
      - name: storageId
        description: Unique identifier of the Storage.
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
      - name: dataMonitorId
        description: Unique ID of a Data Monitor.
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/DataMonitorId'
    put:
      parameters: []
      tags:
        - Data Monitors
      summary: Update Data Monitor
      description: >
        Note: modification of `configuration.id` or set of `dataSources` starts
        background process

        that populates processing log for all Business Partners from data
        monitor scope.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataMonitorUpdate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSourceUpsertsResult'
          description: OK
  /v2/storages/{storageId}/datamonitors/{dataMonitorId}/progress:
    parameters:
      - name: storageId
        description: Unique identifier of the Storage.
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
      - name: dataMonitorId
        description: Unique ID of a Data Monitor.
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/DataMonitorId'
      - name: scope
        description: Scope of data monitor to fetch progress.
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/DataMonitorScopeTechnicalKey'
    get:
      tags:
        - Data Monitors
      summary: Data Monitor Progress
      description: >
        Note: modification of `configuration.id` or set of `dataSources` starts
        background process

        that populates processing log for all Business Partners from data
        monitor scope.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataMonitorProgressResult'
          description: OK
  /v2/storages/{storageId}/datamonitors/refresh:
    parameters:
      - name: storageId
        description: Unique identifier of the Storage.
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
    post:
      parameters: []
      tags:
        - Data Monitors
      summary: Refresh Data Monitors
      description: >
        Refresh Data Monitors. When refreshing data monitor, a reevaluation is
        done

        for all Business Partners from the data monitor scope.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataMonitorRefreshes'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataMonitorRefreshResults'
          description: OK
  /v2/updatemonitors/referencedatasources:
    get:
      tags:
        - Business Partner Storages
      summary: List Update Monitors' Data Sources
      description: List all data sources available for update monitoring.
      parameters:
        - name: featuresOn
          in: query
          required: false
          description: Features to be activated.
          schema:
            type: array
            description: List of Features.
            items:
              $ref: >-
                #/components/schemas/UpdateMonitoringReferenceDataSourcesReadFeatureParam
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateMonitorReferenceDataSourcesResult'
  /v3/storages/{storageId}/businesspartners/updateDisclosure:
    parameters:
      - name: storageId
        description: Unique identifier of the Storage.
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
    post:
      tags:
        - Business Partners
      summary: Update Disclosure
      description: >
        To un-/disclose multiple BusinessPartners, the disclosure can be changed
        in three ways:


        1. A complete data source identified by the parameter 'dataSourceId'
        (deprecated - use Sharing Scopes instead. Still applicable, but can be
        overwritten by Sharing Scopes)

        2. Or for a certain country of a data source. This requires both
        parameters 'dataSourceId' and 'countryCode' to be set (deprecated - use
        Sharing Scopes instead. Still applicable, but can be overwritten by
        Sharing Scopes)

        3. Or a list of Business Partners, identified by their ID. The other
        parameters should be left empty. Note: disclosure set via Business
        Partner ID can be overwritten by creation or deletion of a Sharing
        Scope.


        Any other combination may result in a Bad Request.


        For more details, you can read about [Sharing
        Scopes](https://developer.cdq.com/reference-docs/data-exchange/V5/tag/Business-Partner-Storages/paths/~1v4~1storages~1%7BstorageId%7D~1sharingscopes/post/).
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDisclosureRequest'
        required: true
      responses:
        '200':
          description: OK
  /v3/datamappers/{id}/transformBusinessPartners:
    post:
      deprecated: true
      tags:
        - Data Mappers
      summary: Transform Records
      description: >-
        Use a Data Mapper Definition to transform a list of records into
        Business Partners.
      parameters:
        - name: id
          in: path
          description: ID of the Data Mapper Definition
          required: true
          schema:
            $ref: '#/components/schemas/DataMapperDefinitionId'
      requestBody:
        description: Records.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessPartnersTransformationRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnersTransformationResult'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /v3/datamappers/{id}/transformFields:
    post:
      deprecated: true
      tags:
        - Data Mappers
      summary: Transform Business Partners
      description: >-
        Use a Data Mapper Definition to transform a list of Business Partners
        into key-value lists.
      parameters:
        - name: id
          in: path
          description: ID of the Data Mapper Definition.
          required: true
          schema:
            $ref: '#/components/schemas/DataMapperDefinitionId'
      requestBody:
        description: Records
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FieldsTransformationRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldsTransformationResult'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /v3/datamappers/{id}/transform:
    post:
      deprecated: true
      tags:
        - Data Transformation
      summary: Use Data Mapper Definition
      description: >-
        Use a Data Mapper Definition to transform a list of records into
        Business Partners.
      parameters:
        - name: id
          in: path
          description: ID of the Data Mapper Definition.
          required: true
          schema:
            $ref: '#/components/schemas/DataMapperDefinitionId'
      requestBody:
        description: Records
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransformRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BusinessPartner'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /v4/storages/{storageId}/businesspartners/{id}:
    parameters:
      - name: storageId
        description: Unique identifier of the Storage.
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
    get:
      tags:
        - Business Partners
      summary: Read Business Partner
      description: Read Business Partner by ID.
      parameters:
        - name: id
          description: Unique identifier of the Business Partner.
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/BusinessPartnerId'
        - name: featureOn
          description: Features to be used during the read Business Partner.
          in: query
          required: false
          schema:
            type: array
            description: List of features to be activated.
            items:
              $ref: '#/components/schemas/ReadBusinessPartnerFeatureParam'
        - name: featureOff
          description: Features to be deactivated during the read Business Partner.
          in: query
          required: false
          schema:
            type: array
            description: List of features to be deactivated.
            items:
              $ref: '#/components/schemas/ReadBusinessPartnerFeatureParam'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartner'
  /v4/storages/{storageId}/businesspartners/lookup:
    parameters:
      - name: storageId
        description: Unique identifier of the Storage.
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
    post:
      x-wsdl: true
      tags:
        - Business Partners
      summary: Lookup Business Partner
      description: Lookup a Business Partner in provided storage.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessPartnerLookupRequest'
        required: true
        description: cmd
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnerLookupResult'
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /v4/storages/{storageId}/businesspartners/fetch:
    parameters:
      - name: storageId
        description: Unique identifier of the Storage.
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
    post:
      x-wsdl: false
      tags:
        - Business Partners
      summary: Fetch Business Partner
      description: Fetch a Business Partner from this storage.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FetchBusinessPartnerRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FetchBusinessPartnerResult'
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
  /v4/storages/{storageId}/businesspartners/random:
    parameters:
      - name: storageId
        description: Unique identifier of the Storage.
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
    get:
      x-wsdl: false
      deprecated: true
      tags:
        - Business Partners
      summary: Random Business Partners
      description: Get random Business Partners from this storage.
      parameters:
        - $ref: '#/components/parameters/limitRandomQueryParam'
        - name: dataSource
          in: query
          required: false
          description: >-
            Data Source (name or ID) to be measured during calculating
            statistics. By default, all Data Sources are measured.
          schema:
            $ref: '#/components/schemas/BusinessPartnerDataSource'
        - name: countryCode
          description: >-
            Country code (ISO 3166-1 alpha-2) used to filter the result of
            business partners returned.
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/CountryShortName'
        - name: modifiedBefore
          description: >-
            Return entries which were modified before given data. The given date
            should support ISO-8601 representation.
          in: query
          required: false
          schema:
            type: string
            example: '2025-08-19T06:23:16Z'
        - name: modifiedAfter
          description: >-
            Return entries which were modified after given data. The given date
            should support ISO-8601 representation.
          in: query
          required: false
          schema:
            type: string
            example: '2025-08-19T06:23:16Z'
        - name: featureOn
          description: Features to be used during the fetch Business Partner.
          in: query
          required: false
          schema:
            type: array
            description: List of features to be used.
            items:
              $ref: '#/components/schemas/FetchBusinessPartnerFeatureParam'
        - name: featureOff
          description: Features to be excluded during the fetch Business Partner.
          in: query
          required: false
          schema:
            type: array
            description: List of features to be excluded.
            items:
              $ref: '#/components/schemas/FetchBusinessPartnerFeatureParam'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnerRandomPage'
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
  /v4/datamapperdefinitions/{id}/transformBusinessPartners:
    post:
      tags:
        - Data Mappers
      summary: Transform Records
      description: >-
        Use a Data Mapper Definition to transform a list of records into
        Business Partners.
      parameters:
        - name: id
          in: path
          description: Data Mapper Definition ID.
          required: true
          schema:
            $ref: '#/components/schemas/DataMapperDefinitionId'
      requestBody:
        description: Records
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessPartnersTransformationRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnersTransformationResult'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /v4/datamapperdefinitions/{id}/transformFields:
    post:
      tags:
        - Data Mappers
      summary: Transform Business Partners
      description: >-
        Use a Data Mapper Definition to transform a list of Business Partners
        into key-value lists.
      parameters:
        - name: id
          in: path
          description: Data Mapper Definition ID.
          required: true
          schema:
            $ref: '#/components/schemas/DataMapperDefinitionId'
      requestBody:
        description: Records
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FieldsTransformationRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldsTransformationResult'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /v4/storages/{storageId}/relations:
    parameters:
      - name: storageId
        description: Unique identifier of the Storage.
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
    post:
      tags:
        - Relations
      summary: Initialize Storage relations
      description: Initialize relations in a Business Partner Storage.
      parameters: []
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
    get:
      tags:
        - Relations
      summary: List Relations
      description: Read a page of relations from a Business Partner Storage.
      parameters:
        - $ref: '#/components/parameters/startAfterQueryParam'
        - $ref: '#/components/parameters/limitQueryParam'
        - $ref: '#/components/parameters/relationsReadFeatureOnQueryParam'
        - $ref: '#/components/parameters/relationsReadFeatureOffQueryParam'
        - name: externalId
          description: Business Partner externalIDs.
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/BusinessPartnerExternalId'
        - name: dataSource
          in: query
          required: false
          description: >-
            Data Source (name or ID) to be measured during calculating
            statistics. By default, all Data Sources are measured.
          schema:
            $ref: '#/components/schemas/BusinessPartnerDataSource'
        - name: type
          description: Filter by type.
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/BusinessPartnerRelationTypeTechnicalKey'
        - name: classTechnicalKey
          description: >-
            Filter by class technical key. List of available
            (classes)[https://meta.cdq.com/Business_partner/relation/class].
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/BusinessPartnerRelationClassTechnicalKey'
        - name: endedAfter
          description: Find relations which endedAt is after given date.
          in: query
          required: false
          schema:
            type: string
            example: '2025-08-19T06:23:16Z'
        - name: endedBefore
          description: Find relations which endedAt is before given date.
          in: query
          required: false
          schema:
            type: string
            example: '2025-08-19T06:23:16Z'
        - name: startedAfter
          description: Find relations which startedAt is after given date.
          in: query
          required: false
          schema:
            type: string
            example: '2025-08-19T06:23:16Z'
        - name: startedBefore
          description: Find relations which startedAt is before given date
          in: query
          required: false
          schema:
            type: string
            example: '2025-08-19T06:23:16Z'
        - name: acting
          description: Find relations that are ACTIVE or INACTIVE.
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/RelationsReadActingParam'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnerRelationsPage'
          description: OK
    put:
      tags:
        - Relations
      summary: Upsert Business Partner Relations
      description: >
        Insert or update Business Partner Relations. Relations that are not
        listed in the request are not modified.


        In D&B storages, not listed relations of class [D&B
        Hierarchy](https://meta.cdq.com/Business_partner/relation/class/dnb)

        and one of type
        [https://meta.cdq.com/Business_partner/relation/type/commercial_ultimate](Commercial
        Ultimate) or
        [https://meta.cdq.com/Business_partner/relation/type/domestic_commercial_ultimate](Domestic
        Commercial Ultimate), are marked as INACTIVE.
      parameters: []
      requestBody:
        description: Parameters for Relations Upsert Request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RelationsUpsertRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RelationsUpsertResult'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
  /v4/storages/{storageId}/relations/delete:
    post:
      tags:
        - Relations
      summary: Delete relations
      description: Delete relations from a storage.
      parameters:
        - name: storageId
          description: Unique identifier of the Storage.
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/BusinessPartnerStorageId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessPartnerRelationsDeleteRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnerRelationsDeleteResult'
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /v4/businesspartners/identitylinks:
    get:
      x-wsdl: false
      tags:
        - Subscriptions
      summary: List Links
      description: >-
        Reads a page of links of the Business Partners starting from the
        'startAfter' and with a size of 'limit'.
      parameters:
        - $ref: '#/components/parameters/startAfterQueryParam'
        - $ref: '#/components/parameters/limitQueryParam'
        - name: storageId
          description: Unique identifier of the Storage.
          in: query
          required: true
          schema:
            $ref: '#/components/schemas/BusinessPartnerStorageId'
        - name: referenceDataSource
          description: Reference data source as ALEI prefix of the linked Business Partner.
          in: query
          required: false
          schema:
            type: array
            description: List of Reference Data Sources.
            items:
              type: string
              description: >
                Reference data source as ALEI prefix of the linked Business
                Partner used to filter the result of links returned OR

                in case of link between Business Partners in own data sources,
                string consisting of storageId:dataSourceId.
              example: CDQ.POOL
        - name: businessPartnerId
          description: Business Partner IDs which should be filtered.
          in: query
          required: false
          schema:
            type: array
            description: List of Business Partner IDs.
            items:
              $ref: '#/components/schemas/BusinessPartnerId'
        - name: externalId
          description: Business Partner externalIDs.
          in: query
          required: false
          schema:
            type: array
            description: List of Business Partner externalIDs.
            items:
              $ref: '#/components/schemas/BusinessPartnerExternalId'
        - name: dataSourceId
          description: Filter by specified Data Source ID.
          in: query
          required: false
          schema:
            type: array
            description: List of Data Source IDs.
            items:
              $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        - name: cdqIds
          description: CDQ IDs which should be filtered.
          in: query
          required: false
          schema:
            type: array
            description: List of CDQ IDs.
            items:
              type: string
              description: CDQ ID.
              example: VIES:PL8660001429
        - name: featuresOn
          description: Features to be activated.
          in: query
          schema:
            type: array
            description: List of features to be activated.
            items:
              $ref: >-
                #/components/schemas/BusinessPartnerIdentityLinksReadFeatureParam
        - name: featuresOff
          description: Features to be deactivated.
          in: query
          schema:
            type: array
            description: List of features to be deactivated.
            items:
              $ref: >-
                #/components/schemas/BusinessPartnerIdentityLinksReadFeatureParam
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnerIdentityLinkPage'
  /v4/storages/{storageId}/sharingscopes:
    parameters:
      - name: storageId
        description: Unique identifier of the Storage.
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
    get:
      parameters:
        - $ref: '#/components/parameters/startAfterQueryParam'
        - $ref: '#/components/parameters/limitQueryParam'
        - name: featuresOn
          in: query
          required: false
          description: Features to be activated.
          schema:
            type: array
            description: List of features to be activated.
            items:
              $ref: '#/components/schemas/SharingScopesReadFeatureParam'
      tags:
        - Business Partner Storages
      summary: List Sharing Scopes
      description: List all sharing scopes of the give storage.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharingScopesPage'
          description: OK
    post:
      parameters: []
      tags:
        - Business Partner Storages
      summary: Create Sharing Scope
      description: >
        Create a new sharing scope. Max 100 sharing scopes are allowed.


        When creating sharing scope, all Business Partners from selection scope
        which are covered become disclosed.


        The following table presents the source for disclosed field.


        | Mapping disclosure | Sharing Scope matches | Source for disclosed |

        |---|---|---|

        | true | yes | Mapping disclosure |

        | true | no | Mapping disclosure |

        | false | yes | Sharing Scope |

        | false | no | default: false, otherwise from API request up to V4 |


        When source for disclosed field is Sharing Scope, the value is
        determined only during

        the creation of a Sharing Scope or Business Partner. Any new update of
        Business Partner

        doesn't overwrite the value of disclosed in the Business Partner. To
        change the disclosure 

        of a concrete Business Partner, it has to be [requested
        directly](https://developer.cdq.com/reference-docs/data-exchange/V5/tag/Business-Partners/paths/~1v3~1storages~1%7BstorageId%7D~1businesspartners~1updateDisclosure/post/).
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SharingScopeCreate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharingScope'
              examples:
                Example1:
                  summary: Create Sharing Scope for FR Business Partners
                  value:
                    description: Share Customers From France.
                    dataSources:
                      - id: 648824a691d8d2503d65103e
                    countries:
                      - shortName: FR
                Example2:
                  summary: Create Sharing Scope Template
                  value:
                    description: YOUR_DESCRIPTION.
                    dataSources:
                      - id: YOUR_DATASOURCE_ID
                    countries:
                      - shortName: COUNTRY_CODE
          description: OK
        '400':
          description: Bad Request
  /v4/storages/{storageId}/sharingscopes/delete:
    parameters:
      - name: storageId
        description: Unique identifier of the Storage.
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
    post:
      parameters: []
      tags:
        - Business Partner Storages
      summary: Delete Sharing Scopes
      description: >-
        Delete sharing scopes. When deleting sharing scope, all Business
        Partners from selection scope who are not included in any other sharing
        scopes, become undisclosed.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SharingScopeDeletes'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharingScopeDeleteResults'
          description: OK
  /v4/storages/{storageId}/businesspartners/{businessPartnerId}/profile/tags:
    parameters:
      - name: storageId
        description: Unique identifier of the Storage.
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
      - name: businessPartnerId
        description: Business Partner identifier within a storage.
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
    post:
      parameters: []
      tags:
        - Business Partners
      summary: Create Business Partner Tags
      description: >-
        Allows the creation of Business Partner tags. The tags are created in
        the Business Partner profile.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessPartnerTagCreates'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnerTagCreateResults'
          description: OK
        '400':
          description: Bad Request
  /v4/storages/{storageId}/businesspartners/{businessPartnerId}/profile/tags/delete:
    parameters:
      - name: storageId
        description: Unique identifier of the Storage.
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
      - name: businessPartnerId
        description: Business Partner identifier within a storage.
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
    post:
      parameters: []
      tags:
        - Business Partners
      summary: Delete Business Partner Tags
      description: >-
        Allows the deletion of Business Partner tags. The tags are deleted from
        the Business Partner profile.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessPartnerTagDeletes'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessPartnerTagDeleteResults'
          description: OK
        '400':
          description: Bad Request
components:
  schemas:
    UpdateClassificationRule:
      type: object
      description: |
        Custom rule to be applied to classify the Business Partner.
      required:
        - technicalKey
        - shortDescription
      properties:
        url:
          $ref: '#/components/schemas/UpdateClassificationRuleUrl'
        technicalKey:
          $ref: '#/components/schemas/UpdateClassificationRuleTechnicalKey'
        shortDescription:
          $ref: '#/components/schemas/UpdateClassificationRuleShortDescription'
        targetConcepts:
          type: array
          description: List of target concepts to which this rule applies.
          items:
            $ref: '#/components/schemas/UpdateClassificationRuleTargetConcept'
        conceptFilter:
          type: array
          description: List of concepts to filter by.
          items:
            $ref: '#/components/schemas/UpdateClassificationRuleConceptFilter'
        countryShortNames:
          type: array
          description: List of country short names to apply this rule.
          items:
            $ref: '#/components/schemas/CountryShortName'
        actions:
          type: array
          description: List of actions that this rule applies for.
          items:
            $ref: '#/components/schemas/UpdateActionTechnicalKey'
        ruleType:
          $ref: '#/components/schemas/UpdateClassificationRuleType'
        filter:
          $ref: '#/components/schemas/UpdateClassificationRuleFilter'
        threshold:
          $ref: '#/components/schemas/UpdateClassificationRuleThreshold'
        classification:
          $ref: '#/components/schemas/UpdateClassificationTechnicalKey'
        configuration:
          $ref: '#/components/schemas/UpdateClassificationRuleConfiguration'
        executionScope:
          $ref: '#/components/schemas/UpdateClassificationRuleExecutionScope'
        dataSourceTechnicalKeys:
          type: array
          description: List of data source technical keys to apply this rule.
          items:
            $ref: '#/components/schemas/ProvenanceTechnicalKey'
        dataSourceTechnicalKeysExclusions:
          type: array
          description: List of data source technical keys to exclude from this rule.
          items:
            $ref: '#/components/schemas/ProvenanceTechnicalKey'
    UpdateClassificationRuleUrl:
      type: string
      description: URL to the custom rule.
      example: >-
        http://meta.cdq.com/Feature/data_clinic/update_classification/rule_000035
    UpdateClassificationRuleShortDescription:
      type: string
      description: Short description of the custom rule.
      example: Custom rule for classification
    UpdateClassificationRuleTargetConcept:
      type: string
      description: Target concept to which this rule applies.
      example: NAME
    UpdateClassificationRuleConceptFilter:
      type: string
      description: Concept to filter by.
      example: LOCAL_NAME
    UpdateClassificationRuleType:
      type: string
      description: Type of the custom rule. Can be FILTER or SPECIFIC.
      example: FILTER
    UpdateClassificationRuleFilter:
      type: string
      description: |
        Filter to be applied to the Business Partner. One of:
        - IDENTIFIER_VERIFICATION
        - LEGAL_FORM_DUPLICATE
        - LEGAL_FORM_MATCH
        - LEGAL_FORM_TO_NAMES_MISMATCH
        - REGEX_MATCH
        - REGEX_REPLACEMENT
        - SIMILARITY
        - THOROUGHFARE_MATCH
        - UNALLOWED_NAME_PATTERN
        - US_POST_CODE
        - SPECIAL_KEYWORD
        - MARKED_FOR_DELETION_TAGGED_SIMILARITY
      example: REGEX_MATCH
    UpdateClassificationRuleThreshold:
      type: string
      description: Threshold for the classification rule.
      example: '[0.0 : 0.9)'
    UpdateClassificationRuleConfiguration:
      type: string
      description: Configuration for the classification rule.
      example: '{}'
    UpdateClassificationRuleExecutionScope:
      type: string
      description: >-
        Scope of the classification rule execution. Can be DEFAULT or
        OWN_DATA_SOURCE_MONITORING.
      example: DEFAULT
      default: DEFAULT
    ApiError:
      type: object
      description: Detailed information about API errors.
      properties:
        status:
          $ref: '#/components/schemas/Status'
    Status:
      type: object
      description: Details about status or error of a service
      properties:
        code:
          $ref: '#/components/schemas/HttpStatusCode'
        technicalKey:
          $ref: '#/components/schemas/HttpStatusTechnicalKey'
        details:
          type: array
          items:
            $ref: '#/components/schemas/StatusDetails'
        path:
          $ref: '#/components/schemas/HttpPath'
        timestamp:
          $ref: '#/components/schemas/StatusTimestamp'
    StatusDetails:
      type: object
      description: Details about this status or error
      required:
        - id
        - message
      properties:
        id:
          $ref: '#/components/schemas/StatusDetailsMessageId'
        message:
          $ref: '#/components/schemas/StatusDetailsMessage'
        technicalKey:
          $ref: '#/components/schemas/StatusDetailsTechnicalKey'
        jsonPath:
          $ref: '#/components/schemas/JsonPath'
        jsonRecord:
          $ref: '#/components/schemas/JsonObject'
    BusinessPartner:
      type: object
      description: >-
        An organization which has some degree of involvement with another
        organization's business dealings. Typically, a company's business
        partner is another company in the role of a customer, a supplier, a
        vendor, or a service provider. In the CDL context, the business partner
        is the core managed entity. A business partner is globally uniquely
        identifiable by a CDL ID, and all managed information such as addresses,
        documents, and hierarchies is linked to a business partner.
      properties:
        id:
          $ref: '#/components/schemas/BusinessPartnerId'
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        modifiedAt:
          $ref: '#/components/schemas/ModifiedAt'
        externalId:
          $ref: '#/components/schemas/BusinessPartnerExternalId'
        dataSource:
          $ref: '#/components/schemas/BusinessPartnerDataSource'
        disclosed:
          $ref: '#/components/schemas/BusinessPartnerDisclosed'
        updateMonitoring:
          $ref: '#/components/schemas/BusinessPartnerUpdateMonitoring'
        updateCommercialMonitoring:
          type: array
          description: >
            Enabling update commercial monitoring has 2 possibilities:

            * via Data Mapper Definition: include mapping of
            updateCommercialMonitoring in the Data Mapper Definition

            * via direct Business Partner model upload: fill complete Business
            Partner model and `updateCommercialMonitoring`.

            Null/undefined `updateCommercialMonitoring` results in protection of
            this setup from the previous upsert.

            Empty or filled `updateCommercialMonitoring` results in data
            transition that may link or unlink to / from respective

            commercial Reference Data Source


            Note: follow the approach that is currently used in your storage
            integration.
          items:
            $ref: '#/components/schemas/BusinessPartnerUpdateCommercialMonitoring'
        metadata:
          $ref: '#/components/schemas/BusinessPartnerMetadata'
        record:
          $ref: '#/components/schemas/BusinessPartnerRecord'
        names:
          type: array
          description: List of names.
          items:
            $ref: '#/components/schemas/Name'
        legalForm:
          $ref: '#/components/schemas/LegalForm'
        identifiers:
          type: array
          description: List of Identifiers.
          items:
            $ref: '#/components/schemas/Identifier'
        categories:
          type: array
          description: List of Categories.
          items:
            $ref: '#/components/schemas/BusinessPartnerCategory'
        status:
          $ref: '#/components/schemas/BusinessPartnerStatus'
        profile:
          $ref: '#/components/schemas/PartnerProfile'
        relations:
          type: array
          description: >
            List of Relations.

            Insert or update Business Partner Relations.

            Relations that are not listed in the request and start in the
            current business partner, are marked as INACTIVE.


            In D&B storages, only not listed relations of class [D&B
            Hierarchy](https://meta.cdq.com/Business_partner/relation/class/dnb)

            and one of type
            [https://meta.cdq.com/Business_partner/relation/type/direct_legal_relation](Direct
            Legal Relation),
            [https://meta.cdq.com/Business_partner/relation/type/domestic_legal_ultimate_relation](Domestic
            Legal Ultimate Relation) or
            [https://meta.cdq.com/Business_partner/relation/type/global_legal_ultimate_relation](Global
            Legal Ultimate Relation), are marked as INACTIVE.
          items:
            $ref: '#/components/schemas/BusinessPartnerRelation'
        types:
          type: array
          description: List of Types.
          items:
            $ref: '#/components/schemas/BusinessPartnerType'
        addresses:
          type: array
          description: List of Addresses.
          items:
            $ref: '#/components/schemas/Address'
        bankAccounts:
          type: array
          description: List of Bank Accounts.
          items:
            $ref: '#/components/schemas/BankAccount'
        externalContext:
          $ref: '#/components/schemas/ExternalContext'
    Address:
      type: object
      description: >-
        An address provides information about the physical location of a
        business partner. It can be specialized in a certain context(e.g.
        delivery address or invoice address).
      properties:
        id:
          type: string
          description: ID of the address.
          example: '0001'
        externalId:
          $ref: '#/components/schemas/AddressExternalId'
        cdqId:
          $ref: '#/components/schemas/AddressCdqId'
        version:
          $ref: '#/components/schemas/AddressVersion'
        identifyingName:
          $ref: '#/components/schemas/AddressIdentifyingName'
        careOf:
          $ref: '#/components/schemas/CareOf'
        contexts:
          type: array
          description: List of Address Contexts.
          items:
            $ref: '#/components/schemas/AddressContext'
        country:
          $ref: '#/components/schemas/Country'
        administrativeAreas:
          type: array
          description: List of Administrative Areas.
          items:
            $ref: '#/components/schemas/AdministrativeArea'
        postCodes:
          type: array
          description: List of Post Codes.
          items:
            $ref: '#/components/schemas/PostCode'
        localities:
          type: array
          description: List of Localities.
          items:
            $ref: '#/components/schemas/Locality'
        thoroughfares:
          type: array
          description: List of Thoroughfares.
          items:
            $ref: '#/components/schemas/Thoroughfare'
        premises:
          type: array
          description: List of Premises.
          items:
            $ref: '#/components/schemas/Premise'
        postalDeliveryPoints:
          type: array
          description: List of Postal Delivery Points.
          items:
            $ref: '#/components/schemas/PostalDeliveryPoint'
        geographicCoordinates:
          $ref: '#/components/schemas/GeographicCoordinates'
        types:
          type: array
          description: List of Types.
          items:
            $ref: '#/components/schemas/AddressType'
    BusinessPartnerRelation:
      type: object
      description: >-
        Business Partner hierarchy, or any other kind of relation between two
        Business Partner entities. The data about relationships between
        companies come from official, external data sources.
      properties:
        startedAt:
          $ref: '#/components/schemas/BusinessPartnerRelationStartedAt'
        endedAt:
          $ref: '#/components/schemas/BusinessPartnerRelationEndedAt'
        type:
          $ref: '#/components/schemas/BusinessPartnerRelationType'
        class:
          $ref: '#/components/schemas/BusinessPartnerRelationClass'
        startNode:
          $ref: '#/components/schemas/BusinessPartnerRelationNode'
        endNode:
          $ref: '#/components/schemas/BusinessPartnerRelationNode'
        deactivatedAt:
          $ref: '#/components/schemas/BusinessPartnerRelationDeactivatedAt'
    BusinessPartnerMetadata:
      type: object
      description: Information about results of Business Partner processing.
      properties:
        sharingStatus:
          $ref: '#/components/schemas/SharingStatus'
        identityLinks:
          type: array
          description: List of Identity Links.
          items:
            $ref: '#/components/schemas/IdentityLink'
        logResultStatuses:
          type: array
          description: List of Log Result Statuses.
          items:
            $ref: '#/components/schemas/ProcessingLogResultStatus'
        decisionLogResult:
          $ref: '#/components/schemas/DecisionLogResult'
    AdditionalInformationKey:
      type: string
      description: Key of the generic key/value map.
      example: KEY
    AdditionalInformationValue:
      type: string
      description: Value of the generic key/value map.
      example: '1'
    BusinessPartnerUpdatePage:
      type: object
      description: Page for displaying Business Partner Updates.
      properties:
        limit:
          $ref: '#/components/schemas/Limit'
        total:
          $ref: '#/components/schemas/PageTotal'
        startAfter:
          $ref: '#/components/schemas/StartAfter'
        nextStartAfter:
          type: string
          description: |
            Available only when you used USE_NEXT_START_AFTER feature.
            Provides a value to be used as a startAfter in next page request.
          example: '5712566172571652'
        values:
          type: array
          description: List of Business Partner Updates.
          items:
            $ref: '#/components/schemas/BusinessPartnerUpdate'
    BusinessPartnerUpdate:
      type: object
      description: >
        A Business Partner Update comprises a list of Change Sets which belong
        to this Business Partner


        `businessPartner` contains a BusinessPartner model built out of all
        updates.

        `storageBusinessPartner` contains a current Business Partner from the
        storage.
      properties:
        id:
          $ref: '#/components/schemas/BusinessPartnerUpdateId'
        businessPartnerId:
          $ref: '#/components/schemas/BusinessPartnerId'
        externalBusinessPartnerId:
          $ref: '#/components/schemas/BusinessPartnerExternalId'
        updatedBusinessPartner:
          $ref: '#/components/schemas/UpdatedBusinessPartner'
        storageBusinessPartner:
          $ref: '#/components/schemas/BusinessPartner'
    BusinessPartnerUpdateId:
      type: string
      description: ID of the Business Partner Update.
      example: '5712566172571652'
    BusinessPartnerUpdatesFeatureParam:
      type: string
      description: The feature to be activated/deactivated during Business Partner Updates.
      example: FETCH_STORAGE_BUSINESS_PARTNER
      enum:
        - APPLY_CURATION_DECISIONS
        - FETCH_HISTORICAL_UPDATES
        - FETCH_STORAGE_BUSINESS_PARTNER
        - NUMBER_OF_TOTAL
    DataTransformationDefinitionId:
      type: string
      description: Unique identifier for a data transformation definition.
      example: SAP.ODM
    UpdateTagsProfileEnum:
      type: string
      description: Profile for selection of predefined set of update tags.
      example: LEGAL_DATA
      enum:
        - ADDRESS_DATA
        - LEGAL_DATA
        - RELATIONS
        - VAT_DATA
    UpdatedBusinessPartner:
      type: object
      description: >-
        A Business Partner which contains also contextual information about
        applied updates.
      properties:
        id:
          $ref: '#/components/schemas/BusinessPartnerId'
        summary:
          $ref: '#/components/schemas/UpdateSummary'
        names:
          type: array
          items:
            $ref: '#/components/schemas/UpdatedName'
        legalForm:
          $ref: '#/components/schemas/UpdatedLegalForm'
        identifiers:
          type: array
          items:
            $ref: '#/components/schemas/UpdatedIdentifier'
        categories:
          type: array
          items:
            $ref: '#/components/schemas/UpdatedBusinessPartnerCategory'
        status:
          $ref: '#/components/schemas/UpdatedBusinessPartnerStatus'
        addresses:
          type: array
          items:
            $ref: '#/components/schemas/UpdatedAddress'
        externalId:
          $ref: '#/components/schemas/BusinessPartnerExternalId'
        profile:
          $ref: '#/components/schemas/UpdatedPartnerProfile'
        types:
          type: array
          items:
            $ref: '#/components/schemas/UpdatedBusinessPartnerType'
        relations:
          type: array
          items:
            $ref: '#/components/schemas/UpdatedBusinessPartnerRelation'
        jsonRecord:
          $ref: '#/components/schemas/JsonRecord'
        externalContext:
          $ref: '#/components/schemas/UpdatedExternalContext'
    JsonRecord:
      type: object
      description: A JSON representation of the business partner record.
      additionalProperties: true
      example: '{"key":"value"}'
    UpdateSummary:
      type: object
      description: Summarizes the applied updates for easy consumption.
      properties:
        tags:
          type: array
          items:
            $ref: '#/components/schemas/UpdateTag'
        classification:
          $ref: '#/components/schemas/UpdateClassification'
    UpdateAssessment:
      type: object
      description: Details and assessment of an applied update.
      required:
        - action
      properties:
        action:
          $ref: '#/components/schemas/UpdateAction'
        classification:
          $ref: '#/components/schemas/UpdateClassification'
        provenances:
          type: array
          uniqueItems: true
          items:
            $ref: '#/components/schemas/Provenance'
        modifiedAt:
          $ref: '#/components/schemas/ModifiedAt'
        tags:
          type: array
          items:
            $ref: '#/components/schemas/UpdateTag'
    UpdateAction:
      type: object
      description: Type of update action which has been applied.
      properties:
        technicalKey:
          $ref: '#/components/schemas/UpdateActionTechnicalKey'
    UpdateClassification:
      type: object
      description: >
        Gives a user an indicator how "much" the attribute was changed OR how
        important the change was.
      required:
        - technicalKey
      properties:
        technicalKey:
          $ref: '#/components/schemas/UpdateClassificationTechnicalKey'
        reason:
          $ref: '#/components/schemas/UpdateClassificationReason'
    Provenance:
      type: object
      description: >-
        The source of the change or update. Could be the reference data source
        as VIES or Organization.
      properties:
        name:
          $ref: '#/components/schemas/ProvenanceName'
        url:
          $ref: '#/components/schemas/ProvenanceUrl'
        technicalKey:
          $ref: '#/components/schemas/ProvenanceTechnicalKey'
        cdqId:
          $ref: '#/components/schemas/ProvenanceCdqId'
        subscribers:
          $ref: '#/components/schemas/Subscribers'
    UpdatedName:
      type: object
      description: A name which contains also contextual information about applied updates.
      allOf:
        - $ref: '#/components/schemas/Name'
        - type: object
          description: Update assessment for a name.
          properties:
            updateAssessment:
              $ref: '#/components/schemas/NameUpdateAssessment'
    NameUpdateAssessment:
      type: object
      description: Update assessment for a name.
      allOf:
        - $ref: '#/components/schemas/UpdateAssessment'
        - type: object
          description: Name before applied update.
          properties:
            before:
              $ref: '#/components/schemas/Name'
    UpdatedLegalForm:
      type: object
      description: >-
        A legal form which contains also contextual information about applied
        updates.
      allOf:
        - $ref: '#/components/schemas/LegalForm'
        - type: object
          description: Update assessment for a legal form.
          properties:
            updateAssessment:
              $ref: '#/components/schemas/LegalFormUpdateAssessment'
    LegalFormUpdateAssessment:
      type: object
      description: Update assessment for a legal form.
      allOf:
        - $ref: '#/components/schemas/UpdateAssessment'
        - type: object
          description: Legal form before applied update.
          properties:
            before:
              $ref: '#/components/schemas/LegalForm'
    UpdatedIdentifier:
      type: object
      description: >-
        An identifier which contains also contextual information about applied
        updates.
      allOf:
        - $ref: '#/components/schemas/Identifier'
        - type: object
          description: Update assessment for a identifier.
          properties:
            updateAssessment:
              $ref: '#/components/schemas/IdentifierUpdateAssessment'
    IdentifierUpdateAssessment:
      type: object
      description: Update assessment for an identifier.
      allOf:
        - $ref: '#/components/schemas/UpdateAssessment'
        - type: object
          description: Identifier before applied update.
          properties:
            before:
              $ref: '#/components/schemas/Identifier'
    UpdatedBusinessPartnerStatus:
      type: object
      description: >-
        A business partner status which contains also contextual information
        about applied updates.
      allOf:
        - $ref: '#/components/schemas/BusinessPartnerStatus'
        - type: object
          description: Update assessment for a Business Partner status.
          properties:
            updateAssessment:
              $ref: '#/components/schemas/BusinessPartnerStatusUpdateAssessment'
    BusinessPartnerStatusUpdateAssessment:
      type: object
      description: Update assessment for a Business Partner status.
      allOf:
        - $ref: '#/components/schemas/UpdateAssessment'
        - type: object
          description: Business partner status before applied update.
          properties:
            before:
              $ref: '#/components/schemas/BusinessPartnerStatus'
    UpdatedBusinessPartnerRelation:
      type: object
      description: A name which contains also contextual information about applied updates.
      allOf:
        - $ref: '#/components/schemas/BusinessPartnerRelation'
        - type: object
          description: Update assessment for a Business Partner relation.
          properties:
            updateAssessment:
              $ref: '#/components/schemas/BusinessPartnerRelationUpdateAssessment'
    BusinessPartnerRelationUpdateAssessment:
      type: object
      description: Update assessment for a Business Partner relation.
      allOf:
        - $ref: '#/components/schemas/UpdateAssessment'
        - type: object
          description: Name before applied update.
          properties:
            before:
              $ref: '#/components/schemas/BusinessPartnerRelation'
    UpdatedBusinessPartnerCategory:
      type: object
      description: >-
        A business partner category which contains also contextual information
        about applied updates.
      allOf:
        - $ref: '#/components/schemas/BusinessPartnerCategory'
        - type: object
          description: Update assessment for a Business Partner category.
          properties:
            updateAssessment:
              $ref: '#/components/schemas/BusinessPartnerCategoryUpdateAssessment'
    BusinessPartnerCategoryUpdateAssessment:
      type: object
      description: Update assessment for a Business Partner category.
      allOf:
        - $ref: '#/components/schemas/UpdateAssessment'
        - type: object
          description: Business partner category before applied update.
          properties:
            before:
              $ref: '#/components/schemas/BusinessPartnerCategory'
    UpdatedAddress:
      type: object
      description: >-
        An address provides information about the physical location of a
        Business Partner. It can be specialized in a certain context(e.g.
        delivery address or invoice address).
      properties:
        version:
          $ref: '#/components/schemas/AddressVersion'
        identifyingName:
          $ref: '#/components/schemas/AddressIdentifyingName'
        externalId:
          $ref: '#/components/schemas/AddressExternalId'
        metadata:
          $ref: '#/components/schemas/AddressMetadata'
        careOf:
          $ref: '#/components/schemas/CareOf'
        contexts:
          type: array
          items:
            $ref: '#/components/schemas/AddressContext'
        country:
          $ref: '#/components/schemas/UpdatedCountry'
        administrativeAreas:
          type: array
          items:
            $ref: '#/components/schemas/UpdatedAdministrativeArea'
        postCodes:
          type: array
          items:
            $ref: '#/components/schemas/UpdatedPostCode'
        localities:
          type: array
          items:
            $ref: '#/components/schemas/UpdatedLocality'
        thoroughfares:
          type: array
          items:
            $ref: '#/components/schemas/UpdatedThoroughfare'
        premises:
          type: array
          items:
            $ref: '#/components/schemas/UpdatedPremise'
        postalDeliveryPoints:
          type: array
          items:
            $ref: '#/components/schemas/UpdatedPostalDeliveryPoint'
        geographicCoordinates:
          $ref: '#/components/schemas/UpdatedGeographicCoordinates'
        types:
          type: array
          items:
            $ref: '#/components/schemas/AddressType'
    AddressMetadata:
      type: object
      description: Specifies the language and primary data provenance.
      properties:
        language:
          $ref: '#/components/schemas/Language'
    UpdatedAdministrativeArea:
      type: object
      description: >-
        An administrative area which contains also contextual information about
        applied updates.
      allOf:
        - $ref: '#/components/schemas/AdministrativeArea'
        - type: object
          description: Update assessment for an administrative area.
          properties:
            updateAssessment:
              $ref: '#/components/schemas/AdministrativeAreaUpdateAssessment'
    AdministrativeAreaUpdateAssessment:
      type: object
      description: Update assessment for an administrative area.
      allOf:
        - $ref: '#/components/schemas/UpdateAssessment'
        - type: object
          description: Administrative area before applied update.
          properties:
            before:
              $ref: '#/components/schemas/AdministrativeArea'
    UpdatedCountry:
      type: object
      description: >-
        A country which contains also contextual information about applied
        updates.
      allOf:
        - $ref: '#/components/schemas/Country'
        - type: object
          description: Update assessment for a country.
          properties:
            updateAssessment:
              $ref: '#/components/schemas/CountryUpdateAssessment'
    CountryUpdateAssessment:
      type: object
      description: Update assessment for a country.
      allOf:
        - $ref: '#/components/schemas/UpdateAssessment'
        - type: object
          description: Country before applied update.
          properties:
            before:
              $ref: '#/components/schemas/Country'
    UpdatedLocality:
      type: object
      description: >-
        A locality which contains also contextual information about applied
        updates.
      allOf:
        - $ref: '#/components/schemas/Locality'
        - type: object
          description: Update assessment for a locality.
          properties:
            updateAssessment:
              $ref: '#/components/schemas/LocalityUpdateAssessment'
    LocalityUpdateAssessment:
      type: object
      description: Update assessment for a locality.
      allOf:
        - $ref: '#/components/schemas/UpdateAssessment'
        - type: object
          description: Locality before applied update.
          properties:
            before:
              $ref: '#/components/schemas/Locality'
    UpdatedThoroughfare:
      type: object
      description: >-
        A thoroughfare area which contains also contextual information about
        applied updates.
      allOf:
        - $ref: '#/components/schemas/Thoroughfare'
        - type: object
          description: Update assessment for a thoroughfare.
          properties:
            updateAssessment:
              $ref: '#/components/schemas/ThoroughfareUpdateAssessment'
    ThoroughfareUpdateAssessment:
      type: object
      description: Update assessment for a thoroughfare.
      allOf:
        - $ref: '#/components/schemas/UpdateAssessment'
        - type: object
          description: Thoroughfare before applied update.
          properties:
            before:
              $ref: '#/components/schemas/Thoroughfare'
    UpdatedPostCode:
      type: object
      description: >-
        A post code which contains also contextual information about applied
        updates.
      allOf:
        - $ref: '#/components/schemas/PostCode'
        - type: object
          description: Update assessment for a post code.
          properties:
            updateAssessment:
              $ref: '#/components/schemas/PostCodeUpdateAssessment'
    PostCodeUpdateAssessment:
      type: object
      description: Update assessment for a post code.
      allOf:
        - $ref: '#/components/schemas/UpdateAssessment'
        - type: object
          description: Post code before applied update.
          properties:
            before:
              $ref: '#/components/schemas/PostCode'
    UpdatedPremise:
      type: object
      description: >-
        A premise which contains also contextual information about applied
        updates.
      allOf:
        - $ref: '#/components/schemas/Premise'
        - type: object
          description: Update assessment for a premise.
          properties:
            updateAssessment:
              $ref: '#/components/schemas/PremiseUpdateAssessment'
    PremiseUpdateAssessment:
      type: object
      description: Update assessment for a premise.
      allOf:
        - $ref: '#/components/schemas/UpdateAssessment'
        - type: object
          description: Premise before applied update.
          properties:
            before:
              $ref: '#/components/schemas/Premise'
    UpdatedPostalDeliveryPoint:
      type: object
      description: >-
        A postal delivery point which contains also contextual information about
        applied updates.
      allOf:
        - $ref: '#/components/schemas/PostalDeliveryPoint'
        - type: object
          description: Update assessment for a postal delivery point.
          properties:
            updateAssessment:
              $ref: '#/components/schemas/PostalDeliveryPointUpdateAssessment'
    PostalDeliveryPointUpdateAssessment:
      type: object
      description: Update assessment for a postal delivery point.
      allOf:
        - $ref: '#/components/schemas/UpdateAssessment'
        - type: object
          description: Postal delivery point before applied update.
          properties:
            before:
              $ref: '#/components/schemas/PostalDeliveryPoint'
    UpdatedGeographicCoordinates:
      type: object
      description: >-
        Geographic coordinates which contains also contextual information about
        applied updates.
      allOf:
        - $ref: '#/components/schemas/GeographicCoordinates'
        - type: object
          description: Update assessment for geographic coordinates.
          properties:
            updateAssessment:
              $ref: '#/components/schemas/GeographicCoordinatesUpdateAssessment'
    GeographicCoordinatesUpdateAssessment:
      type: object
      description: Update assessment for geographic coordinates.
      allOf:
        - $ref: '#/components/schemas/UpdateAssessment'
        - type: object
          description: Geographic coordinates before applied update.
          properties:
            before:
              $ref: '#/components/schemas/GeographicCoordinates'
    UpdatedPartnerProfile:
      type: object
      description: >-
        A legal form which contains also contextual information about applied
        updates.
      properties:
        minorityIndicator:
          $ref: '#/components/schemas/MinorityIndicator'
        classifications:
          type: array
          description: List of Classifications.
          items:
            $ref: '#/components/schemas/Classification'
        phoneNumbers:
          type: array
          description: List of Phone Numbers.
          items:
            $ref: '#/components/schemas/PhoneNumber'
        websites:
          type: array
          description: List of Websites.
          items:
            $ref: '#/components/schemas/Website'
        contactEmails:
          type: array
          description: List of Contact Emails.
          items:
            $ref: '#/components/schemas/ContactEmail'
        tags:
          type: array
          description: List of Tags.
          maxItems: 30
          items:
            $ref: '#/components/schemas/Tag'
        vatPayerStatus:
          $ref: '#/components/schemas/VatPayerStatus'
        hcpProfile:
          $ref: '#/components/schemas/UpdatedHcpProfile'
    UpdatedHcpProfile:
      type: object
      description: >-
        A legal form which contains also contextual information about applied
        updates.
      properties:
        generalLicense:
          $ref: '#/components/schemas/UpdatedGeneralLicense'
        operationalPermissions:
          type: array
          description: Operational permissions of the Healthcare Professional.
          items:
            $ref: '#/components/schemas/UpdatedOperationalPermission'
    UpdatedGeneralLicense:
      type: object
      description: >-
        A legal form which contains also contextual information about applied
        updates.
      allOf:
        - $ref: '#/components/schemas/GeneralLicense'
        - type: object
          description: Update assessment for a partner profile.
          properties:
            updateAssessment:
              $ref: '#/components/schemas/GeneralLicenseUpdateAssessment'
    GeneralLicenseUpdateAssessment:
      type: object
      description: Update assessment for hcp profile General License.
      allOf:
        - $ref: '#/components/schemas/UpdateAssessment'
        - type: object
          description: Partner profile GeneralLicense before applied update.
          properties:
            before:
              $ref: '#/components/schemas/GeneralLicense'
    UpdatedOperationalPermission:
      type: object
      description: >-
        A legal form which contains also contextual information about applied
        updates.
      allOf:
        - $ref: '#/components/schemas/OperationalPermission'
        - type: object
          description: Update assessment for a partner profile.
          properties:
            updateAssessment:
              $ref: '#/components/schemas/OperationalPermissionUpdateAssessment'
    OperationalPermissionUpdateAssessment:
      type: object
      description: Update assessment for hcp profile General License.
      allOf:
        - $ref: '#/components/schemas/UpdateAssessment'
        - type: object
          description: Partner profile OperationalPermission before applied update.
          properties:
            before:
              $ref: '#/components/schemas/OperationalPermission'
    PartnerProfile:
      description: >-
        Additional documentation can be found
        [here](https://meta.cdq.com/Partner_profile).
      type: object
      properties:
        minorityIndicator:
          $ref: '#/components/schemas/MinorityIndicator'
        classifications:
          type: array
          description: List of Classifications.
          items:
            $ref: '#/components/schemas/Classification'
        phoneNumbers:
          type: array
          description: List of Phone Numbers.
          items:
            $ref: '#/components/schemas/PhoneNumber'
        websites:
          type: array
          description: List of Websites.
          items:
            $ref: '#/components/schemas/Website'
        contactEmails:
          type: array
          description: List of Contact Emails.
          items:
            $ref: '#/components/schemas/ContactEmail'
        tags:
          type: array
          description: List of Tags.
          maxItems: 30
          items:
            $ref: '#/components/schemas/Tag'
        vatPayerStatus:
          $ref: '#/components/schemas/VatPayerStatus'
        hcpProfile:
          $ref: '#/components/schemas/HcpProfile'
    UpdatedBusinessPartnerType:
      type: object
      description: >-
        A business partner type which contains also contextual information about
        applied updates.
      allOf:
        - $ref: '#/components/schemas/BusinessPartnerType'
        - type: object
          description: Update assessment for a Business Partner type.
          properties:
            updateAssessment:
              $ref: '#/components/schemas/BusinessPartnerTypeUpdateAssessment'
    BusinessPartnerTypeUpdateAssessment:
      type: object
      description: Update assessment for a Business Partner type.
      allOf:
        - $ref: '#/components/schemas/UpdateAssessment'
        - type: object
          description: Business partner type before applied update.
          properties:
            before:
              $ref: '#/components/schemas/BusinessPartnerType'
    Subscribers:
      type: integer
      format: int64
      description: Number of subscribers.
      example: '50'
    SeedUpdateGenerateJobCreate:
      type: object
      description: Job for generating seed updates.
      required:
        - referenceDataSource
      properties:
        referenceDataSource:
          $ref: '#/components/schemas/DataSourceTechnicalKey'
        dataSourceIds:
          $ref: '#/components/schemas/StorageDataSourceIds'
        externalIds:
          $ref: '#/components/schemas/BusinessPartnerExternalIds'
        businessPartnerIds:
          $ref: '#/components/schemas/BusinessPartnerIds'
        countryShortName:
          $ref: '#/components/schemas/CountryShortName'
    SeedUpdateGenerateJob:
      type: object
      description: Job for generating seed updates.
      properties:
        id:
          $ref: '#/components/schemas/JobId'
        name:
          $ref: '#/components/schemas/JobName'
        description:
          $ref: '#/components/schemas/JobDescription'
        progress:
          $ref: '#/components/schemas/JobProgress'
        status:
          $ref: '#/components/schemas/schemas-JobStatus'
        statusMessage:
          $ref: '#/components/schemas/JobStatusMessage'
        createdBy:
          $ref: '#/components/schemas/CreatedBy'
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        modifiedAt:
          $ref: '#/components/schemas/ModifiedAt'
        referenceDataSource:
          $ref: '#/components/schemas/DataSourceTechnicalKey'
        dataSourceIds:
          $ref: '#/components/schemas/StorageDataSourceIds'
        externalIds:
          $ref: '#/components/schemas/BusinessPartnerExternalIds'
        businessPartnerIds:
          $ref: '#/components/schemas/BusinessPartnerIds'
        countryShortName:
          $ref: '#/components/schemas/CountryShortName'
    BusinessPartnerIds:
      type: array
      description: List of business partner IDs to be processed.
      items:
        $ref: '#/components/schemas/BusinessPartnerId'
    BusinessPartnerExternalIds:
      type: array
      description: List of business partner external IDs to be processed.
      items:
        $ref: '#/components/schemas/BusinessPartnerExternalId'
    StorageDataSourceIds:
      type: array
      description: List of data source IDs to be processed.
      items:
        $ref: '#/components/schemas/StorageDataSourceId'
    UpdatedExternalContext:
      type: object
      description: >-
        Represents additional context information that is external to the main
        Business Partner data.
      properties:
        identifiers:
          type: array
          description: List of Identifiers.
          items:
            $ref: '#/components/schemas/UpdatedExternalContextIdentifier'
    UpdatedExternalContextIdentifier:
      type: object
      description: >-
        An identifier of the External Context which contains also contextual
        information about applied updates.
      allOf:
        - $ref: '#/components/schemas/ExternalContextIdentifier'
        - type: object
          description: Update assessment for an external context identifier.
          properties:
            updateAssessment:
              $ref: '#/components/schemas/ExternalContextIdentifierUpdateAssessment'
    ExternalContextIdentifierUpdateAssessment:
      type: object
      description: Update assessment for an external context identifier.
      allOf:
        - $ref: '#/components/schemas/UpdateAssessment'
        - type: object
          description: External context identifier before applied update.
          properties:
            before:
              $ref: '#/components/schemas/ExternalContextIdentifier'
    UpdateClassificationConfiguration:
      type: object
      description: Model that allows customization of update classification rules.
      properties:
        updateClassificationRules:
          type: array
          description: >-
            List of update classification rules, each linked to
            customer-provided classification keys.
          items:
            $ref: '#/components/schemas/UpdateClassificationRule'
    ConfigurationVersionNumber:
      type: integer
      description: Version number of the configuration.
      example: 1
    UpdateClassificationRuleSearchResult:
      type: object
      description: Rule for update classification.
      properties:
        technicalKey:
          $ref: '#/components/schemas/UpdateClassificationRuleTechnicalKey'
        classification:
          $ref: '#/components/schemas/UpdateClassificationSearchResult'
    UpdateClassificationRuleTechnicalKey:
      type: string
      description: Unique identifier for the update classification rule.
      example: UPDATE_RULE_000035
    UpdateClassificationSearchResult:
      type: object
      description: Default update classification with reason.
      properties:
        reason:
          $ref: '#/components/schemas/UpdateClassificationReason'
        technicalKey:
          $ref: '#/components/schemas/UpdateClassificationTechnicalKey'
    TransactionId:
      type: string
      description: >-
        ID of the transaction, pass it in subsequent requests to make them part
        of the transaction.
      example: 8e37da1e-ee9d-4ee0-b03d-24a1f89988f2
    TransactionFeatureParam:
      type: string
      description: Feature used to control transaction process.
      example: CREATE_TRANSACTION
      enum:
        - CREATE_TRANSACTION
        - COMMIT_TRANSACTION
      x-enumDescriptions:
        CREATE_TRANSACTION: >-
          Creates a new transaction and makes the current request a part of it.
          By default turned off.
        COMMIT_TRANSACTION: Commit transaction. By default turned off.
    WorkspaceConfigurationSearchResult:
      type: object
      description: Allows to search for and find specific configurations.
      properties:
        id:
          $ref: '#/components/schemas/ConfigurationId'
        name:
          $ref: '#/components/schemas/ConfigurationName'
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        modifiedAt:
          $ref: '#/components/schemas/ModifiedBy'
        createdBy:
          $ref: '#/components/schemas/CreatedBy'
    BusinessPartnerDisclosed:
      type: boolean
      description: >
        A flag to indicate whether the business partner should participate in
        the sharing or not.

        If 'true' this business partner might be used to create a new entry or
        update an existing entry in the

        community pool. Otherwise, it will not be considered for the sharing
        process. For more details, you can

        read about [Sharing
        Scopes](https://developer.cdq.com/reference-docs/data-exchange/V5/tag/Business-Partner-Storages/paths/~1v4~1storages~1%7BstorageId%7D~1sharingscopes/post/).
      example: 'false'
    BusinessPartnerDataSource:
      type: string
      description: >-
        Name or ID of a data source. Reflects the associated external system
        where the record originates from.
      example: '"CUSTOM_DATA_SOURCE" or "648824a691d8d2503d65103e"'
    BusinessPartnerRecord:
      type: string
      description: >
        Stringified JSON of an individual Business Partner record. Characters:
        backslash `\` and double quote `"` must be escaped (respectively: `\\\\`
        and `\"`). Fields containing `.` are unallowed. Maximum size: 15MB.
      example: '{"name": "BUSINESSPARTNER_NAME", ...}'
    Name:
      type: object
      description: The name of a Business Partner.
      properties:
        type:
          $ref: '#/components/schemas/NameType'
        value:
          $ref: '#/components/schemas/NameValue'
        shortName:
          $ref: '#/components/schemas/NameShortName'
        language:
          $ref: '#/components/schemas/Language'
    Identifier:
      type: object
      description: >-
        Identifies a Business Partner in a given context uniquely such as a VAT
        identification number.
      properties:
        type:
          $ref: '#/components/schemas/IdentifierType'
        value:
          $ref: '#/components/schemas/IdentifierValue'
        issuingBody:
          $ref: '#/components/schemas/IssuingBody'
        status:
          $ref: '#/components/schemas/IdentifierStatus'
    Classification:
      type: object
      description: >-
        A business industry or activity classification is a system of
        categorizing businesses and organizations into specific industries or
        activities based on their primary products or services, functions, or
        activities. These classifications are often used by governments, trade
        organizations, and other institutions to collect and analyze data on
        economic activity and to track trends and changes in various sectors.
      properties:
        value:
          $ref: '#/components/schemas/ClassificationValue'
        code:
          $ref: '#/components/schemas/ClassificationCode'
        type:
          $ref: '#/components/schemas/ClassificationType'
    BusinessPartnerStatus:
      type: object
      description: >-
        Describes the status of a business partner with respect to its level of
        activity (e.g. out of business) or legally relevant conditions (e.g. in
        liquidation).
      properties:
        type:
          $ref: '#/components/schemas/BusinessPartnerStatusType'
        officialDenotation:
          $ref: '#/components/schemas/BusinessPartnerStatusOfficialDenotation'
        validFrom:
          $ref: '#/components/schemas/BusinessPartnerStatusValidFrom'
        validUntil:
          $ref: '#/components/schemas/BusinessPartnerStatusValidUntil'
    Country:
      type: object
      description: >-
        Country consisting of the country name and country code (ISO 3166-1
        alpha-2).
      properties:
        shortName:
          $ref: '#/components/schemas/CountryShortName'
        value:
          $ref: '#/components/schemas/CountryValue'
    AdministrativeArea:
      type: object
      description: A top-level geographical or political area division in a country.
      properties:
        value:
          $ref: '#/components/schemas/AdministrativeAreaValue'
        shortName:
          $ref: '#/components/schemas/AdministrativeAreaShortName'
        isoCode:
          $ref: '#/components/schemas/AdministrativeAreaIsoCode'
        type:
          $ref: '#/components/schemas/schemas-AdministrativeAreaType'
        language:
          $ref: '#/components/schemas/Language'
    PostCode:
      type: object
      description: >-
        A country specific code for a certain
        [address](https://meta.cdq.com/Address) component or a combination of
        [address](https://meta.cdq.com/Address) components, e.g.
        [locality](https://meta.cdq.com/Address/locality).
      properties:
        value:
          $ref: '#/components/schemas/PostCodeValue'
        type:
          $ref: '#/components/schemas/PostCodeType'
    Locality:
      type: object
      description: >-
        A locality is a named densely populated area (a place) such as town,
        village, suburb, etc. A locality composes of many individual addresses.
        Many localities exist in an [administrative
        area](https://meta.cdq.com/Address/administrative_area). A locality can
        also have several levels of sub localities.
      properties:
        type:
          $ref: '#/components/schemas/LocalityType'
        shortName:
          $ref: '#/components/schemas/LocalityShortName'
        value:
          $ref: '#/components/schemas/LocalityValue'
        language:
          $ref: '#/components/schemas/Language'
    Thoroughfare:
      type: object
      description: >-
        Details of the access route along which buildings, lots, or land are
        located, such as street, road, channel, crescent, avenue, etc. This also
        includes canals or banks on which houses or boat houses are located
        where people live.
      properties:
        type:
          $ref: '#/components/schemas/ThoroughfareType'
        shortName:
          $ref: '#/components/schemas/ThoroughfareShortName'
        number:
          $ref: '#/components/schemas/ThoroughfareNumber'
        value:
          $ref: '#/components/schemas/ThoroughfareValue'
        name:
          $ref: '#/components/schemas/ThoroughfareName'
        direction:
          $ref: '#/components/schemas/ThoroughfareDirection'
        language:
          $ref: '#/components/schemas/Language'
    Premise:
      type: object
      description: >-
        A premise is a tract of land including its buildings. A premise may have
        several sublevels to precisely identify.
      properties:
        value:
          $ref: '#/components/schemas/PremiseValue'
        shortName:
          $ref: '#/components/schemas/PremiseShortName'
        number:
          $ref: '#/components/schemas/PremiseNumber'
        type:
          $ref: '#/components/schemas/PremiseType'
        language:
          $ref: '#/components/schemas/Language'
    PostalDeliveryPoint:
      type: object
      description: A single mailbox or other place at which postal mail is delivered.
      properties:
        type:
          $ref: '#/components/schemas/PostalDeliveryPointType'
        shortName:
          $ref: '#/components/schemas/PostalDeliveryPointShortName'
        number:
          $ref: '#/components/schemas/PostalDeliveryPointNumber'
        value:
          $ref: '#/components/schemas/PostalDeliveryPointValue'
        language:
          $ref: '#/components/schemas/Language'
    GeographicCoordinates:
      type: object
      description: Decimal geographic coordinates (WGS 84 - reference coordinate system).
      properties:
        latitude:
          $ref: '#/components/schemas/GeographicCoordinatesLatitude'
        longitude:
          $ref: '#/components/schemas/GeographicCoordinatesLongitude'
    BusinessPartnerResults:
      type: object
      deprecated: true
      description: Business Partner Result.
      properties:
        businessPartnerCurationResult:
          $ref: '#/components/schemas/BusinessPartnerCurationResult'
        categorizationResult:
          $ref: '#/components/schemas/CategorizationResult'
        validationResult:
          $ref: '#/components/schemas/ValidationResult'
    BusinessPartnerCurationResult:
      type: object
      description: Result of Business Partner Curation.
      deprecated: true
      properties:
        curatedBusinessPartner:
          $ref: '#/components/schemas/BusinessPartner'
    CategorizationResult:
      type: object
      description: Result of Categorization.
      deprecated: true
      properties:
        categories:
          type: array
          description: List of categories.
          items:
            $ref: '#/components/schemas/Category'
    Category:
      type: object
      description: Category of a Business Partner.
      deprecated: true
      properties:
        categorized:
          type: boolean
          description: >-
            Toggle to indicate whether the Business Partner is categorized or
            not.
          example: 'true'
        key:
          type: string
          description: Key of the category.
          example: CDQ.BP.INDUSTRY
        label:
          type: string
          description: Label of the category.
          example: Industry
        score:
          type: number
          format: float
          description: Score of the category.
          example: '0.8'
    AddressResults:
      type: object
      deprecated: true
      description: >-
        Address Results. No longer supported for new integrations. Use reading
        results endpoint of respective API.
      properties:
        curationResult:
          $ref: '#/components/schemas/AddressCurationResult'
        goldenRecordGenerationResult:
          $ref: '#/components/schemas/GoldenRecordGenerationResult'
        lookupResults:
          $ref: '#/components/schemas/LookupResults'
        validationResult:
          $ref: '#/components/schemas/ValidationResult'
    AddressCurationResult:
      type: object
      description: Result of Address Curation.
      deprecated: true
      properties:
        accuracyIndicator:
          type: integer
          format: int32
          description: Measure used to assess the degree of accuracy in a given context.
          example: '5'
        changes:
          type: array
          description: List of changes.
          items:
            type: string
            description: Change.
            example: Deprecated
        curatedAddress:
          $ref: '#/components/schemas/Address'
        curationLevel:
          $ref: '#/components/schemas/schemas-CurationLevel'
        requestSimilarity:
          $ref: '#/components/schemas/RequestSimilarity'
        response:
          $ref: '#/components/schemas/AddressCurationResponse'
    RequestSimilarity:
      type: object
      description: Request Similarity.
      deprecated: true
      properties:
        geoCoordinates:
          type: boolean
          description: Geo Coordinates.
          example: 'true'
        locality:
          type: number
          format: double
          description: Locality.
          example: '1.0'
        overall:
          type: number
          format: double
          description: Overall.
          example: '1.0'
        postCode:
          type: number
          format: double
          description: Post Code.
          example: '1.0'
        thoroughfare:
          type: number
          format: double
          description: Thoroughfare.
          example: '1.0'
    AddressCurationResponse:
      type: object
      description: Address Curation Response.
      deprecated: true
      properties:
        message:
          type: string
          description: Additional explanations for status - especially for the FAILED case.
          example: Deprecated
        status:
          type: string
          description: Can be OK or FAILED - default is OK (use enum in request objects).
          example: OK
        timestamp:
          $ref: '#/components/schemas/StatusTimestamp'
    GoldenRecordGenerationResult:
      type: object
      description: Result of Golden Record Generation.
      deprecated: true
      properties:
        explanations:
          type: array
          description: List of explanations.
          items:
            type: string
            description: Explanation.
            example: No errors have been found
        goldenRecord:
          $ref: '#/components/schemas/BusinessPartner'
        originalBusinessPartner:
          $ref: '#/components/schemas/BusinessPartner'
        originalDataDefects:
          type: array
          description: List of original data defects.
          items:
            $ref: '#/components/schemas/DataDefect'
        referenceBusinesspartners:
          type: array
          description: List of reference business partners.
          items:
            $ref: '#/components/schemas/MatchingContainer'
        remainingDataDefects:
          type: array
          description: List of remaining data defects.
          items:
            $ref: '#/components/schemas/DataDefect'
    MatchingContainer:
      type: object
      description: Matching Container.
      deprecated: true
      properties:
        businessPartner:
          $ref: '#/components/schemas/BusinessPartner'
        matchScore:
          type: number
          format: double
          description: Match score.
          example: '0.8'
        matchingExplanation:
          type: string
          description: Explanation for matching score value.
          example: >-
            {'BP: [overall: [PL_NIP: 0.89; overall: 0.89;]] A: [overall:
            [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]'}
        matchingSource:
          type: string
          description: Matching source.
          example: DataSource
        subscribed:
          type: boolean
          description: Subscribed.
          example: 'true'
    LookupResults:
      type: object
      description: Lookup Results.
      deprecated: true
      properties:
        lookupMatches:
          type: array
          description: List of lookup matches.
          items:
            $ref: '#/components/schemas/LookupMatch'
    LookupMatch:
      type: object
      description: Lookup Match.
      deprecated: true
      properties:
        address:
          $ref: '#/components/schemas/Address'
        alei:
          type: string
          description: ALEI prefix of reference data source e.g. CH.UIDR
          example: CH.UIDR
        businessPartner:
          $ref: '#/components/schemas/BusinessPartner'
        cdqId:
          type: string
          description: Unique identifier for the Business Partner.
          example: VIES:PL8660001429
        inactive:
          type: boolean
          description: Inactive.
          example: 'true'
        matchingExplanation:
          type: string
          description: Explanation for matching score value.
          example: >-
            {'BP: [overall: [PL_NIP: 0.89; overall: 0.89;]] A: [overall:
            [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]'}
        matchingScore:
          type: string
          description: >-
            Shows numerical value of similarity between Business Partners or
            address stored in the Data Mirror and the Business Partner from the
            request.
          example: '0.9'
        businessPartnerMatchingScore:
          type: number
          format: double
          description: Business partner matching score.
          example: '0.8'
        addressMatchingScore:
          type: number
          format: double
          description: Address matching score.
          example: '0.8'
        responseMetadata:
          $ref: '#/components/schemas/ReferenceResponseMetadata'
        source:
          type: string
          description: Reference data source.
          example: VIES
    ReferenceResponseMetadata:
      type: object
      description: Reference Response Metadata.
      deprecated: true
      properties:
        responseCurated:
          type: boolean
          description: Response parameter informing whether the response was curated.
          example: 'true'
    ValidationResult:
      type: object
      description: Result of Validation.
      deprecated: true
      properties:
        dataDefects:
          type: array
          description: List of Data Defects.
          items:
            $ref: '#/components/schemas/DataDefect'
        fixProposals:
          type: array
          description: List of Fix Proposals.
          items:
            $ref: '#/components/schemas/FixProposal'
    FixProposal:
      type: object
      description: Fix Proposal.
      deprecated: true
      properties:
        addresses:
          type: array
          description: List of Addresses.
          items:
            $ref: '#/components/schemas/Address'
        identifiers:
          type: array
          description: List of Identifiers.
          items:
            $ref: '#/components/schemas/Identifier'
        names:
          type: array
          description: List of Names.
          items:
            $ref: '#/components/schemas/Name'
    DataDefect:
      type: object
      description: Data Defect.
      deprecated: true
      properties:
        attributes:
          type: array
          description: List of Attributes.
          items:
            type: string
            description: Attribute name.
            example: Deprecated
        businessRule:
          type: string
          description: Business rule.
          example: Deprecated
        entity:
          type: string
          description: Entity name.
          example: Deprecated
        errorCode:
          type: integer
          format: int32
          description: Error code.
          example: '0'
        fixProposal:
          type: string
          description: Fix proposal.
          example: Deprecated
        fixProposalJson:
          type: string
          description: Stringified JSON of a fix proposal.
          example: Deprecated
        violationLevel:
          type: string
          description: Violation level.
          example: NO_DEFECT
          enum:
            - NO_DEFECT
            - INFO
            - WARNING
            - ERROR
          x-enumDescriptions:
            NO_DEFECT: No defect.
            INFO: Informational message.
            WARNING: Warning message.
            ERROR: Error message.
        violationMessage:
          type: string
          description: >-
            Detailed description of what has been violated in the applied data
            quality rule.
          example: Business partner misses an optional D-U-N-S number.
    BusinessPartnerStorageRequest:
      type: object
      description: Request for a new Business Partner storage.
      properties:
        name:
          $ref: '#/components/schemas/BusinessPartnerStorageName'
        dataMatchingDefinitionId:
          $ref: '#/components/schemas/DataMatchingDefinitionId'
        dataSources:
          type: array
          description: List of Data Sources.
          items:
            type: object
            description: >-
              A sub-container of Data Storage/Data Mirror. Few data sources can
              have different data, mappings, and data monitors within the same
              data mirror.
            properties:
              dataSourceName:
                $ref: '#/components/schemas/BusinessPartnerStorageDataSourceName'
              dataMapperDefinitionId:
                $ref: '#/components/schemas/DataMapperDefinitionId'
              dataTransformationDefinitionId:
                $ref: '#/components/schemas/DataTransformationDefinitionId'
            required:
              - dataSourceName
        featuresOn:
          type: array
          items:
            type: string
            description: >
              Available features of a storage: * `LOOKUP` - Enables search
              capabilities for the given storage * `SHARING` - Enables storage
              to participate in the CDQ sharing process * `UPDATES` - Enables
              storing and querying of updates for the given storage *
              `DATA_MIRROR` - Defines storage as a Data Mirror. Turns on:
              NEVER_EXPIRE, LOOKUP, UPDATES, SHARING features. SHARING is not
              applied when records are not disclosed. * `HOMELAND` - Defines
              storage as a Homeland Data Mirror. Turns on: DATA_MIRROR feature
              including its features. * `NEVER_EXPIRE` - Specifies whether a
              storage should never expire. Always turned on for `DATA_MIRROR`.
              Caution: don't use too often due to quota limits. * `RELATIONS` -
              Enables storage to contain relations * `TAGS_MANAGED_BY_UPSERT` -
              Tags are accepted from upsert, not via dedicated endpoints.
              Allowed only when storage does not have HOMELAND activated.
            example: LOOKUP
            enum:
              - LOOKUP
              - UPDATES
              - LAB_USE_INDEX_API
              - SHARING
              - DATA_MIRROR
              - HOMELAND
              - NEVER_EXPIRE
              - RELATIONS
              - TAGS_MANAGED_BY_UPSERT
        sharedWithOrganization:
          type: boolean
          default: false
          description: >-
            Indicates if this storage is shared with all users of the same
            organization.
          example: 'false'
        labels:
          type: array
          maxItems: 10
          uniqueItems: true
          items:
            $ref: '#/components/schemas/StorageLabels'
    BusinessPartnerStorageMetadataUpdate:
      type: object
      description: Update of the Business Partner Storage metadata.
      properties:
        name:
          $ref: '#/components/schemas/BusinessPartnerStorageName'
        labels:
          type: array
          description: List of Storages labels.
          maxItems: 10
          uniqueItems: true
          items:
            $ref: '#/components/schemas/StorageLabels'
        dataMatchingDefinitionId:
          $ref: '#/components/schemas/DataMatchingDefinitionId'
        sharedWithOrganization:
          $ref: '#/components/schemas/SharedWithOrganization'
    BusinessPartnerStorageMetadata:
      type: object
      description: Metadata for Business Partner Storage.
      properties:
        id:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        name:
          $ref: '#/components/schemas/BusinessPartnerStorageName'
        eventStoreId:
          $ref: '#/components/schemas/EventStoreId'
        decisionLogId:
          $ref: '#/components/schemas/DecisionLogId'
        domain:
          $ref: '#/components/schemas/Domain'
        organization:
          $ref: '#/components/schemas/OrganizationId'
        user:
          $ref: '#/components/schemas/UserId'
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        expiresAt:
          type: string
          description: >
            Date when storage expires.


            Possible values:

            * a date when a storage expires,

            * NEVER when storage is a Data Mirror or has been created including
            NEVER_EXPIRE feature.


            Expiry date is calculated based on the date of last write operation
            related

            to a storage (upsert of data, update of data sources, executed job)
            plus 6 months,

            refreshed as most 2 weeks before previous storage expiration date.
          example: '2025-08-19T06:23:16Z'
        dataMatchingDefinitionId:
          $ref: '#/components/schemas/DataMatchingDefinitionId'
        dataSources:
          type: array
          description: List of Data Sources.
          items:
            $ref: '#/components/schemas/DataSource'
        dataMonitors:
          type: array
          description: List of data monitors.
          items:
            $ref: '#/components/schemas/DataMonitor'
        features:
          type: object
          description: Features of a storage.
          properties:
            lookup:
              $ref: '#/components/schemas/FeatureStatus'
            updates:
              $ref: '#/components/schemas/FeatureStatus'
            sharing:
              $ref: '#/components/schemas/FeatureStatus'
            neverExpire:
              $ref: '#/components/schemas/FeatureStatus'
            tagsManagedByUpsert:
              $ref: '#/components/schemas/FeatureStatus'
        numberOfCountries:
          $ref: '#/components/schemas/NumberOfCountries'
        numberOfRecords:
          $ref: '#/components/schemas/NumberOfRecords'
        countryStatistics:
          type: array
          items:
            $ref: '#/components/schemas/CountryStatistic'
        originalFileHeader:
          type: array
          description: List of headers used for a modification of metadata.
          items:
            type: string
            description: >-
              Header of the last file that was used to import data into this
              storage.
            example: BusinessPartnerId, Name, Address
        originalFileName:
          $ref: '#/components/schemas/OriginalFileName'
        results:
          $ref: '#/components/schemas/Results'
        status:
          $ref: '#/components/schemas/StorageMetadataStatus'
        statusMessage:
          $ref: '#/components/schemas/StorageMetadataStatusMessage'
        sharedWithOrganization:
          $ref: '#/components/schemas/SharedWithOrganization'
        labels:
          type: array
          description: Labels to categorize the storage.
          maxItems: 10
          uniqueItems: true
          items:
            $ref: '#/components/schemas/StorageLabels'
    NumberOfCountries:
      type: integer
      format: int64
      description: Number of countries in the Business Partner Storage.
      example: '12'
    NumberOfRecords:
      type: integer
      format: int64
      description: Number of records in the Business Partner Storage.
      example: '500'
    OriginalFileName:
      type: string
      description: >-
        Name of the last file that was used to import data into this Business
        Partner Storage.
      example: business-partner.csv
    StorageMetadataStatus:
      type: string
      description: Status of a Business Partner Storage.
      example: FILE_IMPORTED_SUCCESSFULLY
    StorageMetadataStatusMessage:
      type: string
      description: Details related to status.
      example: >-
        BusinessPartner batch could not be upserted into Business Partner
        Storage.
    SharedWithOrganization:
      type: boolean
      description: >-
        Indicates if this Business Partner Storage is shared with all users of
        the same organization
      example: 'true'
    EventStoreId:
      type: string
      description: Internal ID of Event Store.
      example: 72d6900fce6b326123f5d9d91049e3e6
    Domain:
      type: string
      deprecated: true
      description: Domain of a Business Partner Storage.
      example: BusinessPartner
    DataMatchingDefinitionId:
      type: string
      description: >-
        ID of related data matching definition that is used for matching lookup
        candidates for internal lookup of this Business Partner Storage.
      example: 6400955811c68a034bcef311
    DataMapperDefinitionId:
      type: string
      description: >-
        ID of related Data Mapper Definition that is used for mapping data of
        this Business Partner Storage.
      example: 6440dba32b30176c5917b1b7
    Prefix:
      type: string
      description: Additional prefix for data source name.
      example: Custom prefix
    StorageLabels:
      type: string
      description: Label of a Business Partner Storage.
      example: Custom Storage Name
      maxLength: 50
    MappingDisclosure:
      description: >
        Determines whether disclosed field is set via Data Mapper Definition
        (true) or via Sharing Scopes (false). For more details, you can

        read about [Data Mapper
        Definition](https://developer.cdq.com/reference-docs/data-exchange/V5/tag/Data-Mapping/paths/~1datamapperdefinitions/post/)
        and [Sharing
        Scopes](https://developer.cdq.com/reference-docs/data-exchange/V5/tag/Business-Partner-Storages/paths/~1v4~1storages~1%7BstorageId%7D~1sharingscopes/post/)."
      type: boolean
      example: 'true'
    NumberOfPages:
      type: integer
      format: int32
      description: Number of pages.
      example: '10'
    FeatureStatus:
      type: object
      description: Status of a feature.
      properties:
        status:
          $ref: '#/components/schemas/FeatureStatusParam'
    DataSource:
      type: object
      description: >-
        A sub-container of Data Storage/Data Mirror. Few data sources can have
        different data, mappings, and data monitors within the same data mirror.
      nullable: false
      properties:
        id:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        lastUpdatedAt:
          $ref: '#/components/schemas/ModifiedAt'
        name:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceName'
        dataMapperDefinitionId:
          $ref: '#/components/schemas/DataMapperDefinitionId'
        dataTransformationDefinitionId:
          $ref: '#/components/schemas/DataTransformationDefinitionId'
        mappingDisclosure:
          $ref: '#/components/schemas/MappingDisclosure'
    DataSourceParam:
      type: object
      description: >-
        A sub-container of Data Storage/Data Mirror. Few data sources can have
        different data, mappings, and data monitors within the same data mirror.
      nullable: false
      properties:
        id:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        lastUpdatedAt:
          $ref: '#/components/schemas/ModifiedAt'
        name:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceName'
        dataMapperDefinitionId:
          $ref: '#/components/schemas/DataMapperDefinitionId'
        dataTransformationDefinitionId:
          $ref: '#/components/schemas/DataTransformationDefinitionId'
    DataSourceCreate:
      type: object
      description: Create the Data Source.
      nullable: false
      properties:
        name:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceName'
        dataMapperDefinitionId:
          $ref: '#/components/schemas/DataMapperDefinitionId'
        dataTransformationDefinitionId:
          $ref: '#/components/schemas/DataTransformationDefinitionId'
    DataSourceUpdate:
      type: object
      description: >-
        Update Data Source's records with new updates from the reference Data
        Source.
      nullable: false
      properties:
        name:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceName'
        dataMapperDefinitionId:
          $ref: '#/components/schemas/DataMapperDefinitionId'
        dataTransformationDefinitionId:
          $ref: '#/components/schemas/DataTransformationDefinitionId'
    DataSourceUpdateResult:
      type: object
      description: Result report of the Data Source update.
      properties:
        dataSource:
          $ref: '#/components/schemas/DataSourceParam'
        status:
          type: string
          description: |
            * OK - The Data Source has been updated.
            * NOT_FOUND - The Data Source is not found.
          example: OK
    DataSourceUpserts:
      type: object
      description: >-
        Upsert Data Source's records with updates if the record exists in the
        Data Source. Otherwise, the record is inserted.
      required:
        - dataSources
      properties:
        dataSources:
          type: array
          description: List of Data Sources.
          minItems: 1
          maxItems: 100
          items:
            $ref: '#/components/schemas/DataSourceParam'
    DataSourceUpsertsResult:
      type: object
      description: List of Data Source upsert results.
      properties:
        created:
          $ref: '#/components/schemas/UpsertResultCreated'
        updated:
          $ref: '#/components/schemas/UpsertResultUpdated'
        failed:
          $ref: '#/components/schemas/UpsertResultFailed'
    UpsertResultCreated:
      type: integer
      format: int64
      description: Number of created Data Sources for monitoring.
      example: '4'
    UpsertResultUpdated:
      type: integer
      format: int64
      description: Number of updated Data Sources for monitoring.
      example: '0'
    UpsertResultFailed:
      type: integer
      format: int64
      description: Number of failed updates.
      example: '4'
    CountryStatistic:
      type: object
      description: >-
        Stores information about the number of records associated with the
        country.
      properties:
        countryCode:
          $ref: '#/components/schemas/CountryShortName'
        numberOfRecords:
          $ref: '#/components/schemas/NumberOfRecords'
    Results:
      type: object
      description: Results of a Business Partner Storage.
      properties:
        addressCurationReports:
          type: array
          description: List of Address Curation Reports.
          items:
            $ref: '#/components/schemas/Report'
        goldenRecordGenerationReports:
          type: array
          description: List of Golden Record Generation Reports.
          items:
            $ref: '#/components/schemas/Report'
        resultItems:
          type: array
          description: List of Result Items.
          items:
            $ref: '#/components/schemas/ResultItem'
        validationReports:
          type: array
          description: List of Validation Reports.
          items:
            $ref: '#/components/schemas/Report'
    Report:
      type: object
      description: Report of a Business Partner Storage.
      properties:
        creationTimestamp:
          $ref: '#/components/schemas/CreatedAt'
        description:
          type: string
          description: Description of the Report.
          example: Report description
        name:
          type: string
          description: Display Name of the Report.
          example: Report name
        type:
          type: string
          description: Type of the Report.
          example: Report type
        url:
          type: string
          description: URL of the Report.
          example: https://www.cdq.com
    ResultItem:
      type: object
      description: Result Item.
      properties:
        country:
          $ref: '#/components/schemas/CountryShortName'
        label:
          type: string
          description: Label of the Result Item.
          example: Result Item label
        numberOfRecords:
          $ref: '#/components/schemas/NumberOfRecords'
        type:
          type: string
          description: Type of the Result Item.
          example: Result Item type
    BusinessPartnerStorageMetadataPage:
      type: object
      description: Metadata Page for Business Partner Storages.
      properties:
        values:
          type: array
          description: List of Business Partner Storages Metadata Page.
          items:
            $ref: '#/components/schemas/BusinessPartnerStorageMetadata'
        limit:
          $ref: '#/components/schemas/Limit'
        startAfter:
          $ref: '#/components/schemas/StartAfter'
        nextStartAfter:
          $ref: '#/components/schemas/NextStartAfter'
        total:
          $ref: '#/components/schemas/PageTotal'
    BusinessPartnerStorageCount:
      type: object
      description: Number of Business Partner Storages.
      properties:
        organization:
          $ref: '#/components/schemas/BusinessPartnerStorageCountOrganization'
        workspace:
          $ref: '#/components/schemas/BusinessPartnerStorageCountWorkspace'
        user:
          $ref: '#/components/schemas/BusinessPartnerStorageCountUser'
        value:
          $ref: '#/components/schemas/BusinessPartnerStorageCountValue'
    BusinessPartnerStorageCountOrganization:
      type: object
      description: Number of Business Partner Storages in the organization.
      properties:
        id:
          $ref: '#/components/schemas/OrganizationId'
    BusinessPartnerStorageCountWorkspace:
      type: object
      description: Number of Business Partner Storages in the workspace.
      properties:
        id:
          $ref: '#/components/schemas/WorkspaceId'
    BusinessPartnerStorageCountUser:
      type: object
      description: Number of Business Partner Storages for the user.
      properties:
        id:
          $ref: '#/components/schemas/UserId'
    BusinessPartnerStorageCountValue:
      type: integer
      format: int32
      description: Number of Business Partner Storages.
      example: '10'
    BusinessPartnersUpsertRequest:
      type: object
      description: Parameters for Business Partners Upsert.
      required:
        - businessPartners
      properties:
        dataSource:
          $ref: '#/components/schemas/BusinessPartnerDataSource'
        businessPartners:
          type: array
          description: List of Business Partners.
          minItems: 1
          maxItems: 1000
          items:
            $ref: '#/components/schemas/BusinessPartner'
        featuresOn:
          type: array
          description: Features to be activated during the upsert.
          items:
            $ref: '#/components/schemas/UpsertFeatureParam'
        featuresOff:
          type: array
          description: Features to be deactivated during the upsert.
          items:
            $ref: '#/components/schemas/UpsertFeatureParam'
    UpsertFeature:
      type: string
      description: Features to be used during the upsert.
      example: UPSERT_BY_EXTERNAL_ID
    BusinessPartnersUpsertResult:
      type: object
      description: Result of Business Partners Upsert.
      properties:
        numberOfAccepted:
          type: integer
          description: >
            When asynchronous processing activated (ENABLE_ASYNC or
            LAB_USE_QUEUES), then represents number of Business Partners to be
            processed asynchronously.

            When synchronous processing activated, then provides number of
            Business Partners processed.
          example: '10'
        numberOfFailed:
          type: integer
          description: Number of failed inserts.
          example: '10'
        failures:
          type: array
          description: List of failures.
          items:
            $ref: '#/components/schemas/UpsertFailureLog'
        featuresOn:
          type: array
          description: List of features that cna be activated during the upsert.
          items:
            $ref: '#/components/schemas/UpsertFeature'
    UpsertFailureLog:
      type: object
      description: Log of a failed upsert.
      properties:
        id:
          type: string
          description: ID of a failed upsert.
          example: '567326478287468742'
        externalId:
          type: string
          description: >-
            ID of the failed upsert in the external system where the record
            originates from.
          example: LFA1.1234567
        message:
          type: string
          description: Message displayed in the failure log.
          example: This record could not be stored due to timeout.
    BusinessPartnerPage:
      type: object
      description: Page for displaying Business Partners.
      properties:
        startAfter:
          $ref: '#/components/schemas/StartAfter'
        limit:
          $ref: '#/components/schemas/Limit'
        total:
          $ref: '#/components/schemas/PageTotal'
        values:
          type: array
          description: List of Business Partners.
          items:
            $ref: '#/components/schemas/BusinessPartner'
        nextStartAfter:
          type: string
          description: |
            Available only when you used USE_NEXT_START_AFTER feature.
            Provides a value to be used as a startAfter in next page request.
          example: '5712566172571652'
    BusinessPartnersClearResult:
      type: object
      description: >-
        Result of deleting all Business Partners for the Business Partner
        Storage.
      properties:
        numberOfDeletes:
          $ref: '#/components/schemas/NumberOfDeletes'
    BusinessPartnersDeleteRequest:
      type: object
      description: Request for deleting selected business partners for the Data Source.
      properties:
        dataSource:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        businessPartners:
          type: array
          description: List of Business Partners to be deleted.
          maxItems: 1000
          items:
            type: object
            description: Business Partner to be deleted.
            properties:
              id:
                $ref: '#/components/schemas/BusinessPartnerId'
              externalId:
                $ref: '#/components/schemas/BusinessPartnerExternalId'
              dataSource:
                $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        featuresOn:
          type: array
          description: List of features to be used during delete.
          items:
            $ref: '#/components/schemas/DeleteFeatureParam'
    DeleteFeatureParam:
      type: string
      description: Feature to be used during delete.
      example: DELETE_BY_EXTERNAL_ID
      enum:
        - DELETE_BY_EXTERNAL_ID
        - DELETE_BUSINESS_PARTNER_DATA
        - DELETE_LINKS
      x-enumDescriptions:
        DELETE_BY_EXTERNAL_ID: Deletion is done by external ID.
        DELETE_BUSINESS_PARTNER_DATA: Deletion of Business Partner data.
        DELETE_LINKS: Deletion of links.
    BusinessPartnersDeleteResult:
      type: object
      description: Result of deleting selected Business Partners for the Data Source.
      properties:
        numberOfDeletes:
          $ref: '#/components/schemas/NumberOfDeletes'
        numberOfFailures:
          $ref: '#/components/schemas/NumberOfFailures'
        failures:
          type: array
          description: List of failures.
          items:
            $ref: '#/components/schemas/DeleteFailureLog'
    BusinessPartnersCopyJobCreate:
      type: object
      description: Business Partner Copy Job create.
      properties:
        targetStorageId:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
        dataSourceName:
          type: string
          description: New data source name
          example: generated:token
    BusinessPartnersCopyJob:
      type: object
      description: >-
        Business Partner Copy Job is used to initialize copy of a Business
        Partner Data Source.
      properties:
        id:
          $ref: '#/components/schemas/JobId'
        targetStorageId:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
        targetDataSourceId:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        status:
          $ref: '#/components/schemas/JobStatus'
        statusMessage:
          $ref: '#/components/schemas/JobStatusMessage'
    NumberOfDeletes:
      type: integer
      description: Number of deleted Business Partners.
      example: '50'
    NumberOfFailures:
      type: integer
      description: Number of failures during deletion.
      example: '0'
    DeleteFailureLog:
      type: object
      description: >-
        Log of a failed delete operation containing Business Partner ID, Data
        Source ID, external ID and error message.
      properties:
        id:
          $ref: '#/components/schemas/BusinessPartnerId'
        dataSource:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        externalId:
          $ref: '#/components/schemas/BusinessPartnerExternalId'
        message:
          type: string
          description: Error message.
          example: This record could not be stored due to timeout.
    BusinessPartnerResultPatch:
      type: object
      description: Patch for Business Partner Result.
      properties:
        addressResultPatches:
          type: array
          description: List of Address Result Patches.
          items:
            $ref: '#/components/schemas/AddressResultPatch'
        businessPartnerResults:
          $ref: '#/components/schemas/BusinessPartnerResults'
        id:
          $ref: '#/components/schemas/BusinessPartnerId'
    AddressResultPatch:
      type: object
      description: Patch for Address Result.
      properties:
        addressResults:
          $ref: '#/components/schemas/AddressResults'
        id:
          type: string
          minLength: 1
          description: >-
            Unique identifier for the address which was used for the linkage in
            the POOL.
          example: '0'
    BusinessPartnerLookupRequest:
      type: object
      description: Request for Business Partner Lookup.
      properties:
        matchingThreshold:
          $ref: '#/components/schemas/DataMatchingThreshold'
        pageSize:
          $ref: '#/components/schemas/PageSize'
        page:
          $ref: '#/components/schemas/Page'
        dataSources:
          type: array
          description: List of Data Sources.
          items:
            type: string
            description: DataSource ID or name
            example: '"CUSTOM_DATA_SOURCE" or "648824a691d8d2503d65103e"'
        businessPartner:
          $ref: '#/components/schemas/BusinessPartnerLookupParam'
        featuresOn:
          type: array
          description: Features to be used during the fetch Business Partner.
          items:
            $ref: '#/components/schemas/FetchBusinessPartnerFeatureParam'
        featuresOff:
          type: array
          description: Features to be excluded during the fetch Business Partner.
          items:
            $ref: '#/components/schemas/FetchBusinessPartnerFeatureParam'
    BusinessPartnerLookupResult:
      type: object
      description: Result of Business Partner Lookup.
      properties:
        pageSize:
          $ref: '#/components/schemas/PageSize'
        total:
          type: integer
          description: |
            Total number of items which can be paged. 
            Null if Business Partner was not specified.
          example: '67'
        page:
          $ref: '#/components/schemas/Page'
        values:
          type: array
          description: List of matching Business Partners.
          items:
            $ref: '#/components/schemas/BusinessPartnerLookupMatch'
        debugInfo:
          type: object
          description: >-
            This is just a reference implementation how to structure external
            service responses. Usually this should be hidden behind a feature
            `SHOW_DEBUG_INFO`.
          properties:
            features:
              type: array
              description: List of features.
              items:
                type: object
                description: Feature with its status.
                properties:
                  feature:
                    type: string
                    description: Feature to be used in the request.
                    example: TRANSFORM_RECORD
                  active:
                    type: boolean
                    description: Information, whether the feature is activated or not.
                    example: 'true'
            request:
              $ref: '#/components/schemas/BusinessPartnerLookupRequest'
    BusinessPartnerLookupMatch:
      type: object
      description: Business Partner found in the Data Mirror with the match.
      properties:
        businessPartner:
          $ref: '#/components/schemas/BusinessPartner'
        matchingProfile:
          $ref: '#/components/schemas/MatchingProfile'
    LegalForm:
      type: object
      description: >-
        The legal form of a [business partner/type/legal
        entity](https://meta.cdq.com/Business_partner/type/legal_entity) is the
        form it takes in the eyes of the law governing it. The legal form of a
        [company](https://meta.cdq.com/Business_partner) is the general type it
        may legally use to identify itself according to the local, regional,
        national, or international law governing it. This is normally reflected
        in the ending abbreviation after the
        [company](https://meta.cdq.com/Business_partner)'s name (e.g. AG, Inc.,
        LLC, S.A.).
      properties:
        name:
          $ref: '#/components/schemas/LegalFormName'
        url:
          $ref: '#/components/schemas/LegalFormUrl'
        technicalKey:
          $ref: '#/components/schemas/LegalFormTechnicalKey'
        language:
          $ref: '#/components/schemas/Language'
        mainAbbreviation:
          $ref: '#/components/schemas/LegalFormMainAbbreviation'
        categories:
          type: array
          description: List of Legal Form Categories.
          items:
            $ref: '#/components/schemas/LegalFormCategory'
    DataMapperDefinition:
      type: object
      description: Definition of a Data Mapper.
      properties:
        id:
          $ref: '#/components/schemas/DataMapperDefinitionId'
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        createdBy:
          $ref: '#/components/schemas/CreatedBy'
        lastUpdatedAt:
          type: string
          deprecated: true
          description: Deprecated, please use modifiedAt instead.
          example: '2025-08-19T06:23:16Z'
        modifiedAt:
          $ref: '#/components/schemas/ModifiedAt'
        modifiedBy:
          $ref: '#/components/schemas/ModifiedBy'
        creatorUsername:
          type: string
          description: Username of the creator of the Data Mapper Definition.
          example: john.doe
        creatorOrganization:
          type: string
          description: Organization of the creator of the Data Mapper Definition.
          example: cdq
        shareWithOrganization:
          type: boolean
          description: >-
            Toggle to enable that the Data Mapper Definition is shared with the
            whole organization.
          example: 'true'
        labels:
          type: array
          description: List of labels.
          maxItems: 10
          uniqueItems: true
          items:
            $ref: '#/components/schemas/StorageLabels'
        name:
          type: string
          description: Name of the Data Mapper Definition.
          example: Custom name of Data Mapper
        valueMappings:
          type: array
          description: List of Value Mappings.
          items:
            $ref: '#/components/schemas/ValueMapping'
        inputMapping:
          $ref: '#/components/schemas/BusinessPartnerMappingRule'
        outputMapping:
          $ref: '#/components/schemas/BusinessPartnerMappingRule'
    BusinessPartnerMappingRule:
      type: object
      description: Maps a Business Partner data from raw data to CDQ data model.
      properties:
        businessPartnerAttributeMappings:
          type: array
          description: List of Business Partner Attribute Mappings.
          items:
            $ref: '#/components/schemas/AttributeMappingRule'
        addressesAttributeMappings:
          type: array
          description: Maps an address attribute from raw data to CDQ data model.
          items:
            type: array
            description: List of Address Attribute Mappings.
            items:
              $ref: '#/components/schemas/AttributeMappingRule'
    AttributeMappingRule:
      type: object
      description: Maps an attribute from raw data to CDQ data model.
      properties:
        sourceConstant:
          type: string
          description: Assigns a fix value at path defined in targetAttributes.
          example: LOCAL
        sourceAttributes:
          type: array
          description: List of source attributes.
          items:
            type: string
            description: >-
              The input attributes, respectively the paths of these attributes
              in the data source.
            example: Name
        targetAttributes:
          type: array
          description: List of target attributes.
          items:
            type: string
            description: >-
              The target attributes, respectively the paths of these attributes
              in the CDQ data model.
            example: businessPartner.names[0].value
        targetAttributeTypes:
          type: array
          description: List of target attribute types.
          items:
            type: string
            description: >-
              If there is a typified concept, e.g. identifiers, the target type
              can be specified.
            example: LOCAL
        countryScopes:
          type: array
          description: List of country scopes.
          items:
            type: string
            description: >-
              If there is a country scope, e.g. for addresses, the country scope
              can be specified.
            example: DE
        selectionType:
          $ref: '#/components/schemas/SourceSelectionType'
        separationType:
          $ref: '#/components/schemas/SourceSeparationType'
        isMandatoryAttribute:
          type: boolean
          description: |
            Define if the attribute is mandatory or optional.
            If `true`, the attribute is mandatory.
            If `false`, the attribute is optional.
          example: 'true'
        valueMapping:
          type: string
          description: Maps a cons from raw data to CDQ data model.
          example: INTERNATIONAL
        defaultValue:
          type: string
          description: >-
            Defines default values applied for fields, for which no value was
            provided.
          example: GB
        transformations:
          type: array
          description: List of transformations.
          items:
            $ref: '#/components/schemas/Transformation'
          maxItems: 10
    Transformation:
      type: object
      description: >-
        Transformation of the source value. The source value is the value of the
        source attribute.
      properties:
        type:
          $ref: '#/components/schemas/TransformationTypeParam'
        parameters:
          type: array
          description: >-
            Depending on the Transformation Type different parameters can be
            given.
          items:
            $ref: '#/components/schemas/TransformationParameter'
    TransformationParameter:
      type: object
      description: |
        Parameters for the Transformation.
        * `UPPER_CASE` - no parameters
        * `LOWER_CASE` - no parameters
      properties:
        key:
          type: string
          description: Transformation parameter key.
          example: transformationName
        value:
          type: string
          description: Value of the parameter.
          example: lv_locality_transformation
    TransformationTypeParam:
      type: string
      description: Define the Transformation Type.
      example: UPPER_CASE
      enum:
        - UPPER_CASE
        - LOWER_CASE
      x-enumDescriptions:
        UPPER_CASE: Converts the value to upper case.
        LOWER_CASE: Converts the value to lower case.
    SourceSelectionType:
      type: string
      description: Defines how attribute values should be concatenated.
      example: COMMA
      enum:
        - COMMA
        - EMPTY
        - HYPHEN
        - SEMICOLON
        - SPACE
        - XOR
      x-enumDescriptions:
        COMMA: Selects the first value before the first comma.
        EMPTY: Selects the first value before the first empty space.
        HYPHEN: Selects the first value before the first hyphen.
        SEMICOLON: Selects the first value before the first semicolon.
        SPACE: Selects the first value before the first space.
        XOR: >-
          Selects the first value before the first comma, hyphen, semicolon or
          space.
    SourceSeparationType:
      type: string
      description: Define how the source value should be separated.
      example: LENGTH
      enum:
        - LENGTH
      x-enumDescriptions:
        LENGTH: Selects the first value with the given length.
    DataMapperDefinitionRequest:
      type: object
      description: Request to create a new Data Mapper Definition.
      required:
        - name
        - inputMapping
      properties:
        name:
          type: string
          description: Name of the Data Mapper Definition.
          example: Custom Data Mapper Definition
        labels:
          type: array
          description: Labels to categorize the Data Mapper Definition.
          items:
            type: string
            description: Label to categorize the Data Mapper Definition.
            example: Custom Data Mapper Label
        shareWithOrganization:
          type: boolean
          description: >-
            Toggle to enable that the Data Mapper Definition is shared with the
            whole organization.
          example: 'true'
        valueMappings:
          type: array
          description: List of value mappings.
          items:
            $ref: '#/components/schemas/ValueMapping'
        inputMapping:
          $ref: '#/components/schemas/BusinessPartnerMappingRule'
        outputMapping:
          $ref: '#/components/schemas/BusinessPartnerMappingRule'
    ValueMapping:
      type: object
      description: Maps a cons from raw data to CDQ data model.
      properties:
        sourceValue:
          type: string
          description: The source value for a value mapping.
          example: en
        targetValue:
          type: string
          description: The target value for a value mapping.
          example: INTERNATIONAL
        targetAttribute:
          type: string
          description: >-
            The target attribute value (Business Partner or address) in the CDQ
            data model.
          example: address.version.characterSet
    DataMapperDefinitionPage:
      type: object
      description: Page of Data Mapper Definitions details.
      properties:
        numberOfPages:
          $ref: '#/components/schemas/NumberOfPages'
        page:
          $ref: '#/components/schemas/Page'
        pageSize:
          $ref: '#/components/schemas/PageSize'
        total:
          $ref: '#/components/schemas/PageTotal'
        values:
          type: array
          description: List of Data Mapper Definitions.
          items:
            $ref: '#/components/schemas/DataMapperDefinition'
    TransformRequest:
      deprecated: true
      type: object
      description: Request to transform raw data to CDQ data model.
      properties:
        recordsAsJsonString:
          type: array
          description: The records to be transformed as json string.
          items:
            type: string
            description: The record to be transformed as json string.
            example: '{"address": "Musterstrasse 1, 12345 Musterstadt"}'
    ImportJob:
      type: object
      description: >-
        An Import Job is used to import raw data into the Data Mirror. Job is
        executed asynchronously. The result of the Import Job can be retrieved
        by the Job ID.
      properties:
        id:
          $ref: '#/components/schemas/JobId'
        name:
          $ref: '#/components/schemas/JobName'
        description:
          $ref: '#/components/schemas/JobDescription'
        domain:
          $ref: '#/components/schemas/Domain'
        createdBy:
          $ref: '#/components/schemas/CreatedBy'
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        modifiedAt:
          $ref: '#/components/schemas/ModifiedAt'
        progress:
          $ref: '#/components/schemas/JobProgress'
        status:
          $ref: '#/components/schemas/JobStatus'
        statusMessage:
          $ref: '#/components/schemas/JobStatusMessage'
        storageId:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
        dataSource:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        dataMapperDefinitionId:
          $ref: '#/components/schemas/DataMapperDefinitionId'
        dataTransformationDefinitionId:
          $ref: '#/components/schemas/DataTransformationDefinitionId'
        externalIdColumn:
          type: string
          description: >-
            The name of the column which will be mapped to external ID. This is
            required if feature UPSERT_BY_EXTERNAL_ID is activated.
          example: BP_EXTERNAL_ID
        featureOn:
          type: array
          description: List of features which are activated for the Import Job.
          items:
            type: string
            description: Feature activated during the Import Job.
            example: UPSERT_BY_EXTERNAL_ID
        result:
          $ref: '#/components/schemas/ImportJobResult'
    ImportJobResult:
      type: object
      description: The result of the Import Job.
      properties:
        statistics:
          $ref: '#/components/schemas/ImportJobStatistics'
    ImportJobStatistics:
      type: object
      description: The statistics of the Import Job.
      properties:
        numberOfInserts:
          type: integer
          format: int32
          description: Number of inserted Business Partners.
          example: '10'
        numberOfUpdates:
          type: integer
          format: int32
          description: Number of updated Business Partners.
          example: '10'
        numberOfFailed:
          type: integer
          format: int32
          description: Number of failed Business Partners.
          example: '10'
        skipped:
          type: array
          description: List of skipped lines.
          items:
            $ref: '#/components/schemas/CorruptedLineResult'
        skippedStartAfter:
          type: string
          description: The line number of the first skipped line.
          example: '10'
        skippedNextStartAfter:
          type: string
          description: The line number of the next skipped line.
          example: '20'
    CorruptedLineResult:
      type: object
      description: The result of a corrupted line.
      properties:
        line:
          type: integer
          format: int64
          description: The line number of the corrupted line.
          example: '10'
        column:
          type: integer
          format: int32
          description: The column number of the corrupted line.
          example: '10'
    TransformationJob:
      type: object
      description: >
        A Transformation Job is used to transform raw data into CDQ Data Model,
        and it is based on a Data Mapper Definition.

        Job is executed asynchronously. The result of the Transformation Job can
        be retrieved by the Job ID.
      properties:
        id:
          $ref: '#/components/schemas/JobId'
        domain:
          $ref: '#/components/schemas/Domain'
        name:
          $ref: '#/components/schemas/JobName'
        description:
          $ref: '#/components/schemas/JobDescription'
        createdBy:
          $ref: '#/components/schemas/CreatedBy'
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        modifiedAt:
          $ref: '#/components/schemas/ModifiedAt'
        progress:
          $ref: '#/components/schemas/JobProgress'
        status:
          $ref: '#/components/schemas/JobStatus'
        statusMessage:
          type: string
          description: >-
            The status message contains the error message if the transformation
            job failed.
          example: >-
            DataSource [5e2874fb8d2a7400011acee1] has no DataMapperDefinition
            attached and no alternative dataMapperDefinitionId was passed to the
            job
        storageId:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
        dataSourceId:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        dataMapperDefinitionId:
          $ref: '#/components/schemas/DataMapperDefinitionId'
        dataTransformationDefinitionId:
          $ref: '#/components/schemas/DataTransformationDefinitionId'
        featuresOn:
          type: array
          items:
            $ref: '#/components/schemas/TransformationJobFeature'
        result:
          $ref: '#/components/schemas/TransformationJobResult'
    TransformationJobResult:
      type: object
      description: The result of a Transformation Job.
      properties:
        statistics:
          $ref: '#/components/schemas/TransformationJobStatistics'
    TransformationJobStatistics:
      type: object
      description: The statistics of a transformation job.
      properties:
        numberOfRecords:
          $ref: '#/components/schemas/NumberOfRecords'
        numberOfFailed:
          type: integer
          format: int64
          description: The number of failed transformation.
          example: '10'
    EventCreateFeatureParam:
      type: string
      description: Feature to be used during the Event creation.
      example: INITIALIZE
      enum:
        - INITIALIZE
        - NO_PERSISTENCE
      x-enumDescriptions:
        INITIALIZE: >-
          Used only when the Business Partner Storage has never had UPDATES
          feature. Creates only BusinessPartnerCreated events without checking
          for existing BusinessPartnerEvents. Goal is to speed up setting
          UPDATES feature.
        NO_PERSISTENCE: >-
          Do not persist events. Execution is performed for test and debug
          purposes to check e.g. if no events are missing.
    ToggleUpdateMonitoringJobRequest:
      type: object
      description: >-
        Parameter to describe if the Business Partners should be activated for
        update monitoring (true) or deactivated (false) for non-commercial
        reference data sources.
      required:
        - enable
        - storageId
        - dataSourceId
      properties:
        enable:
          $ref: '#/components/schemas/ToggleUpdateMonitoringRequestEnable'
        storageId:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
        name:
          maxLength: 50
          $ref: '#/components/schemas/JobName'
        description:
          maxLength: 200
          $ref: '#/components/schemas/JobDescription'
        dataSourceId:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        countryShortName:
          $ref: '#/components/schemas/CountryShortName'
    ToggleUpdateMonitoringJobResult:
      type: object
      description: Result of the Toggle Update Monitoring job with the status.
      properties:
        job:
          $ref: '#/components/schemas/ToggleUpdateMonitoringJob'
        status:
          type: string
          description: |
            Status:
              * `OK` - Toggle Update Monitoring Job has been fetched successfully
              * `NOT_FOUND` - Toggle Update Monitoring Job with that ID has not been found
          example: OK
    ToggleUpdateMonitoringJob:
      type: object
      description: Result of the Toggle Update Monitoring job.
      properties:
        id:
          $ref: '#/components/schemas/JobId'
        createdBy:
          $ref: '#/components/schemas/CreatedBy'
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        modifiedAt:
          $ref: '#/components/schemas/ModifiedAt'
        progress:
          $ref: '#/components/schemas/JobProgress'
        status:
          $ref: '#/components/schemas/JobStatus'
        statusMessage:
          $ref: '#/components/schemas/JobStatusMessage'
        enable:
          $ref: '#/components/schemas/ToggleUpdateMonitoringRequestEnable'
        storageId:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
        dataSourceId:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        countryShortName:
          $ref: '#/components/schemas/CountryShortName'
    BusinessPartnerUpdatesReportSummary:
      type: object
      description: Summary of the Business Partner Updates Report.
      properties:
        numberOfUpdates:
          type: integer
          description: Number of updates.
          example: '10'
        numberOfCountries:
          type: integer
          description: The number of countries.
          example: '10'
    JobStatus:
      type: string
      description: Job execution status.
      example: RUNNING
      enum:
        - ARCHIVED
        - UNKNOWN
        - CREATED
        - PERSISTED
        - SCHEDULED
        - WAITING
        - COULDNT_START
        - RUNNING
        - FINISHED
        - DIED
        - CANCELED
        - FAILED
      x-enumDescriptions:
        ARCHIVED: Job has been archived.
        UNKNOWN: Job becomes in unknown status.
        CREATED: Job has been created.
        PERSISTED: Job metadata has been persisted.
        SCHEDULED: Job has been scheduled for execution.
        WAITING: Job is waiting for being scheduled.
        COULDNT_START: Job could not be started.
        RUNNING: Job is being executed.
        FINISHED: Job has finished.
        DIED: Job was scheduled and started running but died unexpectedly.
        CANCELED: Job has been canceled due to invalid input configuration.
        FAILED: Job has failed.
    TransformationJobRequest:
      type: object
      description: >
        A Transformation Job is used to transform raw data into CDQ data model,
        and it is based on a Data Mapper Definition.

        The Transformation Job is executed asynchronously. The result of the
        Transformation Job can be retrieved by the Job ID.
      properties:
        name:
          maxLength: 50
          $ref: '#/components/schemas/JobName'
        description:
          maxLength: 200
          $ref: '#/components/schemas/JobDescription'
        dataSourceId:
          type: string
          description: >
            Unique identifier for a Data Source of the Storage. 


            If set, only the records that belong to the data source identified
            by this ID are transformed.

            By default, all records of the Business Partner Storage (means from
            all data sources) are transformed.
          example: 648824a691d8d2503d65103e
        countries:
          type: array
          description: List of countries for which the records should be transformed.
          items:
            $ref: '#/components/schemas/TransformationJobRequestCountry'
        storageId:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
        dataMapperDefinitionId:
          $ref: '#/components/schemas/DataMapperDefinitionId'
        dataTransformationDefinitionId:
          $ref: '#/components/schemas/DataTransformationDefinitionId'
        startAfter:
          type: string
          description: >-
            Processes transformation of records starting from the ID
            'startAfter'.
          example: NjI4ZGNkZjAzYjlkMjY4NjhlNjQxNDRm
        businessPartnerIds:
          type: array
          description: List of Business Partner IDs to be transformed.
          items:
            $ref: '#/components/schemas/BusinessPartnerId'
        featuresOn:
          type: array
          items:
            $ref: '#/components/schemas/TransformationJobFeatureParam'
      required:
        - storageId
    TransformationJobRequestCountry:
      type: object
      description: >-
        Country code (ISO 3166-1 alpha-2) for which the records should be
        transformed.
      required:
        - shortName
      properties:
        shortName:
          $ref: '#/components/schemas/CountryShortName'
    TransformationJobFeature:
      type: string
      description: Modifies behavior of a transformation job.
      example: UPSERT_CHANGES_ONLY
    TransformationJobFeatureParam:
      type: string
      description: Modifies behavior of a transformation job.
      example: UPSERT_CHANGES_ONLY
      enum:
        - ENABLE_EXTERNAL_ID_UPDATE
        - UPSERT_CHANGES_ONLY
      x-enumDescriptions:
        ENABLE_EXTERNAL_ID_UPDATE: Enables to update external ID of a Business Partner.
        UPSERT_CHANGES_ONLY: >-
          Performs transformation only for business partners, for which changes
          in the mapping are relevant. By default, all records of the storage
          are transformed.
    DnbImportJobFeature:
      type: string
      description: Modifies behavior of a D&B Import Job.
      example: ENRICH_COMMERCIAL_ULTIMATE
      enum:
        - ENRICH_COMMERCIAL_ULTIMATE
        - ENABLE_PARTIAL_QUOTA_CONSUMPTION
        - SKIP_DNB_IMPORT
        - INCREMENT
        - ACTIVATE_MASTER_DATA_EXTENDED
      x-enumDescriptions:
        ENRICH_COMMERCIAL_ULTIMATE: Enriches Commercial Ultimate.
        ENABLE_PARTIAL_QUOTA_CONSUMPTION: >-
          Enables to run import job on a remaining quota when full quota not
          available.
        SKIP_DNB_IMPORT: >-
          Skips requesting D&B data from D&B services. Can be used to enrich
          only Commercial Ultimate.
        INCREMENT: >-
          Continue processing after the last processed result with a goal to run
          on newly created Business Partners from a Business Partner Storage.
        ACTIVATE_MASTER_DATA_EXTENDED: >-
          Enables to use data blocks instead of cmplek when fetching data from
          DNB.
    DnbCreateLODJob:
      type: object
      description: Job for creating List of Duns file.
      properties:
        id:
          $ref: '#/components/schemas/JobId'
        name:
          $ref: '#/components/schemas/JobName'
        description:
          $ref: '#/components/schemas/JobDescription'
        progress:
          $ref: '#/components/schemas/JobProgress'
        status:
          $ref: '#/components/schemas/JobStatus'
        statusMessage:
          type: string
          description: Message describing the status of the job.
          example: Job is running
        createdBy:
          $ref: '#/components/schemas/CreatedBy'
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        modifiedAt:
          $ref: '#/components/schemas/ModifiedAt'
        attachments:
          type: array
          description: List of attachments.
          items:
            $ref: '#/components/schemas/FileResource'
    DnbImportJob:
      type: object
      description: Job for importing data from D&B.
      properties:
        id:
          $ref: '#/components/schemas/JobId'
        name:
          $ref: '#/components/schemas/JobName'
        description:
          $ref: '#/components/schemas/JobDescription'
        progress:
          $ref: '#/components/schemas/JobProgress'
        status:
          $ref: '#/components/schemas/JobStatus'
        statusMessage:
          type: string
          description: Message describing the status of the job.
          example: Job is running
        createdBy:
          $ref: '#/components/schemas/CreatedBy'
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        modifiedAt:
          $ref: '#/components/schemas/ModifiedAt'
        result:
          $ref: '#/components/schemas/DnbImportJobResult'
    DnbImportJobResult:
      type: object
      description: Result of D&B import job.
      properties:
        statistics:
          $ref: '#/components/schemas/DnbImportJobStatistics'
    DnbImportJobStatistics:
      type: object
      description: Statistics of D&B import job.
      properties:
        numberOfRecords:
          $ref: '#/components/schemas/NumberOfRecords'
        numberOfDuplicates:
          type: number
          description: Number of duplicates in input file which have the same DUNS.
          example: '5'
        numberOfInserts:
          type: number
          description: Number of newly created records.
          example: '100'
        numberOfUpdates:
          type: number
          description: Number of updated records.
          example: '100'
        numberOfFailed:
          type: number
          description: Number of records updates / retrieves fails.
          example: '50'
        numberOfQuotaExceeded:
          type: integer
          format: int64
          description: Number of not processed records which exceeded defined quota limit.
          example: '100'
        numberOfUnknown:
          type: number
          description: Number of non-retrieved records from D&B service.
          example: '100'
    DnbLodJobRequest:
      type: object
      description: Parameters for D&B lod job.
      properties:
        name:
          $ref: '#/components/schemas/JobName'
          maxLength: 50
        description:
          $ref: '#/components/schemas/JobDescription'
          maxLength: 200
    FileResource:
      type: object
      description: Provide data with a file.
      properties:
        url:
          type: string
          description: Url of file stored.
          example: /customer-upload/file.xlsx
        createdBy:
          $ref: '#/components/schemas/CreatedBy'
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        modifiedAt:
          $ref: '#/components/schemas/ModifiedAt'
    MonitorStorageCleanupJob:
      type: object
      description: Result of Monitor Storage Cleanup job.
      properties:
        id:
          $ref: '#/components/schemas/JobId'
        progress:
          $ref: '#/components/schemas/JobProgress'
        status:
          $ref: '#/components/schemas/JobStatus'
        statusMessage:
          $ref: '#/components/schemas/JobStatusMessage'
        storageId:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
        createdBy:
          $ref: '#/components/schemas/CreatedBy'
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        modifiedAt:
          $ref: '#/components/schemas/ModifiedAt'
    SharingJob:
      type: object
      description: Result of Sharing job.
      properties:
        id:
          $ref: '#/components/schemas/JobId'
        progress:
          $ref: '#/components/schemas/JobProgress'
        status:
          $ref: '#/components/schemas/JobStatus'
        statusMessage:
          $ref: '#/components/schemas/JobStatusMessage'
        storageId:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
        createdBy:
          $ref: '#/components/schemas/CreatedBy'
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        modifiedAt:
          $ref: '#/components/schemas/ModifiedAt'
    RestartMonitorJobFeatureParam:
      type: string
      description: Features to be used during the Restart Monitor job.
      example: CDQ_POOL
      enum:
        - CDQ_POOL
        - RESTART
        - REMOVE_DUPLICATES
      x-enumDescriptions:
        CDQ_POOL: Points to CDQ.POOL.
        RESTART: Performs restart on pointed sharing pool.
        REMOVE_DUPLICATES: Removes duplicates based on provided deduplication job as input.
        DATA_DEFECTS: Test run for REMOVE_HAVING_DATA_DEFECTS.
        REMOVE_HAVING_DATA_DEFECTS: Removes BPs with data defects from cdq pool.
    FileUploadRequest:
      type: object
      description: Request for file upload.
      properties:
        url:
          type: string
          description: File name which will be uploaded in `customer-uploads/` directory.
          example: dq-chart.png or requestedDirectory/dq-chart.png
      required:
        - url
    FileUploadResult:
      type: object
      description: Result of file upload.
      properties:
        uploadLink:
          type: string
          description: Url to file.
          example: https://file.cdq.com/customer-uploads/cdlbot/dq-chart.png
        uploadMethod:
          type: string
          description: Method of uploading file.
          example: PUT
        expiresAt:
          $ref: '#/components/schemas/ExpiresAt'
        url:
          type: string
          description: Url to file, place where it is stored.
          example: customer-uploads/cdlbot/dq-chart.png
    FileDeleteResponse:
      type: object
      description: Response for file delete.
      properties:
        results:
          type: array
          description: List of results for each file.
          items:
            $ref: '#/components/schemas/FileDeleteResult'
    FileDeleteResult:
      type: object
      description: Result of file delete.
      properties:
        url:
          type: string
          description: Url to file.
          example: customer-uploads/cdlbot/dq-chart.png
        status:
          type: string
          description: File delete status.
          example: OK
        message:
          type: string
          description: Message with result of file delete.
          example: File has been deleted successfully
    FileDownloadResult:
      type: object
      description: Result of file download.
      allOf:
        - $ref: '#/components/schemas/FileResource'
        - type: object
          description: Result of file download.
          properties:
            expiresAt:
              $ref: '#/components/schemas/ExpiresAt'
            downloadLink:
              type: string
              description: Url to file.
              example: https://file.cdq.com/customer-uploads/cdlbot/dq-chart.png
            downloadMethod:
              type: string
              description: Method of uploading file.
              example: GET
    FileDownloadRequest:
      type: object
      description: Request for file download.
      required:
        - url
      properties:
        url:
          type: string
          description: ID of the file.
          example: customer-upload/user/file.xlsx
        downloadLinkAge:
          description: Number of milliseconds the download link is active.
          type: integer
          format: int64
          default: 0
          example: '0'
    ResourcesListResult:
      type: object
      description: Page of file resources.
      properties:
        startAfter:
          type: string
          description: Value of continuation token from the request.
          example: >-
            1XUzntG%2FKE%2B5IN08GrJQgKin9OblLzlorehkIs1xlj46yyCktx%2FsZrQeTh2FvBKOLLB%2Fu%2F32Ow%2BRJfLUjMqi6gGGjsAQRPZ4u
        limit:
          $ref: '#/components/schemas/Limit'
        nextStartAfter:
          type: string
          description: >-
            Value of continuation token required to retrieve results from next
            page. Should be passed in the next request as "startAfter"
            parameter.
          example: >-
            1XUzntG%2FKE%2B5IN08GrJQgKin9OblLzlorehkIs1xlj46yyCktx%2FsZrQeTh2FvBKOLLB%2Fu%2F32Ow%2BRJfLUjMqi6gGGjsAQRPZ4u
        files:
          type: array
          description: Array of FileResource objects.
          items:
            $ref: '#/components/schemas/FileResource'
    FetchDnbRecordRequest:
      type: object
      description: Parameters for fetch D&B record request by DUNS.
      required:
        - duns
      properties:
        duns:
          $ref: '#/components/schemas/Duns'
        featuresOn:
          type: array
          description: Features to be used during the D&B storage creation.
          items:
            $ref: '#/components/schemas/DnbStorageFeatureParam'
    FetchDnbRecordResult:
      type: object
      description: Result of the fetch D&B record request.
      properties:
        dnbRecord:
          $ref: '#/components/schemas/DnbRecord'
        status:
          type: string
          description: |
            status:
              * `OK` - D&B Record has been fetched successfully.
              * `NOT_FOUND` - D&B Record with that DUNS does not exist in storage.
          example: OK
        message:
          type: string
          description: Message describing the status of the request.
          example: D&B Record has been fetched successfully
    DnbRecordsUpsertFeature:
      type: string
      description: Features for D&B Records upsert.
      example: ASYNC_PROCESSING
      enum:
        - ASYNC_PROCESSING
      x-enumDescriptions:
        ASYNC_PROCESSING: Save D&B Records in synchronous mode
    DnbRecordFailureLog:
      type: object
      description: Log of failed D&B record.
      properties:
        id:
          type: string
          description: Unique identifier of the failed record.
          example: 5c6a2c7e-9b0a-4e1a-8b0a-4e1a8b0a4e1a
        duns:
          $ref: '#/components/schemas/Duns'
        message:
          type: string
          description: Message describing the status of the request.
          example: Fail
    CommercialUltimateUpdate:
      type: object
      description: DUNS number of D&B record and his new Commercial Ultimate to update.
      properties:
        duns:
          $ref: '#/components/schemas/Duns'
        commercialUltimate:
          $ref: '#/components/schemas/CommercialUltimate'
      required:
        - duns
        - commercialUltimate
    DnbRecord:
      type: object
      description: D&B Record.
      properties:
        duns:
          $ref: '#/components/schemas/Duns'
        cmpelkV2:
          $ref: '#/components/schemas/CmpelkV2'
        dataBlock:
          $ref: '#/components/schemas/DataBlock'
        cdqRecord:
          $ref: '#/components/schemas/BusinessPartner'
        formattedSapRecord:
          $ref: '#/components/schemas/FormattedSapRecord'
        commercialUltimate:
          $ref: '#/components/schemas/CommercialUltimate'
        domesticCommercialUltimate:
          $ref: '#/components/schemas/CommercialUltimate'
        lastModifiedAt:
          $ref: '#/components/schemas/ModifiedAt'
    Duns:
      type: string
      description: DUNS number of the record to be fetched.
      example: 15-048-3782
    DnbRecordsReadFeatureParam:
      type: string
      description: Features to be used during the read.
      example: SHOW_CDQ_RECORD
      enum:
        - NUMBER_OF_TOTAL
        - SHOW_CDQ_RECORD
        - SHOW_FORMATTED_SAP_RECORD
        - USE_DNB_MASTER_DATA_BASIC
        - USE_DNB_MASTER_DATA_MGMT
        - USE_DNB_MASTER_DATA_LNKG
        - USE_DNB_MASTER_DATA_EXTENDED
        - USE_DNB_LINKAGE_LNKELI
      x-enumDescriptions:
        NUMBER_OF_TOTAL: Provides total number of records in the storage.
        SHOW_CDQ_RECORD: Provides CDQ record.
        SHOW_FORMATTED_SAP_RECORD: Provides formatted SAP record.
        USE_DNB_MASTER_DATA_BASIC: Uses D&B Master Data Basic.
        USE_DNB_MASTER_DATA_MGMT: Uses D&B Master Data Mgmt.
        USE_DNB_MASTER_DATA_LNKG: Uses D&B Master Data Lnkg.
        USE_DNB_MASTER_DATA_EXTENDED: Uses D&B Master Data Extended.
        USE_DNB_LINKAGE_LNKELI: Uses D&B Linkage LNKELI.
    DnbRecordPage:
      type: object
      description: Page of D&B Records.
      properties:
        startAfter:
          $ref: '#/components/schemas/StartAfter'
        limit:
          $ref: '#/components/schemas/Limit'
        total:
          $ref: '#/components/schemas/PageTotal'
        values:
          type: array
          description: List of D&B Records.
          items:
            $ref: '#/components/schemas/DnbRecord'
        nextStartAfter:
          $ref: '#/components/schemas/NextStartAfter'
    CommercialUltimate:
      type: object
      description: >-
        Details of the highest commercial organization in the corporate family
        hierarchy.
      properties:
        duns:
          $ref: '#/components/schemas/Duns'
        primaryName:
          type: string
          description: Name of the Commercial Ultimate.
          example: Dun & Bradstreet, Inc.
        primaryAddress:
          $ref: '#/components/schemas/DnBAddress'
        path:
          type: array
          description: >-
            List of DUNS numbers that represent the path from the subject to the
            Commercial Ultimate.
          items:
            type: object
            description: >-
              DUNS number that represents the path from the subject to the
              Commercial Ultimate.
            properties:
              duns:
                $ref: '#/components/schemas/Duns'
              primaryName:
                type: string
                description: Name of the Commercial Ultimate.
                example: Dun & Bradstreet, Inc.
              parentDuns:
                $ref: '#/components/schemas/Duns'
    DnBAddress:
      type: object
      description: >-
        The details of the single primary or physical address at which the
        entity is located.
      properties:
        language:
          type: object
          description: The details of the language in which this address was recorded.
          properties:
            description:
              type: string
              description: The name of the language in which this address was recorded.
              example: English
            dnbCode:
              type: integer
              description: >-
                A unique code assigned by Dun & Bradstreet to identify the
                language in which this address was recorded.
              example: '39'
        addressCountry:
          type: object
          description: The details of the country in which this address is located.
          properties:
            name:
              type: string
              description: The name of the country in which this address is located.
              example: United States
            isoAlpha2Code:
              type: string
              description: >-
                The two-letter country code, defined by the International
                Organization for Standardization (ISO) ISO 3166-1 scheme
                identifying the country in which this address is located.
              example: US
            fipsCode:
              type: string
              description: >-
                The Federal Information Processing Standards (FIPS) code value
                that identifies the country in which this address is located.
              example: US
        continentalRegion:
          type: object
          description: >-
            The details of the continental region in which this address is
            located.
          properties:
            name:
              type: string
              description: >-
                The name of the continental region for this
                address.<br/><br/>Possible values:<br/>- Africa<br/>- Asia
                Pacific<br/>- Europe<br/>- Latin America<br/>- Middle East<br/>-
                North America.
              example: North America
        addressLocality:
          type: object
          description: >-
            The details of the city, town, township, village, borough, etc. in
            which this address is located.
          properties:
            name:
              type: string
              description: >-
                The name of the city, town, township, village, borough, etc. in
                which this address is located.
              example: SAN FRANCISCO
        minorTownName:
          type: string
          description: >-
            The name of the village, town or suburb when it is not a Primary
            Town or City (e.g., the Booker in Booker, High Wycombe).
          example: Booker
        addressRegion:
          type: object
          description: >-
            The details of the locally governed area that forms part of a
            centrally governed nation to identify where this address is located.
          properties:
            name:
              type: string
              description: >-
                The name of the locally governed area that forms part of a
                centrally governed nation to identify where this address is
                located.
              example: Booker
            abbreviatedName:
              type: string
              description: >-
                The shortened name of the locally governed area that forms part
                of a centrally governed nation. For example 'NJ' for the US
                State New Jersey within Country United States.
              example: CA
            fipsCode:
              type: string
              description: >-
                The Federal Information Processing Standards (FIPS) code value
                that identifies the region in which this address is located.
              example: '06'
        addressCounty:
          type: object
          description: The details of the county in which this address is located.
          properties:
            name:
              type: string
              description: The name of the county in which this address is located.
              example: SAN MATEO
            fipsCode:
              type: string
              description: >-
                The Federal Information Processing Standards (FIPS) code value
                that identifies the county in which this address is located.
              example: '81'
        postalCode:
          type: string
          description: >-
            An identifier used by the local country's postal authority to
            identify where this address is located.
          example: '941109999'
        postalCodePosition:
          type: object
          description: >-
            The details of the position of the Postal Code when presenting the
            address.
          properties:
            description:
              type: string
              description: >-
                The position of the Postal Code when presenting the address
                (e.g., before the Primary Town/City).
              example: Post code presented before Town/City name.
            dnbCode:
              type: integer
              description: >-
                A unique code assigned by Dun & Bradstreet to identify the
                position of the Postal Code when presenting the address.
              example: '1009'
        streetNumber:
          type: string
          description: >-
            The number part of the street address where the entity is located.
            <br/><br/>This may be a single number, a number with an appendix, or
            a range of street numbers. <br/><br/>For example, the &quot;51 -
            59C&quot; in the address 51 - 59C Wall Street.
          example: '492'
        streetName:
          type: string
          description: >-
            The name of the street where the entity is located. <br/><br/>For
            example, &quot;Wall Street&quot; in the address 51 - 59C Wall
            Street.
          example: KOLLER ST
        streetAddress:
          type: object
          description: The details of the street address where the entity is located.
          properties:
            line1:
              type: string
              description: >-
                The first line of the address where the entity is
                located.<br/><br/>For example, &quot;41 Central Chambers&quot;
                in the address <br/>41 Central Chambers<br/>Dame
                Court<br/>Dublin 2.
              example: 492 KOLLER ST
            line2:
              type: string
              description: >-
                The second line of the address where the entity is
                located.<br/><br/>For example, &quot;Dame Court&quot; in the
                address <br/>41 Central Chambers<br/>Dame Court<br/>Dublin 2.
              example: Suite 100
        postOfficeBox:
          type: object
          description: >-
            The details of the identifier issued to the entity by a private or
            public Postal Office for the purposes of collecting mail for the
            entity for subsequent collection or delivery.
          properties:
            postOfficeBoxNumber:
              type: string
              description: >-
                An identifier issued to the entity by a private or public postal
                office for the purposes of collecting mail for the entity for
                subsequent collection or delivery.<br/><br/>This includes only
                the identifying number (or text) and not the textual description
                of the PO Box type. For example the contents would be just the
                number 12 from &quot;PO Box 12&quot;, or just the number 57 from
                &quot;PMB 57&quot;.
              example: '5309'
            typeDescription:
              type: string
              description: The type of the PO Box (e.g., Post Office Box, PMB).
              example: Supplied by public Post Office authority.
            typeDnBCode:
              type: integer
              description: >-
                A unique code assigned by Dun & Bradstreet to identify the type
                of PO Box.
              example: '120'
        latitude:
          type: number
          description: >-
            The latitude component of the entity's location defined as the
            angular distance of the primary physical address north or south from
            the Earth's equator expressed in decimal numbers. <br/><br/>Positive
            numbers indicate degrees north. Negative numbers indicate degrees
            south.
          example: '37.777709'
        longitude:
          type: number
          description: >-
            The longitude component of the entity's location defined as the
            angular distance of the primary physical address east or west from
            an imaginary line (called the prime meridian) that goes from the
            North Pole to the South Pole expressed in decimal numbers.
            <br/><br/>Positive numbers indicate degrees east. Negative numbers
            indicate degrees west.
          example: '-122.404624'
        geographicalPrecision:
          type: object
          description: >-
            The details on how close the latitude and longitude coordinates for
            a location are to rooftop level.
          properties:
            description:
              type: string
              description: >-
                The description of how close the latitude and longitude
                coordinates for a location are to rooftop level.
              example: Street Segment Centroid
            dnbCode:
              type: integer
              description: >-
                A unique code assigned by Dun & Bradstreet to identify how close
                the latitude and longitude coordinates for a location are to
                &quot;rooftop&quot; level.
              example: '30256'
        isRegisteredAddress:
          type: boolean
          description: >-
            Indicates if the primary address is the same as the address of the
            entity as registered with a legal entity.  <br/>  <br/>- If true,
            the primary address is the same as the address of the entity as
            registered with a legal entity.<br/>- If false, the primary address
            is the not same as the address of the entity as registered with a
            legal entity.
          example: 'true'
        isResidentialAddress:
          type: boolean
          description: >-
            Indicates whether the Primary Address is classified as residential
            by the governing postal authority<br/><br/>- If true, the primary
            address is classified as residential.<br/>- If false, the primary
            address is not classified as residential.
          example: 'false'
        statisticalArea:
          type: object
          description: >-
            The details of the various statistical facts associated with this
            address.
          properties:
            cbsaName:
              type: string
              description: >-
                The name assigned to the 5-digit CBSA (Core Based Statistical
                Area) assigned by US Census board to denote a geographical
                region with a relatively high population density at its core and
                close economic ties throughout the area.
              example: San Francisco-Oakland-Hayward CA
            cbsaCode:
              type: string
              description: >-
                The 5-digit CBSA (Core Based Statistical Area) code assigned by
                US Census board to denote a geographical region with a
                relatively high population density at its core and close
                economic ties throughout the area.
              example: '41860'
            economicAreaOfInfluenceCode:
              type: string
              description: >-
                A code assigned by the U.S. Bureau of Economic Analysis to
                identify the entity's regional market that surrounds a
                metropolitan or micropolitan statistical area serving as a
                regional center of economic activity.
              example: '146'
            populationRank:
              type: object
              description: >-
                The details of the statistical facts about population based on
                region's rank.
              properties:
                rankNumber:
                  type: string
                  description: >-
                    A number classifying the geographic area in which the entity
                    is located based on the resident
                    population.<br/><br/><b>Values:</b> 0 to 9<br/>0 denotes the
                    lowest population range; 9 denotes the highest.
                  example: '9'
                rankDnBCode:
                  type: integer
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    population for the geographical area in which this address
                    is located.
                  example: '10961'
                rankDescription:
                  type: string
                  description: >-
                    A range of the population for the geographical area where
                    the entity is located.
                  example: 500,000 +
        locationOwnership:
          type: object
          description: >-
            The details of the terms under which the entity occupies the
            premises.
          properties:
            description:
              type: string
              description: >-
                Description of the terms under which the entity occupies the
                premises (e.g., owned, rented, leased).
              example: Rents
            dnbCode:
              type: integer
              description: >-
                A unique code assigned by Dun & Bradstreet to identify the terms
                under which the entity occupies the premises.
              example: '1129'
        premisesArea:
          type: object
          description: The details of space the entity utilizes at this address.
          properties:
            measurement:
              type: number
              description: >-
                A number portion of the amount to of space the entity occupies
                at this address (e.g., the 2000 in 2000 square meters).
              example: '10034'
            unitDescription:
              type: string
              description: >-
                The measurement unit used to express the premises area
                measurement (e.g., acre, square meters, square feet).
              example: square foot
            unitDnBCode:
              type: integer
              description: >-
                A unique code assigned by Dun & Bradstreet to identify the
                measurement unit used to express the premises area measurement.
              example: '3848'
            reliabilityDescription:
              type: string
              description: >-
                The accuracy of the measurement (e.g., actual, estimated,
                modeled).
              example: Actual
            reliabilityDnBCode:
              type: integer
              description: >-
                A unique code assigned by Dun & Bradstreet to identify the
                accuracy of the measurement.
              example: '9092'
        isManufacturingLocation:
          type: boolean
          description: >-
            Indicates if manufacturing activity is performed at this facility by
            the entity.<br/><br/>- If true, the entity performs manufacturing
            activity at this facility.<br/>- If false, the entity does not
            perform manufacturing activity at this facility.
          example: 'true'
    SubscriptionUpsert:
      type: object
      description: Subscription to be upserted.
      properties:
        id:
          type: string
          description: Uniquely identifying ID of the subscription.
          example: 601ab61bc840f7000186cada
        cdqId:
          $ref: '#/components/schemas/SubscriptionCdqId'
        types:
          type: array
          description: List of subscription types.
          items:
            $ref: '#/components/schemas/SubscriptionType'
          minItems: 1
          uniqueItems: true
      required:
        - cdqId
        - types
    Subscription:
      type: object
      description: Detailed information about created subscriptions.
      properties:
        id:
          type: string
          description: Uniquely identifying ID of the subscription.
          example: 601ab61bc840f7000186cada
        cdqId:
          type: string
          description: Unique identifier for the Business Partner.
          example: VIES:PL8660001429
        types:
          type: array
          description: List of types of subscription.
          items:
            type: string
            description: Type of subscription.
            example: UPDATES
          minItems: 1
          uniqueItems: true
        organization:
          type: string
          readOnly: true
          description: Uniquely identifying ID of the organization.
          example: cdq_monitor
        createdAt:
          readOnly: true
          $ref: '#/components/schemas/CreatedAt'
      required:
        - cdqId
        - types
    SubscriptionType:
      type: string
      description: Type of subscription.
      example: UPDATES
      enum:
        - UPDATES
      x-enumDescriptions:
        UPDATES: Subscription for updates.
    SubscriptionFailureLog:
      type: object
      description: Log of failed subscription.
      properties:
        cdqId:
          type: string
          description: Unique identifier for the Business Partner.
          example: VIES:PL8660001429
        message:
          type: string
          description: Message describing the status of the request.
          example: Fail
    SubscriptionMetadataRequest:
      type: object
      description: Parameters for fetching subscription metadata.
      properties:
        cdqId:
          type: string
          description: Unique identifier for the Business Partner.
          example: VIES:PL8660001429
        businessPartnerId:
          $ref: '#/components/schemas/BusinessPartnerId'
    SubscriptionMetadata:
      type: object
      description: Metadata of a subscription.
      properties:
        cdqId:
          type: string
          description: Unique identifier for the Business Partner.
          example: VIES:PL8660001429
        subscribed:
          type: boolean
          description: Indicates if the subscription is subscribed.
          example: 'true'
        numberOfSubscribers:
          type: integer
          description: Number of subscribers.
          example: '50'
    SubscriptionCdqId:
      type: string
      description: Unique CDQ ID of the subscription.
      example: CDQ.POOL:5E580DD08E8B454820E8F67E0
    BusinessPartnerIdentityLink:
      type: object
      description: >-
        Detailed information about the linkage with the Business Partner from
        another Data Source.
      properties:
        id:
          type: string
          description: Unique identifier of the linkage.
          example: CDQ.POOL:5E580DD08E8B454820E8F67E0
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        organization:
          $ref: '#/components/schemas/OrganizationId'
        storageId:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
        businessPartnerId:
          $ref: '#/components/schemas/BusinessPartnerId'
        referenceBusinessPartnerId:
          type: string
          description: >-
            ID of monitored Business Partner within own Storage. Null for
            reference Data Sources like VIES, LEI.
          example: VIES:ATU12345678
        addressId:
          type: string
          description: >-
            Unique identifier for the address which was used for the linkage in
            the POOL.
          example: '0'
        addressVersion:
          $ref: '#/components/schemas/BusinessPartnerIdentityLinkAddressVersion'
        externalBusinessPartnerId:
          $ref: '#/components/schemas/BusinessPartnerExternalId'
        externalAddressId:
          $ref: '#/components/schemas/AddressExternalId'
        referenceAddressVersion:
          $ref: '#/components/schemas/BusinessPartnerIdentityLinkAddressVersion'
        cdqId:
          type: string
          description: Unique identifier for the Business Partner.
          example: VIES:PL8660001429
        linkageParameter:
          $ref: '#/components/schemas/BusinessPartner'
        linkageStatus:
          $ref: '#/components/schemas/LinkageStatus'
        status:
          $ref: '#/components/schemas/LinkStatus'
        referenceDataSource:
          type: string
          description: >-
            Data Source of the Business Partner which was used for the linkage
            in the POOL.
          example: VIES
        storageDataSource:
          $ref: '#/components/schemas/BusinessPartnerIdentityLinkDataSource'
    BusinessPartnerIdentityLinkAddressVersion:
      type: object
      description: >-
        CDQ supports multiple versions of addresses comprising different
        charsets and languages. An address version is a unique combination of a
        character set and a language.
      properties:
        languageTechnicalKey:
          $ref: '#/components/schemas/LanguageTechnicalKey'
        characterSetTechnicalKey:
          $ref: '#/components/schemas/CharacterSetTechnicalKey'
    LinkageStrategy:
      type: object
      description: Strategy for linking Business Partners from different Data Sources.
      properties:
        externalContext:
          $ref: '#/components/schemas/LinkageStrategyExternalContext'
    LinkageStrategyExternalContext:
      type: object
      description: External Context of a Linkage Strategy.
      properties:
        identifiers:
          type: array
          description: List of identifiers of the external context.
          items:
            $ref: '#/components/schemas/LinkageStrategyExternalContextIdentifier'
    LinkageStrategyExternalContextIdentifier:
      type: object
      description: Identifier of the external context.
      properties:
        type:
          $ref: '#/components/schemas/LinkageStrategyExternalContextIdentifierType'
    LinkageStrategyExternalContextIdentifierType:
      type: object
      description: Type of the external context identifier.
      properties:
        technicalKey:
          $ref: '#/components/schemas/ExternalContextIdentifierTypeTechnicalKey'
    TechnicalReportsRequest:
      type: object
      description: Parameters for Technical Reports.
      properties:
        name:
          maxLength: 50
          $ref: '#/components/schemas/JobName'
        description:
          maxLength: 200
          $ref: '#/components/schemas/JobDescription'
        reportsConfiguration:
          $ref: '#/components/schemas/TechnicalReportsConfiguration'
    StorageDumpReportsRequest:
      type: object
      description: Parameters for Storage Dump Reports.
      properties:
        storageId:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
        name:
          maxLength: 50
          $ref: '#/components/schemas/JobName'
        description:
          maxLength: 200
          $ref: '#/components/schemas/JobDescription'
        reportsConfiguration:
          $ref: '#/components/schemas/StorageDumpReportsConfiguration'
    JobTag:
      type: string
      maxLength: 100
      description: Job Tag to be used for filtering.
      example: tag1
    TechnicalReports:
      type: object
      description: Build Technical reports.
      allOf:
        - $ref: '#/components/schemas/Job'
        - $ref: '#/components/schemas/TechnicalReportsRequest'
    UpdateMonitorDataSourcesResult:
      type: object
      description: Result of the Update Monitor Data Sources operation.
      properties:
        dataSources:
          type: array
          description: List of Data Sources.
          items:
            $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
    ToggleUpdateMonitoringRequest:
      type: object
      description: Parameters for Toggle Update Monitoring job.
      required:
        - enable
        - businessPartnerIds
      properties:
        enable:
          $ref: '#/components/schemas/ToggleUpdateMonitoringRequestEnable'
        businessPartnerIds:
          type: array
          description: >-
            List of Business Partner IDs to identify all those Business Partners
            that should be activated/deactivated.
          minItems: 1
          maxItems: 1000
          items:
            $ref: '#/components/schemas/BusinessPartnerId'
    ToggleUpdateMonitoringRequestEnable:
      type: boolean
      description: >-
        Parameter to describe if the Business Partners should be activated for
        update monitoring (true) or deactivated (false) for non-commercial
        reference data sources.
      example: 'true'
    DataMonitor:
      type: object
      description: >-
        A monitoring service that can be activated for a Data Storage/Data
        Mirror.
      properties:
        id:
          $ref: '#/components/schemas/DataMonitorId'
        type:
          $ref: '#/components/schemas/DataMonitorType'
        dataSources:
          type: array
          description: List of Data Sources.
          items:
            $ref: '#/components/schemas/BusinessPartnerStorageDataSource'
        enabled:
          $ref: '#/components/schemas/DataMonitorToggle'
        disabledAt:
          $ref: '#/components/schemas/DataMonitorDisabledAt'
        configuration:
          $ref: '#/components/schemas/DataMonitorConfiguration'
        executions:
          type: array
          description: Available executions of data monitor.
          items:
            $ref: '#/components/schemas/DataMonitorExecution'
        validitySpan:
          $ref: '#/components/schemas/DataMonitorValiditySpan'
        scopes:
          type: array
          description: Scope of data monitor.
          items:
            $ref: '#/components/schemas/DataMonitorScope'
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        createdBy:
          $ref: '#/components/schemas/CreatedBy'
        modifiedAt:
          $ref: '#/components/schemas/ModifiedAt'
        modifiedBy:
          $ref: '#/components/schemas/ModifiedBy'
        featuresOn:
          type: array
          description: Features to be activated for Data Monitor.
          items:
            $ref: '#/components/schemas/DataMonitorFeature'
    DataMonitorCreate:
      type: object
      description: Create a new Data Monitor.
      required:
        - type
        - dataSources
        - executions
      properties:
        type:
          $ref: '#/components/schemas/DataMonitorTypeParam'
        dataSources:
          type: array
          description: List of Data Sources.
          minItems: 1
          maxItems: 7
          items:
            $ref: '#/components/schemas/BusinessPartnerStorageDataSourceParam'
        enabled:
          $ref: '#/components/schemas/DataMonitorToggle'
        configuration:
          $ref: '#/components/schemas/DataMonitorConfigurationParam'
        executions:
          type: array
          description: Available executions of data monitor.
          minItems: 1
          items:
            $ref: '#/components/schemas/DataMonitorExecutionParam'
        validitySpan:
          $ref: '#/components/schemas/DataMonitorValiditySpanParam'
        featuresOn:
          type: array
          description: Features to be activated for Data Monitor.
          items:
            $ref: '#/components/schemas/DataMonitorFeatureParam'
        scopes:
          type: array
          description: Scope to be enabled for monitor.
          items:
            $ref: '#/components/schemas/DataMonitorScope'
    DataMonitorTypeParam:
      type: object
      description: Type of the Data Monitor.
      required:
        - technicalKey
      properties:
        technicalKey:
          $ref: '#/components/schemas/DataMonitorTypeTechnicalKeyEnum'
    DataMonitorUpdate:
      type: object
      description: |
        Data Monitor definition that is to be updated.

        Note: updating Data Monitor will overwrite all its available properties.
      required:
        - dataSources
        - executions
      properties:
        dataSources:
          type: array
          description: List of Data Sources.
          minItems: 1
          maxItems: 7
          items:
            $ref: '#/components/schemas/BusinessPartnerStorageDataSourceParam'
        enabled:
          $ref: '#/components/schemas/DataMonitorToggle'
        configuration:
          $ref: '#/components/schemas/DataMonitorConfigurationParam'
        executions:
          type: array
          description: Available executions of data monitor.
          minItems: 1
          items:
            $ref: '#/components/schemas/DataMonitorExecutionParam'
        validitySpan:
          $ref: '#/components/schemas/DataMonitorValiditySpanParam'
        scopes:
          type: array
          description: Scope to be enabled for monitor.
          items:
            $ref: '#/components/schemas/DataMonitorScope'
        featuresOn:
          type: array
          description: Features to be activated for Data Monitor.
          items:
            $ref: '#/components/schemas/DataMonitorUpdateFeatureParam'
    DataMonitorsPage:
      type: object
      description: Page with listed Data Monitors.
      properties:
        values:
          description: List of Data Monitors.
          example: '[ff864c7bfe38397b8c160bc624f97574, 1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6p]'
          items:
            $ref: '#/components/schemas/DataMonitorSearchResult'
        limit:
          $ref: '#/components/schemas/Limit'
        startAfter:
          $ref: '#/components/schemas/StartAfter'
        nextStartAfter:
          $ref: '#/components/schemas/NextStartAfter'
        total:
          $ref: '#/components/schemas/PageTotal'
    DataMonitorSearchResult:
      type: object
      description: Data Monitor search result.
      properties:
        id:
          $ref: '#/components/schemas/DataMonitorId'
        type:
          $ref: '#/components/schemas/DataMonitorType'
        dataSources:
          type: array
          description: List of Data Sources.
          items:
            $ref: '#/components/schemas/BusinessPartnerStorageDataSource'
        enabled:
          $ref: '#/components/schemas/DataMonitorToggle'
        disabledAt:
          $ref: '#/components/schemas/DataMonitorDisabledAt'
        configuration:
          $ref: '#/components/schemas/DataMonitorConfiguration'
        executions:
          type: array
          description: Available executions of data monitor.
          items:
            $ref: '#/components/schemas/DataMonitorExecution'
        validitySpan:
          $ref: '#/components/schemas/DataMonitorValiditySpan'
        scopes:
          type: array
          description: Scope of data monitor.
          items:
            $ref: '#/components/schemas/DataMonitorScope'
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        createdBy:
          $ref: '#/components/schemas/CreatedBy'
        modifiedAt:
          $ref: '#/components/schemas/ModifiedAt'
        modifiedBy:
          $ref: '#/components/schemas/ModifiedBy'
        featuresOn:
          type: array
          description: Features to be activated for Data Monitor.
          items:
            $ref: '#/components/schemas/DataMonitorFeature'
        storageId:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
    DataMonitorDisabledAt:
      type: string
      description: Date in ISO-8601 format when data monitor was disabled.
      example: '2025-08-19T06:23:16Z'
    BusinessPartnerStorageDataSource:
      type: object
      description: >-
        A sub-container of Data Storage/Data Mirror. Few data sources can have
        different data, mappings, and data monitors within the same data mirror.
      properties:
        id:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        name:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceName'
    BusinessPartnerStorageDataSourceParam:
      type: object
      description: >-
        A sub-container of Data Storage/Data Mirror. Few data sources can have
        different data, mappings, and data monitors within the same data mirror.
      required:
        - id
      properties:
        id:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
    DataMonitorType:
      type: object
      description: Type of the Data Monitor.
      properties:
        name:
          $ref: '#/components/schemas/DataMonitorTypeName'
        technicalKey:
          $ref: '#/components/schemas/DataMonitorTypeTechnicalKey'
    DataMonitorTypeTechnicalKeyEnum:
      type: string
      description: Technical key of a data monitor.
      example: AUGMENTATION
      enum:
        - AUGMENTATION
        - DATA_QUALITY_PROFILING
        - SCREENING
      x-enumDescriptions:
        AUGMENTATION: >-
          Augmentation monitor returning Augmented Business Partner as a result
          of the curation process and raw updates from Reference Data Sources.
        DATA_QUALITY_PROFILING: >-
          Data validation monitor based on the configuration provided by
          cusotmer providing lis tof data defects of monitored business
          partners.
        SCREENING: Monitor for sanction & watchlist screening processes.
    DataMonitorConfigurationParam:
      type: object
      description: Configuration which is used during processing Business Partners.
      required:
        - id
      properties:
        id:
          $ref: '#/components/schemas/ConfigurationId'
    DataMonitorConfiguration:
      type: object
      description: Configuration which is used during processing Business Partners.
      properties:
        id:
          $ref: '#/components/schemas/ConfigurationId'
    DnbStorageFeatureParam:
      type: string
      description: Features for D&B Storage.
      example: USE_DNB
      enum:
        - SHOW_CDQ_RECORD
        - SHOW_FORMATTED_SAP_RECORD
        - USE_DNB
        - USE_DNB_MASTER_DATA_BASIC
        - USE_DNB_MASTER_DATA_MGMT
        - USE_DNB_MASTER_DATA_LNKG
        - USE_DNB_MASTER_DATA_EXTENDED
        - USE_DNB_LINKAGE_LNKELI
      x-enumDescriptions:
        SHOW_CDQ_RECORD: Provides CDQ record.
        SHOW_FORMATTED_SAP_RECORD: Provides formatted SAP record.
        USE_DNB: >-
          Create/Use Business Partner Storage for D&B data product _Company
          Profile, Linkage, and Executives_ (CMPELK)
        USE_DNB_MASTER_DATA_BASIC: Create/Use for D&B data product _Master Data Basic_
        USE_DNB_MASTER_DATA_MGMT: Create/Use for D&B data product _Master Data Management_
        USE_DNB_MASTER_DATA_LNKG: Create/Use for D&B data product _Master Data Linkage_
        USE_DNB_MASTER_DATA_EXTENDED: Create/Use for D&B data product _Master Data Extended_
        USE_DNB_LINKAGE_LNKELI: Create/Use for D&B data product _Extended Linkage Insight_
    DnbStorageResult:
      type: object
      description: Result of the D&B Storage.
      properties:
        id:
          type: string
          description: Unique ID of the D&B storage.
          example: ff864c7bfe38397b8c160bc624f97574
        technicalKey:
          $ref: '#/components/schemas/DnbStorageTechnicalKey'
        numberOfRecords:
          type: integer
          description: Number of records stored in D&B storage.
          example: 101
    DnbStorageTechnicalKeyParam:
      type: string
      description: Technical key that describes what kind if D&B storage it is.
      example: DNB_MASTER_DATA_BASIC
      enum:
        - DNB
        - DNB_MASTER_DATA_BASIC
        - DNB_MASTER_DATA_MGMT
        - DNB_MASTER_DATA_LNKG
        - DNB_MASTER_DATA_EXTENDED
        - DNB_LINKAGE_LNKELI
      x-enumDescriptions:
        DNB: >-
          Storage for D&B data product _Company Profile, Linkage, and
          Executives_ (CMPELK)
        DNB_MASTER_DATA_BASIC: Storage for D&B data product _Master Data Basic_
        DNB_MASTER_DATA_MGMT: Storage for D&B data product _Master Data Mgmt_
        DNB_MASTER_DATA_LNKG: Storage for D&B data product _Master Data Lnkg_
        DNB_MASTER_DATA_EXTENDED: Storage for D&B data product _Master Data Extended_
        DNB_LINKAGE_LNKELI: Storage for D&B data product _Extended Linkage Insight_
    DnbStorageTechnicalKey:
      type: string
      description: Technical key that describes what kind if D&B storage it is.
      example: DNB_MASTER_DATA_BASIC
    ReferenceDataStorageCreateFeature:
      type: string
      description: Feature for reference data storage creation.
      example: LAB_UPDATED_BUSINESS_PARTNER
    BusinessPartnerStorageMetadataPageReadFeatureParam:
      type: string
      description: The feature to be used for the read request.
      example: NUMBER_OF_TOTAL
      enum:
        - NUMBER_OF_TOTAL
        - INCLUDE_SHARED_STORAGES
        - INCLUDE_SHARED_WORKSPACE_STORAGES
      x-enumDescriptions:
        NUMBER_OF_TOTAL: Returns the total number of storages.
        INCLUDE_SHARED_STORAGES: Returns the shared storages.
        INCLUDE_SHARED_WORKSPACE_STORAGES: Returns the shared workspace storages.
    UpdateMonitoringReferenceDataSourcesReadFeatureParam:
      type: string
      description: The feature to be used for the read request.
      example: FETCH_ACTIVATION_STATUS
      enum:
        - FETCH_ACTIVATION_STATUS
      x-enumDescriptions:
        FETCH_ACTIVATION_STATUS: >-
          Returns information which data source is inactive for the
          organization.
    DataMonitorValiditySpanParam:
      type: object
      description: |
        Period after which Business Partner is evaluated again.
      properties:
        technicalKey:
          $ref: '#/components/schemas/DataMonitorValiditySpanTechnicalKeyParam'
    DataMonitorValiditySpan:
      type: object
      description: |
        Period after which Business Partner is evaluated again.
      properties:
        technicalKey:
          $ref: '#/components/schemas/DataMonitorValiditySpanTechnicalKey'
    DataMonitorValiditySpanTechnicalKeyParam:
      type: string
      description: Validity span period.
      example: YEAR
      enum:
        - HALF_YEAR
        - QUARTER
        - YEAR
      x-enumDescriptions:
        HALF_YEAR: 6 months validity span
        QUARTER: 3 months validity span
        YEAR: Year validity span
    DataMonitorValiditySpanTechnicalKey:
      type: string
      description: Validity span period.
      example: YEAR
      x-enumDescriptions:
        HALF_YEAR: 6 months validity span
        QUARTER: 3 months validity span
        YEAR: Year validity span
    DataMonitorPopulationJob:
      type: object
      description: |
        Last job that was scheduled during:
         * data monitor creation,
         * edit of configurationId in data monitor

        in order to populate data monitor.
      properties:
        id:
          $ref: '#/components/schemas/JobId'
    DataMonitorFeature:
      type: string
      description: Feature of a Data Monitor.
      example: BUILD_REPORT
    DataMonitorFeatureParam:
      type: string
      description: Feature of a Data Monitor.
      example: BUILD_REPORT
      enum:
        - BUILD_REPORT
      x-enumDescriptions:
        BUILD_REPORT: Builds report for data monitor when it has JOB execution type.
    DataMonitorUpdateFeatureParam:
      type: string
      description: Feature of a Data Monitor.
      example: BUILD_REPORT
      enum:
        - BUILD_REPORT
        - REEVALUATION_ON_CHANGES
      x-enumDescriptions:
        REEVALUATION_ON_CHANGES: >-
          Re-evaluates business partners based on changes in the configuration.
          This feature is not persisted.
    DataMonitorRefreshes:
      type: object
      description: List of data monitor refreshes.
      properties:
        dataMonitors:
          type: array
          description: List of Data Monitors.
          maxItems: 1
          items:
            $ref: '#/components/schemas/DataMonitorRefresh'
    DataMonitorRefresh:
      type: object
      description: Data Monitor refresh.
      properties:
        id:
          $ref: '#/components/schemas/DataMonitorId'
    DataMonitorRefreshResults:
      type: object
      description: Result of Data Monitor refresh.
      properties:
        dataMonitors:
          type: array
          description: List of Data Monitors.
          items:
            $ref: '#/components/schemas/DataMonitorRefreshResult'
    DataMonitorRefreshResult:
      type: object
      description: Result of Data Monitor reevaluation.
      properties:
        dataMonitor:
          $ref: '#/components/schemas/DataMonitorRefresh'
        status:
          type: string
          description: >
            * OK - the data monitor reevaluation has been started

            * NOT_FOUND - the data monitor is not found

            * APPLICATION_IN_PROGRESS - the data monitor reevaluation is not
            started because of currently running reevaluation
          example: APPLICATION_IN_PROGRESS
    DataMonitorProgressResult:
      type: object
      description: Data Monitor Progress for different processing statuses.
      properties:
        status:
          $ref: '#/components/schemas/Status'
        total:
          description: Total number of considered Business Partners.
          $ref: '#/components/schemas/DataMonitorProgressTotal'
        scope:
          $ref: '#/components/schemas/DataMonitorScope'
        processingStatuses:
          type: array
          items:
            $ref: '#/components/schemas/ProcessingStatusProgress'
    ProcessingStatusProgress:
      type: object
      description: Progress of specific processing status.
      properties:
        processingStatus:
          $ref: '#/components/schemas/ProcessingStatus'
        progress:
          $ref: '#/components/schemas/DataMonitorProcessingStatusProgress'
    ProcessingStatus:
      type: object
      description: Processing status.
      properties:
        technicalKey:
          $ref: '#/components/schemas/ProcessingStatusTechnicalKey'
        modifiedAt:
          $ref: '#/components/schemas/ModifiedAt'
    DataMonitorProcessingStatusProgress:
      type: object
      description: Progress of specific status.
      properties:
        total:
          $ref: '#/components/schemas/DataMonitorProgressTotal'
        percentage:
          $ref: '#/components/schemas/DataMonitorProgressPercentage'
    DataMonitorProgressTotal:
      type: integer
      format: int64
      description: Total number of Business Partners per processing status.
      example: '1001'
    DataMonitorProgressPercentage:
      type: number
      format: double
      description: >-
        Percentage (%) of number of Business Partners per processing status to
        all Business Partners in Data Monitor.
      example: '85'
    DataMonitorExecutionParam:
      type: object
      description: >-
        Execution of Data Monitor. Frequency required and only allowed in JOB
        execution type.
      required:
        - type
      properties:
        type:
          $ref: '#/components/schemas/DataMonitorExecutionTypeParam'
        frequency:
          $ref: '#/components/schemas/DataMonitorFrequencyEnum'
    DataMonitorExecutionTypeParam:
      type: object
      description: Type of the Data Monitor Execution.
      required:
        - technicalKey
      properties:
        technicalKey:
          $ref: '#/components/schemas/DataMonitorExecutionTypeTechnicalKeyEnum'
    DataMonitorScope:
      type: object
      description: Identifies scope for Data Monitor.
      properties:
        technicalKey:
          $ref: '#/components/schemas/DataMonitorScopeTechnicalKey'
    DataMonitorScopeTechnicalKey:
      type: string
      description: |
        Data Monitor scope of selected products.

        Augmentation Data Monitor may be one of:
        * AUGMENTED_BUSINESS_PARTNERS - enables Business Partner Augmentation
        * RAW_UPDATES - enables Raw Updates
        * OVERLAP - enables Overlap

        By default, when empty in Augmentation Data Monitor, below are enabled:
        * AUGMENTED_BUSINESS_PARTNERS
        * RAW_UPDATES
      example: RAW_UPDATES
    DataMonitorExecution:
      type: object
      description: Specifies how data monitors will be executed.
      required:
        - type
      properties:
        type:
          $ref: '#/components/schemas/DataMonitorExecutionType'
        frequency:
          $ref: '#/components/schemas/DataMonitorFrequency'
    DataMonitorExecutionType:
      type: object
      description: Type of the Data Monitor Execution.
      required:
        - technicalKey
      properties:
        technicalKey:
          $ref: '#/components/schemas/DataMonitorExecutionTypeTechnicalKey'
    UpdateMonitorReferenceDataSourcesResult:
      type: object
      description: Update Monitor Reference Data Sources Result.
      properties:
        referenceDataSources:
          type: array
          description: List of Reference Data Sources.
          items:
            $ref: '#/components/schemas/ReferenceDataSource'
    ReferenceDataSource:
      type: object
      description: Reference Data Source.
      properties:
        aleiPrefix:
          type: string
          description: The monitored Reference Data Source.
          example: VIES
        technicalKey:
          type: string
          description: Technical key of the Reference Data Source.
          example: VIES
        activationStatus:
          type: string
          description: >-
            Indicates whether the data source is active or inactive for the
            organization.
          example: ACTIVE
    BusinessPartnerStorageFeatureUpdateParam:
      type: string
      description: Available features of a storage.
      example: UPDATED_BUSINESS_PARTNER_ONLY
      enum:
        - LAB_UPDATED_BUSINESS_PARTNER
        - TAGS_MANAGED_BY_UPSERT
        - UPDATED_BUSINESS_PARTNER_ONLY
      x-enumDescruptions:
        LAB_UPDATED_BUSINESS_PARTNER: V4 and V5 updates working together.
        TAGS_MANAGED_BY_UPSERT: >-
          Tags are accepted from upsert, not via dedicated endpoints. Allowed
          only when storage does not have HOMELAND activated.
        UPDATED_BUSINESS_PARTNER_ONLY: V5 updates, V4 disabled.
    BusinessPartnerStorageFeatureOffUpdateParam:
      type: string
      description: Available features of a storage, that can be deactivated.
      example: TAGS_MANAGED_BY_UPSERT
      enum:
        - TAGS_MANAGED_BY_UPSERT
      x-enumDescruptions:
        TAGS_MANAGED_BY_UPSERT: >-
          Tags are accepted from upsert, not via dedicated endpoints. Allowed
          only when storage does not have HOMELAND activated.
    DecisionLogId:
      type: string
      description: ID of related decision log.
      example: 72d6900fc3wb326088f5d9d91044e3e6
    BusinessPartnerExternalIdParam:
      type: string
      description: >-
        Arbitrary identifier type to mark customer IDs that are \"external\"\ \
        from CDQ's perspective. This is the identifier a customer provides to
        identify\ \ its records.
      example: The ID managed in the customer's SAP systems.
      minLength: 1
    AddressContext:
      type: object
      description: >-
        The address context provides us with some additional information about
        the usage or specific recipient information of the addresses. It may
        hold multiple information organized as "tags".
      properties:
        value:
          $ref: '#/components/schemas/AddressContextValue'
    FetchBusinessPartnerRequest:
      type: object
      description: >-
        Allows fetching Business Partner information. It requires the externalId
        parameter and allows specifying the dataSource, featuresOn, and
        featuresOff parameters to customize the fetch operation.
      required:
        - externalId
      properties:
        externalId:
          $ref: '#/components/schemas/BusinessPartnerExternalIdParam'
        dataSource:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        featuresOn:
          type: array
          description: Features to be used during the fetch Business Partner.
          items:
            $ref: '#/components/schemas/FetchBusinessPartnerFeatureParam'
        featuresOff:
          type: array
          description: Features to be excluded during the fetch Business Partner.
          items:
            $ref: '#/components/schemas/FetchBusinessPartnerFeatureParam'
    FetchBusinessPartnerResult:
      type: object
      description: Result of fetching a Business Partner from Storage.
      properties:
        businessPartner:
          $ref: '#/components/schemas/BusinessPartner'
        status:
          $ref: '#/components/schemas/FetchBusinessPartnerStatus'
        message:
          $ref: '#/components/schemas/FetchBusinessPartnerMessage'
    FetchBusinessPartnerStatus:
      type: string
      description: |
        Status:
          * `OK` - Business Partner has been fetched successfully.
          * `NOT_FOUND` - Business Partner with that externalId+dataSource does not exist in storage.
      example: NOT_FOUND
    FetchBusinessPartnerMessage:
      type: string
      description: Detailed information about the status.
      example: Business Partner has been fetched successfully.
    MatchingProfile:
      type: object
      description: >-
        Matching profile used for the match. It contains the matching threshold
        and the matching scores.
      properties:
        matchingScores:
          $ref: '#/components/schemas/MatchingScores'
    MatchingScores:
      type: object
      description: >-
        List of the numerical value of similarity between Business Partners or
        addresses enhanced with the overall score.
      properties:
        overall:
          $ref: '#/components/schemas/MatchingScore'
        businessPartner:
          $ref: '#/components/schemas/MatchingScore'
        address:
          $ref: '#/components/schemas/MatchingScore'
    MatchingScore:
      type: object
      description: >-
        Shows numerical value of similarity between Business Partners or address
        stored in the Data Mirror and the Business Partner from the request.
      properties:
        classification:
          $ref: '#/components/schemas/MatchingClassification'
        value:
          type: number
          description: Matching score value.
          example: '0.9'
        explanation:
          type: string
          description: Explanation for matching score value.
          example: >-
            BP: [overall: [IDENTIFIER: 0.55; overall: 0.55;]] A: [overall:
            [COUNTRY_SHORTNAME: 0.5; overall: 0.5;]]
    MatchingClassification:
      type: object
      description: >-
        Classification of the matching score. It can be `HIGH`, `MEDIUM` or
        `LOW`.
      properties:
        technicalKey:
          type: string
          description: Technical key of the Matching Classification.
          example: HIGH
        name:
          type: string
          description: Name of the Matching Classification.
          example: My Matching Configuration
    ClassificationType:
      type: object
      description: >-
        Type of classification such as NACE, SIC, NAF or other industry
        classification standards.
      properties:
        name:
          $ref: '#/components/schemas/ClassificationTypeName'
        url:
          $ref: '#/components/schemas/ClassificationTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/ClassificationTypeTechnicalKey'
    IdentifierType:
      type: object
      description: Type of the identifier.
      properties:
        url:
          $ref: '#/components/schemas/IdentifierTypeUrl'
        name:
          $ref: '#/components/schemas/IdentifierTypeName'
        technicalKey:
          $ref: '#/components/schemas/schemas-IdentifierTypeTechnicalKey'
    NameType:
      type: object
      description: >-
        The type of the name, e.g. a locally used name or an international
        version.
      properties:
        url:
          $ref: '#/components/schemas/NameTypeUrl'
        name:
          $ref: '#/components/schemas/NameTypeName'
        technicalKey:
          $ref: '#/components/schemas/NameTypeTechnicalKey'
    MinorityIndicator:
      type: object
      description: >
        The minority indicator determines the minority group to which a vendor
        belongs. Usually, the minority indicator is only relevant in the United
        States, and it is used for reporting purposes only. There is a
        corresponding SAP field in the vendor master for maintaining the
        minority indicator.


        This feature is as of today dependent on data provided by a US based
        company: SupplierGateway.


        Additional documentation can be found
        [here](https://meta.cdq.com/Business_partner/partner_profile/minority_indicator).
      properties:
        value:
          $ref: '#/components/schemas/MinorityIndicatorValue'
    ThoroughfareType:
      type: object
      description: Type of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare).
      properties:
        name:
          $ref: '#/components/schemas/ThoroughfareTypeName'
        url:
          $ref: '#/components/schemas/ThoroughfareTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/ThoroughfareTypeTechnicalKey'
    LocalityType:
      type: object
      description: Type of the [Locality](https://meta.cdq.com/Address/locality).
      properties:
        name:
          $ref: '#/components/schemas/LocalityTypeName'
        url:
          $ref: '#/components/schemas/LocalityTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/LocalityTypeTechnicalKey'
    PremiseType:
      type: object
      description: Type of the Premise.
      properties:
        name:
          $ref: '#/components/schemas/PremiseTypeName'
        url:
          $ref: '#/components/schemas/PremiseTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/PremiseTypeTechnicalKey'
    PostCodeType:
      type: object
      description: >-
        A country specific code for a certain
        [address](https://meta.cdq.com/Address) component or a combination of
        [address](https://meta.cdq.com/Address) components, e.g.
        [locality](https://meta.cdq.com/Address/locality).
      properties:
        name:
          $ref: '#/components/schemas/PostCodeTypeName'
        url:
          $ref: '#/components/schemas/PostCodeTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/PostCodeTypeTechnicalKey'
    PostalDeliveryPointType:
      type: object
      description: A single mailbox or other place at which postal mail is delivered.
      properties:
        name:
          $ref: '#/components/schemas/PostalDeliveryPointTypeName'
        url:
          $ref: '#/components/schemas/PostalDeliveryPointTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/PostalDeliveryPointTypeTechnicalKey'
    AddressType:
      type: object
      description: >-
        An address type characterizes an address. The type of address is a
        structural statement and provides a truth that is applicable to any user
        (e.g. a legal address is a fact, or that an address is a PO BOX
        address), other than address functions that may differ from user to
        user. Address functions determine the particular business context in
        which an address is in use.
      properties:
        name:
          $ref: '#/components/schemas/AddressTypeName'
        url:
          $ref: '#/components/schemas/AddressTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/AddressTypeTechnicalKey'
    BusinessPartnerCategory:
      type: object
      description: >-
        A business partner category of a business partner groups similar
        business partners.
      properties:
        name:
          $ref: '#/components/schemas/BusinessPartnerCategoryName'
        url:
          $ref: '#/components/schemas/BusinessPartnerCategoryUrl'
        technicalKey:
          $ref: '#/components/schemas/BusinessPartnerCategoryTechnicalKey'
    SharingStatus:
      type: object
      description: Business Partner Sharing Statuses.
      properties:
        status:
          type: string
          description: |
            Sharing Status:
             * `ERRONEOUS_INFORMATION_FOR_LINKAGE` - The business partner violates at least one rule for required parameters defined by collaboration linkage strategy so can not be shared.
             * `ERRONEOUS_RECORD` - The business partner violates at least one rule that leads to an overall data validation result of ERROR, and can not be shared.
             * `MISSING_INFORMATION_FOR_LINKAGE` - The business partner has missing at least one of required parameters defined by collaboration linkage strategy so can not be shared.
             * `NATURAL_PERSON` - The record was identified as natural person and is therefore excluded from the sharing.
             * `PENDING_LINKAGE_DECISION` - As the matching result was uncertain the business partner is currently waiting to be reviewed before it can be shared.
             * `PROCESS_ISSUE` - During the last attempt to share the business partner process issue occurred. This business partner will be processed again.
             * `SHARED_WITH_NO_MATCH` - No match could be found and therefore the business partner was added to the community pool as a new business partner.
             * `SHARED_WITH_CONFIDENT_MATCH` - A confident match was found and therefore the business partner was linked to an existing business partner in the community pool.
             * `SHARED_WITH_NO_MATCH_BY_REVIEW` - Review decision has been made and the business partner was added to the community pool as a new business partner.
             * `SHARED_BY_REVIEW` - Review decision has been made and the business partner was linked to an existing business partner in the community pool.
             * `UNDER_CONSIDERATION` - The business partner will be considered for the sharing process.
             * `UNDISCLOSED_RECORD` - During the last attempt to share the business partner it was marked as 'undisclosed' and for that reason not considered.
          example: SHARED_WITH_NO_MATCH
        description:
          $ref: '#/components/schemas/SharingStatusDescription'
    SharingStatusDescription:
      type: string
      description: >-
        A description of the sharing status. This is a human-readable
        description of the sharing status.
      example: >-
        UNDER_CONSIDERATION: The business partner will be considered for the
        sharing process.
    IdentityLink:
      type: object
      description: Information about which BP in the sharing POOL was linked.
      properties:
        linkId:
          type: string
          description: >-
            Unique identifier for the link between the business partner and the
            sharing pool.
          example: 6465f2492bdcd350159a79d6
        cdqId:
          type: string
          description: Unique identifier for the Business Partner.
          example: VIES:PL8660001429
        addressId:
          type: string
          description: >-
            Unique identifier for the address which was used for the linkage in
            the POOL.
          example: '0'
        externalAddressId:
          type: string
          description: >-
            Unique identifier from an external source for the address which was
            used for the linkage in the POOL.
          example: '123456789'
    BusinessPartnerStatusType:
      type: object
      description: The standardized status which the business partner currently has.
      properties:
        name:
          $ref: '#/components/schemas/BusinessPartnerStatusTypeName'
        url:
          $ref: '#/components/schemas/BusinessPartnerStatusTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/BusinessPartnerStatusTypeTechnicalKey'
    CareOf:
      type: object
      description: >-
        Signifies an intermediary who is responsible for transferring a piece of
        mail between the postal system and the final addressee. For example,
        when the addressee has no standard address, is under a corporate mail
        system, or is being manually forwarded mail sent to a more accessible
        location.
      properties:
        value:
          $ref: '#/components/schemas/CareOfValue'
    ExternalId:
      type: object
      description: >-
        Arbitrary identifier type to mark customer IDs which are "external" from
        CDQ's perspective. This is the identifier a customer provides to
        identify her records, e.g. the ID she manages in her SAP systems.
      properties:
        externalId:
          $ref: '#/components/schemas/ExternalIdValue'
        dataSourceId:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        id:
          $ref: '#/components/schemas/ExternalIdValue'
        concept:
          $ref: '#/components/schemas/Concept'
        language:
          $ref: '#/components/schemas/Language'
        characterSet:
          $ref: '#/components/schemas/CharacterSet1'
        type:
          $ref: '#/components/schemas/AddressType'
    Property:
      type: object
      description: Part of a concept. It describes a single attribute of a concept.
      properties:
        parentConcept:
          $ref: '#/components/schemas/Concept'
        name:
          $ref: '#/components/schemas/PropertyName'
        technicalKey:
          $ref: '#/components/schemas/PropertyTechnicalKey'
        contentSelector:
          $ref: '#/components/schemas/PropertyContentSelector'
        instanceSelectors:
          type: array
          description: List of Instance Selectors.
          items:
            $ref: '#/components/schemas/PropertyContentInstanceSelector'
    Concept:
      type: object
      description: >-
        The Concept is a part of the CDQ data model. For example Address is a
        concept of the Business Partner and have many subconcepts as Locality,
        Thoroughfare, Administrative Area etc.
      properties:
        name:
          $ref: '#/components/schemas/ConceptName'
        technicalKey:
          $ref: '#/components/schemas/ConceptTechnicalKey'
    FieldsTransformationRequest:
      type: object
      description: Request to transform a list of business partners into key-value lists.
      properties:
        businessPartners:
          type: array
          description: List of Business Partners.
          items:
            $ref: '#/components/schemas/BusinessPartner'
    FieldsTransformationResult:
      type: object
      description: Result of transforming a list of business partners into key-value lists.
      properties:
        businessPartners:
          type: array
          description: List of Business Partners.
          items:
            $ref: '#/components/schemas/BusinessPartner'
        fieldBusinessPartners:
          type: array
          description: List of Field Business Partners.
          items:
            $ref: '#/components/schemas/FieldBusinessPartner'
    BusinessPartnersTransformationRequest:
      type: object
      description: Request to transform raw data to CDQ data model.
      properties:
        businessPartners:
          type: array
          description: List of Business Partners.
          items:
            $ref: '#/components/schemas/BusinessPartnerId'
    BusinessPartnersTransformationResult:
      type: object
      description: Result of transforming raw data to CDQ data model.
      properties:
        businessPartners:
          type: array
          description: List of Business Partners.
          items:
            $ref: '#/components/schemas/BusinessPartner'
    FieldBusinessPartner:
      type: object
      description: A list of transformed Business Partners with their properties.
      properties:
        fields:
          type: array
          description: List of fields.
          items:
            $ref: '#/components/schemas/Field'
    Field:
      type: object
      description: Key-value pair of a single Business Partner's property.
      properties:
        key:
          type: string
          description: The key represents the property name.
          example: ADDRESS
        value:
          type: string
          description: The value of the key.
          example: Lukasstrasse 4, 9008 St. Gallen, Switzerland
    UpdateDisclosureRequest:
      type: object
      description: Parameters for Update Disclosure job.
      required:
        - disclosed
      properties:
        disclosed:
          type: boolean
          description: >-
            Parameter to describe if the BusinessPartners should be disclosed
            (true) or undisclosed (false).
          example: 'true'
        dataSourceId:
          deprecated: true
          type: string
          description: >-
            A DataSource ID for which all related BusinessPartners should be
            un-/disclose.
          example: 648824a691d8d2503d65103e
        countryCode:
          deprecated: true
          type: string
          description: >-
            A country code (ISO 3166-2), to be used in combination with a
            DataSource ID to un-/disclose all matching BusinessPartners.
          example: DE
        businessPartnerIds:
          type: array
          description: >-
            List of BusinessPartner IDs to identify all those BusinessPartners
            that should be un-/disclose.
          minLength: 1
          items:
            $ref: '#/components/schemas/BusinessPartnerId'
    BusinessPartnerStorageFeatureParam:
      type: string
      description: Available features of a storage.
      example: LOOKUP
      enum:
        - LOOKUP
        - UPDATES
        - LAB_USE_INDEX_API
        - SHARING
        - DATA_MIRROR
        - HOMELAND
        - NEVER_EXPIRE
        - RELATIONS
        - TAGS_MANAGED_BY_UPSERT
      x-enumDescriptions:
        LOOKUP: Enables search capabilities for the given storage.
        UPDATES: Enables storing and querying of updates for the given storage.
        SHARING: Enables storage to participate in the CDQ sharing process.
        DATA_MIRROR: >-
          Defines storage as a Data Mirror. Turns on - NEVER_EXPIRE, LOOKUP,
          UPDATES, SHARING features. SHARING is not applied when records are not
          disclosed.
        HOMELAND: >-
          Defines storage as a Homeland Data Mirror. Turns on - DATA_MIRROR
          feature including its features.
        NEVER_EXPIRE: >-
          Specifies whether a storage should never expire. Always turned on for
          `DATA_MIRROR`. Caution - don't use too often due to quota limits.
        RELATIONS: Enables storage to contain relations.
        TAGS_MANAGED_BY_UPSERT: >-
          Tags are accepted from upsert, not via dedicated endpoints. Allowed
          only when storage does not have HOMELAND activated.
    BusinessPartnerStorageDataSourceCreate:
      type: object
      description: Create a new Data Source for a Storage.
      required:
        - name
      properties:
        name:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceName'
        dataMapperDefinitionId:
          $ref: '#/components/schemas/DataMapperDefinitionId'
        dataTransformationDefinitionId:
          $ref: '#/components/schemas/DataTransformationDefinitionId'
    BusinessPartnerStorageMetadataInternal:
      type: object
      description: Metadata of a Business Partner storage.
      properties:
        id:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        name:
          $ref: '#/components/schemas/BusinessPartnerStorageName'
        createdBy:
          $ref: '#/components/schemas/CreatedBy'
        organization:
          $ref: '#/components/schemas/BusinessPartnerStorageMetadataOrganization'
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        expiresAt:
          type: string
          description: >
            Date when storage expires.


            Possible values:

            * a date when a storage expires,

            * NEVER when storage is a Data Mirror or has been created including
            NEVER_EXPIRE feature.


            Expiry date is calculated based on the date of last write operation
            related

            to a storage (upsert of data, update of data sources, executed job)
            plus 6 months,

            refreshed as most 2 weeks before previous storage expiration date.
          example: '2025-08-19T06:23:16Z'
        dataMatchingDefinitionId:
          $ref: '#/components/schemas/DataMatchingDefinitionId'
        dataSources:
          type: array
          description: List of Data Sources.
          items:
            $ref: '#/components/schemas/DataSource'
        features:
          $ref: '#/components/schemas/FeatureStatuses'
        tags:
          type: array
          description: List of tags.
          maxItems: 10
          uniqueItems: true
          items:
            $ref: '#/components/schemas/StorageTag'
    BusinessPartnerStorageMetadataOrganization:
      type: object
      description: Your organization to which Business Partner storage is assigned.
      properties:
        id:
          $ref: '#/components/schemas/OrganizationId'
    StorageTag:
      type: string
      description: Tag to categorize the storage.
      example: Custom Tag
      minLength: 1
      maxLength: 20
    FeatureStatuses:
      type: object
      description: List of the feature statuses.
      properties:
        lookup:
          $ref: '#/components/schemas/FeatureStatus'
        updates:
          $ref: '#/components/schemas/FeatureStatus'
        sharing:
          $ref: '#/components/schemas/FeatureStatus'
        neverExpire:
          $ref: '#/components/schemas/FeatureStatus'
        tagsManagedByUpsert:
          $ref: '#/components/schemas/FeatureStatus'
        dataMirror:
          $ref: '#/components/schemas/FeatureStatus'
    FeatureStatusParam:
      type: string
      description: Status of a feature.
      example: ENABLED
      enum:
        - ENABLED
        - DISABLED
      x-enumDescriptions:
        ENABLED: Feature is activated.
        DISABLED: Feature is deactivated.
    JobDependency:
      type: object
      description: Job dependency data.
      properties:
        id:
          $ref: '#/components/schemas/JobId'
    IdentityLinkageJobCountry:
      type: object
      description: Country code (ISO 3166-1 alpha-2).
      properties:
        shortName:
          $ref: '#/components/schemas/CountryShortName'
    IdentityLinkageJobDataSource:
      type: object
      description: Storage data source that is interested in monitoring.
      properties:
        id:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
    IdentityLinkageJobStorageDataSource:
      type: object
      description: Storage data source that is to be monitored.
      properties:
        id:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
    IdentityLinkageJobReferenceDataSource:
      type: object
      description: Reference data source that is to be monitored.
      properties:
        technicalKey:
          $ref: '#/components/schemas/DataSourceTechnicalKey'
    BusinessPartnerUpdateMonitoring:
      type: boolean
      description: >
        A flag to indicate whether the Business Partner should receive updates
        from non-commercial Reference Data Sources or not.

        If 'true' this Business Partner will receive updates since the change
        from 'false'.

        If 'false' this Business Partner will not receive any new updates since
        the change.

        If not provided, the previous value will not be changed. By default,
        Update Monitoring is activated.
      example: 'true'
    BusinessPartnerUpdateCommercialMonitoring:
      type: object
      description: >-
        An indicator whether the Business Partner should receive updates from
        specific commercial Reference Data Source or not.
      required:
        - type
        - value
      properties:
        type:
          $ref: '#/components/schemas/BusinessPartnerUpdateCommercialMonitoringType'
        value:
          $ref: '#/components/schemas/BusinessPartnerUpdateCommercialMonitoringValue'
    BusinessPartnerUpdateCommercialMonitoringType:
      type: object
      description: Type of the Business Partner Update Commercial Monitoring.
      properties:
        technicalKey:
          $ref: >-
            #/components/schemas/BusinessPartnerUpdateCommercialMonitoringTypeTechnicalKey
    BusinessPartnerUpdateCommercialMonitoringTypeTechnicalKey:
      type: string
      description: >
        Name of commercial Reference Data Source that from which the Business
        Partner should receive updates. Possible values:

        *
        [DNB](https://directplus.documentation.dnb.com/openAPI.html?apiID=cmpelkv2)
        ([wiki](https://meta.cdq.com/Data_source/DNB))

        *
        [DNB_MASTER_DATA_BASIC](https://directplus.documentation.dnb.com/DataBlocks.html?apiID=dataBlocks&blockIDs=companyinfo_L1_v1)
        ([wiki](https://meta.cdq.com/Data_source/DNB.MASTER.DATA.BASIC))

        *
        [DNB_MASTER_DATA_EXTENDED](https://directplus.documentation.dnb.com/DataBlocks.html?apiID=dataBlocks&blockIDs=companyinfo_L2_v1,principalscontacts_L2_v2,hierarchyconnections_L1_v1)
        ([wiki](https://meta.cdq.com/Data_source/DNB.MASTER.DATA.EXTENDED))

        *
        [DNB_LINKAGE_LNKELI](https://directplus.documentation.dnb.com/openAPI.html?apiID=lnkeli)
        ([wiki](https://meta.cdq.com/Data_source/DNB.LINKAGE.LNKELI))
      example: DNB
    BusinessPartnerUpdateCommercialMonitoringValue:
      type: boolean
      default: false
      description: >
        Value of the Business Partner Update Commercial Monitoring.

        If 'true', the monitoring of this record will be activated on the
        commercial data source and this Business Partner will receive updates
        from that source.

        If 'false', the monitoring of this record will be deactivated in the
        commercial data source and this Business Partner will not receive any
        new updates from that source.

        By default, Update Commercial Monitoring is NOT activated.
      example: 'true'
    ExternalContext:
      type: object
      description: >-
        Represents additional context information that is external to the main
        Business Partner data.
      properties:
        identifiers:
          type: array
          description: List of Identifiers.
          items:
            $ref: '#/components/schemas/ExternalContextIdentifier'
    ExternalContextIdentifier:
      type: object
      description: An identifier of the External Context.
      properties:
        value:
          $ref: '#/components/schemas/ExternalContextIdentifierValue'
        type:
          $ref: '#/components/schemas/ExternalContextIdentifierType'
    ExternalContextIdentifierType:
      type: object
      description: Type of the External Context Identifier.
      properties:
        technicalKey:
          $ref: '#/components/schemas/ExternalContextIdentifierTypeTechnicalKey'
    BankAccount:
      type: object
      description: >-
        A bank account is a financial account maintained by a bank for a
        customer. A bank account can be a deposit account, a credit card, or any
        other type of account offered by a financial institution.
      properties:
        internationalBankAccountIdentifier:
          $ref: '#/components/schemas/InternationalBankAccountIdentifier'
        internationalBankIdentifier:
          $ref: '#/components/schemas/InternationalBankIdentifier'
        nationalBankAccountIdentifier:
          $ref: '#/components/schemas/NationalBankAccountIdentifier'
        nationalBankIdentifier:
          $ref: '#/components/schemas/NationalBankIdentifier'
        countryCode:
          $ref: '#/components/schemas/BankAccountCountryCode'
        vendorPaymentSummary:
          $ref: '#/components/schemas/VendorPaymentSummary'
    VendorPaymentSummary:
      type: object
      description: Vendor Payment Summary.
      properties:
        firstPaymentDate:
          $ref: '#/components/schemas/FirstPaymentDate'
        lastPaymentDate:
          $ref: '#/components/schemas/LastPaymentDate'
        numberOfPayments:
          $ref: '#/components/schemas/NumberOfPayments'
    BusinessPartnerRelationDeactivatedAt:
      type: string
      description: Describe when this relationship was deactivated. Read only.
      example: '2025-08-19T06:23:16Z'
    RelationAddress:
      type: object
      description: Address of the Business Partner.
      properties:
        country:
          $ref: '#/components/schemas/Country'
        postCodes:
          type: array
          description: List of Post Codes.
          items:
            $ref: '#/components/schemas/PostCode'
        localities:
          type: array
          description: List of Localities.
          items:
            $ref: '#/components/schemas/Locality'
        thoroughfares:
          type: array
          description: List of Thoroughfares.
          items:
            $ref: '#/components/schemas/Thoroughfare'
    BusinessPartnerRelationType:
      type: object
      description: >-
        Provides information about the type of the relationship between two
        Business Partners like:\ direct parent/child, ultimate parent, branch.
      properties:
        name:
          $ref: '#/components/schemas/BusinessPartnerRelationTypeName'
        technicalKey:
          $ref: '#/components/schemas/BusinessPartnerRelationTypeTechnicalKey'
    BusinessPartnerRelationClass:
      type: object
      description: Provides information about the classification of the relation.
      properties:
        name:
          $ref: '#/components/schemas/BusinessPartnerRelationClassName'
        technicalKey:
          $ref: '#/components/schemas/BusinessPartnerRelationClassTechnicalKey'
    BusinessPartnerType:
      type: object
      description: >-
        A distinct type a business partner is assigned to. It determines the
        business context a business partner is involved in. In the Corporate
        Data League, most business partners are legal entities.
      properties:
        name:
          $ref: '#/components/schemas/BusinessPartnerTypeName'
        url:
          $ref: '#/components/schemas/BusinessPartnerTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/BusinessPartnerTypeTechnicalKey'
    BusinessPartnerTypeTechnicalKeyParam:
      type: string
      description: Technical key of the Business Partner Type.
      example: LEGAL_ENTITY
      enum:
        - BP_ADDRESS
        - LEGAL_ENTITY
        - ORGANIZATIONAL_UNIT
        - UNKNOWN
        - BRAND
      x-enumDescritions:
        BP_ADDRESS: Business Partner Address
        LEGAL_ENTITY: Legal Entity
        ORGANIZATIONAL_UNIT: Organizational Unit
        UNKNOWN: Unknown
        BRAND: Brand
    ProcessingLogResultStatus:
      type: object
      description: >
        Summary of processing log result processed for this Business Partner.


        To enable processing log results, you need to [create data
        monitors](https://developer.cdq.com/reference-docs/data-exchange/V4/tag/Business-Partner-Storages/#tag/Business-Partner-Storages/paths/~1v2~1storages~1{storageId}~1datamonitors/post)
        for this storage.
      properties:
        processingLogId:
          $ref: '#/components/schemas/ProcessingLogId'
        triggerProcessedAt:
          $ref: '#/components/schemas/ProcessingLogResultStatusTriggerProcessedAt'
        triggerType:
          $ref: '#/components/schemas/ProcessingLogResultStatusTriggerType'
        trigger:
          $ref: '#/components/schemas/ProcessingLogResultStatusTrigger'
        jobProcessedAt:
          $ref: '#/components/schemas/ProcessingLogResultStatusJobProcessedAt'
        processedAt:
          $ref: '#/components/schemas/ProcessingLogResultStatusProcessedAt'
        status:
          $ref: '#/components/schemas/ProcessingLogResultStatusStatus'
        description:
          $ref: '#/components/schemas/ProcessingLogResultStatusDescription'
        processingStatus:
          $ref: '#/components/schemas/ProcessingStatus'
    ProcessingLogResultStatusTriggerProcessedAt:
      type: string
      description: Time when this log result has been processed by trigger.
      example: '2025-08-19T06:23:16Z'
    ProcessingLogResultStatusJobProcessedAt:
      type: string
      description: Time when this log result has been processed by job.
      example: '2025-08-19T06:23:16Z'
    ProcessingLogResultStatusProcessedAt:
      type: string
      description: Time when this log result has been processed.
      example: '2025-08-19T06:23:16Z'
    ProcessingLogResultStatusTrigger:
      description: Processing trigger reason.
      type: object
      properties:
        processedAt:
          $ref: '#/components/schemas/ProcessingLogResultStatusTriggerProcessedAt'
        provenance:
          $ref: '#/components/schemas/ProcessingLogResultStatusTriggerProvenance'
        type:
          $ref: '#/components/schemas/ProcessingLogResultStatusTriggerType'
    ProcessingLogResultStatusTriggerProvenance:
      description: Processing trigger provenance.
      type: object
      properties:
        name:
          $ref: '#/components/schemas/ProvenanceName'
        technicalKey:
          $ref: '#/components/schemas/ProvenanceTechnicalKey'
        cdqId:
          $ref: '#/components/schemas/ProvenanceCdqId'
    ProcessingLogResultStatusTriggerType:
      type: object
      description: Type of processing triggers.
      properties:
        name:
          $ref: '#/components/schemas/ProcessingLogResultStatusTriggerTypeName'
        technicalKey:
          $ref: >-
            #/components/schemas/ProcessingLogResultStatusTriggerTypeTechnicalKey
    ProcessingLogResultStatusTriggerTypeName:
      type: string
      description: Name of processing trigger reason.
      example: CREATED
    ProcessingLogResultStatusTriggerTypeTechnicalKey:
      type: string
      description: Technical Key of the processing trigger reason.
      example: CREATED
    ProcessingLogResultStatusTriggerTypeTechnicalKeyParam:
      type: string
      description: Technical Key of the processing trigger reason.
      example: CREATED
      enum:
        - CREATED
        - UPDATED
        - REFERENCE_DATA_CHANGED
        - REFRESHED
        - JOB
        - INITIALIZED,
        - CONFIGURATION_MODIFIED
        - MANUALLY_FORCED
        - MONITORING_REENABLED
      x-enumDescription:
        CREATED: Business Partner has been created.
        UPDATED: Business Partner has been updated.
        REFERENCE_DATA_CHANGED: >-
          There was a change in referenced Business Partner from external Data
          Source.
        REFRESHED: Business Partner has been refreshed.
        JOB: evaluated via a job.
        INITIALIZED: >-
          Covers 2 use cases: data monitor has been created; data monitor has
          been reactivated and business partner didn't have processing log
          results before - it was created when monitor was deactivated.
        CONFIGURATION_MODIFIED: >-
          Configuration has been modified for scope, where business partner is
          considered.
        MANUALLY_FORCED: Processing of all business partners has been forced by customer.
        MONITORING_REENABLED: >-
          Data monitor has been enabled from disabled and business partner
          already had processing log results before.
    ProcessingLogResultStatusStatus:
      type: string
      description: Status of log result.
      example: INFO
    ProcessingLogResultStatusDescription:
      type: string
      description: Description of log result.
      example: Validation Level
    Language:
      type: object
      description: Naming of a language according to ISO 639-1.
      properties:
        name:
          $ref: '#/components/schemas/LanguageName'
        technicalKey:
          $ref: '#/components/schemas/LanguageTechnicalKey'
    LegalFormCategory:
      type: object
      description: The categorization of a Legal Form.
      properties:
        name:
          $ref: '#/components/schemas/LegalFormCategoryName'
        shortName:
          $ref: '#/components/schemas/LegalFormCategoryShortName'
        url:
          $ref: '#/components/schemas/LegalFormCategoryUrl'
        technicalKey:
          $ref: '#/components/schemas/LegalFormCategoryTechnicalKey'
    IssuingBody:
      type: object
      description: >-
        An Issuing Body is an organization or government institution that is
        responsible for assigning unique identifiers to individuals,
        organizations, or objects.
      properties:
        name:
          $ref: '#/components/schemas/IssuingBodyName'
        url:
          $ref: '#/components/schemas/IssuingBodyUrl'
        technicalKey:
          $ref: '#/components/schemas/IssuingBodyTechnicalKey'
        jurisdiction:
          $ref: '#/components/schemas/Jurisdiction'
    Jurisdiction:
      type: object
      description: >-
        The authority of an official organization to make decisions and
        judgments in a particular administrative area.
      properties:
        country:
          $ref: '#/components/schemas/Country'
    IdentifierStatus:
      type: object
      description: >-
        Describes the status of an identifier with respect to its level of
        activity (e.g. out of business) or legally relevant conditions (e.g. in
        liquidation).
      properties:
        name:
          $ref: '#/components/schemas/IdentifierStatusName'
        technicalKey:
          $ref: '#/components/schemas/IdentifierStatusTechnicalKey'
    HcpProfile:
      type: object
      description: >
        Healthcare Professional Profile informs about the status, licenses, and
        location of a natural person who is a member 

        of the medical, dental, pharmacy, or nursing professions or any other
        person who, in the course of his/her professional 

        activities, may prescribe, purchase, supply, recommend or administer a
        Medicinal Product and whose primary practice, 

        principal professional address or place of incorporation is in Europe.
      properties:
        generalLicense:
          $ref: '#/components/schemas/GeneralLicense'
        operationalPermissions:
          type: array
          description: Operational permissions of the Healthcare Professional.
          items:
            $ref: '#/components/schemas/OperationalPermission'
    GeneralLicense:
      type: object
      description: The general license of the Healthcare Professional.
      properties:
        professionType:
          $ref: '#/components/schemas/ProfessionType'
        licenseStatus:
          $ref: '#/components/schemas/LicenseStatus'
    ProfessionType:
      type: object
      description: The profession type of the Healthcare Professional.
      properties:
        name:
          $ref: '#/components/schemas/ProfessionTypeName'
        url:
          $ref: '#/components/schemas/ProfessionTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/ProfessionTypeTechnicalKey'
    LicenseStatus:
      type: object
      description: The license status of the Healthcare Professional.
      properties:
        name:
          $ref: '#/components/schemas/LicenseStatusName'
        url:
          $ref: '#/components/schemas/LicenseStatusUrl'
        technicalKey:
          $ref: '#/components/schemas/LicenseStatusTechnicalKey'
    OperationalPermission:
      type: object
      description: The operational permission of the Healthcare Professional.
      properties:
        issuingAuthority:
          type: string
          description: The issuing authority of the operational permission.
          example: Swiss Medical Association
        permissionStatus:
          $ref: '#/components/schemas/PermissionStatus'
        activityStatus:
          $ref: '#/components/schemas/ActivityStatus'
        practiceLocations:
          type: array
          description: Practice locations of the Healthcare Professional.
          items:
            $ref: '#/components/schemas/PracticeLocation'
    PermissionStatus:
      type: object
      description: The permission status of the operational permission.
      properties:
        name:
          $ref: '#/components/schemas/PermissionStatusName'
        url:
          $ref: '#/components/schemas/PermissionStatusUrl'
        technicalKey:
          $ref: '#/components/schemas/PermissionStatusTechnicalKey'
    ActivityStatus:
      type: object
      description: The activity status of the operational permission.
      properties:
        name:
          $ref: '#/components/schemas/ActivityStatusName'
        url:
          $ref: '#/components/schemas/ActivityStatusUrl'
        technicalKey:
          $ref: '#/components/schemas/ActivityStatusTechnicalKey'
    PracticeLocation:
      type: object
      description: The practice location of the Healthcare Professional.
      properties:
        practiceName:
          type: string
          description: The practice location of the Healthcare Professional.
          example: VIVOMED AG
        selfDispensationStatus:
          $ref: '#/components/schemas/SelfDispensationStatus'
        controlledSubstancePurchasePermission:
          $ref: '#/components/schemas/ControlledSubstancePurchasePermission'
    SelfDispensationStatus:
      type: object
      description: The self-dispensation status of the Healthcare Professional.
      properties:
        name:
          $ref: '#/components/schemas/SelfDispensationStatusName'
        url:
          $ref: '#/components/schemas/SelfDispensationStatusUrl'
        technicalKey:
          $ref: '#/components/schemas/SelfDispensationStatusTechnicalKey'
    ControlledSubstancePurchasePermission:
      type: object
      description: >-
        The controlled substance purchase permission of the Healthcare
        Professional.
      properties:
        name:
          $ref: '#/components/schemas/ControlledSubstancePurchasePermissionName'
        url:
          $ref: '#/components/schemas/ControlledSubstancePurchasePermissionUrl'
        technicalKey:
          $ref: >-
            #/components/schemas/ControlledSubstancePurchasePermissionTechnicalKey
    PhoneNumber:
      type: object
      description: >-
        The main phone number of a business partner, usually some info-line of
        the headquarters.
      properties:
        countryPrefix:
          $ref: '#/components/schemas/PhoneNumberCountryPrefix'
        number:
          $ref: '#/components/schemas/PhoneNumberNumber'
        type:
          $ref: '#/components/schemas/PhoneNumberType'
        value:
          $ref: '#/components/schemas/PhoneNumberValue'
    PhoneNumberType:
      type: object
      description: >-
        The type of phone number such as mobile phone or fixed line 
        [here](https://meta.cdq.com/Business_partner/partner_profile/phone_number/type).
      properties:
        name:
          $ref: '#/components/schemas/PhoneNumberTypeName'
        url:
          $ref: '#/components/schemas/PhoneNumberTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/PhoneNumberTypeTechnicalKey'
    Website:
      type: object
      description: >-
        Webpages related to the business partner, e.g. the main corporate
        website as also provided by some company registers.
      properties:
        url:
          $ref: '#/components/schemas/WebsiteUrl'
        type:
          $ref: '#/components/schemas/WebsiteType'
    WebsiteType:
      type: object
      description: >-
        Describes the type of website of a business partner, e.g. corporate
        website, official LinkedIn profile, etc.
      properties:
        name:
          $ref: '#/components/schemas/WebsiteTypeName'
        url:
          $ref: '#/components/schemas/WebsiteTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/WebsiteTypeTechnicalKey'
    ContactEmail:
      type: object
      description: Actual email address of the Business Partner.
      properties:
        value:
          $ref: '#/components/schemas/ContactEmailValue'
    Tag:
      type: object
      description: >
        Typed string describing and identifying a resource. Custom information
        about the resource in form of a tag.


        Read-only value, not allowed to send in any creation endpoints, e.g.
        `PUT /v4/storages/{storageId}/businesspartners` endpoint (leads to Bad
        Request).
      properties:
        value:
          $ref: '#/components/schemas/TagValue'
        type:
          $ref: '#/components/schemas/TagType'
    TagType:
      type: object
      description: A type that specifies the nature of the tag.
      required:
        - technicalKey
      properties:
        technicalKey:
          $ref: '#/components/schemas/TagTypeTechnicalKey'
    AddressCdqId:
      type: string
      description: CDQ ID of an address.
      example: CDQID-123456789
    AddressVersion:
      type: object
      description: >-
        CDQ supports multiple versions of addresses comprising different
        charsets and languages. An address version is a unique combination of a
        character set and a language.
      properties:
        language:
          $ref: '#/components/schemas/Language'
        characterSet:
          $ref: '#/components/schemas/CharacterSet'
    CharacterSet:
      type: object
      description: >-
        Character set. Available values can be found
        [here](https://meta.cdq.com/Address/version/character_set).
      properties:
        name:
          $ref: '#/components/schemas/CharacterSetName'
        technicalKey:
          $ref: '#/components/schemas/CharacterSetTechnicalKey'
    AddressIdentifyingName:
      type: object
      description: >-
        An identifying name assigned to an address. In most cases the
        identifying name refers to the name of a registered agent.
      properties:
        value:
          $ref: '#/components/schemas/AddressIdentifyingNameValue'
    BusinessPartnerLookupParam:
      type: object
      description: >-
        Lookup business partner data in connected data sources like the CDQ
        Community Data Pool, Business registers, or even in the own data mirror.
      properties:
        externalId:
          $ref: '#/components/schemas/BusinessPartnerExternalId'
        record:
          $ref: '#/components/schemas/BusinessPartnerRecord'
        names:
          type: array
          description: List of names.
          items:
            $ref: '#/components/schemas/NameLookupParam'
        identifiers:
          type: array
          description: List of identifiers.
          items:
            $ref: '#/components/schemas/IdentifierLookupParam'
        legalForm:
          $ref: '#/components/schemas/LegalFormLookupParam'
        addresses:
          type: array
          description: List of addresses.
          maxItems: 1
          items:
            $ref: '#/components/schemas/AddressLookupParam'
        externalContext:
          $ref: '#/components/schemas/ExternalContextLookupParam'
        profile:
          $ref: '#/components/schemas/ProfileLookupParam'
    NameLookupParam:
      type: object
      description: The name of a Business Partner.
      properties:
        value:
          $ref: '#/components/schemas/NameValue'
    IdentifierLookupParam:
      type: object
      description: >-
        Identifies a Business Partner in a given context uniquely such as a VAT
        identification number.
      properties:
        value:
          $ref: '#/components/schemas/IdentifierValue'
        type:
          $ref: '#/components/schemas/IdentifierTypeLookupParam'
    IdentifierTypeLookupParam:
      type: object
      description: Type of the identifier.
      properties:
        technicalKey:
          $ref: '#/components/schemas/schemas-IdentifierTypeTechnicalKey'
    LegalFormLookupParam:
      type: object
      description: >-
        The legal form of a Business Partner is the form it takes in the eyes of
        the law governing it. The legal form of a company is the general type it
        may legally use to identify itself according to the local, regional,
        national, or international law governing it. This is normally reflected
        in the ending abbreviation after the company's name.
      properties:
        name:
          $ref: '#/components/schemas/LegalFormName'
    AddressLookupParam:
      type: object
      description: >-
        An address provides information about the physical location of a
        Business Partner. It can be specialized in a certain context(e.g.
        delivery address or invoice address).
      properties:
        country:
          $ref: '#/components/schemas/CountryLookupParam'
        administrativeAreas:
          type: array
          description: List of administrative areas.
          items:
            $ref: '#/components/schemas/AdministrativeAreaLookupParam'
        localities:
          type: array
          description: List of localities.
          items:
            $ref: '#/components/schemas/LocalityLookupParam'
        postCodes:
          type: array
          description: List of post codes.
          items:
            $ref: '#/components/schemas/PostCodeLookupParam'
        thoroughfares:
          type: array
          description: List of thoroughfares.
          items:
            $ref: '#/components/schemas/ThoroughfareLookupParam'
    CountryLookupParam:
      type: object
      description: Country code (ISO 3166-1 alpha-2).
      properties:
        shortName:
          $ref: '#/components/schemas/CountryShortName'
    AdministrativeAreaLookupParam:
      type: object
      description: A top-level geographical or political area division in a country.
      properties:
        value:
          $ref: '#/components/schemas/AdministrativeAreaValue'
    LocalityLookupParam:
      type: object
      description: >-
        A locality is a named densely populated area (a place) such as town,
        village, suburb, etc. A locality composes of many individual addresses.
        Many localities exist in an administrative area. A locality can also
        have several levels of sub localities.
      properties:
        value:
          $ref: '#/components/schemas/LocalityValue'
    PostCodeLookupParam:
      type: object
      description: >-
        A country specific code for a certain address component or a combination
        of address components, e.g. locality.
      properties:
        value:
          $ref: '#/components/schemas/PostCodeValue'
    ThoroughfareLookupParam:
      type: object
      description: >-
        Details of the access route along which buildings, lots, or land are
        located, such as street, road, channel, crescent, avenue, etc. This also
        includes canals or banks on which houses or boat houses are located
        where people live.
      properties:
        value:
          $ref: '#/components/schemas/ThoroughfareValue'
        number:
          $ref: '#/components/schemas/ThoroughfareNumber'
    ExternalContextLookupParam:
      type: object
      description: External context of a Business Partner.
      properties:
        identifiers:
          type: array
          description: List of identifiers.
          items:
            $ref: '#/components/schemas/ExternalContextIdentifierLookupParam'
    ExternalContextIdentifierLookupParam:
      type: object
      description: Identifies a Business Partner in a given context.
      properties:
        value:
          $ref: '#/components/schemas/ExternalContextIdentifierValue'
        type:
          $ref: '#/components/schemas/ExternalContextIdentifierTypeLookupParam'
    ExternalContextIdentifierTypeLookupParam:
      type: object
      description: Type of the identifier.
      properties:
        technicalKey:
          $ref: '#/components/schemas/ExternalContextIdentifierTypeTechnicalKey'
    ProfileLookupParam:
      type: object
      description: Profile of a Business Partner.
      properties:
        tags:
          type: array
          description: List of tags.
          items:
            $ref: '#/components/schemas/TagLookupParam'
    TagLookupParam:
      type: object
      description: Typed string describing and identifying a resource.
      properties:
        value:
          $ref: '#/components/schemas/TagValue'
        type:
          $ref: '#/components/schemas/TagTypeLookupParam'
    TagTypeLookupParam:
      type: object
      description: A type of the tag.
      properties:
        technicalKey:
          $ref: '#/components/schemas/TagTypeTechnicalKey'
    UpsertFeatureParam:
      type: string
      description: Features to be used during the upsert.
      example: UPSERT_BY_EXTERNAL_ID
      enum:
        - UPSERT_BY_EXTERNAL_ID
        - API_ERROR_ON_FAILURES
        - LAB_USE_QUEUES
        - TRANSFORM_RECORD
        - ENABLE_SETTINGS
        - ENABLE_ASYNC
      x-enumDescriptions:
        UPSERT_BY_EXTERNAL_ID: >-
          Updates a Business Partners identified by external ID instead of an
          insert if the external ID is already present in this storage.
        API_ERROR_ON_FAILURES: Throws exception instead of default Upsert Failure Log.
        TRANSFORM_RECORD: >-
          Transforms record into Business Partner model using the
          dataMapperDefinition attached to the dataSource. Supported only for
          batch size up to 250 Business Partners.
        ENABLE_SETTINGS: >-
          Enables usage of user and organization settings in upsert process.
          Enabled by default.
        ENABLE_ASYNC: >-
          Stores data to the storage. Enables asynchronous data processing for
          transformation, updates, indexing and sharing processes. Requires
          externalId to be present in the businessPartner. Enabled by default
          when TRANSFORM_RECORD not used.
    RelationsUpsertRequest:
      type: object
      description: >
        Request for Business Partner Upsert. Each relation must have a unique
        combination of startNodeExternalId, endNodeExternalId and relationType.

        If a relation with the same combination of startNodeExternalId,
        endNodeExternalId and relationType already exists in the storage, it
        will be updated.

        If a relation with the same combination of startNodeExternalId,
        endNodeExternalId and relationType does not exist in the storage, it
        will be inserted.
      required:
        - relations
      properties:
        relations:
          type: array
          description: Batch of Business Partner relations.
          minItems: 1
          maxItems: 1000
          items:
            $ref: '#/components/schemas/BusinessPartnerRelation'
    RelationsUpsertResult:
      type: object
      description: Result of Business Partner Relations Upsert.
      properties:
        numberOfProvidedRelations:
          type: integer
          description: Number of provided Business Partner Relations.
          example: '10'
        numberOfInserts:
          type: integer
          description: Number of inserted Business Partners.
          example: '10'
        numberOfUpdates:
          type: integer
          description: Number of updated Business Partners.
          example: '10'
        numberOfFailed:
          type: integer
          description: Number of failed inserts.
          example: '10'
        failures:
          type: array
          description: List of relations failed to be inserted or updated.
          items:
            $ref: '#/components/schemas/RelationUpsertFailureLog'
    RelationUpsertFailureLog:
      type: object
      description: Log of a failed relation upsert.
      properties:
        startNodeExternalId:
          $ref: '#/components/schemas/RelationUpsertFailureLogExternalId'
        endNodeExternalId:
          $ref: '#/components/schemas/RelationUpsertFailureLogExternalId'
        message:
          $ref: '#/components/schemas/RelationUpsertFailureLogMessage'
    RelationUpsertFailureLogExternalId:
      type: string
      description: External ID of a Business Partner.
      example: '78643267348'
    RelationUpsertFailureLogMessage:
      type: string
      description: Error message.
      example: Missing data source ID.
    FetchBusinessPartnerFeatureParam:
      type: string
      description: Fetch Business Partner Feature.
      example: FETCH_RECORD
      enum:
        - FETCH_RECORD
        - FETCH_RELATIONS
      x-enumDescriptions:
        FETCH_RECORD: >-
          Allows to switch fetching record field to reduce data size. By
          default, turned on.
        FETCH_RELATIONS: >-
          Allows to switch fetching relations of Business Partners. By default,
          deactivated. Only for storages with RELATIONS feature activated.
    ReadBusinessPartnerFeatureParam:
      type: string
      description: Read Business Partner Feature.
      example: FETCH_RECORD
      enum:
        - APPLY_CURATION_DECISIONS
        - FETCH_RECORD
        - FETCH_RELATIONS
      x-enumDescription:
        APPLY_CURATION_DECISIONS: >-
          Applies curation decisions from Decision Log to business partner if
          any decisions found. By default, deactivated.
        FETCH_RECORD: >-
          Allows to switch fetching record field to reduce data size. By
          default, turned on.
        FETCH_RELATIONS: >-
          Allows to switch fetching relations of Business Partners. By default,
          deactivated. Only for storages with RELATIONS feature activated.
    BusinessPartnerEventCreatesRequest:
      type: object
      description: Request for Business Partner Event Creates.
      required:
        - businessPartners
      properties:
        businessPartners:
          type: array
          description: List of Business Partners.
          minItems: 1
          maxItems: 500
          items:
            $ref: '#/components/schemas/BusinessPartner'
        featuresOn:
          type: array
          description: Features to be activated during the upsert.
          items:
            $ref: '#/components/schemas/EventCreateFeatureParam'
    BusinessPartnerEventFlattenFeatureParam:
      type: string
      description: Feature to be used during the flattening.
      example: DELETE_WHEN_DELETED
      enum:
        - DELETE_WHEN_DELETED
        - FLATTEN_ALL_UPDATED_TO_ONE_LATEST
        - FLATTEN_ALL_EVENTS_TO_CREATED_WITH_LATEST_DATE
        - FLATTEN_ALL_EVENTS_TO_CREATED_WITH_LATEST_DATE_OR_REBUILD_CREATED
        - FLATTEN_OVER_6_MONTHS
      x-enumDescriptions:
        DELETE_WHEN_DELETED: >-
          Deletes all events of a Business Partner if a Business Partner doesn't
          exist anymore.
        FLATTEN_ALL_UPDATED_TO_ONE_LATEST: >-
          Flattens all update events to one with the date of the latest update
          event.
        FLATTEN_ALL_EVENTS_TO_CREATED_WITH_LATEST_DATE: >-
          Flattens all events to one created with the date of the latest update
          event.
        FLATTEN_ALL_EVENTS_TO_CREATED_WITH_LATEST_DATE_OR_REBUILD_CREATED: >-
          Flattens all events to one created even if there is only one created,
          with the date of the latest update event or created event.
        FLATTEN_OVER_6_MONTHS: Flatten all events over 6 months.
    ValidationLevelParam:
      type: string
      description: Violation level of validation result.
      example: WARNING
      enum:
        - OK
        - ERROR
        - WARNING
        - INFO
        - UNKNOWN
      x-enumDescriptions:
        OK: No data quality issues have been found after executing all the rules.
        ERROR: At least 1  `ERROR`  defect has been found.
        WARNING: At least 1  `WARNING`  defect has been found.
        INFO: At least 1  `INFO`  defect has been found.
        UNKNOWN: >-
          No  `ERROR`  has been found, but at least one data quality rule could
          not be executed.
    CurationLevelParam:
      type: string
      description: Curation log of curation result.
      example: LEVEL_1
      enum:
        - LEVEL_1
        - LEVEL_2
        - LEVEL_3
        - LEVEL_4
        - LEVEL_5
        - LEVEL_6
        - UNKNOWN
      x-enumDescriptions:
        UNKNOWN: No possibility to determine curation level.
        LEVEL_1: >-
          The address was not found by the CDQ in the employed external data
          sources.
        LEVEL_2: >-
          The address was found, but there were significant changes in critical
          fields.
        LEVEL_3: >-
          The address was found and there are minor changes in highly important
          fields.
        LEVEL_4: >-
          The address was found by the CDQ. There were only  changes in less
          critical fields such as the address/premise or
          address/thoroughfare/number.
        LEVEL_5: >-
          The address was found by the CDQ, but no major changes have been made
          as the address was correct.
        LEVEL_6: >-
          The address was found in the shared CDQ data pool. This means another
          company uses the same address which is a very reliable indicator that
          the address is correct (only  in an alpha version).
    BusinessPartnerIdentityLinksReadFeatureParam:
      type: string
      description: >-
        The features to be used during the reading Business Partner Identity
        Links.
      example: ACCEPT_REPLICATION_DELAYS
      enum:
        - ACCEPT_REPLICATION_DELAYS
        - NUMBER_OF_TOTAL
      x-enumDescriptions:
        ACCEPT_REPLICATION_DELAYS: >-
          Accepts replication delays in persisting to the database. Allows
          faster data access. By default, deactivated.
        NUMBER_OF_TOTAL: >-
          Allows to switch fetching the total number of Business Partners to
          improve performance. By default, turned on.
    BusinessPartnersReadFeatureParam:
      type: string
      description: >-
        The features to be activated/deactivated during the reading Business
        Partners.
      example: APPLY_CURATION_DECISIONS
      enum:
        - APPLY_CURATION_DECISIONS
        - CURATION_LOG_RESULT_STATUSES
        - FETCH_RECORD
        - FETCH_RELATIONS
        - NUMBER_OF_TOTAL
        - USE_NEXT_START_AFTER
        - VALIDATION_LOG_RESULT_STATUSES
      x-enumDescriptions:
        APPLY_CURATION_DECISIONS: >-
          Applies curation decisions from Decision Log to business partner if
          any decisions found. By default, deactivated.
        CURATION_LOG_RESULT_STATUSES: >-
          Allows to switch fetching curation log result statuses. By default,
          deactivated.
        FETCH_RECORD: >-
          Allows to switch fetching record field to reduce data size. By
          default, turned on.
        FETCH_RELATIONS: >-
          Allows to switch fetching relations of Business Partners. By default,
          deactivated. Only for storages with RELATIONS feature activated.
        NUMBER_OF_TOTAL: >-
          Allows to switch fetching the total number of Business Partners to
          improve performance. By default, turned on.
        USE_NEXT_START_AFTER: >-
          Allows to switch fetching the next page of Business Partners using the
          nextStartAfter value. By default, deactivated.
        VALIDATION_LOG_RESULT_STATUSES: >-
          Allows to switch fetching validation log result statuses. By default,
          deactivated.
    BusinessPartnerRandomPage:
      type: object
      description: Return random page with business partners data.
      properties:
        limit:
          $ref: '#/components/schemas/Limit'
        values:
          type: array
          description: List of Business Partners.
          items:
            $ref: '#/components/schemas/BusinessPartner'
    PropertyChange2:
      type: object
      description: >-
        Describes how a property has been changed and how confident we are that
        the change was a good improvement
      properties:
        externalIds:
          type: array
          description: List of External IDs.
          items:
            $ref: '#/components/schemas/ExternalId'
        property:
          $ref: '#/components/schemas/Property'
        newContent:
          $ref: '#/components/schemas/PropertyNewContent'
        previousContent:
          $ref: '#/components/schemas/PropertyPreviousContent'
        provenance:
          $ref: '#/components/schemas/Provenance2'
        changeType:
          $ref: '#/components/schemas/PropertyChangeTypeTechnicalKey'
        changeClassification:
          $ref: '#/components/schemas/schemas-PropertyChangeClassification'
        confidenceScore:
          $ref: '#/components/schemas/PropertyChangeConfidenceScore'
        maxConfidenceScore:
          $ref: '#/components/schemas/PropertyChangeMaxConfidenceScore'
    PropertyPreviousContent:
      type: string
      example: AAB
      description: >
        Value of a property before change.

        * In update coming from reference data source, this is a value from a
        Business Partner

        from this storage that the update suggests to change.

        * In own update done via upsert, this is a last value of this property
        that is coming

        out of last of previous updates of this Business Partner where this
        property

        was changed - it can be either previous own update or update coming from
        reference data source.
    PropertyNewContent:
      type: string
      example: AAB
      description: |
        New value of a property that:
        * has been changed by own update or
        * is an update proposal coming from reference data source.
    CharacterSet1:
      type: object
      description: Character set.
      properties:
        name:
          $ref: '#/components/schemas/CharacterSetName'
        technicalKey:
          $ref: '#/components/schemas/CharacterSetTechnicalKey'
    PropertyContentInstanceSelector:
      type: object
      description: Contains JSON paths allowing to select specific instance of a property.
      properties:
        key:
          $ref: '#/components/schemas/PropertyContentInstanceSelectorKey'
        value:
          $ref: '#/components/schemas/PropertyContentInstanceSelectorValue'
    Provenance2:
      type: object
      description: >-
        The source of the change/update. Could be the reference data source as
        VIES or Organization.
      properties:
        name:
          $ref: '#/components/schemas/ProvenanceName'
        url:
          $ref: '#/components/schemas/ProvenanceUrl'
        technicalKey:
          $ref: '#/components/schemas/ProvenanceTechnicalKey'
        cdqId:
          $ref: '#/components/schemas/ProvenanceCdqId'
    LinkStatus:
      type: object
      description: Details about status or error of a service
      properties:
        details:
          type: array
          items:
            $ref: '#/components/schemas/LinkStatusDetails'
    LinkStatusDetails:
      type: object
      description: Details about this status or error
      properties:
        message:
          $ref: '#/components/schemas/StatusDetailsMessage'
        technicalKey:
          $ref: '#/components/schemas/StatusDetailsTechnicalKey'
    LinkageStatus:
      type: string
      description: |
        Status of the linkage:  
          * SUCCESSFULLY_LINKED - Country and identifier exists, result found by lookup and contains cdqId. Link created.
          * MISSING_INFORMATION_FOR_LINKAGE - Missing country or information for linkage strategy.
          * NO_MATCH_FOUND - No result from lookup.
          * NO_CONFIDENT_MATCH_FOUND - No confident result from lookup.
          * NO_MATCH_ADDRESS_VERSION - Result found in lookup but address version doesn’t match.
          * UNDER_CONSIDERATION - Linkage is under consideration.
          * PROCESS_ISSUE - Internal issues or issues with reference data sources.
          * QUOTA_LIMIT - The customer doesn’t have enough quota.
          * INACTIVE_SOURCE - Reference Data source is not activated for the organization or credentials are not provided.
          * ERRONEOUS_IDENTIFIER - Business Partner didn’t pass the validation due to an incorrect identifier.
          * EXTERNAL_SERVICE_NOT_AVAILABLE - Lookup would succeed if external service was available.
      example: SUCCESSFULLY_LINKED
    BusinessPartnerIdentityLinkDataSource:
      type: object
      description: >-
        Data Source of the Business Partner which was used for the linkage in
        the POOL.
      properties:
        id:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
    BusinessPartnerIdentityLinkPage:
      type: object
      description: Page of Business Partner Identity Links.
      properties:
        startAfter:
          $ref: '#/components/schemas/StartAfter'
        nextStartAfter:
          $ref: '#/components/schemas/NextStartAfter'
        limit:
          $ref: '#/components/schemas/Limit'
        total:
          $ref: '#/components/schemas/PageTotal'
        values:
          type: array
          description: List of Business Partner Identity Links.
          items:
            $ref: '#/components/schemas/BusinessPartnerIdentityLink'
    SharingScope:
      type: object
      description: Indicates scope of Business Partners desired for sharing.
      properties:
        id:
          $ref: '#/components/schemas/SharingScopeId'
        description:
          $ref: '#/components/schemas/SharingScopeDescription'
        dataSources:
          type: array
          description: List of Data Sources.
          items:
            $ref: '#/components/schemas/BusinessPartnerStorageDataSource'
        countries:
          type: array
          description: List of Countries.
          items:
            $ref: '#/components/schemas/SharingScopeCountry'
        applyingJob:
          $ref: '#/components/schemas/SharingScopeApplyingJob'
    SharingScopeApplyingJob:
      type: object
      description: Job that is currently applying the sharing scope.
      properties:
        id:
          $ref: '#/components/schemas/JobId'
        status:
          $ref: '#/components/schemas/schemas-JobStatus'
        progress:
          $ref: '#/components/schemas/JobProgress'
    SharingScopeCountry:
      type: object
      description: Country of the Sharing Scope.
      properties:
        shortName:
          $ref: '#/components/schemas/CountryShortName'
    SharingScopeCreate:
      type: object
      description: Indicates scope of Business Partners desired for sharing.
      properties:
        description:
          $ref: '#/components/schemas/SharingScopeDescription'
        dataSources:
          type: array
          description: List of Data Sources.
          maxItems: 1
          items:
            $ref: '#/components/schemas/BusinessPartnerStorageDataSourceParam'
        countries:
          type: array
          description: List of Countries.
          maxItems: 1
          items:
            $ref: '#/components/schemas/SharingScopeCountryParam'
    SharingScopeCountryParam:
      type: object
      description: Country of the Sharing Scope.
      required:
        - shortName
      properties:
        shortName:
          $ref: '#/components/schemas/CountryShortName'
    SharingScopeDeletes:
      type: object
      description: Delete the Sharing Scopes.
      properties:
        sharingScopes:
          type: array
          description: List of Sharing Scopes to be deleted.
          items:
            $ref: '#/components/schemas/SharingScopeDelete'
          maxItems: 1
    SharingScopeDelete:
      type: object
      description: Delete the Sharing Scope.
      properties:
        id:
          $ref: '#/components/schemas/SharingScopeId'
    SharingScopeDeleteResults:
      type: object
      description: Results of deleting the Sharing Scopes.
      properties:
        sharingScopes:
          type: array
          description: List of results.
          items:
            $ref: '#/components/schemas/SharingScopeDeleteResult'
    SharingScopeDeleteResult:
      type: object
      description: Result of deleting the Sharing Scope.
      properties:
        sharingScope:
          $ref: '#/components/schemas/SharingScopeDelete'
        status:
          type: string
          description: >
            * OK - the sharing scope has been updated

            * NOT_FOUND - the sharing scope is not found

            * APPLICATION_OR_DELETION_IN_PROGRESS - the sharing scope is already
            deleted but deletion consequences are not yet applied
          example: OK
    SharingScopeRefresh:
      type: object
      description: Refresh the Sharing Scope.
      properties:
        id:
          $ref: '#/components/schemas/SharingScopeId'
    SharingScopeRefreshResult:
      type: object
      description: Result of refreshing the Sharing Scope.
      properties:
        sharingScope:
          $ref: '#/components/schemas/SharingScopeRefresh'
        status:
          type: string
          description: >
            * OK - the sharing scope has been updated

            * NOT_FOUND - the sharing scope is not found

            * APPLICATION_IN_PROGRESS - the sharing scope is already deleted but
            deletion consequences are not yet applied
          example: OK
    SharingScopesReadFeatureParam:
      type: string
      description: Features to be used during the Scope Read.
      example: FETCH_JOB_DETAILS
      enum:
        - FETCH_JOB_DETAILS
      x-enumDescriptions:
        FETCH_JOB_DETAILS: Fetch job status and progress. By default, off.
    SharingScopesPage:
      type: object
      description: Page of Sharing Scopes.
      properties:
        values:
          type: array
          description: List of Sharing Scopes.
          items:
            $ref: '#/components/schemas/SharingScopeSearchResult'
        limit:
          $ref: '#/components/schemas/Limit'
        startAfter:
          $ref: '#/components/schemas/StartAfter'
        nextStartAfter:
          $ref: '#/components/schemas/NextStartAfter'
        total:
          $ref: '#/components/schemas/PageTotal'
    SharingScopeSearchResult:
      type: object
      description: Sharing Scope Search Result.
      properties:
        id:
          $ref: '#/components/schemas/SharingScopeId'
        description:
          $ref: '#/components/schemas/SharingScopeDescription'
        dataSources:
          type: array
          description: List of Data Sources.
          items:
            $ref: '#/components/schemas/BusinessPartnerStorageDataSource'
        countries:
          type: array
          description: List of Countries.
          items:
            $ref: '#/components/schemas/SharingScopeCountry'
        applyingJob:
          $ref: '#/components/schemas/SharingScopeApplyingJob'
    BusinessPartnersTransformAndUpsertRequest:
      type: object
      description: >-
        Put storageId on top to show in browsing rabbit messages when multiple
        Business Partners exist.
      allOf:
        - type: object
          description: >-
            Put storageId on top to show in browsing rabbit messages when
            multiple Business Partners exist.
          properties:
            storageId:
              $ref: '#/components/schemas/BusinessPartnerStorageId'
            requests:
              type: array
              description: List of Business Partners.
              items:
                $ref: '#/components/schemas/BusinessPartnerTransformAndUpsertRequest'
        - $ref: '#/components/schemas/BusinessPartnersUpsertRequest'
    BusinessPartnerTransformAndUpsertRequest:
      type: object
      description: Single request per business partner.
      properties:
        businessPartnerId:
          $ref: '#/components/schemas/BusinessPartnerId'
        previousBusinessPartner:
          $ref: '#/components/schemas/BusinessPartner'
        commercialMonitoringTransitions:
          type: array
          items:
            $ref: '#/components/schemas/CommercialMonitoringTransitionInfo'
    CommercialMonitoringTransitionInfo:
      type: object
      description: Transition definition.
      properties:
        referenceDataSource:
          $ref: '#/components/schemas/ProvenanceTechnicalKey'
        transition:
          $ref: '#/components/schemas/UpdateMonitoringTransition'
    UpdateMonitoringTransition:
      type: string
      description: Transition type.
      example: ENABLED
      x-enumDescriptions:
        NO_CHANGE_ENABLED: No transition, monitoring enabled.
        NO_CHANGE_DISABLED: No transition, monitoring disabled.
        ENABLED: Was deactivated and became activated.
        DISABLED: Was activated and became deactivated.
    BusinessPartnerChunkIndexRequest:
      type: object
      description: Request for indexing a chunk of Business Partners.
      properties:
        storageId:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
        skipOldIndexing:
          type: boolean
          description: Skip indexing of Business Partners that were already indexed.
          example: 'true'
        requests:
          type: array
          description: List of Business Partners.
          items:
            $ref: '#/components/schemas/BusinessPartner'
    BusinessPartnerChunkIdentityLinkageRequest:
      type: object
      description: Request for linking a chunk of Business Partners.
      properties:
        link:
          type: boolean
          description: Performs linkage or unlinkage.
          default: true
          example: 'true'
        referenceDataSource:
          $ref: '#/components/schemas/ProvenanceTechnicalKey'
        referenceDataSourceId:
          type: string
          description: ID of monitored data source within own Business Partner Storage.
          example: 648824a691d8d2503d65103e
        linkageStrategy:
          $ref: '#/components/schemas/LinkageStrategy'
        storageId:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
        organizationId:
          $ref: '#/components/schemas/OrganizationId'
        featuresOn:
          type: array
          description: List of features that cna be activated during the linkage.
          items:
            $ref: '#/components/schemas/BusinessPartnerIdentityLinkageFeature'
        featuresOff:
          type: array
          description: List of features that cna be activated during the linkage.
          items:
            $ref: '#/components/schemas/BusinessPartnerIdentityLinkageFeature'
        requests:
          type: array
          description: List of Business Partners.
          items:
            $ref: '#/components/schemas/BusinessPartner'
        requestsV2:
          type: array
          description: List of Business Partners.
          items:
            $ref: '#/components/schemas/BusinessPartnerLinkageRequest'
        source:
          type: string
          description: For debugging purposes.
          example: CDQ
    BusinessPartnerLinkageRequest:
      type: object
      description: >-
        Single processable request as a part of batch of requests. Link is
        present only when recalculating seed updates.
      properties:
        businessPartner:
          $ref: '#/components/schemas/LinkageRequestBusinessPartner'
        candidate:
          $ref: '#/components/schemas/LinkageRequestBusinessPartner'
        identityLink:
          $ref: '#/components/schemas/BusinessPartnerIdentityLink'
    LinkageRequestBusinessPartner:
      type: object
      description: >-
        Business partner restricted only to fields required in
        business-partner-identity-linkage-worker
      properties:
        id:
          description: Business Partner identifier within a storage. Autogenerated.
          example: '1234567891234567'
          type: string
        externalId:
          $ref: '#/components/schemas/BusinessPartnerExternalId'
        dataSource:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        disclosed:
          $ref: '#/components/schemas/BusinessPartnerDisclosed'
        updateMonitoring:
          $ref: '#/components/schemas/BusinessPartnerUpdateMonitoring'
        updateCommercialMonitoring:
          type: array
          description: >
            Enabling update commercial monitoring has 2 possibilities:

            * via Data Mapper Definition: include mapping of
            updateCommercialMonitoring in the Data Mapper Definition

            * via direct Business Partner model upload: fill complete Business
            Partner model and `updateCommercialMonitoring`.

            Null/undefined `updateCommercialMonitoring` results in protection of
            this setup from the previous upsert.

            Empty or filled `updateCommercialMonitoring` results in data
            transition that may link or unlink to / from respective

            commercial Reference Data Source


            Note: follow the approach that is currently used in your storage
            integration.
          items:
            $ref: '#/components/schemas/BusinessPartnerUpdateCommercialMonitoring'
        names:
          type: array
          items:
            $ref: '#/components/schemas/LinkageRequestName'
        identifiers:
          type: array
          items:
            $ref: '#/components/schemas/LinkageRequestIdentifier'
        categories:
          type: array
          description: List of Categories.
          items:
            $ref: '#/components/schemas/LinkageRequestBusinessPartnerCategory'
        addresses:
          type: array
          items:
            $ref: '#/components/schemas/LinkageRequestAddress'
        externalContext:
          $ref: '#/components/schemas/ExternalContext'
    LinkageRequestName:
      type: object
      description: >-
        Name restricted only to fields required in
        business-partner-identity-linkage-worker
      properties:
        type:
          $ref: '#/components/schemas/LinkageRequestNameType'
        value:
          $ref: '#/components/schemas/NameValue'
    LinkageRequestNameType:
      type: object
      description: >-
        Identifier Type restricted only to fields required in
        business-partner-identity-linkage-worker
      properties:
        technicalKey:
          $ref: '#/components/schemas/NameTypeTechnicalKey'
    LinkageRequestIdentifier:
      type: object
      description: >-
        Identifier restricted only to fields required in
        business-partner-identity-linkage-worker
      properties:
        type:
          $ref: '#/components/schemas/LinkageRequestIdentifierType'
        value:
          $ref: '#/components/schemas/IdentifierValue'
        issuingBody:
          $ref: '#/components/schemas/LinkageRequestIssuingBody'
    LinkageRequestIdentifierType:
      type: object
      description: >-
        Identifier Type restricted only to fields required in
        business-partner-identity-linkage-worker
      properties:
        technicalKey:
          $ref: '#/components/schemas/schemas-IdentifierTypeTechnicalKey'
    LinkageRequestIssuingBody:
      type: object
      description: >-
        Issuing Body restricted only to fields required in
        business-partner-identity-linkage-worker
      properties:
        technicalKey:
          $ref: '#/components/schemas/IssuingBodyTechnicalKey'
    LinkageRequestBusinessPartnerCategory:
      type: object
      description: >-
        A business partner category of a business partner groups similar
        business partners.
      properties:
        name:
          $ref: '#/components/schemas/BusinessPartnerCategoryName'
        technicalKey:
          $ref: '#/components/schemas/BusinessPartnerCategoryTechnicalKey'
    LinkageRequestAddress:
      type: object
      description: >-
        Address restricted only to fields required in
        business-partner-identity-linkage-worker
      properties:
        id:
          description: Address identifier within a Business Partner. Autogenerated.
          example: '0'
          type: string
        externalId:
          $ref: '#/components/schemas/AddressExternalId'
        cdqId:
          $ref: '#/components/schemas/AddressCdqId'
        version:
          $ref: '#/components/schemas/AddressVersion'
        country:
          $ref: '#/components/schemas/Country'
        administrativeAreas:
          type: array
          items:
            $ref: '#/components/schemas/LinkageRequestAdministrativeArea'
        postCodes:
          type: array
          items:
            $ref: '#/components/schemas/LinkageRequestPostCode'
        localities:
          type: array
          items:
            $ref: '#/components/schemas/LinkageRequestLocality'
        thoroughfares:
          type: array
          items:
            $ref: '#/components/schemas/LinkageRequestThoroughfare'
    LinkageRequestAdministrativeArea:
      type: object
      description: >-
        Administrative Area restricted only to fields required in
        business-partner-identity-linkage-worker
      properties:
        type:
          $ref: '#/components/schemas/LinkageRequestAdministrativeAreaType'
        value:
          $ref: '#/components/schemas/AdministrativeAreaValue'
    LinkageRequestAdministrativeAreaType:
      type: object
      description: >-
        Administrative Area Type restricted only to fields required in
        business-partner-identity-linkage-worker
      properties:
        technicalKey:
          $ref: '#/components/schemas/AdministrativeAreaTypeTechnicalKey'
    LinkageRequestPostCode:
      type: object
      description: >-
        Post Code restricted only to fields required in
        business-partner-identity-linkage-worker
      properties:
        type:
          $ref: '#/components/schemas/LinkageRequestPostCodeType'
        value:
          $ref: '#/components/schemas/PostCodeValue'
    LinkageRequestPostCodeType:
      type: object
      description: >-
        Post Code Type restricted only to fields required in
        business-partner-identity-linkage-worker
      properties:
        technicalKey:
          $ref: '#/components/schemas/PostCodeTypeTechnicalKey'
    LinkageRequestLocality:
      type: object
      description: >-
        Locality restricted only to fields required in
        business-partner-identity-linkage-worker
      properties:
        type:
          $ref: '#/components/schemas/LinkageRequestLocalityType'
        value:
          $ref: '#/components/schemas/LocalityValue'
    LinkageRequestLocalityType:
      type: object
      description: >-
        Locality Type restricted only to fields required in
        business-partner-identity-linkage-worker
      properties:
        technicalKey:
          $ref: '#/components/schemas/LocalityTypeTechnicalKey'
    LinkageRequestThoroughfare:
      type: object
      description: >-
        Thoroughfare restricted only to fields required in
        business-partner-identity-linkage-worker
      properties:
        type:
          $ref: '#/components/schemas/LinkageRequestThoroughfareType'
        value:
          $ref: '#/components/schemas/ThoroughfareValue'
        number:
          $ref: '#/components/schemas/ThoroughfareNumber'
    LinkageRequestThoroughfareType:
      type: object
      description: >-
        Thoroughfare Type restricted only to fields required in
        business-partner-identity-linkage-worker
      properties:
        technicalKey:
          $ref: '#/components/schemas/ThoroughfareTypeTechnicalKey'
    BusinessPartnerIdentityLinkageFeature:
      type: string
      description: The feature to be used during Business Partner Identity Linkage.
      example: DNB_AUTO_SUBSCRIBE
      enum:
        - DNB_AUTO_SUBSCRIBE
        - REFRESH_SUCCESSFUL_LINKS
        - SEED_UPDATES
        - GENERATE_SEED_UPDATES_ONLY
      x-enumDescriptions:
        DNB_AUTO_SUBSCRIBE: >-
          Automatically subscribe to DNB commercial monitoring when the linkage
          is created. By default deactivated.
        REFRESH_SUCCESSFUL_LINKS: >-
          Reevaluate already successful link by removing existing one in favor
          of creating new. Used when cdqId changes in reference data source.
          When used, it's recommended to send SEED_UPDATES in `featuresOff` to
          avoid sending seed update. By default deactivated.
        SEED_UPDATES: >-
          Send updates to event store of linked business partners. By default
          activated.
        GENERATE_SEED_UPDATES_ONLY: >-
          Send seed updates to event store for given business partner. By
          default deactivated.
    BusinessPartnersWorkerUpsertResult:
      type: object
      description: Result of Business Partners Upsert.
      properties:
        numberOfProcessed:
          type: integer
          description: Number of Business Partners processed.
          example: '10'
        numberOfInserts:
          type: integer
          description: Number of inserted Business Partners.
          example: '10'
        numberOfUpdates:
          type: integer
          description: Number of updated Business Partners.
          example: '10'
        numberOfNoChanges:
          type: integer
          description: Number of Business Partners with no changes.
          example: '10'
        numberOfFailed:
          type: integer
          description: Number of failed inserts.
          example: '10'
        failures:
          type: array
          description: List of failures.
          items:
            $ref: '#/components/schemas/UpsertFailureLog'
        businessPartners:
          type: array
          description: List of Business Partners.
          items:
            $ref: '#/components/schemas/BusinessPartnerUpserted'
    BusinessPartnerUpserted:
      type: object
      description: Business Partner with additional information.
      properties:
        externalId:
          $ref: '#/components/schemas/BusinessPartnerExternalId'
    BusinessPartnerWorkerIdentityLinkageResult:
      type: object
      description: Results of the linkage task.
      properties:
        numberOfProcessed:
          description: Number of all BusinessPartners processed (successfully or not)
          type: integer
          example: '10'
        numberOfIdentityLinkCreations:
          description: Number of newly created links
          type: integer
          example: '10'
        numberOfSuccessfulIdentityLinkCreations:
          description: Number of newly created links with successful linkage.
          type: integer
          example: '10'
        numberOfRefreshSuccessfulLinkCreations:
          description: Number of refreshed successful links with successful linkage.
          type: integer
          example: '10'
        numberOfIdentityLinkDeletions:
          description: Number of deleted links
          type: integer
          example: '10'
        numberOfUpdateMonitoringEnabled:
          description: Number of Business Partners with activated update monitoring
          type: integer
          example: '10'
        numberOfUpdateMonitoringDisabled:
          description: Number of Business Partners with deactivated update monitoring
          type: integer
          example: '10'
        numberOfAlreadyExistingIdentityLinks:
          description: Number of already existing links
          type: integer
          example: '10'
        numberOfNoMatches:
          description: BusinessPartners not found in lookup
          type: integer
          example: '10'
        numberOfVersionNoMatches:
          description: BusinessPartners not found in lookup by version
          type: integer
          example: '10'
        numberOfThresholdRejections:
          description: BusinessPartners rejected via threshold
          type: integer
          example: '10'
        numberOfFailedLookups:
          description: Lookup request failures during execution
          type: integer
          example: '10'
        numberOfFailed:
          description: Any kind of failures during execution
          type: integer
          example: '10'
        numberOfNoIdentifier:
          description: BusinessPartners have no identifiers
          type: integer
          example: '10'
        numberOfNoCountry:
          description: BusinessPartners have no country
          type: integer
          example: '10'
        numberOfMissingInformationForLinkage:
          description: BusinessPartners have remaining missing information for linkage.
          type: integer
          example: '10'
        numberOfNoAccess:
          description: BusinessPartners rejected due to no access to the resource
          type: integer
          example: '10'
        numberOfNotFoundInReferenceData:
          description: >-
            Number of links for which the reference data source did not contain
            the business partner (only for GENERATE_SEED_UPDATES_ONLY)
          type: integer
          example: '10'
        numberOfCreatedSeedUpdates:
          description: Number of seed updates created (only for GENERATE_SEED_UPDATES_ONLY)
          type: integer
          example: '10'
        numberOfProcessIssue:
          description: Number of Business Partners with process issues
          type: integer
          example: '10'
        numberOfQuotaLimit:
          description: Number of Business Partners with quota limit
          type: integer
          example: '10'
        numberOfInactiveSource:
          description: Number of Business Partners with inactive source
          type: integer
          example: '10'
        numberOfErroneousIdentifier:
          description: Number of Business Partners with erroneous identifier
          type: integer
          example: '10'
        numberOfExternalServiceNotAvailable:
          description: Number of Business Partners with external service not available
          type: integer
          example: '10'
    BusinessPartnersDeleteWorkerRequest:
      type: object
      description: Request to delete a list of Business Partners.
      allOf:
        - $ref: '#/components/schemas/BusinessPartnersDeleteRequest'
        - type: object
          description: Request to delete a list of Business Partners.
          properties:
            storageId:
              $ref: '#/components/schemas/BusinessPartnerStorageId'
            referenceDataSource:
              $ref: '#/components/schemas/ProvenanceTechnicalKey'
            source:
              type: string
              description: for debug purposes
              example: CDQ
    BusinessPartnersWorkerDeleteResult:
      type: object
      description: Results of the delete task.
      properties:
        numberOfProcessed:
          type: integer
          description: Number of processed Business Partners.
          example: '10'
        numberOfDeletes:
          type: integer
          description: Number of deleted Business Partners.
          example: '10'
        numberOfFailed:
          type: integer
          description: Number of failed deletes.
          example: '10'
        failures:
          type: array
          description: List of failures.
          items:
            $ref: '#/components/schemas/DeleteFailureLog'
    StorageLongOperationRequest:
      type: object
      description: Parameters for storage long operation worker.
      properties:
        featuresOn:
          type: array
          description: List of features to be activated.
          items:
            $ref: '#/components/schemas/StorageLongOperationFeature'
        storageId:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
        indexNameToProcess:
          type: string
          description: Name of the index to be processed. Used in REMOVE_MONGO_INDEXES.
          example: fieldA_1_fieldB_-1__id_1
        processingStatusTechnicalKey:
          description: >-
            Processing status technical key. Used in
            BATCH_CURATION_PROCESSING_STATUS and
            BATCH_VALIDATION_PROCESSING_STATUS.
          $ref: '#/components/schemas/ProcessingStatusTechnicalKey'
        dataSourceIds:
          type: array
          description: List of Data Sources IDs.
          items:
            $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
        referenceDataSource:
          $ref: '#/components/schemas/ProvenanceTechnicalKey'
        countryShortNames:
          type: array
          description: List of Country Short Names to be included.
          items:
            $ref: '#/components/schemas/CountryShortName'
        exceptCountryShortNames:
          type: array
          description: List of Country Short Names to be excluded.
          items:
            $ref: '#/components/schemas/CountryShortName'
        startAfter:
          $ref: '#/components/schemas/StartAfter'
    StorageLongOperationFeature:
      type: string
      description: Features to be activated with Long Operation.
      example: ENABLE_UPDATE_MONITORING
      enum:
        - BATCH_CURATION_PROCESSING_STATUS
        - BATCH_VALIDATION_PROCESSING_STATUS
        - CLEAN_CDQ_POOL_SETTING
        - CLEAR_STORAGE
        - COUNT_IDENTITY_LINKS
        - COUNT_SUBSCRIPTIONS
        - DELETE_EXPIRED_STORAGE
        - DISABLE_DISCLOSED
        - DISABLE_UPDATE_MONITORING
        - ENABLE_DISCLOSED
        - ENABLE_UPDATE_MONITORING
        - RELOAD_EXPIRES_AT
        - REMOVE_MONGO_INDEXES
        - RESTORE_CDQ_POOL_SETTING
        - SYNCHRONIZE_MONGO_INDEXES
      x-enumDescriptions:
        CLEAN_CDQ_POOL_SETTING: >-
          Remove CDQ.POOL from organizational settings. Used only when
          collaboration restart is invoked. Should not be used anymore, at least
          after last decisions.
        CLEAR_STORAGE: >-
          Invokes clear storage for storageId, like in storages/{}/clear
          endpoint.
        COUNT_IDENTITY_LINKS: >-
          Counts number of Business Partner identity links for
          ReferenceDataSource.
        COUNT_SUBSCRIPTIONS: Counts number of subscriptions for ReferenceDataSource.
        DELETE_EXPIRED_STORAGE: >-
          Applicable only when RELOAD_EXPIRES_AT feature is used. Deletes
          storage storageId when it has expired after reloading expiresAt.
        DISABLE_DISCLOSED: >-
          Sets disclosed to false for all Business Partners selected by
          parameters.
        ENABLE_DISCLOSED: Disclosed true.
        DISABLE_UPDATE_MONITORING: Sets Update Monitoring to false.
        ENABLE_UPDATE_MONITORING: Sets Update Monitoring to true.
        RELOAD_EXPIRES_AT: Invokes reloading expires at for storage storageId.
        RESTORE_CDQ_POOL_SETTING: Set back CDQ.POOL storageId to organizational settings.
        SYNCHRONIZE_MONGO_INDEXES: >-
          Invokes checks across missing indexes for collections related to
          storage storageId. Currently, does not delete indexes.
        REMOVE_MONGO_INDEXES: >-
          Removes specified index. Requires field 'indexNameToProcess' to be
          filled. Currently works only for BP storage.
    StorageLongOperationResult:
      type: object
      description: Results of the storage long operation task.
      properties:
        storageId:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
        status:
          type: string
          description: |
            Execution status of storage long operation:
              * `OK` - Operation has been finished successfully
              * `FAILED` - Operation has failed
          example: OK
        statusMessage:
          type: string
          description: Execution status message of storage long operation.
          example: Operation has been finished successfully
        numberOfProcessed:
          type: integer
          format: int64
          description: Number of processed Business Partners.
          example: '10'
        numberOfInserts:
          type: integer
          format: int64
          description: Number of inserted Business Partners.
          example: '10'
        numberOfUpdates:
          type: integer
          format: int64
          description: Number of updated Business Partners.
          example: '10'
        numberOfDeletes:
          type: integer
          format: int64
          description: Number of deleted Business Partners.
          example: '10'
        numberOfFailed:
          type: integer
          format: int64
          description: Number of failed Business Partners.
          example: '10'
    RelationsReadActingParam:
      type: string
      description: Indicator for acting of the relation.
      example: ACTIVE
      default: ACTIVE
      enum:
        - ACTIVE
        - INACTIVE
      x-enumDescriptions:
        ACTIVE: Only active relations.
        INACTIVE: Only inactive relations.
    BusinessPartnerRelationsPage:
      type: object
      description: Page displaying relations between Business Partners.
      properties:
        startAfter:
          $ref: '#/components/schemas/StartAfter'
        nextStartAfter:
          $ref: '#/components/schemas/NextStartAfter'
        limit:
          $ref: '#/components/schemas/Limit'
        total:
          $ref: '#/components/schemas/PageTotal'
        values:
          type: array
          description: List of relations between Business Partners.
          items:
            $ref: '#/components/schemas/BusinessPartnerRelation'
    RelationsReadFeatureParam:
      type: string
      description: Features to be activated for reading relations.
      example: SHOW_BUSINESS_PARTNER_INFORMATION
      enum:
        - SHOW_BUSINESS_PARTNER_INFORMATION
      x-enumDescriptions:
        SHOW_BUSINESS_PARTNER_INFORMATION: >-
          Allows to switch fetching business partner details to improve
          performance. By default, turned on.
    BusinessPartnerRelationsDeleteRequest:
      type: object
      description: Request to delete relations.
      properties:
        relations:
          type: array
          description: List of relations to delete.
          items:
            $ref: '#/components/schemas/BusinessPartnerRelationDelete'
    BusinessPartnerRelationDelete:
      type: object
      description: >-
        Delete relation by startNode and endNode. StartNode is required. If
        endNode is null, then delete all relations for BP from startNode (both
        as startNode or endNode).
      required:
        - startNode
      properties:
        startNode:
          $ref: '#/components/schemas/BusinessPartnerRelationNode'
        endNode:
          $ref: '#/components/schemas/BusinessPartnerRelationNode'
        type:
          $ref: '#/components/schemas/BusinessPartnerRelationTypeTechnicalKey'
        class:
          $ref: '#/components/schemas/BusinessPartnerRelationClassDelete'
    BusinessPartnerRelationClassDelete:
      type: object
      description: >-
        Provides information about the classification of the relation that is to
        be deleted.
      properties:
        technicalKey:
          $ref: '#/components/schemas/BusinessPartnerRelationClassTechnicalKey'
    BusinessPartnerRelationNode:
      type: object
      description: Unique identifiers for Business Partner in the relation
      properties:
        externalId:
          $ref: '#/components/schemas/BusinessPartnerExternalId'
        dataSourceId:
          $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
    BusinessPartnerRelationsDeleteResult:
      type: object
      description: Result of deleting relations.
      properties:
        deleted:
          type: integer
          description: Number of deleted relations.
          example: '10'
    DecisionLogResult:
      type: object
      description: Outcome of a decision-making process based on a decision log.
      properties:
        reviewStatus:
          $ref: '#/components/schemas/ReviewStatusParam'
        naturalPersonsReviewStatus:
          $ref: '#/components/schemas/ReviewStatusParam'
        duplicatesReviewStatus:
          $ref: '#/components/schemas/ReviewStatusParam'
    ReviewStatusParam:
      type: string
      description: Review status of the Business Partner.
      example: REVIEWED
      enum:
        - REVIEWED
        - NOT_REVIEWED
      x-enumDescriptions:
        REVIEWED: Reviewed.
        NOT_REVIEWED: Not reviewed.
    BusinessPartnerTagCreates:
      type: object
      description: Create Business Partner Tags.
      required:
        - tags
      properties:
        tags:
          type: array
          description: List of Tags.
          maxItems: 30
          items:
            $ref: '#/components/schemas/TagCreate'
    TagCreate:
      type: object
      description: >-
        Typed string describing and identifying a resource. Custom information
        about the resource in form of a tag.
      required:
        - value
        - type
      properties:
        value:
          $ref: '#/components/schemas/TagValue'
        type:
          $ref: '#/components/schemas/TagType'
    BusinessPartnerTagCreateResults:
      type: object
      description: Result page with created tags.
      properties:
        tags:
          $ref: '#/components/schemas/Tags'
        results:
          type: array
          description: List of results.
          items:
            $ref: '#/components/schemas/BusinessPartnerTagCreateResult'
    BusinessPartnerTagCreateResult:
      type: object
      description: Result of tag creation.
      properties:
        tag:
          $ref: '#/components/schemas/TagCreate'
        status:
          type: string
          description: |
            Tag creation status.
            * OK - the tag has been created
            * DUPLICATE - the tag already existed
            * OVER_LIMIT - the tag exceeded allowed tags limit of 30 tags
          example: OK
    BusinessPartnerTagDeletes:
      type: object
      description: Delete Business Partner Tags.
      required:
        - tags
      properties:
        tags:
          type: array
          description: List of deleted Tags.
          maxItems: 30
          items:
            $ref: '#/components/schemas/TagDelete'
    TagDelete:
      type: object
      description: >-
        Typed string describing and identifying a resource. Custom information
        about the resource in form of a tag.
      required:
        - value
        - type
      properties:
        value:
          $ref: '#/components/schemas/TagValue'
        type:
          $ref: '#/components/schemas/TagType'
    BusinessPartnerTagDeleteResults:
      type: object
      description: Result page with deleted tags.
      properties:
        tags:
          $ref: '#/components/schemas/Tags'
        results:
          type: array
          description: List of results.
          items:
            $ref: '#/components/schemas/BusinessPartnerTagDeleteResult'
    BusinessPartnerTagDeleteResult:
      type: object
      description: Result of tag deletion.
      properties:
        tag:
          $ref: '#/components/schemas/TagDelete'
        status:
          type: string
          description: |
            Tag deletion status.
            * OK - the tag has been deleted
            * NOT_FOUND - the tag is not found
          example: OK
    Tags:
      type: array
      description: List of Tags.
      items:
        $ref: '#/components/schemas/Tag'
    UpdateClassificationConfigurationId:
      type: string
      description: Update Classification Configuration Id.
      example: '123'
    PropertyChangeClassificationRequest:
      type: object
      description: Property change classification request.
      required:
        - changeType
        - property
      properties:
        externalIds:
          type: array
          description: List of external IDs.
          items:
            $ref: '#/components/schemas/ExternalId'
        property:
          $ref: '#/components/schemas/Property'
        newContent:
          $ref: '#/components/schemas/PropertyNewContent'
        previousContent:
          $ref: '#/components/schemas/PropertyPreviousContent'
        changeType:
          $ref: '#/components/schemas/PropertyChangeTypeTechnicalKey'
    PropertyChangeClassificationRule:
      type: object
      description: Rule used to classify property change.
      properties:
        url:
          $ref: '#/components/schemas/PropertyChangeClassificationRuleUrl'
    PropertyChangeClassificationRuleUrl:
      type: string
      description: Url of rule.
      example: >-
        https://meta.cdq.com/Feature/data_clinic/update_classification/rule_000054
    PropertyChangeClassificationStatus:
      type: string
      description: |
        * OK
        * UNSUPPORTED_CONCEPT
      example: OK
    TransformToPropertyChangesResult:
      type: object
      description: Result of transforming Business Partner to Property Changes.
      properties:
        businessPartner:
          $ref: '#/components/schemas/BusinessPartner'
        propertyChanges:
          type: array
          description: List of property changes.
          items:
            $ref: '#/components/schemas/PropertyChange2'
    VatPayerStatus:
      type: object
      description: Shows whether the Business Partner is a VAT payer.
      properties:
        publicationDate:
          $ref: '#/components/schemas/VatPayerStatusPublicationDate'
        status:
          $ref: '#/components/schemas/PayerStatus'
        registrationAuthority:
          $ref: '#/components/schemas/RegistrationAuthority'
    RegistrationAuthority:
      type: object
      description: Shows the registration authority of the Business Partner.
      properties:
        registrationAuthorityId:
          $ref: '#/components/schemas/RegistrationAuthorityId'
        registrationAuthorityEntityId:
          $ref: '#/components/schemas/RegistrationAuthorityEntityId'
        otherRegistrationAuthorityId:
          $ref: '#/components/schemas/OtherRegistrationAuthorityId'
    PayerStatus:
      type: object
      description: Payer Status.
      properties:
        name:
          $ref: '#/components/schemas/PayerStatusName'
        technicalKey:
          $ref: '#/components/schemas/PayerStatusTechnicalKey'
    BusinessPartnerStorageId:
      type: string
      description: Unique identifier of the Storage.
      example: 72d6900fce6b326088f5d9d91049e3e6
    BusinessPartnerId:
      type: string
      description: >-
        A CDQ ID identifies a business partner uniquely in the context of the
        Corporate Data League.
      example: 63e635235c06b7396330fe40
    BusinessPartnerExternalId:
      type: string
      description: >-
        Arbitrary identifier type to mark customer IDs that are "external" from
        CDQ's perspective. This is the identifier a customer provides to
        identify its records.
      example: The ID managed in the customer's SAP systems.
    ProvenanceTechnicalKey:
      type: string
      description: Technical Key of the Provenance Name.
      example: VIES
    CountryShortName:
      type: string
      description: Country code (ISO 3166-1 alpha-2).
      example: CH
    UpdateClassificationTechnicalKeyEnum:
      type: string
      example: MAJOR
      description: Technical key of an update classification.
      enum:
        - CRITICAL
        - REJECTED
        - MAJOR
        - MINOR
        - TRIVIAL
        - CONFIRMED
        - UNCHANGED
      x-enumDescriptions:
        CRITICAL: Critical
        REJECTED: Update has been rejected
        MAJOR: Major change
        MINOR: Minor update
        TRIVIAL: Trivial update
        CONFIRMED: Contents have been confirmed by a data source and not changed
        UNCHANGED: Contents have been not changed
    UpdateTagEnum:
      type: string
      description: >-
        Tags an update summary to allow searching or filtering. The tag has the
        format `<type>_<concept>_<action>`.
      example: IDENTIFIER_ADDED
      enum:
        - BANKRUPTCY_BUSINESS_PARTNER
        - BUSINESS_PARTNER_CATEGORY_ADDED
        - BUSINESS_PARTNER_CATEGORY_MODIFIED
        - BUSINESS_PARTNER_CLASSIFICATION_ADDED
        - BUSINESS_PARTNER_CLASSIFICATION_MODIFIED
        - BUSINESS_PARTNER_STATUS_ADDED
        - BUSINESS_PARTNER_STATUS_MODIFIED
        - BUSINESS_PARTNER_TYPE_ADDED
        - BUSINESS_PARTNER_TYPE_MODIFIED
        - DIRECT_LEGAL_RELATION_ADDED
        - DIRECT_LEGAL_RELATION_MODIFIED
        - DISSOLUTION_BUSINESS_PARTNER
        - DOMESTIC_BRANCH_RELATION_ADDED
        - DOMESTIC_BRANCH_RELATION_MODIFIED
        - DOMESTIC_COMMERCIAL_ULTIMATE_RELATION_ADDED
        - DOMESTIC_COMMERCIAL_ULTIMATE_RELATION_MODIFIED
        - DOMESTIC_LEGAL_ULTIMATE_RELATION_ADDED
        - DOMESTIC_LEGAL_ULTIMATE_RELATION_MODIFIED
        - GLOBAL_COMMERCIAL_ULTIMATE_RELATION_ADDED
        - GLOBAL_COMMERCIAL_ULTIMATE_RELATION_MODIFIED
        - GLOBAL_LEGAL_ULTIMATE_RELATION_ADDED
        - GLOBAL_LEGAL_ULTIMATE_RELATION_MODIFIED
        - IDENTIFIER_ADDED
        - IDENTIFIER_HARMONIZED
        - IDENTIFIER_MODIFIED
        - IDENTIFIER_STATUS_ADDED
        - IDENTIFIER_STATUS_MODIFIED
        - IDENTIFIER_VALUE_MODIFIED
        - IN_LIQUIDATION_BUSINESS_PARTNER
        - INACTIVE_BUSINESS_PARTNER
        - INSOLVENCY_BUSINESS_PARTNER
        - INTERNAL_RELATION_ADDED
        - INTERNAL_RELATION_MODIFIED
        - INTERNATIONAL_BRANCH_RELATION_ADDED
        - INTERNATIONAL_BRANCH_RELATION_MODIFIED
        - LEGAL_FORM_ADDED
        - LEGAL_FORM_MODIFIED
        - LEI_DIRECT_PARENT_ADDED
        - LEI_DIRECT_PARENT_MODIFIED
        - LEI_INTERNATIONAL_BRANCH_ADDED
        - LEI_INTERNATIONAL_BRANCH_MODIFIED
        - LEI_ULTIMATE_PARENT_ADDED
        - LEI_ULTIMATE_PARENT_MODIFIED
        - LOCAL_ADDRESS_ADDED
        - LOCAL_ADDRESS_ADMINISTRATIVE_AREA_ADDED
        - LOCAL_ADDRESS_ADMINISTRATIVE_AREA_MODIFIED
        - LOCAL_ADDRESS_COUNTRY_ADDED
        - LOCAL_ADDRESS_COUNTRY_MODIFIED
        - LOCAL_ADDRESS_GEO_COORDINATES_ADDED
        - LOCAL_ADDRESS_GEO_COORDINATES_MODIFIED
        - LOCAL_ADDRESS_LOCALITY_ADDED
        - LOCAL_ADDRESS_LOCALITY_MODIFIED
        - LOCAL_ADDRESS_MODIFIED
        - LOCAL_ADDRESS_POSTAL_DELIVERY_POINT_ADDED
        - LOCAL_ADDRESS_POSTAL_DELIVERY_POINT_MODIFIED
        - LOCAL_ADDRESS_POST_CODE_ADDED
        - LOCAL_ADDRESS_POST_CODE_MODIFIED
        - LOCAL_ADDRESS_PREMISE_ADDED
        - LOCAL_ADDRESS_PREMISE_MODIFIED
        - LOCAL_ADDRESS_THOROUGHFARE_ADDED
        - LOCAL_ADDRESS_THOROUGHFARE_MODIFIED
        - LOCAL_NAME_ADDED
        - LOCAL_NAME_MODIFIED
        - OTHER_NAME_ADDED
        - OTHER_NAME_MODIFIED
        - POST_CODE_HARMONIZED
        - LEGAL_ADDRESS_ADDED
        - LEGAL_ADDRESS_ADMINISTRATIVE_AREA_ADDED
        - LEGAL_ADDRESS_ADMINISTRATIVE_AREA_MODIFIED
        - LEGAL_ADDRESS_COUNTRY_ADDED
        - LEGAL_ADDRESS_COUNTRY_MODIFIED
        - LEGAL_ADDRESS_GEO_COORDINATES_ADDED
        - LEGAL_ADDRESS_GEO_COORDINATES_MODIFIED
        - LEGAL_ADDRESS_LOCALITY_ADDED
        - LEGAL_ADDRESS_LOCALITY_MODIFIED
        - LEGAL_ADDRESS_MODIFIED
        - LEGAL_ADDRESS_POSTAL_DELIVERY_POINT_ADDED
        - LEGAL_ADDRESS_POSTAL_DELIVERY_POINT_MODIFIED
        - LEGAL_ADDRESS_POST_CODE_ADDED
        - LEGAL_ADDRESS_POST_CODE_MODIFIED
        - LEGAL_ADDRESS_PREMISE_ADDED
        - LEGAL_ADDRESS_PREMISE_MODIFIED
        - LEGAL_ADDRESS_THOROUGHFARE_ADDED
        - LEGAL_ADDRESS_THOROUGHFARE_MODIFIED
        - LEGAL_NAME_ADDED
        - LEGAL_NAME_MODIFIED
        - RESTRUCTURING_BUSINESS_PARTNER
        - RELATION_ADDED
        - RELATION_MODIFIED
        - SEED_UPDATE
        - UPDATE_PROPOSAL_INDICATOR
        - VAT_PAYER_STATUS_ADDED
        - VAT_PAYER_STATUS_MODIFIED
        - VAT_REGISTERED_ADDRESS_ADDED
        - VAT_REGISTERED_ADDRESS_ADMINISTRATIVE_AREA_ADDED
        - VAT_REGISTERED_ADDRESS_ADMINISTRATIVE_AREA_MODIFIED
        - VAT_REGISTERED_ADDRESS_COUNTRY_ADDED
        - VAT_REGISTERED_ADDRESS_COUNTRY_MODIFIED
        - VAT_REGISTERED_ADDRESS_GEO_COORDINATES_ADDED
        - VAT_REGISTERED_ADDRESS_GEO_COORDINATES_MODIFIED
        - VAT_REGISTERED_ADDRESS_LOCALITY_ADDED
        - VAT_REGISTERED_ADDRESS_LOCALITY_MODIFIED
        - VAT_REGISTERED_ADDRESS_MODIFIED
        - VAT_REGISTERED_ADDRESS_POSTAL_DELIVERY_POINT_ADDED
        - VAT_REGISTERED_ADDRESS_POSTAL_DELIVERY_POINT_MODIFIED
        - VAT_REGISTERED_ADDRESS_POST_CODE_ADDED
        - VAT_REGISTERED_ADDRESS_POST_CODE_MODIFIED
        - VAT_REGISTERED_ADDRESS_PREMISE_ADDED
        - VAT_REGISTERED_ADDRESS_PREMISE_MODIFIED
        - VAT_REGISTERED_ADDRESS_THOROUGHFARE_ADDED
        - VAT_REGISTERED_ADDRESS_THOROUGHFARE_MODIFIED
        - VAT_REGISTERED_NAME_ADDED
        - VAT_REGISTERED_NAME_MODIFIED
        - VALUE_MODIFIED
    Limit:
      type: integer
      description: Number of items per page.
      example: '100'
    PageTotal:
      description: Total number of items which can be paged.
      example: '67'
      type: integer
    StartAfter:
      type: string
      description: The ID which is used to read the page.
      example: '5712566172571652'
    UpdateTag:
      type: string
      description: >-
        Tags an update summary to allow searching or filtering. The tag has the
        format `<type>_<concept>_<action>`.
      example: IDENTIFIER_ADDED
    UpdateClassificationTechnicalKey:
      type: string
      example: MAJOR
      description: Technical key of an update classification.
    UpdateClassificationReason:
      type: string
      description: Reason why this classification has been applied
      example: The modified post code has deprecated format.
    NameTypeUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of the [Name
        Type](https://meta.cdq.com/Business_partner/name/type).
      example: https://meta.cdq.com/Business_partner/name/type
    NameTypeName:
      type: string
      description: Display label for the Name Type.
      example: Local Name
    NameTypeTechnicalKey:
      type: string
      description: Technical Keys of the Name Type.
      example: LOCAL
    NameValue:
      type: string
      description: The actual name.
      example: Corporate Data Quality AG
    NameShortName:
      type: string
      description: The abbreviated variant of a company's full name.
      example: CDQ AG
    LanguageName:
      type: string
      description: ISO 639-1 name of language.
      example: German
    LanguageTechnicalKey:
      type: string
      description: ISO 639-1 two-letter code of languages.
      example: DE
    UpdateActionTechnicalKey:
      type: string
      description: Technical key of an update assessment action.
      example: ADDED
    ProvenanceName:
      type: string
      description: Display Name of the Provenance Name.
      example: VIES
    ProvenanceUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of the Provenance
        Name.
      example: >-
        https://meta.cdq.com/index.php?title=Property:Has_prefix&limit=500&offset=0&from=&until=&filter=
    ProvenanceCdqId:
      type: string
      description: The ID provided for a linkage with the source by CDQ.
      example: VIES:PL8660001429
    ModifiedAt:
      type: string
      description: Date of modification (ISO 8601-compliant).
      example: '2025-08-19T06:23:16Z'
    LegalFormName:
      type: string
      description: Display of the Legal Form.
      example: Aktiengesellschaft
    LegalFormUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of [Legal
        Form](https://meta.cdq.com/Business_partner/legal_form).
      example: https://meta.cdq.com/Business_partner/legal_form
    LegalFormTechnicalKey:
      type: string
      description: >-
        Technical Key of a Legal Form. Descriptions of below enums contain
        `Country Scope`, `International Name` and `Main Abraviation`.
      example: DE_9866
    LegalFormMainAbbreviation:
      type: string
      description: >-
        The primary abbreviation of a legal form, i.e. the most commonly used
        abbreviation in a country.
      example: AG
    LegalFormCategoryName:
      type: string
      maxLength: 40
      description: Descriptive display name of the Legal Form Category.
      example: Limited Liability Company
    LegalFormCategoryShortName:
      type: string
      maxLength: 15
      description: Short display name of the Legal Form Category.
      example: LLC
    LegalFormCategoryUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of the [Legal Form
        Category](https://meta.cdq.com/Business_partner/legal_form/category).
      example: >-
        https://meta.cdq.com/Business_partner/legal_form/category/technical_key/LF001
    LegalFormCategoryTechnicalKey:
      type: string
      description: >-
        Technical Key of the [Legal Form
        Category](https://meta.cdq.com/Business_partner/legal_form/category).
      example: LIMITED
    IdentifierTypeUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of an
        [Identifier](https://meta.cdq.com/Business_partner/identifier/type).
      example: https://meta.cdq.com/Business_partner/identifier/type
    IdentifierTypeName:
      type: string
      description: Display label for the Identifier.
      example: CH_VAT_ID
    schemas-IdentifierTypeTechnicalKey:
      type: string
      description: Technical key of the type of the Identifier.
      example: CH_VAT_ID
    IdentifierValue:
      type: string
      description: Value of the identifier.
      example: CHE-218.608.886 HR/MWST
    IssuingBodyName:
      type: string
      description: Preferred display label for an Issuing Body.
      example: Amtsgericht Aachen
    IssuingBodyUrl:
      description: >-
        URL to the documentation which summarizes all details of a [Issuing
        Body](https://meta.cdq.com/Business_partner/identifier/issuing_body).
      example: https://meta.cdq.com/Business_partner/identifier/issuing_body
      type: string
    IssuingBodyTechnicalKey:
      description: Technical key of the Issuing Body.
      example: Amtsgericht Aachen
      type: string
    CountryValue:
      type: string
      description: Country name (ISO 3166-1 alpha-2).
      example: Switzerland
    IdentifierStatusName:
      type: string
      description: Display label for the Identifier Status Name.
      example: ACTIVE
    IdentifierStatusTechnicalKey:
      type: string
      description: Technical key of the Identifier Status.
      example: ACTIVE
    BusinessPartnerCategoryName:
      type: string
      description: Display name of the Business Partner Category Name.
      example: Hotel
    BusinessPartnerCategoryUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of the [Business
        Partner Category](https://meta.cdq.com/Business_partner/category).
      example: https://meta.cdq.com/Business_partner/category
    BusinessPartnerCategoryTechnicalKey:
      type: string
      description: Technical Key of the Business Partner Category.
      example: HOTEL
    BusinessPartnerStatusTypeName:
      type: string
      description: Display name of the Business Partner Status.
      example: In Liquidation
    BusinessPartnerStatusTypeUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of the [Business
        Partner Status](https://meta.cdq.com/Business_partner/status/type).
      example: https://meta.cdq.com/Business_partner/status/type
    BusinessPartnerStatusTypeTechnicalKey:
      type: string
      description: Technical Key of the Business Parter Status.
      example: IN_LIQUIDATION
    BusinessPartnerStatusOfficialDenotation:
      type: string
      description: The status as provided by an official register.
      example: Good Standing
    BusinessPartnerStatusValidFrom:
      type: string
      description: >-
        Describes since when a business partner turned or will turn into the
        provided status. If no official date is known, the date of changing the
        status in the CDQ Community Data Pool or an external data source is
        provided.
      example: '2025-08-19T06:23:16Z'
    BusinessPartnerStatusValidUntil:
      type: string
      description: >-
        Describes until when a business partner had a certain status. If no
        official date is known, the date of changing the status in the CDQ
        Community Data Pool or an external data source is provided.
      example: '2025-08-19T06:23:16Z'
    CharacterSetName:
      type: string
      description: >-
        Name of character set. Supported character sets can be found
        [here](https://meta.cdq.com/Address/version/character_set).
      example: International
    CharacterSetTechnicalKey:
      type: string
      description: >-
        Technical key of character set. Supported character sets can be found
        [here](https://meta.cdq.com/Address/version/character_set).
      example: INTERNATIONAL
    AddressIdentifyingNameValue:
      type: string
      description: >-
        An identifying name assigned to an address. In most cases the
        identifying name refers to the name of a registered agent.
      example: John Doe
    AddressExternalId:
      type: string
      description: >-
        ID the address has in the external system where the record originates
        from.
      example: '1'
    CareOfValue:
      type: string
      description: Value of the CareOf.
      example: CDQ GmbH c/o Product Department
    AddressContextValue:
      type: string
      description: Value of the Address Context.
      example: Production hall 7, Storage field 8.
    AdministrativeAreaValue:
      type: string
      description: >-
        Name of the [Administrative
        Area](https://meta.cdq.com/Address/administrative_area).
      example: Sankt Gallen
    AdministrativeAreaShortName:
      type: string
      description: >-
        Abbreviation for the [Administrative
        Area](https://meta.cdq.com/Address/administrative_area).
      example: SG
    AdministrativeAreaIsoCode:
      type: string
      description: >-
        ISO 3166-2 code which uniquely defines the names of countries and their
        subdivisions (e.g., provinces or states).
      example: CH-SG
    AdministrativeAreaTypeName:
      type: string
      description: Display label for the Administrative Area Type.
      example: COUNTY
    AdministrativeAreaTypeUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of the
        [Administrative
        Area](https://meta.cdq.com/Address/administrative_area/type).
      example: https://meta.cdq.com/Address/administrative_area/type
    AdministrativeAreaTypeTechnicalKey:
      type: string
      description: Technical key of the Administrative Area.
      example: COUNTY
    schemas-AdministrativeAreaType:
      type: object
      description: >-
        Type of the [Administrative
        Area](https://meta.cdq.com/Address/administrative_area).
      properties:
        name:
          $ref: '#/components/schemas/AdministrativeAreaTypeName'
        url:
          $ref: '#/components/schemas/AdministrativeAreaTypeUrl'
        technicalKey:
          $ref: '#/components/schemas/AdministrativeAreaTypeTechnicalKey'
    PostCodeValue:
      type: string
      description: Effective [post code](https://meta.cdq.com/Address/post_code).
      example: '9000'
    PostCodeTypeName:
      type: string
      description: Display label for the Post Code Type.
      example: Regular
    PostCodeTypeUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of the
        [Administrative Area](https://meta.cdq.com/Address/post_code/type).
      example: https://meta.cdq.com/Address/post_code/type
    PostCodeTypeTechnicalKey:
      type: string
      description: Technical key of the Post Code.
      example: REGULAR
    LocalityTypeName:
      type: string
      description: Display label for the Locality Type.
      example: City
    LocalityTypeUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of the [Locality
        Type](https://meta.cdq.com/Address/locality/type).
      example: https://meta.cdq.com/Address/locality/type
    LocalityTypeTechnicalKey:
      type: string
      description: Technical Key of the Locality Type.
      example: CITY
    LocalityShortName:
      type: string
      description: Abbreviation of the [Locality](https://meta.cdq.com/Address/locality).
      example: St. Gallen
    LocalityValue:
      type: string
      description: Name of the [Locality](https://meta.cdq.com/Address/locality).
      example: Sankt Gallen
    ThoroughfareTypeName:
      type: string
      description: Display label for the Thoroughfare Type Name.
      example: Industrial zone
    ThoroughfareTypeUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of the
        [Thoroughfare Type](https://meta.cdq.com/Address/thoroughfare/type).
      example: https://meta.cdq.com/Address/thoroughfare/type
    ThoroughfareTypeTechnicalKey:
      type: string
      description: Technical key of the Thoroughfare Type.
      example: INDUSTRIAL_ZONE
    ThoroughfareShortName:
      type: string
      description: >-
        Abbreviation of the
        [Thoroughfare](https://meta.cdq.com/Address/thoroughfare).
      example: Lukasstr. 4
    ThoroughfareNumber:
      type: string
      description: Number of the [Thoroughfare](https://meta.cdq.com/Address/thoroughfare).
      example: '4'
    ThoroughfareValue:
      type: string
      description: >-
        Comprehensive designation of the
        [Thoroughfare](https://meta.cdq.com/Address/thoroughfare) including the
        thoroughfare type such as Street, or Rue.
      example: Lukasstraße 4
    ThoroughfareName:
      type: string
      description: >-
        Pure name of the
        [Thoroughfare](https://meta.cdq.com/Address/thoroughfare) not comprising
        the thoroughfare type such as Street, or Rue.
      example: Lukasstraße
    ThoroughfareDirection:
      type: string
      description: >-
        Direction of the
        [Thoroughfare](https://meta.cdq.com/Address/thoroughfare).
      example: 221-bis Baker Street, North
    PremiseValue:
      type: string
      description: The actual value of a Premise in the language of the address.
      example: Lukasstraße 4
    PremiseShortName:
      type: string
      description: Abbreviation of the Premise.
      example: Lukasstr. 4
    PremiseNumber:
      type: string
      description: Number of the Premise.
      example: '4'
    PremiseTypeName:
      type: string
      description: Display label for the Premise Type.
      example: Factory
    PremiseTypeUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of the [Premise
        Type](https://meta.cdq.com/Address/premise/type).
      example: https://meta.cdq.com/Address/premise/type
    PremiseTypeTechnicalKey:
      type: string
      description: Technical key of the Premise Type.
      example: FACTORY
    PostalDeliveryPointTypeName:
      type: string
      description: Display label for the Postal Delivery Point Type.
      example: Mailbox
    PostalDeliveryPointTypeUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of the [Postal
        Delivery Point](https://meta.cdq.com/Address/postal_delivery_point/type)
      example: https://meta.cdq.com/Address/postal_delivery_point/type
    PostalDeliveryPointTypeTechnicalKey:
      type: string
      description: Technical key of the Postal Delivery Point.
      example: MAILBOX
    PostalDeliveryPointShortName:
      type: string
      description: >-
        Stort name of the [Postal Delivery
        Point](https://meta.cdq.com/Address/postal_delivery_point).
      example: St Gallen, Postfach 460
    PostalDeliveryPointNumber:
      type: string
      description: >-
        Number of the [Postal Delivery
        Point](https://meta.cdq.com/Address/postal_delivery_point).
      example: '460'
    PostalDeliveryPointValue:
      type: string
      description: >-
        Value of the [Postal Delivery
        Point](https://meta.cdq.com/Address/postal_delivery_point).
      example: Postfach
    GeographicCoordinatesLatitude:
      description: Plain on the earth's surface north or south of the equator.
      example: '47.439549'
      type: number
      format: double
    GeographicCoordinatesLongitude:
      description: Plain on the earth's surface east or west of a meridian.
      example: '9.395275'
      type: number
      format: double
    AddressTypeName:
      type: string
      description: Display label for the Address Type.
      example: Legal Address
    AddressTypeUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of the [Address
        Type](https://meta.cdq.com/Address/type).
      example: https://meta.cdq.com/Address/type
    AddressTypeTechnicalKey:
      type: string
      description: Technical key of the Address Type.
      example: LEGAL_ADDRESS
    MinorityIndicatorValue:
      type: string
      description: >-
        The actual value of the minority indicator, representing the minority
        group.
      example: Social enterprise
    ClassificationValue:
      type: string
      description: A textual description of the Classification.
      example: Manufacture of pesticides and other agrochemical products.
    ClassificationCode:
      type: string
      description: Code that classifies the business partner.
      example: 20.20Z
    ClassificationTypeName:
      type: string
      description: Display label for the Classification Type.
      example: NAF 2003
    ClassificationTypeUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of the
        [Classification
        Type](https://meta.cdq.com/Business_partner/partner_profile/classification/type)
      example: >-
        https://meta.cdq.com/Business_partner/partner_profile/classification/type
    ClassificationTypeTechnicalKey:
      type: string
      description: TechnicalKey for the Classification Type.
      example: NAF 2003
    PhoneNumberCountryPrefix:
      type: string
      description: The country prefix of a phone number.
      example: '+41'
    PhoneNumberNumber:
      type: string
      description: The complete phone number without any country prefixes.
      example: 71 571 10 40
    PhoneNumberTypeName:
      type: string
      description: Display label for a Phone Number Type Name.
      example: FAX
    PhoneNumberTypeUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of the [Phone
        Number
        Type](https://meta.cdq.com/Business_partner/partner_profile/phone_number/type).
      example: https://meta.cdq.com/Business_partner/partner_profile/phone_number/type
    PhoneNumberTypeTechnicalKey:
      type: string
      description: Technical Keys of the PhoneNumber.
      example: FAX
    PhoneNumberValue:
      type: string
      description: The actual complete phone number incl. country prefix.
      example: +41 71 571 10 40
    WebsiteUrl:
      type: string
      description: The actual company website URL.
      example: https://cdq.com
    WebsiteTypeName:
      type: string
      description: Display label for a Website Type Name
      example: Corporate Website
    WebsiteTypeUrl:
      type: string
      description: >-
        URL to the documentation which summarizes [Website Type
        Name](https://meta.cdq.com/Business_Partner/partner_profile/website/type).
      example: https://meta.cdq.com/Business_Partner/partner_profile/website/type
    WebsiteTypeTechnicalKey:
      type: string
      description: Technical Keys of the Website Type Name.
      example: WEBSITE_TYPE_CORPORATE
    ContactEmailValue:
      type: string
      description: Value of the email address of the Business Partner.
      example: developer-portal@cdq.com
    TagValue:
      type: string
      description: Value of the tag.
      example: Warehouse
    TagTypeTechnicalKey:
      type: string
      description: Technical Key of the Tag.
      example: WAREHOUSE
    VatPayerStatusPublicationDate:
      type: string
      description: Date of publication
      example: '2025-08-19T06:23:16Z'
    PayerStatusName:
      type: string
      description: Name of Vat payer status. Available values RELIABLE and UNRELIABLE
      example: RELIABLE
    PayerStatusTechnicalKey:
      type: string
      description: Technical key of Vat payer status
      example: VAT_PAYER_STATUS
    RegistrationAuthorityId:
      type: string
      description: >-
        The reference code of the registration authority, taken from the
        Registration Authorities Code List maintained by GLEIF.
      example: RA000009
    RegistrationAuthorityEntityId:
      type: string
      description: The identifier of the Entity at the indicated registration authority.
      example: RA000009
    OtherRegistrationAuthorityId:
      type: string
      description: A legacy / historical reference code of a registration authority.
      example: RA000009
    ProfessionTypeName:
      type: string
      description: Name of the profession type.
      example: Doctor
    ProfessionTypeUrl:
      type: string
      description: URL to the documentation of the Profession Type Technical Key.
      example: >-
        https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/general_license/profession_type/technical_key
    ProfessionTypeTechnicalKey:
      type: string
      description: Technical key of the profession type.
      example: DOCTOR
    LicenseStatusName:
      type: string
      description: Name of the license status.
      example: Granted
    LicenseStatusUrl:
      type: string
      description: URL to the documentation of the License Status Technical Key.
      example: >-
        https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/general_license/license_status/technical_key
    LicenseStatusTechnicalKey:
      type: string
      description: Technical key of the license status.
      example: GRANTED
    PermissionStatusName:
      type: string
      description: Name of the permission status.
      example: Granted
    PermissionStatusUrl:
      type: string
      description: URL to the documentation of the Permission Status Technical Key.
      example: >-
        https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/operational_permissions/permission_status/url
    PermissionStatusTechnicalKey:
      type: string
      description: Technical key of the permission status.
      example: GRANTED
    ActivityStatusName:
      type: string
      description: |
        Name of the activity status.
        Possible values: 
        * Active - The operational permission is active.
        * Inactive - The operational permission is inactive.
      example: Inactive
    ActivityStatusUrl:
      type: string
      description: URL to the documentation of the Activity Status Technical Key.
      example: >-
        https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/operational_permissions/activity_status/url
    ActivityStatusTechnicalKey:
      type: string
      description: Technical key of the activity status.
      example: INACTIVE
    SelfDispensationStatusName:
      type: string
      description: Name of the self-dispensation status.
      example: 'No'
    SelfDispensationStatusUrl:
      type: string
      description: URL to the documentation of the Self Dispensation Status Technical Key.
      example: >-
        https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/operational_permissions/self_dispensation_status/url
    SelfDispensationStatusTechnicalKey:
      type: string
      description: Technical key of the self-dispensation status.
      example: 'NO'
    ControlledSubstancePurchasePermissionName:
      type: string
      description: Name of the controlled substance purchase permission.
      example: 'Yes'
    ControlledSubstancePurchasePermissionUrl:
      type: string
      description: >-
        URL to the documentation of the Controlled Substance Purchase Permission
        Technical Key.
      example: >-
        https://meta.cdq.com/Business_partner/partner_profile/hcp_profile/operational_permissions/controlled_substance_purchase_permission/url
    ControlledSubstancePurchasePermissionTechnicalKey:
      type: string
      description: Technical key of the controlled substance purchase permission.
      example: 'YES'
    BusinessPartnerTypeName:
      type: string
      description: Display name of the Business Partner Type Name.
      example: Legal Entity
    BusinessPartnerTypeUrl:
      type: string
      description: >-
        URL to the documentation which summarizes all details of a [Buisness
        Partner Type](https://meta.cdq.com/Business_partner/type).
      example: https://meta.cdq.com/Business_partner/type
    BusinessPartnerTypeTechnicalKey:
      type: string
      description: Technical key of the Business Partner Type.
      example: LEGAL_ENTITY
    BusinessPartnerRelationStartedAt:
      type: string
      description: Describe when this relationship was first established.
      example: '2025-08-19T06:23:16Z'
    BusinessPartnerRelationEndedAt:
      type: string
      description: Describe when this relationship ended.
      example: '2025-08-19T06:23:16Z'
    BusinessPartnerRelationTypeName:
      type: string
      description: Display name of the Business Partner Relation Type.
      example: Commercial ultimate
    BusinessPartnerRelationTypeTechnicalKey:
      type: string
      description: Technical Key of the Business Partner Relation Type.
      example: COMMERCIAL_ULTIMATE
    BusinessPartnerRelationClassName:
      type: string
      description: Display name of the Business Partner Relation Class.
      example: CDQ Hierarchy
    BusinessPartnerRelationClassTechnicalKey:
      type: string
      description: Technical Key of the Business Partner Relation Class.
      example: BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY
    BusinessPartnerStorageDataSourceId:
      type: string
      description: Unique identifier for a Data Source of the Storage.
      example: 648824a691d8d2503d65103e
    ExternalContextIdentifierValue:
      type: string
      description: Value of own identifiers of a record.
      example: '7250017031'
    ExternalContextIdentifierTypeTechnicalKey:
      type: string
      description: Technical key for the External Context Identifier Type.
      example: KUNNR
    CreatedAt:
      type: string
      description: Date of creation (ISO 8601-compliant).
      example: '2025-08-19T06:23:16Z'
    ProcessingLogId:
      type: string
      description: Unique identifier of a processing log.
      example: CURATION_LOG
    ProcessingStatusTechnicalKey:
      type: string
      description: Possible technical states of processing.
      example: IN_PROGRESS
    InternationalBankAccountIdentifier:
      type: string
      description: The IBAN of a bank account.
      example: CH8800781619278412000
    InternationalBankIdentifier:
      type: string
      description: (BIC/SWIFT) Bank identifier which is globally unique.
      example: KBSGCH22XXX
    NationalBankAccountIdentifier:
      type: string
      description: Identifier of a bank account in a national context, i.e. for a country.
      example: '619278412000'
    NationalBankIdentifier:
      type: string
      description: >-
        Bank identifier which is unique in a national context, i.e. for a
        country.
      example: '00781'
    BankAccountCountryCode:
      type: string
      description: ISO code to identify the country a bank account is registered in.
      example: DE
    FirstPaymentDate:
      type: string
      description: The date of the first payment to the bank account (ISO 8601-compliant).
      example: '2025-08-19T06:23:16Z'
    LastPaymentDate:
      type: string
      description: The date of the last payment to the bank account (ISO 8601-compliant).
      example: '2025-08-19T06:23:16Z'
    NumberOfPayments:
      type: integer
      description: The number of payments to the bank account.
      example: '1'
    HttpStatusCode:
      type: integer
      description: RFC 7231 status code for this error.
      example: '400'
    HttpStatusTechnicalKey:
      type: string
      description: Technical key describing the status or error
      example: OK
    StatusDetailsMessageId:
      type: integer
      description: 9-digit code which is uniquely identifying a message
      example: 200000004
    StatusDetailsMessage:
      type: string
      description: Human-readable message which may also be presented in user interface.
      example: Business Partner Name is mandatory.
    StatusDetailsTechnicalKey:
      type: string
      description: Technical key to uniquely identify a message.
      example: JOB_FINISHED
    JsonPath:
      type: string
      description: JSONPath as specified by the IETF standard
      example: $.businessPartner.names[0].value
    JsonObject:
      type: string
      description: Object provided in plain JSON format.
      example: '{ "key" : "value"}'
      additionalProperties: true
    HttpPath:
      type: string
      description: Requested path which caused this error.
      example: /v2/businesspartners/lookup
    StatusTimestamp:
      type: string
      description: ISO 8601 representation of the timestamp.
      example: '2025-08-19T06:23:16Z'
    DataSourceTechnicalKey:
      type: string
      description: Technical key of the data source.
      example: BR_RF
    StorageDataSourceId:
      type: string
      description: Unique number of Data Source.
      example: 5e2874fb8d2a7400011acee1
    JobId:
      type: string
      description: Unique identifier of a job.
      example: 35f23c03-1c22-45fe-9484-3ffe769325de
    JobName:
      type: string
      description: Name of a Job.
      example: Process vendor data.
    JobDescription:
      type: string
      description: Detailed description of a Job.
      example: I started this job to improve quality of our data.
    JobProgress:
      type: integer
      description: Progress (%) of the job.
      example: '77'
      maximum: 100
      minimum: 0
    schemas-JobStatus:
      type: string
      description: Job execution status.
      example: RUNNING
    JobStatusMessage:
      type: string
      description: Additional information to explain the status.
      example: The job failed because storage is empty.
    CreatedBy:
      type: string
      description: Creator of a resource.
      example: '76248934691294444'
    WorkspaceId:
      type: string
      description: Uniquely identifying ID of the workspace.
      example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
    OrganizationId:
      type: string
      description: Uniquely identifying ID of the organization.
      example: cdq_monitor
    UserId:
      type: string
      description: Unique ID of a user.
      example: johndoe
    BusinessPartnerStorageName:
      type: string
      description: Name of the Business Partner Storage.
      maxLength: 100
      example: CDQ AG
    BusinessPartnerStorageDataSourceName:
      type: string
      description: Name of a data source of a storage.
      example: Internal customers
    DataMonitorId:
      type: string
      description: Unique alpha-numeric number of the Data Monitor.
      example: bfdfd6f7-562f-4d4a-921f-e68cba60d5cf
    DataMonitorTypeName:
      type: string
      description: Display name of the Data Monitor Type.
      example: Augmentation
    DataMonitorTypeTechnicalKey:
      type: string
      description: Technical key of a data monitor.
      example: AUGMENTATION
    DataMonitorToggle:
      type: boolean
      description: The toggle used to enable or disable the Data Monitor.
      example: true
    ConfigurationId:
      type: string
      description: Uniquely identifies a configuration.
      example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
    DataMonitorExecutionTypeTechnicalKey:
      type: string
      description: Technical key of the Data Monitor Execution Type.
      example: TRIGGER
    DataMonitorFrequency:
      type: string
      description: It is the interval at which updates are performed.
      example: BI_WEEKLY
    ModifiedBy:
      type: string
      description: User or Client UUID which modified the resource.
      example: '76248934691294444'
    BuildToggle:
      type: boolean
      description: Enable to generate this report.
      example: 'false'
      default: false
    FileResourceUrl:
      type: string
      description: Url of the file resource linking to s3.
      example: customer-upload/user/file.xlsx
    FeaturePropertyParam:
      type: string
      description: Name of the feature property.
      example: STORE_TECHNICAL_PROFILE
      enum:
        - STORE_TECHNICAL_PROFILE
      x-enumDescriptions:
        STORE_TECHNICAL_PROFILE: >-
          Technical profile is stored in MSSQL database and not deleted
          immediately after report creation.
    TechnicalProfilerReportConfiguration:
      type: object
      description: Configures if and how technical profiler reports are generated.
      properties:
        build:
          $ref: '#/components/schemas/BuildToggle'
        sourceFileUrl:
          $ref: '#/components/schemas/FileResourceUrl'
        storageId:
          $ref: '#/components/schemas/BusinessPartnerStorageId'
        featuresOn:
          type: array
          items:
            $ref: '#/components/schemas/FeaturePropertyParam'
    TechnicalReportsConfiguration:
      description: Configures if and how technical reports are generated.
      type: object
      properties:
        technicalProfiler:
          $ref: '#/components/schemas/TechnicalProfilerReportConfiguration'
    JobUser:
      type: string
      description: ID of (human) user or API key.
      example: 742429-234242-4343-232323
    schemas-Tag:
      type: string
      description: String describing and identifying a resource.
      example: Reporting
    schemas-Tags:
      type: array
      items:
        $ref: '#/components/schemas/schemas-Tag'
    schemas-FileResource:
      description: File resource which can be uploaded or downloaded.
      type: object
      properties:
        url:
          $ref: '#/components/schemas/FileResourceUrl'
        tags:
          $ref: '#/components/schemas/schemas-Tags'
    Job:
      type: object
      description: Task executed based on set frequency (bi-weekly, monthly, quartarely).
      properties:
        id:
          $ref: '#/components/schemas/JobId'
        name:
          $ref: '#/components/schemas/JobName'
        description:
          $ref: '#/components/schemas/JobDescription'
        status:
          $ref: '#/components/schemas/schemas-JobStatus'
        statusMessage:
          $ref: '#/components/schemas/JobStatusMessage'
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        user:
          $ref: '#/components/schemas/JobUser'
        progress:
          $ref: '#/components/schemas/JobProgress'
        attachments:
          type: array
          items:
            $ref: '#/components/schemas/schemas-FileResource'
    NextStartAfter:
      type: string
      description: Provides a value to be used as a startAfter in next page request.
      example: '5712566172571652'
    Page:
      type: integer
      description: Current page number.
      example: '1'
      default: 0
      minimum: 0
    schemas-CurationLevel:
      type: string
      description: Indicator for curation quality. Defines how good curation was.
      example: LEVEL_4
    ExpiresAt:
      type: string
      description: Date of expiration (ISO 8601-compliant).
      example: '2025-08-19T06:23:16Z'
    PageSize:
      type: integer
      description: Number of items per page.
      example: '100'
      default: 10
      minimum: 1
      maximum: 1000
    CmpelkV2Organization:
      type: object
      description: The details of the entity's organization.
      properties:
        duns:
          type: string
          example: 804735132
          description: >-
            The D-U-N-S Number, assigned by Dun & Bradstreet, is an
            identification number that uniquely identifies the entity in
            accordance with the Data Universal Numbering System (D-U-N-S).
        dunsControlStatus:
          type: object
          description: >-
            The details of the entity established to provide products and/or
            services in the marketplace or to the community.
          properties:
            operatingStatus:
              type: object
              description: The details of the entity's functional state or trading status.
              properties:
                description:
                  type: string
                  example: Active
                  description: >-
                    The entity's functional state or trading status (e.g.,
                    active, out of business).
                dnbCode:
                  type: integer
                  example: 9074
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    entity's functional state or trading status.
            isMarketable:
              type: boolean
              example: 'true'
              description: >-
                Indicates whether the data on the entity satisfies Dun &
                Bradstreet's marketability rules for Sales & Marketing Solutions
                products. <br/><br/>- If true, the entity data satisfies the
                marketability rules.<br/>- If false, the entity data does not
                satisfy the marketability rules.
            isMailUndeliverable:
              type: boolean
              example: 'false'
              description: >-
                Indicates whether it is possible to deliver mail to the address
                of this entity.<br/><br/>- If true, it is not possible to
                deliver mail to the address.<br/>- If false, it is possible to
                deliver mail to the address.
            isTelephoneDisconnected:
              type: boolean
              example: 'false'
              description: >-
                Indicates whether the telephone number can be connected to
                successfully.<br/><br/>- If true, connection to the  telephone
                number is unsuccessful.<br/>- If false, connection to the 
                telephone number is successful.
            isDelisted:
              type: boolean
              example: 'false'
              description: >-
                Indicates whether the entity has requested that they not be
                included in any Direct marketing lists (e.g., mailing,
                telephone).<br/><br/>- If true, the entity has objected to and
                MUST NOT receive direct marketing material.<br/>- If false, the
                entity has not objected to receiving direct marketing material.
            subjectHandlingDetails:
              type: array
              items:
                description: >-
                  The details of the manner in which the entity is to receive
                  special care being contacted. In many cases, this was
                  specifically requested by the entity.
                properties:
                  description:
                    type: string
                    example: Do not call
                    description: >-
                      The manner in which the entity is to receive special care
                      when being contacted (e.g., do not call or do not send
                      information requests). In many cases, this was
                      specifically requested by the entity.
                  dnbCode:
                    type: integer
                    example: 7974
                    description: >-
                      A unique code assigned by Dun & Bradstreet to identify the
                      manner in which the entity is to receive special care from
                      Dun & Bradstreet when it is being contacted.
                type: object
            fullReportDate:
              type: string
              example: '2025-08-19T06:23:16Z'
              description: >-
                The most recent date when a complete review of all business
                information data was completed.<br/><br/>Format: YYYY-MM-DD or
                YYYY-MM
        primaryName:
          type: string
          example: GORMAN MANUFACTURING COMPANY, INC.
          description: >-
            The single name by which the entity is primarily known or
            identified.
        tradeStyleNames:
          type: array
          items:
            description: >-
              The details of the names that the entity trades under for
              commercial purposes although its registered legal name used for
              contracts and other formal situations may be another name.
            properties:
              name:
                type: string
                example: Alternate Company Name
                description: >-
                  The name that the entity trades under for commercial purposes 
                  although its registered legal name used for contracts and
                  other formal situations may be another name.
              priority:
                type: integer
                example: 1
                description: >-
                  The sequence in which the entity mostly uses this tradestyle
                  name.
            type: object
        websiteAddress:
          type: array
          items:
            description: >-
              The details of the internet URLs used for online information and
              communication with the entity.
            properties:
              url:
                type: string
                example: http://www.gorman.com
                description: >-
                  The Internet URL (Uniform Resource Locator) that uniquely
                  identifies the proprietary website of the entity or the
                  website preferred by the entity that gives more information on
                  the entity.
              domainName:
                type: string
                example: gorman.com
                description: >-
                  A unique name used to identify the website of the entity that
                  serves as an address to access that website.
            type: object
        telephone:
          type: array
          items:
            description: >-
              The details of the telephone information used for voice
              communication with the entity.
            properties:
              telephoneNumber:
                type: string
                example: 6505550000
                description: >-
                  A sequence of digits used for voice communication with the
                  entity.<br/>This sequence of digits includes the area code or
                  city code and domestic dialing code.
              isdCode:
                type: string
                example: 1
                description: >-
                  The country calling code assigned by the International
                  Telecommunication Union (ITU) required to connect to this
                  telephone number when dialing from outside the entity's
                  country (e.g., '1' for the US, '44' for the UK, '91' for
                  India).
              isUnreachable:
                type: boolean
                example: 'false'
                description: >-
                  Indicates whether the telephone number can be connected to
                  successfully.<br/><br/>- If true, connection to the  telephone
                  number is unsuccessful.<br/>- If false, connection to the 
                  telephone number is successful.
            type: object
        fax:
          type: array
          items:
            description: >-
              The details of the facsimile information used for data
              communication with the entity.
            properties:
              faxNumber:
                type: string
                example: 6505550001
                description: >-
                  A sequence of digits used for facsimile communication with the
                  entity.<br/>This sequence of digits includes the area code or
                  city code and domestic dialing code.
              isdCode:
                type: string
                example: 1
                description: >-
                  The country calling code assigned by the International
                  Telecommunication Union (ITU) required to connect to this
                  facsimile number when dialing from outside the entity's
                  country (e.g., '1' for the US, '44' for the UK, '91' for
                  India).
            type: object
        primaryAddress:
          type: object
          description: >-
            The details of the single primary or physical address at which the
            entity is located.
          properties:
            language:
              type: object
              description: The details of the language in which this address was recorded.
              properties:
                description:
                  type: string
                  example: English
                  description: The name of the language in which this address was recorded.
                dnbCode:
                  type: integer
                  example: 39
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    language in which this address was recorded.
            addressCountry:
              type: object
              description: The details of the country in which this address is located.
              properties:
                name:
                  type: string
                  example: United States
                  description: The name of the country in which this address is located.
                isoAlpha2Code:
                  type: string
                  example: US
                  description: >-
                    The two-letter country code, defined by the International
                    Organization for Standardization (ISO) ISO 3166-1 scheme
                    identifying the country in which this address is located.
                fipsCode:
                  type: string
                  example: US
                  description: >-
                    The Federal Information Processing Standards (FIPS) code
                    value that identifies the country in which this address is
                    located.
            continentalRegion:
              type: object
              description: >-
                The details of the continental region in which this address is
                located.
              properties:
                name:
                  type: string
                  example: North America
                  description: >-
                    The name of the continental region for this
                    address.<br/><br/>Possible values:<br/>- Africa<br/>- Asia
                    Pacific<br/>- Europe<br/>- Latin America<br/>- Middle
                    East<br/>- North America
            addressLocality:
              type: object
              description: >-
                The details of the city, town, township, village, borough, etc.
                in which this address is located.
              properties:
                name:
                  type: string
                  example: SAN FRANCISCO
                  description: >-
                    The name of the city, town, township, village, borough, etc.
                    in which this address is located.
            minorTownName:
              type: string
              example: Booker
              description: >-
                The name of the village, town or suburb when it is not a Primary
                Town or City (e.g., the Booker in Booker, High Wycombe).
            addressRegion:
              type: object
              description: >-
                The details of the locally governed area that forms part of a
                centrally governed nation to identify where this address is
                located.
              properties:
                name:
                  type: string
                  example: California
                  description: >-
                    The name of the locally governed area that forms part of a
                    centrally governed nation to identify where this address is
                    located.
                abbreviatedName:
                  type: string
                  example: CA
                  description: >-
                    The shortened name of the locally governed area that forms
                    part of a centrally governed nation. For example 'NJ' for
                    the US State New Jersey within Country United States.
                isoSubDivisionName:
                  type: string
                  description: >-
                    The official name of a principal subdivision (e.g province
                    or state) of countries coded in ISO 3166-1.
                  example: Yamanashi
                isoSubDivisionCode:
                  type: string
                  description: >-
                    The code assigned by ISO that represents the name of a
                    principal subdivision (e.g province or state) of countries
                    coded in ISO 3166-1.  This code is based on the two-letter
                    code element from ISO 3166-1 followed by a separator and up
                    to three alphanumeric characters.
                  example: JP-19
                fipsCode:
                  type: string
                  example: '06'
                  description: >-
                    The Federal Information Processing Standards (FIPS) code
                    value that identifies the region in which this address is
                    located.
            addressCounty:
              type: object
              description: The details of the county in which this address is located.
              properties:
                name:
                  type: string
                  example: SAN MATEO
                  description: The name of the county in which this address is located.
                fipsCode:
                  type: string
                  example: 81
                  description: >-
                    The Federal Information Processing Standards (FIPS) code
                    value that identifies the county in which this address is
                    located.
            postalCode:
              type: string
              example: 941109999
              description: >-
                An identifier used by the local country's postal authority to
                identify where this address is located.
            postalCodePosition:
              type: object
              description: >-
                The details of the position of the Postal Code when presenting
                the address.
              properties:
                description:
                  type: string
                  example: Post code presented before Town/City name
                  description: >-
                    The position of the Postal Code when presenting the address
                    (e.g., before the Primary Town/City).
                dnbCode:
                  type: integer
                  example: 1009
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    position of the Postal Code when presenting the address.
            streetNumber:
              type: string
              example: 492
              description: >-
                The number part of the street address where the entity is
                located. <br/><br/>This may be a single number, a number with an
                appendix, or a range of street numbers. <br/><br/>For example,
                the &quot;51 - 59C&quot; in the address 51 - 59C Wall Street.
            streetName:
              type: string
              example: KOLLER ST
              description: >-
                The name of the street where the entity is located.
                <br/><br/>For example, &quot;Wall Street&quot; in the address 51
                - 59C Wall Street.
            streetAddress:
              type: object
              description: The details of the street address where the entity is located.
              properties:
                line1:
                  type: string
                  example: 492 KOLLER ST
                  description: >-
                    The first line of the address where the entity is
                    located.<br/><br/>For example, &quot;41 Central
                    Chambers&quot; in the address <br/>41 Central
                    Chambers<br/>Dame Court<br/>Dublin 2
                line2:
                  type: string
                  example: Suite 100
                  description: >-
                    The second line of the address where the entity is
                    located.<br/><br/>For example, &quot;Dame Court&quot; in the
                    address <br/>41 Central Chambers<br/>Dame Court<br/>Dublin 2
            postOfficeBox:
              type: object
              description: >-
                The details of the identifier issued to the entity by a private
                or public Postal Office for the purposes of collecting mail for
                the entity for subsequent collection or delivery.
              properties:
                postOfficeBoxNumber:
                  type: string
                  example: 5309
                  description: >-
                    An identifier issued to the entity by a private or public
                    postal office for the purposes of collecting mail for the
                    entity for subsequent collection or delivery.<br/><br/>This
                    includes only the identifying number (or text) and not the
                    textual description of the PO Box type. For example the
                    contents would be just the number 12 from &quot;PO Box
                    12&quot;, or just the number 57 from &quot;PMB 57&quot;.
                typeDescription:
                  type: string
                  example: Supplied by public Post Office authority
                  description: The type of the PO Box (e.g., Post Office Box, PMB).
                typeDnBCode:
                  type: integer
                  example: 120
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    type of PO Box.
            latitude:
              type: number
              example: 37.777709
              description: >-
                The latitude component of the entity's location defined as the
                angular distance of the primary physical address north or south
                from the Earth's equator expressed in decimal numbers.
                <br/><br/>Positive numbers indicate degrees north. Negative
                numbers indicate degrees south.
            longitude:
              type: number
              example: -122.404624
              description: >-
                The longitude component of the entity's location defined as the
                angular distance of the primary physical address east or west
                from an imaginary line (called the prime meridian) that goes
                from the North Pole to the South Pole expressed in decimal
                numbers. <br/><br/>Positive numbers indicate degrees east.
                Negative numbers indicate degrees west.
            geographicalPrecision:
              type: object
              description: >-
                The details on how close the latitude and longitude coordinates
                for a location are to rooftop level.
              properties:
                description:
                  type: string
                  example: Street Segment Centroid
                  description: >-
                    The description of how close the latitude and longitude
                    coordinates for a location are to rooftop level.
                dnbCode:
                  type: integer
                  example: 30256
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify how
                    close the latitude and longitude coordinates for a location
                    are to &quot;rooftop&quot; level.
            isRegisteredAddress:
              type: boolean
              example: 'true'
              description: >-
                Indicates if the primary address is the same as the address of
                the entity as registered with a legal entity.  <br/>  <br/>- If
                true, the primary address is the same as the address of the
                entity as registered with a legal entity.<br/>- If false, the
                primary address is the not same as the address of the entity as
                registered with a legal entity.
            isResidentialAddress:
              type: boolean
              example: 'false'
              description: >-
                Indicates whether or not the Primary Address is classified as
                residential by the governing postal authority<br/><br/>- If
                true, the primary address is classified as residential.<br/>- If
                false, the primary address is not classified as residential.
            statisticalArea:
              type: object
              description: >-
                The details of the various statistical facts associated with
                this address.
              properties:
                cbsaName:
                  type: string
                  example: San Francisco-Oakland-Hayward CA
                  description: >-
                    The name assigned to the 5-digit CBSA (Core Based
                    Statistical Area) assigned by US Census board to denote a
                    geographical region with a relatively high population
                    density at its core and close economic ties throughout the
                    area.
                cbsaCode:
                  type: string
                  example: 41860
                  description: >-
                    The 5-digit CBSA (Core Based Statistical Area) code assigned
                    by US Census board to denote a geographical region with a
                    relatively high population density at its core and close
                    economic ties throughout the area.
                economicAreaOfInfluenceCode:
                  type: string
                  example: 146
                  description: >-
                    A code assigned by the U.S Bureau of Economic Analysis to
                    identify the entity's regional market that surrounds a
                    metropolitan or micropolitan statistical area serving as a
                    regional center of economic activity.
                populationRank:
                  type: object
                  description: >-
                    The details of the statistical facts about population based
                    on region's rank.
                  properties:
                    rankNumber:
                      type: string
                      example: 9
                      description: >-
                        A number classifying the geographic area in which the
                        entity is located based on the resident
                        population.<br/><br/>Values: 0 to 9<br/>0 denotes the
                        lowest population range; 9 denotes the highest.
                    rankDnBCode:
                      type: integer
                      example: 10961
                      description: >-
                        A unique code assigned by Dun & Bradstreet to identify
                        the population for the geographical area in which this
                        address is located.
                    rankDescription:
                      type: string
                      example: 500,000 +
                      description: >-
                        A range of the population for the geographical area
                        where the entity is located.
            locationOwnership:
              type: object
              description: >-
                The details of the terms under which the entity occupies the
                premises.
              properties:
                description:
                  type: string
                  example: Rents
                  description: >-
                    Description of the terms under which the entity occupies the
                    premises (e.g., owned, rented, leased).
                dnbCode:
                  type: integer
                  example: 1129
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    terms under which the entity occupies the premises.
            premisesArea:
              type: object
              description: The details of space the entity utilizes at this address.
              properties:
                measurement:
                  type: number
                  example: 10034
                  description: >-
                    A number portion of the amount to of space the entity
                    occupies at this address (e.g., the 2000 in 2000 square
                    meters).
                unitDescription:
                  type: string
                  example: square foot
                  description: >-
                    The measurement unit used to express the premises area
                    measurement (e.g., acre, square meters, square feet).
                unitDnBCode:
                  type: integer
                  example: 3848
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    measurement unit used to express the premises area
                    measurement.
                reliabilityDescription:
                  type: string
                  example: Actual
                  description: >-
                    The accuracy of the measurement (e.g., actual, estimated,
                    modeled).
                reliabilityDnBCode:
                  type: integer
                  example: 9092
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    accuracy of the measurement.
            isManufacturingLocation:
              type: boolean
              example: 'true'
              description: >-
                Indicates if manufacturing activity is performed at this
                facility by the entity.<br/><br/>- If true, the entity performs
                manufacturing activity at this facility.<br/>- If false, the
                entity does not performs manufacturing activity at this
                facility.
        registeredAddress:
          type: object
          description: >-
            The details of the official address of the entity as registered with
            a local or national registry to which all official correspondence
            must be sent.
          properties:
            language:
              type: object
              description: The details of the language in which this address was recorded.
              properties:
                description:
                  type: string
                  example: English
                  description: The name of the language in which this address was recorded.
                dnbCode:
                  type: integer
                  example: 39
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    language in which this address was recorded.
            addressCountry:
              type: object
              description: The details of the country in which this address is located.
              properties:
                name:
                  type: string
                  example: United States
                  description: The name of the country in which this address is located.
                isoAlpha2Code:
                  type: string
                  example: US
                  description: >-
                    The two-letter country code, defined by the International
                    Organization for Standardization (ISO) ISO 3166-1 scheme
                    identifying the country in which this address is located.
            addressLocality:
              type: object
              description: >-
                The details of the city, town, township, village, borough, etc.
                in which this address is located.
              properties:
                name:
                  type: string
                  example: SAN FRANCISCO
                  description: >-
                    The name of the city, town, township, village, borough, etc.
                    in which this address is located.
            minorTownName:
              type: string
              example: Booker
              description: >-
                The name of the village, town or suburb when it is not a Primary
                Town or City (e.g., the Booker in Booker, High Wycombe).
            addressRegion:
              type: object
              description: >-
                The details of the locally governed area that forms part of a
                centrally governed nation to identify where this address is
                located.
              properties:
                name:
                  type: string
                  example: California
                  description: >-
                    The name of the locally governed area that forms part of a
                    centrally governed nation to identify where this address is
                    located.
                abbreviatedName:
                  type: string
                  example: CA
                  description: >-
                    The shortened name of the locally governed area that forms
                    part of a centrally governed nation. For example 'NJ' for
                    the US State New Jersey within Country United States.
            addressCounty:
              type: object
              description: The details of the county in which this address is located.
              properties:
                name:
                  type: string
                  example: SAN MATEO
                  description: The name of the county in which this address is located.
            postalCode:
              type: string
              example: 941109999
              description: >-
                An identifier used by the local country's postal authority to
                identify where this address is located.
            postalCodePosition:
              type: object
              description: >-
                The details of the position of the Postal Code when presenting
                the address.
              properties:
                description:
                  type: string
                  example: Post code presented before Town/City name
                  description: >-
                    The position of the Postal Code when presenting the address
                    (e.g., before the Primary Town/City).
                dnbCode:
                  type: integer
                  example: 1009
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    position of the Postal Code when presenting the address.
            streetNumber:
              type: string
              example: 492
              description: >-
                The number part of the street address where the entity is
                located. <br/><br/>This may be a single number, a number with an
                appendix, or a range of street numbers. <br/><br/>For example,
                the &quot;51 - 59C&quot; in the address 51 - 59C Wall Street.
            streetName:
              type: string
              example: KOLLER ST
              description: >-
                The name of the street where the entity is located.
                <br/><br/>For example, &quot;Wall Street&quot; in the address 51
                - 59C Wall Street.
            streetAddress:
              type: object
              description: The details of the street address where the entity is located.
              properties:
                line1:
                  type: string
                  example: 492 KOLLER ST
                  description: >-
                    The first line of the address where the entity is
                    located.<br/><br/>For example, &quot;41 Central
                    Chambers&quot; in the address <br/>41 Central
                    Chambers<br/>Dame Court<br/>Dublin 2
                line2:
                  type: string
                  example: Suite 100
                  description: >-
                    The second line of the address where the entity is
                    located.<br/><br/>For example, &quot;Dame Court&quot; in the
                    address <br/>41 Central Chambers<br/>Dame Court<br/>Dublin 2
                line3:
                  type: string
                  example: Address line 3
                  description: The third line of the address where the entity is located.
                line4:
                  type: string
                  example: Address line 4
                  description: The forth line of the address where the entity is located.
            postOfficeBox:
              type: object
              description: >-
                The details of the identifier issued to the entity by a private
                or public Postal Office for the purposes of collecting mail for
                the entity for subsequent collection or delivery.
              properties:
                postOfficeBoxNumber:
                  type: string
                  example: 5309
                  description: >-
                    An identifier issued to the entity by a private or public
                    postal office for the purposes of collecting mail for the
                    entity for subsequent collection or delivery.<br/><br/>This
                    includes only the identifying number (or text) and not the
                    textual description of the PO Box type. For example the
                    contents would be just the number 12 from &quot;PO Box
                    12&quot;, or just the number 57 from &quot;PMB 57&quot;.
                typeDescription:
                  type: string
                  example: Supplied by public Post Office authority
                  description: The type of the PO Box (e.g., Post Office Box, PMB).
                typeDnBCode:
                  type: integer
                  example: 120
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    type of PO Box.
        mailingAddress:
          type: object
          description: The details of the address used by the entity for mailing purposes.
          properties:
            language:
              type: object
              description: The details of the language in which this address was recorded.
              properties:
                description:
                  type: string
                  example: English
                  description: The name of the language in which this address was recorded.
                dnbCode:
                  type: integer
                  example: 39
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    language in which this address was recorded.
            addressCountry:
              type: object
              description: The details of the country in which this address is located.
              properties:
                name:
                  type: string
                  example: United States
                  description: The name of the country in which this address is located.
                isoAlpha2Code:
                  type: string
                  example: US
                  description: >-
                    The two-letter country code, defined by the International
                    Organization for Standardization (ISO) ISO 3166-1 scheme
                    identifying the country in which this address is located.
            continentalRegion:
              type: object
              description: >-
                The details of the continental region in which this address is
                located.
              properties:
                name:
                  type: string
                  example: North America
                  description: >-
                    The name of the continental region for this
                    address.<br/><br/>Possible values:<br/>- Africa<br/>- Asia
                    Pacific<br/>- Europe<br/>- Latin America<br/>- Middle
                    East<br/>- North America
            addressLocality:
              type: object
              description: >-
                The details of the city, town, township, village, borough, etc.
                in which this address is located.
              properties:
                name:
                  type: string
                  example: SAN FRANCISCO
                  description: >-
                    The name of the city, town, township, village, borough, etc.
                    in which this address is located.
            minorTownName:
              type: string
              example: Booker
              description: >-
                The name of the village, town or suburb when it is not a Primary
                Town or City (e.g., the Booker in Booker, High Wycombe).
            addressRegion:
              type: object
              description: >-
                The details of the locally governed area that forms part of a
                centrally governed nation to identify where this address is
                located.
              properties:
                name:
                  type: string
                  example: California
                  description: >-
                    The name of the locally governed area that forms part of a
                    centrally governed nation to identify where this address is
                    located.
                abbreviatedName:
                  type: string
                  example: CA
                  description: >-
                    The shortened name of the locally governed area that forms
                    part of a centrally governed nation. For example 'NJ' for
                    the US State New Jersey within Country United States.
            addressCounty:
              type: object
              description: The details of the county in which this address is located.
              properties:
                name:
                  type: string
                  example: SAN MATEO
                  description: The name of the county in which this address is located.
            postalCode:
              type: string
              example: 941109999
              description: >-
                An identifier used by the local country's postal authority to
                identify where this address is located.
            postalCodePosition:
              type: object
              description: >-
                The details of the position of the Postal Code when presenting
                the address.
              properties:
                description:
                  type: string
                  example: Post code presented before Town/City name
                  description: >-
                    The position of the Postal Code when presenting the address
                    (e.g., before the Primary Town/City).
                dnbCode:
                  type: integer
                  example: 1009
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    position of the Postal Code when presenting the address.
            postalRoute:
              type: string
              example: route 3B
              description: >-
                A code assigned by the local postal authority that sorts mail
                pieces to the individual carrier routes within a postal code.
            streetNumber:
              type: string
              example: 492
              description: >-
                The number part of the street address where the entity is
                located. <br/><br/>This may be a single number, a number with an
                appendix, or a range of street numbers. <br/><br/>For example,
                the &quot;51 - 59C&quot; in the address 51 - 59C Wall Street.
            streetName:
              type: string
              example: KOLLER ST
              description: >-
                The name of the street where the entity is located.
                <br/><br/>For example, &quot;Wall Street&quot; in the address 51
                - 59C Wall Street.
            streetAddress:
              type: object
              description: The details of the street address where the entity is located.
              properties:
                line1:
                  type: string
                  example: 492 KOLLER ST
                  description: >-
                    The first line of the address where the entity is
                    located.<br/><br/>For example, &quot;41 Central
                    Chambers&quot; in the address <br/>41 Central
                    Chambers<br/>Dame Court<br/>Dublin 2
                line2:
                  type: string
                  example: Suite 100
                  description: >-
                    The second line of the address where the entity is
                    located.<br/><br/>For example, &quot;Dame Court&quot; in the
                    address <br/>41 Central Chambers<br/>Dame Court<br/>Dublin 2
            postOfficeBox:
              type: object
              description: >-
                The details of the identifier issued to the entity by a private
                or public Postal Office for the purposes of collecting mail for
                the entity for subsequent collection or delivery.
              properties:
                postOfficeBoxNumber:
                  type: string
                  example: 5309
                  description: >-
                    An identifier issued to the entity by a private or public
                    postal office for the purposes of collecting mail for the
                    entity for subsequent collection or delivery.<br/><br/>This
                    includes only the identifying number (or text) and not the
                    textual description of the PO Box type. For example the
                    contents would be just the number 12 from &quot;PO Box
                    12&quot;, or just the number 57 from &quot;PMB 57&quot;.
                typeDescription:
                  type: string
                  example: Supplied by public Post Office authority
                  description: The type of the PO Box (e.g., Post Office Box, PMB).
                typeDnBCode:
                  type: integer
                  example: 120
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    type of PO Box.
        stockExchanges:
          type: array
          items:
            description: >-
              The details of the Stock Exchanges on which the entity's shares
              are traded.
            properties:
              tickerName:
                type: string
                example: NYSE:DNB
                description: >-
                  Text by which the entity is identified on this Stock Exchange
                  for share trading purposes.
              exchangeName:
                type: object
                description: >-
                  The details of the name of the Stock Exchange on which the
                  entity's shares are traded.
                properties:
                  description:
                    type: string
                    example: NYSE
                    description: The name the Stock Exchange.
              exchangeCountry:
                type: object
                description: The details of the country of the Stock Exchange.
                properties:
                  isoAlpha2Code:
                    type: string
                    example: US
                    description: >-
                      The two-letter country code, defined by the International
                      Organization for Standardization (ISO) ISO 3166-1 scheme
                      identifying the country of the Stock Exchange.
              isPrimary:
                type: boolean
                example: 'true'
                description: >-
                  Indicates if this is the most important stock exchange among
                  all the stock exchange where the entity's shares are traded.
                  <br/><br/>- If true, indicates that this is the most important
                  Stock Exchange.<br/>- If false, indicates that this is not the
                  most important Stock Exchange.
            type: object
        thirdPartyAssessment:
          type: array
          items:
            description: >-
              The details of the appraisal or opinion assigned to the entity by
              an organization other than the Dun & Bradstreet Worldwide Network
              (WWN).
            properties:
              description:
                type: string
                example: Fortune 500 Revenue Rank
                description: >-
                  The kind of appraisal, opinion, or rank that was assigned to
                  the entity by the third party (e.g., Moody's Long Term
                  Obligation Rating, FICO score, Vantage Score).
              dnbCode:
                type: integer
                example: 23290
                description: >-
                  A unique code assigned by Dun & Bradstreet to identify the
                  type of assessment.
              assessmentDate:
                type: string
                example: 2017
                description: >-
                  The date on which the assessment value was assigned by the
                  third party.
              value:
                type: string
                example: 31
                description: >-
                  The value for the appraisal, opinion, or rank that was
                  assigned by the third party.
            type: object
        registrationNumbers:
          type: array
          items:
            description: >-
              The details of the numbers assigned by an external body or by Dun
              & Bradstreet that either uniquely identifies or helps to identify
              the entity.
            properties:
              registrationNumber:
                type: string
                example: 12-3456789
                description: >-
                  The number assigned by an external body or by Dun & Bradstreet
                  that either uniquely identifies or helps to identify the
                  entity.
              typeDescription:
                type: string
                example: Federal Taxpayer Identification Number (US)
                description: >-
                  The type of registration (e.g., Chamber of Commerce Number,
                  Value Added Tax Number, Federal Taxpayer Identification
                  Number, Companies Registry Office Number).
              typeDnBCode:
                type: integer
                example: 6863
                description: >-
                  A unique code assigned by Dun & Bradstreet to identify the
                  type of registration number.
            type: object
        industryCodes:
          type: array
          items:
            description: >-
              The details of the business activities in which the entity is
              actively engaged using standardized coding schemes such as
              European NACE and U.S. Standard Industry Classifications (SIC).
            properties:
              code:
                type: string
                example: 323111
                description: >-
                  The code that identifies the business activity in which the
                  entity is engaged.  <br/><br/>For example, 1611 represents the
                  highway and street construction industry in the U.S. SIC
                  (Standard Industrial Classification) system.<br/><br/>Note:
                  These are generally external codes created by an external
                  authoritative body, like the U.S. Office of Management and
                  Budget (OMB); however, Dun & Bradstreet may have created
                  extensions to more precisely define an activity, as in the
                  case of the SIC 2+2 (the last 4 digits of an 8-digit SIC).
              description:
                type: string
                example: 'Commercial Printing '
                description: >-
                  The business activity description as assigned by the coding
                  scheme used.
              typeDescription:
                type: string
                example: North American Industry Classification System 2012
                description: >-
                  The industry coding scheme used for this Industry Code (e.g.,
                  U.S. Standard Industrial Classification (SIC) 1987, Standard
                  Industry Code - 8 digit, North American Industry
                  Classification System (NAICS), Nomenclature Generale des
                  Activites Economiques dans L`Union Europeenne (NACE)).
              typeDnBCode:
                type: integer
                example: 24664
                description: >-
                  A unique code assigned by Dun & Bradstreet to identify the
                  industry coding scheme.
              priority:
                type: integer
                example: 1
                description: >-
                  A number identifying the order in which this industry code
                  should be presented relative to other industry codes of the
                  same type where the lower the number the earlier the data is
                  presented.
            type: object
        businessEntityType:
          type: object
          description: >-
            The details of the legal form or structure of the entity as
            registered with government authorities.
          properties:
            description:
              type: string
              example: Corporation
              description: >-
                The name of the legal form or structure of the entity as
                registered with government authorities (e.g., partnership,
                corporation, private limited company, government department,
                proprietorship).
            dnbCode:
              type: integer
              example: 451
              description: >-
                A unique code assigned by Dun & Bradstreet to identify the legal
                form or structure of the entity as registered with government
                authorities.
        controlOwnershipDate:
          type: string
          example: 1985
          description: The date when the current owners took over the entity.
        startDate:
          type: string
          example: 1985
          description: >-
            The date the entity chooses to claim as its established date.
            <br/><br/>Note: This date may be different from the Operations Start
            Date.
        controlOwnershipType:
          type: object
          description: The details of the type of controlling ownership.
          properties:
            description:
              type: string
              example: Privately owned
              description: >-
                The name for the type of controlling ownership (e.g., publicly
                owned, privately owned, state owned).   <br/><br/>Note:  For
                some countries, controlling ownership can be derived from the
                legal form.
            dnbCode:
              type: integer
              example: 9058
              description: >-
                A unique code assigned by Dun & Bradstreet to identify the type
                of controlling ownership.
        isAgent:
          type: boolean
          example: 'false'
          description: >-
            Indicates if the entity acts as an agent promoting the goods or
            services of another entity (e.g., Sales Agent, Purchasing Agent).
            <br/><br/>- If true, the entity acts as an agent.<br/>- If false,
            the entity does not act as an agent.
        isImporter:
          type: boolean
          example: 'false'
          description: >-
            Indicates if the entity is an importer.<br/><br/>- If true, the
            entity imports a quantity of goods from other countries.<br/>- If
            false, the entity does not import a quantity of goods from other
            countries.
        isExporter:
          type: boolean
          example: 'false'
          description: >-
            Indicates if the entity is an exporter.<br/><br/>- If true, the
            entity exports a quantity of goods to other countries.<br/>- If
            false, the entity does not export a quantity of goods to other
            countries.
        numberOfEmployees:
          type: array
          items:
            description: >-
              The details of the people engaged by the entity to perform its
              operations.
            properties:
              value:
                type: integer
                example: 1234
                description: >-
                  The total number of people engaged by the entity to perform
                  its operations.  The scope of this employee figure is
                  identified in informationScopeDescription.
              informationScopeDescription:
                type: string
                example: Consolidated
                description: >-
                  The scope of Number of Employees value (e.g., Consolidated,
                  Individual, HQ only).
              informationScopeDnBCode:
                type: integer
                example: 9067
                description: >-
                  A unique code assigned by Dun & Bradstreet to identify the
                  scope of Number of Employees.
              reliabilityDescription:
                type: string
                example: Actual
                description: >-
                  The integrity of the employee figures (e.g., audited, actual,
                  estimated, or modeled).
              reliabilityDnBCode:
                type: integer
                example: 9092
                description: >-
                  A unique code assigned by Dun & Bradstreet to identify the
                  integrity of the employee figures.
              employeeCategories:
                type: array
                items:
                  description: >-
                    The details of the employee figures for the different
                    function levels of the entity.
                  properties:
                    employmentBasisDescription:
                      type: string
                      example: Principals
                      description: >-
                        The type of employees that have been included in the
                        calculation of the number of employees on the basis of
                        their employment contract (e.g., Principals, Part Time
                        Workers).
                    employmentBasisDnBCode:
                      type: integer
                      example: 9064
                      description: >-
                        A unique code assigned by Dun & Bradstreet to identify
                        the employment basis description.
                  type: object
              trend:
                type: array
                items:
                  description: The details of the employee growth  history.
                  properties:
                    timePeriod:
                      type: object
                      description: >-
                        The details of timeframe for which this data is
                        recorded.
                      properties:
                        description:
                          type: string
                          example: 1 - 5 years
                          description: The timeframe for which this data is recorded.
                        dnbCode:
                          type: integer
                          example: 13721
                          description: >-
                            A unique code assigned by Dun & Bradstreet to
                            identify the timeframe for which this data is
                            recorded.
                    growthRate:
                      type: number
                      example: -7
                      description: >-
                        The percentage of change in number of employees from
                        base year compared to the trend year.
                  type: object
            type: object
        financials:
          type: array
          items:
            description: >-
              The details of the standardized view of the financial results of
              the entity; this is usually extracted from a set of accounts.
            properties:
              financialStatementToDate:
                type: string
                example: '2025-08-19T06:23:16Z'
                description: >-
                  The date when the accounting period ended.  If the Reliability
                  Code denotes the figures are projected (future), then this is
                  the date when the accounting period will end.<br/><br/>Format:
                  YYYY-MM-DD or YYYY-MM
              financialStatementDuration:
                type: string
                example: Annual
                description: >-
                  The period of the financial statement expressed as a time
                  interval.
              informationScopeDescription:
                type: string
                example: Actual
                description: >-
                  The organizational scope of the financial summary (e.g.,
                  Individual (Organization including any branches), Consolidated
                  (Organization including any branches and subsidiaries)).
              informationScopeDnBCode:
                type: integer
                example: 9092
                description: >-
                  A unique code assigned by Dun & Bradstreet to identify the
                  organizational scope of the financial summary.
              reliabilityDescription:
                type: string
                example: Actual
                description: >-
                  The integrity of the financial figures (e.g., audited, actual,
                  estimated, or modeled).
              reliabilityDnBCode:
                type: integer
                example: 9092
                description: >-
                  A unique code assigned by Dun & Bradstreet to identify the
                  integrity of the financial figures.
              unitCode:
                type: string
                example: Single Units
                description: >-
                  The unit of size in which the financial summary figures are
                  provided (e.g., in 1,000s; in 1,000,000s)
              accountantName:
                type: string
                example: Johnson, Jordan & Jones CPAs
                description: The name of either an individual or an accounting firm.
              yearlyRevenue:
                type: array
                items:
                  description: >-
                    The details of the income received from customers from the
                    sale of the entity''s goods and/or services. This is the
                    gross sales minus any returns, rebates/discounts, allowances
                    for damages or shortages, shipping expenses passed on to the
                    customer, and amounts due where there is not a reasonable
                    expectation of collection.
                  properties:
                    value:
                      type: number
                      example: 19945238
                      description: >-
                        The monetary value of income received from customers
                        from the sale of the entity's goods and/or services. 
                        This is the gross sales minus any returns,
                        rebates/discounts, allowances for damages or shortages,
                        shipping expenses passed on to the customer.
                    currency:
                      type: string
                      example: USD
                      description: >-
                        The three-letter currency code, defined in the ISO
                        3166-1 scheme published by International Organization
                        for Standardization (ISO) identifying the type of money
                        in which this amount is expressed (e.g. USD, CAD, GBP,
                        EUR).
                    trend:
                      type: array
                      items:
                        description: >-
                          The details of the percentage of change of this item
                          as of base year compared to the trend year.
                        properties:
                          timePeriod:
                            type: object
                            description: >-
                              The details of the timeframe for which this data
                              is recorded.
                            properties:
                              description:
                                type: string
                                example: 1-5 years
                                description: The timeframe for which this data is recorded.
                              dnbCode:
                                type: integer
                                example: 13721
                                description: >-
                                  A unique code assigned by Dun & Bradstreet to
                                  identify the timeframe in which this data is
                                  recorded.
                          growthRate:
                            type: number
                            example: 2
                            description: >-
                              The percentage of change of this item as of base
                              year compared to the trend year.
                        type: object
                  type: object
            type: object
        mostSeniorPrincipals:
          type: array
          items:
            description: The  details of the most important principals.
            properties:
              givenName:
                type: string
                example: Leslie
                description: The given name of the principal.
              familyName:
                type: string
                example: Smith
                description: The family name of the principal.
              fullName:
                type: string
                example: Leslie Ann Smith
                description: The complete name of the principal.
              namePrefix:
                type: string
                example: Dr.
                description: >-
                  The correct form of address for the principal (e.g., Dr.,
                  Professor, Lord).
              nameSuffix:
                type: string
                example: PhD
                description: The familial or professional suffix to the principal's name.
              gender:
                type: string
                example: Female
                description: The gender of this individual.
              jobTitles:
                type: array
                items:
                  description: The details of the positions held by this individual.
                  properties:
                    title:
                      type: string
                      example: President
                      description: The position held by this individual.
                  type: object
              managementResponsibilities:
                type: array
                items:
                  description: >-
                    The details of the current business functions of the entity
                    represented as a standard Management Responsibility Code
                    (MRC).
                  properties:
                    description:
                      type: string
                      example: President
                      description: >-
                        Name of the business function of the entity derived from
                        a standard Management Responsibility Code (MRC).
                    mrcCode:
                      type: string
                      example: A1A6
                      description: >-
                        A unique code identifying the business function of the
                        entity derived from a standard Management Responsibility
                        Code (MRC).
                  type: object
            type: object
        currentPrincipals:
          type: array
          items:
            description: >-
              The details of the principals that are actively associated with
              the entity.
            properties:
              givenName:
                type: string
                example: Leslie
                description: The given name of the principal.
              familyName:
                type: string
                example: Smith
                description: The family name of the principal.
              fullName:
                type: string
                example: Leslie Ann Smith
                description: The complete name of the principal.
              namePrefix:
                type: string
                example: Dr.
                description: >-
                  The correct form of address for the principal (e.g., Dr.,
                  Professor, Lord).
              nameSuffix:
                type: string
                example: PhD
                description: The familial or professional suffix to the principal's name.
              gender:
                type: string
                example: Female
                description: The gender of this individual.
              jobTitles:
                type: array
                items:
                  description: The details of the positions held by this individual.
                  properties:
                    title:
                      type: string
                      example: President
                      description: The position held by this individual.
                  type: object
              managementResponsibilities:
                type: array
                items:
                  description: >-
                    The details of the current business functions of the entity
                    represented as a standard Management Responsibility Code
                    (MRC).
                  properties:
                    description:
                      type: string
                      example: President
                      description: >-
                        Name of the business function of the entity derived from
                        a standard Management Responsibility Code (MRC).
                    mrcCode:
                      type: string
                      example: A1A6
                      description: >-
                        A unique code identifying the business function of the
                        entity derived from a standard Management Responsibility
                        Code (MRC).
                  type: object
            type: object
        socioEconomicInformation:
          type: object
          description: >-
            The details of the categorization of the entity in Socio Economic or
            Statistical groups.
          properties:
            isMinorityOwned:
              type: boolean
              example: 'false'
              description: >-
                Indicates if the entity is minority owned.  Minority owned means
                it is certified as an entity that is greater than 50% owned by
                and whose management and daily operations are controlled by one
                or more minority group members<br/><br/>- If true, indicates
                that this is a minority-owned entity.<br/>- If false, indicates
                that this is not a minority-owned entity.
            isSmallBusiness:
              type: boolean
              example: 'false'
              description: >-
                Indicates if the business qualifies as small business, eligible
                for assistance from SBA, with a place of business located in the
                United States. It must operate primarily within the United
                States or make a significant contribution to the U.S. economy
                through payment of taxes or use of American products, materials
                or labor. Together with its affiliates, it must meet the
                numerical size standards as defined in the Small Business Size
                Regulations 13 CFR 121.<br/><br/>- If true, indicates that this
                is a small business.<br/>- If false, indicates that this is not
                a small business.
        isStandalone:
          type: boolean
          example: 'false'
          description: >-
            Indicates if the entity is a member of a legal family tree.
            <br/><br/>- If true, indicates that the entity is not a member of a
            legal family tree.  This means it cannot play any family tree role
            and corporateLinkage will not be present.<br/>- If false, indicates
            that the entity is a member of a legal family tree.  The roles it
            plays is indicated by Family Tree Member Roles played.
        corporateLinkage:
          type: object
          description: >-
            The details of the relationship between the entity and other
            entities in the legal family tree.
          properties:
            familytreeRolesPlayed:
              type: array
              items:
                description: >-
                  The details of the roles the entity plays as a member of an
                  ownership structured family tree.
                properties:
                  description:
                    type: string
                    example: Parent/Headquarters
                    description: >-
                      The role the entity plays as a member of an ownership
                      structured family tree (e.g., a branch, division, a
                      parent, headquarters, subsidiary, global ultimate,
                      domestic ultimate).
                  dnbCode:
                    type: integer
                    example: 9141
                    description: >-
                      A unique code assigned by Dun & Bradstreet to identify
                      describing family tree role.
                type: object
            hierarchyLevel:
              type: integer
              example: 1
              description: >-
                The number of family-tree levels below the global ultimate the
                entity is in its corporate hierarchy. The hierarchy level value
                of the global ultimate will always be 1. Each subsidiary level
                below the global ultimate is incremented by 1. Branch locations
                in a family tree will have the same hierarchy code as its
                associated headquarter.
            globalUltimateFamilyTreeMembersCount:
              type: integer
              description: >-
                The total number of entities in the entity's Family tree
                starting from Global Ultimate.
              example: '4'
            globalUltimate:
              type: object
              description: >-
                The details of the top most entity in the family tree, tracing
                each parent up to its own parent.  <br/><br/>For example,
                Company-A is based in the US and has Company-B as its parent
                also in the US. In turn Company-B is owned by Company-C, also in
                the US, which is owned by Company-D which is in the UK. Thus,
                the Global Ultimate of this family tree (and therefore of each
                member of the family tree) is Company-D.
              properties:
                duns:
                  type: string
                  example: 804735132
                  description: >-
                    The D-U-N-S Number, assigned by Dun & Bradstreet, is an
                    identification number that uniquely identifies the entity in
                    accordance with the Data Universal Numbering System
                    (D-U-N-S).
                primaryName:
                  type: string
                  example: GORMAN MANUFACTURING COMPANY, INC.
                  description: >-
                    The single name by which the entity is primarily known or
                    identified.
                primaryAddress:
                  type: object
                  description: >-
                    The details of the single primary or physical address at
                    which the entity is located.
                  properties:
                    addressCountry:
                      type: object
                      description: >-
                        The details of the country in which this address is
                        located.
                      properties:
                        name:
                          type: string
                          example: United States
                          description: >-
                            The name of the country in which this address is
                            located.
                        isoAlpha2Code:
                          type: string
                          example: US
                          description: >-
                            The two-letter country code, defined by the
                            International Organization for Standardization (ISO)
                            ISO 3166-1 scheme identifying the country in which
                            this address is located.
                        fipsCode:
                          type: string
                          example: US
                          description: >-
                            The Federal Information Processing Standards (FIPS)
                            code value that identifies the country in which this
                            address is located.
                    continentalRegion:
                      type: object
                      description: >-
                        The details of the continental region in which this
                        address is located.
                      properties:
                        name:
                          type: string
                          example: North America
                          description: >-
                            The name of the continental region for this
                            address.<br/><br/>Possible values:<br/>-
                            Africa<br/>- Asia Pacific<br/>- Europe<br/>- Latin
                            America<br/>- Middle East<br/>- North America
                    addressLocality:
                      type: object
                      description: >-
                        The details of the city, town, township, village,
                        borough, etc. in which this address is located.
                      properties:
                        name:
                          type: string
                          example: SAN FRANCISCO
                          description: >-
                            The name of the city, town, township, village,
                            borough, etc. in which this address is located.
                    addressRegion:
                      type: object
                      description: >-
                        The details of the locally governed area that forms part
                        of a centrally governed nation to identify where this
                        address is located.
                      properties:
                        name:
                          type: string
                          example: California
                          description: >-
                            The name of the locally governed area that forms
                            part of a centrally governed nation to identify
                            where this address is located.
                        abbreviatedName:
                          type: string
                          example: CA
                          description: >-
                            The shortened name of the locally governed area that
                            forms part of a centrally governed nation. For
                            example 'NJ' for the US State New Jersey within
                            Country United States.
                    addressCounty:
                      type: object
                      description: >-
                        The details of the county in which this address is
                        located.
                      properties:
                        name:
                          type: string
                          example: SAN MATEO
                          description: >-
                            The name of the county in which this address is
                            located.
                    postalCode:
                      type: string
                      example: 941109999
                      description: >-
                        An identifier used by the local country's postal
                        authority to identify where this address is located.
                    streetAddress:
                      type: object
                      description: >-
                        The details of the street address where the entity is
                        located.
                      properties:
                        line1:
                          type: string
                          example: 492 KOLLER ST
                          description: >-
                            The first line of the address where the entity is
                            located.<br/><br/>For example, &quot;41 Central
                            Chambers&quot; in the address <br/>41 Central
                            Chambers<br/>Dame Court<br/>Dublin 2
                        line2:
                          type: string
                          example: Suite 100
                          description: >-
                            The second line of the address where the entity is
                            located.<br/><br/>For example, &quot;Dame
                            Court&quot; in the address <br/>41 Central
                            Chambers<br/>Dame Court<br/>Dublin 2
            domesticUltimate:
              type: object
              description: >-
                The details of the Domestic Ultimate which is the last entity in
                the tree, when reviewing upwards, that is in the same country as
                the entity. <br/><br/>For example, Company-A is based in the US
                and has Company-B as its parent also in the US. In turn
                Company-B is owned by Company-C, also in the US, which is owned
                by Company-D which is in the UK. Thus, the Domestic Ultimate of
                Company-A is actually Company-C as this is the last entity in
                the parent chain that is in the US.
              properties:
                duns:
                  type: string
                  example: 804735132
                  description: >-
                    The D-U-N-S Number, assigned by Dun & Bradstreet, is an
                    identification number that uniquely identifies the entity in
                    accordance with the Data Universal Numbering System
                    (D-U-N-S).
                primaryName:
                  type: string
                  example: GORMAN MANUFACTURING COMPANY, INC.
                  description: >-
                    The single name by which the entity is primarily known or
                    identified.
                primaryAddress:
                  type: object
                  description: >-
                    The details of the single primary or physical address at
                    which the entity is located.
                  properties:
                    addressCountry:
                      type: object
                      description: >-
                        The details of the country in which this address is
                        located.
                      properties:
                        name:
                          type: string
                          example: United States
                          description: >-
                            The name of the country in which this address is
                            located.
                        isoAlpha2Code:
                          type: string
                          example: US
                          description: >-
                            The two-letter country code, defined by the
                            International Organization for Standardization (ISO)
                            ISO 3166-1 scheme identifying the country in which
                            this address is located.
                        fipsCode:
                          type: string
                          example: US
                          description: >-
                            The Federal Information Processing Standards (FIPS)
                            code value that identifies the country in which this
                            address is located.
                    continentalRegion:
                      type: object
                      description: >-
                        The details of the continental region in which this
                        address is located.
                      properties:
                        name:
                          type: string
                          example: North America
                          description: >-
                            The name of the continental region for this
                            address.<br/><br/>Possible values:<br/>-
                            Africa<br/>- Asia Pacific<br/>- Europe<br/>- Latin
                            America<br/>- Middle East<br/>- North America
                    addressLocality:
                      type: object
                      description: >-
                        The details of the city, town, township, village,
                        borough, etc. in which this address is located.
                      properties:
                        name:
                          type: string
                          example: SAN FRANCISCO
                          description: >-
                            The name of the city, town, township, village,
                            borough, etc. in which this address is located.
                    addressRegion:
                      type: object
                      description: >-
                        The details of the locally governed area that forms part
                        of a centrally governed nation to identify where this
                        address is located.
                      properties:
                        name:
                          type: string
                          example: California
                          description: >-
                            The name of the locally governed area that forms
                            part of a centrally governed nation to identify
                            where this address is located.
                        abbreviatedName:
                          type: string
                          example: CA
                          description: >-
                            The shortened name of the locally governed area that
                            forms part of a centrally governed nation. For
                            example 'NJ' for the US State New Jersey within
                            Country United States.
                    addressCounty:
                      type: object
                      description: >-
                        The details of the county in which this address is
                        located.
                      properties:
                        name:
                          type: string
                          example: SAN MATEO
                          description: >-
                            The name of the county in which this address is
                            located.
                    postalCode:
                      type: string
                      example: 941109999
                      description: >-
                        An identifier used by the local country's postal
                        authority to identify where this address is located.
                    streetAddress:
                      type: object
                      example: ''
                      description: >-
                        The details of the street address where the entity is
                        located.
                      properties:
                        line1:
                          type: string
                          example: 492 KOLLER ST
                          description: >-
                            The first line of the address where the entity is
                            located.<br/><br/>For example, &quot;41 Central
                            Chambers&quot; in the address <br/>41 Central
                            Chambers<br/>Dame Court<br/>Dublin 2
                        line2:
                          type: string
                          example: Suite 100
                          description: >-
                            The second line of the address where the entity is
                            located.<br/><br/>For example, &quot;Dame
                            Court&quot; in the address <br/>41 Central
                            Chambers<br/>Dame Court<br/>Dublin 2
            parent:
              type: object
              description: >-
                The details of the entity that owns more than 50% of the subject
                entity.
              properties:
                duns:
                  type: string
                  example: 804735132
                  description: >-
                    The D-U-N-S Number, assigned by Dun & Bradstreet, is an
                    identification number that uniquely identifies the entity in
                    accordance with the Data Universal Numbering System
                    (D-U-N-S).
                primaryName:
                  type: string
                  example: GORMAN MANUFACTURING COMPANY, INC.
                  description: >-
                    The single name by which the entity is primarily known or
                    identified.
                primaryAddress:
                  type: object
                  description: >-
                    The details of the single primary or physical address at
                    which the entity is located.
                  properties:
                    addressCountry:
                      type: object
                      description: >-
                        The details of the country in which this address is
                        located.
                      properties:
                        name:
                          type: string
                          example: United States
                          description: >-
                            The name of the country in which this address is
                            located.
                        isoAlpha2Code:
                          type: string
                          example: US
                          description: >-
                            The two-letter country code, defined by the
                            International Organization for Standardization (ISO)
                            ISO 3166-1 scheme identifying the country in which
                            this address is located.
                        fipsCode:
                          type: string
                          example: US
                          description: >-
                            The Federal Information Processing Standards (FIPS)
                            code value that identifies the country in which this
                            address is located.
                    continentalRegion:
                      type: object
                      description: >-
                        The details of the continental region in which this
                        address is located.
                      properties:
                        name:
                          type: string
                          example: North America
                          description: >-
                            The name of the continental region for this
                            address.<br/><br/>Possible values:<br/>-
                            Africa<br/>- Asia Pacific<br/>- Europe<br/>- Latin
                            America<br/>- Middle East<br/>- North America
                    addressLocality:
                      type: object
                      description: >-
                        The details of the city, town, township, village,
                        borough, etc. in which this address is located.
                      properties:
                        name:
                          type: string
                          example: SAN FRANCISCO
                          description: >-
                            The name of the city, town, township, village,
                            borough, etc. in which this address is located.
                    addressRegion:
                      type: object
                      description: >-
                        The details of the locally governed area that forms part
                        of a centrally governed nation to identify where this
                        address is located.
                      properties:
                        name:
                          type: string
                          example: California
                          description: >-
                            The name of the locally governed area that forms
                            part of a centrally governed nation to identify
                            where this address is located.
                        abbreviatedName:
                          type: string
                          example: CA
                          description: >-
                            The shortened name of the locally governed area that
                            forms part of a centrally governed nation. For
                            example 'NJ' for the US State New Jersey within
                            Country United States.
                    addressCounty:
                      type: object
                      description: >-
                        The details of the county in which this address is
                        located.
                      properties:
                        name:
                          type: string
                          example: SAN MATEO
                          description: >-
                            The name of the county in which this address is
                            located.
                    postalCode:
                      type: string
                      example: 941109999
                      description: >-
                        An identifier used by the local country's postal
                        authority to identify where this address is located.
                    streetAddress:
                      type: object
                      description: >-
                        The details of the street address where the entity is
                        located.
                      properties:
                        line1:
                          type: string
                          example: 492 KOLLER ST
                          description: >-
                            The first line of the address where the entity is
                            located.<br/><br/>For example, &quot;41 Central
                            Chambers&quot; in the address <br/>41 Central
                            Chambers<br/>Dame Court<br/>Dublin 2
                        line2:
                          type: string
                          example: Suite 100
                          description: >-
                            The second line of the address where the entity is
                            located.<br/><br/>For example, &quot;Dame
                            Court&quot; in the address <br/>41 Central
                            Chambers<br/>Dame Court<br/>Dublin 2
            headQuarter:
              type: object
              description: >-
                The details of the office that serves as the administrative
                center for the entity.
              properties:
                duns:
                  type: string
                  example: 804735132
                  description: >-
                    The D-U-N-S Number, assigned by Dun & Bradstreet, is an
                    identification number that uniquely identifies the entity in
                    accordance with the Data Universal Numbering System
                    (D-U-N-S).
                primaryName:
                  type: string
                  example: GORMAN MANUFACTURING COMPANY, INC.
                  description: >-
                    The single name by which the entity is primarily known or
                    identified.
                primaryAddress:
                  type: object
                  description: >-
                    The details of the single primary or physical address at
                    which the entity is located.
                  properties:
                    addressCountry:
                      type: object
                      description: >-
                        The details of the country in which this address is
                        located.
                      properties:
                        name:
                          type: string
                          example: United States
                          description: >-
                            The name of the country in which this address is
                            located.
                        isoAlpha2Code:
                          type: string
                          example: US
                          description: >-
                            The two-letter country code, defined by the
                            International Organization for Standardization (ISO)
                            ISO 3166-1 scheme identifying the country in which
                            this address is located.
                        fipsCode:
                          type: string
                          example: US
                          description: >-
                            The Federal Information Processing Standards (FIPS)
                            code value that identifies the country in which this
                            address is located.
                    continentalRegion:
                      type: object
                      description: >-
                        The details of the continental region in which this
                        address is located.
                      properties:
                        name:
                          type: string
                          example: North America
                          description: >-
                            The name of the continental region for this
                            address.<br/><br/>Possible values:<br/>-
                            Africa<br/>- Asia Pacific<br/>- Europe<br/>- Latin
                            America<br/>- Middle East<br/>- North America
                    addressLocality:
                      type: object
                      description: >-
                        The details of the city, town, township, village,
                        borough, etc. in which this address is located.
                      properties:
                        name:
                          type: string
                          example: SAN FRANCISCO
                          description: >-
                            The name of the city, town, township, village,
                            borough, etc. in which this address is located.
                    addressRegion:
                      type: object
                      description: >-
                        The details of the locally governed area that forms part
                        of a centrally governed nation to identify where this
                        address is located.
                      properties:
                        name:
                          type: string
                          example: California
                          description: >-
                            The name of the locally governed area that forms
                            part of a centrally governed nation to identify
                            where this address is located.
                        abbreviatedName:
                          type: string
                          example: CA
                          description: >-
                            The shortened name of the locally governed area that
                            forms part of a centrally governed nation. For
                            example 'NJ' for the US State New Jersey within
                            Country United States.
                    addressCounty:
                      type: object
                      description: >-
                        The details of the county in which this address is
                        located.
                      properties:
                        name:
                          type: string
                          example: SAN MATEO
                          description: >-
                            The name of the county in which this address is
                            located.
                    postalCode:
                      type: string
                      example: 941109999
                      description: >-
                        An identifier used by the local country's postal
                        authority to identify where this address is located.
                    streetAddress:
                      type: object
                      description: >-
                        The details of the street address where the entity is
                        located.
                      properties:
                        line1:
                          type: string
                          example: 492 KOLLER ST
                          description: >-
                            The first line of the address where the entity is
                            located.<br/><br/>For example, &quot;41 Central
                            Chambers&quot; in the address <br/>41 Central
                            Chambers<br/>Dame Court<br/>Dublin 2
                        line2:
                          type: string
                          example: Suite 100
                          description: >-
                            The second line of the address where the entity is
                            located.<br/><br/>For example, &quot;Dame
                            Court&quot; in the address <br/>41 Central
                            Chambers<br/>Dame Court<br/>Dublin 2
        shareOwnership:
          type: array
          items:
            description: >-
              The details of the recording of the individual, organization or
              entity that owns stock or common stock of the subject
              organization.
            properties:
              duns:
                type: string
                example: '804735132'
                description: >-
                  When a shareholder is a business, Dun & Bradstreet may assign
                  a D-U-N-S Number to the company that owns stock or common
                  stock of the subject entity.  The D-U-N-S Number is an
                  identification number that uniquely identifies the
                  organization in accordance with the Data Universe Numbering
                  System (D-U-N-S).  Presence of a D-U-N-S Number is not a
                  requirement to be a shareholder.
              primaryName:
                type: string
                example: GORMAN MANUFACTURING COMPANY, INC.
                description: >-
                  Single name by which the organization is primarily known or
                  identified.
              primaryAddress:
                type: object
                description: >-
                  The details of the Primary Address at which the organization
                  is located or conducts operations.
                properties:
                  addressCountry:
                    type: object
                    description: >-
                      The details of the country or region where the address of
                      the organization is located or conducts operations.
                    properties:
                      name:
                        type: string
                        example: United States
                        description: >-
                          The Country or Region where the organization's Primary
                          Address is located or conducts operations .
                      isoAlpha2Code:
                        type: string
                        example: US
                        description: >-
                          The 2 letter alpha country code assigned by the
                          International Organization for Standardization (ISO)
                          identifying the Country/Region where the
                          organization's Primary address is located or conducts
                          operations .
                  continentalRegion:
                    type: object
                    description: >-
                      The details of the Continent in which the Primary Address
                      of the organisation is located or conducts operations.
                    properties:
                      name:
                        type: string
                        example: North America
                        description: >-
                          The name of the continent where the Primary Address of
                          the organization is located or conducts
                          operations.<br/>Possible values <br/>Africa<br/>Asia
                          Pacific<br/>Europe<br/>North America<br/>Middle
                          East<br/>South America
                  addressLocality:
                    type: object
                    description: >-
                      The details of the locality where the organization's
                      Primary Address is located or conducts operations.
                      Locality defined as a district population cluster. City,
                      town, township, village, borough etc.
                    properties:
                      name:
                        type: string
                        example: SAN FRANCISCO
                        description: >-
                          The name of the locality where the organization's
                          Primary Address is located or conducts operations.
                          Locality defined as a district population cluster.
                          City, town, township, village, borough etc.
                  addressRegion:
                    type: object
                    description: >-
                      Details of the type of geographical area where the
                      organization's Primary Address is located or conducts
                      operations.<br/>Different markets have their own way of
                      subdividing the country into smaller parts.
                      <br/>Examples:<br/>Departments (France)<br/>States
                      (USA)<br/>Provinces (Netherlands)<br/>Counties
                      (UK)<br/>Bundeslander (Germany)<br/>Provinces and
                      Territories (Canada)
                    properties:
                      name:
                        type: string
                        example: California
                        description: >-
                          The name of the geographical area where the
                          organization's Primary Address is located or conducts
                          operations. For Example New Jersey.
                      abbreviatedName:
                        type: string
                        example: CA
                        description: >-
                          The shortened name of the geographical area where the
                          organization's Primary Address is located or conducts
                          operations For example NJ for the US State New Jersey
                          within Country United States.
                  postalCode:
                    type: string
                    example: '941109999'
                    description: >-
                      The postal code of the organization's Primary
                      Address.<br/><br/>Also known locally in various
                      English-speaking countries throughout the world as a
                      postcode, post code, Eircode, PIN or ZIP Code) is a series
                      of letters or digits or both, sometimes including spaces
                      or punctuation, included in a postal address for the
                      purpose of sorting mail. The code is used by the
                      country&#39;s postal authority to identify the address
                      where the organization is located or conducts operations .
                  streetAddress:
                    type: object
                    description: >-
                      The details of the street address where the organization's
                      Primary Address is located.
                    properties:
                      line1:
                        type: string
                        example: 492 KOLLER ST
                        description: >-
                          The first line of the address where the entity is
                          located.<br/><br/>The first line of the Primary
                          Address where the organization is located or conducts
                          operations. For example The Point in the
                          address<br/><br/>The Point<br/>37 North Wharf
                          Road<br/>London<br/>W2 1AF
                      line2:
                        type: string
                        example: Suite 100
                        description: >-
                          The second line of the Primary Address where the
                          organization is located or conducts operations<br/>For
                          example 37 North Wharf Road in the address<br/>The
                          Point<br/>37 North Wharf Road<br/>London<br/>W2 1AF
              ownershipPercentage:
                type: number
                example: 8.56
                description: >-
                  The total percent of the subject organization's stock or
                  common stock owned by either an individual, organization with
                  DUNS or direct entity shareholder.
            type: object
        affiliates:
          type: array
          items:
            description: >-
              The details of other entities relationships to the subject entity
              typically identified when the affiliated entity has no legal
              obligation for the debts of the subject entity (e.g., Franchises,
              agents, dealers, associations, healthcare networks).
            properties:
              duns:
                type: string
                example: '804735132'
                description: >-
                  The D-U-N-S Number, a proprietary organizational identifier
                  owned and managed by Dun & Bradstreet Inc, provides unique
                  identification of a subject organization, in accordance with
                  the Data Universal Numbering System (D-U-N-S).
              primaryName:
                type: string
                example: GORMAN MANUFACTURING COMPANY, INC.
                description: >-
                  Single name by which the organization is primarily known or
                  identified.
              primaryAddress:
                type: object
                description: >-
                  The details of the Primary Address at which the organization
                  is located or conducts operations.
                properties:
                  addressCountry:
                    type: object
                    description: >-
                      The details of the country or region where the address of
                      the organization is located or conducts operations.
                    properties:
                      name:
                        type: string
                        example: United States
                        description: >-
                          The Country or Region where the organization's Primary
                          Address is located or conducts operations .
                      isoAlpha2Code:
                        type: string
                        example: US
                        description: >-
                          The 2 letter alpha country code assigned by the
                          International Organization for Standardization (ISO)
                          identifying the Country/Region where the
                          organization's Primary address is located or conducts
                          operations .
                  continentalRegion:
                    type: object
                    description: >-
                      The details of the Continent in which the Primary Address
                      of the organisation is located or conducts operations.
                    properties:
                      name:
                        type: string
                        example: North America
                        description: >-
                          The name of the continent where the Primary Address of
                          the organization is located or conducts
                          operations.<br/>Possible values <br/>Africa<br/>Asia
                          Pacific<br/>Europe<br/>North America<br/>Middle
                          East<br/>South America
                  addressLocality:
                    type: object
                    description: >-
                      The details of the locality where the organization's
                      Primary Address is located or conducts operations.
                      Locality defined as a district population cluster. City,
                      town, township, village, borough etc.
                    properties:
                      name:
                        type: string
                        example: SAN FRANCISCO
                        description: >-
                          The name of the locality where the organization's
                          Primary Address is located or conducts operations.
                          Locality defined as a district population cluster.
                          City, town, township, village, borough etc.
                  addressRegion:
                    type: object
                    description: >-
                      Details of the type of geographical area where the
                      organization's Primary Address is located or conducts
                      operations.<br/>Different markets have their own way of
                      subdividing the country into smaller parts.
                      <br/>Examples:<br/>Departments (France)<br/>States
                      (USA)<br/>Provinces (Netherlands)<br/>Counties
                      (UK)<br/>Bundeslander (Germany)<br/>Provinces and
                      Territories (Canada)
                    properties:
                      name:
                        type: string
                        example: California
                        description: >-
                          The name of the geographical area where the
                          organization's Primary Address is located or conducts
                          operations. For Example New Jersey.
                      abbreviatedName:
                        type: string
                        example: CA
                        description: >-
                          The shortened name of the geographical area where the
                          organization's Primary Address is located or conducts
                          operations For example NJ for the US State New Jersey
                          within Country United States.
                  postalCode:
                    type: string
                    example: '941109999'
                    description: >-
                      The postal code of the organization's Primary
                      Address.<br/><br/>Also known locally in various
                      English-speaking countries throughout the world as a
                      postcode, post code, Eircode, PIN or ZIP Code) is a series
                      of letters or digits or both, sometimes including spaces
                      or punctuation, included in a postal address for the
                      purpose of sorting mail. The code is used by the
                      country&#39;s postal authority to identify the address
                      where the organization is located or conducts operations .
                  streetAddress:
                    type: object
                    description: >-
                      The details of the street address where the organization's
                      Primary Address is located.
                    properties:
                      line1:
                        type: string
                        example: 492 KOLLER ST
                        description: >-
                          The first line of the address where the entity is
                          located.<br/><br/>The first line of the Primary
                          Address where the organization is located or conducts
                          operations. For example The Point in the
                          address<br/><br/>The Point<br/>37 North Wharf
                          Road<br/>London<br/>W2 1AF
                      line2:
                        type: string
                        example: Suite 100
                        description: >-
                          The second line of the Primary Address where the
                          organization is located or conducts operations<br/>For
                          example 37 North Wharf Road in the address<br/>The
                          Point<br/>37 North Wharf Road<br/>London<br/>W2 1AF
              associationType:
                type: object
                description: >-
                  The details of the nature of association of this entity with
                  subject entity.
                properties:
                  dnbCode:
                    type: integer
                    example: 30488
                    description: >-
                      A unique code assigned by Dun & Bradstreet to identify the
                      nature of association of this entity with subject
                      entity.<br/>Refer to Reference code table "511
                      [Affiliation Type]" for all possible values.
                  description:
                    type: string
                    example: Dealer Alternate Linkage
                    description: >-
                      The nature of association of this entity with subject
                      entity (e.g., Franchise, Agent).
              franchiseName:
                type: string
                example: Franchise
                description: The franchising branch.
              franchiseID:
                type: string
                example: '1058890509'
                description: >-
                  A unique code assigned by Dun & Bradstreet to identify a
                  franchising brand.
            type: object
        extendedLinkageInsight:
          type: object
          description: >-
            Records data collected from a Dun & Bradstreet Artificial
            Intelligence-driven hierarchy solution that utilizes Machine
            Learning to link businesses as a linkage expert would and capture a
            wide spectrum of potential relationship including majority
            ownership, minority ownership, franchise, dealership and much more.
          properties:
            brandName:
              type: string
              example: DUN&BRADSTREET
              description: >-
                The brand name of DUNS extracted by Extended Linkage algorithm.
                For example, if the Business Name is "The Dun & Bradstreet
                Corporation", then Brand Name will be "DUN&BRADSTREET".
            familyTreeCount:
              type: integer
              example: 145
              description: >-
                The total number of Extended Linkage Family members (i.e. The
                number of records in whole database with the same Extended
                Linkage Global Ultimate DUNS Number as the current records.)
            globalUltimate:
              type: object
              description: >-
                Records details of the Global Ultimate that is within the
                Extended Linkage Family.
              properties:
                duns:
                  type: string
                  example: '005438890'
                  description: >-
                    The Duns number of the Global Ultimate that is within the
                    Extended Linkage Family.
                name:
                  type: string
                  example: Lawson Products, Inc.
                  description: >-
                    The business name of the Global Ultimate that is within the
                    Extended Linkage Family.
                primaryAddress:
                  type: object
                  description: >-
                    The details of the single primary or physical address of the
                    global ultimate within this Extended family tree.
                  properties:
                    addressCountry:
                      type: object
                      description: >-
                        The details of the country/market in which this address
                        is located.
                      properties:
                        name:
                          type: string
                          example: United States
                          description: >-
                            The name of the country/market in which this address
                            is located.
            domesticUltimate:
              type: object
              description: >-
                Records details of the Domestic Ultimate that is within the
                Extended Linkage Family.
              properties:
                duns:
                  type: string
                  example: '005438890'
                  description: >-
                    The Duns number of the Domestic Ultimate that is within the
                    Extended Linkage Family.
                name:
                  type: string
                  example: Lawson Products, Inc.
                  description: >-
                    The business name of the Domestic Ultimate that is within
                    the Extended Linkage Family.
                primaryAddress:
                  type: object
                  description: >-
                    The details of the single primary or physical address of the
                    domestic ultimate within this Extended family tree.
                  properties:
                    addressCountry:
                      type: object
                      description: >-
                        The details of the country/market in which this address
                        is located.
                      properties:
                        name:
                          type: string
                          example: United States
                          description: >-
                            The name of the country/market in which this address
                            is located.
            parent:
              type: object
              description: >-
                Records details of the Parent that is within the Extended
                Linkage Family
              properties:
                duns:
                  type: string
                  example: '005438890'
                  description: >-
                    The DUNS number of the Parent that is within the Extended
                    Linkage Family
                name:
                  type: string
                  example: Lawson Products, Inc.
                  description: >-
                    The business name of the Parent that is within the Extended
                    Linkage Family
                primaryAddress:
                  type: object
                  description: >-
                    The details of the single primary or physical address of the
                    parent company within this Extended family tree.
                  properties:
                    addressCountry:
                      type: object
                      description: >-
                        The details of the country/market in which this address
                        is located.
                      properties:
                        name:
                          type: string
                          example: United States
                          description: >-
                            The name of the country/market in which this address
                            is located.
            linkageSourceCategory:
              type: integer
              example: 6
              description: >-
                This code indicates the source of linkage:<br/>Code "9" is
                assigned when majority ownership linkage is present.<br/>Code
                "8" is assigned when a local market linkage is present.<br/>Code
                "7" is assigned when an alternative linkage is
                present.<br/>Codes "3" to "6" are assigned whenever a modeled
                relationship is present.            Note: The source codes of 3
                - 6 are correlated with ELI Name Evidence, SIC Evidence, Brand
                Evidence, Phone Evidence, CEO Evidence and etc. The more
                evidences we've seen in those scores, the higher the source code
                will be.
            associationType:
              type: object
              description: >-
                Records the type of association and that is intended to provide
                insights into the nature of the relationship between the
                entities. it is sourced from alternative linkage when
                alternative linkage is present. When alternative linkage is not
                present, type is inferred by the model based on the brand name
                extracted and the childs line of business.
              properties:
                description:
                  type: string
                  example: Agent Alternate Linkage
                  description: >-
                    Text that indicates the type of association and that is
                    intended to provide insights into the nature of the
                    relationship between the entities. it is sourced from
                    alternative linkage when alternative linkage is present.
                dnbCode:
                  type: integer
                  example: 30487
                  description: >-
                    A unique code assigned by Dun & Bradstreet that indicates
                    the type of association and that is intended to provide
                    insights into the nature of the relationship between the
                    entities. it is sourced from alternative linkage when
                    alternative linkage is present.<br/>Refer to Reference code
                    table "511 [Affiliation Type]" for all possible values.
            nameEvidenceStrength:
              type: object
              description: >-
                Records the level of the model outcome that supports the family
                tree information derived using name.
              properties:
                description:
                  type: string
                  example: Moderate
                  description: >-
                    Text denoting the level of the model outcome that supports
                    the family tree information derived using name.
                dnbCode:
                  type: integer
                  example: 13695
                  description: >-
                    A unique code assigned by Dun & Bradstreet indicating the
                    level of the model outcome that supports the family tree
                    information derived using name.<br/>Refer to Reference code
                    table "354 [Range Position]" for all possible values.
            brandEvidenceStrength:
              type: object
              description: >-
                Records the level of the model outcome that supports the family
                tree information derived using brand name.
              properties:
                description:
                  type: string
                  example: Moderate
                  description: >-
                    Text denoting the level of the model outcome that supports
                    the family tree information derived using brand name.
                dnbCode:
                  type: integer
                  example: 13695
                  description: >-
                    A unique code assigned by Dun & Bradstreet indicating the
                    level of the model outcome that supports the family tree
                    information derived using brand name.<br/>Refer to Reference
                    code table "354 [Range Position]" for all possible values.
            industryEvidenceStrength:
              type: object
              description: >-
                Records the level of the model outcome that supports the family
                tree information derived using industry code.
              properties:
                description:
                  type: string
                  example: Moderate
                  description: >-
                    Text denoting the level of the model outcome that supports
                    the family tree information derived using industry code.
                dnbCode:
                  type: integer
                  example: 13695
                  description: >-
                    A unique code assigned by Dun & Bradstreet indicating the
                    level of the model outcome that supports the family tree
                    information derived using industry code.<br/>Refer to
                    Reference code table "354 [Range Position]" for all possible
                    values.
            locationEvidenceStrength:
              type: object
              description: >-
                Records the level of the model outcome that supports the family
                tree information derived using address.
              properties:
                description:
                  type: string
                  example: Moderate
                  description: >-
                    Text denoting the level of the model outcome that supports
                    the family tree information derived using address.
                dnbCode:
                  type: integer
                  example: 13695
                  description: >-
                    A unique code assigned by Dun & Bradstreet indicating the
                    level of the model outcome that supports the family tree
                    information derived using address.<br/>Refer to Reference
                    code table "354 [Range Position]" for all possible values.
            ceoEvidenceStrength:
              type: object
              description: >-
                Records the level of the model outcome that supports the family
                tree information derived using most senior principal data.
              properties:
                description:
                  type: string
                  example: Moderate
                  description: >-
                    Text denoting the level of the model outcome that supports
                    the family tree information derived using most senior
                    principal data.
                dnbCode:
                  type: integer
                  example: 13695
                  description: >-
                    A unique code assigned by Dun & Bradstreet indicating the
                    level of the model outcome that supports the family tree
                    information derived using most senior principal
                    data.<br/>Refer to Reference code table "354 [Range
                    Position]" for all possible values.
            principalNameEvidenceStrength:
              type: object
              description: >-
                Records the level of the model outcome that supports the family
                tree information derived using current principal data.
              properties:
                description:
                  type: string
                  example: Moderate
                  description: >-
                    Text denoting the level of the model outcome that supports
                    the family tree information derived using current principal
                    data.
                dnbCode:
                  type: integer
                  example: 13695
                  description: >-
                    A unique code assigned by Dun & Bradstreet indicating the
                    level of the model outcome that supports the family tree
                    information derived using current principal data.<br/>Refer
                    to Reference code table "354 [Range Position]" for all
                    possible values.
            telephoneEvidenceStrength:
              type: object
              description: >-
                Records the level of the model outcome that supports the family
                tree information derived using telephone information.
              properties:
                description:
                  type: string
                  example: Moderate
                  description: >-
                    Text denoting the level of the model outcome that supports
                    the family tree information derived using telephone
                    information.
                dnbCode:
                  type: integer
                  example: 13695
                  description: >-
                    A unique code assigned by Dun & Bradstreet indicating the
                    level of the model outcome that supports the family tree
                    information derived using telephone information.<br/>Refer
                    to Reference code table "354 [Range Position]" for all
                    possible values.
            webDomainEvidenceStrength:
              type: object
              description: >-
                Records the level of the model outcome that supports the family
                tree information derived using website domain information.
              properties:
                description:
                  type: string
                  example: Moderate
                  description: >-
                    Text denoting the level of the model outcome that supports
                    the family tree information derived using website domain
                    information.
                dnbCode:
                  type: integer
                  example: 13695
                  description: >-
                    A unique code assigned by Dun & Bradstreet indicating the
                    level of the model outcome that supports the family tree
                    information derived using website domain
                    information.<br/>Refer to Reference code table "354 [Range
                    Position]" for all possible values.
            webPageEvidenceStrength:
              type: object
              description: >-
                Records the level of the model outcome that supports the family
                tree information derived using website home page information.
              properties:
                description:
                  type: string
                  example: Moderate
                  description: >-
                    Text denoting the level of the model outcome that supports
                    the family tree information derived using website home page
                    information.
                dnbCode:
                  type: integer
                  example: 13695
                  description: >-
                    A unique code assigned by Dun & Bradstreet indicating the
                    level of the model outcome that supports the family tree
                    information derived using website home page
                    information..<br/>Refer to Reference code table "354 [Range
                    Position]" for all possible values.
            financialReportEvidenceStrength:
              type: object
              description: >-
                Records the level of the model outcome that supports the family
                tree information derived using financial statements.
              properties:
                description:
                  type: string
                  example: Moderate
                  description: >-
                    Text denoting the level of the model outcome that supports
                    the family tree information derived using financial
                    statements.
                dnbCode:
                  type: integer
                  example: 13695
                  description: >-
                    A unique code assigned by Dun & Bradstreet indicating the
                    level of the model outcome that supports the family tree
                    information derived using financial statements..<br/>Refer
                    to Reference code table "354 [Range Position]" for all
                    possible values.
            wikipediaEvidenceStrength:
              type: object
              description: >-
                Records the level of the model outcome that supports the family
                tree information derived using company's Wikipedia web page.
              properties:
                description:
                  type: string
                  example: Moderate
                  description: >-
                    Text denoting the level of the model outcome that supports
                    the family tree information derived using company's
                    Wikipedia web page.
                dnbCode:
                  type: integer
                  example: 13695
                  description: >-
                    A unique code assigned by Dun & Bradstreet indicating the
                    level of the model outcome that supports the family tree
                    information derived using company's Wikipedia web
                    page.<br/>Refer to Reference code table "354 [Range
                    Position]" for all possible values.
            feedbackEvidenceStrength:
              type: object
              description: >-
                Records the level of the model outcome that supports the family
                tree information derived using D&B internal expert or customer
                feedback.
              properties:
                description:
                  type: string
                  example: Moderate
                  description: >-
                    Text denoting the level of the model outcome that supports
                    the family tree information derived using D&B internal
                    expert or customer feedback.
                dnbCode:
                  type: integer
                  example: 13695
                  description: >-
                    A unique code assigned by Dun & Bradstreet indicating the
                    level of the model outcome that supports the family tree
                    information derived using D&B internal expert or customer
                    feedback.<br/>Refer to Reference code table "354 [Range
                    Position]" for all possible values.
    CmpelkV2:
      type: object
      description: The details of the entity.
      properties:
        transactionDetail:
          type: object
          description: The information used to process this request.
          properties:
            transactionID:
              description: >-
                A value assigned by the Dun & Bradstreet application to uniquely
                identify this request.
              type: string
              example: rlh-hi9puyoijk-jop8u-kd-d-1
            transactionTimestamp:
              description: >-
                The date and time, in ISO 8601 UTC Z standard, when this
                response was created.
              type: string
              example: '2025-08-19T06:23:16Z'
            inLanguage:
              description: >-
                An IETF BCP 47 code value that defines the language in which
                this product was rendered.
              type: string
              example: en-US
            productID:
              description: The ID of the product used to create the response.
              type: string
              example: PRODID
            productVersion:
              description: The version of the product used to create the response.
              type: string
              example: 1
        inquiryDetail:
          type: object
          description: The criteria used to process this request.
          properties:
            duns:
              type: string
              example: 804735132
              description: The D-U-N-S number provided in the request.
            productID:
              type: string
              example: PRODID
              description: The ID of the product used to produce the response.
            productVersion:
              type: string
              example: v1
              description: The product version number provided in the request.
            tradeUp:
              type: string
              example: hq
              description: The value of the tradeUp parameter provided in the request.
            customerReference:
              type: string
              example: Some text to describe the request.
              description: >-
                A reference string provided by the customer to be linked to the
                product in order to support subsequent order reconciliation.
        organization:
          $ref: '#/components/schemas/CmpelkV2Organization'
    DataBlockOrganization:
      type: object
      properties:
        duns:
          type: string
          description: >-
            The D-U-N-S Number, a proprietary organizational identifier owned
            and managed by Dun & Bradstreet Inc, provides unique identification
            of a subject organization, in accordance with the Data Universal
            Numbering System (D-U-N-S).
          example: '804735132'
        countryISOAlpha2Code:
          type: string
          description: >-
            The two-letter country code, defined by the International
            Organization for Standardization (ISO) ISO 3166-1 scheme,
            identifying the country in which the entity is located.
          example: US
        primaryName:
          type: string
          description: >-
            Single name by which the organization is primarily known or
            identified.
          example: GORMAN MANUFACTURING COMPANY, INC.
        dunsControlStatus:
          type: object
          properties:
            operatingStatus:
              type: object
              description: >-
                The high level categorization of the entity's functional state
                or trading status.
              properties:
                description:
                  type: string
                  description: >-
                    The entity's functional state or trading status summarized
                    into either active or out of business.
                  example: Active
                dnbCode:
                  type: integer
                  description: |
                    A unique code assigned by Dun & Bradstreet
                    to identify the entity''s functional state or trading
                    status.`<br/>Possible values: <br/>9074 [Active]<br/>403
                    [Out of Business]<br/>` Refer to Reference code table
                    "166 [Operating Status]" for all possible values.
                  example: '9074'
                startDate:
                  type: string
                  description: >-
                    A date identifying the beginning of the time period in which
                    this Operating Status is or was applicable.
                  example: '2025-08-19T06:23:16Z'
            operatingSubStatus:
              type: object
              description: Records the specific status of the subject company.
              properties:
                description:
                  type: string
                  description: Textual description of the specific status of the company.
                  example: Out of business - Favourable
                dnbCode:
                  type: integer
                  description: >-
                    A unique code assigned by Dun & Bradstreet denoting the
                    specific status of the company.<br/>Refer to Reference code
                    table "166 [Operating Status]" for all possible values.
                  example: '9077'
                startDate:
                  type: string
                  description: >-
                    The date when this specific status of the company was
                    recorded.
                  example: '2025-08-19T06:23:16Z'
            detailedOperatingStatus:
              type: object
              description: >-
                Records the further low level status of the subject company, in
                terms of its operations.
              properties:
                description:
                  type: string
                  description: >-
                    Textual description of the detailed operating status of the
                    company.
                  example: Operationally Active
                dnbCode:
                  type: integer
                  description: >-
                    A unique code assigned by Dun & Bradstreet denoting the
                    detailed operating status of the company.<br/>Refer to
                    Reference code table "732 [Detailed Operating Status]" for
                    all possible values.
                  example: '29929'
            isMarketable:
              type: boolean
              description: >-
                Indicates whether the data on the entity satisfies Dun &
                Bradstreet's marketability rules for Sales & Marketing Solutions
                products. <br/><br/>- If true, the entity data satisfies the
                marketability rules.<br/>- If false, the entity data does not
                satisfy the marketability rules.
              example: 'true'
            isMailUndeliverable:
              type: boolean
              description: "Indicates whether it is possible to deliver mail to the address of this entity.\r<br/>\r<br/>- If true, it is not possible to deliver mail to at least one of the addresses listed for this DUNS (Primary, Mailing or Registered).<br/>- If false, it is possible to deliver mail to the address."
              example: 'false'
            isTelephoneDisconnected:
              type: boolean
              description: >-
                Indicates whether the telephone number can be connected to
                successfully.<br/><br/>- If true, connection to the telephone
                number is unsuccessful.<br/>- If false, connection to the
                telephone number is successful.
              example: 'false'
            isDelisted:
              type: boolean
              description: >-
                Indicates whether the entity has requested that they not be
                included in any Direct marketing lists (e.g., mailing,
                telephone).<br/><br/>- If true, the entity has objected to and
                MUST NOT receive direct marketing material.<br/>- If false, the
                entity has not objected to receiving direct marketing material.
              example: 'false'
            subjectHandlingDetails:
              type: array
              items:
                type: object
                description: >-
                  The details of the manner in which the entity is to receive
                  special care being contacted. In many cases, this was
                  specifically requested by the entity.
                properties:
                  description:
                    type: string
                    description: >-
                      The manner in which the entity is to receive special care
                      when being contacted (e.g., do not call or do not send
                      information requests). In many cases, this was
                      specifically requested by the entity.
                    example: Do not call.
                  dnbCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun & Bradstreet to identify the
                      manner in which the entity is to receive special care from
                      Dun & Bradstreet when it is being contacted.<br/>Refer to
                      Reference code table "199 [Subject Handling]" for all
                      possible values.
                    example: '7974'
            firstReportDate:
              type: string
              description: >-
                The date when the first complete review of all Business
                Information Report data was updated about the business.
              example: '2025-08-19T06:23:16Z'
            recordClass:
              type: object
              properties:
                description:
                  type: string
                  description: >-
                    Text denoting the classification of the company data
                    maintained in the D&B database.
                  example: Full DMI record
                dnbCode:
                  type: integer
                  description: >-
                    A unique identifier assigned by D&B to denote the
                    classification of the company data maintained in the D&B
                    database.<br/>Refer to Reference code table "240 [Record
                    Class]" for all possible values.
                  example: 10928
              description: >-
                Records the classification of the company data maintained in the
                D&B database.
            isSelfRequestedDUNS:
              type: boolean
              description: >-
                When turned ON (Set to TRUE), it indicates that the D-U-N-S
                Number for this subject was created at the request of the
                subject.<br/><br/>When turned OFF (Set to FALSE), it indicates
                that the D-U-N-S Number for this subject was not created at the
                request of the <br/>subject.; however as this is the assumed
                condition there is no requirement to create this tag to
                represent this fact.
              example: true
            selfRequestDate:
              type: string
              description: The date when the subject requested a D-U-N-S number for itself.
              example: '2025-08-19T06:23:16Z'
          description: >-
            The details of the organization's functional state and controls that
            impact its suitability for various usage purposes.
        registeredName:
          type: string
          description: >-
            The legally recognized name by which the organizationis registered
            with a local or national Registry.
          example: GORMAN MANUFACTURING COMPANY, INC.
        multilingualPrimaryName:
          type: array
          items:
            type: object
            description: >-
              The details of the name by which the entity is primarily known or
              identified presented in multiple languages.
            properties:
              language:
                type: object
                properties:
                  description:
                    type: string
                    description: The language in which this name was recorded.
                    example: Japanese
                  dnbCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun & Bradstreet to identify the
                      language in which this address was recorded.<br/>Refer to
                      Reference code table "3 [Language]" for all possible
                      values.
                    example: 39
                description: The details of the language in which this name was recorded.
              name:
                type: string
                description: The name by which the entity is primarily known or identified.
                example: GORMAN
              writingScript:
                type: object
                properties:
                  description:
                    type: string
                    description: >-
                      Text denoting the type of writing system for the language
                      that was used in recording this textual information. For
                      example, textual information recorded in the language
                      'Japanese' can be written in any of the following scripts:
                      kanji, katakana, hiragana or romaji.
                    example: Kana
                  dnbCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun&Bradstreet denoting the type
                      of writing system for the language that was used in
                      recording this textual information. For example, textual
                      information recorded in the language 'Japanese' can be
                      written in any of the following scripts: kanji, katakana,
                      hiragana or romaji.<br/>Refer to Reference code table "466
                      [Writing Script]" for all possible values.
                    example: 19347
                description: >-
                  Records the type of writing system for the language that was
                  used in recording this textual information. For example,
                  textual information recorded in the language 'Japanese' can be
                  written in any of the following scripts: kanji, katakana,
                  hiragana or romaji.
        multilingualRegisteredNames:
          type: array
          items:
            type: object
            description: >-
              Records the name of the company as recorded in the official
              registry, if available in multiple languages.
            properties:
              language:
                type: object
                properties:
                  description:
                    type: string
                    description: The language in which this name was recorded.
                    example: Japanese
                  dnbCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun & Bradstreet to identify the
                      language in which this address was recorded.<br/>Refer to
                      Reference code table "3 [Language]" for all possible
                      values.
                    example: 39
                description: The details of the language in which this name was recorded.
              name:
                type: string
                description: >-
                  Single name by which the organization is primarily known or
                  identified.
                example: GORMAN MANUFACTURING COMPANY, INC.
              writingScript:
                type: object
                properties:
                  description:
                    type: string
                    description: >-
                      Text denoting the type of writing system for the language
                      that was used in recording this textual information. For
                      example, textual information recorded in the language
                      'Japanese' can be written in any of the following scripts:
                      kanji, katakana, hiragana or romaji.
                    example: Kana
                  dnbCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun&Bradstreet denoting the type
                      of writing system for the language that was used in
                      recording this textual information. For example, textual
                      information recorded in the language 'Japanese' can be
                      written in any of the following scripts: kanji, katakana,
                      hiragana or romaji.<br/>Refer to Reference code table "466
                      [Writing Script]" for all possible values.
                    example: 19347
                description: >-
                  Records the type of writing system for the language that was
                  used in recording this textual information. For example,
                  textual information recorded in the language 'Japanese' can be
                  written in any of the following scripts: kanji, katakana,
                  hiragana or romaji.
        tradeStyleNames:
          type: array
          items:
            type: object
            description: >-
              The details of the names the organization trades under for
              commercial purposes<br/>A 'trading style' or 'trading as name' is
              a name a business chooses to use which is different from their
              registered company name. <br/>For example D&B is a trading style
              of Dun & Bradstreet Ltd. It is what the business chooses to call
              itself for marketing purposes.
            properties:
              name:
                type: string
                description: >-
                  The names the organization trades under for commercial
                  purposes<br/>A 'trading style' or 'trading as name' is a name
                  a business chooses to use which is different from their
                  registered company name.<br/>For example D&B is a trading
                  style of Dun & Bradstreet Ltd. It is what the business chooses
                  to call itself for marketing purposes.
                example: Alternate Company Name
              priority:
                type: integer
                description: >-
                  A numeric value used to identify the relative importance of a
                  Trade Style Name compared to other Trade Style Names.  The
                  lower the numeric value the earlier the data is displayed
                  (i.e. 1 indicates the most important name, 2 the second most
                  important etc...)
                example: 1
        multilingualTradestyleNames:
          type: array
          items:
            type: object
            description: >-
              The details of the names, in multiple languages, that the entity
              trades under for commercial purposes although its registered legal
              name used for contracts and other formal situations may be another
              name.
            properties:
              language:
                type: object
                properties:
                  description:
                    type: string
                    description: The name of the language in which this name was recorded.
                    example: Japanese
                  dnbCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun&Bradstreet to denote the
                      language in which this name was recorded.<br/>Refer to
                      Reference code table "3 [Language]" for all possible
                      values.
                    example: 3807
                description: The details of the language in which this name was recorded.
              name:
                type: string
                description: >-
                  The name that the entity trades under for commercial purposes
                  although its registered legal name used for contracts and
                  other formal situations may be another name.
                example: GORMAN
              priority:
                type: integer
                description: >-
                  The sequence in which the entity mostly uses this trade style
                  name.
                example: 1
        defaultCurrency:
          type: string
          description: >-
            The three-letter currency code, defined in the ISO 4217 scheme
            published by International Organization for Standardization (ISO)
            identifying the type of money that this entity uses by default.
          example: USD
        websiteAddress:
          type: array
          items:
            type: object
            description: >-
              The details of the internet URLs used for online information and
              communication with the Organization.
            properties:
              url:
                type: string
                description: >-
                  The Internet URL (Uniform Resource Locator) that uniquely
                  identifies the proprietary website of the Organization or the
                  website preferred by the Organization that gives more
                  information on the entity.
                example: http://www.gorman.com
              domainName:
                type: string
                description: >-
                  A unique name used to identify the website of the Organization
                  that serves as an address to access that website.
                example: gorman.com
        email:
          type: array
          items:
            type: object
            description: The details of the email address used to contact the entity.
            properties:
              address:
                type: string
                description: The email address for the entity.
                example: someone@company.com
        telephone:
          type: array
          items:
            type: object
            description: >-
              The details of the Telephone contact information used for voice
              communication with the organization.
            properties:
              telephoneNumber:
                type: string
                description: >-
                  The primary voice telephone number for the business, when
                  dialing domestically. The National Telephone Number is created
                  by combining the Domestic Area Code and the Local
                  Number.<br/><br/>A Domestic Area Code is a series of numbers
                  that must be prefixed before dialing a telephone number in
                  another local area. National telecommunication authorities use
                  various formats and dialing rules for area codes. Also known
                  as City Code.<br/><br/>A Local Number is a series of numbers
                  that represents a specific telephone line.
                example: '6505550000'
              isdCode:
                type: string
                description: >-
                  A series of numbers that must be prefixed before dialing a
                  telephone number in another Country, it is comprised of an
                  International Dialing Prefix followed by the Country Code.
                  These are also referred to as Country Calling Code or Country
                  Dial-In Code.
                example: '1'
        primaryAddress:
          type: object
          properties:
            language:
              type: object
              properties:
                description:
                  type: string
                  description: The name of the language in which this address was recorded.
                  example: English
                dnbCode:
                  type: integer
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    language in which this address was recorded.<br/>Refer to
                    Reference code table "3 [Language]" for all possible values.
                  example: 39
              description: The details of the language in which this address was recorded.
            addressCountry:
              type: object
              properties:
                name:
                  type: string
                  description: >-
                    The Country or Region where the organization's Primary
                    Address is located or conducts operations .
                  example: United States
                isoAlpha2Code:
                  type: string
                  description: >-
                    The 2 letter alpha country code assigned by the
                    International Organization for Standardization (ISO)
                    identifying the Country/Region where the organization's
                    Primary address is located or conducts operations .
                  example: US
              description: >-
                The details of the country or region where the address of the
                organization is located or conducts operations.
            continentalRegion:
              type: object
              properties:
                name:
                  type: string
                  description: >-
                    The name of the continent where the Primary Address of the
                    organization is located or conducts operations.<br/>Possible
                    values <br/>Africa<br/>Asia Pacific<br/>Europe<br/>North
                    America<br/>Middle East<br/>South America
                  example: North America
              description: >-
                The details of the Continent in which the Primary Address of the
                organisation is located or conducts operations.
            addressLocality:
              type: object
              properties:
                name:
                  type: string
                  description: >-
                    The name of the locality where the organization's Primary
                    Address is located or conducts operations. Locality defined
                    as a district population cluster. City, town, township,
                    village, borough etc.
                  example: SAN FRANCISCO
              description: >-
                The details of the locality where the organization's Primary
                Address is located or conducts operations. Locality defined as a
                district population cluster. City, town, township, village,
                borough etc.
            minorTownName:
              type: string
              description: >-
                The name of the  village, town or suburb where the
                organization's Primary Address is located or conducts
                operations.<br/>For example Booker in  Booker, High Wycombe.
              example: Booker
            addressRegion:
              type: object
              properties:
                name:
                  type: string
                  description: >-
                    The name of the geographical area where the organization's
                    Primary Address is located or conducts operations. For
                    Example New Jersey.
                  example: California
                abbreviatedName:
                  type: string
                  description: >-
                    The shortened name of the geographical area where the
                    organization's Primary Address is located or conducts
                    operations For example NJ for the US State New Jersey within
                    Country United States.
                  example: CA
                isoSubDivisionName:
                  type: string
                  description: >-
                    The official name of a principal subdivision (e.g province
                    or state) of countries coded in ISO 3166-1.
                  example: Yamanashi
                isoSubDivisionCode:
                  type: string
                  description: >-
                    The code assigned by ISO that represents the name of a
                    principal subdivision (e.g province or state) of countries
                    coded in ISO 3166-1.  This code is based on the two-letter
                    code element from ISO 3166-1 followed by a separator and up
                    to three alphanumeric characters.
                  example: JP-19
              description: >-
                Details of the type of geographical area where the
                organization's Primary Address is located or conducts
                operations.<br/>Different markets have their own way of
                subdividing the country into smaller parts.
                <br/>Examples:<br/>Departments (France)<br/>States
                (USA)<br/>Provinces (Netherlands)<br/>Counties
                (UK)<br/>Bundeslander (Germany)<br/>Provinces and Territories
                (Canada)
            addressCounty:
              type: object
              properties:
                name:
                  type: string
                  description: >-
                    The name of the geographical area of a Country or Region
                    where the organization's address is located or conducts
                    operations.<br/><br/>Countries subdivide their geography
                    into smaller sub divisions. County is an example of a
                    commonly used subdivision, oftenfound in the UK.
                  example: SAN MATEO
              description: >-
                The details of the geographical area of a Country or Region
                where the organization's Primary Address is located or conducts
                operations. Countries divide their geography into smaller sub
                divisions.<br/><br/>County is an example of a commonly used
                subdivision. Often found in UK.
            streetAddress:
              type: object
              properties:
                line1:
                  type: string
                  description: >-
                    The first line of the address where the entity is
                    located.<br/><br/>The first line of the Primary Address
                    where the organization is located or conducts operations.
                    For example The Point in the address<br/><br/>The
                    Point<br/>37 North Wharf Road<br/>London<br/>W2 1AF
                  example: 492 KOLLER ST
                line2:
                  type: string
                  description: >-
                    The second line of the Primary Address where the
                    organization is located or conducts operations<br/>For
                    example 37 North Wharf Road in the address<br/>The
                    Point<br/>37 North Wharf Road<br/>London<br/>W2 1AF
                  example: Suite 100
              description: >-
                The details of the street address where the organization's
                Primary Address is located.
            postalCode:
              type: string
              description: >-
                The postal code of the organization's Primary
                Address.<br/><br/>Also known locally in various English-speaking
                countries throughout the world as a postcode, post code,
                Eircode, PIN or ZIP Code) is a series of letters or digits or
                both, sometimes including spaces or punctuation, included in a
                postal address for the purpose of sorting mail. The code is used
                by the country&#39;s postal authority to identify the address
                where the organization is located or conducts operations .
              example: '941109999'
            postalCodePosition:
              type: object
              properties:
                description:
                  type: string
                  description: >-
                    The position of the Postal Code when presenting the Primary
                    Address where the organization is located or conducts
                    operations (e.g. before or after the address Town/City).
                  example: Post code presented before Town/City name
                dnbCode:
                  type: integer
                  description: >-
                    A unique code assigned by Dun and Bradstreet to identify the
                    position of the postal code when presenting the Primary
                    Address where the organization is located or conducts
                    operations.<br/>Refer to Reference code table "210 [Postal
                    Code Position]" for all possible values.
                  example: 1009
              description: >-
                The details of the position of the Postal Code when presenting
                the Primary Address where the organization is located or
                conducts operations.
            streetNumber:
              type: string
              description: >-
                The numerical part of the street address where the
                organization's Primary Address is located or conducts
                operations.<br/>This may be a single number, a number with an
                appendix, or a range of street numbers.<br/>For example 37 in
                the address<br/>The Point<br/>37 North Wharf
                Road<br/>London<br/>W2 1AF
              example: '492'
            streetName:
              type: string
              description: >-
                The name of the street where the organization's Primary address
                is located or conducts operations. For example North Wharf Road
                in the address<br/>The Point<br/>37 North
                Wharf<br/>London<br/>W2 1AF
              example: KOLLER ST
            postOfficeBox:
              type: object
              properties:
                postOfficeBoxNumber:
                  type: string
                  description: >-
                    A unique dentifier issued to the organizationby a private or
                    public postal office where the organizationrequests to have
                    mail delivered for its Primary Address.<br/><br/>This
                    includes only the identifying number (or text) and not the
                    textual description of the PO Box type. For example the
                    contents would be just the number 12 from PO Box 12 not PO
                    Box or just the number 57 from PMB 57 not PMB
                  example: '5309'
                typeDescription:
                  type: string
                  description: The type of the PO Box (e.g., Post Office Box, PMB).
                  example: Supplied by public Post Office authority
                typeDnBCode:
                  type: integer
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    type of PO Box where the organisation requests to have mail
                    delivered for its Primary Address.<br/>Refer to Reference
                    code table "208 [Postal Box Type]" for all possible values.
                  example: 120
              description: >-
                The details of the location  issued by a private or public
                Postal Office where the organization requests to have mail
                delivered for its Primary Address.
            standardAddressCodes:
              type: array
              items:
                type: object
                description: >-
                  Records identifiers that uniquely identifies an entire address
                  as opposed to an individual component of an address (such as a
                  street). For example, a NIKE Address Identifier, a Japan
                  Postal Barcode.
                properties:
                  addressCode:
                    type: string
                    description: >-
                      An identifier that uniquely identifies an entire address
                      as opposed to an individual component of an address (such
                      as a street). For example, a NIKE Address Identifier, a
                      Japan Postal Barcode.
                    example: ZV12467A
                  codeType:
                    type: object
                    properties:
                      description:
                        type: string
                        description: >-
                          Text that denotes the type of the standard address
                          code.
                        example: DK standard address code
                      dnbCode:
                        type: integer
                        description: >-
                          A unique code assigned by Dun&Bradstreet to identify
                          the type of the standard address code.
                        example: 487
                    description: Records the type of the standard address code.
            isRegisteredAddress:
              type: boolean
              description: >-
                Indicates if the address is the same as the organization's
                Registered Address<br/>if TRUE the primary/main address is the
                same as the organization's RegisteredAddress.<br/><br/>if FALSE
                The address is not the same as the organization's Registered
                Address.
              example: true
            latitude:
              type: number
              description: >-
                The geographic coordinate that specifies the north-south
                position of the Primary  Address where the organisation is
                located or conducts operations .
              example: 37.777709
            longitude:
              type: number
              description: >-
                The geographic coordinate that specifies the  east-west position
                of the Primary Address where the organisation is located or
                conducts operations .
              example: -122.404624
            geographicalPrecision:
              type: object
              properties:
                description:
                  type: string
                  description: >-
                    A description of  how close the latitude and longitude
                    coordinates are to the geographical position of the address
                    where the organization  is located or conducts operations.
                  example: Street Segment Centroid
                dnbCode:
                  type: integer
                  description: >-
                    A unique code assigned by Dun and Bradstreet to identify how
                    close the latitude and longitude coordinates are for the
                    address where the organization is located or conducts
                    operations.<br/>Refer to Reference code table "231
                    [Geographical Precision]" for all possible values.
                  example: 30256
              description: >-
                The details on how close the latitude and longitude coordinates
                are to the geographical position of the address where the
                organization  is located or conducts operations .
            statisticalArea:
              type: object
              properties:
                economicAreaOfInfluenceCode:
                  type: string
                  description: >-
                    A code assigned by the U.S Bureau of Economic Analysis to
                    identify the entity's regional market that surrounds a
                    metropolitan or micropolitan statistical area serving as a
                    regional center of economic activity.
                  example: '146'
              description: >-
                The details of the various statistical facts associated with
                this address.
            isManufacturingLocation:
              type: boolean
              description: >-
                Indicates if manufacturing activity is performed at this
                facility by the entity.<br/><br/>- If true, the entity performs
                manufacturing activity at this facility.<br/>- If false, the
                entity does not performs manufacturing activity at this
                facility.
              example: true
          description: >-
            The details of the Primary Address at which the organization is
            located or conducts operations.
        multilingualPrimaryAddress:
          type: array
          items:
            type: object
            description: >-
              The details of the primary or physical address at which the entity
              is located presented in multiple languages.
            properties:
              language:
                type: object
                properties:
                  description:
                    type: string
                    description: >-
                      The name of the language in which this address was
                      recorded.
                    example: Japanese
                  dnbCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun & Bradstreet to identify the
                      language in which this address was recorded.<br/>Refer to
                      Reference code table "3 [Language]" for all possible
                      values.
                    example: 3807
                description: >-
                  The details of the language in which this address was
                  recorded.
              addressCountry:
                type: object
                properties:
                  name:
                    type: string
                    description: >-
                      The name of the country/market in which this address is
                      located.
                    example: Japan
                  isoAlpha2Code:
                    type: string
                    description: >-
                      The two-letter country code, defined by the International
                      Organization for Standardization (ISO) ISO 3166-1 scheme
                      identifying the country/market in which this address is
                      located
                    example: JP
                description: >-
                  The details of the country/market in which this address is
                  located.
              continentalRegion:
                type: object
                properties:
                  name:
                    type: string
                    description: >-
                      The name of the continental region for this address.
                      Possible values: - Africa - Asia Pacific - Europe - Latin
                      America - Middle East - North America.
                    example: Asia Pacific
                description: >-
                  The details of the continental region in which this address is
                  located.
              addressLocality:
                type: object
                properties:
                  name:
                    type: string
                    description: >-
                      The name of the city, town, township, village, borough,
                      etc. in which this address is located.
                    example: SAN FRANCISCO
                description: >-
                  The details of the city, town, township, village, borough,
                  etc. in which this address is located.
              minorTownName:
                type: string
                description: >-
                  The name of the village, town or suburb when it is not a
                  Primary Town or City (e.g., the Booker in Booker, High
                  Wycombe).
                example: Booker
              addressRegion:
                type: object
                properties:
                  name:
                    type: string
                    description: >-
                      The name of the locally governed area that forms part of a
                      centrally governed nation to identify where this address
                      is located.
                    example: California
                description: >-
                  The details of the locally governed area that forms part of a
                  centrally governed nation to identify where this address is
                  located.
              addressCounty:
                type: object
                properties:
                  name:
                    type: string
                    description: The name of the county in which this address is located.
                    example: SAN MATEO
                description: The details of the county in which this address is located.
              postalCode:
                type: string
                description: >-
                  An identifier used by the local country's postal authority to
                  identify where this address is located.
                example: '941109999'
              streetNumber:
                type: string
                description: >-
                  The number part of the street address where the entity is
                  located. This may be a single number, a number with an
                  appendix, or a range of street numbers. For example, the "51 -
                  59C" in the address 51 - 59C Wall Street.
                example: '2'
              streetName:
                type: string
                description: >-
                  The name of the street where the entity is located. For
                  example, "Wall Street" in the address 51 - 59C Wall Street.
                example: Wall Street
              streetAddress:
                type: object
                properties:
                  line1:
                    type: string
                    description: >-
                      The first line of the address where the entity is located.
                      For example, "41 Central Chambers" in the address 41
                      Central Chambers Dame Court Dublin 2
                    example: The Point
                  line2:
                    type: string
                    description: >-
                      The second line of the address where the entity is
                      located. For example, "Dame Court" in the address 41
                      Central Chambers Dame Court Dublin 2
                    example: 37 North Wharf Road
                description: The details of the street address where the entity is located.
        registeredAddress:
          type: object
          properties:
            language:
              type: object
              properties:
                description:
                  type: string
                  description: >-
                    A description of the language in which the organization's
                    official address is presented .
                  example: English
                dnbCode:
                  type: integer
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    language in which this organization's official address  is
                    presented
                  example: 39
              description: >-
                The details of the language in which the organization's official
                address is presented.
            addressCountry:
              type: object
              properties:
                name:
                  type: string
                  description: >-
                    The name of the country/region where the organization's
                    official address is located
                  example: United States
                isoAlpha2Code:
                  type: string
                  description: >-
                    The 2 letter alpha country code assigned by the
                    International Organization for Standardization (ISO)
                    identifying the country/region where the organization's
                    official address is located.
                  example: US
              description: >-
                The details of the Country or Region where the organization's
                official address is located.
            addressLocality:
              type: object
              properties:
                name:
                  type: string
                  description: >-
                    The name of the locality where the organization's official
                    address is located. <br/>Locality defined as a district
                    population cluster. City, Town, Township, Village, Borough
                    etc.
                  example: SAN FRANCISCO
              description: >-
                The details of the locality where the organization's official
                address is located.
            minorTownName:
              type: string
              description: >-
                The name of the village, town or suburb where the organization's
                official address is located .<br/>E.g. Booker in Booker High
                Wycombe
              example: Booker
            addressRegion:
              type: object
              properties:
                name:
                  type: string
                  description: >-
                    The name of the geographical area where the organization's
                    official address is located . <br/>Example:<br/>New Jersey
                  example: California
                abbreviatedName:
                  type: string
                  description: >-
                    The shortened name of the geographical area where the
                    organization's official address is located.<br/>For example
                    NJ for the US State New Jersey within Country United States.
                  example: CA
              description: >-
                Details of the type of geographical area where the
                organization's official address is located.<br/><br/>Different
                markets have their own way of subdividing the country into
                smaller parts. <br/>Examples:<br/>Departments
                (France)<br/>States (USA)<br/>Provinces
                (Netherlands)<br/>Bundeslnder (Germany)<br/>Provinces and
                Territories (Canada)
            addressCounty:
              type: object
              properties:
                name:
                  type: string
                  description: >-
                    The name of the geographical area of a country or region
                    where the organization's official address is
                    located.<br/><br/>Countries subdivide their geography into
                    smaller areas; the UK county is a typical example.
                  example: SAN MATEO
              description: >-
                The details of the geographical  area of a country or region
                where the organization's official address is
                located.<br/>Countries subdivide their  geography into smaller
                areas. County is an example of commonly used area often found in
                UK
            postalCode:
              type: string
              description: >-
                The postal code of the organization's Registered Address. Also
                known locally in various English-speaking countries throughout
                the world as a postcode, post code, Eircode, PIN or ZIP Code.
                Itis a series of letters or digits or both, sometimes including
                spaces or punctuation, included in a postal address for the
                purpose of sorting mail.
              example: '941109999'
            postalCodePosition:
              type: object
              properties:
                description:
                  type: string
                  description: >-
                    The position of the Postal Code when presenting the
                    organization's official address (e.g. before or after the
                    address Town/City)
                  example: Post code presented before Town/City name
                dnbCode:
                  type: integer
                  description: >-
                    A  unique code assigned by Dun and Bradstreet to identify
                    the position of the postal code when presenting the
                    organization's official address.
                  example: 1009
              description: >-
                The details of the position of the Postal Code when presenting
                the address where the organization's official correspondence is
                delivered .
            streetNumber:
              type: string
              description: >-
                The numerical part of the street address where the
                organization's official address is located. This may be a single
                number, a number with an appendix, or a range of street
                numbers.<br/><br/><br/>For example, 51 - 59C for the address 51
                - 59C Wall Street.
              example: 51 - 59C
            streetName:
              type: string
              description: >-
                The name of the street where the organization's official address
                is located. <br/>For example; Wall Street for the address 51 -
                59C Wall Street.
              example: Wall Street
            streetAddress:
              type: object
              properties:
                line1:
                  type: string
                  description: >-
                    The first line of the organization's official address. For
                    example The Point In the address<br/>The Point<br/>37 North
                    Wharf Road<br/>London<br/>W2 1AF
                  example: The Point
                line2:
                  type: string
                  description: >-
                    The second line of the organization's official address. For
                    example 37 North Wharf Road In the address<br/>The
                    Point<br/>37 North Wharf Road<br/>London
                  example: 37 North Wharf Road
                line3:
                  type: string
                  description: >-
                    The third line of the organization's official address. For
                    example  London in the address<br/>The Point<br/>37 North
                    Wharf Road<br/>London<br/>W2 1AF
                  example: Address line 3
                line4:
                  type: string
                  description: >-
                    The  fourth line of the organization's official address. For
                    example W2 1AF in the address<br/>The Point<br/>37 North
                    Wharf Road<br/>London<br/>W2 1AF
                  example: Address line 4
              description: >-
                The details of the street address where the organization's
                official address is located.
            postOfficeBox:
              type: object
              properties:
                postOfficeBoxNumber:
                  type: string
                  description: >-
                    A unique identifier issued to the organisation by a private
                    or public postal office where all official correspondence is
                    delivered.<br/><br/>This includes only the identifying
                    number (or text) and not the textual description of the PO
                    Box type. For example the contents would be just the number
                    12 from PO Box 12 not PO Box or just the number 57 from PMB
                    57 not PMB
                  example: '5309'
                typeDescription:
                  type: string
                  description: >-
                    A description of the type of post office box e.g.Post Office
                    Box or Private Mail Box PMB<br/>A post office box (commonly
                    abbreviated as P.O. box, or also known as a postal box) is a
                    uniquely addressable lockable box located on the premises of
                    a post office station where the organisation requests to
                    have official correspondence delivered. <br/>A Private Mail
                    box  (commonly abbreviated as PMB provides a real street
                    address and can accept delivery of packages as well as mail.
                  example: Supplied by public Post Office authority
                typeDnBCode:
                  type: integer
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    type of PO Box where the organisation requests to have
                    official correspondence delivered.
                  example: 120
              description: >-
                A description of the language in which the organization's
                official address is presented.
          description: >-
            The details of the organization's official address as recorded with
            an external authority to which all official correspondence must be
            sent<br/>Example<br/>Companies House for the UK.
        mailingAddress:
          type: object
          properties:
            language:
              type: object
              properties:
                description:
                  type: string
                  description: The name of the language in which this address was recorded.
                  example: English
                dnbCode:
                  type: integer
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    language in which this address was recorded.<br/>Refer to
                    Reference code table "3 [Language]" for all possible values.
                  example: 39
              description: The details of the language in which this address was recorded.
            addressCountry:
              type: object
              properties:
                name:
                  type: string
                  description: >-
                    The Country or Region where the organization's Primary
                    Address is located or conducts operations .
                  example: United States
                isoAlpha2Code:
                  type: string
                  description: >-
                    The 2 letter alpha country code assigned by the
                    International Organization for Standardization (ISO)
                    identifying the Country/Region where the organization's
                    Primary address is located or conducts operations .
                  example: US
              description: >-
                The details of the country or region where the address of the
                organization is located or conducts operations.
            continentalRegion:
              type: object
              properties:
                name:
                  type: string
                  description: >-
                    The name of the continent where the Primary Address of the
                    organization is located or conducts operations.<br/>Possible
                    values <br/>Africa<br/>Asia Pacific<br/>Europe<br/>North
                    America<br/>Middle East<br/>South America
                  example: North America
              description: >-
                The details of the Continent in which the Primary Address of the
                organisation is located or conducts operations.
            addressLocality:
              type: object
              properties:
                name:
                  type: string
                  description: >-
                    The name of the locality where the organization's Primary
                    Address is located or conducts operations. Locality defined
                    as a district population cluster. City, town, township,
                    village, borough etc.
                  example: SAN FRANCISCO
              description: >-
                The details of the locality where the organization's Primary
                Address is located or conducts operations. Locality defined as a
                district population cluster. City, town, township, village,
                borough etc.
            minorTownName:
              type: string
              description: >-
                The name of the  village, town or suburb where the
                organization's Primary Address is located or conducts
                operations.<br/>For example Booker in  Booker, High Wycombe.
              example: Booker
            addressRegion:
              type: object
              properties:
                name:
                  type: string
                  description: >-
                    The name of the geographical area where the organization's
                    Primary Address is located or conducts operations. For
                    Example New Jersey.
                  example: California
                abbreviatedName:
                  type: string
                  description: >-
                    The shortened name of the geographical area where the
                    organization's Primary Address is located or conducts
                    operations For example NJ for the US State New Jersey within
                    Country United States.
                  example: CA
              description: >-
                Details of the type of geographical area where the
                organization's Primary Address is located or conducts
                operations.<br/>Different markets have their own way of
                subdividing the country into smaller parts.
                <br/>Examples:<br/>Departments (France)<br/>States
                (USA)<br/>Provinces (Netherlands)<br/>Counties
                (UK)<br/>Bundeslander (Germany)<br/>Provinces and Territories
                (Canada)
            addressCounty:
              type: object
              properties:
                name:
                  type: string
                  description: >-
                    The name of the geographical area of a Country or Region
                    where the organization's address is located or conducts
                    operations.<br/><br/>Countries subdivide their geography
                    into smaller sub divisions. County is an example of a
                    commonly used subdivision, oftenfound in the UK.
                  example: SAN MATEO
              description: >-
                The details of the geographical area of a Country or Region
                where the organization's Primary Address is located or conducts
                operations. Countries divide their geography into smaller sub
                divisions.<br/><br/>County is an example of a commonly used
                subdivision. Often found in UK.
            postalCode:
              type: string
              description: >-
                The postal code of the organization's Primary
                Address.<br/><br/>Also known locally in various English-speaking
                countries throughout the world as a postcode, post code,
                Eircode, PIN or ZIP Code) is a series of letters or digits or
                both, sometimes including spaces or punctuation, included in a
                postal address for the purpose of sorting mail. The code is used
                by the country&#39;s postal authority to identify the address
                where the organization is located or conducts operations .
              example: '941109999'
            postalCodePosition:
              type: object
              properties:
                description:
                  type: string
                  description: >-
                    The position of the Postal Code when presenting the Primary
                    Address where the organization is located or conducts
                    operations (e.g. before or after the address Town/City).
                  example: Post code presented before Town/City name
                dnbCode:
                  type: integer
                  description: >-
                    A unique code assigned by Dun and Bradstreet to identify the
                    position of the postal code when presenting the Primary
                    Address where the organization is located or conducts
                    operations.<br/>Refer to Reference code table "210 [Postal
                    Code Position]" for all possible values.
                  example: 1009
              description: >-
                The details of the position of the Postal Code when presenting
                the Primary Address where the organization is located or
                conducts operations.
            postalRoute:
              type: string
              description: >-
                A code assigned by the local postal authority that sorts mail
                pieces to the individual carrier routes within a postal code.
              example: route 3B
            streetNumber:
              type: string
              description: >-
                The numerical part of the street address where the
                organization's Primary Address is located or conducts
                operations.<br/>This may be a single number, a number with an
                appendix, or a range of street numbers.<br/>For example 37 in
                the address<br/>The Point<br/>37 North Wharf
                Road<br/>London<br/>W2 1AF
              example: '492'
            streetName:
              type: string
              description: >-
                The name of the street where the organization's Primary address
                is located or conducts operations. For example North Wharf Road
                in the address<br/>The Point<br/>37 North
                Wharf<br/>London<br/>W2 1AF
              example: KOLLER ST
            streetAddress:
              type: object
              properties:
                line1:
                  type: string
                  description: >-
                    The first line of the address where the entity is
                    located.<br/><br/>The first line of the Primary Address
                    where the organization is located or conducts operations.
                    For example The Point in the address<br/><br/>The
                    Point<br/>37 North Wharf Road<br/>London<br/>W2 1AF
                  example: 492 KOLLER ST
                line2:
                  type: string
                  description: >-
                    The second line of the Primary Address where the
                    organization is located or conducts operations<br/>For
                    example 37 North Wharf Road in the address<br/>The
                    Point<br/>37 North Wharf Road<br/>London<br/>W2 1AF
                  example: Suite 100
              description: >-
                The details of the street address where the organization's
                Primary Address is located.
            postOfficeBox:
              type: object
              properties:
                postOfficeBoxNumber:
                  type: string
                  description: >-
                    A unique dentifier issued to the organizationby a private or
                    public postal office where the organizationrequests to have
                    mail delivered for its Primary Address.<br/><br/>This
                    includes only the identifying number (or text) and not the
                    textual description of the PO Box type. For example the
                    contents would be just the number 12 from PO Box 12 not PO
                    Box or just the number 57 from PMB 57 not PMB
                  example: '5309'
                typeDescription:
                  type: string
                  description: The type of the PO Box (e.g., Post Office Box, PMB).
                  example: Supplied by public Post Office authority
                typeDnBCode:
                  type: integer
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    type of PO Box where the organisation requests to have mail
                    delivered for its Primary Address.<br/>Refer to Reference
                    code table "208 [Postal Box Type]" for all possible values.
                  example: 120
              description: >-
                The details of the location  issued by a private or public
                Postal Office where the organization requests to have mail
                delivered for its Primary Address.
          description: The details of the address used by the entity for mailing purposes.
        stockExchanges:
          type: array
          items:
            type: object
            description: >-
              The details of the Stock Exchanges on which the entity's shares
              are traded.
            properties:
              tickerName:
                type: string
                description: >-
                  Text by which the entity is identified on this Stock Exchange
                  for share trading purposes.
                example: NYSE:DNB
              exchangeName:
                type: object
                properties:
                  description:
                    type: string
                    description: The name the Stock Exchange.
                    example: NYSE
                description: >-
                  The details of the name of the Stock Exchange on which the
                  entity's shares are traded.
              isPrimary:
                type: boolean
                description: >-
                  Indicates if this is the most important stock exchange among
                  all the stock exchange where the entity's shares are traded.
                  <br/><br/>- If true, indicates that this is the most important
                  Stock Exchange.<br/>- If false, indicates that this is not the
                  most important Stock Exchange.
                example: true
        standardizedStockExchanges:
          type: array
          items:
            type: object
            description: >-
              Records all the stock exchanges that the subject trades in
              represented using predefined finite values.
            properties:
              exchangeName:
                type: object
                properties:
                  description:
                    type: string
                    description: >-
                      Text that denotes the standardized name of the stock
                      exchange.
                    example: Shanghai Stock Exchange
                  dnbCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun&Bradstreet that denotes the
                      standardized name of the stock exchange.<br/>Refer to
                      Reference code table "178 [Stock Exchange]" for all
                      possible values.
                    example: 20666
                description: Records the standardized name of the stock exchange.
              sectionNames:
                type: array
                items:
                  type: object
                  description: >-
                    Records the different sections within a stock exchange in
                    different languages.
                  properties:
                    name:
                      type: string
                      description: >-
                        Records the name of the section within the stock
                        exchange, e.g., First section of the Tokyo Stock
                        Exchange, Second section of the Tokyo Stock Exchange,
                        JASDAQ, MOTHERS.
                      example: JASDAQ
                    language:
                      type: object
                      properties:
                        description:
                          type: string
                          description: >-
                            Text that records the language in which this
                            information was recorded.<br/>Refer to Reference
                            code table "3 [Language]" for all possible values.
                          example: Japanese
                        dnbCode:
                          type: integer
                          description: >-
                            A unique code assigned by Dun&Bradstreet that
                            records the language in which this information was
                            recorded.
                          example: 3807
                      description: >-
                        Records the language in which this information was
                        recorded.
        isForbesLargestPrivateCompaniesListed:
          type: boolean
          description: >-
            Indicates whether the entity has ever been listed as one of the
            largest private companies in the United States on the annual list
            compiled and published by Forbes magazine<br/>.<br/><br/><br/>- If
            true, the entity has been listed.<br/>- If false, the entity has not
            been listed.
          example: false
        isFortune1000Listed:
          type: boolean
          description: >-
            Indicates whether the entity has ever been listed as one of the 1000
            largest American companies, ranked on revenues alone by the American
            business magazine Fortune.<br/><br/><br/>- If true, the entity has
            been listed.<br/>- If false, the entity has not been listed.
          example: false
        registrationNumbers:
          type: array
          items:
            type: object
            description: >-
              The details of the organization's identifiers issued by a
              recognized external authority to uniquely identify subjects. The
              issuing authority may be a Registration Authority, Government
              Department or Commercial Enterprise (e.g., Chamber of Commerce
              numbers, VAT numbers).
            properties:
              registrationNumber:
                type: string
                description: >-
                  The number or alphanumeric value assigned by a recognized
                  external authority that either uniquely identifies or helps to
                  identify the organization.
                example: 12-3456789
              typeDescription:
                type: string
                description: >-
                  The official name of the organization identifier assigned by a
                  recognized external authority (e.g.. Australian Company
                  Number, Federal Taxpayer Identification Number, Value Added
                  Tax Number).
                example: Federal Taxpayer Identification Number (US)
              typeDnBCode:
                type: integer
                description: >-
                  A unique code assigned by Dun & Bradstreet to identify the
                  type of organization identifier. For example, 2541 stands for
                  company number issued by the UK Companies House.<br/>Refer to
                  Reference code table "7 [Registration Number Type]" for all
                  possible values.
                example: 6863
              isPreferredRegistrationNumber:
                type: boolean
                description: >-
                  Indicates whether this is the preferred organization
                  identifier. When turned ON (set to TRUE), this organization
                  identifier is the one Dun & Bradstreet recommends for this
                  organization. When turned OFF (set to FALSE), this is not the
                  preferred organization identifier.
                example: true
        primaryIndustryCode:
          type: object
          properties:
            usSicV4:
              type: string
              description: >-
                The 4-digit code in the U.S. SIC (Standard Industrial
                Classification) 1987 system assigned to an organization
                categorizing the primary business activities performed at its
                location. For example, 1611 represents the highway and street
                construction industry.
              example: '5461'
            usSicV4Description:
              type: string
              description: >-
                The description of the business activities represented by the
                Primary US SIC Code. For example, 'highway and street
                construction' is the description of industry code 1611.
              example: Credit reporting services
          description: >-
            The details of the business activity in which the organisation is
            primarily engaged using standardised coding schemes such as European
            NACE and U.S Standard Industry Classification (SIC).
        industryCodes:
          type: array
          items:
            type: object
            description: >-
              The details of the business activities in which the organization
              is actively engaged using a standardized coding schemes such as
              European NACE and U.S. Standard Industry Classification (SIC).
            properties:
              code:
                type: string
                description: >-
                  An alphanumeric value assigned to an organization categorizing
                  the business activities performed at its location. Business
                  activities are coded using standardized coding schemes. For
                  example, 1611 represents the highway and street construction
                  industry in the U.S. SIC (Standard Industrial Classification)
                  1987 system.
                example: '323111'
              description:
                type: string
                description: >-
                  The description of the business activities represented by the
                  Industry Code as defined in the coding scheme identified by
                  the Industry Code Type Description. For example, 'highway and
                  street construction' is the description of industry code 1611
                  in the U.S. SIC 1987 system.
                example: 'Commercial Printing '
              typeDescription:
                type: string
                description: >-
                  The details of the standardized coding scheme used to classify
                  the business activities of an organization. This can be an
                  externally recognized coding scheme as for instance North
                  American Industry Classification System (NAICS) or a
                  proprietary scheme like D&B SIC-8.
                example: North American Industry Classification System 2012
              typeDnBCode:
                type: integer
                description: >-
                  A unique code assigned by Dun & Bradstreet to identify the
                  industry coding scheme.<br/>Industry schemes supported
                  currently:<br/>D&B Industry Code (3599)<br/>NAICS Code
                  (30832)<br/>US 1987 SIC Code (399)<br/>NACE Revision 2
                  (29104)<br/>D&B Hoovers Industry Code (25838)<br/>Major
                  Industry Category (24657)<br/>Local Activity Codes (specific
                  to markets)<br/>Refer to Reference code table "30 [Industry
                  Code Type]" for all possible values.
                example: 24664
              priority:
                type: integer
                description: >-
                  A number identifying the order in which this industry code
                  should be presented relative to other industry codes of the
                  same type. Priority is based on the importance of the business
                  activity to the organization.
                example: 1
        unspscCodes:
          type: array
          items:
            type: object
            description: >-
              The details of several products and services represented in the
              United Nations Standard Products and Services Code (UNSPSC)
              scheme; this scheme was jointly developed by the United Nations
              Development Programme (UNDP) and Dun & Bradstreet Corporation in
              1998.<br/><br/>The United Nations Standard Products and Services
              Code (UNSPSC) provides an open, global multi-sector standard for
              efficient, accurate classification of products and services. It is
              a 4-level hierarchy coded as an 8-digit number.<br/><br/>The
              UNSPSC for a given item is composed of four 2-digit identifiers,
              which together categorize the item into a five-level hierarchy.
              The five levels of the classification are Segment, Family, Class,
              and Commodity. Business Function is optional.
            properties:
              code:
                type: string
                description: >-
                  The UNSPSC code that identifies a product or service offered
                  by the entity.
                example: '31111617'
              description:
                type: string
                description: The description associated with the UNSPSC code.
                example: Zinc impact extrusions
              priority:
                type: integer
                description: >-
                  Identifies the order in which this UNSPSC code should be
                  presented relative to other UNSPSC codes.
                example: 1
        isNonClassifiedEstablishment:
          type: boolean
          description: >-
            When set to "true", it denotes that the Dun & Bradstreet is unable
            to classify the subject into a specific industry.<br/>When set to
            "false", it denotes that the Dun & Bradstreet is able to classify
            the subject into a specific industry.
          example: true
        activities:
          type: array
          items:
            type: object
            description: >-
              The details of the descriptions of operations in different
              languages.
            properties:
              description:
                type: string
                description: Description of operations continued by a business.
                example: Entity operation description
              language:
                type: object
                properties:
                  description:
                    type: string
                    description: >-
                      The name of the language in which this business activity
                      was recorded.
                    example: English
                  dnbCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun & Bradstreet to identify the
                      language in which this business activity was
                      recorded.<br/>Refer to Reference code table "3 [Language]"
                      for all possible values.
                    example: 39
                description: >-
                  The details of the language in which this business activity
                  was recorded.
        startDate:
          type: string
          description: >-
            The date the entity chooses to claim as its established date.<br/>
            <br/>Note: This date may be different from the Operations Start Date
            and adheres to ISO 8601 standard.The date an organization originally
            commenced operations. If the business was formed to acquire or
            continue the operations of a pre-existing business, then the Start
            Date may reflect that original start date. The Start Date is not
            necessarily the date that the subject was registered/incorporated.
            If a company registered on 25th August 1930 continues business
            activities established on 18th June 1815 then the start date is the
            1815 date.
          example: '2025-08-19T06:23:16Z'
        incorporatedDate:
          type: string
          description: >-
            The date on which a legal form was first registered with the
            appropriate Government body for this organization.
          example: '1987'
        businessEntityType:
          type: object
          properties:
            description:
              type: string
              description: >-
                The text description of the unique code assigned by Dun &
                Bradstreet for the Legal Form Class.
              example: Corporation
            dnbCode:
              type: integer
              description: >-
                A unique code assigned by D&B to identify the Legal Form Class.
                <br/>E.g. 451 is the Code for Corporation.<br/>Refer to
                Reference code table "197 [Business Entity Type]" for all
                possible values.
              example: 451
          description: >-
            A broad category of an organization structure into which all Legal
            Forms are grouped. These categories are created by Dun & Bradstreet
            for client use based on Legal Form association with one and only one
            Legal Form Class. Legal Form Class is limited to Corporation,
            Partnership, Proprietorship, National Government, Local Government,
            Joint Venture, Non Profit Organization, Co-operative / Mutual
            Organization and Foreign Company as well as a category for Legal
            Forms that do not fit into an existing Legal Form Class.
        legalForm:
          type: object
          properties:
            description:
              type: string
              description: >-
                The text description of the unique code assigned by Dun &
                Bradstreet for the Global Legal Form.
              example: Corporation
            dnbCode:
              type: integer
              description: >-
                A unique code assigned by D&B for the Global Legal Form.
                <br/>For example 31145 is the Code for Government
                Agency<br/>Refer to Reference code table "750 [Global Legal
                Form]" for all possible values.
              example: 31217
            startDate:
              type: string
              description: >-
                The date on which the legal form was registered with the
                appropriate Government body or recognised by Dun and Bradstreet.
              example: '2025-08-19T06:23:16Z'
            registrationLocation:
              type: object
              properties:
                addressRegion:
                  type: string
                  description: >-
                    The name of the geographical area where the organization's
                    Primary Address is located or conducts operations. For
                    Example New Jersey.
                  example: California
              description: The details of the address where the Legal Form is registered.
          description: >-
            The details of the structure of an organization, irrespective of the
            laws of the country or region in which it was formed. Commonly, this
            structure will be determined when registered with government
            authorities, however some entities are not required to register.
            This structure affects how much is paid in taxes, the ability to
            raise money, the requirements to register and the liability of
            proprietors. These structure types are universally standardized by
            Dun & Bradstreet for client use based on Legal Form association with
            one and only one Global Legal Form. Examples include Joint Stock
            Company and Limited Liability Company.
        controlOwnershipDate:
          type: string
          description: The date when the current owners took over the entity.
          example: '1985'
        controlOwnershipType:
          type: object
          properties:
            description:
              type: string
              description: >-
                The name for the type of controlling ownership (e.g., publicly
                owned, privately owned, state owned). <br/><br/>Note: For some
                countries, controlling ownership can be derived from the legal
                form.
              example: Privately owned
            dnbCode:
              type: integer
              description: >-
                A unique code assigned by Dun & Bradstreet to identify the type
                of controlling ownership.<br/>Refer to Reference code table "175
                [Control Type]" for all possible values.
              example: 9058
          description: The details of the type of controlling ownership.
        charterType:
          type: object
          properties:
            description:
              type: string
              description: >-
                The nature of the document identifying the purpose of this
                entity and its rules of conduct (e.g., municipality charter,
                local public school charter, medical partnership charter, mutual
                surety company charter).
              example: Joint tenancy
            dnbCode:
              type: integer
              description: >-
                A unique code assigned by Dun & Bradstreet to identify the
                entity's charter type.<br/>Refer to Reference code table "162
                [Charter Type]" for all possible values.
              example: 2110
          description: The details of the entity's charter type.
        isAgent:
          type: boolean
          description: >-
            Indicates if the entity acts as an agent promoting the goods or
            services of another entity (e.g., Sales Agent, Purchasing Agent).
            <br/><br/>- If true, the entity acts as an agent.<br/>- If false,
            the entity does not act as an agent.
          example: false
        isImporter:
          type: boolean
          description: >-
            Indicates if the entity is an importer.<br/><br/>- If true, the
            entity imports a quantity of goods from other countries.<br/>- If
            false, the entity does not import a quantity of goods from other
            countries.
          example: false
        isExporter:
          type: boolean
          description: >-
            Indicates if the entity is an exporter.<br/><br/>- If true, the
            entity exports a quantity of goods to other countries.<br/>- If
            false, the entity does not export a quantity of goods to other
            countries.
          example: false
        registeredDetails:
          type: object
          properties:
            legalForm:
              type: object
              properties:
                description:
                  type: string
                  description: >-
                    The text description of the unique code assigned by D&B for
                    the Legal Form. <br/>For example Public Limited Liability
                    Company .
                  example: Corporation (US)
                dnbCode:
                  type: integer
                  description: >-
                    The  unique code assigned by D&B for the  Legal
                    Form.<br/>E.g. 1868 is the Code for Italian Public Limited
                    Liability Company<br/>Refer to Reference code table "4
                    [Legal Form]" for all possible values.
                  example: 7101
                registrationStatus:
                  type: object
                  properties:
                    description:
                      type: string
                      description: >-
                        Status description of the registration with respect to
                        this legal form.
                      example: Pending
                    dnbCode:
                      type: integer
                      description: >-
                        A unique code assigned by Dun & Bradstreet to identify
                        the status of the registration with respect to this
                        legal form.<br/>Refer to Reference code table "396
                        [Registration Status]" for all possible values.
                      example: 15626
                  description: >-
                    The details of the status of the registration with respect
                    to this legal form.
              description: >-
                The details of the structure of an organization according to the
                laws of the country or region in which it was formed. Commonly,
                this structure will be determined when registered with
                government authorities, however some organisations are not
                required to register. This structure affects how much is paid in
                taxes, the ability to raise money, the requirements to register
                and the liability of proprietors. These structure types are
                unique by country, as similar legal form types can have
                different interpretations by country or region. Also known as
                Legal Structure or Business Structure. Examples include Limited
                Liability Company (US), Private Unlimited Company Without Share
                Capital (GB) or Limited Responsibility Cooperative (BO).
          description: >-
            The details of the constitutional status of the entity as defined
            under the laws of a country (e.g., Limited Company, Partnership,
            co-operative Society) and the Stock Equity or share structure
            employed by the entity according to the legal form and rules of
            incorporation. The owners of the stock or shares are the owners of
            the business.
        numberOfEmployees:
          type: array
          items:
            type: object
            description: >-
              The details of the number of individuals engaged by a business for
              various purposes, e.g., to perform its business operations.
            properties:
              value:
                type: integer
                description: >-
                  The number of individuals engaged by a business to perform its
                  various purposes, e.g., business operations, and can include
                  directors, principals and full or part time employees.
                example: 1234
              employeeFiguresDate:
                type: string
                description: >-
                  The date for which the employee figure was reported by the
                  entity.
                example: '2025-08-19T06:23:16Z'
              informationScopeDescription:
                type: string
                description: >-
                  The organizational scope of the Employee Quantity Values.
                  Employees here means it represents a single organization
                  inclusive of any branches. Employees Total means it represents
                  an organization inclusive of any branches and any
                  subsidiaries.
                example: Consolidated
              informationScopeDnBCode:
                type: integer
                description: >-
                  A unique code assigned by Dun & Bradstreet to identify the
                  organizational scope of the Employee Quantity value.<br/>Refer
                  to Reference code table "192 [Information Scope]" for all
                  possible values.
                example: 9067
              reliabilityDescription:
                type: string
                description: >-
                  The integrity of the Employee Quantity Value (e.g., actual,
                  estimated, or modeled).
                example: Actual
              reliabilityDnBCode:
                type: integer
                description: >-
                  A unique code assigned by Dun & Bradstreet to identify the
                  integrity of the Employee Quantity Values.<br/>Refer to
                  Reference code table "171 [Reliability]" for all possible
                  values.
                example: 9092
              employeeCategories:
                type: array
                items:
                  type: object
                  description: >-
                    The details of the type of individuals included in the
                    calculation of the Employee Quantity Value.
                  properties:
                    employmentBasisDescription:
                      type: string
                      description: >-
                        The type of individuals that have been included in the
                        calculation of the Employee Quantity Value on the basis
                        of their employment contract (e.g., Directors,
                        Principals, Part Time Workers).
                      example: Principals
                    employmentBasisDnBCode:
                      type: integer
                      description: >-
                        A unique code assigned by Dun & Bradstreet to identify
                        the employment basis description.<br/>Refer to Reference
                        code table "77 [Employment Basis]" for all possible
                        values.
                      example: 9064
              trend:
                type: array
                items:
                  type: object
                  description: The details of the employee growth history.
                  properties:
                    timePeriod:
                      type: object
                      properties:
                        description:
                          type: string
                          description: The timeframe for which this data is recorded.
                          example: 1 - 5 years
                        dnbCode:
                          type: integer
                          description: >-
                            A unique code assigned by Dun & Bradstreet to
                            identify the timeframe for which this data is
                            recorded.<br/>Refer to Reference code table "168
                            [Time Period]" for all possible values.
                          example: 13721
                      description: >-
                        The details of timeframe for which this data is
                        recorded.
                    growthRate:
                      type: number
                      description: >-
                        The percentage of change in number of employees from
                        base year compared to the trend year.
                      example: -7
                    value:
                      type: number
                      description: >-
                        The total number of people engaged by an entity to
                        perform its business operations. Several different
                        Employee Figures for the entity may be recorded (e.g.,
                        consolidated, individual entity, headquarters only).
                      example: 23.01
                    reliabilityDescription:
                      type: string
                      description: The integrity of the financial figures.
                      example: Audited
                    reliabilityDnBCode:
                      type: integer
                      description: >-
                        A unique code assigned by Dun & Bradstreet to identify
                        the integrity of the financial figures.<br/>Refer to
                        Reference code table "171 [Reliability]" for all
                        possible values.
                      example: 9092
        financials:
          type: array
          items:
            type: object
            description: >-
              The details of the standardized summary view of the financial
              results (actual or estimated) for the organization.
            properties:
              financialStatementToDate:
                type: string
                description: >-
                  The date associated with the financial results. When the
                  values are from a financial statement, it represents the date
                  the accounting period ended. When it is an estimated or
                  modeled value, it is the date on which the data was submitted.
                example: '2025-08-19T06:23:16Z'
              financialStatementDuration:
                type: string
                description: >-
                  The period of the financial statement expressed as a time
                  interval.
                example: Annual
              informationScopeDescription:
                type: string
                description: >-
                  The organizational scope of the values within the Summary
                  Financials section. Individual means it represents a single
                  organization inclusive of any branches. Consolidated means it
                  represents an organization inclusive of any branches and any
                  subsidiaries.
                example: Consolidated
              informationScopeDnBCode:
                type: integer
                description: >-
                  A unique code assigned by Dun & Bradstreet to identify the
                  organizational scope of the Summary Financials
                  values.<br/>Refer to Reference code table "192 [Information
                  Scope]" for all possible values.
                example: 9067
              reliabilityDescription:
                type: string
                description: >-
                  The integrity of the financial figures present within the
                  Summary Financials section (e.g., actual, estimated, or
                  modeled).
                example: Actual
              reliabilityDnBCode:
                type: integer
                description: >-
                  A unique code assigned by Dun & Bradstreet to identify the
                  integrity of the financial figures present within the Summary
                  Financials section.<br/>Refer to Reference code table "171
                  [Reliability]" for all possible values.
                example: 9092
              unitCode:
                type: string
                description: >-
                  The magnitude in which the Summary Financials figures are
                  provided (e.g., in Single Units, Thousands, Millions).
                example: Single Units
              yearlyRevenue:
                type: array
                items:
                  type: object
                  description: >-
                    The details of the total income attributable to product and
                    services sold by an organization annually.
                  properties:
                    value:
                      type: number
                      description: >-
                        The total income attributable to product and services
                        sold by an organization annually. It may be derived from
                        sales, gross revenue, commissions, billings or a
                        combination of any of these.
                      example: 19945238
                    currency:
                      type: string
                      description: >-
                        The three-letter currency code, defined in the ISO 4217
                        scheme published by the International Organization for
                        Standardization (ISO) identifying the type of money in
                        which this amount is expressed (e.g., USD, CAD, GBP,
                        EUR).
                      example: USD
        banks:
          type: array
          items:
            type: object
            description: >-
              The details of banks or other financial institutions at which the
              entity has an account.
            properties:
              name:
                type: string
                description: >-
                  The name of the bank or a financial institution at which the
                  entity has an account.
                example: Bank of My Country
              telephone:
                type: array
                items:
                  type: object
                  description: >-
                    The details of the Telephone contact information used for
                    voice communication with the organization.
                  properties:
                    telephoneNumber:
                      type: string
                      description: >-
                        The primary voice telephone number for the business,
                        when dialing domestically. The National Telephone Number
                        is created by combining the Domestic Area Code and the
                        Local Number.<br/><br/>A Domestic Area Code is a series
                        of numbers that must be prefixed before dialing a
                        telephone number in another local area. National
                        telecommunication authorities use various formats and
                        dialing rules for area codes. Also known as City
                        Code.<br/><br/>A Local Number is a series of numbers
                        that represents a specific telephone line.
                      example: '6505550000'
              address:
                type: object
                properties:
                  addressLocality:
                    type: object
                    properties:
                      name:
                        type: string
                        description: >-
                          The name of the locality where the organization's
                          Primary Address is located or conducts operations.
                          Locality defined as a district population cluster.
                          City, town, township, village, borough etc.
                        example: SAN FRANCISCO
                    description: >-
                      The details of the locality where the organization's
                      Primary Address is located or conducts operations.
                      Locality defined as a district population cluster. City,
                      town, township, village, borough etc.
                  addressRegion:
                    type: object
                    properties:
                      name:
                        type: string
                        description: >-
                          The name of the geographical area where the
                          organization's Primary Address is located or conducts
                          operations. For Example New Jersey.
                        example: California
                    description: >-
                      Details of the type of geographical area where the
                      organization's Primary Address is located or conducts
                      operations.<br/>Different markets have their own way of
                      subdividing the country into smaller parts.
                      <br/>Examples:<br/>Departments (France)<br/>States
                      (USA)<br/>Provinces (Netherlands)<br/>Counties
                      (UK)<br/>Bundeslander (Germany)<br/>Provinces and
                      Territories (Canada)
                  postalCode:
                    type: string
                    description: >-
                      The postal code of the organization's Primary
                      Address.<br/><br/>Also known locally in various
                      English-speaking countries throughout the world as a
                      postcode, post code, Eircode, PIN or ZIP Code) is a series
                      of letters or digits or both, sometimes including spaces
                      or punctuation, included in a postal address for the
                      purpose of sorting mail. The code is used by the
                      country&#39;s postal authority to identify the address
                      where the organization is located or conducts operations .
                    example: '941109999'
                  streetAddress:
                    type: object
                    properties:
                      line1:
                        type: string
                        description: >-
                          The first line of the address where the entity is
                          located.<br/><br/>The first line of the Primary
                          Address where the organization is located or conducts
                          operations. For example The Point in the
                          address<br/><br/>The Point<br/>37 North Wharf
                          Road<br/>London<br/>W2 1AF
                        example: 492 KOLLER ST
                      line2:
                        type: string
                        description: >-
                          The second line of the Primary Address where the
                          organization is located or conducts operations<br/>For
                          example 37 North Wharf Road in the address<br/>The
                          Point<br/>37 North Wharf Road<br/>London<br/>W2 1AF
                        example: Suite 100
                    description: >-
                      The details of the street address where the organization's
                      Primary Address is located.
                description: >-
                  The details of the Primary Address at which the organization
                  is located or conducts operations.
              registrationNumbers:
                type: array
                items:
                  type: object
                  description: >-
                    The details of the organization's identifiers issued by a
                    recognized external authority to uniquely identify subjects.
                    The issuing authority may be a Registration Authority,
                    Government Department or Commercial Enterprise (e.g.,
                    Chamber of Commerce numbers, VAT numbers).
                  properties:
                    registrationNumber:
                      type: string
                      description: >-
                        The number or alphanumeric value assigned by a
                        recognized external authority that either uniquely
                        identifies or helps to identify the organization.
                      example: 12-3456789
        isSmallBusiness:
          type: boolean
          description: >-
            Indicates if the business qualifies as small business, eligible for
            assistance from SBA, with a place of business located in the United
            States. It must operate primarily within the United States or make a
            significant contribution to the U.S. economy through payment of
            taxes or use of American products, materials or labor. Together with
            its affiliates, it must meet the numerical size standards as defined
            in the Small Business Size Regulations 13 CFR 121.<br/><br/>- If
            true, indicates that this is a small business.<br/>- If false,
            indicates that this is not a small business
          example: true
        isStandalone:
          type: boolean
          description: >-
            Indicates if the entity is a member of a legal family tree.
            <br/><br/>- If true, indicates that the entity is not a member of a
            legal family tree. This means it cannot play any family tree role
            and corporateLinkage will not be present.<br/>- If false, indicates
            that the entity is a member of a legal family tree. The roles it
            plays is indicated by Family Tree Member Roles played.
          example: false
        globalUltimate:
          type: object
          properties:
            numberOfEmployees:
              type: array
              items:
                type: object
                description: >-
                  The details of the number of individuals engaged by a business
                  for various purposes, e.g., to perform its business
                  operations.
                properties:
                  value:
                    type: integer
                    description: >-
                      The number of individuals engaged by a business to perform
                      its various purposes, e.g., business operations, and can
                      include directors, principals and full or part time
                      employees.
                    example: 1234
                  minimumValue:
                    type: integer
                    description: >-
                      The minimum number of people engaged by this entity to
                      perform its business operations. The scope of this
                      employee figure is identified in
                      informationScopeDescription.
                    example: 700
                  maximumValue:
                    type: integer
                    description: >-
                      The maximum number of people engaged by this entity to
                      perform its business operations. The scope of this
                      employee figure is identified in
                      informationScopeDescription.
                    example: 1500
                  employeeFiguresDate:
                    type: string
                    description: >-
                      The date for which the employee figure was reported by the
                      entity.
                    example: '2025-08-19T06:23:16Z'
                  informationScopeDescription:
                    type: string
                    description: >-
                      The organizational scope of the Employee Quantity Values.
                      Employees here means it represents a single organization
                      inclusive of any branches. Employees Total means it
                      represents an organization inclusive of any branches and
                      any subsidiaries.
                    example: Consolidated
                  informationScopeDnBCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun & Bradstreet to identify the
                      organizational scope of the Employee Quantity
                      value.<br/>Refer to Reference code table "192 [Information
                      Scope]" for all possible values.
                    example: 9067
                  reliabilityDescription:
                    type: string
                    description: >-
                      The integrity of the Employee Quantity Value (e.g.,
                      actual, estimated, or modeled).
                    example: Actual
                  reliabilityDnBCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun & Bradstreet to identify the
                      integrity of the Employee Quantity Values.<br/>Refer to
                      Reference code table "171 [Reliability]" for all possible
                      values.
                    example: 9092
            financials:
              type: array
              items:
                type: object
                description: >-
                  The details of the standardized summary view of the financial
                  results (actual or estimated) for the organization.
                properties:
                  yearlyRevenue:
                    type: array
                    items:
                      type: object
                      description: >-
                        The details of the total income attributable to product
                        and services sold by an organization annually.
                      properties:
                        value:
                          type: number
                          description: >-
                            The total income attributable to product and
                            services sold by an organization annually. It may be
                            derived from sales, gross revenue, commissions,
                            billings or a combination of any of these.
                          example: 19945238
                        currency:
                          type: string
                          description: >-
                            The three-letter currency code, defined in the ISO
                            4217 scheme published by the International
                            Organization for Standardization (ISO) identifying
                            the type of money in which this amount is expressed
                            (e.g., USD, CAD, GBP, EUR).
                          example: USD
                  informationScopeDescription:
                    type: string
                    description: >-
                      The organizational scope of the values within the Summary
                      Financials section. Individual means it represents a
                      single organization inclusive of any branches.
                      Consolidated means it represents an organization inclusive
                      of any branches and any subsidiaries.
                    example: Consolidated
                  informationScopeDnBCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun & Bradstreet to identify the
                      organizational scope of the Summary Financials
                      values.<br/>Refer to Reference code table "192
                      [Information Scope]" for all possible values.
                    example: 9067
                  reliabilityDescription:
                    type: string
                    description: >-
                      The integrity of the financial figures present within the
                      Summary Financials section (e.g., actual, estimated, or
                      modeled).
                    example: Actual
                  reliabilityDnBCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun & Bradstreet to identify the
                      integrity of the financial figures present within the
                      Summary Financials section.<br/>Refer to Reference code
                      table "171 [Reliability]" for all possible values.
                    example: 9092
          description: Records the firmograhics information of the Global Ultimate company.
        domesticUltimate:
          type: object
          properties:
            numberOfEmployees:
              type: array
              items:
                type: object
                description: >-
                  The details of the number of individuals engaged by a business
                  for various purposes, e.g., to perform its business
                  operations.
                properties:
                  value:
                    type: integer
                    description: >-
                      The number of individuals engaged by a business to perform
                      its various purposes, e.g., business operations, and can
                      include directors, principals and full or part time
                      employees.
                    example: 1234
                  minimumValue:
                    type: integer
                    description: >-
                      The minimum number of people engaged by this entity to
                      perform its business operations. The scope of this
                      employee figure is identified in
                      informationScopeDescription.
                    example: 700
                  maximumValue:
                    type: integer
                    description: >-
                      The maximum number of people engaged by this entity to
                      perform its business operations. The scope of this
                      employee figure is identified in
                      informationScopeDescription.
                    example: 1500
                  employeeFiguresDate:
                    type: string
                    description: >-
                      The date for which the employee figure was reported by the
                      entity.
                    example: '2025-08-19T06:23:16Z'
                  informationScopeDescription:
                    type: string
                    description: >-
                      The organizational scope of the Employee Quantity Values.
                      Employees here means it represents a single organization
                      inclusive of any branches. Employees Total means it
                      represents an organization inclusive of any branches and
                      any subsidiaries.
                    example: Consolidated
                  informationScopeDnBCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun & Bradstreet to identify the
                      organizational scope of the Employee Quantity
                      value.<br/>Refer to Reference code table "192 [Information
                      Scope]" for all possible values.
                    example: 9067
                  reliabilityDescription:
                    type: string
                    description: >-
                      The integrity of the Employee Quantity Value (e.g.,
                      actual, estimated, or modeled).
                    example: Actual
                  reliabilityDnBCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun & Bradstreet to identify the
                      integrity of the Employee Quantity Values.<br/>Refer to
                      Reference code table "171 [Reliability]" for all possible
                      values.
                    example: 9092
            financials:
              type: array
              items:
                type: object
                description: >-
                  The details of the standardized summary view of the financial
                  results (actual or estimated) for the organization.
                properties:
                  yearlyRevenue:
                    type: array
                    items:
                      type: object
                      description: >-
                        The details of the total income attributable to product
                        and services sold by an organization annually.
                      properties:
                        value:
                          type: number
                          description: >-
                            The total income attributable to product and
                            services sold by an organization annually. It may be
                            derived from sales, gross revenue, commissions,
                            billings or a combination of any of these.
                          example: 19945238
                        currency:
                          type: string
                          description: >-
                            The three-letter currency code, defined in the ISO
                            4217 scheme published by the International
                            Organization for Standardization (ISO) identifying
                            the type of money in which this amount is expressed
                            (e.g., USD, CAD, GBP, EUR).
                          example: USD
                  informationScopeDescription:
                    type: string
                    description: >-
                      The organizational scope of the values within the Summary
                      Financials section. Individual means it represents a
                      single organization inclusive of any branches.
                      Consolidated means it represents an organization inclusive
                      of any branches and any subsidiaries.
                    example: Consolidated
                  informationScopeDnBCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun & Bradstreet to identify the
                      organizational scope of the Summary Financials
                      values.<br/>Refer to Reference code table "192
                      [Information Scope]" for all possible values.
                    example: 9067
                  reliabilityDescription:
                    type: string
                    description: >-
                      The integrity of the financial figures present within the
                      Summary Financials section (e.g., actual, estimated, or
                      modeled).
                    example: Actual
                  reliabilityDnBCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun & Bradstreet to identify the
                      integrity of the financial figures present within the
                      Summary Financials section.<br/>Refer to Reference code
                      table "171 [Reliability]" for all possible values.
                    example: 9092
          description: >-
            Records the firmograhics information of the Domestic Ultimate
            company.
        organizationSizeCategory:
          type: object
          properties:
            description:
              type: string
              description: The description of the company size.
              example: Medium
            dnbCode:
              type: integer
              description: >-
                A unique code assigned by Dun & Bradstreet to identify the
                company size.<br/>Refer to Reference code table "493
                [Organization Size Category]" for all possible values.
              example: 20548
          description: >-
            The details about the entity's size. The size of an entity is
            determined using factors such as the net worth, total employee
            quantity, and sales amount.
        employerDesignation:
          type: object
          properties:
            scoreDate:
              type: string
              description: The date when this score was calculated.
              example: '2025-08-19T06:23:16Z'
            indexScore:
              type: number
              description: >-
                Underlying score (0 to 1) that determines Employment
                Classification for Modeled Classification, where higher scores
                are assigned as Employers and lower scores assigned as
                Non-Employers.
              example: 0.3
            designation:
              type: object
              properties:
                description:
                  type: string
                  description: >-
                    Text that denotes the classification derived based on the
                    data available for this organization.
                  example: Employer
                dnbCode:
                  type: integer
                  description: >-
                    A unique code assigned by Dun&Bradstreet that denotes the
                    classification derived based on the data available for this
                    organization.<br/>Refer to Reference code table "825
                    [Employer Designation]" for all possible values.
                  example: 36133
              description: >-
                Records the classification derived based on the data available
                for this organization.
            reliability:
              type: object
              properties:
                description:
                  type: string
                  description: >-
                    Text that records the reliability of employer designation
                    type; e.g., audited, actual, estimated, modeled.
                  example: Actual
                dnbCode:
                  type: integer
                  description: >-
                    A unique code assigned by Dun & Bradstreet that records the
                    reliability of employer designation type; e.g., audited,
                    actual, estimated, modeled.<br/>Refer to Reference code
                    table "171 [Reliability]" for all possible values.
                  example: 9092
              description: >-
                Records the reliability of this figure definition; e.g.,
                audited, actual, estimated, modeled.
          description: >-
            Three category classification of a business in relation to its
            employment status: Non-employers, Employers, and Holding Companies.
            Non-employers are businesses that have no paid employees, including
            self-employed individuals operating unincorporated business (sole
            proprietors). Non-employers constitute most active DUNS in the D&B
            Data Cloud. Employers are businesses that have paid employees. Some
            employers have complex corporate ownership structures, where some
            entities exist for the purpose of controlling companies or holding
            assets, such as real estate, patents, or stocks. These entities,
            classified as Holding Companies, have very few or no employees and
            does not conduct any operations or active tasks. This newly created
            classification provides D&B customers with improved targeting of
            businesses relevant to their use case.
        preferredLanguage:
          type: object
          properties:
            description:
              type: string
              description: >-
                Text defining the language in which the organization prefers to
                do business.
              example: English
            dnbCode:
              type: integer
              description: >-
                A unique code assigned by Dun & Bradstreet, defining the
                language in which the organization prefers to do
                business.<br/>Refer to Reference code table "3 [Language]" for
                all possible values.
              example: 39
          description: >-
            Records the language in which the organization prefers to do
            business.
        multiLingualSearchNames:
          type: array
          items:
            type: object
            description: >-
              Records the names in different languages created by D&B to
              facilitate name matching.
            properties:
              name:
                type: string
                description: A name created by D&B to facilitate name matching.
                example: GORMAN
              language:
                type: object
                properties:
                  description:
                    type: string
                    description: >-
                      Text that records the language in which this information
                      was recorded.
                    example: Japanese
                  dnbCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun&Bradstreet that records the
                      language in which this information was recorded.<br/>Refer
                      to Reference code table "3 [Language]" for all possible
                      values.
                    example: 3807
                description: Records the language in which this information was recorded.
              writingScript:
                type: object
                properties:
                  description:
                    type: string
                    description: >-
                      Text denoting the type of writing system for the language
                      that was used in recording this textual information. For
                      example, textual information recorded in the language
                      'Japanese' can be written in any of the following scripts:
                      kanji, katakana, hiragana or romaji.
                    example: Kana
                  dnbCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun&Bradstreet denoting the type
                      of writing system for the language that was used in
                      recording this textual information. For example, textual
                      information recorded in the language 'Japanese' can be
                      written in any of the following scripts: kanji, katakana,
                      hiragana or romaji.<br/>Refer to Reference code table "466
                      [Writing Script]" for all possible values.
                    example: 19347
                description: >-
                  Records the type of writing system for the language that was
                  used in recording this textual information. For example,
                  textual information recorded in the language 'Japanese' can be
                  written in any of the following scripts: kanji, katakana,
                  hiragana or romaji.
        imperialCalendarStartYear:
          type: string
          description: >-
            This is the year in which the operations undertaken by the subject
            were first started, expressed in terms of Japanese Emperial calendar
            eg.Bunkyu 1st year
          example: 1861
        businessTrustIndex:
          type: object
          properties:
            scoreDate:
              type: string
              description: The date when this score was calculated.
              example: '2025-08-19T06:23:16Z'
            trustIndex:
              type: number
              description: >-
                Index ranging from 0 to 1 representing the likelihood of a
                business record being created to enable the company to continue
                doing business with the government while obfuscating a past
                violation, debarment, or novation fraud.  1 indicates the
                highest likelihood  and 0 indicates the lowest
              example: 0.4
            trustClass:
              type: object
              properties:
                description:
                  type: string
                  description: >-
                    Textual description of the score representing likelihood of
                    a business record being created to enable the company to
                    continue doing business with the government while
                    obfuscating a past violation, debarment, or novation fraud.
                  example: Low
                dnbCode:
                  type: integer
                  description: >-
                    A unique code assigned by Dun&Bradstreet, representing the
                    likelihood of a business record being created to enable the
                    company to continue doing business with the government while
                    obfuscating a past violation, debarment, or novation
                    fraud.<br/>Refer to Reference code table "354 [Range
                    Position]" for all possible values.
                  example: 13693
              description: >-
                1 to 5 class score (Lowest Risk to Highest Risk) representing
                the likelihood of a business record being created to enable the
                company to continue doing business with the government while
                obfuscating a past violation, debarment, or novation
                fraud.<br/>13693 = 1 (Lowest Risk)<br/>13694 = 2 (Low
                Risk)<br/>13695 = 3 (Moderate Risk)<br/>13700 = 4 (High
                Risk)<br/>13702 = 5 (Higest Risk)
            nationalPercentile:
              type: number
              description: >-
                A numerical value between 1 to 100 as a percentile score
                representing likelihood of a business record being created to
                enable the company to continue doing business with the
                government while obfuscating a past violation, debarment, or
                novation fraud, where 100 indicates highest likelihood and 1
                indicates lowest.
              example: 75
            dataProvider:
              type: object
              properties:
                description:
                  type: string
                  description: >-
                    Details on the data source from which the excluded business
                    was drawn from.
                  example: Debarment
                dnbCode:
                  type: integer
                  description: >-
                    A unique code assigned by Dun & Bradstreet to identify the
                    data source from which the excluded business was drawn
                    from.<br/>36140 = DEBARMENT <br/>35904 = OFCCP <br/>24144 =
                    ERCR<br/>Refer to Reference code table "29 [Data Provider]"
                    for all possible values.
                  example: 36140
              description: Data source from which the excluded business was drawn from.
            scoreReasons:
              type: array
              items:
                type: object
                description: >-
                  The highest contributing factor to attach the Active DUNS to
                  the Excluded DUNS.
                properties:
                  description:
                    type: string
                    description: >-
                      Textual description of the highest contributing factor to
                      attach the Active DUNS to the Excluded DUNS.
                    example: >-
                      The subject's URL is found to have a similar match in
                      D&B's repository of high risk businesses.
                  dnbCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun&Bradstreet, representing the
                      highest contributing factor to attach the Active DUNS to
                      the Excluded DUNS.<br/>11111 = TELEPHONE NUMBER<br/>22222
                      = URL<br/>33333 = BUSINESS NAME<br/>27677 = HIGH RISK
                      INDIVIDUAL<br/>27647 = HIGH_RISK_ADDRESS<br/>44444 =
                      CEO_NAME<br/>55555 = FIRST_EXECUTIVE_NAME<br/>66666 =
                      CEO_FE_NAME<br/>77777 = BUSINESS_ADDRESS<br/>88888 =
                      LAST_NAME<br/>99999 = LINKAGE<br/>Refer to Reference code
                      table "173 [Score Commentary]" for all possible values.
                    example: 11111
            excludedOrganization:
              type: object
              properties:
                duns:
                  type: string
                  description: >-
                    The D-U-N-S Number of the debarred/high risk business with
                    highest value of Business Trust Index with the scored DUNS.
                  example: '804735132'
                name:
                  type: string
                  description: >-
                    Single name by which debarred/high risk business with
                    highest value of Business Trust Index with the scored DUNS
                    is primarily known or identified.
                  example: GORMAN MANUFACTURING COMPANY, INC.
                address:
                  type: object
                  properties:
                    streetAddressLines:
                      type: array
                      items:
                        type: object
                        description: >-
                          Primary street address details of the debarred/high
                          risk business with highest value of Business Trust
                          Index with the scored DUNS.
                        properties:
                          line1:
                            type: string
                            description: >-
                              The first line of the Primary Address where the
                              organization is located or conducts operations.
                              For example The Point in the address<br/><br/>The
                              Point<br/>37 North Wharf Road<br/>London<br/>W2
                              1AF
                            example: The Point
                  description: >-
                    Primary address of the debarred/high risk business with
                    highest value of Business Trust Index with the scored DUNS.
              description: >-
                Business name of the debarred/high risk business with highest
                value of Business Trust Index with the scored DUNS.
          description: Records the likelihood of a business attempting evasion.
        securitiesReportID:
          type: string
          description: >-
            The reference identifier of the document that states the trade name
            of the company, financial conditions of the corporate group to which
            the company belongs and other important matters concerning the
            company's business.
          example: E04991
        corporateLinkage:
          type: object
          properties:
            familytreeRolesPlayed:
              type: array
              items:
                type: object
                description: >-
                  The details of the roles the entity plays as a member of an
                  ownership structured family tree.
                properties:
                  description:
                    type: string
                    description: >-
                      The role the entity plays as a member of an ownership
                      structured family tree (e.g., a branch, division, a
                      parent, headquarters, subsidiary, global ultimate,
                      domestic ultimate).
                    example: Parent/Headquarters
                  dnbCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun & Bradstreet to identify
                      describing family tree role.<br/>Refer to Reference code
                      table "202 [Family Tree Role]" for all possible values.
                    example: 9141
            hierarchyLevel:
              type: integer
              description: >-
                The number of family-tree levels below the global ultimate the
                entity is in its corporate hierarchy. The hierarchy level value
                of the global ultimate will always be 1. Each subsidiary level
                below the global ultimate is incremented by 1. Branch locations
                in a family tree will have the same hierarchy code as its
                associated headquarter.
              example: 1
            globalUltimateFamilyTreeMembersCount:
              type: integer
              description: >-
                The total number of entities in the entity's Family tree
                starting from Global Ultimate.
              example: 9000
            branchesCount:
              type: integer
              description: >-
                The total number of branch companies that report to the subject
                in the family tree.
              example: 27
            globalUltimate:
              type: object
              properties:
                duns:
                  type: string
                  description: >-
                    The unique identification number assigned by Dun and
                    Bradstreet identifying the top most organisation in the
                    family tree.
                  example: '804735132'
                primaryName:
                  type: string
                  description: >-
                    Single name by which the organization is primarily known or
                    identified.
                  example: GORMAN MANUFACTURING COMPANY, INC.
                primaryAddress:
                  type: object
                  properties:
                    addressCountry:
                      type: object
                      properties:
                        name:
                          type: string
                          description: >-
                            The Country or Region where the organization's
                            Primary Address is located or conducts operations .
                          example: United States
                        isoAlpha2Code:
                          type: string
                          description: >-
                            The 2 letter alpha country code assigned by the
                            International Organization for Standardization (ISO)
                            identifying the Country/Region where the
                            organization's Primary address is located or
                            conducts operations .
                          example: US
                      description: >-
                        The details of the country or region where the address
                        of the organization is located or conducts operations.
                    continentalRegion:
                      type: object
                      properties:
                        name:
                          type: string
                          description: >-
                            The name of the continent where the Primary Address
                            of the organization is located or conducts
                            operations.<br/>Possible values <br/>Africa<br/>Asia
                            Pacific<br/>Europe<br/>North America<br/>Middle
                            East<br/>South America
                          example: North America
                      description: >-
                        The details of the Continent in which the Primary
                        Address of the organisation is located or conducts
                        operations.
                    addressLocality:
                      type: object
                      properties:
                        name:
                          type: string
                          description: >-
                            The name of the locality where the organization's
                            Primary Address is located or conducts operations.
                            Locality defined as a district population cluster.
                            City, town, township, village, borough etc.
                          example: SAN FRANCISCO
                      description: >-
                        The details of the locality where the organization's
                        Primary Address is located or conducts operations.
                        Locality defined as a district population cluster. City,
                        town, township, village, borough etc.
                    addressRegion:
                      type: object
                      properties:
                        name:
                          type: string
                          description: >-
                            The name of the geographical area where the
                            organization's Primary Address is located or
                            conducts operations. For Example New Jersey.
                          example: California
                        abbreviatedName:
                          type: string
                          description: >-
                            The shortened name of the geographical area where
                            the organization's Primary Address is located or
                            conducts operations For example NJ for the US State
                            New Jersey within Country United States.
                          example: CA
                      description: >-
                        Details of the type of geographical area where the
                        organization's Primary Address is located or conducts
                        operations.<br/>Different markets have their own way of
                        subdividing the country into smaller parts.
                        <br/>Examples:<br/>Departments (France)<br/>States
                        (USA)<br/>Provinces (Netherlands)<br/>Counties
                        (UK)<br/>Bundeslander (Germany)<br/>Provinces and
                        Territories (Canada)
                    postalCode:
                      type: string
                      description: >-
                        The postal code of the organization's Primary
                        Address.<br/><br/>Also known locally in various
                        English-speaking countries throughout the world as a
                        postcode, post code, Eircode, PIN or ZIP Code) is a
                        series of letters or digits or both, sometimes including
                        spaces or punctuation, included in a postal address for
                        the purpose of sorting mail. The code is used by the
                        country&#39;s postal authority to identify the address
                        where the organization is located or conducts operations
                        .
                      example: '941109999'
                    streetAddress:
                      type: object
                      properties:
                        line1:
                          type: string
                          description: >-
                            The first line of the address where the entity is
                            located.<br/><br/>The first line of the Primary
                            Address where the organization is located or
                            conducts operations. For example The Point in the
                            address<br/><br/>The Point<br/>37 North Wharf
                            Road<br/>London<br/>W2 1AF
                          example: 492 KOLLER ST
                        line2:
                          type: string
                          description: >-
                            The second line of the Primary Address where the
                            organization is located or conducts
                            operations<br/>For example 37 North Wharf Road in
                            the address<br/>The Point<br/>37 North Wharf
                            Road<br/>London<br/>W2 1AF
                          example: Suite 100
                      description: >-
                        The details of the street address where the
                        organization's Primary Address is located.
                  description: >-
                    The details of the Primary Address at which the organization
                    is located or conducts operations.
              description: >-
                The details of the top most organizationin the family tree,
                tracing each parent up to its own parent. For example,
                organizationA is based in the US and has organizationB as its
                parent also in the US. In turn organizationB is owned by
                organizationC, also in the US, which is owned by organizationD
                which is in the UK. Thus, the Global Ultimate of this family
                tree (and therefore of each member of the family tree) is
                organization D.
            domesticUltimate:
              type: object
              properties:
                duns:
                  type: string
                  description: >-
                    The D-U-N-S number of the highest ranking member of a family
                    tree within the same country/region within a limb of a
                    family tree.
                  example: '804735132'
                primaryName:
                  type: string
                  description: >-
                    Single name by which the organization is primarily known or
                    identified.
                  example: GORMAN MANUFACTURING COMPANY, INC.
                primaryAddress:
                  type: object
                  properties:
                    addressCountry:
                      type: object
                      properties:
                        name:
                          type: string
                          description: >-
                            The Country or Region where the organization's
                            Primary Address is located or conducts operations .
                          example: United States
                        isoAlpha2Code:
                          type: string
                          description: >-
                            The 2 letter alpha country code assigned by the
                            International Organization for Standardization (ISO)
                            identifying the Country/Region where the
                            organization's Primary address is located or
                            conducts operations .
                          example: US
                      description: >-
                        The details of the country or region where the address
                        of the organization is located or conducts operations.
                    continentalRegion:
                      type: object
                      properties:
                        name:
                          type: string
                          description: >-
                            The name of the continent where the Primary Address
                            of the organization is located or conducts
                            operations.<br/>Possible values <br/>Africa<br/>Asia
                            Pacific<br/>Europe<br/>North America<br/>Middle
                            East<br/>South America
                          example: North America
                      description: >-
                        The details of the Continent in which the Primary
                        Address of the organisation is located or conducts
                        operations.
                    addressLocality:
                      type: object
                      properties:
                        name:
                          type: string
                          description: >-
                            The name of the locality where the organization's
                            Primary Address is located or conducts operations.
                            Locality defined as a district population cluster.
                            City, town, township, village, borough etc.
                          example: SAN FRANCISCO
                      description: >-
                        The details of the locality where the organization's
                        Primary Address is located or conducts operations.
                        Locality defined as a district population cluster. City,
                        town, township, village, borough etc.
                    addressRegion:
                      type: object
                      properties:
                        name:
                          type: string
                          description: >-
                            The name of the geographical area where the
                            organization's Primary Address is located or
                            conducts operations. For Example New Jersey.
                          example: California
                        abbreviatedName:
                          type: string
                          description: >-
                            The shortened name of the geographical area where
                            the organization's Primary Address is located or
                            conducts operations For example NJ for the US State
                            New Jersey within Country United States.
                          example: CA
                      description: >-
                        Details of the type of geographical area where the
                        organization's Primary Address is located or conducts
                        operations.<br/>Different markets have their own way of
                        subdividing the country into smaller parts.
                        <br/>Examples:<br/>Departments (France)<br/>States
                        (USA)<br/>Provinces (Netherlands)<br/>Counties
                        (UK)<br/>Bundeslander (Germany)<br/>Provinces and
                        Territories (Canada)
                    postalCode:
                      type: string
                      description: >-
                        The postal code of the organization's Primary
                        Address.<br/><br/>Also known locally in various
                        English-speaking countries throughout the world as a
                        postcode, post code, Eircode, PIN or ZIP Code) is a
                        series of letters or digits or both, sometimes including
                        spaces or punctuation, included in a postal address for
                        the purpose of sorting mail. The code is used by the
                        country&#39;s postal authority to identify the address
                        where the organization is located or conducts operations
                        .
                      example: '941109999'
                    streetAddress:
                      type: object
                      properties:
                        line1:
                          type: string
                          description: >-
                            The first line of the address where the entity is
                            located.<br/><br/>The first line of the Primary
                            Address where the organization is located or
                            conducts operations. For example The Point in the
                            address<br/><br/>The Point<br/>37 North Wharf
                            Road<br/>London<br/>W2 1AF
                          example: 492 KOLLER ST
                        line2:
                          type: string
                          description: >-
                            The second line of the Primary Address where the
                            organization is located or conducts
                            operations<br/>For example 37 North Wharf Road in
                            the address<br/>The Point<br/>37 North Wharf
                            Road<br/>London<br/>W2 1AF
                          example: Suite 100
                      description: >-
                        The details of the street address where the
                        organization's Primary Address is located.
                  description: >-
                    The details of the Primary Address at which the organization
                    is located or conducts operations.
              description: >-
                The details of the highest ranking member of a family tree
                within the same country/region within a limb of a
                family.<br/><br/><br/><br/>For example, Company A is based in
                the US and has Company B as its parent also in the US. In turn
                Company B is owned by Company C, also in the US, which is owned
                by Company D which is in the UK. Thus, the Domestic Ultimate of
                Company A is actually Company C as this is the last entity in
                the parent chain that is in the US.
            parent:
              type: object
              properties:
                duns:
                  type: string
                  description: >-
                    The D-U-N-S number of the organization that owns more than
                    50% of the subject organization.
                  example: '804735132'
                primaryName:
                  type: string
                  description: >-
                    Single name by which the organization is primarily known or
                    identified.
                  example: GORMAN MANUFACTURING COMPANY, INC.
                primaryAddress:
                  type: object
                  properties:
                    addressCountry:
                      type: object
                      properties:
                        name:
                          type: string
                          description: >-
                            The Country or Region where the organization's
                            Primary Address is located or conducts operations .
                          example: United States
                        isoAlpha2Code:
                          type: string
                          description: >-
                            The 2 letter alpha country code assigned by the
                            International Organization for Standardization (ISO)
                            identifying the Country/Region where the
                            organization's Primary address is located or
                            conducts operations .
                          example: US
                      description: >-
                        The details of the country or region where the address
                        of the organization is located or conducts operations.
                    continentalRegion:
                      type: object
                      properties:
                        name:
                          type: string
                          description: >-
                            The name of the continent where the Primary Address
                            of the organization is located or conducts
                            operations.<br/>Possible values <br/>Africa<br/>Asia
                            Pacific<br/>Europe<br/>North America<br/>Middle
                            East<br/>South America
                          example: North America
                      description: >-
                        The details of the Continent in which the Primary
                        Address of the organisation is located or conducts
                        operations.
                    addressLocality:
                      type: object
                      properties:
                        name:
                          type: string
                          description: >-
                            The name of the locality where the organization's
                            Primary Address is located or conducts operations.
                            Locality defined as a district population cluster.
                            City, town, township, village, borough etc.
                          example: SAN FRANCISCO
                      description: >-
                        The details of the locality where the organization's
                        Primary Address is located or conducts operations.
                        Locality defined as a district population cluster. City,
                        town, township, village, borough etc.
                    addressRegion:
                      type: object
                      properties:
                        name:
                          type: string
                          description: >-
                            The name of the geographical area where the
                            organization's Primary Address is located or
                            conducts operations. For Example New Jersey.
                          example: California
                        abbreviatedName:
                          type: string
                          description: >-
                            The shortened name of the geographical area where
                            the organization's Primary Address is located or
                            conducts operations For example NJ for the US State
                            New Jersey within Country United States.
                          example: CA
                      description: >-
                        Details of the type of geographical area where the
                        organization's Primary Address is located or conducts
                        operations.<br/>Different markets have their own way of
                        subdividing the country into smaller parts.
                        <br/>Examples:<br/>Departments (France)<br/>States
                        (USA)<br/>Provinces (Netherlands)<br/>Counties
                        (UK)<br/>Bundeslander (Germany)<br/>Provinces and
                        Territories (Canada)
                    postalCode:
                      type: string
                      description: >-
                        The postal code of the organization's Primary
                        Address.<br/><br/>Also known locally in various
                        English-speaking countries throughout the world as a
                        postcode, post code, Eircode, PIN or ZIP Code) is a
                        series of letters or digits or both, sometimes including
                        spaces or punctuation, included in a postal address for
                        the purpose of sorting mail. The code is used by the
                        country&#39;s postal authority to identify the address
                        where the organization is located or conducts operations
                        .
                      example: '941109999'
                    streetAddress:
                      type: object
                      properties:
                        line1:
                          type: string
                          description: >-
                            The first line of the address where the entity is
                            located.<br/><br/>The first line of the Primary
                            Address where the organization is located or
                            conducts operations. For example The Point in the
                            address<br/><br/>The Point<br/>37 North Wharf
                            Road<br/>London<br/>W2 1AF
                          example: 492 KOLLER ST
                        line2:
                          type: string
                          description: >-
                            The second line of the Primary Address where the
                            organization is located or conducts
                            operations<br/>For example 37 North Wharf Road in
                            the address<br/>The Point<br/>37 North Wharf
                            Road<br/>London<br/>W2 1AF
                          example: Suite 100
                      description: >-
                        The details of the street address where the
                        organization's Primary Address is located.
                  description: >-
                    The details of the Primary Address at which the organization
                    is located or conducts operations.
              description: >-
                The details of the organization that owns more than 50% of the
                subject organization.
            headQuarter:
              type: object
              properties:
                duns:
                  type: string
                  description: >-
                    The D-U-N-S number of the Headquarters organization  that
                    serves as the administrative office for its branches.
                  example: '804735132'
                primaryName:
                  type: string
                  description: >-
                    Single name by which the organization is primarily known or
                    identified.
                  example: GORMAN MANUFACTURING COMPANY, INC.
                primaryAddress:
                  type: object
                  properties:
                    addressCountry:
                      type: object
                      properties:
                        name:
                          type: string
                          description: >-
                            The Country or Region where the organization's
                            Primary Address is located or conducts operations .
                          example: United States
                        isoAlpha2Code:
                          type: string
                          description: >-
                            The 2 letter alpha country code assigned by the
                            International Organization for Standardization (ISO)
                            identifying the Country/Region where the
                            organization's Primary address is located or
                            conducts operations .
                          example: US
                      description: >-
                        The details of the country or region where the address
                        of the organization is located or conducts operations.
                    continentalRegion:
                      type: object
                      properties:
                        name:
                          type: string
                          description: >-
                            The name of the continent where the Primary Address
                            of the organization is located or conducts
                            operations.<br/>Possible values <br/>Africa<br/>Asia
                            Pacific<br/>Europe<br/>North America<br/>Middle
                            East<br/>South America
                          example: North America
                      description: >-
                        The details of the Continent in which the Primary
                        Address of the organisation is located or conducts
                        operations.
                    addressLocality:
                      type: object
                      properties:
                        name:
                          type: string
                          description: >-
                            The name of the locality where the organization's
                            Primary Address is located or conducts operations.
                            Locality defined as a district population cluster.
                            City, town, township, village, borough etc.
                          example: SAN FRANCISCO
                      description: >-
                        The details of the locality where the organization's
                        Primary Address is located or conducts operations.
                        Locality defined as a district population cluster. City,
                        town, township, village, borough etc.
                    addressRegion:
                      type: object
                      properties:
                        name:
                          type: string
                          description: >-
                            The name of the geographical area where the
                            organization's Primary Address is located or
                            conducts operations. For Example New Jersey.
                          example: California
                        abbreviatedName:
                          type: string
                          description: >-
                            The shortened name of the geographical area where
                            the organization's Primary Address is located or
                            conducts operations For example NJ for the US State
                            New Jersey within Country United States.
                          example: CA
                      description: >-
                        Details of the type of geographical area where the
                        organization's Primary Address is located or conducts
                        operations.<br/>Different markets have their own way of
                        subdividing the country into smaller parts.
                        <br/>Examples:<br/>Departments (France)<br/>States
                        (USA)<br/>Provinces (Netherlands)<br/>Counties
                        (UK)<br/>Bundeslander (Germany)<br/>Provinces and
                        Territories (Canada)
                    postalCode:
                      type: string
                      description: >-
                        The postal code of the organization's Primary
                        Address.<br/><br/>Also known locally in various
                        English-speaking countries throughout the world as a
                        postcode, post code, Eircode, PIN or ZIP Code) is a
                        series of letters or digits or both, sometimes including
                        spaces or punctuation, included in a postal address for
                        the purpose of sorting mail. The code is used by the
                        country&#39;s postal authority to identify the address
                        where the organization is located or conducts operations
                        .
                      example: '941109999'
                    streetAddress:
                      type: object
                      properties:
                        line1:
                          type: string
                          description: >-
                            The first line of the address where the entity is
                            located.<br/><br/>The first line of the Primary
                            Address where the organization is located or
                            conducts operations. For example The Point in the
                            address<br/><br/>The Point<br/>37 North Wharf
                            Road<br/>London<br/>W2 1AF
                          example: 492 KOLLER ST
                        line2:
                          type: string
                          description: >-
                            The second line of the Primary Address where the
                            organization is located or conducts
                            operations<br/>For example 37 North Wharf Road in
                            the address<br/>The Point<br/>37 North Wharf
                            Road<br/>London<br/>W2 1AF
                          example: Suite 100
                      description: >-
                        The details of the street address where the
                        organization's Primary Address is located.
                  description: >-
                    The details of the Primary Address at which the organization
                    is located or conducts operations.
              description: >-
                The details of the organization that serves as the
                administrative office for its branches.
            branches:
              type: array
              items:
                type: object
                description: >-
                  Records the entities with a valid linkage/association to a
                  business record which is its Headquarters.
                properties:
                  multiLingualNames:
                    type: array
                    items:
                      type: object
                      description: >-
                        The details of the name by which the entity is primarily
                        known or identified presented in multiple languages.
                      properties:
                        name:
                          type: string
                          description: >-
                            The name by which the entity is primarily known or
                            identified.
                          example: GORMAN
                        language:
                          type: object
                          properties:
                            description:
                              type: string
                              description: The language in which this name was recorded.
                              example: Japanese
                            dnbCode:
                              type: integer
                              description: >-
                                A unique code assigned by Dun & Bradstreet to
                                identify the language in which this address was
                                recorded.<br/>Refer to Reference code table "3
                                [Language]" for all possible values.
                              example: 39
                          description: >-
                            The details of the language in which this name was
                            recorded.
          description: >-
            Details of organization to organization relationships based on
            majority ownership or control (>50%). There are two types of
            relationships, branch/division to Headquarter and Subsidiary to
            Parent.
        industrialPlantsCount:
          type: integer
          description: >-
            The number of facilities necessary for an industrial or
            manufacturing operation i.e. the equipment, including machinery,
            tools, instruments, and fixtures and the buildings containing them.
          example: 23
        principalsSummary:
          type: object
          properties:
            currentPrincipalsCount:
              type: integer
              description: >-
                The number of current principals that are associated with the
                entity.
              example: 10
            otherAssociationsCount:
              type: integer
              description: >-
                The number of relationships where the active principals are
                associated with other companies currently or in the past.
              example: 4
            inactiveAssociationsCount:
              type: integer
              description: >-
                The number of relationships where the active principals are
                associated with other companies that are out of business.
              example: 7
            unfavorableInactiveAssociationsCount:
              type: integer
              description: >-
                The number of relationships where the principals are associated
                with other companies that was involved in an unfavorable
                bankruptcy event.
              example: 5
            favorableInactiveAssociationsCount:
              type: integer
              description: >-
                The number of relationships where the principals are associated
                with other companies that was involved in a favorable bankruptcy
                event.
              example: 2
            detrimentalPrincipalsCount:
              type: integer
              description: >-
                The number of principals that are associated with negative legal
                events.
              example: 2
            detrimentalPrincipalsPercentage:
              type: number
              description: >-
                The percentage of total active principals that are associated
                with negative legal events.
              example: 20
          description: >-
            The summary information for the principals associated with the
            entity.
        currentPrincipals:
          type: array
          items:
            type: object
            description: >-
              The detail of the person identified as a key stakeholder of the
              business or organization by the local registry or other official
              sources. The key stakeholder can be a natural person or an
              organization. Unless clearly defined as "former" or "most senior" 
              the definitions below refer to the current key stakeholder.
            properties:
              givenName:
                type: string
                description: >-
                  The given name of the key stakeholder who is an individual. In
                  western cultures this is usually presented first.
                example: Leslie
              middleName:
                type: string
                description: >-
                  Additional name associated to the key stakeholder to
                  distinguish them from other people with the same given name
                  and surname. In several cultures, the middle name is a portion
                  of a personal name that is written between the key
                  stakeholder's given name and their surname. In some countries
                  such as the US, a single letter can be populated in this
                  field.
                example: Ann
              familyName:
                type: string
                description: >-
                  The family or surname of the key stakeholder who is an
                  individual. In western cultures this is usually presented
                  last.
                example: Smith
              fullName:
                type: string
                description: >-
                  The key stakeholder's given and surname in addition to the
                  middle name and name suffix (when available) listed on one
                  field if the key stakeholder is an individual. This will be
                  submitted in the appropriate format for the local country. If
                  the key stakeholder is an organization, the name of the
                  organization will be populated in the full name field.
                example: Leslie Ann Smith
              namePrefix:
                type: string
                description: >-
                  The correct form of address for the key stakeholder (e.g.,
                  Dr., Professor, Lord).
                example: Dr.
              nameSuffix:
                type: string
                description: >-
                  Letters listed after the key stakeholder's last name to
                  provide additional details about the person's family
                  generation(e.g., Senior, Junior, III. ) or their
                  professional/qualification (e.g., MD, PhD etc.) Populated when
                  available.
                example: PhD
              associationStartDate:
                type: string
                description: >-
                  The date when this principal first became a principal of the
                  subject. This is not necessarily the date that the principal
                  first took up their current position.
                example: '2025-08-19T06:23:16Z'
              otherLanguageNames:
                type: array
                items:
                  type: object
                  description: Records the names of the principal in other languages.
                  properties:
                    givenName:
                      type: string
                      description: >-
                        Records the first name of the principal in other
                        languages.
                      example: Leslie
                    familyName:
                      type: string
                      description: >-
                        Records the last name of the principal in other
                        languages.
                      example: Smith
              gender:
                type: object
                properties:
                  description:
                    type: string
                    description: >-
                      Text description of the binary classification or unknown
                      classification based on the key stakeholder's personal
                      identity when key stakeholder is an individual.
                    example: Female
                  dnbCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun & Bradstreet to identify the
                      male/female binary classification or unknown
                      classification when the key stakeholder is an
                      individual.<br/>Possible values:<br/>- 190: Male<br/>-
                      191: Female<br/>- 3581: not specified<br/>Refer to
                      Reference code table "18 [Gender]" for all possible
                      values.
                    example: 191
                description: >-
                  The detail of the binary classification or unknown
                  classification based on the key stakeholder's personal
                  identity when key stakeholder is an individual.
              jobTitles:
                type: array
                items:
                  type: object
                  description: >-
                    The detail of the text string that denotes a position held
                    by the key stakeholder in the organization or recording of
                    the title used by the organization to describe this person's
                    job e.g., Leader Global Communication, Manager National
                    Technical Support Center.
                  properties:
                    title:
                      type: string
                      description: >-
                        Text string that denotes a position held by the key
                        stakeholder in the organization or recording of the
                        title used by the organization to describe this person's
                        job e.g., Leader Global Communication, Manager National
                        Technical Support Center.
                      example: President
              managementResponsibilities:
                type: array
                items:
                  type: object
                  description: >-
                    The details of the standardized alphanumeric classification
                    code generated by Dun & Bradstreet used to identify the
                    business function and hierarchical level of the key
                    stakeholder based on their professional job title.
                  properties:
                    description:
                      type: string
                      description: >-
                        A text description of the standardized alphanumeric
                        classification code generated by Dun & Bradstreet that
                        identifies the business function and hierarchical level
                        of the key stakeholder based on their professional job
                        title.<br/><br/>For example " Chief Executive Officer"
                        in<br/>A1A7 Chief Executive Officer
                      example: President
                    mrcCode:
                      type: string
                      description: >-
                        A standardized alphanumeric classification code
                        generated by Dun & Bradstreet that identifies the
                        business function of the key stakeholder based on the
                        associated job title data. This information is expressed
                        as a standard Management Responsibility Code
                        (MRC).<br/><br/>For example " A1A7" in<br/>A1A7 Chief
                        Executive Officer<br/>Refer to Reference code table
                        "27751[MRC]" for all possible values.
                      example: A1A6
              idNumbers:
                type: array
                items:
                  type: object
                  description: >-
                    The details of the identification/registration numbers for
                    the key stakeholder of the business or organization.
                  properties:
                    idNumber:
                      type: string
                      description: >-
                        A number assigned by an external body or by Dun &
                        Bradstreet which either uniquely identifies or helps to
                        identify the key stakeholder of the business or
                        organization.
                      example: '11356097'
                    idType:
                      type: object
                      properties:
                        description:
                          type: string
                          description: >-
                            Text that identifies the type of "Principal
                            Identification Number", e.g., Social Security
                            Number.
                          example: Super Person ID
                        dnbCode:
                          type: integer
                          description: >-
                            A unique code assigned by Dun & Bradstreet that
                            identifies the type of "Principal Identification
                            Number", e.g., Social Security Number.<br/>Refer to
                            Reference code table "7 [Registration Number Type]"
                            for all possible values.
                          example: 11694
                      description: >-
                        The details that identifies the type of key stakeholder
                        Identification Number, e.g., Social Security Number.
        mostSeniorPrincipals:
          type: array
          items:
            type: object
            description: >-
              The person identified as a highest ranking key stakeholder of a
              business or organization by the local registry or other official
              sources. A key stakeholder can be a natural person or an
              organization.
            properties:
              givenName:
                type: string
                description: >-
                  The given name of the highest ranking key stakeholder who is
                  an individual. In western cultures this is usually presented
                  first.
                example: Leslie
              middleName:
                type: string
                description: >-
                  Additional name associated to the highest ranking key
                  stakeholder to distinguish them from other people with the
                  same given name and surname. In several cultures, the middle
                  name is a portion of a personal name that is written between
                  the highest ranking key stakeholder's given name and their
                  surname. In some countries such as the US, a single letter can
                  be populated in this field.
                example: Ann
              familyName:
                type: string
                description: >-
                  The family or surname of the highest ranking key stakeholder
                  who is an individual. In western cultures this is usually
                  presented last.
                example: Smith
              fullName:
                type: string
                description: >-
                  The highest ranking key stakeholder's given and surname in
                  addition to the middle name and name suffix (when available)
                  listed on one field if the key stakeholder is an individual.
                  This will be submitted in the appropriate format for the local
                  country. If the highest ranking key stakeholder is an
                  organization, the name of the organization will be populated
                  in the full name field.
                example: Leslie Ann Smith
              namePrefix:
                type: string
                description: >-
                  The correct form of address for the highest ranking key
                  stakeholder (e.g., Dr., Professor, Lord).
                example: Dr.
              nameSuffix:
                type: string
                description: >-
                  Letters listed after the highest ranking key stakeholder's
                  last name to provide additional details about the person's
                  family generation(e.g., Senior, Junior, III. ) or their
                  professional/qualification (e.g., MD, PhD etc.) Populated when
                  available.
                example: PhD
              associationStartDate:
                type: string
                description: >-
                  The date when this principal first became a principal of the
                  subject. This is not necessarily the date that the principal
                  first took up their current position.
                example: '2025-08-19T06:23:16Z'
              otherLanguageNames:
                type: array
                items:
                  type: object
                  description: Records the names of the principal in other languages.
                  properties:
                    givenName:
                      type: string
                      description: >-
                        Records the first name of the principal in other
                        languages.
                      example: Leslie
                    familyName:
                      type: string
                      description: >-
                        Records the last name of the principal in other
                        languages.
                      example: Smith
                    fullName:
                      type: string
                      description: >-
                        The full name of the most senior principal in other
                        local languages.
                      example: Leslie Smith
                    language:
                      type: object
                      properties:
                        description:
                          type: string
                          description: >-
                            Text that records the language in which this
                            information was recorded.<br/>Refer to Reference
                            code table "3 [Language]" for all possible values.
                          example: Japanese
                        dnbCode:
                          type: integer
                          description: >-
                            A unique code assigned by Dun&Bradstreet that
                            records the language in which this information was
                            recorded.<br/>Refer to Reference code table "3
                            [Language]" for all possible values.
                          example: 3807
                      description: >-
                        Records the language in which this information was
                        recorded.
                    writingScript:
                      type: object
                      properties:
                        description:
                          type: string
                          description: >-
                            Text denoting the type of writing system for the
                            language that was used in recording this textual
                            information. For example, textual information
                            recorded in the language 'Japanese' can be written
                            in any of the following scripts: kanji, katakana,
                            hiragana or romaji.
                          example: Kana
                        dnbCode:
                          type: integer
                          description: >-
                            A unique code assigned by Dun&Bradstreet denoting
                            the type of writing system for the language that was
                            used in recording this textual information. For
                            example, textual information recorded in the
                            language 'Japanese' can be written in any of the
                            following scripts: kanji, katakana, hiragana or
                            romaji.<br/>Refer to Reference code table "466
                            [Writing Script]" for all possible values.
                          example: 19347
                      description: >-
                        Records the type of writing system for the language that
                        was used in recording this textual information. For
                        example, textual information recorded in the language
                        'Japanese' can be written in any of the following
                        scripts: kanji, katakana, hiragana or romaji.
              gender:
                type: object
                properties:
                  description:
                    type: string
                    description: >-
                      Text description of the binary classification or unknown
                      classification based on the highest ranking key
                      stakeholder's personal identity when key stakeholder is an
                      individual.
                    example: Female
                  dnbCode:
                    type: integer
                    description: >-
                      A unique code assigned by Dun & Bradstreet to identify to
                      define the male/female binary classification or unknown
                      classification when the highest ranking key stakeholder is
                      an individual.<br/>Possible values:<br/>- 190: Male<br/>-
                      191: Female<br/>- 3581: not specified<br/>Refer to
                      Reference code table "18 [Gender]" for all possible
                      values.
                    example: 191
                description: >-
                  The detail of the binary classification or unknown
                  classification based on the highest ranking key stakeholder's
                  personal identity when key stakeholder is an individual.
              jobTitles:
                type: array
                items:
                  description: >-
                    Text string that denotes a position held by the highest
                    ranking key stakeholder in the organization or recording of
                    the title used by the organization to describe this person's
                    job e.g., Leader Global Communication, Manager National
                    Technical Support Center.
                  properties:
                    title:
                      type: string
                      example: President
                      description: >-
                        Text string that denotes a position held by the key
                        stakeholder in the organization or recording of the
                        title used by the organization to describe this person's
                        job e.g., Leader Global Communication, Manager National
                        Technical Support Center.
                  type: object
              managementResponsibilities:
                type: array
                items:
                  type: object
                  description: >-
                    The details of the standardized alphanumeric classification
                    code generated by Dun & Bradstreet used to identify the
                    business function and hierarchical level of the key
                    stakeholder based on their professional job title.
                  properties:
                    description:
                      type: string
                      description: >-
                        A text description of the standardized alphanumeric
                        classification code generated by Dun & Bradstreet that
                        identifies the business function and hierarchical level
                        of the highest ranking key stakeholder of the business
                        or organization based on their professional job
                        title.<br/><br/>For example " Chief Executive Officer"
                        in<br/>A1A7 Chief Executive Officer
                      example: President
                    mrcCode:
                      type: string
                      description: >-
                        A standardized alphanumeric classification code
                        generated by Dun & Bradstreet that identifies the
                        business function of the highest ranking key stakeholder
                        based on the associated job title data. This information
                        is expressed as a standard Management Responsibility
                        Code (MRC).<br/><br/>For example " A1A7" in<br/>A1A7
                        Chief Executive Officer<br/>Refer to Reference code
                        table "27751[MRC]" for all possible values.
                      example: A1A6
              idNumbers:
                type: array
                items:
                  type: object
                  description: >-
                    Identification/registration numbers for the highest ranking
                    key stakeholder of the organization.
                  properties:
                    idNumber:
                      type: string
                      description: >-
                        A number assigned by an external body or by Dun &
                        Bradstreet which either uniquely identifies or helps to
                        identify the highest ranking key stakeholder of the
                        organization.
                      example: '11356097'
                    idType:
                      type: object
                      properties:
                        description:
                          type: string
                          description: >-
                            Text that identifies the type of "Principal
                            Identification Number", e.g., Social Security Number
                            for the highest ranking key stakeholder of the
                            organization
                          example: Super Person ID
                        dnbCode:
                          type: integer
                          description: >-
                            A unique code assigned by Dun & Bradstreet that
                            identifies the type of "Principal Identification
                            Number", e.g., Social Security Number for the
                            highest ranking key stakeholder of the
                            organization<br/>Refer to Reference code table "7
                            [Registration Number Type]" for all possible values.
                          example: 11694
                      description: >-
                        Identifies the type of "Principal Identification
                        Number", e.g., Social Security Number for the highest
                        ranking key stakeholder of the organization.
      description: The details of the entity.
    DataBlock:
      type: object
      description: >-
        A data block is a collection of data elements that are logically grouped
        together. Enables you to retrieve data on a specific entity or category.
      properties:
        transactionDetail:
          type: object
          description: The information used to process this request.
          properties:
            transactionID:
              type: string
              description: >-
                A value assigned by the Dun & Bradstreet application to uniquely
                identify this request.
              example: rlh-hi9puyoijk-jop8u-kd-d-1
            transactionTimestamp:
              type: string
              description: >-
                The date and time, in ISO 8601 UTC Z standard, when this
                response was created.
              example: '2025-08-19T06:23:16Z'
            inLanguage:
              type: string
              description: >-
                An IETF BCP 47 code value that defines the language in which
                this product was rendered.
              example: en-US
        inquiryDetail:
          type: object
          description: The criteria used to process this request.
          properties:
            duns:
              type: string
              description: The D-U-N-S number provided in the request.
              example: '804735132'
            blockIDs:
              type: array
              items:
                description: The blockIDs provided in the request.
                example:
                  - blockID
                type: string
            tradeUp:
              type: string
              description: The value of the tradeUp parameter provided in the request.
              example: hq
            customerReference:
              type: string
              description: >-
                A reference string provided by the customer for this particular
                transaction.
              example: Some text to describe the request.
        blockStatus:
          type: array
          items:
            type: object
            description: Records the status of the data blocks requested by the customer.
            properties:
              blockID:
                type: string
                description: The unique identifier for the data block.
                example: blockID
              status:
                type: string
                description: >-
                  The current status of the data block fulfilled in this
                  response.<br/><br/>Possible values:<br/>* OK<br/>* Unavailable
                example: OK
              reason:
                type: string
                description: >-
                  Any specific reason why the data block is not delivered in
                  this response.<br/><br/>Possible values:<br/>* Data is not
                  available.<br/>* Data is not available for the branch.<br/>*
                  Data is not available on the requested country code.
                example: Data is not available.
        organization:
          $ref: '#/components/schemas/DataBlockOrganization'
    FormattedSapRecordName1:
      type: string
      description: A name1 filed of a business partner name.
      example: CDQ AG
    FormattedSapRecordName2:
      type: string
      description: A name2 filed of a business partner name.
      example: CDQ AG
    FormattedSapRecordName3:
      type: string
      description: A name3 filed of a business partner name.
      example: CDQ AG
    FormattedSapRecordName4:
      type: string
      description: A name4 filed of a business partner name.
      example: CDQ AG
    FormattedSapRecordNameCo:
      type: string
      description: The legal form name of a Legal Form.
      example: Aktiengesellschaft
    FormattedSapRecordLegalEntity:
      type: string
      description: The legal entity of a Legal Form.
      example: Aktiengesellschaft
    FormattedSapRecordLegalForm:
      type: string
      description: The legal form of a Legal Form.
      example: Aktiengesellschaft
    FormattedSapRecordIndSector:
      type: string
      description: >-
        A business industry or activity classification is a system of
        categorizing businesses and organizations into specific industries or
        activities based on their primary products or services, functions, or
        activities. These classifications are often used by governments, trade
        organizations, and other institutions to collect and analyze data on
        economic activity and to track trends and changes in various sectors.
      example: NAF
    FormattedSapRecordIndSectorCode:
      type: string
      description: >-
        A code of business industry or activity classification is a system of
        categorizing businesses and organizations into specific industries or
        activities based on their primary products or services, functions, or
        activities. These classifications are often used by governments, trade
        organizations, and other institutions to collect and analyze data on
        economic activity and to track trends and changes in various sectors.
      example: NAF
    FormattedSapRecordEmailAddress:
      type: string
      description: Email address of the Business Partner.
      example: bp@gmail.com
    FormattedSapRecordNarp:
      type: string
      description: >-
        An individual person, i.e. not an organization. An individual has no
        identifiers and has no legal form in its name.
      example: Friedrich Nietzsche
    FormattedSapRecordStceg:
      type: string
      description: VAT registration number.
      example: CHE-218.608.88
    FormattedSapRecordStcd1:
      type: string
      description: Standard tax number field1.
      example: CHE-218.608.88
    FormattedSapRecordStcd2:
      type: string
      description: Standard tax number field2.
      example: CHE-218.608.88
    FormattedSapRecordStcd3:
      type: string
      description: Standard tax number field3.
      example: CHE-218.608.88
    FormattedSapRecordStcd4:
      type: string
      description: Standard tax number field4.
      example: CHE-218.608.88
    FormattedSapRecordStcd5:
      type: string
      description: Standard tax number field5.
      example: CHE-218.608.88
    FormattedSapRecordUrl:
      type: string
      description: >-
        Webpages related to the business partner, e.g. the main corporate
        website as also provided by some company registers.
      example: www.cdq.com
    FormattedSapRecordTelNumber:
      type: string
      description: >-
        The main phone number of a business partner, usually some info-line of
        the headquarter.
      example: +41 71 571 10 40
    FormattedSapRecordCountry:
      type: string
      description: Country name.
      example: Switzerland
    FormattedSapRecordCountryCode:
      type: string
      description: Country code (ISO 3166-1 alpha-2)
      example: CH
    FormattedSapRecordRegion:
      type: string
      description: A top-level geographical or political area division in a country.
      example: Sankt Gallen
    FormattedSapRecordRegionCodeSap:
      type: string
      description: A Region specific code for a certain address.
      example: '9004'
    FormattedSapRecordRegionCode:
      type: string
      description: A country specific code for a certain address in the region.
      example: '9004'
    FormattedSapRecordCounty:
      type: string
      description: A sub-level geographical or political area division in a country.
      example: Sankt Gallen
    FormattedSapRecordCountyCode:
      type: string
      description: A county specific code for a certain address in the region.
      example: '9004'
    FormattedSapRecordTownship:
      type: string
      description: A sub-level geographical or political area division in a country.
      example: Sankt Gallen
    FormattedSapRecordTownshipCode:
      type: string
      description: A township specific code for a certain address in the region.
      example: '9004'
    FormattedSapRecordCity:
      type: string
      description: >-
        A locality is a named densely populated area (a place) such as town,
        village, suburb, etc. A locality composes of many individual addresses.
        Many localities exist in an [administrative
        area](https://meta.cdq.com/Address/administrative_area). A locality can
        also have several levels of sub localities.
      example: Sankt Gallen
    FormattedSapRecordDistrict:
      type: string
      description: Area of a country or city.
      example: St. Georgen
    FormattedSapRecordPostalCode:
      type: string
      description: A country specific code for a certain address.
      example: '9000'
    FormattedSapRecordPostalCode3:
      type: string
      description: A country specific code for a certain address.
      example: '9000'
    FormattedSapRecordStreet1:
      type: string
      description: >-
        Details of the access route along which buildings, lots, or land are
        located, such as street, road, channel, crescent, avenue, etc. This also
        includes canals or banks on which houses or boat houses are located
        where people live.
      example: Lukasstraße 4
    FormattedSapRecordStreet2:
      type: string
      description: Additional street filed.
      example: Lukasstraße 4
    FormattedSapRecordStreet5:
      type: string
      description: Additional street filed.
      example: Lukasstraße 4
    FormattedSapRecordHouseNum:
      type: string
      description: Number of the Thoroughfare.
      example: '4'
    FormattedSapRecordHouseNum2:
      type: string
      description: Additional number filed.
      example: '4'
    FormattedSapRecordBuilding:
      type: string
      description: >-
        A structure (such as a house, hospital, school, etc.) with a roof and
        walls that is used as a place for people to live, work, do activities,
        store things, etc.
      example: Office 2
    FormattedSapRecordFloor:
      type: string
      description: The floor/story of the building.
      example: '2'
    FormattedSapRecordRoomnumber:
      type: string
      description: A distinct room in a building.
      example: '123'
    FormattedSapRecordPoBoxCountry:
      type: string
      description: A location at an address where the post is delivered to.
      example: '9000'
    FormattedSapRecordPoBoxCity:
      type: string
      description: A location at an address where the post is delivered to.
      example: '9000'
    FormattedSapRecordPoBoxPostalCode:
      type: string
      description: A location at an address where the post is delivered to.
      example: '9000'
    FormattedSapRecordPoBox:
      type: string
      description: Des
      example: '9000'
    FormattedSapRecordLatitude:
      type: string
      description: Plain on the earth's surface north or south of the equator.
      example: '47.439549'
    FormattedSapRecordLongitude:
      type: string
      description: Plain on the earth's surface east or west of a meridian.
      example: '9.395275'
    FormattedSapRecord:
      description: >-
        Provides business partner and address information in a data structure
        similar to SAP Business Partner table BUT000 and SAP Business Address
        Services table ADRC. Field names are equal or very similar to SAP field
        names in order to simplify field mapping. Data for name and street
        fields is already split into chunks of max. 35 characters.
      type: object
      properties:
        name1:
          $ref: '#/components/schemas/FormattedSapRecordName1'
        name2:
          $ref: '#/components/schemas/FormattedSapRecordName2'
        name3:
          $ref: '#/components/schemas/FormattedSapRecordName3'
        name4:
          $ref: '#/components/schemas/FormattedSapRecordName4'
        nameCo:
          $ref: '#/components/schemas/FormattedSapRecordNameCo'
        legalEntity:
          $ref: '#/components/schemas/FormattedSapRecordLegalEntity'
        legalForm:
          $ref: '#/components/schemas/FormattedSapRecordLegalForm'
        indSector:
          $ref: '#/components/schemas/FormattedSapRecordIndSector'
        indSectorCode:
          $ref: '#/components/schemas/FormattedSapRecordIndSectorCode'
        emailAddress:
          $ref: '#/components/schemas/FormattedSapRecordEmailAddress'
        narp:
          $ref: '#/components/schemas/FormattedSapRecordNarp'
        stceg:
          $ref: '#/components/schemas/FormattedSapRecordStceg'
        stcd1:
          $ref: '#/components/schemas/FormattedSapRecordStcd1'
        stcd2:
          $ref: '#/components/schemas/FormattedSapRecordStcd2'
        stcd3:
          $ref: '#/components/schemas/FormattedSapRecordStcd3'
        stcd4:
          $ref: '#/components/schemas/FormattedSapRecordStcd4'
        stcd5:
          $ref: '#/components/schemas/FormattedSapRecordStcd5'
        url:
          $ref: '#/components/schemas/FormattedSapRecordUrl'
        telNumber:
          $ref: '#/components/schemas/FormattedSapRecordTelNumber'
        country:
          $ref: '#/components/schemas/FormattedSapRecordCountry'
        countryCode:
          $ref: '#/components/schemas/FormattedSapRecordCountryCode'
        region:
          $ref: '#/components/schemas/FormattedSapRecordRegion'
        regionCodeSap:
          $ref: '#/components/schemas/FormattedSapRecordRegionCodeSap'
        regionCode:
          $ref: '#/components/schemas/FormattedSapRecordRegionCode'
        county:
          $ref: '#/components/schemas/FormattedSapRecordCounty'
        countyCode:
          $ref: '#/components/schemas/FormattedSapRecordCountyCode'
        township:
          $ref: '#/components/schemas/FormattedSapRecordTownship'
        townshipCode:
          $ref: '#/components/schemas/FormattedSapRecordTownshipCode'
        city:
          $ref: '#/components/schemas/FormattedSapRecordCity'
        district:
          $ref: '#/components/schemas/FormattedSapRecordDistrict'
        postalCode:
          $ref: '#/components/schemas/FormattedSapRecordPostalCode'
        postalCode3:
          $ref: '#/components/schemas/FormattedSapRecordPostalCode3'
        street1:
          $ref: '#/components/schemas/FormattedSapRecordStreet1'
        street2:
          $ref: '#/components/schemas/FormattedSapRecordStreet2'
        street5:
          $ref: '#/components/schemas/FormattedSapRecordStreet5'
        houseNum:
          $ref: '#/components/schemas/FormattedSapRecordHouseNum'
        houseNum2:
          $ref: '#/components/schemas/FormattedSapRecordHouseNum2'
        building:
          $ref: '#/components/schemas/FormattedSapRecordBuilding'
        floor:
          $ref: '#/components/schemas/FormattedSapRecordFloor'
        roomnumber:
          $ref: '#/components/schemas/FormattedSapRecordRoomnumber'
        poBoxCountry:
          $ref: '#/components/schemas/FormattedSapRecordPoBoxCountry'
        poBoxCity:
          $ref: '#/components/schemas/FormattedSapRecordPoBoxCity'
        poBoxPostalCode:
          $ref: '#/components/schemas/FormattedSapRecordPoBoxPostalCode'
        poBox:
          $ref: '#/components/schemas/FormattedSapRecordPoBox'
        latitude:
          $ref: '#/components/schemas/FormattedSapRecordLatitude'
        longitude:
          $ref: '#/components/schemas/FormattedSapRecordLongitude'
    ConfigurationName:
      type: string
      description: Display name for a configuration.
      example: Client configuration.
    DataMonitorExecutionTypeTechnicalKeyEnum:
      type: string
      description: Technical key of the Data Monitor Execution Type.
      example: TRIGGER
      enum:
        - TRIGGER
      x-enumDescriptions:
        TRIGGER: >-
          Execution is engaged for only these business partners, where any
          change (added, modified or deleted concepts) was detected. Adding
          completely new businness partner or new updates from reference data
          sources are also a reason to start monitor.
    DataMonitorFrequencyEnum:
      type: string
      description: List of Data Monitor Frequency parapeters.
      example: BI_WEEKLY
      enum:
        - BI_WEEKLY
        - MONTHLY
        - QUARTERLY
      x-enumDescriptions:
        BI_WEEKLY: The update is performed once for two weeks.
        MONTHLY: The update is performed once for one month.
        QUARTERLY: The update is performed once for three months.
    ProcessingStatusTechnicalKeyEnum:
      type: string
      description: Possible technical states of processing.
      enum:
        - READY
        - RETRY
        - BLOCKED
        - IN_PROGRESS
      x-enumDescriptions:
        READY: >-
          Processing Log Data processing has finished and result ready to
          consume.
        RETRY: Processing Log Data processing has failed and needs to be retried.
        BLOCKED: Processing Log Data processing is blocked and needs to be resolved.
        IN_PROGRESS: Processing Log Data is being processed.
      example: IN_PROGRESS
    DataMatchingThreshold:
      type: number
      description: The threshold for the data matching.
      example: '0.5'
      format: double
      default: 0
      minimum: 0
      maximum: 1
    SharingScopeId:
      type: string
      description: Unique identifier for the Sharing Scope.
      example: bfdfd6f7-562f-4d4a-921f-e68cba60d5cf
    SharingScopeDescription:
      type: string
      description: Description of defined sharing scope provided by customer
      example: Share customers from France.
      maxLength: 50
    ExternalIdValue:
      type: string
      description: Value of the ExternalId of the business partner.
      example: '123'
    ConceptName:
      type: string
      description: Display name of the Concept.
      example: Address
    ConceptTechnicalKey:
      type: string
      description: Technical key of the Concept.
      example: ADDRESS
    PropertyName:
      type: string
      description: Name of the property.
      example: Minority Indicator Value
    PropertyTechnicalKey:
      type: string
      description: Technical key of the property.
      example: MINORITY_INDICATOR_VALUE
    PropertyContentSelector:
      type: string
      description: JSON path to the property in the provided JSON object.
      example: $.partnerProfile.minorityIndicator.value
    PropertyContentInstanceSelectorKey:
      type: string
      description: >-
        JSON subpath to the property allowing to select concrete instance of a
        property in the provided JSON object.
      example: type.technicalKey
    PropertyContentInstanceSelectorValue:
      type: string
      description: >-
        Value of a JSON subpath to the property allowing to select concrete
        instance of a property in the provided JSON object.
      example: CH_UID
    PropertyChangeTypeTechnicalKey:
      type: string
      description: Technical Key of the Property Change Type.
      example: MODIFIED
    schemas-PropertyChangeClassification:
      type: string
      example: MAJOR
      description: >
        Gives a user an indicator how "much" the attribute was changed OR how
        important the change was. Allowed values are:
         * `TRIVIAL` - Trivial change
         * `MINOR` - Minor change
         * `MAJOR` - Major change
         * `CRITICAL` - Critical change
    PropertyChangeConfidenceScore:
      type: number
      description: >-
        Confidence score which shows how confident CDQ is about enrichment of
        that property. Calculation dependes on property type, see here for a
        complete description.
      example: '0.0'
      minimum: 0
    PropertyChangeMaxConfidenceScore:
      type: number
      description: >-
        Maximum confidence score which is achievable for this property type.
        Note that the max value will change over time depending on the
        udnerlying algorithm which will be continously improved.
      example: '1.0'
    FormattedAddressCountry:
      type: string
      description: Country name.
      example: Switzerland
    FormattedAddressAdministrativeArea:
      type: string
      description: A top-level geographical or political area division in a country.
      example: Sankt Gallen
    FormattedAddressRegion:
      type: string
      description: Top level subdivision of a country.
      example: Sankt Gallen
    FormattedAddressRegionCode:
      type: string
      description: A country specific code for a certain address in the region.
      example: '9004'
    FormattedAddressDistrict:
      type: string
      description: >-
        Type of administrative division that, in some countries, is managed by
        local government. Across the world, areas known as "districts" vary
        greatly in size, spanning regions or counties, several municipalities,
        subdivisions of municipalities, school district, or political district.
      example: City center
    FormattedAddressLocality:
      type: string
      description: >-
        A locality is a named densely populated area (a place) such as town,
        village, suburb, etc. A locality composes of many individual addresses.
      example: Sankt Gallen
    FormattedAddressPostalCode:
      type: string
      description: A country specific code for a certain address.
      example: '9000'
    FormattedAddressThoroughfare:
      type: string
      description: >-
        Details of the access route along which buildings, lots, or land are
        located, such as street, road, channel, crescent, avenue.
      example: Lukassstrasse
    FormattedAddressPremise:
      type: string
      description: >-
        A premise is a tract of land including its buildings. A premise may have
        several sub-levels to precisely identify.
      example: Lukasstraße 4, Building 2, Floor 3, Room 4
    FormattedAddressMailbox:
      type: string
      description: A location at an address where the post is delivered to.
      example: Postfach 460
    FormattedAddressInterurbanDeliveryPoint:
      type: string
      description: A single mailbox or other place at which postal mail is delivered.
      example: Sankt Gallen, Postfach 460
    FormattedAddressPostOfficeBox:
      type: string
      description: >-
        A uniquely addressable lockable box located on the premises of a post
        office station.
      example: Postfach 460
    DnBDumpReportConfiguration:
      type: object
      description: Configures if and how DnB reports are generated.
      properties:
        build:
          $ref: '#/components/schemas/BuildToggle'
        countryShortNames:
          type: array
          items:
            $ref: '#/components/schemas/CountryShortName'
          description: An array which contains country short names (ISO-2 Format).
          example: '[''PL'', ''DE'', ''CZ'', ''SK'']'
    FeatureProperty:
      type: string
      description: Name of the feature property.
      example: FETCH_RECORD
    StorageDumpReportConfiguration:
      type: object
      description: Configures if and how storage dump reports are generated.
      properties:
        build:
          $ref: '#/components/schemas/BuildToggle'
        countryShortNames:
          type: array
          items:
            $ref: '#/components/schemas/CountryShortName'
          description: An array which contains country short names (ISO-2 Format).
          example: '[''PL'', ''DE'', ''CZ'', ''SK'']'
        dataSourceIds:
          type: array
          items:
            $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
          description: An array which contains Data Source IDs.
          example: '[''61236a2781bf2e000164bac8'']'
        featuresOn:
          type: array
          items:
            $ref: '#/components/schemas/FeatureProperty'
    StorageDumpReportsConfiguration:
      description: Configures if and how Storage Dump reports are generated.
      type: object
      properties:
        dnbDumpReport:
          $ref: '#/components/schemas/DnBDumpReportConfiguration'
        storageDumpReport:
          $ref: '#/components/schemas/StorageDumpReportConfiguration'
    schemas-PropertyNewContent:
      type: string
      example: AAB
      description: New value after change
    schemas-PropertyPreviousContent:
      type: string
      example: AAB
      description: Value before change
    CorrelationId:
      type: string
      description: ID which uniquely chains a set of request()s and or task(s).
      example: 123e4567-e89b-12d3-a456-426614174000
    Task:
      type: object
      description: A task is a unit of work.
      properties:
        correlationId:
          $ref: '#/components/schemas/CorrelationId'
        userId:
          $ref: '#/components/schemas/UserId'
        jobId:
          $ref: '#/components/schemas/JobId'
    ReplyQueue:
      type: string
      description: >-
        Technical descriptor of reply queue where workers should put back the
        result.
      example: 647328648329632-34890742-3432
    Worker:
      type: string
      description: Worker which generated the result.
      example: pod-647328648329632-34890742-3432
    TaskStatus:
      type: string
      description: Task status.
      example: OK
    TaskMessage:
      type: string
      description: Details task status.
      example: The validation was successful.
    TaskResult:
      type: object
      description: Result or outcome of a task.
      properties:
        worker:
          $ref: '#/components/schemas/Worker'
        correlationId:
          $ref: '#/components/schemas/CorrelationId'
        status:
          $ref: '#/components/schemas/TaskStatus'
        message:
          $ref: '#/components/schemas/TaskMessage'
  parameters:
    storageIdPathParam:
      name: storageId
      description: Unique identifier of the Storage.
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/BusinessPartnerStorageId'
    jobIdPathParam:
      name: jobId
      description: ID of the job.
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/JobId'
    dataTransformationDefinitionId:
      name: dataTransformationDefinitionId
      description: >-
        When dataTransformationDefinitionId is provided, map
        updatedBusinessPartner using that transformation.
      in: query
      required: false
      schema:
        $ref: '#/components/schemas/DataTransformationDefinitionId'
    usernameHeaderParam:
      name: X-Credential-Username
      description: >
        Username that is passed as header parameter with the name
        X-Credential-Username.

        The header can take form of:
          * username (e.g. "lukaszmichta")
          * user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
      in: header
      required: true
      schema:
        type: string
        example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
    storageId:
      name: storageId
      description: Unique identifier of the Storage.
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/BusinessPartnerStorageId'
    dataSourceId:
      name: dataSourceId
      description: Unique identifier for a Data Source of the Storage.
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/BusinessPartnerStorageDataSourceId'
    labelsQueryParam:
      name: label
      description: >-
        Label for filtering that is passed as header parameter with the name
        label.
      in: query
      required: false
      schema:
        type: array
        description: List of labels to be filtered by.
        items:
          type: string
          description: Label for filtering.
          example: Custom label
    sharedWithOrganizationParam:
      name: sharedWithOrganization
      description: Filters only mappings which are shared with organization or not.
      in: query
      required: false
      schema:
        type: boolean
        example: 'true'
    pageQueryParam:
      name: page
      description: Number of the page that will be retrieved.
      in: query
      required: false
      schema:
        type: integer
        format: int32
        minimum: 0
        default: 0
        example: '10'
    pageSizeQueryParam:
      name: pageSize
      description: Number of items to be returned on the page.
      in: query
      required: false
      schema:
        type: integer
        format: int32
        minimum: 1
        default: 20
        example: '10'
    startAfterQueryParam:
      name: startAfter
      description: >
        Only items with an ID greater than the given one will be retrieved.


        When nextStartAfter provided in the response, should be used instead of
        the ID

        as an indicator for a next page.
      in: query
      required: false
      schema:
        type: string
        example: '5712566172571652'
    limitQueryParam:
      name: limit
      description: Number of items to be returned on the page.
      in: query
      required: false
      schema:
        type: integer
        format: int32
        minimum: 1
        default: 500
        example: '100'
    limitRandomQueryParam:
      name: limit
      description: Number of items to be returned on the page.
      in: query
      required: false
      schema:
        type: integer
        format: int32
        minimum: 1
        maximum: 10
        default: 1
        example: '5'
    skippedStartAfterQueryParam:
      name: skippedStartAfter
      description: >-
        Next page of items will be retrieved. When skippedNextStartAfter
        provided in the response, should be used.
      in: query
      required: false
      schema:
        type: string
        example: '5712566172571652'
    dnbRecordsReadFeatureOnQueryParam:
      name: featureOn
      description: Features to be activated during D&B Records Read.
      in: query
      required: false
      schema:
        type: array
        description: List of features to be activated.
        items:
          $ref: '#/components/schemas/DnbRecordsReadFeatureParam'
    dnbRecordsReadFeatureOffQueryParam:
      name: featureOff
      description: Features to be deactivated during D&B Records Read.
      in: query
      required: false
      schema:
        type: array
        description: List of features to be deactivated.
        items:
          $ref: '#/components/schemas/DnbRecordsReadFeatureParam'
    configurationId:
      in: path
      name: configurationId
      description: ID of the configuration.
      required: true
      schema:
        type: string
        example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4
    configurationVersion:
      in: path
      name: version
      required: true
      description: Version number of the configuration.
      schema:
        type: integer
        example: 1
    relationsReadFeatureOnQueryParam:
      name: featureOn
      description: Features to be activated during Relations read.
      in: query
      required: false
      schema:
        type: array
        description: List of features to be activated.
        items:
          $ref: '#/components/schemas/RelationsReadFeatureParam'
    relationsReadFeatureOffQueryParam:
      name: featureOff
      description: Features to be deactivated during Relations read.
      in: query
      required: false
      schema:
        type: array
        description: List of features to be deactivated.
        items:
          $ref: '#/components/schemas/RelationsReadFeatureParam'
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-KEY
  requestBodies:
    BusinessPartnersUpsertRequest:
      description: Request to create or update business partners.
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BusinessPartnersUpsertRequest'
    DataMapperDefinitionRequest:
      description: Request to create a new Data Mapper Definition.
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DataMapperDefinitionRequest'
          examples:
            Basic:
              summary: Basic Data Mapper Definition
              value:
                name: CustomDataMapperDefinition
                labels:
                  - CustomDataMapperLabel
                shareWithOrganization: true
                valueMappings:
                  - sourceValue: en
                    targetValue: INTERNATIONAL
                    targetAttribute: address.version.characterSet
                inputMapping:
                  businessPartnerAttributeMappings:
                    - sourceConstant: LOCAL
                      sourceAttributes:
                        - Name
                      targetAttributes:
                        - businessPartner.names[0].value
                      targetAttributeTypes:
                        - LOCAL
                      countryScopes:
                        - DE
                      selectionType: COMMA
                      separationType: LENGTH
                      isMandatoryAttribute: 'true'
                      valueMapping: INTERNATIONAL
                      defaultValue: GB
                      transformations:
                        - type: UPPER_CASE
                          parameters:
                            - {}
                  addressesAttributeMappings:
                    - - sourceConstant: LOCAL
                        sourceAttributes:
                          - Name
                        targetAttributes:
                          - businessPartner.names[0].value
                        targetAttributeTypes:
                          - LOCAL
                        countryScopes:
                          - DE
                        selectionType: COMMA
                        separationType: LENGTH
                        isMandatoryAttribute: 'true'
                        valueMapping: INTERNATIONAL
                        defaultValue: GB
                        transformations:
                          - type: UPPER_CASE
                            parameters:
                              - null
                outputMapping:
                  businessPartnerAttributeMappings:
                    - sourceConstant: LOCAL
                      sourceAttributes:
                        - Name
                      targetAttributes:
                        - businessPartner.names[0].value
                      targetAttributeTypes:
                        - LOCAL
                      countryScopes:
                        - DE
                      selectionType: COMMA
                      separationType: LENGTH
                      isMandatoryAttribute: 'true'
                      valueMapping: INTERNATIONAL
                      defaultValue: GB
                      transformations:
                        - type: UPPER_CASE
                          parameters:
                            - {}
                  addressesAttributeMappings:
                    - - sourceConstant: LOCAL
                        sourceAttributes:
                          - Name
                        targetAttributes:
                          - businessPartner.names[0].value
                        targetAttributeTypes:
                          - LOCAL
                        countryScopes:
                          - DE
                        selectionType: COMMA
                        separationType: LENGTH
                        isMandatoryAttribute: 'true'
                        valueMapping: INTERNATIONAL
                        defaultValue: GB
                        transformations:
                          - type: UPPER_CASE
                            parameters:
                              - null
            DisclosedBP:
              summary: Disclosed Business Partner
              value:
                name: CustomDataMapperDefinition
                shareWithOrganization: true
                inputMapping:
                  businessPartnerAttributeMappings:
                    - sourceAttributes:
                        - Name
                      targetAttributes:
                        - businessPartner.names[0].value
                      targetAttributeTypes:
                        - LOCAL
                    - sourceConstant: 'TRUE'
                      targetAttributes:
                        - businessPartner.disclosed
                  addressesAttributeMappings:
                    - - sourceAttributes:
                          - country
                        targetAttributes:
                          - address.country.shortName
                        targetAttributeTypes: []
    BusinessPartnerEventCreatesRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BusinessPartnerEventCreatesRequest'
      description: BusinessPartnerEventCreatesRequest
      required: true
  responses:
    400_BadRequest:
      description: The sent request is malformed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    401_Unauthorized:
      description: Invalid authentication was sent.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    403_Forbidden:
      description: Permission denied.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    404_NotFound:
      description: The specified resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
