Class TaxMgr

dw.order

Class TaxMgr

Object

dw.order.TaxMgr

Provides methods to access the tax table.

TAX_POLICY_GROSS : Number = 0

Constant representing the gross taxation policy.

TAX_POLICY_NET : Number = 1

Constant representing the net taxation policy.

customRateTaxClassID : String (Read Only)

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 : String (Read Only)

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 : String (Read Only)

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.

taxationPolicy : Number (Read Only)

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

taxExemptTaxClassID : String (Read Only)

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.

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

static applyExternalTax(basket : Basket) : void

Applies externally set tax rates to the given Basket.

static applyTax(basket : Basket) : void

Applies tax to the given Basket using the platform's tax hook dispatch logic.

static getCustomRateTaxClassID() : String

Returns the ID of the tax class that represents items with a custom tax rate.

static getDefaultTaxClassID() : String

Returns the ID of the default tax class defined for the site.

static getDefaultTaxJurisdictionID() : String

Returns the ID of the default tax jurisdiction defined for the site.

static getTaxationPolicy() : Number

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

static getTaxExemptTaxClassID() : String

Returns the ID of the tax class that represents tax exempt items.

static getTaxJurisdictionID(location : ShippingLocation) : String

Returns the ID of the tax jurisdiction for the specified address.

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

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

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

applyExternalTax

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:

    var TaxMgr = require('dw/order/TaxMgr');

    calculateTaxes: function () {
       Basket basket = BasketMgr.getCurrentBasket();
       if ( basket.isExternallyTaxed() )
       {
          TaxMgr.applyExternalTaxation( basket );
       }
       else
       {
          // calculation with tax tables or customization
       }
    }

Parameters:

basket - apply external taxation to this basket

applyTax

static applyTax(basket : Basket) : void

Applies tax to the given Basket using the platform's tax hook dispatch logic.

This method is intended for use in custom dw.order.calculate hook implementations (e.g., in SFRA or SiteGenesis) that override the default basket calculation. Calling this method instead of directly invoking dw.order.calculateTax ensures that Commerce App tax providers registered via sfcc.app.tax.calculate are invoked when available, with automatic fallback to the legacy dw.order.calculateTax hook or the platform default tax calculation.

WARNING: Do NOT call this method from within a dw.order.calculateTax hook implementation, as this will cause infinite recursion. This method is designed to be called from dw.order.calculate hooks only.

The dispatch precedence is:

sfcc.app.tax.calculate — if a Commerce App tax provider is installed and the feature is enabled.
dw.order.calculateTax — if registered by the storefront.
Platform default tax calculation — using the site's tax tables.

Typical usage in a custom dw.order.calculate hook:

 var TaxMgr = require('dw/order/TaxMgr');

 exports.calculate = function (basket) {
     // ... product prices, promotions, shipping ...
     TaxMgr.applyTax(basket);
     basket.updateTotals();
 };

Parameters:

basket - the basket for which tax should be calculated.

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.

getTaxationPolicy

static getTaxationPolicy() : Number

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

Returns:

Taxation policy configured for current site