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

# Get mandate

> Accepted cases (Aktenzeichen).

Main-case-centric: the list returns **main cases only**.
Sub-cases are reachable through the main case detail representation and
direct detail/subresource URLs, not a flat list expansion. Tenant-scoped by
the authenticated company.

Sub-resources of one mandate:

  * payments — the reported, non-ignored payments
  * documents — claim-document metadata and a proxy-stream download
  * history — published client activity, related resources, and attachments.
    A main case includes its subcases; a subcase includes only itself.

The sub-resource operations resolve the mandate **including sub-cases** —
unlike the list, which hides sub-cases — so an individually-addressable
sub-case's own track stays reachable. These public mandate operations are
reads.



## OpenAPI

````yaml /api-docs/case-management-api/openapi.json get /v2/mandates/{id}/
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/mandates/{id}/:
    get:
      tags:
        - Mandates
      summary: Get mandate
      description: >-
        Accepted cases (Aktenzeichen).


        Main-case-centric: the list returns **main cases only**.

        Sub-cases are reachable through the main case detail representation and

        direct detail/subresource URLs, not a flat list expansion. Tenant-scoped
        by

        the authenticated company.


        Sub-resources of one mandate:

          * payments — the reported, non-ignored payments
          * documents — claim-document metadata and a proxy-stream download
          * history — published client activity, related resources, and attachments.
            A main case includes its subcases; a subcase includes only itself.

        The sub-resource operations resolve the mandate **including sub-cases**
        —

        unlike the list, which hides sub-cases — so an individually-addressable

        sub-case's own track stays reachable. These public mandate operations
        are

        reads.
      operationId: get-mandate
      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: With history=true, embed the typed related resource body.
          in: query
          name: expand
          schema:
            enum:
              - history.related_resources
            type: string
        - description: Embed up to 100 unified history entries.
          in: query
          name: history
          schema:
            type: boolean
        - description: UUID of the accepted case in this request.
          in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
        - description: >-
            Return 304 with an empty body when the current `ETag` matches one of
            the supplied validators (or `*`).
          in: header
          name: If-None-Match
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                mandate-main-case:
                  value:
                    archived: false
                    claims:
                      - additional_charges: []
                        additional_charges_amount:
                          currency: EUR
                          value: '0.00'
                        additional_debtor_ids: []
                        created_at: '2026-07-18T10:00:00Z'
                        debtor_id: 40000000-0000-4000-8000-000000000001
                        delay_date: '2026-07-09'
                        dispute_reason: null
                        document_date: '2026-06-05'
                        document_reference: 2026-0042
                        documents: []
                        due_date: '2026-06-19'
                        events:
                          - description: null
                            location: null
                            occurence: '2026-06-05T09:00:00Z'
                            title: Invoice issued
                            type: claim
                            your_reference: 2026-0042
                        id: 30000000-0000-4000-8000-000000000001
                        is_disputed: false
                        items: []
                        legal_basis:
                          claim_type_code: null
                          contract_date: null
                          description: null
                        mandate_id: 50000000-0000-4000-8000-000000000001
                        metadata:
                          - type: comment
                            value: Consulting invoice from the customer portal
                        order_id: 20000000-0000-4000-8000-000000000001
                        payments: []
                        principal_amount:
                          currency: EUR
                          value: '100.00'
                        reminders: []
                        status: accepted
                        subject_matter: Website accessibility consulting in June 2026
                        total_amount:
                          currency: EUR
                          value: '100.00'
                        type: receivable
                        updated_at: '2026-07-18T10:00:00Z'
                        your_reference: INV-2026-0042
                    created_at: '2026-07-18T11:00:00Z'
                    debtor:
                      acting_as: consumer
                      events:
                        - description: null
                          location: null
                          occurence: '2026-05-01T09:00:00Z'
                          title: Customer registered
                          type: registration
                          your_reference: null
                      legal_form: null
                      metadata:
                        - type: user:reference
                          value: CUSTOMER-1001
                      organization: null
                      person:
                        birth_date: null
                        first_name: Alex
                        last_name: Example
                        salutation: mx
                      your_reference: CUSTOMER-1001
                    id: 50000000-0000-4000-8000-000000000001
                    legal_balance: null
                    main_case: null
                    previous_reference_numbers: []
                    reference_number: PW-2026-000123
                    state:
                      legal_stage:
                        code: extrajudicial
                        label: Extrajudicial
                        label_key: mandate.state.legal_stage.extrajudicial
                      payment:
                        code: open
                        label: Open
                        label_key: mandate.state.payment.open
                      processing:
                        code: active
                        label: Active
                        label_key: mandate.state.processing.active
                    subcases: []
                    total_amount:
                      currency: EUR
                      value: '100.00'
                    updated_at: '2026-07-18T11:00:00Z'
                mandate-subcase:
                  value:
                    archived: false
                    claims:
                      - additional_charges: []
                        additional_charges_amount:
                          currency: EUR
                          value: '0.00'
                        additional_debtor_ids: []
                        created_at: '2026-07-18T10:00:00Z'
                        debtor_id: 40000000-0000-4000-8000-000000000001
                        delay_date: '2026-07-09'
                        dispute_reason: null
                        document_date: '2026-06-05'
                        document_reference: 2026-0042
                        documents: []
                        due_date: '2026-06-19'
                        events:
                          - description: null
                            location: null
                            occurence: '2026-06-05T09:00:00Z'
                            title: Invoice issued
                            type: claim
                            your_reference: 2026-0042
                        id: 30000000-0000-4000-8000-000000000001
                        is_disputed: false
                        items: []
                        legal_basis:
                          claim_type_code: null
                          contract_date: null
                          description: null
                        mandate_id: 50000000-0000-4000-8000-000000000001
                        metadata:
                          - type: comment
                            value: Consulting invoice from the customer portal
                        order_id: 20000000-0000-4000-8000-000000000001
                        payments: []
                        principal_amount:
                          currency: EUR
                          value: '100.00'
                        reminders: []
                        status: accepted
                        subject_matter: Website accessibility consulting in June 2026
                        total_amount:
                          currency: EUR
                          value: '100.00'
                        type: receivable
                        updated_at: '2026-07-18T10:00:00Z'
                        your_reference: INV-2026-0042
                    created_at: '2026-07-18T11:00:00Z'
                    debtor:
                      acting_as: consumer
                      events:
                        - description: null
                          location: null
                          occurence: '2026-05-01T09:00:00Z'
                          title: Customer registered
                          type: registration
                          your_reference: null
                      legal_form: null
                      metadata:
                        - type: user:reference
                          value: CUSTOMER-1001
                      organization: null
                      person:
                        birth_date: null
                        first_name: Alex
                        last_name: Example
                        salutation: mx
                      your_reference: CUSTOMER-1001
                    id: 50000000-0000-4000-8000-000000000002
                    legal_balance: null
                    main_case:
                      debtor:
                        acting_as: consumer
                        events:
                          - description: null
                            location: null
                            occurence: '2026-05-01T09:00:00Z'
                            title: Customer registered
                            type: registration
                            your_reference: null
                        legal_form: null
                        metadata:
                          - type: user:reference
                            value: CUSTOMER-1001
                        organization: null
                        person:
                          birth_date: null
                          first_name: Alex
                          last_name: Example
                          salutation: mx
                        your_reference: CUSTOMER-1001
                      id: 50000000-0000-4000-8000-000000000001
                      reference_number: PW-2026-000123
                    previous_reference_numbers: []
                    reference_number: PW-2026-000123-2
                    state:
                      legal_stage:
                        code: extrajudicial
                        label: Extrajudicial
                        label_key: mandate.state.legal_stage.extrajudicial
                      payment:
                        code: open
                        label: Open
                        label_key: mandate.state.payment.open
                      processing:
                        code: active
                        label: Active
                        label_key: mandate.state.processing.active
                    subcases: []
                    total_amount:
                      currency: EUR
                      value: '100.00'
                    updated_at: '2026-07-18T11:00:00Z'
              schema:
                $ref: '#/components/schemas/MandateDetail'
          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
            ETag:
              description: >-
                Strong validator of this representation. Send it back as
                `If-None-Match` to skip an unchanged re-read (304) or as
                `If-Match` on PATCH/PUT/DELETE to fail with 412 when the
                resource changed.
              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
        '304':
          description: 'Not modified: the `If-None-Match` validator still matches.'
          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
        '404':
          content:
            application/json:
              examples:
                not-found-error:
                  value:
                    code: not_found
                    detail: The requested resource was not found.
              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:
    MandateDetail:
      description: >-
        Complete representation of one case, including its main case and
        sub-cases.
      properties:
        archived:
          description: Whether your company archived the case from its active view.
          readOnly: true
          type: boolean
        claims:
          description: >-
            Claims of the main case, shared by the main case and its sub-cases,
            ordered by creation time.
          items:
            $ref: '#/components/schemas/Claim'
          readOnly: true
          type: array
        created_at:
          description: Time at which the accepted case was created.
          format: date-time
          readOnly: true
          type: string
        debtor:
          allOf:
            - $ref: '#/components/schemas/MandateDebtor'
          description: Debtor associated with the accepted case.
          nullable: true
          readOnly: true
        history:
          description: >-
            Up to 100 published history entries. Included only when
            `history=true`; use the paginated history endpoint for the full
            timeline.
          items:
            $ref: '#/components/schemas/MandateHistory'
          type: array
        id:
          description: Stable identifier of the accepted case.
          format: uuid
          readOnly: true
          type: string
        legal_balance:
          allOf:
            - $ref: '#/components/schemas/MandateLegalBalance'
          description: >-
            Legal claim, payments, and remaining balance by component for the
            main case, shared with its sub-cases; null when no legal balance is
            available.
          nullable: true
          readOnly: true
        main_case:
          allOf:
            - $ref: '#/components/schemas/MandateReference'
          description: Main case when this resource is a sub-case.
          nullable: true
          readOnly: true
        previous_reference_numbers:
          description: >-
            Earlier paywise case-file reference numbers of this case. Usually
            empty: when a case is re-keyed, `reference_number` shows the new
            number and the previous one is appended here. The `reference_number`
            list filter also matches these exactly.
          items:
            type: string
          readOnly: true
          type: array
        reference_number:
          description: paywise case-file reference number.
          readOnly: true
          type: string
        state:
          allOf:
            - $ref: '#/components/schemas/MandateState'
          description: Current legal, processing, and payment states.
          readOnly: true
        subcases:
          description: >-
            Up to 100 sub-cases grouped under this main case, ordered by
            sub-case number. Empty when this resource is itself a sub-case.
          items:
            $ref: '#/components/schemas/MandateReference'
          readOnly: true
          type: array
        total_amount:
          allOf:
            - $ref: '#/components/schemas/PaymentAmountRead'
          description: >-
            Current claim total maintained on the main case, shared with its
            sub-cases. Use the mandate detail `legal_balance` for the legal
            claim and remaining balance broken down by component.
          nullable: true
          readOnly: true
        updated_at:
          description: Time at which the accepted case was last updated.
          format: date-time
          readOnly: true
          type: string
      required:
        - archived
        - claims
        - created_at
        - debtor
        - id
        - legal_balance
        - main_case
        - previous_reference_numbers
        - reference_number
        - state
        - subcases
        - total_amount
        - updated_at
      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'
    MandateDebtor:
      description: Immutable debtor snapshot embedded in accepted-case resources.
      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
        events:
          description: Stored contextual events associated with this resource.
          items:
            $ref: '#/components/schemas/LegacyEventRead'
          readOnly: true
          type: array
        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
        your_reference:
          description: Your reference for this debtor.
          nullable: true
          readOnly: true
          type: string
      required:
        - acting_as
        - events
        - legal_form
        - metadata
        - organization
        - person
        - your_reference
      type: object
    MandateHistory:
      description: One published status and the resources it makes available to the client.
      properties:
        advance_type:
          description: Category of the requested advance, when applicable.
          nullable: true
          readOnly: true
          type: string
        attachments:
          description: Files explicitly published with this entry.
          items:
            $ref: '#/components/schemas/HistoryAttachment'
          readOnly: true
          type: array
        claim_type_code:
          description: Claim or event category associated with the update.
          nullable: true
          readOnly: true
          type: string
        description:
          description: Plain-text explanation of the published event.
          nullable: true
          readOnly: true
          type: string
        id:
          description: Stable identifier of this history entry.
          format: uuid
          readOnly: true
          type: string
        is_advance_request:
          description: Whether this update requests an advance payment.
          readOnly: true
          type: boolean
        occurred_at:
          description: Time at which the published event occurred.
          format: date-time
          readOnly: true
          type: string
        related_resources:
          description: >-
            Resources published through this entry. Multiple resources may be
            linked; bodies are included only when explicitly expanded and
            authorized.
          items:
            $ref: '#/components/schemas/MandateHistoryRelatedResource'
          readOnly: true
          type: array
        source_mandate:
          allOf:
            - $ref: '#/components/schemas/HistorySourceMandate'
          description: Main case or subcase that produced the entry.
          readOnly: true
        state:
          allOf:
            - $ref: '#/components/schemas/MandateState'
          description: >-
            Workflow values recorded on this status. Blank dimensions were not
            recorded; this is not a complete state snapshot.
          readOnly: true
        text:
          description: Compatibility alias of the event description.
          nullable: true
          readOnly: true
          type: string
        title:
          description: Short title of the published event.
          readOnly: true
          type: string
        type:
          allOf:
            - $ref: '#/components/schemas/MandateHistoryTypeEnum'
          description: Business category of the history entry.
          readOnly: true
        updated_at:
          description: >-
            Latest change to this entry or its published related content; use
            for incremental synchronization.
          format: date-time
          readOnly: true
          type: string
      required:
        - advance_type
        - attachments
        - claim_type_code
        - description
        - id
        - is_advance_request
        - occurred_at
        - related_resources
        - source_mandate
        - state
        - text
        - title
        - type
        - updated_at
      type: object
    MandateLegalBalance:
      description: >-
        The case's legal claim balance: claim, payments, and remaining balance
        per component.
      properties:
        balance_of_costs_interest_bearing:
          allOf:
            - $ref: '#/components/schemas/ClaimAmountRead'
          description: Open balance of interest-bearing costs.
          nullable: true
          readOnly: true
        balance_of_costs_interest_free:
          allOf:
            - $ref: '#/components/schemas/ClaimAmountRead'
          description: Open balance of interest-free costs.
          nullable: true
          readOnly: true
        balance_of_interest_on_costs:
          allOf:
            - $ref: '#/components/schemas/ClaimAmountRead'
          description: Open balance of interest charged on costs.
          nullable: true
          readOnly: true
        balance_of_interest_on_principal_claim:
          allOf:
            - $ref: '#/components/schemas/ClaimAmountRead'
          description: Open balance of interest charged on the principal claim.
          nullable: true
          readOnly: true
        balance_of_principal_claim:
          allOf:
            - $ref: '#/components/schemas/ClaimAmountRead'
          description: Open balance of the principal claim.
          nullable: true
          readOnly: true
        legal_claim_of_costs_interest_bearing:
          allOf:
            - $ref: '#/components/schemas/ClaimAmountRead'
          description: Total legal claim for interest-bearing costs.
          nullable: true
          readOnly: true
        legal_claim_of_costs_interest_free:
          allOf:
            - $ref: '#/components/schemas/ClaimAmountRead'
          description: Total legal claim for interest-free costs.
          nullable: true
          readOnly: true
        legal_claim_of_interest_on_costs:
          allOf:
            - $ref: '#/components/schemas/ClaimAmountRead'
          description: Total legal claim for interest on costs.
          nullable: true
          readOnly: true
        legal_claim_of_interest_on_principal_claim:
          allOf:
            - $ref: '#/components/schemas/ClaimAmountRead'
          description: Total legal claim for interest on the principal claim.
          nullable: true
          readOnly: true
        legal_claim_of_principal_claim:
          allOf:
            - $ref: '#/components/schemas/ClaimAmountRead'
          description: Total legal principal claim.
          nullable: true
          readOnly: true
        payment_on_costs_interest_bearing:
          allOf:
            - $ref: '#/components/schemas/ClaimAmountRead'
          description: Payments allocated to interest-bearing costs.
          nullable: true
          readOnly: true
        payment_on_costs_interest_free:
          allOf:
            - $ref: '#/components/schemas/ClaimAmountRead'
          description: Payments allocated to interest-free costs.
          nullable: true
          readOnly: true
        payment_on_interest_on_costs:
          allOf:
            - $ref: '#/components/schemas/ClaimAmountRead'
          description: Payments allocated to interest on costs.
          nullable: true
          readOnly: true
        payment_on_interest_on_principal_claim:
          allOf:
            - $ref: '#/components/schemas/ClaimAmountRead'
          description: Payments allocated to interest on the principal claim.
          nullable: true
          readOnly: true
        payment_on_principal_claim:
          allOf:
            - $ref: '#/components/schemas/ClaimAmountRead'
          description: Payments allocated to the principal claim.
          nullable: true
          readOnly: true
        total_balance:
          allOf:
            - $ref: '#/components/schemas/ClaimAmountRead'
          description: Current total open balance of the legal claim.
          nullable: true
          readOnly: true
        total_legal_claim:
          allOf:
            - $ref: '#/components/schemas/ClaimAmountRead'
          description: Total legal claim before deducting payments.
          nullable: true
          readOnly: true
        total_payment:
          allOf:
            - $ref: '#/components/schemas/ClaimAmountRead'
          description: Total payments allocated to the legal claim.
          nullable: true
          readOnly: true
        updated:
          description: Time at which the legal-claim balance was last updated.
          format: date-time
          readOnly: true
          type: string
      required:
        - balance_of_costs_interest_bearing
        - balance_of_costs_interest_free
        - balance_of_interest_on_costs
        - balance_of_interest_on_principal_claim
        - balance_of_principal_claim
        - legal_claim_of_costs_interest_bearing
        - legal_claim_of_costs_interest_free
        - legal_claim_of_interest_on_costs
        - legal_claim_of_interest_on_principal_claim
        - legal_claim_of_principal_claim
        - payment_on_costs_interest_bearing
        - payment_on_costs_interest_free
        - payment_on_interest_on_costs
        - payment_on_interest_on_principal_claim
        - payment_on_principal_claim
        - total_balance
        - total_legal_claim
        - total_payment
        - updated
      type: object
    MandateReference:
      properties:
        debtor:
          allOf:
            - $ref: '#/components/schemas/MandateDebtor'
          description: Debtor associated with the accepted case.
          nullable: true
          readOnly: true
        id:
          description: Stable identifier of the accepted case.
          format: uuid
          readOnly: true
          type: string
        reference_number:
          description: paywise case-file reference number.
          readOnly: true
          type: string
      required:
        - debtor
        - id
        - reference_number
      type: object
    MandateState:
      properties:
        legal_stage:
          allOf:
            - $ref: '#/components/schemas/MandateStateValue'
          description: Current legal collection stage.
          readOnly: true
        payment:
          allOf:
            - $ref: '#/components/schemas/MandateStateValue'
          description: Current payment or settlement state.
          readOnly: true
        processing:
          allOf:
            - $ref: '#/components/schemas/MandateStateValue'
          description: Current operational processing state.
          readOnly: true
      required:
        - legal_stage
        - payment
        - processing
      type: object
    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
    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
    ActingAsEnum:
      description: |-
        * `consumer` - consumer
        * `business` - business
      enum:
        - consumer
        - business
      type: string
    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
    HistoryAttachment:
      properties:
        download_url:
          description: >-
            Authenticated history attachment download URL, or null when no file
            is available.
          format: uri
          nullable: true
          readOnly: true
          type: string
        filename:
          description: Original filename of the published attachment.
          readOnly: true
          type: string
        id:
          description: Stable identifier of the published file.
          format: uuid
          readOnly: true
          type: string
        mime_type:
          description: Media type of the attachment.
          readOnly: true
          type: string
      required:
        - download_url
        - filename
        - id
        - mime_type
      type: object
    MandateHistoryRelatedResource:
      discriminator:
        mapping:
          email: '#/components/schemas/EmailHistoryRelatedResource'
          message: '#/components/schemas/MessageHistoryRelatedResource'
          request_to_client: '#/components/schemas/RequestToClientHistoryRelatedResource'
          single_mandate_statement: '#/components/schemas/StatementHistoryRelatedResource'
        propertyName: type
      oneOf:
        - $ref: '#/components/schemas/RequestToClientHistoryRelatedResource'
        - $ref: '#/components/schemas/MessageHistoryRelatedResource'
        - $ref: '#/components/schemas/EmailHistoryRelatedResource'
        - $ref: '#/components/schemas/StatementHistoryRelatedResource'
    HistorySourceMandate:
      properties:
        id:
          description: Identifier of the case that produced the entry.
          format: uuid
          readOnly: true
          type: string
        reference_number:
          description: paywise reference number of the source case.
          readOnly: true
          type: string
        relation:
          allOf:
            - $ref: '#/components/schemas/RelationEnum'
          description: |-
            Main-case or subcase attribution.

            * `main_case` - main_case
            * `subcase` - subcase
          readOnly: true
      required:
        - id
        - reference_number
        - relation
      type: object
    MandateHistoryTypeEnum:
      enum:
        - status_update
      type: string
    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
    MandateStateValue:
      description: Stable machine code plus an i18n-ready label key and current label.
      properties:
        code:
          description: >-
            Stable machine-readable state code; an empty string when that state
            has not been set.
          readOnly: true
          type: string
        label:
          description: >-
            Current human-readable state label; an empty string when its code is
            unset.
          readOnly: true
          type: string
        label_key:
          description: >-
            Stable translation key for the state; an empty string when its code
            is unset.
          readOnly: true
          type: string
      required:
        - code
        - label
        - label_key
      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
    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
    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
    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
    SalutationEnum:
      enum:
        - mr
        - ms
        - mx
      type: string
    EmailHistoryRelatedResource:
      properties:
        body:
          allOf:
            - $ref: '#/components/schemas/HistoryEmailMetadata'
          description: >-
            Expanded email metadata; message bodies and email attachments are
            not exposed.
        id:
          description: Identifier of the related resource.
          format: uuid
          readOnly: true
          type: string
        type:
          allOf:
            - $ref: '#/components/schemas/EmailHistoryRelatedResourceTypeEnum'
          description: |-
            Related resource kind.

            * `email` - email
          readOnly: true
        url:
          description: >-
            Null: published email metadata has no standalone public API
            resource.
          format: uri
          nullable: true
          readOnly: true
          type: string
      required:
        - id
        - type
        - url
      title: Email
      type: object
    MessageHistoryRelatedResource:
      properties:
        body:
          allOf:
            - $ref: '#/components/schemas/MessageRead'
          description: Message, included when explicitly expanded and authorized.
        id:
          description: Identifier of the related resource.
          format: uuid
          readOnly: true
          type: string
        type:
          allOf:
            - $ref: '#/components/schemas/MessageHistoryRelatedResourceTypeEnum'
          description: |-
            Related resource kind.

            * `message` - message
          readOnly: true
        url:
          description: Authenticated API URL of the related resource.
          format: uri
          readOnly: true
          type: string
      required:
        - id
        - type
        - url
      title: Message
      type: object
    RequestToClientHistoryRelatedResource:
      properties:
        body:
          allOf:
            - $ref: '#/components/schemas/RequestToClientRead'
          description: >-
            Expanded client request, included only with
            `expand=history.related_resources` and the
            `case:requests_to_client:read` scope. On mandate detail, also set
            `history=true`.
        id:
          description: Identifier of the related resource.
          format: uuid
          readOnly: true
          type: string
        type:
          allOf:
            - $ref: >-
                #/components/schemas/RequestToClientHistoryRelatedResourceTypeEnum
          description: |-
            Related resource kind.

            * `request_to_client` - request_to_client
          readOnly: true
        url:
          description: Authenticated API URL of the related resource.
          format: uri
          readOnly: true
          type: string
      required:
        - id
        - type
        - url
      title: Client request
      type: object
    StatementHistoryRelatedResource:
      properties:
        body:
          allOf:
            - $ref: '#/components/schemas/SingleMandateStatementRead'
          description: Case statement, included when explicitly expanded and authorized.
        id:
          description: Identifier of the related resource.
          format: uuid
          readOnly: true
          type: string
        type:
          allOf:
            - $ref: '#/components/schemas/StatementHistoryRelatedResourceTypeEnum'
          description: |-
            Related resource kind.

            * `single_mandate_statement` - single_mandate_statement
          readOnly: true
        url:
          description: Authenticated API URL of the related resource.
          format: uri
          readOnly: true
          type: string
      required:
        - id
        - type
        - url
      title: Case statement
      type: object
    RelationEnum:
      description: |-
        * `main_case` - main_case
        * `subcase` - subcase
      enum:
        - main_case
        - subcase
      type: string
    CurrencyEnum:
      description: '* `EUR` - EUR'
      enum:
        - EUR
      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
    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
    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
    HistoryEmailMetadata:
      properties:
        date:
          description: Time the email record was created.
          format: date-time
          readOnly: true
          type: string
        direction:
          allOf:
            - $ref: '#/components/schemas/DirectionEnum'
          description: Whether paywise received or sent the email.
          readOnly: true
        subject:
          description: Subject of the email published through this history entry.
          nullable: true
          readOnly: true
          type: string
      required:
        - date
        - direction
        - subject
      type: object
    EmailHistoryRelatedResourceTypeEnum:
      description: '* `email` - email'
      enum:
        - email
      type: string
    MessageRead:
      description: Resource representation with a native UUID `id`.
      properties:
        author:
          allOf:
            - $ref: '#/components/schemas/MessageAuthor'
          description: Channel through which the message was authored.
          readOnly: true
        body:
          description: Message content exchanged with paywise.
          nullable: true
          readOnly: true
          type: string
        created_at:
          description: Time at which the message was created.
          format: date-time
          readOnly: true
          type: string
        documents:
          description: Documents attached to the message.
          items:
            $ref: '#/components/schemas/DocumentRead'
          readOnly: true
          type: array
        editable:
          description: >-
            Whether this message can be edited through the API. True only for a
            client message created through current Case Management API for the
            calling company while it is under review and no review task has
            started.
          readOnly: true
          type: boolean
        href:
          description: API URL of this message.
          format: uri
          readOnly: true
          type: string
        id:
          description: Stable identifier for this resource.
          format: uuid
          readOnly: true
          type: string
        parent:
          allOf:
            - $ref: '#/components/schemas/MessageParent'
          description: Order or accepted case to which the message belongs.
          readOnly: true
        response_to:
          description: Message to which this message responds, when applicable.
          format: uuid
          nullable: true
          readOnly: true
          type: string
        sender:
          allOf:
            - $ref: '#/components/schemas/SenderEnum'
          description: Party that sent the message.
          readOnly: true
        state:
          allOf:
            - $ref: '#/components/schemas/StateEnum'
          description: >-
            Review/publication state: `under_review` for a client message
            awaiting review, `handled` after handling, or `published` for a
            published message. Check `editable` before offering edits.
          readOnly: true
        title:
          description: Short subject of the message.
          nullable: true
          readOnly: true
          type: string
        updated_at:
          description: Time at which the message was last updated.
          format: date-time
          readOnly: true
          type: string
      required:
        - author
        - body
        - created_at
        - documents
        - editable
        - href
        - id
        - parent
        - response_to
        - sender
        - state
        - title
        - updated_at
      type: object
    MessageHistoryRelatedResourceTypeEnum:
      description: '* `message` - message'
      enum:
        - message
      type: string
    RequestToClientRead:
      description: Published clarification request with its optional answer.
      properties:
        allowed_answer_types:
          allOf:
            - $ref: '#/components/schemas/AllowedAnswerTypesEnum'
          description: >-
            Answer format accepted by the answer endpoint. Choice formats use
            `text: yes` or `text: no`; `yes-no-dontknow` also permits
            `dontknow`. Formats ending in `freetext-on-no` require
            `additional_comment` for `no`; `yes-with-date-no-freetext-on-no`
            requires `booking_date` for `yes`. `freetext` requires text;
            `fileupload` accepts text, documents, or both.
          readOnly: true
        answer:
          allOf:
            - $ref: '#/components/schemas/AnswerRead'
          description: Submitted answer, or null while unanswered.
          nullable: true
          readOnly: true
        answered:
          description: Whether an answer has already been submitted.
          readOnly: true
          type: boolean
        answered_at:
          description: Time at which the answer was submitted, when answered.
          format: date-time
          nullable: true
          readOnly: true
          type: string
        created_at:
          description: Time at which the request was created.
          format: date-time
          readOnly: true
          type: string
        description:
          description: Question or explanation describing what paywise needs.
          nullable: true
          readOnly: true
          type: string
        href:
          description: API URL of this client request.
          format: uri
          readOnly: true
          type: string
        id:
          description: Stable identifier of this client request.
          format: uuid
          readOnly: true
          type: string
        mandate:
          allOf:
            - $ref: '#/components/schemas/RequestToClientMandateReference'
          description: Accepted case for which paywise needs information.
          readOnly: true
        question_attachments:
          description: Files paywise attached to the question.
          items:
            properties:
              download_url:
                description: >-
                  Authenticated API URL for downloading the question attachment;
                  null when no downloadable file is available.
                format: uri
                nullable: true
                type: string
              filename:
                description: Original filename of the attachment.
                nullable: true
                type: string
              id:
                description: Stable identifier of the attachment.
                format: uuid
                type: string
              mime_type:
                description: Media type of the attachment.
                nullable: true
                type: string
            type: object
          readOnly: true
          type: array
        title:
          description: Short subject of the requested information.
          readOnly: true
          type: string
        updated_at:
          description: Time at which the request was last updated.
          format: date-time
          readOnly: true
          type: string
      required:
        - allowed_answer_types
        - answer
        - answered
        - answered_at
        - created_at
        - description
        - href
        - id
        - mandate
        - question_attachments
        - title
        - updated_at
      type: object
    RequestToClientHistoryRelatedResourceTypeEnum:
      description: '* `request_to_client` - request_to_client'
      enum:
        - request_to_client
      type: string
    SingleMandateStatementRead:
      properties:
        booking_date:
          description: Date on which the case statement was booked.
          format: date
          readOnly: true
          type: string
        cancelled_at:
          description: Time at which the case statement was cancelled.
          format: date-time
          nullable: true
          readOnly: true
          type: string
        clearing_no:
          description: Clearing number of the case statement.
          readOnly: true
          type: string
        comment:
          description: Additional notes supplied with the case statement.
          nullable: true
          readOnly: true
          type: string
        created_at:
          description: Time at which the case statement was created.
          format: date-time
          readOnly: true
          type: string
        file:
          allOf:
            - $ref: '#/components/schemas/StatementFile'
          description: Downloadable statement document, when available.
          nullable: true
          readOnly: true
        financials:
          allOf:
            - $ref: '#/components/schemas/SingleMandateStatementFinancials'
          description: Principal claims, payment allocation, and settlement balance.
          readOnly: true
        id:
          description: Stable identifier of this case statement.
          format: uuid
          readOnly: true
          type: string
        invoice_no:
          description: Invoice number, when this settlement produces an invoice.
          nullable: true
          readOnly: true
          type: string
        mandate:
          allOf:
            - $ref: '#/components/schemas/SingleMandateStatementMandateReference'
          description: Accepted case settled by this statement, when still linked.
          nullable: true
          readOnly: true
        payout_method:
          allOf:
            - $ref: '#/components/schemas/PayoutMethodEnum'
          description: |-
            Whether the balance is settled by transfer or direct debit.

            * `transfer` - Überweisung
            * `direct_debit` - Lastschrift
          nullable: true
          readOnly: true
        period_end:
          description: End of the settled period.
          format: date
          readOnly: true
          type: string
        period_start:
          description: Start of the settled period, or null for the full case history.
          format: date
          nullable: true
          readOnly: true
          type: string
        pre_tax_deductible:
          description: Whether you may deduct input VAT for this settlement.
          readOnly: true
          type: boolean
        reference_number:
          description: paywise case-file reference number of the settled case.
          readOnly: true
          type: string
        statement_type:
          allOf:
            - $ref: '#/components/schemas/StatementTypeEnum'
          description: >-
            Kind of interim, final, expense, or monitoring settlement.


            * `interim` - Zwischenabrechnung

            * `final` - Endabrechnung

            * `expenses_invoice` - Auslagenrechnung

            * `transition_to_longtime_monitoring` - Übergabe
            Überwachungsverfahren

            * `negative_closing` - Negativabschluss
          readOnly: true
        status:
          allOf:
            - $ref: '#/components/schemas/CaseStatementStatusEnum'
          description: Whether the case statement is published or cancelled.
          readOnly: true
        updated_at:
          description: Time at which the case statement was last updated.
          format: date-time
          readOnly: true
          type: string
        your_reference:
          description: Your customer number for the debtor on the settled case.
          nullable: true
          readOnly: true
          type: string
      required:
        - booking_date
        - cancelled_at
        - clearing_no
        - comment
        - created_at
        - file
        - financials
        - id
        - invoice_no
        - mandate
        - payout_method
        - period_end
        - period_start
        - pre_tax_deductible
        - reference_number
        - statement_type
        - status
        - updated_at
        - your_reference
      type: object
    StatementHistoryRelatedResourceTypeEnum:
      description: '* `single_mandate_statement` - single_mandate_statement'
      enum:
        - single_mandate_statement
      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
    DirectionEnum:
      enum:
        - inbound
        - outbound
      type: string
    MessageAuthor:
      properties:
        type:
          allOf:
            - $ref: '#/components/schemas/MessageAuthorTypeEnum'
          description: >-
            Authorship channel: `api` for a client message created through
            current Case Management API, `user` for another client-authored
            message, or `paywise` for a message sent by paywise.
          readOnly: true
      required:
        - type
      type: object
    MessageParent:
      properties:
        id:
          description: Identifier of the order or accepted case owning the message.
          format: uuid
          readOnly: true
          type: string
        type:
          allOf:
            - $ref: '#/components/schemas/MessageParentTypeEnum'
          description: >-
            Whether the message belongs to an order (`order`) or an accepted
            case (`mandate`).
          readOnly: true
      required:
        - id
        - type
      type: object
    SenderEnum:
      enum:
        - client
        - paywise
      type: string
    StateEnum:
      enum:
        - under_review
        - handled
        - published
      type: string
    AllowedAnswerTypesEnum:
      description: |-
        * `fileupload` - fileupload
        * `freetext` - freetext
        * `yes-no` - yes-no
        * `yes-no-dontknow` - yes-no-dontknow
        * `yes-no-freetext-on-no` - yes-no-freetext-on-no
        * `yes-with-date-no-freetext-on-no` - yes-with-date-no-freetext-on-no
      enum:
        - fileupload
        - freetext
        - yes-no
        - yes-no-dontknow
        - yes-no-freetext-on-no
        - yes-with-date-no-freetext-on-no
      type: string
    AnswerRead:
      properties:
        additional_comment:
          description: Additional context supplied with the answer.
          nullable: true
          readOnly: true
          type: string
        booking_date:
          description: Relevant booking date requested by the question, when applicable.
          format: date
          nullable: true
          readOnly: true
          type: string
        created_at:
          description: Time at which the answer was submitted.
          format: date-time
          readOnly: true
          type: string
        documents:
          description: Documents supplied with the answer.
          items:
            $ref: '#/components/schemas/DocumentRead'
          readOnly: true
          type: array
        id:
          description: Stable identifier of this answer.
          format: uuid
          readOnly: true
          type: string
        text:
          description: >-
            Selected choice (`yes`, `no`, or `dontknow`) or free-text answer.
            Empty for an API answer supplied with documents only; legacy answers
            may use null.
          nullable: true
          readOnly: true
          type: string
        updated_at:
          description: Time at which the answer was last updated.
          format: date-time
          readOnly: true
          type: string
      required:
        - additional_comment
        - booking_date
        - created_at
        - documents
        - id
        - text
        - updated_at
      type: object
    RequestToClientMandateReference:
      properties:
        href:
          description: API URL of the accepted case.
          format: uri
          nullable: true
          type: string
        id:
          description: Identifier of the accepted case.
          format: uuid
          type: string
        reference_number:
          description: paywise case-file reference number.
          nullable: true
          type: string
      type: object
    StatementFile:
      properties:
        download_url:
          description: Authenticated URL for downloading this file.
          format: uri
          readOnly: true
          type: string
        filename:
          description: Descriptive filename for this download.
          readOnly: true
          type: string
        media_type:
          description: Media type of this download.
          readOnly: true
          type: string
      required:
        - download_url
        - filename
        - media_type
      type: object
    SingleMandateStatementFinancials:
      properties:
        cost_burden:
          allOf:
            - $ref: '#/components/schemas/SingleMandateStatementCostBurden'
          description: What you owe paywise on this case, when applicable.
          nullable: true
          readOnly: true
        open_principal_claim:
          allOf:
            - $ref: '#/components/schemas/StatementAmount'
          description: Principal claim still open after this settlement.
          nullable: true
          readOnly: true
        principal_claims:
          description: Invoices settled by this statement.
          items:
            $ref: '#/components/schemas/SingleMandateStatementPrincipalClaim'
          readOnly: true
          type: array
        principal_claims_total:
          allOf:
            - $ref: '#/components/schemas/StatementAmount'
          description: Total of all principal claims settled by this statement.
          nullable: true
          readOnly: true
        total_balance:
          allOf:
            - $ref: '#/components/schemas/StatementAmount'
          description: 'Settlement balance: positive pays you, negative is owed by you.'
          nullable: true
          readOnly: true
        vat_entries:
          description: Payments and their allocation grouped by VAT rate.
          items:
            $ref: '#/components/schemas/SingleMandateStatementVATEntry'
          readOnly: true
          type: array
      required:
        - cost_burden
        - open_principal_claim
        - principal_claims
        - principal_claims_total
        - total_balance
        - vat_entries
      type: object
    SingleMandateStatementMandateReference:
      properties:
        id:
          description: Identifier of the accepted case settled by this statement.
          format: uuid
          readOnly: true
          type: string
        reference_number:
          description: paywise case-file reference number.
          readOnly: true
          type: string
      required:
        - id
        - reference_number
      type: object
    PayoutMethodEnum:
      description: |-
        * `transfer` - Überweisung
        * `direct_debit` - Lastschrift
      enum:
        - transfer
        - direct_debit
      type: string
    StatementTypeEnum:
      description: |-
        * `interim` - Zwischenabrechnung
        * `final` - Endabrechnung
        * `expenses_invoice` - Auslagenrechnung
        * `transition_to_longtime_monitoring` - Übergabe Überwachungsverfahren
        * `negative_closing` - Negativabschluss
      enum:
        - interim
        - final
        - expenses_invoice
        - transition_to_longtime_monitoring
        - negative_closing
      type: string
    CaseStatementStatusEnum:
      enum:
        - published
        - cancelled
      type: string
    MessageAuthorTypeEnum:
      description: |-
        * `api` - api
        * `user` - user
        * `paywise` - paywise
      enum:
        - api
        - user
        - paywise
      type: string
    MessageParentTypeEnum:
      description: |-
        * `order` - order
        * `mandate` - mandate
      enum:
        - order
        - mandate
      type: string
    SingleMandateStatementCostBurden:
      description: 'Kostenbelastung: what the client owes us on this case.'
      properties:
        fee:
          allOf:
            - $ref: '#/components/schemas/StatementAmount'
          description: Collection fee charged to you.
          nullable: true
          readOnly: true
        fee_vat:
          allOf:
            - $ref: '#/components/schemas/StatementAmount'
          description: VAT on the collection fee charged to you.
          nullable: true
          readOnly: true
        items:
          description: Itemized positions making up the cost burden.
          items:
            $ref: '#/components/schemas/SingleMandateStatementCostBurdenItem'
          readOnly: true
          type: array
        tax_free_expenses:
          allOf:
            - $ref: '#/components/schemas/StatementAmount'
          description: Tax-free expenses charged to you.
          nullable: true
          readOnly: true
        taxable_expenses:
          allOf:
            - $ref: '#/components/schemas/StatementAmount'
          description: Taxable expenses charged to you.
          nullable: true
          readOnly: true
        taxable_expenses_vat:
          allOf:
            - $ref: '#/components/schemas/StatementAmount'
          description: VAT on taxable expenses charged to you.
          nullable: true
          readOnly: true
        total_amount:
          allOf:
            - $ref: '#/components/schemas/StatementAmount'
          description: Total gross amount of the cost burden.
          nullable: true
          readOnly: true
        total_net:
          allOf:
            - $ref: '#/components/schemas/StatementAmount'
          description: Total net amount of the cost burden.
          nullable: true
          readOnly: true
        total_vat:
          allOf:
            - $ref: '#/components/schemas/StatementAmount'
          description: Total VAT included in the cost burden.
          nullable: true
          readOnly: true
        vat_rate:
          description: VAT rate as a decimal fraction, for example 0.19 for 19%.
          format: decimal
          pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
          readOnly: true
          type: string
      required:
        - fee
        - fee_vat
        - items
        - tax_free_expenses
        - taxable_expenses
        - taxable_expenses_vat
        - total_amount
        - total_net
        - total_vat
        - vat_rate
      type: object
    StatementAmount:
      properties:
        currency:
          description: Currency of the amount.
          readOnly: true
          type: string
        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
    SingleMandateStatementPrincipalClaim:
      description: One invoice (Hauptforderung) settled by this Aktenabrechnung.
      properties:
        amount:
          allOf:
            - $ref: '#/components/schemas/StatementAmount'
          description: Invoiced amount of the principal claim.
          nullable: true
          readOnly: true
        voucher_date:
          description: Date of the invoice or voucher.
          format: date
          nullable: true
          readOnly: true
          type: string
        voucher_no:
          description: Your invoice or voucher number for the settled claim.
          nullable: true
          readOnly: true
          type: string
      required:
        - amount
        - voucher_date
        - voucher_no
      type: object
    SingleMandateStatementVATEntry:
      description: |-
        Payments and their allocation for one VAT rate.

        `vat_rate` is a decimal fraction (`0.19`) — the Aktenabrechnung
        convention, preserved verbatim. It deliberately differs from the percent
        representation on `/v2/statements/`: that resource inherited its shape
        from the Sammelabrechnung model, this one from the Aktenabrechnung.
      properties:
        allocation_to_client_costs:
          allOf:
            - $ref: '#/components/schemas/StatementAmount'
          description: Amount allocated to your costs.
          nullable: true
          readOnly: true
        allocation_to_client_expenses:
          allOf:
            - $ref: '#/components/schemas/StatementAmount'
          description: Amount allocated to your expenses.
          nullable: true
          readOnly: true
        allocation_to_default_interest:
          allOf:
            - $ref: '#/components/schemas/StatementAmount'
          description: Amount allocated to default interest.
          nullable: true
          readOnly: true
        allocation_to_fee:
          allOf:
            - $ref: '#/components/schemas/StatementAmount'
          description: Amount allocated to the collection fee.
          nullable: true
          readOnly: true
        allocation_to_fee_vat:
          allOf:
            - $ref: '#/components/schemas/StatementAmount'
          description: Amount allocated to VAT on the collection fee.
          nullable: true
          readOnly: true
        allocation_to_main_claim:
          allOf:
            - $ref: '#/components/schemas/StatementAmount'
          description: Amount allocated to the principal claim.
          nullable: true
          readOnly: true
        allocation_to_overpayment:
          allOf:
            - $ref: '#/components/schemas/StatementAmount'
          description: Amount allocated to an overpayment.
          nullable: true
          readOnly: true
        allocation_to_success_commission:
          allOf:
            - $ref: '#/components/schemas/StatementAmount'
          description: Amount allocated to the success commission.
          nullable: true
          readOnly: true
        allocation_to_success_commission_vat:
          allOf:
            - $ref: '#/components/schemas/StatementAmount'
          description: Amount allocated to VAT on the success commission.
          nullable: true
          readOnly: true
        allocation_to_tax_free_expenses:
          allOf:
            - $ref: '#/components/schemas/StatementAmount'
          description: Amount allocated to tax-free expenses.
          nullable: true
          readOnly: true
        allocation_to_taxable_expenses:
          allOf:
            - $ref: '#/components/schemas/StatementAmount'
          description: Amount allocated to taxable expenses.
          nullable: true
          readOnly: true
        allocation_to_taxable_expenses_vat:
          allOf:
            - $ref: '#/components/schemas/StatementAmount'
          description: Amount allocated to VAT on taxable expenses.
          nullable: true
          readOnly: true
        instalment_payments_to_client:
          allOf:
            - $ref: '#/components/schemas/StatementAmount'
          description: Instalment payments already passed on to you.
          nullable: true
          readOnly: true
        payments_to_client:
          allOf:
            - $ref: '#/components/schemas/StatementAmount'
          description: Debtor payments made directly to you.
          nullable: true
          readOnly: true
        payments_to_dca:
          allOf:
            - $ref: '#/components/schemas/StatementAmount'
          description: Debtor payments received by paywise.
          nullable: true
          readOnly: true
        payout:
          allOf:
            - $ref: '#/components/schemas/StatementAmount'
          description: Balance for this VAT rate.
          nullable: true
          readOnly: true
        total_payments:
          allOf:
            - $ref: '#/components/schemas/StatementAmount'
          description: Total debtor payments at this VAT rate.
          nullable: true
          readOnly: true
        vat_rate:
          description: VAT rate as a decimal fraction, for example 0.19 for 19%.
          format: decimal
          pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
          readOnly: true
          type: string
      required:
        - allocation_to_client_costs
        - allocation_to_client_expenses
        - allocation_to_default_interest
        - allocation_to_fee
        - allocation_to_fee_vat
        - allocation_to_main_claim
        - allocation_to_overpayment
        - allocation_to_success_commission
        - allocation_to_success_commission_vat
        - allocation_to_tax_free_expenses
        - allocation_to_taxable_expenses
        - allocation_to_taxable_expenses_vat
        - instalment_payments_to_client
        - payments_to_client
        - payments_to_dca
        - payout
        - total_payments
        - vat_rate
      type: object
    SingleMandateStatementCostBurdenItem:
      description: One account line of a Kostenbelastung.
      properties:
        account_code:
          description: Account code of this cost position.
          readOnly: true
          type: string
        designation:
          description: Human-readable designation of the cost position.
          readOnly: true
          type: string
        gross_amount:
          allOf:
            - $ref: '#/components/schemas/StatementAmount'
          description: Gross amount of this cost position.
          nullable: true
          readOnly: true
        main_account_code:
          description: Main account into which this position is grouped.
          nullable: true
          readOnly: true
          type: string
        net_amount:
          allOf:
            - $ref: '#/components/schemas/StatementAmount'
          description: Net amount of this cost position.
          nullable: true
          readOnly: true
        vat_amount:
          allOf:
            - $ref: '#/components/schemas/StatementAmount'
          description: VAT amount of this cost position.
          nullable: true
          readOnly: true
      required:
        - account_code
        - designation
        - gross_amount
        - main_account_code
        - net_amount
        - vat_amount
      type: object
  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.