openapi: 3.0.1
info:
  title: network_core API
  description: Merged OpenAPI spec for network_core domain
  version: 1.0.0
servers:
- url: https://api.cve.btx.eu.banqup.com/network/core
paths:
  /transaction/v1/spaces/{spaceId}/connections/{connectionId}/relations:
    get:
      tags:
      - Connections
      summary: Get list of connection relations
      description: "<div class='my-preview'><span>Preview: The API is in development\
        \ or testing phases and the interface could still change slightly.</span></div>\
        \ <br/> \tGet list of connection relations on the given space. The API supports\
        \ pagination.\n <br/> Scope: space_read"
      operationId: getAllConnectionRelations
      parameters:
      - name: spaceId
        in: path
        description: The space identifier
        required: true
        schema:
          type: string
          format: uuid
      - name: connectionId
        in: path
        description: The connection identifier
        required: true
        schema:
          type: string
          format: uuid
      - name: page
        in: query
        description: Zero-based page index, cannot be negative, default 0
        schema:
          maximum: 10737418
          minimum: 0
          type: integer
          format: int32
          default: 0
        example: 20
      - name: pageSize
        in: query
        description: 'Page size. Minimum 1, maximum: 200, default 20'
        schema:
          maximum: 200
          minimum: 1
          type: integer
          format: int32
          default: 20
        example: 20
      - name: includeTotalElements
        in: query
        description: Return the totalElements number of entries in the response
        schema:
          type: boolean
        example: true
      - name: onlyCount
        in: query
        description: Return ONLY the totalElements number of entries in the response.
        schema:
          type: boolean
        example: true
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AllConnectionRelationResult'
              example:
                connection_relations:
                - id: 00000011-0000-0000-0000-000000000000
                  connection:
                    type: business
                    id: 00000001-0000-0000-0000-000000000000
                    spaceUrl: https://entity.store/api/v1/spaces/space_1
                    globalIdentifiers:
                      fr:siret: '12345678901234'
                      nl:kvk: '87654321'
                      be:vat: '123456789'
                      global:email:
                      - john@example.com
                      global:phoneNumber:
                      - '+1234567890'
                    localIdentifier: '001'
                    assignedAccountId: '001'
                    alias: UP
                    connectionStatus: CONNECTED
                    relationType: CUSTOMER
                    addresses:
                      main:
                        streetName: Nitzsche Lodge
                        house: '80728'
                        postalCode: '3110'
                        city: Fernandahaven
                        country: Belgium
                        countryCode: BE
                    tags:
                    - favorite
                    - liked
                    active: true
                    metadata:
                      channels:
                        main: delivery_on_platform
                        secondary: email
                      department: Accounting
                      logo: https://somelinks.com/logo.jpg
                      website: https://mycompanywebsite.com
                      notes: some notes
                      industry: Agriculture, Forestry And Fishing
                    legalName: Unifiedpost Group
                    tradeName: unifiedpost
                    businessType: ENTERPRISE
                  role: role2
                  createdAt: 2023-06-01 15:25:10+00:00
                  updatedAt: 2023-06-02 15:25:10+00:00
                - id: 00000012-0000-0000-0000-000000000000
                  connection:
                    type: person
                    id: 00000002-0000-0000-0000-000000000000
                    spaceUrl: https://entity.store/api/v1/spaces/space_1
                    globalIdentifiers:
                      global:email:
                      - john@example.com
                      global:phoneNumber:
                      - '+1234567890'
                    alias: UP
                    connectionStatus: CONNECTED
                    relationType: CUSTOMER
                    addresses:
                      main:
                        streetName: Milo Crossroad
                        house: '7850'
                        postalCode: '3100'
                        city: Kubhaven
                        country: Belgium
                        countryCode: BE
                    tags:
                    - favorite
                    - liked
                    active: true
                    metadata:
                      channels:
                        main: delivery_on_platform
                        secondary: email
                      department: Accounting
                      logo: https://somelinks.com/logo.jpg
                      website: https://mycompanywebsite.com
                      notes: some notes
                      industry: Agriculture, Forestry And Fishing
                    firstName: John
                    lastName: Doe
                  role: role1
                  createdAt: 2023-06-01 15:25:10+00:00
                  updatedAt: 2023-06-02 15:25:10+00:00
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 404
                error: NOT_FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: The HTTP method was not allowed on this endpoint.
        default:
          description: Other error messages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
      security:
      - oauth2:
        - space_read
    post:
      tags:
      - Connections
      summary: Create connection relation
      description: '<div class=''my-preview''><span>Preview: The API is in development
        or testing phases and the interface could still change slightly.</span></div>
        <br/> Create connection relation on the given space <br/> Scope: space_write'
      operationId: createConnectionRelation
      parameters:
      - name: spaceId
        in: path
        description: The space identifier
        required: true
        schema:
          type: string
          format: uuid
      - name: connectionId
        in: path
        description: The connection identifier
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        description: Connection Relation to add
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectionRelationRequest'
            example:
              role: CTO
              relatedConnectionId: 00000004-0000-0000-0000-000000000000
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionRelationResult'
              examples:
                Business Connection Relation:
                  description: Business Connection Relation
                  value:
                    id: 00000011-0000-0000-0000-000000000000
                    connection:
                      type: business
                      id: 00000001-0000-0000-0000-000000000000
                      spaceUrl: https://entity.store/api/v1/spaces/space_1
                      globalIdentifiers:
                        fr:siret: '12345678901234'
                        nl:kvk: '87654321'
                        be:vat: '123456789'
                        global:email:
                        - john@example.com
                        global:phoneNumber:
                        - '+1234567890'
                      localIdentifier: '001'
                      assignedAccountId: '001'
                      alias: UP
                      connectionStatus: CONNECTED
                      relationType: CUSTOMER
                      addresses:
                        main:
                          streetName: Nitzsche Lodge
                          house: '80728'
                          postalCode: '3110'
                          city: Fernandahaven
                          country: Belgium
                          countryCode: BE
                      tags:
                      - favorite
                      - liked
                      active: true
                      metadata:
                        channels:
                          main: delivery_on_platform
                          secondary: email
                        department: Accounting
                        logo: https://somelinks.com/logo.jpg
                        website: https://mycompanywebsite.com
                        notes: some notes
                        industry: Agriculture, Forestry And Fishing
                      legalName: Unifiedpost Group
                      tradeName: unifiedpost
                      businessType: ENTERPRISE
                    role: role2
                    createdAt: 2023-06-01 15:25:10+00:00
                    updatedAt: 2023-06-02 15:25:10+00:00
                Person Connection Relation:
                  description: Person Connection Relation
                  value:
                    id: 00000012-0000-0000-0000-000000000000
                    connection:
                      type: person
                      id: 00000002-0000-0000-0000-000000000000
                      spaceUrl: https://entity.store/api/v1/spaces/space_1
                      globalIdentifiers:
                        global:email:
                        - john@example.com
                        global:phoneNumber:
                        - '+1234567890'
                      localIdentifier: '001'
                      assignedAccountId: '001'
                      alias: UP
                      connectionStatus: CONNECTED
                      relationType: CUSTOMER
                      addresses:
                        main:
                          streetName: Milo Crossroad
                          house: '7850'
                          postalCode: '3100'
                          city: Kubhaven
                          country: Belgium
                          countryCode: BE
                      tags:
                      - favorite
                      - liked
                      active: true
                      metadata:
                        channels:
                          main: delivery_on_platform
                          secondary: email
                        department: Accounting
                        logo: https://somelinks.com/logo.jpg
                        website: https://mycompanywebsite.com
                        notes: some notes
                        industry: Agriculture, Forestry And Fishing
                      firstName: John
                      lastName: Doe
                    role: role1
                    createdAt: 2023-06-01 15:25:10+00:00
                    updatedAt: 2023-06-02 15:25:10+00:00
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
        '404':
          description: Not Found. Connection relation uuid must be invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 404
                error: NOT_FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: The HTTP method was not allowed on this endpoint.
        default:
          description: Other error messages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
      security:
      - oauth2:
        - space_write
  /transaction/v1/spaces/{spaceId}/connections/{connectionId}/relations/{relationId}:
    get:
      tags:
      - Connections
      summary: Get connection relation info
      description: '<div class=''my-preview''><span>Preview: The API is in development
        or testing phases and the interface could still change slightly.</span></div>
        <br/> Get connection relation information by its ID on the given space <br/>
        Scope: space_read'
      operationId: getConnectionRelation
      parameters:
      - name: spaceId
        in: path
        description: The space identifier
        required: true
        schema:
          type: string
          format: uuid
      - name: connectionId
        in: path
        description: The connection identifier
        required: true
        schema:
          type: string
          format: uuid
      - name: relationId
        in: path
        description: The connection relation identifier
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Ok. Connection relation info.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionRelationResult'
              examples:
                Business Connection Relation:
                  description: Business Connection Relation
                  value:
                    id: 00000011-0000-0000-0000-000000000000
                    connection:
                      type: business
                      id: 00000001-0000-0000-0000-000000000000
                      spaceUrl: https://entity.store/api/v1/spaces/space_1
                      globalIdentifiers:
                        fr:siret: '12345678901234'
                        nl:kvk: '87654321'
                        be:vat: '123456789'
                        global:email:
                        - john@example.com
                        global:phoneNumber:
                        - '+1234567890'
                      localIdentifier: '001'
                      assignedAccountId: '001'
                      alias: UP
                      connectionStatus: CONNECTED
                      relationType: CUSTOMER
                      addresses:
                        main:
                          streetName: Nitzsche Lodge
                          house: '80728'
                          postalCode: '3110'
                          city: Fernandahaven
                          country: Belgium
                          countryCode: BE
                      tags:
                      - favorite
                      - liked
                      active: true
                      metadata:
                        channels:
                          main: delivery_on_platform
                          secondary: email
                        department: Accounting
                        logo: https://somelinks.com/logo.jpg
                        website: https://mycompanywebsite.com
                        notes: some notes
                        industry: Agriculture, Forestry And Fishing
                      legalName: Unifiedpost Group
                      tradeName: unifiedpost
                      businessType: ENTERPRISE
                    role: role2
                    createdAt: 2023-06-01 15:25:10+00:00
                    updatedAt: 2023-06-02 15:25:10+00:00
                Person Connection Relation:
                  description: Person Connection Relation
                  value:
                    id: 00000012-0000-0000-0000-000000000000
                    connection:
                      type: person
                      id: 00000002-0000-0000-0000-000000000000
                      spaceUrl: https://entity.store/api/v1/spaces/space_1
                      globalIdentifiers:
                        global:email:
                        - john@example.com
                        global:phoneNumber:
                        - '+1234567890'
                      localIdentifier: '001'
                      assignedAccountId: '001'
                      alias: UP
                      connectionStatus: CONNECTED
                      relationType: CUSTOMER
                      addresses:
                        main:
                          streetName: Milo Crossroad
                          house: '7850'
                          postalCode: '3100'
                          city: Kubhaven
                          country: Belgium
                          countryCode: BE
                      tags:
                      - favorite
                      - liked
                      active: true
                      metadata:
                        channels:
                          main: delivery_on_platform
                          secondary: email
                        department: Accounting
                        logo: https://somelinks.com/logo.jpg
                        website: https://mycompanywebsite.com
                        notes: some notes
                        industry: Agriculture, Forestry And Fishing
                      firstName: John
                      lastName: Doe
                    role: role1
                    createdAt: 2023-06-01 15:25:10+00:00
                    updatedAt: 2023-06-02 15:25:10+00:00
        '404':
          description: Not Found. Connection relation uuid must be invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 404
                error: NOT_FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: The HTTP method was not allowed on this endpoint.
        default:
          description: Other error messages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
      security:
      - oauth2:
        - space_read
    delete:
      tags:
      - Connections
      summary: Delete connection relation
      description: '<div class=''my-preview''><span>Preview: The API is in development
        or testing phases and the interface could still change slightly.</span></div>
        <br/> Delete connection relation by its ID on the given space <br/> Scope:
        space_write'
      operationId: deleteConnectionRelation
      parameters:
      - name: spaceId
        in: path
        description: The space identifier
        required: true
        schema:
          type: string
          format: uuid
      - name: connectionId
        in: path
        description: The connection identifier
        required: true
        schema:
          type: string
          format: uuid
      - name: relationId
        in: path
        description: The connection relation identifier
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Ok.
        '404':
          description: UUID not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 404
                error: NOT_FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: The HTTP method was not allowed on this endpoint.
        default:
          description: Other error messages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
      security:
      - oauth2:
        - space_write
    patch:
      tags:
      - Connections
      summary: Update connection relation
      description: '<div class=''my-preview''><span>Preview: The API is in development
        or testing phases and the interface could still change slightly.</span></div>
        <br/> Update connection relation by its ID on the given space <br/> Scope:
        space_write'
      operationId: updateConnectionRelation
      parameters:
      - name: spaceId
        in: path
        description: The space identifier
        required: true
        schema:
          type: string
          format: uuid
      - name: connectionId
        in: path
        description: The connection identifier
        required: true
        schema:
          type: string
          format: uuid
      - name: relationId
        in: path
        description: The connection relation identifier
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        description: Connection relation data to update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateConnectionRelationRequest'
            example:
              role: CTO
              relatedConnectionId: 00000004-0000-0000-0000-000000000000
        required: true
      responses:
        '200':
          description: Update connection relation successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionRelationResult'
              examples:
                Business Connection Relation:
                  description: Business Connection Relation
                  value:
                    id: 00000011-0000-0000-0000-000000000000
                    connection:
                      type: business
                      id: 00000001-0000-0000-0000-000000000000
                      spaceUrl: https://entity.store/api/v1/spaces/space_1
                      globalIdentifiers:
                        fr:siret: '12345678901234'
                        nl:kvk: '87654321'
                        be:vat: '123456789'
                        global:email:
                        - john@example.com
                        global:phoneNumber:
                        - '+1234567890'
                      localIdentifier: '001'
                      assignedAccountId: '001'
                      alias: UP
                      connectionStatus: CONNECTED
                      relationType: CUSTOMER
                      addresses:
                        main:
                          streetName: Nitzsche Lodge
                          house: '80728'
                          postalCode: '3110'
                          city: Fernandahaven
                          country: Belgium
                          countryCode: BE
                      tags:
                      - favorite
                      - liked
                      active: true
                      metadata:
                        channels:
                          main: delivery_on_platform
                          secondary: email
                        department: Accounting
                        logo: https://somelinks.com/logo.jpg
                        website: https://mycompanywebsite.com
                        notes: some notes
                        industry: Agriculture, Forestry And Fishing
                      legalName: Unifiedpost Group
                      tradeName: unifiedpost
                      businessType: ENTERPRISE
                    role: role2
                    createdAt: 2023-06-01 15:25:10+00:00
                    updatedAt: 2023-06-02 15:25:10+00:00
                Person Connection Relation:
                  description: Person Connection Relation
                  value:
                    id: 00000012-0000-0000-0000-000000000000
                    connection:
                      type: person
                      id: 00000002-0000-0000-0000-000000000000
                      spaceUrl: https://entity.store/api/v1/spaces/space_1
                      globalIdentifiers:
                        global:email:
                        - john@example.com
                        global:phoneNumber:
                        - '+1234567890'
                      localIdentifier: '001'
                      assignedAccountId: '001'
                      alias: UP
                      connectionStatus: CONNECTED
                      relationType: CUSTOMER
                      addresses:
                        main:
                          streetName: Milo Crossroad
                          house: '7850'
                          postalCode: '3100'
                          city: Kubhaven
                          country: Belgium
                          countryCode: BE
                      tags:
                      - favorite
                      - liked
                      active: true
                      metadata:
                        channels:
                          main: delivery_on_platform
                          secondary: email
                        department: Accounting
                        logo: https://somelinks.com/logo.jpg
                        website: https://mycompanywebsite.com
                        notes: some notes
                        industry: Agriculture, Forestry And Fishing
                      firstName: John
                      lastName: Doe
                    role: role1
                    createdAt: 2023-06-01 15:25:10+00:00
                    updatedAt: 2023-06-02 15:25:10+00:00
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
        '404':
          description: Not Found. Connection relation uuid must be invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 404
                error: NOT_FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: The HTTP method was not allowed on this endpoint.
        default:
          description: Other error messages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
      security:
      - oauth2:
        - space_write
  /transaction/v1/spaces/{spaceId}/connections/{connectionId}/connectors:
    post:
      tags:
      - Connections
      summary: Add selected connector
      description: '<div class=''my-preview''><span>Preview: The API is in development
        or testing phases and the interface could still change slightly.</span></div>
        <br/> Add the selected connector which user chooses on the connection (customer/supplier)
        <br/> Scope: space_write'
      operationId: addSelectedConnector
      parameters:
      - name: spaceId
        in: path
        description: The space identifier
        required: true
        schema:
          type: string
          format: uuid
      - name: connectionId
        in: path
        description: The connection identifier
        required: true
        schema:
          type: string
          format: uuid
        example: 1d0159ca-ab19-49d5-9e13-9d34afb03849
      requestBody:
        description: Connector to add
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectorRequest'
            examples:
              Email connector:
                description: Email connector
                value:
                  name: email
                  settings:
                    emailAddress: john.doe@example.com
                  active: true
              Peppol connector:
                description: Peppol connector
                value:
                  extensionId: 00000001-0001-0000-0000-000000000001
                  name: cross-peppol
                  namespace: com.unifiedpost.btx.connectors
                  settings:
                    peppolAccessPoint: access-point
                    peppolID: '12345'
                  active: true
        required: true
      responses:
        '201':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionDetailsResult'
              examples:
                Business Connection:
                  description: Business Connection
                  value:
                    type: business
                    id: 00000001-0000-0000-0000-000000000000
                    spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                    globalIdentifiers:
                      be:vat: '123456789'
                      fr:siret: '12345678901234'
                      global:email:
                      - john@example.com
                      global:phoneNumber:
                      - '00301234567'
                      nl:kvk: '87654321'
                    localIdentifier: '001'
                    assignedAccountId: '001'
                    alias: UP
                    connectionStatus: CONNECTED
                    relationType: CUSTOMER
                    addresses:
                      main:
                        streetName: Nitzsche Lodge
                        house: '80728'
                        postalCode: '3110'
                        city: Fernandahaven
                        country: Belgium
                        countryCode: BE
                    tags:
                    - favorite
                    - liked
                    active: true
                    metadata:
                      channels:
                        main: delivery_on_platform
                        secondary: email
                      department: Accounting
                      industry: Agriculture, Forestry And Fishing
                      logo: https://somelinks.com/logo.jpg
                      notes: some notes
                      website: https://mycompanywebsite.com
                    connectors:
                    - active: true
                      extensionId: 00000001-0001-0000-0000-000000000001
                      name: cross-peppol
                      namespace: com.unifiedpost.btx.connectors
                      settings:
                        peppolAccessPoint: access-point
                        peppolID: '12345'
                    legalName: Unifiedpost Group
                    tradeName: unifiedpost
                    businessType: ENTERPRISE
                Person Connection:
                  description: Person Connection
                  value:
                    type: person
                    id: 00000002-0000-0000-0000-000000000000
                    spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                    globalIdentifiers:
                      global:email:
                      - john@example.com
                      global:phoneNumber:
                      - '00301234567'
                    localIdentifier: '001'
                    assignedAccountId: '001'
                    alias: UP
                    connectionStatus: CONNECTED
                    relationType: CUSTOMER
                    addresses:
                      main:
                        streetName: Milo Crossroad
                        house: '7850'
                        postalCode: '3100'
                        city: Kubhaven
                        country: Belgium
                        countryCode: BE
                    tags:
                    - favorite
                    - liked
                    active: true
                    metadata:
                      channels:
                        main: delivery_on_platform
                        secondary: email
                      department: Accounting
                      industry: Agriculture, Forestry And Fishing
                      logo: https://somelinks.com/logo.jpg
                      notes: some notes
                      website: https://mycompanywebsite.com
                    connectors:
                    - active: true
                      name: email
                      settings:
                        emailAddress: john.doe@example.com
                    firstName: John
                    lastName: Doe
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
      security:
      - oauth2:
        - space_write
  /transaction/v1/spaces/{spaceId}/connections:
    get:
      tags:
      - Connections
      summary: Get list of connections
      description: "<div class='my-preview'><span>Preview: The API is in development\
        \ or testing phases and the interface could still change slightly.</span></div>\
        \ <br/> \tGet list of connections on the given space with optional filtering\
        \ by identifiers.\n\tThe API supports pagination and sorting.\n <br/> Scope:\
        \ space_read"
      operationId: getAllConnections
      parameters:
      - name: spaceId
        in: path
        description: The space identifier
        required: true
        schema:
          type: string
          format: uuid
      - name: identifierValue
        in: query
        description: Connection identifier (e.g. VAT number)
        schema:
          type: string
      - name: identifierKeyValue
        in: query
        description: Connection identifier (e.g. VAT number)
        schema:
          type: string
      - name: name
        in: query
        description: Connection name for searching
        schema:
          type: string
      - name: relationTypes
        in: query
        description: Relation Types for searching. Can be multiple values separated
          by comma, or just one value.
        schema:
          type: string
      - name: tags
        in: query
        description: Filter by tags. Can be an array to filter by all tags (AND) -
          e.g. ?tags=first_tag&tags=second_tag. Or it could be a comma-separated list
          to filter by any of the values (OR) - e.g. ?tags=first_tag,second_tag.
        schema:
          type: array
          items:
            type: string
        example:
        - first_tag
        - second_tag
        - third_tag
      - name: page
        in: query
        description: Zero-based page index, cannot be negative, default 0
        schema:
          maximum: 10737418
          minimum: 0
          type: integer
          format: int32
          default: 0
        example: 20
      - name: pageSize
        in: query
        description: 'Page size. Minimum 1, maximum: 200, default 20'
        schema:
          maximum: 200
          minimum: 1
          type: integer
          format: int32
          default: 20
        example: 20
      - name: includeTotalElements
        in: query
        description: Return the totalElements number of entries in the response
        schema:
          type: boolean
        example: true
      - name: sortBy
        in: query
        description: Sorting criteria
        schema:
          type: string
          enum:
          - createdAt
          - createdAt.asc
          - createdAt.desc
          - name
          - name.asc
          - name.desc
          - type
          - type.asc
          - type.desc
          - assignedAccountId
          - assignedAccountId.asc
          - assignedAccountId.desc
          - businessType
          - businessType.asc
          - businessType.desc
        example: createdAt.asc
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AllConnectionsResult'
              example:
                connections:
                - type: business
                  id: 0ca2797b-6365-4bf2-a490-247075e3cede
                  globalIdentifiers:
                    fr:siret: '12345678901234'
                    nl:kvk: '87654321'
                    be:vat: '123456789'
                    global:email:
                    - john@example.com
                    global:phoneNumber:
                    - '+1234567890'
                  localIdentifier: Local123
                  assignedAccountId: Local123
                  alias: Sample Connection
                  connectionStatus: CONNECTED
                  relationType: SUPPLIER
                  addresses:
                    main:
                      streetName: Nitzsche Lodge
                      house: '80728'
                      postalCode: '3110'
                      city: Fernandahaven
                      country: Belgium
                      countryCode: BE
                  tags:
                  - tag1
                  - tag2
                  active: true
                  metadata:
                    channels:
                      main: delivery_on_platform
                      secondary: email
                    department: Accounting
                    logo: https://somelinks.com/logo.jpg
                    website: https://mycompanywebsite.com
                    notes: some notes
                    industry: Agriculture, Forestry And Fishing
                  spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                  createdAt: 2024-01-02 07:27:51.251000+00:00
                  legalName: Sample Business
                  tradeName: Trade Business
                  businessType: ENTERPRISE
                - type: person
                  id: 12345678-90ab-cdef-1234-567890abcdef
                  globalIdentifiers:
                    fr:siret: '12345678901234'
                    nl:kvk: '87654321'
                    be:vat: '123456789'
                    global:email:
                    - john@example.com
                    global:phoneNumber:
                    - '+1234567890'
                  localIdentifier: '001'
                  assignedAccountId: '001'
                  alias: Sample Person
                  connectionStatus: CONNECTED
                  relationType: CUSTOMER
                  addresses:
                    main:
                      streetName: Milo Crossroad
                      house: '7850'
                      postalCode: '3100'
                      city: Kubhaven
                      country: Belgium
                      countryCode: BE
                  tags:
                  - tag3
                  - tag4
                  active: false
                  metadata:
                    channels:
                      main: delivery_on_platform
                      secondary: email
                    department: Accounting
                    logo: https://somelinks.com/logo.jpg
                    website: https://mycompanywebsite.com
                    notes: some notes
                    industry: Agriculture, Forestry And Fishing
                  spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                  createdAt: 2024-01-02 07:27:51.251000+00:00
                  firstName: John
                  lastName: Doe
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 404
                error: NOT_FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: The HTTP method was not allowed on this endpoint.
        default:
          description: Other error messages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
      security:
      - oauth2:
        - space_read
    post:
      tags:
      - Connections
      summary: Create connection
      description: '<div class=''my-preview''><span>Preview: The API is in development
        or testing phases and the interface could still change slightly.</span></div>
        <br/> Create connection on the given space <br/> Scope: space_write'
      operationId: createConnection
      parameters:
      - name: spaceId
        in: path
        description: The space identifier
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        description: Connection to add
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectionRequest'
            examples:
              PersonConnection:
                description: PersonConnection
                value:
                  type: person
                  spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                  globalIdentifiers:
                    global:email:
                    - john@example.com
                    global:phoneNumber:
                    - '+1234567890'
                  assignedAccountId: '001'
                  alias: UP
                  connectionStatus: CONNECTED
                  relationType: CUSTOMER
                  addresses:
                    main:
                      streetName: Milo Crossroad
                      house: '7850'
                      postalCode: '3100'
                      city: Kubhaven
                      country: Belgium
                      countryCode: BE
                  tags:
                  - favorite
                  - liked
                  active: true
                  metadata:
                    channels:
                      main: delivery_on_platform
                      secondary: email
                    department: Accounting
                    logo: https://somelinks.com/logo.jpg
                    website: https://mycompanywebsite.com
                    notes: some notes
                    industry: Agriculture, Forestry And Fishing
                  firstName: John
                  lastName: Doe
              BusinessConnection:
                description: BusinessConnection
                value:
                  type: business
                  spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                  globalIdentifiers:
                    fr:siren: '530514157'
                    fr:siret: '53051415700029'
                    nl:kvk: '87654321'
                    be:en: 0400282475
                    be:vat: BE0400282475
                    global:email:
                    - john@example.com
                    global:phoneNumber:
                    - '+1234567890'
                  localIdentifier: '001'
                  assignedAccountId: '001'
                  alias: UP
                  connectionStatus: CONNECTED
                  relationType: CUSTOMER
                  addresses:
                    main:
                      streetName: Nitzsche Lodge
                      house: '80728'
                      postalCode: '3110'
                      city: Fernandahaven
                      country: Belgium
                      countryCode: BE
                  tags:
                  - favorite
                  - liked
                  active: true
                  metadata:
                    channels:
                      main: delivery_on_platform
                      secondary: email
                    department: Accounting
                    logo: https://somelinks.com/logo.jpg
                    website: https://mycompanywebsite.com
                    notes: some notes
                    industry: Agriculture, Forestry And Fishing
                  legalName: Unifiedpost Group
                  tradeName: unifiedpost
                  businessType: ENTERPRISE
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionDetailsResultWithPaymentAccounts'
              examples:
                Business Connection:
                  description: Business Connection
                  value:
                    type: business
                    id: 00000001-0000-0000-0000-000000000000
                    spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                    globalIdentifiers:
                      be:vat: '123456789'
                      fr:siret: '12345678901234'
                      global:email:
                      - john@example.com
                      global:phoneNumber:
                      - '00301234567'
                      nl:kvk: '87654321'
                    localIdentifier: '001'
                    assignedAccountId: '001'
                    alias: UP
                    connectionStatus: CONNECTED
                    relationType: CUSTOMER
                    addresses:
                      main:
                        streetName: Nitzsche Lodge
                        house: '80728'
                        postalCode: '3110'
                        city: Fernandahaven
                        country: Belgium
                        countryCode: BE
                    tags:
                    - favorite
                    - liked
                    active: true
                    metadata:
                      channels:
                        main: delivery_on_platform
                        secondary: email
                      department: Accounting
                      industry: Agriculture, Forestry And Fishing
                      logo: https://somelinks.com/logo.jpg
                      notes: some notes
                      website: https://mycompanywebsite.com
                    connectors:
                    - active: true
                      extensionId: 00000001-0001-0000-0000-000000000001
                      name: cross-peppol
                      namespace: com.unifiedpost.btx.connectors
                      settings:
                        peppolAccessPoint: access-point
                        peppolID: '12345'
                    paymentAccounts:
                    - id: 0ca2797b-6365-4bf2-a490-247075e3cede
                      identifier: BE19519469892112
                      scheme: IBAN
                      country: BE
                      currency: EUR
                      bank:
                        identifier: ABNABE2AIDJ
                        scheme: BIC
                      spaceId: 56079d21-a756-49fb-9286-9859c354aa69
                      ownedBySpace: true
                      active: true
                      ownerName: UP RO
                    legalName: Unifiedpost Group
                    tradeName: unifiedpost
                    businessType: ENTERPRISE
                Person Connection:
                  description: Person Connection
                  value:
                    type: person
                    id: 00000002-0000-0000-0000-000000000000
                    spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                    globalIdentifiers:
                      global:email:
                      - john@example.com
                      global:phoneNumber:
                      - '00301234567'
                    localIdentifier: '001'
                    assignedAccountId: '001'
                    alias: UP
                    connectionStatus: CONNECTED
                    relationType: CUSTOMER
                    addresses:
                      main:
                        streetName: Milo Crossroad
                        house: '7850'
                        postalCode: '3100'
                        city: Kubhaven
                        country: Belgium
                        countryCode: BE
                    tags:
                    - favorite
                    - liked
                    active: true
                    metadata:
                      channels:
                        main: delivery_on_platform
                        secondary: email
                      department: Accounting
                      industry: Agriculture, Forestry And Fishing
                      logo: https://somelinks.com/logo.jpg
                      notes: some notes
                      website: https://mycompanywebsite.com
                    connectors:
                    - active: true
                      name: email
                      settings:
                        emailAddress: john.doe@example.com
                    paymentAccounts:
                    - id: 0ca2797b-6365-4bf2-a490-247075e3cede
                      identifier: BE19519469892112
                      scheme: IBAN
                      country: BE
                      currency: EUR
                      bank:
                        identifier: ABNABE2AIDJ
                        scheme: BIC
                      spaceId: 56079d21-a756-49fb-9286-9859c354aa69
                      ownedBySpace: true
                      active: true
                      ownerName: UP RO
                    firstName: John
                    lastName: Doe
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
        default:
          description: Other error messages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
      security:
      - oauth2:
        - space_write
  /transaction/v1/spaces/{spaceId}/connections/{connectionId}:
    get:
      tags:
      - Connections
      summary: Get connection info
      description: '<div class=''my-preview''><span>Preview: The API is in development
        or testing phases and the interface could still change slightly.</span></div>
        <br/> Get connection information by its ID on the given space <br/> Scope:
        space_read'
      operationId: getConnection
      parameters:
      - name: spaceId
        in: path
        description: The space identifier
        required: true
        schema:
          type: string
          format: uuid
      - name: connectionId
        in: path
        description: The connection identifier
        required: true
        schema:
          type: string
          format: uuid
        example: 1d0159ca-ab19-49d5-9e13-9d34afb03849
      responses:
        '200':
          description: Ok. Connection info
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionDetailsResult'
              examples:
                Business Connection:
                  description: Business Connection
                  value:
                    type: business
                    id: 00000001-0000-0000-0000-000000000000
                    spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                    globalIdentifiers:
                      be:vat: '123456789'
                      fr:siret: '12345678901234'
                      global:email:
                      - john@example.com
                      global:phoneNumber:
                      - '00301234567'
                      nl:kvk: '87654321'
                    localIdentifier: '001'
                    assignedAccountId: '001'
                    alias: UP
                    connectionStatus: CONNECTED
                    relationType: CUSTOMER
                    addresses:
                      main:
                        streetName: Nitzsche Lodge
                        house: '80728'
                        postalCode: '3110'
                        city: Fernandahaven
                        country: Belgium
                        countryCode: BE
                    tags:
                    - favorite
                    - liked
                    active: true
                    metadata:
                      channels:
                        main: delivery_on_platform
                        secondary: email
                      department: Accounting
                      industry: Agriculture, Forestry And Fishing
                      logo: https://somelinks.com/logo.jpg
                      notes: some notes
                      website: https://mycompanywebsite.com
                    connectors:
                    - active: true
                      extensionId: 00000001-0001-0000-0000-000000000001
                      name: cross-peppol
                      namespace: com.unifiedpost.btx.connectors
                      settings:
                        peppolAccessPoint: access-point
                        peppolID: '12345'
                    legalName: Unifiedpost Group
                    tradeName: unifiedpost
                    businessType: ENTERPRISE
                Person Connection:
                  description: Person Connection
                  value:
                    type: person
                    id: 00000002-0000-0000-0000-000000000000
                    spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                    globalIdentifiers:
                      global:email:
                      - john@example.com
                      global:phoneNumber:
                      - '00301234567'
                    localIdentifier: '001'
                    assignedAccountId: '001'
                    alias: UP
                    connectionStatus: CONNECTED
                    relationType: CUSTOMER
                    addresses:
                      main:
                        streetName: Milo Crossroad
                        house: '7850'
                        postalCode: '3100'
                        city: Kubhaven
                        country: Belgium
                        countryCode: BE
                    tags:
                    - favorite
                    - liked
                    active: true
                    metadata:
                      channels:
                        main: delivery_on_platform
                        secondary: email
                      department: Accounting
                      industry: Agriculture, Forestry And Fishing
                      logo: https://somelinks.com/logo.jpg
                      notes: some notes
                      website: https://mycompanywebsite.com
                    connectors:
                    - active: true
                      name: email
                      settings:
                        emailAddress: john.doe@example.com
                    firstName: John
                    lastName: Doe
        '404':
          description: Not Found. Connection uuid must be invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 404
                error: NOT_FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: The HTTP method was not allowed on this endpoint.
        default:
          description: Other error messages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
      security:
      - oauth2:
        - space_read
    delete:
      tags:
      - Connections
      summary: Delete connection
      description: '<div class=''my-preview''><span>Preview: The API is in development
        or testing phases and the interface could still change slightly.</span></div>
        <br/> Delete connection by its ID on the given space <br/> Scope: space_write'
      operationId: deleteConnection
      parameters:
      - name: spaceId
        in: path
        description: The space identifier
        required: true
        schema:
          type: string
          format: uuid
      - name: connectionId
        in: path
        description: The connection identifier
        required: true
        schema:
          type: string
          format: uuid
        example: 1d0159ca-ab19-49d5-9e13-9d34afb03849
      responses:
        '204':
          description: Ok.
        '404':
          description: UUID not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 404
                error: NOT_FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: The HTTP method was not allowed on this endpoint.
        default:
          description: Other error messages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
      security:
      - oauth2:
        - space_write
    patch:
      tags:
      - Connections
      summary: Update connection
      description: '<div class=''my-preview''><span>Preview: The API is in development
        or testing phases and the interface could still change slightly.</span></div>
        <br/> Update connection by its ID on the given space <br/> Scope: space_write'
      operationId: updateConnection
      parameters:
      - name: spaceId
        in: path
        description: The space identifier
        required: true
        schema:
          type: string
          format: uuid
      - name: connectionId
        in: path
        description: The connection identifier
        required: true
        schema:
          type: string
          format: uuid
        example: 1d0159ca-ab19-49d5-9e13-9d34afb03849
      requestBody:
        description: Connection data to update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateConnectionRequest'
            examples:
              Update Person Connection Request:
                description: Update Person Connection Request
                value:
                  type: person
                  spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                  globalIdentifiers:
                    global:email:
                    - john@example.com
                    global:phoneNumber:
                    - '+1234567890'
                  assignedAccountId: '001'
                  alias: Johnny
                  connectionStatus: CONNECTED
                  relationType: CUSTOMER
                  addresses:
                    main:
                      streetName: Milo Crossroad
                      house: '7850'
                      postalCode: '3100'
                      city: Kubhaven
                      country: Belgium
                      countryCode: BE
                  tags:
                  - favorite
                  - liked
                  active: true
                  metadata:
                    channels:
                      main: delivery_on_platform
                      secondary: email
                    department: Accounting
                    logo: https://somelinks.com/logo.jpg
                    website: https://mycompanywebsite.com
                    notes: some notes
                    industry: Agriculture, Forestry And Fishing
                  firstName: Joan
                  lastName: Doe
              Update Business Connection Request:
                description: Update Business Connection Request
                value:
                  type: business
                  spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                  globalIdentifiers:
                    fr:siret: '53051415700029'
                    nl:kvk: '87654321'
                    be:vat: BE0400282475
                    global:email:
                    - john@example.com
                    global:phoneNumber:
                    - '+1234567890'
                  localIdentifier: '001'
                  assignedAccountId: '001'
                  alias: UP
                  connectionStatus: CONNECTED
                  relationType: SUPPLIER
                  addresses:
                    main:
                      streetName: Nitzsche Lodge
                      house: '80728'
                      postalCode: '3110'
                      city: Fernandahaven
                      country: Belgium
                      countryCode: BE
                  tags:
                  - favorite
                  - liked
                  active: true
                  metadata:
                    channels:
                      main: delivery_on_platform
                      secondary: email
                    department: Accounting
                    logo: https://somelinks.com/logo.jpg
                    website: https://mycompanywebsite.com
                    notes: some notes
                    industry: Agriculture, Forestry And Fishing
                  legalName: Unifiedpost Group
                  tradeName: unifiedpost
                  businessType: ENTERPRISE
        required: true
      responses:
        '200':
          description: Update connection successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionDetailsResult'
              examples:
                Business Connection:
                  description: Business Connection
                  value:
                    type: business
                    id: 00000001-0000-0000-0000-000000000000
                    spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                    globalIdentifiers:
                      be:vat: '123456789'
                      fr:siret: '12345678901234'
                      global:email:
                      - john@example.com
                      global:phoneNumber:
                      - '00301234567'
                      nl:kvk: '87654321'
                    localIdentifier: '001'
                    assignedAccountId: '001'
                    alias: UP
                    connectionStatus: CONNECTED
                    relationType: CUSTOMER
                    addresses:
                      main:
                        streetName: Nitzsche Lodge
                        house: '80728'
                        postalCode: '3110'
                        city: Fernandahaven
                        country: Belgium
                        countryCode: BE
                    tags:
                    - favorite
                    - liked
                    active: true
                    metadata:
                      channels:
                        main: delivery_on_platform
                        secondary: email
                      department: Accounting
                      industry: Agriculture, Forestry And Fishing
                      logo: https://somelinks.com/logo.jpg
                      notes: some notes
                      website: https://mycompanywebsite.com
                    connectors:
                    - active: true
                      extensionId: 00000001-0001-0000-0000-000000000001
                      name: cross-peppol
                      namespace: com.unifiedpost.btx.connectors
                      settings:
                        peppolAccessPoint: access-point
                        peppolID: '12345'
                    legalName: Unifiedpost Group
                    tradeName: unifiedpost
                    businessType: ENTERPRISE
                Person Connection:
                  description: Person Connection
                  value:
                    type: person
                    id: 00000002-0000-0000-0000-000000000000
                    spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                    globalIdentifiers:
                      global:email:
                      - john@example.com
                      global:phoneNumber:
                      - '00301234567'
                    localIdentifier: '001'
                    assignedAccountId: '001'
                    alias: UP
                    connectionStatus: CONNECTED
                    relationType: CUSTOMER
                    addresses:
                      main:
                        streetName: Milo Crossroad
                        house: '7850'
                        postalCode: '3100'
                        city: Kubhaven
                        country: Belgium
                        countryCode: BE
                    tags:
                    - favorite
                    - liked
                    active: true
                    metadata:
                      channels:
                        main: delivery_on_platform
                        secondary: email
                      department: Accounting
                      industry: Agriculture, Forestry And Fishing
                      logo: https://somelinks.com/logo.jpg
                      notes: some notes
                      website: https://mycompanywebsite.com
                    connectors:
                    - active: true
                      name: email
                      settings:
                        emailAddress: john.doe@example.com
                    firstName: John
                    lastName: Doe
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
        '404':
          description: Connection UUID could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 404
                error: NOT_FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: The HTTP method was not allowed on this endpoint.
        default:
          description: Other error messages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
      security:
      - oauth2:
        - space_write
  /transaction/v1/spaces/{spaceId}/connections/{connectionId}/paymentAccounts:
    get:
      tags:
      - Connections
      summary: Get payment accounts for connection owned by space
      description: '<div class=''my-preview''><span>Preview: The API is in development
        or testing phases and the interface could still change slightly.</span></div>
        <br/> Get list of payment accounts for connection owned by space <br/> Scope:
        space_read'
      operationId: getAllConnectionPaymentAccounts
      parameters:
      - name: spaceId
        in: path
        description: The space identifier
        required: true
        schema:
          type: string
          format: uuid
      - name: connectionId
        in: path
        description: The connection uuid identifier
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AllPaymentAccountsResult'
              example:
                paymentAccounts:
                - id: 0ca2797b-6365-4bf2-a490-247075e3cede
                  identifier: BE19519469892112
                  scheme: IBAN
                  country: BE
                  currency: EUR
                  bank:
                    identifier: ABNABE2AIDJ
                    scheme: BIC
                  spaceId: 56079d21-a756-49fb-9286-9859c354aa69
                  connections:
                  - id: 3b0291e3-2a54-487f-8563-57391ef8535e
                    type: person
                    name: John Doe
                    alias: Johnny
                    defaultPaymentAccount: true
                  address:
                    country: BE
                    townName: Gent
                    addressType: BIZZ
                    streetName: Kortrijksesteenweg
                    buildingNumber: '1146'
                    postCode: '9051'
                  createdAt: 2023-10-04 14:20:31.502921+00:00
                  updatedAt: 2023-10-04 14:20:31.502921+00:00
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 404
                error: NOT_FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: The HTTP method was not allowed on this endpoint.
        default:
          description: Other error messages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
      security:
      - oauth2:
        - space_read
    post:
      tags:
      - Connections
      summary: Create payment account for connection owned by space
      description: '<div class=''my-preview''><span>Preview: The API is in development
        or testing phases and the interface could still change slightly.</span></div>
        <br/> Create the payment account for connection owned by space <br/> Scope:
        space_write'
      operationId: createConnectionPaymentAccount
      parameters:
      - name: spaceId
        in: path
        description: The space identifier
        required: true
        schema:
          type: string
          format: uuid
      - name: connectionId
        in: path
        description: The connection uuid identifier
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        description: Payment account to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectionPaymentAccountRequest'
            example:
              identifier: BE19519469892112
              scheme: IBAN
              bank:
                identifier: ABNABE2AIDJ
                scheme: BIC
              country: BE
              currency: EUR
              ownedBySpace: true
              active: true
              isDefault: true
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentAccountResult'
              example:
                id: 0ca2797b-6365-4bf2-a490-247075e3cede
                identifier: BE19519469892112
                scheme: IBAN
                country: BE
                currency: EUR
                bank:
                  identifier: ABNABE2AIDJ
                  scheme: BIC
                spaceId: 56079d21-a756-49fb-9286-9859c354aa69
                ownedBySpace: true
                active: true
                ownerName: UP RO
                connections:
                - id: 3b0291e3-2a54-487f-8563-57391ef8535e
                  type: person
                  name: John Doe
                  alias: Johnny
                  defaultPaymentAccount: true
                createdAt: 2023-10-04 14:20:31.502921+00:00
                updatedAt: 2023-10-04 14:20:31.502921+00:00
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 404
                error: NOT_FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: The HTTP method was not allowed on this endpoint.
        default:
          description: Other error messages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
      security:
      - oauth2:
        - space_write
  /transaction/v1/spaces/{spaceId}/connections/{connectionId}/paymentAccounts/{paymentAccountId}:
    patch:
      tags:
      - Connections
      summary: Update payment account in context of connection
      description: '<div class=''my-preview''><span>Preview: The API is in development
        or testing phases and the interface could still change slightly.</span></div>
        <br/> Allow to set the default flag and ownerName of connection payment account
        <br/> Scope: space_write'
      operationId: updateConnectionPaymentAccount
      parameters:
      - name: spaceId
        in: path
        description: The space identifier
        required: true
        schema:
          type: string
          format: uuid
      - name: connectionId
        in: path
        description: The connection identifier
        required: true
        schema:
          type: string
          format: uuid
        example: 1d0159ca-ab19-49d5-9e13-9d34afb03849
      - name: paymentAccountId
        in: path
        required: true
        schema:
          type: string
          format: uuid
        example: 1d0159ca-ab19-49d5-9e13-9d34afb03849
      requestBody:
        description: Default payment account data
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateConnectionPaymentAccountRequest'
            examples:
              Update default payment account Request:
                description: Update default payment account Request
                value:
                  ownerName: New owner
                  isDefault: true
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionPaymentAccountListItem'
              example: "{\n\"id\" : \"0ca2797b-6365-4bf2-a490-247075e3cede\",\n\"\
                identifier\" : \"BE19519469892112\",\n\"scheme\" : \"IBAN\",\n\"country\"\
                \ : \"BE\",\n\"currency\" : \"EUR\",\n\"bank\" : {\n\t\"scheme\" :\
                \ \"BIC\",\n\t\"identifier\" : \"ABNABE2AIDJ\"\n}\n\"spaceId\" : \"\
                56079d21-a756-49fb-9286-9859c354aa69\",\n\"ownedBySpace\" : true,\n\
                \"active\" : true,\n\"ownerName\" : \"UP RO\",\n\"address\": {\n\t\
                \"country\": \"BE\",\n\t\"townName\": \"Gent\",\n\t\"addressType\"\
                : \"BIZZ\",\n\t\"streetName\": \"Kortrijksesteenweg\",\n\t\"buildingNumber\"\
                : \"1146\",\n\t\"postCode\": \"9051\"\n},\n\"isDefault\": true\n}"
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
        '404':
          description: Connection UUID could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 404
                error: NOT_FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: The HTTP method was not allowed on this endpoint.
        default:
          description: Other error messages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
      security:
      - oauth2:
        - space_write
  /transaction/v1/spaces/{spaceId}/connections/{connectionId}/taxInfo:
    get:
      tags:
      - Connections
      summary: Get tax information
      description: '<div class=''my-preview''><span>Preview: The API is in development
        or testing phases and the interface could still change slightly.</span></div>
        <br/> Retrieve the tax information associated with the given connection <br/>
        Scope: space_read'
      operationId: getTaxInfo
      parameters:
      - name: spaceId
        in: path
        description: The space identifier
        required: true
        schema:
          type: string
          format: uuid
      - name: connectionId
        in: path
        description: The connection identifier
        required: true
        schema:
          type: string
          format: uuid
      - name: includeTaxRegistrations
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaxInfoResult'
              example:
                id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                corporateId: corporate456
                b2cIndicator: true
                customerClassification: '1'
                taxRegistrations:
                - id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                  taxId: DE44444444
                  country: US
                  type: Corporate
                  voluntaryTax: true
                  oss: false
                  startDate: 2024-01-23
                  endDate: 2025-01-23
                  vatGroup:
                    name: Retail company 1
                    startDate: 2024-01-23
                    endDate: 2025-01-23
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
        default:
          description: Other error messages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
      security:
      - oauth2:
        - space_read
    post:
      tags:
      - Connections
      summary: Create tax information
      description: '<div class=''my-preview''><span>Preview: The API is in development
        or testing phases and the interface could still change slightly.</span></div>
        <br/> Store Valitax specific Connection information <br/> Scope: space_write'
      operationId: createConnectionTaxInfo
      parameters:
      - name: spaceId
        in: path
        description: The space identifier
        required: true
        schema:
          type: string
          format: uuid
      - name: connectionId
        in: path
        description: The connection identifier
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        description: Tax Information to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaxInfoRequest'
            example:
              corporateId: corporate456
              b2cIndicator: true
              customerClassification: '1'
              smallEnterprise: true
              businessUnit: HEAD_OFFICE
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaxInfoResult'
              example:
                id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                corporateId: corporate456
                b2cIndicator: true
                customerClassification: '1'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
        default:
          description: Other error messages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
      security:
      - oauth2:
        - space_write
    delete:
      tags:
      - Connections
      summary: Delete tax information
      description: "<div class='my-preview'><span>Preview: The API is in development\
        \ or testing phases and the interface could still change slightly.</span></div>\
        \ <br/> Delete tax information associated for the connection in the given\
        \ space. Will cascade delete tax registrations.\n <br/> Scope: space_write"
      operationId: deleteTaxInfo
      parameters:
      - name: spaceId
        in: path
        description: The space identifier
        required: true
        schema:
          type: string
          format: uuid
      - name: connectionId
        in: path
        description: The connection identifier
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 404
                error: NOT_FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: The HTTP method was not allowed on this endpoint.
        default:
          description: Other error messages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
      security:
      - oauth2:
        - space_write
    patch:
      tags:
      - Connections
      summary: Update tax information
      description: '<div class=''my-preview''><span>Preview: The API is in development
        or testing phases and the interface could still change slightly.</span></div>
        <br/> Update tax information <br/> Scope: space_write'
      operationId: updateTaxInfo
      parameters:
      - name: spaceId
        in: path
        description: The space identifier
        required: true
        schema:
          type: string
          format: uuid
      - name: connectionId
        in: path
        description: The connection identifier
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        description: Tax information to update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaxInfoRequest'
            example:
              corporateId: corporate456
              b2cIndicator: true
              customerClassification: '1'
              smallEnterprise: true
              businessUnit: HEAD_OFFICE
        required: true
      responses:
        '200':
          description: Tax information updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaxInfoResult'
              example:
                id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                corporateId: corporate456
                b2cIndicator: true
                customerClassification: '1'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 404
                error: NOT_FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: The HTTP method was not allowed on this endpoint.
        default:
          description: Other error messages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
      security:
      - oauth2:
        - space_write
  /transaction/v1/spaces/{spaceId}/connections/{connectionId}/taxRegistrations:
    post:
      tags:
      - Connections
      summary: Create tax registration
      description: '<div class=''my-preview''><span>Preview: The API is in development
        or testing phases and the interface could still change slightly.</span></div>
        <br/> Create connection''s VAT registration <br/> Scope: space_write'
      operationId: createTaxRegistration
      parameters:
      - name: spaceId
        in: path
        description: The space identifier
        required: true
        schema:
          type: string
          format: uuid
      - name: connectionId
        in: path
        description: The connection identifier
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        description: Tax Information to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaxRegistrationRequest'
            example:
              taxId: DE44444444
              country: US
              type: Corporate
              voluntaryTax: true
              oss: false
              startDate: 2024-01-23
              endDate: 2025-01-23
              vatGroup:
                name: Retail company 1
                startDate: 2024-01-23
                endDate: 2025-01-23
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaxRegistrationResult'
              example:
                id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                taxId: DE44444444
                country: US
                type: Corporate
                voluntaryTax: true
                oss: false
                startDate: 2024-01-23
                endDate: 2025-01-23
                vatGroup:
                  name: Retail company 1
                  startDate: 2024-01-23
                  endDate: 2025-01-23
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
        default:
          description: Other error messages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
      security:
      - oauth2:
        - space_write
  /transaction/v1/spaces/{spaceId}/connections/{connectionId}/taxRegistrations/{taxRegistrationId}:
    delete:
      tags:
      - Connections
      summary: Delete tax registration of a connection
      description: "<div class='my-preview'><span>Preview: The API is in development\
        \ or testing phases and the interface could still change slightly.</span></div>\
        \ <br/> Delete tax registration by ID.\n <br/> Scope: space_write"
      operationId: deleteTaxRegistration
      parameters:
      - name: spaceId
        in: path
        description: The space identifier
        required: true
        schema:
          type: string
          format: uuid
      - name: connectionId
        in: path
        description: The connection identifier
        required: true
        schema:
          type: string
          format: uuid
      - name: taxRegistrationId
        in: path
        description: The tax registration identifier
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 404
                error: NOT_FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: The HTTP method was not allowed on this endpoint.
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 409
                error: ABORTED
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Conflict
                detail: Specific detail about what could not be done.
        default:
          description: Other error messages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
      security:
      - oauth2:
        - space_write
    patch:
      tags:
      - Connections
      summary: Update tax registration
      description: '<div class=''my-preview''><span>Preview: The API is in development
        or testing phases and the interface could still change slightly.</span></div>
        <br/> Update connection''s VAT registration <br/> Scope: space_write'
      operationId: updateTaxRegistration
      parameters:
      - name: spaceId
        in: path
        description: The space identifier
        required: true
        schema:
          type: string
          format: uuid
      - name: connectionId
        in: path
        description: The connection identifier
        required: true
        schema:
          type: string
          format: uuid
      - name: taxRegistrationId
        in: path
        description: The tax registration identifier
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        description: Tax Registration to update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaxRegistrationRequest'
            example:
              taxId: DE44444444
              country: US
              type: Corporate
              voluntaryTax: true
              oss: false
              startDate: 2024-01-23
              endDate: 2025-01-23
              vatGroup:
                name: Retail company 1
                startDate: 2024-01-23
                endDate: 2025-01-23
        required: true
      responses:
        '200':
          description: Update tax registration successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaxRegistrationResult'
              example:
                id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                taxId: DE44444444
                country: US
                type: Corporate
                voluntaryTax: true
                oss: false
                startDate: 2024-01-23
                endDate: 2025-01-23
                vatGroup:
                  name: Retail company 1
                  startDate: 2024-01-23
                  endDate: 2025-01-23
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
        default:
          description: Other error messages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
      security:
      - oauth2:
        - space_write
  /transaction/v2/spaces/{spaceId}/connections:
    get:
      tags:
      - Connections
      summary: Get list of connections v2
      description: "<div class='my-preview'><span>Preview: The API is in development\
        \ or testing phases and the interface could still change slightly.</span></div>\
        \ <br/> \tGet list of connections v2 on the given space with optional filtering\
        \ by identifiers.\n\tThe API supports pagination and sorting.\n <br/> Scope:\
        \ space_read"
      operationId: listConnectionsV2
      parameters:
      - name: filter
        in: query
        schema:
          $ref: '#/components/schemas/ListConnectionsQueryParamsSingle'
      - name: spaceId
        in: path
        description: The space identifier
        required: true
        schema:
          type: string
          format: uuid
      - name: type
        in: query
        description: List of connection type for searching. Can be multiple values
          separated by comma, or just one value
        explode: false
        schema:
          type: array
          items:
            type: string
        example: business,person
      - name: businessType
        in: query
        description: List of business type for searching. Can be multiple values separated
          by comma, or just one value
        explode: false
        schema:
          type: array
          items:
            type: string
        example: ENTERPRISE,GOVERNMENT
      - name: ql
        in: query
        description: "\tBTX Query Language filter expression. Examples:\n\t- type=business\
          \ (or type[eq]=business or type[in]=(business))\n\t- connectionStatus=CONNECTED\
          \ (or connectionStatus[in]=(CONNECTED,PENDING), connectionStatus[not_in]=(DISCONNECTED))\n\
          \ \t- businessType=ENTERPRISE (or businessType[eq]=ENTERPRISE)\n\t- addresses.main.countryCode=BE\n\
          \ \t- assignedAccountId=\"00044\" (or assignedAccountId[cont]=\"00044\"\
          )\n \t- globalIdentifiers.\"be:en\"=\"0400282475\" (or globalIdentifiers.\"\
          be:en\"[eq]=\"0400282475\")\n\t- metadata.selfBilling.customer.mandate=true\n\
          \ \t- relationTypes[in]=(CUSTOMER,SUPPLIER)\n\t- tags[in]=(first_tag,second_tag)\n"
        schema:
          type: string
      - name: identifierKeyValue
        in: query
        description: Connection identifier (e.g. VAT number)
        schema:
          type: array
          items:
            type: string
      - name: metadata
        in: query
        description: "\tAllows filtering connections by nested metadata fields.\n\t\
          \ Example:\n\tGiven the following metadata:\n\t{\n\t\t\"metadata\": {\n\t\
          \t\t\"selfBilling\": {\n\t\t\t\t\"customer\": { \"mandate\": true },\n\t\
          \t\t\t\"supplier\": { \"mandate\": false }\n\t\t\t}\n\t\t}\n\t}\n\tTo filter\
          \ by connections where selfBilling.customer.mandate is true, send the query\
          \ parameter:\n\t?metadata=selfBilling.customer.mandate=true\n"
        schema:
          type: array
          items:
            type: string
        example: metadata=selfBilling.customer.mandate=true
      - name: relationTypes
        in: query
        description: Relation Types for searching. Can be multiple values separated
          by comma, or just one value.
        explode: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/ConnectionRelationType'
        example: CUSTOMER,PARTNER
      - name: tags
        in: query
        description: Filter by tags. Can be an array to filter by all tags (AND) -
          e.g. ?tags=first_tag&tags=second_tag. Or it could be a comma-separated list
          to filter by any of the values (OR) - e.g. ?tags=first_tag,second_tag.
        schema:
          type: array
          items:
            type: string
        example:
        - first_tag
        - second_tag
        - third_tag
      - name: include
        in: query
        description: What extra data to include in the response.
        explode: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/ConnectionInclude'
        example: paymentAccounts
      - name: connectorsKeyValue
        in: query
        description: Connectors data (key value)
        schema:
          type: array
          items:
            type: string
        example: connectorsKeyValue=name=email&connectorsKeyValue=active=true
      - name: page
        in: query
        description: Zero-based page index, cannot be negative, default 0
        schema:
          maximum: 10737418
          minimum: 0
          type: integer
          format: int32
          default: 0
        example: 20
      - name: pageSize
        in: query
        description: 'Page size. Minimum 1, maximum: 200, default 20'
        schema:
          maximum: 200
          minimum: 1
          type: integer
          format: int32
          default: 20
        example: 20
      - name: includeTotalElements
        in: query
        description: Return the totalElements number of entries in the response
        schema:
          type: boolean
        example: true
      - name: onlyCount
        in: query
        description: Return ONLY the totalElements number of entries in the response.
        schema:
          type: boolean
        example: true
      - name: sortBy
        in: query
        description: Sorting criteria
        schema:
          type: string
          enum:
          - createdAt
          - createdAt.asc
          - createdAt.desc
          - name
          - name.asc
          - name.desc
          - type
          - type.asc
          - type.desc
          - assignedAccountId
          - assignedAccountId.asc
          - assignedAccountId.desc
          - businessType
          - businessType.asc
          - businessType.desc
        example: createdAt.asc
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListConnectionsResponseV2'
              example:
                connections:
                - type: business
                  id: 0ca2797b-6365-4bf2-a490-247075e3cede
                  globalIdentifiers:
                    fr:siret: '12345678901234'
                    nl:kvk: '87654321'
                    be:vat: '123456789'
                    global:email:
                    - john@example.com
                    global:phoneNumber:
                    - '+1234567890'
                  assignedAccountId: Local123
                  alias: Sample Connection
                  connectionStatus: CONNECTED
                  relationTypes:
                  - SUPPLIER
                  addresses:
                    main:
                      streetName: Nitzsche Lodge
                      house: '80728'
                      postalCode: '3110'
                      city: Fernandahaven
                      country: Belgium
                      countryCode: BE
                  tags:
                  - tag1
                  - tag2
                  active: true
                  metadata:
                    channels:
                      main: delivery_on_platform
                      secondary: email
                    department: Accounting
                    logo: https://somelinks.com/logo.jpg
                    website: https://mycompanywebsite.com
                    notes: some notes
                    industry: Agriculture, Forestry And Fishing
                  spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                  createdAt: 2024-01-02 07:27:51.251000+00:00
                  legalName: Sample Business
                  tradeName: Trade Business
                  businessType: ENTERPRISE
                - type: person
                  id: 12345678-90ab-cdef-1234-567890abcdef
                  globalIdentifiers:
                    fr:siret: '12345678901234'
                    nl:kvk: '87654321'
                    be:vat: '123456789'
                    global:email:
                    - john@example.com
                    global:phoneNumber:
                    - '+1234567890'
                  assignedAccountId: '001'
                  alias: Sample Person
                  connectionStatus: CONNECTED
                  relationTypes:
                  - CUSTOMER
                  addresses:
                    main:
                      streetName: Milo Crossroad
                      house: '7850'
                      postalCode: '3100'
                      city: Kubhaven
                      country: Belgium
                      countryCode: BE
                  tags:
                  - tag3
                  - tag4
                  active: false
                  metadata:
                    channels:
                      main: delivery_on_platform
                      secondary: email
                    department: Accounting
                    logo: https://somelinks.com/logo.jpg
                    website: https://mycompanywebsite.com
                    notes: some notes
                    industry: Agriculture, Forestry And Fishing
                  spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                  createdAt: 2024-01-02 07:27:51.251000+00:00
                  firstName: John
                  lastName: Doe
                totalElements: 1
                currentPage: 0
                pageSize: 20
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 404
                error: NOT_FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: The HTTP method was not allowed on this endpoint.
        default:
          description: Other error messages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
      security:
      - oauth2:
        - space_read
    post:
      tags:
      - Connections
      summary: Create connection v2
      description: '<div class=''my-preview''><span>Preview: The API is in development
        or testing phases and the interface could still change slightly.</span></div>
        <br/> Create connection v2 on the given space <br/> Scope: space_write'
      operationId: createConnectionV2
      parameters:
      - name: spaceId
        in: path
        description: The space identifier
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        description: Connection to add
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectionRequestV2'
            examples:
              PersonConnection:
                description: PersonConnection
                value:
                  type: person
                  spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                  globalIdentifiers:
                    global:email:
                    - john@example.com
                    global:phoneNumber:
                    - '+1234567890'
                  assignedAccountId: '001'
                  alias: UP
                  connectionStatus: CONNECTED
                  relationTypes:
                  - CUSTOMER
                  addresses:
                    main:
                      streetName: Milo Crossroad
                      house: '7850'
                      postalCode: '3100'
                      city: Kubhaven
                      country: Belgium
                      countryCode: BE
                  tags:
                  - favorite
                  - liked
                  active: true
                  metadata:
                    channels:
                      main: delivery_on_platform
                      secondary: email
                    department: Accounting
                    logo: https://somelinks.com/logo.jpg
                    website: https://mycompanywebsite.com
                    notes: some notes
                    industry: Agriculture, Forestry And Fishing
                  connectors:
                  - active: true
                    extensionId: 00000001-0001-0000-0000-000000000001
                    name: cross-peppol
                    namespace: com.unifiedpost.btx.connectors
                    settings:
                      peppolAccessPoint: access-point
                      peppolID: '12345'
                  firstName: John
                  lastName: Doe
              BusinessConnection:
                description: BusinessConnection
                value:
                  type: business
                  spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                  globalIdentifiers:
                    fr:siren: '530514157'
                    fr:siret: '53051415700029'
                    nl:kvk: '87654321'
                    be:en: 0400282475
                    be:vat: BE0400282475
                    global:email:
                    - john@example.com
                    global:phoneNumber:
                    - '+1234567890'
                  assignedAccountId: '001'
                  alias: UP
                  connectionStatus: CONNECTED
                  relationTypes:
                  - CUSTOMER
                  addresses:
                    main:
                      streetName: Nitzsche Lodge
                      house: '80728'
                      postalCode: '3110'
                      city: Fernandahaven
                      country: Belgium
                      countryCode: BE
                  tags:
                  - favorite
                  - liked
                  active: true
                  metadata:
                    paymentTerms:
                      defaultDuePeriod: P0D
                      isEndOfMonth: true
                    paymentMethod: '31'
                    channels:
                      main: delivery_on_platform
                      secondary: email
                    department: Accounting
                    logo: https://somelinks.com/logo.jpg
                    website: https://mycompanywebsite.com
                    notes: some notes
                    industry: Agriculture, Forestry And Fishing
                  connectors:
                  - active: true
                    extensionId: 00000001-0001-0000-0000-000000000001
                    name: cross-peppol
                    namespace: com.unifiedpost.btx.connectors
                    settings:
                      peppolAccessPoint: access-point
                      peppolID: '12345'
                  legalName: Unifiedpost Group
                  tradeName: unifiedpost
                  businessType: ENTERPRISE
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionV2'
              examples:
                Business Connection:
                  description: Business Connection
                  value:
                    type: business
                    id: 00000001-0000-0000-0000-000000000000
                    spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                    globalIdentifiers:
                      be:vat: '123456789'
                      fr:siret: '12345678901234'
                      global:email:
                      - john@example.com
                      global:phoneNumber:
                      - '00301234567'
                      nl:kvk: '87654321'
                    assignedAccountId: '001'
                    alias: UP
                    connectionStatus: CONNECTED
                    relationTypes:
                    - CUSTOMER
                    addresses:
                      main:
                        streetName: Nitzsche Lodge
                        house: '80728'
                        postalCode: '3110'
                        city: Fernandahaven
                        country: Belgium
                        countryCode: BE
                    tags:
                    - favorite
                    - liked
                    active: true
                    metadata:
                      channels:
                        main: delivery_on_platform
                        secondary: email
                      department: Accounting
                      industry: Agriculture, Forestry And Fishing
                      logo: https://somelinks.com/logo.jpg
                      notes: some notes
                      website: https://mycompanywebsite.com
                    connectors:
                    - active: true
                      extensionId: 00000001-0001-0000-0000-000000000001
                      name: cross-peppol
                      namespace: com.unifiedpost.btx.connectors
                      settings:
                        peppolAccessPoint: access-point
                        peppolID: '12345'
                    paymentAccounts:
                    - id: 0ca2797b-6365-4bf2-a490-247075e3cede
                      identifier: BE19519469892112
                      scheme: IBAN
                      country: BE
                      currency: EUR
                      bank:
                        identifier: ABNABE2AIDJ
                        scheme: BIC
                      spaceId: 56079d21-a756-49fb-9286-9859c354aa69
                      ownedBySpace: true
                      active: true
                      ownerName: UP RO
                      isDefault: true
                    legalName: Unifiedpost Group
                    tradeName: unifiedpost
                    businessType: ENTERPRISE
                Person Connection:
                  description: Person Connection
                  value:
                    type: person
                    id: 00000002-0000-0000-0000-000000000000
                    spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                    globalIdentifiers:
                      global:email:
                      - john@example.com
                      global:phoneNumber:
                      - '00301234567'
                    assignedAccountId: '001'
                    alias: UP
                    connectionStatus: CONNECTED
                    relationTypes:
                    - CUSTOMER
                    addresses:
                      main:
                        streetName: Milo Crossroad
                        house: '7850'
                        postalCode: '3100'
                        city: Kubhaven
                        country: Belgium
                        countryCode: BE
                    tags:
                    - favorite
                    - liked
                    active: true
                    metadata:
                      channels:
                        main: delivery_on_platform
                        secondary: email
                      department: Accounting
                      industry: Agriculture, Forestry And Fishing
                      logo: https://somelinks.com/logo.jpg
                      notes: some notes
                      website: https://mycompanywebsite.com
                    connectors:
                    - active: true
                      name: email
                      settings:
                        emailAddress: john.doe@example.com
                    paymentAccounts:
                    - id: 0ca2797b-6365-4bf2-a490-247075e3cede
                      identifier: BE19519469892112
                      scheme: IBAN
                      country: BE
                      currency: EUR
                      bank:
                        identifier: ABNABE2AIDJ
                        scheme: BIC
                      spaceId: 56079d21-a756-49fb-9286-9859c354aa69
                      ownedBySpace: true
                      active: true
                      ownerName: UP RO
                      isDefault: true
                    firstName: John
                    lastName: Doe
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
        default:
          description: Other error messages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
      security:
      - oauth2:
        - space_write
  /transaction/v2/spaces/{spaceId}/connections/{connectionId}:
    get:
      tags:
      - Connections
      summary: Get connection info v2
      description: '<div class=''my-preview''><span>Preview: The API is in development
        or testing phases and the interface could still change slightly.</span></div>
        <br/> Get connection information v2 by its ID on the given space <br/> Scope:
        space_read'
      operationId: getConnectionV2
      parameters:
      - name: spaceId
        in: path
        description: The space identifier
        required: true
        schema:
          type: string
          format: uuid
      - name: connectionId
        in: path
        description: The connection identifier
        required: true
        schema:
          type: string
          format: uuid
        example: 1d0159ca-ab19-49d5-9e13-9d34afb03849
      - name: include
        in: query
        description: What extra data to include in the response.
        explode: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/ConnectionInclude'
        example: paymentAccounts
      responses:
        '200':
          description: Ok. Connection info
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionV2'
              examples:
                Business Connection:
                  description: Business Connection
                  value:
                    type: business
                    id: 00000001-0000-0000-0000-000000000000
                    spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                    globalIdentifiers:
                      be:vat: '123456789'
                      fr:siret: '12345678901234'
                      global:email:
                      - john@example.com
                      global:phoneNumber:
                      - '00301234567'
                      nl:kvk: '87654321'
                    assignedAccountId: '001'
                    alias: UP
                    connectionStatus: CONNECTED
                    relationTypes:
                    - CUSTOMER
                    addresses:
                      main:
                        streetName: Nitzsche Lodge
                        house: '80728'
                        postalCode: '3110'
                        city: Fernandahaven
                        country: Belgium
                        countryCode: BE
                    tags:
                    - favorite
                    - liked
                    active: true
                    metadata:
                      channels:
                        main: delivery_on_platform
                        secondary: email
                      department: Accounting
                      industry: Agriculture, Forestry And Fishing
                      logo: https://somelinks.com/logo.jpg
                      notes: some notes
                      website: https://mycompanywebsite.com
                    connectors:
                    - active: true
                      extensionId: 00000001-0001-0000-0000-000000000001
                      name: cross-peppol
                      namespace: com.unifiedpost.btx.connectors
                      settings:
                        peppolAccessPoint: access-point
                        peppolID: '12345'
                    paymentAccounts:
                    - id: 0ca2797b-6365-4bf2-a490-247075e3cede
                      identifier: BE19519469892112
                      scheme: IBAN
                      country: BE
                      currency: EUR
                      bank:
                        identifier: ABNABE2AIDJ
                        scheme: BIC
                      spaceId: 56079d21-a756-49fb-9286-9859c354aa69
                      ownedBySpace: true
                      active: true
                      ownerName: UP RO
                      isDefault: true
                    legalName: Unifiedpost Group
                    tradeName: unifiedpost
                    businessType: ENTERPRISE
                Person Connection:
                  description: Person Connection
                  value:
                    type: person
                    id: 00000002-0000-0000-0000-000000000000
                    spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                    globalIdentifiers:
                      global:email:
                      - john@example.com
                      global:phoneNumber:
                      - '00301234567'
                    assignedAccountId: '001'
                    alias: UP
                    connectionStatus: CONNECTED
                    relationTypes:
                    - CUSTOMER
                    addresses:
                      main:
                        streetName: Milo Crossroad
                        house: '7850'
                        postalCode: '3100'
                        city: Kubhaven
                        country: Belgium
                        countryCode: BE
                    tags:
                    - favorite
                    - liked
                    active: true
                    metadata:
                      channels:
                        main: delivery_on_platform
                        secondary: email
                      department: Accounting
                      industry: Agriculture, Forestry And Fishing
                      logo: https://somelinks.com/logo.jpg
                      notes: some notes
                      website: https://mycompanywebsite.com
                    connectors:
                    - active: true
                      name: email
                      settings:
                        emailAddress: john.doe@example.com
                    paymentAccounts:
                    - id: 0ca2797b-6365-4bf2-a490-247075e3cede
                      identifier: BE19519469892112
                      scheme: IBAN
                      country: BE
                      currency: EUR
                      bank:
                        identifier: ABNABE2AIDJ
                        scheme: BIC
                      spaceId: 56079d21-a756-49fb-9286-9859c354aa69
                      ownedBySpace: true
                      active: true
                      ownerName: UP RO
                      isDefault: true
                    firstName: John
                    lastName: Doe
        '404':
          description: Not Found. Connection uuid must be invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 404
                error: NOT_FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: The HTTP method was not allowed on this endpoint.
        default:
          description: Other error messages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
      security:
      - oauth2:
        - space_read
    delete:
      tags:
      - Connections
      summary: Delete connection v2
      description: '<div class=''my-preview''><span>Preview: The API is in development
        or testing phases and the interface could still change slightly.</span></div>
        <br/> Delete connection v2 by its ID on the given space <br/> Scope: space_write'
      operationId: deleteConnectionV2
      parameters:
      - name: spaceId
        in: path
        description: The space identifier
        required: true
        schema:
          type: string
          format: uuid
      - name: connectionId
        in: path
        description: The connection identifier
        required: true
        schema:
          type: string
          format: uuid
        example: 1d0159ca-ab19-49d5-9e13-9d34afb03849
      responses:
        '204':
          description: Ok.
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 404
                error: NOT_FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: The HTTP method was not allowed on this endpoint.
        default:
          description: Other error messages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
      security:
      - oauth2:
        - space_write
    patch:
      tags:
      - Connections
      summary: Update connection v2
      description: '<div class=''my-preview''><span>Preview: The API is in development
        or testing phases and the interface could still change slightly.</span></div>
        <br/> Update connection v2 by its ID on the given space <br/> Scope: space_write'
      operationId: updateConnectionV2
      parameters:
      - name: spaceId
        in: path
        description: The space identifier
        required: true
        schema:
          type: string
          format: uuid
      - name: connectionId
        in: path
        description: The connection identifier
        required: true
        schema:
          type: string
          format: uuid
        example: 1d0159ca-ab19-49d5-9e13-9d34afb03849
      requestBody:
        description: Connection data to update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectionPatchRequestV2'
            examples:
              Update Person Connection Request:
                description: Update Person Connection Request
                value:
                  type: person
                  spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                  globalIdentifiers:
                    global:email:
                    - john@example.com
                    global:phoneNumber:
                    - '+1234567890'
                  assignedAccountId: '001'
                  alias: Johnny
                  connectionStatus: CONNECTED
                  relationTypes:
                  - CUSTOMER
                  addresses:
                    main:
                      streetName: Milo Crossroad
                      house: '7850'
                      postalCode: '3100'
                      city: Kubhaven
                      country: Belgium
                      countryCode: BE
                  tags:
                  - favorite
                  - liked
                  active: true
                  metadata:
                    channels:
                      main: delivery_on_platform
                      secondary: email
                    department: Accounting
                    logo: https://somelinks.com/logo.jpg
                    website: https://mycompanywebsite.com
                    notes: some notes
                    industry: Agriculture, Forestry And Fishing
                  firstName: Joan
                  lastName: Doe
              Update Business Connection Request:
                description: Update Business Connection Request
                value:
                  type: business
                  spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                  globalIdentifiers:
                    fr:siret: '53051415700029'
                    nl:kvk: '87654321'
                    be:vat: BE0400282475
                    global:email:
                    - john@example.com
                    global:phoneNumber:
                    - '+1234567890'
                  assignedAccountId: '001'
                  alias: UP
                  connectionStatus: CONNECTED
                  relationTypes:
                  - SUPPLIER
                  addresses:
                    main:
                      streetName: Nitzsche Lodge
                      house: '80728'
                      postalCode: '3110'
                      city: Fernandahaven
                      country: Belgium
                      countryCode: BE
                  tags:
                  - favorite
                  - liked
                  active: true
                  metadata:
                    paymentTerms:
                      defaultDuePeriod: P0D
                      isEndOfMonth: true
                    paymentMethod: '31'
                    channels:
                      main: delivery_on_platform
                      secondary: email
                    department: Accounting
                    logo: https://somelinks.com/logo.jpg
                    website: https://mycompanywebsite.com
                    notes: some notes
                    industry: Agriculture, Forestry And Fishing
                  legalName: Unifiedpost Group
                  tradeName: unifiedpost
                  businessType: ENTERPRISE
        required: true
      responses:
        '200':
          description: Update connection successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionV2'
              examples:
                Business Connection:
                  description: Business Connection
                  value:
                    type: business
                    id: 00000001-0000-0000-0000-000000000000
                    spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                    globalIdentifiers:
                      be:vat: '123456789'
                      fr:siret: '12345678901234'
                      global:email:
                      - john@example.com
                      global:phoneNumber:
                      - '00301234567'
                      nl:kvk: '87654321'
                    assignedAccountId: '001'
                    alias: UP
                    connectionStatus: CONNECTED
                    relationTypes:
                    - CUSTOMER
                    addresses:
                      main:
                        streetName: Nitzsche Lodge
                        house: '80728'
                        postalCode: '3110'
                        city: Fernandahaven
                        country: Belgium
                        countryCode: BE
                    tags:
                    - favorite
                    - liked
                    active: true
                    metadata:
                      channels:
                        main: delivery_on_platform
                        secondary: email
                      department: Accounting
                      industry: Agriculture, Forestry And Fishing
                      logo: https://somelinks.com/logo.jpg
                      notes: some notes
                      website: https://mycompanywebsite.com
                    connectors:
                    - active: true
                      extensionId: 00000001-0001-0000-0000-000000000001
                      name: cross-peppol
                      namespace: com.unifiedpost.btx.connectors
                      settings:
                        peppolAccessPoint: access-point
                        peppolID: '12345'
                    paymentAccounts:
                    - id: 0ca2797b-6365-4bf2-a490-247075e3cede
                      identifier: BE19519469892112
                      scheme: IBAN
                      country: BE
                      currency: EUR
                      bank:
                        identifier: ABNABE2AIDJ
                        scheme: BIC
                      spaceId: 56079d21-a756-49fb-9286-9859c354aa69
                      ownedBySpace: true
                      active: true
                      ownerName: UP RO
                      isDefault: true
                    legalName: Unifiedpost Group
                    tradeName: unifiedpost
                    businessType: ENTERPRISE
                Person Connection:
                  description: Person Connection
                  value:
                    type: person
                    id: 00000002-0000-0000-0000-000000000000
                    spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                    globalIdentifiers:
                      global:email:
                      - john@example.com
                      global:phoneNumber:
                      - '00301234567'
                    assignedAccountId: '001'
                    alias: UP
                    connectionStatus: CONNECTED
                    relationTypes:
                    - CUSTOMER
                    addresses:
                      main:
                        streetName: Milo Crossroad
                        house: '7850'
                        postalCode: '3100'
                        city: Kubhaven
                        country: Belgium
                        countryCode: BE
                    tags:
                    - favorite
                    - liked
                    active: true
                    metadata:
                      channels:
                        main: delivery_on_platform
                        secondary: email
                      department: Accounting
                      industry: Agriculture, Forestry And Fishing
                      logo: https://somelinks.com/logo.jpg
                      notes: some notes
                      website: https://mycompanywebsite.com
                    connectors:
                    - active: true
                      name: email
                      settings:
                        emailAddress: john.doe@example.com
                    paymentAccounts:
                    - id: 0ca2797b-6365-4bf2-a490-247075e3cede
                      identifier: BE19519469892112
                      scheme: IBAN
                      country: BE
                      currency: EUR
                      bank:
                        identifier: ABNABE2AIDJ
                        scheme: BIC
                      spaceId: 56079d21-a756-49fb-9286-9859c354aa69
                      ownedBySpace: true
                      active: true
                      ownerName: UP RO
                      isDefault: true
                    firstName: John
                    lastName: Doe
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
        '404':
          description: Connection UUID could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 404
                error: NOT_FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: The HTTP method was not allowed on this endpoint.
        default:
          description: Other error messages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
      security:
      - oauth2:
        - space_write
  /transaction/v2/spaces/{spaceId}/connections/{connectionId}:jsonpatch:
    patch:
      tags:
      - Connections
      summary: Update connection v2
      description: '<div class=''my-preview''><span>Preview: The API is in development
        or testing phases and the interface could still change slightly.</span></div>
        <br/> Update connection v2 by its ID on the given space by sending JSON patch
        <br/> Scope: space_write'
      operationId: jsonpatchConnectionV2
      parameters:
      - name: spaceId
        in: path
        description: The space identifier
        required: true
        schema:
          type: string
          format: uuid
      - name: connectionId
        in: path
        description: The connection identifier
        required: true
        schema:
          type: string
          format: uuid
        example: 1d0159ca-ab19-49d5-9e13-9d34afb03849
      requestBody:
        description: Connection data to update
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/PatchRequest'
            example: "[\n\t{op\": \"add\", \"path\": \"/metadata/selfBilling\", \"\
              value\": {}},\n\t{\"op\": \"remove\", \"path\": \"/foo\"}\n]"
        required: true
      responses:
        '200':
          description: Update connection successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionV2'
              examples:
                Business Connection:
                  description: Business Connection
                  value:
                    type: business
                    id: 00000001-0000-0000-0000-000000000000
                    spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                    globalIdentifiers:
                      be:vat: '123456789'
                      fr:siret: '12345678901234'
                      global:email:
                      - john@example.com
                      global:phoneNumber:
                      - '00301234567'
                      nl:kvk: '87654321'
                    assignedAccountId: '001'
                    alias: UP
                    connectionStatus: CONNECTED
                    relationTypes:
                    - CUSTOMER
                    addresses:
                      main:
                        streetName: Nitzsche Lodge
                        house: '80728'
                        postalCode: '3110'
                        city: Fernandahaven
                        country: Belgium
                        countryCode: BE
                    tags:
                    - favorite
                    - liked
                    active: true
                    metadata:
                      channels:
                        main: delivery_on_platform
                        secondary: email
                      department: Accounting
                      industry: Agriculture, Forestry And Fishing
                      logo: https://somelinks.com/logo.jpg
                      notes: some notes
                      website: https://mycompanywebsite.com
                    connectors:
                    - active: true
                      extensionId: 00000001-0001-0000-0000-000000000001
                      name: cross-peppol
                      namespace: com.unifiedpost.btx.connectors
                      settings:
                        peppolAccessPoint: access-point
                        peppolID: '12345'
                    paymentAccounts:
                    - id: 0ca2797b-6365-4bf2-a490-247075e3cede
                      identifier: BE19519469892112
                      scheme: IBAN
                      country: BE
                      currency: EUR
                      bank:
                        identifier: ABNABE2AIDJ
                        scheme: BIC
                      spaceId: 56079d21-a756-49fb-9286-9859c354aa69
                      ownedBySpace: true
                      active: true
                      ownerName: UP RO
                      isDefault: true
                    legalName: Unifiedpost Group
                    tradeName: unifiedpost
                    businessType: ENTERPRISE
                Person Connection:
                  description: Person Connection
                  value:
                    type: person
                    id: 00000002-0000-0000-0000-000000000000
                    spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                    globalIdentifiers:
                      global:email:
                      - john@example.com
                      global:phoneNumber:
                      - '00301234567'
                    assignedAccountId: '001'
                    alias: UP
                    connectionStatus: CONNECTED
                    relationTypes:
                    - CUSTOMER
                    addresses:
                      main:
                        streetName: Milo Crossroad
                        house: '7850'
                        postalCode: '3100'
                        city: Kubhaven
                        country: Belgium
                        countryCode: BE
                    tags:
                    - favorite
                    - liked
                    active: true
                    metadata:
                      channels:
                        main: delivery_on_platform
                        secondary: email
                      department: Accounting
                      industry: Agriculture, Forestry And Fishing
                      logo: https://somelinks.com/logo.jpg
                      notes: some notes
                      website: https://mycompanywebsite.com
                    connectors:
                    - active: true
                      name: email
                      settings:
                        emailAddress: john.doe@example.com
                    paymentAccounts:
                    - id: 0ca2797b-6365-4bf2-a490-247075e3cede
                      identifier: BE19519469892112
                      scheme: IBAN
                      country: BE
                      currency: EUR
                      bank:
                        identifier: ABNABE2AIDJ
                        scheme: BIC
                      spaceId: 56079d21-a756-49fb-9286-9859c354aa69
                      ownedBySpace: true
                      active: true
                      ownerName: UP RO
                      isDefault: true
                    firstName: John
                    lastName: Doe
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
        '404':
          description: Connection UUID could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 404
                error: NOT_FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: The HTTP method was not allowed on this endpoint.
        default:
          description: Other error messages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
      security:
      - oauth2:
        - space_write
  /transaction/v2/spaces/{spaceId}/connections/{connectionId}/connectors:
    put:
      tags:
      - Connections
      summary: Create/update connectors in the connection.
      description: '<div class=''my-preview''><span>Preview: The API is in development
        or testing phases and the interface could still change slightly.</span></div>
        <br/> Create/update entire content inside the connectors of the given connectionId.
        <br/> Scope: space_write'
      operationId: replaceConnectorsV2
      parameters:
      - name: spaceId
        in: path
        description: The space identifier
        required: true
        schema:
          type: string
          format: uuid
      - name: connectionId
        in: path
        description: The connection identifier
        required: true
        schema:
          type: string
          format: uuid
        example: 1d0159ca-ab19-49d5-9e13-9d34afb03849
      requestBody:
        description: Array of connectors
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/JsonBMap'
            example:
            - active: true
              extensionId: 00000001-0001-0000-0000-000000000001
              name: cross-peppol1
              namespace: com.unifiedpost.btx.connectors1
              settings:
                peppolAccessPoint: access-point1
                peppolID: '12345'
            - active: true
              extensionId: 00000001-0002-0000-0000-000000000001
              name: cross-peppol2
              namespace: com.unifiedpost.btx.connectors2
              settings:
                peppolAccessPoint: access-point2
                peppolID: '67890'
        required: true
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/JsonBMap'
              example:
              - active: true
                extensionId: 00000001-0001-0000-0000-000000000001
                name: cross-peppol1
                namespace: com.unifiedpost.btx.connectors1
                settings:
                  peppolAccessPoint: access-point1
                  peppolID: '12345'
              - active: true
                extensionId: 00000001-0002-0000-0000-000000000001
                name: cross-peppol2
                namespace: com.unifiedpost.btx.connectors2
                settings:
                  peppolAccessPoint: access-point2
                  peppolID: '67890'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
        '404':
          description: Connection UUID could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 404
                error: NOT_FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: The HTTP method was not allowed on this endpoint.
        default:
          description: Other error messages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
      security:
      - oauth2:
        - space_write
  /transaction/v3/spaces/{spaceId}/connections:
    get:
      tags:
      - Connections
      summary: Get list of connections v3
      description: "<div class='my-preview'><span>Preview: The API is in development\
        \ or testing phases and the interface could still change slightly.</span></div>\
        \ <br/> \tGet list of connections v3 on the given space with optional filtering\
        \ by identifiers.\n\tThe API supports pagination and sorting.\n <br/> Scope:\
        \ space_read"
      operationId: listConnectionsV3
      parameters:
      - name: filter
        in: query
        schema:
          $ref: '#/components/schemas/ListConnectionsQueryParamsSingleV3'
      - name: spaceId
        in: path
        description: The space identifier
        required: true
        schema:
          type: string
          format: uuid
      - name: type
        in: query
        description: List of connection type for searching. Can be multiple values
          separated by comma, or just one value
        explode: false
        schema:
          type: array
          items:
            type: string
        example: business,person
      - name: businessType
        in: query
        description: List of business type for searching. Can be multiple values separated
          by comma, or just one value
        explode: false
        schema:
          type: array
          items:
            type: string
        example: ENTERPRISE,GOVERNMENT
      - name: ql
        in: query
        description: "\tBTX Query Language filter expression. Examples:\n\t- type=business\
          \ (or type[eq]=business or type[in]=(business))\n\t- connectionStatus=CONNECTED\
          \ (or connectionStatus[in]=(CONNECTED,PENDING), connectionStatus[not_in]=(DISCONNECTED))\n\
          \ \t- businessType=ENTERPRISE (or businessType[eq]=ENTERPRISE)\n\t- addresses.main.countryCode=BE\n\
          \ \t- assignedAccountId=\"00044\" (or assignedAccountId[cont]=\"00044\"\
          )\n \t- globalIdentifiers.\"be:en\"=\"0400282475\" (or globalIdentifiers.\"\
          be:en\"[eq]=\"0400282475\")\n\t- metadata.selfBilling.customer.mandate=true\n\
          \ \t- relationTypes[in]=(CUSTOMER,SUPPLIER)\n\t- tags[in]=(first_tag,second_tag)\n"
        schema:
          type: string
      - name: identifierKeyValue
        in: query
        description: Connection identifier (e.g. VAT number)
        schema:
          type: array
          items:
            type: string
      - name: metadata
        in: query
        description: "\tAllows filtering connections by nested metadata fields.\n\t\
          \ Example:\n\tGiven the following metadata:\n\t{\n\t\t\"metadata\": {\n\t\
          \t\t\"selfBilling\": {\n\t\t\t\t\"customer\": { \"mandate\": true },\n\t\
          \t\t\t\"supplier\": { \"mandate\": false }\n\t\t\t}\n\t\t}\n\t}\n\tTo filter\
          \ by connections where selfBilling.customer.mandate is true, send the query\
          \ parameter:\n\t?metadata=selfBilling.customer.mandate=true\n"
        schema:
          type: array
          items:
            type: string
        example: metadata=selfBilling.customer.mandate=true
      - name: relationTypes
        in: query
        description: Relation Types for searching. Can be multiple values separated
          by comma, or just one value.
        explode: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/ConnectionRelationType'
        example: CUSTOMER,PARTNER
      - name: tags
        in: query
        description: Filter by tags. Can be an array to filter by all tags (AND) -
          e.g. ?tags=first_tag&tags=second_tag. Or it could be a comma-separated list
          to filter by any of the values (OR) - e.g. ?tags=first_tag,second_tag.
        schema:
          type: array
          items:
            type: string
        example:
        - first_tag
        - second_tag
        - third_tag
      - name: include
        in: query
        description: What extra data to include in the response.
        explode: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/ConnectionInclude'
        example: paymentAccounts
      - name: connectorsKeyValue
        in: query
        description: Connectors data (key value)
        schema:
          type: array
          items:
            type: string
        example: connectorsKeyValue=name=email&connectorsKeyValue=active=true
      - name: page
        in: query
        description: Zero-based page index, cannot be negative, default 0
        schema:
          maximum: 10737418
          minimum: 0
          type: integer
          format: int32
          default: 0
        example: 20
      - name: pageSize
        in: query
        description: 'Page size. Minimum 1, maximum: 200, default 20'
        schema:
          maximum: 200
          minimum: 1
          type: integer
          format: int32
          default: 20
        example: 20
      - name: includeTotalElements
        in: query
        description: Return the totalElements number of entries in the response
        schema:
          type: boolean
        example: true
      - name: onlyCount
        in: query
        description: Return ONLY the totalElements number of entries in the response.
        schema:
          type: boolean
        example: true
      - name: sortBy
        in: query
        description: Sorting criteria
        schema:
          type: string
          enum:
          - createdAt
          - createdAt.asc
          - createdAt.desc
          - name
          - name.asc
          - name.desc
          - type
          - type.asc
          - type.desc
          - assignedAccountId
          - assignedAccountId.asc
          - assignedAccountId.desc
          - businessType
          - businessType.asc
          - businessType.desc
        example: createdAt.asc
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListConnectionsResponseV3'
              example:
                connections:
                - type: business
                  id: 0ca2797b-6365-4bf2-a490-247075e3cede
                  globalIdentifiers:
                    fr:siret: '12345678901234'
                    nl:kvk: '87654321'
                    be:vat: '123456789'
                    global:email:
                    - john@example.com
                    global:phoneNumber:
                    - '+1234567890'
                  assignedAccountId: Local123
                  alias: Sample Connection
                  connectionStatus: CONNECTED
                  relationTypes:
                  - SUPPLIER
                  addresses:
                    main:
                      addressType: BIZZ
                      streetName: Nitzsche Lodge
                      buildingNumber: '80728'
                      postCode: '3110'
                      townName: Fernandahaven
                      country: BE
                  tags:
                  - tag1
                  - tag2
                  active: true
                  metadata:
                    channels:
                      main: delivery_on_platform
                      secondary: email
                    department: Accounting
                    logo: https://somelinks.com/logo.jpg
                    website: https://mycompanywebsite.com
                    notes: some notes
                    industry: Agriculture, Forestry And Fishing
                  spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                  createdAt: 2024-01-02 07:27:51.251000+00:00
                  legalName: Sample Business
                  tradeName: Trade Business
                  businessType: ENTERPRISE
                - type: person
                  id: 12345678-90ab-cdef-1234-567890abcdef
                  globalIdentifiers:
                    fr:siret: '12345678901234'
                    nl:kvk: '87654321'
                    be:vat: '123456789'
                    global:email:
                    - john@example.com
                    global:phoneNumber:
                    - '+1234567890'
                  assignedAccountId: '001'
                  alias: Sample Person
                  connectionStatus: CONNECTED
                  relationTypes:
                  - CUSTOMER
                  addresses:
                    main:
                      streetName: Milo Crossroad
                      house: '7850'
                      postalCode: '3100'
                      city: Kubhaven
                      country: Belgium
                      countryCode: BE
                  tags:
                  - tag3
                  - tag4
                  active: false
                  metadata:
                    channels:
                      main: delivery_on_platform
                      secondary: email
                    department: Accounting
                    logo: https://somelinks.com/logo.jpg
                    website: https://mycompanywebsite.com
                    notes: some notes
                    industry: Agriculture, Forestry And Fishing
                  spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                  createdAt: 2024-01-02 07:27:51.251000+00:00
                  firstName: John
                  lastName: Doe
                totalElements: 1
                currentPage: 0
                pageSize: 20
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 404
                error: NOT_FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: The HTTP method was not allowed on this endpoint.
        default:
          description: Other error messages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
      security:
      - oauth2:
        - space_read
    post:
      tags:
      - Connections
      summary: Create connection v3
      description: '<div class=''my-preview''><span>Preview: The API is in development
        or testing phases and the interface could still change slightly.</span></div>
        <br/> Create connection v3 on the given space <br/> Scope: space_write'
      operationId: createConnectionV3
      parameters:
      - name: spaceId
        in: path
        description: The space identifier
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        description: Connection to add
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectionRequestV3'
            examples:
              PersonConnection:
                description: PersonConnection
                value:
                  type: person
                  spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                  globalIdentifiers:
                    global:email:
                    - john@example.com
                    global:phoneNumber:
                    - '+1234567890'
                  assignedAccountId: '001'
                  alias: UP
                  connectionStatus: CONNECTED
                  relationTypes:
                  - CUSTOMER
                  addresses:
                    main:
                      addressType: BIZZ
                      streetName: Nitzsche Lodge
                      buildingNumber: '80728'
                      postCode: '3110'
                      townName: Fernandahaven
                      country: BE
                  tags:
                  - favorite
                  - liked
                  active: true
                  metadata:
                    channels:
                      main: delivery_on_platform
                      secondary: email
                    department: Accounting
                    logo: https://somelinks.com/logo.jpg
                    website: https://mycompanywebsite.com
                    notes: some notes
                    industry: Agriculture, Forestry And Fishing
                  connectors:
                  - active: true
                    extensionId: 00000001-0001-0000-0000-000000000001
                    name: cross-peppol
                    namespace: com.unifiedpost.btx.connectors
                    settings:
                      peppolAccessPoint: access-point
                      peppolID: '12345'
                  firstName: John
                  lastName: Doe
              BusinessConnection:
                description: BusinessConnection
                value:
                  type: business
                  spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                  globalIdentifiers:
                    fr:siren: '530514157'
                    fr:siret: '53051415700029'
                    nl:kvk: '87654321'
                    be:en: 0400282475
                    be:vat: BE0400282475
                    global:email:
                    - john@example.com
                    global:phoneNumber:
                    - '+1234567890'
                  assignedAccountId: '001'
                  alias: UP
                  connectionStatus: CONNECTED
                  relationTypes:
                  - CUSTOMER
                  addresses:
                    main:
                      addressType: BIZZ
                      streetName: Nitzsche Lodge
                      buildingNumber: '80728'
                      postCode: '3110'
                      townName: Fernandahaven
                      country: BE
                  tags:
                  - favorite
                  - liked
                  active: true
                  metadata:
                    paymentTerms:
                      defaultDuePeriod: P0D
                      isEndOfMonth: true
                    paymentMethod: '31'
                    channels:
                      main: delivery_on_platform
                      secondary: email
                    department: Accounting
                    logo: https://somelinks.com/logo.jpg
                    website: https://mycompanywebsite.com
                    notes: some notes
                    industry: Agriculture, Forestry And Fishing
                  connectors:
                  - active: true
                    extensionId: 00000001-0001-0000-0000-000000000001
                    name: cross-peppol
                    namespace: com.unifiedpost.btx.connectors
                    settings:
                      peppolAccessPoint: access-point
                      peppolID: '12345'
                  legalName: Unifiedpost Group
                  tradeName: unifiedpost
                  businessType: ENTERPRISE
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionV3'
              examples:
                Business Connection:
                  description: Business Connection
                  value:
                    type: business
                    id: 00000001-0000-0000-0000-000000000000
                    spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                    globalIdentifiers:
                      be:vat: '123456789'
                      fr:siret: '12345678901234'
                      global:email:
                      - john@example.com
                      global:phoneNumber:
                      - '00301234567'
                      nl:kvk: '87654321'
                    assignedAccountId: '001'
                    alias: UP
                    connectionStatus: CONNECTED
                    relationTypes:
                    - CUSTOMER
                    addresses:
                      main:
                        addressType: BIZZ
                        streetName: Nitzsche Lodge
                        buildingNumber: '80728'
                        postCode: '3110'
                        townName: Fernandahaven
                        country: BE
                    tags:
                    - favorite
                    - liked
                    active: true
                    metadata:
                      channels:
                        main: delivery_on_platform
                        secondary: email
                      department: Accounting
                      industry: Agriculture, Forestry And Fishing
                      logo: https://somelinks.com/logo.jpg
                      notes: some notes
                      website: https://mycompanywebsite.com
                    connectors:
                    - active: true
                      extensionId: 00000001-0001-0000-0000-000000000001
                      name: cross-peppol
                      namespace: com.unifiedpost.btx.connectors
                      settings:
                        peppolAccessPoint: access-point
                        peppolID: '12345'
                    paymentAccounts:
                    - id: 0ca2797b-6365-4bf2-a490-247075e3cede
                      identifier: BE19519469892112
                      scheme: IBAN
                      country: BE
                      currency: EUR
                      bank:
                        identifier: ABNABE2AIDJ
                        scheme: BIC
                      spaceId: 56079d21-a756-49fb-9286-9859c354aa69
                      ownedBySpace: true
                      active: true
                      ownerName: UP RO
                      isDefault: true
                    legalName: Unifiedpost Group
                    tradeName: unifiedpost
                    businessType: ENTERPRISE
                Person Connection:
                  description: Person Connection
                  value:
                    type: person
                    id: 00000002-0000-0000-0000-000000000000
                    spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                    globalIdentifiers:
                      global:email:
                      - john@example.com
                      global:phoneNumber:
                      - '00301234567'
                    assignedAccountId: '001'
                    alias: UP
                    connectionStatus: CONNECTED
                    relationTypes:
                    - CUSTOMER
                    addresses:
                      main:
                        addressType: BIZZ
                        streetName: Nitzsche Lodge
                        buildingNumber: '80728'
                        postCode: '3110'
                        townName: Fernandahaven
                        country: BE
                    tags:
                    - favorite
                    - liked
                    active: true
                    metadata:
                      channels:
                        main: delivery_on_platform
                        secondary: email
                      department: Accounting
                      industry: Agriculture, Forestry And Fishing
                      logo: https://somelinks.com/logo.jpg
                      notes: some notes
                      website: https://mycompanywebsite.com
                    connectors:
                    - active: true
                      name: email
                      settings:
                        emailAddress: john.doe@example.com
                    paymentAccounts:
                    - id: 0ca2797b-6365-4bf2-a490-247075e3cede
                      identifier: BE19519469892112
                      scheme: IBAN
                      country: BE
                      currency: EUR
                      bank:
                        identifier: ABNABE2AIDJ
                        scheme: BIC
                      spaceId: 56079d21-a756-49fb-9286-9859c354aa69
                      ownedBySpace: true
                      active: true
                      ownerName: UP RO
                      isDefault: true
                    firstName: John
                    lastName: Doe
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
        default:
          description: Other error messages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
      security:
      - oauth2:
        - space_write
  /transaction/v3/spaces/{spaceId}/connections/{connectionId}:
    get:
      tags:
      - Connections
      summary: Get connection info v3
      description: '<div class=''my-preview''><span>Preview: The API is in development
        or testing phases and the interface could still change slightly.</span></div>
        <br/> Get connection information v3 by its ID on the given space <br/> Scope:
        space_read'
      operationId: getConnectionV3
      parameters:
      - name: spaceId
        in: path
        description: The space identifier
        required: true
        schema:
          type: string
          format: uuid
      - name: connectionId
        in: path
        description: The connection identifier
        required: true
        schema:
          type: string
          format: uuid
        example: 1d0159ca-ab19-49d5-9e13-9d34afb03849
      - name: include
        in: query
        description: What extra data to include in the response.
        explode: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/ConnectionInclude'
        example: paymentAccounts
      responses:
        '200':
          description: Ok. Connection info
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionV3'
              examples:
                Business Connection:
                  description: Business Connection
                  value:
                    type: business
                    id: 00000001-0000-0000-0000-000000000000
                    spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                    globalIdentifiers:
                      be:vat: '123456789'
                      fr:siret: '12345678901234'
                      global:email:
                      - john@example.com
                      global:phoneNumber:
                      - '00301234567'
                      nl:kvk: '87654321'
                    assignedAccountId: '001'
                    alias: UP
                    connectionStatus: CONNECTED
                    relationTypes:
                    - CUSTOMER
                    addresses:
                      main:
                        addressType: BIZZ
                        streetName: Nitzsche Lodge
                        buildingNumber: '80728'
                        postCode: '3110'
                        townName: Fernandahaven
                        country: BE
                    tags:
                    - favorite
                    - liked
                    active: true
                    metadata:
                      channels:
                        main: delivery_on_platform
                        secondary: email
                      department: Accounting
                      industry: Agriculture, Forestry And Fishing
                      logo: https://somelinks.com/logo.jpg
                      notes: some notes
                      website: https://mycompanywebsite.com
                    connectors:
                    - active: true
                      extensionId: 00000001-0001-0000-0000-000000000001
                      name: cross-peppol
                      namespace: com.unifiedpost.btx.connectors
                      settings:
                        peppolAccessPoint: access-point
                        peppolID: '12345'
                    paymentAccounts:
                    - id: 0ca2797b-6365-4bf2-a490-247075e3cede
                      identifier: BE19519469892112
                      scheme: IBAN
                      country: BE
                      currency: EUR
                      bank:
                        identifier: ABNABE2AIDJ
                        scheme: BIC
                      spaceId: 56079d21-a756-49fb-9286-9859c354aa69
                      ownedBySpace: true
                      active: true
                      ownerName: UP RO
                      isDefault: true
                    legalName: Unifiedpost Group
                    tradeName: unifiedpost
                    businessType: ENTERPRISE
                Person Connection:
                  description: Person Connection
                  value:
                    type: person
                    id: 00000002-0000-0000-0000-000000000000
                    spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                    globalIdentifiers:
                      global:email:
                      - john@example.com
                      global:phoneNumber:
                      - '00301234567'
                    assignedAccountId: '001'
                    alias: UP
                    connectionStatus: CONNECTED
                    relationTypes:
                    - CUSTOMER
                    addresses:
                      main:
                        addressType: BIZZ
                        streetName: Nitzsche Lodge
                        buildingNumber: '80728'
                        postCode: '3110'
                        townName: Fernandahaven
                        country: BE
                    tags:
                    - favorite
                    - liked
                    active: true
                    metadata:
                      channels:
                        main: delivery_on_platform
                        secondary: email
                      department: Accounting
                      industry: Agriculture, Forestry And Fishing
                      logo: https://somelinks.com/logo.jpg
                      notes: some notes
                      website: https://mycompanywebsite.com
                    connectors:
                    - active: true
                      name: email
                      settings:
                        emailAddress: john.doe@example.com
                    paymentAccounts:
                    - id: 0ca2797b-6365-4bf2-a490-247075e3cede
                      identifier: BE19519469892112
                      scheme: IBAN
                      country: BE
                      currency: EUR
                      bank:
                        identifier: ABNABE2AIDJ
                        scheme: BIC
                      spaceId: 56079d21-a756-49fb-9286-9859c354aa69
                      ownedBySpace: true
                      active: true
                      ownerName: UP RO
                      isDefault: true
                    firstName: John
                    lastName: Doe
        '404':
          description: Not Found. Connection uuid must be invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 404
                error: NOT_FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: The HTTP method was not allowed on this endpoint.
        default:
          description: Other error messages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
      security:
      - oauth2:
        - space_read
    patch:
      tags:
      - Connections
      summary: Update connection v3
      description: '<div class=''my-preview''><span>Preview: The API is in development
        or testing phases and the interface could still change slightly.</span></div>
        <br/> Update connection v3 by its ID on the given space <br/> Scope: space_write'
      operationId: updateConnectionV3
      parameters:
      - name: spaceId
        in: path
        description: The space identifier
        required: true
        schema:
          type: string
          format: uuid
      - name: connectionId
        in: path
        description: The connection identifier
        required: true
        schema:
          type: string
          format: uuid
        example: 1d0159ca-ab19-49d5-9e13-9d34afb03849
      requestBody:
        description: Connection data to update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectionPatchRequestV3'
            examples:
              Update Person Connection Request:
                description: Update Person Connection Request
                value:
                  type: person
                  spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                  globalIdentifiers:
                    global:email:
                    - john@example.com
                    global:phoneNumber:
                    - '+1234567890'
                  assignedAccountId: '001'
                  alias: Johnny
                  connectionStatus: CONNECTED
                  relationTypes:
                  - CUSTOMER
                  addresses:
                    main:
                      addressType: BIZZ
                      streetName: Nitzsche Lodge
                      buildingNumber: '80728'
                      postCode: '3110'
                      townName: Fernandahaven
                      country: BE
                  tags:
                  - favorite
                  - liked
                  active: true
                  metadata:
                    channels:
                      main: delivery_on_platform
                      secondary: email
                    department: Accounting
                    logo: https://somelinks.com/logo.jpg
                    website: https://mycompanywebsite.com
                    notes: some notes
                    industry: Agriculture, Forestry And Fishing
                  firstName: Joan
                  lastName: Doe
              Update Business Connection Request:
                description: Update Business Connection Request
                value:
                  type: business
                  spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                  globalIdentifiers:
                    fr:siret: '53051415700029'
                    nl:kvk: '87654321'
                    be:vat: BE0400282475
                    global:email:
                    - john@example.com
                    global:phoneNumber:
                    - '+1234567890'
                  assignedAccountId: '001'
                  alias: UP
                  connectionStatus: CONNECTED
                  relationTypes:
                  - SUPPLIER
                  addresses:
                    main:
                      addressType: BIZZ
                      streetName: Nitzsche Lodge
                      buildingNumber: '80728'
                      postCode: '3110'
                      townName: Fernandahaven
                      country: BE
                  tags:
                  - favorite
                  - liked
                  active: true
                  metadata:
                    paymentTerms:
                      defaultDuePeriod: P0D
                      isEndOfMonth: true
                    paymentMethod: '31'
                    channels:
                      main: delivery_on_platform
                      secondary: email
                    department: Accounting
                    logo: https://somelinks.com/logo.jpg
                    website: https://mycompanywebsite.com
                    notes: some notes
                    industry: Agriculture, Forestry And Fishing
                  legalName: Unifiedpost Group
                  tradeName: unifiedpost
                  businessType: ENTERPRISE
        required: true
      responses:
        '200':
          description: Update connection successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionV3'
              examples:
                Business Connection:
                  description: Business Connection
                  value:
                    type: business
                    id: 00000001-0000-0000-0000-000000000000
                    spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                    globalIdentifiers:
                      be:vat: '123456789'
                      fr:siret: '12345678901234'
                      global:email:
                      - john@example.com
                      global:phoneNumber:
                      - '00301234567'
                      nl:kvk: '87654321'
                    assignedAccountId: '001'
                    alias: UP
                    connectionStatus: CONNECTED
                    relationTypes:
                    - CUSTOMER
                    addresses:
                      main:
                        addressType: BIZZ
                        streetName: Nitzsche Lodge
                        buildingNumber: '80728'
                        postCode: '3110'
                        townName: Fernandahaven
                        country: BE
                    tags:
                    - favorite
                    - liked
                    active: true
                    metadata:
                      channels:
                        main: delivery_on_platform
                        secondary: email
                      department: Accounting
                      industry: Agriculture, Forestry And Fishing
                      logo: https://somelinks.com/logo.jpg
                      notes: some notes
                      website: https://mycompanywebsite.com
                    connectors:
                    - active: true
                      extensionId: 00000001-0001-0000-0000-000000000001
                      name: cross-peppol
                      namespace: com.unifiedpost.btx.connectors
                      settings:
                        peppolAccessPoint: access-point
                        peppolID: '12345'
                    paymentAccounts:
                    - id: 0ca2797b-6365-4bf2-a490-247075e3cede
                      identifier: BE19519469892112
                      scheme: IBAN
                      country: BE
                      currency: EUR
                      bank:
                        identifier: ABNABE2AIDJ
                        scheme: BIC
                      spaceId: 56079d21-a756-49fb-9286-9859c354aa69
                      ownedBySpace: true
                      active: true
                      ownerName: UP RO
                      isDefault: true
                    legalName: Unifiedpost Group
                    tradeName: unifiedpost
                    businessType: ENTERPRISE
                Person Connection:
                  description: Person Connection
                  value:
                    type: person
                    id: 00000002-0000-0000-0000-000000000000
                    spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                    globalIdentifiers:
                      global:email:
                      - john@example.com
                      global:phoneNumber:
                      - '00301234567'
                    assignedAccountId: '001'
                    alias: UP
                    connectionStatus: CONNECTED
                    relationTypes:
                    - CUSTOMER
                    addresses:
                      main:
                        addressType: BIZZ
                        streetName: Nitzsche Lodge
                        buildingNumber: '80728'
                        postCode: '3110'
                        townName: Fernandahaven
                        country: BE
                    tags:
                    - favorite
                    - liked
                    active: true
                    metadata:
                      channels:
                        main: delivery_on_platform
                        secondary: email
                      department: Accounting
                      industry: Agriculture, Forestry And Fishing
                      logo: https://somelinks.com/logo.jpg
                      notes: some notes
                      website: https://mycompanywebsite.com
                    connectors:
                    - active: true
                      name: email
                      settings:
                        emailAddress: john.doe@example.com
                    paymentAccounts:
                    - id: 0ca2797b-6365-4bf2-a490-247075e3cede
                      identifier: BE19519469892112
                      scheme: IBAN
                      country: BE
                      currency: EUR
                      bank:
                        identifier: ABNABE2AIDJ
                        scheme: BIC
                      spaceId: 56079d21-a756-49fb-9286-9859c354aa69
                      ownedBySpace: true
                      active: true
                      ownerName: UP RO
                      isDefault: true
                    firstName: John
                    lastName: Doe
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
        '404':
          description: Connection UUID could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 404
                error: NOT_FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: The HTTP method was not allowed on this endpoint.
        default:
          description: Other error messages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
      security:
      - oauth2:
        - space_write
  /transaction/v3/spaces/{spaceId}/connections/{connectionId}/connectors:
    put:
      tags:
      - Connections
      summary: Create/update connectors in the connection v3.
      description: '<div class=''my-preview''><span>Preview: The API is in development
        or testing phases and the interface could still change slightly.</span></div>
        <br/> Create/update entire content inside the connectors of the given connectionId.
        <br/> Scope: space_write'
      operationId: replaceConnectorsV3
      parameters:
      - name: spaceId
        in: path
        description: The space identifier
        required: true
        schema:
          type: string
          format: uuid
      - name: connectionId
        in: path
        description: The connection identifier
        required: true
        schema:
          type: string
          format: uuid
        example: 1d0159ca-ab19-49d5-9e13-9d34afb03849
      requestBody:
        description: Array of connectors
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/JsonBMap'
            example:
            - active: true
              extensionId: 00000001-0001-0000-0000-000000000001
              name: cross-peppol1
              namespace: com.unifiedpost.btx.connectors1
              settings:
                peppolAccessPoint: access-point1
                peppolID: '12345'
            - active: true
              extensionId: 00000001-0002-0000-0000-000000000001
              name: cross-peppol2
              namespace: com.unifiedpost.btx.connectors2
              settings:
                peppolAccessPoint: access-point2
                peppolID: '67890'
        required: true
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/JsonBMap'
              example:
              - active: true
                extensionId: 00000001-0001-0000-0000-000000000001
                name: cross-peppol1
                namespace: com.unifiedpost.btx.connectors1
                settings:
                  peppolAccessPoint: access-point1
                  peppolID: '12345'
              - active: true
                extensionId: 00000001-0002-0000-0000-000000000001
                name: cross-peppol2
                namespace: com.unifiedpost.btx.connectors2
                settings:
                  peppolAccessPoint: access-point2
                  peppolID: '67890'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 400
                error: BAD_REQUEST
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Bad Request
                detail: Bad Request message details.
        '404':
          description: Connection UUID could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
              example:
                status: 404
                error: NOT_FOUND
                requestId: a78150d2-7913-4ea6-933f-286cadac6745
                timestamp: 2018-08-27 12:34:50+00:00
                type: about:blank
                title: Not Found
                detail: The HTTP method was not allowed on this endpoint.
        default:
          description: Other error messages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorProblemDetail'
      security:
      - oauth2:
        - space_write
  /business/v1/spaces/{spaceId}/network/connections:
    post:
      description: 'Created connection on the given space with generated local identifier
        <br/> Scope: space_write'
      operationId: createConnection
      parameters:
      - in: path
        name: spaceId
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            examples:
              BusinessConnection:
                description: BusinessConnection
                value:
                  type: BUSINESS
                  globalIdentifiers:
                    fr:siren: '530514157'
                    fr:siret: '53051415700029'
                    nl:kvk: '87654321'
                    be:en: 0400282475
                    be:vat: BE0400282475
                    global:email:
                    - john@example.com
                    global:phoneNumber:
                    - '+1234567890'
                  alias: UP
                  connectionStatus: CONNECTED
                  relationTypes:
                  - CUSTOMER
                  addresses:
                    main:
                      streetName: Nitzsche Lodge
                      house: '80728'
                      postalCode: '3110'
                      city: Fernandahaven
                      country: Belgium
                      countryCode: BE
                  tags:
                  - favorite
                  - liked
                  active: true
                  metadata:
                    channels:
                      main: delivery_on_platform
                      secondary: email
                    department: Accounting
                    logo: https://somelinks.com/logo.jpg
                    website: https://mycompanywebsite.com
                    notes: some notes
                    industry: Agriculture, Forestry And Fishing
                  legalName: Unifiedpost Group
                  tradeName: unifiedpost
                  businessType: ENTERPRISE
              PersonConnection:
                description: PersonConnection
                value:
                  type: PERSON
                  globalIdentifiers:
                    global:email:
                    - john@example.com
                    global:phoneNumber:
                    - '+1234567890'
                  alias: UP
                  connectionStatus: CONNECTED
                  relationTypes:
                  - CUSTOMER
                  addresses:
                    main:
                      streetName: Milo Crossroad
                      house: '7850'
                      postalCode: '3100'
                      city: Kubhaven
                      country: Belgium
                      countryCode: BE
                  tags:
                  - favorite
                  - liked
                  active: true
                  metadata:
                    channels:
                      main: delivery_on_platform
                      secondary: email
                    department: Accounting
                    logo: https://somelinks.com/logo.jpg
                    website: https://mycompanywebsite.com
                    notes: some notes
                    industry: Agriculture, Forestry And Fishing
                  firstName: John
                  lastName: Doe
            schema:
              $ref: '#/components/schemas/ConnectionInput'
        description: Connection to add
        required: true
      responses:
        '201':
          content:
            application/json:
              examples:
                Business Connection:
                  description: Business Connection
                  value:
                    type: business
                    id: 00000001-0000-0000-0000-000000000000
                    spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                    globalIdentifiers:
                      be:vat: '123456789'
                      fr:siret: '12345678901234'
                      global:email:
                      - john@example.com
                      global:phoneNumber:
                      - '00301234567'
                      nl:kvk: '87654321'
                    assignedAccountId: '001'
                    alias: UP
                    connectionStatus: CONNECTED
                    relationTypes:
                    - CUSTOMER
                    addresses:
                      main:
                        streetName: Nitzsche Lodge
                        house: '80728'
                        postalCode: '3110'
                        city: Fernandahaven
                        country: Belgium
                        countryCode: BE
                    tags:
                    - favorite
                    - liked
                    active: true
                    metadata:
                      channels:
                        main: delivery_on_platform
                        secondary: email
                      department: Accounting
                      industry: Agriculture, Forestry And Fishing
                      logo: https://somelinks.com/logo.jpg
                      notes: some notes
                      website: https://mycompanywebsite.com
                    connectors:
                    - active: true
                      extensionId: 00000001-0001-0000-0000-000000000001
                      name: cross-peppol
                      namespace: com.unifiedpost.btx.connectors
                      settings:
                        peppolAccessPoint: access-point
                        peppolID: '12345'
                    paymentAccounts:
                    - id: 0ca2797b-6365-4bf2-a490-247075e3cede
                      identifier: BE19519469892112
                      scheme: IBAN
                      country: BE
                      currency: EUR
                      bank:
                        identifier: ABNABE2AIDJ
                        scheme: BIC
                      spaceId: 56079d21-a756-49fb-9286-9859c354aa69
                      ownedBySpace: true
                      active: true
                      ownerName: UP RO
                      isDefault: true
                    legalName: Unifiedpost Group
                    tradeName: unifiedpost
                    businessType: ENTERPRISE
                Person Connection:
                  description: Person Connection
                  value:
                    type: person
                    id: 00000002-0000-0000-0000-000000000000
                    spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                    globalIdentifiers:
                      global:email:
                      - john@example.com
                      global:phoneNumber:
                      - '00301234567'
                    assignedAccountId: '001'
                    alias: UP
                    connectionStatus: CONNECTED
                    relationTypes:
                    - CUSTOMER
                    addresses:
                      main:
                        streetName: Milo Crossroad
                        house: '7850'
                        postalCode: '3100'
                        city: Kubhaven
                        country: Belgium
                        countryCode: BE
                    tags:
                    - favorite
                    - liked
                    active: true
                    metadata:
                      channels:
                        main: delivery_on_platform
                        secondary: email
                      department: Accounting
                      industry: Agriculture, Forestry And Fishing
                      logo: https://somelinks.com/logo.jpg
                      notes: some notes
                      website: https://mycompanywebsite.com
                    connectors:
                    - active: true
                      name: email
                      settings:
                        emailAddress: john.doe@example.com
                    paymentAccounts:
                    - id: 0ca2797b-6365-4bf2-a490-247075e3cede
                      identifier: BE19519469892112
                      scheme: IBAN
                      country: BE
                      currency: EUR
                      bank:
                        identifier: ABNABE2AIDJ
                        scheme: BIC
                      spaceId: 56079d21-a756-49fb-9286-9859c354aa69
                      ownedBySpace: true
                      active: true
                      ownerName: UP RO
                      isDefault: true
                    firstName: John
                    lastName: Doe
              schema:
                $ref: '#/components/schemas/ConnectionDetails'
          description: Connection was created successfully.
        '403':
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ConnectionDetails'
                - $ref: '#/components/schemas/BusinessConnectionDetails'
                - $ref: '#/components/schemas/PersonConnectionDetails'
          description: Permission Denied
        '409':
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ConnectionDetails'
                - $ref: '#/components/schemas/BusinessConnectionDetails'
                - $ref: '#/components/schemas/PersonConnectionDetails'
          description: Conflicted space locked setting
        '422':
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ConnectionDetails'
                - $ref: '#/components/schemas/BusinessConnectionDetails'
                - $ref: '#/components/schemas/PersonConnectionDetails'
          description: Unprocessable Entity
      security:
      - oauth2:
        - space_write
      summary: Create connection on the given space
      tags:
      - Connections
  /business/v1/spaces/{spaceId}/network/connections/template:
    get:
      description: 'Download import business partners template on the given space.
        Use the Accept header to request the desired format: ''text/csv'' (default)
        or ''application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'' for
        Excel. <br/> Scope: space_read'
      operationId: downloadImportConnectionsTemplate
      parameters:
      - in: path
        name: spaceId
        required: true
        schema:
          type: string
          format: uuid
      - in: header
        name: Accept
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
              schema:
                type: string
                format: binary
            text/csv:
              schema:
                type: string
                format: binary
          description: Template file (CSV by default, or XLSX when requested via Accept
            header).
        '403':
          content:
            application/json:
              schema:
                type: string
                format: binary
          description: Permission Denied
        '422':
          content:
            application/json:
              schema:
                type: string
                format: binary
          description: Unprocessable Entity
      security:
      - oauth2:
        - space_read
      summary: Download import business partners template on the given space
      tags:
      - Connections
  /business/v1/spaces/{spaceId}/network/connections/{connectionId}:
    patch:
      description: 'Update the connection by its ID on the given space <br/> Scope:
        space_write'
      operationId: updateConnection
      parameters:
      - in: path
        name: spaceId
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: connectionId
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            examples:
              BusinessUpdateConnection:
                description: BusinessUpdateConnection
                value:
                  type: business
                  globalIdentifiers:
                    fr:siren: '530514157'
                    fr:siret: '53051415700029'
                    nl:kvk: '87654321'
                    be:en: 0400282475
                    be:vat: BE0400282475
                    global:email:
                    - john@example.com
                    global:phoneNumber:
                    - '+1234567890'
                  alias: UP
                  connectionStatus: CONNECTED
                  relationTypes:
                  - CUSTOMER
                  addresses:
                    main:
                      addressType: BIZZ
                      streetName: Nitzsche Lodge
                      buildingNumber: '80728'
                      postCode: '3110'
                      townName: Fernandahaven
                      country: BE
                  tags:
                  - favorite
                  - liked
                  active: true
                  metadata:
                    channels:
                      main: delivery_on_platform
                      secondary: email
                    department: Accounting
                    logo: https://somelinks.com/logo.jpg
                    website: https://mycompanywebsite.com
                    notes: some notes
                    industry: Agriculture, Forestry And Fishing
                  legalName: Unifiedpost Group
                  tradeName: unifiedpost
                  businessType: ENTERPRISE
              PersonUpdateConnection:
                description: PersonUpdateConnection
                value: "{\n  \"type\" : \"PERSON\",\n  \"globalIdentifiers\" : {\n\
                  \t\"global:email\" : [ \"john@example.com\" ],\n\t\"global:phoneNumber\"\
                  \ : [ \"+1234567890\" ]\n  },\n  \"alias\" : \"UP\",\n  \"connectionStatus\"\
                  \ : \"CONNECTED\",\n  \"relationTypes\" : [ \"CUSTOMER\" ],\n  \"\
                  addresses\" : {\n\t\"main\" : {\n\t  \"addressType\": \"BIZZ\",\n\
                  \t  \"streetName\": \"Milo Crossroad\",\n\t  \"buildingNumber\"\
                  \ : \"80728\",\n\t  \"postCode\": \"3110\",\n\t  \"townName\": \"\
                  Fernandahaven\",\n\t  \"country\": \"BE\"\n  },\n  \"tags\" : [\
                  \ \"favorite\", \"liked\" ],\n  \"active\" : true,\n  \"metadata\"\
                  \ : {\n\t\"channels\" : {\n\t  \"main\" : \"delivery_on_platform\"\
                  ,\n\t  \"secondary\" : \"email\"\n\t},\n\t\"department\" : \"Accounting\"\
                  ,\n\t\"logo\" : \"https://somelinks.com/logo.jpg\",\n\t\"website\"\
                  \ : \"https://mycompanywebsite.com\",\n\t\"notes\" : \"some notes\"\
                  ,\n\t\"industry\" : \"Agriculture, Forestry And Fishing\"\n  },\n\
                  \  \"firstName\" : \"John\",\n  \"lastName\" : \"Doe\"\n}"
            schema:
              $ref: '#/components/schemas/UpdateConnectionInput'
        description: Connection to update
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                Business Update Connection:
                  description: Business Update Connection
                  value:
                    type: business
                    id: 00000001-0000-0000-0000-000000000000
                    spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                    globalIdentifiers:
                      be:vat: '123456789'
                      fr:siret: '12345678901234'
                      global:email:
                      - john@example.com
                      global:phoneNumber:
                      - '00301234567'
                      nl:kvk: '87654321'
                    assignedAccountId: '001'
                    alias: UP
                    connectionStatus: CONNECTED
                    relationTypes:
                    - CUSTOMER
                    addresses:
                      main:
                        streetName: Nitzsche Lodge
                        house: '80728'
                        postalCode: '3110'
                        city: Fernandahaven
                        country: Belgium
                        countryCode: BE
                    tags:
                    - favorite
                    - liked
                    active: true
                    metadata:
                      channels:
                        main: delivery_on_platform
                        secondary: email
                      department: Accounting
                      industry: Agriculture, Forestry And Fishing
                      logo: https://somelinks.com/logo.jpg
                      notes: some notes
                      website: https://mycompanywebsite.com
                    connectors:
                    - active: true
                      extensionId: 00000001-0001-0000-0000-000000000001
                      name: cross-peppol
                      namespace: com.unifiedpost.btx.connectors
                      settings:
                        peppolAccessPoint: access-point
                        peppolID: '12345'
                    paymentAccounts:
                    - id: 0ca2797b-6365-4bf2-a490-247075e3cede
                      identifier: BE19519469892112
                      scheme: IBAN
                      country: BE
                      currency: EUR
                      bank:
                        identifier: ABNABE2AIDJ
                        scheme: BIC
                      spaceId: 56079d21-a756-49fb-9286-9859c354aa69
                      ownedBySpace: true
                      active: true
                      ownerName: UP RO
                      isDefault: true
                    legalName: Unifiedpost Group
                    tradeName: unifiedpost
                    businessType: ENTERPRISE
                Person Update Connection:
                  description: Person Update Connection
                  value:
                    type: person
                    id: 00000002-0000-0000-0000-000000000000
                    spaceUrl: https://entity.store/entitystore/v1/directory/entities/entity_1/spaces/space_1
                    globalIdentifiers:
                      global:email:
                      - john@example.com
                      global:phoneNumber:
                      - '00301234567'
                    assignedAccountId: '001'
                    alias: UP
                    connectionStatus: CONNECTED
                    relationTypes:
                    - CUSTOMER
                    addresses:
                      main:
                        streetName: Milo Crossroad
                        house: '7850'
                        postalCode: '3100'
                        city: Kubhaven
                        country: Belgium
                        countryCode: BE
                    tags:
                    - favorite
                    - liked
                    active: true
                    metadata:
                      channels:
                        main: delivery_on_platform
                        secondary: email
                      department: Accounting
                      industry: Agriculture, Forestry And Fishing
                      logo: https://somelinks.com/logo.jpg
                      notes: some notes
                      website: https://mycompanywebsite.com
                    connectors:
                    - active: true
                      name: email
                      settings:
                        emailAddress: john.doe@example.com
                    paymentAccounts:
                    - id: 0ca2797b-6365-4bf2-a490-247075e3cede
                      identifier: BE19519469892112
                      scheme: IBAN
                      country: BE
                      currency: EUR
                      bank:
                        identifier: ABNABE2AIDJ
                        scheme: BIC
                      spaceId: 56079d21-a756-49fb-9286-9859c354aa69
                      ownedBySpace: true
                      active: true
                      ownerName: UP RO
                      isDefault: true
                    firstName: John
                    lastName: Doe
              schema:
                $ref: '#/components/schemas/UpdateConnectionInput'
          description: Connection was updated successfully.
        '403':
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ConnectionDetails'
                - $ref: '#/components/schemas/BusinessConnectionDetails'
                - $ref: '#/components/schemas/PersonConnectionDetails'
          description: Permission Denied
        '409':
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ConnectionDetails'
                - $ref: '#/components/schemas/BusinessConnectionDetails'
                - $ref: '#/components/schemas/PersonConnectionDetails'
          description: Conflicted space locked setting
        '422':
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ConnectionDetails'
                - $ref: '#/components/schemas/BusinessConnectionDetails'
                - $ref: '#/components/schemas/PersonConnectionDetails'
          description: Unprocessable Entity
      security:
      - oauth2:
        - space_write
      summary: Update the connection
      tags:
      - Connections
  /business/v1/spaces/{spaceId}/network/connections/{connectionId}/connectors:
    get:
      description: 'Returns a list of connectors that can be used to interact with
        the connection. <br/> Scope: space_read'
      operationId: listConnectionConnectors
      parameters:
      - in: path
        name: spaceId
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: connectionId
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionConnectorResponse'
          description: Get connectors for a connection.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionConnectorResponse'
          description: Unprocessable Entity
      security:
      - oauth2:
        - space_read
      summary: Get connectors for a connection
      tags:
      - Connections
  /business/v1/spaces/{spaceId}/network/connections:import:
    post:
      description: 'Created or updated connections on the given space <br/> Scope:
        space_write'
      operationId: importConnections
      parameters:
      - in: path
        name: spaceId
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          multipart/form-data:
            encoding:
              file:
                contentType: text/csv, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
              required:
              - file
        description: File to import.
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportConnectionsResponse'
          description: File csv was processed successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportConnectionsResponse'
          description: Bad Request - e.g., file part is missing
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportConnectionsResponse'
          description: Permission Denied
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportConnectionsResponse'
          description: Unprocessable Entity
      security:
      - oauth2:
        - space_write
      summary: Import bulk connections on the given space
      tags:
      - Connections
