Sales orders
A confirmed commercial document for a sale, with its products, quantities, prices, and terms.
- API name:
salesorders - 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 | |
| Name | label | Text | ||
| Order number | uid | Text | The number is a human-readable, unique identifier for the record. | |
| Date | date | Date | Yes | Pricing date. Used to resolve applicable price lists. |
| Deal | salesdealId | Reference | ||
| Quote | salesquoteId | Reference | ||
| Framework agreement | salesagreementId | Reference | ||
| Project | projectId | Reference | ||
| Customer | customerId | Reference | Yes | |
| Branch | customerbranchId | Reference | ||
| Contact | customercontactId | Reference | ||
| Seller | userId | User | ||
| Delivery address | addressDelivery | Address | ||
| Quote currency | currency | Constant | Yes | Value from the table catalog for this field. |
| Product revision | productrevisionId | Reference | ||
| Customer reference | customerReference | Text | The customer's own reference for this document, such as their purchase order number. | |
| Credit check | creditcheckOutcome | Constant | Outcome of the customer credit exposure check for this approved order. | |
| Billing due since | dateBillingDue | Date | Earliest date since which a line of this order has billable quantity that is not invoiced yet. Set by the system; empty when nothing is left to bill. | |
| Fulfillment site | siteIdFulfillment | Reference | ||
| Delivery | delivery | Constant | Method and conditions for delivering goods. | |
| Incoterm | incoterm | Constant | Fixed option from the allowed set for this field. | |
| Incoterm place | incotermPlace | Text | ||
| Requested date | dateRequested | Date | Calendar date without time of date. | |
| Shipment policy | shipmentPolicy | Constant | Yes | Whether the order may ship in parts or only when complete. |
| Hold fulfillment | holdFulfillment | Boolean | Yes | When enabled, the related rule or behavior applies to this record. |
| Payment term | financespaymenttermId | Reference | ||
| Sales terms | salestermsconditionId | Reference | ||
| Price basis | priceBasis | Constant | Yes | Whether unit prices include tax (gross) or exclude tax (net). |
| Subtotal | subtotal | Currency | Yes | Sum of line amounts before tax and withholding on this document. |
| Tax | tax | Currency | Yes | Tax amount for this scope, in document currency, from the configured tax engine. |
| Withholding | withholding | Currency | Yes | Withholding tax amount retained on this scope, in document currency. |
| Total | total | Currency | Yes | Document total after discounts, tax, and withholding in document currency. |
| Force close reason | forceCloseReason | Constant | Required explanation when closing despite open documents. | |
| Credit release reason | releaseCreditReason | Text Area | Required when you release an order from credit hold. | |
| Cancel reason | cancelReason | Text Area | Required explanation when canceling this record. | |
| Tags | tagIds | Tags | ||
| Comments | comments | Text Area | Printed on the document. Use this field for the DOF exchange-rate clause or other commercial terms. | |
| 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 | |
| Approved by | approvedBy | User | ||
| Approved at | approvedAt | Date and Time | ||
| Closed by | closedBy | User | ||
| Closed at | closedAt | Date and Time | ||
| Canceled by | canceledBy | User | ||
| Canceled at | canceledAt | Date and Time | ||
| Credit released by | creditReleasedBy | User | ||
| Credit released | creditReleasedAt | 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 |
|---|---|---|
Deal salesdealId | Sales deals | reference |
Quote salesquoteId | Sales quotes | reference |
Framework agreement salesagreementId | Framework agreements | reference |
Project projectId | Projects | reference |
Customer customerId | Customers | reference |
Branch customerbranchId | Customer branches | reference |
Contact customercontactId | Customer contacts | reference |
Seller userId | Users | reference |
Fulfillment site siteIdFulfillment | Sites | reference |
Payment term financespaymenttermId | Payment terms | reference |
Sales terms salestermsconditionId | Sales terms and conditions | reference |
Tags tagIds | Tags | reference |
Actions
What you can do with a record. Every action also sends the webhook event salesorders.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add an new order. | App · API · MCP · CLI |
| Edit | update | Save changes to this order. | App · API · MCP · CLI |
| Approve | approve | Approve this order so the next step can run. | App · API · MCP · CLI |
| Close | close | Stop new references to this order. It stays, and existing documents stay. Unclose to allow new references again. | App · API · MCP · CLI |
| Reopen | unclose | Allow new references to this order again. | App · API · MCP · CLI |
| Cancel | cancel | Reverse the posted effect of this order. | App · API · MCP · CLI |
| Revoke external links | revoke | Revoke active external share links for this order. | App · API · MCP · CLI |
| Create invoice | createInvoice | Create an invoice from the lines of this order that are not billed yet. | App · API · MCP · CLI |
| Release credit | releaseCredit | Clear credit hold so this order can be reserved, shipped, or invoiced. | App · API · MCP · CLI |
| Reserve | reserve | Create a draft goods issue and reserve stock that is available. | App · API · MCP · CLI |
| Share externally | share | Publish and send an external link to this document. | App · API · MCP · CLI |
| Block | block | Stop edits and deletion of this order. 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 order again. | App · API · MCP · CLI |
| Archive | archive | Retire this order 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 order to active lists and actions. | App · API · MCP · CLI |
| Delete | delete | Delete this order and the data that belongs with it. This cannot be undone. | App · API · MCP · CLI |
States
How a record moves from state to state. Archive and block can happen in any state.