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.

GET /v2/mandates/

List mandates

Python

import requests

url = "https://api.paywise.de/v2/mandates/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

200

{
  "count": 123,
  "results": [
    {
      "archived": true,
      "created_at": "2023-11-07T05:31:56Z",
      "debtor": {
        "acting_as": "consumer",
        "events": [
          {
            "description": "<string>",
            "location": "<string>",
            "occurence": "2023-11-07T05:31:56Z",
            "title": "<string>",
            "type": "<string>",
            "your_reference": "<string>"
          }
        ],
        "legal_form": "<string>",
        "metadata": [
          {
            "type": "<string>",
            "value": "<string>"
          }
        ],
        "organization": {
          "commercial_register": "<string>",
          "commercial_registration_number": "<string>",
          "name": "<string>"
        },
        "person": {
          "birth_date": "2023-12-25",
          "first_name": "<string>",
          "last_name": "<string>",
          "salutation": "mr"
        },
        "your_reference": "<string>"
      },
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "previous_reference_numbers": [
        "<string>"
      ],
      "reference_number": "<string>",
      "state": {
        "legal_stage": {
          "code": "<string>",
          "label": "<string>",
          "label_key": "<string>"
        },
        "payment": {
          "code": "<string>",
          "label": "<string>",
          "label_key": "<string>"
        },
        "processing": {
          "code": "<string>",
          "label": "<string>",
          "label_key": "<string>"
        }
      },
      "total_amount": {
        "currency": "<string>",
        "value": "<string>"
      },
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Authorizations

caseBearerAuthpartnerBearerAuth

Authorization · string · header · required

Company-bound Case Management API key — the standard credential for this API.

Headers

X-On-Behalf-Of-Company · string<uuid>

Required when a Partner key calls the Case Management API; rejected for direct Case keys. Contains the entitled paywise company UUID.

Query Parameters

archived · boolean

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.

created_after · string<date-time>

Created at or after this timestamp (inclusive).

created_before · string<date-time>

Created at or before this timestamp (inclusive).

cursor · string

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.

legal_stage · string

Exact legal stage of the accepted case.

limit · integer · default: 10

Number of results to return (maximum 100).

Required range: 1 <= x <= 100

offset · integer · default: 0

Zero-based result offset. Cannot be combined with updated_since; follow the next URL (cursor) instead.

Required range: x >= 0

ordering · string

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.

payment_state · enum<string>[]

Payment state: unpaid, partially_paid, or fully_paid. Repeat the parameter to include any of several states.

Available options: fully_paid, partially_paid, unpaid

processing_state · enum<string>[]

Exact processing state. Repeat the parameter to include any of several states.

Available options: canceled_by_client, canceled_by_service_provider, ended, in_progress, paused

q · string

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.

reference_number · string

Case-insensitive substring of the current paywise case reference, or an exact match on a previous paywise reference.

requests · enum<string>[]

Filter by published open or answered client requests, or by having no published client requests. Repeat the parameter to include any of these categories.

Available options: has_answered_requests_to_client, has_no_requests_to_client, has_open_requests_to_client

updated_since · string<date-time>

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.

Response

200

application/json

count · integer · required

Total number of matching resources.

Example:

123

results · object[] · required

Resources returned for the requested page.

Show child attributes

next · string<uri> | null

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"

previous · string<uri> | null

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"