From 205b96f8466e0887a527f04bb2df3e097a167072 Mon Sep 17 00:00:00 2001 From: vol4onok Date: Fri, 7 Feb 2025 15:03:00 +0200 Subject: [PATCH] ACP-4696: Updated doc with new vertax glue endpoint --- _data/sidebars/pbc_all_sidebar.yml | 3 ++ .../vertex/connect-vertex.md | 38 ++++++++++++++++-- .../vertex/install-vertex/install-vertex.md | 3 +- .../integrate-the-taxamo-app.md | 40 +++++++++++++++++++ 4 files changed, 80 insertions(+), 4 deletions(-) create mode 100644 docs/pbc/all/tax-management/202410.0/base-shop/third-party-integrations/vertex/install-vertex/integrate-the-taxamo-app.md diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml index 55ea912e3cb..193584aa05f 100644 --- a/_data/sidebars/pbc_all_sidebar.yml +++ b/_data/sidebars/pbc_all_sidebar.yml @@ -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 diff --git a/docs/pbc/all/tax-management/202410.0/base-shop/third-party-integrations/vertex/connect-vertex.md b/docs/pbc/all/tax-management/202410.0/base-shop/third-party-integrations/vertex/connect-vertex.md index cb69c37dbae..0ba5dd94c89 100644 --- a/docs/pbc/all/tax-management/202410.0/base-shop/third-party-integrations/vertex/connect-vertex.md +++ b/docs/pbc/all/tax-management/202410.0/base-shop/third-party-integrations/vertex/connect-vertex.md @@ -1,7 +1,7 @@ --- 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 --- @@ -11,6 +11,7 @@ This document describes how to connect a Spryker project to Vertex. - [Install Vertex](/docs/pbc/all/tax-management/202311.0/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. +- Create an account with [Taxamo](https://www.taxamo.com/) (optional feature). If you need support getting a Taxamo account, [contact support](https://support.spryker.com/) or your Customer Success Manager. ## Connect Vertex @@ -28,8 +29,6 @@ This document describes how to connect a Spryker project to Vertex. 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) - ## Verify Vertex connection {% info_block warningBox "Test the configuration" %} @@ -55,6 +54,39 @@ 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) +## Connect Taxamo (optional) + +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. Select Enable Tax id validation (taxamo). +7. In **Api URL (v3)**, enter the Api URI of your Taxamo platform. For details on the Api URI, see [Taxamo documentation](https://docs.marketplace.taxamo.com/docs/standalone#useful-links). +7. In **Seller token**, enter your Taxamo seller token. See [Vertex documentation](https://docs.marketplace.taxamo.com/docs/getting-started-1) for details about how to obtain it. +10. Click **Save**. + +![taxamo-configuration](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/tax-management/vertex/configure-taxamo/taxamo-configuration.png) + +## Verify Taxamo tax id validation endpoint connection + +Send `/tax-id-validate` validation request via GLUE to validate your tax ID. + +```json +{ + "data": { + "type": "tax-id-validate", + "attributes": { + "countryCode": "**", + "taxId": "*****" + } + } +} +``` + + ## Retain Vertex configuration after a destructive deployment {% info_block errorBox "" %} diff --git a/docs/pbc/all/tax-management/202410.0/base-shop/third-party-integrations/vertex/install-vertex/install-vertex.md b/docs/pbc/all/tax-management/202410.0/base-shop/third-party-integrations/vertex/install-vertex/install-vertex.md index 18a66410939..da00333b7c2 100644 --- a/docs/pbc/all/tax-management/202410.0/base-shop/third-party-integrations/vertex/install-vertex/install-vertex.md +++ b/docs/pbc/all/tax-management/202410.0/base-shop/third-party-integrations/vertex/install-vertex/install-vertex.md @@ -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 @@ -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) diff --git a/docs/pbc/all/tax-management/202410.0/base-shop/third-party-integrations/vertex/install-vertex/integrate-the-taxamo-app.md b/docs/pbc/all/tax-management/202410.0/base-shop/third-party-integrations/vertex/install-vertex/integrate-the-taxamo-app.md new file mode 100644 index 00000000000..9fc146dc70c --- /dev/null +++ b/docs/pbc/all/tax-management/202410.0/base-shop/third-party-integrations/vertex/install-vertex/integrate-the-taxamo-app.md @@ -0,0 +1,40 @@ +--- +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-rest-api) and install the [spryker/tax-app-rest-api](https://github.com/spryker/tax-app-rest-api) module first. + +To integrate Taxamo API, follow these steps. + +## 1. Configure GlueApplicationDependencyProvider to enable Tax ID validator + +```php + + */ + protected function getResourceRoutePlugins(): array + { + return [ + //.... + new TaxValidateIdResourceRoutePlugin(), + ]; + } + +} +``` + +## Next step +[Configure Vertex in the Back Office](/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/vertex/connect-vertex.html)