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

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

Connecting to Avalara

By default, the Sync App connects to a production environment. Set UseSandbox to true to configure the Sync App to connect to a Avalara sandbox environment.

Authenticating to Avalara

There are two authentication methods available for connecting to the Avalara data source: Basic and LicenseKey.

Login Credentials

To use login credentials for authentication, set the following:

• AuthScheme: Set this to Basic.
• User: Set this to your Avalara username.
• Password: Set this to your Avalara password.

Account Number and License Key

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

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

Fine Tuning Data Access

You can use the following properties to gain more control over the data returned from Avalara:

• CompanyCode: Only transaction information tied to this company code will be returned.
• IncludeAdjustedTransactions: Set this to true to include adjusted transactions in the transaction listing.

This section details a selection of advanced features of the Avalara 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 Avalara 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.

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.

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.

Overview

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

Key Features

• The Sync App models Avalara entities as relational views, allowing you to write SQL to query Avalara data.
• Stored procedures allow you to execute operations to Avalara.
• Live connectivity to these objects means any changes to your Avalara account are immediately reflected when using the Sync App.

Tables

Tables describes the available tables. Tables are statically defined to model Accounts, Transactions, Users, and more.

Views

Views describes the available views. Views are statically defined to model Reports, Subscriptions, and more.

Stored Procedures

Stored Procedures are function-like interfaces to Avalara. Stored procedures allow you to execute operations to Avalara, including downloading documents and moving envelopes.

The Sync App models the data in Avalara into a list of tables that can be queried using standard SQL statements.

Generally, querying Avalara 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.

Avalara Connector for CData Sync Tables

Accounts table for AvalaraAvatax data provider.

Select

The Sync App will use the Avalara API to process WHERE clause conditions built with the following columns and operators. Most of the columns support server side filtering with the following operators: =,>,<,<=,>=,IN,NOT,IN,AND,OR,LIKE. The rest of the filter is executed client side within the Sync App. For example, the following query is processed server side:

SELECT * FROM Accounts WHERE accountStatusId = 'Active' AND accountTypeId = 'Regular1'

Insert

To add an Account.

INSERT INTO Accounts (id,name,effectiveDate,accountStatusId,accountTypeId) VALUES ('12345','Test Account','2019-06-24T00:00:00+00:00','Test','Regular')

Update

Avalara allows updates Accounts columns.

UPDATE Accounts SET crmid = '0010b000Ardit' WHERE Id = 2000137504 

In order to update AccountsSubscriptions #TEMP table should be used.

INSERT INTO AccountsSubscriptions#TEMP (subscriptionDescription,id) VALUES ('Avacert2','567961')
UPDATE Accounts SET linkedSubscriptions = 'AccountsSubscriptions#TEMP', crmid = '0010b000Ardit' WHERE Id = 2000137504

Delete

Accounts can be deleted by providing the Id of the address and issuing a DELETE statement.

DELETE FROM Accounts WHERE Id = 100

Columns

Batches table for AvalaraAvatax data provider.

Insert

Create batch objects attached to a company. Each batch object must have one file object. When a batch is created, it is added to the AvaTax Batch Queue and will be processed as quickly as possible in the order it was received. As a result of this operation you will get the status of a batch. First insert the file, referencing the local path of the file on your machine, using #Temp table:

INSERT INTO File#Temp (Name, FileLocalPath, ContentType) VALUES ('samplebatch.csv','C:\\Users\\User\\Desktop\\BatchFile.csv', 'text/csv')

INSERT INTO Batches (CompanyId, Name, LinkedFiles, Type) VALUES ('247015', 'TestBatch2', 'File#Temp', 'TransactionImport')

Update

Update operation is not supported for Batches table.

Delete

If you attempt to delete a batch that is being processed, you will receive an error message. Deleting a batch does not delete any transactions that were created by importing the batch. Deleting a batch requires one of the following user roles: CSPAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin; Companyid and Id should be specified in the WHERE clause.

DELETE FROM Batches WHERE Id= 9030440 AND CompanyId = 247015

Columns

Companies table for AvalaraAvatax data provider.

Insert

To insert a new company to an existing account you need to specify AccountId, CompanyCode, Name and DefaultCountry fields.

INSERT INTO Companies (AccountId,CompanyCode, Name, defaultCountry) VALUES ('2000137504', 'SAB', 'SAB&Co', 'US')

Update

