integration guide - vertex® tax links for magento 1 - 1.3 › media › catalog › product ›...

Integration Guide

Vertex® Tax Links for Magento 1 - 1.3.5

For Vertex® Indirect Tax O Series® and Vertex® Cloud

November 2018

Copyright and legal notices

Copyright © 2018 Vertex Global Tax Solutions Ireland Holdings. All rights reserved.

This documentation may not be reproduced, displayed, distributed, modified, posted, republished, or transmitted in any form or by any means, without the prior written consent of Vertex Global Tax Solutions Ireland Holdings or its affiliates (collectively, “Vertex”), except as otherwise specified in a valid, current Vertex license agreement or allowed by law.

Disclaimers

The information contained in this documentation is designed to help users in regard to the subject matter covered. Some of it may be based upon interpretations of federal, state, foreign and other tax laws and regulations. Each entity is responsible for making its own determination of how such laws and regulations apply to its own circumstances and for evaluating the capabilities of, and all data and results generated by, any product that is described in this documentation. Vertex is not engaged in providing legal, tax or accounting advice or services and the information contained in this documentation or in any product cannot replace the advice of competent legal counsel. Further, the information in this documentation is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

Trademarks and Service Marks

The trademarks, logos and service marks ("marks") displayed in this documentation are the property of Vertex or other third parties. Users are not permitted to use these marks without the prior written consent of Vertex or the third party that may own the mark.

Third Party Products

Copies of the licenses for some third-party products included with a Vertex product may be found in or with the installation materials for that product.

November 2018

Contents

Preface ............................................................................................................... 4 About Vertex and our services .................................................................................................. 4 About Vertex® Tax Links for Magento ...................................................................................... 4 About this guide ........................................................................................................................ 4

Chapter 1. Release Notes ................................................................................... 5 Compatibility ............................................................................................................................. 5 Enhancements and fixes ........................................................................................................... 6 Known issues ............................................................................................................................. 7

Chapter 2. Installation ........................................................................................ 8 Before you install ...................................................................................................................... 8

Environments ...................................................................................................................... 8 Vertex account information ................................................................................................ 8 System and data backup ..................................................................................................... 9

Accessing and Installing Vertex Tax Links for Magento ............................................................ 9 After you install ....................................................................................................................... 10 Uninstalling Vertex Tax Links................................................................................................... 10

Chapter 3. Configuration ................................................................................... 12 Architecture and design .......................................................................................................... 12

Magento tax request flow ................................................................................................. 13 Tax calculation ................................................................................................................... 13 API Overview ..................................................................................................................... 14

Vertex Tax Links for Magento Configuration .......................................................................... 21 Configurable data .............................................................................................................. 22 Accessing the Vertex Tax Links for Magento configuration .............................................. 22 Managing the Vertex Tax Links for Magento configuration ............................................. 25 Additional Vertex Tax Solution functions .......................................................................... 30

November 2018

Preface This preface contains information about Vertex services, Vertex® Indirect Tax O Series®, Vertex® Cloud, and available documentation.

About Vertex and our services Vertex Inc. is the leading provider of corporate tax software and services for companies of all sizes, from small businesses to global multinationals. Vertex provides solutions in every major line of tax including corporate income, sales and consumer use, value added, and payroll. Vertex also offers tailored solutions for specific industries including retail, communications, hospitality, and leasing.

Contact details depend on whether you are integrating with Vertex Cloud or Vertex O Series as follows:

• If you are integrating with Vertex Cloud, contact Vertex via email or phone: − To contact Vertex by email: [email protected]. − To contact Vertex by phone: 1-855-221-5885.

• If you are integrating with Vertex O Series: − To contact Vertex about technical support, account services, or training,

go to https://www.vertexinc.com/contact/. − To access technical information about your Vertex tax solution, go to

https://vertexinc.custhelp.com/. − To contact Vertex by phone: 1-855-281-1900.

About Vertex® Tax Links for Magento Vertex Tax Links for Magento 1 is a connector that integrates Magento 1 with Vertex tax solutions for sales tax calculation. This functionality is available for the United States and Canada.

About this guide This guide contains information to install and configure Vertex Tax Links for Magento with Vertex tax solutions. Magento is a highly customizable application, and this guide provides instructions to help you leverage that capability.

