Kaizen #105 - Functions, Integration Tasks, and API Credits - Part 1

Hello everyone!

Welcome back to another week of Kaizen!

In today's post, we will discuss functions, integration tasks, how they consume API and function credits.

In the next post, we will discuss connections, the difference between integration tasks and invoke URL in functions, how authentication happens for invoke URLs, and their credit consumption pattern.

What are functions in CRM?

A business involves multiple processes that cater to specific needs, like managing the sales pipeline, automating the flow of data between modules or different third-party systems, etc.

Zoho CRM gives you a wide range of options to achieve your business goals in the form of pre-defined functions under Setup > Developer Space > Functions. You can tweak these functions and associate them to workflows, blueprints, approval processes, circuits amongst many others, at just the click of a button.

While it is understandable that every business' needs are different, and the pre-defined functions, albeit very generic and most-commonly used, may not suit every business, Zoho CRM allows you to write your own functions specific to your needs.

More details on functions, here.

You can use Zoho's Deluge scripting language to write your own functions in a simple drag-and-drop function editor under Setup > Developer Space > Functions.

Integration tasks

We talked about how functions solve your business cases. How exactly do they do it?

Let's say you want to create a record in Zoho CRM using Functions. Instead of having to add values to every field the traditional way in web UI, functions have integration tasks that make working with records a lot easier as they act as API wrappers. These integration tasks help you make direct API calls without having to write code manually to handle API endpoints, HTTP methods, request parameters, or authentication mechanisms. What's more? They accept the input as function arguments in key-value pairs, much like JSON.

How are integration tasks beneficial to you?

When you use multiple Zoho products, data flow between them becomes much simpler and easier through integration tasks.

Your code becomes concise and easy to interpret.

As the integration tasks are essentially API wrappers, you do not have to worry about authorization as these integration tasks are considered as API calls triggered by the org's admin.

For today's post, let us discuss the function Converting a Sales Order to a Purchase Order, that uses integration tasks.

A gist of the code:

1. Use the getRecordById integration tasks to get the ID of the Sales Order you want to convert to a Purchase Order
   
2. Get the details of the product line items in the sales order, iterate through each of them, and add them to a map.
   
3. Put these in another map to be used in the Purchase Order.
   
4. Use the createRecord integration task and pass the new map to create a purchase order with the details from the sales order.
   

Here is the code:

Note that this function takes the soID(sales order ID) as the argument.

respMap = zoho.crm.getRecordById("Sales_Orders",input.soId.toLong()); productDet = ifnull(respMap.get("Product_Details"),""); pdlist = List(); for each eachProd in productDet { productvalue = eachProd.get("product"); proid = productvalue.get("id"); proname = productvalue.get("name"); mp = Map(); mp.put("product",{"name":proname,"id":proid}); mp.put("quantity",ifnull(eachProd.get("quantity"),"0").toLong()); mp.put("list_price",ifnull(eachProd.get("list_price"),"0.0").toDecimal()); mp.put("discount",ifnull(eachProd.get("discount"),"0.0").toDecimal()); mp.put("total",ifnull(eachProd.get("total"),"0.0").toDecimal()); mp.put("net_total",ifnull(eachProd.get("net_total"),"0.0").toDecimal()); pdlist.add(mp); } paramap = Map(); paramap.put("Product_Details",pdlist); paramap.put("Subject",ifnull(respMap.get("Subject"),"")); paramap.put("Contact_Name",ifnull(respMap.get("Contact_Name"),"").get("id")); paramap.put("Account_Name",ifnull(respMap.get("Account_Name"),"").get("id")); paramap.put("Owner",ifnull(respMap.get("Owner"),"").get("id")); paramap.put("Sales_Order",ifnull(respMap.get("id"),"")); paramap.put("Terms_and_Conditions",ifnull(respMap.get("Terms_and_Conditions"),"")); paramap.put("Description",ifnull(respMap.get("Description"),"")); paramap.put("Adjustment",ifnull(respMap.get("Adjustment"),"0.0").toDecimal()); paramap.put("Discount",ifnull(respMap.get("Discount"),"0.0").toDecimal()); paramap.put("Tax",ifnull(respMap.get("Tax"),"0.0").toDecimal()); paramap.put("Shipping_Cuty",ifnull(respMap.get("Shipping_Cuty"),"")); paramap.put("Shipping_Code",ifnull(respMap.get("Shipping_Code"),"")); paramap.put("Shipping_Method",ifnull(respMap.get("Shipping_Method"),"")); paramap.put("Shipping_State",ifnull(respMap.get("Shipping_State"),"")); paramap.put("Shipping_Street",ifnull(respMap.get("Shipping_Street"),"")); paramap.put("Status",ifnull(respMap.get("Status"),"")); createResp = zoho.crm.createRecord("Purchase_Orders",paramap); info paramap; info createResp;

