curl --request GET \
--url https://{host}/primula/api/v3/family_balances \
--header 'Authorization: Bearer <token>'import requests
url = "https://{host}/primula/api/v3/family_balances"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{host}/primula/api/v3/family_balances', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{host}/primula/api/v3/family_balances",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{host}/primula/api/v3/family_balances"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{host}/primula/api/v3/family_balances")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/primula/api/v3/family_balances")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyList family balances and ledgers
Scoped to company_id; the handler does not restrict this read to the session school assignments. Default: sparse balance rows, one per family, with optional fields. group_by plus metrics selects nested FamilyBalanceAggregate rows; family_ids does not filter aggregates. school_id and school_ids are both applied when provided (their intersection).
view=transactions takes precedence and returns FamilyLedger objects (family_id, student_ids, transactions). This view requires school_id assigned to the session. It ignores balance filters, fields, school_ids and grouping after the shared filter parser validates supplied filter values. last_n_days defaults to 30 and is clamped to 0..365. Pagination applies to families, not to transactions inside each family.
Balance rows use per_page capped at 200; transaction-family pages use 500. Aggregates use limit and X-Truncated without Link.
curl --request GET \
--url https://{host}/primula/api/v3/family_balances \
--header 'Authorization: Bearer <token>'import requests
url = "https://{host}/primula/api/v3/family_balances"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{host}/primula/api/v3/family_balances', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{host}/primula/api/v3/family_balances",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{host}/primula/api/v3/family_balances"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{host}/primula/api/v3/family_balances")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/primula/api/v3/family_balances")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyAuthorizations
Access token issued by POST /sessions and associated with a valid server-side session.
Query Parameters
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 UUID. Omit to use the operation's documented company/session scope.
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.
Optional family UUIDs; balance row view only. Accepts repeated query parameters or comma-separated values; empty entries are dropped and surrounding whitespace is trimmed.
Case-insensitive family-name substring filter; balance rows and aggregates.
Inclusive minimum balance; balance rows and aggregates.
Inclusive maximum balance; balance rows and aggregates.
Select response properties. Unknown names return 400. Default: family_id, family_name, balance, transaction_date. Balance row view only. Accepts repeated query parameters or comma-separated values; empty entries are dropped and surrounding whitespace is trimmed.
family_id, school_id, family_name, family_student_count, transaction_id, transaction_date, amount, balance, receipt_number, kind Rows: balance, family_name or transaction_date with _asc/_desc. Aggregates: group or a supported metric with _asc/_desc. Unsupported keys use the backend default. Defaults: balance_desc for rows, count_desc for aggregates.
Read per-family transaction ledgers; takes precedence over grouping.
transactions Transactions only: defaults to 30 and clamps to 0 through 365.
Select an aggregate representation; metrics must also be supplied.
school_id, family_id, family_name Metrics to calculate; required with group_by and invalid without it. Accepts repeated query parameters or comma-separated values; empty entries are dropped and surrounding whitespace is trimmed.
count, sum_balance, avg_balance, min_balance, max_balance, sum_positive_balance, sum_negative_balance, count_zero_balance Aggregate result limit. Defaults to 50 and clamps values above 200 to 200. Zero and negative values use the default.
One-based page number. Balance rows clamp at 200; view=transactions instead clamps at 500.
x >= 1Items per page; values greater than 200 are clamped to 200. Balance rows clamp at 200; view=transactions instead clamps at 500.
x >= 1Response
Successful response.
- Option 1 · object[]
- Option 2 · object[]
- Option 3 · object[]
A sparse row containing only the selected fields. Default fields: family_id, family_name, balance, transaction_date.