Goods receipts
A plan to receive inbound inventory at one site, confirmed through goods receipt notes.
- API name:
inventoryreceipts - Domain: Inventory
- Modules: Inventory analytics, Purchasing analytics, Sales, Inventory, Purchasing
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Name | label | Text | ||
| Receipt number | uid | Text | The number is a human-readable, unique identifier for the record. | |
| Day | date | Date | Yes | Calendar date for this value. |
| User | userId | User | ||
| Record | tableUid | Constant | Business table this row points to. | |
| Record ID | recordId | Reference | ||
| Close reason | closeReason | Constant | Value from the table catalog for this field. | |
| Tags | tagIds | Tags | ||
| Description | description | Text Area | ||
| Data | data | Data | ||
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Posted by | processedBy | User | ||
| Posted at | processedAt | Date and Time | ||
| Closed by | closedBy | User | ||
| Closed at | closedAt | 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.
Actions
What you can do with a record. Every action also sends the webhook event inventoryreceipts.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new goods receipt. | App · API · MCP · CLI |
| Edit | update | Save changes to this goods receipt. | App · API · MCP · CLI |
| Post | process | Post this goods receipt. You cannot undo it. | App · API · MCP · CLI |
| Close | close | Close this short receipt. The received quantity stays below the plan, and the remainder is not received. | App · API · MCP · CLI |
| Reopen | unclose | Allow new references to this goods receipt again. | App · API · MCP · CLI |
| Cancel | cancel | Reverse the posted effect of this goods receipt. | App · API · MCP · CLI |
| Block | block | Stop edits and deletion of this goods receipt. 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 again. | App · API · MCP · CLI |
| Archive | archive | Retire this goods receipt 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 to active lists and actions. | App · API · MCP · CLI |
| Delete | delete | Delete this goods receipt 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.