Initial revision
[freeside.git] / htdocs / docs / man / cust_main_county.txt
1 NAME
2     FS::cust_main_county - Object methods for cust_main_county
3     objects
4
5 SYNOPSIS
6       use FS::cust_main_county;
7
8       $record = create FS::cust_main_county \%hash;
9       $record = create FS::cust_main_county { 'column' => 'value' };
10
11       $error = $record->insert;
12
13       $error = $new_record->replace($old_record);
14
15       $error = $record->delete;
16
17       $error = $record->check;
18
19 DESCRIPTION
20     An FS::cust_main_county object represents a tax rate, defined by
21     locale. FS::cust_main_county inherits from FS::Record. The
22     following fields are currently supported:
23
24     taxnum - primary key (assigned automatically for new tax rates)
25     state
26     county
27     tax - percentage
28 METHODS
29     create HASHREF
30         Creates a new tax rate. To add the tax rate to the database,
31         see the section on "insert".
32
33     insert
34         Adds this tax rate to the database. If there is an error,
35         returns the error, otherwise returns false.
36
37     delete
38         Deletes this tax rate from the database. If there is an
39         error, returns the error, otherwise returns false.
40
41     replace OLD_RECORD
42         Replaces the OLD_RECORD with this one in the database. If
43         there is an error, returns the error, otherwise returns
44         false.
45
46     check
47         Checks all fields to make sure this is a valid tax rate. If
48         there is an error, returns the error, otherwise returns
49         false. Called by the insert and replace methods.
50
51 BUGS
52     It doesn't properly override FS::Record yet.
53
54     A country field (and possibly a currency field) should be added.
55
56 SEE ALSO
57     the FS::Record manpage, the FS::cust_main manpage, the
58     FS::cust_bill manpage, schema.html from the base documentation.
59
60 HISTORY
61     ivan@voicenet.com 97-dec-16
62
63     Changed check for 'tax' to use the new ut_float subroutine
64     bmccane@maxbaud.net 98-apr-3
65
66     pod ivan@sisd.com 98-sep-21
67