Difference between revisions of "Freeside:3:Documentation:Developer/FS/cust tax location"
From Freeside
m (Edit via perl MediaWiki framework (1.13)) |
m (Edit via perl MediaWiki framework (1.13)) |
||
| Line 18: | Line 18: | ||
</code> | </code> | ||
==DESCRIPTION== | ==DESCRIPTION== | ||
| − | An FS::cust_tax_location object represents a | + | An FS::cust_tax_location object represents a mapping between a customer and a tax location. FS::cust_tax_location inherits from FS::Record. The following fields are currently supported: |
| − | + | ; custlocationnum | |
| − | + | :primary key | |
| − | + | ; data_vendor | |
| − | + | :a tax data vendor | |
| − | + | ; zip; state; plus4hi | |
| + | :the upper bound of the last 4 zip code digits | ||
| + | ; plus4lo | ||
| + | :the lower bound of the last 4 zip code digits | ||
| + | ; default_location | ||
| + | :'Y' when this record represents the default for zip | ||
| + | ; geocode - the foreign key into FS::part_pkg_tax_rate and FS::tax_rate | ||
==METHODS== | ==METHODS== | ||
; new HASHREF | ; new HASHREF | ||
| Line 38: | Line 44: | ||
; check | ; check | ||
:Checks all fields to make sure this is a valid cust_tax_location. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods. | :Checks all fields to make sure this is a valid cust_tax_location. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==BUGS== | ==BUGS== | ||
| − | + | The author should be informed of any you find. | |
==SEE ALSO== | ==SEE ALSO== | ||
[[Freeside:3:Documentation:Developer/FS/Record|FS::Record]], schema.html from the base documentation. | [[Freeside:3:Documentation:Developer/FS/Record|FS::Record]], schema.html from the base documentation. | ||
Latest revision as of 09:59, 10 April 2015
Contents
NAME
FS::cust_tax_location - Object methods for cust_tax_location records
SYNOPSIS
use FS::cust_tax_location;
$record = new FS::cust_tax_location \%hash;
$record = new FS::cust_tax_location { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
DESCRIPTION
An FS::cust_tax_location object represents a mapping between a customer and a tax location. FS::cust_tax_location inherits from FS::Record. The following fields are currently supported:
- custlocationnum
- primary key
- data_vendor
- a tax data vendor
- zip; state; plus4hi
- the upper bound of the last 4 zip code digits
- plus4lo
- the lower bound of the last 4 zip code digits
- default_location
- 'Y' when this record represents the default for zip
- geocode - the foreign key into FS::part_pkg_tax_rate and FS::tax_rate
METHODS
- new HASHREF
- Creates a new cust_tax_location. To add the cust_tax_location 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 cust_tax_location. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
BUGS
The author should be informed of any you find.
SEE ALSO
FS::Record, schema.html from the base documentation.
