> ## Documentation Index
> Fetch the complete documentation index at: https://docs.paywise.de/llms.txt
> Use this file to discover all available pages before exploring further.

# List debtors

> The reusable debtors of your company.

List, retrieve, create, and PATCH. A supplied owned collection
(addresses, bank accounts, communication channels, legal
representatives) replaces that collection completely; omitted
collections stay unchanged. A case's debtor is the case's own snapshot
(published as `MandateDebtor` without an id) and is not a reusable
debtor: it is neither listed nor readable here.



## OpenAPI

````yaml /api-docs/case-management-api/openapi.json get /v2/debtors/
openapi: 3.0.3
info:
  description: >-
    Submit orders and manage their complete lifecycle through the current API at
    the `/v2/` HTTP path.
  title: paywise Case Management API
  version: current
servers:
  - description: Production environment
    url: https://api.paywise.de
  - description: Sandbox environment
    url: https://api-sandbox.paywise.de
security: []
tags:
  - description: Submit orders and manage them until acceptance.
    name: Orders
  - description: Stable claim resources and their current relationships.
    name: Claims
  - description: 'Accepted cases: state, published history and documents.'
    name: Mandates
  - description: Debtor master data reused across orders.
    name: Debtors
  - description: Payments reported by you and booked by paywise.
    name: Payments
  - description: Files attached to claims and other resources.
    name: Documents
  - description: Collective statements (Sammelabrechnungen).
    name: Statements
  - description: Per-case statements (Aktenabrechnungen).
    name: Single mandate statements
  - description: Webhook endpoints and their signing secrets.
    name: Webhooks
  - description: Delivery log and redelivery of webhook events.
    name: Webhook deliveries
  - description: Ordered feed of the events webhooks deliver.
    name: Events
  - description: Reference catalog of legal forms.
    name: Legal forms
  - description: The authenticated credential and its context.
    name: Info
  - description: Rate-limit headroom of the credential.
    name: Usage
  - description: Availability of the API.
    name: Health
externalDocs:
  url: https://docs.paywise.de/api-docs/case-management-api/introduction
