X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=httemplate%2Fdocs%2Fman%2FFS%2Fcust_pay.html;h=ce057f068ccfdbfde963468fd10b71a0f155a5ee;hp=8033762605d6b216f77f26c3d514e9f7a23793e5;hb=6991d4986df7fb3a6c7c49b5ae1b3713e87a16c4;hpb=f02dd9b0e5042ef000d9338089eed50988d48914 diff --git a/httemplate/docs/man/FS/cust_pay.html b/httemplate/docs/man/FS/cust_pay.html index 803376260..ce057f068 100644 --- a/httemplate/docs/man/FS/cust_pay.html +++ b/httemplate/docs/man/FS/cust_pay.html @@ -50,7 +50,7 @@ currently supported:

paynum - primary key (assigned automatically for new payments)
-
invnum - Invoice (see the FS::cust_bill manpage)
+
custnum - customer (see the FS::cust_main manpage)
paid - Amount of this payment
@@ -59,10 +59,12 @@ currently supported:

payby - `CARD' (credit cards), `BILL' (billing), or `COMP' (free)
-
payinfo - card number, P.O.#, or comp issuer (4-8 lowercase alphanumerics; think username)
+
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'
+


@@ -74,8 +76,10 @@ Creates a new payment. To add the payment to the databse, see

insert
-Adds this payment to the databse, and updates the invoice (see -the FS::cust_bill manpage). +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
@@ -89,11 +93,21 @@ Currently unimplemented (accounting reasons).
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.1 2001-07-30 07:36:03 ivan Exp $

+

$Id: cust_pay.html,v 1.2 2002-01-29 16:33:15 ivan Exp $


BUGS

@@ -101,7 +115,8 @@ returns the error, otherwise returns false. Called by the insert method.


SEE ALSO

-

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

+

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