Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

ACP-4696: Updated doc with new vertax glue endpoint #3049

3 changes: 3 additions & 0 deletions _data/sidebars/pbc_all_sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4227,6 +4227,9 @@ entries:
url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/install-vertex/integrate-the-acp-connector-module-for-tax-calculation.html
- title: Integrate Vertex
url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/install-vertex/integrate-the-vertex-app.html
nested:
- title: Integrate Taxamo
url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/install-vertex/integrate-the-taxamo-app.html

- title: Project configuration for Vertex
url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/project-configuration-for-vertex.html
Expand Down
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
---
title: Connect Vertex
description: Find out how you can confiure Sprykers third party Vertex in to your Spryker Based project.
last_updated: Nov 3 2023
last_updated: Jan 8 2025
template: howto-guide-template
---

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

## Prerequisites

- [Install Vertex](/docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/install-vertex/install-vertex.html)
- [Install Vertex](/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/vertex/install-vertex/install-vertex.html).
- Create an account with [Vertex](https://www.vertexinc.com/). If you need support getting a Vertex account, [contact support](https://support.spryker.com/) or your Customer Success Manager.
- Optional: For Taxamo integration, create an account with [Taxamo](https://www.taxamo.com/). If you need help getting a Taxamo account, [contact support](https://support.spryker.com/) or your Customer Success Manager.

## Connect Vertex

Expand All @@ -20,15 +21,18 @@ This document describes how to connect a Spryker project to Vertex.
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](https://tax-calc-api.vertexcloud.com/resources/index.html).
7. In **Transaction calls URI**, enter the Transaction Calls URI of your Vertex platform. For details on the Transaction Calls URI, see [Vertex documentation](https://tax-calc-api.vertexcloud.com/resources/index.html).
7. In **Client ID/Client secret**, enter your Vertex client secret. See [Vertex documentation](https://tax-calc-api.vertexcloud.com/resources/index.html) for details about how to obtain it.
8. For **DEFAULT TAXPAYER COMPANY CODE**, enter the company code you set in your Vertex account.
9. Optional: To enable invoice saving in Vertex, select **Enable invoice save in Vertex**.
10. Click **Save**.

![vertex-configuration](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/tax-management/vertex/configure-vertex/vertex-configuration.png)
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](https://tax-calc-api.vertexcloud.com/resources/index.html).
7. In **TRANSACTION CALLS URI**, enter the Transaction Calls URI of your Vertex platform. For details on the Transaction Calls URI, see [Vertex documentation](https://tax-calc-api.vertexcloud.com/resources/index.html).
8. For **CLIENT ID**, enter the Vertex client ID. For details on obtaining the ID, see [Vertex documentation](https://tax-calc-api.vertexcloud.com/resources/index.html).
9. For **CLIENT SECRET**, enter the Vertex client secret. For details on obtaining the secret, see [Vertex documentation](https://tax-calc-api.vertexcloud.com/resources/index.html).
10. For **DEFAULT TAXPAYER COMPANY CODE**, enter the company code you set in your Vertex account.
11. Optional: Enable Taxamo:
1. Select **ENABLE TAX ID VALIDATION (TAXAMO)**.
2. For **API URL (V3)**, enter the API URI of your Taxamo environment. For details on the API URI, see [Standalone Vertex Validator](https://docs.marketplace.taxamo.com/docs/standalone#useful-links).
3. For **SELLER TOKEN**, enter your Taxamo seller token. For details on obtaining the token, see [Accessing the APIs](https://docs.marketplace.taxamo.com/docs/getting-started-1).
12. Optional: To enable invoice saving in Vertex, select **ENABLE INVOICE SAVE IN VERTEX**.
13. Click **Save**.

## Verify Vertex connection

Expand All @@ -55,6 +59,24 @@ If you configured invoices to be saved in Vertex, you can view the taxes process
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](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/tax-management/vertex/configure-vertex/invoice-in-vertex.png)


## Verify Taxamo tax ID validation

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

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

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the criteria of success?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What should be the reply?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated


## Retain Vertex configuration after a destructive deployment

{% info_block errorBox "" %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Install Vertex
description: Find out how you can install Vertex in your Spryker shop
draft: true
last_updated: May 17, 2024
last_updated: Jan 8, 2025
template: howto-guide-template
related:
- title: Vertex
Expand Down Expand Up @@ -37,3 +37,4 @@ To install Vertex, integrate the ACP connector module and the Vertex app:

1. [Integrate ACP connector module for tax calculation](/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/vertex/install-vertex/integrate-the-acp-connector-module-for-tax-calculation.html)
2. [Integrate the Vertex app](/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/vertex/install-vertex/integrate-the-vertex-app.html)
3. [Integrate the Taxamo app](/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/vertex/install-vertex/integrate-the-taxamo-app.html)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this not optional?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's not. we have one configuration for the Vertex. but if we don't create an integration for Taxamo we'll have a configuration for it (it's optional) but it won't be possible to use from the SCOSS side. in this case it's require for vertax integration

Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
title: Integrate the Vertex app
description: Find out how you can integrate the Taxamo app into your Spryker shop
draft: true
last_updated: Jan 8, 2025
template: howto-guide-template
---

To [install Taxamo](/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/vertex/install-vertex/install-vertex.html), you need to update [spryker/tax-app:0.4.0](https://github.com/spryker/tax-app) and install the [spryker/tax-app-rest-api](https://github.com/spryker/tax-app-rest-api) module first.

```bash
composer require spryker/tax-app-rest-api:"^0.1.0" --update-with-dependencies
```


To integrate Taxamo API, follow these steps.

## 1. Configure GlueApplicationDependencyProvider to enable Tax ID validator

```php
<?php

namespace Pyz\Glue\GlueApplication;

use Spryker\Glue\GlueApplication\GlueApplicationDependencyProvider as SprykerGlueApplicationDependencyProvider;
use Spryker\Glue\TaxAppRestApi\Plugin\TaxValidateIdResourceRoutePlugin;

class GlueApplicationDependencyProvider extends SprykerGlueApplicationDependencyProvider
{
/**
* @return array<\Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\ResourceRoutePluginInterface>
*/
protected function getResourceRoutePlugins(): array
{
return [
//....
new TaxValidateIdResourceRoutePlugin(),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this still correct?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

];
}

}
```

## Next step
[Configure Vertex in the Back Office](/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/vertex/connect-vertex.html)
Loading