2. Home
  3. Articles
  4. CRM
  5. Zoho
  6. ZohoCRM: Using Criteria with Module Record Count

For Zoho Services only:


I'm actually part of something bigger at Ascent Business Solutions recognized as the top Zoho Premium Solutions Partner in the United Kingdom.

Ascent Business Solutions offer support for smaller technical fixes and projects for larger developments, such as migrating to a ZohoCRM.  A team rather than a one-man-band is always available to ensure seamless progress and address any concerns. You'll find our competitive support rates with flexible, no-expiration bundles at http://ascentbusiness.co.uk/zoho-support-2.  For larger projects, check our bespoke pricing structure and receive dedicated support from our hands-on project consultants and developers at http://ascentbusiness.co.uk/crm-solutions/zoho-crm-packages-prices.

The team I manage specializes in coding API integrations between Zoho and third-party finance/commerce suites such as Xero, Shopify, WooCommerce, and eBay; to name but a few.  Our passion lies in creating innovative solutions where others have fallen short as well as working with new businesses, new sectors, and new ideas.  Our success is measured by the growth and ROI we deliver for clients, such as transforming a garden shed hobby into a 250k monthly turnover operation or generating a +60% return in just three days after launch through online payments and a streamlined e-commerce solution, replacing a paper-based system.

If you're looking for a partner who can help you drive growth and success, we'd love to work with you.  You can reach out to us on 0121 392 8140 (UK) or info@ascentbusiness.co.uk.  You can also visit our website at http://ascentbusiness.co.uk.

ZohoCRM: Using Criteria with Module Record Count

Zoho
Hits: 1905
What?
An example of code using the new API call "Module Record Count" with some criteria.

Why?
At time of print, I couldn't find an example of how to use this API call with search filters or criteria. Not sure about the rest of you, but I've been using this for pagination purposes and for the system to work out how many pages or loops in total it would need to do.

How?
Here's a couple of working examples I use in production systems:

Pre-amble:
  • I'm applying to a Zoho Instance on the US Datacenter (.COM)
  • These examples are using CRM REST API v5 but you can use these as far back as CRM REST API v2.1:
  • I have a connection in ZohoCRM with the required scopes: ZohoSearch.securesearch.READ AND ZohoCRM.modules.quotes.READ; I've called it "zcrm".

Standard Call for Module Record Count:
copyraw 
v_PerPage = 200;
v_Endpoint = "https://www.zohoapis.com/crm/v5/Quotes/actions/count";
r_MaximumCount = invokeurl
[
	url :v_Endpoint
	type :GET
	connection:"zcrm"
];
v_MaxCount = ifnull(r_MaximumCount.get("count"),0).toLong();
v_Pages = ceil(v_MaxCount / v_PerPage);
info v_Pages;
  1.  v_PerPage = 200; 
  2.  v_Endpoint = "https://www.zohoapis.com/crm/v5/Quotes/actions/count"; 
  3.  r_MaximumCount = invokeUrl 
  4.  [ 
  5.      url :v_Endpoint 
  6.      type :GET 
  7.      connection:"zcrm" 
  8.  ]; 
  9.  v_MaxCount = ifnull(r_MaximumCount.get("count"),0).toLong(); 
  10.  v_Pages = ceil(v_MaxCount / v_PerPage); 
  11.  info v_Pages; 

