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

• Zoho CRM Client Script - SetCriteria in lookup Field

  Hello All One More Zoho CRM Client Script Tips & Trick. Now you can Set the Criteria on Your lookup in zoho CRM, It Comes With a Create Page, Edit Page, and Details Page (Standard). Example:- We have a Room Module that includes Room Name, Status, Campus,

• Kaizen #71 - Client Script ZDKs for Detail (Canvas) Page

  Hello everyone! Welcome back to another interesting Kaizen post. In this post, we can discuss Client Script ZDKs support for Detail (Canvas) Page. What is Detail (Canvas) Page? A Detail(Canvas) Page allows you to customize the record detail page to your

• how to use validation rules in subform

  Is it possible to use validation rules for subforms? I tried the following code: entityMap = crmAPIRequest.toMap().get("record"); sum = 0; direct_billing = entityMap.get("direct_billing_details"); response = Map(); for each i in direct_billing { if(i.get("type")

• Add Custom Reports To Dashboard or Home Tab

  Hi there, I think it would be great to be able to add our custom reports to the Home Tab or Dashboards. Thanks! Chad

• Rich-text fields in Zoho CRM

  Hello everyone, We're thrilled to announce an important enhancement that will significantly enhance the readability and formatting capabilities of your information: rich text options for multi-line fields. With this update, you can now enjoy a more versatile

• Zoho Reports Duplicating Entries

  I have a custom costing tab with a table where we entre invoices. These are under a Heading (PO Subject) and notes added in the form with different line items. In the reports, I have organised the report to group per PO Subject, with the total of the

• Validation Rule Not Working for Mandatory Field in Zoho Blueprint

  As a Zoho user, we created a validation rule for a specific field. However, we noticed that when we made the same field mandatory within a Blueprint, the validation rule we defined did not work. When we reported this issue to Zoho Support, they stated

• Notes Issues

  Been having issues with Notes in the CRM. Yesterday it wasn't showing the notes, but it got resolved after a few minutes., Now I have been having a hard time saving notes the whole day. Notes can't be saved by the save button. it's grayed out or not grayed

• Export from Contacts module to Products module in Zoho CRM

  Good afternoon, I would like to send a number of contact info from the Contacts module into the customized module (tickets to an event) in one operation. I have selected several contacts in the Contact module (people who I have labelled as people I want

• Zoho Commerce

  Hi, I have zoho one and use Zoho Books. I am very interested in Zoho Commerce , especially with how all is integrated but have a question. I do not want my store to show prices for customers that are not log in. Is there a way to hide the prices if not

• Can’t receive emailI c

  I have generated a basic for but when I submit it I don’t get a email, I’ve been in the settings and tested me email, all appears correct, can you please help me

• Data Capture for Historical Activity (Especially One Lead Downloading Variois reports without Overwriting the info)

  Is there a better way in Zoho CRM to capture and archive a lead’s historical activity—specifically whenever they download reports—so that the data is stored without being overwritten?”

• Client Script - Updating Field Value in Detail Page of a Lead

  Hello, I'm trying to use Client Script To enrich some data of the Lead when one of my User fill the "City" field in the detail page of the Lead. This is my Script: log (value); var response = ZDK.Apps.CRM.Functions.execute("getInfoCitta", { "nomeCitta":

• Auto shapes in Zoho sheet.

  Does Zoho sheet supports inserting auto shapes (rectangle, circle...). I did not see any option to do so.  If its not supported currently, is there any plans on bring in this features. Any timelines ?

• I Can't Clone Webinar that I Co-Organize

  How do i get our account admin to give me permission to clone our webinars? I am a co-organizer

• I want to Make the due date of the project appears automatically

  hello everyone I want to know if the zoho projects app can add automatically the END DATE of the project I added the duration, start after dates of each tasks in the project template & the starting date of the project itself and the end date of it doesn't

• Introducing Profile Summary: Faster Candidate Insights with Zia

  We’re excited to launch Profile Summary, a powerful new feature in Zoho Recruit that transforms how you review candidate profiles. What used to take minutes of resume scanning can now be assessed in seconds—thanks to Zia. A Quick Example Say you’re hiring

• How to get the call recording external ID via desk API

  I have enabled phonbridge integration with Zoom Call. I am trying to access the call recording in Zoom by calling Zoom API. I have built a Desk workflow to trigger on a new call, to call a custom function. when calling the API, the response doesn't contain

• Can't View Project Names in Mobile App

  I can't view project names on PO's in the app, nor can I add that as a viewable PDF field in inventory on the computer. I've attached screenshots showing that in the mobile version whether you are on the PO, editing the PO, or viewing the PO line items,

• How do you print a refund check to customer?

  Maybe this is a dumb question, but how does anyone print a refund check to a customer? We cant find anywhere to either just print a check and pick a customer, or where to do so from a credit note.

• Notebook

  I have purchased the monthly pro subscription of Notebook. But it does not support my XP-Pen to write something in it. So it is not useful to me. Hence I am requesting you to help me to discontinue this subscription.

• Domain Mapping & Image Publishing Issues on Zoho Sites

  Hello, I am facing two issues with my Zoho Sites account: 1. Images not visible after publishing. 2. Domain mapping error: "Domain already exists". I am a paid customer. Please connect me with Live Chat Support or Zoho Assist so I can show my issue

• Prevent duplicate with custom fields?

  I was wondering something about custom field/custom modules in Zoho Desk. For some reason you can make a custom field mandatory but not unique? For example, if I create a custom module to manage equipment and renewal and make a field serial number no

• Round robin

  Hi, I'm trying to set up a round robin to automatically distribute tickets between agents in my team but only those tickets that are not otherwise distributed by other workflows or direct assignments. Is that possible and if so which criteria should I

• "Is Zoho CRM customer" vs "Is linked with Zoho CRM"

  Recently while building a Flow, I was setting up a Decision action following a Zoho Invoice Fetch record action. There were 2 choices that I had not seen as something I could manually action in Zoho Invoice: "Is Zoho CRM customer" and "Is linked with

• Two currencies

  More and more I am finding that internattional payments' fees are unpredictable. I would like, on my invoices that are in a foreign currency (eg. USD$ or EUR€) for there to be a GBP£ TOTAL display alongside the invoice's currency total. This would make

• Automatic Matching from Bank Statements / Feeds

  Is it possible to have transactions from a feed or bank statement automatically match when certain criteria are met? My use case, which is pretty broadly applicable, is e-commerce transactions for merchant services accounts (clearing accounts). In these

• Generate leads from instagram

  hello i have question. If connect instagram using zoho social, it is possible to get lead from instagram? example if someone send me direct message or comment on my post and then they generate to lead

• Zoho PDF editor has a lot of issues.

  Zoho PDF editor needs a lot of work. It hangs and glitches a lot. Deletes annotations and clearings randomly.

• Where is the desktop app for Zoho Projects???

  As a project manager, I need a desktop app for the projects I manage. Yes, there's the web app, which is AWESOME for cross browser and platform compatibility... but I need a real desktop app for Projects that allow me to enter offline information where

• How to Automate Monthly PDF Reports with Filters in Zoho Creator

  Hi everyone, I’m trying to build an automated monthly reporting process in Zoho Creator and would appreciate suggestions or best practices from anyone who has done something similar. What I’m trying to do: I have a form called New_Customer with fields

• Feedback: Streamlining Note Management in Zoho Notebook

  Dear Team/Support, I would like to share some feedback regarding the note management system that could help improve usability and accessibility for users like myself. Notebook 1 (screenshot attached): Currently, the system does not allow selecting and

• showing Limit exceeded

  Good afternoon...trust you're good. I've been having issues working with but it's not responding. it's showing Limit exceeded, sorry it seems like too many people are working on the sheet right now please try again later. meanwhile no one is working on

• Converting Sales Order to Invoice via API; Problem with decimal places tax

  We are having problems converting a Sales Order to an Invoice via API Call. The cause of the issue is, that the Tax value in a Sales Order is sometimes calculated with up to 16 decimal places (e.g. 0.8730000000000001). The max decimal places allowed in

• Sorting columns in Zoho Projects

  Hi, In project management best practice, sorting columns (ascending, descending) is an important tool. Sorting dates to see the order of tasks starting, sorting on priority or even on planned hours is a must for an efficient project control. Currently,

• Business Continuity - Disaster Recovery

  I know about the Zoho CRM backup .zip files, however, this doesn't include any of the infrastructure with like custom fields or custom modules. I am curious on what everyone has in place for a true backup or what your plan is if your Zoho instance were

• Upload API

  I'm trying to use the Upload API to upload some images and attach them to comments (https://desk.zoho.com/DeskAPIDocument#Uploads#Uploads_Uploadfile) - however I can only ever get a 401 or bad request back. I'm using an OAuth token with the Desk.tickets.ALL

• Losing description after merging tickets

  Hello, We merge tickets when they are about the same topic from the same client. It happens sometimes. We recently noticed that after the merger only the description from the master ticket is left in a thread. And the slave-ticket description is erased.

• update linked contacts when update happens in account

  Hi, I have a custom field called Licence in the Accounts module. When someone buys a licence, I’d like to update a custom field in the related Contacts. How can I achieve this? I noticed that workflows triggered on Accounts only allow me to update fields

• Problem Management Module

  I am looking for a Problem Management module within Zoho Desk. I saw in some training videos that this is available, and some even provided an annual price for it. I want an official confirmation on whether this is indeed available. This is not a particularly

• Next Page