Avalara Connection Details¶

Introduction¶

Connector Version

This documentation is based on version 23.0.8936 of the connector.

Get Started¶

Avalara Version Support

The connector leverages the Avalara Avatax API to enable bidirectional access to Avalara.

Establish a Connection¶

Connect to Avalara¶

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

Authenticate 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¶

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.

Important Notes¶

Configuration Files and Their Paths¶

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

Advanced Features¶

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

User Defined Views

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

SSL Configuration

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

Proxy

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

Query Processing

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

See Query Processing for more information.

User Defined Views¶

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

There are two ways to create user defined views:

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

Define Views Using a Configuration File¶

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

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

This User Defined View configuration file is formatted as follows:

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

For example:

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

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

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

Define Views Using DDL Statements¶

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

Create a View¶

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

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

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

Alter a View¶

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

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

The view is then updated in the JSON configuration file.

Drop a View¶

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

DROP LOCAL VIEW [MyViewName]

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

Schema for User Defined Views¶

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

Work with User Defined Views¶

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

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

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

Resulting in the effective query to the source:

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

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

SSL Configuration¶

Customize the SSL Configuration¶

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

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

Data Model¶

Overview

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

Key Features

• The connector 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 connector.

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.

Tables¶

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

Avalara Connector Tables¶

Accounts¶

Accounts table for AvalaraAvatax data provider.

Select¶

The connector 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 connector. 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¶

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')

Then insert in the main Batches table. The following fielda are required:

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¶

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¶

Contacts table for AvalaraAvatax data provider.

Select¶

The connector 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 connector. 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', 'bob@example.org', '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¶

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 connector 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 connector. 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¶

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¶

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¶

FilingCalendars table for AvalaraAvatax data provider.

Select¶

To retrieve records from FilingCalendar table, at least CompanyId should be specified in the WHERE clause. The connector 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 connector. For example, the following query is processed server side:

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

Columns¶

Items¶

Items table for AvalaraAvatax data provider.

Select¶

The connector 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 connector. 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¶

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¶

MultiDocument table for AvalaraAvatax data provider.

Columns¶

Nexus¶

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¶

Notices table for AvalaraAvatax data provider.

Columns¶

Notifications¶

Notifications table for AvalaraAvatax data provider.

Columns¶

Settings¶

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¶

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¶

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¶

TransactionLines view for AvalaraAvatax data provider.

Select¶

The connector 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 connector. 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¶

Transactions table for AvalaraAvatax data provider.

Select¶

The connector 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 connector. 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¶

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¶

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', 'smith@gmail.com', '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¶

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.

Avalara Connector Views¶

BatchFiles¶

BatchFiles view for AvalaraAvatax data provider.

Columns¶

CustomerCustomFields¶

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 connector 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 connector. For example, the following query is processed server side:

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

Columns¶

CustomerExposureZones¶

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 connector 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 connector. For example, the following query is processed server side:

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

Columns¶

FilingCalendarAvailablePOA¶

FilingCalendarAvailablePOA view for AvalaraAvatax data provider.

Columns¶

ItemClassifications¶

ItemClassifications view for AvalaraAvatax data provider.

Columns¶

ItemParameters¶

ItemParameters view for AvalaraAvatax data provider.

Columns¶

LocationSettings¶

LocationSettings view for AvalaraAvatax data provider.

Columns¶

Nexus¶

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¶

NoticeComments view for AvalaraAvatax data provider.

Columns¶

NoticeFinances¶

NoticeFinances view for AvalaraAvatax data provider.

Columns¶

NoticeResponsibility¶

NoticeResponsibility view for AvalaraAvatax data provider.

Columns¶

NoticeRootCause¶

NoticeRootCause view for AvalaraAvatax data provider.

Columns¶

ReportParameters¶

ReportParameters view for AvalaraAvatax data provider.

Columns¶

Reports¶

Reports table for AvalaraAvatax data provider.

Columns¶

Subscriptions¶

Subscriptions table for AvalaraAvatax data provider.

Select¶

The connector 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 connector. For example, the following query is processed server side:

SELECT * FROM Subscriptions WHERE SubscriptionDescription LIKE 'AVA%'

Columns¶

TransactionAddresses¶

TransactionAddresses view for AvalaraAvatax data provider.

Columns¶

TransactionInvoiceMessages¶

TransactionInvoicemessages view for AvalaraAvatax data provider.

Columns¶

TransactionLocationTypes¶

TransactionLocationTypes view for AvalaraAvatax data provider.

Columns¶

TransactionMessages¶

TransactionMessages view for AvalaraAvatax data provider.

Columns¶

TransactionParameters¶

TransactionParameters view for AvalaraAvatax data provider.

Columns¶

TransactionSummary¶

TransactionSummary view for AvalaraAvatax data provider.

Columns¶

TransactionTaxDetailsByTaxType¶

TransactionTaxdetailsbytaxtype view for AvalaraAvatax data provider.

Columns¶

Stored Procedures¶

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

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

Avalara Connector Stored Procedures¶

CommitTransaction¶

Commit a transaction for reporting.

Input¶

DownloadBatch¶

Download a single batch file.

Input¶

Result Set Columns¶

RefundTransaction¶

Refund a transaction.

Input¶

VoidTransaction¶

Void a transaction.

Input¶

System Tables¶

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

Schema Tables¶

The following tables return database metadata for Avalara:

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

Data Source Tables¶

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

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

Query Information Tables¶

The following table returns query statistics for data modification queries:

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

sys_catalogs¶

Lists the available databases.

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

SELECT * FROM sys_catalogs

Columns¶

sys_schemas¶

Lists the available schemas.

The following query retrieves all available schemas:

SELECT * FROM sys_schemas

Columns¶

sys_tables¶

Lists the available tables.

The following query retrieves the available tables and views:

SELECT * FROM sys_tables

Columns¶

sys_tablecolumns¶

Describes the columns of the available tables and views.

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

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

Columns¶

sys_procedures¶

Lists the available stored procedures.

The following query retrieves the available stored procedures:

SELECT * FROM sys_procedures

Columns¶

sys_procedureparameters¶

Describes stored procedure parameters.

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

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

Columns¶

sys_keycolumns¶

Describes the primary and foreign keys.

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

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

Columns¶

sys_foreignkeys¶

Describes the foreign keys.

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

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columns¶

sys_primarykeys¶

Describes the primary keys.

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

SELECT * FROM sys_primarykeys

Columns¶

sys_indexes¶

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

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

SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns¶

sys_connection_props¶

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

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

jdbc:cdata:avalara:config:

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

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

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns¶

sys_sqlinfo¶

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

Discovering the Data Source's SELECT Capabilities¶

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

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

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

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

Columns¶

sys_identity¶

Returns information about attempted modifications.

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

SELECT * FROM sys_identity

Columns¶