The CData Sync App provides a straightforward way to continuously pipeline your TaxJar data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The TaxJar connector can be used from the CData Sync application to pull data from TaxJar and move it to any of the supported destinations.
The Sync App leverages v2 of the TaxJar API to enable bidirectional access to TaxJar.
For required properties, see the Settings tab.
For connection properties that are not typically required, see the Advanced tab.
This section details a selection of advanced features of the TaxJar Sync App.
The Sync App supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .
Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .
Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
For further information, see Query Processing.
By default, the Sync App attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.
To specify another certificate, see the SSLServerCert connection property.
To authenticate to an HTTP proxy, set the following:
Set the following properties:
This section shows the available API objects and provides more information on executing SQL to TaxJar APIs.
Views describes the available views. Views are statically defined to model Categories, OrderLineItems, and more.
Tables describes the available tables. Tables are statically defined to model Customers, Orders, Refunds.
Stored Procedures are function-like interfaces to TaxJar. Stored procedures allow you to execute operations to TaxJar, including calculating sales tax and validating addresses.
The Sync App models the data in TaxJar as a list of tables in a relational database that can be queried using standard SQL statements.
| Name | Description |
| Customers | Lists existing customers. |
| Orders | Lists existing order transactions. |
| Refunds | Lists existing refund transactions. |
Lists existing customers.
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.
SELECT * FROM Customers WHERE CustomerID = '123'
SELECT * FROM Customers WHERE CustomerID IN ('123', '1234')
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')
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
In order to delete a Customer the CustomerID needs to be specified, for ex.
DELETE FROM Customers WHERE CustomerID = '100'
| 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. |
Lists existing order transactions.
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.
For the following query:
SELECT * FROM TableNameWe have these 2 cases:
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'
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')
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'
In order to delete an Order the TransactionID needs to be specified, for ex.
DELETE FROM Orders WHERE TransactionID = '100'
| 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. |
Lists existing refund transactions.
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.
For the following query:
SELECT * FROM TableNameWe have these 2 cases:
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'
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')
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'
In order to delete an Refund the TransactionID needs to be specified, for ex.
DELETE FROM Refunds WHERE TransactionID = '100'
| 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 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.
| 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. |
Lists all tax categories.
| 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. |
Lists exempt regions of a customer.
| 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. |
Lists existing nexus locations for a TaxJar account.
| 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. |
Lists existing order transactions.
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.
For the following query:
SELECT * FROM TableNameWe have these 2 cases:
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'
| 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. |
Lists line items of an order transactions.
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.
For the following query:
SELECT * FROM TableNameWe have these 2 cases:
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'
| 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. |
Retrieve minimum and average sales tax rates by region.
| 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 are function-like interfaces that extend the functionality of the Sync App 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.
| 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 |
Shows the sales tax that should be collected for a given order.
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:
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"}]'
| 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. |
| 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. |
Get tax rates for a location.
| 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. |
| 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. |
Validates a customer address and returns back a collection of address matches.
| 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. |
| Name | Type | Description |
| AdressAggregates | String | Collection of address matches |
Validates an existing VAT identification number
| Name | Type | Required | Description |
| VAT | String | True | VAT identification number to validate. Country code should precede number, e.g. GB980780684. |
| 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. |
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.
| Property | Description |
| APIKey | The APIKey obtained from the TaxJar UI. |
| UseSandbox | Whether to connect to the sandbox environment or not. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
| Property | Description |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| MaxThreads | Specifies the number of concurrent requests. |
| Other | Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
| Property | Description |
| StartDate | Determines the start date of the transaction orders/refunds. |
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. |
The APIKey obtained from the TaxJar UI.
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.
Whether to connect to the sandbox environment or not.
Set this to true to connect to the TaxJar sandbox environment. Remember that the APIKey must also be generated for the sandbox environment.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
Specifies the certificate to be accepted from the server when connecting using TLS/SSL.
If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are 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 |
Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.
This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Note: 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.
The following table provides port number information for each of the supported protocols.
| Protocol | Default Port | Description |
| TUNNEL | 80 | The port where the Sync App opens a connection to TaxJar. Traffic flows back and forth via the proxy at this location. |
| SOCKS4 | 1080 | The port where the Sync App opens a connection to TaxJar. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted. |
| SOCKS5 | 1080 | The port where the Sync App sends data to TaxJar. If the SOCKS 5 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.
Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the TCP port to be used for a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Identifies the user ID of the account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the password of the user account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).
This connection property takes precedence over other proxy settings. If you want to configure the Sync App to connect to a specific proxy server, set ProxyAutoDetect to False.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False.
If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.
Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
The Sync App only routes HTTP traffic through the ProxyServer port specified in this connection property when ProxyAutoDetect is set to False.
If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.
For other proxy types, see FirewallType.
Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
Supported authentication types :
For all values other than NONE, you must also set the ProxyUser and ProxyPassword connection properties.
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyUser |
| BASIC | The username of a user registered with the proxy server. |
| DIGEST | The username of a user registered with the proxy server. |
| NEGOTIATE | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NTLM | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NONE | Do not set the ProxyPassword connection property. |
Note: The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the username specified in your system proxy settings.
Specifies the password of the user specified in the ProxyUser connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyPassword |
| BASIC | The password associated with the proxy server user specified in ProxyUser. |
| DIGEST | The password associated with the proxy server user specified in ProxyUser. |
| NEGOTIATE | The password associated with the Windows user account specified in ProxyUser. |
| NTLM | The password associated with the Windows user account specified in ProxyUser. |
| NONE | Do not set the ProxyPassword connection property. |
For SOCKS 5 authentication or tunneling, see FirewallType.
Note: The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the password specified in your system proxy settings.
Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :
| AUTO | Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option. |
| ALWAYS | The connection is always SSL enabled. |
| NEVER | The connection is not SSL enabled. |
| TUNNEL | The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note: 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, set ProxyAutoDetect to False.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
The Sync App writes details about each operation it performs into the logfile specified by the Logfile connection property.
Each of these logged operations are assigned to a themed category called a module, and each module has a corresponding short code used to labels individual Sync App operations as belonging to that module.
When this connection property is set to a semicolon-separated list of module codes, only operations belonging to the specified modules are written to the logfile. Note that this only affects which operations are logged moving forward and doesn't retroactively alter the existing contents of the logfile. For example: INFO;EXEC;SSL;META;
By default, logged operations from all modules are included.
You can explicitly exclude a module by prefixing it with a "-". For example: -HTTP
To apply filters to submodules, identify them with the syntax <module name>.<submodule name>. For example, the following value causes the Sync App to only log actions belonging to the HTTP module, and further refines it to exclude actions belonging to the Res submodule of the HTTP module: HTTP;-HTTP.Res
Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.
The available modules and submodules are:
| Module Name | Module Description | Submodules |
| INFO | General Information. Includes the connection string, product version (build number), and initial connection messages. |
|
| EXEC | Query Execution. Includes execution messages for user-written SQL queries, parsed SQL queries, and normalized SQL queries. Success/failure messages for queries and query pages appear here as well. |
|
| HTTP | HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages. |
|
| WSDL | Messages pertaining to the generation of WSDL/XSD files. | — |
| SSL | SSL certificate messages. |
|
| AUTH | Authentication related failure/success messages. |
|
| SQL | Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages. |
|
| META | Metadata cache and schema messages. |
|
| FUNC | Information related to executing SQL functions. |
|
| TCP | Incoming and outgoing raw bytes on TCP transport layer messages. |
|
| FTP | Messages pertaining to the File Transfer Protocol. |
|
| SFTP | Messages pertaining to the Secure File Transfer Protocol. |
|
| POP | Messages pertaining to data transferred via the Post Office Protocol. |
|
| SMTP | Messages pertaining to data transferred via the Simple Mail Transfer Protocol. |
|
| CORE | Messages relating to various internal product operations not covered by other modules. | — |
| DEMN | Messages related to SQL remoting. | — |
| CLJB | Messages about bulk data uploads (cloud job). |
|
| SRCE | Miscellaneous messages produced by the product that don't belong in any other module. | — |
| TRANCE | Advanced messages concerning low-level product operations. | — |
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) 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, where %APPDATA% is set to the user's configuration directory:
| Platform | %APPDATA% |
| Windows | The value of the APPDATA environment variable |
| Linux | ~/.config |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.
Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.
If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, 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: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.
Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.
If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, 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: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| MaxThreads | Specifies the number of concurrent requests. |
| Other | Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)
Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.
This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.
Specifies the number of concurrent requests.
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.
Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
This property allows advanced users to configure hidden properties for specialized situations, with the advice of our Support team. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. To define multiple properties, use a semicolon-separated list.
Note: It is strongly recommended to set these properties only when advised by the Support team to address specific scenarios or issues.
| 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=True | Converts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time). |
| RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
This property allows you to define which pseudocolumns the Sync App exposes as table columns.
To specify individual pseudocolumns, use the following format:
Table1=Column1;Table1=Column2;Table2=Column3
To include all pseudocolumns for all tables use:
*=*
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.
Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.
Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.
Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.
Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
UserDefinedViews allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the 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)"
}
}
You can use this property to define multiple views in a single file and specify the filepath.
For example:
UserDefinedViews=C:\Path\To\UserDefinedViews.jsonWhen you specify a view in UserDefinedViews, the Sync App only sees that view.
For further information, see User Defined Views.
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. |
Determines the start date of the transaction orders/refunds.
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.
LZMA from 7Zip LZMA SDK
LZMA SDK is placed in the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
LZMA2 from XZ SDK
Version 1.9 and older are in the public domain.
Xamarin.Forms
Xamarin SDK
The MIT License (MIT)
Copyright (c) .NET Foundation Contributors
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
NSIS 3.10
Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.
"Contributor" means any person or entity that distributes the Program.
"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.
"Program" means the Contributions distributed in accordance with this Agreement.
"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.
b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
3. REQUIREMENTS
A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:
a) it complies with the terms and conditions of this Agreement; and
b) its license agreement:
i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and
iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
When the Program is made available in source code form:
a) it must be made available under this Agreement; and
b) a copy of this Agreement must be included with each copy of the Program.
Contributors may not remove or alter any copyright notices contained within the Program.
Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.
All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.
This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.