November 2018

Chapter 1. Release Notes This chapter provides information about Vertex Tax Links for Magento 1 - version 1.3.5.

Vertex Tax Links for Magento 1 is a connector that integrates Magento 1 with Vertex tax solutions for sales tax calculation. This functionality is available for the United States and Canada.

For detailed information about installing and using Vertex Tax Links for Magento 1, refer to the following chapters:

• Installation (see page 8) • Configuration (see page 12)

In this chapter

Compatibility ................................................................................... 5 Enhancements and fixes ................................................................. 6 Known issues ................................................................................... 7

Compatibility Vertex Tax Links for Magento 1- version 1.3.5 is supported with:

Vertex tax solutions [ERP] versions

• Vertex O Series for Indirect Tax 6.0 using the 6.0 schema

• Magento 1.x Open Source: 1.6.0.0 – 1.9.3.10

• Magento 1.x Commerce: 1.12.0.0 – 1.14.3.10



• Vertex Cloud

Vertex® Tax Links for Magento 1 Integration Guide - 1.3.5 Chapter 1. Release Notes Enhancements and fixes

November 2018

Enhancements and fixes This section provides a release history of enhancements and fixes to Vertex Tax Links for Magento 1 - version 1.3.x.

Version 1.3.5 enhancements and fixes • Resolved issue where Vertex would not calculate taxes when editing an order

through the Magento Order Edit process Version 1.3.4 enhancements and fixes • Replaced short array syntax with traditional array syntax Version 1.3.3 enhancements and fixes • Corrected 500 error when child product has a different tax class than the

parent class Version 1.3.2 enhancements and fixes • Resolved empty () parameter Version 1.3.1 enhancements and fixes • Corrected 500 error when Shopping Cart display settings were set to

“Including and Excluding Tax” • Refactored code to remove erroneous native Magento tax detail when Vertex

is used to calculate tax • Corrected issue where product class was passed incorrectly from the

storefront • Refactored code to accurately extend Magento’s core controller during

checkout Version 1.3.0 enhancements and fixes • Enhanced connector to work with O Series 7.0 as well as O Series 6.0

Vertex® Tax Links for Magento 1 Integration Guide - 1.3.5 Chapter 1. Release Notes Known issues

November 2018

Known issues This section describes known issues with Vertex Tax Links for Magento 2:

• When checking out in the Storefront as a guest, the amount for Subtotal Including Tax displays incorrectly.

• When using the Including and Excluding Tax setting for Orders, Invoices, and Credit Memos, the Sales & Use Tax amount in the Order Summary section of a Magento Invoice is off by a penny, but the Total Tax amount is correct.

• When using the Including and Excluding Tax setting for Orders, Invoices, and Credit Memos, the Sales & Use Tax amount in the Order Summary section of a Magento Credit Memo is off by a penny but the Total Tax amount is correct.”

• Creating a Magento Credit Memo does not generate a Vertex invoice message for bundled products.

• Magento Tax Rates are ignored for unsupported countries.

November 2018

Chapter 2. Installation This chapter describes how to install and uninstall Vertex® Tax Links for Magento 1 - version 1.3.5.

In this chapter

Before you install ............................................................................ 8 Accessing and Installing Vertex Tax Links for Magento .................. 9 After you install ............................................................................. 10 Uninstalling Vertex Tax Links......................................................... 10

Before you install This section describes prerequisites you should fulfill before you begin to install Vertex Tax Links for Magento.

Note: If your Magento instance has an earlier version of Vertex Tax Links installed, and you want to upgrade your Tax Links Version, you must uninstall the earlier version of Tax Links prior to upgrading.

Environments For the ability to support Vertex Tax Links, ensure that your installed environment is one of the following:

• Magento Open Source version 1.6.0.0 through 1.9.3.10 • Magento Commerce version 1.12.0.0 through 1.14.3.10 Refer to Release Notes (see page 5) for more information about version compatibility, release history of fixes and enhancements, and descriptions of any known issues.

Vertex account information Confirm that you have the following account information provided by Vertex or your IT department:

• Login user name and password, or a Trusted ID. • Endpoints for tax calculation and address verification. • Company name that you registered with Vertex.

