Configuration

Checkout configuration and frontend changes

When requesting the Avalara Add-on, your SCAYLE Account Manager will adjust the SCAYLE Checkout settings as needed.

Checkout configuration changes for Avalara:

Set taxRate.externalService.enabled to true
Set taxRate.externalService.supportedCountryCodes to [“USA”]
Set basket.showNetPrices to true
Add new translation string basket.taxes: “Estimated Taxes“

These settings will lead to the following changes in the Checkout frontend for your end users.

Prices of products and service costs are displayed with net values
Voucher discounts on item level are not displayed
Promotional artifacts on item levels are not displayed
Tax is declared as Estimates Taxes
An info message on tax exemption support process is displayed below the oder summary

Checkout frontend with external tax service

Make sure your Storefront displays net prices and provides your users with a message like: "taxes are calculated during the Checkout process".

Add-on configuration

Avalara Add-on Settings

This section allows to specify and test the connection to your AvaTax Production and Sandbox Account:

Service URL to access the connector. Toggle Enable Sandbox Mode on for Sandbox access, or off for Production access
Enter AvaTax API Username and Password.
Click “Test Connection” to verify credentials and fetch Company Codes once Username and Password are set.
Select Company Code from a dropdown.
Turn off “Enable Document Commitment” to disable document recording.
Enable AvaTax API: Switch on Enable AvaTax.
Enable client-side logging: Switch on Enable Logging.
Click Save.

If Logging is enabled complete request and response for each calls made to AvaTax will be saved and displayed on the Transaction Logs page for 30 days.

If AvaTax API is enabled, the Add-on will transmit sales order, order invoice and refund events to Avalara based on the following webhook subscriptions:

order-confirmed
order-cancelled
order-item-cancelled
order-item-returned
order-item-unshippable

Tax codes for products are handled via SCAYLE attribute groups. The Avalara Add-on sends null to AvaTax, if the tax code is not set as product attribute. AvaTax considers a default tax code (P000000).

For each product or variant in SCAYLE you use the SCAYLE attribute enhancement capabilities and make sure that the attribute group taxCodeUS is set.

Look up the tax codes for your product in the Avalara AvaTax System.
In the SCAYLE Panel, go to Products and select the required product.
In the Attributes section, click the taxCode field and enter the appropriate tax code.
Click Save.

You can also use bulk operations feature to enhance tax codes on your products, use the import capabilities of the SCAYLE Panel, or set product attributes via the Admin API.

If you leave the product attribute group taxCodeUS blank, then Avalara AvaTax Add-on assigns the default code for physical goods tax, P000000, to your product or variant.

Manage Avalara item code

Item codes for products are also handled via SCAYLE attribute groups. Find an advanced Attribute Group named itemCode in your SCAYLE Panel after installing the Add-on.

Service cost code - tax code mapping

Tax codes for shipment, freight or other taxable services can be configured in the Avalara Add-on. The section Service Cost Code - Tax Code Mapping on the Settings page allows assigning of the custom cost key to a tax code value.

Add new TaxCode/CostKey mapping

Click on Add New Row button.
This will create a new row with empty Tax Code and Cost Key input fields to assigns mappings.

Free text input fields should be populated before saving, otherwise validation with required rule set will kick in per backend specification.

Remove the mapping row

Select the Trash icon at the right end of the mapping row.

Transmission of origin shipping address

This mapping section allows assigning a custom Address value to a Warehouse specified by an ID.

Before assigning custom address, make sure that a mapping row exists.

Select the Enable transmission of origin shipping address toggle button.
Click on the Add Warehouse button to add new warehouse address mapping.
Select Warehouse ID from the dropdown.
Select the pen icon to edit the address input field. In the popup, enter:
1. Required fields : Line1 (text), City (text), Region (text), Postal Code (text), Country (select from dropdown).
2. If required fields are not set:
  Click on the Edit button to trigger validation on the required fields. Upon adding the valid address with the Edit button, the address will appear in the compact form in the Address field of the mapping row.
3. If the Enable transmission of origin shipping address toggle is enabled:
  mapping rows with properly filled address mapping should be present, otherwise the validation of empty address mapping will kick-in per backend spec.
To save the entire config, click Save in the top right of the page header.

If at any time Transmission of origin shipping address toggle is disabled: the address mapping row state will be preserved, but the section won’t be visible.

Customer Tax Exemption

The Customer Tax Exemption page allows you to assign entity use codes to customers. Like this customer service agents can assign entity use codes to a customers so that these customers can be exempted from taxes if they are eligible for it.

Assign Ava Tax code exemption to a customer

Go to Go to Add-Ons > Avalara > Customer Tax Exemption.
Search for a customer using the customerID
In the AvaTax entity use code dropdown, select the Entity Use Code for the customer.
Click Save.