Sales quotes
A commercial offer with the products, prices, and terms proposed to a customer.
- API name:
salesquotes - 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 | ||
| Quote 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. |
| Project | projectId | Reference | ||
| Original quote | salesquoteIdRoot | Reference | ||
| Previous quote | salesquoteIdPrevious | Reference | ||
| Deal | salesdealId | Reference | ||
| Framework agreement | salesagreementId | Reference | ||
| Customer | customerId | Reference | Yes | |
| Branch | customerbranchId | Reference | ||
| Contact | customercontactId | Reference | ||
| Seller | userId | User | ||
| Delivery address | addressDelivery | Address | ||
| Product revision | productrevisionId | Reference | ||
| Quote currency | currency | Constant | Yes | Value from the table catalog for this field. |
| Revision | revision | Whole Number | Yes | Whole number without fractional part. |
| Customer reference | customerReference | Text | The customer's own reference for this document, such as their purchase order number. | |
| Concession rate | concessionRate | Percent | Yes | Share of list amount given as line and header discounts (0–1). |
| Price floor breached | isFloorBreached | Boolean | Yes | Set when approval runs. True if any line unit price is below the price list floor. |
| 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. | |
| Valid until | dateTo | Date | Last calendar date this record applies, if any. | |
| Payment term | financespaymenttermId | Reference | ||
| Sales terms | salestermsconditionId | Reference | ||
| Price basis | priceBasis | Constant | Yes | Whether unit prices include tax (gross) or exclude tax (net). |
| List amount | amountList | Currency | Yes | Sum of line extensions at list price before discounts. |
| Line discount | amountLineDiscount | Currency | Yes | Sum of line discounts before header discount is applied. |
| Header discount | amountHeaderDiscount | Currency | Yes | Total header-level discount allocated to lines. |
| Net amount | amountNet | Currency | Yes | Line totals after line discounts and before header discount allocation. |
| 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. |
| Decline reason | declineReason | Constant | Value from the table catalog for this field. | |
| Decline note | declineNote | Text Area | ||
| Close reason | forceCloseReason | Constant | Required explanation when closing despite open documents. | |
| 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 | |
| Sent by | sentBy | User | ||
| Sent at | sentAt | Date and Time | ||
| Confirmed by | confirmedBy | User | ||
| Confirmed at | confirmedAt | Date and Time | ||
| Rejected by | rejectedBy | User | ||
| Rejected at | rejectedAt | Date and Time | ||
| Closed by | closedBy | User | ||
| Closed at | closedAt | 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 |
|---|---|---|
Project projectId | Projects | reference |
Original quote salesquoteIdRoot | Sales quotes | reference |
Previous quote salesquoteIdPrevious | Sales quotes | reference |
Deal salesdealId | Sales deals | reference |
Framework agreement salesagreementId | Framework agreements | reference |
Customer customerId | Customers | reference |
Branch customerbranchId | Customer branches | reference |
Contact customercontactId | Customer contacts | reference |
Seller userId | Users | reference |
Product revision productrevisionId | Product revisions | 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 salesquotes.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new quote. | App · API · MCP · CLI |
| Edit | update | Save changes to this quote. | App · API · MCP · CLI |
| Decline | reject | The customer declines this quote revision. Choose the reason. | App · API · MCP · CLI |
| Send | send | Send the quote to the customer. When a line breaches the price floor, approval is required before send. | App · API · MCP · CLI |
| Close | close | Stop new references to this quote. It stays, and existing documents stay. Unclose to allow new references again. | App · API · MCP · CLI |
| Reopen | unclose | Allow new references to this quote again. | App · API · MCP · CLI |
| Revise | revise | Open a new revision of this quote. | App · API · MCP · CLI |
| Revoke external links | revoke | Revoke active external share links for this quote. | App · API · MCP · CLI |
| Create order | createOrder | Create a sales order from this quote. | App · API · MCP · CLI |
| Accept | confirm | The customer accepts this quote revision. | 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 quote. 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 quote again. | App · API · MCP · CLI |
| Archive | archive | Retire this quote 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 quote to active lists and actions. | App · API · MCP · CLI |
| Delete | delete | Delete this quote 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.