Ir para o conteúdo

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

Name Description
Customers Lists existing customers.
Orders Lists existing order transactions.
Refunds Lists existing refund transactions.

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
Name Type ReadOnly Description
CustomerID [KEY] String False Unique identifier of the given customer.
ExemptionType String False Type of customer exemption: wholesale, government, other, or non_exempt.
Name String False Name of the customer.
Country String False Two-letter ISO country code of the customers primary address.
State String False Two-letter ISO state code of the customers primary address.
ZIP String False Postal code of the customers primary address.
City String False City of the customers primary address.
Street String False Street address of the customers primary address.
ExemptRegionsAggregate String False Places where the customer is exempt.

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
Name Type ReadOnly Description
TransactionID [KEY] String False Unique identifier of the given order transaction.
UserID Int False Unique identifier of the user who created the order transaction.
TransactionDate Date False The date/time the transaction was originally recorded.
Provider String False Source of where the transaction was originally recorded.
ExemptionType String False Type of exemption for the order: wholesale, government, marketplace, other, non_exempt, or null.
FromCountry String False Two-letter ISO country code of the country where the order shipped from.
FromZip String False Postal code where the order shipped from (5-Digit ZIP or ZIP+4).
FromState String False Two-letter ISO state code where the order shipped from.
FromCity String False City where the order shipped from.
FromStreet String False Street address where the order shipped from.
ToCountry String False Two-letter ISO country code of the country where the order shipped to.
ToZip String False Postal code where the order shipped to (5-Digit ZIP or ZIP+4).
ToState String False Two-letter ISO state code where the order shipped to.
ToCity String False City where the order shipped to.
ToStreet String False Street address where the order shipped to.
Amount Double False Total amount of the order with shipping, excluding sales tax.
Shipping Double False Total amount of shipping for the order.
SalesTax Double False Total amount of sales tax collected for the order.
LineItemsAggregate String False Street address where the order shipped to.

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
Name Type ReadOnly Description
TransactionID [KEY] String False Unique identifier of the given refund transaction.
TransactionReferenceID String False Unique identifier of the corresponding order transaction for the refund.
UserID Int False Unique identifier of the user who created the refund transaction.
TransactionDate Date False The date/time the transaction was originally recorded.
Provider String False Source of where the transaction was originally recorded.
ExemptionType String False Type of exemption for the order: wholesale, government, marketplace, other, non_exempt, or null.
FromCountry String False Two-letter ISO country code of the country where the order shipped from.
FromZip String False Postal code where the order shipped from (5-Digit ZIP or ZIP+4).
FromState String False Two-letter ISO state code where the order shipped from.
FromCity String False City where the order shipped from.
FromStreet String False Street address where the order shipped from.
ToCountry String False Two-letter ISO country code of the country where the order shipped to.
ToZip String False Postal code where the order shipped to (5-Digit ZIP or ZIP+4).
ToState String False Two-letter ISO state code where the order shipped to.
ToCity String False City where the order shipped to.
ToStreet String False Street address where the order shipped to.
Amount Double False Total amount of the refunded order with shipping, excluding sales tax.
Shipping Double False Total amount of shipping for the refunded order.
SalesTax Double False Total amount of sales tax collected for the refunded order.
LineItemsAggregate String False Street address where the order shipped to.

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

Name Description
Categories Lists all tax categories.
CustomerExemptRegions Lists exempt regions of a customer.
NexusRegions Lists existing nexus locations for a TaxJar account.
OrderLineItems Lists existing order transactions.
RefundLineItems Lists line items of an order transactions.
SummarizedRates Retrieve minimum and average sales tax rates by region.

Categories

Lists all tax categories.

Columns
Name Type Description
ProductTaxCode String Tax code of the given product category.
Name String Name of the given product category.
Description String Description of the given product category.

CustomerExemptRegions

Lists exempt regions of a customer.

Columns
Name Type Description
CustomerID [KEY] String Unique identifier of the given customer.
State String Two-letter ISO country code where the customer is exempt.
Country String Two-letter ISO state code where the customer is exempt.

NexusRegions

Lists existing nexus locations for a TaxJar account.

