> ## 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 mandates > 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/ 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/: get: tags: - Mandates summary: List mandates 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: list-mandates 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: >- Whether the accepted case is archived. When omitted, archived cases are hidden unless `updated_since` is set; with `updated_since` archived and active cases are both returned. in: query name: archived schema: type: boolean - description: Created at or after this timestamp (inclusive). in: query name: created_after schema: format: date-time type: string - description: Created at or before this timestamp (inclusive). in: query name: created_before schema: format: date-time type: string - description: Exact legal stage of the accepted case. in: query name: legal_stage 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: Zero-based result offset. in: query name: offset required: false schema: default: 0 minimum: 0 type: integer - description: >- Comma-separated sort fields: debtor `name`, `created`, total claim `amount`, or the latest published status title (`status`). 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: >- Payment state: `unpaid`, `partially_paid`, or `fully_paid`. Repeat the parameter to include any of several states. explode: true in: query name: payment_state schema: items: enum: - fully_paid - partially_paid - unpaid type: string type: array style: form - description: >- Exact processing state. Repeat the parameter to include any of several states. explode: true in: query name: processing_state schema: items: enum: - canceled_by_client - canceled_by_service_provider - ended - in_progress - paused type: string type: array style: form - description: >- A UUID matches the case, one of its subcases, or one of its claims. Otherwise searches case-insensitively by substring: debtor names (accents ignored), your debtor reference, current and previous case references, claim and document references, and, from three characters, the titles, texts and event codes of published status updates. Subcase matches return their main case. Debtor name and reference matches include production-mode debtors only, as in the portal. in: query name: q schema: type: string - description: >- Case-insensitive substring of the current paywise case reference, or an exact match on a previous paywise reference. in: query name: reference_number schema: type: string - description: >- Filter by published open or answered client requests, or by having no published client requests. Repeat the parameter to include any of these categories. explode: true in: query name: requests schema: items: enum: - has_answered_requests_to_client - has_no_requests_to_client - has_open_requests_to_client type: string type: array style: form - description: >- Return rows changed at or after this timezone-aware RFC 3339 timestamp. Results are ordered by updated_at and id. in: query name: updated_since schema: format: date-time type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedMandateListList' 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: PaginatedMandateListList: properties: count: description: Total number of matching resources. example: 123 type: integer next: description: URL for the next page, or null when this is the last page. example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: description: URL for the previous page, or null when this is the first page. example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: description: Resources returned for the requested page. items: $ref: '#/components/schemas/MandateList' 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 MandateList: description: Compact list representation of one case. properties: archived: description: Whether your company archived the case from its active view. readOnly: true type: boolean 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 id: description: Stable identifier of the accepted case. format: uuid readOnly: true type: string 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 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 - created_at - debtor - id - previous_reference_numbers - reference_number - state - total_amount - 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 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 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 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 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 SalutationEnum: enum: - mr - ms - mx type: string securitySchemes: caseBearerAuth: description: >- Company-bound Case Management API key — the standard credential for this API. scheme: bearer type: http partnerBearerAuth: description: >- Partner API key acting for one entitled company; every Case request must then also carry the X-On-Behalf-Of-Company header. scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.