Difference between revisions of "Freeside:3:Documentation:Developer/FS/cust tax adjustment"

Latest revision as of 20:04, 27 June 2012

NAME

FS::cust_tax_adjustment - Object methods for cust_tax_adjustment records

SYNOPSIS

 use FS::cust_tax_adjustment;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::cust_tax_adjustment object represents an taxation adjustment. FS::cust_tax_adjustment inherits from FS::Record. The following fields are currently supported:

adjustmentnum

primary key

custnum

custnum

taxname

taxname

amount

amount

comment

comment

billpkgnum

billpkgnum

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::Record, schema.html from the base documentation.