{"id":13835633,"url":"https://github.com/boomerdigital/solidus_avatax_certified","last_synced_at":"2026-01-08T16:58:18.317Z","repository":{"id":10081232,"uuid":"62075701","full_name":"boomerdigital/solidus_avatax_certified","owner":"boomerdigital","description":"Improve your Solidus store's sales tax decision automation with Avalara AvaTax","archived":false,"fork":false,"pushed_at":"2024-01-25T12:07:35.000Z","size":2992,"stargazers_count":9,"open_issues_count":19,"forks_count":44,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-08-05T14:16:24.954Z","etag":null,"topics":["avalara","avatax","certified","rails","ruby","solidus","tax"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/boomerdigital.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2016-06-27T17:45:48.000Z","updated_at":"2022-01-25T16:25:20.000Z","dependencies_parsed_at":"2024-01-25T13:29:08.441Z","dependency_job_id":"661183d8-820e-4785-b65f-5f9f374d97dd","html_url":"https://github.com/boomerdigital/solidus_avatax_certified","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boomerdigital%2Fsolidus_avatax_certified","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boomerdigital%2Fsolidus_avatax_certified/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boomerdigital%2Fsolidus_avatax_certified/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boomerdigital%2Fsolidus_avatax_certified/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/boomerdigital","download_url":"https://codeload.github.com/boomerdigital/solidus_avatax_certified/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225632929,"owners_count":17499889,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["avalara","avatax","certified","rails","ruby","solidus","tax"],"created_at":"2024-08-04T14:01:07.052Z","updated_at":"2026-01-08T16:58:18.287Z","avatar_url":"https://github.com/boomerdigital.png","language":"Ruby","funding_links":[],"categories":["Ruby"],"sub_categories":[],"readme":"# solidus_avatax_certified\n\n[![CircleCI](https://circleci.com/gh/boomerdigital/solidus_avatax_certified.svg?style=svg)](https://circleci.com/gh/boomerdigital/solidus_avatax_certified)\n\nsolidus_avatax_certified is the *only* [officially certified AvaTax solution](https://www.avalara.com/legal/avalara-certified.html)\nthat integrates with Solidus. With this extension, you can add instantaneous sales tax decisions to\nyour store.\n\nFrom Avalara's own explanation of the certification program:\n\n\u003e Relax. It’s certified.\n\u003e\n\u003e Our “Certified for AvaTax” Program features integrations that perform at the highest level,\n\u003e providing the best possible customer experience.\n\u003e\n\u003e Avalara’s partners who have created certified integrations for AvaTax have demonstrated that those\n\u003e integrations contain elements which are essential to providing customers with easy-to-use software\n\u003e that gives accurate sales tax calculations. The certification criteria used to demonstrate these\n\u003e elements are based on Avalara’s years of experience integrating into ERP, ecommerce and\n\u003e point-of-sale applications.\n\n**[For Installation and Setup instructions, please visit our wiki.](https://github.com/boomerdigital/solidus_avatax_certified/wiki)**\n\n## Installation\n\n### 1. Install the gem\n\nFirst of all, install the gem:\n\n```console\n$ gem 'solidus_avatax_certified', github: 'boomerdigital/solidus_avatax_certified'\n$ bundle install\n$ bundle exec rails g solidus_avatax_certified:install\n```\n\n### 2. Configure the gem\n\nOnce you're done with the setup, you have to configure the gem. You can do this via an initializer\nor, for some option, via environment variables. The defaults are shown below:\n\n```ruby\n# config/initializers/avatax.rb\nSpree::Avatax::Config.configure do |config|\n  config.company_code = ENV['AVATAX_COMPANY_CODE']\n  config.license_key = ENV['AVATAX_LICENSE_KEY']\n  config.account = ENV['AVATAX_ACCOUNT']\n  config.environment = ENV['AVATAX_ENVIRONMENT'].presence || (Rails.env.production? ? :production : :sandbox)\n  config.log = true\n  config.log_to_stdout = false\n  config.address_validation = true\n  config.address_validation_enabled_countries = ['United States', 'Canada']\n  config.tax_calculation = true\n  config.document_commit = true\n  # The origin MUST be a JSON string. An example is shown below:\n  # { line1: '915 S Jackson St', line2: '', city: 'Montgomery', region: 'AL', postalCode: 36104, country: 'US' }.to_json\n  config.origin = '{}'\n  config.refuse_checkout_address_validation_error = false\n  config.customer_can_validate = false\n  config.raise_exceptions = false \nend\n```\n\n### 3. Seed the DB\n\nThen, load all seeds:\n\n```console\n$ bundle exec rake solidus_avatax_certified:load_seeds\n```\n\nThe line above will:\n\n- Create the entity use codes given to us by Avalara\n- Destroy the _Default_ tax category\n- Create the _Clothing_ and _Shipping_ tax categories\n- Add the _Shipping_ tax category to all shipping methods\n- Add the _Clothing_ tax category to all products\n- Destroy the _North America_ tax rate\n- Create tax rates for _Clothing_ and _Shipping_\n- Populate the default stock location with a random address\n\nYou can also run the following if you only want to load Avalara entity use codes:\n\n```console\n$ bundle exec rake solidus_avatax_certified:load_use_codes\n```\n\n### 4. Adjust your tax categories\n\nAvaTax has a list of [tax codes](https://taxcode.avatax.avalara.com/). You should create a tax\ncategory for each tax code used by your store.\n\nThe `solidus_avatax_certified:load_seeds` tax creates two tax categories: _Clothing_ and _Shipping_.\nWe invite you to check that the tax categories make sense for your store and that they have the\nappropriate tax codes.\n\nIf you need to adjust the tax categories or create new ones, the process is:\n\n1. Create a new tax category, using the appropriate tax code\n2. Create a tax rate for the tax category, use 0.0 as the rate and the _Spree/Avalara Transaction_\n   calculator\n3. Assign products (or shipping methods) to the tax category\n\n## Usage\n\nsolidus_avatax_certified will automatically calculate sales taxes for any products that belong to\nan AvaTax-backed tax category.\n\n### Assigning entity use codes to users\n\nIf any of your clients require a special entity use code, you can assign it to them from their\nprofile page in the Solidus backend.\n\n## Testing\n\nTo run the tests, install the bundle and run `rake`, which will generate a test app and run all\ntests against it:\n\n```console\n$ bundle\n$ bundle exec rake\n```\n\n## License\n\nCopyright (c) 2016-∞ Boomer Digital LLC, released under the New BSD License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboomerdigital%2Fsolidus_avatax_certified","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fboomerdigital%2Fsolidus_avatax_certified","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboomerdigital%2Fsolidus_avatax_certified/lists"}