Deals

Response Structure


   {
    "data": [
        {
            "Owner": { //Name, ID, and Email of the owner of the Deal
               
                "name": "Patricia Boyle",
                
                "id": "4150868000000225013",
                
                "email": "sneha.ss@zohocorp.com"
            },
            
            "Description": "This is a sample description.", //Description of the case
            
            "$currency_symbol": "DA", //Represents the symbol of the currency of the deal amount
            
            "Campaign_Source": { //Represents the name and ID of the campaign if the deal is related to one.
               
                "name": "Sample",
                
                "id": "4150868000000584006"
            },
            
            "$review_process": { //Represents the review process details, if the deal was created in review mode.
               
                "approve": false,
                
                "reject": false,
                
                "resubmit": false
            },
            
            "$followers": null, //Each object represents the name and ID of the user who is following the deal.
            
            "Closing_Date": "2020-07-24", //The date on which the deal closes/is closed. This is a mandatory field.
            
            "Last_Activity_Time": "2020-07-01T15:11:53+05:30", //The date and time at which the record was last used in an operation 
            
            "$review": null, //Represents the review process details
            
            "Lead_Conversion_Time": 20, //The number of days taken to convert the lead into a Deal (if the Deal was created from a Lead).
            
            "$process_flow": false, //Represents if the record is a blueprint data
            
            "Deal_Name": "Sample Deal", //Name of the Deal. This is a mandatory field.
            
            "Exchange_Rate": 3, //Represents the exchange rate of the currency of the deal amount.
            
            "Expected_Revenue": 0, //Represents the expected revenue of the deal. The system calculates the value based on the amount and the Deal Stage that you specify. It is a read_only field. 
            
            "Currency": "DZD", //The currency in which the revenue is generated
            
            "Overall_Sales_Duration": 79, //Represents the average number of days taken for the Lead to be converted to a Deal, and then to be won. 
            
            "Stage": "Qualification", Represents the stage of the deal. It can be: Qualification, Needs Analysis, Value Proposition, Identify Decision Makers, and so on. You can customize these values based on your business model. This is a mandatory field.
            
            "Account_Name": { //Name and ID of the Account the Deal is associated with
               
                "name": "Zylker",
                
                "id": "4150868000002782004"
            },
            
            "id": "4150868000002782026", //Unique ID of the Deal
            
            "$approved": true, //Represents whether the record is approved
            
            "$approval": { //Represents if the current user can approve, delegate, reject, or resubmit the operations performed on this record
               
                "delegate": false,
                
                "approve": false,
                
                "reject": false,
                
                "resubmit": false
            },
            
            "Territory": [ //Represents the territories the deal is associated with.
                "Sample"
            ],
            
            "Amount": 1000, //Represents the value of the deal.
            
            "$followed": false, //Represents whether the current user follows this Deal
            
            "Probability": 10, //Represents the probability of deal closure.
            
            "Next_Step": "Sample",  //Represents the details of the next steps of the sales process (this may vary based on your business model).
            
            "$editable": true,  //Represents if the user can edit records in the module
            
            "$orchestration": false, //Represents if the deal is a part of orchestration process
            
            "Contact_Name": { //Name and ID of the Contact associated with the Deal
               
                "name": "Patricia Boyle",
                
                "id": "4150868000002780035"
            },
            
            "Sales_Cycle_Duration": 59, //Represents the average number of days taken for the deal to be won.
            
            "Type": "Existing Business", Represents the type of the deal. These values can be customized based on your business model.
            
            "Layout": { //Represents the layout details of the deal
               
                "name": "Standard",
                
                "id": "4150868000000091023"
            },
            
            "$in_merge": false,
            
            "Lead_Source": Advertisement", //Represents the source of the lead. These values can be customized based on your business model. 
            
            "Tag": [],  //List of tags associated with the record
            
            "$approval_state": "approved" //Represents if the deal is approved
        }
    ]
}

Note:

  • The fields beginning with "$" indicate that they do not appear on the Zoho CRM UI, but contain important data. They are read-only fields.
  • For more information about sample attributes, refer Get List of Records.