Retrieving a sales order as a PDF from Zoho CRM is handled through the inventory toolset built into the platform, using the getsalesorderaspdf function tied to a specific record ID.
Why this matters
Sales teams frequently need to share or archive sales order documents in a portable, print-ready format. Whether you are sending a confirmed order to a customer, attaching it to an email, or storing it for audit purposes, having a reliable way to pull the PDF programmatically — or through an automation — saves significant manual effort. This is especially relevant when Zoho CRM is integrated with inventory workflows.
Step-by-step
Step 1. Confirm that your Zoho CRM account has the Inventory module enabled. The PDF retrieval capability sits within the Inventory section of Zoho CRM, so the Sales Orders module must be active in your organisation's setup. [1]
Step 2. Identify the Record ID (rid) of the sales order you want to export. You can find this in the URL when you open a sales order record in Zoho CRM — it is the long numeric string at the end of the address bar. This ID is the key parameter required to fetch the correct document. [1]
Step 3. Invoke the getsalesorderaspdf tool, passing the record ID as the rid argument. In an automation or custom function context, the call follows the pattern:
self.get_sales_order_as_pdf(m, rid)Here, m refers to the module context and rid is the sales order record ID you captured in Step 2. [1]
Step 4. Handle the returned PDF output according to your use case. Common next steps include attaching the file to an email alert, saving it to Zoho WorkDrive, or triggering a download for the end user. The tool returns the PDF as binary data that can be routed through Zoho CRM's workflow or custom function framework. [1]
Step 5. If your organisation also uses Zoho Books alongside Zoho CRM, note that the two platforms can be linked so that sales orders created in CRM are visible and manageable from the Books side as well. This integration allows finance and sales teams to work from a shared data set without duplicating records. [3]
Step 6. For organisations that need visually customised output, Zoho Inventory now supports Retail PDF Templates for the Sales Orders module, including both standard and premium retail template styles. If your CRM inventory is connected to Zoho Inventory, you can design the template there and the PDF generated will reflect that layout. [6][7]
Common pitfalls
- Missing record ID: Passing an incorrect or blank
ridwill cause the function to fail silently or return an error. Always validate that the record ID belongs to a Sales Orders record, not a quote or invoice. [1] - Module not enabled: If the Inventory module is not active in your Zoho CRM edition, the
getsalesorderaspdftool will not be available. Check your module settings under the CRM admin panel before building any automation around this function. [1] - Template not assigned: If no PDF template has been assigned to the Sales Orders module, the generated PDF may be blank or use a default layout that does not meet your branding requirements. Assign a template in the module settings before triggering the export. [6][7]
What to check
- Verify the record ID is correct and corresponds to an existing, confirmed sales order in Zoho CRM's Inventory module. [1]
- Confirm a PDF template is active for the Sales Orders module — particularly if you need branded or retail-style output. [6][7]
- Test the output in a sandbox or with a non-critical record before deploying the function in a live workflow, to ensure the returned file is complete and correctly formatted. [1]
---
*Beam Help is an independent expert support resource for Zoho products and is not official Zoho support. For platform-level billing or account issues, contact Zoho directly.*