Here is the response:

This is the Purchase order created from the sales order.

I have associated this function to a workflow that converts a sales order to a purchase order, every time a sales order is created or updated.

How is authentication handled for integration tasks?

Functions with integration tasks are triggered by actions like workflows, blueprints etc. These triggers are org-wide and not restricted to specific sets of users. So, the integration tasks are executed as if the actions are done by the org’s admin.

API and Function Credits

Just like how APIs consume credits, integration tasks consume API credits, too.

The number of credits depends on the integration task you have used. For example, if you use the createRecord integration task, it consumes the same credits as the create records API. Similarly, the getRecordById integration task consumes the same credits as the Get Records API.

This is in addition to the function credits.

So, for the above function, the following are the various limits applied:

• API credits - 2 - one each for getRecordById and createRecords integration tasks.
  
• Function credits - 1
  

Where can you find the usage stats?

The API Dashboard and Functions Dashboard.

API Dashboard

Apart from API credit consumption, the API dashboard also gives you the details of the credits consumed by integration tasks.

The "Credits Usage" section shows you the credits specific to integration tasks. As you can see, out of the total available 56000 credits, 36 credits are consumed. Out of these 36 credits, 32 are from integration tasks.

The "Credits by Applications/Functions" pie chart gives you the credit consumption by each function or app.

When you click on one of them, you will see the details.

Functions Dashboard

The "Most Credits Consumed Functions" chart gives you the details of the functions that have consumed credits higher than most.

We hope you found this post useful. Next week, we will discuss Connections, invoke URLs and more.

Let us know what you think in the comments, or drop us an email at support@zohocrm.com.

Cheers!

• Topic Participants

• Shylaja S

  

• Pablo Silva Osorio

  

• 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

• Recent Topics

• Pourquoi dans zohobooks version gratuite on ne peut ajouter notre stock d'ouverture??

  Pourquoi dans zohobooks version gratuite on ne peut ajouter notre stock d'ouverture ??

• How can I adjust column width in Zoho Books?

  One issue I keep running into is as I show or hide columns in reports, the column widths get weird. Some columns have text cut off while others can take a fourth of the page for just a few characters. I checked report layout guides and my settings, but

• Invalid value passed for file_name

  System generated file name does not send file anymore - what is the problem?

• Custom Function for Estimates

  Hey everyone, I was wondering if there was a way to automate the Subject of an estimate whenever one is created or edited: * the green box using following infos: * Customer Name and Estimate Date. My Goal is to change the Subject to have this format "<MyFirm>-Estimate

• This domain is not allowed to add. Please contact support-as@zohocorp.com for further details

  I am trying to setup the free version of Zoho Mail. When I tried to add my domain, theselfreunion.com I got the error message that is the subject of this Topic. I've read your other community forum topics, and this is NOT a free domain. So what is the

• Search in module lists has detiorated

  Every module has a problem with the search function :-/

• YouTube Live #1: AI-powered agreement management with Zia and Zoho Sign

  Hi there! We're excited to announce Zoho Sign’s first YouTube live series, where you can catch the latest updates and interact with our Zoho Sign experts, pose questions, and discover lesser-known features. We're starting off by riding the AI wave in

• Search in module lists has detiorated

  Every module has a problem with the search function :-/

