Skip to main content
GET
List mandates

Authorizations

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

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.

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.

Response

count
integer
required

Total number of matching resources.

Example:

123

results
object[]
required

Resources returned for the requested page.

next
string<uri> | null

URL for the next page, or null when this is the last page.

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.

Example:

"http://api.example.org/accounts/?offset=200&limit=100"