Freeside:1.7:Documentation:Developer/FS/cust tax exempt
From Freeside
Contents
NAME
FS::cust_tax_exempt - Object methods for cust_tax_exempt records
SYNOPSIS
use FS::cust_tax_exempt; $record = new FS::cust_tax_exempt \%hash; $record = new FS::cust_tax_exempt { 'column' => 'value' }; $error = $record->insert; $error = $new_record->replace($old_record); $error = $record->delete; $error = $record->check;
DESCRIPTION
An FS::cust_tax_exempt object represents a record of an old-style customer tax exemption. Currently this is only used for "texas tax". FS::cust_tax_exempt inherits from FS::Record. The following fields are currently supported:
- exemptnum - primary key; custnum - customer (see FS::cust_main); taxnum - tax rate (see FS::cust_main_county); year; month; amount
NOTE
Old-style customer tax exemptions are only useful for legacy migrations - if you are looking for current customer tax exemption data see FS::cust_tax_exempt_pkg.
METHODS
- new HASHREF
- Creates a new exemption record. To add the example 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 example. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
- cust_main_county
- Returns the FS::cust_main_county object associated with this tax exemption.
BUGS
Texas tax is a royal pain in the ass.
SEE ALSO
FS::cust_main_county, FS::cust_main, FS::Record, schema.html from the base documentation.