PATCH
/v2/finplus/debtmanagement/debtornotes/notes/{id}
Use this endpoint to update an existing debtor note for a specified school.
The note ID must be passed in the URL and can be retrieved using the call.
If you need to update the payment arrangements attached to a promise-to-pay note, include the updated data in the promise_to_pays
array (see details below).
To update an existing promise-to-pay entry, provide its promise_to_pay_id
. This ID can be retrieved using either the or call.
If a promise_to_pay_id
is not included, a new promise-to-pay entry will be created.
The API will not allow a duplicate promise-to-pay entry to be added if both date_promised
and amount_promised
match an existing record.
To restore a previously deleted note, provide the note_id
and set the status
field to "Created"
.
For a detailed explanation of individual fields, refer to the documentation.
{id}
*
Integer
The Note ID of the note to be updated
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
status
String
The status of the note (either "Created" or "Deleted")
promise_to_pays
Array
An array of payment arrangement data for promise-to-pay notes
Status: 200 OK