components:
  schemas:
    JsonBMap:
      type: object
      additionalProperties: true
    JsonBMapNullable:
      type: object
      additionalProperties: true
      nullable: true
    PatchRequest:
      type: array
      items:
        $ref: '#/components/schemas/PatchDocument'
    PatchDocument:
      required:
      - op
      - path
      type: object
      properties:
        op:
          type: string
          description: The operation to be performed
          enum:
          - add
          - remove
          - replace
          - move
          - copy
          - test
        path:
          type: string
          description: A JSON-Pointer
        value:
          type: object
          description: The value to be used within the operations.
        from:
          type: string
          description: A string containing a JSON Pointer value.
      description: A JSONPatch document as defined by RFC 6902
    BusinessConnectionDetailsResult:
      required:
      - connectionStatus
      type: object
      allOf:
      - $ref: '#/components/schemas/ConnectionDetailsResult'
      - type: object
        properties:
          legalName:
            type: string
            description: Legal name of business
          tradeName:
            type: string
            description: Trade name of business
          businessType:
            $ref: '#/components/schemas/BusinessConnectionType'
    BusinessConnectionType:
      type: string
      description: Business connection type
      nullable: true
      example: ENTERPRISE
      enum:
      - GOVERNMENT
      - ENTERPRISE
      - PRIVATE_PERSON
    ConnectionDetailsResult:
      required:
      - connectionStatus
      type: object
      properties:
        type:
          type: string
          description: discriminator to determine PersonConnectionDetailsResult /
            BusinessConnectionDetailsResult
          example: person
          enum:
          - business
          - person
        id:
          type: string
          description: Connection ID
          format: uuid
        spaceUrl:
          type: string
          description: URL to the BTX Space endpoint of this connection in the connection's
            entity store
        globalIdentifiers:
          $ref: '#/components/schemas/JsonBMap'
        localIdentifier:
          type: string
          description: Local identifier. Please use assignedAccountId instead!
          deprecated: true
        assignedAccountId:
          type: string
          description: Assigned Account Id
        alias:
          type: string
          description: Nickname for the connection
        connectionStatus:
          $ref: '#/components/schemas/ConnectionStatus'
        relationType:
          $ref: '#/components/schemas/ConnectionRelationType'
        addresses:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SepaStructuredAddress'
          description: Connection addresses
        tags:
          type: array
          description: Tags
          items:
            type: string
            description: Tags
        active:
          type: boolean
          description: Active / Not active
        createdAt:
          type: string
          description: creation datetime
          format: date-time
        metadata:
          $ref: '#/components/schemas/JsonBMap'
        connectors:
          type: array
          description: Connectors
          items:
            $ref: '#/components/schemas/JsonBMap'
      description: discriminator to determine PersonConnectionDetailsResult / BusinessConnectionDetailsResult
      example: person
      discriminator:
        propertyName: type
        mapping:
          business: '#/components/schemas/BusinessConnectionDetailsResult'
          person: '#/components/schemas/PersonConnectionDetailsResult'
    ConnectionRelationResult:
      type: object
      properties:
        id:
          type: string
          description: Connection relation ID
          format: uuid
        connection:
          $ref: '#/components/schemas/ConnectionDetailsResult'
        role:
          type: string
          description: The role of the connection
        createdAt:
          type: string
          description: creation datetime
          format: date-time
        updatedAt:
          type: string
          description: updated datetime
          format: date-time
    ConnectionRelationType:
      type: string
      description: Connection relation type
      example: CUSTOMER
      enum:
      - CUSTOMER
      - SUPPLIER
      - ACCOUNTANT
      - PARTNER
      - GROUP
    ConnectionStatus:
      type: string
      description: Connection status
      nullable: true
      example: INVITED
      enum:
      - INVITED
      - PENDING
      - CONNECTED
      - DISCONNECTED
      - CREATED
    PersonConnectionDetailsResult:
      required:
      - connectionStatus
      type: object
      allOf:
      - $ref: '#/components/schemas/ConnectionDetailsResult'
      - type: object
        properties:
          firstName:
            type: string
            description: Person first name
          lastName:
            type: string
            description: Person last name
    SepaStructuredAddress:
      type: object
      properties:
        streetName:
          type: string
          description: Name of the street
          example: Avenue Reine Astrid
        house:
          type: string
        buildingNumber:
          type: string
          description: A unique number assigned to the building in the street or area
          example: A22
        level:
          type: string
        postalCode:
          type: string
          description: Series of letters or digits or both, included in a postal address
          example: 12345-1A
        city:
          type: string
          description: Name of the city
          example: La Hulpe
        state:
          type: string
          description: Name of the state
          example: California
        country:
          type: string
          description: Name of the country
          example: Belgium
        countryCode:
          type: string
          description: Two-letter country code defined in ISO 3166
          example: BE
        province:
          type: string
        postalCodeExtension:
          type: string
        department:
          maxLength: 70
          type: string
          description: Identification of a division of a large organisation or building.
          example: Finance
        subDepartment:
          maxLength: 70
          type: string
          description: Identification of a sub-division of a large organisation or
            building.
          example: Accounting
        buildingName:
          maxLength: 35
          type: string
          description: Name of the building or house.
          example: Empire State Building
        floor:
          maxLength: 70
          type: string
          description: A unique number or name assigned to the floor within the building
          example: ground
        postBox:
          maxLength: 16
          type: string
          description: Numbered box in a post office, assigned to a person or organisation,
            where letters are kept until called for.
          example: '1033'
        room:
          maxLength: 70
          type: string
          description: Building room number.
          example: '2.22'
        cityLocationName:
          maxLength: 35
          type: string
          description: Specific location name within the town.
          example: City center
        district:
          type: string
          description: Identifies a subdivision within a country sub-division
          example: Walloon Brabant
        subDistrict:
          maxLength: 35
          type: string
          description: Identifies a subdivision of a country such as state, region,
            county.
          example: Wallonia
      description: 'EPC Interbank Structured Address Structure. Structured addresses
        are address information split into several fields instead of one unstructured
        address field.

        From November 2023, all banks and PSPs will have to accept payment messages
        with structured addresses.

        From 2025, banks and PSPs will have to send all their messages with structured
        addresses.

        '
      nullable: true
      externalDocs:
        description: More about EPC Interbank Structured Address Structure
        url: https://www.europeanpaymentscouncil.eu/sites/default/files/kb/file/2022-10/EPC153-22%20EPC%20guidance%20document%20-%20Use%20of%20Structured%20Address%20under%20the%20SEPA%20Payment%20Schemes%20as%20of%20Nov%202025.pdf
    ApiErrorProblemDetail:
      required:
      - error
      - requestId
      - timestamp
      type: object
      properties:
        status:
          type: integer
          format: int32
        error:
          type: string
        requestId:
          type: string
        timestamp:
          type: string
          format: date-time
        type:
          type: string
          format: uri
        title:
          type: string
        detail:
          type: string
        instance:
          type: string
          format: uri
        problems:
          type: array
          items:
            $ref: '#/components/schemas/NestedProblem'
        properties:
          type: object
          additionalProperties:
            type: object
    NestedProblem:
      required:
      - detail
      - error
      - title
      type: object
      properties:
        error:
          type: string
        title:
          type: string
        detail:
          type: string
        type:
          type: string
          format: uri
    ConnectionRelationRequest:
      type: object
      properties:
        role:
          type: string
          description: The role of the connection relation
        relatedConnectionId:
          type: string
          description: The ID of the target connection
          format: uuid
    AllConnectionRelationResult:
      type: object
      properties:
        connection_relations:
          type: array
          description: List of connection relations
          items:
            $ref: '#/components/schemas/ConnectionRelationResult'
        totalElements:
          type: integer
          description: Total number of items in the database that correspond to this
            search criteria
          format: int64
        currentPage:
          type: integer
          description: Current page
          format: int32
        pageSize:
          type: integer
          description: Response page size
          format: int32
    UpdateConnectionRelationRequest:
      type: object
      properties:
        role:
          type: string
          description: The role of the connection relation
        relatedConnectionId:
          type: string
          description: The ID of the target connection
          format: uuid
    ConnectorRequest:
      type: object
      properties:
        empty:
          type: boolean
      additionalProperties:
        type: object
    AccountIdentifier:
      type: object
      properties:
        identifier:
          type: string
          description: Account Identifier
          example: BE83504010119715
          minLength: 1
        scheme:
          type: string
          description: Account Scheme
          example: IBAN
        bank:
          $ref: '#/components/schemas/BankIdentifier'
        country:
          pattern: ^[a-zA-Z]{2}
          type: string
          example: BE
        currency:
          pattern: '[A-Z]{3}'
          type: string
          description: International code ISO 4217 of the currency used
          example: EUR
        parent:
          $ref: '#/components/schemas/AccountIdentifier'
      description: Parent payment account
      required:
      - currency
      - identifier
      - scheme
    BankIdentifier:
      type: object
      properties:
        identifier:
          type: string
          description: Bank Identifier
          example: PANXBEB1XXX
          minLength: 1
        scheme:
          type: string
          description: Bank Identifier Scheme
          example: BIC
          enum:
          - BIC
          - CODE
          - ABA
          - CLABE
          - THIRD_PARTY
      description: Information about the issuer of the account
      required:
      - identifier
      - scheme
    BusinessConnectionDetailsResultWithPaymentAccounts:
      required:
      - connectionStatus
      type: object
      allOf:
      - $ref: '#/components/schemas/ConnectionDetailsResultWithPaymentAccounts'
      - type: object
        properties:
          legalName:
            type: string
            description: Legal name of business
          tradeName:
            type: string
            description: Trade name of business
          businessType:
            $ref: '#/components/schemas/BusinessConnectionType'
    ConnectionDetailsResultWithPaymentAccounts:
      required:
      - connectionStatus
      type: object
      properties:
        type:
          type: string
          description: discriminator to determine PersonConnectionDetailsResult /
            BusinessConnectionDetailsResult
          example: person
          enum:
          - business
          - person
        id:
          type: string
          description: Connection ID
          format: uuid
        spaceUrl:
          type: string
          description: URL to the BTX Space endpoint of this connection in the connection's
            entity store
        globalIdentifiers:
          $ref: '#/components/schemas/JsonBMap'
        localIdentifier:
          type: string
          description: Local identifier. Please use assignedAccountId instead!
          deprecated: true
        assignedAccountId:
          type: string
          description: Assigned Account Id
        alias:
          type: string
          description: Nickname for the connection
        connectionStatus:
          $ref: '#/components/schemas/ConnectionStatus'
        relationType:
          $ref: '#/components/schemas/ConnectionRelationType'
        addresses:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SepaStructuredAddress'
          description: Connection addresses
        tags:
          type: array
          description: Tags
          items:
            type: string
            description: Tags
        active:
          type: boolean
          description: Active / Not active
        createdAt:
          type: string
          description: creation datetime
          format: date-time
        metadata:
          $ref: '#/components/schemas/JsonBMap'
        connectors:
          type: array
          description: Connectors
          items:
            $ref: '#/components/schemas/JsonBMap'
        paymentAccounts:
          uniqueItems: true
          type: array
          description: Payment accounts linked to connection
          items:
            $ref: '#/components/schemas/PaymentAccountListItem'
      description: discriminator to determine PersonConnectionDetailsResultWithPaymentAccounts
        / BusinessConnectionDetailsResultWithPaymentAccounts
      example: person
      discriminator:
        propertyName: type
        mapping:
          business: '#/components/schemas/BusinessConnectionDetailsResultWithPaymentAccounts'
          person: '#/components/schemas/PersonConnectionDetailsResultWithPaymentAccounts'
    Iso20022StructuredAddress:
      type: object
      properties:
        country:
          type: string
          description: Nation with its own government, expressed as a two letter ISO
            3166 code (alpha-2) of the country. The country code is written in upper
            case.
          example: BE
        townName:
          type: string
          description: Name of a built-up area, with defined boundaries, and a local
            government.
          example: La Hulpe
        addressType:
          type: string
          description: Identifies the nature of the postal address.
          example: ADDR
          enum:
          - ADDR
          - PBOX
          - HOME
          - BIZZ
          - MLTO
          - DLVY
        streetName:
          maxLength: 140
          type: string
          description: Name of a street or thoroughfare.
          example: Avenue Reine Astrid
        buildingNumber:
          maxLength: 16
          type: string
          description: A unique number assigned to the building in the street or area
            //Number that identifies the position of a building on a street.
          example: '40'
        careOf:
          maxLength: 140
          type: string
          description: Identifies an addressee that is accepting the correspondence
            for the intended recipient. Using care of ensures the correspondence reaches
            the right recipient rather than getting returned to the sender.
          example: Finance
        department:
          maxLength: 70
          type: string
          description: Identification of a division of a large organisation or building.
          example: Finance
        subDepartment:
          maxLength: 70
          type: string
          description: Identification of a sub-division of a large organisation or
            building.
          example: Accounting
        buildingName:
          maxLength: 140
          type: string
          description: Name of the building or house.
          example: Empire State Building
        floor:
          maxLength: 70
          type: string
          description: Floor or storey within a building.
          example: ground
        unitNumber:
          maxLength: 16
          type: string
          description: Identifies a flat or dwelling within the building.
          example: '2'
        postBox:
          maxLength: 16
          type: string
          description: Numbered box in a post office, assigned to a person or organisation,
            where letters are kept until called for.
          example: '1003'
        room:
          maxLength: 70
          type: string
          description: Building room number.
          example: '2.22'
        postCode:
          maxLength: 16
          type: string
          description: Identifier consisting of a group of letters and/or numbers
            that is added to a postal address to assist the sorting of mail.
          example: '1310'
        townLocationName:
          maxLength: 140
          type: string
          description: Specific location name within the town. eg Borough (USA), Village
            (GB).
          example: Miami Beach
        districtName:
          maxLength: 140
          type: string
          description: Identifies a subdivision within a country sub-division eg County
            (USA), Landkreis (DE).
          example: Miami-Dade, Coburg
        countrySubDivision:
          maxLength: 35
          type: string
          description: Identifies a subdivision of a country such as state (USA),
            Bundesland (DE), region, province,....
          example: Florida, Bayern, Wallonia, Hainaut
      description: Information that locates and identifies a specific address, as
        defined by postal services
      externalDocs:
        description: More about EPC Interbank Structured Address Structure; see also
          PostalAddress27 type in https://www.iso20022.org/message/22905/download
        url: https://www.europeanpaymentscouncil.eu/sites/default/files/kb/file/2022-10/EPC153-22%20EPC%20guidance%20document%20-%20Use%20of%20Structured%20Address%20under%20the%20SEPA%20Payment%20Schemes%20as%20of%20Nov%202025.pdf
    PaymentAccountListItem:
      type: object
      properties:
        id:
          type: string
          description: Payment account ID
          format: uuid
        identifier:
          type: string
          description: Identifier of the payment account
        scheme:
          type: string
          description: Scheme of the payment account
        country:
          type: string
          description: Country for the payment account
        currency:
          type: string
          description: Currency for the payment account
        bank:
          $ref: '#/components/schemas/BankIdentifier'
        spaceId:
          type: string
          description: Space id
          format: uuid
        ownedBySpace:
          type: boolean
          description: Flag to indicate if the space is the actual holder of the payment
            account.
        active:
          type: boolean
          description: Flag to indicate if the payment account is active or not.
        ownerName:
          type: string
          description: Name of owner.
        address:
          $ref: '#/components/schemas/Iso20022StructuredAddress'
        parent:
          $ref: '#/components/schemas/AccountIdentifier'
        financialPlatformId:
          type: string
          description: Optional identifier of the financial platform.
      description: Payment accounts linked to connection
    PersonConnectionDetailsResultWithPaymentAccounts:
      required:
      - connectionStatus
      type: object
      allOf:
      - $ref: '#/components/schemas/ConnectionDetailsResultWithPaymentAccounts'
      - type: object
        properties:
          firstName:
            type: string
            description: Person first name
          lastName:
            type: string
            description: Person last name
    BusinessConnectionRequest:
      required:
      - businessType
      - relationType
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/ConnectionRequest'
      - type: object
        properties:
          legalName:
            type: string
            description: Legal name of business
          tradeName:
            type: string
            description: Trade name of business
          businessType:
            $ref: '#/components/schemas/BusinessConnectionType'
    ConnectionRequest:
      required:
      - relationType
      - type
      type: object
      properties:
        type:
          type: string
          description: discriminator to determine PersonConnectionRequest / BusinessConnectionRequest
          example: person
          enum:
          - business
          - person
        spaceUrl:
          type: string
          description: URL to the BTX Space endpoint of this connection in the connection's
            entity store
        globalIdentifiers:
          $ref: '#/components/schemas/JsonBMap'
        localIdentifier:
          type: string
          description: Local identifier. Please use assignedAccountId instead!
          deprecated: true
        assignedAccountId:
          type: string
          description: Assigned Account Id
        alias:
          type: string
          description: Nickname for the connection
        connectionStatus:
          $ref: '#/components/schemas/ConnectionStatus'
        relationType:
          $ref: '#/components/schemas/ConnectionRelationType'
        addresses:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SepaStructuredAddress'
          description: Connection addresses
        tags:
          type: array
          description: Tags
          example:
          - tag1
          - tag2
          items:
            type: string
            description: Tags
            example: '["tag1","tag2"]'
        active:
          type: boolean
          description: Active / Not active
        metadata:
          $ref: '#/components/schemas/JsonBMap'
        paymentAccounts:
          uniqueItems: true
          type: array
          description: Payment accounts
          items:
            $ref: '#/components/schemas/NamedPaymentAccountDto'
      discriminator:
        propertyName: type
        mapping:
          person: '#/components/schemas/PersonConnectionRequest'
          business: '#/components/schemas/BusinessConnectionRequest'
    NamedPaymentAccountDto:
      type: object
      properties:
        identifier:
          type: string
          description: Account Identifier
          example: BE83504010119715
        scheme:
          type: string
          description: Account Scheme
          example: IBAN
        bank:
          $ref: '#/components/schemas/BankIdentifier'
        country:
          pattern: ^[a-zA-Z]{2}
          type: string
          example: BE
        currency:
          pattern: '[A-Z]{3}'
          type: string
          description: International code ISO 4217 of the currency used
          example: EUR
        parent:
          $ref: '#/components/schemas/AccountIdentifier'
        ownerName:
          type: string
          description: Name of the holder of this payment account.
      description: Payment accounts
    PersonConnectionRequest:
      required:
      - relationType
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/ConnectionRequest'
      - type: object
        properties:
          firstName:
            type: string
            description: Person first name
          lastName:
            type: string
            description: Person last name
    AllConnectionsResult:
      type: object
      properties:
        connections:
          type: array
          description: List of connections
          items:
            $ref: '#/components/schemas/ConnectionListItem'
        totalElements:
          type: integer
          description: Total number of items in the database that correspond to this
            search criteria
          format: int64
        currentPage:
          type: integer
          description: Current page
          format: int32
        pageSize:
          type: integer
          description: Response page size
          format: int32
    BusinessConnectionListItem:
      required:
      - connectionStatus
      type: object
      allOf:
      - $ref: '#/components/schemas/ConnectionListItem'
      - type: object
        properties:
          legalName:
            type: string
            description: Legal name of business
          tradeName:
            type: string
            description: Trade name of business
          businessType:
            $ref: '#/components/schemas/BusinessConnectionType'
    ConnectionListItem:
      required:
      - connectionStatus
      type: object
      properties:
        type:
          type: string
          description: discriminator to determine PersonConnectionListItem / BusinessConnectionListItem
          example: person
          enum:
          - business
          - person
        id:
          type: string
          description: Connection ID
          format: uuid
        globalIdentifiers:
          $ref: '#/components/schemas/JsonBMap'
        localIdentifier:
          type: string
          description: Local identifier. Please use `assignedAccountId` instead!
          deprecated: true
        assignedAccountId:
          type: string
          description: Assigned account id
        alias:
          type: string
          description: Nickname for the connection
        connectionStatus:
          $ref: '#/components/schemas/ConnectionStatus'
        relationType:
          $ref: '#/components/schemas/ConnectionRelationType'
        addresses:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SepaStructuredAddress'
          description: Connection addresses
        tags:
          type: array
          description: Tags
          items:
            type: string
            description: Tags
        active:
          type: boolean
          description: Active / Not active
        metadata:
          $ref: '#/components/schemas/JsonBMap'
        spaceUrl:
          type: string
          description: Space url
        createdAt:
          type: string
          description: Creation datetime
          format: date-time
      description: discriminator to determine PersonConnectionListItem / BusinessConnectionListItem
      example: person
      discriminator:
        propertyName: type
        mapping:
          business: '#/components/schemas/BusinessConnectionListItem'
          person: '#/components/schemas/PersonConnectionListItem'
    PersonConnectionListItem:
      required:
      - connectionStatus
      type: object
      allOf:
      - $ref: '#/components/schemas/ConnectionListItem'
      - type: object
        properties:
          firstName:
            type: string
            description: Person first name
          lastName:
            type: string
            description: Person last name
    UpdateBusinessConnectionRequest:
      required:
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/UpdateConnectionRequest'
      - type: object
        properties:
          legalName:
            type: string
            description: Legal name of business
          tradeName:
            type: string
            description: Trade name of business
          businessType:
            $ref: '#/components/schemas/BusinessConnectionType'
    UpdateConnectionRequest:
      required:
      - type
      type: object
      properties:
        type:
          type: string
          description: discriminator to determine PersonConnectionRequest / BusinessConnectionRequest
          example: person
          enum:
          - business
          - person
        spaceUrl:
          type: string
          description: URL to the BTX Space endpoint of this connection in the connection's
            entity store
        globalIdentifiers:
          $ref: '#/components/schemas/JsonBMap'
        localIdentifier:
          type: string
          description: Local identifier. Please use assignedAccountId instead!
          deprecated: true
        assignedAccountId:
          type: string
          description: Assigned Account Id
        alias:
          type: string
          description: Nickname for the connection
        connectionStatus:
          $ref: '#/components/schemas/ConnectionStatus'
        relationType:
          $ref: '#/components/schemas/ConnectionRelationType'
        addresses:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SepaStructuredAddress'
          description: Connection addresses
        tags:
          type: array
          description: Tags
          example:
          - tag1
          - tag2
          items:
            type: string
            description: Tags
            example: '["tag1","tag2"]'
        active:
          type: boolean
          description: Active / Not active
        metadata:
          $ref: '#/components/schemas/JsonBMap'
      discriminator:
        propertyName: type
        mapping:
          person: '#/components/schemas/UpdatePersonConnectionRequest'
          business: '#/components/schemas/UpdateBusinessConnectionRequest'
    UpdatePersonConnectionRequest:
      required:
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/UpdateConnectionRequest'
      - type: object
        properties:
          firstName:
            type: string
            description: Person first name
          lastName:
            type: string
            description: Person last name
    PaymentAccountConnectionDetails:
      type: object
      properties:
        id:
          type: string
          description: Connection ID
          format: uuid
        type:
          type: string
          description: Connection type
          example: person
        name:
          type: string
          description: Connection name
        alias:
          type: string
          description: Connection alias
        defaultPaymentAccount:
          type: boolean
          description: Flag to indicate if paymentAccount is default for this connection
      description: List of associated connection
    PaymentAccountResult:
      type: object
      properties:
        id:
          type: string
          description: Payment account ID
          format: uuid
        identifier:
          type: string
          description: Identifier of the payment account
        scheme:
          type: string
          description: Scheme of the payment account
        country:
          type: string
          description: Country for the payment account
        currency:
          type: string
          description: Currency for the payment account
        bank:
          $ref: '#/components/schemas/BankIdentifier'
        spaceId:
          type: string
          description: Space id
          format: uuid
        ownedBySpace:
          type: boolean
          description: Flag to indicate if the space is the actual holder of the payment
            account.
        active:
          type: boolean
          description: Flag to indicate if the payment account is active or not.
        ownerName:
          type: string
          description: Name of owner.
        address:
          $ref: '#/components/schemas/Iso20022StructuredAddress'
        parent:
          $ref: '#/components/schemas/AccountIdentifier'
        financialPlatformId:
          type: string
          description: Optional identifier of the financial platform.
        connections:
          type: array
          description: List of associated connection
          items:
            $ref: '#/components/schemas/PaymentAccountConnectionDetails'
        createdAt:
          type: string
          description: creation datetime
          format: date-time
        updatedAt:
          type: string
          description: updated datetime
          format: date-time
        entityPaymentAccountId:
          type: string
          description: entityPaymentAccountId in Payment Account
          format: uuid
    ConnectionPaymentAccountRequest:
      type: object
      properties:
        identifier:
          type: string
          description: Account Identifier
          example: BE83504010119715
        scheme:
          type: string
          description: Account Scheme
          example: IBAN
        bank:
          $ref: '#/components/schemas/BankIdentifier'
        country:
          pattern: ^[a-zA-Z]{2}
          type: string
          example: BE
        currency:
          pattern: '[A-Z]{3}'
          type: string
          description: International code ISO 4217 of the currency used
          example: EUR
        parent:
          $ref: '#/components/schemas/AccountIdentifier'
        ownerName:
          type: string
          description: Name of the holder of this payment account.
        address:
          $ref: '#/components/schemas/Iso20022StructuredAddress'
        ownedBySpace:
          type: boolean
          description: Flag to indicate if the space is the actual holder of the payment
            account. Default value is false.
        active:
          type: boolean
          description: Flag to indicate if the payment account is active or not. Default
            value is true.
        financialPlatformId:
          type: string
          description: Optional identifier of the financial platform associated with
            this payment account.
        isDefault:
          type: boolean
          description: Is default payment account of connection. If a default already
            exists, it will be overwritten in case you pass true!
          default: false
    AllPaymentAccountsResult:
      type: object
      properties:
        paymentAccounts:
          type: array
          description: List of payment accounts
          items:
            $ref: '#/components/schemas/PaymentAccountResult'
        totalElements:
          type: integer
          description: Total number of items in the database that correspond to this
            search criteria
          format: int64
        currentPage:
          type: integer
          description: Current page
          format: int32
        pageSize:
          type: integer
          description: Response page size
          format: int32
    ConnectionPaymentAccountListItem:
      type: object
      properties:
        id:
          type: string
          description: Payment account ID
          format: uuid
        identifier:
          type: string
          description: Identifier of the payment account
        scheme:
          type: string
          description: Scheme of the payment account
        country:
          type: string
          description: Country for the payment account
        currency:
          type: string
          description: Currency for the payment account
        bank:
          $ref: '#/components/schemas/BankIdentifier'
        spaceId:
          type: string
          description: Space id
          format: uuid
        ownedBySpace:
          type: boolean
          description: Flag to indicate if the space is the actual holder of the payment
            account.
        active:
          type: boolean
          description: Flag to indicate if the payment account is active or not.
        ownerName:
          type: string
          description: Name of owner.
        address:
          $ref: '#/components/schemas/Iso20022StructuredAddress'
        parent:
          $ref: '#/components/schemas/AccountIdentifier'
        financialPlatformId:
          type: string
          description: Optional identifier of the financial platform.
        isDefault:
          type: boolean
          description: Is default payment account of connection.
      description: Payment accounts linked to connection
    UpdateConnectionPaymentAccountRequest:
      type: object
      properties:
        ownerName:
          type: string
          description: Owner name
        isDefault:
          type: boolean
          description: flag to specify if payment account should be default nor not
            for current connection
        financialPlatformId:
          type: string
          description: Optional identifier of the financial platform associated with
            this payment account. Passing null clears the existing value.
    BusinessUnit:
      type: string
      description: Business Unit
      example: HEAD_OFFICE
      enum:
      - HEAD_OFFICE
      - BRANCH
      - OTHER
    TaxInfoResult:
      type: object
      properties:
        id:
          type: string
          description: TaxInfo id
          format: uuid
        corporateId:
          type: string
          description: Trade register number or corporate tax id (different from VAT
            ID)
        b2cIndicator:
          type: boolean
          description: B2C Indicator
        customerClassification:
          type: string
          description: Customer classification. Applies to customer connection only.
        smallEnterprise:
          type: boolean
          description: Small enterprise
        businessUnit:
          $ref: '#/components/schemas/BusinessUnit'
        taxRegistrations:
          type: array
          description: Tax registrations
          items:
            $ref: '#/components/schemas/TaxRegistrationResult'
    TaxRegistrationResult:
      type: object
      properties:
        id:
          type: string
          description: Tax registration id
        taxId:
          type: string
          description: Tax id
        country:
          type: string
          description: Country
        type:
          type: string
          description: Tax type
        voluntaryTax:
          type: boolean
          description: Voluntary tax flag
        oss:
          type: boolean
          description: Oss flag
        startDate:
          type: string
          description: Start Date
          format: date
        endDate:
          type: string
          description: End Date
          format: date
        vatGroup:
          $ref: '#/components/schemas/VatGroup'
    VatGroup:
      type: object
      properties:
        name:
          type: string
          description: VAT group name
        startDate:
          type: string
          description: VAT group start date
          format: date
        endDate:
          type: string
          description: VAT group end date
          format: date
      description: Vat Group
    TaxInfoRequest:
      type: object
      properties:
        corporateId:
          type: string
          description: Trade register number or corporate tax id (different from VAT
            ID)
        b2cIndicator:
          type: boolean
          description: B2C Indicator
        customerClassification:
          type: string
          description: Customer classification. Applies to customer connection only.
        smallEnterprise:
          type: boolean
          description: Small enterprise
        businessUnit:
          $ref: '#/components/schemas/BusinessUnit'
    TaxRegistrationRequest:
      type: object
      properties:
        taxId:
          type: string
          description: TaxId
        country:
          type: string
          description: Country
        type:
          type: string
          description: Type
        voluntaryTax:
          type: boolean
          description: Voluntary Tax
        oss:
          type: boolean
          description: oss
        startDate:
          type: string
          description: Start Date
          format: date
        endDate:
          type: string
          description: End Date
          format: date
        vatGroup:
          $ref: '#/components/schemas/VatGroup'
    BusinessConnectionDetailsResultV2:
      required:
      - active
      - connectionStatus
      - displayName
      - id
      - spaceUrl
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/ConnectionV2'
      - type: object
        properties:
          legalName:
            type: string
            description: Legal name of business
          tradeName:
            type: string
            description: Trade name of business
          businessType:
            $ref: '#/components/schemas/BusinessConnectionType'
    ConnectionV2:
      required:
      - active
      - connectionStatus
      - displayName
      - id
      - spaceUrl
      - type
      type: object
      properties:
        type:
          type: string
          description: discriminator to determine PersonConnectionV2 / BusinessConnectionV2
          example: person
          enum:
          - business
          - person
        id:
          type: string
          description: Connection ID
          format: uuid
        spaceUrl:
          type: string
          description: URL to the BTX Space endpoint of this connection in the connection's
            entity store
        globalIdentifiers:
          $ref: '#/components/schemas/JsonBMap'
        assignedAccountId:
          type: string
          description: Assigned Account Id
        alias:
          type: string
          description: Nickname for the connection
        connectionStatus:
          $ref: '#/components/schemas/ConnectionStatus'
        relationTypes:
          uniqueItems: true
          type: array
          description: Relation types of this connection
          items:
            $ref: '#/components/schemas/ConnectionRelationType'
        addresses:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SepaStructuredAddress'
          description: Connection addresses
        tags:
          type: array
          description: Tags
          items:
            type: string
            description: Tags
        active:
          type: boolean
          description: Active / Not active
        createdAt:
          type: string
          description: creation datetime
          format: date-time
        metadata:
          $ref: '#/components/schemas/JsonBMap'
        connectors:
          type: array
          description: Connectors of this connection.
          items:
            $ref: '#/components/schemas/JsonBMap'
        paymentAccounts:
          uniqueItems: true
          type: array
          description: Payment accounts linked to connection
          items:
            $ref: '#/components/schemas/ConnectionPaymentAccountListItem'
        displayName:
          type: string
          description: Display name
      description: discriminator to determine PersonConnectionV2 / BusinessConnectionV2
      example: person
      discriminator:
        propertyName: type
        mapping:
          business: '#/components/schemas/BusinessConnectionDetailsResultV2'
          person: '#/components/schemas/PersonConnectionDetailsResultV2'
    PersonConnectionDetailsResultV2:
      required:
      - active
      - connectionStatus
      - displayName
      - id
      - spaceUrl
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/ConnectionV2'
      - type: object
        properties:
          firstName:
            type: string
            description: Person first name
          lastName:
            type: string
            description: Person last name
    BusinessConnectionRequestV2:
      required:
      - businessType
      - relationTypes
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/ConnectionRequestV2'
      - type: object
        properties:
          legalName:
            type: string
            description: Legal name of business
          tradeName:
            type: string
            description: Trade name of business
          businessType:
            $ref: '#/components/schemas/BusinessConnectionType'
    ConnectionPaymentAccountItemV2:
      type: object
      properties:
        identifier:
          type: string
          description: Account Identifier
          example: BE83504010119715
        scheme:
          type: string
          description: Account Scheme
          example: IBAN
        bank:
          $ref: '#/components/schemas/BankIdentifier'
        country:
          pattern: ^[a-zA-Z]{2}
          type: string
          example: BE
        currency:
          pattern: '[A-Z]{3}'
          type: string
          description: International code ISO 4217 of the currency used
          example: EUR
        parent:
          $ref: '#/components/schemas/AccountIdentifier'
        isDefault:
          type: boolean
          description: Is default payment account of connection. If multiple with
            default=true => 400 response. If one without isDefault set, will consider
            'true'.
          default: true
        financialPlatformId:
          type: string
          description: Optional identifier of the financial platform associated with
            this payment account.
      example:
        identifier: BE19519469892112
        scheme: IBAN
        bank:
          identifier: ABNABE2AIDJ
          scheme: BIC
        country: BE
        currency: EUR
        isDefault: true
        financialPlatformId: platform-xyz
    ConnectionRequestV2:
      required:
      - relationTypes
      - type
      type: object
      properties:
        type:
          type: string
          description: discriminator to determine PersonConnectionRequestV2 / BusinessConnectionRequestV2
          example: person
          enum:
          - business
          - person
        spaceUrl:
          type: string
          description: URL to the BTX Space endpoint of this connection in the connection's
            entity store
        globalIdentifiers:
          $ref: '#/components/schemas/JsonBMap'
        assignedAccountId:
          type: string
          description: Assigned Account Id
        alias:
          type: string
          description: Nickname for the connection
        connectionStatus:
          $ref: '#/components/schemas/ConnectionStatus'
        relationTypes:
          uniqueItems: true
          type: array
          description: Relation types of this connection
          items:
            $ref: '#/components/schemas/ConnectionRelationType'
        addresses:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SepaStructuredAddress'
          description: Connection addresses
        tags:
          type: array
          description: Tags
          example:
          - tag1
          - tag2
          items:
            type: string
            description: Tags
            example: '["tag1","tag2"]'
        active:
          type: boolean
          description: Active / Not active
        metadata:
          $ref: '#/components/schemas/JsonBMap'
        connectors:
          type: array
          description: Array of connectors
          items:
            $ref: '#/components/schemas/JsonBMap'
        paymentAccounts:
          uniqueItems: true
          type: array
          description: Payment accounts
          items:
            $ref: '#/components/schemas/ConnectionPaymentAccountItemV2'
      discriminator:
        propertyName: type
        mapping:
          person: '#/components/schemas/PersonConnectionRequestV2'
          business: '#/components/schemas/BusinessConnectionRequestV2'
    PersonConnectionRequestV2:
      required:
      - relationTypes
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/ConnectionRequestV2'
      - type: object
        properties:
          firstName:
            type: string
            description: Person first name
          lastName:
            type: string
            description: Person last name
    ConnectionInclude:
      type: string
      description: The possible linked resources to include
      example: paymentAccounts
      enum:
      - paymentAccounts
    JsonPatch:
      type: object
    ListConnectionsResponseV2:
      type: object
      properties:
        connections:
          type: array
          description: List of connections
          items:
            $ref: '#/components/schemas/ConnectionV2'
        totalElements:
          type: integer
          description: Total number of items in the database that correspond to this
            search criteria
          format: int64
        currentPage:
          type: integer
          description: Current page
          format: int32
        pageSize:
          type: integer
          description: Response page size
          format: int32
    ANTLRErrorListener:
      type: object
    ATN:
      type: object
      properties:
        states:
          type: array
          items:
            $ref: '#/components/schemas/ATNState'
        decisionToState:
          type: array
          items:
            $ref: '#/components/schemas/DecisionState'
        ruleToStartState:
          type: array
          items:
            $ref: '#/components/schemas/RuleStartState'
        ruleToStopState:
          type: array
          items:
            $ref: '#/components/schemas/RuleStopState'
        modeNameToStartState:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/TokensStartState'
        grammarType:
          type: string
          enum:
          - LEXER
          - PARSER
        maxTokenType:
          type: integer
          format: int32
        ruleToTokenType:
          type: array
          items:
            type: integer
            format: int32
        lexerActions:
          type: array
          items:
            $ref: '#/components/schemas/LexerAction'
        modeToStartState:
          type: array
          items:
            $ref: '#/components/schemas/TokensStartState'
        numberOfDecisions:
          type: integer
          format: int32
    ATNConfig:
      type: object
      properties:
        state:
          $ref: '#/components/schemas/ATNState'
        alt:
          type: integer
          format: int32
        context:
          $ref: '#/components/schemas/PredictionContext'
        reachesIntoOuterContext:
          type: integer
          format: int32
        semanticContext:
          $ref: '#/components/schemas/SemanticContext'
        precedenceFilterSuppressed:
          type: boolean
        outerContextDepth:
          type: integer
          format: int32
    ATNConfigSet:
      uniqueItems: true
      type: array
      properties:
        readonly:
          type: boolean
        configLookup:
          type: array
          properties:
            empty:
              type: boolean
          items:
            $ref: '#/components/schemas/ATNConfig'
        configs:
          type: array
          items:
            $ref: '#/components/schemas/ATNConfig'
        uniqueAlt:
          type: integer
          format: int32
        hasSemanticContext:
          type: boolean
        dipsIntoOuterContext:
          type: boolean
        fullCtx:
          type: boolean
        empty:
          type: boolean
        alts:
          type: object
          properties:
            empty:
              type: boolean
        states:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/ATNState'
        predicates:
          type: array
          items:
            $ref: '#/components/schemas/SemanticContext'
      items:
        $ref: '#/components/schemas/ATNConfig'
    ATNState:
      type: object
      properties:
        atn:
          $ref: '#/components/schemas/ATN'
        stateNumber:
          type: integer
          format: int32
        ruleIndex:
          type: integer
          format: int32
        epsilonOnlyTransitions:
          type: boolean
        transitions:
          type: array
          items:
            $ref: '#/components/schemas/Transition'
        nextTokenWithinRule:
          $ref: '#/components/schemas/IntervalSet'
        stateType:
          type: integer
          format: int32
        nonGreedyExitState:
          type: boolean
        numberOfTransitions:
          type: integer
          format: int32
    AbstractConfigHashSet:
      type: array
      properties:
        empty:
          type: boolean
      items:
        $ref: '#/components/schemas/ATNConfig'
    AmbiguityInfo:
      type: object
      properties:
        decision:
          type: integer
          format: int32
        configs:
          uniqueItems: true
          type: array
          properties:
            readonly:
              type: boolean
            configLookup:
              type: array
              properties:
                empty:
                  type: boolean
              items:
                $ref: '#/components/schemas/ATNConfig'
            configs:
              type: array
              items:
                $ref: '#/components/schemas/ATNConfig'
            uniqueAlt:
              type: integer
              format: int32
            hasSemanticContext:
              type: boolean
            dipsIntoOuterContext:
              type: boolean
            fullCtx:
              type: boolean
            empty:
              type: boolean
            alts:
              type: object
              properties:
                empty:
                  type: boolean
            states:
              uniqueItems: true
              type: array
              items:
                $ref: '#/components/schemas/ATNState'
            predicates:
              type: array
              items:
                $ref: '#/components/schemas/SemanticContext'
          items:
            $ref: '#/components/schemas/ATNConfig'
        input:
          $ref: '#/components/schemas/TokenStream'
        startIndex:
          type: integer
          format: int32
        stopIndex:
          type: integer
          format: int32
        fullCtx:
          type: boolean
        ambigAlts:
          type: object
          properties:
            empty:
              type: boolean
    CharStream:
      type: object
      properties:
        sourceName:
          type: string
    ContextSensitivityInfo:
      type: object
      properties:
        decision:
          type: integer
          format: int32
        configs:
          uniqueItems: true
          type: array
          properties:
            readonly:
              type: boolean
            configLookup:
              type: array
              properties:
                empty:
                  type: boolean
              items:
                $ref: '#/components/schemas/ATNConfig'
            configs:
              type: array
              items:
                $ref: '#/components/schemas/ATNConfig'
            uniqueAlt:
              type: integer
              format: int32
            hasSemanticContext:
              type: boolean
            dipsIntoOuterContext:
              type: boolean
            fullCtx:
              type: boolean
            empty:
              type: boolean
            alts:
              type: object
              properties:
                empty:
                  type: boolean
            states:
              uniqueItems: true
              type: array
              items:
                $ref: '#/components/schemas/ATNState'
            predicates:
              type: array
              items:
                $ref: '#/components/schemas/SemanticContext'
          items:
            $ref: '#/components/schemas/ATNConfig'
        input:
          $ref: '#/components/schemas/TokenStream'
        startIndex:
          type: integer
          format: int32
        stopIndex:
          type: integer
          format: int32
        fullCtx:
          type: boolean
    DecisionInfo:
      type: object
      properties:
        decision:
          type: integer
          format: int32
        invocations:
          type: integer
          format: int64
        timeInPrediction:
          type: integer
          format: int64
        SLL_TotalLook:
          type: integer
          format: int64
        SLL_MinLook:
          type: integer
          format: int64
        SLL_MaxLook:
          type: integer
          format: int64
        SLL_MaxLookEvent:
          $ref: '#/components/schemas/LookaheadEventInfo'
        LL_TotalLook:
          type: integer
          format: int64
        LL_MinLook:
          type: integer
          format: int64
        LL_MaxLook:
          type: integer
          format: int64
        LL_MaxLookEvent:
          $ref: '#/components/schemas/LookaheadEventInfo'
        contextSensitivities:
          type: array
          items:
            $ref: '#/components/schemas/ContextSensitivityInfo'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorInfo'
        ambiguities:
          type: array
          items:
            $ref: '#/components/schemas/AmbiguityInfo'
        predicateEvals:
          type: array
          items:
            $ref: '#/components/schemas/PredicateEvalInfo'
        SLL_ATNTransitions:
          type: integer
          format: int64
        SLL_DFATransitions:
          type: integer
          format: int64
        LL_Fallback:
          type: integer
          format: int64
        LL_ATNTransitions:
          type: integer
          format: int64
        LL_DFATransitions:
          type: integer
          format: int64
    DecisionState:
      type: object
      properties:
        atn:
          $ref: '#/components/schemas/ATN'
        stateNumber:
          type: integer
          format: int32
        ruleIndex:
          type: integer
          format: int32
        epsilonOnlyTransitions:
          type: boolean
        transitions:
          type: array
          items:
            $ref: '#/components/schemas/Transition'
        nextTokenWithinRule:
          $ref: '#/components/schemas/IntervalSet'
        decision:
          type: integer
          format: int32
        nonGreedy:
          type: boolean
        stateType:
          type: integer
          format: int32
        nonGreedyExitState:
          type: boolean
        numberOfTransitions:
          type: integer
          format: int32
    ErrorInfo:
      type: object
      properties:
        decision:
          type: integer
          format: int32
        configs:
          uniqueItems: true
          type: array
          properties:
            readonly:
              type: boolean
            configLookup:
              type: array
              properties:
                empty:
                  type: boolean
              items:
                $ref: '#/components/schemas/ATNConfig'
            configs:
              type: array
              items:
                $ref: '#/components/schemas/ATNConfig'
            uniqueAlt:
              type: integer
              format: int32
            hasSemanticContext:
              type: boolean
            dipsIntoOuterContext:
              type: boolean
            fullCtx:
              type: boolean
            empty:
              type: boolean
            alts:
              type: object
              properties:
                empty:
                  type: boolean
            states:
              uniqueItems: true
              type: array
              items:
                $ref: '#/components/schemas/ATNState'
            predicates:
              type: array
              items:
                $ref: '#/components/schemas/SemanticContext'
          items:
            $ref: '#/components/schemas/ATNConfig'
        input:
          $ref: '#/components/schemas/TokenStream'
        startIndex:
          type: integer
          format: int32
        stopIndex:
          type: integer
          format: int32
        fullCtx:
          type: boolean
    IntStream:
      type: object
      properties:
        sourceName:
          type: string
    Interval:
      type: object
      properties:
        a:
          type: integer
          format: int32
        b:
          type: integer
          format: int32
    IntervalSet:
      type: object
      properties:
        intervals:
          type: array
          items:
            $ref: '#/components/schemas/Interval'
        readonly:
          type: boolean
        nil:
          type: boolean
        maxElement:
          type: integer
          format: int32
        minElement:
          type: integer
          format: int32
    LexerAction:
      type: object
      properties:
        actionType:
          type: string
          enum:
          - CHANNEL
          - CUSTOM
          - MODE
          - MORE
          - POP_MODE
          - PUSH_MODE
          - SKIP
          - TYPE
        positionDependent:
          type: boolean
    ListConnectionsQueryParamsSingle:
      type: object
      properties:
        name[eq]:
          type: string
          description: 'Exact match on name fields only (Case insensitive). Scope:
            Legal Name, Trade Name, First Name, Last Name.'
        search[eq]:
          type: string
          description: 'Exact match on names and identifiers (Case insensitive). Scope:
            Legal Name, Trade Name, First Name, Last Name, Alias, Local Identifier
            (Assigned Account ID), Global Identifiers.'
        search[cont]:
          type: string
          description: 'Substring (partial) match on names and identifiers (Case insensitive).
            Scope: Legal Name, Trade Name, First Name, Last Name, Alias, Local Identifier
            (Assigned Account ID), Global Identifiers.'
        search[has]:
          type: string
          description: 'Word/Token match on names and identifiers (Full Text Search).
            Finds records containing the input as a distinct word. Scope: Legal Name,
            Trade Name, First Name, Last Name, Alias, Local Identifier (Assigned Account
            ID), Global Identifiers.'
        identifierValue:
          type: string
          description: Connection identifier (e.g. VAT number)
        name:
          type: string
          description: Connection name for searching
        search:
          type: string
          description: Global search parameter. Supports partial matching for names
            (business/person) and strict matching for identifiers/aliases.
        type:
          type: string
        countryCode:
          type: string
          description: Connection address country code for searching
          example: BE
        assignedAccountId:
          type: string
          description: Assigned account id for searching (supports partial matches)
          example: '00044'
        businessType:
          type: string
        metadata[ql]:
          type: string
          description: Metadata query language DSL
          example: metadata[ql]=selfBilling[exists]=true
        ql:
          type: string
    LookaheadEventInfo:
      type: object
      properties:
        decision:
          type: integer
          format: int32
        configs:
          uniqueItems: true
          type: array
          properties:
            readonly:
              type: boolean
            configLookup:
              type: array
              properties:
                empty:
                  type: boolean
              items:
                $ref: '#/components/schemas/ATNConfig'
            configs:
              type: array
              items:
                $ref: '#/components/schemas/ATNConfig'
            uniqueAlt:
              type: integer
              format: int32
            hasSemanticContext:
              type: boolean
            dipsIntoOuterContext:
              type: boolean
            fullCtx:
              type: boolean
            empty:
              type: boolean
            alts:
              type: object
              properties:
                empty:
                  type: boolean
            states:
              uniqueItems: true
              type: array
              items:
                $ref: '#/components/schemas/ATNState'
            predicates:
              type: array
              items:
                $ref: '#/components/schemas/SemanticContext'
          items:
            $ref: '#/components/schemas/ATNConfig'
        input:
          $ref: '#/components/schemas/TokenStream'
        startIndex:
          type: integer
          format: int32
        stopIndex:
          type: integer
          format: int32
        fullCtx:
          type: boolean
        predictedAlt:
          type: integer
          format: int32
    ParseInfo:
      type: object
      properties:
        decisionInfo:
          type: array
          items:
            $ref: '#/components/schemas/DecisionInfo'
        lldecisions:
          type: array
          items:
            type: integer
            format: int32
        dfasize:
          type: integer
          format: int32
        totalTimeInPrediction:
          type: integer
          format: int64
        totalSLLLookaheadOps:
          type: integer
          format: int64
        totalLLLookaheadOps:
          type: integer
          format: int64
        totalSLLATNLookaheadOps:
          type: integer
          format: int64
        totalLLATNLookaheadOps:
          type: integer
          format: int64
        totalATNLookaheadOps:
          type: integer
          format: int64
    ParseTree:
      type: object
      properties:
        parent:
          $ref: '#/components/schemas/ParseTree'
        text:
          type: string
        sourceInterval:
          $ref: '#/components/schemas/Interval'
        payload:
          type: object
        childCount:
          type: integer
          format: int32
    ParserRuleContext:
      type: object
      properties:
        parent:
          $ref: '#/components/schemas/ParserRuleContext'
        invokingState:
          type: integer
          format: int32
        children:
          type: array
          items:
            $ref: '#/components/schemas/ParseTree'
        start:
          $ref: '#/components/schemas/Token'
        stop:
          $ref: '#/components/schemas/Token'
        exception:
          $ref: '#/components/schemas/RecognitionException'
        childCount:
          type: integer
          format: int32
        sourceInterval:
          $ref: '#/components/schemas/Interval'
        empty:
          type: boolean
        payload:
          $ref: '#/components/schemas/RuleContext'
        text:
          type: string
        ruleContext:
          $ref: '#/components/schemas/RuleContext'
        ruleIndex:
          type: integer
          format: int32
        altNumber:
          type: integer
          format: int32
    PredicateEvalInfo:
      type: object
      properties:
        decision:
          type: integer
          format: int32
        configs:
          uniqueItems: true
          type: array
          properties:
            readonly:
              type: boolean
            configLookup:
              type: array
              properties:
                empty:
                  type: boolean
              items:
                $ref: '#/components/schemas/ATNConfig'
            configs:
              type: array
              items:
                $ref: '#/components/schemas/ATNConfig'
            uniqueAlt:
              type: integer
              format: int32
            hasSemanticContext:
              type: boolean
            dipsIntoOuterContext:
              type: boolean
            fullCtx:
              type: boolean
            empty:
              type: boolean
            alts:
              type: object
              properties:
                empty:
                  type: boolean
            states:
              uniqueItems: true
              type: array
              items:
                $ref: '#/components/schemas/ATNState'
            predicates:
              type: array
              items:
                $ref: '#/components/schemas/SemanticContext'
          items:
            $ref: '#/components/schemas/ATNConfig'
        input:
          $ref: '#/components/schemas/TokenStream'
        startIndex:
          type: integer
          format: int32
        stopIndex:
          type: integer
          format: int32
        fullCtx:
          type: boolean
        semctx:
          $ref: '#/components/schemas/SemanticContext'
        predictedAlt:
          type: integer
          format: int32
        evalResult:
          type: boolean
    PredictionContext:
      type: object
      properties:
        id:
          type: integer
          format: int32
        cachedHashCode:
          type: integer
          format: int32
        empty:
          type: boolean
    QueryContext:
      type: object
      properties:
        parent:
          $ref: '#/components/schemas/ParserRuleContext'
        invokingState:
          type: integer
          format: int32
        children:
          type: array
          items:
            $ref: '#/components/schemas/ParseTree'
        start:
          $ref: '#/components/schemas/Token'
        stop:
          $ref: '#/components/schemas/Token'
        exception:
          $ref: '#/components/schemas/RecognitionException'
        ruleIndex:
          type: integer
          format: int32
        childCount:
          type: integer
          format: int32
        sourceInterval:
          $ref: '#/components/schemas/Interval'
        empty:
          type: boolean
        payload:
          $ref: '#/components/schemas/RuleContext'
        text:
          type: string
        ruleContext:
          $ref: '#/components/schemas/RuleContext'
        altNumber:
          type: integer
          format: int32
    RecognitionException:
      type: object
      properties:
        cause:
          type: object
          properties:
            stackTrace:
              type: array
              items:
                type: object
                properties:
                  classLoaderName:
                    type: string
                  moduleName:
                    type: string
                  moduleVersion:
                    type: string
                  methodName:
                    type: string
                  fileName:
                    type: string
                  lineNumber:
                    type: integer
                    format: int32
                  className:
                    type: string
                  nativeMethod:
                    type: boolean
            message:
              type: string
            suppressed:
              type: array
              items:
                type: object
                properties:
                  stackTrace:
                    type: array
                    items:
                      type: object
                      properties:
                        classLoaderName:
                          type: string
                        moduleName:
                          type: string
                        moduleVersion:
                          type: string
                        methodName:
                          type: string
                        fileName:
                          type: string
                        lineNumber:
                          type: integer
                          format: int32
                        className:
                          type: string
                        nativeMethod:
                          type: boolean
                  message:
                    type: string
                  localizedMessage:
                    type: string
            localizedMessage:
              type: string
        stackTrace:
          type: array
          items:
            type: object
            properties:
              classLoaderName:
                type: string
              moduleName:
                type: string
              moduleVersion:
                type: string
              methodName:
                type: string
              fileName:
                type: string
              lineNumber:
                type: integer
                format: int32
              className:
                type: string
              nativeMethod:
                type: boolean
        recognizer:
          $ref: '#/components/schemas/RecognizerObjectObject'
        ctx:
          $ref: '#/components/schemas/RuleContext'
        offendingToken:
          $ref: '#/components/schemas/Token'
        offendingState:
          type: integer
          format: int32
        inputStream:
          $ref: '#/components/schemas/IntStream'
        expectedTokens:
          $ref: '#/components/schemas/IntervalSet'
        message:
          type: string
        suppressed:
          type: array
          items:
            type: object
            properties:
              stackTrace:
                type: array
                items:
                  type: object
                  properties:
                    classLoaderName:
                      type: string
                    moduleName:
                      type: string
                    moduleVersion:
                      type: string
                    methodName:
                      type: string
                    fileName:
                      type: string
                    lineNumber:
                      type: integer
                      format: int32
                    className:
                      type: string
                    nativeMethod:
                      type: boolean
              message:
                type: string
              localizedMessage:
                type: string
        localizedMessage:
          type: string
    RecognizerObjectObject:
      type: object
      properties:
        state:
          type: integer
          format: int32
        inputStream:
          $ref: '#/components/schemas/IntStream'
        tokenNames:
          type: array
          items:
            type: string
        vocabulary:
          $ref: '#/components/schemas/Vocabulary'
        grammarFileName:
          type: string
        serializedATN:
          type: string
        atn:
          $ref: '#/components/schemas/ATN'
        tokenFactory:
          $ref: '#/components/schemas/TokenFactoryObject'
        parseInfo:
          $ref: '#/components/schemas/ParseInfo'
        ruleIndexMap:
          type: object
          additionalProperties:
            type: integer
            format: int32
        interpreter:
          type: object
        tokenTypeMap:
          type: object
          additionalProperties:
            type: integer
            format: int32
        errorListeners:
          type: array
          items:
            $ref: '#/components/schemas/ANTLRErrorListener'
        ruleNames:
          type: array
          items:
            type: string
        errorListenerDispatch:
          $ref: '#/components/schemas/ANTLRErrorListener'
    RuleContext:
      type: object
      properties:
        parent:
          $ref: '#/components/schemas/RuleContext'
        invokingState:
          type: integer
          format: int32
        empty:
          type: boolean
        payload:
          $ref: '#/components/schemas/RuleContext'
        text:
          type: string
        childCount:
          type: integer
          format: int32
        ruleContext:
          $ref: '#/components/schemas/RuleContext'
        ruleIndex:
          type: integer
          format: int32
        sourceInterval:
          $ref: '#/components/schemas/Interval'
        altNumber:
          type: integer
          format: int32
    RuleStartState:
      type: object
      properties:
        atn:
          $ref: '#/components/schemas/ATN'
        stateNumber:
          type: integer
          format: int32
        ruleIndex:
          type: integer
          format: int32
        epsilonOnlyTransitions:
          type: boolean
        transitions:
          type: array
          items:
            $ref: '#/components/schemas/Transition'
        nextTokenWithinRule:
          $ref: '#/components/schemas/IntervalSet'
        stopState:
          $ref: '#/components/schemas/RuleStopState'
        isLeftRecursiveRule:
          type: boolean
        stateType:
          type: integer
          format: int32
        nonGreedyExitState:
          type: boolean
        numberOfTransitions:
          type: integer
          format: int32
    RuleStopState:
      type: object
      properties:
        atn:
          $ref: '#/components/schemas/ATN'
        stateNumber:
          type: integer
          format: int32
        ruleIndex:
          type: integer
          format: int32
        epsilonOnlyTransitions:
          type: boolean
        transitions:
          type: array
          items:
            $ref: '#/components/schemas/Transition'
        nextTokenWithinRule:
          $ref: '#/components/schemas/IntervalSet'
        stateType:
          type: integer
          format: int32
        nonGreedyExitState:
          type: boolean
        numberOfTransitions:
          type: integer
          format: int32
    SemanticContext:
      type: object
    Token:
      type: object
      properties:
        type:
          type: integer
          format: int32
        inputStream:
          $ref: '#/components/schemas/CharStream'
        channel:
          type: integer
          format: int32
        text:
          type: string
        tokenSource:
          $ref: '#/components/schemas/TokenSource'
        startIndex:
          type: integer
          format: int32
        stopIndex:
          type: integer
          format: int32
        tokenIndex:
          type: integer
          format: int32
        charPositionInLine:
          type: integer
          format: int32
        line:
          type: integer
          format: int32
    TokenFactoryObject:
      type: object
    TokenSource:
      type: object
      properties:
        inputStream:
          $ref: '#/components/schemas/CharStream'
        tokenFactory:
          $ref: '#/components/schemas/TokenFactoryObject'
        sourceName:
          type: string
        charPositionInLine:
          type: integer
          format: int32
        line:
          type: integer
          format: int32
    TokenStream:
      type: object
      properties:
        text:
          type: string
        tokenSource:
          $ref: '#/components/schemas/TokenSource'
        sourceName:
          type: string
    TokensStartState:
      type: object
      properties:
        atn:
          $ref: '#/components/schemas/ATN'
        stateNumber:
          type: integer
          format: int32
        ruleIndex:
          type: integer
          format: int32
        epsilonOnlyTransitions:
          type: boolean
        transitions:
          type: array
          items:
            $ref: '#/components/schemas/Transition'
        nextTokenWithinRule:
          $ref: '#/components/schemas/IntervalSet'
        decision:
          type: integer
          format: int32
        nonGreedy:
          type: boolean
        stateType:
          type: integer
          format: int32
        nonGreedyExitState:
          type: boolean
        numberOfTransitions:
          type: integer
          format: int32
    Transition:
      type: object
      properties:
        target:
          $ref: '#/components/schemas/ATNState'
        serializationType:
          type: integer
          format: int32
        epsilon:
          type: boolean
    Vocabulary:
      type: object
      properties:
        maxTokenType:
          type: integer
          format: int32
    ConnectorsRequestV2:
      type: object
      properties:
        connectors:
          type: array
          description: Array of connectors
          items:
            $ref: '#/components/schemas/JsonBMap'
    BusinessConnectionPatchRequestV2:
      required:
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/ConnectionPatchRequestV2'
      - type: object
        properties:
          legalName:
            type: string
            description: Legal name of business
            nullable: true
          tradeName:
            type: string
            description: Trade name of business
            nullable: true
          businessType:
            $ref: '#/components/schemas/BusinessConnectionType'
    ConnectionPatchRequestV2:
      required:
      - type
      type: object
      properties:
        type:
          type: string
          description: discriminator to determine PersonConnectionPatchRequestV2 /
            BusinessConnectionPatchRequestV2
          example: person
          enum:
          - business
          - person
        spaceUrl:
          type: string
          description: URL to the BTX Space endpoint of this connection in the connection's
            entity store
          nullable: true
        globalIdentifiers:
          $ref: '#/components/schemas/JsonBMapNullable'
        assignedAccountId:
          type: string
          description: Assigned Account Id
          nullable: true
        alias:
          type: string
          description: Nickname for the connection
          nullable: true
        connectionStatus:
          $ref: '#/components/schemas/ConnectionStatus'
        relationTypes:
          uniqueItems: true
          type: array
          description: Relation types of this connection
          nullable: true
          items:
            $ref: '#/components/schemas/ConnectionRelationType'
        addresses:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SepaStructuredAddress'
          description: Connection addresses
          nullable: true
        tags:
          type: array
          description: Tags
          nullable: true
          example:
          - tag1
          - tag2
          items:
            type: string
        active:
          type: boolean
          description: Active / Not active
          nullable: true
        metadata:
          $ref: '#/components/schemas/JsonBMapNullable'
        paymentAccount:
          $ref: '#/components/schemas/ConnectionPaymentAccountData'
      discriminator:
        propertyName: type
        mapping:
          person: '#/components/schemas/PersonConnectionPatchRequestV2'
          business: '#/components/schemas/BusinessConnectionPatchRequestV2'
    ConnectionPaymentAccountData:
      type: object
      properties:
        id:
          type: string
          description: Payment account id
          format: uuid
          example: 34663a97-35ae-4cb7-80a2-71050b7c1a80
        isDefault:
          type: boolean
          description: Is default payment account of connection.
        financialPlatformId:
          type: string
          description: Optional identifier of the financial platform associated with
            this payment account. Passing null clears the existing value.
      description: Payment account to be set or unset as default
      nullable: true
    PersonConnectionPatchRequestV2:
      required:
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/ConnectionPatchRequestV2'
      - type: object
        properties:
          firstName:
            type: string
            description: Person first name
            nullable: true
          lastName:
            type: string
            description: Person last name
            nullable: true
    BusinessConnectionDetailsResultV3:
      required:
      - active
      - connectionStatus
      - displayName
      - id
      - spaceUrl
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/ConnectionV3'
      - type: object
        properties:
          legalName:
            type: string
            description: Legal name of business
          tradeName:
            type: string
            description: Trade name of business
          businessType:
            $ref: '#/components/schemas/BusinessConnectionType'
    ConnectionV3:
      required:
      - active
      - connectionStatus
      - displayName
      - id
      - spaceUrl
      - type
      type: object
      properties:
        type:
          type: string
          description: discriminator to determine PersonConnectionV3 / BusinessConnectionV3
          example: person
          enum:
          - business
          - person
        id:
          type: string
          description: Connection ID
          format: uuid
        spaceUrl:
          type: string
          description: URL to the BTX Space endpoint of this connection in the connection's
            entity store
        globalIdentifiers:
          $ref: '#/components/schemas/JsonBMap'
        assignedAccountId:
          type: string
          description: Assigned Account Id
        alias:
          type: string
          description: Nickname for the connection
        connectionStatus:
          $ref: '#/components/schemas/ConnectionStatus'
        relationTypes:
          uniqueItems: true
          type: array
          description: Relation types of this connection
          items:
            $ref: '#/components/schemas/ConnectionRelationType'
        addresses:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/LenientIso20022StructuredAddress'
          description: Connection addresses
        tags:
          type: array
          description: Tags
          items:
            type: string
            description: Tags
        active:
          type: boolean
          description: Active / Not active
        createdAt:
          type: string
          description: creation datetime
          format: date-time
        metadata:
          $ref: '#/components/schemas/JsonBMap'
        connectors:
          type: array
          description: Connectors of this connection.
          items:
            $ref: '#/components/schemas/JsonBMap'
        paymentAccounts:
          uniqueItems: true
          type: array
          description: Payment accounts linked to connection
          items:
            $ref: '#/components/schemas/ConnectionPaymentAccountListItem'
        displayName:
          type: string
          description: Display name
      description: discriminator to determine PersonConnectionV3 / BusinessConnectionV3
      example: person
      discriminator:
        propertyName: type
        mapping:
          business: '#/components/schemas/BusinessConnectionDetailsResultV3'
          person: '#/components/schemas/PersonConnectionDetailsResultV3'
    LenientIso20022StructuredAddress:
      type: object
      properties:
        country:
          type: string
          description: Nation with its own government, expressed as a two letter ISO
            3166 code (alpha-2) of the country. The country code is written in upper
            case.
          example: BE
        townName:
          type: string
          description: Name of a built-up area, with defined boundaries, and a local
            government.
          example: La Hulpe
        addressType:
          type: string
          description: Identifies the nature of the postal address.
          example: ADDR
          enum:
          - ADDR
          - PBOX
          - HOME
          - BIZZ
          - MLTO
          - DLVY
        streetName:
          maxLength: 140
          type: string
          description: Name of a street or thoroughfare.
          example: Avenue Reine Astrid
        buildingNumber:
          maxLength: 16
          type: string
          description: A unique number assigned to the building in the street or area
            //Number that identifies the position of a building on a street.
          example: '40'
        careOf:
          maxLength: 140
          type: string
          description: Identifies an addressee that is accepting the correspondence
            for the intended recipient. Using care of ensures the correspondence reaches
            the right recipient rather than getting returned to the sender.
          example: Finance
        department:
          maxLength: 70
          type: string
          description: Identification of a division of a large organisation or building.
          example: Finance
        subDepartment:
          maxLength: 70
          type: string
          description: Identification of a sub-division of a large organisation or
            building.
          example: Accounting
        buildingName:
          maxLength: 140
          type: string
          description: Name of the building or house.
          example: Empire State Building
        floor:
          maxLength: 70
          type: string
          description: Floor or storey within a building.
          example: ground
        unitNumber:
          maxLength: 16
          type: string
          description: Identifies a flat or dwelling within the building.
          example: '2'
        postBox:
          maxLength: 16
          type: string
          description: Numbered box in a post office, assigned to a person or organisation,
            where letters are kept until called for.
          example: '1003'
        room:
          maxLength: 70
          type: string
          description: Building room number.
          example: '2.22'
        postCode:
          maxLength: 16
          type: string
          description: Identifier consisting of a group of letters and/or numbers
            that is added to a postal address to assist the sorting of mail.
          example: '1310'
        townLocationName:
          maxLength: 140
          type: string
          description: Specific location name within the town. eg Borough (USA), Village
            (GB).
          example: Miami Beach
        districtName:
          maxLength: 140
          type: string
          description: Identifies a subdivision within a country sub-division eg County
            (USA), Landkreis (DE).
          example: Miami-Dade, Coburg
        countrySubDivision:
          maxLength: 35
          type: string
          description: Identifies a subdivision of a country such as state (USA),
            Bundesland (DE), region, province,....
          example: Florida, Bayern, Wallonia, Hainaut
      description: Information that locates and identifies a specific address, as
        defined by postal services
      nullable: true
      externalDocs:
        description: More about EPC Interbank Structured Address Structure; see also
          PostalAddress27 type in https://www.iso20022.org/message/22905/download
        url: https://www.europeanpaymentscouncil.eu/sites/default/files/kb/file/2022-10/EPC153-22%20EPC%20guidance%20document%20-%20Use%20of%20Structured%20Address%20under%20the%20SEPA%20Payment%20Schemes%20as%20of%20Nov%202025.pdf
    PersonConnectionDetailsResultV3:
      required:
      - active
      - connectionStatus
      - displayName
      - id
      - spaceUrl
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/ConnectionV3'
      - type: object
        properties:
          firstName:
            type: string
            description: Person first name
          lastName:
            type: string
            description: Person last name
    BusinessConnectionRequestV3:
      required:
      - businessType
      - relationTypes
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/ConnectionRequestV3'
      - type: object
        properties:
          legalName:
            type: string
            description: Legal name of business
          tradeName:
            type: string
            description: Trade name of business
          businessType:
            $ref: '#/components/schemas/BusinessConnectionType'
    ConnectionRequestV3:
      required:
      - relationTypes
      - type
      type: object
      properties:
        type:
          type: string
          description: discriminator to determine PersonConnectionRequestV3 / BusinessConnectionRequestV3
          example: person
          enum:
          - business
          - person
        spaceUrl:
          type: string
          description: URL to the BTX Space endpoint of this connection in the connection's
            entity store
        globalIdentifiers:
          $ref: '#/components/schemas/JsonBMap'
        assignedAccountId:
          type: string
          description: Assigned Account Id
        alias:
          type: string
          description: Nickname for the connection
        connectionStatus:
          $ref: '#/components/schemas/ConnectionStatus'
        relationTypes:
          uniqueItems: true
          type: array
          description: Relation types of this connection
          items:
            $ref: '#/components/schemas/ConnectionRelationType'
        addresses:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/LenientIso20022StructuredAddress'
          description: Connection addresses
        tags:
          type: array
          description: Tags
          example:
          - tag1
          - tag2
          items:
            type: string
            description: Tags
            example: '["tag1","tag2"]'
        active:
          type: boolean
          description: Active / Not active
        metadata:
          $ref: '#/components/schemas/JsonBMap'
        connectors:
          type: array
          description: Array of connectors
          items:
            $ref: '#/components/schemas/JsonBMap'
        paymentAccounts:
          uniqueItems: true
          type: array
          description: Payment accounts
          items:
            $ref: '#/components/schemas/ConnectionPaymentAccountItemV2'
      discriminator:
        propertyName: type
        mapping:
          person: '#/components/schemas/PersonConnectionRequestV3'
          business: '#/components/schemas/BusinessConnectionRequestV3'
    PersonConnectionRequestV3:
      required:
      - relationTypes
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/ConnectionRequestV3'
      - type: object
        properties:
          firstName:
            type: string
            description: Person first name
          lastName:
            type: string
            description: Person last name
    ListConnectionsResponseV3:
      type: object
      properties:
        connections:
          type: array
          description: List of connections
          items:
            $ref: '#/components/schemas/ConnectionV3'
        totalElements:
          type: integer
          description: Total number of items in the database that correspond to this
            search criteria
          format: int64
        currentPage:
          type: integer
          description: Current page
          format: int32
        pageSize:
          type: integer
          description: Response page size
          format: int32
    ListConnectionsQueryParamsSingleV3:
      type: object
      properties:
        name[eq]:
          type: string
          description: 'Exact match on name fields only (Case insensitive). Scope:
            Legal Name, Trade Name, First Name, Last Name.'
        search[eq]:
          type: string
          description: 'Exact match on names and identifiers (Case insensitive). Scope:
            Legal Name, Trade Name, First Name, Last Name, Alias, Local Identifier
            (Assigned Account ID), Global Identifiers.'
        search[cont]:
          type: string
          description: 'Substring (partial) match on names and identifiers (Case insensitive).
            Scope: Legal Name, Trade Name, First Name, Last Name, Alias, Local Identifier
            (Assigned Account ID), Global Identifiers.'
        search[has]:
          type: string
          description: 'Word/Token match on names and identifiers (Full Text Search).
            Finds records containing the input as a distinct word. Scope: Legal Name,
            Trade Name, First Name, Last Name, Alias, Local Identifier (Assigned Account
            ID), Global Identifiers.'
        identifierValue:
          type: string
          description: Connection identifier (e.g. VAT number)
        name:
          type: string
          description: Connection name for searching
        search:
          type: string
          description: Global search parameter. Supports partial matching for names
            (business/person) and strict matching for identifiers/aliases.
        type:
          type: string
        countryCode:
          type: string
          description: Connection address country code for searching
          example: BE
        assignedAccountId:
          type: string
          description: Assigned account id for searching (supports partial matches)
          example: '00044'
        businessType:
          type: string
        metadata[ql]:
          type: string
          description: Metadata query language DSL
          example: metadata[ql]=selfBilling[exists]=true
        ql:
          type: string
    ConnectorsRequestV3:
      type: object
      properties:
        connectors:
          type: array
          description: Array of connectors
          items:
            $ref: '#/components/schemas/JsonBMap'
    BusinessConnectionPatchRequestV3:
      required:
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/ConnectionPatchRequestV3'
      - type: object
        properties:
          legalName:
            type: string
            description: Legal name of business
            nullable: true
          tradeName:
            type: string
            description: Trade name of business
            nullable: true
          businessType:
            $ref: '#/components/schemas/BusinessConnectionType'
    ConnectionPatchRequestV3:
      required:
      - type
      type: object
      properties:
        type:
          type: string
          description: discriminator to determine PersonConnectionPatchRequestV3 /
            BusinessConnectionPatchRequestV3
          example: person
          enum:
          - business
          - person
        spaceUrl:
          type: string
          description: URL to the BTX Space endpoint of this connection in the connection's
            entity store
          nullable: true
        globalIdentifiers:
          $ref: '#/components/schemas/JsonBMapNullable'
        assignedAccountId:
          type: string
          description: Assigned Account Id
          nullable: true
        alias:
          type: string
          description: Nickname for the connection
          nullable: true
        connectionStatus:
          $ref: '#/components/schemas/ConnectionStatus'
        relationTypes:
          uniqueItems: true
          type: array
          description: Relation types of this connection
          nullable: true
          items:
            $ref: '#/components/schemas/ConnectionRelationType'
        addresses:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/LenientIso20022StructuredAddress'
          description: Connection addresses
          nullable: true
        tags:
          type: array
          description: Tags
          nullable: true
          example:
          - tag1
          - tag2
          items:
            type: string
        active:
          type: boolean
          description: Active / Not active
          nullable: true
        metadata:
          $ref: '#/components/schemas/JsonBMapNullable'
        paymentAccount:
          $ref: '#/components/schemas/ConnectionPaymentAccountData'
      discriminator:
        propertyName: type
        mapping:
          person: '#/components/schemas/PersonConnectionPatchRequestV3'
          business: '#/components/schemas/BusinessConnectionPatchRequestV3'
    PersonConnectionPatchRequestV3:
      required:
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/ConnectionPatchRequestV3'
      - type: object
        properties:
          firstName:
            type: string
            description: Person first name
            nullable: true
          lastName:
            type: string
            description: Person last name
            nullable: true
    BusinessConnectionDetails:
      type: object
      allOf:
      - $ref: '#/components/schemas/ConnectionDetails'
      - type: object
        properties:
          businessType:
            type: string
            enum:
            - GOVERNMENT
            - ENTERPRISE
            - PRIVATE_PERSON
          legalName:
            type: string
          tradeName:
            type: string
      required:
      - active
      - addresses
      - assignedAccountId
      - businessType
      - connectionStatus
      - connectors
      - createdAt
      - globalIdentifiers
      - id
      - legalName
      - metadata
      - relationTypes
      - tags
      - type
    BusinessConnectionInput:
      type: object
      allOf:
      - $ref: '#/components/schemas/ConnectionInput'
      - type: object
        properties:
          legalName:
            type: string
            minLength: 1
          tradeName:
            type: string
      required:
      - addresses
      - businessType
      - globalIdentifiers
      - legalName
      - metadata
      - relationTypes
      - tags
      - type
    BusinessUpdateConnectionInput:
      type: object
      allOf:
      - $ref: '#/components/schemas/UpdateConnectionInput'
      - type: object
        properties:
          legalName:
            type: string
          tradeName:
            type: string
      required:
      - type
    ConnectionConnector:
      type: object
      properties:
        active:
          type: boolean
        extensionId:
          type: string
          format: uuid
        name:
          type: string
          minLength: 1
        namespace:
          type: string
          minLength: 1
        searchResults:
          type: array
          items:
            $ref: '#/components/schemas/SearchResult'
        settings:
          type: object
          additionalProperties:
            type: object
      required:
      - active
      - extensionId
      - name
      - namespace
    ConnectionConnectorResponse:
      type: object
      properties:
        connectors:
          type: array
          items:
            $ref: '#/components/schemas/ConnectionConnector'
      required:
      - connectors
    ConnectionDetails:
      type: object
      description: discriminator to determine PersonConnectionDetails / BusinessConnectionDetails
      discriminator:
        mapping:
          BUSINESS: '#/components/schemas/BusinessConnectionDetails'
          PERSON: '#/components/schemas/PersonConnectionDetails'
        propertyName: type
      example: PERSON
      properties:
        active:
          type: boolean
        addresses:
          $ref: '#/components/schemas/SepaStructuredAddressBook'
        alias:
          type: string
        assignedAccountId:
          type: string
          minLength: 1
        connectionStatus:
          type: string
          enum:
          - INVITED
          - PENDING
          - CONNECTED
          - DISCONNECTED
          - CREATED
        connectors:
          type: array
          items:
            $ref: '#/components/schemas/ConnectionConnector'
        createdAt:
          type: string
          format: date-time
        globalIdentifiers:
          type: object
          additionalProperties:
            type: object
        id:
          type: string
          format: uuid
        metadata:
          type: object
          additionalProperties:
            type: object
        relationTypes:
          type: array
          items:
            type: string
            enum:
            - CUSTOMER
            - SUPPLIER
            - ACCOUNTANT
            - PARTNER
            - GROUP
          minItems: 1
          uniqueItems: true
        spaceUrl:
          type: string
        tags:
          type: array
          items:
            type: string
        type:
          type: string
          enum:
          - BUSINESS
          - PERSON
      required:
      - active
      - addresses
      - assignedAccountId
      - connectionStatus
      - connectors
      - createdAt
      - globalIdentifiers
      - id
      - metadata
      - relationTypes
      - tags
      - type
    ConnectionInput:
      type: object
      discriminator:
        mapping:
          BUSINESS: '#/components/schemas/BusinessConnectionInput'
          PERSON: '#/components/schemas/PersonConnectionInput'
        propertyName: type
      properties:
        active:
          type: boolean
        addresses:
          $ref: '#/components/schemas/SepaStructuredAddressBook'
        alias:
          type: string
        businessType:
          type: string
          enum:
          - GOVERNMENT
          - ENTERPRISE
          - PRIVATE_PERSON
        connectionStatus:
          type: string
          enum:
          - INVITED
          - PENDING
          - CONNECTED
          - DISCONNECTED
          - CREATED
        globalIdentifiers:
          type: object
          additionalProperties:
            type: object
        metadata:
          type: object
          additionalProperties:
            type: object
        paymentAccounts:
          type: array
          items:
            $ref: '#/components/schemas/ConnectionPaymentAccount'
          uniqueItems: true
        relationTypes:
          type: array
          items:
            type: string
            enum:
            - CUSTOMER
            - SUPPLIER
            - ACCOUNTANT
            - PARTNER
            - GROUP
          minItems: 1
          uniqueItems: true
        tags:
          type: array
          items:
            type: string
        type:
          type: string
          enum:
          - BUSINESS
          - PERSON
      required:
      - addresses
      - globalIdentifiers
      - metadata
      - relationTypes
      - tags
      - type
    ConnectionPaymentAccount:
      type: object
      properties:
        bank:
          $ref: '#/components/schemas/BankIdentifier'
        country:
          type: string
          example: BE
          pattern: ^[a-zA-Z]{2}
        currency:
          type: string
          description: International code ISO 4217 of the currency used
          example: EUR
          pattern: '[A-Z]{3}'
        identifier:
          type: string
          description: Account Identifier
          example: BE83504010119715
          minLength: 1
        isDefault:
          type: boolean
          default: true
          description: Is default payment account of connection. If multiple with
            default=true => 400 response. If one without isDefault set, will consider
            'true'.
        parent:
          $ref: '#/components/schemas/AccountIdentifier'
        scheme:
          type: string
          description: Account Scheme
          example: IBAN
      required:
      - currency
      - identifier
      - scheme
    ImportConnectionsResponse:
      type: object
      properties:
        numberOfFailures:
          type: integer
          format: int32
        numberOfSuccesses:
          type: integer
          format: int32
        resultUrl:
          type: string
        totalRows:
          type: integer
          format: int32
    PersonConnectionDetails:
      type: object
      allOf:
      - $ref: '#/components/schemas/ConnectionDetails'
      - type: object
        properties:
          firstName:
            type: string
          lastName:
            type: string
      required:
      - active
      - addresses
      - assignedAccountId
      - connectionStatus
      - connectors
      - createdAt
      - firstName
      - globalIdentifiers
      - id
      - lastName
      - metadata
      - relationTypes
      - tags
      - type
    PersonConnectionInput:
      type: object
      allOf:
      - $ref: '#/components/schemas/ConnectionInput'
      - type: object
        properties:
          firstName:
            type: string
            maxLength: 128
            minLength: 0
          lastName:
            type: string
            maxLength: 128
            minLength: 0
      required:
      - addresses
      - firstName
      - globalIdentifiers
      - lastName
      - metadata
      - relationTypes
      - tags
      - type
    PersonUpdateConnectionInput:
      type: object
      allOf:
      - $ref: '#/components/schemas/UpdateConnectionInput'
      - type: object
        properties:
          firstName:
            type: string
          lastName:
            type: string
      required:
      - type
    SearchResult:
      type: object
      properties:
        description:
          type: string
        name:
          type: string
          minLength: 1
        settings:
          type: object
          additionalProperties:
            type: object
      required:
      - name
      - settings
    SepaStructuredAddressBook:
      type: object
    UpdateConnectionInput:
      type: object
      discriminator:
        mapping:
          BUSINESS: '#/components/schemas/BusinessUpdateConnectionInput'
          PERSON: '#/components/schemas/PersonUpdateConnectionInput'
        propertyName: type
      properties:
        active:
          type: boolean
        addresses:
          $ref: '#/components/schemas/SepaStructuredAddressBook'
        alias:
          type: string
        assignedAccountId:
          type: string
        businessType:
          type: string
          enum:
          - GOVERNMENT
          - ENTERPRISE
          - PRIVATE_PERSON
        connectionStatus:
          type: string
          enum:
          - INVITED
          - PENDING
          - CONNECTED
          - DISCONNECTED
          - CREATED
        globalIdentifiers:
          type: object
          additionalProperties:
            type: object
        metadata:
          type: object
          additionalProperties:
            type: object
        paymentAccounts:
          type: array
          items:
            $ref: '#/components/schemas/ConnectionPaymentAccount'
          uniqueItems: true
        relationTypes:
          type: array
          items:
            type: string
            enum:
            - CUSTOMER
            - SUPPLIER
            - ACCOUNTANT
            - PARTNER
            - GROUP
          uniqueItems: true
        spaceUrl:
          type: string
        tags:
          type: array
          items:
            type: string
        type:
          type: string
          enum:
          - BUSINESS
          - PERSON
      required:
      - type
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://api.cve.btx.eu.banqup.com/oauth2/client_credential/gettoken
          scopes:
            info: Scopes are endpoint-specific, see each endpoint for required scope.
        authorizationCode:
          authorizationUrl: https://api.cve.btx.eu.banqup.com/oauth2/auth
          tokenUrl: https://api.cve.btx.eu.banqup.com/oauth2/token
          scopes:
            info: Scopes are endpoint-specific, see each endpoint for required scope.
