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
- Adding product line items while inserting a quote (through the Insert Records API)
- 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!
Access your files securely from anywhere
Centralize Knowledge. Transform Learning.
All-in-one knowledge management and training platform for your employees and customers.
New to Zoho Recruit?
Zoho Developer Community
New to Zoho LandingPage?
Zoho LandingPage Resources
New to Zoho Survey?
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Bigin?
Topic Participants
Shylaja S
itdept
Praveen Sankar
carsten.schmitz
Sticky Posts
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.Kaizen #226: Using ZRC in Client Script
Hello everyone! Welcome to another week of Kaizen. In today's post, lets see what is ZRC (Zoho Request Client) and how we can use ZRC methods in Client Script to get inputs from a Salesperson and update the Lead status with a single button click. In thisKaizen #222 - Client Script Support for Notes Related List
Hello everyone! Welcome to another week of Kaizen. The final Kaizen post of the year 2025 is here! With the new Client Script support for the Notes Related List, you can validate, enrich, and manage notes across modules. In this post, we’ll explore howKaizen #217 - Actions APIs : Tasks
Welcome to another week of Kaizen! In last week's post we discussed Email Notifications APIs which act as the link between your Workflow automations and you. We have discussed how Zylker Cloud Services uses Email Notifications API in their custom dashboard.Kaizen #216 - Actions APIs : Email Notifications
Welcome to another week of Kaizen! For the last three weeks, we have been discussing Zylker's workflows. We successfully updated a dormant workflow, built a new one from the ground up and more. But our work is not finished—these automated processes are
New to Zoho TeamInbox?
Zoho TeamInbox Resources
Zoho CRM Plus Resources
Zoho Books Resources
Zoho Subscriptions Resources
Zoho Projects Resources
Zoho Sprints Resources
Qntrl Resources
Zoho Creator Resources
Zoho CRM Resources
Design. Discuss. Deliver.
Zoho Show Resources
Get Started. Write Away!
Writer is a powerful online word processor, designed for collaborative work.
Zoho CRM コンテンツ
-
オンラインヘルプ
-
Webセミナー
-
機能活用動画
-
よくある質問
-
Ebook
-
-
Zoho Campaigns
- Zoho サービスのWebセミナー
その他のサービス コンテンツ
Nederlandse Hulpbronnen
ご検討中の方
Recent Topics
Export all of our manuals from Zoho Learn in one go
Hi, I know there's a way to export manuals in Zoho Learn, but I want to export everything in one go so it won't take so long. I can't see a way to do this, can I get some assistance or is this a feature in the pipeline? Thanks, HannahAutomation#31: Automate Splitting Names for New Contact Records
Hello Everyone, This week, we present to you a custom function, which allows you to split the first and last names from the user's email ID based on the separator used in the ID. Having grown into a large firm, Zylker Techfix aims to optimize its processes,Automatically remove commas
Team, Please be consistent in Zoho Books. In Payments, you have commas here: But when we copy and paste the amount in the Payments Made field, it does not accept it because the default setting is no commas. Please have Zoho Books remove commas automProject Change Orders and Additions
We are in the process of migrating from QuickBooks Online to Zoho Books. We have Zoho One and like the ability to sync all of our data across everything. And I like that projects work in a way that's less dumb than QuickBooks. I'm trying to figure outZOHO Desk - Description of slave ticket disappeared after Merge
Dear Support, On Zoho Desk the description of a ticket disappeared after merging two ticket. The one which was the slave one completely disappeared. The problem that in this description there was an image which i had only on Desk in that ticket. CouldHow do I insert a cross-reference link to a different section within one Knowledge Base article using Zoho Desk?
I would like to insert a link within a Knowledge Base article to a different section of that same article. The section I want to link to is formatted with the Heading 3 style and is displayed within my TOC. However, I do not see any way to add a linkProblem Adding Facebook Account
Hi, I'm new here, I'm having trouble setting up my Facebook account as a social channel. I think the issue is down to how my Facebook is set up, which is pretty confusing. I have a personal Facebook account (let’s called it A) which is my main FacebookZoho Desk Teams App is not loading
Hi Zoho Desk support. Need an assistance on the Zoho Desk Teams app. Once I click View Ticket, it isn't showing anything. Kindly refer to attached: ZohoDesk Teams App_View Ticket Error.jpg For our Dashboard, we are still experiencing the same issue. KindlyZoho People - Retrieve the Leave Details - get("LeaveCount")
Hi, Zoho People I need to collect all of an employee's leave requests for the calendar year and check how many half-days they have taken. If I run the script on the query he just modified, I can retrieve the information related to that query and use theMapping a new Ticket in Zoho Desk to an Account or Deal in Zoho CRM manually
Is there any way for me to map an existing ticket in Zoho desk to an account or Deal within Zoho CRM? Sometimes people use different email to put in a ticket than the one that we have in the CRM, but it's still the same person. We would like to be ableWhich WhatsApp API works seamlessly with Zoho CRM?
I’m exploring WhatsApp API solutions that integrate seamlessly with Zoho CRM for customer communication, lead nurturing, and automation. I would love to hear insights from those who have successfully implemented WhatsApp within Zoho CRM. My Requirements:Allow people to sign a zoho form by using esign or scanned signature
Allow people to sign a zoho form by using esign or scanned signatureButton to Reapply Filters on Sheet(s)
I wrote a macro that I attached to a button to reapply the filters on all my sheets and it says it works, but it doesn't actually do anything. What is wrong with it? Is there another way? Or even make it work for one sheet? Sub UniversalFilterRefresh()Integrate Multiple ZohoBooks organization with zoho projects
We have successfully connected our Zoho Books with Zoho Projects for synronizing timesheet data. Our Business specialty is, that the staff of the Main company (A) is working on several projects, but the Clients are sometimes contracted and paying to aZoho OAuth Connector Deprecation and Its Impact on Zoho Desk
Hello everyone, Zoho believes in continuously refining its integrations to uphold the highest standards of security, reliability, and compliance. As part of this ongoing improvement, the Zoho OAuth default connector will be deprecated for all Zoho servicesHow do I add todays date to merge field
I don't see any selection of todays date when creating a letter. Surely the date option of printing is standard? JohnTracking Emails sent through Outlook
All of our sales team have their Outlook 365 accounts setup with IMAP integration. We're trying to track their email activity that occurs outside the CRM. I can see the email exchanges between the sales people and the clients in the contact module. ButWhats that
Price?The same Contact associated to multiple Companies - Deals
Hi, I would like to know if there is an option to associate the same contact with multiple companies (two or more) deals, using the same contact details for all. This is because we have contacts who are linked to different companies or branches of thePortals-Adjust Column Sizes
I am trying to adjust the column widths in Portals tabs. Columns that don't need to be wide are wide and longer ones are very short. I thought adding more to the digits box in Edit would widen them, but it doesn't. Anyone know how to adjust these?Add link/button to open approved record from approval list and detail views?
Hi, How do I allow users to click on an approval record and open that submission? For example, userA submits a quotation then userB approves/rejects. They both can see the quotation on "completed task" list & detail views, but there's no way for themrecord submitted from creator and invoice is creating in books , but the workflow of books is not tiggering on create of record in books
record submitted from creator and invoice is creating in books , but the workflow of books is not tiggering on create of record in books headermap = Map(); headermap.put("X-ZOHO-Execute-CustomFunction","true"); response_inv = invokeurl [ url :"https://www.zohoapis.com/books/v3/invoices/fromsalesorder?salesorder_id="Prevent editing of a record after getting approved/rejectedr
Hi, I'd like to block any user from editing a record after it was approved or rejected, how can I do that?Formula Field/Campo de Fórmula
Hello everyone, I have a purchase requisition form in which each department submits a request, and the request is automatically routed to the person responsible for that department. In this form, I have several fields with the following link names: Quantidade1,Formatting Problem | Export to Zoho Sheet View
When I export data to Zoho Sheet View, ID columns are automatically formatted as scientific notation. Reformatting them to text changes the actual ID values. For example, 6557000335603071 becomes 6557000335603070. I have attached screenshots showing thisFeature Request - The Ability to Link A Customer with a Vendor
Hi Finance Suite Team, Many businesses buy and sell products from the same companies or individuals. For example, a car sales business may buy a car from a member of the public, and that member of the public may also buy a new car from us. This makesLong table name (sync from Zoho Creator)
Dears, How can I remove the suffix in parentheses? These tables are synced from Zoho Creator and are treated as system tables, so their names cannot be changed. This issue makes the aggregation formulas look awful.[Free Webinar] Learning Table Series - Streamlining incident management process with Zoho Creator
Hello everyone, We’re excited to invite you to another edition of the Learning Table Series webinar. As you may already know, we've moved to a purpose-based approach in the Learning Table Series this year. Each session now focuses on how a Zoho CreatorUnattended - Silent
How can I hide the tray icon / pop up window during unattended remote access for silent unattended remote access?Importing into Multiselect Picklist
Hi, We just completed a trade show and one of the bits of information we collect is tool style. The application supplied by the show set this up as individual questions. For example, if the customer used Thick Turret and Trumpf style but not Thin Turret,Text snippet
There is a nice feature in Zoho Desk called Text Snippet. It allows you to insert a bit of text anywhere in a reply that you are typing. That would be nice to have that option in Zoho CRM as well when we compose an email. Moderation Update: We agree thatMarketing Tip #18: Make your online store mobile-friendly to improve traffic
Most online shoppers browse on their phones first. If your store is hard to read, slow to load, or tricky to navigate on mobile, they’ll bounce fast. A mobile-friendly store doesn’t just look nice; it improves engagement, reduces drop-offs, and helps[Need help] Form closed. Please contact your form administrator for further assistance.
https://forms.zohopublic.com/cceinfoifly1/form/CCE2025CCEFocusGroupRegistrationForm2025Fall/formperma/s_8XcLETTbFxZ_TAS4r_W6W5UBl8o5oxEnIX35IBKg4 I checked we didn't exceed the usage limit and form availability is enabled, Please help us enable this formZoho People. Updating TabularData
I am trying to update tabular data in the record. I always have the same response. I have checked many times. Section ID is correct. May be something wrong with request structure itself. Can someone help me. Body content type: form urlencoded query paramsAutomatically CC an address using Zoho CRM Email Templates
Hi all - have searched but can't see a definitive answer. We have built multiple email templates in CRM. Every time we send this we want it to CC a particular address (the same address for every email sent) so that it populates the reply back into ourUnable to Send Different Email Templates for Different Documents in Zoho Sign
Hello Zoho Community, I am facing a limitation with Zoho Sign regarding email notifications sent to customers when a document is sent for signing. Currently, whenever I send any template/document for signing, the email notification that goes to the customerReminder needs 0 minute choice
I most use 0 minute reminders. Every other calender service has this choice. If I create an event in my Android calendar with 0 minute reminder it will change to 5 minute. Please ad 0 as a reminder choice, this should be a 5 minute fix. Thanks.Customer ticket creation via Microsoft Teams
Hi all, I'm looking to see if someone could point me in the right direction. I'd love to make it so my customers/ end users can make tickets, see responses and respond within microsoft teams. As Admin and an Agent i've installed the zoho assist app withinIs there a way to update all the start and end dates of tasks of a project after a calendar change?
Hi! Here's my situation. I've built a complete project planning. All its tasks have start dates and due dates. After completing the planning, I've realized that the project calendar was not the right one. So I changed the project calendar. I now haveHow to update task start date when project start date changes?
Hi there, When the start date of a project changes, it's important to update the start dates of the tasks associated with that project to reflect the new timeline. Is there a way to shift the start date of all project tasks when the start date of a projectNext Page