X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=htdocs%2Fdocs%2Fman%2FFS%2Fcust_bill_pkg.html;fp=htdocs%2Fdocs%2Fman%2FFS%2Fcust_bill_pkg.html;h=2cdd8952e5606126048e74e18945f1d129e549da;hp=b94874408c803bd6fcbeb6e2646045f4575324a9;hb=f3235d39d083518d47f21cd5585e5f9a13070763;hpb=ece31063b782031e21ba1f57476afab555af5363 diff --git a/htdocs/docs/man/FS/cust_bill_pkg.html b/htdocs/docs/man/FS/cust_bill_pkg.html index b94874408..2cdd8952e 100644 --- a/htdocs/docs/man/FS/cust_bill_pkg.html +++ b/htdocs/docs/man/FS/cust_bill_pkg.html @@ -1,118 +1,111 @@ FS::cust_bill_pkg - Object methods for cust_bill_pkg records - + +

NAME -
SYNOPSIS -
DESCRIPTION -
METHODS -
VERSION -
BUGS -
SEE ALSO +
NAME
SYNOPSIS
DESCRIPTION
METHODS
VERSION
BUGS
SEE ALSO

NAME

-FS::cust_bill_pkg - Object methods for cust_bill_pkg records - +

NAME

FS::cust_bill_pkg - Object methods for cust_bill_pkg records

SYNOPSIS

  use FS::cust_bill_pkg;
-

  $record = new FS::cust_bill_pkg \%hash;
-  $record = new FS::cust_bill_pkg { 'column' => 'value' };
-

  $error = $record->insert;
-

  $error = $new_record->replace($old_record);
-

  $error = $record->delete;
-

  $error = $record->check;
-

SYNOPSIS

+  use FS::cust_bill_pkg;

+  $record = new FS::cust_bill_pkg \%hash;
+  $record = new FS::cust_bill_pkg { 'column' => 'value' };

+  $error = $record->insert;

+  $error = $new_record->replace($old_record);

+  $error = $record->delete;

+  $error = $record->check;

DESCRIPTION

-An FS::cust_bill_pkg object represents an invoice line item. -FS::cust_bill_pkg inherits from FS::Record. The following fields are -currently supported: - +

DESCRIPTION

An FS::cust_bill_pkg object represents an invoice line item. +FS::cust_bill_pkg inherits from FS::Record. The following fields are currently +supported:

invnum - invoice (see FS::cust_bill): -
pkgnum - package (see FS::cust_pkg): -
setup - setup fee: -
recur - recurring fee: -
sdate - starting date of recurring fee: -
edate - ending date of recurring fee: +
invnum - invoice (see the FS::cust_bill manpage)
+: +
pkgnum - package (see the FS::cust_pkg manpage) or 0 for the special virtual sales tax package
+: +
setup - setup fee
+: +
recur - recurring fee
+: +
sdate - starting date of recurring fee
+: +
edate - ending date of recurring fee
+

-sdate and edate are specified as UNIX timestamps; see perlfunc. Also see Time::Local and Date::Parse for conversion functions. - +

sdate and edate are specified as UNIX timestamps; see perlfunc/``time''. Also +see the Time::Local manpage and the Date::Parse manpage for conversion functions.

METHODS

new HASHREF: -
-Creates a new line item. To add the line item to the database, see -insert. Line items are normally created by calling the bill method of a customer -object (see FS::cust_main). - -
insert: -
-Adds this line item to the database. If there is an error, returns the -error, otherwise returns false. - -
delete: -
-Currently unimplemented. I don't remove line items because there would then -be no record the items ever existed (which is bad, no?) - -
replace OLD_RECORD: -
-Currently unimplemented. This would be even more of an accounting nightmare -than deleteing the items. Just don't do it. - -
check: -
-Checks all fields to make sure this is a valid line item. If there is an -error, returns the error, otherwise returns false. Called by the insert +
new HASHREF
+: +Creates a new line item. To add the line item to the database, see +insert. Line items are normally created by calling the bill method of a +customer object (see the FS::cust_main manpage). +
+
insert
+: +Adds this line item to the database. If there is an error, returns the error, +otherwise returns false. +
+
delete
+: +Currently unimplemented. I don't remove line items because there would then be +no record the items ever existed (which is bad, no?) +
+
replace OLD_RECORD
+: +Currently unimplemented. This would be even more of an accounting nightmare +than deleteing the items. Just don't do it. +
+
check
+: +Checks all fields to make sure this is a valid line item. If there is an +error, returns the error, otherwise returns false. Called by the insert method. - -

VERSION

-$Id: cust_bill_pkg.html,v 1.2 2000-03-03 18:22:42 ivan Exp $ - +

VERSION

$Id: cust_bill_pkg.html,v 1.3 2001-04-23 12:40:31 ivan Exp $