Sales deals
A sales opportunity with a customer, tracked through the stages of a sales pipeline by value, probability, and time in stage.
- API name:
salesdeals - Domain: Sales
- Modules: Sales analytics, Sales
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 | ||
| Number | uid | Text | The number is a human-readable, unique identifier for the record. | |
| Day | date | Date | Calendar date for this value. | |
| Inquiry | salesinquiryId | Reference | ||
| Customer | customerId | Reference | Yes | |
| Branch | customerbranchId | Reference | ||
| Primary contact | customercontactId | Reference | ||
| Seller | userId | User | ||
| Pipeline | salespipelineId | Reference | Yes | |
| Stage | salespipelinestageId | Reference | Yes | |
| Campaign | salescampaignId | Reference | ||
| Expected close date | dateExpectedClose | Date | Calendar date when the deal is expected to close. | |
| Cadence | cadence | Constant | Commercial recurrence of the deal (one-time or recurring revenue or service). | |
| Priority | priority | Constant | Yes | Whole number without fractional part. |
| Amount | amount | Currency | Expected financial value or revenue of the deal. | |
| Quote currency | currency | Constant | Yes | Value from the table catalog for this field. |
| Win probability (%) | probability | Percent | Yes | Estimated chance of closing, seeded from the selected stage (0 to 1). You can adjust it afterward. |
| Cancellation reason | cancelReason | Option (Select) | Why the deal was canceled. Required when status is canceled; references an organization-defined option. | |
| Tags | tagIds | Tags | ||
| Description | description | Text Area | ||
| 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 | |
| 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 |
|---|---|---|
Inquiry salesinquiryId | Sales inquiries | reference |
Customer customerId | Customers | reference |
Branch customerbranchId | Customer branches | reference |
Primary contact customercontactId | Customer contacts | reference |
Seller userId | Users | reference |
Pipeline salespipelineId | Sales pipelines | reference |
Stage salespipelinestageId | Sales pipeline stages | reference |
Campaign salescampaignId | Sales campaigns | reference |
Tags tagIds | Tags | reference |
Actions
What you can do with a record. Every action also sends the webhook event salesdeals.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new deal. | App · API · MCP · CLI |
| Edit | update | Save changes to this deal. | App · API · MCP · CLI |
| Create quote | createQuote | Create a quote from this deal. | App · API · MCP · CLI |
| Block | block | Stop edits and deletion of this deal. 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 deal again. | App · API · MCP · CLI |
| Archive | archive | Retire this deal 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 deal to active lists and actions. | App · API · MCP · CLI |
| Delete | delete | Delete this deal 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.
Events
Moments the record reaches on its own. Subscribe to them with a webhook.
| Name | Webhook event | Description |
|---|---|---|
| Stage overdue | salesdeals.stageOverdue | The deal stayed in its pipeline stage longer than the stage allows. |