% include( '/elements/header.html', 'Developer Documentation' ) %> <& /elements/menubar.html, 'Freeside Perl Modules' => $fsurl.'docs/library/FS.html', 'Complete Index' => $fsurl.'docs/library/index.html', &>
FS::part_pkg_taxclass - Object methods for part_pkg_taxclass records
use FS::part_pkg_taxclass;
$record = new FS::part_pkg_taxclass \%hash;
$record = new FS::part_pkg_taxclass { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
An FS::part_pkg_taxclass object declares the existence of a taxable sales class. FS::part_pkg_taxclass inherits from FS::Record.
FS::part_pkg_taxclass is not used in tax calculation. It is only used to list a set of valid tax class names for use in the user interface. When using internal taxes, the actual matching of tax definitions to package tax class is a string match between tax class names. This is arguably a bug.
The following fields are currently supported:
Primary key
Tax class
Disabled flag, empty or 'Y'
Creates a new tax class. To add the tax class 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.
Adds this record to the database. If there is an error, returns the error, otherwise returns false.
Delete this record from the database.
Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false.
Checks all fields to make sure this is a valid tax class. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
Returns a list of all the non-disabled tax classes. If tax classes aren't enabled, returns a single empty string.
Other tables (cust_main_county, part_pkg, agent_payment_gateway) have a text taxclass instead of a key to this table.
FS::Record, schema.html from the base documentation.
Hey! The above document had some coding errors, which are explained below:
You forgot a '=back' before '=head1'