SchoolSet APIContract Statements

Generate contract statement PDF

Generates a statement PDF for the selected contract and filters.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
family_student_iddoubleRequired
family student ID identifier.
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.

students_idlist of integersOptional
Student IDs included in this request.
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.
send_test_emailstring or nullOptional
Must be a valid email address. Must not be greater than 255 characters.
contract_iddouble or nullOptional
contract ID identifier.
payer_idsobject or nullOptional
payer IDs list.

Response

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