Skip to content
This repository has been archived by the owner on Jan 15, 2024. It is now read-only.

Commit

Permalink
feat(tax): TAX-1867 Update tax settings documentation for tax zone ba…
Browse files Browse the repository at this point in the history
…sed price display for storefront
  • Loading branch information
bc-msung committed Sep 7, 2023
1 parent 6994cba commit bb61496
Showing 1 changed file with 26 additions and 2 deletions.
28 changes: 26 additions & 2 deletions reference/tax_settings.v3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,19 @@ components:
should_subtract_store_tax:
default: true
type: boolean
description: This setting applies only if a merchant enters tax-inclusive prices. When enabled, the store subtracts the itemʼs store tax rate before calculating tax using the shopperʼs tax zone. The tax-exclusive amount will be the same across all tax zones. When disabled, the tax-inclusive price remains the same across all tax zones; only the tax amount will vary based on the shopperʼs location. The tax-exclusive amount may vary among tax zones. These calculations are relevant for tax pricing and tax quotations that use basic tax.
description: This setting applies only if a merchant enters tax-inclusive prices. When enabled, the store subtracts the itemʼs store tax rate before calculating tax using the shopperʼs tax zone. The tax-exclusive amount will be the same across all tax zones. When disabled, the tax-inclusive price remains the same across all tax zones; only the tax amount will vary based on the shopperʼs location. The tax-exclusive amount may vary among tax zones. These calculations are relevant for tax pricing and tax quotations that use basic tax.
should_use_geolocation_to_determine_guest_shopper_tax_zone:
default: false
type: boolean
description: When enabled, geolocation data will be used to match the guest shopper with a relevant country-level tax zone for tax estimation on the storefront. The geolocation data will be used to determine the corresponding tax zone provided in basic tax - once the corresponding tax zone is found, the tax estimation will be applied to the store.
guest_shopper_tax_zone_id:
default: 1
type: integer
description: Describes which tax zone is used for guest shoppers when requiring storefront tax estimation. When applicable, the shopper's geolocation data will be used in favour of the guest shopper tax zone.
store_tax_zone_id:
default: 1
type: integer
description: This setting applies only if a merchant enters tax-inclusive prices. Describes which tax zone to use for store tax subtraction.
Tax_Settings_Req:
type: object
properties:
Expand All @@ -169,7 +181,7 @@ components:
- EXCLUSIVE
fallback_strategy:
type: string
description: 'Decribes the fallback behaviour that applies when a tax provider produces an error. A merchant may decide to use a flat 10% fallback tax rate, their basic tax settings, or to block the transaction until a successful result can be achieved.'
description: 'Describes the fallback behaviour that applies when a tax provider produces an error. A merchant may decide to use a flat 10% fallback tax rate, their basic tax settings, or to block the transaction until a successful result can be achieved.'
enum:
- FIXED
- BASIC
Expand All @@ -178,6 +190,18 @@ components:
default: true
type: boolean
description: This setting applies only if a merchant enters tax-inclusive prices. When enabled, the store subtracts the itemʼs store tax rate before calculating tax using the shopperʼs tax zone. The tax-exclusive amount will be the same across all tax zones. When disabled, the tax-inclusive price remains the same across all tax zones; only the tax amount will vary based on the shopperʼs location. The tax-exclusive amount may vary among tax zones. These calculations are relevant for tax pricing and tax quotations that use basic tax.
should_use_geolocation_to_determine_guest_shopper_tax_zone:
default: false
type: boolean
description: When enabled, geolocation data will be used to match the guest shopper with a relevant country-level tax zone for tax estimation on the storefront. The geolocation data will be used to determine the corresponding tax zone provided in basic tax - once the corresponding tax zone is found, the tax estimation will be applied to the store.
guest_shopper_tax_zone_id:
default: 1
type: integer
description: Describes which tax zone is used for guest shoppers when requiring storefront tax estimation. When applicable, the shopper's geolocation data will be used in favour of the guest shopper tax zone.
store_tax_zone_id:
default: 1
type: integer
description: This setting applies only if a merchant enters tax-inclusive prices. Describes which tax zone to use for store tax subtraction.
MetaOpen:
title: Response meta
type: object
Expand Down

0 comments on commit bb61496

Please sign in to comment.