Register sessions
A cashier shift on one register: opening float, expected cash from movements, counted cash, and variance on close.
- API name:
storecashregistersessions - Domain: Retail
- Modules: Sales analytics, Stores
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Cash register | storecashregisterId | Reference | Yes | |
| Name | label | Text | ||
| Session number | uid | Text | The number is a human-readable, unique identifier for the record. | |
| Day | date | Date | Yes | Calendar date for this value. |
| Store manager | userId | User | Yes | |
| Opening amount | amountOpening | Currency | Yes | Amount in the document or line currency. |
| Expected amount | amountExpected | Currency | Amount in the document or line currency. | |
| Counted amount | amountCounted | Currency | Amount in the document or line currency. | |
| Variance | amountVariance | Currency | Amount in the document or line currency. | |
| 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 | |
| Closed by | closedBy | User | ||
| Closed at | closedAt | 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 |
|---|---|---|
Cash register storecashregisterId | Cash registers | grouped by |
Store manager userId | Users | reference |
Tags tagIds | Tags | reference |
Actions
What you can do with a record. Every action also sends the webhook event storecashregistersessions.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new register session. | App · API · MCP · CLI |
| Edit | update | Save changes to this register session. | App · API · MCP · CLI |
| Close | close | Count the cash and close this register session. You cannot reopen it. | App · API · MCP · CLI |
| Reopen | unclose | Allow new references to this register session again. | App · API · MCP · CLI |
| Block | block | Stop edits and deletion of this register session. 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 register session again. | App · API · MCP · CLI |
| Archive | archive | Retire this register session 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 register session to active lists and actions. | App · API · MCP · CLI |
States
How a record moves from state to state. Archive and block can happen in any state.