Kaizen #9 - Handling Product Line Items in the Inventory Modules #API

Hello everyone!

Welcome back to another post in the Kaizen series!

This week, we will discuss handling product line items associated with the inventory modules—Quotes, Invoices, Purchase Orders, and Sales Orders.

What is a product line item?

On the Quote, Invoice, Purchase Order, Sales Order create or edit page, you add individual products in the Product Details section. This section also contains other details like the List Price, Quantity, Amount, Discount, and Tax. Every product and the corresponding details are called product line items.

In this post, we will discuss 

1. Adding product line items while inserting a quote (through the Insert Records API)
   
2. Updating a quote by adding another product line item (through the Update Specific Records API)
   

The JSON input is similar while adding/updating an invoice, purchase order, and sales order.

1. Adding Product Line Items to a Quote

While adding a product to a quote you can,

      a. Select a price book to associate with the product

      b. Specify a different list price for the product

1. a. Selecting a price book to associate with the product

To associate a price book with the product, you must pass the ID of that price book in the input.

What happens when you pass the Price Book's ID?

• The discount on the product is automatically applied based on the range you specified in the price book.
  
• The cumulative tax (specified for the product) is automatically calculated based on the amount (after the discount).
  
• The List Price of the product specified in the associated price book is automatically taken for calculating the amount.
  

The sample input for Product_Details is as follows.

"Product_Details": [     {       "product": {         "id": "3652397000000491147"       },       "quantity": 100,       "product_description": "product_description",       "book": "3652397000000616007"     }   ]

The following table gives information about each key in the Product_Details JSON Array.

Key	Data Type	Description
product	JSON Object	The ID of the product in the quote.
quantity	Number	The number of units of the product the quote is generated for. Accepts only positive integer values. The amount is calculated based on this number and the price for each unit.
book	String	The ID of the Price Book you have associated with the product.
product_description	String	Description of the product.

Here is a screenshot from the UI.

1.b. Specifying a different list price for the product

When the product does not have an associated price book or you want to give a different list price, you must specify the list price and the discount in the Product_Details array. 

Otherwise, the system enters the value for the discount as 0 and takes the list price you specified while creating that product.

The sample input for the Product_Details JSON array is as follows.

"Product_Details": [     {       "product": {         "id": "3652397000000491147"       },       "quantity": 150,       "product_description": "product_description",       "Discount": 1000,       "list_price": 1100,       "line_tax": [         {           "percentage": 1,           "name": "VAT"         }       ]     }   ]

The following table gives information about each key in the Product_Details JSON Array.

Key	Data Type	Description
Product	JSON Object	ID of the product the quote generated for.
quantity	Number	The number of units of the product the quote is generated for. Accepts only positive integer values.
Discount	Currency	The discount, in decimals, you want to apply for the product. Accepts up to 16 digits before the decimal, and up to 9 digits after the decimal. This limit may vary based on the value configured in 'Maximum digits allowed' in the properties pop-up of the field, in the UI.
product_description	String	Description of the product.
list_price	Currency	The list price of the product.
line_tax	JSON Array	Contains the percentage and the name of the tax associated with the product.
percentage	Percent	The percentage of tax applied on the product. Accepts only numeric values, up to 5 digits.
name	String	The name of the tax applied on the product.

As mentioned earlier, the Product Details section encompasses the taxes applied for each product and the aggregate tax applied to the Sub Total of the quote or any other inventory module.

You can specify the different taxes you want to apply for your products in the CRM UI.

You can add them under Setup > Customization > Modules and Fields > Products as shown in the below image.

You can use these configured values as inputs in the API.

Adding taxes to the product while creating/updating an inventory module

When you add a product to an inventory module, to apply the taxes to that product, you must specify the tax details in the line_tax JSON array inside Product_Details.

You must specify the percentage and the name of the tax associated with the product as JSON objects.

You cannot specify the amount as the system calculates it automatically based on the quantity.

Example:

"Product_Details": [     {       "product": {         "id": "3652397000001363004"       },       "quantity": 100,       "Discount": 20.1,       "product_description": "product_description",       "line_tax": [         {           "percentage": 10,           "name": "Sales Tax"         },         {           "percentage": 1,           "name": "Vat"         }       ]     }   ]

Adding aggregate tax to the quote or other inventory modules

