3 <TITLE>FS::cust_pay - Object methods for cust_pay objects</TITLE>
4 <LINK REV="made" HREF="mailto:none">
13 <LI><A HREF="#NAME">NAME</A>
14 <LI><A HREF="#SYNOPSIS">SYNOPSIS</A>
15 <LI><A HREF="#DESCRIPTION">DESCRIPTION</A>
16 <LI><A HREF="#METHODS">METHODS</A>
17 <LI><A HREF="#VERSION">VERSION</A>
18 <LI><A HREF="#BUGS">BUGS</A>
19 <LI><A HREF="#SEE_ALSO">SEE ALSO</A>
25 <H1><A NAME="NAME">NAME</A></H1>
27 FS::cust_pay - Object methods for cust_pay objects
31 <H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
33 <PRE> use FS::cust_pay;
36 <PRE> $record = new FS::cust_pay \%hash;
37 $record = new FS::cust_pay { 'column' => 'value' };
40 <PRE> $error = $record->insert;
43 <PRE> $error = $new_record->replace($old_record);
46 <PRE> $error = $record->delete;
49 <PRE> $error = $record->check;
53 <H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
55 An FS::cust_pay object represents a payment. FS::cust_pay inherits from
56 FS::Record. The following fields are currently supported:
59 <DT><STRONG><A NAME="item_paynum">paynum - primary key (assigned automatically for new payments)</A></STRONG><DD>
60 <DT><STRONG><A NAME="item_invnum">invnum - Invoice (see FS::cust_bill)</A></STRONG><DD>
61 <DT><STRONG><A NAME="item_paid">paid - Amount of this payment</A></STRONG><DD>
62 <DT><STRONG><A NAME="item__date">_date - specified as a UNIX timestamp; see perlfunc/"time". Also see
63 Time::Local and Date::Parse for conversion functions.</A></STRONG><DD>
64 <DT><STRONG><A NAME="item_payby">payby - `CARD' (credit cards), `BILL' (billing), or `COMP' (free)</A></STRONG><DD>
65 <DT><STRONG><A NAME="item_payinfo">payinfo - card number, P.O.#, or comp issuer (4-8 lowercase alphanumerics; think username)</A></STRONG><DD>
66 <DT><STRONG><A NAME="item_paybatch">paybatch - text field for tracking card processing</A></STRONG><DD>
70 <H1><A NAME="METHODS">METHODS</A></H1>
72 <DT><STRONG><A NAME="item_new">new HASHREF</A></STRONG><DD>
74 Creates a new payment. To add the payment to the databse, see <A HREF="#insert">insert</A>.
76 <DT><STRONG><A NAME="item_insert">insert</A></STRONG><DD>
78 Adds this payment to the databse, and updates the invoice (see
79 <A HREF="../FS/cust_bill.html">FS::cust_bill</A>).
81 <DT><STRONG><A NAME="item_delete">delete</A></STRONG><DD>
83 Currently unimplemented (accounting reasons).
85 <DT><STRONG><A NAME="item_replace">replace OLD_RECORD</A></STRONG><DD>
87 Currently unimplemented (accounting reasons).
89 <DT><STRONG><A NAME="item_check">check</A></STRONG><DD>
91 Checks all fields to make sure this is a valid payment. If there is an
92 error, returns the error, otherwise returns false. Called by the insert
98 <H1><A NAME="VERSION">VERSION</A></H1>
100 $Id: cust_pay.html,v 1.2 2000-03-03 18:22:43 ivan Exp $
104 <H1><A NAME="BUGS">BUGS</A></H1>
106 Delete and replace methods.
110 <H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
112 <A HREF="../FS/Record.html">FS::Record</A>, <A HREF="../FS/cust_bill.html">FS::cust_bill</A>, schema.html from the base documentation.