16
Sovos Adapter for Magento Functional Guide Version 8.5.1 200 Ballardvale Street, 4th Floor | Wilmington, MA 01887 T. 978.527.1000 | Toll Free 866.890.3970 www.sovos.com

Sovos Adapter for Magentogo.sovos.com/rs/485-CPP-341/images/Sovos_Magento... · This guide is written for end users of the Sovos Adapter for Magento. For optimal performance, Sovos

Embed Size (px)

Citation preview

Sovos Adapter

for Magento

Functional Guide

Version 8.5.1

200 Ballardvale Street, 4th Floor | Wilmington, MA 01887

T. 978.527.1000 | Toll Free 866.890.3970

www.sovos.com

“THIS PUBLICATION IS DESIGNED TO PROVIDE ACCURATE AND AUTHORITATIVE INFORMATION IN REGARD TO THE SUBJECT MATTER COVERED. IT IS PROVIDED WITH THE UNDERSTANDING THAT THE PUBLISHER IS NOT ENGAGED IN RENDERING LEGAL, ACCOUNTING OR OTHER PROFESSIONAL SERVICE. IF LEGAL ADVICE OR ANY OTHER EXPERT ASSISTANCE IS REQUIRED, THE SERVICES OF A COMPETENT PROFESSIONAL PERSON SHOULD BE SOUGHT.”

—From a declaration of Principles jointly adopted by a Committee of the American Bar Association and a Committee of Publishers and Associations.

All trade names referenced herein are either trademarks or registered trademarks of their respective companies.

New editions of the Manual will incorporate all material updated since the previous edition.

We welcome any constructive suggestions regarding this manual.

© 2017 Sovos Compliance, LLC. All rights reserved.

TOCC O N T E N T S

Chapter 1. About This Guide

Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Before You Begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Support and Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Chapter 2. Use Cases

Enable/Disable Auditing - for TWE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Calculate Only/Calculate Plus Filing - For Taxify . . . . . . . . . . . . . . . . . . . . . . . . . 6

Use Cases. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Standard Sales Order. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Multi-line Sales Order. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Multiple Ship-To Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Transaction Fees . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Apply Discounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

i

ii

Overview

1C H A P T E R

About This Guide

This chapter provides the following information:

• Audience

• Before You Begin

• Conventions

• Support and Service

3 Confidential and Proprietary Information of Sovos Compliance, LLC

Audience

This guide is written for end users of the Sovos Adapter for Magento.

For optimal performance, Sovos is committed to supporting the 8.5.1 Sovos Adapter for Magento with TWE version 8.5.x or with Taxify. Please ensure that the adapter and tax engine are up to date to achieve the best levels of support and performance.

Before You Begin

Before beginning the process of utilizing Magento with Taxware Enterprise or Taxify, users must have successfully installed and configured both Magento version 2.0 or higher and Taxware Enterprise or Taxify.

Conventions

This guide may contain the following conventions for formatting text and code examples:

Support and Service

If you have any questions regarding this product, please contact your Designated Support Contact or call toll free at (866) 890-3971.

Typeface Description Example

<variable> A variable to be replaced by another name or value.

<user_name>

Command Names of commands, command-line input or elements that appear on screen.

Sovos Parameters

Menu > Item > Selection

Menu item selection in Taxware Enterprise, Taxify, or another application.

Organization Administration > Setup > Organization > Legal Entities

4 Confidential and Proprietary Information of Sovos Compliance, LLC

Overview

2C H A P T E R

Use Cases

This chapter includes a list of the use cases that are supported by the Adapter. This is not a comprehensive list.

These use cases rely on a demo user interface provided by Magento. This is just to provide an example. The exact steps necessary to utilize the Adapter’s tax calculation service will be determined by your financial system.

5 Confidential and Proprietary Information of Sovos Compliance, LLC

Enable/Disable Auditing - for TWE

The Sovos Adapter for Magento allows you to configure whether or not transactions are audited in the TWE Data Warehouse.

To set this configuration:

1. Log into your Magento instance as an Administrator.

2. Navigate to Stores > Configuration > Sovos > TWE Settings.

3. From the Audit Checkout Transaction drop-down list, select Yes to enable auditing or select No to disable auditing.

Caution! Do not edit any of the other fields in the Plugin Settings menu. Doing so will interrupt your integration with the Adapter.

4. Click .

Calculate Only/Calculate Plus Filing - For Taxify

The Sovos Adapter for Magento allows you to configure Calculate Only or Calculate Plus Filing in the Taxify Data Warehouse.

To set this configuration:

1. Log into your Magento instance as an Administrator.

2. Navigate to Stores > Configuration > Sovos > Taxify Settings.

