Getting Started
The Spree Avatax Extenstion was developed by the RailsDog team to integrate Avalara’s Avatax REST API with the Spree e-Commerce solution. This implementation has been certified by the Avalara team to work with their tax software solution. The extension was created to work with the basic implementation of a Spree e-Commerce solution, meaning that it will need to be enhanced for more heavily altered or enhanced e-commerce solutions that have been developed.
Spree version 2 Rails 4
- Add the following line to your application's Gemfile after the gem 'spree' line:
gem 'spree_avatax', :git => 'git://github.com/railsdog/spree_avatax_certified.git' - Install the gem using Bundler:
bundle install - Copy & run migrations:
bundle exec rails g spree_avatax:install
An Avatax accoutn/subscription will be needed to and the configure the Avatax settings, Avatax entity use codes, and Tax category codes in the Spree Admin UI. Please visit the Avalara site first to get an account on their site along with configuring entity use codes and tax category codes. An Avalara representative will assist in configuring the Avalara web site; which will be used as a data source for configuring the Spree Admin site.
-
In the Spree Admin site configure the Avalara Setting.
-
Enter the Entity Use Codes that are configured in your Avalara site
-
Configure the Tax category codes that are mirrored in the Avalara site; the description is being passed through the Avalara Rest service.
-
Edit the Shipping Methods configuration settings, to add Tax Use Code for each type of Shipping Method. The Use code must be matched to a value that is configured in the Avalara site.
-
Configure specific users to utilize Customer Code, Avalara Entity Use Code, and Exemption number; Customer Code and Exemption Number are sourced from the Avalara site and the Avalara Entity Use code is a searchable drop down that was previously configured in the system.