This is the tax that you want to apply to the Sub Total of the line items while generating the invoice, quote, sales order, or purchase order. The taxes you specify in the $line_tax key are added to the ones already applied to the product through the line_tax key.

The $line_tax key is present outside the Product_Details JSON array.

The structure for this JSON array is as follows.

"Product_Details": [     {       "product": {         "id": "3652397000001363004"       },       "quantity": 100,       "product_description": "product_description",       "line_tax": [         {           "percentage": 10,           "name": "Sales Tax"         },         {           "percentage": 1,           "name": "Vat"         }       ]     }   ],   "$line_tax": [     {       "percentage": 1.5,       "name": "Common Tax",       "id": "3652397000001376005"     }   ]

Key	Data type	Description
$line_tax	JSON Array	Contains the name, ID, and the percentage of the tax you want to apply to the quote.
percentage	Percent	The percentage of tax applied on the quote. Accepts only numeric values, up to 5 digits.
name	String	The name of the tax.
id	String	The unique ID of the tax.

Note

Make a GET request to "{{api-domain}}/crm/v2/org/taxes" to obtain the IDs of all the taxes for your organization.

The below image shows the data corresponding to the line_tax and $line_tax keys in the UI for a quote.

Points to note

• For Product_Details
  When you have associated a price book with an inventory module, and you include the key and value for Discount inside Product_Details, this discount value overrides the discount calculated from the price book.
• For line_tax
  You must specify the percentage of tax in every JSON object inside the line_tax array.

2. Updating a Quote by adding Product Line Items

You can associate multiple products to a quote.

While updating a quote, you can add/update/remove a line item.

Let us consider an example where you have five line items in a quote, and you want to remove two line items, and add a new one.

In this case, you must

• Pass the IDs of the line items you want to retain as individual JSON objects.
  
• Add the new line item with the required details as a new JSON object.
  
• Do not include any details about the line item you want to remove. When you do not specify the ID of any line item, the system deletes it automatically.
  

A sample JSON structure for the above scenario is as follows.         

"Product_Details": [     {       "id": "3652397000001377174"     },     {       "id": "3652397000001378168"     },     {       "id": "3652397000001379172"     },     {       "product": {         "id": "3652397000001351002"       },       "quantity": 100,       "book": "3652397000000616007"     }   ]

To obtain the ID of the existing line item, make a GET request to fetch the Quote you want to update. The response contains the ID of the existing line item in the Product_Details array.

Note

• You can add a maximum of 200 line items to an inventory module.
  

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.

Cheers!

• Topic Participants

• Shylaja S

  

• itdept

• Praveen Sankar

  

• carsten.schmitz

• 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

• Need the ability to have read only fields on a form.

  There needs to be functionality in Creator that allows a field on a form to be read only. Most screen building software applications have this capability. I know you can hide certain fields from specific users and that you can also make the whole form read only but that's not the functionality I need. I want to be able to create a form where certain fields are editable and other are for display purposes only (read only). For example if the form was displaying information on an item that the user

• Reverse payment on accidentally closed invoice.

  An invoice was closed accidentally with the full payment added. However, only partial payment was paid. How can I reopen the invoice and reverse this to update it to show partial payment?

• New integration: Track booking page appointments in Google Analytics 4

  Hello all, Greetings from the Zoho Bookings team! We’re excited to introduce our new Google Analytics 4 (GA4) integration designed to help you track booking activity, understand customer behavior, and measure marketing performance, all in one place. What

• 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

• Zoho Calendar soft bounce on @hotmail.com and @yahoo.com email addresses

  Hello, our Zoho calendar recently does not send the calendar invites to emails with hotmail and yahoo domains and comes back with a "soft bounce". other domains like Gmail works fine. Also sending "email" to the same emails to the above domains work well

• ERROR CODE :512 - 5.4.4 DNS error:NXDOMAIN.

  Suddenly we cant send mail, we are getting this error for all outbound mail to multiple domains.

• Can Zoho Flows repeat Actions more than once?

  I'm attempting to make an intentional Zoho Flow loop using the below layout. However, when "WithinLimit" condition is met, the program fails to execute the action "Get & Add Request Co..." again. Is this by design? Is Zoho Flows unable to repeat actions

• Unveiling Cadences: Redefining CRM interactions with automated sequential follow-ups

  Last modified on 01/04/2024: Cadences is now available for all Zoho CRM users in all data centres (DCs). Note that it was previously an early access feature, available only upon request, and was also known as Cadences Studio. As of April 1, 2024, it's

