Connect to TaxJar Data in DBeaver

Ready to get started?

Download for a free trial:

Download Now

Learn more:

TaxJar JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with TaxJar.



Manage TaxJar data with visual tools in DBeaver like the query browser.

The CData JDBC Driver for TaxJar implements JDBC standards that enable third-party tools to interoperate, from wizards in IDEs to business intelligence tools. This article shows how to connect to TaxJar data with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for TaxJar Data

Follow the steps below to load the driver JAR in DBeaver.

  1. Open the DBeaver application and, in the Databases menu, select the Driver Manager option. Click New to open the Create New Driver form.
  2. In the Driver Name box, enter a user-friendly name for the driver.
  3. To add the .jar, click Add File.
  4. In the create new driver dialog that appears, select the cdata.jdbc.taxjar.jar file, located in the lib subfolder of the installation directory.
  5. Click the Find Class button and select the TaxJarDriver class from the results. This will automatically fill the Class Name field at the top of the form. The class name for the driver is cdata.jdbc.taxjar.TaxJarDriver.
  6. Add jdbc:taxjar: in the URL Template field.

Create a Connection to TaxJar Data

Follow the steps below to add credentials and other required connection properties.

  1. In the Databases menu, click New Connection.
  2. In the Create new connection wizard that results, select the driver.
  3. On the next page of the wizard, click the driver properties tab.
  4. Enter values for authentication credentials and other properties required to connect to TaxJar.

    To authenticate to the TaxJar API, you will need to first obtain the API Key from the TaxJar UI.

    NOTE: the API is available only for Professional and Premium TaxJar plans.

    If you already have a Professional or Premium plan you can find the API Key by logging in the TaxJar UI and navigating to Account -> TaxJar API. After obtaining the API Key, you can set it in the APIKey connection property.

    Additional Notes

    • By default, the CData connector will retrieve data of the last 3 months in cases where the entity support date range filtering. You can set StartDate to specify the minimum creation date of the data retrieved.
    • If the API Key has been created for a sandbox API account please set UseSandbox to true, but not all endpoints will work as expected. For more information, refer to the TaxJar developer documentation.

    Built-in Connection String Designer

    For assistance in constructing the JDBC URL, use the connection string designer built into the TaxJar JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

    java -jar cdata.jdbc.taxjar.jar

    Fill in the connection properties and copy the connection string to the clipboard.

    Below is a typical connection string:

    jdbc:taxjar:APIKey=3bb04218ef8t80efdf1739abf7257144;

Query TaxJar Data

You can now query information from the tables exposed by the connection: Right-click a Table and then click Edit Table. The data is available on the Data tab.