Skip to main content
GET
Get a family balance

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

UUID identifying this resource.

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>

School UUID. Omit to use the operation's documented company/session scope.

school_ids
string<uuid>[]

Optional school UUID filter. When school_id is also supplied, both filters apply. Accepts repeated query parameters or comma-separated values; empty entries are dropped and surrounding whitespace is trimmed.

fields
enum<string>[]

Select response properties. Unknown names return 400. Default: family_id, family_name, balance, transaction_date. Accepts repeated query parameters or comma-separated values; empty entries are dropped and surrounding whitespace is trimmed.

Available options:
family_id,
school_id,
family_name,
family_student_count,
transaction_id,
transaction_date,
amount,
balance,
receipt_number,
kind

Response

Successful response.

A sparse row containing only the selected fields. Default fields: family_id, family_name, balance, transaction_date.

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