GET /v2/finplus/debtmanagement/financialtransactions
This report provides a comprehensive view of transactions, offering the ability to group data by family/parent while also allowing for further breakdowns per learner using the per_learner parameter. When per_learner is specified, the family/parent object is extended to include learner-specific transaction details. The API supports flexible filtering options, such as date ranges, category IDs, debtor codes, learners, and accountable persons.
The possible transaction types and transaction categories can be looked up using the and Get Transaction Category(s) API calls.
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_limit specified in the response's meta object.
cursor: If the meta object contains a next_cursor field, it indicates that more records are available. To fetch the next set of records, include the cursor parameter in your request with the value of next_cursor. If the next_cursor field 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.
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.
all_accounts
Boolean
Whether to include all accounts
per_learner
Boolean
Whether to include a break-down of transactions 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
start_date
String
The start date for filtering transactions (format: YYYY-MM-DD)
end_date
String
The end date for filtering transactions (format: YYYY-MM-DD). The start_date is required when specifying an end date.
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
Status: 200 OK
