Zoho Deluge - Modify the product line items in an invoice module

: Category: Zoho Deluge; 07 October 2019; 22 August 2019; Hits: 22890; Rating:

( 815 Ratings )

What?
This is a reminder on how to swap out a product in an invoice.

Why?
A client wanted one of their products to be swapped out with another as they had a 3rd-party feed that kept creating a product that they didn't stock.

How?
So editing the product_details field of an invoice record seems straightforward but it isn't. Undocumented, the trick is to remove the existing ID of the line item and posting the map back to the record. In the following example, we are swapping out the product "123456789012345678" with the product "987654321098765432" and p_InvoiceID is the ID of the invoice record:

copy raw

v_Index = 0;
m_Update = Map();
l_ProductItems = List();
r_InvoiceDetails = Map();
r_InvoiceDetails = zoho.crm.getRecordById("Invoices",p_InvoiceID);
for each  r_ProductLineItem in r_InvoiceDetails.get("Product_Details")
{
    m_NewProduct = Map();
    m_NewProduct = r_ProductLineItem;
    if(r_ProductLineItem.get("product").get("id") == "123456789012345678")
    {
        m_NewProduct.remove("product");
        m_NewProduct.remove("id");
        m_NewProduct.remove("product_description");
        m_Mini = Map();
        m_Mini.put("id","987654321098765432");
        m_NewProduct.put("product",m_Mini);
    }
    l_ProductItems.add(m_NewProduct);
}
m_Update = Map();
m_Update.put("Product_Details",l_ProductItems);
r_Update = zoho.crm.updateRecord("Invoices",p_InvoiceID,m_Update);

v_Index = 0;
m_Update = Map();
l_ProductItems = List();
r_InvoiceDetails = Map();
r_InvoiceDetails = zoho.crm.getRecordById("Invoices",p_InvoiceID);
for each r_ProductLineItem in r_InvoiceDetails.get("Product_Details")
{
m_NewProduct = Map();
m_NewProduct = r_ProductLineItem;
if(r_ProductLineItem.get("product").get("id") == "123456789012345678")
{
m_NewProduct.remove("product");
m_NewProduct.remove("id");
m_NewProduct.remove("product_description");
m_Mini = Map();
m_Mini.put("id","987654321098765432");
m_NewProduct.put("product",m_Mini);
}
l_ProductItems.add(m_NewProduct);
}
m_Update = Map();
m_Update.put("Product_Details",l_ProductItems);
r_Update = zoho.crm.updateRecord("Invoices",p_InvoiceID,m_Update);

Additional Note(s):
Just a list of fields to build up a Product Line Item:

copy raw

"Product_Details": [
    {
        "product": {
            "Product_Code": null,
            "Currency": "USD",
            "name": "Test Product",
            "id": "1642130000000104087"
        },
        "quantity": 1,
        "Discount": 0,
        "total_after_discount": 0,
        "net_total": 0,
        "book": null,
        "Tax": 0,
        "list_price": 0,
        "unit_price": 0,
        "quantity_in_stock": 0,
        "total": 0,
        "id": "1642130000047106029",
        "product_description": null,
        "line_tax": []
    }
],