Vertex® Tax Links for Magento 1 Integration Guide - 1.3.5 Chapter 2. Installation Accessing and Installing Vertex Tax Links for Magento

November 2018

System and data backup Always back up your files and data before making any significant changes to your webstore.

Complete the following steps to perform a full backup of your Magento software and data prior to installation:

1. On the Admin menu, navigate to System > Tools > Backups. 2. Click System Backup. 3. Click OK to continue when prompted that the backup will take time. 4. Select the Put store in maintenance mode while backup creation check box. Note: After the backup is created, maintenance mode turns off automatically.

5. If the check box labeled Include Media folder to System Backup displays, select it.

Note: Do not select Exclude media folder from backup.

6. Click OK. 7. After the backup process completes, download the backup and keep it in a

safe place.

Accessing and Installing Vertex Tax Links for Magento This chapter provides instructions for accessing and installing the Vertex Tax Links for Magento 1.

Although Vertex Tax Links for Magento solution is free, you need to add it to your cart and check it out through the Magento marketplace. Vertex Tax Links will be downloaded as a .tgz file. Note the location of the download location because you will need to upload the file as part of the installation process.

Note: When upgrading to a new version of Vertex Tax Links, uninstall the existing version first.

• If the older version of the connector was installed using Magento Connect, use Magento Connect to uninstall the connector. Refer to Uninstalling Vertex Tax Links (see page 10) for more details.

• If command-line prompts were used to install the older version of the connector, have your Trusted IT Professional uninstall the older connector using command-line prompts.

Vertex® Tax Links for Magento 1 Integration Guide - 1.3.5 Chapter 2. Installation After you install

November 2018

Complete the following steps to install Vertex Tax Links using Magento Connect:

1. Log in to the Magento Admin Panel.2. Navigate to System > Magento Connect > Magento Connect Manager.3. Log in to Magento Connector using your Magento Admin Panel credentials.4. Locate the Direct Package File Upload section.5. Click Choose File.6. Select the .tgz file you downloaded from the Magento marketplace.7. Click Upload.8. Click Refresh.9. Click Return to Admin.10. Navigate to System > Cache Management.11. Flush the Configuration cache and Layouts cache if disabled.12. Log off the Magento Admin Panel.

After you install For detailed information about configuring Vertex Tax Links for Magento, refer to Configuration (see page 12).

Uninstalling Vertex Tax Links To uninstall Vertex Tax Links from your Magento 1 instances, complete the following steps:

1. Log in to the Magento Admin Panel.2. Navigate to System > Magento Connect > Magento Connect Manager.3. Log in to the Magento Connector using your Magento Admin Panel

credentials.4. Scroll down to Manage Existing Extensions.5. Locate Vertex.6. Click the down arrow in the Actions field and select Uninstall.7. Click Commit Changes.8. Click Refresh.9. Click Return to Admin.10. Navigate to System > Cache Management.

Vertex® Tax Links for Magento 1 Integration Guide - 1.3.5 Chapter 2. Installation Uninstalling Vertex Tax Links

November 2018

11. Flush the Configuration cache and Layouts cache if disabled. 12. Log off the Magento Admin Panel.

November 2018

Chapter 3. Configuration This chapter provides details about the configuration of Vertex® Tax Links for Magento 1.

In this chapter

Architecture and design ................................................................ 12 Vertex Tax Links for Magento Configuration ................................ 21

Architecture and design Magento is a feature-rich eCommerce platform built on open-source technology that provides online merchants with unprecedented flexibility and control over the look, content and functionality of their eCommerce store. Magento’s intuitive administration interface features powerful marketing, search engine optimization, and catalog management tools to give merchants the power to create sites that are tailored to their unique business needs. Magento offers companies the ultimate eCommerce solution.

Magento Open Source is an open-source content-management system. Anyone can modify the core system. Developers can implement the core files and extend its functionality by adding new plug-in modules provided by other developers. Since the first public beta version was released in 2007, Magento Open Source has been developed and customized in order to provide a basic eCommerce platform. The latest version, 1.9.3.10, was released on September 18, 2018. Magento has announced that June 2020 is the end of software support for Magento 1 Open Source.

