NoteModel
A note is a customizable text string that can be attached to various account attributes
within Lockstep. You can use notes for internal communication, correspondence with
clients, or personal reminders. The Note Model represents a note and a number of
different metadata attributes related to the creation, storage, and ownership of the note.
See Extensibility for more information.
Methods
The following API methods use this data model.
Read-Only Fields
These fields are assigned by the API server and cannot be changed.
noteId
uuid, read-only
The unique ID of this record, automatically assigned by Lockstep when this record is
added to the Lockstep platform.
groupKey
uuid, read-only
The GroupKey uniquely identifies a single Lockstep Platform account. All records for this
account will share the same GroupKey value. GroupKey values cannot be changed once created.
For more information, see Accounts and GroupKeys.
tableKey
string, read-only, 1-40 characters
A Note is connected to an existing item within the Lockstep Platform by the fields TableKey
and
ObjectKey
. For example, a Note connected to Invoice 12345 would have a TableKey
value of
Invoice
and an ObjectKey
value of 12345
.
The TableKey
value contains the name of the table within the Lockstep Platform to which this metadata
is connected.
For more information, see linking metadata to an object.
objectKey
uuid, read-only, min 1 characters
A Note is connected to an existing item within the Lockstep Platform by the fields TableKey
and
ObjectKey
. For example, a Note connected to Invoice 12345 would have a TableKey
value of
Invoice
and an ObjectKey
value of 12345
.
The ObjectKey
value contains the primary key of the record within the Lockstep Platform to which this
metadata is connected.
For more information, see linking metadata to an object.
isArchived
boolean, read-only
A flag indicating whether this Note is archived (also known as hidden or deleted). When you call
ArchiveNote this field will
be set to true.
You should avoid displaying Notes with the IsArchived field set to true in your user interface.
created
date-time, read-only
The date the note was created
createdUserId
uuid, read-only
The unique ID of the UserAccount of the user
who created this Note.
modified
date-time, read-only
The date this note was last modified
modifiedUserId
uuid, read-only
The ID of the user who last modified this note
createdUserName
string, nullable, read-only
The name of the user who created the note
appEnrollmentId
uuid, nullable, read-only
The AppEnrollmentId of the application that imported this record. For accounts
with more than one financial system connected, this field identifies the originating
financial system that produced this record. This value is null if this record
was not loaded from an external ERP or financial system.
Required Fields
noteText
string, 1-1000 characters
The full text of the note
Optional Fields
noteType
string, nullable, max 30 characters
The type of the note
recipientName
string, nullable, max 99 characters
The person to whom this note is intended for.
Updated 20 days ago