4 use base qw( FS::otaker_Mixin FS::payinfo_transaction_Mixin FS::cust_main_Mixin
6 use vars qw( $DEBUG $me $conf @encrypted_fields
7 $unsuspendauto $ignore_noapply
10 use Business::CreditCard;
12 use FS::UID qw( getotaker driver_name );
13 use FS::Misc qw( send_email );
14 use FS::Misc::DateTime qw( parse_datetime ); #for batch_import
15 use FS::Record qw( dbh qsearch qsearchs );
18 use FS::cust_main_Mixin;
19 use FS::payinfo_transaction_Mixin;
21 use FS::cust_bill_pay;
22 use FS::cust_pay_refund;
25 use FS::cust_pay_void;
26 use FS::upgrade_journal;
31 $me = '[FS::cust_pay]';
35 #ask FS::UID to run this stuff for us later
36 FS::UID->install_callback( sub {
38 $unsuspendauto = $conf->exists('unsuspendauto');
41 @encrypted_fields = ('payinfo');
42 sub nohistory_fields { ('payinfo'); }
46 FS::cust_pay - Object methods for cust_pay objects
52 $record = new FS::cust_pay \%hash;
53 $record = new FS::cust_pay { 'column' => 'value' };
55 $error = $record->insert;
57 $error = $new_record->replace($old_record);
59 $error = $record->delete;
61 $error = $record->check;
65 An FS::cust_pay object represents a payment; the transfer of money from a
66 customer. FS::cust_pay inherits from FS::Record. The following fields are
73 primary key (assigned automatically for new payments)
77 customer (see L<FS::cust_main>)
81 specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
82 L<Time::Local> and L<Date::Parse> for conversion functions.
86 Amount of this payment
90 order taker (see L<FS::access_user>)
94 Payment Type (See L<FS::payinfo_Mixin> for valid values)
98 Payment Information (See L<FS::payinfo_Mixin> for data format)
102 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
106 obsolete text field for tracking card processing or other batch grouping
110 Optional unique identifer to prevent duplicate transactions.
114 books closed flag, empty or `Y'
118 Desired pkgnum when using experimental package balances.
122 The bank where the payment was deposited.
126 The name of the depositor.
130 The deposit account number.
138 The number of the batch this payment came from (see L<FS::pay_batch>),
139 or null if it was processed through a realtime gateway or entered manually.
143 The number of the realtime or batch gateway L<FS::payment_gateway>) this
144 payment was processed through. Null if it was entered manually or processed
145 by the "system default" gateway, which doesn't have a number.
149 The name of the processor module (Business::OnlinePayment, ::BatchPayment,
150 or ::OnlineThirdPartyPayment subclass) used for this payment. Slightly
151 redundant with C<gatewaynum>.
155 The authorization number returned by the credit card network.
159 The transaction ID returned by the gateway, if any. This is usually what
160 you would use to initiate a void or refund of the payment.
170 Creates a new payment. To add the payment to the databse, see L<"insert">.
174 sub table { 'cust_pay'; }
175 sub cust_linked { $_[0]->cust_main_custnum; }
176 sub cust_unlinked_msg {
178 "WARNING: can't find cust_main.custnum ". $self->custnum.
179 ' (cust_pay.paynum '. $self->paynum. ')';
182 =item insert [ OPTION => VALUE ... ]
184 Adds this payment to the database.
186 For backwards-compatibility and convenience, if the additional field invnum
187 is defined, an FS::cust_bill_pay record for the full amount of the payment
188 will be created. In this case, custnum is optional.
190 If the additional field discount_term is defined then a prepayment discount
191 is taken for that length of time. It is an error for the customer to owe
192 after this payment is made.
194 A hash of optional arguments may be passed. Currently "manual" is supported.
195 If true, a payment receipt is sent instead of a statement when
196 'payment_receipt_email' configuration option is set.
198 About the "manual" flag: Normally, if the 'payment_receipt' config option
199 is set, and the customer has an invoice email address, inserting a payment
200 causes a I<statement> to be emailed to the customer. If the payment is
201 considered "manual" (or if the customer has no invoices), then it will
202 instead send a I<payment receipt>. "manual" should be true whenever a
203 payment is created directly from the web interface, from a user-initiated
204 realtime payment, or from a third-party payment via self-service. It should
205 be I<false> when creating a payment from a billing event or from a batch.
210 my($self, %options) = @_;
212 local $SIG{HUP} = 'IGNORE';
213 local $SIG{INT} = 'IGNORE';
214 local $SIG{QUIT} = 'IGNORE';
215 local $SIG{TERM} = 'IGNORE';
216 local $SIG{TSTP} = 'IGNORE';
217 local $SIG{PIPE} = 'IGNORE';
219 my $oldAutoCommit = $FS::UID::AutoCommit;
220 local $FS::UID::AutoCommit = 0;
224 if ( $self->invnum ) {
225 $cust_bill = qsearchs('cust_bill', { 'invnum' => $self->invnum } )
227 $dbh->rollback if $oldAutoCommit;
228 return "Unknown cust_bill.invnum: ". $self->invnum;
230 $self->custnum($cust_bill->custnum );
233 my $error = $self->check;
234 return $error if $error;
236 my $cust_main = $self->cust_main;
237 my $old_balance = $cust_main->balance;
239 $error = $self->SUPER::insert;
241 $dbh->rollback if $oldAutoCommit;
242 return "error inserting cust_pay: $error";
245 if ( my $credit_type = $conf->config('prepayment_discounts-credit_type') ) {
246 if ( my $months = $self->discount_term ) {
247 # XXX this should be moved out somewhere, but discount_term_values
249 my ($cust_bill) = ($cust_main->cust_bill)[-1]; # most recent invoice
250 return "can't accept prepayment for an unbilled customer" if !$cust_bill;
252 # %billing_pkgs contains this customer's active monthly packages.
253 # Recurring fees for those packages will be credited and then rebilled
254 # for the full discount term. Other packages on the last invoice
255 # (canceled, non-monthly recurring, or one-time charges) will be
257 my %billing_pkgs = map { $_->pkgnum => $_ }
258 grep { $_->part_pkg->freq eq '1' }
259 $cust_main->billing_pkgs;
260 my $credit = 0; # sum of recurring charges from that invoice
261 my $last_bill_date = 0; # the real bill date
262 foreach my $item ( $cust_bill->cust_bill_pkg ) {
263 next if !exists($billing_pkgs{$item->pkgnum}); # skip inactive packages
264 $credit += $item->recur;
265 $last_bill_date = $item->cust_pkg->last_bill
266 if defined($item->cust_pkg)
267 and $item->cust_pkg->last_bill > $last_bill_date
270 my $cust_credit = new FS::cust_credit {
271 'custnum' => $self->custnum,
272 'amount' => sprintf('%.2f', $credit),
273 'reason' => 'customer chose to prepay for discount',
275 $error = $cust_credit->insert('reason_type' => $credit_type);
277 $dbh->rollback if $oldAutoCommit;
278 return "error inserting prepayment credit: $error";
282 # bill for the entire term
283 $_->bill($_->last_bill) foreach (values %billing_pkgs);
284 $error = $cust_main->bill(
285 # no recurring_only, we want unbilled packages with start dates to
287 'no_usage_reset' => 1,
288 'time' => $last_bill_date, # not $cust_bill->_date
289 'pkg_list' => [ values %billing_pkgs ],
290 'freq_override' => $months,
293 $dbh->rollback if $oldAutoCommit;
294 return "error inserting cust_pay: $error";
296 $error = $cust_main->apply_payments_and_credits;
298 $dbh->rollback if $oldAutoCommit;
299 return "error inserting cust_pay: $error";
301 my $new_balance = $cust_main->balance;
302 if ($new_balance > 0) {
303 $dbh->rollback if $oldAutoCommit;
304 return "balance after prepay discount attempt: $new_balance";
306 # user friendly: override the "apply only to this invoice" mode
313 if ( $self->invnum ) {
314 my $cust_bill_pay = new FS::cust_bill_pay {
315 'invnum' => $self->invnum,
316 'paynum' => $self->paynum,
317 'amount' => $self->paid,
318 '_date' => $self->_date,
320 $error = $cust_bill_pay->insert(%options);
322 if ( $ignore_noapply ) {
323 warn "warning: error inserting cust_bill_pay: $error ".
324 "(ignore_noapply flag set; inserting cust_pay record anyway)\n";
326 $dbh->rollback if $oldAutoCommit;
327 return "error inserting cust_bill_pay: $error";
332 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
334 #false laziness w/ cust_credit::insert
335 if ( $unsuspendauto && $old_balance && $cust_main->balance <= 0 ) {
336 my @errors = $cust_main->unsuspend;
338 # side-fx with nested transactions? upstack rolls back?
339 warn "WARNING:Errors unsuspending customer ". $cust_main->custnum. ": ".
345 #bill setup fees for voip_cdr bill_every_call packages
346 #some false laziness w/search in freeside-cdrd
348 'LEFT JOIN part_pkg USING ( pkgpart ) '.
349 "LEFT JOIN part_pkg_option
350 ON ( cust_pkg.pkgpart = part_pkg_option.pkgpart
351 AND part_pkg_option.optionname = 'bill_every_call' )";
353 my $extra_sql = " AND plan = 'voip_cdr' AND optionvalue = '1' ".
354 " AND ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 ) ";
356 my @cust_pkg = qsearch({
357 'table' => 'cust_pkg',
358 'addl_from' => $addl_from,
359 'hashref' => { 'custnum' => $self->custnum,
363 'extra_sql' => $extra_sql,
367 warn "voip_cdr bill_every_call packages found; billing customer\n";
368 my $bill_error = $self->cust_main->bill_and_collect( 'fatal' => 'return' );
370 warn "WARNING: Error billing customer: $bill_error\n";
373 #end of billing setup fees for voip_cdr bill_every_call packages
375 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
378 my $trigger = $conf->config('payment_receipt-trigger',
379 $self->cust_main->agentnum) || 'cust_pay';
380 if ( $trigger eq 'cust_pay' ) {
381 my $error = $self->send_receipt(
382 'manual' => $options{'manual'},
383 'cust_bill' => $cust_bill,
384 'cust_main' => $cust_main,
386 warn "can't send payment receipt/statement: $error" if $error;
393 =item void [ REASON ]
395 Voids this payment: deletes the payment and all associated applications and
396 adds a record of the voided payment to the FS::cust_pay_void table.
403 local $SIG{HUP} = 'IGNORE';
404 local $SIG{INT} = 'IGNORE';
405 local $SIG{QUIT} = 'IGNORE';
406 local $SIG{TERM} = 'IGNORE';
407 local $SIG{TSTP} = 'IGNORE';
408 local $SIG{PIPE} = 'IGNORE';
410 my $oldAutoCommit = $FS::UID::AutoCommit;
411 local $FS::UID::AutoCommit = 0;
414 my $cust_pay_void = new FS::cust_pay_void ( {
415 map { $_ => $self->get($_) } $self->fields
417 $cust_pay_void->reason(shift) if scalar(@_);
418 my $error = $cust_pay_void->insert;
420 my $cust_pay_pending =
421 qsearchs('cust_pay_pending', { paynum => $self->paynum });
422 if ( $cust_pay_pending ) {
423 $cust_pay_pending->set('void_paynum', $self->paynum);
424 $cust_pay_pending->set('paynum', '');
425 $error ||= $cust_pay_pending->replace;
428 $error ||= $self->delete;
431 $dbh->rollback if $oldAutoCommit;
435 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
443 Unless the closed flag is set, deletes this payment and all associated
444 applications (see L<FS::cust_bill_pay> and L<FS::cust_pay_refund>). In most
445 cases, you want to use the void method instead to leave a record of the
450 # very similar to FS::cust_credit::delete
453 return "Can't delete closed payment" if $self->closed =~ /^Y/i;
455 local $SIG{HUP} = 'IGNORE';
456 local $SIG{INT} = 'IGNORE';
457 local $SIG{QUIT} = 'IGNORE';
458 local $SIG{TERM} = 'IGNORE';
459 local $SIG{TSTP} = 'IGNORE';
460 local $SIG{PIPE} = 'IGNORE';
462 my $oldAutoCommit = $FS::UID::AutoCommit;
463 local $FS::UID::AutoCommit = 0;
466 foreach my $app ( $self->cust_bill_pay, $self->cust_pay_refund ) {
467 my $error = $app->delete;
469 $dbh->rollback if $oldAutoCommit;
474 my $error = $self->SUPER::delete(@_);
476 $dbh->rollback if $oldAutoCommit;
480 if ( $conf->exists('deletepayments')
481 && $conf->config('deletepayments') ne '' ) {
483 my $cust_main = $self->cust_main;
485 my $error = send_email(
486 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
487 #invoice_from??? well as good as any
488 'to' => $conf->config('deletepayments'),
489 'subject' => 'FREESIDE NOTIFICATION: Payment deleted',
491 "This is an automatic message from your Freeside installation\n",
492 "informing you that the following payment has been deleted:\n",
494 'paynum: '. $self->paynum. "\n",
495 'custnum: '. $self->custnum.
496 " (". $cust_main->last. ", ". $cust_main->first. ")\n",
497 'paid: $'. sprintf("%.2f", $self->paid). "\n",
498 'date: '. time2str("%a %b %e %T %Y", $self->_date). "\n",
499 'payby: '. $self->payby. "\n",
500 'payinfo: '. $self->paymask. "\n",
501 'paybatch: '. $self->paybatch. "\n",
506 $dbh->rollback if $oldAutoCommit;
507 return "can't send payment deletion notification: $error";
512 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
518 =item replace [ OLD_RECORD ]
520 You can, but probably shouldn't modify payments...
522 Replaces the OLD_RECORD with this one in the database, or, if OLD_RECORD is not
523 supplied, replaces this record. If there is an error, returns the error,
524 otherwise returns false.
530 return "Can't modify closed payment" if $self->closed =~ /^Y/i;
531 $self->SUPER::replace(@_);
536 Checks all fields to make sure this is a valid payment. If there is an error,
537 returns the error, otherwise returns false. Called by the insert method.
544 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
547 $self->ut_numbern('paynum')
548 || $self->ut_numbern('custnum')
549 || $self->ut_numbern('_date')
550 || $self->ut_money('paid')
551 || $self->ut_alphan('otaker')
552 || $self->ut_textn('paybatch')
553 || $self->ut_textn('payunique')
554 || $self->ut_enum('closed', [ '', 'Y' ])
555 || $self->ut_foreign_keyn('pkgnum', 'cust_pkg', 'pkgnum')
556 || $self->ut_textn('bank')
557 || $self->ut_alphan('depositor')
558 || $self->ut_numbern('account')
559 || $self->ut_numbern('teller')
560 || $self->ut_foreign_keyn('batchnum', 'pay_batch', 'batchnum')
561 || $self->payinfo_check()
563 return $error if $error;
565 return "paid must be > 0 " if $self->paid <= 0;
567 return "unknown cust_main.custnum: ". $self->custnum
569 || qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
571 $self->_date(time) unless $self->_date;
573 return "invalid discount_term"
574 if ($self->discount_term && $self->discount_term < 2);
576 if ( $self->payby eq 'CASH' and $conf->exists('require_cash_deposit_info') ) {
577 foreach (qw(bank depositor account teller)) {
578 return "$_ required" if $self->get($_) eq '';
582 #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it
583 # # UNIQUE index should catch this too, without race conditions, but this
584 # # should give a better error message the other 99.9% of the time...
585 # if ( length($self->payunique)
586 # && qsearchs('cust_pay', { 'payunique' => $self->payunique } ) ) {
587 # #well, it *could* be a better error message
588 # return "duplicate transaction".
589 # " - a payment with unique identifer ". $self->payunique.
596 =item send_receipt HASHREF | OPTION => VALUE ...
598 Sends a payment receipt for this payment..
606 Flag indicating the payment is being made manually.
610 Invoice (FS::cust_bill) object. If not specified, the most recent invoice
615 Customer (FS::cust_main) object (for efficiency).
623 my $opt = ref($_[0]) ? shift : { @_ };
625 my $cust_bill = $opt->{'cust_bill'};
626 my $cust_main = $opt->{'cust_main'} || $self->cust_main;
628 my $conf = new FS::Conf;
630 return '' unless $conf->config_bool('payment_receipt', $cust_main->agentnum);
632 my @invoicing_list = $cust_main->invoicing_list_emailonly;
633 return '' unless @invoicing_list;
635 $cust_bill ||= ($cust_main->cust_bill)[-1]; #rather inefficient though?
639 if ( ( exists($opt->{'manual'}) && $opt->{'manual'} )
640 #|| ! $conf->exists('invoice_html_statement')
644 my $msgnum = $conf->config('payment_receipt_msgnum', $cust_main->agentnum);
647 my %substitutions = ();
648 $substitutions{invnum} = $opt->{cust_bill}->invnum if $opt->{cust_bill};
650 my $queue = new FS::queue {
651 'job' => 'FS::Misc::process_send_email',
652 'paynum' => $self->paynum,
653 'custnum' => $cust_main->custnum,
655 $error = $queue->insert(
656 FS::msg_template->by_key($msgnum)->prepare(
657 'cust_main' => $cust_main,
659 'from_config' => 'payment_receipt_from',
660 'substitutions' => \%substitutions,
662 'msgtype' => 'receipt', # override msg_template's default
665 } elsif ( $conf->exists('payment_receipt_email') ) {
667 my $receipt_template = new Text::Template (
669 SOURCE => [ map "$_\n", $conf->config('payment_receipt_email') ],
671 warn "can't create payment receipt template: $Text::Template::ERROR";
675 my $payby = $self->payby;
676 my $payinfo = $self->payinfo;
677 $payby =~ s/^BILL$/Check/ if $payinfo;
678 if ( $payby eq 'CARD' || $payby eq 'CHEK' ) {
679 $payinfo = $self->paymask
681 $payinfo = $self->decrypt($payinfo);
683 $payby =~ s/^CHEK$/Electronic check/;
686 'date' => time2str("%a %B %o, %Y", $self->_date),
687 'name' => $cust_main->name,
688 'paynum' => $self->paynum,
689 'paid' => sprintf("%.2f", $self->paid),
690 'payby' => ucfirst(lc($payby)),
691 'payinfo' => $payinfo,
692 'balance' => $cust_main->balance,
693 'company_name' => $conf->config('company_name', $cust_main->agentnum),
696 $fill_in{'invnum'} = $opt->{cust_bill}->invnum if $opt->{cust_bill};
698 if ( $opt->{'cust_pkg'} ) {
699 $fill_in{'pkg'} = $opt->{'cust_pkg'}->part_pkg->pkg;
700 #setup date, other things?
703 my $queue = new FS::queue {
704 'job' => 'FS::Misc::process_send_generated_email',
705 'paynum' => $self->paynum,
706 'custnum' => $cust_main->custnum,
707 'msgtype' => 'receipt',
709 $error = $queue->insert(
710 'from' => $conf->invoice_from_full( $cust_main->agentnum ),
711 #invoice_from??? well as good as any
712 'to' => \@invoicing_list,
713 'subject' => 'Payment receipt',
714 'body' => [ $receipt_template->fill_in( HASH => \%fill_in ) ],
719 warn "payment_receipt is on, but no payment_receipt_msgnum\n";
723 } elsif ( ! $cust_main->invoice_noemail ) { #not manual
725 my $queue = new FS::queue {
726 'job' => 'FS::cust_bill::queueable_email',
727 'paynum' => $self->paynum,
728 'custnum' => $cust_main->custnum,
732 'invnum' => $cust_bill->invnum,
736 if ( my $mode = $conf->config('payment_receipt_statement_mode') ) {
737 $opt{'mode'} = $mode;
739 # backward compatibility, no good fix for this yet as some people may
740 # still have "invoice_latex_statement" and such options
741 $opt{'template'} = 'statement';
742 $opt{'notice_name'} = 'Statement';
745 $error = $queue->insert(%opt);
749 warn "send_receipt: $error\n" if $error;
754 Returns all applications to invoices (see L<FS::cust_bill_pay>) for this
761 map { $_ } #return $self->num_cust_bill_pay unless wantarray;
762 sort { $a->_date <=> $b->_date
763 || $a->invnum <=> $b->invnum }
764 qsearch( 'cust_bill_pay', { 'paynum' => $self->paynum } )
768 =item cust_pay_refund
770 Returns all applications of refunds (see L<FS::cust_pay_refund>) to this
775 sub cust_pay_refund {
777 map { $_ } #return $self->num_cust_pay_refund unless wantarray;
778 sort { $a->_date <=> $b->_date }
779 qsearch( 'cust_pay_refund', { 'paynum' => $self->paynum } )
786 Returns the amount of this payment that is still unapplied; which is
787 paid minus all payment applications (see L<FS::cust_bill_pay>) and refund
788 applications (see L<FS::cust_pay_refund>).
794 my $amount = $self->paid;
795 $amount -= $_->amount foreach ( $self->cust_bill_pay );
796 $amount -= $_->amount foreach ( $self->cust_pay_refund );
797 sprintf("%.2f", $amount );
802 Returns the amount of this payment that has not been refuned; which is
803 paid minus all refund applications (see L<FS::cust_pay_refund>).
809 my $amount = $self->paid;
810 $amount -= $_->amount foreach ( $self->cust_pay_refund );
811 sprintf("%.2f", $amount );
816 Returns the "paid" field.
831 =item batch_insert CUST_PAY_OBJECT, ...
833 Class method which inserts multiple payments. Takes a list of FS::cust_pay
834 objects. Returns a list, each element representing the status of inserting the
835 corresponding payment - empty. If there is an error inserting any payment, the
836 entire transaction is rolled back, i.e. all payments are inserted or none are.
838 FS::cust_pay objects may have the pseudo-field 'apply_to', containing a
839 reference to an array of (uninserted) FS::cust_bill_pay objects. If so,
840 those objects will be inserted with the paynum of the payment, and for
841 each one, an error message or an empty string will be inserted into the
846 my @errors = FS::cust_pay->batch_insert(@cust_pay);
847 my $num_errors = scalar(grep $_, @errors);
848 if ( $num_errors == 0 ) {
849 #success; all payments were inserted
851 #failure; no payments were inserted.
857 my $self = shift; #class method
859 local $SIG{HUP} = 'IGNORE';
860 local $SIG{INT} = 'IGNORE';
861 local $SIG{QUIT} = 'IGNORE';
862 local $SIG{TERM} = 'IGNORE';
863 local $SIG{TSTP} = 'IGNORE';
864 local $SIG{PIPE} = 'IGNORE';
866 my $oldAutoCommit = $FS::UID::AutoCommit;
867 local $FS::UID::AutoCommit = 0;
873 foreach my $cust_pay (@_) {
874 my $error = $cust_pay->insert( 'manual' => 1 );
875 push @errors, $error;
876 $num_errors++ if $error;
878 if ( ref($cust_pay->get('apply_to')) eq 'ARRAY' ) {
880 foreach my $cust_bill_pay ( @{ $cust_pay->apply_to } ) {
881 if ( $error ) { # insert placeholders if cust_pay wasn't inserted
885 $cust_bill_pay->set('paynum', $cust_pay->paynum);
886 my $apply_error = $cust_bill_pay->insert;
887 push @errors, $apply_error || '';
888 $num_errors++ if $apply_error;
892 } elsif ( !$error ) { #normal case: apply payments as usual
893 $cust_pay->cust_main->apply_payments;
899 $dbh->rollback if $oldAutoCommit;
901 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
910 Returns an SQL fragment to retreive the unapplied amount.
915 my ($class, $start, $end) = @_;
916 my $bill_start = $start ? "AND cust_bill_pay._date <= $start" : '';
917 my $bill_end = $end ? "AND cust_bill_pay._date > $end" : '';
918 my $refund_start = $start ? "AND cust_pay_refund._date <= $start" : '';
919 my $refund_end = $end ? "AND cust_pay_refund._date > $end" : '';
923 ( SELECT SUM(amount) FROM cust_bill_pay
924 WHERE cust_pay.paynum = cust_bill_pay.paynum
925 $bill_start $bill_end )
929 ( SELECT SUM(amount) FROM cust_pay_refund
930 WHERE cust_pay.paynum = cust_pay_refund.paynum
931 $refund_start $refund_end )
940 # Used by FS::Upgrade to migrate to a new database.
944 sub _upgrade_data { #class method
945 my ($class, %opt) = @_;
947 warn "$me upgrading $class\n" if $DEBUG;
949 local $FS::payinfo_Mixin::ignore_masked_payinfo = 1;
952 # otaker/ivan upgrade
955 unless ( FS::upgrade_journal->is_done('cust_pay__otaker_ivan') ) {
957 #not the most efficient, but hey, it only has to run once
959 my $where = "WHERE ( otaker IS NULL OR otaker = '' OR otaker = 'ivan' ) ".
960 " AND usernum IS NULL ".
961 " AND 0 < ( SELECT COUNT(*) FROM cust_main ".
962 " WHERE cust_main.custnum = cust_pay.custnum ) ";
964 my $count_sql = "SELECT COUNT(*) FROM cust_pay $where";
966 my $sth = dbh->prepare($count_sql) or die dbh->errstr;
967 $sth->execute or die $sth->errstr;
968 my $total = $sth->fetchrow_arrayref->[0];
969 #warn "$total cust_pay records to update\n"
971 local($DEBUG) = 2 if $total > 1000; #could be a while, force progress info
976 my @cust_pay = qsearch( {
977 'table' => 'cust_pay',
979 'extra_sql' => $where,
980 'order_by' => 'ORDER BY paynum',
983 foreach my $cust_pay (@cust_pay) {
985 my $h_cust_pay = $cust_pay->h_search('insert');
987 next if $cust_pay->otaker eq $h_cust_pay->history_user;
988 #$cust_pay->otaker($h_cust_pay->history_user);
989 $cust_pay->set('otaker', $h_cust_pay->history_user);
991 $cust_pay->set('otaker', 'legacy');
994 delete $FS::payby::hash{'COMP'}->{cust_pay}; #quelle kludge
995 my $error = $cust_pay->replace;
998 warn " *** WARNING: Error updating order taker for payment paynum ".
999 $cust_pay->paynun. ": $error\n";
1003 $FS::payby::hash{'COMP'}->{cust_pay} = ''; #restore it
1006 if ( $DEBUG > 1 && $lastprog + 30 < time ) {
1007 warn "$me $count/$total (".sprintf('%.2f',100*$count/$total). '%)'."\n";
1013 FS::upgrade_journal->set_done('cust_pay__otaker_ivan');
1017 # payinfo N/A upgrade
1020 unless ( FS::upgrade_journal->is_done('cust_pay__payinfo_na') ) {
1022 #XXX remove the 'N/A (tokenized)' part (or just this entire thing)
1024 my @na_cust_pay = qsearch( {
1025 'table' => 'cust_pay',
1026 'hashref' => {}, #could be encrypted# { 'payinfo' => 'N/A' },
1027 'extra_sql' => "WHERE ( payinfo = 'N/A' OR paymask = 'N/AA' OR paymask = 'N/A (tokenized)' ) AND payby IN ( 'CARD', 'CHEK' )",
1030 foreach my $na ( @na_cust_pay ) {
1032 next unless $na->payinfo eq 'N/A';
1034 my $cust_pay_pending =
1035 qsearchs('cust_pay_pending', { 'paynum' => $na->paynum } );
1036 unless ( $cust_pay_pending ) {
1037 warn " *** WARNING: not-yet recoverable N/A card for payment ".
1038 $na->paynum. " (no cust_pay_pending)\n";
1041 $na->$_($cust_pay_pending->$_) for qw( payinfo paymask );
1042 my $error = $na->replace;
1044 warn " *** WARNING: Error updating payinfo for payment paynum ".
1045 $na->paynun. ": $error\n";
1051 FS::upgrade_journal->set_done('cust_pay__payinfo_na');
1055 # otaker->usernum upgrade
1058 delete $FS::payby::hash{'COMP'}->{cust_pay}; #quelle kludge
1059 $class->_upgrade_otaker(%opt);
1060 $FS::payby::hash{'COMP'}->{cust_pay} = ''; #restore it
1062 # if we do this anywhere else, it should become an FS::Upgrade method
1063 my $num_to_upgrade = $class->count('paybatch is not null');
1064 my $num_jobs = FS::queue->count('job = \'FS::cust_pay::process_upgrade_paybatch\' and status != \'failed\'');
1065 if ( $num_to_upgrade > 0 ) {
1066 warn "Need to migrate paybatch field in $num_to_upgrade payments.\n";
1067 if ( $opt{queue} ) {
1068 if ( $num_jobs > 0 ) {
1069 warn "Upgrade already queued.\n";
1071 warn "Scheduling upgrade.\n";
1072 my $job = FS::queue->new({ job => 'FS::cust_pay::process_upgrade_paybatch' });
1076 process_upgrade_paybatch();
1081 sub process_upgrade_paybatch {
1083 local $FS::payinfo_Mixin::ignore_masked_payinfo = 1;
1084 local $FS::UID::AutoCommit = 1;
1087 # migrate batchnums from the misused 'paybatch' field to 'batchnum'
1089 my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
1090 my $search = FS::Cursor->new( {
1091 'table' => 'cust_pay',
1092 'addl_from' => " JOIN pay_batch ON cust_pay.paybatch = CAST(pay_batch.batchnum AS $text) ",
1094 while (my $cust_pay = $search->fetch) {
1095 $cust_pay->set('batchnum' => $cust_pay->paybatch);
1096 $cust_pay->set('paybatch' => '');
1097 my $error = $cust_pay->replace;
1098 warn "error setting batchnum on cust_pay #".$cust_pay->paynum.":\n $error"
1103 # migrate gateway info from the misused 'paybatch' field
1106 # not only cust_pay, but also voided and refunded payments
1107 if (!FS::upgrade_journal->is_done('cust_pay__parse_paybatch_1')) {
1108 local $FS::Record::nowarn_classload=1;
1109 # really inefficient, but again, only has to run once
1110 foreach my $table (qw(cust_pay cust_pay_void cust_refund)) {
1111 my $and_batchnum_is_null =
1112 ( $table =~ /^cust_pay/ ? ' AND batchnum IS NULL' : '' );
1113 my $pkey = ($table =~ /^cust_pay/ ? 'paynum' : 'refundnum');
1114 my $search = FS::Cursor->new({
1116 extra_sql => "WHERE payby IN('CARD','CHEK') ".
1117 "AND (paybatch IS NOT NULL ".
1118 "OR (paybatch IS NULL AND auth IS NULL
1119 $and_batchnum_is_null ) )
1120 ORDER BY $pkey DESC"
1122 while ( my $object = $search->fetch ) {
1123 if ( $object->paybatch eq '' ) {
1124 # repair for a previous upgrade that didn't save 'auth'
1125 my $pkey = $object->primary_key;
1126 # find the last history record that had a paybatch value
1128 table => "h_$table",
1130 $pkey => $object->$pkey,
1131 paybatch => { op=>'!=', value=>''},
1132 history_action => 'replace_old',
1134 order_by => 'ORDER BY history_date DESC LIMIT 1',
1137 warn "couldn't find paybatch history record for $table ".$object->$pkey."\n";
1140 # if the paybatch didn't have an auth string, then it's fine
1141 $h->paybatch =~ /:(\w+):/ or next;
1142 # set paybatch to what it was in that record
1143 $object->set('paybatch', $h->paybatch)
1144 # and then upgrade it like the old records
1147 my $parsed = $object->_parse_paybatch;
1148 if (keys %$parsed) {
1149 $object->set($_ => $parsed->{$_}) foreach keys %$parsed;
1150 $object->set('auth' => $parsed->{authorization});
1151 $object->set('paybatch', '');
1152 my $error = $object->replace;
1153 warn "error parsing CARD/CHEK paybatch fields on $object #".
1154 $object->get($object->primary_key).":\n $error\n"
1159 FS::upgrade_journal->set_done('cust_pay__parse_paybatch_1');
1169 =item batch_import HASHREF
1171 Inserts new payments.
1178 my $fh = $param->{filehandle};
1179 my $format = $param->{'format'};
1181 my $agentnum = $param->{agentnum};
1182 my $_date = $param->{_date};
1183 $_date = parse_datetime($_date) if $_date && $_date =~ /\D/;
1184 my $paybatch = $param->{'paybatch'};
1186 my $custnum_prefix = $conf->config('cust_main-custnum-display_prefix');
1187 my $custnum_length = $conf->config('cust_main-custnum-display_length') || 8;
1189 # here is the agent virtualization
1190 my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
1194 if ( $format eq 'simple' ) {
1195 @fields = qw( custnum agent_custid paid payinfo invnum );
1197 } elsif ( $format eq 'extended' ) {
1198 die "unimplemented\n";
1202 die "unknown format $format";
1205 eval "use Text::CSV_XS;";
1208 my $csv = new Text::CSV_XS;
1212 local $SIG{HUP} = 'IGNORE';
1213 local $SIG{INT} = 'IGNORE';
1214 local $SIG{QUIT} = 'IGNORE';
1215 local $SIG{TERM} = 'IGNORE';
1216 local $SIG{TSTP} = 'IGNORE';
1217 local $SIG{PIPE} = 'IGNORE';
1219 my $oldAutoCommit = $FS::UID::AutoCommit;
1220 local $FS::UID::AutoCommit = 0;
1224 while ( defined($line=<$fh>) ) {
1226 $csv->parse($line) or do {
1227 $dbh->rollback if $oldAutoCommit;
1228 return "can't parse: ". $csv->error_input();
1231 my @columns = $csv->fields();
1235 paybatch => $paybatch,
1237 $cust_pay{_date} = $_date if $_date;
1240 foreach my $field ( @fields ) {
1242 if ( $field eq 'agent_custid'
1244 && $columns[0] =~ /\S+/ )
1247 my $agent_custid = $columns[0];
1248 my %hash = ( 'agent_custid' => $agent_custid,
1249 'agentnum' => $agentnum,
1252 if ( $cust_pay{'custnum'} !~ /^\s*$/ ) {
1253 $dbh->rollback if $oldAutoCommit;
1254 return "can't specify custnum with agent_custid $agent_custid";
1257 $cust_main = qsearchs({
1258 'table' => 'cust_main',
1259 'hashref' => \%hash,
1260 'extra_sql' => $extra_sql,
1263 unless ( $cust_main ) {
1264 $dbh->rollback if $oldAutoCommit;
1265 return "can't find customer with agent_custid $agent_custid";
1269 $columns[0] = $cust_main->custnum;
1272 $cust_pay{$field} = shift @columns;
1275 if ( $custnum_prefix && $cust_pay{custnum} =~ /^$custnum_prefix(0*([1-9]\d*))$/
1276 && length($1) == $custnum_length ) {
1277 $cust_pay{custnum} = $2;
1280 my $custnum = $cust_pay{custnum};
1282 my $cust_pay = new FS::cust_pay( \%cust_pay );
1283 my $error = $cust_pay->insert;
1285 if ( ! $error && $cust_pay->custnum != $custnum ) {
1286 #invnum was defined, and ->insert set custnum to the customer for that
1287 #invoice, but it wasn't the one the import specified.
1288 $dbh->rollback if $oldAutoCommit;
1289 $error = "specified invoice #". $cust_pay{invnum}.
1290 " is for custnum ". $cust_pay->custnum.
1291 ", not specified custnum $custnum";
1295 $dbh->rollback if $oldAutoCommit;
1296 return "can't insert payment for $line: $error";
1299 if ( $format eq 'simple' ) {
1300 # include agentnum for less surprise?
1301 $cust_main = qsearchs({
1302 'table' => 'cust_main',
1303 'hashref' => { 'custnum' => $cust_pay->custnum },
1304 'extra_sql' => $extra_sql,
1308 unless ( $cust_main ) {
1309 $dbh->rollback if $oldAutoCommit;
1310 return "can't find customer to which payments apply at line: $line";
1313 $error = $cust_main->apply_payments_and_credits;
1315 $dbh->rollback if $oldAutoCommit;
1316 return "can't apply payments to customer for $line: $error";
1324 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1326 return "Empty file!" unless $imported;
1336 Delete and replace methods.
1340 L<FS::cust_pay_pending>, L<FS::cust_bill_pay>, L<FS::cust_bill>, L<FS::Record>,
1341 schema.html from the base documentation.