Magento Commerce is derived from Magento Open Source and has the same core files. Unlike Open Source, Magento Commerce is not free, but it has more features and functionality. This edition is designed for large businesses that require technical support with installation, usage, configuration, and troubleshooting.

The Magento team develops Magento Commerce by cooperating with users and third parties. The latest version, 1.14.3.10, was released on September 18, 2018. Magento has announced that June 2020 is the end of software support for Magento 1 Commerce.

Vertex® Tax Links for Magento 1 Integration Guide - 1.3.5 Chapter 3. Configuration Architecture and design

November 2018

Magento extensions (also known as modules or plugins) are created by Magento developers to extend Magento’s basic functionality. Magento users can install modules by downloading them, and uploading them to their server, or by purchasing them in the Magento Marketplace and using the Magento Web Setup Wizard to install them automatically.

The Magento Marketplace is an online marketplace that site owners can search for compatible Magento extensions to add to their stores. The Marketplace offers both free and paid extensions.

Magento tax request flow

Tax calculation At checkout, Vertex Tax Links passes the order details and the address to Vertex. Based on these details, Vertex calculates the applicable sales taxes and returns those values to Magento.

Vertex uses the address provided by Magento to determine the tax jurisdiction, and then calculates tax based on the selected products and prices.

If a system error or connectivity issue prevents tax from being calculated or returned by Vertex, the tax is set to zero, the checkout process continues, and an error is logged.


November 2018

API Overview The Vertex tax calculation service executes when Vertex Tax Links sends references using CalculateExternalTaxesStrategy to the standard external tax calculation framework. The Magento event type and Vertex Tax Links configuration determine the Vertex message type.

For non-digital products, shipping must be determined prior to the tax calculation, regardless of the Magento event being processed.

Magento events Five Magento events trigger the Vertex Tax Solution to calculate sales tax. Two of the events occur within the Shopping Cart. Three of the events occur within Admin Panel.

Note: When processing Magento events, Vertex Tax Links for Magento uses the following two types of Vertex messages:

• Quotation messages do not write the tax to the Vertex Tax Journal. • Invoice messages write the tax to the Vertex Tax Journal for compliance and

auditing records.


November 2018

Shopping Cart events The two Shopping Cart events that trigger the Vertex Tax Solution to calculate sales tax are Estimate and Checkout.

Estimate event When processing an Estimate from the Shopping Cart, the Vertex quotation message is always used, and Vertex Tax Links for Magento does not write the tax to the Vertex Tax Journal.

Checkout event When processing a Checkout from the Shopping Cart, the Vertex Tax Links for Magento configuration determines the Vertex message type, and specifically identifies the Invoice Tax field.


November 2018

The following two values are available for the Invoice Tax field:

• When Invoice Created (as shown in the figure): Processing a checkout from the Shopping Cart uses the Vertex quotation message, and Vertex Tax Links for Magento does not write the tax to the Vertex Tax Journal.

• When Order Status is Changed: Processing a checkout from the Shopping Cart uses the Vertex quotation message until the desired order status is reached. When the order status is achieved, a Vertex invoice message is used. Magento merchants define their order statuses as part of their Magento configuration. The Vertex quotation message does not write the tax to the Vertex Tax Journal; however, the Vertex invoice message does write tax to the Vertex Tax Journal.


November 2018

Admin Panel events The three Admin Panel events that trigger the Vertex Tax Solution to calculate sales tax are Order, Invoice, and Credit Memo.

Order event The Vertex Tax Links configuration determines the Vertex message type.

The setting in the Invoice Tax field determines whether Vertex Tax Links writes the tax to the Vertex Tax Journal as follows:

• When Invoice Created (as shown in the figure): Processing an Order from the Admin Panel uses the Vertex quotation message, and Vertex Tax Links for Magento does not write the tax to the Vertex Tax Journal.

• When Order Status is Changed: Processing a checkout from the Admin Panel uses the Vertex quotation message until the desired order status is reached. When the order status is achieved, a Vertex invoice message is used. The Vertex quotation message does not write the tax to the Vertex Tax Journal; however, the Vertex invoice message does write tax to the Vertex Tax Journal.

Invoice event The Vertex Tax Links configuration determines the Vertex message type.

