3 <TITLE>FS::cust_pay - Object methods for cust_pay objects</TITLE>
4 <LINK REV="made" HREF="mailto:perl@packages.debian.org">
9 <A NAME="__index__"></A>
14 <LI><A HREF="#name">NAME</A></LI>
15 <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
16 <LI><A HREF="#description">DESCRIPTION</A></LI>
17 <LI><A HREF="#methods">METHODS</A></LI>
18 <LI><A HREF="#version">VERSION</A></LI>
19 <LI><A HREF="#bugs">BUGS</A></LI>
20 <LI><A HREF="#see also">SEE ALSO</A></LI>
26 <H1><A NAME="name">NAME</A></H1>
27 <P>FS::cust_pay - Object methods for cust_pay objects</P>
30 <H1><A NAME="synopsis">SYNOPSIS</A></H1>
32 use FS::cust_pay;</PRE>
34 $record = new FS::cust_pay \%hash;
35 $record = new FS::cust_pay { 'column' => 'value' };</PRE>
37 $error = $record->insert;</PRE>
39 $error = $new_record->replace($old_record);</PRE>
41 $error = $record->delete;</PRE>
43 $error = $record->check;</PRE>
46 <H1><A NAME="description">DESCRIPTION</A></H1>
47 <P>An FS::cust_pay object represents a payment; the transfer of money from a
48 customer. FS::cust_pay inherits from FS::Record. The following fields are
49 currently supported:</P>
51 <DT><STRONG><A NAME="item_key">paynum - primary key (assigned automatically for new payments)</A></STRONG><BR>
53 <DT><STRONG><A NAME="item_customer">custnum - customer (see <A HREF=".././FS/cust_main.html">the FS::cust_main manpage</A>)</A></STRONG><BR>
55 <DT><STRONG><A NAME="item_paid_%2D_Amount_of_this_payment">paid - Amount of this payment</A></STRONG><BR>
57 <DT><STRONG><A NAME="item__date_%2D_specified_as_a_UNIX_timestamp%3B_see_per">_date - specified as a UNIX timestamp; see <EM>perlfunc/``time''</EM>. Also see
58 <A HREF="../Time/Local.html">the Time::Local manpage</A> and <A HREF="../Date/Parse.html">the Date::Parse manpage</A> for conversion functions.</A></STRONG><BR>
60 <DT><STRONG><A NAME="item_payby_%2D_%60CARD%27_%28credit_cards%29%2C_%60BILL">payby - `CARD' (credit cards), `BILL' (billing), or `COMP' (free)</A></STRONG><BR>
62 <DT><STRONG><A NAME="item_issuer">payinfo - card number, check #, or comp issuer (4-8 lowercase alphanumerics; think username), respectively</A></STRONG><BR>
64 <DT><STRONG><A NAME="item_paybatch_%2D_text_field_for_tracking_card_processi">paybatch - text field for tracking card processing</A></STRONG><BR>
66 <DT><STRONG><A NAME="item_closed_%2D_books_closed_flag%2C_empty_or_%60Y%27">closed - books closed flag, empty or `Y'</A></STRONG><BR>
71 <H1><A NAME="methods">METHODS</A></H1>
73 <DT><STRONG><A NAME="item_new">new HASHREF</A></STRONG><BR>
75 Creates a new payment. To add the payment to the databse, see <A HREF="#insert">insert</A>.
77 <DT><STRONG><A NAME="item_insert">insert</A></STRONG><BR>
79 Adds this payment to the database.
80 <P>For backwards-compatibility and convenience, if the additional field invnum
81 is defined, an FS::cust_bill_pay record for the full amount of the payment
82 will be created. In this case, custnum is optional.</P>
84 <DT><STRONG><A NAME="item_delete">delete</A></STRONG><BR>
86 Currently unimplemented (accounting reasons).
88 <DT><STRONG><A NAME="item_replace_OLD_RECORD">replace OLD_RECORD</A></STRONG><BR>
90 Currently unimplemented (accounting reasons).
92 <DT><STRONG><A NAME="item_check">check</A></STRONG><BR>
94 Checks all fields to make sure this is a valid payment. If there is an error,
95 returns the error, otherwise returns false. Called by the insert method.
97 <DT><STRONG><A NAME="item_cust_bill_pay">cust_bill_pay</A></STRONG><BR>
99 Returns all applications to invoices (see <A HREF=".././FS/cust_bill_pay.html">the FS::cust_bill_pay manpage</A>) for this
102 <DT><STRONG><A NAME="item_unapplied">unapplied</A></STRONG><BR>
104 Returns the amount of this payment that is still unapplied; which is
105 paid minus all payment applications (see <A HREF=".././FS/cust_bill_pay.html">the FS::cust_bill_pay manpage</A>).
109 <H1><A NAME="version">VERSION</A></H1>
110 <P>$Id: cust_pay.html,v 1.3 2002-01-29 17:42:46 ivan Exp $</P>
113 <H1><A NAME="bugs">BUGS</A></H1>
114 <P>Delete and replace methods.</P>
117 <H1><A NAME="see also">SEE ALSO</A></H1>
118 <P><A HREF=".././FS/cust_bill_pay.html">the FS::cust_bill_pay manpage</A>, <A HREF=".././FS/cust_bill.html">the FS::cust_bill manpage</A>, <A HREF=".././FS/Record.html">the FS::Record manpage</A>, schema.html from the
119 base documentation.</P>