Kaizen #11 - The $Properties in Zoho CRM #API
Hello everyone!
Welcome back to yet another post in the Kaizen series!
This week, we will discuss the $Properties in Zoho CRM .
What will you learn from this post?
- What are $properties?
- $properties common to all the modules
- Module-specific $properties
1. What are the $properties?
The $properties represent the derived properties of a record in Zoho CRM. They are not available as fields in Zoho CRM. For instance, $converted —It represents the state of a lead or a quote. If you convert a lead or a quote into a contact/account (or) a sales order/invoice, the value for $converted becomes true.
Since they are derived, you cannot set these properties while creating or updating leads/quotes.
2. $properties common to all the modules
All the $properties are read-only keys.
$Property | Description |
$currency_symbol string | Represents the corresponding currency symbol of the currency chosen. For instance, for Dollars, the currency symbol would be— "$currency_symbol": "USD" |
$review_process JSON object | Represents the current state of the record in the review process. For instance, if the record is resubmitted— "$review_process": { "approve": false, "reject": false, "resubmit": true } |
$review string | Represents the review status of the record. null - The record does not come under the review process. approved - The record is approved. unreviewed - The record is yet to be reviewed. |
$process_flow boolean | Represents if the record is in blueprint data. true - The record is a blueprint data. false - The record is not associated with any blueprint. |
$approved boolean | Represents if the record is approved or not. true - The record is approved. false - The record is not approved. |
$approval JSON object | Represents if the current user can approve the record in approval. For instance, if the current user can approve the record— "$approval": { "delegate": true, "approve": true, "reject": true, "resubmit": false } |
$editable boolean | Represents if the record is editable or not. true - Record can be edited. false - Record cannot be edited. |
3. Module-Specific $properties
Except $send_notification and $line_tax, all the other module-specific $properties are read-only keys.
Property Details | Description |
$converted boolean | Represents the state of a lead/quote. true - The record is converted. false - The record is not converted. Modules - Leads, Quotes HTTP Method - GET |
$converted_detail JSON object | Represents conversion details of a lead. "$converted_detail": { "deal": null, "convert_date": "2019-12-17T01:58:25+05:30", "contact": "4150868000000939001", "converted_by": "4150868000000225013", "account": "4150868000000413103" } Modules - Leads HTTP Method - GET |
$followers JSON Array | Represents the details of the followers of that deal. "$followers": [ { "name": "User_1901", "id": "4150868000000225013" } ] Modules - Deals HTTP Method - GET |
$followed boolean | Represents if the current user is following that particular deal or not. true - The current user is following the deal. false - The current user is not following the deal. Modules - Deals HTTP Method - GET |
$se_module string | Represents to which module a task, event, or call is related to. It depends on the value stored in the "Related to" field. "$se_module": "Leads" Modules - Tasks, Events, Calls HTTP Method - GET |
$calender_booking_event boolean | Represents if the event is a calendar booking event. true - It is a calendar booking event. false - It is not a calendar booking event. Modules - Events HTTP Method - GET |
$recurrence_id string | Represents the unique ID of the recurrence rule. "$recurrence_id": "4150868000000383036" Modules - Events HTTP Method - GET |
$u_id string | Represents the unique ID of the recurring event. "$u_id": "4150868000000383036" Modules - Events HTTP Method - GET |
$meeting_details JSON object | Represents the details of the online meeting. "$meeting_details": { "tool_name": "ZohoMeeting", } Modules - Events HTTP Method - GET |
$send_notification boolean | You can set if an email notification has to be sent to all the participants of the event or not. true - Send notification to all the participants of the event. false - Do not send a notification to all the participants of the event. Modules - Events HTTP Method - GET, POST, PUT |
$calender_booking_call boolean | Represents if the call is a calendar booking call. true - It is a calendar booking call. false - It is not a calendar booking call. Modules - Calls HTTP Methods - GET |
$taxable boolean | true - The inventory line item is taxable. false - The inventory line item is not taxable. Modules - Products HTTP Methods - GET |
$line_tax JSON Array | "$line_tax": [ { "percentage": 0, "name": "Sales Tax", "id": null, "value": 0 }, { "percentage": 0, "name": "Vat", "id": null, "value": 0 } ] Modules - Quotes, Invoices, Sales Orders, Purchase Orders HTTP Method - GET, POST |
We hope you found this post useful. Please reach out to us if you have any questions, or let us know in the comment section.
We wish you all a happy new year!
Cheers!
Previous 'Kaizen' - Search Records API and Query API
Next 'Kaizen' - Bulk Read API
Zoho Developer Community
New to Zoho LandingPage?
Zoho LandingPage Resources
New to Zoho Survey?
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Bigin?
Topic Participants
Sneha Sridharan
Sticky Posts
Extension pointers for integrating Zoho CRM with Zoho products #8: Upload and manage Zoho Workdrive folders and files from within Zoho CRM
Keeping records on your customers and business prospects is essential for tracking data, conducting follow-ups, and running a business smoothly. When you use two separate applications, and store relevant data in each, checking and tracking data becomesExtension pointers: Handle cases with personalized solutions using custom actions
In our last post, we detailed the steps involved in creating a custom action and the workflow from the developer and end user's side. Now let's look at a working example of how we can create a custom action and implement it in a Zoho CRM account to makeExtension pointers - Simple yet significant pointers #13: On change of field value for CRM variables
CRM variables provide global access to a variable across an entire extension. They also help in the storage of user-specific data provided by the user at the time of installation, which can later be fetched to perform data functionalities. Additionally,Extension pointers: Extend end-user benefits and allow personalization by implementing extensions with custom actions
From our earlier post on custom actions, we know that we can create templated actions, share them with end users, and allow them to reuse those actions to achieve personalized outcomes. In this post, we'll look at how custom actions make it easy for usersExtension pointers - Simple yet significant pointers #12: Functions for Zoho CRM extensions
Functions are essential in achieving logical functionality for an extension. You can easily code your functions in Deluge using drag-and-drop tools to meet your requirements. How to create functions for Zoho CRM extensions in Sigma Go to Sigma and select
New to Zoho TeamInbox?
Zoho TeamInbox Resources
Zoho DataPrep Resources
Zoho CRM Plus Resources
Zoho Books Resources
Zoho Subscriptions Resources
Zoho Projects Resources
Zoho Sprints Resources
Qntrl Resources
Zoho Creator Resources
Zoho WorkDrive Resources
Zoho Campaigns Resources
Zoho CRM Resources
Design. Discuss. Deliver.
Zoho Show Resources
Get Started. Write Away!
Writer is a powerful online word processor, designed for collaborative work.
Zoho CRM コンテンツ
-
オンラインヘルプ
-
Webセミナー
-
機能活用動画
-
よくある質問
-
Ebook
-
-
Zoho Campaigns
- Zoho サービスのWebセミナー