docs
  1. Scayle Resource Center
  2. Avalara
  3. Avalara Add-On
  4. Configuration

Configuration

Checkout configuration and changes

Add-On configuration

AvaTax Settings

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

  1. Service URL to access the connector. Switch on Enable Sandbox Mode to access Sandbox environment, or switch off Enable sandbox mode to access Production environment.
  2. Enter AvaTax API Username and Password.
  3. Test Connection. When Username and Password are set, click Test connection to verify credentials and fetch Company Codes for this account.
  4. Select Company Code from a dropdown.
  5. Option to disable document recording. Switch off Enable Document Commitment to disable document recording.
  6. Enable/disable AvaTax API: Switch on/off Enable AvaTax.
  7. Enable client-side logging: Switch on/off Enable Logging .If Logging is enabled complete request/response for each call made to AvaTax will be saved and displayed on the Transaction Logs page for 30 days.

Upon clicking the Save button configurations will be saved. If AvaTax API is enabled, option to sync order events to AvaTax will be enabled, following webhook subscriptions will be created:

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

If AvaTax API is disabled, option to sync order events to AvaTax will be disabled as well.

Define tax codes

Service Cost Code - Tax Code mapping

This section allows assigning of the custom cost key to a tax code value.

Add new TaxCode/CostKey mapping

  1. 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

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

Remove 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.

  1. Select the Enable transmission of origin shipping address toggle button.
  2. Click on the Add Warehouse button to Add new warehouse address mapping.
  3. Select Warehouse ID from the dropdown.
  4. 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 of countries per ISO-3166).
    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.
  5. To save the entire config, press 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.

Add Warehouse

Edit warehouse Address

Manage tax codes using product Attribute Groups

Tax codes are handled via SCAYLE Attribute Groups. The Add-On considers a default tax (P000000), if the tax code is not set.

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

  1. Look up the tax codes for your product in the Avalara AvaTax System.
  2. In the SCAYLE Panel, go to Products and select the required product.
  3. In the Attributes section, click the taxCodeUS field and enter the appropriate tax code.
  4. 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 using SCAYLE Attribute Groups

Find an advanced Attribute Group named itemCodeAvaTax in your SCAYLE Panel after installing the add-on.

Customer Tax Exemption

The Customer Tax Exemption page allows you to assign entity use codes to customers in order to cover the use case of tax exemptions for the certification.

A customer service agent can assign an entity use code to a customer so that this customer can be exempted from taxes if the customer is eligible for it.

Customer Tax Exemption

Search for a single customer

Use Customer search functionality in the header to search for a single customer using the customer ID as the search parameter. Upon entering the customer ID, loader will appear in the input prefix, and a GET search request is sent to Admin API (through Add-On backend proxy) to fetch the customer with the matching customer ID.

Upon receiving the Customer (on a successful fetch) from the Admin API, another GET request is initiated to the Add-On Backend by using the fetched Customer ID to check for the assigned Entity Use Code, if present in the Add-On DB. When the both, search and fetch requests are finalized, the user is displayed with the UI showing the full customer information on Personal Data and Last Contact cards.

The list of the available Tax Use Codes is provided by the GET request to the Avalara API (by the Add-On BE proxy).

Assign Ava Tax code exemption to a customer

  1. Go to the Customer Tax Exemption section.
  2. In the AvaTax entity use code dropdown, select the Tax Code for the customer.
  3. Click Save.

This will initiate a PUT request to update the customer in the Add-On BE database with the selected Tax Use code.
The assigned Tax Code for the specific customer can be updated at any time with the same process.

Assign Ava Tax code exemption to a customer