After July 2021, the 2.3.x release line will no longer receive quality fixes, or user guide updates. PHP 7.3 reaches end of support in December 2021 and Adobe Commerce 2.3.x reaches end of support in April 2022. We strongly recommend planning your upgrade now to Adobe Commerce 2.4.x and PHP 7.4.x to help maintain PCI compliance.

Configuring Magento for Vertex Tax Calculations

To complete the Magento configuration for Vertex tax calculations, you will need to enter a few values from Vertex Cloud. If you need help, see Vertex Field Mapping.

When enabled, the Tax configuration page includes the following Vertex sections:

Vertex Settings Vertex integration and account configuration
Vertex Company Information Configure your company information
Vertex Delivery Terms Configure the shipping terms for shipments. Set a global term, with an option to add overrides per country
Vertex Shipping Product Codes Displays available shipping methods and costs
Vertex Logging Located at the bottom of the page. Provides logging information and configuration

Begin the Magento configuration

  1. On the Admin sidebar, go to Stores > Settings > Configuration.

  2. To define the scope of the configuration for a multisite or multistore installation, set the Store View chooser in the upper-left corner to the specific website or store view that is to be configured.

  3. In the left panel, expand Sales and choose Tax.

  4. Expand the Vertex Settings on the page to enable Vertex and configure initial settings.

    • Set Use Vertex Tax Links to Enable. This setting enables performance enhancements and allows you to enable and configure Vertex settings.

      Vertex Settings Disabled

    • Set Vertex Tax Calculation to Enable the extension and configure settings.

      You must have this option set to use Vertex and save configurations.

    • Enter the Vertex Trusted ID from your Vertex Cloud account. To find your Vertex Trusted ID, log in to your Vertex Cloud account and go to Settings > View All Connectors.

    • Verify the default values for the Vertex Calculation API URL and Vertex Address Validation API URL.

      These connect the integration with Vertex Cloud and must match the URL displayed in your Vertex Connectors page for the Magento connector in the ERP Connector URL and Address Lookup URL fields. Clear the Use system value checkbox and change these values if needed.

    • To determine when tax is calculated for an invoice according to the workflow, set When to send invoiced to Vertex to one of the following:

      When Invoice Created The tax is calculated and sent to Vertex when the invoice generates.
      When Order Status is Changed The invoice generates when orders enter the selected status. If this value is selected, set the Invoice when Order Status option to specify the status.
    • To set the Use Vertex for orders shipping to, select the countries and nations to apply Vertex taxes for destination addresses.

      If a shipping address is not available on the order, the billing address is used.

    • Set how you want to Summarize Tax By. Choose Product and Shipping or Jurisdiction.

  5. Expand the Vertex Company Information section. Then, do the following:

    Vertex Company Information

    • Enter the Company Code from the heading of the Configure Company page of your Vertex Cloud account.

    • Enter the Location Code from the Registration Details section of your Vertex Cloud account.

      This is the specific jurisdiction where the company is registered to file tax returns. This value corresponds to the Location Code that is entered as a Registered Location.

    • Complete the remaining company address fields.

  6. Click Save Config.

    If the configuration settings are correct, the Vertex API Status field turns green and indicates the status is Valid. At this point, you can continue with the remaining Vertex configuration settings, or complete them later.

    You need to save the configuration again if you modify any of the Vertex tax class or calculation settings.

    Vertex API Status - Valid

  7. When you are ready to continue, complete the following sections.

Vertex delivery terms

Set the delivery terms (shipping terms) that determines the vendor or customer jurisdiction where the title transfer of a supply takes place. You can set a global term and overrides per country. These options provide support to EU VAT.

  1. Expand the Vertex Delivery Terms section.

  2. To change the default Global Delivery Term, select an option (SUP - Supplier Ships is the default).

  3. (Optional) Create a Delivery Term Override for each country you want a specific delivery term that differs from the global.

    Click Add and select a country and term.

    Vertex Delivery Terms

Vertex Shipping product codes

The Vertex Shipping Product Codes section lists all shipping methods and rates that are currently mapped to product SKUs in Vertex Cloud.

Shipping Product Codes

Vertex Flexible Fields

If you need to identify taxability based on information in your Magento store beyond the standard customer and and product taxability drivers defined by Vertex, configure the flexible fields to be used in your Vertex Tax Assist Rules.

Step 1: Create custom Flexible Field in Magento

  1. Expand the Vertex Flexible Fields section.

    Flexible Fields

  2. Expand the area for the category you want to use to map a Magento field. There are three available flexible field categories:

    Code Fields Use this category to define a fields using an alphanumeric string value with a maximum length of 40 characters. Strings that exceed the size limit are truncated. You can create a maximum of 25 flexible code fields.
    Numeric Fields Use this category to define fields using numeric values for data, such as durations and weights, including floating decimal points. You can create a maximum of 10 flexible numeric fields.
    Date Fields Use this category to define fields using dates in the format YYYY/MM/DD. You can create a maximum of five flexible date fields.
  3. For the Field ID you want to configure, click the Data Source option to display the list of Magento fields and select the field to use as a flexible field in Vertex Cloud.

    You can enter a text string in the search field at the top of the list to filter the displayed items and help to find the field you want.

    Code - Field ID 1

  4. Click Save Config.

