Get this month's payment widget

GET

https://ssuccessv2.com/app/api/v1/collection/widgets/monthly/payments/:year_id

GET

/app/api/v1/collection/widgets/monthly/payments/:year_id

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

1 {
2   "status": "success",
3   "message": "",
4   "data": [
5     {
6       "projected": {
7         "value": 4800,
8         "date": {},
9         "count": 6
10       },
11       "collected": {
12         "value": 3200,
13         "date": {},
14         "count": 4
15       },
16       "failed": {
17         "value": 0,
18         "date": {},
19         "count": 0
20       },
21       "fees_total": {
22         "value": 1600,
23         "date": {}
24       },
25       "collected_percent": {
26         "value": 33.33,
27         "date": {}
28       },
29       "projected_percent": {
30         "value": 50,
31         "date": {}
32       },
33       "fees_percent": {
34         "value": 16.67,
35         "date": {}
36       }
37     }
38   ]
39 }

Returns projected, collected, failed, outstanding-fee, and percentage values for the current month, optionally limited to an academic year.

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.

Response

Monthly payment widget returned.

statusstringOptional

messagestringOptional

datalist of objectsOptional

Errors

401

Unauthorized Error

403

Forbidden Error