htdocs/docs/man/cust_bill_pkg.txt

   1 NAME
   2     FS::cust_bill_pkg - Object methods for cust_bill_pkg records
   3
   4 SYNOPSIS
   5       use FS::cust_bill_pkg;
   6
   7       $record = new FS::cust_bill_pkg \%hash;
   8       $record = new FS::cust_bill_pkg { 'column' => 'value' };
   9
  10       $error = $record->insert;
  11
  12       $error = $new_record->replace($old_record);
  13
  14       $error = $record->delete;
  15
  16       $error = $record->check;
  17
  18 DESCRIPTION
  19     An FS::cust_bill_pkg object represents an invoice line item.
  20     FS::cust_bill_pkg inherits from FS::Record. The following fields
  21     are currently supported:
  22
  23     invnum - invoice (see the FS::cust_bill manpage)
  24     pkgnum - package (see the FS::cust_pkg manpage)
  25     setup - setup fee
  26     recur - recurring fee
  27     sdate - starting date of recurring fee
  28     edate - ending date of recurring fee
  29     sdate and edate are specified as UNIX timestamps; see the
  30     section on "time" in the perlfunc manpage. Also see the
  31     Time::Local manpage and the Date::Parse manpage for conversion
  32     functions.
  33
  34 METHODS
  35     new HASHREF
  36         Creates a new line item. To add the line item to the
  37         database, see the section on "insert". Line items are
  38         normally created by calling the bill method of a customer
  39         object (see the FS::cust_main manpage).
  40
  41     insert
  42         Adds this line item to the database. If there is an error,
  43         returns the error, otherwise returns false.
  44
  45     delete
  46         Currently unimplemented. I don't remove line items because
  47         there would then be no record the items ever existed (which
  48         is bad, no?)
  49
  50     replace OLD_RECORD
  51         Currently unimplemented. This would be even more of an
  52         accounting nightmare than deleteing the items. Just don't do
  53         it.
  54
  55     check
  56         Checks all fields to make sure this is a valid line item. If
  57         there is an error, returns the error, otherwise returns
  58         false. Called by the insert method.
  59
  60 VERSION
  61     $Id: cust_bill_pkg.txt,v 1.3 1999-04-08 13:39:31 ivan Exp $
  62
  63 BUGS
  64 SEE ALSO
  65     the FS::Record manpage, the FS::cust_bill manpage, the
  66     FS::cust_pkg manpage, the FS::cust_main manpage, schema.html
  67     from the base documentation.
  68
  69 HISTORY
  70     ivan@sisd.com 98-mar-13
  71
  72     pod ivan@sisd.com 98-sep-21
  73