Avatax Plugin

Overview

A plugin that interfaces your Vendure store with Avalara's AvaTax platform for automated US sales tax calculation based on geolocation, item taxability, new legislation, tax regulations, and more.

This is a paid plugin. For production use, please purchase a license at https://vendure.io/marketplace.

Installation

Add all other dependencies required to compile the plugin's UI

Usage

1. Add the AvataxPlugin to your VendureConfig plugins array.

2. Use the Vendure CLI to generate a database migration by running npx vendure migrate

3. Add the plugin's UI extensions to the AdminUiPlugin options in your VendureConfig.

Read more about the Admin Ui extension and compilation from the Vendure docs.

4. The plugin's UI extensions are built using React and JSX. For the Admin UI to compile, add the jsx property to the compilerOptions in tsconfig.json file.

5. Start the server and navigate to Settings > Avatax. Here you can configure the plugin with your Avalara credentials.

6. Click Test Connection to validate your credentials and test the connection to the AvaTax API, then Save Credentials to persist them.

Features

1. Admin UI extension with widgets to configure Avalara credentials, plugin preferences, company profiles and validate addresses.
2. A custom TaxLineCalculationStrategy that fetches tax rates from the AvaTax API.
3. Automated AvaTax transaction commits when orders transtion to the PaymentSettled state.
4. A custom permission definition for plugin configuration access control.
5. A verifyAddress mutation to verify addresses through the AvaTax API

Custom Fields

The plugins adds custom fields to the following entities;

Customer

entityUseCode: Customer Avalara Entity Use Code

ProductVariant

taxCode: Product Avalara Tax Code

Order

avataxInvoiceMessages: Invoice messaging returned by the AvaTax engine stored as a JSON string. These messages can be queried and displayed appropriately on invoices. Read More

Reference

• AvaTax Node.js SDK
• AvaTax API Reference