API Docs / Schemas / NoteDto

NoteDto

A note attached to an entity such as a client or task

Properties

Name Type Description
codestring

The unique code for this note

The unique code for this note

textstring

The note text

The note text

datestring

The date/time of the note

The date/time of the note

noteFromUserCodeAndNameDto
pinnedLevelinteger

The pinned level for ordering pinned notes

The pinned level for ordering pinned notes

createdDatestring

When the note was created

When the note was created

updatedDatestring

When the note was last updated

When the note was last updated

stepNumberinteger

The workflow step number if this is a step-level note (null for task-level notes)

The workflow step number if this is a step-level note (null for task-level notes)

groupNumberinteger

The workflow group number if this is a step-level note (null for task-level notes)

The workflow group number if this is a step-level note (null for task-level notes)

stepNamestring

The name of the workflow step if this is a step-level note (null for task-level notes)

The name of the workflow step if this is a step-level note (null for task-level notes)

JSON Example

{
  "code": "string",
  "text": "string",
  "date": "2024-01-01T00:00:00Z",
  "noteFromUser": {
    "code": "string",
    "name": "string"
  },
  "pinnedLevel": 0
}

Used By Operations

Contained in Schemas