3 <TITLE>FS::cust_main_invoice - Object methods for cust_main_invoice records</TITLE>
4 <LINK REV="made" HREF="mailto:ivan@rootwood.sisd.com">
13 <LI><A HREF="#NAME">NAME</A>
14 <LI><A HREF="#SYNOPSIS">SYNOPSIS</A>
15 <LI><A HREF="#DESCRIPTION">DESCRIPTION</A>
16 <LI><A HREF="#METHODS">METHODS</A>
17 <LI><A HREF="#VERSION">VERSION</A>
18 <LI><A HREF="#BUGS">BUGS</A>
19 <LI><A HREF="#SEE_ALSO">SEE ALSO</A>
25 <H1><A NAME="NAME">NAME</A></H1>
27 FS::cust_main_invoice - Object methods for cust_main_invoice records
31 <H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
33 <PRE> use FS::cust_main_invoice;
36 <PRE> $record = new FS::cust_main_invoice \%hash;
37 $record = new FS::cust_main_invoice { 'column' => 'value' };
40 <PRE> $error = $record->insert;
43 <PRE> $error = $new_record->replace($old_record);
46 <PRE> $error = $record->delete;
49 <PRE> $error = $record->check;
52 <PRE> $email_address = $record->address;
56 <H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
58 An FS::cust_main_invoice object represents an invoice destination.
59 FS::cust_main_invoice inherits from FS::Record. The following fields are
63 <DT><STRONG><A NAME="item_destnum">destnum - primary key</A></STRONG><DD>
64 <DT><STRONG><A NAME="item_custnum">custnum - customer (see FS::cust_main)</A></STRONG><DD>
65 <DT><STRONG><A NAME="item_dest">dest - Invoice destination: If numeric, a <a href="#svc_acct">svcnum</a>, if string, a literal email address, or `POST' to enable mailing (the default if no cust_main_invoice records exist)</A></STRONG><DD>
69 <H1><A NAME="METHODS">METHODS</A></H1>
71 <DT><STRONG><A NAME="item_new">new HASHREF</A></STRONG><DD>
73 Creates a new invoice destination. To add the invoice destination to the
74 database, see <A HREF="#insert">insert</A>.
77 Note that this stores the hash reference, not a distinct copy of the hash
78 it points to. You can ask the object for a copy with the <EM>hash</EM> method.
80 <DT><STRONG><A NAME="item_insert">insert</A></STRONG><DD>
82 Adds this record to the database. If there is an error, returns the error,
83 otherwise returns false.
85 <DT><STRONG><A NAME="item_delete">delete</A></STRONG><DD>
87 Delete this record from the database.
89 <DT><STRONG><A NAME="item_replace">replace OLD_RECORD</A></STRONG><DD>
91 Replaces the OLD_RECORD with this one in the database. If there is an
92 error, returns the error, otherwise returns false.
94 <DT><STRONG><A NAME="item_check">check</A></STRONG><DD>
96 Checks all fields to make sure this is a valid invoice destination. If
97 there is an error, returns the error, otherwise returns false. Called by
98 the insert and repalce methods.
100 <DT><STRONG><A NAME="item_checkdest">checkdest</A></STRONG><DD>
102 Checks the dest field only.
104 <DT><STRONG><A NAME="item_address">address</A></STRONG><DD>
106 Returns the literal email address for this record (or `POST').
111 <H1><A NAME="VERSION">VERSION</A></H1>
113 $Id: cust_main_invoice.html,v 1.1 1999-08-04 12:13:27 ivan Exp $
117 <H1><A NAME="BUGS">BUGS</A></H1>
120 <H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
122 <A HREF="../FS/Record.html">FS::Record</A>, <A HREF="../FS/cust_main.html">FS::cust_main</A>