diff options
Diffstat (limited to 'htdocs/docs/man/cust_main_county.txt')
-rw-r--r-- | htdocs/docs/man/cust_main_county.txt | 67 |
1 files changed, 67 insertions, 0 deletions
diff --git a/htdocs/docs/man/cust_main_county.txt b/htdocs/docs/man/cust_main_county.txt new file mode 100644 index 000000000..8e99397cc --- /dev/null +++ b/htdocs/docs/man/cust_main_county.txt @@ -0,0 +1,67 @@ +NAME + FS::cust_main_county - Object methods for cust_main_county + objects + +SYNOPSIS + use FS::cust_main_county; + + $record = create FS::cust_main_county \%hash; + $record = create FS::cust_main_county { 'column' => 'value' }; + + $error = $record->insert; + + $error = $new_record->replace($old_record); + + $error = $record->delete; + + $error = $record->check; + +DESCRIPTION + An FS::cust_main_county object represents a tax rate, defined by + locale. FS::cust_main_county inherits from FS::Record. The + following fields are currently supported: + + taxnum - primary key (assigned automatically for new tax rates) + state + county + tax - percentage +METHODS + create HASHREF + Creates a new tax rate. To add the tax rate to the database, + see the section on "insert". + + insert + Adds this tax rate to the database. If there is an error, + returns the error, otherwise returns false. + + delete + Deletes this tax rate from the database. If there is an + error, returns the error, otherwise returns false. + + 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 tax rate. If + there is an error, returns the error, otherwise returns + false. Called by the insert and replace methods. + +BUGS + It doesn't properly override FS::Record yet. + + A country field (and possibly a currency field) should be added. + +SEE ALSO + the FS::Record manpage, the FS::cust_main manpage, the + FS::cust_bill manpage, schema.html from the base documentation. + +HISTORY + ivan@voicenet.com 97-dec-16 + + Changed check for 'tax' to use the new ut_float subroutine + bmccane@maxbaud.net 98-apr-3 + + pod ivan@sisd.com 98-sep-21 + |