Difference between revisions of "Freeside:3:Documentation:Developer/FS/cust main exemption"

Revision as of 20:04, 27 June 2012

NAME

FS::cust_main_exemption - Object methods for cust_main_exemption records

SYNOPSIS

 use FS::cust_main_exemption;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::cust_main_exemption object represents a customer tax exemption from a specific tax name (prefix). FS::cust_main_exemption inherits from FS::Record. The following fields are currently supported:

exemptionnum

Primary key

custnum

Customer (see FS::cust_main)

taxname

taxname

exempt_number

Exemption number

METHODS

new HASHREF

Creates a new record. To add the record 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 record. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

BUGS

SEE ALSO

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