Difference between revisions of "Freeside:3:Documentation:Developer/FS/part pkg taxproduct"

Latest revision as of 13:37, 27 June 2014

NAME

FS::part_pkg_taxproduct - Object methods for part_pkg_taxproduct records

SYNOPSIS

 use FS::part_pkg_taxproduct;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::part_pkg_taxproduct object represents a tax product. FS::part_pkg_taxproduct inherits from FS::Record. The following fields are currently supported:

taxproductnum

Primary key

data_vendor

Tax data vendor

taxproduct

Tax product id from the vendor

description

A human readable description of the id in taxproduct

METHODS

new HASHREF

Creates a new tax product. To add the tax product 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 product. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

part_pkg_taxrate GEOCODE

Returns the FS::part_pkg_taxrate records (tax definitions) that can apply to this tax product category in the location identified by GEOCODE.

expand_cch_taxproduct

Returns the full set of part_pkg_taxproduct records that are "implied" by this one.

BUGS

Confusingly named. It has nothing to do with part_pkg.

SEE ALSO

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