Kentico 8.x - 10.x Avalara Set-Up

Follow

Introduction

You must merge files, build the JMA.Custom library, and create a custom module in Kentico.

Do you support tax-exempt customers?

Yes, we support entity use codes.

What references must I add to my application?

Merge the file in the .ZIP that you downloaded from the JMA Web Store into your application. Unzip the JMA.Custom project and add it to your solution. For Kentico eight and nine, add these references:

  • Avalara.AvaTax.Adapter (located in bin folder of download)
  • CMS.Base
  • CMS.Core
  • CMS.DataEngine
  • CMS.Ecommerce
  • CMS.EcommerceProvider
  • CMS.EventLog
  • CMS.Globalization
  • CMS.Helpers
  • CMS.SiteProvider
  • CMS.Syncronization

For Kentico 10, add these references:

  • CMS.Base
  • CMS.Core
  • CMS.DataEngine
  • CMS.Ecommerce
  • CMS.Ecommerce.Web.UI
  • CMS.EventLog
  • CMS.Globalization
  • CMS.Helpers
  • CMS.SiteProvider
  • CMS.Synchronization

To add a reference, follow these steps:

  • Right click the bin folder of your Kentico add site
  • Click add reference
  • Select solution > JMA.Custom

How do I set up the module in Kentico?

Custom Module

You must set-up a custom module in Kentico:

  • On the home page, click modules
  • Next to ECommerce, click the green pencil: 
  • On the left, click user interface
  • Left click CMS > Administration > ECommerce:
     
  • On the top left, click the plus sign
  • On the form, enter these values:


Display Name: Avalara
Module: Custom
Element Icon Type: CSS Class
Element Icon CSS Class: icon-app-product-coupons
Type: URL
Target URL: ~/CMSModules/ECommerce/Pages/Tools/Configuration/Avalara/AvalaraAuthentication.aspx

Once you have added the module, it's time to access it.

  1. On the top left, click save
  2. On the left menu, click e-commerce > Avalara:

How do I mark some items as taxable and others as non taxable?

So Kentico can show the customer sales tax in the cart details, you must add two tax codes. Failure to perform this step will cause no calculations and errors in the log asking you to add the codes:

  • On the top left menu, type store configuration.
  • On the left, click tax classes.
  • Add a record called sales tax.
  • In the code name field, enter D0000000.
  • Click save.
  • Add another code called shipping tax.
  • Enter FR020200 in the code name field.
  • Click save.

There is no need to assign these codes to any items. If you want to change the tax code applied to certain items, you may add a custom tax code: 

  • On the top left menu, type store configuration.
  • On the left, click tax classes.
  • Add a code called electronics.
  • In the code name field, enter the Avalara tax code.
  • Click save.

Next, assign the tax code to products:

  • Next, go to Products > Add Products
  • From the dialog, select the products to have the tax code:


Shipping Tax

Add a tax class called Shipping tax. Under code name, enter FR010100. If you are using a pro subscription, contact Avalara for the correct code. If you fail to follow this step, the default code is FR020200.

If you are using the pro subscription, determine your tax category. Then, add another tax class. You can add that class to your digital items.

Origin Address

On the Kentico Avalara plugin settings page, you can add the address:

 

Settings

Here are three screenshots of the various areas and a description of what they do: 

  1. Avalara Settings
  2. AVS
  3. Batch Transactions

URL, Account Number, Company Code and License Key

You receive these from Avalara.

Product License Key from JMA

This is received from JMA with your purchase

Log Avalara Transactions

Creates a log file at ~/avalaralog.txt with info and error messages or uses the Kentico event log. Type event log in the Kentico menu to see this log.

Use Avalara in Certain States

Only transactions in these states will have transactions run through the service.

Use Avalara Address Validation

If you want Avalara to validate addresses, then check this box.

Order Prefix

When orders are entered in Avalara, it is the order number and this prefix.

Order Status Insert Tax

This order status that must occur before Avalara receives a Sales Invoice. Completed is the default value.

AVS settings can be found here.

Tax Details

In Kentico 8, you can see tax details in the shopping cart. Click the magnifying glass next to the product. Here is an example:

Have more questions? Submit a request
Powered by Zendesk