Deals
Stores information about sales opportunities, including stage, expected revenue, and related accounts or contacts.
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 deal owner. |
| DealOwner_LastName | String | True |
Last name of the deal owner. |
| DealOwner_Email | String | True |
Email address of the deal owner. |
| DealOwner_Name | String | True |
Full name of the deal owner. |
| Amount | Decimal | False |
Total value of the deal. |
| DealName | String | False |
Name or title of the deal. |
| ClosingDate | Date | False |
Expected date when the deal is closed. |
| AccountName_Id | String | False |
Identifier of the account associated with the deal. |
| AccountName_Name | String | True |
Name of the account linked to the deal. |
| Stage | String | False |
Current stage of the deal in the sales pipeline. |
| Type | String | False |
Classification of the deal, such as new business or existing customer. |
| Probability(%) | Int | False |
Estimated probability of closing the deal, expressed as a percentage. |
| ExpectedRevenue | Decimal | True |
Projected revenue expected from the deal. |
| NextStep | String | False |
Next planned action or follow-up step for the deal. |
| LeadSource | String | False |
Source from which the lead associated with the deal originated. |
| CampaignSource_Id | String | False |
Identifier of the campaign linked to the deal. |
| CampaignSource_Name | String | True |
Name of the campaign associated with the deal. |
| ContactName_Id | String | False |
Identifier of the primary contact associated with the deal. |
| ContactName_Name | String | True |
Name of the primary contact linked to the deal. |
| CreatedBy_Id | String | False |
Identifier of the user who created the deal record. |
| CreatedBy_FirstName | String | True |
First name of the user who created the deal record. |
| CreatedBy_LastName | String | True |
Last name of the user who created the deal record. |
| CreatedBy_Email | String | True |
Email address of the user who created the deal record. |
| CreatedBy_Name | String | True |
Full name of the user who created the deal record. |
| ModifiedBy_Id | String | False |
Identifier of the user who last modified the deal record. |
| ModifiedBy_FirstName | String | True |
First name of the user who last modified the deal record. |
| ModifiedBy_LastName | String | True |
Last name of the user who last modified the deal record. |
| ModifiedBy_Email | String | True |
Email address of the user who last modified the deal record. |
| ModifiedBy_Name | String | True |
Full name of the user who last modified the deal record. |
| CreatedTime | Datetime | False |
Timestamp indicating when the deal record was created. |
| ModifiedTime | Datetime | False |
Timestamp indicating when the deal record was last modified. |
| LastActivityTime | Datetime | True |
Timestamp of the most recent activity related to the deal. |
| LeadConversionTime | Int | True |
Number of days between lead creation and conversion to a deal. |
| SalesCycleDuration | Int | True |
Number of days taken to progress the deal through the sales cycle. |
| OverallSalesDuration | Int | True |
Total duration of the sales process from lead to closure. |
| Tag | String | False |
Comma-separated list of tags associated with the deal. |
| Description | String | False |
Detailed description or notes about the deal. |
| ChangeLogTime | Datetime | True |
Timestamp indicating when changes were last logged for the deal. |
| Locked | Bool | True |
Indicates whether the deal record is locked from further edits. |
| 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 |
Field or fields used to identify duplicate deals during an upsert. Multiple fields are supported in the REST API, but only one is allowed in the BULK API. |
| Trigger | String |
Specifies whether to trigger automation or workflow rules when inserting the record. |
| CustomViewId | Long |
Identifier of the custom view used to filter this record. Applies only when the useCOQL parameter is set to false. |