Skip to main content
GET
List family balances

Authorizations

Authorization
string
header
required

Access token issued by POST /sessions and associated with a valid server-side session.

Query Parameters

company_id
string<uuid>
required

Company UUID. Must equal the authenticated session company when that session has a company assigned; the equality check is skipped for sessions without one.

school_id
string<uuid>
required

School UUID. Must be allowed for the authenticated session.

family_ids
string<uuid>[]

Optional family UUIDs. Accepts repeated query parameters or comma-separated values; empty entries are dropped and surrounding whitespace is trimmed.

family_name
string

Case-insensitive family-name substring filter.

page
integer
default:1

One-based page number.

Required range: x >= 1
per_page
integer
default:200

Items per page; defaults to 200 and values greater than 200 are clamped to 200.

Required range: 1 <= x <= 200

Response

Successful response.

family_id
string

Family id.

school_id
string

School id.

family_name
string
family_student_count
integer
transaction_id
string

Transaction id.

transaction_date
string<date>
amount
number
balance
number
receipt_number
string
kind
string