Deals
Represents sales opportunities, tracking amount, probability, stage, and related contacts or accounts with full record-management capabilities.
Table-Specific Information
Select
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
Insert
INSERT INTO Deals (DealName, Stage) VALUES ('Converting company XYZ into our client.', 'Qualification')
Required fields: DealName.
Any field which is not read-only (ReadOnly = false in the table below) can be inserted.
Delete
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM Deals WHERE Id = '3152079000000153079'
Update
You must specify the Id in the WHERE clause when executing an update against this table.
UPDATE Deals SET Description = 'Updated from API' WHERE Id = '3152079000000153079'
Required fields: Id.
Any field which is not read-only (ReadOnly = false in the table below) can be updated.
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
Unique identifier for the deal record. |
| DealOwner_Id | String | False |
Identifier of the user who owns the deal. |
| DealOwner_FirstName | String | True |
First name of the user who owns the deal. |
| DealOwner_LastName | String | True |
Last name of the user who owns the deal. |
| DealOwner_Email | String | True |
Email address of the user who owns the deal. |
| DealOwner_Name | String | True |
Full name of the user who owns the deal. |
| Amount | Decimal | False |
Total monetary value of the deal. |
| DealName | String | False |
Name assigned to the deal. |
| ClosingDate | Date | False |
Scheduled closing date of the deal. |
| AccountName_Id | String | False |
Identifier of the account associated with the deal. |
| AccountName_Name | String | True |
Name of the account associated with the deal. |
| Stage | String | False |
Current stage of the deal in the sales process. |
| Type | String | False |
Type or category of the deal. |
| Probability(%) | Int | False |
Estimated probability of winning the deal, expressed as a percentage. |
| ExpectedRevenue | Decimal | True |
Expected revenue from the deal based on the probability and amount. |
| NextStep | String | False |
Planned next action for progressing the deal. |
| LeadSource | String | False |
Source from which the deal originated. |
| CampaignSource_Id | String | False |
Identifier of the campaign linked to the deal. |
| CampaignSource_Name | String | True |
Name of the campaign linked to the deal. |
| ContactName_Id | String | False |
Identifier of the primary contact associated with the deal. |
| ContactName_Name | String | True |
Name of the primary contact associated with the deal. |
| CreatedBy_Id | String | False |
Identifier of the user who created the deal. |
| CreatedBy_FirstName | String | True |
First name of the user who created the deal. |
| CreatedBy_LastName | String | True |
Last name of the user who created the deal. |
| CreatedBy_Email | String | True |
Email address of the user who created the deal. |
| CreatedBy_Name | String | True |
Full name of the user who created the deal. |
| ModifiedBy_Id | String | False |
Identifier of the user who last modified the deal. |
| ModifiedBy_FirstName | String | True |
First name of the user who last modified the deal. |
| ModifiedBy_LastName | String | True |
Last name of the user who last modified the deal. |
| ModifiedBy_Email | String | True |
Email address of the user who last modified the deal. |
| ModifiedBy_Name | String | True |
Full name of the user who last modified the deal. |
| CreatedTime | Datetime | False |
Date and time when the deal was created. |
| ModifiedTime | Datetime | False |
Date and time when the deal was last modified. |
| LastActivityTime | Datetime | True |
Date and time of the most recent activity related to the deal. |
| LeadConversionTime | Int | True |
Number of days taken to convert the lead into a deal. |
| SalesCycleDuration | Int | True |
Duration of the sales cycle in days. |
| OverallSalesDuration | Int | True |
Total duration from lead creation to deal closure in days. |
| Tag | String | False |
Tags associated with the deal for classification or filtering. |
| Description | String | False |
Detailed description of the deal. |
| RecordId | Long | True |
Internal system identifier for the deal record. |
| ChangeLogTime | Datetime | True |
Timestamp of the last change made to the deal. |
| Locked | Bool | True |
Indicates whether the deal record is locked from editing. |
| ReasonForLoss | String | False |
Reason provided for losing the deal, if applicable. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| DuplicateCheckFields | String |
Fields used to identify duplicate records during an upsert operation. The REST API supports multiple fields; the BULK API supports only one. |
| Trigger | String |
Indicates whether to trigger a rule when inserting the deal record into the CRM account. |
| CustomViewId | Long |
Custom view identifier used to filter this record. Works only when the useCOQL parameter is false. |