Use this endpoint to fetch one or more debtor note records for the specified school. By default, all active debtor notes will be returned. To include deleted debtor notes in the results, provide the include_deleted query parameter.
It is possible to retrieve a single debtor note by providing the optional note_id query parameter.
Additionally it is also possible to search for a debtor note(s) using the debtor_code, accountable_person_id and/or note_type_id query parameters. To return notes for only a specific year, use the year query parameter.
To include the "Promise to Pay" payment arrangement data directly in the notes response payload, providing the additional include_promise_to_pays query parameter. The payment arrangement data will be included in a sub-array per note.
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
note_id
Integer
The ID of a specific note
note_type_id
Integer
To only return notes of a given note type
communication_type_id
Integer
To only return notes of a given communication type
accountable_person_id
Integer
To only return a specific accountable person's notes
debtor_code
Integer
To only return a given debtor code's notes
year
Integer
To filter on a specific year
include_deleted
Boolean
Whether to include notes that have been deleted already
include_promise_to_pays
Boolean
Whether to include promise-to-pay data in the response
Response Examples
[ {"note_id":"6","accountable_person_id":"40","accountable_person":"Mr James, John","debtor_code":"1001","debtor_reference":"James","date":"2024-03-03","note_type_id":"2","note_type":"Promise to Pay","communication_type_id":"2","communication_type":"E-mail","note":"Payment arrangement of R1000 to be paid off on outstanding school fees","status":"Created" }, {"note_id":"7","accountable_person_id":"3","accountable_person":"Mr Webster, Nic","debtor_code":"1002","debtor_reference":"Webster","date":"2024-04-15","note_type_id":"3","note_type":"Internal","communication_type_id":"7","communication_type":"Internal","note":"Mr Webster asked to be phoned back tomorrow at 2pm","status":"Created" }]
[ {"note_id":"6","accountable_person_id":"40","accountable_person":"Mr James, John","debtor_code":"1001","debtor_reference":"James","date":"2024-03-03","note_type_id":"2","note_type":"Promise to Pay","communication_type_id":"2","communication_type":"E-mail","note":"Payment arrangement of R1000 to be paid off on outstanding school fees","status":"Created","promise_to_pays": [ {"promise_to_pay_id":"8","date_promised":"2024-03-31","amount_promised":"1000.00","amount_paid":"1000.00","promise_completed":"Yes" }, {"promise_to_pay_id":"10","date_promised":"2024-04-30","amount_promised":"1000.00","amount_paid":"750.00","promise_completed":"Partial" }, {"promise_to_pay_id":"12","date_promised":"2020-05-31","amount_promised":"1000.00","amount_paid":"","promise_completed":"No" } ] }]
{"error":"Not Found","error_description":"The note does not exist"}
{"error":"Unauthorized","error_description":"Client access not authorised"}
{"error":"Integration not activated","error_description":"Please activate the Admin+ API for this client before making this request"}