tags:
- name: Spaces
  description: 'Spaces are virtual environments (work spaces) where all relevant resources
    of an entity are managed.  Spaces can also facilitate document exchange and communication
    among entities, depending on the space type.

    The role of spaces is to gather all relevant data of an entity into one accessible
    setting.  Such data can include: invoices, connections, cards, clients, payments,
    users, installed apps etc.  The capabilities offered by a space depends on the
    space type and the active subscription.'
  x-BTX:
    unDocumented: 'false'
    internal: 'false'
- name: Files
  description: A file refers to the digital container that stores the data of one
    or more documents.  Files are the medium through which electronic documents are
    stored, transmitted, and accessed.
  x-BTX:
    unDocumented: 'false'
    internal: 'false'
- name: Documents
  description: 'A document in e-invoicing refers to a formal, structured piece of
    information that contains details  related to invoicing: e.g financial data, payment
    details, tax information etc. or any other information  relevant to the company''s
    operations, services, or interactions with clients and partners.

    Every Banqup document is associated with a unique UUID that is stored in the Banqup
    database as documentId.  The UUID is generated when a new file is received/uploaded
    into Banqup and is necessary when performing  document actions via the Banqup
    APIs.'
  x-BTX:
    unDocumented: 'false'
    internal: 'false'
- name: Connections
  description: 'Connections are business and persons in the private address book of
    a space and they represent the actors involved  in document exchange, such as:
    customers, suppliers, accountants, partners, groups.'
  x-BTX:
    unDocumented: 'false'
    internal: 'false'
