The Bold BI dashboard designer supports connecting the QuickBooks Payments web services through REST API.
To configure the QuickBooks Payments data source, follow these steps:
Click 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 QuickBooks Payments connection in the connection panel.
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.
Use the following steps to authenticate with QuickBooks Payments web service:
Click the data source, you will be prompted with a login window. Enter the credentials of your QuickBooks Payments account to authorize.
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.
Set a name to identify the account and click Next.
You have now successfully authorized your connection. Click Connect to continue with the data source connection.
To connect through already connected account, refer to the Connected Accounts.
NOTE: To connect another account, click Connect New Account.
After the successful authentication, the NEW DATA SOURCE configuration panel will open. Follow these steps to create a QuickBooks Payments data source.
You can also edit the connection information set here using the Edit Connection option.
|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.|
Replace it in the URL to query a particular account:
For more information on the API endpoints available for this data source, refer to their official API Documentation
Get all bank accounts associated with a customer
Get all cards associated with a customer
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.
Click Save, to save the data source with a relevant name..
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.