Freeside:3:Documentation:Developer/FS/tax status
From Freeside
Contents
NAME
FS::tax_status - Object methods for tax_status records
SYNOPSIS
use FS::tax_status;
$record = new FS::tax_status \%hash;
$record = new FS::tax_status { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
DESCRIPTION
An FS::tax_status object represents a customer tax status for use with an external tax table. FS::tax_status inherits from FS::Record. The following fields are currently supported:
- taxstatusnum
- primary key
- data_vendor
- Data vendor name (corresponds to the value of the taxproduct config variable.)
- taxstatus
- The data vendor's name or code for the tax status.
- description
- Description for use in the Freeside UI.
METHODS
- new HASHREF
- Creates a new tax status. To add the record to the database, see "insert".
- 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 example. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
SEE ALSO
FS::Record, schema.html from the base documentation.
