Last updated
Last updated
PATCH
https://integrate.d6plus.co.za/api/v1/finplus/debtmanagement/debtornotes/notes/{school_login_id}
Use this endpoint to update an existing debtor note for the specified school.
The note_id
is required and can be found using the call.
If you need to update the payment arrangements attached to a promise-to-pay note, you must include the updated data in the promise_to_pays
array (see below for more information). To update an existing promise-to-pay's data, the promise_to_pay_id
needs to be included. This can be found either under the call or the . If a promise_to_pay_id
is not included, a new promise-to-pay will be created. The API will not allow a promise-to-pay to be added to the note if the date_promised
and amount_promised
matches an existing record.
To restore a deleted note, provide the note_id
and set the status
to "Created".
To see more information about the individual fields, please refer to the page.
school_login_id*
Integer
The login ID of the school to retrieve data from
HTTP-X-USERNAME*
String
As provided by d6
HTTP-X-PASSWORD*
String
As provided by d6
note_id*
Integer
The id of the debtor note
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