List family contracts

GET

https://ssuccessv2.com/app/api/v1/family/:id/contracts

GET

/app/api/v1/family/:id/contracts

$ curl -G https://ssuccessv2.com/app/api/v1/family/1842/contracts \
>      -H "Authorization: Bearer <token>" \
>      -d batch_id=2026

1 {
2   "status": "success",
3   "message": "",
4   "data": [
5     {
6       "id": 812,
7       "academic_year": {
8         "id": 2026,
9         "name": "2026-2027"
10       },
11       "total": 5400,
12       "balance": 1250,
13       "statement_current_due": 325,
14       "statement_total_due": 1250,
15       "statement_contract_balance": 1250,
16       "statement_balance_without_plan": 0,
17       "statement_previous_balance": 0,
18       "statement_end_of_year_balance": 1250,
19       "created_by": "Office Admin",
20       "created_at": "2024-01-15T09:30:00Z",
21       "updated_at": "2024-01-15T09:30:00Z",
22       "students": []
23     }
24   ]
25 }

Returns contracts belonging to the family, optionally filtered by academic year.

Authentication

AuthorizationBearer

The signed-in SchoolSet user token sent by the frontend.

Path parameters

idintegerRequired>=1

Query parameters

batch_idintegerOptional>=1

Response

Contracts returned.

statusstringOptional

messagestringOptional

datalist of objectsOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error