TaxJar Connection Details

Introduction

Connector Version

This documentation is based on version 23.0.9039 of the connector.

Get Started

TaxJar Version Support

The connector leverages v2 of the TaxJar API to enable bidirectional access to TaxJar.

Establish a Connection

Authenticate a TaxJar Account

To authenticate to the TaxJar API, you will need to first obtain the API Key from the TaxJar UI. Remember that the API is available only for Professional and Premium TaxJar plans. If you already have a Professional or Premium plan you can find the APIKey by logging in the TaxJar UI and going to Account->TaxJar API. After obtaining the API Key you can set the APIKey connection property. That's all you need to do for a successful connection.

Extra Notes

• By default the connector will retrieve data of the last 3 months in case the entity supports date range filtering. You can use the StartDate to set 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 in order for a successful connection.
• In case you are using a sandbox API account please remember that not everything will work as expected. This is also documented in the TaxJar developer docs here: Sandbox Environment and here: Unsupported endpoints
• The TaxJar API rate limiting is really generous. (10000 requests per minute for TaxJar Professional plans and 25000 per minute for the TaxJar Premium plans).
• Because of the TaxJar API limits we are restricted to make an http request for each row in order to collect as much data as we can. We suggest to increase the value of the MaxThreads connection property.
• The default value of MaxThreads has been set to 20 which means it will make at most 20 concurrent requests. To improve the performance of the connector consider increasing this value based on the machines resources.

Important Notes

Configuration Files and Their Paths

• All references to adding configuration files and their paths refer to files and locations on the Jitterbit agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.

Advanced Features

This section details a selection of advanced features of the TaxJar connector.

User Defined Views

The connector allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Proxy

To configure the connector using private agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.

Query Processing

The connector offloads as much of the SELECT statement processing as possible to TaxJar and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

User Defined Views

The TaxJar connector allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.

There are two ways to create user defined views:

• Create a JSON-formatted configuration file defining the views you want.
• DDL statements.

Define Views Using a Configuration File

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM Orders WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Define Views Using DDL Statements

The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.

Create a View

To create a new view using DDL statements, provide the view name and query as follows:

CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;

If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews connection property.

Alter a View

To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:

ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

The view is then updated in the JSON configuration file.

Drop a View

To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.

DROP LOCAL VIEW [MyViewName]

This removes the view from the JSON configuration file. It can no longer be queried.

Schema for User Defined Views

User Defined Views are exposed in the UserViews schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName property.

Work with User Defined Views

For example, a SQL statement with a User Defined View called UserViews.RCustomers only lists customers in Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resulting in the effective query to the source:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.

SSL Configuration

Customize the SSL Configuration

By default, the connector attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Data Model

Overview

This section shows the available API objects and provides more information on executing SQL to TaxJar APIs.

Key Features

• The connector models TaxJar entities like documents, folders, and groups as relational views, allowing you to write SQL to query TaxJar data.
• Stored procedures allow you to execute operations to TaxJar
• Live connectivity to these objects means any changes to your TaxJar account are immediately reflected when using the connector.

Views

Views describes the available views. Views are statically defined to model Categories, OrderLineItems, and more.

Tables

Tables describes the available tables. Tables are statically defined to model Customers, Orders, Refunds.

Stored Procedures

Stored Procedures are function-like interfaces to TaxJar. Stored procedures allow you to execute operations to TaxJar, including calculating sales tax and validating addresses.

Tables

The connector models the data in TaxJar as a list of tables in a relational database that can be queried using standard SQL statements.

TaxJar Connector Tables

Customers

Lists existing customers.

Select

The connector will use the TaxJar API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• CustomerID supports the following operators: =,IN

The following queries are processed server side:

SELECT * FROM Customers WHERE CustomerID = '123'
SELECT * FROM Customers WHERE CustomerID IN ('123', '1234')

Insert

To add a Order, at least the TransactionID, TransactionDate, ToCountry, ToZip, ToState, Amount, Shipping, SalesTax need to be specified. Also, the connector can execute an insert in 2 ways.
Using an aggregate to specify the exempt regions:

