POS sale line items
A line of a POS sale with a product and the quantity sold at the register.
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 | |
| Item | productitemId | Reference | ||
| Quantity | quantity | Quantity | Quantity in the catalog unit after any unit conversion on the line. | |
| Material | materialId | Reference | ||
| Catalog | catalog | Constant | Yes | Fixed option from the allowed set for this field. |
| Unit | catalogunit | Unit | ||
| Dimensions | dimensions | Dimensions | Size of the piece sold when the catalog is a material. | |
| Unit price | unitPrice | Unit price | Price for one unit, before line discount. Includes tax only when the document price basis is gross. | |
| Discount | discount | Unit price | Yes | Amount in the document or line currency. |
| Amount | amount | Unit price | Monetary amount in the applicable currency for this record. | |
| Subtotal | subtotal | Unit price | Yes | Line amount before tax. |
| Tax | 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 | Line amount after tax and withholding. |
| 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 | owned by |
Actions
What you can do with a record. Every action also sends the webhook event storepossaleitems.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new line item. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this line item. | App · API · MCP · CLI |
| Delete | delete | Delete this line item and the data that belongs with it. This cannot be undone. | App · WebMCP · API · MCP · CLI |