regenerated perl api docs from embedded pod
[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 = new FS::cust_main_county \%hash;
9       $record = new 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     country
28     tax - percentage
29 METHODS
30     new HASHREF
31         Creates a new tax rate. To add the tax rate to the database,
32         see the section on "insert".
33
34     insert
35         Adds this tax rate to the database. If there is an error,
36         returns the error, otherwise returns false.
37
38     delete
39         Deletes this tax rate from the database. If there is an
40         error, returns the error, otherwise returns false.
41
42     replace OLD_RECORD
43         Replaces the OLD_RECORD with this one in the database. If
44         there is an error, returns the error, otherwise returns
45         false.
46
47     check
48         Checks all fields to make sure this is a valid tax rate. If
49         there is an error, returns the error, otherwise returns
50         false. Called by the insert and replace methods.
51
52 VERSION
53     $Id: cust_main_county.txt,v 1.3 1999-04-08 13:39:32 ivan Exp $
54
55 BUGS
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
68     $Log: cust_main_county.txt,v $
69     Revision 1.3  1999-04-08 13:39:32  ivan
70     convert from pod for 1.2.0 release
71  Revision 1.3 1998/12/29 11:59:41
72     ivan mostly properly OO, some work still to be done with svc_
73     stuff
74
75     Revision 1.2 1998/11/18 09:01:43 ivan i18n! i18n!
76