Age Analysis Report
GET /v2/finplus/debtmanagement/ageanalysis
Use this endpoint to generate an age analysis report for the specified school.
Default Behavior:
The report returns only active accounts (i.e., current learners or accounts with an outstanding balance).
To include all accounts (including left learners and zero-balance accounts), set the
all_accountsquery parameter totrue.
Grouping Options:
By default, the report is grouped by family and parent.
Use
per_learnerto group the data per learner.Use
per_categoryto group the data per category.If both
per_learnerandper_categoryare set totrue, the report will be grouped per learner, per category.
Filtering Options:
Use
debtor_codeto filter by a specific debtor.Use
learner_idto filter by a specific learner.Use
accountable_person_idto filter by a specific accountable person.Use
category_idto filter by a specific category.
The response provides balances across different aging periods (current, 30 days, 60 days, etc.), along with optional learner-specific and category-specific breakdowns based on the provided parameters.
Pagination
The response data includes a meta object that contains pagination-specific metadata. You can use the following query parameters to control pagination:
limit: This parameter allows you to override the default limit of records returned, up to the
max_allowed_limitspecified in the response'smetaobject.cursor: If the
metaobject contains anext_cursorfield, it indicates that more records are available. To fetch the next set of records, include thecursorparameter in your request with the value ofnext_cursor. If thenext_cursorfield is not present, it means there are no more records to retrieve.reverse_order: This parameter can be used to reverse the order in which the data is returned, useful for fetching the latest records first.
Request Headers
HTTP-X-USERNAME*
String
As provided by d6
HTTP-X-PASSWORD*
String
As provided by d6
HTTP-X-SCHOOLID*
Integer
The unique identifier of the school for which the data is being queried.
Query Parameters
all_accounts
Boolean
Whether to include all accounts
per_learner
Boolean
Whether to group the data per learner
per_category
Boolean
Whether to group the data per category (can be used in conjunction with 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
category_id
Integer
To filter on a specific Category ID
cursor
String
To retrieve the next group of items (if any)
limit
Integer
To override the default limit of records returned (up to the max_allowed_limit provided in the response metadata).
reverse_order
Boolean
To reverse the order the data is returned in
Response Examples
Status: 200 OK