Establishing a Connection

Create a connection to TaxJar by navigating to the Connections page in the Sync App application and selecting the corresponding icon in the Add Connections panel. If the TaxJar icon is not available, click the Add More icon to download and install the TaxJar connector from the CData site.

Required properties are listed under the Settings tab. The Advanced tab lists connection properties that are not typically required.

Authenticating 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 Sync App 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 Sync App consider increasing this value based on the machines resources.

Advanced Features

This section details a selection of advanced features of the TaxJar Sync App.

User Defined Views

The Sync App 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 Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App 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.

Logging

See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.

SSL Configuration

Customizing the SSL Configuration

By default, the Sync App 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.

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

Other Proxies

Set the following properties:

To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
To tunnel the connection, set FirewallType to TUNNEL.
To authenticate, specify FirewallUser and FirewallPassword.
To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Data Model

Overview

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

Key Features

The Sync App 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 Sync App.

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 Sync App models the data in TaxJar into a list of tables that can be queried using standard SQL statements.

Generally, querying TaxJar tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns. These types of situations are clearly documented at the top of the table page linked below.

TaxJar Connector for CData Sync Tables


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

Customers

Lists existing customers.

Select

The Sync App 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 Sync App.

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 Sync App 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 Sync App 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 Sync App 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 Sync App.

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 Sync App will retrieve data of the last 3 months.
StartDate connection property is set. The Sync App 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 Sync App 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 Sync App.

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 Sync App will retrieve data of the last 3 months.
StartDate connection property is set. The Sync App 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 composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure is available to update the data if such functionality is applicable to the data source.

Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard.

Dynamic views, such as queries exposed as views, and views for looking up specific combinations of project_team work items are supported.

TaxJar Connector for CData Sync 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.

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 Sync App 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 Sync App.

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 Sync App will retrieve data of the last 3 months.
StartDate connection property is set. The Sync App 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 Sync App 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 Sync App.

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 Sync App will retrieve data of the last 3 months.
StartDate connection property is set. The Sync App 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.

Connection String Options

The connection string 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 in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

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.

Firewall

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

Proxy

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging

Property	Description
LogModules	Core modules to be included in the log file.

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 rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
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 the Authentication properties you can configure in the connection string for this provider.

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.

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.

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 the SSL properties you can configure in the connection string for this provider.

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.

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.

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

Firewall

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

FirewallType

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.


Type	Default Port	Description
TUNNEL	80	When this is set, the Sync App opens a connection to TaxJar and traffic flows back and forth through the proxy.
SOCKS4	1080	When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5	1080	When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

FirewallServer

The name or IP address of a proxy-based firewall.

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

FirewallPort

The TCP port for a proxy-based firewall.

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

FirewallUser

The user name to use to authenticate with a proxy-based firewall.

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

FirewallPassword

A password used to authenticate to a proxy-based firewall.

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

Proxy

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

ProxyAutoDetect

This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

ProxyServer

The hostname or IP address of a proxy to route HTTP traffic through.

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

ProxyPort

The TCP port the ProxyServer proxy is running on.

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

ProxyAuthScheme

The authentication type to use to authenticate to the ProxyServer proxy.

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

BASIC: The Sync App performs HTTP BASIC authentication.
DIGEST: The Sync App performs HTTP DIGEST authentication.
NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
PROPRIETARY: The Sync App does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

ProxyUser

A user name to be used to authenticate to the ProxyServer proxy.

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain
domain\user

ProxyPassword

A password to be used to authenticate to the ProxyServer proxy.

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

ProxySSLType

The SSL type to use when connecting to the ProxyServer proxy.

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:


AUTO	Default setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

ProxyExceptions

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

Logging

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

Property	Description
LogModules	Core modules to be included in the log file.

LogModules

Core modules to be included in the log file.

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

Schema

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

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.

Remarks

The path to a directory which contains the schema files for the Sync App (.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%\\CData\\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.

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.

Remarks

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

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.

Remarks

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

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 the Miscellaneous properties you can configure in the connection string for this provider.

Property	Description
MaxRows	Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
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 rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Remarks

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

MaxThreads

Specifies the number of concurrent requests.

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 Sync App 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 Sync App consider increasing this value based on the machine's resources.

Other

These hidden properties are used only in specific use cases.

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


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.

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.

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 Sync App throws an exception.

UserDefinedViews

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

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App 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 Sync App.

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"

Other

This section provides a complete list of the Other properties you can configure in the connection string for this provider.

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

StartDate

Determines the start date of the transaction orders/refunds.

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.