3. From the Calculate Type drop-down list, select Calculate Plus Filing to enable auditing or select Calculate Only if you do now want to audit.

Caution! Do not edit any of the other fields in the Plugin Settings menu. Doing so will interrupt your integration with the Adapter.

4. Click .

6 Confidential and Proprietary Information of Sovos Compliance, LLC

Use Cases

Use Cases

This section describes the basic use cases supported by the Adapter.

Note: The use cases below rely on a demo web page provided by Magento. They assume you are logged in to a Magento instance.

Standard Sales Order

To complete a standard domestic sales order:

1. From the home screen, navigate to a category of items.

2. Select an item.

3. Enter the Color, Size, and Qty of the item, as applicable, and click

.

4. Click the icon at the top of the screen and click .

5. On the Shipping screen, select the Shipping Address and Shipping Method and

click .

7 Confidential and Proprietary Information of Sovos Compliance, LLC

The Order Summary will display the Order Total, including the shipping charge and tax amount.

6. To complete the transaction, click .

A confirmation message with your order number will appear. Click the order number to display the full order summary that is saved in Magento.

Multi-line Sales Order

To complete a sales order with multiple line items:

1. From the home screen, navigate to a category of items.

8 Confidential and Proprietary Information of Sovos Compliance, LLC

Use Cases

2. Select an item.

3. Enter the Color, Size, and Qty of the item, as applicable, and click

.

4. Navigate to another category, and select another item.

5. Enter the Color, Size, and Qty of the item, as applicable, and click

.

6. Click the icon at the top of the screen and click .

7. On the Shipping screen, select the Shipping Address and Shipping Method and

click .

9 Confidential and Proprietary Information of Sovos Compliance, LLC

The Order Summary will display the Order Total, including the shipping charge and tax amount.

8. To complete the transaction, click .

A confirmation message with your order number will appear. Click the order number to display the full order summary that is saved in Magento.

Multiple Ship-To Locations

To complete a multi-line transaction with multiple Ship-To locations:

1. Perform steps 1 through 5 of the Multi-line Sales Order use case.

2. Click the icon at the top of the screen and click View and edit cart.

3. On the Shopping Cart screen, click Check Out with Multiple Addresses.

4. For each item, select a different Send To location from the drop-down list and

click .

Note: To enter a Ship To location that doesn’t appear in the drop-down list, click Enter a New Address, enter the new address information, then select it from the drop-down list.

5. Once the Send To addresses have updated, click .

6. On the Select Shipping Method screen, select the Shipping Method for each

location and click .

10 Confidential and Proprietary Information of Sovos Compliance, LLC

Use Cases

7. On the Billing Information screen, select the Payment Method, and click

.

The Order Summary will display the Grand Total, including the shipping charge and tax amount for each location.

8. To complete the transaction, click .

A confirmation message with your order numbers will appear. Click the order number to display the full order summary that is saved in Magento.

Transaction Fees

Certain items are mapped to transaction fees in Magento. To complete a transaction that includes fees:

1. From the home screen, navigate to a category of items.

11 Confidential and Proprietary Information of Sovos Compliance, LLC

2. Select an item that is mapped to a transaction fee.

3. Enter the Color, Size, and Qty of the item, as applicable, and click

.

4. Click the icon at the top of the screen and click .

5. On the Shipping screen, if necessary, select the Shipping Address and Shipping

Method that are associated with the transaction fee and click .

The Order Summary will display the Order Total, including the shipping charge and tax amount. The transaction fee is included in the tax amount.

6. To complete the transaction, click .

A confirmation message with your order number will appear. Click the order number to display the full order summary that is saved in Magento.

Apply Discounts

Users have the ability to apply discounts through the View and Edit screen and the Review & Payments screen. To apply discounts to a sales order, complete the following steps:

12 Confidential and Proprietary Information of Sovos Compliance, LLC

Use Cases

1. Select an item to add to your cart. To do so, perform steps 1 through 3 of the Standard Sales Order.

2. Click on the icon at the top of the screen. To apply a discount in the View and Edit screen, click View and edit cart.

3. On the Edit Cart screen, enter the discount code in the Apply Discount Code field and click Apply Discount.

13 Confidential and Proprietary Information of Sovos Compliance, LLC

4. Users also have the option to apply discounts at checkout. To do so, click on

the icon on the top of the screen and click Go to Checkout.

5. On the Review & Payments screen, enter the discount code in the Apply Discount Code field and click Apply Discount.

6. Click Place Order to complete the transaction.

Note: Discounts such as “Buy 2 get 1 free” will be automatically applied at checkout.

14 Confidential and Proprietary Information of Sovos Compliance, LLC