SchoolSet APIContract Statements

Generate batch contract statements

Generates statement PDFs for a batch of selected contracts.

Authentication

AuthorizationBearer

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Request

This endpoint expects an object.
family_student_idslist of integersRequired
family student IDs list.
fromstringRequired

Must be a valid date. Must be a valid date in the format Y-m-d\TH:i:sP.

tostringRequired

Must be a valid date. Must be a valid date in the format Y-m-d\TH:i:sP.

modeenumRequired
mode value.
Allowed values:
emailstringOptional
Must be a valid email address. Must not be greater than 255 characters.
contracts_idsobject or nullOptional
contracts IDs list.
separate_linebooleanOptional
separate line flag.
include_previous_years_balancebooleanOptional
include previous years balance flag.
show_payment_allocationsbooleanOptional
show payment allocations value.
send_emailbooleanOptional
send email used for login, contact, or delivery flows.

Response

Returns the updated contract state or a confirmation message after the operation completes.