paths:
  /v2/debtors/:
    get:
      tags:
        - Debtors
      summary: List debtors
      description: |-
        The reusable debtors of your company.

        List, retrieve, create, and PATCH. A supplied owned collection
        (addresses, bank accounts, communication channels, legal
        representatives) replaces that collection completely; omitted
        collections stay unchanged. A case's debtor is the case's own snapshot
        (published as `MandateDebtor` without an id) and is not a reusable
        debtor: it is neither listed nor readable here.
      operationId: list-debtors
      parameters:
        - description: >-
            Required when a Partner key calls the Case Management API; rejected
            for direct Case keys. Contains the entitled paywise company UUID.
          in: header
          name: X-On-Behalf-Of-Company
          schema:
            format: uuid
            type: string
        - description: >-
            Exact capacity in which the debtor incurred the obligation:
            `consumer` or `business`.
          in: query
          name: acting_as
          schema:
            enum:
              - business
              - consumer
            type: string
        - description: >-
            Opaque continuation cursor for incremental synchronization, taken
            from the `next` URL of a previous page. Only valid together with
            `updated_since`: with `updated_since` set the list is ordered by
            change time and then id and pages by this cursor instead of
            `offset`, so a row that changes while you page is returned again
            later instead of pushing another row out of the result. Rows changed
            less than 60 seconds ago are held back until they are settled; use
            the largest `updated_at` you received as the next `updated_since`.
          in: query
          name: cursor
          required: false
          schema:
            type: string
        - description: Return the debtor with this UUID.
          in: query
          name: id
          schema:
            format: uuid
            type: string
        - description: Number of results to return (maximum 100).
          in: query
          name: limit
          required: false
          schema:
            default: 10
            maximum: 100
            minimum: 1
            type: integer
        - description: >-
            Zero-based result offset. Cannot be combined with `updated_since`;
            follow the `next` URL (`cursor`) instead.
          in: query
          name: offset
          required: false
          schema:
            default: 0
            minimum: 0
            type: integer
        - description: >-
            Return rows changed at or after this timezone-aware RFC 3339
            timestamp. Results are ordered by updated_at and id (a requested
            `ordering` is ignored), page by `cursor` instead of `offset`, and
            rows changed less than a minute ago are held back.
          in: query
          name: updated_since
          schema:
            format: date-time
            type: string
        - description: Case-insensitive substring of your debtor reference.
          in: query
          name: your_reference
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedDebtorListList'
          description: ''
          headers:
            Cache-Control:
              description: >-
                Cacheability directive. Authenticated responses use `private,
                no-store`; the legal-form catalog may use `private,
                max-age=86400`.
              schema:
                type: string
            X-Paywise-Environment:
              description: Environment that produced the response.
              schema:
                enum:
                  - production
                  - sandbox
                type: string
            X-Paywise-Request-Id:
              description: >-
                Fresh server-assigned correlation id for this response.
                Caller-provided request ids are ignored.
              schema:
                format: uuid
                type: string
        '400':
          content:
            application/json:
              examples:
                validation-error:
                  value:
                    code: validation_error
                    detail: The request contains invalid data.
                    errors:
                      - code: invalid
                        field: claims[0].due_date
                        message: Due date must not precede the document date.
              schema:
                $ref: '#/components/schemas/Error'
          description: Standard error response.
          headers:
            Cache-Control:
              description: >-
                Cacheability directive. Authenticated responses use `private,
                no-store`; the legal-form catalog may use `private,
                max-age=86400`.
              schema:
                type: string
            X-Paywise-Environment:
              description: Environment that produced the response.
              schema:
                enum:
                  - production
                  - sandbox
                type: string
            X-Paywise-Request-Id:
              description: >-
                Fresh server-assigned correlation id for this response.
                Caller-provided request ids are ignored.
              schema:
                format: uuid
                type: string
        '401':
          content:
            application/json:
              examples:
                authentication-error:
                  value:
                    code: not_authenticated
                    detail: Authentication credentials were not provided.
              schema:
                $ref: '#/components/schemas/Error'
          description: Standard error response.
          headers:
            Cache-Control:
              description: >-
                Cacheability directive. Authenticated responses use `private,
                no-store`; the legal-form catalog may use `private,
                max-age=86400`.
              schema:
                type: string
            X-Paywise-Environment:
              description: Environment that produced the response.
              schema:
                enum:
                  - production
                  - sandbox
                type: string
            X-Paywise-Request-Id:
              description: >-
                Fresh server-assigned correlation id for this response.
                Caller-provided request ids are ignored.
              schema:
                format: uuid
                type: string
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Standard error response.
          headers:
            Cache-Control:
              description: >-
                Cacheability directive. Authenticated responses use `private,
                no-store`; the legal-form catalog may use `private,
                max-age=86400`.
              schema:
                type: string
            X-Paywise-Environment:
              description: Environment that produced the response.
              schema:
                enum:
                  - production
                  - sandbox
                type: string
            X-Paywise-Request-Id:
              description: >-
                Fresh server-assigned correlation id for this response.
                Caller-provided request ids are ignored.
              schema:
                format: uuid
                type: string
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Standard error response.
          headers:
            Cache-Control:
              description: >-
                Cacheability directive. Authenticated responses use `private,
                no-store`; the legal-form catalog may use `private,
                max-age=86400`.
              schema:
                type: string
            Retry-After:
              description: Integer seconds to wait before retrying a throttled request.
              schema:
                minimum: 1
                type: integer
            X-Paywise-Environment:
              description: Environment that produced the response.
              schema:
                enum:
                  - production
                  - sandbox
                type: string
            X-Paywise-Request-Id:
              description: >-
                Fresh server-assigned correlation id for this response.
                Caller-provided request ids are ignored.
              schema:
                format: uuid
                type: string
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Standard error response.
          headers:
            Cache-Control:
              description: >-
                Cacheability directive. Authenticated responses use `private,
                no-store`; the legal-form catalog may use `private,
                max-age=86400`.
              schema:
                type: string
            X-Paywise-Environment:
              description: Environment that produced the response.
              schema:
                enum:
                  - production
                  - sandbox
                type: string
            X-Paywise-Request-Id:
              description: >-
                Fresh server-assigned correlation id for this response.
                Caller-provided request ids are ignored.
              schema:
                format: uuid
                type: string
      security:
        - caseBearerAuth: []
        - partnerBearerAuth: []
