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

New structure for Tax Management #2080

Merged
merged 11 commits into from
Aug 15, 2023
126 changes: 64 additions & 62 deletions _data/sidebars/pbc_all_sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1004,7 +1004,7 @@ entries:
- title: Dynamic Multistore
url: /docs/pbc/all/dynamic-multistore/dynamic-multistore.html
include_versions:
- "202307.0"
- "202307.0"
nested:
- title: Base shop
nested:
Expand Down Expand Up @@ -3326,70 +3326,72 @@ entries:
- title: Tax Management
url: /docs/pbc/all/tax-management/tax-management.html
nested:
- title: Base shop
- title: Avalara
url: /docs/pbc/all/tax-management/avalara/avalara.html
nested:
- title: Install Avalara
url: /docs/pbc/all/tax-management/avalara/avalara.html
- title: Install Avalara + Product Options
url: /docs/pbc/all/tax-management/avalara/install-avalara-product-options.html
- title: Install Avalara + Shipment
url: /docs/pbc/all/tax-management/avalara/install-avalara-shipment.html
- title: Apply Avalara tax codes
url: /docs/pbc/all/tax-management/avalara/apply-avalara-tax-codes.html
- title: Spryker Tax
nested:
- title: What's changed
url: /docs/pbc/all/tax-management/base-shop/whats-changed-in-tax-management.html
- title: Tax feature overview
url: /docs/pbc/all/tax-management/base-shop/tax-feature-overview.html
- title: Install and upgrade
- title: Base shop
nested:
- title: Integrate the Tax Glue API
url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/install-the-tax-glue-api.html
- title: Integrate the Product Tax Sets Glue API
url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/install-the-product-tax-sets-glue-api.html
- title: Upgrade the ProductTaxSetsRestApi module
url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/upgrade-the-producttaxsetsrestapi-module.html
- title: Upgrade the Tax module
url: /docs/pbc/all/tax-management/base-shop/install-and-upgrade/upgrade-the-tax-module.html
- title: Manage in the Back Office
url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/log-into-the-back-office.html
nested:
- title: Create tax rates
url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/create-tax-rates.html
- title: Edit tax rates
url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/edit-tax-rates.html
- title: Create tax sets
url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/create-tax-sets.html
- title: Edit tax sets
url: /docs/pbc/all/tax-management/base-shop/manage-in-the-back-office/edit-tax-sets.html
- title: Manage using Glue API
- title: Tax feature overview
url: /docs/pbc/all/tax-management/spryker-tax/base-shop/tax-feature-overview.html
- title: Install and upgrade
nested:
- title: Integrate the Tax Glue API
url: /docs/pbc/all/tax-management/spryker-tax/base-shop/install-and-upgrade/install-the-tax-glue-api.html
- title: Integrate the Product Tax Sets Glue API
url: /docs/pbc/all/tax-management/spryker-tax/base-shop/install-and-upgrade/install-the-product-tax-sets-glue-api.html
- title: Upgrade the ProductTaxSetsRestApi module
url: /docs/pbc/all/tax-management/spryker-tax/base-shop/install-and-upgrade/upgrade-the-producttaxsetsrestapi-module.html
- title: Upgrade the Tax module
url: /docs/pbc/all/tax-management/spryker-tax/base-shop/install-and-upgrade/upgrade-the-tax-module.html
- title: Manage in the Back Office
url: /docs/pbc/all/tax-management/spryker-tax/base-shop/manage-in-the-back-office/log-into-the-back-office.html
nested:
- title: Create tax rates
url: /docs/pbc/all/tax-management/spryker-tax/base-shop/manage-in-the-back-office/create-tax-rates.html
- title: Edit tax rates
url: /docs/pbc/all/tax-management/spryker-tax/base-shop/manage-in-the-back-office/edit-tax-rates.html
- title: Create tax sets
url: /docs/pbc/all/tax-management/spryker-tax/base-shop/manage-in-the-back-office/create-tax-sets.html
- title: Edit tax sets
url: /docs/pbc/all/tax-management/spryker-tax/base-shop/manage-in-the-back-office/edit-tax-sets.html
- title: Manage using Glue API
nested:
- title: Retrieve tax sets
url: /docs/pbc/all/tax-management/spryker-tax/base-shop/manage-using-glue-api/retrieve-tax-sets.html
- title: Retrieve tax sets when retrieving abstract products
url: /docs/pbc/all/tax-management/spryker-tax/base-shop/manage-using-glue-api/retrieve-tax-sets-when-retrieving-abstract-products.html
- title: Import and export data
url: /docs/pbc/all/tax-management/spryker-tax/base-shop/import-and-export-data/tax-management-data-import.html
nested:
- title: "Import file details: tax_sets.csv"
url: /docs/pbc/all/tax-management/spryker-tax/base-shop/import-and-export-data/import-file-details-tax-sets.csv.html
- title: "Import file details: product_abstract.csv"
url: /docs/pbc/all/tax-management/spryker-tax/base-shop/import-and-export-data/import-file-details-product-abstract.csv.html
- title: "Import file details: product_option.csv"
url: /docs/pbc/all/tax-management/spryker-tax/base-shop/import-and-export-data/import-file-details-product-option.csv.html
- title: "Import file details: shipment.csv"
url: /docs/pbc/all/tax-management/spryker-tax/base-shop/import-and-export-data/import-file-details-shipment.csv.html
- title: Extend and customize
url: /docs/pbc/all/tax-management/spryker-tax/base-shop/extend-and-customize/tax-module-reference-information.html
- title: Domain model and relationships
url: /docs/pbc/all/tax-management/spryker-tax/base-shop/domain-model-and-relationships/tax-domain-model-and-relationships.html
- title: Marketplace
include_versions:
- "202212.0"
- "202307.0"
nested:
- title: Retrieve tax sets
url: /docs/pbc/all/tax-management/base-shop/manage-using-glue-api/retrieve-tax-sets.html
- title: Retrieve tax sets when retrieving abstract products
url: /docs/pbc/all/tax-management/base-shop/manage-using-glue-api/retrieve-tax-sets-when-retrieving-abstract-products.html
- title: Import and export data
url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/tax-management-data-import.html
nested:
- title: "Import file details: tax_sets.csv"
url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-tax-sets.csv.html
- title: "Import file details: product_abstract.csv"
url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-product-abstract.csv.html
- title: "Import file details: product_option.csv"
url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-product-option.csv.html
- title: "Import file details: shipment.csv"
url: /docs/pbc/all/tax-management/base-shop/import-and-export-data/import-file-details-shipment.csv.html
- title: Extend and customize
url: /docs/pbc/all/tax-management/base-shop/extend-and-customize/tax-module-reference-information.html
- title: Domain model and relationships
url: /docs/pbc/all/tax-management/base-shop/domain-model-and-relationships/tax-domain-model-and-relationships.html
- title: Third-party integrations
url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/avalara.html
nested:
- title: Integrate Avalara
url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/integrate-avalara.html
- title: Integrate Avalara Tax + Product Options
url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/integrate-avalara-tax-product-options.html
- title: Integrate Avalara Tax + Shipment
url: /docs/pbc/all/tax-management/base-shop/third-party-integrations/integrate-avalara-tax-shipment.html
- title: Marketplace
include_versions:
- "202212.0"
- "202307.0"
nested:
- title: Install the Tax + Merchant Portal - Marketplace Product feature
url: /docs/pbc/all/tax-management/marketplace/install-the-tax-merchant-portal-marketplace-product-feature.html
- title: Install the Tax + Merchant Portal - Marketplace Product feature
url: /docs/pbc/all/tax-management/spryker-tax/marketplace/install-the-tax-merchant-portal-marketplace-product-feature.html
- title: Vertex
url: /docs/pbc/all/tax-management/vertex/vertex.html
include_versions:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ To learn how to migrate to the new structure see, the [Upgrading from version 3.

## Upgrading from version 2.* to version 3.*

The tax plugins are using the version 3.* of the Tax module. See [Migration Guide - Tax](/docs/pbc/all/tax-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-tax-module.html) for more details.
The tax plugins are using the version 3.* of the Tax module. See [Migration Guide - Tax](/docs/pbc/all/tax-management/{{site.version}}/spryker-tax/base-shop/install-and-upgrade/upgrade-the-tax-module.html) for more details.

A new tax calculator must be registered in `CalculationDependencyProvider::getCalculatorStack()`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

## Upgrading from version 2.* to version 3.*

The tax plugins are using the version 3.* of the Tax module. You need to upgrade the [Tax](/docs/pbc/all/tax-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-tax-module.html) module.
The tax plugins are using the version 3.* of the Tax module. You need to upgrade the [Tax](/docs/pbc/all/tax-management/{{site.version}}/spryker-tax/base-shop/install-and-upgrade/upgrade-the-tax-module.html) module.
Original file line number Diff line number Diff line change
Expand Up @@ -373,4 +373,4 @@ For all other issues that you might encounter after migration, please refer to t

## Upgrading from version 2.* to version 3.*

The Product module does not provide the tax functionality anymore. Upgrade [Migration Guide - Tax](/docs/pbc/all/tax-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-tax-module.html).
The Product module does not provide the tax functionality anymore. Upgrade [Migration Guide - Tax](/docs/pbc/all/tax-management/{{site.version}}/spryker-tax/base-shop/install-and-upgrade/upgrade-the-tax-module.html).
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

## Upgrading from version 2.* to version 3.*

The tax plugins are using the version 3.* of the Tax module. Upgrade [Migration Guide - Tax](/docs/pbc/all/tax-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-tax-module.html).
The tax plugins are using the version 3.* of the Tax module. Upgrade [Migration Guide - Tax](/docs/pbc/all/tax-management/{{site.version}}/spryker-tax/base-shop/install-and-upgrade/upgrade-the-tax-module.html).
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

## Upgrading from version 2.* to version 3.*

The `ProductOptionExporter` module does not provide the tax functionality anymore. Upgrade [Migration Guide - Tax](/docs/pbc/all/tax-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-tax-module.html).
The `ProductOptionExporter` module does not provide the tax functionality anymore. Upgrade [Migration Guide - Tax](/docs/pbc/all/tax-management/{{site.version}}/spryker-tax/base-shop/install-and-upgrade/upgrade-the-tax-module.html).
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ The payment methods have changed accordingly to use `SalesFacade` instead of `Sa

## Upgrading from version 2.* to version 3.*

The tax plugins are using the version 3.* of the Tax module. See [Migration Guide - Tax](/docs/pbc/all/tax-management/{{site.version}}/base-shop/install-and-upgrade/upgrade-the-tax-module.html) for more details.
The tax plugins are using the version 3.* of the Tax module. See [Migration Guide - Tax](/docs/pbc/all/tax-management/{{site.version}}/spryker-tax/base-shop/install-and-upgrade/upgrade-the-tax-module.html) for more details.

### SalesAggregator migration console command

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -489,4 +489,4 @@ The new shipment table structure requires manual data migration, we have provide

## Upgrading from version 2.* to version 3.*

The tax plugins are using the version 3.* of the Tax module. You need to upgrade the [Tax](/docs/pbc/all/tax-management/{{page.version}}/base-shop/install-and-upgrade/upgrade-the-tax-module.html) module.
The tax plugins are using the version 3.* of the Tax module. You need to upgrade the [Tax](/docs/pbc/all/tax-management/{{page.version}}/spryker-tax/base-shop/install-and-upgrade/upgrade-the-tax-module.html) module.
Original file line number Diff line number Diff line change
Expand Up @@ -1483,7 +1483,7 @@ For the attributes of other included resources, see:
* [Retrieve prices of an abstract product](/docs/pbc/all/price-management/{{site.version}}/base-shop/manage-using-glue-api/retrieve-abstract-product-prices.html)
* [Retrieve a concrete product](/docs/marketplace/dev/glue-api-guides/{{page.version}}/concrete-products/retrieving-concrete-products.html)
* [Retrieve a category node](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/categories/glue-api-retrieve-category-nodes.html)
* [Retrieve tax sets](/docs/pbc/all/tax-management/{{page.version}}/base-shop/manage-using-glue-api/retrieve-tax-sets.html)
* [Retrieve tax sets](/docs/pbc/all/tax-management/{{page.version}}/spryker-tax/base-shop/manage-using-glue-api/retrieve-tax-sets.html)
* [Retrieve a product label](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-product-labels.html)
* [Retrieve product reviews](/docs/pbc/all/ratings-reviews/{{site.version}}/manage-using-glue-api/manage-product-reviews-using-glue-api.html#retrieve-product-reviews)
* [Retrieve a measurement unit](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/manage-using-glue-api/glue-api-retrieve-measurement-units.html)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This document describes how to create Marketplace product options.

To start working with product options, go to **Catalog&nbsp;<span aria-label="and then">></span> Product Options**.

There should be an existing tax set to apply it to the [product option group](/docs/marketplace/user/features/{{page.version}}/marketplace-product-options-feature-overview.html). For detailed instructions about creating tax sets, see [Create tax sets](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-in-the-back-office/create-tax-sets.html).
There should be an existing tax set to apply it to the [product option group](/docs/marketplace/user/features/{{page.version}}/marketplace-product-options-feature-overview.html). For detailed instructions about creating tax sets, see [Create tax sets](/docs/pbc/all/tax-management/{{site.version}}/spryker-tax/base-shop/manage-in-the-back-office/create-tax-sets.html).

Each section in this article contains reference information. Make sure to review it before you start, or look up the necessary information as you go through the process.

Expand Down Expand Up @@ -48,7 +48,7 @@ The following table describes the attributes you enter and select while creating
| ATTRIBUTE | DESCRIPTION |
| --- | --- |
| Group name translation key | Glossary key for the product option group. The format is `product.option.group.name.{your key}`. For example, `product.option.group.name.warranty`. |
| Tax Set | Conditions under which the product option group is to be taxed. To learn how to create tax sets, see [Create tax sets](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-in-the-back-office/create-tax-sets.html). |
| Tax Set | Conditions under which the product option group is to be taxed. To learn how to create tax sets, see [Create tax sets](/docs/pbc/all/tax-management/{{site.version}}/spryker-tax/base-shop/manage-in-the-back-office/create-tax-sets.html). |
| Option name translation key | Glossary key for the product option value. The format is `product.option.{your key}`. For example, `product.option.warranty1`. |
| SKU | Unique identifier for the product option value. This value is autogenerated based on the **Option name translation key**, and you can adjust it per your requirements.|
| Gross price and Net price | Price values of the product option value for gross and net modes. Prices are integer values and, in the database, they are stored in their normalized form. For example, `4EUR` is stored as `400`. If you do not define a price for a product option value, it is considered *inactive* for that specific currency and price mode. If a price is `0`, it is considered *free of charge*.|
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The following table describes the attributes you enter and select while editing
| ATTRIBUTE | DESCRIPTION |
| --- | --- |
| Group name translation key | Glossary key of the product option group. You can enter this value only when [creating product options](/docs/marketplace/user/back-office-user-guides/{{page.version}}/catalog/product-options/creating-product-options.html). |
| Tax Set | Conditions under which the product option group is taxed. To learn how to create tax sets, see [Create tax sets](/docs/pbc/all/tax-management/{{site.version}}/base-shop/manage-in-the-back-office/create-tax-sets.html). |
| Tax Set | Conditions under which the product option group is taxed. To learn how to create tax sets, see [Create tax sets](/docs/pbc/all/tax-management/{{site.version}}/spryker-tax/base-shop/manage-in-the-back-office/create-tax-sets.html). |
| Option name translation key | Glossary key for the product option value. You can enter this value only when [creating product options](/docs/marketplace/user/back-office-user-guides/{{page.version}}/catalog/product-options/creating-product-options.html). |
| SKU | Unique identifier of the product option value. You can enter this value only when [creating product options](/docs/marketplace/user/back-office-user-guides/{{page.version}}/catalog/product-options/creating-product-options.html). |
| Gross price and Net price | Price values of the product option value for gross and net modes. Prices are integer values and, in the database, they are stored in their normalized form. For example, `4EUR` is stored as `400`. If you do not define a price for a product option value, it is considered *inactive* for that specific currency and price mode. If a price is `0`, it is considered *free of charge*.|
Expand Down
Loading
Loading