POS sales
An in-store sale at a register, with its lines, payments, stock issue, and customer invoice.
- API name:
storepossales - 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 | |
| Name | label | Text | ||
| Sale number | uid | Text | The number is a human-readable, unique identifier for the record. | |
| Day | date | Date | Yes | Calendar date for this value. |
| Register session | storecashregistersessionId | Reference | Yes | |
| Invoice | financesinvoiceId | Reference | ||
| Customer | customerId | Reference | Yes | |
| User | userId | User | ||
| POS terminal | posterminalId | Reference | Yes | |
| POS sale claim | storepossaleclaimId | Reference | ||
| Price basis | priceBasis | Constant | Yes | Whether unit prices include tax (gross) or exclude tax (net). |
| Amount paid | amountPaid | Unit price | Yes | Amount in the document or line currency. |
| Subtotal | subtotal | Unit price | Yes | Sum of line amounts before tax and withholding on this document. |
| Fiscal compliance | tax | Unit price | Yes | Tax amount for this scope, in document currency, from the configured tax engine. |
| Withholding | withholding | Unit price | Yes | Withholding tax amount retained on this scope, in document currency. |
| Total | total | Unit price | Yes | Document total after discounts, tax, and withholding in document currency. |
| 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 | |
| Processed by | processedBy | User | ||
| Processed at | processedAt | Date and Time | ||
| Sent by | sentBy | User | ||
| Sent at | sentAt | 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 |
|---|---|---|
Register session storecashregistersessionId | Register sessions | reference |
Invoice financesinvoiceId | Invoices | reference |
Customer customerId | Customers | reference |
User userId | Users | reference |
POS terminal posterminalId | POS terminals | reference |
POS sale claim storepossaleclaimId | POS sale claims | reference |
Tags tagIds | Tags | reference |
Actions
What you can do with a record. Every action also sends the webhook event storepossales.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new sale. | App · API · MCP · CLI |
| Edit | update | Save changes to this sale. | App · API · MCP · CLI |
| Send | send | Send this sale to the customer. | App · API · MCP · CLI |
| Process | process | Post this sale. You cannot undo it. | App · API · MCP · CLI |
| Cancel | cancel | Reverse the posted effect of this sale. | App · API · MCP · CLI |
| Block | block | Stop edits and deletion of this sale. 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 sale again. | App · API · MCP · CLI |
| Archive | archive | Retire this sale 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 sale to active lists and actions. | App · API · MCP · CLI |
| Delete | delete | Delete this sale and the data that belongs with it. This cannot be undone. | App · API · CLI |
States
How a record moves from state to state. Archive and block can happen in any state.