htdocs/docs/man/FS/cust_main_invoice.html

   1 <HTML>
   2 <HEAD>
   3 <TITLE>FS::cust_main_invoice - Object methods for cust_main_invoice records</TITLE>
   4 <LINK REV="made" HREF="mailto:none">
   5 </HEAD>
   6
   7 <BODY>
   8
   9 <!-- INDEX BEGIN -->
  10
  11 <UL>
  12
  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>
  20 </UL>
  21 <!-- INDEX END -->
  22
  23 <HR>
  24 <P>
  25 <H1><A NAME="NAME">NAME</A></H1>
  26 <P>
  27 FS::cust_main_invoice - Object methods for cust_main_invoice records
  28
  29 <P>
  30 <HR>
  31 <H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
  32 <P>
  33 <PRE>  use FS::cust_main_invoice;
  34 </PRE>
  35 <P>
  36 <PRE>  $record = new FS::cust_main_invoice \%hash;
  37   $record = new FS::cust_main_invoice { 'column' =&gt; 'value' };
  38 </PRE>
  39 <P>
  40 <PRE>  $error = $record-&gt;insert;
  41 </PRE>
  42 <P>
  43 <PRE>  $error = $new_record-&gt;replace($old_record);
  44 </PRE>
  45 <P>
  46 <PRE>  $error = $record-&gt;delete;
  47 </PRE>
  48 <P>
  49 <PRE>  $error = $record-&gt;check;
  50 </PRE>
  51 <P>
  52 <PRE>  $email_address = $record-&gt;address;
  53 </PRE>
  54 <P>
  55 <HR>
  56 <H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
  57 <P>
  58 An FS::cust_main_invoice object represents an invoice destination.
  59 FS::cust_main_invoice inherits from FS::Record. The following fields are
  60 currently supported:
  61
  62 <DL>
  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 &lt;a href=&quot;#svc_acct&quot;&gt;svcnum&lt;/a&gt;, if string, a literal email address, or `POST' to enable mailing (the default if no cust_main_invoice records exist)</A></STRONG><DD>
  66 </DL>
  67 <P>
  68 <HR>
  69 <H1><A NAME="METHODS">METHODS</A></H1>
  70 <DL>
  71 <DT><STRONG><A NAME="item_new">new HASHREF</A></STRONG><DD>
  72 <P>
  73 Creates a new invoice destination. To add the invoice destination to the
  74 database, see <A HREF="#insert">insert</A>.
  75
  76 <P>
  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.
  79
  80 <DT><STRONG><A NAME="item_insert">insert</A></STRONG><DD>
  81 <P>
  82 Adds this record to the database. If there is an error, returns the error,
  83 otherwise returns false.
  84
  85 <DT><STRONG><A NAME="item_delete">delete</A></STRONG><DD>
  86 <P>
  87 Delete this record from the database.
  88
  89 <DT><STRONG><A NAME="item_replace">replace OLD_RECORD</A></STRONG><DD>
  90 <P>
  91 Replaces the OLD_RECORD with this one in the database. If there is an
  92 error, returns the error, otherwise returns false.
  93
  94 <DT><STRONG><A NAME="item_check">check</A></STRONG><DD>
  95 <P>
  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.
  99
 100 <DT><STRONG><A NAME="item_checkdest">checkdest</A></STRONG><DD>
 101 <P>
 102 Checks the dest field only.
 103
 104 <DT><STRONG><A NAME="item_address">address</A></STRONG><DD>
 105 <P>
 106 Returns the literal email address for this record (or `POST').
 107
 108 </DL>
 109 <P>
 110 <HR>
 111 <H1><A NAME="VERSION">VERSION</A></H1>
 112 <P>
 113 $Id: cust_main_invoice.html,v 1.2 2000-03-03 18:22:43 ivan Exp $
 114
 115 <P>
 116 <HR>
 117 <H1><A NAME="BUGS">BUGS</A></H1>
 118 <P>
 119 <HR>
 120 <H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
 121 <P>
 122 <A HREF="../FS/Record.html">FS::Record</A>, <A HREF="../FS/cust_main.html">FS::cust_main</A>
 123
 124
 125
 126 </BODY>
 127
 128 </HTML>