How to merge Subform Fields via Merge API's in Writer?
1. Create a Merge template in Writer with related (RL) fields
|
Invoice Owner |
Invoice Number |
Created By |
Due Date |
|
<<Invoices.Invoice Owner>> |
<<Invoices.Invoice Number>> |
<< Invoices. Created By>> |
<<Invoices.Due Date>> |
Product_Code |
Product_Description |
Item_Quantity |
Item_Price |
«Products.Product_Code» |
«Products.Product_Description» |
«Products.Item_Quantity» |
«Products.Item_Price» |
2. Sample code to get the RL fields info
document_id -> It can be derived from the document open url: https://{{domain}}/writer/open/eb4kob4cf65bb6d074af****************
{
"merge": [
{
"id": "First_Name",
"groupname": "Contacts",
"display_name": "First Name",
"type": "text"
},
{
"id": "Email",
"groupname": "Contacts",
"display_name": "Email",
"type": "email"
},
{
"id": "Invoices",
"display_name": "Invoices",
"type": "subform",
"fields": [
{
"id": "Invoices.Owner",
"groupname": "Invoices",
"display_name": "Invoice Owner",
"type": "text"
},
{
"id": "Invoices.Invoice_Number",
"groupname": "Invoices",
"display_name": "Invoice Number",
"type": "number"
},
{
"id": "Invoices.Created_By",
"groupname": "Invoices",
"display_name": "Created By",
"type": "text"
},
{
"id": "Invoices.Due_Date",
"groupname": "Invoices",
"display_name": "Due Date",
"type": "text"
}
]
},
{
"id": "Products",
"display_name": "Products",
"type": "subform",
"fields": [
{
"id": "Products.Product_Code",
"groupname": "Products",
"display_name": "Product Code",
"type": "text"
},
{
"id": "Products.Product_Description",
"groupname": "Products",
"display_name": "Product Description",
"type": "text"
},
{
"id": "Products.Item_Quantity",
"groupname": "Products",
"display_name": "Item Quantity",
"type": "number"
},
{
"id": "Products.Item_Price",
"groupname": "Products",
"display_name": "Item Price",
"type": "number"
}
]
}
],
"sign": {},
"fill": {}
}
3. Sample code to map the RL fields (via deluge)
invoicesRecords = zoho.crm.getRecordById("Invoices", invoiceId);
CustomerInvoice = Map();
CustomerInvoice.put("First_Name", invoicesRecords.get("Account_Name").get("name"));
CustomerInvoice.put("Email", invoicesRecords.get("Account_Name").get("id"));
invoicesList = list();
invoiceDetails = Map();
invoiceDetails.put("Invoices.Owner", invoicesRecords.get("Owner").get("name"));
invoiceDetails.put("Invoices.Invoice_Number", invoicesRecords.get("Invoice_Number"));
invoiceDetails.put("Invoices.Created_By", invoicesRecords.get("Created_By").get("name"));
invoiceDetails.put("Invoices.Due_Date", invoicesRecords.get("Due_Date"));
invoicesList.add(invoiceDetails);
productList = list();
productDetails = Map();
productDetails.put("Products.Product_Code", invoicesRecords.get("Product_Code"));
productDetails.put("Products.Product_Description", invoicesRecords.get("Product_Description"));
productDetails.put("Products.Item_Quantity", invoicesRecords.get("Item_Quantity"));
productDetails.put("Products.Item_Price", invoicesRecords.get("Item_Price"));
productList.add(productDetails);
CustomerInvoice.put("Invoices", invoicesList);
CustomerInvoice.put("Products", productList)
mergedata = Map();
mergedata.put("merge_data", {"data": CustomerInvoice});
mergedata.put("subject", "Invoice Details");
//optional
mergedata.put("message", "Please find your invoice attached.");
info mergedata;
zoho.writer.mergeAndSend("eb4kob4cf65bb6d074af7a7de21e561119eb9", "pdf", invoicesRecords.get("email"), mergedata, "writer_name");
4. Sample JSON data with RL fields (via APIs)
{
"data": [
{
"First_Name": "Amelia",
"Email": "amelia@zylker.com",
"Invoices": [
{
"Invoices.Owner": "John",
"Invoices.Invoice_Number": 1279,
"Invoices.Created_By": "Amelia",
"Invoices.Due_Date": "07/10/2020"
}
]
"Products": [
{
"Products.Product_Code": "A123",
"Products.Product_Description": "Mobile Cases",
"Products.Item_Quantity": 2,
"Products.Item_Price": 1000
}
]
}
]
}
Access your files securely from anywhere
Zoho CRM Training Programs
Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.
Zoho DataPrep Personalized Demo
If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.
- Zoho Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
Create. Review. Publish.
You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.
Zoho Sheet Resources
Zoho Forms Resources
Zoho Sign Resources
Sign, Paperless!
Zoho TeamInbox Resources
Design. Discuss. Deliver.
Related Articles
How to merge subform fields and image field via Zoho Writer's Merge APIs?
Overview Zoho Writer's Merge API enables the dynamic population of documents using data from Zoho CRM. This includes merging not only standard fields but also related list (subform) fields and image fields. This guide outlines the steps required to ...How to track merge status and handle errors in Zoho Writer
Overview You can track the status of the merge jobs using email notifications and the merge logs. While email notifications help you track the merge initiation and completion status, the merge logs help you track the status of jobs in progress, along ...Getting started with document merge in Zoho Writer
Overview Template-based document generation in Zoho Writer allows you to automate the creation of personalized documents by connecting pre-designed templates with structured data sources such as spreadsheets, forms, CRMs, or APIs. Each template ...How to merge and send document via email in Zoho Writer
Overview The Merge and Send via Email option in Zoho Writer lets you generate personalized documents for each record in your data source and automatically send them via email. Each recipient gets a customized document as an attachment or inline ...How to trigger document merge in Zoho Writer
Overview Zoho Writer document merge can be triggered in four ways: manually, on a schedule, on form submission, or via an incoming webhook. This flexibility allows you to choose the most suitable automation method—whether you want to merge documents ...