Freeside:3:Documentation:Developer/FS/part pkg taxoverride

From Freeside
< Freeside:3:Documentation:Developer‎ | FS
Revision as of 20:05, 27 June 2012 by Ivan (talk | contribs) (Edit via perl MediaWiki framework (1.13))

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

NAME

FS::part_pkg_taxoverride - Object methods for part_pkg_taxoverride records

SYNOPSIS

 use FS::part_pkg_taxoverride;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::part_pkg_taxoverride object represents a manual mapping of a package to tax rates. FS::part_pkg_taxoverride inherits from FS::Record. The following fields are currently supported:

taxoverridenum
Primary key
pkgpart
The package definition id
taxclassnum
The tax class id

METHODS

new HASHREF
Creates a new tax override. 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.

BUGS

SEE ALSO

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