Notes
A comment on one business item in one module.
- API name:
notes - Domain: Features
- Modules: Sales analytics, Finance analytics, Inventory analytics, Manufacturing analytics, Purchasing analytics, Sales, Stores, Services, Finances, Inventory, Manufacturing, Purchasing, Logistics, Human resources, Employee portal, Point of sale, Site operations, My workspace, Master data, Directory, Administration
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Description | description | Text Area | ||
| User | userId | User | Yes | |
| Record | tableUid | Constant | Yes | Business table this row points to. |
| Record ID | recordId | Text | Yes | |
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Relations
| Field | Points to | Kind |
|---|---|---|
User userId | Users | reference |
Actions
What you can do with a record. Every action also sends the webhook event notes.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new note. | App · API · MCP · CLI |
| Edit | update | Save changes to this note. | App · API · MCP · CLI |
| Block | block | Stop edits and deletion of this note. It stays visible and can still appear on existing documents. Unblock to edit again. | App · API · MCP · CLI |
| Unblock | unblock | Allow edits and deletion of this note again. | App · API · MCP · CLI |
| Archive | archive | Retire this note from daily use. It leaves active lists and pickers, and most actions stop. Unarchive to restore it. | App · API · MCP · CLI |
| Restore | unarchive | Return this note to active lists and actions. | App · API · MCP · CLI |
| Delete | delete | Delete this note and the data that belongs with it. This cannot be undone. | App · API · MCP · CLI |