List a family's scheduled payments

Returns upcoming and pending payments for the family’s contracts and independent fees. Set batch_id to limit the result to one academic year.

Authentication

AuthorizationBearer

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

Path parameters

idlongRequired

Query parameters

batch_idlongOptional

Academic year identifier used to filter contract and independent-fee payments.

Response

Scheduled payments returned.
statusstring
messagestring
datalist of objects

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error