Package DE_EPAGES::TaxUSSystemDB::API::Table::Zip2TaxUS
interface for table Zip2TaxUS
Functions
- DeleteZip2TaxUS
- DeleteZip2TaxUSByVersion
- ExistsZip2TaxUS
- GetAllInfoZip2TaxUSs
- GetAllPKeyZip2TaxUSs
- GetInfoZip2TaxUS
- GetInfoZip2TaxUSsByCity
- GetInfoZip2TaxUSsBySalesTaxRate
- GetInfoZip2TaxUSsByState
- GetInfoZip2TaxUSsByVersion
- GetInfoZip2TaxUSsByZipCodePart
- GetPKeyZip2TaxUSsByCity
- GetPKeyZip2TaxUSsBySalesTaxRate
- GetPKeyZip2TaxUSsByState
- GetPKeyZip2TaxUSsByVersion
- GetPKeyZip2TaxUSsByZipCode
- GetSalesTaxRangeByState
- InsertZip2TaxUS
- UpdateZip2TaxUS
DeleteZip2TaxUS
Deletes a(n) Zip2TaxUS.
Syntax |
DeleteZip2TaxUS($ZipCode, $City, $State, $Version);
DeleteZip2TaxUS($hZip2TaxUS); # if $hZip2TaxUS includes ZipCode, City, State, Version
|
Input |
- $ZipCode (varchar(50))
- (part of primary key)
- $City (varchar(50))
- (part of primary key)
- $State (varchar(50))
- (part of primary key)
- $Version (char(7))
- (part of primary key)
|
DeleteZip2TaxUSByVersion
Removes all entries of table zip2taxusmeta with the given version.
Syntax |
$ahInfo = DeleteZip2TaxUSByVersion($State);
|
Input |
- $Version (char(7))
|
ExistsZip2TaxUS
Returns true if the Zip2TaxUS exists.
Syntax |
$exists = ExistsZip2TaxUS($ZipCode, $City, $State, $Version);
|
Input |
- $ZipCode (varchar(50))
- (part of primary key)
- $City (varchar(50))
- (part of primary key)
- $State (varchar(50))
- (part of primary key)
- $Version (char(7))
- (part of primary key)
|
Return |
- $exists (boolean)
- 1/0 the Zip2TaxUS exists (yes/no)
|
GetAllInfoZip2TaxUSs
Returns all objects of Zip2TaxUS.
Syntax |
$ahZip2TaxUSs = GetAllInfoZip2TaxUSs();
|
Return |
- $ahZip2TaxUSs (reference to array of hashes)
- with following keys:
- z2t_ID - (optional)- int
- ZipCode - (part of primary key)- varchar(50)
- SalesTaxRate - (optional)- float
- RateState - (optional)- float
- ReportingCodeState - (optional)- varchar(50)
- RateCounty - (optional)- float
- ReportingCodeCounty - (optional)- varchar(50)
- RateCity - (optional)- float
- ReportingCodeCity - (optional)- varchar(50)
- RateSpecialDistrict - (optional)- float
- ReportingCodeSpecialDistrict - (optional)- varchar(50)
- City - (part of primary key)- varchar(50)
- PostOffice - (optional)- varchar(50)
- State - (part of primary key)- varchar(50)
- County - (optional)- varchar(50)
- ShippingTaxable - (optional)- bit
- PrimaryRecord - (optional)- bit
- Version - (part of primary key)- char(7)
|
GetAllPKeyZip2TaxUSs
Returns all Zip2TaxUS identifiers.
Syntax |
$ahZip2TaxUSIDs = GetAllPKeyZip2TaxUSs();
|
Return |
- $ahZip2TaxUSIDs (reference to array of hashes)
- with following keys:
- ZipCode - (part of primary key)- varchar(50)
- City - (part of primary key)- varchar(50)
- State - (part of primary key)- varchar(50)
- Version - (part of primary key)- char(7)
|
GetInfoZip2TaxUS
Returns the Zip2TaxUS by identifier.
Syntax |
$hZip2TaxUS = GetInfoZip2TaxUS($ZipCode, $City, $State, $Version);
|
Input |
- $ZipCode (varchar(50))
- (part of primary key)
- $City (varchar(50))
- (part of primary key)
- $State (varchar(50))
- (part of primary key)
- $Version (char(7))
- (part of primary key)
|
Return |
- $hZip2TaxUS (reference to hash)
- with following keys:
- z2t_ID - (optional)- int
- ZipCode - (part of primary key)- varchar(50)
- SalesTaxRate - (optional)- float
- RateState - (optional)- float
- ReportingCodeState - (optional)- varchar(50)
- RateCounty - (optional)- float
- ReportingCodeCounty - (optional)- varchar(50)
- RateCity - (optional)- float
- ReportingCodeCity - (optional)- varchar(50)
- RateSpecialDistrict - (optional)- float
- ReportingCodeSpecialDistrict - (optional)- varchar(50)
- City - (part of primary key)- varchar(50)
- PostOffice - (optional)- varchar(50)
- State - (part of primary key)- varchar(50)
- County - (optional)- varchar(50)
- ShippingTaxable - (optional)- bit
- PrimaryRecord - (optional)- bit
- Version - (part of primary key)- char(7)
|
GetInfoZip2TaxUSsByCity
Returns objects of Zip2TaxUS by alternate key City.
Syntax |
$ahZip2TaxUSs = GetInfoZip2TaxUSsByCity($City);
|
Input |
- $City (varchar(50))
|
Return |
- $ahZip2TaxUSs (reference to array of hashes)
- with following keys:
- z2t_ID - (optional)- int
- ZipCode - (part of primary key)- varchar(50)
- SalesTaxRate - (optional)- float
- RateState - (optional)- float
- ReportingCodeState - (optional)- varchar(50)
- RateCounty - (optional)- float
- ReportingCodeCounty - (optional)- varchar(50)
- RateCity - (optional)- float
- ReportingCodeCity - (optional)- varchar(50)
- RateSpecialDistrict - (optional)- float
- ReportingCodeSpecialDistrict - (optional)- varchar(50)
- City - (part of primary key)- varchar(50)
- PostOffice - (optional)- varchar(50)
- State - (part of primary key)- varchar(50)
- County - (optional)- varchar(50)
- ShippingTaxable - (optional)- bit
- PrimaryRecord - (optional)- bit
- Version - (part of primary key)- char(7)
|
GetInfoZip2TaxUSsBySalesTaxRate
Returns objects of Zip2TaxUS by alternate key SalesTaxRate.
Syntax |
$ahZip2TaxUSs = GetInfoZip2TaxUSsBySalesTaxRate($SalesTaxRate);
|
Input |
- $SalesTaxRate (float)
|
Return |
- $ahZip2TaxUSs (reference to array of hashes)
- with following keys:
- z2t_ID - (optional)- int
- ZipCode - (part of primary key)- varchar(50)
- SalesTaxRate - (optional)- float
- RateState - (optional)- float
- ReportingCodeState - (optional)- varchar(50)
- RateCounty - (optional)- float
- ReportingCodeCounty - (optional)- varchar(50)
- RateCity - (optional)- float
- ReportingCodeCity - (optional)- varchar(50)
- RateSpecialDistrict - (optional)- float
- ReportingCodeSpecialDistrict - (optional)- varchar(50)
- City - (part of primary key)- varchar(50)
- PostOffice - (optional)- varchar(50)
- State - (part of primary key)- varchar(50)
- County - (optional)- varchar(50)
- ShippingTaxable - (optional)- bit
- PrimaryRecord - (optional)- bit
- Version - (part of primary key)- char(7)
|
GetInfoZip2TaxUSsByState
Returns objects of Zip2TaxUS by alternate key State.
Syntax |
$ahZip2TaxUSs = GetInfoZip2TaxUSsByState($State);
|
Input |
- $State (varchar(50))
|
Return |
- $ahZip2TaxUSs (reference to array of hashes)
- with following keys:
- z2t_ID - (optional)- int
- ZipCode - (part of primary key)- varchar(50)
- SalesTaxRate - (optional)- float
- RateState - (optional)- float
- ReportingCodeState - (optional)- varchar(50)
- RateCounty - (optional)- float
- ReportingCodeCounty - (optional)- varchar(50)
- RateCity - (optional)- float
- ReportingCodeCity - (optional)- varchar(50)
- RateSpecialDistrict - (optional)- float
- ReportingCodeSpecialDistrict - (optional)- varchar(50)
- City - (part of primary key)- varchar(50)
- PostOffice - (optional)- varchar(50)
- State - (part of primary key)- varchar(50)
- County - (optional)- varchar(50)
- ShippingTaxable - (optional)- bit
- PrimaryRecord - (optional)- bit
- Version - (part of primary key)- char(7)
|
GetInfoZip2TaxUSsByVersion
Returns objects of Zip2TaxUS by alternate key Version.
Syntax |
$ahZip2TaxUSs = GetInfoZip2TaxUSsByVersion($Version);
|
Input |
- $Version (char(7))
|
Return |
- $ahZip2TaxUSs (reference to array of hashes)
- with following keys:
- z2t_ID - (optional)- int
- ZipCode - (part of primary key)- varchar(50)
- SalesTaxRate - (optional)- float
- RateState - (optional)- float
- ReportingCodeState - (optional)- varchar(50)
- RateCounty - (optional)- float
- ReportingCodeCounty - (optional)- varchar(50)
- RateCity - (optional)- float
- ReportingCodeCity - (optional)- varchar(50)
- RateSpecialDistrict - (optional)- float
- ReportingCodeSpecialDistrict - (optional)- varchar(50)
- City - (part of primary key)- varchar(50)
- PostOffice - (optional)- varchar(50)
- State - (part of primary key)- varchar(50)
- County - (optional)- varchar(50)
- ShippingTaxable - (optional)- bit
- PrimaryRecord - (optional)- bit
- Version - (part of primary key)- char(7)
|
GetInfoZip2TaxUSsByZipCodePart
Returns objects of Zip2TaxUS by alternate key ZipCode.
Syntax |
$ahZip2TaxUSs = GetInfoZip2TaxUSsByZipCodePart($ZipCode);
|
Input |
- $ZipCode (varchar(50))
|
Return |
- $ahZip2TaxUSs (reference to array of hashes)
- with following keys:
- z2t_ID - (optional)- int
- ZipCode - (part of primary key)- varchar(50)
- SalesTaxRate - (optional)- float
- RateState - (optional)- float
- ReportingCodeState - (optional)- varchar(50)
- RateCounty - (optional)- float
- ReportingCodeCounty - (optional)- varchar(50)
- RateCity - (optional)- float
- ReportingCodeCity - (optional)- varchar(50)
- RateSpecialDistrict - (optional)- float
- ReportingCodeSpecialDistrict - (optional)- varchar(50)
- City - (part of primary key)- varchar(50)
- PostOffice - (optional)- varchar(50)
- State - (part of primary key)- varchar(50)
- County - (optional)- varchar(50)
- ShippingTaxable - (optional)- bit
- PrimaryRecord - (optional)- bit
|
GetPKeyZip2TaxUSsByCity
Returns primary keys of Zip2TaxUS by alternate key City.
Syntax |
$ahKeys = GetPKeyZip2TaxUSsByCity($City);
|
Input |
- $City (varchar(50))
|
Return |
- $ahKeys (reference to array of hashes)
- with following keys:
- ZipCode - (part of primary key)- varchar(50)
- City - (part of primary key)- varchar(50)
- State - (part of primary key)- varchar(50)
- Version - (part of primary key)- char(7)
|
GetPKeyZip2TaxUSsBySalesTaxRate
Returns primary keys of Zip2TaxUS by alternate key SalesTaxRate.
Syntax |
$ahKeys = GetPKeyZip2TaxUSsBySalesTaxRate($SalesTaxRate);
|
Input |
- $SalesTaxRate (float)
|
Return |
- $ahKeys (reference to array of hashes)
- with following keys:
- ZipCode - (part of primary key)- varchar(50)
- City - (part of primary key)- varchar(50)
- State - (part of primary key)- varchar(50)
- Version - (part of primary key)- char(7)
|
GetPKeyZip2TaxUSsByState
Returns primary keys of Zip2TaxUS by alternate key State.
Syntax |
$ahKeys = GetPKeyZip2TaxUSsByState($State);
|
Input |
- $State (varchar(50))
|
Return |
- $ahKeys (reference to array of hashes)
- with following keys:
- ZipCode - (part of primary key)- varchar(50)
- City - (part of primary key)- varchar(50)
- State - (part of primary key)- varchar(50)
- Version - (part of primary key)- char(7)
|
GetPKeyZip2TaxUSsByVersion
Returns primary keys of Zip2TaxUS by alternate key Version.
Syntax |
$ahKeys = GetPKeyZip2TaxUSsByVersion($Version);
|
Input |
- $Version (char(7))
|
Return |
- $ahKeys (reference to array of hashes)
- with following keys:
- ZipCode - (part of primary key)- varchar(50)
- City - (part of primary key)- varchar(50)
- State - (part of primary key)- varchar(50)
- Version - (part of primary key)- char(7)
|
GetPKeyZip2TaxUSsByZipCode
Returns primary keys of Zip2TaxUS by alternate key ZipCode.
Syntax |
$ahKeys = GetPKeyZip2TaxUSsByZipCode($ZipCode);
|
Input |
- $ZipCode (varchar(50))
|
Return |
- $ahKeys (reference to array of hashes)
- with following keys:
- ZipCode - (part of primary key)- varchar(50)
- City - (part of primary key)- varchar(50)
- State - (part of primary key)- varchar(50)
- Version - (part of primary key)- char(7)
|
GetSalesTaxRangeByState
Returns primary keys of Zip2TaxUS by alternate key State.
Syntax |
$ahInfo = GetSalesTaxRangeByState($State);
|
Input |
- $State (varchar(50))
|
Return |
- $InfoZip2Tax (reference to array of hashes)
- with following keys:
- SalesTaxRateMin - float
- SalesTaxRateMax - float
- OriginBased - bit
|
InsertZip2TaxUS
Creates an entry of Zip2TaxUS.
Syntax |
InsertZip2TaxUS($hZip2TaxUS);
|
Input |
- $hZip2TaxUS (reference to hash)
- with following keys:
- z2t_ID - (optional)- int
- ZipCode - (part of primary key)- varchar(50)
- SalesTaxRate - (optional)- float
- RateState - (optional)- float
- ReportingCodeState - (optional)- varchar(50)
- RateCounty - (optional)- float
- ReportingCodeCounty - (optional)- varchar(50)
- RateCity - (optional)- float
- ReportingCodeCity - (optional)- varchar(50)
- RateSpecialDistrict - (optional)- float
- ReportingCodeSpecialDistrict - (optional)- varchar(50)
- City - (part of primary key)- varchar(50)
- PostOffice - (optional)- varchar(50)
- State - (part of primary key)- varchar(50)
- County - (optional)- varchar(50)
- ShippingTaxable - (optional)- bit
- PrimaryRecord - (optional)- bit
- Version - (part of primary key)- char(7)
|
UpdateZip2TaxUS
Updates a(n) Zip2TaxUS if any element was changed.
Syntax |
UpdateZip2TaxUS($ZipCode, $City, $State, $Version, $hZip2TaxUS);
UpdateZip2TaxUS($hZip2TaxUS); # if $hZip2TaxUS includes ZipCode, City, State, Version
|
Input |
- $ZipCode (varchar(50))
- (part of primary key)
- $City (varchar(50))
- (part of primary key)
- $State (varchar(50))
- (part of primary key)
- $Version (char(7))
- (part of primary key)
- $hZip2TaxUS (reference to hash)
- with following keys:
- z2t_ID - (optional)- int
- SalesTaxRate - (optional)- float
- RateState - (optional)- float
- ReportingCodeState - (optional)- varchar(50)
- RateCounty - (optional)- float
- ReportingCodeCounty - (optional)- varchar(50)
- RateCity - (optional)- float
- ReportingCodeCity - (optional)- varchar(50)
- RateSpecialDistrict - (optional)- float
- ReportingCodeSpecialDistrict - (optional)- varchar(50)
- PostOffice - (optional)- varchar(50)
- County - (optional)- varchar(50)
- ShippingTaxable - (optional)- bit
- PrimaryRecord - (optional)- bit
|