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

Revision as of 10:57, 30 March 2015

NAME

FS::part_pkg_taxclass - Object methods for part_pkg_taxclass records

SYNOPSIS

 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;

DESCRIPTION

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:

taxclassnum

Primary key

taxclass

Tax class

disabled

Disabled flag, empty or 'Y'

METHODS

new HASHREF

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.

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 class. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

BUGS

Other tables (cust_main_county, part_pkg, agent_payment_gateway) have a text taxclass instead of a key to this table.

SEE ALSO

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