Columns
Name Type Description
CountryCode String Two-letter ISO country code for nexus region.
Country String Country name for nexus region.
RegionCode String Two-letter ISO region code for nexus region.
Region String Region name for nexus region.

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
Name Type Description
TransactionID [KEY] String Unique identifier of the given order transaction.
TransactionDate Date The date/time the transaction was originally recorded.
Provider String Source of where the transaction was originally recorded.
ID [KEY] String Unique identifier of the given line item.
Quantity Int Quantity for the item.
ProductIdentifier String Product identifier for the item.
Description String Description of the line item (up to 255 characters).
ProductTaxCode String Product tax code for the item.
UnitPrice Double Unit price for the item in dollars.
Discount Double Total discount (non-unit) for the item in dollars.
SalesTax Double Total sales tax collected (non-unit) for the item in dollars.

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
Name Type Description
TransactionID [KEY] String Unique identifier of the given order transaction.
TransactionDate Date The date/time the transaction was originally recorded.
Provider String Source of where the transaction was originally recorded.
ID [KEY] String Unique identifier of the given line item.
Quantity Int Quantity for the item.
ProductIdentifier String Product identifier for the item.
Description String Description of the line item (up to 255 characters).
ProductTaxCode String Product tax code for the item.
UnitPrice Double Unit price for the item in dollars.
Discount Double Total discount (non-unit) for the item in dollars.
SalesTax Double Total sales tax collected (non-unit) for the item in dollars.

SummarizedRates

Retrieve minimum and average sales tax rates by region.

Columns
Name Type Description
CountryCode String Two-letter ISO country code for summarized region.
Country String Country name for summarized region.
RegionCode String Two-letter ISO region code for summarized region.
Region String Region name for summarized region.
MinimumRateLabel String Region/state-only sales tax label.
MinimumRate String Region/state-only sales tax rate.
AverageRateLabel String Average rate for region/state label.
AverageRate String Average rate for region/state and local sales tax across all postal codes in the summarized region.

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

Name Description
CalculateTaxes Shows the sales tax that should be collected for a given order.
GetTaxRate Get tax rates for a location.
ValidateAddress Validates a customer address and returns back a collection of address matches.
ValidateVAT Validates an existing VAT identification number

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
Name Type Required Description
FromCountry String False Two-letter ISO country code of the country where the order shipped from. View Note
FromZip String False Postal code where the order shipped from (5-Digit ZIP or ZIP+4).
FromState String False Two-letter ISO state code where the order shipped from.
FromCity String False City where the order shipped from.
FromStreet String False Street address where the order shipped from.
ToCountry String True Two-letter ISO country code of the country where the order shipped to.
ToZip String False Postal code where the order shipped to (5-Digit ZIP or ZIP+4).
ToState String False Two-letter ISO state code where the order shipped to.
ToCity String False City where the order shipped to.
ToStreet String False Street address where the order shipped to. View Note
Amount Double False Total amount of the order, excluding shipping. View Note
Shipping Double True Total amount of shipping for the order.
CustomerId String False Unique identifier of the given customer for exemptions.
ExemptionType String False Type of exemption for the order: wholesale, government, marketplace, other, or non_exempt.
NexusAddressId String False Unique identifier of the given nexus address. This column input will not be accepted if NexusAddresses column is added.
NexusAddressCountry String False Two-letter ISO country code for the nexus address. This column input will not be accepted if NexusAddresses column is added.
NexusAddressZip String False Postal code for the nexus address. This column input will not be accepted if NexusAddresses column is added.
NexusAddressState String False Two-letter ISO state code for the nexus address. This column input will not be accepted if NexusAddresses column is added.
NexusAddressCity String False City for the nexus address. This column input will not be accepted if NexusAddresses column is added.
NexusAddressStreet String False Street address for the nexus address. This column input will not be accepted if NexusAddresses column is added.
NexusAddresses String False The aggregate for Nexus Addresses.
LineItemId String False Unique identifier of the given line item. This column input will not be accepted if LineItems column is added.
LineItemQuantity Integer False Quantity for the item. This column input will not be accepted if LineItems column is added.
LineItemProductTaxCode String False Product tax code for the item. This column input will not be accepted if LineItems column is added.
LineItemUnitPrice Double False Unit price for the item. This column input will not be accepted if LineItems column is added.
LineItemDiscount Double False Total discount (non-unit) for the item. This column input will not be accepted if LineItems column is added.
LineItems String False The aggregate for Line Items.
Result Set Columns
Name Type Description
OrderTotalAmount Double Total amount of the order.
Shipping Double Total amount of shipping for the order.
TaxableAmount Double Amount of the order to be taxed.
AmountToCollect Double Amount of sales tax to collect.
Rate Double Overall sales tax rate of the order (amount_to_collect ÷ taxable_amount).
HasNexus Bool Whether or not you have nexus for the order based on an address on file, nexus_addresses parameter, or from_ parameters.
FreightTaxable Bool Freight taxability for the order.
TaxSource String Origin-based or destination-based sales tax collection.
ExemptionType String Type of exemption for the order: wholesale, government, marketplace, other, or non_exempt. If no customer_id or exemption_type is provided, no exemption_type is returned in the response.
JurisdictionAggregate String Jurisdiction names for the order.
BreakdownAggregate String Breakdown of rates by jurisdiction for the order, shipping, and individual line items. If has_nexus is false or no line items are provided, no breakdown is returned in the response.

