Freeside:3:Documentation:Developer/FS/quotation pkg tax

From Freeside
Jump to: navigation, search

NAME

FS::quotation_pkg_tax - Object methods for quotation_pkg_tax records

SYNOPSIS

 use FS::quotation_pkg_tax;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::quotation_pkg_tax object represents tax on a quoted package. FS::quotation_pkg_tax inherits from FS::Record (though it should eventually inherit from some shared superclass of FS::cust_bill_pkg_tax_location). The following fields are currently supported:

quotationtaxnum - primary key; quotationpkgnum - the FS::quotation_pkg record that the tax applies to.; itemdesc - the name of the tax; taxnum - the FS::cust_main_county or FS::tax_rate defining the tax.; taxtype - the class of the tax rate represented by taxnum.; setup_amount - the amount of tax calculated on one-time charges; recur_amount - the amount of tax calculated on recurring charges

METHODS

new HASHREF
Creates a new estimated tax amount. To add the record to the database, see "insert".
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 example. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

SEE ALSO

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