Skip to main content
Avalara Help Center

Install the Schedule Transaction Importer Tool

This article applies to:Excise


This site is only for Avalara customers licensed for Returns Excise, AvaTax Excise and Government. 
Documentation of operation, usage and release dates is confidential and proprietary information of Avalara.

This document applies only to Enterprise customers.  Content last updated 2020-01-14.  


Software install requires Windows administrator privileges.


  1. Download these files:
    • ScheduleTransactionImporter_5_xx_yy_zz_x64_Setup.exe where xx, yy and zz change with each release.
    • If you use custom mappers or custom profiles, download them from 5.xx.yy/custom-profiles or 5.xx.yy/custom-mappers from Select Version.
      Be sure to use matched versions.
    • The 5.xx.0 Avalara Returns Excise Release Highlights
    • Avalara Excise Platform System Requirements (Use Select Version: Documents)
  2. Changes to the Schedule Transaction Importer (STI) Tool, if there are any, are described in the Avalara Returns Excise Release Highlights with the same version.
  3. The STI Tool requires Microsoft's .NET Framework. Check the Release Highlights and the System Requirements you downloaded earlier for version requirements.
    Tip: Microsoft has help on checking the version, currently at How to: Determine Which .NET Framework Versions Are Installed.  Avalara is not responsible for the accuracy of of websites that are not our own.

Upgrade only preparations

As of version 5.35.0, if you install the new version in the same folder as before, the installer will upgrade your configuration files to the new version and include your customizations. We still encourage saving the Configuration folder manually, as described here.

  1. Find your current Schedule Transaction Importer (STI) Tool folder. The default location, unless otherwise specified in the installation, is %Program Files%\Zytax Schedule Transaction Importer.
  2. Right click on the Configuration folder and choose Send to > Compressed (zipped) folder.
  3. Save the file to a safe place.

Install or upgrade

You must be a Windows Administrator on the machine where you are installing.

  1. Right-click the ScheduleTransactionImporter_5_xx_yy_zz_x64_Setup.exe that you downloaded earlier.
  2. Click Run as administrator and answer any subsequent security prompts.
  3. Click Next on the Welcome screen.
  4. Read the License Agreement, check mark the box to accept it, then click Next.
  5. Install to the default destination folder, or click Change... to select another location and click Next.
  6. Click Install on the Ready screen.
  7. You will receive a reminder to refer to the Release Notes for any AppSettings.config are needed.  This is occasionally necessary on an upgrade of an existing install of STI.  Click OK to continue the install.
    • The AppSettings.config file is located in the Configuration folder under the install directory.  The default location, unless otherwise specified in the installation, is %Program Files%\Zytax Schedule Transaction Importer\Configuration.
    • Tip: Use Run as administrator to open Notepad so that you can save it in the default location.
  8. If you use custom mappers or custom profiles, copy them into the install directory. The version of any custom mappers or custom profiles must match the version of the program.

STI Tool setup

When you launch the new install, it needs to be configured..

  1. The appropriate database type will be selected for you during your implementation by Professional Services.  You may need to choose it again if you need to re-install the software.
  2. Click the Avalara Data Adapter tab and select Avalara Authentication.
  3. Confirm the host name for the import.  The URL is displayed in the lower left corner.  
    • Click the ellipse button and then on Change Web Service.
    • Select an available web service from the dropdown and click Submit.
    • Each web service must then be authenticated.
    • The default web service is and can be changed.  Professional Services will configure this file based on your business.  
  4. Select the Mode.  Professional Services will help you with this selection on implementation.  It is recommended that you select Avalara Authentication.
  5. Enter the Company, Username and Password for the mode you selected.
    • Company must exactly match the name in the Maintenance > Companies table in the software, including punctuation and special characters.  For example, Smith & Jones Oil Inc is not the exact same name as Smith and Jones Oil, Inc.
  6. Click Validate Credentials.
    • If you see Validation failed, click on Change Credentials.
      Note: If you copy and paste the Company name from the Avalara Excise Platform, do not include the FEIN (e. g. this will fail: Smith & Jones Oil Inc; 123456789).
    • Enter new criteria and click Validate Credentials again until you see Validation succeeded.
  7. Click Close to save your settings.

STI data settings

In addition to the Avalara Authentication, there are 6 tabs with import configuration settings.

  • General
  • Business Entity Import
  • Location Import
  • Tax Session Assignment
  • Transaction Update Behavior
  • Email Notification

Click here for documentation on using the data import settings.

Operating system reference pages

Microsoft download home (external link). 

  • Was this article helpful?