From ea0d3938b57a079ce4aa6db0cae316e3ac6da654 Mon Sep 17 00:00:00 2001 From: ivan Date: Tue, 29 Jan 2002 17:46:41 +0000 Subject: these are all auto-generated by the installation; don't check them into CVS (probably should generate them for a release tarball though) --- httemplate/docs/man/FS/cust_pay.html | 123 ----------------------------------- 1 file changed, 123 deletions(-) delete mode 100644 httemplate/docs/man/FS/cust_pay.html (limited to 'httemplate/docs/man/FS/cust_pay.html') diff --git a/httemplate/docs/man/FS/cust_pay.html b/httemplate/docs/man/FS/cust_pay.html deleted file mode 100644 index a8c481fc0..000000000 --- a/httemplate/docs/man/FS/cust_pay.html +++ /dev/null @@ -1,123 +0,0 @@ - - -FS::cust_pay - Object methods for cust_pay objects - - - - - - - - -

- - -

NAME

FS::cust_pay - Object methods for cust_pay objects

SYNOPSIS

-  use FS::cust_pay;

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

-  $error = $record->insert;

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

-  $error = $record->delete;

-  $error = $record->check;

DESCRIPTION

An FS::cust_pay object represents a payment; the transfer of money from a -customer. FS::cust_pay inherits from FS::Record. The following fields are -currently supported:

paynum - primary key (assigned automatically for new payments)
-: -
custnum - customer (see the FS::cust_main manpage)
-: -
paid - Amount of this payment
-: -
_date - specified as a UNIX timestamp; see perlfunc/``time''. Also see -the Time::Local manpage and the Date::Parse manpage for conversion functions.
-: -
payby - `CARD' (credit cards), `BILL' (billing), or `COMP' (free)
-: -
payinfo - card number, check #, or comp issuer (4-8 lowercase alphanumerics; think username), respectively
-: -
paybatch - text field for tracking card processing
-: -
closed - books closed flag, empty or `Y'
-: -

METHODS

new HASHREF
-

-Creates a new payment. To add the payment to the databse, see insert. -

insert
-

-Adds this payment to the database. -

For backwards-compatibility and convenience, if the additional field invnum -is defined, an FS::cust_bill_pay record for the full amount of the payment -will be created. In this case, custnum is optional.

delete
-

-Currently unimplemented (accounting reasons). -

replace OLD_RECORD
-

-Currently unimplemented (accounting reasons). -

check
-

-Checks all fields to make sure this is a valid payment. If there is an error, -returns the error, otherwise returns false. Called by the insert method. -

cust_bill_pay
-

-Returns all applications to invoices (see the FS::cust_bill_pay manpage) for this -payment. -

unapplied
-

-Returns the amount of this payment that is still unapplied; which is -paid minus all payment applications (see the FS::cust_bill_pay manpage). -

VERSION

$Id: cust_pay.html,v 1.3 2002-01-29 17:42:46 ivan Exp $

BUGS