ePages 6.11.0 - DE_EPAGES/Tax/API/Table/TaxAreaCountry.pm

Package DE_EPAGES::Tax::API::Table::TaxAreaCountry

interface for table TaxAreaCountry

@EXPORT_OK
InsertTaxAreaCountry
UpdateTaxAreaCountry
DeleteTaxAreaCountry
GetAllPKeyTaxAreaCountries
GetAllInfoTaxAreaCountries
GetInfoTaxAreaCountry
ExistsTaxAreaCountry
GetPKeyTaxAreaCountriesByTaxAreaID
GetInfoTaxAreaCountriesByTaxAreaID
GetPKeyTaxAreaCountriesByTaxMatrixID
GetInfoTaxAreaCountriesByTaxMatrixID

Functions

DeleteTaxAreaCountry
ExistsTaxAreaCountry
GetAllInfoTaxAreaCountries
GetAllPKeyTaxAreaCountries
GetInfoTaxAreaCountriesByTaxAreaID
GetInfoTaxAreaCountriesByTaxMatrixID
GetInfoTaxAreaCountry
GetPKeyTaxAreaCountriesByTaxAreaID
GetPKeyTaxAreaCountriesByTaxMatrixID
InsertTaxAreaCountry
OnDeleteCountry
OnDeleteShopCountry
UpdateTaxAreaCountry

DeleteTaxAreaCountry

Deletes a(n) TaxAreaCountry.

Syntax
DeleteTaxAreaCountry($TaxAreaCountryID);
DeleteTaxAreaCountry($hTaxAreaCountry); # if $hTaxAreaCountry includes TaxAreaCountryID
Input
$TaxAreaCountryID (int)
identifier for taxarea for country (primary key)

ExistsTaxAreaCountry

Returns true if the TaxAreaCountry exists.

Syntax
$exists = ExistsTaxAreaCountry($TaxAreaCountryID);
Input
$TaxAreaCountryID (int)
identifier for taxarea for country
Return
$exists (boolean)
1/0 the TaxAreaCountry exists (yes/no)

GetAllInfoTaxAreaCountries

Returns all objects of TaxAreaCountry.

Syntax
$ahTaxAreaCountrys = GetAllInfoTaxAreaCountries();
Return
$ahTaxAreaCountrys (reference to array of hashes)
with following keys:
  • TaxAreaCountryID - identifier for taxarea for country (primary key)- int
  • TaxMatrixID - tax matrix id - int
  • CountryID - country id - int
  • TaxAreaID - tax area id - int
  • ZipcodeFrom - min zipcode (optional)- varchar(25)
  • ZipcodeTo - max zipcode (optional)- varchar(25)
  • RegionName - name for region given by zipcodes (optional)- varchar(255)

GetAllPKeyTaxAreaCountries

Returns all TaxAreaCountry identifiers.

Syntax
$aTaxAreaCountryIDs = GetAllPKeyTaxAreaCountries();
Return
$aTaxAreaCountryIDs (reference to array of int)
identifier for taxarea for country

GetInfoTaxAreaCountriesByTaxAreaID

Returns objects of TaxAreaCountry by alternate key TaxAreaID.

Syntax
$ahTaxAreaCountries = GetInfoTaxAreaCountriesByTaxAreaID($TaxAreaID);
Input
$TaxAreaID (int)
tax area id
Return
$ahTaxAreaCountries (reference to array of hashes)
with following keys:
  • TaxAreaCountryID - identifier for taxarea for country (primary key)- int
  • TaxMatrixID - tax matrix id - int
  • CountryID - country id - int
  • TaxAreaID - tax area id - int
  • ZipcodeFrom - min zipcode (optional)- varchar(25)
  • ZipcodeTo - max zipcode (optional)- varchar(25)
  • RegionName - name for region given by zipcodes (optional)- varchar(255)

GetInfoTaxAreaCountriesByTaxMatrixID

Returns objects of TaxAreaCountry by alternate keys TaxMatrixID and CountryID.

