4 use vars qw( @ISA $conf $unsuspendauto );
6 use Business::CreditCard;
8 use FS::Record qw( dbh qsearch qsearchs );
9 use FS::Misc qw(send_email);
11 use FS::cust_bill_pay;
12 use FS::cust_pay_refund;
14 use FS::cust_pay_void;
16 @ISA = qw( FS::Record );
18 #ask FS::UID to run this stuff for us later
19 FS::UID->install_callback( sub {
21 $unsuspendauto = $conf->exists('unsuspendauto');
26 FS::cust_pay - Object methods for cust_pay objects
32 $record = new FS::cust_pay \%hash;
33 $record = new FS::cust_pay { 'column' => 'value' };
35 $error = $record->insert;
37 $error = $new_record->replace($old_record);
39 $error = $record->delete;
41 $error = $record->check;
45 An FS::cust_pay object represents a payment; the transfer of money from a
46 customer. FS::cust_pay inherits from FS::Record. The following fields are
51 =item paynum - primary key (assigned automatically for new payments)
53 =item custnum - customer (see L<FS::cust_main>)
55 =item paid - Amount of this payment
57 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
58 L<Time::Local> and L<Date::Parse> for conversion functions.
60 =item payby - `CARD' (credit cards), `CHEK' (electronic check/ACH),
61 `LECB' (phone bill billing), `BILL' (billing), or `COMP' (free)
63 =item payinfo - card number, check #, or comp issuer (4-8 lowercase alphanumerics; think username), respectively
65 =item paybatch - text field for tracking card processing
67 =item closed - books closed flag, empty or `Y'
77 Creates a new payment. To add the payment to the databse, see L<"insert">.
81 sub table { 'cust_pay'; }
85 Adds this payment to the database.
87 For backwards-compatibility and convenience, if the additional field invnum
88 is defined, an FS::cust_bill_pay record for the full amount of the payment
89 will be created. In this case, custnum is optional.
96 local $SIG{HUP} = 'IGNORE';
97 local $SIG{INT} = 'IGNORE';
98 local $SIG{QUIT} = 'IGNORE';
99 local $SIG{TERM} = 'IGNORE';
100 local $SIG{TSTP} = 'IGNORE';
101 local $SIG{PIPE} = 'IGNORE';
103 my $oldAutoCommit = $FS::UID::AutoCommit;
104 local $FS::UID::AutoCommit = 0;
107 if ( $self->invnum ) {
108 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $self->invnum } )
110 $dbh->rollback if $oldAutoCommit;
111 return "Unknown cust_bill.invnum: ". $self->invnum;
113 $self->custnum($cust_bill->custnum );
116 my $cust_main = $self->cust_main;
117 my $old_balance = $cust_main->balance;
119 my $error = $self->check;
120 return $error if $error;
122 $error = $self->SUPER::insert;
124 $dbh->rollback if $oldAutoCommit;
125 return "error inserting $self: $error";
128 if ( $self->invnum ) {
129 my $cust_bill_pay = new FS::cust_bill_pay {
130 'invnum' => $self->invnum,
131 'paynum' => $self->paynum,
132 'amount' => $self->paid,
133 '_date' => $self->_date,
135 $error = $cust_bill_pay->insert;
137 $dbh->rollback if $oldAutoCommit;
138 return "error inserting $cust_bill_pay: $error";
142 if ( $self->paybatch =~ /^webui-/ ) {
143 my @cust_pay = qsearch('cust_pay', {
144 'custnum' => $self->custnum,
145 'paybatch' => $self->paybatch,
147 if ( scalar(@cust_pay) > 1 ) {
148 $dbh->rollback if $oldAutoCommit;
149 return "a payment with webui token ". $self->paybatch. " already exists";
153 #false laziness w/ cust_credit::insert
154 if ( $unsuspendauto && $old_balance && $cust_main->balance <= 0 ) {
155 my @errors = $cust_main->unsuspend;
157 # side-fx with nested transactions? upstack rolls back?
158 warn "WARNING:Errors unsuspending customer ". $cust_main->custnum. ": ".
164 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
166 #my $cust_main = $self->cust_main;
167 if ( $conf->exists('payment_receipt_email')
168 && grep { $_ ne 'POST' } $cust_main->invoicing_list
171 my $receipt_template = new Text::Template (
173 SOURCE => [ map "$_\n", $conf->config('payment_receipt_email') ],
175 warn "can't create payment receipt template: $Text::Template::ERROR";
179 my @invoicing_list = grep { $_ ne 'POST' } $cust_main->invoicing_list;
181 my $payby = $self->payby;
182 my $payinfo = $self->payinfo;
183 $payby =~ s/^BILL$/Check/ if $payinfo;
184 $payinfo = $self->payinfo_masked if $payby eq 'CARD';
186 my $error = send_email(
187 'from' => $conf->config('invoice_from'), #??? well as good as any
188 'to' => \@invoicing_list,
189 'subject' => 'Payment receipt',
190 'body' => [ $receipt_template->fill_in( HASH => {
191 'date' => time2str("%a %B %o, %Y", $self->_date),
192 'name' => $cust_main->name,
193 'paynum' => $self->paynum,
194 'paid' => sprintf("%.2f", $self->paid),
195 'payby' => ucfirst(lc($payby)),
196 'payinfo' => $payinfo,
197 'balance' => $cust_main->balance,
201 warn "can't send payment receipt: $error";
210 =item void [ REASON ]
212 Voids this payment: deletes the payment and all associated applications and
213 adds a record of the voided payment to the FS::cust_pay_void table.
220 local $SIG{HUP} = 'IGNORE';
221 local $SIG{INT} = 'IGNORE';
222 local $SIG{QUIT} = 'IGNORE';
223 local $SIG{TERM} = 'IGNORE';
224 local $SIG{TSTP} = 'IGNORE';
225 local $SIG{PIPE} = 'IGNORE';
227 my $oldAutoCommit = $FS::UID::AutoCommit;
228 local $FS::UID::AutoCommit = 0;
231 my $cust_pay_void = new FS::cust_pay_void ( {
232 map { $_ => $self->get($_) } $self->fields
234 $cust_pay_void->reason(shift) if scalar(@_);
235 my $error = $cust_pay_void->insert;
237 $dbh->rollback if $oldAutoCommit;
241 $error = $self->delete;
243 $dbh->rollback if $oldAutoCommit;
247 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
255 Deletes this payment and all associated applications (see L<FS::cust_bill_pay>),
256 unless the closed flag is set. In most cases, you want to use the void
257 method instead to leave a record of the deleted payment.
263 return "Can't delete closed payment" if $self->closed =~ /^Y/i;
265 local $SIG{HUP} = 'IGNORE';
266 local $SIG{INT} = 'IGNORE';
267 local $SIG{QUIT} = 'IGNORE';
268 local $SIG{TERM} = 'IGNORE';
269 local $SIG{TSTP} = 'IGNORE';
270 local $SIG{PIPE} = 'IGNORE';
272 my $oldAutoCommit = $FS::UID::AutoCommit;
273 local $FS::UID::AutoCommit = 0;
276 foreach my $app ( $self->cust_bill_pay, $self->cust_pay_refund ) {
277 my $error = $app->delete;
279 $dbh->rollback if $oldAutoCommit;
284 my $error = $self->SUPER::delete(@_);
286 $dbh->rollback if $oldAutoCommit;
290 if ( $conf->config('deletepayments') ne '' ) {
292 my $cust_main = $self->cust_main;
294 my $error = send_email(
295 'from' => $conf->config('invoice_from'), #??? well as good as any
296 'to' => $conf->config('deletepayments'),
297 'subject' => 'FREESIDE NOTIFICATION: Payment deleted',
299 "This is an automatic message from your Freeside installation\n",
300 "informing you that the following payment has been deleted:\n",
302 'paynum: '. $self->paynum. "\n",
303 'custnum: '. $self->custnum.
304 " (". $cust_main->last. ", ". $cust_main->first. ")\n",
305 'paid: $'. sprintf("%.2f", $self->paid). "\n",
306 'date: '. time2str("%a %b %e %T %Y", $self->_date). "\n",
307 'payby: '. $self->payby. "\n",
308 'payinfo: '. $self->payinfo. "\n",
309 'paybatch: '. $self->paybatch. "\n",
314 $dbh->rollback if $oldAutoCommit;
315 return "can't send payment deletion notification: $error";
320 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
326 =item replace OLD_RECORD
328 You probably shouldn't modify payments...
332 Checks all fields to make sure this is a valid payment. If there is an error,
333 returns the error, otherwise returns false. Called by the insert method.
341 $self->ut_numbern('paynum')
342 || $self->ut_numbern('custnum')
343 || $self->ut_money('paid')
344 || $self->ut_numbern('_date')
345 || $self->ut_textn('paybatch')
346 || $self->ut_enum('closed', [ '', 'Y' ])
348 return $error if $error;
350 return "paid must be > 0 " if $self->paid <= 0;
352 return "unknown cust_main.custnum: ". $self->custnum
354 || qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
356 $self->_date(time) unless $self->_date;
358 $self->payby =~ /^(CARD|CHEK|LECB|BILL|COMP)$/ or return "Illegal payby";
361 #false laziness with cust_refund::check
362 if ( $self->payby eq 'CARD' ) {
363 my $payinfo = $self->payinfo;
365 $self->payinfo($payinfo);
366 if ( $self->payinfo ) {
367 $self->payinfo =~ /^(\d{13,16})$/
368 or return "Illegal (mistyped?) credit card number (payinfo)";
370 validate($self->payinfo) or return "Illegal credit card number";
371 return "Unknown card type" if cardtype($self->payinfo) eq "Unknown";
373 $self->payinfo('N/A');
377 $error = $self->ut_textn('payinfo');
378 return $error if $error;
386 Returns all applications to invoices (see L<FS::cust_bill_pay>) for this
393 sort { $a->_date <=> $b->_date
394 || $a->invnum <=> $b->invnum }
395 qsearch( 'cust_bill_pay', { 'paynum' => $self->paynum } )
399 =item cust_pay_refund
401 Returns all applications of refunds (see L<FS::cust_pay_refund>) to this
406 sub cust_pay_refund {
408 sort { $a->_date <=> $b->_date }
409 qsearch( 'cust_pay_refund', { 'paynum' => $self->paynum } )
416 Returns the amount of this payment that is still unapplied; which is
417 paid minus all payment applications (see L<FS::cust_bill_pay>) and refund
418 applications (see L<FS::cust_pay_refund>).
424 my $amount = $self->paid;
425 $amount -= $_->amount foreach ( $self->cust_bill_pay );
426 $amount -= $_->amount foreach ( $self->cust_pay_refund );
427 sprintf("%.2f", $amount );
432 Returns the amount of this payment that has not been refuned; which is
433 paid minus all refund applications (see L<FS::cust_pay_refund>).
439 my $amount = $self->paid;
440 $amount -= $_->amount foreach ( $self->cust_pay_refund );
441 sprintf("%.2f", $amount );
447 Returns the parent customer object (see L<FS::cust_main>).
453 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
458 Returns a "masked" payinfo field with all but the last four characters replaced
459 by 'x'es. Useful for displaying credit cards.
465 my $payinfo = $self->payinfo;
466 'x'x(length($payinfo)-4). substr($payinfo,(length($payinfo)-4));
473 Delete and replace methods. payinfo_masked false laziness with cust_main.pm
478 L<FS::cust_bill_pay>, L<FS::cust_bill>, L<FS::Record>, schema.html from the