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:perl@packages.debian.org">
   5 </HEAD>
   6
   7 <BODY>
   8
   9 <A NAME="__index__"></A>
  10 <!-- INDEX BEGIN -->
  11
  12 <UL>
  13
  14         <LI><A HREF="#name">NAME</A></LI>
  15         <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  16         <LI><A HREF="#description">DESCRIPTION</A></LI>
  17         <LI><A HREF="#methods">METHODS</A></LI>
  18         <LI><A HREF="#version">VERSION</A></LI>
  19         <LI><A HREF="#bugs">BUGS</A></LI>
  20         <LI><A HREF="#see also">SEE ALSO</A></LI>
  21 </UL>
  22 <!-- INDEX END -->
  23
  24 <HR>
  25 <P>
  26 <H1><A NAME="name">NAME</A></H1>
  27 <P>FS::cust_bill_pkg - Object methods for cust_bill_pkg records</P>
  28 <P>
  29 <HR>
  30 <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  31 <PRE>
  32   use FS::cust_bill_pkg;</PRE>
  33 <PRE>
  34   $record = new FS::cust_bill_pkg \%hash;
  35   $record = new FS::cust_bill_pkg { 'column' =&gt; 'value' };</PRE>
  36 <PRE>
  37   $error = $record-&gt;insert;</PRE>
  38 <PRE>
  39   $error = $new_record-&gt;replace($old_record);</PRE>
  40 <PRE>
  41   $error = $record-&gt;delete;</PRE>
  42 <PRE>
  43   $error = $record-&gt;check;</PRE>
  44 <P>
  45 <HR>
  46 <H1><A NAME="description">DESCRIPTION</A></H1>
  47 <P>An FS::cust_bill_pkg object represents an invoice line item.
  48 FS::cust_bill_pkg inherits from FS::Record.  The following fields are currently
  49 supported:</P>
  50 <DL>
  51 <DT><STRONG><A NAME="item_invoice">invnum - invoice (see <A HREF=".././FS/cust_bill.html">the FS::cust_bill manpage</A>)</A></STRONG><BR>
  52 <DD>
  53 <DT><STRONG><A NAME="item_package">pkgnum - package (see <A HREF=".././FS/cust_pkg.html">the FS::cust_pkg manpage</A>) or 0 for the special virtual sales tax package</A></STRONG><BR>
  54 <DD>
  55 <DT><STRONG><A NAME="item_setup_%2D_setup_fee">setup - setup fee</A></STRONG><BR>
  56 <DD>
  57 <DT><STRONG><A NAME="item_recur_%2D_recurring_fee">recur - recurring fee</A></STRONG><BR>
  58 <DD>
  59 <DT><STRONG><A NAME="item_sdate_%2D_starting_date_of_recurring_fee">sdate - starting date of recurring fee</A></STRONG><BR>
  60 <DD>
  61 <DT><STRONG><A NAME="item_edate_%2D_ending_date_of_recurring_fee">edate - ending date of recurring fee</A></STRONG><BR>
  62 <DD>
  63 </DL>
  64 <P>sdate and edate are specified as UNIX timestamps; see <EM>perlfunc/``time''</EM>.  Also
  65 see <A HREF="../Time/Local.html">the Time::Local manpage</A> and <A HREF="../Date/Parse.html">the Date::Parse manpage</A> for conversion functions.</P>
  66 <P>
  67 <HR>
  68 <H1><A NAME="methods">METHODS</A></H1>
  69 <DL>
  70 <DT><STRONG><A NAME="item_new">new HASHREF</A></STRONG><BR>
  71 <DD>
  72 Creates a new line item.  To add the line item to the database, see
  73 <A HREF="#insert">insert</A>.  Line items are normally created by calling the bill method of a
  74 customer object (see <A HREF=".././FS/cust_main.html">the FS::cust_main manpage</A>).
  75 <P></P>
  76 <DT><STRONG><A NAME="item_insert">insert</A></STRONG><BR>
  77 <DD>
  78 Adds this line item to the database.  If there is an error, returns the error,
  79 otherwise returns false.
  80 <P></P>
  81 <DT><STRONG><A NAME="item_delete">delete</A></STRONG><BR>
  82 <DD>
  83 Currently unimplemented.  I don't remove line items because there would then be
  84 no record the items ever existed (which is bad, no?)
  85 <P></P>
  86 <DT><STRONG><A NAME="item_replace_OLD_RECORD">replace OLD_RECORD</A></STRONG><BR>
  87 <DD>
  88 Currently unimplemented.  This would be even more of an accounting nightmare
  89 than deleteing the items.  Just don't do it.
  90 <P></P>
  91 <DT><STRONG><A NAME="item_check">check</A></STRONG><BR>
  92 <DD>
  93 Checks all fields to make sure this is a valid line item.  If there is an
  94 error, returns the error, otherwise returns false.  Called by the insert
  95 method.
  96 <P></P></DL>
  97 <P>
  98 <HR>
  99 <H1><A NAME="version">VERSION</A></H1>
 100 <P>$Id: cust_bill_pkg.html,v 1.3 2001-04-23 12:40:31 ivan Exp $</P>
 101 <P>
 102 <HR>
 103 <H1><A NAME="bugs">BUGS</A></H1>
 104 <P>
 105 <HR>
 106 <H1><A NAME="see also">SEE ALSO</A></H1>
 107 <P><A HREF=".././FS/Record.html">the FS::Record manpage</A>, <A HREF=".././FS/cust_bill.html">the FS::cust_bill manpage</A>, <A HREF=".././FS/cust_pkg.html">the FS::cust_pkg manpage</A>, <A HREF=".././FS/cust_main.html">the FS::cust_main manpage</A>, schema.html
 108 from the base documentation.</P>
 109
 110 </BODY>
 111
 112 </HTML>