Freeside:3:Documentation:Developer/FS/tax class

From Freeside
< Freeside:3:Documentation:Developer‎ | FS
Revision as of 20:06, 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::tax_class - Object methods for tax_class records

SYNOPSIS

 use FS::tax_class;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

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

taxclassnum
Primary key
data_vendor
Vendor of the tax data
taxclass
Tax class
description
Human readable description of the tax class

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.
batch_import
Loads part_pkg_taxrate records from an external CSV file. If there is an error, returns the error, otherwise returns false.

BUGS

 batch_import does not handle mixed I and D records in the same file for
 format cch-update

SEE ALSO

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