Connect Vertex

Last updated:
Edit on GitHub

This document describes how to connect a Spryker project to Vertex.

Prerequisites

Connect Vertex

  1. In the Back Office, go to Apps.
  2. On the App Composition Platform Catalog page, click Vertex. This opens the Vertex app details page.
  3. In the top right corner of the Vertex app details page, click Connect app. The notification saying that the application connection is pending is displayed.
  4. In the top right corner of the Vertex app details page, click Configure.
  5. To activate the app, select Active.
  6. In Security URI, enter the Security URI of your Vertex platform. For details on the Security URI, see Vertex documentation.
  7. In Transaction calls URI, enter the Transaction Calls URI of your Vertex platform. For details on the Transaction Calls URI, see Vertex documentation.
  8. In Client ID/Client secret, enter your Vertex client secret. See Vertex documentation for details about how to obtain it.
  9. For DEFAULT TAXPAYER COMPANY CODE, enter the company code you set in your Vertex account.
  10. Optional: To enable invoice saving in Vertex, select Enable invoice save in Vertex.
  11. Click Save.

vertex-configuration

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

Retain Vertex configuration after a destructive deployment

[Destructive deployment](https://spryker.com/docs/dg/dev/acp/retaining-acp-apps-when-running-destructive-deployments.html) permanently deletes the configuration of Vertex.

To run a destructive deployment, follow the steps:

  1. Disconnect Vertex.
  2. Run a destructive deployment.
  3. Reconnect Vertex.

Next steps