Search results

Connecting Bold BI to the QuickBooks Payments data source

The Bold BI dashboard designer supports connecting the QuickBooks Payments web services through REST API.

Choose QuickBooks Payments data source

To configure the QuickBooks Payments 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 QuickBooks Payments 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

Authentication with QuickBooks Payments

Use the following steps to authenticate with QuickBooks Payments web service:

  1. Click the data source, you will be prompted with a login window. Enter the credentials of your QuickBooks Payments 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.

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

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

  3. To connect through already connected account, refer to the Connected Accounts.

NOTE: To connect another account, click Connect New Account.

Connect to QuickBooks Payments

Create a QuickBooks Payments data source

After the successful authentication, the NEW DATA SOURCE configuration panel will open. Follow these steps to create a QuickBooks Payments data source.

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

Data source preview

You can also edit the connection information set here 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.
Data Formats By default, the data is retrieved in the JSON format. Additionally, XML is supported in QuickBooks Payments.
  1. For instance, to query about the account, query the /Get bank account endpoint.
  2. From the listed information, you can get the ID of the specific account.

Replace it in the URL to query a particular account:<:id>/bank-accounts/<:bankaccount_id>

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

Sample queries

Get all bank accounts associated with a customer<:id>/bank-accounts

Get all cards associated with a customer<:id>/cards

Preview and data import

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

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


  • Now, the data design view page with the selected table schema opens. Drag and drop the table. Query Editor

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

Connected accounts for the 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.


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

Blog post