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 6, 2023
1 parent 9c331d2 commit ed3326c
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion 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: Configures the tax estimation and display settings the shoppers see based on their geolocation before they confirm the destination address at checkout.
guest_shopper_tax_zone_id:
default: 1
type: integer
description: Setting to configure the default guest shopper tax zone id if there are no geolocation provided.
store_tax_zone_id:
default: 1
type: integer
description: Setting to configure the default store tax zone id.
Tax_Settings_Req:
type: object
properties:
Expand Down Expand Up @@ -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: Configures the tax estimation and display settings the shoppers see based on their geolocation before they confirm the destination address at checkout.
guest_shopper_tax_zone_id:
default: 1
type: integer
description: Setting to configure the default guest shopper tax zone id if there are no geolocation provided.
store_tax_zone_id:
default: 1
type: integer
description: Setting to configure the default store tax zone id.
MetaOpen:
title: Response meta
type: object
Expand Down

0 comments on commit ed3326c

Please sign in to comment.