POS sale payments
A payment captured against a POS sale, with its payment method and execution data.
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Sale | storepossaleId | Reference | Yes | |
| Method | method | Constant | Yes | Fixed option from the allowed set for this field. |
| Treasury account | treasuryaccountId | Reference | ||
| Payment | financespaymentId | Reference | ||
| Amount | amount | Currency | Yes | Monetary amount in the applicable currency for this record. |
| Amount received | amountReceived | Currency | Yes | Amount in the document or line currency. |
| Change | amountChange | Currency | Yes | Amount in the document or line currency. |
| 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 | ||
| 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 |
|---|---|---|
Sale storepossaleId | POS sales | grouped by |
Treasury account treasuryaccountId | Treasury accounts | reference |
Actions
What you can do with a record. Every action also sends the webhook event storepossalepayments.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new pos payment. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this pos payment. | App · WebMCP · API · MCP · CLI |
| Block | block | Stop edits and deletion of this pos payment. It stays visible and can still appear on existing documents. Unblock to edit again. | App · WebMCP · API · MCP · CLI |
| Unblock | unblock | Allow edits and deletion of this pos payment again. | App · WebMCP · API · MCP · CLI |
| Archive | archive | Retire this pos payment from daily use. It leaves active lists and pickers, and most actions stop. Unarchive to restore it. | App · WebMCP · API · MCP · CLI |
| Restore | unarchive | Return this pos payment to active lists and actions. | App · WebMCP · API · MCP · CLI |
| Delete | delete | Delete this pos payment and the data that belongs with it. This cannot be undone. | App · WebMCP · API · MCP · CLI |