> ## 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 claims

> Claims addressed by their stable UUID and current relationships.

Read claims throughout their lifecycle using URLs that remain valid after
internal order moves. Standalone creation requires a draft `order_id`;
the relationship is read-only thereafter. Create, PATCH, and DELETE require
a draft order and otherwise return `409 claim_not_editable`. An expired
draft instead returns `409 order_expired`. Tenant-scoped by the
authenticated company.



## OpenAPI

````yaml /api-docs/case-management-api/openapi.json get /v2/claims/
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/claims/:
    get:
      tags:
        - Claims
      summary: List claims
      description: >-
        Claims addressed by their stable UUID and current relationships.


        Read claims throughout their lifecycle using URLs that remain valid
        after

        internal order moves. Standalone creation requires a draft `order_id`;

        the relationship is read-only thereafter. Create, PATCH, and DELETE
        require

        a draft order and otherwise return `409 claim_not_editable`. An expired

        draft instead returns `409 order_expired`. Tenant-scoped by the

        authenticated company.
      operationId: list-claims
      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: 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.
          in: query
          name: offset
          required: false
          schema:
            default: 0
            minimum: 0
            type: integer
        - description: Filter claims by their parent order's UUID.
          in: query
          name: order_id
          schema:
            format: uuid
            type: string
        - description: |-
            * `draft` - draft
            * `submitted` - submitted
            * `awaiting_client_response` - awaiting_client_response
            * `accepted` - accepted
            * `rejected` - rejected
            * `withdrawn` - withdrawn
          in: query
          name: status
          schema:
            enum:
              - accepted
              - awaiting_client_response
              - draft
              - rejected
              - submitted
              - withdrawn
            type: string
        - description: >-
            Return rows changed at or after this timezone-aware RFC 3339
            timestamp. Results are ordered by updated_at and id.
          in: query
          name: updated_since
          schema:
            format: date-time
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedClaimList'
          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:
    PaginatedClaimList:
      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.
          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.
          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/Claim'
          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
    Claim:
      discriminator:
        mapping:
          receivable: '#/components/schemas/ReceivableClaim'
          titled: '#/components/schemas/TitledClaim'
        propertyName: type
      oneOf:
        - $ref: '#/components/schemas/ReceivableClaim'
        - $ref: '#/components/schemas/TitledClaim'
    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
    ReceivableClaim:
      description: >-
        A receivable claim based on an invoice, rent, or another obligation. Its
        principal amount, dates, charges, and documents belong to the claim.
      properties:
        additional_charges:
          description: >-
            Itemized incidental claims such as reminder or bank fees. API
            submissions are limited to 50 entries.
          items:
            $ref: '#/components/schemas/ClaimChargeRead'
          readOnly: true
          type: array
        additional_charges_amount:
          allOf:
            - $ref: '#/components/schemas/ClaimAmountRead'
          description: Sum of all itemized additional charges.
          readOnly: true
        additional_debtor_ids:
          description: >-
            Read-only additional debtor identifiers projected from the current
            order.
          items:
            format: uuid
            type: string
          readOnly: true
          type: array
        created_at:
          description: Time at which the claim was created.
          format: date-time
          readOnly: true
          type: string
        debtor_id:
          description: >-
            Read-only primary debtor identifier projected from the current
            order. Change party membership only on a draft order; debtor details
            use the debtor resource.
          format: uuid
          nullable: true
          readOnly: true
          type: string
        delay_date:
          description: Date from which the debtor is considered in payment default.
          format: date
          nullable: true
          readOnly: true
          type: string
        dispute_reason:
          description: Debtor's stated reason for disputing the claim.
          nullable: true
          readOnly: true
          type: string
        document_date:
          description: Date of the invoice, contract, or other claim document.
          format: date
          nullable: true
          readOnly: true
          type: string
        document_reference:
          description: Invoice, contract, or other source-document number.
          nullable: true
          readOnly: true
          type: string
        documents:
          description: Documents relevant to processing the claim.
          items:
            $ref: '#/components/schemas/DocumentRead'
          readOnly: true
          type: array
        due_date:
          description: Date on which payment of the principal claim became due.
          format: date
          nullable: true
          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 claim.
          format: uuid
          readOnly: true
          type: string
        is_disputed:
          description: Whether the debtor disputes the claim.
          readOnly: true
          type: boolean
        items:
          description: >-
            Invoice or contract lines that make up the principal claim. API
            submissions are limited to 100 entries.
          items:
            $ref: '#/components/schemas/ClaimItemRead'
          readOnly: true
          type: array
        legal_basis:
          allOf:
            - $ref: '#/components/schemas/ClaimLegalBasisRead'
          description: Contract or obligation that establishes the principal claim.
          readOnly: true
        mandate_id:
          description: Read-only accepted mandate identifier, or null before acceptance.
          format: uuid
          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
        order_id:
          description: >-
            Read-only current order identifier. Internal review may change this
            relationship while the claim identifier and all claim-specific URLs
            remain stable.
          format: uuid
          readOnly: true
          type: string
        payments:
          description: >-
            Read-only payments attributed to this claim. Report subsequent
            payments through the stable claim payments URL, including after
            acceptance or an internal order move. Reporting requires
            case:payments:write.
          items:
            $ref: '#/components/schemas/PaymentRead'
          readOnly: true
          type: array
        principal_amount:
          allOf:
            - $ref: '#/components/schemas/ClaimAmountRead'
          description: >-
            Original principal amount including VAT, before charges and
            payments.
          nullable: true
          readOnly: true
        reminders:
          description: >-
            Payment reminders issued for this claim in chronological order. API
            submissions are limited to 50 entries.
          items:
            $ref: '#/components/schemas/ClaimReminderRead'
          readOnly: true
          type: array
        status:
          allOf:
            - $ref: '#/components/schemas/ClaimStatusEnum'
          description: >-
            Read-only effective claim lifecycle. Draft-only commands return 409
            claim_not_editable after submission and 409 order_expired once the
            draft has passed its expires_at; payment and title commands retain
            their specific lifecycle conflict codes.
          readOnly: true
        subject_matter:
          description: >-
            Goods, services, or other obligation underlying the claim. API
            submissions are limited to 2000 characters.
          nullable: true
          readOnly: true
          type: string
        total_amount:
          allOf:
            - $ref: '#/components/schemas/ClaimAmountRead'
          description: Current open amount after charges and reported payments.
          nullable: true
          readOnly: true
        type:
          allOf:
            - $ref: '#/components/schemas/ReceivableClaimTypeEnum'
          description: Literal receivable claim discriminator.
          readOnly: true
        updated_at:
          description: Time at which the claim was last updated.
          format: date-time
          readOnly: true
          type: string
        your_reference:
          description: Your reference for this claim.
          nullable: true
          readOnly: true
          type: string
      required:
        - additional_charges
        - additional_charges_amount
        - additional_debtor_ids
        - created_at
        - debtor_id
        - delay_date
        - dispute_reason
        - document_date
        - document_reference
        - documents
        - due_date
        - events
        - id
        - is_disputed
        - items
        - legal_basis
        - mandate_id
        - metadata
        - order_id
        - payments
        - principal_amount
        - reminders
        - status
        - subject_matter
        - total_amount
        - type
        - updated_at
        - your_reference
      title: Receivable claim
      type: object
    TitledClaim:
      description: >-
        A claim backed by an enforceable title. The title's amount, dates, and
        documents belong to `enforceable_title`.
      properties:
        additional_debtor_ids:
          description: >-
            Read-only additional debtor identifiers projected from the current
            order.
          items:
            format: uuid
            type: string
          readOnly: true
          type: array
        created_at:
          description: Time at which the claim was created.
          format: date-time
          readOnly: true
          type: string
        debtor_id:
          description: >-
            Read-only primary debtor identifier projected from the current
            order. Change party membership only on a draft order; debtor details
            use the debtor resource.
          format: uuid
          nullable: true
          readOnly: true
          type: string
        dispute_reason:
          description: Debtor's stated reason for disputing the claim.
          nullable: true
          readOnly: true
          type: string
        document_reference:
          description: Invoice, contract, or other source-document number.
          nullable: true
          readOnly: true
          type: string
        enforceable_title:
          allOf:
            - $ref: '#/components/schemas/EnforceableTitleRead'
          description: >-
            Enforceable title that owns this claim's gross amount, legal
            metadata, and title documents.
          nullable: true
          readOnly: true
        events:
          description: Stored contextual events associated with this resource.
          items:
            $ref: '#/components/schemas/LegacyEventRead'
          readOnly: true
          type: array
        id:
          description: Stable identifier of this claim.
          format: uuid
          readOnly: true
          type: string
        is_disputed:
          description: Whether the debtor disputes the claim.
          readOnly: true
          type: boolean
        mandate_id:
          description: Read-only accepted mandate identifier, or null before acceptance.
          format: uuid
          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
        order_id:
          description: >-
            Read-only current order identifier. Internal review may change this
            relationship while the claim identifier and all claim-specific URLs
            remain stable.
          format: uuid
          readOnly: true
          type: string
        payments:
          description: >-
            Read-only payments attributed to this claim. Report subsequent
            payments through the stable claim payments URL, including after
            acceptance or an internal order move. Reporting requires
            case:payments:write.
          items:
            $ref: '#/components/schemas/PaymentRead'
          readOnly: true
          type: array
        principal_amount:
          allOf:
            - $ref: '#/components/schemas/ClaimAmountRead'
          description: >-
            Always null for a titled claim; use enforceable_title.amount for the
            authoritative gross amount.
          nullable: true
          readOnly: true
        status:
          allOf:
            - $ref: '#/components/schemas/ClaimStatusEnum'
          description: >-
            Read-only effective claim lifecycle. Draft-only commands return 409
            claim_not_editable after submission and 409 order_expired once the
            draft has passed its expires_at; payment and title commands retain
            their specific lifecycle conflict codes.
          readOnly: true
        subject_matter:
          description: >-
            Goods, services, or other obligation underlying the claim. API
            submissions are limited to 2000 characters.
          nullable: true
          readOnly: true
          type: string
        total_amount:
          allOf:
            - $ref: '#/components/schemas/ClaimAmountRead'
          description: >-
            Authoritative gross enforceable-title amount; reported payments are
            exposed separately and do not reduce it.
          nullable: true
          readOnly: true
        type:
          allOf:
            - $ref: '#/components/schemas/TitledClaimTypeEnum'
          description: Literal titled claim discriminator.
          readOnly: true
        updated_at:
          description: Time at which the claim was last updated.
          format: date-time
          readOnly: true
          type: string
        your_reference:
          description: Your reference for this claim.
          nullable: true
          readOnly: true
          type: string
      required:
        - additional_debtor_ids
        - created_at
        - debtor_id
        - dispute_reason
        - document_reference
        - enforceable_title
        - events
        - id
        - is_disputed
        - mandate_id
        - metadata
        - order_id
        - payments
        - principal_amount
        - status
        - subject_matter
        - total_amount
        - type
        - updated_at
        - your_reference
      title: Titled claim
      type: object
    ClaimChargeRead:
      description: Read representation of one canonical additional charge.
      properties:
        amount:
          allOf:
            - $ref: '#/components/schemas/ClaimAmountRead'
          description: Amount of the additional charge.
          readOnly: true
        events:
          description: Stored contextual events associated with this resource.
          items:
            $ref: '#/components/schemas/LegacyEventRead'
          readOnly: true
          type: array
        id:
          description: Stable identifier of this additional charge.
          format: uuid
          readOnly: true
          type: string
        metadata:
          description: Stored metadata entries; duplicate types remain separate entries.
          items:
            $ref: '#/components/schemas/LegacyMetadataRead'
          readOnly: true
          type: array
        occurrence_date:
          description: Date on which the additional charge arose.
          format: date
          nullable: true
          readOnly: true
          type: string
        subject_matter:
          description: Reason or subject of the additional charge.
          nullable: true
          readOnly: true
          type: string
        type:
          allOf:
            - $ref: '#/components/schemas/CaseChargeTypeEnum'
          description: |-
            Business category of the additional charge.

            * `reminder_fee` - reminder_fee
            * `bank_charge` - bank_charge
            * `research_costs` - research_costs
          readOnly: true
        your_reference:
          description: Your reference for this additional charge.
          nullable: true
          readOnly: true
          type: string
      required:
        - amount
        - events
        - id
        - metadata
        - occurrence_date
        - subject_matter
        - type
        - your_reference
      type: object
    ClaimAmountRead:
      description: Read-only two-decimal EUR amount.
      properties:
        currency:
          allOf:
            - $ref: '#/components/schemas/CurrencyEnum'
          description: |-
            Currency of the amount; currently always EUR.

            * `EUR` - EUR
          readOnly: true
        value:
          description: Monetary value expressed with two decimal places.
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
          readOnly: true
          type: string
      required:
        - currency
        - value
      type: object
    DocumentRead:
      description: Resource representation with a native UUID `id`.
      properties:
        created_at:
          description: Time at which the document was submitted.
          format: date-time
          readOnly: true
          type: string
        download_url:
          description: >-
            Authenticated API URL for downloading the document; null while its
            status is not `ready`.
          format: uri
          nullable: true
          readOnly: true
          type: string
        failure_reason:
          allOf:
            - $ref: '#/components/schemas/DocumentFailureReasonEnum'
          description: >-
            Why processing failed when status is `failed`; `null` otherwise.
            `page_limit_exceeded`: PDF above the 100-page ceiling; `encrypted`:
            password-protected PDF; `corrupt`: bytes could not be parsed;
            `unsupported`: content type not accepted; `processing_failed`: any
            other processing error.
          nullable: true
          readOnly: true
        filename:
          description: Original filename shown to users.
          readOnly: true
          type: string
        id:
          description: Stable identifier for this resource.
          format: uuid
          readOnly: true
          type: string
        mime_type:
          description: Detected media type of the document.
          nullable: true
          readOnly: true
          type: string
        parent:
          allOf:
            - $ref: '#/components/schemas/DocumentParent'
          description: Resource that owns the document.
          readOnly: true
        status:
          allOf:
            - $ref: '#/components/schemas/CaseDocumentStatusEnum'
          description: >-
            Document availability: `pending` while scanning or processing is
            incomplete; `ready` when processing permits download; `failed` when
            scanning or processing failed; `rejected` when the malware check
            rejected the file.
          readOnly: true
        type:
          allOf:
            - $ref: '#/components/schemas/CaseDocumentTypeEnum'
          description: Business purpose of the document.
          readOnly: true
        updated_at:
          description: Time at which document processing last changed.
          format: date-time
          readOnly: true
          type: string
      required:
        - created_at
        - download_url
        - failure_reason
        - filename
        - id
        - mime_type
        - parent
        - status
        - type
        - updated_at
      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
    ClaimItemRead:
      description: Read representation of one invoice line.
      properties:
        amount:
          allOf:
            - $ref: '#/components/schemas/ClaimAmountRead'
          description: 'Calculated line total: quantity multiplied by unit price.'
          readOnly: true
        description:
          description: Goods or service represented by this invoice or contract line.
          readOnly: true
          type: string
        quantity:
          description: Number of units represented by this line.
          format: decimal
          pattern: ^-?\d{0,10}(?:\.\d{0,6})?$
          readOnly: true
          type: string
        unit:
          description: Unit of measure for the quantity, when applicable.
          nullable: true
          readOnly: true
          type: string
        unit_price:
          allOf:
            - $ref: '#/components/schemas/ClaimAmountRead'
          description: Price of one unit before multiplying by quantity.
          readOnly: true
      required:
        - amount
        - description
        - quantity
        - unit
        - unit_price
      type: object
    ClaimLegalBasisRead:
      description: Read representation of the singular legal basis.
      properties:
        claim_type_code:
          description: >-
            Code identifying the contract or transaction underlying the claim.
            H17 is commercial rent, H19 is residential rent, and K014 identifies
            receivable enforcement costs in titled orders. See [legal basis
            codes](https://docs.paywise.de/api-docs/case-management-api/concepts/claims#legal-basis-codes)
            for the full code-to-meaning table.
          nullable: true
          readOnly: true
          type: string
        contract_date:
          description: Date on which the underlying contract or obligation arose.
          format: date
          nullable: true
          readOnly: true
          type: string
        description:
          description: >-
            Terms or circumstances establishing the principal claim. API
            submissions are limited to 2000 characters.
          nullable: true
          readOnly: true
          type: string
      required:
        - claim_type_code
        - contract_date
        - description
      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
    PaymentRead:
      description: Read representation of one reported payment.
      properties:
        amount:
          allOf:
            - $ref: '#/components/schemas/PaymentAmountRead'
          description: Amount received.
          nullable: true
          readOnly: true
        claim:
          allOf:
            - $ref: '#/components/schemas/PaymentClaimReference'
          description: Claim to which the payment was reported.
          nullable: true
          readOnly: true
        created_at:
          description: Time at which the payment was reported.
          format: date-time
          readOnly: true
          type: string
        id:
          description: Stable identifier of this reported payment.
          format: uuid
          readOnly: true
          type: string
        mandate:
          allOf:
            - $ref: '#/components/schemas/PaymentMandateReference'
          description: Accepted case containing the claim.
          nullable: true
          readOnly: true
        metadata:
          description: Stored metadata entries; duplicate types remain separate entries.
          items:
            $ref: '#/components/schemas/LegacyMetadataRead'
          readOnly: true
          type: array
        updated_at:
          description: Time at which the payment record was last updated.
          format: date-time
          readOnly: true
          type: string
        value_date:
          description: Date on which the payment was credited.
          format: date
          readOnly: true
          type: string
        your_reference:
          description: Your reference for reconciling this payment.
          nullable: true
          readOnly: true
          type: string
      required:
        - amount
        - claim
        - created_at
        - id
        - mandate
        - metadata
        - updated_at
        - value_date
        - your_reference
      type: object
    ClaimReminderRead:
      description: Read representation of one normalized reminder.
      properties:
        date:
          description: Date on which the payment reminder was issued.
          format: date
          nullable: true
          readOnly: true
          type: string
        due_date:
          description: Payment deadline stated in the reminder, when present.
          format: date
          nullable: true
          readOnly: true
          type: string
        id:
          description: Stable identifier of this reminder.
          format: uuid
          nullable: true
          readOnly: true
          type: string
      required:
        - date
        - due_date
        - id
      type: object
    ClaimStatusEnum:
      description: |-
        * `draft` - draft
        * `submitted` - submitted
        * `awaiting_client_response` - awaiting_client_response
        * `accepted` - accepted
        * `rejected` - rejected
        * `withdrawn` - withdrawn
      enum:
        - draft
        - submitted
        - awaiting_client_response
        - accepted
        - rejected
        - withdrawn
      type: string
    ReceivableClaimTypeEnum:
      enum:
        - receivable
      type: string
    EnforceableTitleRead:
      properties:
        amount:
          allOf:
            - $ref: '#/components/schemas/TitleAmountWrite'
          description: >-
            Gross amount confirmed by the client and owned by the enforceable
            title.
          nullable: true
          readOnly: true
        created_at:
          description: Time at which the enforceable title was created.
          format: date-time
          readOnly: true
          type: string
        documents:
          description: >-
            Documents owned by the title; one primary enforceable-title document
            is required before finalization.
          items:
            $ref: '#/components/schemas/DocumentRead'
          readOnly: true
          type: array
        file_number:
          description: Official file or reference number shown on the title.
          readOnly: true
          type: string
        id:
          description: Stable identifier of the enforceable title.
          format: uuid
          readOnly: true
          type: string
        issued_on:
          description: Date on which the enforceable title was issued.
          format: date
          nullable: true
          readOnly: true
          type: string
        issuing_authority:
          description: Court, notary, or other authority that issued the title.
          readOnly: true
          type: string
        legally_binding_since:
          description: >-
            Optional date from which the title is legally binding; it cannot
            precede issued_on.
          format: date
          nullable: true
          readOnly: true
          type: string
        served_on:
          description: >-
            Optional date on which the title was served; it cannot precede
            issued_on.
          format: date
          nullable: true
          readOnly: true
          type: string
        title_type:
          allOf:
            - $ref: '#/components/schemas/TitleTypeEnum'
          description: >-
            Legal title category: enforcement_order = Vollstreckungsbescheid;
            default_judgment = Versäumnisurteil; final_judgment = Endurteil;
            acknowledgment_judgment = Anerkenntnisurteil; reservation_judgment =
            Vorbehaltsurteil; court_settlement = Gerichtlicher Vergleich;
            enforceable_notarial_deed = Vollstreckbare notarielle Urkunde;
            cost_assessment_order = Kostenfestsetzungsbeschluss; other =
            Sonstiger Titel.
          nullable: true
          readOnly: true
        updated_at:
          description: Time at which the enforceable title last changed.
          format: date-time
          readOnly: true
          type: string
      required:
        - amount
        - created_at
        - documents
        - file_number
        - id
        - issued_on
        - issuing_authority
        - legally_binding_since
        - served_on
        - title_type
        - updated_at
      type: object
    TitledClaimTypeEnum:
      description: '* `titled` - Titled claim'
      enum:
        - titled
      type: string
    CaseChargeTypeEnum:
      description: |-
        * `reminder_fee` - reminder_fee
        * `bank_charge` - bank_charge
        * `research_costs` - research_costs
      enum:
        - reminder_fee
        - bank_charge
        - research_costs
      type: string
    CurrencyEnum:
      description: '* `EUR` - EUR'
      enum:
        - EUR
      type: string
    DocumentFailureReasonEnum:
      enum:
        - page_limit_exceeded
        - encrypted
        - corrupt
        - unsupported
        - processing_failed
      type: string
    DocumentParent:
      properties:
        id:
          description: Identifier of the resource that owns the document.
          format: uuid
          readOnly: true
          type: string
        type:
          allOf:
            - $ref: '#/components/schemas/DocumentParentTypeEnum'
          description: |-
            Kind of resource that owns the document.

            * `claim` - claim
            * `message` - message
            * `request_to_client_answer` - request_to_client_answer
            * `rental_agreement` - rental_agreement
            * `enforceable_title` - enforceable_title
          readOnly: true
      required:
        - id
        - type
      type: object
    CaseDocumentStatusEnum:
      enum:
        - pending
        - ready
        - failed
        - rejected
      type: string
    CaseDocumentTypeEnum:
      description: |-
        * `bank_statement` - bank_statement
        * `claim_statement` - claim_statement
        * `correspondence` - correspondence
        * `enforceable_title` - enforceable_title
        * `invoice` - invoice
        * `other` - other
        * `payment_proof` - payment_proof
        * `reminder` - reminder
        * `rental_agreement` - rental_agreement
      enum:
        - bank_statement
        - claim_statement
        - correspondence
        - enforceable_title
        - invoice
        - other
        - payment_proof
        - reminder
        - rental_agreement
      type: string
    PaymentAmountRead:
      properties:
        currency:
          description: Currency of the payment.
          readOnly: true
          type: string
        value:
          description: Amount received, expressed with two decimal places.
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
          readOnly: true
          type: string
      required:
        - currency
        - value
      type: object
    PaymentClaimReference:
      properties:
        document_reference:
          description: Invoice, contract, or source-document number of the claim.
          nullable: true
          readOnly: true
          type: string
        id:
          description: Identifier of the claim receiving the payment.
          format: uuid
          readOnly: true
          type: string
        your_reference:
          description: Your reference for the claim.
          nullable: true
          readOnly: true
          type: string
      required:
        - document_reference
        - id
        - your_reference
      type: object
    PaymentMandateReference:
      properties:
        id:
          description: Identifier of the accepted case receiving the payment.
          format: uuid
          readOnly: true
          type: string
        reference_number:
          description: paywise case-file reference number.
          readOnly: true
          type: string
      required:
        - id
        - reference_number
      type: object
    TitleAmountWrite:
      description: The gross enforceable amount; validated as a whole even on PATCH.
      properties:
        currency:
          allOf:
            - $ref: '#/components/schemas/CurrencyEnum'
          default: EUR
          description: Currency of the title amount; only EUR is supported.
        value:
          description: >-
            Gross title amount in major currency units, with at most two decimal
            places. Zero is accepted while drafting; the amount must be positive
            before finalization.
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
          type: string
      required:
        - value
      type: object
    TitleTypeEnum:
      description: |-
        * `enforcement_order` - enforcement_order
        * `default_judgment` - default_judgment
        * `final_judgment` - final_judgment
        * `acknowledgment_judgment` - acknowledgment_judgment
        * `reservation_judgment` - reservation_judgment
        * `court_settlement` - court_settlement
        * `enforceable_notarial_deed` - enforceable_notarial_deed
        * `cost_assessment_order` - cost_assessment_order
        * `other` - other
      enum:
        - enforcement_order
        - default_judgment
        - final_judgment
        - acknowledgment_judgment
        - reservation_judgment
        - court_settlement
        - enforceable_notarial_deed
        - cost_assessment_order
        - other
      type: string
    DocumentParentTypeEnum:
      description: |-
        * `claim` - claim
        * `message` - message
        * `request_to_client_answer` - request_to_client_answer
        * `rental_agreement` - rental_agreement
        * `enforceable_title` - enforceable_title
      enum:
        - claim
        - message
        - request_to_client_answer
        - rental_agreement
        - enforceable_title
      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.