Skip to main content
GET
List single mandate statements

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

booking_date
string<date>

Booked on exactly this date.

booking_date_from
string<date>

Booking date on or after this date (inclusive).

booking_date_to
string<date>

Booking date on or before this date (inclusive).

clearing_no
string

Exact clearing number.

invoice_no
string

Exact invoice number.

limit
integer
default:10

Number of results to return (maximum 100).

Required range: 1 <= x <= 100
mandate
string<uuid>

Return statements for this accepted case UUID.

offset
integer
default:0

Zero-based result offset.

Required range: x >= 0
ordering
string

Comma-separated sort fields: booking_date, period_start, period_end, created, updated, clearing_no, or invoice_no. Prefix a field with - for descending order. Defaults to -created; updated_since uses its synchronization order instead.

reference_number
string

Exact paywise case reference recorded on the statement.

statement_type
enum<string>

Statement kind: interim, final, expenses invoice, transition to long-term monitoring, or negative closing. Use the corresponding enum value.

Available options:
expenses_invoice,
final,
interim,
negative_closing,
transition_to_longtime_monitoring
status
enum<string>

Return published statements that have not been cancelled, or cancelled statements.

Available options:
cancelled,
published
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.

your_reference
string

Exact client reference recorded on the statement.

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"