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

# List statements

> Published payout statements and their customer-visible breakdown.



## OpenAPI

````yaml /api-docs/case-management-api/openapi.json get /v2/statements/
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/statements/:
    get:
      tags:
        - Statements
      summary: List statements
      description: Published payout statements and their customer-visible breakdown.
      operationId: list-statements
      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: Booking date on or after this date (inclusive).
          in: query
          name: booking_date_from
          schema:
            format: date
            type: string
        - description: Booking date on or before this date (inclusive).
          in: query
          name: booking_date_to
          schema:
            format: date
            type: string
        - description: Exact clearing number.
          in: query
          name: clearing_no
          schema:
            type: string
        - description: >-
            Opaque continuation cursor for incremental synchronization, taken
            from the `next` URL of a previous page. Only valid together with
            `updated_since`: with `updated_since` set the list is ordered by
            change time and then id and pages by this cursor instead of
            `offset`, so a row that changes while you page is returned again
            later instead of pushing another row out of the result. Rows changed
            less than 60 seconds ago are held back until they are settled; use
            the largest `updated_at` you received as the next `updated_since`.
          in: query
          name: cursor
          required: false
          schema:
            type: string
        - description: Exact invoice number.
          in: query
          name: invoice_no
          schema:
            type: string
        - description: Number of results to return (maximum 100).
          in: query
          name: limit
          required: false
          schema:
            default: 10
            maximum: 100
            minimum: 1
            type: integer
        - description: >-
            Statements that include the accepted case with this paywise
            reference number, exact match.
          in: query
          name: mandate_reference_number
          schema:
            type: string
        - description: >-
            Zero-based result offset. Cannot be combined with `updated_since`;
            follow the `next` URL (`cursor`) instead.
          in: query
          name: offset
          required: false
          schema:
            default: 0
            minimum: 0
            type: integer
        - description: >-
            Comma-separated sort fields: `booking_date`, `period_start`,
            `period_end`, `created`, `updated`, `clearing_no`, or `invoice_no`.
            Prefix a field with `-` for descending order. Defaults to
            `-created`; `updated_since` uses its synchronization order instead.
          in: query
          name: ordering
          required: false
          schema:
            type: string
        - description: Statement period ends on or after this date (inclusive).
          in: query
          name: period_end_from
          schema:
            format: date
            type: string
        - description: Statement period ends on or before this date (inclusive).
          in: query
          name: period_end_to
          schema:
            format: date
            type: string
        - description: Statement period starts on or after this date (inclusive).
          in: query
          name: period_start_from
          schema:
            format: date
            type: string
        - description: Statement period starts on or before this date (inclusive).
          in: query
          name: period_start_to
          schema:
            format: date
            type: string
        - description: >-
            A UUID matches the statement. Otherwise searches clearing number,
            invoice number, and company name by case-insensitive substring.
            Related case, claim, and document references use exact,
            case-insensitive matches.
          in: query
          name: q
          schema:
            type: string
        - description: >-
            Return `published` statements that have not been cancelled, or
            `cancelled` statements.
          in: query
          name: status
          schema:
            enum:
              - cancelled
              - published
            type: string
        - description: >-
            Return rows changed at or after this timezone-aware RFC 3339
            timestamp. Results are ordered by updated_at and id (a requested
            `ordering` is ignored), page by `cursor` instead of `offset`, and
            rows changed less than a minute ago are held back.
          in: query
          name: updated_since
          schema:
            format: date-time
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedStatementListList'
          description: ''
          headers:
            Cache-Control:
              description: >-
                Cacheability directive. Authenticated responses use `private,
                no-store`; the legal-form catalog may use `private,
                max-age=86400`.
              schema:
                type: string
            X-Paywise-Environment:
              description: Environment that produced the response.
              schema:
                enum:
                  - production
                  - sandbox
                type: string
            X-Paywise-Request-Id:
              description: >-
                Fresh server-assigned correlation id for this response.
                Caller-provided request ids are ignored.
              schema:
                format: uuid
                type: string
        '400':
          content:
            application/json:
              examples:
                validation-error:
                  value:
                    code: validation_error
                    detail: The request contains invalid data.
                    errors:
                      - code: invalid
                        field: claims[0].due_date
                        message: Due date must not precede the document date.
              schema:
                $ref: '#/components/schemas/Error'
          description: Standard error response.
          headers:
            Cache-Control:
              description: >-
                Cacheability directive. Authenticated responses use `private,
                no-store`; the legal-form catalog may use `private,
                max-age=86400`.
              schema:
                type: string
            X-Paywise-Environment:
              description: Environment that produced the response.
              schema:
                enum:
                  - production
                  - sandbox
                type: string
            X-Paywise-Request-Id:
              description: >-
                Fresh server-assigned correlation id for this response.
                Caller-provided request ids are ignored.
              schema:
                format: uuid
                type: string
        '401':
          content:
            application/json:
              examples:
                authentication-error:
                  value:
                    code: not_authenticated
                    detail: Authentication credentials were not provided.
              schema:
                $ref: '#/components/schemas/Error'
          description: Standard error response.
          headers:
            Cache-Control:
              description: >-
                Cacheability directive. Authenticated responses use `private,
                no-store`; the legal-form catalog may use `private,
                max-age=86400`.
              schema:
                type: string
            X-Paywise-Environment:
              description: Environment that produced the response.
              schema:
                enum:
                  - production
                  - sandbox
                type: string
            X-Paywise-Request-Id:
              description: >-
                Fresh server-assigned correlation id for this response.
                Caller-provided request ids are ignored.
              schema:
                format: uuid
                type: string
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Standard error response.
          headers:
            Cache-Control:
              description: >-
                Cacheability directive. Authenticated responses use `private,
                no-store`; the legal-form catalog may use `private,
                max-age=86400`.
              schema:
                type: string
            X-Paywise-Environment:
              description: Environment that produced the response.
              schema:
                enum:
                  - production
                  - sandbox
                type: string
            X-Paywise-Request-Id:
              description: >-
                Fresh server-assigned correlation id for this response.
                Caller-provided request ids are ignored.
              schema:
                format: uuid
                type: string
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Standard error response.
          headers:
            Cache-Control:
              description: >-
                Cacheability directive. Authenticated responses use `private,
                no-store`; the legal-form catalog may use `private,
                max-age=86400`.
              schema:
                type: string
            Retry-After:
              description: Integer seconds to wait before retrying a throttled request.
              schema:
                minimum: 1
                type: integer
            X-Paywise-Environment:
              description: Environment that produced the response.
              schema:
                enum:
                  - production
                  - sandbox
                type: string
            X-Paywise-Request-Id:
              description: >-
                Fresh server-assigned correlation id for this response.
                Caller-provided request ids are ignored.
              schema:
                format: uuid
                type: string
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Standard error response.
          headers:
            Cache-Control:
              description: >-
                Cacheability directive. Authenticated responses use `private,
                no-store`; the legal-form catalog may use `private,
                max-age=86400`.
              schema:
                type: string
            X-Paywise-Environment:
              description: Environment that produced the response.
              schema:
                enum:
                  - production
                  - sandbox
                type: string
            X-Paywise-Request-Id:
              description: >-
                Fresh server-assigned correlation id for this response.
                Caller-provided request ids are ignored.
              schema:
                format: uuid
                type: string
      security:
        - caseBearerAuth: []
        - partnerBearerAuth: []