- name: Payments
  description: A payment is a generic term for the business event of transferring
    funds from one party to another.
  x-BTX:
    unDocumented: 'false'
    internal: 'false'
- name: Payment Accounts
  description: "Payment accounts are bank or financial accounts used for managing\
    \ payments, deposits, withdrawals, and transfers. \nThe Payment Accounts of a\
    \ space are all bank or financial account the business represented by the space\
    \ interacts with via e-invoicing or payments."
  x-BTX:
    unDocumented: 'false'
    internal: 'false'
- name: Payment Information
  description: "Payment Information representing some sort of evidence related to\
    \ a Payment.\nThis evidence could be in different forms :\n  - PaymentTransaction\
    \ : information related to a payment of which the transaction (initiation) \n\
    \                         was started on platform.\n  - BookedPaymentMovement\
    \ : information imported from your own account indicating a payment movement was\
    \ booked. \n  - PlannedPaymentMovement : information imported from your own account\
    \ indicating an amount was reserved \n                         for a future payment.\n\
    \  - ManualPaymentInformation : information about a payment that was manually\
    \ entered by a user of the platform.\n  - CounterpartyPaymentInformation : information\
    \ added to your space about a payment which was based on the \n              \
    \           PaymentInformation the counter party of the payment indicated on BTX\
    \ platform."
  x-BTX:
    unDocumented: 'false'
    internal: 'false'
- name: Internal Payments
  description: "This is a set of internal API call only intended to be used by BTX\
    \ Payment Service or Aggregation Service. They are restricted to ensure that updates\
    \ on payments, payment information and links to documents (BalanceOffset)  are\
    \ done in consistent way.  \nThe higher level public APIs for adding payment,\
    \ payment information and linking payments to documents  will be provided by the\
    \ BTX Payment Service or Aggregation Service."
  x-BTX:
    unDocumented: 'false'
    internal: 'true'
- name: Internal
  description: This is a set of pure internal API.  It contains for example callback
    endpoints that get registered to receive messages.
  x-BTX:
    unDocumented: 'true'
    internal: 'true'
security:
- oauth2: []
