Kaizen #11 - The $Properties in Zoho CRM #API

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",
        "joinmeeting_url": " https://meeting.zoho.com/join?key=1094205335 ",
    }

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
Represents if the inventory line item (product in inventory module) is taxable or not. 

true - The inventory line item is taxable.
false - The inventory line item is not taxable.

Modules - Products
HTTP Methods - GET
$line_tax
JSON Array
You can set the tax on individual product line items using this property.

 "$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! 

Next 'Kaizen' - Bulk Read API



    Access your files securely from anywhere







                            Zoho Developer Community





                                                  Use cases

                                                  Make the most of Zoho Desk with the use cases.

                                                   
                                                    

                                                  eBooks

                                                  Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho Desk.

                                                   
                                                    

                                                  Videos

                                                  Watch comprehensive videos on features and other important topics that will help you master Zoho Desk.

                                                   
                                                    

                                                  Webinar

                                                  Sign up for our webinars and learn the Zoho Desk basics, from customization to automation and more

                                                   
                                                    
                                                  • Desk Community Learning Series


                                                  • Meetups


                                                  • Ask the Experts


                                                  • Kbase


                                                  • Resources


                                                  • Glossary


                                                  • Desk Marketplace


                                                  • MVP Corner




                                                            • Sticky Posts

                                                            • Kaizen #197: Frequently Asked Questions on GraphQL APIs

                                                              🎊 Nearing 200th Kaizen Post – We want to hear from you! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.
                                                            • Kaizen #198: Using Client Script for Custom Validation in Blueprint

                                                              Nearing 200th Kaizen Post – 1 More to the Big Two-Oh-Oh! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.
                                                            • Celebrating 200 posts of Kaizen! Share your ideas for the milestone post

                                                              Hello Developers, We launched the Kaizen series in 2019 to share helpful content to support your Zoho CRM development journey. Staying true to its spirit—Kaizen Series: Continuous Improvement for Developer Experience—we've shared everything from FAQs
                                                            • Kaizen #193: Creating different fields in Zoho CRM through API

                                                              🎊 Nearing 200th Kaizen Post – We want to hear from you! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.
                                                            • Client Script | Update - Introducing Commands in Client Script!

                                                              Have you ever wished you could trigger Client Script from contexts other than just the supported pages and events? Have you ever wanted to leverage the advantage of Client Script at your finger tip? Discover the power of Client Script - Commands! Commands


                                                            Manage your brands on social media



                                                                  Zoho TeamInbox Resources



                                                                      Zoho CRM Plus Resources

                                                                        Zoho Books Resources


                                                                          Zoho Subscriptions Resources

                                                                            Zoho Projects Resources


                                                                              Zoho Sprints Resources


                                                                                Qntrl Resources


                                                                                  Zoho Creator Resources



                                                                                      Zoho CRM Resources

                                                                                      • CRM Community Learning Series

                                                                                        CRM Community Learning Series


                                                                                      • Kaizen

                                                                                        Kaizen

                                                                                      • Functions

                                                                                        Functions

                                                                                      • Meetups

                                                                                        Meetups

                                                                                      • Kbase

                                                                                        Kbase

                                                                                      • Resources

                                                                                        Resources

                                                                                      • Digest

                                                                                        Digest

                                                                                      • CRM Marketplace

                                                                                        CRM Marketplace

                                                                                      • MVP Corner

                                                                                        MVP Corner







                                                                                          Design. Discuss. Deliver.

                                                                                          Create visually engaging stories with Zoho Show.

                                                                                          Get Started Now


                                                                                            Zoho Show Resources


                                                                                              Zoho Writer Writer

                                                                                              Get Started. Write Away!

                                                                                              Writer is a powerful online word processor, designed for collaborative work.

                                                                                                Zoho CRM コンテンツ








                                                                                                  Nederlandse Hulpbronnen


                                                                                                      ご検討中の方




                                                                                                            • Recent Topics

                                                                                                            • create invoice in zoho books from the zoho forms

                                                                                                              Is there a native way to have create invoice in zoho books, when zoho form is completed?
                                                                                                            • Email undelivered

                                                                                                              GOod Day I am always receiving an uncategorized-bounce to my email. I am not sure why this is happening.
                                                                                                            • Add inventory_valuation_method to items endpooints

                                                                                                              To ensure consistent item creation it would be helpful to have the inventory_valuation_method (FIFO vs WAC) be able to be set at item creation or as an update (consistent with current behavior where it is not allowed for items with existing transactions)
                                                                                                            • Use Zoho to send sales receipts for Gocardless transactions

                                                                                                              I've been using gocardless for years and have d/d mandates set up on there. Each week we get bulk payments from customer d/d's. However, we need to send sales receipts to these customers. So I know I can sync mandates into Zoho, and then I can set up
                                                                                                            • Zoho - Gocardless sales receipts

                                                                                                              I've been using gocardless for years and have d/d mandates set up on there. Each week we get bulk payments from customer d/d's. However, we need to send sales receipts to these customers. So I know I can sync mandates into Zoho, and then I can set up
                                                                                                            • Introducing Rollup summary in Zoho CRM

                                                                                                              ------------------------------------------Moderated on 5th July'23---------------------------------------------- Rollup summary is now available for all organizations in all the DCs. Hello All, We hope you're well! We're here with an exciting update that
                                                                                                            • Introducing Connected Workflows in Zoho CRM for Everyone : Free Your Teams to Focus on What Matters

                                                                                                              Hello Everyone, We’re thrilled to introduce the next big evolution in Zoho CRM for Everyone -- Connected Workflows. This new feature builds on our commitment to deliver a CRM that’s truly inclusive, adaptable, and designed for consistent collaboration
                                                                                                            • Introducing Connected Records to bring business context to every aspect of your work in Zoho CRM for Everyone

                                                                                                              Hello Everyone, We are excited to unveil phase one of a powerful enhancement to CRM for Everyone - Connected Records, available only in CRM's Nextgen UI. With CRM for Everyone, businesses can onboard all customer-facing teams onto the CRM platform to
                                                                                                            • Cooling-off Period Just Got Better: More Coverage, More Control

                                                                                                              We’ve enhanced the Cooling-off Period feature in Zoho Recruit to give you more control over repeat applications and referrals. This helps you maintain a cleaner, more efficient recruitment pipeline. With this enhancement, you can: Prevent duplicate candidate
                                                                                                            • Revenue Management: #7 Revenue Recongition in Construction & Real Estate Industry

                                                                                                              If you are in the construction or real estate business, you are used to long project timelines and progressive invoicing to keep up with your billing. But when does revenue get recognized? Will it happen when the contract gets signed? At different milestones
                                                                                                            • TikTok (and other social platform) Messages and comments of the past

                                                                                                              When I link a social channel, Zoho will show in "Inbox", "Messages" and "Contact" sections the interaction done in the past? (comment, messages...)
                                                                                                            • Email Integration - Zoho CRM - OAuth and IMAP

                                                                                                              Hello, We are attempting to integrate our Microsoft 365 email with Zoho CRM. We are using the documentation at Email Configuration for IMAP and POP3 (zoho.com) We use Microsoft 365 and per their recommendations (and requirements) for secure email we have
                                                                                                            • How do I fix this? Unable to send message; Reason:554 5.1.8 Email Outgoing Blocked.

                                                                                                              How do I fix this? Unable to send message; Reason:554 5.1.8 Email Outgoing Blocked.
                                                                                                            • Restrict Employee mail deletion

                                                                                                              Dear Zoho, Is there a way where i can restrict my employees to delete any mails from their account
                                                                                                            • 554 5.1.8 Email Outgoing Blocked.

                                                                                                              Hi guys, I just singed up for mateusz.nowicki@zoho.com mail and I can't send any mails.. Why? Everytime I try to send something I got error like the one in the screenshot. Please, help me.
                                                                                                            • Zoho IP blocked by SpamHaus

                                                                                                              ERROR CODE :550 - 5.7.0 Your server IP address is in the SpamHaus SBL-XBL database, bye
                                                                                                            • File Upload in Creator's Subfrom

                                                                                                              Hello Sir/Madam, Here is a Problem......... Scenario: In CRM One Custom Module (Payments) have one File Upload Field now we have to Upload that File into Creator's Custom Form (Documents) have one Subform (Documents) in Document Upload Field using Deluge
                                                                                                            • Error AS101 when adding new email alias

                                                                                                              Hi, I am trying to add apple@(mydomain).com The error AS101 is shown while I try to add the alias.
                                                                                                            • Trigger workflow base on email clic

                                                                                                              Searching the help and forum, I see that there were workflow trigger rules based on email. But now, I can't find this type of trigger when I create a custom workflow. What I'm looking for would be to automate the sending of an email for a new prospect,
                                                                                                            • Bigin Form Acknowledgement

                                                                                                              How to troubleshoot and find out why form acknowledgement is not sending emails after form submission?
                                                                                                            • Option to Customize Career Site URL Without “/jobs/Careers”

                                                                                                              Dear Zoho Recruit Team, I hope you are doing well. We would like to request an enhancement to the Career Site URL structure in Zoho Recruit. In the old version of the career site, our URL was simply: 👉 https://jobs.domain.com However, after moving to
                                                                                                            • Zoho Mail POP & IMAP Server Details

                                                                                                              Hello all! We have been receiving a number of requests regarding the errors while configuring or using Zoho Mail account in POP/ IMAP clients. The server details vary based on your account type and the Datacenter in which your account is setup. Ensure
                                                                                                            • Ever since the new Android App udpates notifications are not working

                                                                                                              notifications are not working for the app is its closed I followed the tutuorial to the notificaction fixed and everythig seems to be right but notifications are not workig
                                                                                                            • Zoho Analytics & Zoho Desk - but not all desks

                                                                                                              I have several desks in our company and one of those is used by our HR department. I want to bring through the data to the shared Zoho Analytics workspace - except for the HR desk. Can this be excluded at data import stage ?
                                                                                                            • Incoming Emails Not Showing Up in Zoho Inbox

                                                                                                              Hi - I have my Zoho email account set up to forward a copy of all incoming emails to a secondary Gmail address, whilst retaining the original email in the Zoho inbox. However, all my incoming emails are currently not showing up in my Zoho inbox, so I'm
                                                                                                            • How to retrieve my following requests on this forum?

                                                                                                              Sorry, but I did not find the proper subforum for this question.
                                                                                                            • How to list emails in a folder, e.g. Inbox, on multiple pages when using Zoho mail webpage?

                                                                                                              Something as shown in the figure. There are totally 50 emails in Sent folder. If "Mail per page" equals 20, then the Sent folder is split into 3 pages. When I wander through Sent folder, I can just select a specific page to jump to. BTW, it seems that
                                                                                                            • Unable to Create Zoho Booking via the Book Appointment API

                                                                                                              Its giving the below error {     "response": {         "errormessage": "Error setting value for the variable:customer_details\n null",         "status": "Error"     } } Request: POST Url: https://www.zohoapis.in/bookings/v1/json/appointment attached Zoho-oauthtoken
                                                                                                            • SHEET - Send email when a cell changes

                                                                                                              I would like to create a custom function for Zoho Sheet that triggers when a paticular cell changes to a specific value. This would result in sending an email to a recipient (this would be an address that remains the same and included in the script). Example: = IF(N4= "Drafted", <>EmailFunction) 1)     Cell N4 changes to "Drafted" 2)    Email is sent to recipient            or alternatively 3)    Post to chat channel I have found the Custom function editor in Sheet. I am not bad at scripting, but
                                                                                                            • Apply transaction rules to multiple banks

                                                                                                              Is there any way to make transaction rules for one bank apply to other banks? It seems cumbersome to have to re-enter the same date for every account.
                                                                                                            • 【開催報告】 福岡 ユーザー交流会 2025/8/8(金)

                                                                                                              皆さま、こんにちは。コミュニティチームの中野です。 8/8(金)に、福岡 ユーザー交流会を開催しました。 本投稿では、その様子をお届けします。当日の登壇資料などもこちらに共有しますので、参加できなかった皆さまもご参照ください。 今年初の開催となる福岡 ユーザー交流会では、CreativeStudio樂合同会社 前田さんによるZoho CRM / Sign / Survey の事例セッションのほか、 Zoho社員セッションでは、Zoho Forms の活用法を解説。 さらに、「見込み客・顧客データの管理/活用方法」をテーマに参加者同士でZoho
                                                                                                            • no me llegan los correos a Zoho mail

                                                                                                              No puedo recibir correos pero sí enviarlos, ya hice la modificación de MX y la verificación de teléfonos, qué es lo que ocurre? gracias
                                                                                                            • Error: Invalid login: 535 Authentication Failed

                                                                                                              I have used zoho with nodemailer. const transporter = nodemailer.createTransport({ host: 'smtp.zoho.com', port: 465, secure: true, auth: { user: 'example@example.com', pass: 'password' } }); While sending the mail, it shows the following error: Error:
                                                                                                            • Zoho Renewal

                                                                                                              Hello, If I am not going for zoho email renewal. will i get back my free zoho account? and if yes then is it possible to get back my all free user. how many user get back 10 or 25?
                                                                                                            • javax.mail.authenticationfailedexception 535 authentication failed

                                                                                                              Hi, I am facing 535 authentication failed error when trying to send email from zoho desktop as well as in webmail. Can you suggest to fix this issue,. Regards, Rekha
                                                                                                            • Not reciving emails

                                                                                                              Apparently i cannot recive emails on my adress contact@sportperformance.ro I can send, but do not recive. The mail i'm trying to send from mybother adress gets sent and doesn't bounce back... but still doesn't get in my inbox. Please advise
                                                                                                            • Not receiving MailChimp verification e-mail

                                                                                                              It seems that their verification e-mails are blocked. I can receive their other e-mails, but not their verification of domain ownership e-mail. I've checked and double checked how I typed the e-mail, using different e-mails (my personal e-mail can receive it), white listing the domain and all that is left is for the IP's to be white listed, but I don't have that power.  If a staff member could take a look at this -> http://mailchimp.com/about/ips/ And perhaps white list them for me, that would be
                                                                                                            • Creating my 2nd email account

                                                                                                              After creating my first email address, I decided to get another email address. I would like to use this new address as the primary address too. I don't know how to set it up there doesn't seem to be an option for that
                                                                                                            • Cannot - create more email account - Unusual activity detected from this IP. Please try again after some time

                                                                                                              Hello, I come across the error message in Control Panel. Unusual activity detected from this IP. Please try again after some time and i cannot create any more users We are an IT company and we provide service for another company Please unlock us.
                                                                                                            • "Unable to send message;Reason:553 Relaying disallowed. Invalid Domain"

                                                                                                              Good day. When I try to send mail through ZOHO mail I get the following error : "Unable to send message;Reason:553 Relaying disallowed. Invalid Domain" I need help with this. My zohomail is : @eclipseweb.site Thank you,
                                                                                                            • Next Page