Syntax
$ahTaxAreaCountries = GetInfoTaxAreaCountriesByTaxMatrixID($TaxMatrixID, $CountryID);
Input
$TaxMatrixID (int)
tax matrix id
$CountryID (int)
country id (optional)
Return
$ahTaxAreaCountries (reference to array of hashes)
with following keys:
  • TaxAreaCountryID - identifier for taxarea for country (primary key)- int
  • TaxMatrixID - tax matrix id - int
  • CountryID - country id - int
  • TaxAreaID - tax area id - int
  • ZipcodeFrom - min zipcode (optional)- varchar(25)
  • ZipcodeTo - max zipcode (optional)- varchar(25)
  • RegionName - name for region given by zipcodes (optional)- varchar(255)

GetInfoTaxAreaCountry

Returns the TaxAreaCountry by identifier.

Syntax
$hTaxAreaCountry = GetInfoTaxAreaCountry($TaxAreaCountryID);
Input
$TaxAreaCountryID (int)
identifier for taxarea for country (primary key)
Return
$hTaxAreaCountry (reference to hash)
with following keys:
  • TaxAreaCountryID - identifier for taxarea for country (primary key)- int
  • TaxMatrixID - tax matrix id - int
  • CountryID - country id - int
  • TaxAreaID - tax area id - int
  • ZipcodeFrom - min zipcode (optional)- varchar(25)
  • ZipcodeTo - max zipcode (optional)- varchar(25)
  • RegionName - name for region given by zipcodes (optional)- varchar(255)

GetPKeyTaxAreaCountriesByTaxAreaID

Returns primary keys of TaxAreaCountry by alternate key TaxAreaID.

Syntax
$aKeys = GetPKeyTaxAreaCountriesByTaxAreaID($TaxAreaID);
Input
$TaxAreaID (int)
tax area id
Return
$aKeys (reference to array of int)
identifier for taxarea for country (primary key)

GetPKeyTaxAreaCountriesByTaxMatrixID

Returns primary keys of TaxAreaCountry by alternate keys TaxMatrixID and CountryID.

Syntax
$aKeys = GetPKeyTaxAreaCountriesByTaxMatrixID($TaxMatrixID, $CountryID);
Input
$TaxMatrixID (int)
tax matrix id
$CountryID (int)
country id (optional)
Return
$aKeys (reference to array of int)
identifier for taxarea for country (primary key)

InsertTaxAreaCountry

Creates an entry of TaxAreaCountry.

Syntax
$TaxAreaCountryID = InsertTaxAreaCountry($hTaxAreaCountry);
Input
$hTaxAreaCountry (reference to hash)
with following keys:
  • TaxAreaCountryID - identifier for taxarea for country (primary key)(optional)- int
  • TaxMatrixID - tax matrix id - int
  • CountryID - country id - int
  • TaxAreaID - tax area id - int
  • ZipcodeFrom - min zipcode (optional)- varchar(25)
  • ZipcodeTo - max zipcode (optional)- varchar(25)
  • RegionName - name for region given by zipcodes (optional)- varchar(255)
Return
$TaxAreaCountryID (int)
identifier for taxarea for country (primary key)

OnDeleteCountry

Deletes TaxAreaCountry of this model when a(n) Country is deleted.

Syntax
OnDeleteCountry($hParams);
Input
$hParams (ref.hash.*)
primary key of object Country, key is
  • CountryID

OnDeleteShopCountry

Deletes TaxAreaCountry of this model when a(n) Country is deleted.

Syntax
OnDeleteShopCountry($hParams);
Input
$hParams (ref.hash.*)
primary key of object Country, key is
  • CountryID

UpdateTaxAreaCountry

Updates a(n) TaxAreaCountry if any element was changed.

Syntax
UpdateTaxAreaCountry($TaxAreaCountryID, $hTaxAreaCountry);
UpdateTaxAreaCountry($hTaxAreaCountry); # if $hTaxAreaCountry includes TaxAreaCountryID
Input
$TaxAreaCountryID (int)
identifier for taxarea for country (primary key)
$hTaxAreaCountry (reference to hash)
with following keys:
  • TaxMatrixID - tax matrix id - int
  • CountryID - country id - int
  • TaxAreaID - tax area id - int
  • ZipcodeFrom - min zipcode (optional)- varchar(25)
  • ZipcodeTo - max zipcode (optional)- varchar(25)
  • RegionName - name for region given by zipcodes (optional)- varchar(255)