Avalara allows updates on Companies columns, expect for aggregate columns. Aggregate columns can not be updated.

UPDATE Companies SET Name='UpdatedName' WHERE Id = 283040

Delete

A company can be deleted by providing the Id of the company and issuing a DELETE statement.

DELETE FROM Companies WHERE Id = 283040

Columns

Contacts table for AvalaraAvatax data provider.

Select

The Sync App will use the Avalara API to process WHERE clause conditions built with the following columns and operators. Most of the columns support server side filtering with the following operators: =,>,<,<=,>=,IN,NOT,IN,AND,OR,LIKE. The rest of the filter is executed client side within the Sync App. For example, the following query is processed server side:

SELECT * FROM Contacts WHERE companyid = 247015
SELECT * FROM Contacts WHERE companyid = 247015 AND region = 'NY'

Insert

To add a Contact, ContactCode is a required field.

INSERT INTO Contacts (companyId,contactCode,firstName,lastName,title,line1,city,region,postalCode,country,email,phone) VALUES ('247015','TestContactc7356131ca2442'," +
          "'Bob','McExample','Owner','2000 Main Street','Irvine','CA','92614','US','[email protected]','714 555-1212')

Update

Avalara allows updates Contacts columns. To update a Contact, Id and CompanyId should be specified in the WHERE clause of the Update statement.

UPDATE Contacts SET firstName = 'tidra' WHERE CompanyId = 247015 AND Id = 175596

Delete

Contacts can be deleted by providing the Companyid and Id of the Contact and issuing a DELETE statement.

DELETE FROM Contacts WHERE Id = 100

Columns

Customers table for AvalaraAvatax data provider.

Select

To retrieve Customer records from Customers table, at least CompanyId or CompanyId and CustomerCode should be specified in the WHERE clause. The Sync App will use the Avalara API to process WHERE clause conditions built with the following columns and operators. CompanyId and CustomerCode fields support server side filtering with the = operator. The rest of the filter is executed client side within the Sync App. For example, the following query is processed server side:

SELECT * FROM Customers WHERE CompanyId = '247015'
SELECT * FROM Contacts WHERE CompanyId = 247015 AND CustomerCode = 'CC001'

Columns

DataSources table for AvalaraAvatax data provider.

Insert

To create a data source at least CompanyId and Source should be specified.

INSERT INTO DataSources (CompanyId, Source) VALUES (247015, 'Amazon v2 Extractor')

Update

To update a data source, you need to specify Id and CompanyId in WHERE clause.

UPDATE DataSources SET isEnabled = true WHERE Id = 297 AND CompanyId = 247015

Delete

To delete a user, you need to specify Id and AccountId in WHERE clause.

DELETE FROM DataSources WHERE Id = 297 AND CompanyId = 247015

Columns

DistanceThresholds table for AvalaraAvatax data provider.

A company-distance-threshold model indicates the distance between a company and the taxing borders of various countries. Distance thresholds are necessary to correctly calculate some value-added taxes.

Insert

To create a distance-threshold object you need one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. At least the following fields should be specified:

INSERT INTO DistanceThresholds (companyId,originCountry,destinationCountry, type) VALUES (283040,'FR','BR', 'Purchase')

Update

To update a distance-threshold, you need to specify Id and CompanyId in WHERE clause.

UPDATE DistanceThresholds SET EffDate = '2019/11/08' WHERE Id = 11785 AND CompanyId = 283040

Delete

To delete a distance-threshold, you need to specify Id and AccountId in WHERE clause.

DELETE FROM DistanceThresholds WHERE Id = 11785 AND CompanyId = 283040

Columns

FilingCalendars table for AvalaraAvatax data provider.

Select

To retrieve records from FilingCalendar table, at least CompanyId should be specified in the WHERE clause. The Sync App will use the Avalara API to process WHERE clause conditions built with the following columns and operators. Most of the columns support server side filtering with the following operators: =,>,<,<=,>=,IN,NOT,IN,AND,OR,LIKE. The rest of the filter is executed client side within the Sync App. For example, the following query is processed server side:

SELECT * FROM FilingCalendars WHERE CompanyId = '247015' AND Success = False

Columns

Items table for AvalaraAvatax data provider.

Select

The Sync App will use the Avalara API to process WHERE clause conditions built with the following columns and operators. Most of the columns support server side filtering with the following operators: =,>,<,<=,>=,IN,NOT,IN,AND,OR,LIKE. The rest of the filter is executed client side within the Sync App. For example, the following query is processed server side:

SELECT * FROM Items WHERE CompanyId = 247015 AND Description LIKE '%MUG'
SELECT * FROM Items WHERE CompanyId = 247015 AND ModifiedUserId IN (289767, 1354)

Insert

To add an Item.

INSERT INTO Items (companyId,itemCode,taxCode,description,itemGroup) VALUES ('247015','CERMUG1','P0000000','Ceramic Mug','Mugs')")

In order to add an item with ItemsClassifications #TEMP table should be used

INSERT INTO Itemsclassifications#TEMP (productCode,systemCode) VALUES ('P0000000','TARIC')")
INSERT INTO Items (companyId,itemCode,taxCode,description,itemGroup,Linkedclassifications) VALUES ('247015','CERMUG','P0000000','Ceramic Mug','Mugs','Itemsclassifications#TEMP')")
INSERT INTO Items (companyId,itemCode,taxCode,description,itemGroup) VALUES ('247015','CERMUG1','P0000000','Ceramic Mug','Mugs')")

Update

Avalara allows updates to Items columns.

UPDATE Items SET Description = 'description',itemcode = 'CERMUG' WHERE Id = '189117938' AND CompanyId = '247015'

In order to update ItemsClassifications, a #TEMP table should be used.

INSERT INTO Itemsclassifications#TEMP (systemcode,productcode) VALUES ('P0000001','AVATAXCEDE')")
UPDATE items SET description = 'description',itemcode = 'CERMUG',linkedclassifications = 'Itemsclassifications#TEMP' WHERE id = '189117938' AND companyId = '247015'")

Delete

Items can be deleted by providing the Id of the address and issuing a DELETE statement.

DELETE FROM Items WHERE Id = 100

Columns

Locations table for AvalaraAvatax data provider.

Insert

To create a location at least the following fields should be specified.

INSERT INTO Locations (CompanyId, Line1, LocationCode, AddressTypeId, AddressCategoryId, PostalCode, Country) VALUES (247015, '2000 Main Street', 'L001', 'Location', 'MainOffice', 92614, 'US')

Update

To update a location, you need to specify Id and CompanyId in WHERE clause.

UPDATE Locations SET City = 'Irvine' WHERE Id = 56789 AND CompanyId = 247015

Delete

To delete a location, you need to specify Id and AccountId in WHERE clause.

DELETE FROM Locations WHERE Id = 56789 AND CompanyId = 247015

Columns

MultiDocument table for AvalaraAvatax data provider.

Columns

Nexus table for AvalaraAvatax data provider.

Insert

To create a nexus declaration for your company, you must first obtain a list of Avalara-defined nexus querying NexusDefinitions table. Once you have determined which nexus you wish to declare, you should customize only the user-selectable fields in this object. The user selectable fields for the nexus object are CompanyId, EffectiveDate, EndDate, LocalNexusTypeId, TaxId, NexusTypeId, HasPermanentEstablishment, and IsSellerImporterOfRecord. When calling CreateNexus or UpdateNexus, all values in your nexus object except for the user-selectable fields must match an Avalara-defined system nexus object. If any data does not match, AvaTax may not recognize your nexus declaration. To create a Nexus you must specify Country, Region, JurisdictionTypeId, JurisCode,JurisName, ShortName, NexusTaxTypeGroup of an existing Avalara-defined system nexus object and optionally any other selectable field.

INSERT INTO Nexus (CompanyId, Country, Region, JurisdictionTypeId, JurisCode,JurisName, ShortName, NexusTaxTypeGroup, EffectiveDate) VALUES (283040,'US','US','Country','US','UNITED STATES','UNITED STATES','Hospitality', '2019-11-08')

Update

Only user selectable fields can be updated. To update a nexus object, you need to specify Id and CompanyId in WHERE clause.

UPDATE Nexus SET HasPermanentEstablishment = true WHERE Id = 20684351 AND CompanyId = 283040

Delete

To delete a nexus object, you need to specify Id and CompanyId in WHERE clause.

DELETE FROM Nexus WHERE Id = 20684351 AND CompanyId = 283040

Columns

Nexus table for AvalaraAvatax data provider.

Insert

To create a nexus declaration for your company, you must first obtain a list of Avalara-defined nexus querying NexusDefinitions table. Once you have determined which nexus you wish to declare, you should customize only the user-selectable fields in this object. The user selectable fields for the nexus object are CompanyId, EffectiveDate, EndDate, LocalNexusTypeId, TaxId, NexusTypeId, HasPermanentEstablishment, and IsSellerImporterOfRecord. When calling CreateNexus or UpdateNexus, all values in your nexus object except for the user-selectable fields must match an Avalara-defined system nexus object. If any data does not match, AvaTax may not recognize your nexus declaration. To create a Nexus you must specify Country, Region, JurisdictionTypeId, JurisCode,JurisName, ShortName, NexusTaxTypeGroup of an existing Avalara-defined system nexus object and optionally any other selectable field.

INSERT INTO Nexus (CompanyId, Country, Region, JurisdictionTypeId, JurisCode,JurisName, ShortName, NexusTaxTypeGroup, EffectiveDate) VALUES (283040,'US','US','Country','US','UNITED STATES','UNITED STATES','Hospitality', '2019-11-08')

Update

Only user selectable fields can be updated. To update a nexus object, you need to specify Id and CompanyId in WHERE clause.

UPDATE Nexus SET HasPermanentEstablishment = true WHERE Id = 20684351 AND CompanyId = 283040

Delete

To delete a nexus object, you need to specify Id and CompanyId in WHERE clause.

DELETE FROM Nexus WHERE Id = 20684351 AND CompanyId = 283040

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Notices table for AvalaraAvatax data provider.

Columns

Notifications table for AvalaraAvatax data provider.

Columns

Settings table for AvalaraAvatax data provider.

The company settings system is a metadata system that you can use to store extra information about a company. Your integration or connector could use this data storage to keep track of preference information, reminders, or any other storage that would need to persist even if the customer uninstalls your application.

Insert

A setting can refer to any type of data you need to remember about this company object. When creating this object, you may define your own set, name, and value parameters. To define your own values, please choose a set name that begins with X- to indicate an extension. CompanyId, Set and Name are required fields.

INSERT INTO Settings (CompanyId, Set, Name) VALUES (283040, 'ItemsToRemember', 'Texas')

Update

To update a setting, you need to specify Id and CompanyId in WHERE clause.

UPDATE Settings SET Value = 'Alamo' WHERE Id = 297847 AND CompanyId = 283040

Delete

To delete a setting, you need to specify Id and CompanyId in WHERE clause.

DELETE FROM Settings WHERE Id = 297847 AND CompanyId = 283040

Columns

TaxCodes table for AvalaraAvatax data provider.

Insert

Create one or more new taxcode objects attached to a company specifying at least CompanyId, TaxCode, TaxCodeTypeId:

INSERT INTO TaxCodes (TaxCode, taxCodeTypeId, CompanyId) VALUES ('PS081283', 'P', '283040')

Update

Avalara allows one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin to update TaxCode objects. CompanyId and Id should be specified in the WHERE clause.

UPDATE TaxCodes SET Description='Yarn' WHERE Id = 85083 AND CompanyId = 283040

Delete

To delete a TaxCode object CompanyId and Id should be specified in the WHERE clause:

DELETE FROM TaxCodes WHERE Id = 85083 AND CompanyId = 283040

Columns

TaxRules table for AvalaraAvatax data provider.

Insert

You can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your business. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use custom tax rules to redefine the behavior for your company or item.

INSERT INTO TaxRules (CompanyId, JurisCode, JurisName, JurisdictionTypeId, TaxRuleTypeId, Country, TaxTypeId, TaxCode, TaxCodeId, TaxTypeGroup, TaxSubType) VALUES ('283040','013','MARICOPA','County','ProductTaxabilityRule', 'US', 'BothSalesAndUseTax','PS081283','85083', 'SalesAndUse', 'ALL')

Update

To update a tax rule, you need to specify Id and CompanyId in WHERE clause.

UPDATE TaxRules SET Description='Freight' WHERE Id = 56789 AND CompanyId = 247015

Delete

To delete a tax rule, you need to specify Id and AccountId in WHERE clause.

DELETE FROM TaxRules WHERE Id=56789 AND CompanyId = 247015

Columns

TransactionLines view for AvalaraAvatax data provider.

Select

The Sync App will use the Avalara 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. By default the lines of Adjusted transactions will not be listed. If you want to include them, you need to set IncludeAdjustedTransactions to true.

• TrsnactionId, TransactionCode support the '=', IN operator.

For example, the following query is processed server side:

SELECT * FROM TransactionLines WHERE TransactionCode IN ('Code1', 'Code2')

Delete

To delete a TransactionLine item, you need to specify the TransactionCode and LineNumber in the WHERE clause.

Delete FROM TransactionLines WHERE TransactionCode = 'TC001' AND LineNumber = 1

Columns

Transactions table for AvalaraAvatax data provider.

Select

The Sync App will use the Avalara API to process WHERE clause conditions built with the following columns and operators. Most of the columns support server side filtering with the following operators: =,>,<,<=,>=,IN,NOT,IN,AND,OR,LIKE. The rest of the filter is executed client side within the Sync App. By default the Adjusted transactions will not be listed. If you want to include them, you need to set IncludeAdjustedTransactions to true. For example, the following query is processed server side:

SELECT * FROM Transactions WHERE AdjustmentReason = 'PriceAdjusted'
SELECT * FROM Items WHERE Status = 'Cancelled'

Insert

To add a new Transaction item, the following columns need to be specified: CustomerCode, Date, Type, LinkedLines, Code, LinkedAddresses. If you want to commit the transaction, set the Commit flag in the request to true. The linked columns can be inserted using a #Temp table or by passing the aggregate value.

The LinkedAddresses aggregate must include information about the origin and destination address. If this transaction occurred at a retail point-of-sale location, provide that single address here and leave all other address types null. If origin differs from destination, insert both ShipFrom and ShipTo address types. If you wish to use the address of an existing location for the actual company, specify the address in the addressType_locationCode field.

The examples below illustrate the aforementioned scenarios.

Inserting LinkedAddresses aggregate through #Temp table with SingleLocation:

INSERT INTO Addresses#Temp (SingleLocation_line1, SingleLocation_City, SingleLocation_County, SingleLocation_PostalCode) VALUES ('2000 Main Street', 'Irvine', 'US', 92614)")
INSERT INTO Addresses#Temp (SingleLocation_locationCode) VALUES ('LC001')")

Inserting LinkedAddresses aggregate through #Temp table with ShipFrom and ShipTo locations:

INSERT INTO Addresses#Temp (shipTo_line1, shipTo_City, shipTo_County, shipTo_PostalCode, shipFrom_line1, shipFrom_City, shipFrom_Country, shipFrom_PostalCode) VALUES ('2000 Main Street', 'Irvine', 'US', 92614, '', '', 'US', '')")
INSERT INTO Addresses#Temp (shipTo_locationCode, shipFrom_locationCode) VALUES ('LC001','LC002')")

Insert line items aggregate using #Temp table. For a list of the columns you can insert into the temporary table, refer to TransactionLines table.

INSERT INTO TransactionLines#Temp (ItemCode, Quantity, LineAmount) VALUES ('IC005', 3, 300)")

Insert into the main Transactions table :

INSERT INTO Transactions (LinkedLines,LinkedAddresses, Code, CompanyId, CustomerCode, Date, Type, Commit, TotalTax) VALUES (TransactionLines#Temp, Addresses#Temp, DC008, 247015, 'CC002', '09/30/2019', 'SalesInvoice', true, 12.0)")

Update

Avalara allows updates on Transactions. To update a transaction, AdjustmentReason and Adjustment description are required fields. Additionally, you need to specify the Code of the transaction you are updating in the WHERE clause.

Similarly, to Insert, you can update line items using temporary tables. To update an existing line, include the LineNumber of the line you wish to update. To insert a new line in the transaction, set the LineNumber to a new, non-existing value.

When a transaction is updated, the actual transaction's status changes to Adjusted and a new transaction with the updated information is created. The new transaction will have the same document code, but a different id and status: Saved or Commited. If you wish to commit the new updated transaction, set the Commit flag in the request to true.

INSERT INTO TransactionLines#Temp (ItemCode, Quantity, LineAmount, LineNumber) VALUES (IC007, 3, 300, 3)
UPDATE Transactions SET LinkedLines = 'TransactionLines#Temp', AdjustmentDescription = 'MyDescription', AdjustmentReason = 'PriceAdjusted' WHERE Code = '051349'

Columns

Upcs table for AvalaraAvatax data provider.

A UPC represents a single Universal Product Code in your catalog and matches this product to the tax code identified by this UPC.

Insert

To create a UPC object CompanyId, Upc and Description are required fields.

INSERT INTO Upcs (CompanyId, Upc, Description) VALUES (283040, '023032550992', 'Yarn')

Update

To update a Upc, you need to specify Id and CompanyId in WHERE clause.

UPDATE Upcs SET LegacyTaxCode = 'PS081282' WHERE Id = 123456789 AND CompanyId = 283040

Delete

To delete a Upc, you need to specify Id and CompanyId in WHERE clause.

DELETE FROM Upcs WHERE Id = 123456789 AND CompanyId = 283040

Columns

Users table for AvalaraAvatax data provider.

Insert

To create a new user the following fields should be specified. A newly created user will receive an email inviting them to create their password. This means that you must provide a valid email address for all user accounts created.

INSERT INTO Users (AccountId, UserName, FirstName, LastName, Email, securityRoleId) VALUES (2000137504, 'user123', 'James', 'Smith', '[email protected]', 'AccountUser')

Update

Only user selectable fields can be updated. To update a user, you need to specify Id and AccountId in WHERE clause.

UPDATE Users SET IsActive = true WHERE Id = 332668 AND AccountId = 2000137504

Delete

To delete a user, you need to specify Id and AccountId in WHERE clause.

DELETE FROM Users WHERE Id = 332668 AND AccountId = 2000137504

Columns

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.

Avalara Connector for CData Sync Views

BatchFiles view for AvalaraAvatax data provider.

Columns

CustomerCustomFields view for AvalaraAvatax data provider.

Select

To retrieve records from CustomerCustomFields view, at least CompanyId or CompanyId and CompanyCode should be specified in the WHERE clause. The Sync App will use the Avalara API to process WHERE clause conditions built with the following columns and operators. CompanyId and CompanyCode support server side filtering with the = operator. The rest of the filter is executed client side within the Sync App. For example, the following query is processed server side:

SELECT * FROM CustomerCustomFields WHERE CompanyId = '247015' AND CustomerCode = 'CC001'

Columns

CustomerExposureZones view for AvalaraAvatax data provider.

Select

To retrieve records from CustomerExposureZones view, at least CompanyId or CompanyId and CompanyCode should be specified in the WHERE clause. The Sync App will use the Avalara API to process WHERE clause conditions built with the following columns and operators. CompanyId and CompanyCode support server side filtering with the = operator. The rest of the filter is executed client side within the Sync App. For example, the following query is processed server side:

SELECT * FROM CustomerExposureZones WHERE CompanyId = '247015' AND CustomerCode = 'CC001'

Columns

FilingCalendarAvailablePOA view for AvalaraAvatax data provider.

Columns

ItemClassifications view for AvalaraAvatax data provider.

Columns

ItemParameters view for AvalaraAvatax data provider.

Columns

LocationSettings view for AvalaraAvatax data provider.

Columns

Nexus table for AvalaraAvatax data provider.

Insert

To create a nexus declaration for your company, you must first obtain a list of Avalara-defined nexus querying NexusDefinitions table. Once you have determined which nexus you wish to declare, you should customize only the user-selectable fields in this object. The user selectable fields for the nexus object are CompanyId, EffectiveDate, EndDate, LocalNexusTypeId, TaxId, NexusTypeId, HasPermanentEstablishment, and IsSellerImporterOfRecord. When calling CreateNexus or UpdateNexus, all values in your nexus object except for the user-selectable fields must match an Avalara-defined system nexus object. If any data does not match, AvaTax may not recognize your nexus declaration. To create a Nexus you must specify Country, Region, JurisdictionTypeId, JurisCode,JurisName, ShortName, NexusTaxTypeGroup of an existing Avalara-defined system nexus object and optionally any other selectable field.

INSERT INTO Nexus (CompanyId, Country, Region, JurisdictionTypeId, JurisCode,JurisName, ShortName, NexusTaxTypeGroup, EffectiveDate) VALUES (283040,'US','US','Country','US','UNITED STATES','UNITED STATES','Hospitality', '2019-11-08')

Update

Only user selectable fields can be updated. To update a nexus object, you need to specify Id and CompanyId in WHERE clause.

UPDATE Nexus SET HasPermanentEstablishment = true WHERE Id = 20684351 AND CompanyId = 283040

Delete

To delete a nexus object, you need to specify Id and CompanyId in WHERE clause.

DELETE FROM Nexus WHERE Id = 20684351 AND CompanyId = 283040

Columns

Nexus table for AvalaraAvatax data provider.

Insert

To create a nexus declaration for your company, you must first obtain a list of Avalara-defined nexus querying NexusDefinitions table. Once you have determined which nexus you wish to declare, you should customize only the user-selectable fields in this object. The user selectable fields for the nexus object are CompanyId, EffectiveDate, EndDate, LocalNexusTypeId, TaxId, NexusTypeId, HasPermanentEstablishment, and IsSellerImporterOfRecord. When calling CreateNexus or UpdateNexus, all values in your nexus object except for the user-selectable fields must match an Avalara-defined system nexus object. If any data does not match, AvaTax may not recognize your nexus declaration. To create a Nexus you must specify Country, Region, JurisdictionTypeId, JurisCode,JurisName, ShortName, NexusTaxTypeGroup of an existing Avalara-defined system nexus object and optionally any other selectable field.

INSERT INTO Nexus (CompanyId, Country, Region, JurisdictionTypeId, JurisCode,JurisName, ShortName, NexusTaxTypeGroup, EffectiveDate) VALUES (283040,'US','US','Country','US','UNITED STATES','UNITED STATES','Hospitality', '2019-11-08')

Update

Only user selectable fields can be updated. To update a nexus object, you need to specify Id and CompanyId in WHERE clause.

UPDATE Nexus SET HasPermanentEstablishment = true WHERE Id = 20684351 AND CompanyId = 283040

Delete

To delete a nexus object, you need to specify Id and CompanyId in WHERE clause.

DELETE FROM Nexus WHERE Id = 20684351 AND CompanyId = 283040

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

NoticeComments view for AvalaraAvatax data provider.

Columns

NoticeFinances view for AvalaraAvatax data provider.

Columns

NoticeResponsibility view for AvalaraAvatax data provider.

Columns

NoticeRootCause view for AvalaraAvatax data provider.

Columns

ReportParameters view for AvalaraAvatax data provider.

Columns

Reports table for AvalaraAvatax data provider.

Columns

Subscriptions table for AvalaraAvatax data provider.

Select

The Sync App will use the Avalara API to process WHERE clause conditions built with the following columns and operators. Most of the columns support server side filtering with the following operators: =,>,<,<=,>=,IN,NOT,IN,AND,OR,LIKE. The rest of the filter is executed client side within the Sync App. For example, the following query is processed server side:

SELECT * FROM Subscriptions WHERE SubscriptionDescription LIKE 'AVA%'

Columns

TransactionAddresses view for AvalaraAvatax data provider.

Columns

TransactionInvoicemessages view for AvalaraAvatax data provider.

Columns

TransactionLocationTypes view for AvalaraAvatax data provider.

Columns

TransactionMessages view for AvalaraAvatax data provider.

Columns

TransactionParameters view for AvalaraAvatax data provider.

Columns

TransactionSummary view for AvalaraAvatax data provider.

Columns

TransactionTaxdetailsbytaxtype view for AvalaraAvatax data provider.

Columns

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.

Authentication

Connection

SSL

Firewall

Proxy

Logging

Schema

Miscellaneous

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

The scheme used for authentication. Accepted entries are Basic and LicenseKey.

Remarks

• Auto: Lets the driver decide automatically based on the other connection properties you have set.
• Basic: Set this to use Basic User / Password authentication.
• LicenseKey: Set to this to perform the authentication using the AccountId and the LicenseKey properties.

A boolean indicating whether you are using a Sandbox account. The provider makes requests to the production environment by default.

Remarks

If you are using a production account, this property can be left blank.

The Avalara user account used to authenticate.

Remarks

Together with Password, this field is used to authenticate against the Avalara server.

The password used to authenticate the user.

Remarks

The User and Password are together used to authenticate with the server.

The account ID number of your Avalara account.

Remarks

The Account Id is listed in the upper right hand corner of the Avalara admin console.

The license key generated by an account administrator on the Avalara website.

Remarks

You can generate a license key as follows:

1. Log into Avalara as an account administrator.
2. Select Settings.
3. Select Reset License Key.

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

Only transaction information tied to this company code will be returned.

Remarks

Only transaction information tied to this company code will be returned.

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

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:

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.

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

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.

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

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.

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.

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.

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.

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

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.

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.

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.

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.

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

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.

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:

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.

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

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.

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

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