• customer data security

  We are exploring ways to enhance our within Zoho CRM. Our Goal: We want to fully integrate RingCentral with Zoho CRM to enable click-to-call functionality for our sales team. However, to comply with data privacy regulations and protect customer contact

• Zoho Cliq not working on airplanes

  Hi, My team and I have been having this constant issue of cliq not working when connected to an airplane's wifi. Is there a reason for this? We have tried on different Airlines and it doesn't work on any of them. We need assistance here since we are constantly

• Sync CRM inventory data with Zoho Books

  I just switched everything over to ZoHo books, but I am trying to find out why the CRM Estimates, Invoices, and Sales Orders created in ZoHo CRM are not then duplicated in ZoHo Books? I had Quickbooks before, and had to do everything twice, I thought

• mask Customer phone number and agents cant see customer phone number

  Is there any way we can integrate Zoom Phone with Zoho CRM while ensuring that customer phone numbers remain masked? We need a solution where agents can make outbound calls but cannot see customer phone numbers. Please let us know if there is any solution

• Email Reminders on Shared Calendars

  How do we turn off the setting that emails reminders to everyone who has accepted or declined a calendar invite? If 8 of us have been invited to the same meeting, we receive 8 notifications for every step of the process, from invitation to decision.

• WebDAV / FTP / SFTP protocols for syncing

  I believe the Zoho for Desktop app is built using a proprietary protocol. For the growing number of people using services such as odrive to sync multiple accounts from various providers (Google, Dropbox, Box, OneDrive, etc.) it would be really helpful if you implemented standard protocols such as WebDAV / FTP / SFTP so that alternative inc clients can be used.

• What's New in Zoho Inventory | Q2 2025

  Hello Customers, The second quarter have been exciting months for Zoho Inventory! We’ve introduced impactful new features and enhancements to help you manage inventory operations with even greater precision and control. While we have many more exciting

• How to refresh a ticket view ?

  I am doing a widget where I send a rest api call to make a new draft to the ticket I am viewing. The issue is sometimes it refresh a ticket view and I can see inserted draft right away, but sometimes I do not see it even if it is inserted correctly and

• Ugh! - Text Box (Single Line) Not Enough - Text Box (Multi-line) Unavailable in PDF!

  I provide services, I do not sell items. In each estimate I send I provide a customized job description. A two or three sentence summary of the job to be performed. I need to be able to include this job description on each estimate I send as it's a critical

• Merge Items

  Is there a work around for merging items? We currently have three names for one item, all have had a transaction associated so there is no deleting (just deactivating, which doesn't really help. It still appears so people are continuing to use it). I also can't assign inventory tracking to items used in past transactions, which I don't understand, this is an important feature moving forward.. It would be nice to merge into one item and be able to track inventory. Let me know if this is possible.

• Supervisor Rules - Zoho Desk

  Hi, I have set up a Supervisor Rule in Zoho Desk to send an email alert when a ticket has been on hold for 48 hours. Is there a way to change it so that the alert only sends once and not on an hourly basis? Thank you Laura

• ResponseCode 421, 4.7.0 [TSS04] Messages from 136.143.188.51 temporarily deferred due to user complaints

  Had email bounce. Let me know if you can fix this. Thanks. Michael

• Zoho Canvas - Custom templates for related lists

  Hi, I see that the example pages load always one of our related lists in a custom template, but I dont know how to work with that:  1) How can i make my own custom templates for related lists?  2) Where and how can i check out existing custom templates?

• Automation #15: Automatically Adding Static Secondary Contacts

  Rockel is a top-tier client of Zylker traders. Marcus handles communications with Rockel and would like to add Terence, the CTO of Zylker traders to the email conversations. In this case, the emails coming from user address rockel.com should have Terence

• New Zoho triggers Google Dangerous flag due toabnormal charcters

  Just signed up and doing my first email test. I sent it to my google email account but it got flagged as Dangerous" due abnormal characters. My DNS setup looks ok. Page snips attached Help Please Thanks, Rick DC PowerWorld

• Is there a API to fetch tasks in a Board/Section

  I am writing a scheduled function that retrieves all the tasks and send an reminder on cliq. I cannot seem to find a API to fetch tasks (by user / board / section) What are the way to fetch tasks?