• Sales Receipts Duplicating when I run reports why and how do we rectify this and any other report if this happens

  find attached extract of my report

• Add Zoho Forms to Zoho CRM Plus bundle

  Great Zoho apps like CRM and Desk have very limited form builders when it comes to form and field rules, design, integration and deployment options. Many of my clients who use Zoho CRM Plus often hit limitations with the built in forms in CRM or Desk and are then disappointed to hear that they have to additionally pay for Zoho Forms to get all these great forms functionalities. Please consider adding Zoho Forms in the Zoho CRM Plus bundle. Best regards, Mladen Svraka Zoho Certified Consultant and

• Bigin: filter Contacts by Company fields

  Hello, I was wondering if there's a way to filter the contacts based on a field belonging to their company. I.e.: - filter contacts by Company Annual Revenue field - filter contacts by Company Employee No. field In case this is not possibile, what workaround

• Has Zoho changed the way it searches Items?

  Right now all of our searches have broken and we can no longer search using the SKU or alias. It was fine last night and we came in this morning to broken.....this is impacting our operations now.

• Refunds do not export from Shopify, Amazon and Esty to Zoho. And then do not go from Zoho inventory to Quickbooks.

  I have a huge hole in my accounts from refunds and the lack of synchronisation between shopify , Amazon and Etsy to Zoho ( i.e when I process a refund on shopify/ Amazon or Etsy it does not come through to Zoho) and then if I process a manual credit note/

• CRM->INVENTORY, sync products as composite items

  We have a product team working in the CRM, as it’s more convenient than using Books or Inventory—especially with features like Blueprints being available. Once a product reaches a certain stage, it needs to become visible in Inventory. To achieve this,

• Zoho Calendar not working since a few days

  Hey there, first off a minor thing, since I just tried to enable the Calendar after reading this in another topic (there was no setting for this though) : For some reason my current session is showing me based in New York - I'm in Germany, not using a

• Monthly timesheet, consolidation of time by project

  I have time logs for various jobs for project. Is it possible to consolidate the time spent for each job, when I am generating a timesheet for a month? I am getting the entries of jobs done on each day when I generate a timesheet for a month For example

• Building a Strong Online Identity with G-Tech Solutions

  In today’s fast-moving world, having a strong online identity is essential for every business. https://gtechsol.com.au helps businesses establish a digital presence that reflects their vision and values. By focusing on innovation and quality, they create

• Sending emails from an outlook account

  Hi, I need to know if it's possible to send automatic emails from an Outlook account configured in Zoho CRM and, if so, how I can accomplish that. To give you some context, I set up a domain and created a function that generates PDF files to be sent later

• Struggling with stock management in Zoho CRM – is Zoho Inventory the solution?

  My biggest pain point today with Zoho is inventory management. I run a retail business and reliable stock management is absolutely critical. Obviously, I need this inventory to be visible inside the CRM. At first, I tried handling it through custom modules

• Automating CRM backup storage?

  Hi there, We've recently set up automatic backups for our Zoho CRM account. We were hoping that the backup functionality would not require any manual work on our end, but it seems that we are always required to download the backups ourselves, store them,

• Nimble enhancements to WhatsApp for Business integration in Zoho CRM: Enjoy context and clarity in business messaging

  Dear Customers, We hope you're well! WhatsApp for business is a renowned business messaging platform that takes your business closer to your customers; it gives your business the power of personalized outreach. Using the WhatsApp for Business integration

• can't login Kiosk URGENT

  already try, can't login pls help to support. thanks.

• 【Zoho CRM】CRM for Everyoneに関するアップデート：関連データ機能

  ユーザーの皆さま、こんにちは。コミュニティチームの中野です。 今回は「Zoho CRM アップデート情報」の中から、CRM for Everyoneの新機能「関連データ機能」をご紹介します。 関連データ機能は、あるタブのデータを別のタブに柔軟に関連付け、異なるタブで管理されている情報を1か所にまとめて表示できます。 たとえば、組織タブとチームタブのデータを関連付けることで、必要な情報に効率よくアクセスでき、顧客理解を深めながら他チームとの連携もスムーズに行えます。 目次 1. 関連データの設定方法

