5 use Business::CreditCard;
6 use FS::Record qw( dbh qsearch qsearchs );
11 @ISA = qw( FS::Record );
15 FS::cust_pay - Object methods for cust_pay objects
21 $record = new FS::cust_pay \%hash;
22 $record = new FS::cust_pay { 'column' => 'value' };
24 $error = $record->insert;
26 $error = $new_record->replace($old_record);
28 $error = $record->delete;
30 $error = $record->check;
34 An FS::cust_pay object represents a payment; the transfer of money from a
35 customer. FS::cust_pay inherits from FS::Record. The following fields are
40 =item paynum - primary key (assigned automatically for new payments)
42 =item custnum - customer (see L<FS::cust_main>)
44 =item paid - Amount of this payment
46 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
47 L<Time::Local> and L<Date::Parse> for conversion functions.
49 =item payby - `CARD' (credit cards), `BILL' (billing), or `COMP' (free)
51 =item payinfo - card number, P.O.#, or comp issuer (4-8 lowercase alphanumerics; think username)
53 =item paybatch - text field for tracking card processing
63 Creates a new payment. To add the payment to the databse, see L<"insert">.
67 sub table { 'cust_pay'; }
71 Adds this payment to the database.
73 For backwards-compatibility and convenience, if the additional field invnum
74 is defined, an FS::cust_bill_pay record for the full amount of the payment
75 will be created. In this case, custnum is optional.
82 local $SIG{HUP} = 'IGNORE';
83 local $SIG{INT} = 'IGNORE';
84 local $SIG{QUIT} = 'IGNORE';
85 local $SIG{TERM} = 'IGNORE';
86 local $SIG{TSTP} = 'IGNORE';
87 local $SIG{PIPE} = 'IGNORE';
89 my $oldAutoCommit = $FS::UID::AutoCommit;
90 local $FS::UID::AutoCommit = 0;
93 my $error = $self->check;
94 return $error if $error;
96 if ( $self->invnum ) {
97 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $self->invnum } )
99 $dbh->rollback if $oldAutoCommit;
100 return "Unknown cust_bill.invnum: ". $self->invnum;
102 $self->custnum($cust_bill->custnum );
105 $error = $self->SUPER::insert;
107 $dbh->rollback if $oldAutoCommit;
108 return "error inserting $self: $error";
111 if ( $self->invnum ) {
112 my $cust_bill_pay = new FS::cust_bill_pay {
113 'invnum' => $self->invnum,
114 'paynum' => $self->paynum,
115 'amount' => $self->paid,
116 '_date' => $self->_date,
118 $error = $cust_bill_pay->insert;
120 $dbh->rollback if $oldAutoCommit;
121 return "error inserting $cust_bill_pay: $error";
125 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
131 sub upgrade_replace { #1.3.x->1.4.x
134 local $SIG{HUP} = 'IGNORE';
135 local $SIG{INT} = 'IGNORE';
136 local $SIG{QUIT} = 'IGNORE';
137 local $SIG{TERM} = 'IGNORE';
138 local $SIG{TSTP} = 'IGNORE';
139 local $SIG{PIPE} = 'IGNORE';
141 my $oldAutoCommit = $FS::UID::AutoCommit;
142 local $FS::UID::AutoCommit = 0;
145 my $error = $self->check;
146 return $error if $error;
148 my %new = $self->hash;
149 my $new = FS::cust_pay->new(\%new);
151 if ( $self->invnum ) {
152 my $cust_bill_pay = new FS::cust_bill_pay {
153 'invnum' => $self->invnum,
154 'paynum' => $self->paynum,
155 'amount' => $self->paid,
156 '_date' => $self->_date,
158 $error = $cust_bill_pay->insert;
160 $dbh->rollback if $oldAutoCommit;
163 $new->custnum($cust_bill_pay->cust_bill->custnum);
168 $error = $new->SUPER::replace($self);
170 $dbh->rollback if $oldAutoCommit;
174 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
183 Currently unimplemented (accounting reasons).
188 return "Can't (yet?) delete cust_pay records!";
191 =item replace OLD_RECORD
193 Currently unimplemented (accounting reasons).
198 return "Can't (yet?) modify cust_pay records!";
203 Checks all fields to make sure this is a valid payment. If there is an error,
204 returns the error, otherwise returns false. Called by the insert method.
212 $self->ut_numbern('paynum')
213 || $self->ut_numbern('custnum')
214 || $self->ut_money('paid')
215 || $self->ut_numbern('_date')
216 || $self->ut_textn('paybatch')
218 return $error if $error;
220 return "unknown cust_main.custnum: ". $self->custnum
222 || qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
224 $self->_date(time) unless $self->_date;
226 $self->payby =~ /^(CARD|BILL|COMP)$/ or return "Illegal payby";
229 if ( $self->payby eq 'CARD' ) {
230 my $payinfo = $self->payinfo;
232 $self->payinfo($payinfo);
233 if ( $self->payinfo ) {
234 $self->payinfo =~ /^(\d{13,16})$/
235 or return "Illegal (mistyped?) credit card number (payinfo)";
237 validate($self->payinfo) or return "Illegal credit card number";
238 return "Unknown card type" if cardtype($self->payinfo) eq "Unknown";
240 $self->payinfo('N/A');
244 $error = $self->ut_textn('payinfo');
245 return $error if $error;
254 Returns all applications to invoices (see L<FS::cust_bill_pay>) for this
261 sort { $a->_date <=> $b->_date }
262 qsearch( 'cust_bill_pay', { 'paynum' => $self->paynum } )
268 Returns the amount of this payment that is still unapplied; which is
269 paid minus all payment applications (see L<FS::cust_bill_pay>).
275 my $amount = $self->paid;
276 $amount -= $_->amount foreach ( $self->cust_bill_pay );
277 sprintf("%.2f", $amount );
284 $Id: cust_pay.pm,v 1.7 2001-09-03 22:07:38 ivan Exp $
288 Delete and replace methods.
292 L<FS::cust_bill_pay>, L<FS::cust_bill>, L<FS::Record>, schema.html from the