detailed_student_balance

Complete finance overview for each student: amount for each fee type, gross amount, amount for each discount type, amount for each deduction type, net amount, amount for each payment method, total refunds, payment percentage and student balance. You can use the "additional_fields" parameter to include more fields in the JSON results. Check the /fields service to explore the additional fields that you can add. Example:

{
"additional_fields":"customField_35,idnumber,countryName"
}

Rate Limit: MEDIUM

Permission needed: Financial Reports (#400)

Reference Code: srv_118

Body Params
integer
required

School year id

integer
Defaults to 0

Sectioning

integer

Student status

string

Religion Format: Comma separated numbers, i.e. 23,24,25

string

Student Format: Comma separated numbers, i.e. 23,24,25

string

Paid% Number range value. Format: Comma separated two numbers:-100,100

string

Group level Format: Comma separated numbers, i.e. 23,24,25

string

Include more fields in the JSON results. Check the /fields service to explore the additional fields that you can add. Format: {"additional_fields":"customField_35,idnumber,countryName"}

Headers
string
required
Responses

Language
Credentials
Bearer
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json