Get collected contract payment totals

GET

https://ssuccessv2.com/app/api/v1/portal/payment/contract/details/payment/collected/:contract_id

Returns the authenticated parent student’s collected-payment summary for a contract.

AuthorizationBearer

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

contract_idlongRequired>=1

Collected contract totals in the standard success envelope.

statusstring

messagestring

datamap from strings to any

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

1	{
2	"status": "success",
3	"message": "",
4	"data": {
5	"contract_total": "2400.00",
6	"collected": "800.00",
7	"balance": "1600.00",
8	"statement_current_due": "400.00",
9	"statement_total_due_today": "400.00",
10	"statement_total_due_today_all": "400.00",
11	"family_credit_account_balance": "0.00",
12	"family_unallocated_payments": "0.00"
13	}
14	}

$	curl https://ssuccessv2.com/app/api/v1/portal/payment/contract/details/payment/collected/4821 \
>	-H "Authorization: Bearer <token>"