Notes service

Introducer Supplier

The following methods are in this service:

POST /instruction/{tmpReference}/note Introducer Supplier
PUT /instruction/{tmpReference}/readnotes Introducer Supplier

Create note

POST /instruction/{tmpReference}/note Introducer Supplier

This method will create a new note.

{
  visibleTo: [ "Customer", "Introducer" ],
  noteBody: { "This is a note" },
  caseNoteReference: "TMP-1293-N01"
}

INFO

All notes are visible to TMP.

You can specify "Customer" in the visibleTo property to make the property visible to the Customer.

Validation

Valid values for visibleTo are Customer, Introducer, Supplier. Notes created by Introducers are always visible to the Introducer and similarly notes Created by Suppliers are always visible to Suppliers. However, Introducers cannot normally send notes to the Supplier and the Supplier cannot send notes to the Introducer (and specifying the party in this situation would be ignored). You would send a note to TMP to pass onto the other party.
Maximum length of noteBody is 1000 characters.
Valid text in the body is Unicode.
caseNoteReference can be up to 30 characters but is not mandatory
A note cannot be added to a case that is read only.

INFO

The property caseNoteReference is returned in the method to retrieve an instruction. You can use it to determine if a note that you have created has already been added.

This property will be empty for notes that were created by other parties (e.g. Customer or TMP). You should use the sequence property of the InstructionNote object to determine if you have downloaded this already.

Configuration

Normally, Introducers cannot make notes visible to Suppliers and Suppliers cannot make notes visible to Customers. However, there are some circumstances where this is allowed, mainly where there is primary customer (e.g. a lender).

Mark notes as read

PUT /instruction/{tmpReference}/readnotes Introducer Supplier

This method will mark all notes that are currently unread as having been read.