JDBC Driver for Avalara

Build 23.0.8839

Establishing a Connection

Creating a JDBC Data Source

You can create a JDBC data source to connect from your Java application. Creating a JDBC data source based on the CData JDBC Driver for Avalara consists of three basic steps:

  • Add the driver JAR file to the classpath. The JAR file is located in the lib subfolder of the installation directory. Note that the .lic file must be located in the same folder as the JAR file.
  • Provide the driver class. For example:
    cdata.jdbc.avalara.AvalaraDriver
  • Provide the JDBC URL. For example:
    jdbc:avalara:User=MyUser;Password=MyPassword;
    
    or
    
    jdbc:cdata:avalara:User=MyUser;Password=MyPassword;

    The second format above can be used whenever there is a conflict in your application between drivers using the same URL format to ensure you are using the CData driver. The URL must start with either "jdbc:avalara:" or "jdbc:cdata:avalara:" and can include any of the connection properties in name-value pairs separated with semicolons.

Connecting to Avalara

By default, the driver connects to a production environment. Set UseSandbox to true to configure the driver to connect to a Avalara sandbox environment.

Authenticating to Avalara

There are two authentication methods available for connecting to the Avalara data source: Basic and LicenseKey.

Login Credentials

To use login credentials for authentication, set the following:

  • AuthScheme: Set this to Basic.
  • User: Set this to your Avalara username.
  • Password: Set this to your Avalara password.

Account Number and License Key

Alternatively, you can authenticate using your account number and license key. Connect to the data source using the following:

  • AuthScheme: Set this to LicenseKey.
  • AccountId: Set this to your Avalara Account Id. The Account Id is listed in the upper right-hand corner of the Avalara admin console.
  • LicenseKey: Set this to your Avalara license key. You can generate a license key by logging into Avalara as an account adminstrator and navigating to Settings > Reset License Key.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839