• Having trouble fetching contents of Zoho Connect Feeds using the API, requesting alternative API documentation.

  I'm trying to retrieve feed/post data from Zoho Connect using the API but facing challenges with the current documentation. What I've tried: OAuth authentication is working correctly (getting 200 OK responses) Tested multiple endpoints: /pulse/nativeapi/v2/feeds,

• Adding an Account Name to Tasks/Reminders

  Does anyone know how to add the related account name to a task?  When we look at the list of activities and when the reminders pop up, there is no way of quickly seeing who the account is. 

• Triggering Zoho Flow on Workdrive File Label

  Right now Im trying to have a zoho flow trigger on the labeling/classification of a file in a folder. Looking at the trigger options they arent great for something like this. File event occurred is probably the most applicable, but the events it has arent

• SendMail to multiple recipients

  Hi, I'm trying to send an email to a list of recipients.  Right now the "to" field is directed to a string variable. (List variables won't work here). In the string variable, how can I make it work? trying "user@app.com;user2@app.com" or "user@app.com; user2@app.com" just failed to send the emails. Ravid

• Populate drop down field from another form's subform

  Hello, I found how to do that, but not in case of a subform. I have a Product form that has a subform for unit and prices. A product might have more than one unit. For example, the product "Brocoli" can be sold in unit at 3$ or in box of 10 at 25 $. Both

• Usar o Inventory ou módulo customizado no CRM para Gestão de Estoque ?

  Minha maior dor hoje em usar o zoho é a gestão do meu estoque. Sou uma empresa de varejo e essa gestão é fundamental pra mim. Obviamente preciso que esse estoque seja visível no CRM, Inicialmente fiz através de módulos personalizados no próprio Zoho CRM,

• Signup forms behaviour : Same email & multiple submissions

  My use case is that I have a signup form (FormA) that I use in several places on my website, with a hidden field so I can see where the contact has been made from. I also have a couple of other signup forms (FormB and FormC) that slight differences. All

• getting error in project users api

  Hello, I'm getting a "Given URL is wrong" error when trying to use the Zoho Projects V3 API endpoint for adding users to a project. The URL I'm using is https://projectsapi.zoho.com/api/v3/portal/{portalid}/projects/{projectid}/projectusers/ and it's

• Change total display format in weekly time logs

  Hi! Would it be possible to display the total of the value entered in the weekly time log in the same format that the user input? This could be an option in the general settings -> display daily timesheet total in XX.XX format or XX:XX.

• Different Company Name for billing & shipping address

  We are using Zoho Books & Inventory for our Logistics and started to realize soon, that Zoho is not offering a dedicated field for a shipping address company name .. when we are creating carrier shipping labels, the Billing Address company name gets always

• How to display historical ticket information of the total time spent in each status

  Hi All, Hoping someone can help me, as I am new to Zoho Analytics, and I am a little stuck. I am looking to create a bar chart that looks back over tickets raised in the previous month and displays how much time was spent in each status (With Customer,

• Zoho Projects iOS app update: Global Web Tabs support

  Hello everyone! In the latest version(v3.10.10) of the Zoho Projects app update, we have brought in support for Global Web Tabs. You can now access the web tabs across all the projects from the Home module of the app. Please update the app to the latest

• Zoho Community Weekend Maintenance: 13–15 Sep 2025

  Hi everyone, We wanted to give you a heads-up that Zoho Community will undergo scheduled maintenance this weekend. During this period, some community features will be temporarily unavailable, while others will be in read-only mode. Maintenance Window:

• Agent Performance Report

  From data to decisions: A deep dive into ticketing system reports An agent performance report in a ticketing system provides a comprehensive view of how support agents manage customer tickets. It measures efficiency and quality by tracking key performance

• Show both Vendor and Customers in contact statement

  Dear Sir, some companies like us working with companies as Vendor and Customers too !!! it mean we send invoice and also receive bill from them , so we need our all amount in one place , but in contact statement , is separate it as Vendor and Customer, 

• URL validation

  We use an internal intranet site which has a short DNS name which Zoho CRM will not accept.   When attempting to update the field it says "Please enter a valid URL". The URL I am trying to set is http://intranet/pm/ Our intranet is not currently setup with a full DNS name and given the amount of links using the shortname probably isn't a feasible change for us.

• Next Page