Skip to main content
GET
Get single mandate 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 per-case statement in this request.

Response

booking_date
string<date>
required
read-only

Date on which the case statement was booked.

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

Time at which the case statement was cancelled.

clearing_no
string
required
read-only

Clearing number of the case statement.

comment
string | null
required
read-only

Additional notes supplied with the case statement.

created_at
string<date-time>
required
read-only

Time at which the case statement was created.

file
object | null
required

Downloadable statement document, when available.

financials
object
required

Principal claims, payment allocation, and settlement balance.

id
string<uuid>
required
read-only

Stable identifier of this case statement.

invoice_no
string | null
required
read-only

Invoice number, when this settlement produces an invoice.

mandate
object | null
required

Accepted case settled by this statement, when still linked.

payout_method
enum<string> | null
required

Whether the balance is settled by transfer or direct debit.

  • transfer - Überweisung
  • direct_debit - Lastschrift
Available options:
transfer,
direct_debit
period_end
string<date>
required
read-only

End of the settled period.

period_start
string<date> | null
required
read-only

Start of the settled period, or null for the full case history.

pre_tax_deductible
boolean
required
read-only

Whether you may deduct input VAT for this settlement.

reference_number
string
required
read-only

paywise case-file reference number of the settled case.

statement_type
enum<string>
required

Kind of interim, final, expense, or monitoring settlement.

  • interim - Zwischenabrechnung
  • final - Endabrechnung
  • expenses_invoice - Auslagenrechnung
  • transition_to_longtime_monitoring - Übergabe Überwachungsverfahren
  • negative_closing - Negativabschluss
Available options:
interim,
final,
expenses_invoice,
transition_to_longtime_monitoring,
negative_closing
status
enum<string>
required

Whether the case statement is published or cancelled.

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

Time at which the case statement was last updated.

your_reference
string | null
required
read-only

Your customer number for the debtor on the settled case.