Skip to main content
GET
Get statement

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.

If-None-Match
string

Return 304 with an empty body when the current ETag matches one of the supplied validators (or *).

Path Parameters

id
string<uuid>
required

UUID of the statement in this request.

Response

booking_date
string<date> | null
required
read-only

Date on which the statement was booked.

cancelled_at
string<date-time> | null
required
read-only

Time at which the statement was cancelled, when applicable.

clearing_no
string | null
required
read-only

Clearing number of the statement.

comment
string | null
required
read-only

Free-text note paywise attached to the statement, when any.

created_at
string<date-time>
required
read-only

Time at which the statement record was created.

files
object[]
required
read-only

Every available download of this statement: the PDF and the Excel exports for third-party money, cost burden and closings. A file appears once it has been transferred.

financials
object
required

Statement-wide balances and VAT breakdown.

id
string<uuid>
required
read-only

Stable identifier of this statement.

invoice_no
string | null
required
read-only

Invoice number of the statement.

mandate_count
integer
required
read-only

Number of accepted cases included in this statement.

Required range: x >= 0
mandates
object[]
required
read-only

Accepted cases included in this statement.

period_end
string<date> | null
required
read-only

End of the period covered by the statement.

period_start
string<date> | null
required
read-only

Start of the period covered by the statement.

published_at
string<date-time> | null
required
read-only

Time at which the statement became available to you.

status
enum<string>
required

Whether the statement is published or cancelled.

Available options:
published,
cancelled
updated_at
string<date-time> | null
required
read-only

Time at which the statement record was last updated.