The setting in the Invoice Tax field determines whether Vertex Tax Links writes the tax to the Vertex Tax Journal as follows:

• When Invoice Created (as shown in the figure): Processing an Invoice from the Admin Panel uses the Vertex invoice message, and Vertex Tax Links for Magento writes the tax to the Vertex Tax Journal.

• When Order Status is Changed: Processing an Invoice from the Admin Panel does not generate a Vertex tax call unless you changed your connector configuration between the creation of the Order and the creation of the Invoice.

Credit Memo event When processing a Credit Memo from the Admin Panel, the Vertex invoice message is used. Vertex Tax Links for Magento writes the tax to the Vertex Tax Journal.


November 2018

Messaging and data mapping For tax calculations, Vertex Tax Links for Magento uses the Vertex CalculateTax web service for messaging and data mapping. Magento customers can use either the Magento Open Source platform or the Magento Commerce platform to calculate tax on estimates, checkouts, orders, invoices, and credit memos, and leverage many features of the Vertex tax solution.

For demonstration purposes, sample Invoice Request XML and Invoice Response XML are provided. The XML data elements for the Vertex Invoice Request and Response are the same as those for the Vertex Quotation Request and Response.

Sample invoice request message The following is an example of an invoice request message: <?xml version="1.0" encoding="UTF-8"?> <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <VertexEnvelope xmlns="urn:vertexinc:o-series:tps:6:0"> <Login> <TrustedId>XXXXXXXXXXXXXXXX</TrustedId> </Login> <InvoiceRequest documentNumber="000000001" documentDate="2018-01-19" transactionType="SALE" postingDate="2018-01-19"> <LineItem lineItemId="0" locationCode="X3T" lineItemNumber="1"> <Seller> Xetrev100</Company> <PhysicalOrigin> <StreetAddress1>100 applegate</StreetAddress1> <StreetAddress2/> <City>Central Islip</City> <MainDivision>NY</MainDivision> <PostalCode>11722-1924</PostalCode> <Country>USA</Country> </PhysicalOrigin> </Seller> <Customer> <CustomerCode classCode="Retail Customer">General</CustomerCode> <Destination> <StreetAddress1>194 Lodi Ave</StreetAddress1> <StreetAddress2/> <City>Metuchen</City> <MainDivision>NJ</MainDivision> <PostalCode>08840-2733</PostalCode> <Country>USA</Country> </Destination> </Customer> <Product productClass="Taxable Goods">2480-8-50</Product> <Quantity>1</Quantity> <ExtendedPrice>3244.95</ExtendedPrice> <UnitPrice>3244.95</UnitPrice> </LineItem> </QuotationRequest>


November 2018

</VertexEnvelope> </s:Body> </s:Envelope>

Sample invoice response message The following is an example of an invoice request message: <?xml version="1.0" encoding="UTF-8"?> <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header/> <soapenv:Body> <VertexEnvelope xmlns="urn:vertexinc:o-series:tps:6:0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Login> <TrustedId/> </Login> <InvoiceResponse documentNumber="000000001" documentDate="2018-01-19" transactionType="SALE" postingDate="2018-01-19"> <SubTotal>3244.95</SubTotal> <Total>3459.93</Total> <TotalTax>214.98</TotalTax> <LineItem lineItemId="1" locationCode="X3T"> <Seller> Xetrev100</Company> <PhysicalOrigin taxAreaId="331030000"> <StreetAddress1>100 applegate</StreetAddress1> <City>Central Islip</City> <MainDivision>NY</MainDivision> <PostalCode>11722-1924</PostalCode> <Country>USA</Country> </PhysicalOrigin> </Seller> <Customer> <CustomerCode classCode="Retail Customer">General</CustomerCode> <Destination taxAreaId="310231410"> <StreetAddress1>194 Lodi Ave</StreetAddress1> <City>Metuchen</City> <MainDivision>NJ</MainDivision> <PostalCode>08840-2733</PostalCode> <Country>USA</Country> </Destination> </Customer> <Product productClass="Taxable Goods">2480-8-50</Product> <Quantity>1.0</Quantity> <FairMarketValue>3244.95</FairMarketValue> <UnitPrice>3244.95</UnitPrice> <ExtendedPrice>3244.95</ExtendedPrice> <Taxes taxResult="TAXABLE" taxType="SELLER_USE" situs="DESTINATION" taxCollectedFromParty="BUYER"> <Jurisdiction jurisdictionLevel="STATE" jurisdictionId="23018">NEW JERSEY</Jurisdiction> <CalculatedTax>214.98</CalculatedTax> <EffectiveRate>0.06625</EffectiveRate> <Taxable>3244.95</Taxable> <Imposition impositionType="General Sales and Use Tax">Sales and Use Tax</Imposition> <TaxRuleId>1592410</TaxRuleId> </Taxes> <TotalTax>214.98</TotalTax> </LineItem> </QuotationResponse> <ApplicationData> <ResponseTimeMS>4.8</ResponseTimeMS> </ApplicationData>


