Search results

Connecting Bold BI to Zoho Books data source

The Bold BI dashboard designer supports connecting the Zoho Books web services using the REST API.

Choose Zoho Books data source

To configure the Zoho Books data source, follow these steps:

  1. Click the Data Sources button in the configuration panel to add a new data connection.

    Data source icon

  2. Click CREATE NEW to launch a new connection from the connection panel.

  3. Select the Zoho Books connection in the connection panel.

    Choose data source

    NOTE: You can also create a data source from the home page by clicking the Data Sources menu from the left menu panel and Create Data Source from the data sources page.

    Choose data source from server

Authentication with Zoho Books

Use the following steps to authenticate with the Zoho Books web service:

  1. Click the data source, you will be prompted with a login window. Enter the credentials of your Zoho Books account to authorize.

  2. Click Allow in the authorization window to accept the scopes requested by the Bold BI dashboards.

    NOTE: If the permission is denied, the account will not be accessible from the dashboard.

  3. Set a name to identify the account and click Next.

  4. You have now successfully authorized your connection. Click Connect to continue with the data source connection.

  5. To connect using the already connected account, refer to the Connected Accounts.

    NOTE: To connect with a new account click Connect New Account.

Create a Zoho Books data source

Once you click the data source, the NEW DATA SOURCE configuration panel opens. Follow these steps to create a Zoho Books data source.

  1. Enter the name and description (optional) for the data source.
  2. Enter the Organization Id for the connected account in the Organization Id text box. Refer the documentation for get the Organization Id.
  3. Click the Resources dropdown box and choose the required endpoint.
  4. Click Custom Url to enter the URL manually. Refer to the Zoho Books API documentation for more details.
  5. Select the GET method for the REST API in the Method combo box.
  6. In Max Rows, enter the maximum number of rows to be fetched from the Zoho Books data source. This value is used to fetch the data from the Zoho Books data source using pagination.
  7. Choose a time interval for Refresh Settings using the combo box, to trigger the Rest API request periodically to keep the data in sync with your dashboard.
  8. Select the JSON data type in the Data Format combo box.
  9. The authentication type will be set to the Zoho Books automatically since OAuth is used for authenticating with the Zoho Books account.

Data source preview

You can also edit the connection information set using the Edit Connection option.

Additional information

Max Rows Most of the REST APIs return only fewer data on a single API request. To pull the amount of data you need, set a value in this field. Pagination is handled internally and will fetch the amount of data you need.
Refresh Settings Period of time before next refresh call is triggered. This will automatically trigger a call for the API configured in the data source to keep the data up to date.

Setting up the URL

  1. For instance, to get the specific bill details, query the /Show Bill resource.
  2. From the listed information get the id of the specific bill.

Replace it in the URL to query particular bills:

https://books.zoho.com/api/v3/bills/<:bill_id>?organization_id=<:Organization Id>

For more information on the API endpoints available for this data source, refer to their official API documentation

Sample queries

All Invoices

https://books.zoho.com/api/v3/invoice?organization_id=<:organization id>

All Credit Notes

https://books.zoho.com/api/v3/creditnotes?organization_id=<:organization_id>

Preview and data import

  • Click Preview & Connect to connect with the configurations set.

  • The Choose Table(s) dialog opens. The schema represents the key fields of JSON data retrieved from the Zoho Books Rest API request. This dialog displays a list of schemas in the treeview and its corresponding values in the grid for preview. Select required tables from the treeview to use in designer and click Connect.

    Preview

  • Now, the data design view page with the selected table schema opens. Drag from the tree view table in the left pane and drop the table in the Query designer page. Query Editor

  • Click Save to save the data source with a relevant name.

Connected accounts for OAuth data sources

If you have already logged into the account and authenticated with a web data source, the account information will be listed here. You can select one of the accounts or connect to a new account by clicking the Connect New Account button.

OAuth

You can edit, delete, and re-authorize this account from the Connected Accounts page.

Manage Accounts

Data Transformation

Editing a Data Connection

Dashboard Designer Walkthrough