ePages 6.11.0 - DE_EPAGES/Tax/API/Object/TaxArea.pm

Package DE_EPAGES::Tax::API::Object::TaxArea

object interface for TaxArea.

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

Functions

addCountry
className
countries
dbPackage
existsCountry
exportXMLElements
removeCountry

addCountry

Adds a Country to the TaxArea.

Syntax
$TaxArea->addCountry($CountryID);
Example
$TaxArea->addCountry(4);
Input
$CountryID (int)
Country identifier
$Zipcode (string)
zipcode (optional)
$ZipcodeTo (string)
max zipcode (optional)
$RegionName (string)
name for the region given by zipcodes (optional)

className

Returns the class name, used for DAL access.

Syntax
$ClassName = $TaxArea->className;
Return
$ClassName (String)
class name

countries

Returns all countries that are assigned to the TaxArea.

Syntax
$aCountryID = $TaxArea->countries;
Return
$aCountryID (ref.array.cahr(3))
list of country identifiers

dbPackage

Returns the database package, used for DAL access.

Syntax
$DbPackage = $TaxArea->dbPackage;
Return
$DbPackage (String)
database package name

existsCountry

Asks if a Country exists for the TaxArea.

Syntax
$TaxArea->existsCountry($CountryID);
Input
$CountryID (integer)
Country identifier
$Zipcode (string)
zipcode (optional)
$ZipcodeTo (string)
max zipcode (optional)
$SameCodes (boolean)
true to check if area with same from and to values exists (optional)
$TaxAreaCountryID (integer)
taxareacountry identifier (optional)
Return
$exists (int)
Returns true if exists country

exportXMLElements

add tax rates elements of tax class

Syntax
$Object->exportXMLElements($Driver, $allAttributes);

removeCountry

Removes a Country from the TaxArea.

Syntax
$TaxArea->removeCountry($CountryID, $ZipcodeFrom, $ZipcodeTo);
Input
$CountryID (int)
Country identifier
$Zipcode (string)
zipcode (optional)
$ZipcodeTo (string)
max zipcode (optional)