Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Setup Checklist

...

1. POS TASKS

...

  • Ensure that Taxes are set up in RTP|One or Siriusware.

    Status
    colourRed
    titleRequired

  • If your resort used Unity AND you wish to apply taxes by shipping location, the RTP|One administrator must configure taxes by shipping location in RTP|One, and each region, province/state, or postal code must match the tax rates you configure in Aspenware Commerce.

    Status
    colourBlue
    titleoptional

...

Status
colourYellow
titlePrerequisite

...

2. INFRASTRUCTURE TASKS

...

Infrastructure Task 2 -

Status
colourRed
titleRequired

...

Status
colourYellow
titlePrerequisite

...

3. COMMERCE TASKS

...

Commerce Task 3 -

Status
colourRed
titleRequired

...

Status
colourYellow
titlePrerequisite

Language String, Setting, HTML widgets

Setting

  • Ensure that shoppingcartsettings.displaytax is set to ‘True.’

    Status
    colourBlue
    titleoptional

  • If configuring taxes by shipping location, set ecommercesettings.taxes.displayitemized to 'True.'

    Status
    colourBlue
    titleoptional

  • If configuring taxes by shipping location, set taxSettings.DisplayTaxRates to 'True.'

    Status
    colourBlue
    titleoptional

Language Strings

...

Set shoppingcart.totals.taxlabel to ‘Tax (Estimate)’

Status
colourRed
titlerequired

...

Table of Contents

Setup Checklist

Insert excerpt
Set-up Checklist
Set-up Checklist
nopaneltrue

1. POS Tasks

RTP|One

  • If products are taxed inclusively, setup Product Headers for inclusive tax, ensuring it matches what is configured in Aspenware Commerce.

    Status
    colourRed
    title

requiredSet Messages.Order.TaxRateLine to ‘Tax {0}:’ StatuscolourBluetitleoptionaltitlePrerequisite 1. Create Tax Rules
  • Required

  • If products are taxed exclusively, setup Product Headers for exclusive tax, ensuring it matches what is configured in Aspenware Commerce.

    Status
    colourRed
    title

Yellow 2. Create Tax Settings
  • required

  • If your resort uses Unity AND you wish to apply taxes by shipping location (only supported for Retail products), the RTP|One administrator must configure taxes by shipping location in RTP|One, and each region, province/state, or postal code must match the tax rates you configure in Aspenware Commerce.

    Status
    colour

RedtitleRequired
  • Go to Configuration > Settings > Tax Settings

  • On the Tax settings page, scroll down to the Tax Displaying tab.

    1. To setup exclusive tax, enter the following:

      1. Allow customers to select tax display type: Uncheck  

      2. Tax display type: Select ‘Excluding tax’ 

    2. To setup inclusive tax, enter the following:

      1. Allow customers to select tax display type: Uncheck 

      2. Tax display type: Select ‘Including tax’ 

  • Click Save.

Add the applicable tax to all taxable products in your store.
  • Blue
    titleoptional

Siriusware

  • If products are taxed inclusively, setup Item(s) for Siriusware inclusive tax, ensuring it matches what is configured in Aspenware Commerce.

    Status
    colourRed
    titlerequired

  • Go to Configuration > Tax Categories.

  • Scroll down to the Add new record section.

  • Enter a Name for the new tax category and Display Order.

  • Click Add new record.

  • Go to Configuration > Tax providers page in Administration.

  • Click Configure next to the Manual (Fixed or By Country/State/Zip) provider.

  • The Tax category created in the previous step will be shown in the Tax category list

  • Click Edit and enter the Rate.

  • Click Update to save. 

  • Return to the Tax providers list and if the updated provider is not already set as the primary provider, click Mark as primary provider for Manual (Fixed or By Country/State/Zip). 

3. Apply Tax Setting to Products

Status
colourRed
titlerequired

  • Go to the Catalog > Products and Search for the desired product. 

  • Click Edit.

  • Scroll down to the Price section on the page.

  • Ensure that Tax exempt is unchecked. 

  • From the Tax category drop-down, select the tax category that applies to the product.

  • Click Save at the top of the Edit product details page.

4. Configure Taxes by Shipping Location (Unity users only)

