Get Note(s)
GET
/v2/finplus/debtmanagement/debtornotes/notes/
(/{id})
Use this endpoint to fetch one or more debtor note records for the specified school.
Deleted debtor notes are excluded by default but can be included by setting the optional include_deleted
query parameter.
Additionally, you can search for debtor notes using the debtor_code
, accountable_person_id
, and/or note_type_id
query parameters. To return notes for a specific year, use the year
query parameter.s
To include "Promise to Pay" records directly in the response, set the include_promise_to_pays
query parameter. The payment arrangement data will be included in a sub-array within each note.
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_limit
specified in the response'smeta
object.cursor: If the
meta
object contains anext_cursor
field, it indicates that more records are available. To fetch the next set of records, include thecursor
parameter in your request with the value ofnext_cursor
. If thenext_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.
Path Parameters
{id}
Integer
Optionally provide the Note ID for retrieving a single record.
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
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
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