Call with a criteria:
copyraw 
v_PerPage = 200;
v_CountCriteria = "Quote_Stage:equals:Draft";
v_Endpoint = "https://www.zohoapis.com/crm/v5/Quotes/actions/count?criteria=" + v_CountCriteria;
r_MaximumCount = invokeurl
[
	url :v_Endpoint
	type :GET
	connection:"zcrm"
];
v_MaxCount = ifnull(r_MaximumCount.get("count"),0).toLong();
v_Pages = ceil(v_MaxCount / v_PerPage);
info v_Pages;
  1.  v_PerPage = 200; 
  2.  v_CountCriteria = "Quote_Stage:equals:Draft"; 
  3.  v_Endpoint = "https://www.zohoapis.com/crm/v5/Quotes/actions/count?criteria=" + v_CountCriteria; 
  4.  r_MaximumCount = invokeUrl 
  5.  [ 
  6.      url :v_Endpoint 
  7.      type :GET 
  8.      connection:"zcrm" 
  9.  ]; 
  10.  v_MaxCount = ifnull(r_MaximumCount.get("count"),0).toLong(); 
  11.  v_Pages = ceil(v_MaxCount / v_PerPage); 
  12.  info v_Pages; 

Call with 2 criteria:
copyraw 
v_PerPage = 200;
v_CountCriteria = "((Quote_Stage:equals:" + encodeUrl("Draft") + ")AND(Valid_Till:greater_than:" + encodeUrl("2023-11-01") + "))";
v_Endpoint = "https://www.zohoapis.com/crm/v5/Quotes/actions/count?criteria=" + v_CountCriteria;
r_MaximumCount = invokeurl
[
	url :v_Endpoint
	type :GET
	connection:"zcrm"
];
v_MaxCount = ifnull(r_MaximumCount.get("count"),0).toLong();
v_Pages = ceil(v_MaxCount / v_PerPage);
info v_Pages;
  1.  v_PerPage = 200; 
  2.  v_CountCriteria = "((Quote_Stage:equals:" + encodeUrl("Draft") + ")AND(Valid_Till:greater_than:" + encodeUrl("2023-11-01") + "))"; 
  3.  v_Endpoint = "https://www.zohoapis.com/crm/v5/Quotes/actions/count?criteria=" + v_CountCriteria; 
  4.  r_MaximumCount = invokeUrl 
  5.  [ 
  6.      url :v_Endpoint 
  7.      type :GET 
  8.      connection:"zcrm" 
  9.  ]; 
  10.  v_MaxCount = ifnull(r_MaximumCount.get("count"),0).toLong(); 
  11.  v_Pages = ceil(v_MaxCount / v_PerPage); 
  12.  info v_Pages; 

Call with datetime criteria:
NB: You can't compare a date time value to a field that is simply of datatype: date
copyraw 
v_PerPage = 200;
v_CountCriteria = "((Quote_Stage:equals:" + encodeUrl("Draft") + ")AND(Created_Time:less_than:" + encodeUrl("2023-11-01T01:00:00+01:00") + "))";
v_Endpoint = "https://www.zohoapis.com/crm/v5/Quotes/actions/count?criteria=" + v_CountCriteria;
r_MaximumCount = invokeurl
[
	url :v_Endpoint
	type :GET
	connection:"zcrm"
];
v_MaxCount = ifnull(r_MaximumCount.get("count"),0).toLong();
v_Pages = ceil(v_MaxCount / v_PerPage);
info v_Pages;
  1.  v_PerPage = 200; 
  2.  v_CountCriteria = "((Quote_Stage:equals:" + encodeUrl("Draft") + ")AND(Created_Time:less_than:" + encodeUrl("2023-11-01T01:00:00+01:00") + "))"; 
  3.  v_Endpoint = "https://www.zohoapis.com/crm/v5/Quotes/actions/count?criteria=" + v_CountCriteria; 
  4.  r_MaximumCount = invokeUrl 
  5.  [ 
  6.      url :v_Endpoint 
  7.      type :GET 
  8.      connection:"zcrm" 
  9.  ]; 
  10.  v_MaxCount = ifnull(r_MaximumCount.get("count"),0).toLong(); 
  11.  v_Pages = ceil(v_MaxCount / v_PerPage); 
  12.  info v_Pages; 

Additional
  • Urlencoding or not didn't have much affect on the above but it is recommended you do as it did work if the criteria were encoded...
  • The criteria is in the same syntax format as the one used in the Search API call. Code-wise using the same criteria variable for both calls might offer some consistency.

