{"id":50852858,"url":"https://github.com/spree/spree_avatax_official","last_synced_at":"2026-06-14T15:40:05.963Z","repository":{"id":35857656,"uuid":"164463265","full_name":"spree/spree_avatax_official","owner":"spree","description":"The new officially certified Spree Avatax (Avalara) extension","archived":false,"fork":false,"pushed_at":"2026-06-10T11:18:53.000Z","size":978,"stargazers_count":7,"open_issues_count":7,"forks_count":22,"subscribers_count":9,"default_branch":"master","last_synced_at":"2026-06-14T15:40:04.112Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://spreecommerce.org/integrations/avatax-integration-with-spree/","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/spree.png","metadata":{"files":{"readme":"README.md","changelog":null,"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,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2019-01-07T16:54:43.000Z","updated_at":"2026-06-05T15:35:12.000Z","dependencies_parsed_at":"2023-01-16T07:43:52.687Z","dependency_job_id":"4e6ea408-ab8f-4927-8993-8e275e540d2c","html_url":"https://github.com/spree/spree_avatax_official","commit_stats":null,"previous_names":["spree/spree_avatax_official"],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/spree/spree_avatax_official","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spree%2Fspree_avatax_official","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spree%2Fspree_avatax_official/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spree%2Fspree_avatax_official/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spree%2Fspree_avatax_official/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/spree","download_url":"https://codeload.github.com/spree/spree_avatax_official/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spree%2Fspree_avatax_official/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34326240,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-14T02:00:07.365Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2026-06-14T15:40:05.189Z","updated_at":"2026-06-14T15:40:05.941Z","avatar_url":"https://github.com/spree.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Spree Avalara AvaTax official extension\n\n[![CI](https://github.com/spree/spree_avatax_official/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/spree/spree_avatax_official/actions/workflows/ci.yml)\n\nThe new officially supported Avalara AvaTax extension for [Spree Commerce](https://spreecommerce.org/) using [Avalara REST API v2](https://developer.avalara.com/api-reference/avatax/rest/v2/).\n* [Introduction](#introduction)\n* [Maintenance \u0026 support](#maintenance--support)\n* [Features](#features)\n* [Installation](#installation)\n* [Setup](#setup)\n* [Migrating from spree_avatax_certified](#migrating-from-spree_avatax_certified)\n* [Testing](#testing)\n* [Contributing](#contributing)\n* [About Spark Solutions](#about-spark-solutions)\n\n## Introduction\n\n\u003cimg src=\"https://spreecommerce.org/wp-content/uploads/2019/11/AvalaraCertifiedBadge_Refunds.png\" width=150 align=right\u003e \u003cimg src=\"https://spreecommerce.org/wp-content/uploads/2019/11/AvalaraCertifiedBadge_SalesTax.png\" width=150 align=right\u003e Avalara AvaTax is a cloud-based solution automating transaction tax calculations and the tax filing process. Avalara provides real-time tax calculation using tax content from more than 12,000 US taxing jurisdictions and over 200 countries, ensuring your transaction tax is calculated based on the most current tax rules.\n\nThe new officially certified Spree AvaTax extension helps Spree users and developers to switch from the old Avalara REST API V1 to the latest [Avalara REST API v2](https://developer.avalara.com/api-reference/avatax/rest/v2/). In the words of Avalara developers \"the benefits are huge\" as the new API V2 offers improved AvaTax performance, reliability and a wide range of new functionality.\n\nAnd since AvaTax delivers sales and use tax calculations at the time of checkout or billing — in real time — the business benefits from implementing the new Spree AvaTax V2 extension are significant, potentially improving conversion rates and sales results.\n\n## Maintenance \u0026 support\n\nThe new extension comes with technical support from both Spree Commerce core team and Avalara and will be maintained to keep up with the innovations introduced by Avalara in the future. The old extension will no longer be maintained or supported.\n\nFor more information, support and guidance on how to implement Spree AvaTax V2 extension feel free to:\n* reach out through the [Spree contact form](https://spreecommerce.org/contact/)\n* join the Spree slack channel #spree-avatax at [slack.spreecommerce.org](http://slack.spreecommerce.org)\n\n## Features\n\n1. Tax calculation (additional/included tax), US state tax, Canadian HST, VAT supported\n2. Address validation for US \u0026 Canada\n3. Commiting complete orders\n4. Cancelling (voiding) orders\n5. Refunding orders\n6. GetByCodeService for getting SalesInvoice for order from Avatax\n7. GetTaxService for getting totalTaxCalculated for order from Avatax\n8. AvataxLog for logging API calls\n9. Caching responses for improved performance\n10. Multiple company (store) support\n\n## Installation\n\n1. Add this extension to your `Gemfile` with this line:\n  ```ruby\n  gem 'spree_avatax_official'\n  ```\n\n2. Install the gem using Bundler:\n\n  ```bash\n  bundle install\n  ```\n\n3. Run the install generator\n\n  ```bash\n  bundle exec rails g spree_avatax_official:install\n  ```\n\n4. Restart your server\n\n  If your server was running, restart it so that it can find the assets properly.\n\n## Setup\n\nIn order to configure tax calculation you need to:\n1. [Connect Spree to AvaTax](#connect-spree-to-avatax)\n2. [Configure Spree Stock Location](#configure-spree-stock-location)\n3. [Configure AvaTax settings](#configure-avalara-avatax)\n4. [Assign an AvaTax System Tax Code to a Tax Category](#assign-an-avatax-system-tax-code-to-a-tax-category)\n\n### Connect Spree to AvaTax\n\nIn order to use `spree_avatax_official` extension, you need to configure your\nAvatax credentials. To do so, open spree admin panel and go to **Configurations**\nand then **Avatax Settings**.\n\n\u003cimg width=\"1053\" alt=\"Zrzut ekranu 2019-10-15 o 12 46 14\" src=\"https://user-images.githubusercontent.com/581569/66825661-fcd5d000-ef4a-11e9-84b1-993b1a5c1996.png\"\u003e\n\nCompany code, account number and license key can be\nconfigured in the **Avatax Credentials** section of the form.\n\n\u003cimg width=\"1053\" alt=\"Zrzut ekranu 2019-10-16 o 12 20 14\" src=\"https://user-images.githubusercontent.com/581569/66910959-da59ba80-f00f-11e9-8b96-ad2fa45b01ae.png\"\u003e\n\n* **Account Number:** Provided during your AvaTax account activation process.\n* **License Key:** Provided during your AvaTax account activation process.\n* **Company Code:** Company profile identifier in the AvaTax Admin Console.\n\n**Service URL** is an URL to connect to the Development or Production AvaTax services. It can be configured in the **Avatax Endpoint urls** section below.\n\n\u003cimg width=\"1053\" alt=\"Zrzut ekranu 2019-10-16 o 12 24 35\" src=\"https://user-images.githubusercontent.com/581569/66911009-fa897980-f00f-11e9-8524-1c64540a9a0f.png\"\u003e\n\nYou can test settings you provided using the **Ping Avatax** button under the form\n\n\u003cimg width=\"1053\" alt=\"Zrzut ekranu 2019-10-16 o 12 25 26\" src=\"https://user-images.githubusercontent.com/581569/66911077-17be4800-f010-11e9-89e0-e1982dd84e25.png\"\u003e\n\n### Configure Spree Stock Locations\n\nIn order for extension to be able to calculate the taxes, you need to set your stock locations addresses properly.\nTo do so, in Spree admin panel, go to `Configurations -\u003e Stock Locations` and edit addresses of all Stock Locations  visible on the list.\n\n### Configure Avalara AvaTax\n\nOnce connected, you configure additional settings.\n\n\u003cimg width=\"1053\" alt=\"Zrzut ekranu 2019-10-16 o 12 26 54\" src=\"https://user-images.githubusercontent.com/581569/66911217-5c49e380-f010-11e9-86e7-f6fee2f0795d.png\"\u003e\n\n* **Enable Commiting Transactions:** Enables tax document submission to **Avalara’s AvaTax** service for record keeping. With this setting enabled, transactions will be posted and committed to the **AvaTax Admin Console**.\n* **Enable Address Validation:** Option to enable or disable address validation\n\n### Assign an AvaTax System Tax Code to a Tax Category\n\nIn order to assign **AvaTax System Tax Code** to **Spree Tax Category**, you need to open **Tax Categories** settings screen (`Configurations -\u003e Tax Categories`), pick up existing or create a new **Tax Category** and fill the **Tax Code** input with the applicable **AvaTax System Tax Code**.\n\n\u003cimg width=\"1053\" alt=\"Zrzut ekranu 2019-10-15 o 12 51 04\" src=\"https://user-images.githubusercontent.com/581569/66825678-095a2880-ef4b-11e9-840c-0a86dbc721b4.png\"\u003e\n\nIf left blank, the **Tax Code** will\ndefault to `P0000000`.\n\nTo see a listing of all available **AvaTax System** tax codes, see http://taxcode.avatax.avalara.com\n\n## Migrating from spree_avatax_certified\n\nThe old extension spree_avatax_certified using the old Avalara REST API V1 will no longer be maintained or supported by the Spree team.\n\nIf you need to migrate from the old spree_avatax_certified to the new spree_avatax_official, in order to take advantage of the improved AvaTax performance, reliability and new functionality, there are various ways of ensuring backwards compatibility of Orders (eg. for refund purposes) which were committed to Avatax using the old extension.\n\nPlease reach out through the [Spree contact form](https://spreecommerce.org/contact/) to discuss an optimal strategy for your use case.\n\n## Testing\n\nFirst bundle your dependencies, then run `rake`. `rake` will default to building the dummy app if it does not exist, then it will run specs. The dummy app can be regenerated by using `rake test_app`.\n\n```shell\nbundle\nbundle exec rake\n```\n\nWhen testing your applications integration with this extension you may use it's factories.\nSimply add this require statement to your spec_helper:\n\n```ruby\nrequire 'spree_avatax_official/factories'\n```\n\n## Contributing\n\nIf you'd like to contribute, please take a look at the\n[instructions](CONTRIBUTING.md) for installing dependencies and crafting a good\npull request.\n\n## License\n\nSpree Avatax Official is copyright © 2019 [Spark Solutions Sp. z o.o.][spark].\nIt is free software, and may be redistributed under the terms specified in the\n[LICENCE](LICENSE) file.\n\n[LICENSE]: https://github.com/spree-contrib/spree_avatax_official/blob/master/LICENSE\n\n## About Spark Solutions\n\n[![Spark Solutions](http://sparksolutions.co/wp-content/uploads/2015/01/logo-ss-tr-221x100.png)][spark]\n\nSpree Avatax Official is maintained by [Spark Solutions Sp. z o.o.](http://sparksolutions.co?utm_source=github) and\nsupported by [Avalara Inc.](https://www.avalara.com/us/en/index.html). The names and logos are trademarks of Avalara Inc.\n\nWe are passionate about open source software and [available for hire][spark].\n\n[spark]:http://sparksolutions.co?utm_source=github\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspree%2Fspree_avatax_official","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspree%2Fspree_avatax_official","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspree%2Fspree_avatax_official/lists"}