> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://apidoc.dreamclass.io/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://apidoc.dreamclass.io/_mcp/server. # GetInvoices POST https://dreamclassapi/v1/financial/invoices/list Content-Type: application/json Returns a list of invoices based on issue date, due date and status Input variables 1. json representation of an Invoicefilters object with properties 1. issueDateFrom 2. issueDateTo 3. dueDateFrom 4. dueDateTo 5. status of Invoice (1 unpaid, 2 partially paid, 3 fully paid) Reference: https://apidoc.dreamclass.io/dream-class-api/invoices/get-invoices ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: collection version: 1.0.0 paths: /dreamclassapi/v1/financial/invoices/list: post: operationId: get-invoices summary: GetInvoices description: |- Returns a list of invoices based on issue date, due date and status Input variables 1. json representation of an Invoicefilters object with properties 1. issueDateFrom 2. issueDateTo 3. dueDateFrom 4. dueDateTo 5. status of Invoice (1 unpaid, 2 partially paid, 3 fully paid) tags: - subpackage_invoices parameters: - name: tenant in: header required: false schema: type: string - name: schoolCode in: header required: false schema: type: string responses: '200': description: OK content: application/json: schema: type: array items: $ref: >- #/components/schemas/DreamclassapiV1FinancialInvoicesListPostResponsesContentApplicationJsonSchemaItems requestBody: content: application/json: schema: type: object properties: status: type: integer dueDateFrom: type: string format: date dueDateΤο: type: string format: date issueDateFrom: type: string format: date issueDateΤο: type: string format: date required: - status - dueDateFrom - dueDateΤο - issueDateFrom - issueDateΤο servers: - url: https:/ description: https://{server} - url: https://your-webhook-url description: https://your-webhook-url components: schemas: DreamclassapiV1FinancialInvoicesListPostResponsesContentApplicationJsonSchemaItemsFeesItems: type: object properties: id: type: integer name: type: string type: description: Any type amount: type: integer status: type: string expireDate: description: Any type paidamount: type: integer required: - id - name - amount - status - paidamount title: >- DreamclassapiV1FinancialInvoicesListPostResponsesContentApplicationJsonSchemaItemsFeesItems DreamclassapiV1FinancialInvoicesListPostResponsesContentApplicationJsonSchemaItemsPaymentsItems: type: object properties: id: type: integer amount: type: integer createdAt: type: string format: date-time invoiceId: type: integer publicNotes: description: Any type privateNotes: description: Any type paymentmethod: description: Any type required: - id - amount - createdAt - invoiceId title: >- DreamclassapiV1FinancialInvoicesListPostResponsesContentApplicationJsonSchemaItemsPaymentsItems DreamclassapiV1FinancialInvoicesListPostResponsesContentApplicationJsonSchemaItems: type: object properties: id: type: integer fees: type: array items: $ref: >- #/components/schemas/DreamclassapiV1FinancialInvoicesListPostResponsesContentApplicationJsonSchemaItemsFeesItems email: description: Any type amount: type: integer status: type: integer address: type: string dueDate: type: string format: date fullname: type: string payments: type: array items: $ref: >- #/components/schemas/DreamclassapiV1FinancialInvoicesListPostResponsesContentApplicationJsonSchemaItemsPaymentsItems createdAt: type: string format: date-time issueDate: type: string format: date telephone: description: Any type paidAmount: type: integer publicNotes: description: Any type invoiceRefId: description: Any type privateNotes: description: Any type required: - id - fees - amount - status - address - dueDate - fullname - payments - createdAt - issueDate - paidAmount title: >- DreamclassapiV1FinancialInvoicesListPostResponsesContentApplicationJsonSchemaItems ``` ## Examples **Request** ```json { "status": 1, "dueDateFrom": "2022-12-01", "dueDateΤο": "2022-12-31", "issueDateFrom": "2022-12-01", "issueDateΤο": "2022-12-31" } ``` **Response** ```json [ { "id": 3, "fees": [ { "id": 18, "name": "Registration Fee", "amount": 10, "status": "PAID", "paidamount": 10 } ], "amount": 10, "status": 3, "address": "123 Clement Street", "dueDate": "2024-04-30", "fullname": "John Johnson", "payments": [ { "id": 2, "amount": 5, "createdAt": "2024-04-21T12:24:06.877+00:00", "invoiceId": 3 }, { "id": 1, "amount": 5, "createdAt": "2024-04-21T12:23:07.533+00:00", "invoiceId": 3, "paymentmethod": null } ], "createdAt": "2024-04-21T12:22:40.661+00:00", "issueDate": "2024-04-01", "paidAmount": 10 } ] ``` **SDK Code** ```python Invoices_GetInvoices_example import requests url = "https://https/dreamclassapi/v1/financial/invoices/list" payload = { "status": 1, "dueDateFrom": "2022-12-01", "dueDateΤο": "2022-12-31", "issueDateFrom": "2022-12-01", "issueDateΤο": "2022-12-31" } headers = { "tenant": "{{tenant}}", "schoolCode": "{{schoolCode}}", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript Invoices_GetInvoices_example const url = 'https://https/dreamclassapi/v1/financial/invoices/list'; const options = { method: 'POST', headers: { tenant: '{{tenant}}', schoolCode: '{{schoolCode}}', 'Content-Type': 'application/json' }, body: '{"status":1,"dueDateFrom":"2022-12-01","dueDateΤο":"2022-12-31","issueDateFrom":"2022-12-01","issueDateΤο":"2022-12-31"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Invoices_GetInvoices_example package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://https/dreamclassapi/v1/financial/invoices/list" payload := strings.NewReader("{\n \"status\": 1,\n \"dueDateFrom\": \"2022-12-01\",\n \"dueDateΤο\": \"2022-12-31\",\n \"issueDateFrom\": \"2022-12-01\",\n \"issueDateΤο\": \"2022-12-31\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("tenant", "{{tenant}}") req.Header.Add("schoolCode", "{{schoolCode}}") 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 Invoices_GetInvoices_example require 'uri' require 'net/http' url = URI("https://https/dreamclassapi/v1/financial/invoices/list") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["tenant"] = '{{tenant}}' request["schoolCode"] = '{{schoolCode}}' request["Content-Type"] = 'application/json' request.body = "{\n \"status\": 1,\n \"dueDateFrom\": \"2022-12-01\",\n \"dueDateΤο\": \"2022-12-31\",\n \"issueDateFrom\": \"2022-12-01\",\n \"issueDateΤο\": \"2022-12-31\"\n}" response = http.request(request) puts response.read_body ``` ```java Invoices_GetInvoices_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://https/dreamclassapi/v1/financial/invoices/list") .header("tenant", "{{tenant}}") .header("schoolCode", "{{schoolCode}}") .header("Content-Type", "application/json") .body("{\n \"status\": 1,\n \"dueDateFrom\": \"2022-12-01\",\n \"dueDateΤο\": \"2022-12-31\",\n \"issueDateFrom\": \"2022-12-01\",\n \"issueDateΤο\": \"2022-12-31\"\n}") .asString(); ``` ```php Invoices_GetInvoices_example request('POST', 'https://https/dreamclassapi/v1/financial/invoices/list', [ 'body' => '{ "status": 1, "dueDateFrom": "2022-12-01", "dueDateΤο": "2022-12-31", "issueDateFrom": "2022-12-01", "issueDateΤο": "2022-12-31" }', 'headers' => [ 'Content-Type' => 'application/json', 'schoolCode' => '{{schoolCode}}', 'tenant' => '{{tenant}}', ], ]); echo $response->getBody(); ``` ```csharp Invoices_GetInvoices_example using RestSharp; var client = new RestClient("https://https/dreamclassapi/v1/financial/invoices/list"); var request = new RestRequest(Method.POST); request.AddHeader("tenant", "{{tenant}}"); request.AddHeader("schoolCode", "{{schoolCode}}"); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"status\": 1,\n \"dueDateFrom\": \"2022-12-01\",\n \"dueDateΤο\": \"2022-12-31\",\n \"issueDateFrom\": \"2022-12-01\",\n \"issueDateΤο\": \"2022-12-31\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Invoices_GetInvoices_example import Foundation let headers = [ "tenant": "{{tenant}}", "schoolCode": "{{schoolCode}}", "Content-Type": "application/json" ] let parameters = [ "status": 1, "dueDateFrom": "2022-12-01", "dueDateΤο": "2022-12-31", "issueDateFrom": "2022-12-01", "issueDateΤο": "2022-12-31" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://https/dreamclassapi/v1/financial/invoices/list")! 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() ```