GetTaxRate

Get tax rates for a location.

Input
Name Type Required Description
ZIP String True Postal code for given location (5-Digit ZIP or ZIP+4).
Country String False Two-letter ISO country code for given location.
State String False Two-letter ISO state code for given location.
City String False City for given location.
Street String False Street address for given location.
Result Set Columns
Name Type Description
ZIP String Whether or not the VAT number is valid via regex and VIES.
Country String Country for given location if SST state.
CountryRate Double Country sales tax rate for given location if SST state.
State String Postal abbreviated state name for given location.
StateRate Double State sales tax rate for given location.
County String County name for given location.
CountyRate Double County sales tax rate for given location.
City String City name for given location.
CityRate Double City sales tax rate for given location.
CombinedDistrictRate Double Aggregate rate for all city and county sales tax districts effective at the location.
CombinedRate Double Overall sales tax rate which includes state, county, city and district tax. This rate should be used to determine how much sales tax to collect for an order.
FreightTaxable Bool Freight taxability for given location.
Name String Country name for given location.
StandardRate Double Standard rate for given location.
ReducedRate Double Reduced rate for given location.
SuperReducedRate Double Super reduced rate for given location.
ParkingRate Double Parking reduced rate for given location.
DistanceSaleThreshold Double Distance selling threshold for given location.

ValidateAddress

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

Input
Name Type Required Description
Country String False Two-letter ISO country code of the customers address.
State String False Two-letter ISO state code of the customers address.
ZIP String False Postal code for given location (5-Digit ZIP or ZIP+4).
City String False City of the customers address.
Street String False Street address of the customers address or the entire address as freeform input.
Result Set Columns
Name Type Description
AdressAggregates String Collection of address matches

ValidateVAT

Validates an existing VAT identification number

Input
Name Type Required Description
VAT String True VAT identification number to validate. Country code should precede number, e.g. GB980780684.
Result Set Columns
Name Type Description
Valid Bool Whether or not the VAT number is valid via regex and VIES.
Exists Bool Whether or not the VAT number exists in VIES.
ViesAvailable Bool Whether or not VIES is currently available.
ViesResponseCountryCode String Country code returned by VIES based on the given VAT number.
ViesResponseVatNumber String VAT number returned by VIES based on the given VAT number.
ViesResponseRequestDate Date Request date returned by VIES based on the given VAT number.
ViesResponseValid Bool Whether or not the VAT number is valid, returned by VIES based on the given VAT number.
ViesResponseName String Name returned by VIES based on the given VAT number.
ViesResponseAddress String Address returned by VIES based on the given VAT number.

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:

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
Name Type Description
CatalogName String The database name.

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

SELECT * FROM sys_schemas
Columns
Name Type Description
CatalogName String The database name.
SchemaName String The schema name.

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