November 2018

</VertexEnvelope> </soapenv:Body> </soapenv:Envelope>

Request data mapping The following table shows the Request Data mapping:

Message ERP Data

TransactionType Hard coded in XML as "SALE"

deliveryTerm Passes "SUP" when ship to address is in Canada

DocumentDate Order’s creation date

PostingDate Current time of API call

Currency isoCurrencyCodeAlpha Is not passed and is assumed to be United States Dollars

DocumentNumber Order’s Increment ID in Magento

Seller Information

Seller.Company Admin > Stores > Configuration > Sales > Tax > Vertex Settings > Vertex Company Information > Company Code

Seller.PhysicalOrigin Admin > Stores > Configuration > Sales > Tax > Vertex Settings > Vertex Company Information > Company Street Address, Company City, Company Country, Company State and Company Postal Code

Seller.AdministrativeOrigin Not applicable for Magento

Customer Information and Delivery Address

Customer.CustomerCode Admin > Customers > All Customers > Account Information > Vertex Customer or, if not set, Admin > Stores > Configuration > Sales > Tax > Vertex Settings > Vertex Tax Classes > Default Customer Code

Customer.classCode Admin > Customers > All Customers > Account Information > Group specifies the group Then the tax class can be found at Admin > Customers > Customer Groups > Group information > Tax Class

Customer.Destination From Order-Ship to Address

Vertex® Tax Links for Magento 1 Integration Guide - 1.3.5 Chapter 3. Configuration Vertex Tax Links for Magento Configuration

November 2018

Message ERP Data

Product entries

LineItem lineItemNumber ID of line item in Magento

LineItem.Product.productClass Admin > Products > Catalog > Tax Class. Also decided by Admin > Stores > Configuration > Sales Tax - Vertex Tax Classes for non-products

LineItem.Product Admin > Products > Catalog > SKU Also decided by Admin > Stores > Configuration > Sales > Tax > Vertex Tax Classes for non-products

LineItem.Quantity Items Ordered Quantity

LineItem.ExtendedPrice Items Ordered Subtotal

LineItem.UnitPrice Items per unit price

LineItem.Discount.DiscountAmount Not applicable for Magento

LineItem.Customer.Destination Order-Ship to Address

Vertex Tax Links for Magento Configuration This section describes the Vertex Tax Links for Magento configuration.

If you are running more than one website or store view on the same Magento install, you can restrict the Vertex configuration settings by selecting the default configuration from the top of the left menu and choosing your desired website or store view.


November 2018

Configurable data The configuration requires the following Vertex Tax Links settings:

• Vertex Calculation API URL• Vertex Address Validation API URL• Vertex trusted ID or username and password• Company codeNote: Multiple ship-to addresses are not supported currently.

Depending on the Vertex Tax Solution you use, you can get the settings as follows:

• Vertex Cloud users can find the settings on your Cloud UI.• Vertex® Indirect Tax O Series®, which is installed and managed on premise

users can get the settings from your IT administrator.• Vertex® Indirect Tax O Series® On-Demand users can get the settings from

Vertex Support or Account Services.

Accessing the Vertex Tax Links for Magento configuration Complete the following steps to access the Vertex Tax Links for Magento configuration:

1. Log in to the Magento Admin Panel.2. Navigate to System > Configuration.


November 2018

3. Select Tax from the menu on the left side of the screen, below the Sales tab:


November 2018

The Vertex Settings page displays.


November 2018

