Skip to content

Commit

Permalink
Merge pull request #2430 from spryker/feature/acp-2128/tax-app-stack-…
Browse files Browse the repository at this point in the history
…update

ACP-2128: Updated Vertex documentation
  • Loading branch information
lenadoc authored Jan 15, 2024
2 parents a68e918 + e39e2ba commit 0c1b785
Show file tree
Hide file tree
Showing 6 changed files with 465 additions and 338 deletions.
9 changes: 9 additions & 0 deletions _data/sidebars/pbc_all_sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3844,6 +3844,15 @@ entries:
url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/install-vertex.html
include_versions:
- "202311.0"
nested:
- title: Integrate the connector module
url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/install-vertex/integrate-the-acp-connector-module-for-tax-calculation.html
include_versions:
- "202311.0"
- title: Integrate Vertex
url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/install-vertex/integrate-the-vertex-app.html
include_versions:
- "202311.0"
- title: Configure Vertex
url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/vertex/configure-vertex.html
include_versions:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ last_updated: Nov 3 2023
template: howto-guide-template
---

Once you have [integrated the Vertex app](/docs/pbc/all/tax-management/{{page.version}}/third-party-integrations/vertex/install-vertex.html), you can configure it.
Once you have [installed the Vertex app](/docs/pbc/all/tax-management/{{page.version}}/third-party-integrations/vertex/install-vertex.html), you can configure it.

## Prerequisites

Expand Down Expand Up @@ -36,7 +36,7 @@ To configure Vertex, do the following:

{% info_block infoBox "Company code" %}

Vertex expects to receive the Company Code you have set in Vertex from Spryker and use it to determine taxes. Although the Company Code field is not currently included in the Vertex app configuration page, we recommend that you provide this code as [Quote/Order TaxMetadata](/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/vertex/install-vertex.html#reference-quoteorder-object-to-vertex-api-mapping) in your projects.
Vertex expects to receive the Company Code you have set in Vertex from Spryker and use it to determine taxes. Although the Company Code field is not currently included in the Vertex app configuration page, we recommend that you provide this code as [Quote/Order TaxMetadata](/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/vertex/install-vertex/integrate-the-vertex-app.html#reference-quoteorder-object-to-vertex-api-mapping) in your projects.


{% endinfo_block %}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: Disconnect Vertex
description: Find out how you can disconnect Vertex from your Spryker shop
last_updated: Jan 10, 2024
template: howto-guide-template
---
Disconnecting Vertex permanently deletes all the existing Veretx tax rates.
Disconnecting Vertex permanently deletes all the existing Vertex tax rates.

To disconnect the Vertex app from your store, do the following

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: Install Vertex
description: Find out how you can install Vertex in your Spryker shop
draft: true
last_updated: Jan 10, 2024
template: howto-guide-template
related:
- title: Vertex
link: docs/pbc/all/tax-management/page.version/vertex/vertex.html
redirect_from:
- /docs/pbc/all/tax-management/202311.0/vertex/install-vertex.html
- /docs/pbc/all/tax-management/202311.0/base-shop/vertex/install-vertex.html
- /docs/pbc/all/tax-management/202400.0/third-party-integrations/vertex/install-vertex.html
- /docs/pbc/all/tax-management/202311.0/third-party-integrations/vertex/install-vertex.html
- /docs/pbc/all/tax-management/202311.0/base-shop/third-party-integrations/vertex/install-vertex.html

---
This document describes how to integrate [Vertex](/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/vertex/vertex.html) into a Spryker shop.

## Prerequisites

Before integrating Vertex, ensure the following prerequisites are met:

- Make sure your project is ACP-enabled. See [App Composition Platform installation](/docs/acp/user/app-composition-platform-installation.html) for details.

- The Vertex app catalog page lists specific packages that must be installed or upgraded before you can use the Vertex app. To check the list of the necessary packages, in the Back Office, go to **Apps**-> **Vertex**.
Ensure that your installation meets these requirements.

- Make sure that your deployment pipeline executes database migrations.
- You are using NET prices in your Spryker project. Keep in mind that the Vertex integration only works with NET prices, as it is assumed that businesses using the app are unable to determine GROSS prices.

## Installation steps

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)
Loading

0 comments on commit 0c1b785

Please sign in to comment.