Goods receipt notes
A numbered document for a partial or complete goods receipt against a plan.
- API name:
inventoryreceiptnotes - Domain: Inventory
- Modules: Inventory analytics, Inventory
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Goods receipt | inventoryreceiptId | Reference | Yes | |
| Name | label | Text | ||
| Note number | uid | Text | The number is a human-readable, unique identifier for the record. | |
| Day | date | Date | Yes | Calendar date for this value. |
| Project | projectId | Reference | ||
| User | userId | User | ||
| Reference | reference | Text | ||
| Tags | tagIds | Tags | ||
| Description | description | Text Area | ||
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Processed by | processedBy | User | ||
| Processed at | processedAt | Date and Time | ||
| Canceled by | canceledBy | User | ||
| Canceled at | canceledAt | Date and Time | ||
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Relations
Owned records (solid line) are deleted with their owner. Grouped records (dashed line) can exist alone.
| Field | Points to | Kind |
|---|---|---|
Goods receipt inventoryreceiptId | Goods receipts | grouped by |
Project projectId | Projects | reference |
User userId | Users | reference |
Tags tagIds | Tags | reference |
Actions
What you can do with a record. Every action also sends the webhook event inventoryreceiptnotes.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new goods receipt note. | App · API · MCP · CLI |
| Edit | update | Save changes to this goods receipt note. | App · API · MCP · CLI |
| Process | process | Post this goods receipt note. You cannot undo it. | App · API · MCP · CLI |
| Reverse | cancel | Reverse the stock movement of this receipt note. | App · API · MCP · CLI |
| Block | block | Stop edits and deletion of this goods receipt 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 goods receipt note again. | App · API · MCP · CLI |
| Archive | archive | Retire this goods receipt 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 goods receipt note to active lists and actions. | App · API · MCP · CLI |
| Delete | delete | Delete this goods receipt note and the data that belongs with it. This cannot be undone. | App · API · MCP · CLI |
States
How a record moves from state to state. Archive and block can happen in any state.