Guides

Name / Description	Type / Format	Example
`noteDate` The date of the note	`string` date	`"2024-12-22"`
`noteText` Note text	`string`	`"string"`
`createdBy` The email address of the user that create the Note	`string`	`"string"`
`updatedBy` The email address of the user that last updated the Note	`string`	`"string"`
`type`	`string`	`"General"` `"NewStarterStatement"` `"RtwProof"` `"P45"`
`documentCount` The number of attachments associated with this model	`integer` int32	`0`
`documents` The attachments associated with this model	`Item[]`	`{Item}`
`employee`	`Item`	`{Item}`
`id` The unique id of the object	`string` uuid	`"string"`

JSON Example

{
  "noteDate": "2024-12-22",
  "noteText": "string",
  "createdBy": "string",
  "updatedBy": "string",
  "type": "General",
  "documentCount": 0,
  "documents": [
    {
      "id": "string",
      "name": "string",
      "metadata": {},
      "url": "string"
    }
  ],
  "employee": {
    "id": "string",
    "name": "string",
    "metadata": {},
    "url": "string"
  },
  "id": "string"
}

References

Contained in Models

- none -

Consumed by Operations
Create Note
Update Note

Returned by Operations
Get Note
Update Note