Connect Vertex

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

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 Taxamo integration, create an account with Taxamo. If you need help getting a Taxamo account, contact support or your Customer Success Manager.

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, for Activate, 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. For CLIENT ID, enter the Vertex client ID. For details on obtaining the ID, see Vertex documentation.
9. For CLIENT SECRET, enter the Vertex client secret. For details on obtaining the secret, see Vertex documentation.
10. For DEFAULT TAXPAYER COMPANY CODE, enter the company code you set in your Vertex account.
11. Optional: Enable Taxamo:
12. Select ENABLE TAX ID VALIDATION (TAXAMO).
13. For API URL (V3), enter the API URI of your Taxamo environment. For details on the API URI, see Standalone Vertex Validator.
14. For SELLER TOKEN, enter your Taxamo seller token. For details on obtaining the token, see Accessing the APIs.
15. Optional: To enable invoice saving in Vertex, select ENABLE INVOICE SAVE IN VERTEX.
16. Click Save.

Verify Vertex connection

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.

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.
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.

Verify Taxamo 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."
    }
  ]
}

Retain Vertex configuration after a destructive deployment

Next steps

• Vertex FAQ
• Troubleshooting Vertex