Query Avalara AvaTax Data as a MySQL Database in Node.js

You can use the SQL Gateway from the ODBC Driver for Avalara AvaTax to query Avalara AvaTax data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and start querying using Node.js.

Connect to Avalara AvaTax Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

The primary method for performing basic authentication is to provide your login credentials, as follows:

• User: Set this to your username.
• Password: Set this to your password.

Optionally, if you are making use of a sandbox environment, set the following:

• UseSandbox: Set this to true if you are authenticating with a sandbox account.

Authenticating Using Account Number and License Key

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

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

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Avalara AvaTax data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

Query Avalara AvaTax from Node.js

The following example shows how to define a connection and execute queries to Avalara AvaTax with the mysql module. You will need the following information:

• Host name or address, and port: The machine and port where the MySQL remoting service is listening for MySQL connections.
• Username and password: The username and password of a user you authorized on the Users tab of the SQL Gateway.
• Database name: The DSN you configured for the MySQL remoting service.

Connect to Avalara AvaTax data and start executing queries with the code below:

var mysql      = require('mysql');
var connection = mysql.createConnection({
  host     : 'localhost',
  database : 'CData AvalaraAvatax Sys',
  port	   : '3306',
  user     : 'mysql_user',
  password : 'test'
});
connection.connect();
connection.query('SELECT * FROM Transactions', function(err, rows, fields) {
  if (err) throw err;
  console.log(rows);
});

connection.end();