Status
colourBlue
titleoptional

  • For resorts using Unity, to apply taxes by shipping location, go to Configuration > Tax Providers.

  • Click Configure next to the ‘Manual’ tax provider.

  • Select 'By Country'

    1. Configure tax by location for each region, state/province, or postal code. (These should have already been created by the RTP|One administrator and created in Commerce using the previous steps.

    2. This will be the tax that is assigned to/set up in the product shell under 'Price.'

    3. If taxes are NOT priced by location, then you will want to set this up with a flat rate (i.e. flat 7.45% tax). This requires a new tax category, you will assign a tax rate to United States as a whole.

5. Display Itemized Taxes to Guest

Status
colourBlue
titleoptional

  • Ensure that itemized taxes in your store are enabled (See Settings above) so that Tax Category Name is used for tax labels displayed in the store.

  • Tax Category Name is configurable, so the administrator can choose a meaningful label to display to the guest. To configure a tax category name, go to Configuration > Tax Categories.

  • Click Edit to update the names as desired.

  • Click Update.  

    • If products are taxed exclusively, setup Item(s) for Siriusware exclusive tax, ensuring it matches what is configured in Aspenware Commerce.

      Status
      colourRed
      titlerequired

    • If you wish to display itemized taxes, ensure that the corresponding products in Siriusware must also be configured with only one tax, at the matching rate.

      Status
      colourBlue
      titleoptional

    Status
    colourYellow
    titlePrerequisite

    2. Commerce Tasks

    Language Strings, Settings, HTML widgets

    Settings

    • Ensure that ‘shoppingcartsettings.displaytax’ is set to ‘True.’

      Status
      colourBlue
      titleoptional
      for Fixed Rate tax configuration
      Status
      colourRed
      titlerequired
      for by Country tax configuration

    • If configuring taxes for Itemized Taxes, set ‘ecommercesettings.taxes.displayitemized’ to 'True.' (Only supported for Exclusive tax)

      Status
      colourBlue
      titleoptional

    • If configuring taxes by shipping location, set ‘taxSettings.DisplayTaxRates’ to 'True.' (Only supported for stores that sell Retail products and have tax set to “By Country” in Tax Providers

      Status
      colourRed
      titlerequired

    Language Strings

    • Set ‘shoppingcart.totals.taxlabel’ to ‘Tax (Estimate)’

      Status
      colourRed
      titlerequired

    • Set ‘checkout.totals.tax’ to ‘Tax’

      Status
      colourRed
      titlerequired

    • Set ‘Messages.Order.TaxRateLine’to ‘Tax {0}:’

      Status
      colourBlue
      titleoptional

    Status
    colourYellow
    titlePrerequisite

    1. Create Tax Rules to be either Inclusive or Exclusive

    Status
    colourRed
    titleRequired

    2. Create Tax Settings

    Status
    colourRed
    titlerequired

    • Create Tax Category

    • Configure rate for each Tax Category

    • Assign a primary Tax Provider

    3. Apply Tax Setting to Products

    Status
    colourRed
    titlerequired

    4. Display Itemized Taxes to Guest

    Status
    colourBlue
    titleoptional

    Status
    colourGreen
    titleDetailed Setup

    Prerequisite Tasks

    Insert excerpt
    AE:Prerequisites Tasks ExcerptAE:
    Prerequisites Tasks Excerpt
    nopaneltrue

    POS Tasks

    ...

    Tasks

    RTP|One

    • If products are taxed exclusively, setup Product Header(s) for exclusive tax, ensuring it matches what is configured in Aspenware Commerce.

    • If products are taxed inclusively, setup Product Header(s) for inclusive tax, ensuring it matches what is configured in Aspenware Commerce.

    • If your resort used uses Unity AND you wish to apply taxes by shipping location, the RTP|One administrator must configure taxes by shipping location in RTP|One, and each region, province/state, or postal code must match the tax rates you configure in Aspenware Commerce.

    • If you wish to display itemized taxes, ensure that the corresponding products in RTP|One or Siriusware must also be configured with only one tax, at the matching rate. For the example above, the lift product component in RTP and DCI in Siriusware must have a tax of 5%. The rental product component/DCI must have a tax of 12%.

    Infrastructure Tasks

    • Infrastructure Task that must be completed first. Remove section if not required

    Commerce Tasks

    • AW Commerce task that must be completed first

    ...

    • rate.

    Siriusware

    • If products are taxed inclusively, setup Item(s) for Siriusware inclusive tax, ensuring it matches what is configured in Aspenware Commerce.

    • If products are taxed exclusively, setup Item(s) for Siriusware exclusive tax, ensuring it matches what is configured in Aspenware Commerce.

    • If you wish to display itemized taxes, ensure that the corresponding products in Siriusware must also be configured with only one tax, at the matching rate.

    Settings and Language Strings for this Feature

    Insert excerpt
    AE:Setting, Language String and/or HTML Widgets for this featureAE:
    Setting, Language String and/or HTML Widgets for this feature
    nopaneltrue

    Settings

    ...

    Settings

    • To display tax in the cart during checkout, go to Configuration > Settings > All Settings (advanced) and add the following setting and value if it doesn’t already exist. 

    ...

    Setting

    ...

    Value

    ...

    shoppingcartsettings.displaytax

    ...

    True

    • (Optional) To enable itemized taxes in your store, go to Settings > All Settings (Advanced), search for the ecommercesettings.taxes.displayitemized setting and set to True. Click Update. If you also want the Tax Category Name to be displayed on the confirmation letter, set TaxSettings.DisplayTaxRates to ‘True’ as well.

    ...

    Setting

    ...

    Value

    ...

    ecommercesettings.taxes.displayitemized

    ...

    True

    ...

    taxSettings.DisplayTaxRates

    ...

    True

    ...

    Language Strings

    • Go to Configuration > Languages, select to Edit English, and select the String resources tab. Add the following language strings if they don’t exist:

    ...

    String resource

    ...

    Value

    ...

    shoppingcart.totals.taxlabel

    ...

    Tax (Estimated)

    ...

    checkout.totals.tax

    ...

    Tax

    • (For Displaying Itemized Taxes) If you use a % at the end of the tax category name be sure to edit the following Language String to remove the % from the Value. Go to Configuration>Languages select to Edit English, and select the String resources tab. Search for the following string and configure as shown (remove the %.)

    ...

    String resource

    ...

    Value

    ...

    Messages.Order.TaxRateLine

    ...

    Tax {0}:

    HTML Widgets

    • AW Commerce HTML Widgets that must first be completed

    Detailed Setup Guide

    1. Create Tax Rules

    2. Create Tax Settings

    3. Apply Tax Setting to Products

    4. Configure Taxes by Shipping Location (Optional - Unity users only)

    5. Display Itemized Taxes to Guest (Optional)

    1. Create Tax Rules

    This step configures whether the store will use and display inclusive tax or exclusive tax across the store. 

    Info

    NOTE: An online store can only display inclusive or exclusive tax to customers and doesn’t support displaying tax for both products with inclusive tax and exclusive tax. If both tax types (inclusive and exclusive) are required, it is recommended to set up the store for exclusive tax and to price products that are inclusive of tax with inclusive tax in RTP|One only. In this scenario, exclusive tax will be calculated and displayed to the customer in the online store, but products with inclusive tax will not show the inclusive tax on the shop.

    Determine which of the following two options are desired for your store:

    1. Exclusive Tax: Exclusive tax amount is available for display in the cart, checkout and confirmation pages and email. The order total is the sum of the subtotal and tax on the order.

    2. Inclusive Tax: Inclusive tax amount is available for display in the cart, checkout and confirmation pages and email. The order total is the sum of the subtotal and the tax on the order included in the price of the products.

    • Go to Configuration > Settings > Tax Settings

    • On the Tax settings page, scroll down to the Tax Displaying tab.

      1. To setup exclusive tax, enter the following:

        1. Allow customers to select tax display type: Uncheck  

        2. Tax display type: Select ‘Excluding tax’ 

      2. To setup inclusive tax, enter the following:

        1. Allow customers to select tax display type: Uncheck 

        2. Tax display type: Select ‘Including tax’ 

    • Click Save.

      Image Removed

    2. Create Tax Settings

    • Go to Configuration > Tax Categories.

    • Scroll down to the Add new record section.

    • Enter a Name for the new tax category and Display Order.

    • Click Add new record.

    • Image Removed
    • Go to Configuration > Tax providers page in Administration.

    • Click Configure next to the Manual (Fixed or By Country/State/Zip) provider.

    • The Tax category created in the previous step will be shown in the Tax category list

    • Click Edit and enter the Rate.

    • Click Update to save. 

      Image Removed
    • Return to the Tax providers list and if the updated provider is not already set as the primary provider, click Mark as primary provider for Manual (Fixed or By Country/State/Zip). 

      Image Removed

    3. Apply Tax Setting to Products

    • Go to the Catalog > Products and Search for the desired product. 

    • Click Edit.

    • Scroll down to the Price section on the page.

    • Ensure that Tax exempt is unchecked. 

    • From the Tax category drop-down, select the tax category that applies to the product.

      Image Removed
    • Click Save at the top of the Edit product details page.

    4. Configure Taxes by Shipping Location (Optional - Unity users only)

    Note

    IMPORTANT: For resorts using Unity, Aspenware Commerce supports Taxes by shipping location, which will apply the tax rate configured for the shipping address entered by the guest during checkout. Resorts using RTP|Connect cannot utilize this feature and need to use Fixed Rate taxes, since RTP|Connect cannot specify a shipping address when creating an RTP|One order, which is required for tax by shipping location in RTP|One.

    Note

    IMPORTANT: The RTP|One administrator must also configure taxes by shipping location in RTP|One, and each region, province/state, or postal code must match the tax rates you configure in Aspenware Commerce.

    • For resorts using Unity, to apply taxes by shipping location, go to Configuration > Tax Providers.

    • Click Configure next to the ‘Manual’ tax provider.

    • Select 'By Country'

      1. Configure tax by location for each region, state/province, or postal code. (These should have already been created by the RTP|One administrator and created in Commerce using the previous steps.

      2. This will be the tax that is assigned to/set up in the product shell under 'Price.'

      3. If taxes are NOT priced by location, then you will want to set this up with a flat rate (i.e. flat 7.45% tax). This requires a new tax category, you will assign a tax rate to United States as a whole.

    ...

    • and add the following setting and value if it doesn’t already exist. 

    Setting

    Value

    Example

    shoppingcartsettings.displaytax

    When set to “True”, the line item for taxes will be displayed on the shopping cart and checkout and are defaulted to the language strings shoppingcart.totals.taxlabel for the shopping cart and checkout.totals.tax for checkout.

    When set to “False”, the line item for taxes will not be displayed on the shopping cart.

    Note: checkout will display the tax line whether this setting is True or False.

    NOTE: Depending on this setting, inclusive vs exclusive taxes, and the setting for 'taxsettings.hidetaxinordersummary”, the cart display may vary.

    True

    Image Added

    False

    Image Added

    taxsettings.hidetaxinordersummary

    When set to “True”, checkout will display the taxes $__.

    When set to “False”, checkout will always display a $0 value in checkout.

    NOTE: Depending on this setting, inclusive vs exclusive taxes, and the setting for shoppingcartsettings.displaytax, the cart display may vary.

    True

    Image Added

    False

    Image Added
    • (Only supported for Exclusive Tax) To enable itemized taxes in your store, go to Settings > All Settings (Advanced), search for the ‘ecommercesettings.taxes.displayitemized’ setting and set it to ‘True’. Click Update. If you also want the Tax Category Name to be displayed on the confirmation letter, set ‘TaxSettings.DisplayTaxRates’ to ‘True’ as well. This is REQUIRED for stores that sell Retail products and have tax set to “By Country” in Tax Providers.

    Setting

    Value

    ecommercesettings.taxes.displayitemized

    True

    taxSettings.DisplayTaxRates

    True

    ...

    Language Strings

    • To configure the language string for the tax component of the shopping cart, go to Configuration > Languages, select to Edit English, and select the String resources tab. Add the following language strings if they don’t exist:

    String resource

    Value

    shoppingcart.totals.taxlabel

    Tax (Estimated)

    checkout.totals.tax

    Tax

    • (For Displaying Itemized Taxes) If you use a % at the end of the tax category name be sure to edit the following Language String to remove the % from the Value. Go to Configuration>Languages select to Edit English, and select the String resources tab. Search for the following string and configure as shown (remove the %.)

    String resource

    Value

    Messages.Order.TaxRateLine

    Tax {0}:

    Detailed Setup Guide

    Insert excerpt
    Detailed Setup Guide Excerpt
    Detailed Setup Guide Excerpt
    nopaneltrue

    1. Create Tax Rules

    2. Create Tax Settings

    3. Apply Tax Setting to Products

    4. Display Itemized Taxes to Guest (Optional)

    Info

    NOTE: For information on tax setup within the retail configuration, see the Retail Configuration Documentation section.

    1. Create Tax Rules

    This step configures whether the store will use and display inclusive tax or exclusive tax across the store. 

    Info

    NOTE: An online store can only display inclusive or exclusive tax to customers and doesn’t support displaying tax for both products with inclusive tax and exclusive tax. If both tax types (inclusive and exclusive) are required, it is recommended to set up the store for exclusive tax and to price products that are inclusive of tax with inclusive tax in RTP|One only. In this scenario, exclusive tax will be calculated and displayed to the customer in the online store, but products with inclusive tax will not show the inclusive tax on the shop; however, if the price of the product in the shop is inclusive of tax and the product in the POS is setup for inclusive tax, taxes for these products will be calculated correctly in the POS.

    Determine which of the following two options are desired for your store:

    1. Exclusive Tax: Exclusive tax amount is available for display in the cart, checkout and confirmation pages and email. The order total is the sum of the subtotal and tax on the order.

    2. Inclusive Tax: Inclusive tax amount is available for display in the cart, checkout and confirmation pages and email. The order total is the sum of the subtotal and the tax on the order included in the price of the products.

    Note

    IMPORTANT: Unity does not support RTP|One Tax configuration for the method called “Inclusive Tax with Discount/Commission Reduction”.

    • Go to Configuration > Settings > Tax Settings. Toggle the display to ‘Advanced’

    • On the Tax settings page, scroll down to the Tax Displaying tab.

      1. To setup exclusive tax, enter the following:

        1. Allow customers to select tax display type: Uncheck  

        2. Tax display type: Select ‘Excluding tax’ 

        3. Price Include tax: Uncheck

      2. To setup inclusive tax, enter the following:

        1. Allow customers to select tax display type: Uncheck 

        2. Tax display type: Select ‘Including tax’ 

        3. Price Include tax: Check

    • Click Save.

      Image Added

    2. Create Tax Settings

    • Go to Configuration > Tax Categories.

    • Scroll down to the Add new record section.

    • Enter a Name for the new tax category and Display Order.

    • Click Add new record.

    • Image Added
    • Go to Configuration > Tax providers page in Administration.

    • Click Configure next to the Manual (Fixed or By Country/State/Zip) provider.

    Info

    NOTE: Unless configuring tax for Retail products, set this to 'Fixed rate.'

    • The Tax category created in the previous step will be shown in the Tax category list

    • Click Edit and enter the Rate.

    • Click Update to save. 

      Image Added
    • Return to the Tax providers list and if the updated provider is not already set as the primary provider, click Mark as primary provider for Manual (Fixed or By Country/State/Zip). 

      Image Added

    3. Apply Tax Setting to Products

    • Go to the Catalog > Products and Search for the desired product. 

    • Click Edit.

    • Scroll down to the Price section on the page.

    • Ensure that Tax exempt is unchecked if the product is taxed.

    • From the Tax category drop-down, select the tax category that applies to the product.

      Image Added
    • Click Save at the top of the Edit product details page.

    4. Display Itemized Taxes to Guest (Optional)

    Aspenware Commerce supports displaying itemized taxes to the guest. Using this feature enables the Aspenware Commerce Administrator to break out taxes store to display taxes broken out by tax category in the cart, order summary, and confirmation letter. Follow these steps to enable itemized taxes and customize your tax category names.

    ...

    • Ensure that itemized taxes in your store are enabled (See Settings above) so that Tax Category Name is used for tax labels displayed in the store.

    • Tax Category Name is configurable, so the administrator can choose a meaningful label to display to the guest. To configure a tax category name, go to Configuration > Tax Categories.

    • Click Edit to update the names as desired.

    • Click Update.

        

    • Add the applicable tax to all taxable products in your store (See Step 3 above.) For example, if lift, lesson, and pass products all carry a tax rate of 5%, and rental products are taxed at 12%, you need to configure two taxes tax categories and assign the 5% tax to lift, lesson, and pass products, and the 12% tax to rental products.

    Info

    NOTE: Aspenware Commerce supports one tax per product, so ensure you have one tax rate configured for all your applicable tax rates for each product type.

    ...

    Note

    ...

    IMPORTANT: If configuring tax for products using Aspenware Payment Plan functionality, see additional configuration steps in the detailed setup guide.

    ...