Skip to content

Commit

Permalink
Merge branch 'master' into feature/ae-157/master-strategy-resolver
Browse files Browse the repository at this point in the history
  • Loading branch information
andriitserkovnyi committed Feb 20, 2025
2 parents 84890fa + 270e499 commit b2186d2
Show file tree
Hide file tree
Showing 6 changed files with 115 additions and 13 deletions.
2 changes: 2 additions & 0 deletions Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,8 @@ commonOptions = {
/www.mysql.com\/[\.\w\-\/\?]+/,
/www.gnu.org\/[\.\w\-\/\?]+/,
/algolia.com\/[\.\w\-\/\?]+/,
/mysql.com\/[\.\w\-\/\?]+/,
/wt.io\/[\.\w\-\/\?]+/,
/www.facebook.com\/[\.\w\-\/\?]+/

],
Expand Down
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-taxamo.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
Expand Up @@ -58,6 +58,12 @@ If you need help with whitelisting the email addresses, forward this request to
-->

## Adjust auto replies

Automatic responses to updates and notifications we send you can lead to cases being created accidentally. Make sure automatic replies are disabled for [email protected].

If you are using the email address of a ticket system or any other automated system to receive our communications and notifications, make sure that that system also doesn't send automatic replies to [email protected].

## Provide all the information

Our goal is to increase the number of tickets that are solved with the first engagement. This is more likely to happen when a support case is opened with all the information needed to assess, reproduce, and solve the problem. Such cases may be resolved with the first response.
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,48 @@ 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.

### Request

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

One of the following should be returned:

Successful response: HTTP code: 200.

```json
{
"data": [],
"links": []
}
```
Unsuccessful response: HTTP code: 400, 422.

```json
{
"errors": [
{
"status": 400,
"detail": "Wrong format of the tax number."
}
]
}
```

## Retain Vertex configuration after a destructive deployment

{% info_block errorBox "" %}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,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 +36,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 Taxamo](/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/vertex/install-vertex/integrate-taxamo.html)
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
title: Integrate Taxamo
description: Find out how you can integrate the Taxamo app into your Spryker shop
last_updated: Jan 8, 2025
template: howto-guide-template
---

To integrate Taxamo, follow the steps:

1. Update [spryker/tax-app](https://github.com/spryker/tax-app) to `0.4.0` and install the [spryker/tax-app-rest-api](https://github.com/spryker/tax-app-rest-api) module:

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


2. To integrate Taxamo API, 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(),
];
}

}
```

## Next step

[Connect Vertex](/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/vertex/connect-vertex.html)

0 comments on commit b2186d2

Please sign in to comment.