POST
/v2/finplus/debtmanagement/debtornotes/notes
Use this endpoint to create a new debtor note for a specified school.
Accountable Person: The note must be linked to an accountable person, requiring an accountable_person_id
. This ID can be retrieved using either the or calls.
Note Date: The date
of the note must be in "YYYY-MM-DD" format and must fall between the start of last year and the end of next year.
Note Type: The note_type_id
is required and can be retrieved using the call.
Communication Type: The communication_type_id
is required for all note types except Internal Notes. This ID can be obtained using the call.
Note Content: The actual text of the note should be provided in the note
field.
Promise to Pay Notes:
If creating a Promise to Pay note (note_type_id: 2
), payment arrangement details must be included under the promise_to_pays
array.
A Promise to Pay requires:
date_promised
: A date between the start of this year and the end of next year.
amount_promised
: A numeric value without a currency symbol (e.g., "100.00"
).
The amount_paid
value and the promise_completed
flag may only be set by the school.
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.
accountable_person_id
*
Integer
The id of the accountable person who the note belongs to.
date
*
String
The date of the note in "yyyy-mm-dd" format.
note_type_id
*
Integer
The id of the note type.
communication_type_id
Integer
The id of the communication type (not required for internal notes).
note
String
The note text
promise_to_pays
Array
An array of payment arrangement data for promise-to-pay notes
Status: 201 Created