• Zoho Books

  How do I manually insert opening balance?

• Profit / margins on Sales orders / Invoices / Estimates

  When we select an SKU or item name in any of these documents, much info such as invoice.line_items.rate is pulled from the item & filled into the document being worked on. If we had another lineItem DB field (hidden) auto filled at the same time: invoice.line_items.purchase_rate

• Inventory to Xero Invocie Sync Issues

  Has anyone had an issue with Invoices not syncing to Xero. It seems to be an issue when there is VAT on a shipping cost, but I cannot be 100% as the error is vague: "Unable to export Invoice 'INV-000053' as the account mapped with some items does not

• How to activate RFQ? What if a price list has ladder price for items?

  Where can I find the option to activate request for quotation? How does it work? If the item has ladder price, does it gets calculated depending on how many items are in the cart?

• Mailk got blocked / Inquiry About Email Sending Limits and Upgrade Options

  Dear Zoho Support Team, My name is Kamr Elsayed I created this account to use for applying for vocational training in Germany. As part of this process, I send multiple emails to different companies. However, after sending only 8 emails today, I received

• Can't join canal Developers Zoho User

  Hello, I received an invitation to join this channel, but I get an error when I try to join it, and I get the same error when I go to the Zoho Cliq interface > Search for a channel. Is this because I don't have a license linked to this email address?

• Desk Email reply - set default font / use custom font

  Hello, in our e-mails, which we send to our customers, a certain font must be used (Corporate Design): Segoe UI https://en.wikipedia.org/wiki/Segoe#Segoe_UI How can this be included? How can this be set as the default font to ensure that this font is

• PDF Templates - Checkbox Borders

  Is there a way to remove the border of a radio/checkbox on a PDF? I'd like to use the function of checkbox but if there's no easy way to remove the border (the PDF form already has a rectangle so it gets cluttered), then I'm forced to create a single

• Zoho CRM's custom views are now deployable from sandboxes

  This feature is now available for users in the AU, JP, and CN DCs. This feature is now available for users in CA and SA DCs. New update: This feature is now available for users in all DCs. Hello everyone, We're excited to announce that you can now deploy

• Settings Icon No Longer in ZOHO Desk?

  In ZOHO desk, there has been a gear icon for settings. as of yesterday, it is no longer there. I showed up briefly this morning but is gone again. Anybody else experiecing this?

• Introducing the all-new email parser!

  Greetings, We are pleased to introduce to you, a brand-new, upgraded version of the Zoho CRM Email Parser, which is packed with fresh features and has been completely redesigned to meet latest customers needs and their business requirements. On that note,

• Tip #43 - Track, Review, and Analyze Your Assist Sessions with Reports-'Insider Insights'

  Did you know you can generate detailed reports for both remote support sessions and unattended access sessions in Zoho Assist? This makes it easy to monitor technician activity, measure efficiency, and review customer interactions. Let us now take a closer

• Function #20: Custom calculation in item table of invoices

  When you create an invoice in Zoho Books, the 'Amount' of a line item is typically calculated as the product of the "Quantity" and the "Rate" of the item. For instance, if an item has a sales rate of $50 and a quantity of 5 is sold, then the amount would

• CBSA - GST CHARGES on imports

  Hi there, We have a questions about landed cost categorization. We received a shipment from overseas. CBSA invoiced us for the GST on the items. Now we entered the CBSA-GST as a separate bill and attached it as landed cost to the main invoice based on

• Simplified Call Logging

  Our organization would like to start logging calls in our CRM; however, with 13 fields that can't be removed, our team is finding it extremely cumbersome. For our use case, we only need to record that a call happened theirfor would only need the following

• Sub form doesn't as formula field

  Is it possible to get formula field in sub form in futures?

• Week date range in pivot table

  Hello, I need to create a report that breakouts the data by week.  I am using the pivot table report, and breaking out the date by week, however the date is displayed as 'Week 1 2014' format.  Is there anyway to get the actual dates in there? ex. 1/6/2014-1/12/2014 Thanks,

• Next Page