Get mandate documents

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/{id}/documents/

Get mandate documents

Python

import requests

url = "https://api.paywise.de/v2/mandates/{id}/documents/"

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

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

print(response.text)

200

{
  "count": 123,
  "next": "<string>",
  "previous": "<string>",
  "results": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "download_url": "<string>",
      "filename": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "mime_type": "<string>",
      "status": "pending",
      "type": "bank_statement"
    }
  ]
}

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.

Path Parameters

id · string<uuid> · required

UUID of the accepted case in this request.

Query Parameters

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.

limit · integer · default: 10

Number of results to return (maximum 100).

Required range: 1 <= x <= 100

offset · integer · default: 0

Zero-based result offset.

Required range: x >= 0

updated_since · string<date-time>

Return entries changed at or after this timezone-aware RFC 3339 timestamp (inclusive). With it set, results are ordered by change time and then id instead of newest first, page by cursor instead of offset, and entries changed less than a minute ago are held back.

Response

200

application/json

Limit/offset page of results.

count · integer · required · read-only

Total number of matching resources.

next · string<uri> | null · required · read-only

URL for the next page, or null when this is the last page. With updated_since it carries an opaque cursor.

previous · string<uri> | null · required · read-only

URL for the previous page, or null when this is the first page. Always null with updated_since.

results · object[] · required · read-only

Documents returned for the requested page.

Show child attributes