Step 2: Use the Flex Field in a Vertex Tax assist rule

Add a new tax assist rule or edit an existing rule for your Vertex Cloud account that uses the configured flex field for tax calculation.

For detailed information about adding tax assist rules in the Vertex Cloud, see Add a tax assist rule (requires a login to the Vertex Documentation Center).

Vertex Tax Assist Rule

In this example, Flex Code 1 is mapped to Product > Eco Collection and when this has a value of 1, the Physical Origin/Ship From address (215 S Gilbert St, Danville, IL 61832) is used instead of the Company Address configured in Vertex.

Vertex Tax Assist Rule

Vertex tax classes

By default, many of the following tax classes are initially set to None.

  1. Expand the Vertex Tax Classes section.

  2. To change the default Tax Class for Shipping, clear the Use System Value checkbox and choose the applicable tax class.

  3. Set Tax Class for Gift Options to one of the following:

    • None
    • Gift Options
  4. To change the Default Tax Class for Product, clear the Use System Value checkbox and choose the applicable tax class.

  5. To change the Default Tax Class for Customer, clear the Use System Value checkbox and choose the applicable tax class.

  6. Accept the default value for Default Customer Code, which is used for unregistered guests and customers who shop while not logged in to their accounts.

    Vertex Tax Classes

  7. In the Vertex Tax Classes section, complete as many of the following settings as applicable:

Adjustment fees

  1. Set Refund Adjustments Class to one of the following:

    • None
    • Refund Adjustments
  2. Accept the default value for Adjustment Fee Code.

  3. Accept the default value for Adjustment Refund Code.

Gift wrap order

  1. Set Gift Wrap for Order Class to one of the following:

    • None
    • Order Gift Wrapping
  2. Accept the default value for Gift Wrap for Order Code.

    Gift Wrap - Order

Gift wrap single product

  1. Set Gift Wrap Class for Single Product to one of the following:

    • None
    • Item Gift Wrapping
  2. Accept the default value for Gift Wrap Code Prefix for Single Product.

    Gift Wrap - Single Product

Printed gift card

  1. Set Item Line Class for Printed Gift Card to one of the following:

    • None
    • Printed Gift Card
  2. Accept the default value for Item Line Code for Printed Gift Card.

    Printed Gift Card

Reward points

  1. Set Class for Reward Points Discount Line Item to one of the following:

    • None
    • Reward Points
  2. Accept the default value for Product Code for Reward Points Discount Line Item.

    Reward Points

Vertex logging

  1. To track and review Vertex actions and taxes, enable the logging options.

    This exports the logs and saves the information to the var/vertexlog_Y-m-d.csv file (year-month-day).

  2. When opening and reviewing the CSV log files, make sure to use a spreadsheet application that supports long cell contents.

    Some applications, like Microsoft Excel, could cause issues with cut off data.

  3. Expand the Vertex Logging section at the bottom of the page.

  4. Set Vertex Request Logging to Enable to capture full logs.

  5. Set Log Rotation to Enable. Additional configuration fields appear for setting the rotation.

  6. For Rotation Action, set to Delete or Export to File and Delete.

  7. For Log Entry Lifetime (days), set how long the log should exist before the rotation action occurs.

    For example, if set to 7, on the 7th day the action completes on the schedule.

  8. Set the Rotation Frequency to Daily, Weekly, or Monthly.

  9. For Rotation Time, set the hours, minutes, and seconds in the day to complete the rotation action.

    Vertex Logging

Complete the Magento configuration

  1. Expand (  ) the Calculation Settings section.

  2. For Tax Calculation Method Based On, clear the Use system value checkbox and set the value to Vertex.

    Calculation Settings

  3. When complete, click Save Config.

  4. To refresh the cache, do the following:

    • On the Admin sidebar, go to System > Tools > Cache Management.

    • Select the checkbox of each invalid cache.

    • Set Actions to Refresh. Then, click Submit.

Test the Vertex Configuration

After completing the configuration, your Magento store is connected to Vertex Cloud. Visit the Vertex Cloud Help Center to review your settings in more detail, and to learn how to enter test transactions, generate returns, and run reports.

Vertex Cloud has excellent documentation with videos to help you come up to speed. When your testing is complete and you are ready, you can Go Live with the click of a button.

Vertex API Automatically Disabled

When the Vertex connector is enabled and the Display prices in Catalog is set to Including Tax, updating your product prices in the Magento catalog to include tax could significantly degrade Magento performance. In this situation, the Vertex connector will automatically disable and you will see an error message in the Vertex configuration page. You must set this value to Excluding Tax to re-enable the Vertex connector.

Vertex API error

Vertex Cache Management

When clearing caches using Cache Management, Vertex has a cache option included. This option improves performance during the checkout process.