Class TaxGroup

• TopLevel.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.

Property Summary 

Property	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.

Constructor Summary 

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

Method Summary 

Method	Description
static create(String, String, String, Decimal)	Creates a TaxGroup.
getCaption()	Gets the caption.
getDescription()	Gets the description.
getRate()	Gets the percentage amount of the rate.
getTaxType()	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

Property Details 

caption 

caption: String (read-only)

Gets the caption.

---

description 

description: String (read-only)

Gets the description.

---

rate 

rate: Number (read-only)

Gets the percentage amount of the rate.

---

taxType 

taxType: String (read-only)

Gets the tax type.

---

Method Details 

create(String, String, String, Decimal) 

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

---