Cycle counts
A physical count of inventory at one location, compared with system quantities to find differences.
- API name:
inventorycyclecounts - 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 | |
| Name | label | Text | ||
| Count number | uid | Text | The number is a human-readable, unique identifier for the record. | |
| User | userId | User | ||
| Mode | mode | Constant | Yes | Blind is the default. Guided is stored on the count. Both modes hide the book quantity. |
| Result | result | Constant | Yes | Count outcome: pending, no discrepancies, or adjusted. |
| Location | sitelocationId | Reference | ||
| Zone | siteareaId | Reference | ||
| 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 | |
| Started by | startedBy | User | ||
| Started at | startedAt | Date and Time | ||
| Ended by | endedBy | User | ||
| Ended at | endedAt | Date and Time | ||
| 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.
| Field | Points to | Kind |
|---|---|---|
User userId | Users | reference |
Location sitelocationId | Site locations | reference |
Zone siteareaId | Site areas | reference |
Tags tagIds | Tags | reference |
Actions
What you can do with a record. Every action also sends the webhook event inventorycyclecounts.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new cycle count. | App · API · MCP · CLI |
| Edit | update | Save changes to this cycle count. | App · API · MCP · CLI |
| Start | start | Begin the count and capture the opening book at this location. | App · API · MCP · CLI |
| Post differences | process | Post the differences. This action is irreversible. | App · API · MCP · CLI |
| End | end | Complete the observation set and fill missing zero lines. | App · API · MCP · CLI |
| Close | close | Stop new references to this cycle count. It stays, and existing documents stay. Unclose to allow new references again. | App · API · MCP · CLI |
| Reopen | unclose | Allow new references to this cycle count again. | App · API · MCP · CLI |
| Cancel | cancel | Reverse the posted effect of this cycle count. | App · API · MCP · CLI |
| Set uncounted to 0 | zeroUncounted | Set uncounted baseline lines to quantity 0. | App · API · MCP · CLI |
| Block | block | Stop edits and deletion of this cycle count. 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 cycle count again. | App · API · MCP · CLI |
| Archive | archive | Retire this cycle count 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 cycle count to active lists and actions. | App · API · MCP · CLI |
| Delete | delete | Delete this cycle count 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.