}

Committed by
bjoerntx on Monday, February 18, 2019

Create your First Document

After you created a trial account and created at least one API Key, you can send your first request to create a document. When creating a trial account, a demo template is created in your storage account automatically.

Prerequisites

  1. Trial Account
    Sign up for a trial account.

  2. Create an API Key
    In order to send your first request, you will need to create an API Key in the ReportingCloud Portal.

Please check the My Templates overview in your portal and make sure that the demo template sample_invoice.tx has been created in your template storage.

Build your Request

In the following form, the endpoint document/merge is called using JavaScript. You simply need to add your API Key, manipulate the mergeData in the mergeBody object and to send the request.

  1. Specify your API Key

    The API Key is securely transmitted to ReportingCloud using HTTPS.

  2. Set the return format

  3. Set the merge data

    [{"yourcompany_companyname":"TextControl, LLC","yourcompany_zip":"28226","yourcompany_city":"Charlotte","yourcompany_street":"6926 Shannon Willow Rd,Suite 400","yourcompany_phone":"7045447445","yourcompany_fax":"704-542-0936","yourcompany_url":"www.textcontrol.com","yourcompany_email":"sales@textcontrol.com","invoice_no":"778723","billto_name":"Joey Montana","billto_companyname":"Montana, LLC","billto_customerid":"123","billto_zip":"27878","billto_city":"Charlotte","billto_street":"1 Washignton Dr","billto_phone":"8872673356","payment_due":"20/1/2016","payment_terms":"NET30","salesperson_name":"Mark Frontier","delivery_date":"20/1/2016","delivery_method":"Ground","delivery_method_terms":"NET30","recipient_name":"Joey Montana","recipient_companyname":"Montana, LLC","recipient_zip":"27878","recipient_city":"Charlotte","recipient_street":"1 Washignton Dr","recipient_phone":"8872673356","item":[{"qty":"1","item_no":"1","item_description":"Itemdescription1","item_unitprice":"2663","item_discount":"20","item_total":"2130.40"},{"qty":"1","item_no":"2","item_description":"Itemdescription2","item_unitprice":"5543","item_discount":"0","item_total":"5543"}],"total_discount":"532.60","total_sub":"7673.4","total_tax":"537.138","total":"8210.538"}]

  4. Create the request

Your Request

The following generated request will be send to this endpoint:

https://api.reporting.cloud/v1/document/merge

HTTP Header

Authorization: ReportingCloud-APIKey

Request Payload

{ "mergeData": "", "template": null, "mergeSettings": null }

ReportingCloud Response

    Found a in our documentation?

    Edit this page on GitHub