List contracts requiring collection

GET

https://ssuccessv2.com/app/api/v1/collection/all/:year_id

GET

/app/api/v1/collection/all/:year_id

$ curl https://ssuccessv2.com/app/api/v1/collection/all/2026 \
>      -H "Authorization: Bearer <token>"

1 {
2   "status": "success",
3   "message": "",
4   "data": [
5     {
6       "academic_year_id": 2026,
7       "academic_year_title": "2026-2027",
8       "contract_id": 8841,
9       "family": {
10         "id": 331,
11         "name": "Rivera Family",
12         "parents": [
13           {
14             "id": 902,
15             "name": "Elena Rivera"
16           }
17         ]
18       },
19       "students_statuses": [
20         "Enrolled"
21       ],
22       "has_failed_payments": false,
23       "is_scheduled_payments": true,
24       "balance_without_plan": 1200,
25       "statement_total_due": 9600,
26       "end_of_year_balance": 1200,
27       "account_balance": 1200,
28       "account_due": 1200,
29       "aging_balance_1_30": 1200,
30       "aging_balance_31_60": 0,
31       "aging_balance_61_90": 0,
32       "aging_balance_90_plus": 0,
33       "paid": 8400,
34       "recurring_payment_count": 6,
35       "upcoming_payment_count": 2,
36       "last_payment_date": {},
37       "last_payment_amount": 800,
38       "contract_balance": 1200,
39       "previous_balance": 0,
40       "total": 9600,
41       "current_due": 800,
42       "next_payment_date": {},
43       "snoozed_until": null,
44       "last_snoozed_until": null,
45       "last_unsnoozed_at": null,
46       "assigned_user": null,
47       "assigned_at": null,
48       "payment_plan": {
49         "scheduled": 800
50       }
51     }
52   ]
53 }

Returns contracts with an account due for the selected academic year, filtered to active or snoozed collection records and optionally by scheduled payment status.

Authentication

AuthorizationBearer

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

Path parameters

year_idintegerRequired

Academic year identifier. Use 0 to include all years.

Query parameters

statusenumOptionalDefaults to active

Collection records to return.

Allowed values:

payment_plan_statusstring or list of stringsOptional

Optional scheduled-payment status or statuses.

Response

Collection contracts returned.

statusstringOptional

messagestringOptional

datalist of maps from strings to anyOptional

Errors

401

Unauthorized Error

403

Forbidden Error