Verify Vertex Connection

Edit on GitHub

This document describes how to verify Vertex integration.

Prerequisites

  • Install Vertex.
  • Create an account with Vertex. If you need support getting a Vertex account, contact support or your Customer Success Manager.
  • Optional: For Vertex Validator integration, create an account with Vertex Validator.

Verify Vertex connection

Test the configuration

To ensure accuracy and compliance with tax laws, we highly recommend thoroughly testing the Vertex integration.

Once you’ve configured Vertex, the taxes are calculated in real time in the checkout. A message about this is displayed on the checkout page.

vertex_checkout_page

On the Storefront, the tax amount is displayed on the checkout summary page.

In the Back Office, the taxes are displayed on the order details page.

If you configured invoices to be saved in Vertex, you can view the taxes processed by Vertex as follows:

  1. In the Vertex dashboard, go to Reporting > Standard Reports.
  2. Click Report Output.
  3. Next to the report you want to view the taxes for, click Action>View report. vertex-report-output
  4. On the invoice page, you can verify the invoice number that corresponds to the Spryker order number and the applicable country tax calculated by Vertex. invoice-in-vertex

Verify Vertex Validator tax ID validation

Validate a tax ID by sending a request to /tax-id-validate using Glue API.

Request

{
    "data": {
        "type": "tax-id-validate",
        "attributes": {
            "countryCode": "**",
            "taxId": "*****"
        }
    }
}

One of the following should be returned:

Successful response: HTTP code: 200.

{
  "data": [],
  "links": []
}

Unsuccessful response: HTTP code: 400, 422.

{
  "errors": [
    {
      "status": 400,
      "detail": "Wrong format of the tax number."
    }
  ]
}