Notes on the attribute: Criteria
  • You can't compare a date time value to a field that is simply of datatype: date (eg. Valid_Till)
  • The supported operators are equals, starts_with, in, not_equal, greater_equal, greater_than, less_equal, less_than and between.
  • The supported data types are picklist, id, owner_lookup, user_lookup, lookup, phone, email, date, datetime, text, textarea, integer, currency, decimal and double.
  • You can search for a maximum of 10 criteria (with same or different columns) with equals and starts_with conditions.
  • The only operator that is supported for encrypted fields is equals.
  • When you use "equals" for multiple conditions, and if one of your conditions is (Company:equals:ABC), the response will contain records with ABC as well as ABC Inc in their Company fields.
  • When you use "equals" with a single condition and search for a field (mentioned in point #3 of the Note on this page), like Campaign_Name:equals:CRM, the response will contain only those records whose Campaign_Name is "CRM" and not records with "Best CRM" or "Latest CRM" in their Campaign_Name fields.
  • When you use parentheses or comma in the value for a criteria, you must escape them using a backslash. Further, you must encode the value.
    Example:
    Consider the search term:
    copyraw 
    ((Last_Name:equals:Burns,B)and(First_Name:starts_with:M))
    1.  ((Last_Name:equals:Burns,B)and(First_Name:starts_with:M)) 
    After escaping comma and parenthesis in the value:
    copyraw 
    ((Last_Name:equals:Burns\,B)and(First_Name:starts_with:M))
    1.  ((Last_Name:equals:Burns\,B)and(First_Name:starts_with:M)) 
    After encoding the value:
    copyraw 
    ((Last_Name:equals:Burns%5C%2CB)and(First_Name:starts_with:M))
    1.  ((Last_Name:equals:Burns%5C%2CB)and(First_Name:starts_with:M)) 
  • When you use backslash as the last character in the value for a criteria, you must escape it using another backslash. Further, you must encode the value. Example:
    Consider the search term:
    copyraw 
    (Last_Name:equals:K\)
    1.  (Last_Name:equals:K\) 
    After escaping backslash in the value:
    copyraw 
    (Last_Name:equals:K\\)
    1.  (Last_Name:equals:K\\) 
    After encoding the value:
    copyraw 
    (Last_Name:equals:K%5C%5C)
    1.  (Last_Name:equals:K%5C%5C) 
  • To search for Date, DateTime, Lookup, Number, Currency, Boolean fields, you need comparators other than starts_with and equals.

Source(s):
Category: Zoho :: Article: 862

Credit where Credit is Due:


Feel free to copy, redistribute and share this information. All that we ask is that you attribute credit and possibly even a link back to this website as it really helps in our search engine rankings.

Disclaimer: Please note that the information provided on this website is intended for informational purposes only and does not represent a warranty. The opinions expressed are those of the author only. We recommend testing any solutions in a development environment before implementing them in production. The articles are based on our good faith efforts and were current at the time of writing, reflecting our practical experience in a commercial setting.

Thank you for visiting and, as always, we hope this website was of some use to you!

Kind Regards,

Joel Lipman
www.joellipman.com

Related Articles

Joes Revolver Map

Joes Word Cloud

Accreditation

Badge - Certified Zoho Creator Associate
Badge - Certified Zoho Creator Associate

Donate & Support

If you like my content, and would like to support this sharing site, feel free to donate using a method below:

Paypal:
Donate to Joel Lipman via PayPal

Bitcoin:
Donate to Joel Lipman with Bitcoin bc1qf6elrdxc968h0k673l2djc9wrpazhqtxw8qqp4

Ethereum:
Donate to Joel Lipman with Ethereum 0xb038962F3809b425D661EF5D22294Cf45E02FebF
© 2024 Joel Lipman .com. All Rights Reserved.