Get tuition payment trends

POST

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

Returns collected, projected, outstanding-fee, and failed-payment values for each period between the supplied dates.

AuthorizationBearer

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

year_idintegerRequired

Academic year identifier. The current implementation calculates across contracts regardless of this optional scope.

This endpoint expects an object.

fromdateRequired

todateRequired

modeenumRequired

Allowed values:

Tuition trend returned.

statusstringOptional

messagestringOptional

dataobjectOptional

exampleanyOptional

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

$	curl -X POST https://ssuccessv2.com/app/api/v1/collection/widgets/tuition/payments/2026 \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"from": {},
>	"to": {},
>	"mode": "monthly"
>	}'