Receeve Account API

openapi: 3.0.3
info:
  title: InDebted Receive API Documentation Account API
  description: 'This is the API definition for interacting with InDebted''s Receive debt servicing platform. For more details please visit the [Integration Documentation](https://docs.indebted.co/docs/receive/receive-knowledge-base).


    **Using this spec in code generators, Postman, or other tooling?** Fetch the raw document at [https://receive-api.indebted.co/openapi/apiSchema.yaml](https://receive-api.indebted.co/openapi/apiSchema.yaml) — that is the canonical OpenAPI file. Prefer it over the in-page download button, which re-serialises the document and can alter value types (e.g. date-formatted strings).'
  contact:
    email: techteam@indebted.co
  version: 1.53.1
servers:
- url: /
  description: API base path
tags:
- name: Account
  description: A formal business arrangement providing for regular dealings or services (such as banking, advertising, or store credit) and involving the establishment and maintenance of an account
  externalDocs:
    description: Account
    url: https://docs.indebted.co/docs/receive/integration/account-claims
paths:
  /v1/{clientId}/get_account:
    get:
      tags:
      - Account
      summary: It retrieves the Account information
      operationId: getAccount
      parameters:
      - $ref: '#/components/parameters/ClientIdParameter'
      - $ref: '#/components/parameters/AuthorizationParameter'
      - $ref: '#/components/parameters/TriggerNameParameter'
      - $ref: '#/components/parameters/AccountReferenceParameter'
      responses:
        '200':
          $ref: '#/components/responses/200SuccessGetAccount'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '429':
          $ref: '#/components/responses/429LimitsReached'
        '500':
          $ref: '#/components/responses/500InternalError'
      security:
      - api_key: []
  /v1/{clientId}/create_accounts:
    post:
      tags:
      - Account
      summary: Create Accounts in Receive
      description: 'The intetion of this endpoint is to create an Account in the platform, and it offer the possibility to include other related entities like the Debtor, the Account Score, Products, etc. But all those other sub-entities are optional and can be included in subsequent calls.

        For more details about the Account, and the relationship with the other entities please visit the [Account](https://docs.indebted.co/docs/receive/integration/account-claims) page.

        '
      operationId: createAccounts
      parameters:
      - $ref: '#/components/parameters/ClientIdParameter'
      - $ref: '#/components/parameters/AuthorizationParameter'
      - $ref: '#/components/parameters/TriggerNameParameter'
      - $ref: '#/components/parameters/AsyncParameter'
      - $ref: '#/components/parameters/MinorVersionParameter'
      - $ref: '#/components/parameters/SequentialParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: AccountReference as key and the Account as value
              additionalProperties:
                $ref: '#/components/schemas/CreateAccountInput'
              example:
                ACCOUNT_REFERENCE_002:
                  currency: EUR
                  paymentReference: ACCOUNT_PAYMENT_REFERENCE
                  meta:
                    accountMetaKey002: value002
                    invoiceExternalNumber: 111
                  scores:
                  - type: INTERNAL
                    value: V1
                  debtors:
                  - lastName: LAST_NAME_1
                    firstName: FIRST_NAME
                    debtorReference: EXTERNAL_DEBTOR_REF_002
                    contactInformation:
                      country: NL
                      email: first.last@acme.com
                  products:
                  - productReference: PRODUCT_REFERENCE_1
                    paymentReference: PRODUCT_PAYMENT_REFERENCE_1
                  - productReference: PRODUCT_REFERENCE_2
                    paymentReference: PRODUCT_PAYMENT_REFERENCE_2
                  ledgerEntries:
                  - ledgerEntryReference: INVOICE_LEDGER_ENTRY_REFERENCE_002_1
                    invoiceDetails:
                      amount: 100000
                      dueDate: '2022-01-08'
                      paymentReference: INVOICE_PAYMENT_REFERENCE_1
                    context:
                      productReference: PRODUCT_REFERENCE_1
      responses:
        '200':
          $ref: '#/components/responses/200SuccessCreateAccounts'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '429':
          $ref: '#/components/responses/429LimitsReached'
        '500':
          $ref: '#/components/responses/500InternalError'
      security:
      - api_key: []
  /v1/{clientId}/update_account_meta:
    post:
      tags:
      - Account
      summary: Update Account Meta
      description: 'The intetion of this endpoint is to update the Account level metadata, the given information is merged with the previous data.

        Notice that the metadata that is provided in the Account level, is inherited by the Claims that are created for that Account.

        For more details about the Account, and the relationship with the other entities please visit the [Account](https://docs.indebted.co/docs/receive/integration/account-claims) page.

        '
      operationId: updateAccountMeta
      parameters:
      - $ref: '#/components/parameters/ClientIdParameter'
      - $ref: '#/components/parameters/AuthorizationParameter'
      - $ref: '#/components/parameters/TriggerNameParameter'
      - $ref: '#/components/parameters/AsyncParameter'
      - $ref: '#/components/parameters/MinorVersionParameter'
      - $ref: '#/components/parameters/SequentialParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: AccountReference as key and the Metadata as value
              additionalProperties:
                $ref: '#/components/schemas/Metadata'
              example:
                ACCOUNT_REFERENCE_002:
                  updateAccountMeta002: updateAccountMetaValue002
      responses:
        '200':
          $ref: '#/components/responses/200Success'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '429':
          $ref: '#/components/responses/429LimitsReached'
        '500':
          $ref: '#/components/responses/500InternalError'
      security:
      - api_key: []
  /v1/{clientId}/add_account_ledger_entries:
    post:
      tags:
      - Account
      summary: Add account ledger entries
      description: 'The intetion of this endpoint is to add Ledger Entries to the Account.

        Those Entries are used to create or update the Claims that are associated with the Account.

        For more details about the Account, and the relationship with the other entities please visit the [Account](https://docs.indebted.co/docs/receive/integration/account-claims) page.

        '
      operationId: addAccountLedgerEntries
      parameters:
      - $ref: '#/components/parameters/ClientIdParameter'
      - $ref: '#/components/parameters/AuthorizationParameter'
      - $ref: '#/components/parameters/TriggerNameParameter'
      - $ref: '#/components/parameters/AsyncParameter'
      - $ref: '#/components/parameters/MinorVersionParameter'
      - $ref: '#/components/parameters/SequentialParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                allOf:
                - $ref: '#/components/schemas/LedgerEntry'
                - $ref: '#/components/schemas/EntityWithAccountReference'
              example:
              - accountReference: ACCOUNT_REFERENCE_002
                context: {}
                invoiceDetails:
                  amount: 13025
                  dueDate: '2020-01-01'
                  meta: {}
                ledgerEntryReference: INVOICE_LEDGER_ENTRY_REFERENCE_002_2
      responses:
        '200':
          $ref: '#/components/responses/200SuccessAddAccountLedgerEntries'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '429':
          $ref: '#/components/responses/429LimitsReached'
        '500':
          $ref: '#/components/responses/500InternalError'
      security:
      - api_key: []
  /v1/{clientId}/add_account_products:
    post:
      tags:
      - Account
      summary: Add Account Products
      description: 'The intetion of this endpoint is to Add Products to the Account.

        The products are used as contextual information to the Claims that are created for that Account. And can be used for further Use Cases within the platform.

        For more details about the Account, and the relationship with the other entities please visit the [Account](https://docs.indebted.co/docs/receive/integration/account-claims) page.

        '
      operationId: addAccountProducts
      parameters:
      - $ref: '#/components/parameters/ClientIdParameter'
      - $ref: '#/components/parameters/AuthorizationParameter'
      - $ref: '#/components/parameters/TriggerNameParameter'
      - $ref: '#/components/parameters/AsyncParameter'
      - $ref: '#/components/parameters/MinorVersionParameter'
      - $ref: '#/components/parameters/SequentialParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                allOf:
                - $ref: '#/components/schemas/Product'
                - $ref: '#/components/schemas/EntityWithAccountReference'
              example:
              - accountReference: ACCOUNT_REFERENCE_002
                productReference: PRODUCT_REFERENCE_002_2
                type: Computer
                name: MacBook Air
                code: '2022'
      responses:
        '200':
          $ref: '#/components/responses/200SuccessAccountProductResponse'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '429':
          $ref: '#/components/responses/429LimitsReached'
        '500':
          $ref: '#/components/responses/500InternalError'
      security:
      - api_key: []
  /v1/{clientId}/update_account_products:
    post:
      tags:
      - Account
      summary: Update Account Products
      description: 'The intetion of this endpoint is to update existing Products of the Account.

        The products are used as contextual information to the Claims that are created for that Account. And can be used for further Use Cases within the platform.

        For more details about the Account, and the relationship with the other entities please visit the [Account](https://docs.indebted.co/docs/receive/integration/account-claims) page.

        '
      operationId: updateAccountProducts
      parameters:
      - $ref: '#/components/parameters/ClientIdParameter'
      - $ref: '#/components/parameters/AuthorizationParameter'
      - $ref: '#/components/parameters/TriggerNameParameter'
      - $ref: '#/components/parameters/AsyncParameter'
      - $ref: '#/components/parameters/MinorVersionParameter'
      - $ref: '#/components/parameters/SequentialParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                allOf:
                - $ref: '#/components/schemas/Product'
                - $ref: '#/components/schemas/EntityWithAccountReference'
              example:
              - accountReference: ACCOUNT_REFERENCE_002
                productReference: PRODUCT_REFERENCE_002_2
                type: Computer
                name: MacBook Air
                code: '2022'
      responses:
        '200':
          $ref: '#/components/responses/200SuccessAccountProductResponse'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '429':
          $ref: '#/components/responses/429LimitsReached'
        '500':
          $ref: '#/components/responses/500InternalError'
      security:
      - api_key: []
  /v1/{clientId}/add_account_debtors:
    post:
      tags:
      - Account
      summary: Add Account Debtors
      description: 'The intetion of this endpoint is to Add Debtors to the Account.

        The Debtor represents the entity that owes money described by the Account.

        For more details about the Account, and the relationship with the other entities please visit the [Account](https://docs.indebted.co/docs/receive/integration/account-claims) page.

        '
      operationId: addAccountDebtors
      parameters:
      - $ref: '#/components/parameters/ClientIdParameter'
      - $ref: '#/components/parameters/AuthorizationParameter'
      - $ref: '#/components/parameters/TriggerNameParameter'
      - $ref: '#/components/parameters/AsyncParameter'
      - $ref: '#/components/parameters/MinorVersionParameter'
      - $ref: '#/components/parameters/SequentialParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                allOf:
                - $ref: '#/components/schemas/Debtor'
                - $ref: '#/components/schemas/EntityWithAccountReference'
              example:
              - accountReference: ACCOUNT_REFERENCE_002
                debtorReference: EXTERNAL_DEBTOR_REF_002
                contactInformation:
                  country: DE
                  email: first.last@acme.com
                firstName: First_2
                lastName: Last_2
      responses:
        '200':
          $ref: '#/components/responses/200SuccessDebtorResponse'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '429':
          $ref: '#/components/responses/429LimitsReached'
        '500':
          $ref: '#/components/responses/500InternalError'
      security:
      - api_key: []
  /v1/{clientId}/update_account_debtors:
    post:
      tags:
      - Account
      summary: Update Account Debtors
      description: 'The intetion of this endpoint is to Update Debtors to the Account.

        The Debtor represents the entity that owes money described by the Account.

        For more details about the Account, and the relationship with the other entities please visit the [Account](https://docs.indebted.co/docs/receive/integration/account-claims) page.

        '
      operationId: updateAccountDebtors
      parameters:
      - $ref: '#/components/parameters/ClientIdParameter'
      - $ref: '#/components/parameters/AuthorizationParameter'
      - $ref: '#/components/parameters/TriggerNameParameter'
      - $ref: '#/components/parameters/AsyncParameter'
      - $ref: '#/components/parameters/MinorVersionParameter'
      - $ref: '#/components/parameters/SequentialParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                allOf:
                - $ref: '#/components/schemas/Debtor'
                - $ref: '#/components/schemas/EntityWithAccountReference'
              example:
              - accountReference: ACCOUNT_REFERENCE_002
                debtorReference: EXTERNAL_DEBTOR_REF_002
                contactInformation:
                  country: DE
                  email: first.last@acme.com
                firstName: First_2
                lastName: Last_2
      responses:
        '200':
          $ref: '#/components/responses/200Success'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '429':
          $ref: '#/components/responses/429LimitsReached'
        '500':
          $ref: '#/components/responses/500InternalError'
      security:
      - api_key: []
  /v1/{clientId}/get_account_claims:
    get:
      tags:
      - Account
      summary: It retrieves the claims from a given account
      description: 'The intetion of this endpoint is to fetch the Claims from a given Account.

        For more details about the Account, and the relationship with the other entities please visit the [Account](https://docs.indebted.co/docs/receive/integration/account-claims) page.

        '
      operationId: getAccountClaims
      parameters:
      - $ref: '#/components/parameters/ClientIdParameter'
      - $ref: '#/components/parameters/AuthorizationParameter'
      - $ref: '#/components/parameters/TriggerNameParameter'
      - $ref: '#/components/parameters/AccountReferenceParameter'
      - name: status
        in: query
        required: false
        description: Claim Status filter
        schema:
          type: string
          enum:
          - ACTIVE
          - RESOLVED
          description: 'The Claim is either Active or Resolved, where Active means that there is an existing debt and Resolved means that the debt does not longer exist (there are multiple ways of resolving the Claim other than paying the claim, please refer to the Integration Documentation for further details).

            '
      - name: paginationId
        in: query
        required: false
        description: Get the Account Claims by Pagination
        schema:
          type: string
          description: 'The Pagination will be unique identifier to fetch and traverse the claims page wise with every new request and returns null when no claims founds in DB.

            '
          example: paginationId=eyJhY2NvdW50SWQiOiJBTExBVklOX0FDQ09VTlRfMDEyNyIsImNsaWVudElkIjoiM2QxMzJiMTgtNmI2Zi00ZjdjLWI0NjQtNmE4ZWU3Y2E1MjM1IiwiZXh0ZXJuYWxDbGFpbVJlZiI6IjAyOGZmNDM3LTc2NmItNDNjNC1iY2E4LWVlMTI4OWVhMDZjMCJ9
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          maximum: 10000
        description: amount of events per page, default is 1000
        example: 1000
      responses:
        '200':
          $ref: '#/components/responses/200SuccessGetAccountClaims'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '429':
          $ref: '#/components/responses/429LimitsReached'
        '500':
          $ref: '#/components/responses/500InternalError'
      security:
      - api_key: []
  /v1/{clientId}/set_account_scores:
    post:
      tags:
      - Account
      summary: Set Account Scores
      description: 'The intention of the endpoint is to set the scores for the Account.

        The scores provide further contextual information about the Account that can be used to improve the performance of the processes in the Collection Strategy.

        For more details about the Account, and the relationship with the other entities please visit the [Account](https://docs.indebted.co/docs/receive/integration/account-claims) page.

        '
      operationId: SetAccountScores
      parameters:
      - $ref: '#/components/parameters/ClientIdParameter'
      - $ref: '#/components/parameters/AuthorizationParameter'
      - $ref: '#/components/parameters/TriggerNameParameter'
      - $ref: '#/components/parameters/SequentialParameter'
      - $ref: '#/components/parameters/AsyncParameter'
      - $ref: '#/components/parameters/MinorVersionParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                allOf:
                - $ref: '#/components/schemas/AccountScore'
                - $ref: '#/components/schemas/EntityWithAccountReference'
              example:
              - accountReference: ACCOUNT_REFERENCE_002
                type: EXTERNAL
                value: SCORE1
                meta: {}
      responses:
        '200':
          $ref: '#/components/responses/200SuccessSetAccountScore'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '429':
          $ref: '#/components/responses/429LimitsReached'
        '500':
          $ref: '#/components/responses/500InternalError'
      security:
      - api_key: []
  /v1/{clientId}/match_account_payment:
    post:
      tags:
      - Account
      summary: Register a payment for an account
      description: 'The intention of the endpoint is to register a payment for an account.

        The payment amount will be matched to the different claims of the account using the indicated matching strategy.

        '
      operationId: MatchAccountPayment
      parameters:
      - $ref: '#/components/parameters/ClientIdParameter'
      - $ref: '#/components/parameters/AuthorizationParameter'
      - $ref: '#/components/parameters/TriggerNameParameter'
      - $ref: '#/components/parameters/SequentialParameter'
      - $ref: '#/components/parameters/AsyncParameter'
      - $ref: '#/components/parameters/MinorVersionParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                allOf:
                - $ref: '#/components/schemas/MatchAccountPaymentInput'
                - $ref: '#/components/schemas/EntityWithAccountReference'
              example:
              - accountReference: ACCOUNT_REFERENCE_002
                currency: EUR
                matchStrategy: ORDERED_INVOICES_WITH_FEES_THEN_ACCOUNT_ENTRIES
                totalAmount: 100000
                providerName: trustly
                trackingId: TRACKING_ID_2
                paymentReference: PAYMENT_REFERENCE_2
                context:
                  productReference: PRODUCT_REFERENCE_2
                meta: {}
      responses:
        '200':
          $ref: '#/components/responses/200SuccessMatchAccountPayment'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '429':
          $ref: '#/components/responses/429LimitsReached'
        '500':
          $ref: '#/components/responses/500InternalError'
      security:
      - api_key: []
  /v1/{clientId}/allocate_account_payment:
    post:
      tags:
      - Account
      summary: Allocate a payment across an account's claims
      description: 'Distribute a single lump payment across an account''s open claims for

        accounts that are not ledger-managed. The amount is allocated one claim

        at a time using the chosen strategy; the per-claim breakdown is published

        on the event.accountPayment.allocated event.

        '
      operationId: AllocateAccountPayment
      parameters:
      - $ref: '#/components/parameters/ClientIdParameter'
      - $ref: '#/components/parameters/AuthorizationParameter'
      - $ref: '#/components/parameters/TriggerNameParameter'
      - $ref: '#/components/parameters/SequentialParameter'
      - $ref: '#/components/parameters/AsyncParameter'
      - $ref: '#/components/parameters/MinorVersionParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                allOf:
                - $ref: '#/components/schemas/AllocateAccountPaymentInput'
                - $ref: '#/components/schemas/EntityWithAccountReference'
              example:
              - accountReference: ACCOUNT_REFERENCE_002
                currency: EUR
                matchStrategy: OLDEST_FIRST
                totalAmount: 6000
                providerName: trustly
                trackingId: TRACKING_ID_2
                context:
                  productReference: PRODUCT_REFERENCE_2
      responses:
        '200':
          $ref: '#/components/responses/200SuccessAllocateAccountPayment'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '429':
          $ref: '#/components/responses/429LimitsReached'
        '500':
          $ref: '#/components/responses/500InternalError'
      security:
      - api_key: []
  /v1/{clientId}/update_account_ledger_entries_amounts:
    post:
      tags:
      - Account
      summary: Updates the amounts of Account ledger entries
      description: 'The intention of the endpoint is to update the amounts of the Account ledger entries.

        This is an abstraction over adding directly the Ledger Entries to the Account, the objective is to simplify the process of updating the amounts of the ledger entries, using the target amount in the request, instead of the individual entries.

        Notes:

        - The calculations are executed first, and the claims related to those invoices will be updated only once.

        - The `reason` field is mandatory, and it will be used to identify the reason of the update, `PAYMENT` and `CHARGEBACK` are special values that will affect the creation of the ledger entries, creating Payment Ledger Entries and Chargeback Ledger Entries, any other reason is mapped to Adjustment Ledger Entries.

        - The last value in the array is the one that will be used to update the claim refered by the `ledgerEntryReference`, but the previous values are used to give context of the changes.

        '
      operationId: updateAccountLedgerEntriesAmounts
      parameters:
      - $ref: '#/components/parameters/ClientIdParameter'
      - $ref: '#/components/parameters/AuthorizationParameter'
      - $ref: '#/components/parameters/TriggerNameParameter'
      - $ref: '#/components/parameters/SequentialParameter'
      - $ref: '#/components/parameters/AsyncParameter'
      - $ref: '#/components/parameters/MinorVersionParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/UpdateAccountLedgerEntriesAmountsInput'
              example:
              - accountReference: ACCOUNT_REFERENCE_002
                ledgerEntries:
                - ledgerEntryReference: INVOICE_LEDGER_ENTRY_REFERENCE_002_1
                  amount: 10000
                  reason: CHARGEBACK
                  meta: {}
                - ledgerEntryReference: INVOICE_LEDGER_ENTRY_REFERENCE_002_2
                  amount: 0
                  reason: PAYMENT
                  meta: {}
      responses:
        '200':
          $ref: '#/components/responses/200SuccessUpdateAccountLedgerEntriesAmounts'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '429':
          $ref: '#/components/responses/429LimitsReached'
        '500':
          $ref: '#/components/responses/500InternalError'
      security:
      - api_key: []
  /v1/{clientId}/get_debtor_accounts_and_claims:
    get:
      tags:
      - Account
      summary: It retrieves information about a debtor's accounts and claims
      description: 'The intention of the endpoint is to retrieve information about a debtor''s accounts and claims.

        '
      operationId: getDebtorAccountsAndClaims
      parameters:
      - $ref: '#/components/parameters/ClientIdParameter'
      - $ref: '#/components/parameters/AuthorizationParameter'
      - $ref: '#/components/parameters/TriggerNameParameter'
      - name: debtorReference
        in: query
        required: true
        description: Identifier of the debtor
        schema:
          type: string
      responses:
        '200':
          $ref: '#/components/responses/200SuccessGetDebtorAccountsAndClaims'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '429':
          $ref: '#/components/responses/429LimitsReached'
        '500':
          $ref: '#/components/responses/500InternalError'
      security:
      - api_key: []
components:
  schemas:
    ClaimScore:
      type: object
      description: An Claim Score is a score that is calculated for a specific claim.
      required:
      - type
      - value
      properties:
        type:
          type: string
          description: Type of score
          enum:
          - INTERNAL
          - EXTERNAL
          - COLLECTION
          - BEHAVIORAL
        value:
          nullable: true
          oneOf:
          - type: string
            example: risky
            description: The score's value
          - type: object
            description: composed value
        meta:
          $ref: '#/components/schemas/Metadata'
    RelatedClaim:
      type: object
      description: A typed relation from this claim to another claim (lineage metadata; the platform does not act on it)
      required:
      - type
      - claimReference
      additionalProperties: false
      properties:
        type:
          type: string
          description: 'Relation type, declared on THIS claim pointing at the referenced claim (single direction; inverses are derived at query time). REPLACES: this claim supersedes the referenced ones (e.g. a consolidated claim placed at acceleration after crediting the individual instalment claims). SPLIT_FROM: this claim was split out of the referenced claim (e.g. the disputed portion of an invoice separated for independent handling). REINSTATES: this claim places debt back into collection after the referenced claim was already resolved (e.g. a settlement breached after the original claim was closed). REFINANCES: this claim is a new credit agreement curing the referenced claims under new terms — counts as recovery. RESTRUCTURES: this claim re-schedules the referenced debt by agreement with the debtor (workout/forbearance executed in your core system and placed as a new claim — restructures executed inside Receive use an Instalment Plan instead; do not create a new claim for those). DEFERS: this fee claim gates a due-date deferral of the referenced claims.'
          enum:
          - REPLACES
          - SPLIT_FROM
          - REINSTATES
          - REFINANCES
          - RESTRUCTURES
          - DEFERS
        claimReference:
          type: string
          minLength: 1
          description: Your reference of the related claim
          example: API_CLAIM_REF_INST_001
    MatchAccountPaymentInput:
      description: Input for match_account_payment endpoint.
      type: object
      required:
      - totalAmount
      - currency
      - matchStrategy
      properties:
        providerName:
          type: string
          description: Name of payment provider
          example: trustly
        trackingId:
          type: string
          description: This is the orderID or other identifier from the payment provider
          example: 3889445415
        totalAmount:
          $ref: '#/components/schemas/Amount'
        currency:
          

# --- truncated at 32 KB (80 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/receeve/refs/heads/main/openapi/receeve-account-api-openapi.yml