Last updated
Last updated
GET
https://integrate.d6plus.co.za/api/v1/finplus/debtmanagement/ageanalysis/{school_login_id}
Use this endpoint to generate an age analysis report for the specified school.
By default, only active accounts (current learners or accounts with an outstanding balance) will be returned. You can use the all_accounts
query parameter to generate the report for all accounts (includes left learners and 0 balance accounts).
The report will be grouped by family and parent by default. Use the per_learner
query parameter to group the data per learner.
Additionally it is possible to filter on a specific debtor_code
, learner_id
or accountable_person_id
.
school_login_id*
Integer
The login ID of the school to retrieve data from
HTTP-X-USERNAME*
String
As provided by d6
HTTP-X-PASSWORD*
String
As provided by d6
all_accounts
Boolean
Whether to include all accounts
per_learner
Boolean
Whether to group the data per learner
debtor_code
Integer
To filter on a specific Debtor Code
learner_id
Integer
To filter on a specific Learner ID
accountable_person_id
Integer
To filter on a specific Accountable Person ID