4 use vars qw( @ISA $DEBUG $me $conf @encrypted_fields
5 $unsuspendauto $ignore_noapply
8 use Business::CreditCard;
10 use FS::UID qw( getotaker );
11 use FS::Misc qw( send_email );
12 use FS::Record qw( dbh qsearch qsearchs );
14 use FS::cust_main_Mixin;
15 use FS::payinfo_transaction_Mixin;
17 use FS::cust_bill_pay;
18 use FS::cust_pay_refund;
20 use FS::cust_pay_void;
22 @ISA = qw( FS::payinfo_transaction_Mixin FS::cust_main_Mixin FS::Record );
26 $me = '[FS::cust_pay]';
30 #ask FS::UID to run this stuff for us later
31 FS::UID->install_callback( sub {
33 $unsuspendauto = $conf->exists('unsuspendauto');
36 @encrypted_fields = ('payinfo');
40 FS::cust_pay - Object methods for cust_pay objects
46 $record = new FS::cust_pay \%hash;
47 $record = new FS::cust_pay { 'column' => 'value' };
49 $error = $record->insert;
51 $error = $new_record->replace($old_record);
53 $error = $record->delete;
55 $error = $record->check;
59 An FS::cust_pay object represents a payment; the transfer of money from a
60 customer. FS::cust_pay inherits from FS::Record. The following fields are
65 =item paynum - primary key (assigned automatically for new payments)
67 =item custnum - customer (see L<FS::cust_main>)
69 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
70 L<Time::Local> and L<Date::Parse> for conversion functions.
72 =item paid - Amount of this payment
74 =item otaker - order taker (assigned automatically, see L<FS::UID>)
76 =item payby - Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
78 =item payinfo - Payment Information (See L<FS::payinfo_Mixin> for data format)
80 =item paymask - Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
82 =item paybatch - text field for tracking card processing or other batch grouping
84 =item payunique - Optional unique identifer to prevent duplicate transactions.
86 =item closed - books closed flag, empty or `Y'
96 Creates a new payment. To add the payment to the databse, see L<"insert">.
100 sub table { 'cust_pay'; }
101 sub cust_linked { $_[0]->cust_main_custnum; }
102 sub cust_unlinked_msg {
104 "WARNING: can't find cust_main.custnum ". $self->custnum.
105 ' (cust_pay.paynum '. $self->paynum. ')';
110 Adds this payment to the database.
112 For backwards-compatibility and convenience, if the additional field invnum
113 is defined, an FS::cust_bill_pay record for the full amount of the payment
114 will be created. In this case, custnum is optional. An hash of optional
115 arguments may be passed. Currently "manual" is supported. If true, a
116 payment receipt is sent instead of a statement when 'payment_receipt_email'
117 configuration option is set.
122 my ($self, %options) = @_;
124 local $SIG{HUP} = 'IGNORE';
125 local $SIG{INT} = 'IGNORE';
126 local $SIG{QUIT} = 'IGNORE';
127 local $SIG{TERM} = 'IGNORE';
128 local $SIG{TSTP} = 'IGNORE';
129 local $SIG{PIPE} = 'IGNORE';
131 my $oldAutoCommit = $FS::UID::AutoCommit;
132 local $FS::UID::AutoCommit = 0;
136 if ( $self->invnum ) {
137 $cust_bill = qsearchs('cust_bill', { 'invnum' => $self->invnum } )
139 $dbh->rollback if $oldAutoCommit;
140 return "Unknown cust_bill.invnum: ". $self->invnum;
142 $self->custnum($cust_bill->custnum );
146 my $error = $self->check;
147 return $error if $error;
149 my $cust_main = $self->cust_main;
150 my $old_balance = $cust_main->balance;
152 $error = $self->SUPER::insert;
154 $dbh->rollback if $oldAutoCommit;
155 return "error inserting $self: $error";
158 if ( $self->invnum ) {
159 my $cust_bill_pay = new FS::cust_bill_pay {
160 'invnum' => $self->invnum,
161 'paynum' => $self->paynum,
162 'amount' => $self->paid,
163 '_date' => $self->_date,
165 $error = $cust_bill_pay->insert;
167 if ( $ignore_noapply ) {
168 warn "warning: error inserting $cust_bill_pay: $error ".
169 "(ignore_noapply flag set; inserting cust_pay record anyway)\n";
171 $dbh->rollback if $oldAutoCommit;
172 return "error inserting $cust_bill_pay: $error";
177 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
179 #false laziness w/ cust_credit::insert
180 if ( $unsuspendauto && $old_balance && $cust_main->balance <= 0 ) {
181 my @errors = $cust_main->unsuspend;
183 # side-fx with nested transactions? upstack rolls back?
184 warn "WARNING:Errors unsuspending customer ". $cust_main->custnum. ": ".
190 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
192 #my $cust_main = $self->cust_main;
193 if ( $conf->exists('payment_receipt_email')
194 && grep { $_ !~ /^(POST|FAX)$/ } $cust_main->invoicing_list
197 $cust_bill ||= ($cust_main->cust_bill)[-1]; #rather inefficient though?
200 if ( ( exists($options{'manual'}) && $options{'manual'} )
201 || ! $conf->exists('invoice_html_statement')
205 my $receipt_template = new Text::Template (
207 SOURCE => [ map "$_\n", $conf->config('payment_receipt_email') ],
209 warn "can't create payment receipt template: $Text::Template::ERROR";
213 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ }
214 $cust_main->invoicing_list;
216 my $payby = $self->payby;
217 my $payinfo = $self->payinfo;
218 $payby =~ s/^BILL$/Check/ if $payinfo;
219 $payinfo = $self->paymask if $payby eq 'CARD' || $payby eq 'CHEK';
220 $payby =~ s/^CHEK$/Electronic check/;
223 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
224 #invoice_from??? well as good as any
225 'to' => \@invoicing_list,
226 'subject' => 'Payment receipt',
227 'body' => [ $receipt_template->fill_in( HASH => {
228 'date' => time2str("%a %B %o, %Y", $self->_date),
229 'name' => $cust_main->name,
230 'paynum' => $self->paynum,
231 'paid' => sprintf("%.2f", $self->paid),
232 'payby' => ucfirst(lc($payby)),
233 'payinfo' => $payinfo,
234 'balance' => $cust_main->balance,
240 my $queue = new FS::queue {
241 'paynum' => $self->paynum,
242 'job' => 'FS::cust_bill::queueable_email',
244 $error = $queue->insert(
245 'invnum' => $cust_bill->invnum,
246 'template' => 'statement',
252 warn "can't send payment receipt/statement: $error";
261 =item void [ REASON ]
263 Voids this payment: deletes the payment and all associated applications and
264 adds a record of the voided payment to the FS::cust_pay_void table.
271 local $SIG{HUP} = 'IGNORE';
272 local $SIG{INT} = 'IGNORE';
273 local $SIG{QUIT} = 'IGNORE';
274 local $SIG{TERM} = 'IGNORE';
275 local $SIG{TSTP} = 'IGNORE';
276 local $SIG{PIPE} = 'IGNORE';
278 my $oldAutoCommit = $FS::UID::AutoCommit;
279 local $FS::UID::AutoCommit = 0;
282 my $cust_pay_void = new FS::cust_pay_void ( {
283 map { $_ => $self->get($_) } $self->fields
285 $cust_pay_void->reason(shift) if scalar(@_);
286 my $error = $cust_pay_void->insert;
288 $dbh->rollback if $oldAutoCommit;
292 $error = $self->delete;
294 $dbh->rollback if $oldAutoCommit;
298 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
306 Unless the closed flag is set, deletes this payment and all associated
307 applications (see L<FS::cust_bill_pay> and L<FS::cust_pay_refund>). In most
308 cases, you want to use the void method instead to leave a record of the
313 # very similar to FS::cust_credit::delete
316 return "Can't delete closed payment" if $self->closed =~ /^Y/i;
318 local $SIG{HUP} = 'IGNORE';
319 local $SIG{INT} = 'IGNORE';
320 local $SIG{QUIT} = 'IGNORE';
321 local $SIG{TERM} = 'IGNORE';
322 local $SIG{TSTP} = 'IGNORE';
323 local $SIG{PIPE} = 'IGNORE';
325 my $oldAutoCommit = $FS::UID::AutoCommit;
326 local $FS::UID::AutoCommit = 0;
329 foreach my $app ( $self->cust_bill_pay, $self->cust_pay_refund ) {
330 my $error = $app->delete;
332 $dbh->rollback if $oldAutoCommit;
337 my $error = $self->SUPER::delete(@_);
339 $dbh->rollback if $oldAutoCommit;
343 if ( $conf->config('deletepayments') ne '' ) {
345 my $cust_main = $self->cust_main;
347 my $error = send_email(
348 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
349 #invoice_from??? well as good as any
350 'to' => $conf->config('deletepayments'),
351 'subject' => 'FREESIDE NOTIFICATION: Payment deleted',
353 "This is an automatic message from your Freeside installation\n",
354 "informing you that the following payment has been deleted:\n",
356 'paynum: '. $self->paynum. "\n",
357 'custnum: '. $self->custnum.
358 " (". $cust_main->last. ", ". $cust_main->first. ")\n",
359 'paid: $'. sprintf("%.2f", $self->paid). "\n",
360 'date: '. time2str("%a %b %e %T %Y", $self->_date). "\n",
361 'payby: '. $self->payby. "\n",
362 'payinfo: '. $self->paymask. "\n",
363 'paybatch: '. $self->paybatch. "\n",
368 $dbh->rollback if $oldAutoCommit;
369 return "can't send payment deletion notification: $error";
374 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
380 =item replace OLD_RECORD
382 You can, but probably shouldn't modify payments...
387 #return "Can't modify payment!"
389 return "Can't modify closed payment" if $self->closed =~ /^Y/i;
390 $self->SUPER::replace(@_);
395 Checks all fields to make sure this is a valid payment. If there is an error,
396 returns the error, otherwise returns false. Called by the insert method.
403 $self->otaker(getotaker) unless ($self->otaker);
406 $self->ut_numbern('paynum')
407 || $self->ut_numbern('custnum')
408 || $self->ut_numbern('_date')
409 || $self->ut_money('paid')
410 || $self->ut_alpha('otaker')
411 || $self->ut_textn('paybatch')
412 || $self->ut_textn('payunique')
413 || $self->ut_enum('closed', [ '', 'Y' ])
414 || $self->payinfo_check()
416 return $error if $error;
418 return "paid must be > 0 " if $self->paid <= 0;
420 return "unknown cust_main.custnum: ". $self->custnum
422 || qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
424 $self->_date(time) unless $self->_date;
426 #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it
427 # # UNIQUE index should catch this too, without race conditions, but this
428 # # should give a better error message the other 99.9% of the time...
429 # if ( length($self->payunique)
430 # && qsearchs('cust_pay', { 'payunique' => $self->payunique } ) ) {
431 # #well, it *could* be a better error message
432 # return "duplicate transaction".
433 # " - a payment with unique identifer ". $self->payunique.
440 =item batch_insert CUST_PAY_OBJECT, ...
442 Class method which inserts multiple payments. Takes a list of FS::cust_pay
443 objects. Returns a list, each element representing the status of inserting the
444 corresponding payment - empty. If there is an error inserting any payment, the
445 entire transaction is rolled back, i.e. all payments are inserted or none are.
449 my @errors = FS::cust_pay->batch_insert(@cust_pay);
450 my $num_errors = scalar(grep $_, @errors);
451 if ( $num_errors == 0 ) {
452 #success; all payments were inserted
454 #failure; no payments were inserted.
460 my $self = shift; #class method
462 local $SIG{HUP} = 'IGNORE';
463 local $SIG{INT} = 'IGNORE';
464 local $SIG{QUIT} = 'IGNORE';
465 local $SIG{TERM} = 'IGNORE';
466 local $SIG{TSTP} = 'IGNORE';
467 local $SIG{PIPE} = 'IGNORE';
469 my $oldAutoCommit = $FS::UID::AutoCommit;
470 local $FS::UID::AutoCommit = 0;
476 my $error = $_->insert( 'manual' => 1 );
480 $_->cust_main->apply_payments;
486 $dbh->rollback if $oldAutoCommit;
488 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
497 Returns all applications to invoices (see L<FS::cust_bill_pay>) for this
504 sort { $a->_date <=> $b->_date
505 || $a->invnum <=> $b->invnum }
506 qsearch( 'cust_bill_pay', { 'paynum' => $self->paynum } )
510 =item cust_pay_refund
512 Returns all applications of refunds (see L<FS::cust_pay_refund>) to this
517 sub cust_pay_refund {
519 sort { $a->_date <=> $b->_date }
520 qsearch( 'cust_pay_refund', { 'paynum' => $self->paynum } )
527 Returns the amount of this payment that is still unapplied; which is
528 paid minus all payment applications (see L<FS::cust_bill_pay>) and refund
529 applications (see L<FS::cust_pay_refund>).
535 my $amount = $self->paid;
536 $amount -= $_->amount foreach ( $self->cust_bill_pay );
537 $amount -= $_->amount foreach ( $self->cust_pay_refund );
538 sprintf("%.2f", $amount );
543 Returns the amount of this payment that has not been refuned; which is
544 paid minus all refund applications (see L<FS::cust_pay_refund>).
550 my $amount = $self->paid;
551 $amount -= $_->amount foreach ( $self->cust_pay_refund );
552 sprintf("%.2f", $amount );
557 Returns the "paid" field.
574 Returns an SQL fragment to retreive the unapplied amount.
583 ( SELECT SUM(amount) FROM cust_bill_pay
584 WHERE cust_pay.paynum = cust_bill_pay.paynum )
588 ( SELECT SUM(amount) FROM cust_pay_refund
589 WHERE cust_pay.paynum = cust_pay_refund.paynum )
598 # Used by FS::Upgrade to migrate to a new database.
602 sub _upgrade_data { #class method
603 my ($class, %opts) = @_;
605 warn "$me upgrading $class\n" if $DEBUG;
607 #not the most efficient, but hey, it only has to run once
609 my $where = "WHERE ( otaker IS NULL OR otaker = '' OR otaker = 'ivan' ) ".
610 " AND 0 < ( SELECT COUNT(*) FROM cust_main ".
611 " WHERE cust_main.custnum = cust_pay.custnum ) ";
613 my $count_sql = "SELECT COUNT(*) FROM cust_pay $where";
615 my $sth = dbh->prepare($count_sql) or die dbh->errstr;
616 $sth->execute or die $sth->errstr;
617 my $total = $sth->fetchrow_arrayref->[0];
618 #warn "$total cust_pay records to update\n"
620 local($DEBUG) = 2 if $total > 1000; #could be a while, force progress info
625 my @cust_pay = qsearch( {
626 'table' => 'cust_pay',
628 'extra_sql' => $where,
629 'order_by' => 'ORDER BY paynum',
632 foreach my $cust_pay (@cust_pay) {
634 my $h_cust_pay = $cust_pay->h_search('insert');
636 next if $cust_pay->otaker eq $h_cust_pay->history_user;
637 $cust_pay->otaker($h_cust_pay->history_user);
639 $cust_pay->otaker('legacy');
642 delete $FS::payby::hash{'COMP'}->{cust_pay}; #quelle kludge
643 my $error = $cust_pay->replace;
646 warn " *** WARNING: Error updating order taker for payment paynum ".
647 $cust_pay->paynun. ": $error\n";
651 $FS::payby::hash{'COMP'}->{cust_pay} = ''; #restore it
654 if ( $DEBUG > 1 && $lastprog + 30 < time ) {
655 warn "$me $count/$total (". sprintf('%.2f',100*$count/$total). '%)'. "\n";
669 =item batch_import HASHREF
671 Inserts new payments.
678 my $fh = $param->{filehandle};
679 my $agentnum = $param->{agentnum};
680 my $format = $param->{'format'};
681 my $paybatch = $param->{'paybatch'};
683 # here is the agent virtualization
684 my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
688 if ( $format eq 'simple' ) {
689 @fields = qw( custnum agent_custid paid payinfo );
691 } elsif ( $format eq 'extended' ) {
692 die "unimplemented\n";
696 die "unknown format $format";
699 eval "use Text::CSV_XS;";
702 my $csv = new Text::CSV_XS;
706 local $SIG{HUP} = 'IGNORE';
707 local $SIG{INT} = 'IGNORE';
708 local $SIG{QUIT} = 'IGNORE';
709 local $SIG{TERM} = 'IGNORE';
710 local $SIG{TSTP} = 'IGNORE';
711 local $SIG{PIPE} = 'IGNORE';
713 my $oldAutoCommit = $FS::UID::AutoCommit;
714 local $FS::UID::AutoCommit = 0;
718 while ( defined($line=<$fh>) ) {
720 $csv->parse($line) or do {
721 $dbh->rollback if $oldAutoCommit;
722 return "can't parse: ". $csv->error_input();
725 my @columns = $csv->fields();
729 paybatch => $paybatch,
733 foreach my $field ( @fields ) {
735 if ( $field eq 'agent_custid'
737 && $columns[0] =~ /\S+/ )
740 my $agent_custid = $columns[0];
741 my %hash = ( 'agent_custid' => $agent_custid,
742 'agentnum' => $agentnum,
745 if ( $cust_pay{'custnum'} !~ /^\s*$/ ) {
746 $dbh->rollback if $oldAutoCommit;
747 return "can't specify custnum with agent_custid $agent_custid";
750 $cust_main = qsearchs({
751 'table' => 'cust_main',
753 'extra_sql' => $extra_sql,
756 unless ( $cust_main ) {
757 $dbh->rollback if $oldAutoCommit;
758 return "can't find customer with agent_custid $agent_custid";
762 $columns[0] = $cust_main->custnum;
765 $cust_pay{$field} = shift @columns;
768 my $cust_pay = new FS::cust_pay( \%cust_pay );
769 my $error = $cust_pay->insert;
772 $dbh->rollback if $oldAutoCommit;
773 return "can't insert payment for $line: $error";
776 if ( $format eq 'simple' ) {
777 # include agentnum for less surprise?
778 $cust_main = qsearchs({
779 'table' => 'cust_main',
780 'hashref' => { 'custnum' => $cust_pay->custnum },
781 'extra_sql' => $extra_sql,
785 unless ( $cust_main ) {
786 $dbh->rollback if $oldAutoCommit;
787 return "can't find customer to which payments apply at line: $line";
790 $error = $cust_main->apply_payments_and_credits;
792 $dbh->rollback if $oldAutoCommit;
793 return "can't apply payments to customer for $line: $error";
801 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
803 return "Empty file!" unless $imported;
813 Delete and replace methods.
817 L<FS::cust_pay_pending>, L<FS::cust_bill_pay>, L<FS::cust_bill>, L<FS::Record>,
818 schema.html from the base documentation.