From 0cd792ca0dd5d52ae22e5c0a08297e567e499f66 Mon Sep 17 00:00:00 2001 From: Benjamin Willems Date: Fri, 25 May 2018 15:37:06 -0700 Subject: [PATCH 1/6] Add zones article stub --- guides/users/settings/zones.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 guides/users/settings/zones.md diff --git a/guides/users/settings/zones.md b/guides/users/settings/zones.md new file mode 100644 index 00000000000..21d9b3245ce --- /dev/null +++ b/guides/users/settings/zones.md @@ -0,0 +1,3 @@ +# Zones + +Solidus manages locations using a concept called **Zones**. From f49808d3669e7dd59ec49b7d18051270da6026d7 Mon Sep 17 00:00:00 2001 From: Benjamin Willems Date: Fri, 25 May 2018 15:37:22 -0700 Subject: [PATCH 2/6] Add settings overview stub --- guides/users/settings/overview.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 guides/users/settings/overview.md diff --git a/guides/users/settings/overview.md b/guides/users/settings/overview.md new file mode 100644 index 00000000000..f5ae020535b --- /dev/null +++ b/guides/users/settings/overview.md @@ -0,0 +1,10 @@ +# Overview + + + +## Taxes + +With Solidus, you can create tax rates and tax categories that correspond with +each item in your store and each state or country that you ship to. From bd95f87e4a3c492c2cb51b2551f1c6f07c23b56b Mon Sep 17 00:00:00 2001 From: Benjamin Willems Date: Fri, 25 May 2018 18:48:50 -0700 Subject: [PATCH 3/6] Add initial tax settings article --- guides/users/settings/taxes.md | 45 ++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 guides/users/settings/taxes.md diff --git a/guides/users/settings/taxes.md b/guides/users/settings/taxes.md new file mode 100644 index 00000000000..85305e16cb3 --- /dev/null +++ b/guides/users/settings/taxes.md @@ -0,0 +1,45 @@ +# Taxes + +When you go to the **Settings -> Taxes** page of the Solidus admin interface, +you can set up [tax categories](#tax-categories) and [tax rates](#tax-rates) +that help you tax customers according to the taxation laws in your region(s). + +## Tax categories + +Each of your [products][products] has a **Tax Category** field. This allows you +to charge different tax rates for products, which you may need to do in order to +comply with your regional laws. + +For example, if you have a stock location in California, any clothing you ship +within the state should be taxed. But any candy that you sell is tax exempt. You +may want to create a "Candy" tax category to handle your candy products that are +exempt from tax. + +When you create or edit a tax category, it uses the following settings: + +- **Name**: The name for your tax category. +- **Tax Code**: An optional tax code that describes your tax category. +- **Default**: A checkbox that sets whether the current tax category should be + used as the default tax category for new products. +- **Description**: An optional long description for your tax category. + +[products]: ../products/overview.md + +## Tax rates + +You can create tax rates that should be used for orders from [different states +or countries][zones], as well as for each of your tax categories. If your stores +have more complicated tax requirements, your tax rates can perform more complex +functions: + +- You can create tax rates that calculate using sales tax (U.S.-style taxes) or + value-added taxes (VAT, or E.U.-style taxes). +- You can show or hide tax rates in customer invoices. +- You can create tax rates that are valid from a specific date. +- You can change the **Base Calculator** to a custom tax calculator.[^1] + +[^1]: Talk to your developers if you need another tax calculator. By default, + Solidus only provides a base calculator, which is acceptable for calculating + taxes in most ecommerce stores. + +[zones]: zones.md From b2262b4bc3e19673e28c7b1e757181fd5db42dda Mon Sep 17 00:00:00 2001 From: Benjamin Willems Date: Mon, 28 May 2018 14:16:03 -0700 Subject: [PATCH 4/6] Add tax rates and calcators docs --- guides/users/settings/taxes.md | 58 +++++++++++++++++++++++++++++----- 1 file changed, 50 insertions(+), 8 deletions(-) diff --git a/guides/users/settings/taxes.md b/guides/users/settings/taxes.md index 85305e16cb3..825073dc98e 100644 --- a/guides/users/settings/taxes.md +++ b/guides/users/settings/taxes.md @@ -4,6 +4,9 @@ When you go to the **Settings -> Taxes** page of the Solidus admin interface, you can set up [tax categories](#tax-categories) and [tax rates](#tax-rates) that help you tax customers according to the taxation laws in your region(s). +*Before you set up taxes in your store, you should set up [zones][zones], which +are locations that your store manages regarding shipping and taxes.* + ## Tax categories Each of your [products][products] has a **Tax Category** field. This allows you @@ -15,6 +18,10 @@ within the state should be taxed. But any candy that you sell is tax exempt. You may want to create a "Candy" tax category to handle your candy products that are exempt from tax. +[products]: ../products/overview.md + +### Tax category fields + When you create or edit a tax category, it uses the following settings: - **Name**: The name for your tax category. @@ -23,8 +30,6 @@ When you create or edit a tax category, it uses the following settings: used as the default tax category for new products. - **Description**: An optional long description for your tax category. -[products]: ../products/overview.md - ## Tax rates You can create tax rates that should be used for orders from [different states @@ -33,13 +38,50 @@ have more complicated tax requirements, your tax rates can perform more complex functions: - You can create tax rates that calculate using sales tax (U.S.-style taxes) or - value-added taxes (VAT, or E.U.-style taxes). + value-added taxes ([VAT][vat], or E.U.-style taxes). - You can show or hide tax rates in customer invoices. - You can create tax rates that are valid from a specific date. -- You can change the **Base Calculator** to a custom tax calculator.[^1] - -[^1]: Talk to your developers if you need another tax calculator. By default, - Solidus only provides a base calculator, which is acceptable for calculating - taxes in most ecommerce stores. +- You can change the **Base Calculator** to [a custom tax + calculator](#tax-calculators). +[vat]: https://en.wikipedia.org/wiki/Value-added_tax [zones]: zones.md + +### Create a tax rate + +You can create a new tax rate in just a few steps: + +1. Go to the **Settings -> Taxes** page of the Solidus admin interface. +2. Go to the **Tax Rates** page. +3. Select the **New Tax Rate** button. +4. Fill in the information for your new tax rate. See [Tax rate + fields](#tax-rate-fields) for more information. +5. Select the **Create** button to save the new tax rate. + +### Tax rate fields + +When you add or edit a tax rate, the following settings are available: + +- **Name**: The name for the tax rate. By default, customers can see the name of + the tax rate during checkout. +- **Rate**: The tax rate as a decimal. For example, `0.05` would become a 5% tax + rate. +- **Included in Price**: Sets whether the tax should be calculated as already + included in price of items ([value-added tax][vat]) or should be calculated + as sales tax on top of the price of items. +- **Zone**: The [zone][zones] where this tax rate applies. +- **Tax Category**: The [tax category](#tax-categories) that this tax rate + should apply to. +- **Validity Period**: The start and end dates that this tax rate is valid to. +- **Base Calculator**: The tax calculator that should be used to calculate + taxes. For more information, see [Tax calculators](#tax-calculators) below. + +## Tax calculators + +By default, Solidus includes a single tax calculator called **Default Tax**. +This calculator is suitable to calculate taxes for typical ecommerce +transactions around the world. + +If your business has complicated tax requirements, you may want to have your +development team create a tax calculator that is suited specifically to your +store. From 7f383d59418886a0add78808206ea190ca54216c Mon Sep 17 00:00:00 2001 From: Benjamin Willems Date: Tue, 29 May 2018 10:19:50 -0700 Subject: [PATCH 5/6] Convert user documentation to Middleman format --- .../overview.md => source/users/settings/overview.html.md} | 0 .../settings/taxes.md => source/users/settings/taxes.html.md} | 4 ++-- .../settings/zones.md => source/users/settings/zones.html.md} | 0 3 files changed, 2 insertions(+), 2 deletions(-) rename guides/{users/settings/overview.md => source/users/settings/overview.html.md} (100%) rename guides/{users/settings/taxes.md => source/users/settings/taxes.html.md} (98%) rename guides/{users/settings/zones.md => source/users/settings/zones.html.md} (100%) diff --git a/guides/users/settings/overview.md b/guides/source/users/settings/overview.html.md similarity index 100% rename from guides/users/settings/overview.md rename to guides/source/users/settings/overview.html.md diff --git a/guides/users/settings/taxes.md b/guides/source/users/settings/taxes.html.md similarity index 98% rename from guides/users/settings/taxes.md rename to guides/source/users/settings/taxes.html.md index 825073dc98e..4f527570100 100644 --- a/guides/users/settings/taxes.md +++ b/guides/source/users/settings/taxes.html.md @@ -18,7 +18,7 @@ within the state should be taxed. But any candy that you sell is tax exempt. You may want to create a "Candy" tax category to handle your candy products that are exempt from tax. -[products]: ../products/overview.md +[products]: ../products/overview.html ### Tax category fields @@ -45,7 +45,7 @@ functions: calculator](#tax-calculators). [vat]: https://en.wikipedia.org/wiki/Value-added_tax -[zones]: zones.md +[zones]: zones.html ### Create a tax rate diff --git a/guides/users/settings/zones.md b/guides/source/users/settings/zones.html.md similarity index 100% rename from guides/users/settings/zones.md rename to guides/source/users/settings/zones.html.md From e5e1399aacf67e186905dbb6e559a93c27a6bd9c Mon Sep 17 00:00:00 2001 From: Benjamin Willems Date: Tue, 29 May 2018 12:03:48 -0700 Subject: [PATCH 6/6] Revise description of VAT; fix typo --- guides/source/users/settings/overview.html.md | 2 +- guides/source/users/settings/taxes.html.md | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/guides/source/users/settings/overview.html.md b/guides/source/users/settings/overview.html.md index f5ae020535b..895d34dd43e 100644 --- a/guides/source/users/settings/overview.html.md +++ b/guides/source/users/settings/overview.html.md @@ -7,4 +7,4 @@ ## Taxes With Solidus, you can create tax rates and tax categories that correspond with -each item in your store and each state or country that you ship to. +each item in your store and each location that you ship to. diff --git a/guides/source/users/settings/taxes.html.md b/guides/source/users/settings/taxes.html.md index 4f527570100..fd5c5111774 100644 --- a/guides/source/users/settings/taxes.html.md +++ b/guides/source/users/settings/taxes.html.md @@ -38,7 +38,9 @@ have more complicated tax requirements, your tax rates can perform more complex functions: - You can create tax rates that calculate using sales tax (U.S.-style taxes) or - value-added taxes ([VAT][vat], or E.U.-style taxes). + value-added taxes ([VAT][vat], or E.U.-style taxes). Sales tax is applied on + top of the price of each item, where as VAT is included in the price of each + item. - You can show or hide tax rates in customer invoices. - You can create tax rates that are valid from a specific date. - You can change the **Base Calculator** to [a custom tax