htdocs/docs/man/FS/cust_bill_pkg.html

   1 <HTML>
   2 <HEAD>
   3 <TITLE>FS::cust_bill_pkg - Object methods for cust_bill_pkg records</TITLE>
   4 <LINK REV="made" HREF="mailto:ivan@rootwood.sisd.com">
   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_bill_pkg - Object methods for cust_bill_pkg records
  28
  29 <P>
  30 <HR>
  31 <H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
  32 <P>
  33 <PRE>  use FS::cust_bill_pkg;
  34 </PRE>
  35 <P>
  36 <PRE>  $record = new FS::cust_bill_pkg \%hash;
  37   $record = new FS::cust_bill_pkg { '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 <HR>
  53 <H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
  54 <P>
  55 An FS::cust_bill_pkg object represents an invoice line item.
  56 FS::cust_bill_pkg inherits from FS::Record. The following fields are
  57 currently supported:
  58
  59 <DL>
  60 <DT><STRONG><A NAME="item_invnum">invnum - invoice (see FS::cust_bill)</A></STRONG><DD>
  61 <DT><STRONG><A NAME="item_pkgnum">pkgnum - package (see FS::cust_pkg)</A></STRONG><DD>
  62 <DT><STRONG><A NAME="item_setup">setup - setup fee</A></STRONG><DD>
  63 <DT><STRONG><A NAME="item_recur">recur - recurring fee</A></STRONG><DD>
  64 <DT><STRONG><A NAME="item_sdate">sdate - starting date of recurring fee</A></STRONG><DD>
  65 <DT><STRONG><A NAME="item_edate">edate - ending date of recurring fee</A></STRONG><DD>
  66 </DL>
  67 <P>
  68 sdate and edate are specified as UNIX timestamps; see <EM>perlfunc</EM>. Also see <A HREF="../Time/Local.html">Time::Local</A> and <A HREF="../Date/Parse.html">Date::Parse</A> for conversion functions.
  69
  70 <P>
  71 <HR>
  72 <H1><A NAME="METHODS">METHODS</A></H1>
  73 <DL>
  74 <DT><STRONG><A NAME="item_new">new HASHREF</A></STRONG><DD>
  75 <P>
  76 Creates a new line item. To add the line item to the database, see
  77 <A HREF="#insert">insert</A>. Line items are normally created by calling the bill method of a customer
  78 object (see <A HREF="../FS/cust_main.html">FS::cust_main</A>).
  79
  80 <DT><STRONG><A NAME="item_insert">insert</A></STRONG><DD>
  81 <P>
  82 Adds this line item to the database. If there is an error, returns the
  83 error, otherwise returns false.
  84
  85 <DT><STRONG><A NAME="item_delete">delete</A></STRONG><DD>
  86 <P>
  87 Currently unimplemented. I don't remove line items because there would then
  88 be no record the items ever existed (which is bad, no?)
  89
  90 <DT><STRONG><A NAME="item_replace">replace OLD_RECORD</A></STRONG><DD>
  91 <P>
  92 Currently unimplemented. This would be even more of an accounting nightmare
  93 than deleteing the items. Just don't do it.
  94
  95 <DT><STRONG><A NAME="item_check">check</A></STRONG><DD>
  96 <P>
  97 Checks all fields to make sure this is a valid line item. If there is an
  98 error, returns the error, otherwise returns false. Called by the insert
  99 method.
 100
 101 </DL>
 102 <P>
 103 <HR>
 104 <H1><A NAME="VERSION">VERSION</A></H1>
 105 <P>
 106 $Id: cust_bill_pkg.html,v 1.1 1999-08-04 12:13:27 ivan Exp $
 107
 108 <P>
 109 <HR>
 110 <H1><A NAME="BUGS">BUGS</A></H1>
 111 <P>
 112 <HR>
 113 <H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
 114 <P>
 115 <A HREF="../FS/Record.html">FS::Record</A>, <A HREF="../FS/cust_bill.html">FS::cust_bill</A>, <A HREF="../FS/cust_pkg.html">FS::cust_pkg</A>, <A HREF="../FS/cust_main.html">FS::cust_main</A>, schema.html from the base documentation.
 116
 117 </BODY>
 118
 119 </HTML>