X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=htdocs%2Fdocs%2Fman%2FFS%2Fcust_pay.html;fp=htdocs%2Fdocs%2Fman%2FFS%2Fcust_pay.html;h=dc7b54c8df05c2a181e1cca2d74d3b512f782133;hp=e9ae08a4167e763807a2003bf6bdf3f7df1acf5a;hb=f3235d39d083518d47f21cd5585e5f9a13070763;hpb=ece31063b782031e21ba1f57476afab555af5363 diff --git a/htdocs/docs/man/FS/cust_pay.html b/htdocs/docs/man/FS/cust_pay.html index e9ae08a41..dc7b54c8d 100644 --- a/htdocs/docs/man/FS/cust_pay.html +++ b/htdocs/docs/man/FS/cust_pay.html @@ -1,115 +1,107 @@ FS::cust_pay - Object methods for cust_pay objects - + +

-

NAME

-

-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;
-
+

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. FS::cust_pay inherits from -FS::Record. The following fields are currently supported: - +

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)
-
invnum - Invoice (see FS::cust_bill)
-
paid - Amount of this payment
-
_date - specified as a UNIX timestamp; see perlfunc/"time". Also see -Time::Local and Date::Parse for conversion functions.
-
payby - `CARD' (credit cards), `BILL' (billing), or `COMP' (free)
-
payinfo - card number, P.O.#, or comp issuer (4-8 lowercase alphanumerics; think username)
-
paybatch - text field for tracking card processing
+
paynum - primary key (assigned automatically for new payments)
+
+
invnum - Invoice (see the FS::cust_bill 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, P.O.#, or comp issuer (4-8 lowercase alphanumerics; think username)
+
+
paybatch - text field for tracking card processing
+


-

METHODS

+

METHODS

-
new HASHREF
-

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

insert
-

+

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

+
insert
+
Adds this payment to the databse, and updates the invoice (see -FS::cust_bill). - -
delete
-

+the FS::cust_bill manpage). +

+
delete
+
Currently unimplemented (accounting reasons). - -
replace OLD_RECORD
-

+

+
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. - -

+

+
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. +


-

VERSION

-

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

VERSION

+

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


-

BUGS

-

-Delete and replace methods. - +

BUGS

+

Delete and replace methods.


-

SEE ALSO

-

-FS::Record, FS::cust_bill, schema.html from the base documentation. +

SEE ALSO

+

the FS::Record manpage, the FS::cust_bill manpage, schema.html from the base documentation.