Sales order line items
A line of a sales order, with the product, quantity, price, and other commercial terms to be fulfilled.
- API name:
salesorderitems - Domain: Sales
- Modules: Sales analytics, Sales, 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 | |
| Order | salesorderId | Reference | Yes | |
| Position | rank | Order rank | Yes | |
| Item | productitemId | Reference | ||
| Quantity | quantity | Quantity | Quantity in the catalog unit after any unit conversion on the line. | |
| Shipped quantity | quantityShipped | Quantity | Yes | Quantity in the catalog unit after any unit conversion on the line. |
| Quantity reserved | quantityReserved | Quantity | Yes | Quantity in the catalog unit after any unit conversion on the line. |
| Confirmed quantity | quantityConfirmed | Quantity | Yes | Quantity in the catalog unit after any unit conversion on the line. |
| Billable quantity | quantityBillable | Quantity | Yes | Quantity in the catalog unit after any unit conversion on the line. |
| Invoiced quantity | quantityInvoiced | Quantity | Yes | Quantity in the catalog unit after any unit conversion on the line. |
| Item | serviceitemId | Reference | ||
| Item | customitemId | Reference | ||
| Material | materialId | Reference | ||
| Catalog | catalog | Constant | Yes | Fixed option from the allowed set for this field. |
| Unit | catalogunit | Unit | ||
| Line item | salesquoteitemId | Reference | ||
| Line item | salesagreementitemId | Reference | ||
| Demand | projectdemandId | Reference | ||
| Budget line | projectbudgetlineId | Reference | ||
| Dimensions | dimensions | Dimensions | Size of the piece sold or bought when the catalog is a material. | |
| Supply mode | supplyMode | Constant | Yes | Fixed option from the allowed set for this field. |
| Discount (%) | discountPercent | Percent | Yes | Share of the extended price taken off the line, before tax. Stored as a fraction from 0 to 1. |
| Billing due since | dateBillingDue | Date | Date since which this line has billable quantity that is not invoiced yet. Set by the system; empty when nothing is left to bill. | |
| Unit price | unitPrice | Unit price | Price for one unit, before line discount. Includes tax only when the document price basis is gross. | |
| Price source | priceSource | Constant | Shows whether the unit price is manual, from a price list, or from a contract. | |
| Amount | amount | Unit price | Monetary amount in the applicable currency for this record. | |
| Header discount | amountHeaderDiscount | 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. |
| 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 | Document total after discounts, tax, and withholding in document currency. |
| Fulfillment site | siteIdFulfillment | Reference | ||
| Price list | salespricelistId | Reference | List the price came from. Empty when the price was typed. | |
| 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 | |
| Approved by | approvedBy | User | ||
| Approved at | approvedAt | 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 |
|---|---|---|
Order salesorderId | Sales orders | owned by |
Line item salesquoteitemId | Sales quote line items | reference |
Line item salesagreementitemId | Framework agreement line items | reference |
Demand projectdemandId | Project demands | reference |
Budget line projectbudgetlineId | Project budget lines | reference |
Fulfillment site siteIdFulfillment | Sites | reference |
Price list salespricelistId | Sales price lists | reference |
Actions
What you can do with a record. Every action also sends the webhook event salesorderitems.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new line item. | App · 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 · API · MCP · CLI |