INSERT INTO Customers (CustomerID, ExemptionType, Name, Country, State, ZIP, City, Street, ExemptRegionsAggregate)
VALUES ('123', 'wholesale', 'Dunder Mifflin Paper Company', 'US', 'PA', '18504', 'Scranton', '1725 Slough Avenue',
'[
{
"country": "US",
"state": "FL"
},
{
"country": "US",
"state": "PA"
}
]')

Or using temporary tables to specify the exempt regions:

INSERT INTO CustomerExemptRegions#TEMP (State, Country) VALUES ('PA', 'US')
INSERT INTO CustomerExemptRegions#TEMP (State, Country) VALUES ('FL', 'US')

INSERT INTO Customers (CustomerID, ExemptionType, Name, Country, State, ZIP, City, Street, ExemptRegionsAggregate)
VALUES ('123', 'wholesale', 'Dunder Mifflin Paper Company', 'US', 'PA', '18504', 'Scranton', '1725 Slough Avenue', 'CustomerExemptRegions#TEMP')

Update

Similarly to the Insert operation, the connector can update an item in 2 ways.
Using an aggregate to specify the exempt regions:

UPDATE Customers SET CustomerID = '123', ExemptionType = 'non_exempt', Name = 'egi', Country = 'US', State = 'CA', ZIP = '90002', City = 'Los Angeles', Street = '123 Palm Grove Ln', ExemptRegionsAggregate = '[
      {
        "country": "US",
        "state": "FL"
      },
      {
        "country": "US",
        "state": "PA"
      }
]' WHERE CustomerID = 123

And using temporary tables to specify the exempt regions:

INSERT INTO CustomerExemptRegions#TEMP (State, Country) VALUES ('PA', 'US')
INSERT INTO CustomerExemptRegions#TEMP (State, Country) VALUES ('FL', 'US')
UPDATE Customers SET CustomerID = '1', ExemptionType = 'non_exempt', Name = 'egi', Country = 'US', State = 'CA', ZIP = '90002', City = 'Los Angeles', Street = '123 Palm Grove Ln', ExemptRegionsAggregate = 'CustomerExemptRegions#TEMP' WHERE CustomerID = 123

Delete

In order to delete a Customer the CustomerID needs to be specified, for ex.

DELETE FROM Customers WHERE CustomerID = '100'

Columns

Orders

Lists existing order transactions.

Select

The connector will use the TaxJar API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• TransactionDate supports the following operators: <,<=,=,>,>=
• TransactionID supports the following operators: =,IN
• Provider supports the following operator: = (By default the Provider is set to "api" which means that only data that has been created from the API will be retrieved.)

For the following query:

SELECT * FROM TableName

We have these 2 cases:

• StartDate connection property is not set. The connector will retrieve data of the last 3 months.
• StartDate connection property is set. The connector will retrieve data from the StartDate specified, until today.

The following queries are processed server side:

SELECT * FROM TableName WHERE TransactionID = '200'
SELECT * FROM TableName WHERE Provider = 'ebay'
SELECT * FROM TableName WHERE TransactionID IN ('123', '122')
SELECT * FROM TableName WHERE TransactionDate <= '2020/05/15' AND TransactionDate >= '2014/05/15'
SELECT * FROM TableName WHERE TransactionDate < '2015/05/15' AND TransactionDate > '2014/05/15'
SELECT * FROM TableName WHERE TransactionDate < '2015/05/15'
SELECT * FROM TableName WHERE TransactionDate > '2015/05/15'
SELECT * FROM TableName WHERE TransactionDate >= '2015/05/15'
SELECT * FROM TableName WHERE TransactionDate = '2015/05/15'

Insert

To add a Order, at least the TransactionID, TransactionDate, ToCountry, ToZip, ToState, Amount, Shipping, SalesTax need to be specified. Also we can execute an insert in 2 ways.
Using an aggregate to specify the line items:

INSERT INTO Orders (TransactionID, UserID, TransactionDate, Provider, ExemptionType, FromCountry, FromZip, FromState, FromCity, FromStreet, ToCountry, ToZip, ToState, ToCity, ToStreet, Amount, Shipping, SalesTax, LineItemsAggregate)
        VALUES ('123', '2', '2015/05/05', 'api', 'non_exempt', 'US', '', 'NC', '', '', 'US', '90002', 'CA', 'Los Angeles', '123 Palm Grove Ln', '15', '0', 1,
     '[
        {
          "id": 2,
          "quantity": 2,
          "product_identifier": "22-22222-2",
          "description": "Fuzzy Widget",
          "unit_price": 5,
          "sales_tax": 0.0
        },
        {
          "id": 1,
          "quantity": 1,
          "product_identifier": "11-11111-1",
          "description": "Fuzzy Widget",
          "unit_price": 5,
          "sales_tax": 0.0
        }
]')

