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, enabling precise and targeted reporting. Additionally, the all_accounts parameter provides control over whether to include only active accounts or a complete financial history.
Path Parameters
Name
Type
Description
school_login_id*
Integer
The login ID of the school to retrieve data from
Headers
Name
Type
Description
HTTP-X-USERNAME*
String
As provided by d6
HTTP-X-PASSWORD*
String
As provided by d6
Query Parameters
Name
Type
Description
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.