SELECT * FROM sys_tables
Columns
Name Type Description
CatalogName String The database containing the table or view.
SchemaName String The schema containing the table or view.
TableName String The name of the table or view.
TableType String The table type (table or view).
Description String A description of the table or view.
IsUpdateable Boolean Whether the table can be updated.

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
Name Type Description
CatalogName String The name of the database containing the table or view.
SchemaName String The schema containing the table or view.
TableName String The name of the table or view containing the column.
ColumnName String The column name.
DataTypeName String The data type name.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
Length Int32 The storage size of the column.
DisplaySize Int32 The designated column's normal maximum width in characters.
NumericPrecision Int32 The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale Int32 The column scale or number of digits to the right of the decimal point.
IsNullable Boolean Whether the column can contain null.
Description String A brief description of the column.
Ordinal Int32 The sequence number of the column.
IsAutoIncrement String Whether the column value is assigned in fixed increments.
IsGeneratedColumn String Whether the column is generated.
IsHidden Boolean Whether the column is hidden.
IsArray Boolean Whether the column is an array.
IsReadOnly Boolean Whether the column is read-only.
IsKey Boolean Indicates whether a field returned from sys_tablecolumns is the primary key of the table.

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

SELECT * FROM sys_procedures
Columns
Name Type Description
CatalogName String The database containing the stored procedure.
SchemaName String The schema containing the stored procedure.
ProcedureName String The name of the stored procedure.
Description String A description of the stored procedure.
ProcedureType String The type of the procedure, such as PROCEDURE or FUNCTION.

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
Name Type Description
CatalogName String The name of the database containing the stored procedure.
SchemaName String The name of the schema containing the stored procedure.
ProcedureName String The name of the stored procedure containing the parameter.
ColumnName String The name of the stored procedure parameter.
Direction Int32 An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataTypeName String The name of the data type.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
Length Int32 The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericPrecision Int32 The maximum precision for numeric data. The column length in characters for character and date-time data.
NumericScale Int32 The number of digits to the right of the decimal point in numeric data.
IsNullable Boolean Whether the parameter can contain null.
IsRequired Boolean Whether the parameter is required for execution of the procedure.
IsArray Boolean Whether the parameter is an array.
Description String The description of the parameter.
Ordinal Int32 The index of the parameter.

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
Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
IsKey Boolean Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey Boolean Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName String The name of the primary key.
ForeignKeyName String The name of the foreign key.
ReferencedCatalogName String The database containing the primary key.
ReferencedSchemaName String The schema containing the primary key.
ReferencedTableName String The table containing the primary key.
ReferencedColumnName String The column name of the primary key.

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
Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
PrimaryKeyName String The name of the primary key.
ForeignKeyName String The name of the foreign key.
ReferencedCatalogName String The database containing the primary key.
ReferencedSchemaName String The schema containing the primary key.
ReferencedTableName String The table containing the primary key.
ReferencedColumnName String The column name of the primary key.
ForeignKeyType String Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

sys_primarykeys

Describes the primary keys.

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

SELECT * FROM sys_primarykeys
Columns
Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
KeySeq String The sequence number of the primary key.
KeyName String The name of the primary key.

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
Name Type Description
CatalogName String The name of the database containing the index.
SchemaName String The name of the schema containing the index.
TableName String The name of the table containing the index.
IndexName String The index name.
ColumnName String The name of the column associated with the index.
IsUnique Boolean True if the index is unique. False otherwise.
IsPrimary Boolean True if the index is a primary key. False otherwise.
Type Int16 An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder String The sort order: A for ascending or D for descending.
OrdinalPosition Int16 The sequence number of the column in the index.

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
Name Type Description
Name String The name of the connection property.
ShortDescription String A brief description.
Type String The data type of the connection property.
Default String The default value if one is not explicitly set.
Values String A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value String The value you set or a preconfigured default.
Required Boolean Whether the property is required to connect.
Category String The category of the connection property.
IsSessionProperty String Whether the property is a session property, used to save information about the current connection.
Sensitivity String The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName String A camel-cased truncated form of the connection property name.
Ordinal Int32 The index of the parameter.
CatOrdinal Int32 The index of the parameter category.
Hierarchy String Shows dependent properties associated that need to be set alongside this one.
Visible Boolean Informs whether the property is visible in the connection UI.
ETC String Various miscellaneous information about the property.

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.

