Function-1: Compute and update sales commission in quotes.

Function-1: Compute and update sales commission in quotes.


Welcome back folks!

In this week's custom functions series, we've picked a requirement that has often been asked by users!

Business requirement:

In most sales organizations, commissions are an integral part of the extrinsic rewards program, contributing significantly to the sales person’s compensation package. Sales commission is usually calculated as a percentage of revenue generated by the sales person. What if your sales team is enabled with an option to check their sales commission associated with each quote? The first post in 'Automate using Custom Functions' series unravels just that.

A sample scenario:

Let's  assume a case where a sales person gets a commission based on the quantity of products she/he sells. I'm sure you agree that this is  an important practice in many  companies. Internally, there must be records to know just how much commission the sales person received.  Zoho CRM tracks the commission associated with the sale of each product in ‘Commission Rate’, a standard field in the Products module. Using custom functions, this information is pushed to the Quotes module. The commission associated with each line item of the quote is calculated and summed up to find the overall commission associated with that quote.The resultant value is then updated in a custom field in the Quotes module. Pretty convenient right?

Steps to add a custom function:

  1. Click  Setup > Actions under Automation > Custom Functions > Configure Custom Function > Write your own .
  2. Enter the name of the Custom function. For example: “Calculate commission in Quotes”.
  3. Select the module as  Quotes . You can add a description as well(optional).
  4. Click “ Free flow scripting ”.
  5. Copy the code given below.
  6. Click “ Edit arguments ”.
  7. Enter the name as “ quoteId ” and select the value as “ Quote Id ”.
  8. Click  Save .

The script:

Code for Version 2.0 API:


quoteMap = zoho.crm.getRecordById("Quotes", input.quoteId.toLong()); 

productDet = ifnull(quoteMap.get("Product_Details"),""); 

value = 0.0; 

for each eachProd in productDet 


qty = (ifnull(eachProd.get("quantity"),"0")).toLong(); 

productId = ifnull(eachProd.get("product"),"").get("id"); 

proDetails = zoho.crm.getRecordById("Products", productId.toLong()); 

commission = (ifnull(proDetails.get("Commission_Rate"),"0.0")).toDecimal(); 

value = (value + commission * qty); 


params = map(); 

params.put("Total_Commission", value); 

updateResp = zoho.crm.update("Quotes", quoteId.toLong(), params); 

info params;

info updateResp;

Code for Version 1.0 API:

quoteIdStr = input.quoteId.toString();
quoteMap = zoho.crm.getRecordById("Quotes", input.quoteId);
productDet = ifnull(quoteMap.get("product"),"");
productList = productDet.toJSONList();
value = 0.0;
for each eachProd in productList
eachProdDet = eachProd.toMap();
qty = (ifnull(eachProdDet.get("Quantity"),"0")).toLong();
productId = ifnull(eachProdDet.get("Product Id"),"");
proDetails = zoho.crm.getRecordById("Products", productId.toLong());
commission = (ifnull(proDetails.get("Commission Rate"),"0.0")).toDecimal();
value = (value + commission * qty);
params = map();
params.put("Total Commission", value);
updateResp = zoho.crm.updateRecord("Quotes", quoteIdStr, params);



  • Change the "[field Id]" or "[module]" name to any other module or field name(Custom modules or fields) to fit your requirement.
  • Update the commission associated with each product in the Products module.
  • Create a custom field in Quotes module where the commission associated with the quote gets updated.

Do try this out and let me know how it worked. If you have questions, ask away. Share this with your team if you think they'll find this useful. See you all next week with another interesting custom function in this series. Until then!

Update: As you must be aware, API V1.0 will be deprecated and support for version 1.0 API will be available only till Dec 31, 2018. Version 1.0 compatible Functions will continue to work until Dec 31, 2019. You're advised to migrated to API Version 2.0 at the earliest. Check this announcement for more. We've updated the post to include the Version 2.0 compatible Function.

      Zoho Marketing Automation
            • Sticky Posts

            • Function #50: Schedule Calls to records

              Welcome back everyone! Last week's function was about changing ownership of multiple records concurrently. This week, it's going to be about scheduling calls for records in various modules. Business scenario Calls are an integral part of most sales routines.. Sales, Management, Support, all the branches of the business structure would work in cohesion only through calls. You could say they are akin to engine oil, which is required by the engine to make all of it's components function perfectly. CRM
            • Function #37: Create a Purchase Order from a Quote

              Welcome back everyone! Last week, we learnt how to calculate the total number of activities for a lead and further take note of the activity count for particular dates. For instance, from the period of Demo to Negotiation. This week, let's look at a function that lets you create a Purchase Order instantly from a Quote. Business scenario: In any form of business, one of the most important things to do is to document the transactions. Naturally, negotiation, signing an agreement, placing an order,
            • Function-2: Round-Robin assignment of records

              Welcome back folks! Last week, we saw how to update sales commission in quotes using a custom function. This week, let's see an interesting use case asked by many of you - auto-assignment records by round-robin method. Business scenario: Right now, the solution allows you to auto-assign leads from web form and imported lists. Let us look at a need where you want to auto-assign leads from in-bound calls in a round-robin method, across modules. Prerequisite: You must create a permanent record in the
            • Focus Group : Functions 101 - A webinar series

              A lot of businesses require their CRM to perform activities that are out-of-the-box. And dynamic as Zoho CRM is, a lot of these scenarios can be achieved by running simple functions. They help you update data in CRM modules or in third-party applications and automate most of your business processes.  We're organizing a four part webinar series to help you build your own functions from scratch. This series breaks down the myth that functions are complex. Follow this link to register.    Note - If
            • Custom Function: Tracking the Case Closed time

              Scenario: Tracking the Case Closed time   We create cases and close them but how do we keep track of the details on when the case was closed? This custom function helps you track the closed time of a case, in a custom date-time field. You can then generate reports based on the closed time. You need to have a custom date time field to update the Closed Time. Please follow these steps: Log in to Zoho CRM with administrative privileges. Click Setup > Automation > Workflow > Create Rule. In the New Rule

            Zoho Pagesense Resources

              Zoho SalesIQ Resources

                    Zoho TeamInbox Resources

                      Zoho DataPrep Resources

                        Zoho CRM Plus Resources

                          Zoho Books Resources

                            Zoho Subscriptions Resources

                              Zoho Desk Resources

                                Zoho Projects Resources

                                  Zoho Sprints Resources

                                    Qntrl Resources

                                      Zoho Creator Resources

                                        Zoho WorkDrive Resources

                                            Zoho Campaigns Resources

                                              Zoho CRM Resources

                                                    Design. Discuss. Deliver.

                                                    Create visually engaging stories with Zoho Show.

                                                    Get Started Now