Generate a contract statement PDF

POST

https://ssuccessv2.com/app/api/v2/contract/statement/generate-report-pdf

Generates, downloads, views, or emails one family's contract statement for the requested date range and options.

AuthorizationBearer

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

This endpoint expects an object.

family_student_idintegerRequired>=1

fromdatetimeRequired

todatetimeRequired

contract_idinteger or nullOptional

students_idlist of integersOptional

separate_linebooleanOptional

include_previous_years_balancebooleanOptional

show_payment_allocationsbooleanOptional

send_emailbooleanOptional

send_test_emailstring or nullOptionalformat: "email"

payer_idslist of strings or nullOptional

The requested PDF is returned as binary content when downloading or viewing

statusstringOptional

messagestringOptional

dataobject or nullOptional

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

$	curl -X POST https://ssuccessv2.com/app/api/v2/contract/statement/generate-report-pdf \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"family_student_id": 284,
>	"from": {},
>	"to": {},
>	"contract_id": 901,
>	"separate_line": false,
>	"include_previous_years_balance": true,
>	"show_payment_allocations": true,
>	"send_email": false
>	}'

1	{
2	"status": "success",
3	"message": "Email sent to 1 of 1 parents",
4	"data": {}
5	}