Managing the Vertex Tax Links for Magento configuration After accessing the Vertex Settings screen, complete the following steps to manage your Vertex Tax Links for Magento configuration:

1. Select Yes from the drop-down list in the Enable Vertex Tax Calculation field. Additional configuration fields display.

2. Verify your Vertex Calculation API URL and your Vertex Address Validation API URL as follows:

Vertex Tax Solution Description

Vertex Cloud Update the endpoints in both URLs from 60 to 70. For example: • https://mgcsconnect.vertexsmb.com/vertex-ws/services/CalculateTax60

should be https://mgcsconnect.vertexsmb.com/vertex-ws/services/CalculateTax70

• https://mgcsconnect.vertexsmb.com/vertex-ws/services/LookupTaxAreas60 should be https://mgcsconnect.vertexsmb.com/vertex-ws/services/LookupTaxAreas70

Vertex installed and managed on premises

Your IT Administrator supplies your API URLs.

Vertex On-Demand Vertex supplies your Vertex API URLs.


November 2018

3. Enter your Vertex TrustedID in the Vertex Trusted Id field as follows: • If you use Vertex Cloud, you can find your Vertex TrustedID in Vertex

Cloud. • If you use Vertex, which is installed and managed on premise (Vertex on

premise), your IT administrator supplies your Vertex TrustedID. • If you use Vertex On-Demand, Vertex supplies your Vertex TrustedID.

4. Scroll down and open the Vertex Company Information tab.


November 2018

5. Complete the fields on this page with your company code, location code, and address information.

Note: These values must match the information for your Vertex Tax Solution (Vertex O Series on premise, Vertex O Series On-Demand, or Vertex Cloud). Magento supports only one company address.


November 2018

6. Click Save Config. The Vertex API Status field contains VALID and the bar is green.


November 2018

7. On the Cache management page, click Flush Magento Cache to flush the configuration and page cache after successfully turning on or making any changes to your Vertex settings.

Note: If the status bar is still red, or is orange and contains VALIDATION ERROR: PLEASE CHECK SETTINGS, there is something wrong with your configuration. Refer to Troubleshooting the configuration.

Troubleshooting the configuration Complete as many of the following steps as needed:

Note: If you make any changes, steps 4 and 6 are required steps.

1. Verify the values of the following information you entered when managing the Vertex Tax Links for Magento configuration: • TrustedID • Company code • Company address information

2. Verify that the Vertex Tax Links Calculation API URL matches the ERP Adapter URL. If you use Vertex Cloud, you can find the URL in Vertex Cloud. If you use Vertex On-Demand, the URL was provided to you in an email from Vertex.


November 2018

3. Verify that the Vertex Tax Links Address Validation API URL matches the Address Lookup URL. If you use Vertex On-Demand, the URL was provided to you. If you use Vertex Cloud, you can find the URL in Vertex Cloud.

4. If you updated any values, click Save Config. 5. If the status bar is not green, there may be a connection issue with the Vertex

Tax Solution secure server. Contact Vertex Support (see page 4) for further help.

6. (Required) On the Cache management page, click Flush Magento Cache to flush the configuration and page cache after successfully turning on or making any changes to your Vertex settings.

Additional Vertex Tax Solution functions Vertex Tax Links for Magento provides the following functions:

• Monitoring (see page 31) • Tax calculation (see page 13) • Logging (see page 31) Note: Address verification and modification is not currently supported.


November 2018

Monitoring Vertex Tax Links logs errors and abnormal behavior to the standard Magento log files. Additionally, Tax Links logs SOAP requests and responses to the vertex_taxrequest table in your Magento database.

Note: Monitoring the log and alert messaging are out of the scope of Tax Links, so these tasks must be performed by a separate application performance monitoring system.

Logging The default Magento logging framework is used to log messages from Vertex Tax Links. Errors encountered by the Vertex Tax Links module are included in system.log and/or exception.log in Magento’s var/log folder.

Additionally, Vertex Tax Links logs all communication through the SOAP protocol between Vertex Tax Links and Magento. These logs are stored in the vertex_taxrequest table of your Magento installation’s database.

integration guide - vertex® tax links for magento 1 - 1.3 › media › catalog › product ›...

Documents