Get Note Type(s)
GET
/v2/finplus/debtmanagement/debtornotes/notetypes
(/{id})
This endpoint retrieves a list of available debtor note types.
Debtor Notes consist of three types: Internal Note, Text Note, and Promise to Pay Arrangement.
Internal Note: As the name suggests, this is an internal record for the school. It allows staff to document conversations and interactions with debtors for reference.
Text Note: Similar to an internal note, but with the distinction that it is typically printed on the debtorβs statement.
Promise to Pay Arrangement: This represents a commitment from the debtor to make specific payments on agreed-upon dates. The system records these arrangements and provides reminders to the school for follow-ups.
Path Parameters
{id}
Integer
Optionally provide the Note Type 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.
Response Examples
Status: 200 OK