> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.schoolset.io/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.schoolset.io/_mcp/server. # Queue batch statement report POST https://ssuccessv2.com/app/api/v2/contract/statement/generate-batch-report-pdf Content-Type: application/json Queues PDF or ZIP statement generation for the selected families, contracts, date range, and delivery mode. Reference: https://docs.schoolset.io/api-reference/school-set-api/contract-statements/generate-batch-statement-report ## Authentication - `Authorization` header (bearer token, required) — The signed-in SchoolSet user token sent by the frontend. ## Request ### Body (application/json) This endpoint expects an object. - `family_student_ids` (list of integer, required) - `from` (datetime, required) - `to` (datetime, required) - `mode` (enum, required) - Allowed values: `pdf`, `zip` - `email` (string, optional) - `contracts_ids` (list of integer, optional, nullable) - `separate_line` (boolean, optional) - `include_previous_years_balance` (boolean, optional) - `show_payment_allocations` (boolean, optional) - `send_email` (boolean, optional) - `document_layout` (enum, optional, nullable) - Allowed values: `combined`, `separate` ## Response ### 200 Batch statement work was queued for background processing. - `status` (string, optional) - `message` (string, optional) - `data` (any, optional, nullable) ## Errors ### 401 Unauthorized Error Authentication is required to generate statements. - `status` (string, required) - `message` (string, required) - `data` (any, optional, nullable) ### 403 Forbidden Error The user cannot view contracts in the active school. - `status` (string, required) - `message` (string, required) - `data` (any, optional, nullable) ### 422 Unprocessable Entity Error Required family IDs - `message` (string, required) - `errors` (map from string to list of string, required) ## Examples **Request** ```json { "family_student_ids": [ 284, 285 ], "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" } ``` **Response** ```json { "status": "success", "message": "Queued successfully.", "data": null } ``` **SDK Code** ```python import requests url = "https://ssuccessv2.com/app/api/v2/contract/statement/generate-batch-report-pdf" payload = { "family_student_ids": [284, 285], "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" } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://ssuccessv2.com/app/api/v2/contract/statement/generate-batch-report-pdf'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"family_student_ids":[284,285],"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"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://ssuccessv2.com/app/api/v2/contract/statement/generate-batch-report-pdf" payload := strings.NewReader("{\n \"family_student_ids\": [\n 284,\n 285\n ],\n \"mode\": \"zip\",\n \"email\": \"finance@schoolset.example\",\n \"contracts_ids\": [\n 901,\n 902\n ],\n \"include_previous_years_balance\": true,\n \"show_payment_allocations\": true,\n \"send_email\": false,\n \"document_layout\": \"combined\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://ssuccessv2.com/app/api/v2/contract/statement/generate-batch-report-pdf") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"family_student_ids\": [\n 284,\n 285\n ],\n \"mode\": \"zip\",\n \"email\": \"finance@schoolset.example\",\n \"contracts_ids\": [\n 901,\n 902\n ],\n \"include_previous_years_balance\": true,\n \"show_payment_allocations\": true,\n \"send_email\": false,\n \"document_layout\": \"combined\"\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://ssuccessv2.com/app/api/v2/contract/statement/generate-batch-report-pdf") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"family_student_ids\": [\n 284,\n 285\n ],\n \"mode\": \"zip\",\n \"email\": \"finance@schoolset.example\",\n \"contracts_ids\": [\n 901,\n 902\n ],\n \"include_previous_years_balance\": true,\n \"show_payment_allocations\": true,\n \"send_email\": false,\n \"document_layout\": \"combined\"\n}") .asString(); ``` ```php request('POST', 'https://ssuccessv2.com/app/api/v2/contract/statement/generate-batch-report-pdf', [ 'body' => '{ "family_student_ids": [ 284, 285 ], "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" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://ssuccessv2.com/app/api/v2/contract/statement/generate-batch-report-pdf"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"family_student_ids\": [\n 284,\n 285\n ],\n \"mode\": \"zip\",\n \"email\": \"finance@schoolset.example\",\n \"contracts_ids\": [\n 901,\n 902\n ],\n \"include_previous_years_balance\": true,\n \"show_payment_allocations\": true,\n \"send_email\": false,\n \"document_layout\": \"combined\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "family_student_ids": [284, 285], "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" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://ssuccessv2.com/app/api/v2/contract/statement/generate-batch-report-pdf")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```