Skip to main content
GET
List statement cases

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.

Path Parameters

id
string<uuid>
required

UUID of the statement in this request.

Query Parameters

document_reference
string

Case-insensitive substring of any claim document reference in the case, usually your invoice number.

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
reference_number
string

Case-insensitive substring of the paywise case reference.

your_reference
string

Case-insensitive substring of any claim reference in the case, such as your order or contract reference.

Response

Limit/offset page of statement case rows.

count
integer
required
read-only

Total number of matching case rows.

next
string<uri> | null
required
read-only

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

previous
string<uri> | null
required
read-only

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

results
object[]
required
read-only

Case rows returned for the requested page.