Show collected contract payments

GET

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

Recalculates and returns contract payment totals, balances, credits, due amounts, and account balances.

AuthorizationBearer

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

contract_idintegerRequired>=1

Contract identifier whose payments should be summarized.

Collected payment summary returned.

statusstringOptional

messagestringOptional

dataobjectOptional

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

1	{
2	"status": "success",
3	"message": "",
4	"data": {
5	"contract_total": 12500,
6	"contract_balance": 5000,
7	"contract_scheduled_balance": 2500,
8	"contract_credits": 0,
9	"contract_upcoming_credits": 0,
10	"contract_remaining_balance": 5000,
11	"balance_today": 5000,
12	"balance_after_today": 7500,
13	"statement_current_due": 500,
14	"statement_total_due_today": 500,
15	"statement_total_due_today_all": 750,
16	"family_credit_account_balance": 0,
17	"family_unallocated_payments": 0
18	}
19	}

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