Queue batch statement report

POST

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

Queues PDF or ZIP statement generation for the selected families, contracts, date range, and delivery mode.

AuthorizationBearer

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

This endpoint expects an object.

family_student_idslist of integersRequired

fromdatetimeRequired

todatetimeRequired

modeenumRequired

Allowed values:

emailstringOptionalformat: "email"

contracts_idslist of integers or nullOptional

separate_linebooleanOptional

include_previous_years_balancebooleanOptional

show_payment_allocationsbooleanOptional

send_emailbooleanOptional

document_layoutenum or nullOptional

Allowed values:

Batch statement work was queued for background processing.

statusstringOptional

messagestringOptional

dataany or nullOptional

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

$	curl -X POST https://ssuccessv2.com/app/api/v2/contract/statement/generate-batch-report-pdf \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"family_student_ids": [
>	284,
>	285
>	],
>	"from": {},
>	"to": {},
>	"mode": "zip",
>	"email": "finance@schoolset.example",
>	"contracts_ids": [
>	901,
>	902
>	],
>	"include_previous_years_balance": true,
>	"show_payment_allocations": true,
>	"send_email": false,
>	"document_layout": "combined"
>	}'

1	{
2	"status": "success",
3	"message": "Queued successfully.",
4	"data": null
5	}