Sample Solution for High Volume Document Generation API
For all new users and partners using High Volume Document Generation API, Conga Advantage Platform contains a pre-built sample API solution containing everything you need in order to help you get started using High Volume Document Generation in a matter of minutes.
To Start using High Volume Document Generation Solutions
As an Administrator, login to your Conga Advantage Platform environment.
Open Document Management Apps, and navigate to Document Automation > Composer Solution Manager.
Under the Composer Solution tab, select the existing example High Volume API Sample Solution.
The Solution Information tab contains the name and description of this pre-built solution, as well as the Solution Recommendations notice regarding how to structure future High Volume Document Generation solutions.
The Templates tab contains an example template named "Invoice Template (High Volume API Sample Template)" saved as an HTML file. The file contains example merge fields and formatting examples to used as a basis for future solutions.
The entire solution also contains a sample Data Model, in order to populate the associated example templates with appropriate information and give an example of how the template will populate. For more details on how data models work, refer to our documentation on Conga Platform Data Models.
The Solution Behaviors tab defaults to Email as the desired merge output, and also points to another pre-built template, the High Volume API Sample Email Template. This template also contains merge fields and formatting examples to be used as a basis for future email templates and is stored in the Conga Drive repository on Conga Advantage Platform. For details on editing these types of templates, refer to Creating an Email Platform Template.
The Deploy tab displays the Environment, Region and preferred coding language for you to choose for your solution needs. The example code in the Fetch Request window can be easily copied and pasted into your preferred development platform to be run immediately. You will see in your High Volume API request how the Template Id, Email Template Id, and Platform email delivery (set to true) were automatically routed to your API request.
Paste the High Volume API request into your development tool of choice and complete your authorization.
- Leverage the following .json data file with your sample solution to get a working solution in minutes.
Example JSON File Data [ { "Id":"1", "EmailOptions":{ "From":{ "Address":"YOUR-CONGA-PLATFORM-EMAIL", "DisplayName":"Greg Fisher" }, "To":[ { "Address":"YOUR-TARGET-EMAIL-ADDRESS", "DisplayName":"Emily Gibbons" } ] }, "DocumentOptions":{ "OutputName":"Invoice-1.pdf" }, "Data":{ "InvoiceDetails":{ "invoice_date":"December 20th", "invoice_number":"INV-00001", "po_number":"6851", "due_date":"January 20th" }, "Account":{ "organization":{ "name":"Archer LLC", "billingDetails":{ "street":"101 Maple Drive", "zip":"52858", "city":"Frankfurt", "country":"Germany" } }, "contact":{ "contactname":"Emily Gibbons", "phone":"(555) 303-1464", "email":"emily.gibbons@archer.com" } }, "InvoiceLineItems":[ { "name":"Conga CLM", "unitPrice":"$50.00", "qty":30, "totalPrice":"$1,500.00" }, { "name":"Conga High Volume API", "unitPrice":"$50.00", "qty":8126, "totalPrice":"$406,300.00" }, { "name":"Conga CPQ", "unitPrice":"$10.00", "qty":7645, "totalPrice":"$76,450.00" }, { "name":"Summit Support", "unitPrice":"$87,165.00", "qty":1, "totalPrice":"$87,165.00" }, { "name":"Conga Learning Pass", "unitPrice":"$1,743.30", "qty":1, "totalPrice":"$1,743.30" } ], "TotalInvoice":"$573,158.30" } } ]
