Freeside:4:Documentation:Developer/FS/part pkg taxrate

From Freeside
Jump to: navigation, search

NAME

FS::part_pkg_taxrate - Object methods for part_pkg_taxrate records

SYNOPSIS

 use FS::part_pkg_taxrate;

 $record = new FS::part_pkg_taxrate \%hash;
 $record = new FS::part_pkg_taxrate { 'column' => 'value' };

 $error = $record->insert;

 $error = $new_record->replace($old_record);

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::part_pkg_taxrate object maps packages onto tax rates. FS::part_pkg_taxrate inherits from FS::Record. The following fields are currently supported:

pkgtaxratenum
Primary key
data_vendor
Tax data vendor
geocode
Tax vendor location code
taxproductnum
Class of package for tax purposes, Index into FS::part_pkg_taxproduct
city
city
county
county
state
state
local
local
country
country
taxclassnum
Class of tax index into FS::tax_taxclass and FS::tax_rate
taxclassnumtaxed
Class of tax taxed by this entry.
taxable
taxable
effdate
effdate

METHODS

new HASHREF
Creates a new customer (location), package, tax rate mapping. To add the mapping to the database, see "insert".
Note that this stores the hash reference, not a distinct copy of the hash it points to. You can ask the object for a copy with the hash method.
insert
Adds this record to the database. If there is an error, returns the error, otherwise returns false.
delete
Delete this record from the database.
replace OLD_RECORD
Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false.
check
Checks all fields to make sure this is a valid tax rate mapping. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
batch_import
Loads part_pkg_taxrate records from an external CSV file. If there is an error, returns the error, otherwise returns false.

BUGS

SEE ALSO

FS::Record, schema.html from the base documentation.