Documentation Home

Vertex Environment Setup

Prerequisites

  • Users must establish their own developer account with Vertex in order to use the Broadleaf Vertex Tax module, in a testing environment.
  • Users must establish a live account with Vertex in order to start using the module in production correctly.

The following configuration items are used in the API calls with the Vertex Tax Module:

  • User / UserName
  • Trusted ID
  • Password

First start out by adding the Vertex tax module to your existing project. Add this dependency to your pom.xml :

<dependency>
    <groupId>com.broadleafcommerce</groupId>
    <artifactId>blc-vertex</artifactId>
    <version>1.0.0-SNAPSHOT</version> --Edit the version
    <type>jar</type>
    <scope>compile</scope>
</dependency>

As well as to your core pom.xml:

<dependency>
    <groupId>com.broadleafcommerce</groupId>
    <artifactId>blc-vertex</artifactId>
</dependency>

Now you can start up the admin to configure the module. To do this, please log in to the admin, select the "Settings" tab on the left, and then select "Modules". From here, add a new Module Configuration, and select the "Vertex Tax Module Configuration". With this new window, you may now enter your relevant information pertaining to your required set up.