List contract collections

GET

https://app.schoolset.io/app/api/v1/collection/all/:year_id

GET

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

1 curl https://app.schoolset.io/app/api/v1/collection/all/year_id \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json"

200Retrieved

1 {
2   "status": "success",
3   "message": "Contract collection records retrieved successfully.",
4   "data": [
5     {
6       "academic_year_id": 2023,
7       "academic_year_title": "2023-2024 Academic Year",
8       "contract_id": 4527,
9       "family": {
10         "id": 789,
11         "name": "Johnson Family",
12         "parents": [
13           {
14             "id": 1234,
15             "firstname": "Emily",
16             "lastname": "Johnson",
17             "email": "emily.johnson@example.com",
18             "cell_phone": "+1-555-123-4567"
19           }
20         ]
21       },
22       "students_statuses": [
23         "enrolled",
24         "active"
25       ],
26       "has_failed_payments": false,
27       "is_scheduled_payments": true,
28       "balance_without_plan": 250.75,
29       "statement_total_due": 500,
30       "end_of_year_balance": 0,
31       "account_balance": 250.75,
32       "account_due": 150,
33       "aging_balance_1_30": 100,
34       "aging_balance_31_60": 50,
35       "aging_balance_61_90": 0,
36       "aging_balance_90_plus": 0,
37       "paid": 1250,
38       "recurring_payment_count": 3,
39       "upcoming_payment_count": 1,
40       "last_payment_date": "2024-05-10",
41       "last_payment_amount": 500,
42       "contract_balance": 250.75,
43       "previous_balance": 300,
44       "total": 1500.75,
45       "current_due": 150,
46       "next_payment_date": "2024-06-10",
47       "snoozed_until": null,
48       "last_snoozed_until": null,
49       "last_unsnoozed_at": null,
50       "assigned_user": {
51         "id": 42,
52         "fullname": "Michael Thompson",
53         "email": "michael.thompson@schoolset.io"
54       },
55       "assigned_at": "2024-04-01T09:00:00Z"
56     }
57   ]
58 }

Returns contract collection records for the selected academic year.

Authentication

AuthorizationBearer

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Path parameters

year_idstringRequired

Response

Successful GET response for /api/v1/collection/all/{year_id}.

statusstring

messagestring

datalist of objects