Class TaxGroup

dw.order

Class TaxGroup

Object

dw.order.TaxGroup

Contains the formal definition of a tax including a type (it's just the key), a percentage value if provided, a caption and a description.

caption : String (Read Only)

Gets the caption.

description : String (Read Only)

Gets the description.

rate : Number (Read Only)

Gets the percentage amount of the rate.

taxType : String (Read Only)

Gets the tax type.

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

static create(taxType : String, caption : String, description : String, taxRate : Decimal) : TaxGroup

Creates a TaxGroup.

getCaption() : String

Gets the caption.

getDescription() : String

Gets the description.

getRate() : Number

Gets the percentage amount of the rate.

getTaxType() : String

Gets the tax type.

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

create

static create(taxType : String, caption : String, description : String, taxRate : Decimal) : TaxGroup

Creates a TaxGroup.
This TaxGroup can be used for example in ReturnItem.addTaxItem(Decimal, TaxGroup).

Parameters:

taxType - the tax type

caption - the caption

description - the description

taxRate - the tax rate as floating point.
1.0 means 100 %.

Returns:

the tax group

getCaption

getCaption() : String

Gets the caption.

Returns:

the caption

getDescription

getDescription() : String

Gets the description.

Returns:

the description

getRate

getRate() : Number

Gets the percentage amount of the rate.

Returns:

the tax rate percentage value

getTaxType

getTaxType() : String

Gets the tax type.

Returns:

the tax type