components:
  schemas:
    PaginatedStatementListList:
      properties:
        count:
          description: Total number of matching resources.
          example: 123
          type: integer
        next:
          description: >-
            URL for the next page, or null when this is the last page. With
            `updated_since` it carries an opaque `cursor`.
          example: http://api.example.org/accounts/?offset=400&limit=100
          format: uri
          nullable: true
          type: string
        previous:
          description: >-
            URL for the previous page, or null when this is the first page.
            Always null with `updated_since`.
          example: http://api.example.org/accounts/?offset=200&limit=100
          format: uri
          nullable: true
          type: string
        results:
          description: Resources returned for the requested page.
          items:
            $ref: '#/components/schemas/StatementList'
          type: array
      required:
        - count
        - results
      type: object
    Error:
      properties:
        code:
          description: Machine-readable error category.
          type: string
        detail:
          description: Short human-readable summary of the error.
          type: string
        errors:
          description: Field-level validation errors, when applicable.
          items:
            $ref: '#/components/schemas/ErrorItem'
          type: array
      required:
        - detail
        - code
      type: object
    StatementList:
      properties:
        booking_date:
          description: Date on which the statement was booked.
          format: date
          nullable: true
          readOnly: true
          type: string
        cancelled_at:
          description: Time at which the statement was cancelled, when applicable.
          format: date-time
          nullable: true
          readOnly: true
          type: string
        clearing_no:
          description: Clearing number of the statement.
          nullable: true
          readOnly: true
          type: string
        comment:
          description: Free-text note paywise attached to the statement, when any.
          nullable: true
          readOnly: true
          type: string
        created_at:
          description: Time at which the statement record was created.
          format: date-time
          readOnly: true
          type: string
        id:
          description: Stable identifier of this statement.
          format: uuid
          readOnly: true
          type: string
        invoice_no:
          description: Invoice number of the statement.
          nullable: true
          readOnly: true
          type: string
        mandate_count:
          description: Number of accepted cases included in this statement.
          minimum: 0
          readOnly: true
          type: integer
        period_end:
          description: End of the period covered by the statement.
          format: date
          nullable: true
          readOnly: true
          type: string
        period_start:
          description: Start of the period covered by the statement.
          format: date
          nullable: true
          readOnly: true
          type: string
        published_at:
          description: Time at which the statement became available to you.
          format: date-time
          nullable: true
          readOnly: true
          type: string
        status:
          allOf:
            - $ref: '#/components/schemas/CaseStatementStatusEnum'
          description: Whether the statement is published or cancelled.
          readOnly: true
        updated_at:
          description: Time at which the statement record was last updated.
          format: date-time
          nullable: true
          readOnly: true
          type: string
      required:
        - booking_date
        - cancelled_at
        - clearing_no
        - comment
        - created_at
        - id
        - invoice_no
        - mandate_count
        - period_end
        - period_start
        - published_at
        - status
        - updated_at
      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
    CaseStatementStatusEnum:
      enum:
        - published
        - cancelled
      type: string
  securitySchemes:
    caseBearerAuth:
      description: >-
        Company-bound Case Management API key — the standard credential for this
        API.
      scheme: bearer
      type: http
    partnerBearerAuth:
      description: >-
        Partner API key acting for one entitled company; every Case request must
        then also carry the X-On-Behalf-Of-Company header.
      scheme: bearer
      type: http

````

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