Or using temporary tables to specify the line items:

INSERT INTO [OrderLineItems#TEMP] (ID, Quantity, ProductIdentifier, Description, ProductTaxCode, UnitPrice, Discount, SalesTax) VALUES ('1', '1', '11-11111-1', 'description 1', '', '5', '', '0.0')
INSERT INTO [OrderLineItems#TEMP] (ID, Quantity, ProductIdentifier, Description, ProductTaxCode, UnitPrice, Discount, SalesTax) VALUES ('2', '2', '22-22222-2', 'description 2', '', '5', '', '0.0')
INSERT INTO Orders (TransactionID, UserID, TransactionDate, Provider, ExemptionType, FromCountry, FromZip, FromState, FromCity, FromStreet, ToCountry, ToZip, ToState, ToCity, ToStreet, Amount, Shipping, SalesTax, LineItemsAggregate)
"VALUES ('123', '2', '2015/05/05', 'api', 'non_exempt', 'US', '', 'NC', '', '', 'US', '90002', 'CA', 'Los Angeles', '123 Palm Grove Ln', '15', '0', 1, 'OrderLineItems#TEMP')

Update

Similarly to the Insert operation we can update an item in 2 ways.
Using an aggregate to specify the line items:

UPDATE Orders SET TransactionID = '111', UserID = '2', TransactionDate = '2015/05/05', Provider = 'api', ExemptionType = 'non_exempt', FromCountry = 'US', FromZip = '', FromState = 'NC',
FromCity = '', FromStreet = '', ToCountry = 'US', ToZip = '90002', ToState = 'CA', ToCity = 'Los Angeles', ToStreet = '123 Palm Grove Ln', Amount = '15', Shipping = '0', SalesTax = 1,
LineItemsAggregate = '[
{
"id": 2,
"quantity": 2,
"product_identifier": "22-22222-2",
"description": "Fuzzy Widget",
"unit_price": 5,
"sales_tax": 0.0
},
{
"id": 1,
"quantity": 1,
"product_identifier": "11-11111-1",
"description": "Fuzzy Widget",
"unit_price": 5,
"sales_tax": 0.0
}
]'

And using temporary tables to specify the line items:

INSERT INTO [OrderLineItems#TEMP] (ID, Quantity, ProductIdentifier, Description, ProductTaxCode, UnitPrice, Discount, SalesTax) VALUES ('1', '1', '11-11111-1', 'description 1', '', '5', '', '0.0')
INSERT INTO [OrderLineItems#TEMP] (ID, Quantity, ProductIdentifier, Description, ProductTaxCode, UnitPrice, Discount, SalesTax) VALUES ('2', '2', '22-22222-2', 'description 2', '', '5', '', '0.0')
UPDATE Orders SET TransactionID = '123', UserID = '2', TransactionDate = '2015/05/05', Provider = 'api', ExemptionType = 'non_exempt', FromCountry = 'US', FromZip = '', FromState = 'NC', FromCity = '', FromStreet = '', ToCountry = 'US', ToZip = '90002', ToState = 'CA', ToCity = 'Los Angeles', ToStreet = '123 Palm Grove Ln', Amount = '15', Shipping = '0', SalesTax = 1, LineItemsAggregate = 'OrderLineItems#TEMP' WHERE TransactionID = '123'

Delete

In order to delete an Order the TransactionID needs to be specified, for ex.

DELETE FROM Orders WHERE TransactionID = '100'

Columns

Refunds

Lists existing refund transactions.

Select

The connector will use the TaxJar API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• TransactionDate supports the following operators: <,<=,=,>,>=
• TransactionID supports the following operators: =,IN
• Provider supports the following operator: = (By default the Provider is set to "api" which means that only data that has been created from the API will be retrieved.)

For the following query:

SELECT * FROM TableName

We have these 2 cases:

• StartDate connection property is not set. The connector will retrieve data of the last 3 months.
• StartDate connection property is set. The connector will retrieve data from the StartDate specified, until today.

The following queries are processed server side:

SELECT * FROM TableName WHERE TransactionID = '200'
SELECT * FROM TableName WHERE Provider = 'ebay'
SELECT * FROM TableName WHERE TransactionID IN ('123', '122')
SELECT * FROM TableName WHERE TransactionDate <= '2020/05/15' AND TransactionDate >= '2014/05/15'
SELECT * FROM TableName WHERE TransactionDate < '2015/05/15' AND TransactionDate > '2014/05/15'
SELECT * FROM TableName WHERE TransactionDate < '2015/05/15'
SELECT * FROM TableName WHERE TransactionDate > '2015/05/15'
SELECT * FROM TableName WHERE TransactionDate >= '2015/05/15'
SELECT * FROM TableName WHERE TransactionDate = '2015/05/15'

Insert

To add a Order, at least the TransactionID, TransactionDate, ToCountry, ToZip, ToState, Amount, Shipping, SalesTax need to be specified. Also we can execute an insert in 2 ways.
Using an aggregate to specify the line items:

INSERT INTO Refunds (TransactionID, UserID, TransactionDate, Provider, ExemptionType, FromCountry, FromZip, FromState, FromCity, FromStreet, ToCountry, ToZip, ToState, ToCity, ToStreet, Amount, Shipping, SalesTax, LineItemsAggregate)
        VALUES ('123', '2', '2015/05/05', 'api', 'non_exempt', 'US', '', 'NC', '', '', 'US', '90002', 'CA', 'Los Angeles', '123 Palm Grove Ln', '15', '0', 1,
     '[
        {
          "id": 2,
          "quantity": 2,
          "product_identifier": "22-22222-2",
          "description": "Fuzzy Widget",
          "unit_price": 5,
          "sales_tax": 0.0
        },
        {
          "id": 1,
          "quantity": 1,
          "product_identifier": "11-11111-1",
          "description": "Fuzzy Widget",
          "unit_price": 5,
          "sales_tax": 0.0
        }
]')

Or using temporary tables to specify the line items:

INSERT INTO [RefundLineItems#TEMP] (ID, Quantity, ProductIdentifier, Description, ProductTaxCode, UnitPrice, Discount, SalesTax) VALUES ('1', '1', '11-11111-1', 'description 1', '', '5', '', '0.0')
INSERT INTO [RefundLineItems#TEMP] (ID, Quantity, ProductIdentifier, Description, ProductTaxCode, UnitPrice, Discount, SalesTax) VALUES ('2', '2', '22-22222-2', 'description 2', '', '5', '', '0.0')
INSERT INTO Refunds (TransactionID, UserID, TransactionDate, Provider, ExemptionType, FromCountry, FromZip, FromState, FromCity, FromStreet, ToCountry, ToZip, ToState, ToCity, ToStreet, Amount, Shipping, SalesTax, LineItemsAggregate)
"VALUES ('123', '2', '2015/05/05', 'api', 'non_exempt', 'US', '', 'NC', '', '', 'US', '90002', 'CA', 'Los Angeles', '123 Palm Grove Ln', '15', '0', 1, 'RefundLineItems#TEMP')

Update

Similarly to the Insert operation we can update an item in 2 ways.
Using an aggregate to specify the line items:

UPDATE Refunds SET TransactionID = '111', UserID = '2', TransactionDate = '2015/05/05', Provider = 'api', ExemptionType = 'non_exempt', FromCountry = 'US', FromZip = '', FromState = 'NC',
FromCity = '', FromStreet = '', ToCountry = 'US', ToZip = '90002', ToState = 'CA', ToCity = 'Los Angeles', ToStreet = '123 Palm Grove Ln', Amount = '15', Shipping = '0', SalesTax = 1,
LineItemsAggregate = '[
{
"id": 2,
"quantity": 2,
"product_identifier": "22-22222-2",
"description": "Fuzzy Widget",
"unit_price": 5,
"sales_tax": 0.0
},
{
"id": 1,
"quantity": 1,
"product_identifier": "11-11111-1",
"description": "Fuzzy Widget",
"unit_price": 5,
"sales_tax": 0.0
}
]'

And using temporary tables to specify the line items:

INSERT INTO [RefundLineItems#TEMP] (ID, Quantity, ProductIdentifier, Description, ProductTaxCode, UnitPrice, Discount, SalesTax) VALUES ('1', '1', '11-11111-1', 'description 1', '', '5', '', '0.0')
INSERT INTO [RefundLineItems#TEMP] (ID, Quantity, ProductIdentifier, Description, ProductTaxCode, UnitPrice, Discount, SalesTax) VALUES ('2', '2', '22-22222-2', 'description 2', '', '5', '', '0.0')
UPDATE Refunds SET TransactionID = '123', UserID = '2', TransactionDate = '2015/05/05', Provider = 'api', ExemptionType = 'non_exempt', FromCountry = 'US', FromZip = '', FromState = 'NC', FromCity = '', FromStreet = '', ToCountry = 'US', ToZip = '90002', ToState = 'CA', ToCity = 'Los Angeles', ToStreet = '123 Palm Grove Ln', Amount = '15', Shipping = '0', SalesTax = 1, LineItemsAggregate = 'RefundLineItems#TEMP' WHERE TransactionID = '123'

Delete

In order to delete an Refund the TransactionID needs to be specified, for ex.

DELETE FROM Refunds WHERE TransactionID = '100'

Columns

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

TaxJar Connector Views

Categories

Lists all tax categories.

Columns

CustomerExemptRegions

Lists exempt regions of a customer.

Columns

NexusRegions

Lists existing nexus locations for a TaxJar account.

Columns

OrderLineItems

Lists existing order transactions.

Select

The connector will use the TaxJar API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• TransactionDate supports the following operators: <,<=,=,>,>=
• TransactionID supports the following operators: =,IN
• Provider supports the following operator: = (By default the Provider is set to "api" which means that only data that has been created from the API will be retrieved.)

For the following query:

SELECT * FROM TableName

We have these 2 cases:

• StartDate connection property is not set. The connector will retrieve data of the last 3 months.
• StartDate connection property is set. The connector will retrieve data from the StartDate specified, until today.

The following queries are processed server side:

SELECT * FROM TableName WHERE TransactionID = '200'
SELECT * FROM TableName WHERE Provider = 'ebay'
SELECT * FROM TableName WHERE TransactionID IN ('123', '122')
SELECT * FROM TableName WHERE TransactionDate <= '2020/05/15' AND TransactionDate >= '2014/05/15'
SELECT * FROM TableName WHERE TransactionDate < '2015/05/15' AND TransactionDate > '2014/05/15'
SELECT * FROM TableName WHERE TransactionDate < '2015/05/15'
SELECT * FROM TableName WHERE TransactionDate > '2015/05/15'
SELECT * FROM TableName WHERE TransactionDate >= '2015/05/15'
SELECT * FROM TableName WHERE TransactionDate = '2015/05/15'

Columns

RefundLineItems

Lists line items of an order transactions.

Select

The connector will use the TaxJar API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• TransactionDate supports the following operators: <,<=,=,>,>=
• TransactionID supports the following operators: =,IN
• Provider supports the following operator: = (By default the Provider is set to "api" which means that only data that has been created from the API will be retrieved.)

For the following query:

SELECT * FROM TableName

We have these 2 cases:

• StartDate connection property is not set. The connector will retrieve data of the last 3 months.
• StartDate connection property is set. The connector will retrieve data from the StartDate specified, until today.

The following queries are processed server side:

SELECT * FROM TableName WHERE TransactionID = '200'
SELECT * FROM TableName WHERE Provider = 'ebay'
SELECT * FROM TableName WHERE TransactionID IN ('123', '122')
SELECT * FROM TableName WHERE TransactionDate <= '2020/05/15' AND TransactionDate >= '2014/05/15'
SELECT * FROM TableName WHERE TransactionDate < '2015/05/15' AND TransactionDate > '2014/05/15'
SELECT * FROM TableName WHERE TransactionDate < '2015/05/15'
SELECT * FROM TableName WHERE TransactionDate > '2015/05/15'
SELECT * FROM TableName WHERE TransactionDate >= '2015/05/15'
SELECT * FROM TableName WHERE TransactionDate = '2015/05/15'

Columns

SummarizedRates

Retrieve minimum and average sales tax rates by region.

Columns

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT/INSERT/UPDATE/DELETE operations with TaxJar.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from TaxJar, along with an indication of whether the procedure succeeded or failed.

TaxJar Connector Stored Procedures

CalculateTaxes

Shows the sales tax that should be collected for a given order.

Calculate Taxes

To calculate taxes for a given order the CalculateTaxes stored procedure must be called. To make a CalculateTaxes SP call please specify at least ToCountry and Shipping parameters.

Note: For adding more than one values to "NexusAddresses" and "LineItems", you can use the NexusAddresses#TEMP and LineItems#TEMP tables or create the JSON structure to provide the values to insert.

In order to avoid errors please follow the conditions for a successful SP call enforced by the TaxJar API:

• If ToCountry is set to US, ToZIP is required.
• If ToCountry is set to US or CA, ToState is required.
• If any NexusAddresses is provided, NexusAddressesCountry and NexusAddressesState is required.
• Specify either Amount or LineItems to perform tax calculations.

EXEC CalculateTaxes
@FromCountry = 'US',
@FromZip = '92093',
@FromState = 'CA',
@FromCity = 'La Jolla',
@FromStreet = '9500 Gilman Drive',
@ToCountry = 'US',
@ToZip = '90002',
@ToState = 'CA',
@ToCity = 'Los Angeles',
@ToStreet = '1335 E 103rd St',
@Amount = '15',
@Shipping = '1.5',
@NexusAddressId = 'Main Location',
@NexusAddressCountry = 'US',
@NexusAddressZip = '92093',
@NexusAddressState = 'CA',
@NexusAddressCity = 'La Jolla',
@NexusAddressStreet = '9500 Gilman Drive'

INSERT INTO NexusAddresses#TEMP (NexusAddressID, NexusAddressCountry, NexusAddressZip, NexusAddressState, NexusAddressCity, NexusAddressStreet) VALUES ('Main Location', 'US', '92093', 'CA', 'La Jolla', '9500 Gilman Drive')
INSERT INTO NexusAddresses#TEMP (NexusAddressID, NexusAddressCountry, NexusAddressZip, NexusAddressState, NexusAddressCity, NexusAddressStreet) VALUES ('Main Location 2', 'US', '92093', 'CA', 'La Jolla 2', '9500 Gilman Drive 2')
INSERT INTO LineItems#TEMP (LineItemId, LineItemQuantity, LineItemProductTaxCode, LineItemUnitPrice, LineItemDiscount) VALUES ('1', '1', '20010', '15', '0')

EXEC CalculateTaxes
@FromCountry = 'US',
@FromZip = '92093',
@FromState = 'CA',
@FromCity = 'La Jolla',
@FromStreet = '9500 Gilman Drive',
@ToCountry = 'US',
@ToZip = '90002',
@ToState = 'CA',
@ToCity = 'Los Angeles',
@ToStreet = '1335 E 103rd St',
@Amount = '15',
@Shipping = '1.5',
@NexusAddresses = 'NexusAddresses#TEMP',
@LineItems = 'LineItems#TEMP'

EXEC CalculateTaxes
@FromCountry = 'US',
@FromZip = '92093',
@FromState = 'CA',
@FromCity = 'La Jolla',
@FromStreet = '9500 Gilman Drive',
@ToCountry = 'US',
@ToZip = '90002',
@ToState = 'CA',
@ToCity = 'Los Angeles',
@ToStreet = '1335 E 103rd St',
@Amount = '15',
@Shipping = '1.5',
@NexusAddresses = '[{"NexusAddressId":"Main Location","NexusAddresscountry":"US","NexusAddresszip":"92093","NexusAddressstate":"CA","NexusAddresscity":"La Jolla","NexusAddressstreet":"9500 Gilman Drive"},{"NexusAddressid":"Main Location 2","NexusAddresscountry":"US","NexusAddresszip":"92093","NexusAddressstate":"CA","NexusAddresscity":"La Jolla 2","NexusAddressstreet":"9500 Gilman Drive 2"}]',
@LineItems = '[{"LineItemid":"1","LineItemquantity":"1","LineItemproducttaxcode":"20010","LineItemunitprice":"15","LineItemdiscount":"0"}]'

Input

Result Set Columns

GetTaxRate

Get tax rates for a location.

Input

Result Set Columns

ValidateAddress

Validates a customer address and returns back a collection of address matches.

Input

Result Set Columns

ValidateVAT

Validates an existing VAT identification number

Input

Result Set Columns

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for TaxJar:

• sys_catalogs: Lists the available databases.
• sys_schemas: Lists the available schemas.
• sys_tables: Lists the available tables and views.
• sys_tablecolumns: Describes the columns of the available tables and views.
• sys_procedures: Describes the available stored procedures.
• sys_procedureparameters: Describes stored procedure parameters.
• sys_keycolumns: Describes the primary and foreign keys.
• sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

• sys_connection_props: Returns information on the available connection properties.
• sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

• sys_identity: Returns information about batch operations or single updates.

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

SELECT * FROM sys_schemas

Columns

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

SELECT * FROM sys_tables

Columns

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Orders table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Orders'

Columns

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

SELECT * FROM sys_procedures

Columns

sys_procedureparameters

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the ValidateVAT stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='ValidateVAT' AND Direction=1 OR Direction=2

Columns

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the Orders table:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Orders'

Columns

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columns

sys_primarykeys

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

SELECT * FROM sys_primarykeys

Columns

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

When querying this table, the config connection string should be used:

jdbc:cdata:taxjar:config:

This connection string enables you to query this table without a valid connection.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

sys_sqlinfo

Describes the SELECT query processing that the connector can offload to the data source.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

SELECT * FROM sys_identity

Columns

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

Advanced Configurations Properties

The advanced configurations properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure. Click the links for further details.

Authentication

SSL

Schema

Miscellaneous

Other

Authentication

This section provides a complete list of authentication properties you can configure.

APIKey

The APIKey obtained from the TaxJar UI.

Data Type

string

Default Value

""

Remarks

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.

UseSandbox

Whether to connect to the sandbox environment or not.

Data Type

bool

Default Value

false

Remarks

Set this to true to connect to the TaxJar sandbox environment. Remember that the APIKey must also be generated for the sandbox environment.

SSL

This section provides a complete list of SSL properties you can configure.

SSLServerCert

The certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

If not specified, any certificate trusted by the machine is accepted.

Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Schema

This section provides a complete list of schema properties you can configure.

Location

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Data Type

string

Default Value

%APPDATA%\TaxJar Data Provider\Schema

Remarks

The path to a directory which contains the schema files for the connector (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\TaxJar Data Provider\Schema" with %APPDATA% being set to the user's configuration directory:

BrowsableSchemas

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type

string

Default Value

""

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Tables

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Data Type

string

Default Value

""

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Views

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Data Type

string

Default Value

""

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Miscellaneous

This section provides a complete list of miscellaneous properties you can configure.

MaxRows

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Data Type

int

Default Value

-1

Remarks

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

MaxThreads

Specifies the number of concurrent requests.

Data Type

string

Default Value

20

Remarks

This property allows you to issue multiple requests simultaneously, thereby improving performance.

The TaxJar API has a rate limit of 10000 requests per minute for TaxJar Professional plans and 25000 per minute for the TaxJar Premium plans.

Because of the TaxJar API limits, the connector is restricted to making an http request for each row in order to collect as much data as possible.

To improve the performance of the connector consider increasing this value based on the machine's resources.

Other

These hidden properties are used only in specific use cases.

Data Type

string

Default Value

""

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

PseudoColumns

This property indicates whether or not to include pseudo columns as columns to the table.

Data Type

string

Default Value

""

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

Timeout

The value in seconds until the timeout error is thrown, canceling the operation.

Data Type

int

Default Value

60

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the connector throws an exception.

UserDefinedViews

A filepath pointing to the JSON configuration file containing your custom views.

Data Type

string

Default Value

""

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM Orders WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json

Note that the specified path is not embedded in quotation marks.

Other

This section provides a complete list of the Other properties you can configure.

StartDate

Determines the start date of the transaction orders/refunds.

Data Type

string

Default Value

""

Remarks

By default the orders or refunds retrieved from the API will be those of the last 3 months. In order to change this range please set this connection property to a desired date using the format YYYY/MM/DD.