ePages 6.17.40 - DE_EPAGES/TaxUS/API/Object/TaxMatrixUS.pm

Package DE_EPAGES::TaxUS::API::Object::TaxMatrixUS

object interface for TaxMatrixUS.

Base
DE_EPAGES::Object::API::Object::Object

Functions

clone
defaultTaxArea
defaultTaxClass
taxRate

clone

Inserts a new object into the database as copy from old object. This function copies also tax rates of the matrix, which are no objects.

Syntax
$Clone = $Object->clone( $hInfo );
$Clone = $Object->clone( $hInfo, $Recursive );
Input
$hInfo (hash ref)
hash with mandatory attribute values.
  • ClassID - class id - int
  • Alias - alias - varchar(255)
  • ParentID - parent objectid - int
  • Inherit - (optional) inherit permissions from parent object - boolean
$Recursive (boolean)
clone child object too (optional, default is false)
Return
$Clone (object)
the new object

defaultTaxArea

Gets the default tax area of the matrix

Syntax
$TaxArea = $TaxMatrixUS->defaultTaxAreaUS;
Return
$AreaUS (object)
tax area us

defaultTaxClass

Gets the default tax class of the matrix

Syntax
$TaxClass = $TaxMatrixUS->defaultTaxClass;
Return
$TaxClassUS (object)
tax class us

taxRate

Tax rate of matrix defined by tax area and class.

Syntax
$TaxRate = $TaxMatrix->taxRate($Area, $Class);
Input
$Area (object)
tax area
$Class (object)
tax class
Return
$TaxRate (float)
percentage of tax (eg 0.16 for 16 %)