Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Vertex overview page #2308

Merged
merged 7 commits into from
Nov 13, 2023
Merged

Vertex overview page #2308

merged 7 commits into from
Nov 13, 2023

Conversation

lenadoc
Copy link
Contributor

@lenadoc lenadoc commented Nov 9, 2023

PR Description

TBD

Checklist

  • I agree with the Code Contribution License Agreement in CONTRIBUTING.md

@lenadoc lenadoc added the new PR contains a new document label Nov 9, 2023
@@ -13,12 +13,68 @@ redirect_from:

![vertex-hero](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/tax-management/vertex/vertex.md/vertex-hero.png)

*Vertex O Series* is a software that delivers the latest sales and use tax calculations to your shopping cart or invoicing system at the point of purchase while accounting for the following:
The Spryker Vertex app, constructed on the basis of the *Vertex O Series* software, performs automatic, near-real-time taxes calculation at the point of purchase while accounting for the following:
Copy link
Contributor

Choose a reason for hiding this comment

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

Taxes are an important part of any commerce business and this applies to the different commerce business models including marketplaces. The need for a sales tax management solution is highly recognized in a constantly changing economic environment with updated regulations and increased audit activity. Spryker identifies the need to offer integrations with established sale tax applications as fundamental for a complete e-commerce enhancement through the App Composition Platform (ACP).

In the Tax Category of Spryker’s App Composition Platform, we introduce the Spryker-Vertex Integration. This is available to customers and is built with support for both the default Storefront (also called Yves) as well as Spryker’s GLUE APIs.

You can read more about Vertex here and the product integrated here: Vertex O Series website.


* Tax rates in each state, county, and city.
* Laws, rules, and jurisdiction boundaries.
* Special circumstances like tax holidays and product exemptions.

For more information about how Vertex calculates taxes, see the [Vertex O Series website](https://www.vertexinc.com/solutions/products/vertex-indirect-tax-o-series).

The Spryker Vertex app offers the following features that are worth considering when comparing it to the default Spryker [Tax Management capability](/docs/pbc/all/tax-management/{{page.version}}/tax-management.html) or the [Avalara integration](/docs/pbc/all/tax-management/{{page.versoin}}/base-shop/third-party-integrations/avalara/avalara.html):
Copy link
Contributor

Choose a reason for hiding this comment

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

We should take out Avalara and not put two Tech Partners at competition

- *Tax reporting and filing*: You have the option of sending invoice requests to Vertex after an order is paid. You can generate accurate tax reports which helps in the filing of sales tax returns across multiple jurisdictions, reducing the risk of audit and penalties.
- *Application of custom tax rules to products*: You can implement custom tax rules to accommodate unique product categorizations or specific tax regulations that apply to your business. The Vertex Integration provides a means for taxes to be calculated using these rules.

## Using the Vertex app in Spryker-based projects
Copy link
Contributor

Choose a reason for hiding this comment

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

Using the Vertex App in your Spryker Projects


To start using the Spryker Vertex app in your project, you need to do the following:

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

Choose a reason for hiding this comment

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

We should add why here: The vertex integration in Spryker is built on Spryker’s App Composition Platform (ACP) as an ACP Application.

4. Install the Vertex app. See [Install Vertex](/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/vertex/install-vertex.html) for details.
5. Configure the Vertex app. See [Configure Vertex](/docs/pbc/all/tax-management/{{page.version}}/base-shop/third-party-integrations/vertex/configure-vertex.html) for details.

Once you have installed and configured the Vertex app, the taxes will be automatically calculated based on the address from where the order is shipped. In case of a Marketplace, Vertex uses the merchant warehouse address to calculate taxes.
Copy link
Contributor

Choose a reason for hiding this comment

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

Rephrase this line to: Once you have installed and configured the Vertex app, the taxes will be calculated by Vertex during the checkout process. See the video below to understand the experience for the end user

---> Insert Video showing end user journey

Data Sent to Vertex for Tax Calculation
OOTB, we send the following data for Tax Calculation:

  1. Shipping address
  2. Sku
  3. Warehouse address ( also includes Merchant Warehouse address for Marketplace model)

Note: Vertex uses an hierarchy structure for tax determination. The highest in the structure is the Company Code. It is important to setup your company code in Vertex and add it on your project as it determines what rate applies


Once you have installed and configured the Vertex app, the taxes will be automatically calculated based on the address from where the order is shipped. In case of a Marketplace, Vertex uses the merchant warehouse address to calculate taxes.

Buyers see the tax amount calculated by Vertex during the checkout, after they have provided their shipping address.
Copy link
Contributor

Choose a reason for hiding this comment

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

we can take this out


Buyers see the tax amount calculated by Vertex during the checkout, after they have provided their shipping address.

The Back Office users can see the taxes calculated by Vertex on the order details page.
Copy link
Contributor

Choose a reason for hiding this comment

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

we can take this out and structure it under the Guideline & Notes

@lenadoc lenadoc merged commit 0b6abe9 into master Nov 13, 2023
13 checks passed
@lenadoc lenadoc deleted the vertex-overview branch November 13, 2023 18:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new PR contains a new document
Development

Successfully merging this pull request may close these issues.

2 participants