SchoolSet APIPayment Plan Reports

Report recurring payment plans

Returns recurring payment plans and their payment summaries, filtered by source, payer, dates, statuses, amounts, and payment mode.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
search_modeenumOptional
Allowed values:
payment_sourceslist of enumsOptional
Allowed values:
academic_year_idslist of integersOptional
payer_idslist of strings or objectsOptional
payment_recurring_status_idslist of integersOptional
payment_recurring_period_idslist of integersOptional
plan_fromdatetimeOptional
plan_todatetimeOptional
payment_date_fromdatetimeOptional
payment_date_todatetimeOptional
payment_status_idslist of integersOptional
payment_filterenumOptional
Allowed values:
credit_type_idslist of integersOptional
amount_fromdoubleOptional
amount_todoubleOptional
payment_plan_statuslist of enumsOptional
Allowed values:

Response

Payment-plan report returned as an array; an empty array is returned when no plans match.

statusstring
messagestring
datalist of objects

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error