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 the COQL and BULK APIs 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. |
| Owner_Id | String | False |
Identifier of the user who owns the deal. |
| Owner_FirstName | String | True |
First name of the user who owns the deal. |
| Owner_LastName | String | True |
Last name of the user who owns the deal. |
| Owner_Email | String | True |
Email address of the user who owns the deal. |
| Amount | Decimal | False |
Total monetary value of the deal. |
| Deal_Name | String | False |
Name assigned to the deal. |
| Closing_Date | Date | False |
Scheduled closing date of the deal. |
| Account_Name_Id | String | False |
Identifier 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. |
| Expected_Revenue | Decimal | True |
Expected revenue from the deal based on the probability and amount. |
| Next_Step | String | False |
Planned next action for progressing the deal. |
| Lead_Source | String | False |
Source from which the deal originated. |
| Campaign_Source_Id | String | False |
Identifier of the campaign linked to the deal. |
| Contact_Name_Id | String | False |
Identifier of the primary contact associated with the deal. |
| Created_By_Id | String | False |
Identifier of the user who created the deal. |
| Modified_By_Id | String | False |
Identifier of the user who last modified the deal. |
| Modified_By_FirstName | String | True |
First name of the user who last modified the deal. |
| Modified_By_LastName | String | True |
Last name of the user who last modified the deal. |
| Modified_By_Email | String | True |
Email address of the user who last modified the deal. |
| Created_Time | Datetime | False |
Date and time when the deal was created. |
| Modified_Time | Datetime | False |
Date and time when the deal was last modified. |
| Last_Activity_Time | Datetime | True |
Date and time of the most recent activity related to the deal. |
| Lead_Conversion_Time | Int | True |
Number of days taken to convert the lead into a deal. |
| Sales_Cycle_Duration | Int | True |
Duration of the sales cycle in days. |
| Overall_Sales_Duration | 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. |
| Pipeline | String | False |
Pipeline that categorizes the deal into a specific sales or workflow path. |
| Id_CustomModule | Long | True |
Internal system identifier for the deal record. |
| Change_Log_Time__s | Datetime | True |
Timestamp of the last change made to the deal. |
| Locked__s | Bool | True |
Indicates whether the deal record is locked from editing. |
| Reason_For_Loss__s | String | False |
Reason provided for losing the deal, if applicable. |
| Record_Status__s | String | False |
Internal system status representing the current lifecycle/state of the deal record. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description |
| DuplicateCheckFields | String |
The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field. |
| Trigger | String |
To trigger the rule while inserting record into CRM account. |