Connecting Bold BI to Xero data source

The Bold BI dashboard designer supports connecting to Xero web services through the REST API.

Choose Xero data source

To configure the Xero data source, follow these steps:

Click on the Data Sources button in the configuration panel to add a new data connection.
Click CREATE NEW to launch a new connection from the connection panel.
Select the Xero connection in the connection panel.

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

Choose data source from server

Create a Xero data source

Once you click on the data source, the NEW DATA SOURCE configuration panel will open. Follow these steps to create a Xero data source.

Enter a name and description (optional) for the data source.
Click the drop-down box for Organizations and choose the required organizations.
Click the drop-down menu for Resources and select the necessary resources.
Enter a valid REST Resources in the URL textbox. Refer to the Xero API documentation for more details.
Click Custom Url to enter the URL manually.
Enter xero-tenant-id in the header panel by clicking ADD above the header, if you select the Custom URL checkbox.
Select the GET method for the REST API in the Method combo box.
In Max Rows, enter the maximum number of rows to be fetched from the Xero data source. This value is used to fetch the data from the Xero data source using the pagination.
Choose a time interval for the Refresh Settings using the combo box, to periodically trigger the REST API request and keep the data in sync with our dashboard.
Select JSON data type in the Data Format combo box.
The authentication type will be set to Xero automatically since OAuth is used for authenticating with the Xero account.

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

Additional information

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

Setting up the URL

For example, in order to retrieve specific account details, you should connect to the Show Accounts endpoint. This will return all account IDs, allowing you to select the specific account ID from the results.
Replace the account ID in the URL to query a particular account.

https://api.xero.com/api.xro/2.0/Accounts/<:accountid>

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

Sample queries

All Accounts

https://api.xero.com/api.xro/2.0/Accounts

All Bank Transactions

https://api.xero.com/api.xro/2.0/BankTransactions

Preview and data import

Click Preview & Connect to connect with the configurations that have been set.
The Choose Schema(s) dialog opens. The schema represents the key fields of JSON data retrieved from the Xero Rest API request. This dialog displays a list of schemas in treeview and its corresponding values in the grid for preview. Select required schema(s) from treeview to use in designer and click Connect.
Now, the data design view page with the selected table schema opens. Drag the table from the tree view on the left pane and drop it onto the Query designer page.
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