components:
  schemas:
    PaginatedDebtorListList:
      properties:
        count:
          description: Total number of matching resources.
          example: 123
          type: integer
        next:
          description: >-
            URL for the next page, or null when this is the last page. With
            `updated_since` it carries an opaque `cursor`.
          example: http://api.example.org/accounts/?offset=400&limit=100
          format: uri
          nullable: true
          type: string
        previous:
          description: >-
            URL for the previous page, or null when this is the first page.
            Always null with `updated_since`.
          example: http://api.example.org/accounts/?offset=200&limit=100
          format: uri
          nullable: true
          type: string
        results:
          description: Resources returned for the requested page.
          items:
            $ref: '#/components/schemas/DebtorList'
          type: array
      required:
        - count
        - results
      type: object
    Error:
      properties:
        code:
          description: Machine-readable error category.
          type: string
        detail:
          description: Short human-readable summary of the error.
          type: string
        errors:
          description: Field-level validation errors, when applicable.
          items:
            $ref: '#/components/schemas/ErrorItem'
          type: array
      required:
        - detail
        - code
      type: object
    DebtorList:
      properties:
        acting_as:
          allOf:
            - $ref: '#/components/schemas/ActingAsEnum'
          description: >-
            Whether the debtor incurred the obligation as a consumer or in a
            business capacity.


            * `consumer` - consumer

            * `business` - business
          readOnly: true
        addresses:
          description: Postal addresses associated with the debtor.
          items:
            $ref: '#/components/schemas/AddressRead'
          readOnly: true
          type: array
        created_at:
          description: Time at which the debtor was created.
          format: date-time
          readOnly: true
          type: string
        events:
          description: Stored contextual events associated with this resource.
          items:
            $ref: '#/components/schemas/LegacyEventRead'
          readOnly: true
          type: array
        id:
          description: Stable identifier of this debtor.
          format: uuid
          readOnly: true
          type: string
        legal_form:
          description: >-
            Permanent public legal-form code; look up its label and
            representation rules with GET /v2/legal-forms/. Null for consumers.
          nullable: true
          readOnly: true
          type: string
        metadata:
          description: Stored metadata entries; duplicate types remain separate entries.
          items:
            $ref: '#/components/schemas/LegacyMetadataRead'
          readOnly: true
          type: array
        organization:
          allOf:
            - $ref: '#/components/schemas/OrganizationRead'
          description: Organization identity for a business debtor.
          nullable: true
          readOnly: true
        person:
          allOf:
            - $ref: '#/components/schemas/PersonRead'
          description: Natural-person identity for a consumer or sole proprietor.
          nullable: true
          readOnly: true
        updated_at:
          description: Time at which the debtor was last updated.
          format: date-time
          readOnly: true
          type: string
        your_reference:
          description: Your reference for this debtor.
          nullable: true
          readOnly: true
          type: string
      required:
        - acting_as
        - addresses
        - created_at
        - events
        - id
        - legal_form
        - metadata
        - organization
        - person
        - updated_at
        - your_reference
      type: object
    ErrorItem:
      properties:
        code:
          description: Machine-readable field error code.
          type: string
        field:
          description: >-
            Path to the field that caused the error, using dots for objects and
            brackets for list indexes, for example `claims[0].amount`; null for
            an error without a field path.
          nullable: true
          type: string
        message:
          description: Human-readable explanation of the field error.
          type: string
      required:
        - field
        - code
        - message
      type: object
    ActingAsEnum:
      description: |-
        * `consumer` - consumer
        * `business` - business
      enum:
        - consumer
        - business
      type: string
    AddressRead:
      properties:
        city:
          description: City or locality of the address.
          readOnly: true
          type: string
        country:
          description: Country as a two-letter ISO 3166-1 code.
          readOnly: true
          type: string
        id:
          description: Stable identifier of this address.
          format: uuid
          readOnly: true
          type: string
        postal_code:
          description: Postal code of the address.
          readOnly: true
          type: string
        primary:
          description: Whether this is the debtor's primary postal address.
          readOnly: true
          type: boolean
        street:
          description: Street and house number.
          readOnly: true
          type: string
      required:
        - city
        - country
        - id
        - postal_code
        - primary
        - street
      type: object
    LegacyEventRead:
      description: Stored events may likewise use retired or internal type values.
      properties:
        description:
          description: Optional description of the event.
          nullable: true
          readOnly: true
          type: string
        location:
          description: Optional location associated with the event.
          nullable: true
          readOnly: true
          type: string
        occurence:
          description: >-
            Time at which the event occurred; the historical field spelling is
            intentional.
          format: date-time
          readOnly: true
          type: string
        title:
          description: Human-readable title of the event.
          readOnly: true
          type: string
        type:
          description: >-
            Stored event type; historical values may be outside today's input
            enum.
          readOnly: true
          type: string
        your_reference:
          description: Your optional reference for the event.
          nullable: true
          readOnly: true
          type: string
      required:
        - description
        - location
        - occurence
        - title
        - type
        - your_reference
      type: object
    LegacyMetadataRead:
      description: Stored types may predate today's resource-specific input choices.
      properties:
        type:
          description: >-
            Stored metadata type; historical values may be outside today's input
            enum.
          readOnly: true
          type: string
        value:
          description: Stored metadata value.
          readOnly: true
          type: string
      required:
        - type
        - value
      type: object
    OrganizationRead:
      properties:
        commercial_register:
          description: Register court or authority holding the registration.
          nullable: true
          readOnly: true
          type: string
        commercial_registration_number:
          description: Commercial, association, or partnership register number.
          nullable: true
          readOnly: true
          type: string
        name:
          description: Registered or trading name of the organization.
          readOnly: true
          type: string
      required:
        - commercial_register
        - commercial_registration_number
        - name
      type: object
    PersonRead:
      properties:
        birth_date:
          description: Date of birth used to identify the natural person.
          format: date
          nullable: true
          readOnly: true
          type: string
        first_name:
          description: Given name of the natural person.
          readOnly: true
          type: string
        last_name:
          description: Family name of the natural person.
          readOnly: true
          type: string
        salutation:
          allOf:
            - $ref: '#/components/schemas/SalutationEnum'
          description: >-
            Salutation of the natural person; null if no supported salutation is
            stored.
          nullable: true
          readOnly: true
      required:
        - birth_date
        - first_name
        - last_name
        - salutation
      type: object
    SalutationEnum:
      enum:
        - mr
        - ms
        - mx
      type: string
  securitySchemes:
    caseBearerAuth:
      description: >-
        Company-bound Case Management API key — the standard credential for this
        API.
      scheme: bearer
      type: http
    partnerBearerAuth:
      description: >-
        Partner API key acting for one entitled company; every Case request must
        then also carry the X-On-Behalf-Of-Company header.
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.