Class TaxMgr

• TopLevel.Object
  • dw.order.TaxMgr

Provides methods to access the tax table.

Constant Summary 

Constant	Description
TAX_POLICY_GROSS: Number = 0	Constant representing the gross taxation policy.
TAX_POLICY_NET: Number = 1	Constant representing the net taxation policy.

Property Summary 

Property	Description
customRateTaxClassID: String (read-only)	Returns the ID of the tax class that represents items with a custom tax rate.
defaultTaxClassID: String (read-only)	Returns the ID of the default tax class defined for the site.
defaultTaxJurisdictionID: String (read-only)	Returns the ID of the default tax jurisdiction defined for the site.
taxExemptTaxClassID: String (read-only)	Returns the ID of the tax class that represents tax exempt items.
taxationPolicy: Number (read-only)	Returns the taxation policy (net/gross) configured for the current site.

Constructor Summary 

This class does not have a constructor, so you cannot create it directly.

Method Summary 

Method	Description
static applyExternalTax(Basket)	Applies externally set tax rates to the given Basket.
static getCustomRateTaxClassID()	Returns the ID of the tax class that represents items with a custom tax rate.
static getDefaultTaxClassID()	Returns the ID of the default tax class defined for the site.
static getDefaultTaxJurisdictionID()	Returns the ID of the default tax jurisdiction defined for the site.
static getTaxExemptTaxClassID()	Returns the ID of the tax class that represents tax exempt items.
static getTaxJurisdictionID(ShippingLocation)	Returns the ID of the tax jurisdiction for the specified address.
static getTaxRate(String, String)	Returns the tax rate defined for the specified combination of tax class and tax jurisdiction.
static getTaxationPolicy()	Returns the taxation policy (net/gross) configured for the current site.

Methods inherited from class Object 

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

Constant Details 

TAX_POLICY_GROSS 

TAX_POLICY_GROSS: Number = 0

Constant representing the gross taxation policy.

---

TAX_POLICY_NET 

TAX_POLICY_NET: Number = 1

Constant representing the net taxation policy.

---

Property Details 

customRateTaxClassID 

customRateTaxClassID: String (read-only)

Returns the ID of the tax class that represents items with a custom tax rate. The standard order calculation process assumes that such line items are initialized with a tax rate and a being ignored during the tax rate lookup sequence of the calculation process.

Note that this tax class does not appear in the Business Manager tax module.

---

defaultTaxClassID 

defaultTaxClassID: String (read-only)

Returns the ID of the default tax class defined for the site. This class might be used in case a product or service does not define a tax class.

If no default tax class is defined, the method returns null.

---

defaultTaxJurisdictionID 

defaultTaxJurisdictionID: String (read-only)

Returns the ID of the default tax jurisdiction defined for the site. This jurisdiction might be used in case no jurisdiction is defined for a specific address.

If no default tax jurisdiction is defined, this method returns null.

---

taxExemptTaxClassID 

taxExemptTaxClassID: String (read-only)

Returns the ID of the tax class that represents tax exempt items. The tax manager will return a tax rate of 0.0 for this tax class.

Note that this tax class does not appear in the Business Manager tax module.

---

taxationPolicy 

taxationPolicy: Number (read-only)

Returns the taxation policy (net/gross) configured for the current site.

See Also:

• TAX_POLICY_GROSS
• TAX_POLICY_NET

---

Method Details 

applyExternalTax(Basket) 

static applyExternalTax(basket: Basket): void

Applies externally set tax rates to the given Basket. Only use when LineItemCtnr.isExternallyTaxed() returns true. Note: a basket can only be created in EXTERNAL tax mode using SCAPI.

Typical usage in tax calculation:

1var TaxMgr = require('dw/order/TaxMgr');
2   
3   calculateTaxes: function () {
4      Basket basket = BasketMgr.getCurrentBasket();
5      if ( basket.isExternallyTaxed() )
6      {
7         TaxMgr.applyExternalTaxation( basket );
8      }
9      else
10      {
11         // calculation with tax tables or customization
12      }
13   }

Parameters:

• basket - apply external taxation to this basket

---

getCustomRateTaxClassID() 

static getCustomRateTaxClassID(): String

Returns the ID of the tax class that represents items with a custom tax rate. The standard order calculation process assumes that such line items are initialized with a tax rate and a being ignored during the tax rate lookup sequence of the calculation process.

Note that this tax class does not appear in the Business Manager tax module.

---

getDefaultTaxClassID() 

static getDefaultTaxClassID(): String

Returns the ID of the default tax class defined for the site. This class might be used in case a product or service does not define a tax class.

If no default tax class is defined, the method returns null.

Returns:

• the ID of the default tax class defined for the site or null.

---

getDefaultTaxJurisdictionID() 

static getDefaultTaxJurisdictionID(): String

Returns the ID of the default tax jurisdiction defined for the site. This jurisdiction might be used in case no jurisdiction is defined for a specific address.

If no default tax jurisdiction is defined, this method returns null.

Returns:

• the ID of the default tax jurisdiction defined for the site or null.

---

getTaxExemptTaxClassID() 

static getTaxExemptTaxClassID(): String

Returns the ID of the tax class that represents tax exempt items. The tax manager will return a tax rate of 0.0 for this tax class.

Note that this tax class does not appear in the Business Manager tax module.

---

getTaxJurisdictionID(ShippingLocation) 

static getTaxJurisdictionID(location: ShippingLocation): String

Returns the ID of the tax jurisdiction for the specified address. If no tax jurisdiction defined for the site matches the specified address, this method returns null.

Parameters:

• location - The shipping location

Returns:

• the ID of the tax jurisdiction for the specified address or null.

---

getTaxRate(String, String) 

static getTaxRate(taxClassID: String, taxJurisdictionID: String): Number

Returns the tax rate defined for the specified combination of tax class and tax jurisdiction.

Method returns null if no tax rate is defined.

Method returns 0.0 of 'nontaxable' tax rate is specified (see method 'getNontaxableTaxClassID'.

Parameters:

• taxClassID - ID of the tax class
• taxJurisdictionID - ID of tax jusrisdiction

Returns:

• the tax rate defined for the specified combination of tax class and tax jurisdiction.

---

getTaxationPolicy() 

static getTaxationPolicy(): Number

Returns the taxation policy (net/gross) configured for the current site.

Returns:

• Taxation policy configured for current site

See Also:

• TAX_POLICY_GROSS
• TAX_POLICY_NET

---