Name Description Possible Values
AGGREGATE_FUNCTIONS Supported aggregation functions. AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT Whether COUNT function is supported. YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR The opening character used to escape an identifier. [
IDENTIFIER_QUOTE_CLOSE_CHAR The closing character used to escape an identifier. ]
SUPPORTED_OPERATORS A list of supported SQL operators. =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY Whether GROUP BY is supported, and, if so, the degree of support. NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
STRING_FUNCTIONS Supported string functions. LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS Supported numeric functions. ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS Supported date/time functions. NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION Indicates if the provider supports transactions such as commit and rollback. YES, NO
DIALECT Indicates the SQL dialect to use.
KEY_PROPERTIES Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS Indicates if multiple schemas may exist for the provider. YES, NO
SUPPORTS_MULTIPLE_CATALOGS Indicates if multiple catalogs may exist for the provider. YES, NO
DATASYNCVERSION The Data Sync version needed to access this driver. Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY The Data Sync category of this driver. Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL Whether enhanced SQL functionality beyond what is offered by the API is supported. TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS Whether batch operations are supported. YES, NO
SQL_CAP All supported SQL capabilities for this driver. SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. YES, NO
PSEUDO_COLUMNS A string array indicating the available pseudo columns.
MERGE_ALWAYS If the value is true, The Merge Mode is forcibly executed in Data Sync. TRUE, FALSE
REPLICATION_MIN_DATE_QUERY A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID Indicates whether the CheckCache statement should be done against the parent key column. TRUE, FALSE
CREATE_SCHEMA_PROCEDURES Indicates stored procedures that can be used for generating schema files.

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
Name Type Description
NAME String A component of SQL syntax, or a capability that can be processed on the server.
VALUE String Detail on the supported SQL or SQL syntax.

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
Name Type Description
Id String The database-generated ID returned from a data modification operation.
Batch String An identifier for the batch. 1 for a single operation.
Operation String The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message String SUCCESS or an error message if the update in the batch failed.

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information
Columns
Name Type Description
Product String The name of the product.
Version String The version number of the product.
Datasource String The name of the datasource the product connects to.
NodeId String The unique identifier of the machine where the product is installed.
HelpURL String The URL to the product's help documentation.
License String The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
Location String The file path location where the product's library is stored.
Environment String The version of the environment or rumtine the product is currently running under.
DataSyncVersion String The tier of Sync required to use this connector.
DataSyncCategory String The category of Sync functionality (e.g., Source, Destination).

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

Property Description
APIKey The APIKey obtained from the TaxJar UI.
UseSandbox Whether to connect to the sandbox environment or not.

SSL

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

Schema

Property Description
Location A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC.
Views Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC.

Miscellaneous

Property Description
MaxRows 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.
Other These hidden properties are used only in specific use cases.
PseudoColumns This property indicates whether or not to include pseudo columns as columns to the table.
Timeout The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews A filepath pointing to the JSON configuration file containing your custom views.

Other

Property Description
StartDate Determines the start date of the transaction orders/refunds.

Authentication

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

Property Description
APIKey The APIKey obtained from the TaxJar UI.
UseSandbox Whether to connect to the sandbox environment or not.

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.

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

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:

Description Example
A full PEM Certificate (example shortened for brevity) -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate C:\\cert.cer
The public key (example shortened for brevity) -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated) ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated) 34a929226ae0819f2ec14b4a3d904f801cbb150d

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.

Property Description
Location A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC.
Views Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC.

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:

Platform %APPDATA%
Windows The value of the APPDATA environment variable
Mac ~/Library/Application Support
Linux ~/.config

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.

Property Description
MaxRows 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.
Other These hidden properties are used only in specific use cases.
PseudoColumns This property indicates whether or not to include pseudo columns as columns to the table.
Timeout The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews A filepath pointing to the JSON configuration file containing your custom views.

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
Property Description
DefaultColumnSize Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename Records the underlying socket data transfer to the specified file.

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.

Property Description
StartDate Determines the start date of the transaction orders/refunds.

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.