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::Misc::DateTime qw( parse_datetime ); #for batch_import
13 use FS::Record qw( dbh qsearch qsearchs );
16 use FS::cust_main_Mixin;
17 use FS::payinfo_transaction_Mixin;
19 use FS::cust_bill_pay;
20 use FS::cust_pay_refund;
23 use FS::cust_pay_void;
24 use FS::upgrade_journal;
29 $me = '[FS::cust_pay]';
33 #ask FS::UID to run this stuff for us later
34 FS::UID->install_callback( sub {
36 $unsuspendauto = $conf->exists('unsuspendauto');
39 @encrypted_fields = ('payinfo');
40 sub nohistory_fields { ('payinfo'); }
44 FS::cust_pay - Object methods for cust_pay objects
50 $record = new FS::cust_pay \%hash;
51 $record = new FS::cust_pay { 'column' => 'value' };
53 $error = $record->insert;
55 $error = $new_record->replace($old_record);
57 $error = $record->delete;
59 $error = $record->check;
63 An FS::cust_pay object represents a payment; the transfer of money from a
64 customer. FS::cust_pay inherits from FS::Record. The following fields are
71 primary key (assigned automatically for new payments)
75 customer (see L<FS::cust_main>)
79 specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
80 L<Time::Local> and L<Date::Parse> for conversion functions.
84 Amount of this payment
88 order taker (see L<FS::access_user>)
92 Payment Type (See L<FS::payinfo_Mixin> for valid values)
96 Payment Information (See L<FS::payinfo_Mixin> for data format)
100 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
104 obsolete text field for tracking card processing or other batch grouping
108 Optional unique identifer to prevent duplicate transactions.
112 books closed flag, empty or `Y'
116 Desired pkgnum when using experimental package balances.
120 The bank where the payment was deposited.
124 The name of the depositor.
128 The deposit account number.
136 The number of the batch this payment came from (see L<FS::pay_batch>),
137 or null if it was processed through a realtime gateway or entered manually.
141 The number of the realtime or batch gateway L<FS::payment_gateway>) this
142 payment was processed through. Null if it was entered manually or processed
143 by the "system default" gateway, which doesn't have a number.
147 The name of the processor module (Business::OnlinePayment, ::BatchPayment,
148 or ::OnlineThirdPartyPayment subclass) used for this payment. Slightly
149 redundant with C<gatewaynum>.
153 The authorization number returned by the credit card network.
157 The transaction ID returned by the gateway, if any. This is usually what
158 you would use to initiate a void or refund of the payment.
168 Creates a new payment. To add the payment to the databse, see L<"insert">.
172 sub table { 'cust_pay'; }
173 sub cust_linked { $_[0]->cust_main_custnum || $_[0]->custnum; }
174 sub cust_unlinked_msg {
176 "WARNING: can't find cust_main.custnum ". $self->custnum.
177 ' (cust_pay.paynum '. $self->paynum. ')';
180 =item insert [ OPTION => VALUE ... ]
182 Adds this payment to the database.
184 For backwards-compatibility and convenience, if the additional field invnum
185 is defined, an FS::cust_bill_pay record for the full amount of the payment
186 will be created. In this case, custnum is optional.
188 If the additional field discount_term is defined then a prepayment discount
189 is taken for that length of time. It is an error for the customer to owe
190 after this payment is made.
192 A hash of optional arguments may be passed. Currently "manual" is supported.
193 If true, a payment receipt is sent instead of a statement when
194 'payment_receipt_email' configuration option is set.
196 About the "manual" flag: Normally, if the 'payment_receipt' config option
197 is set, and the customer has an invoice email address, inserting a payment
198 causes a I<statement> to be emailed to the customer. If the payment is
199 considered "manual" (or if the customer has no invoices), then it will
200 instead send a I<payment receipt>. "manual" should be true whenever a
201 payment is created directly from the web interface, from a user-initiated
202 realtime payment, or from a third-party payment via self-service. It should
203 be I<false> when creating a payment from a billing event or from a batch.
208 my($self, %options) = @_;
210 local $SIG{HUP} = 'IGNORE';
211 local $SIG{INT} = 'IGNORE';
212 local $SIG{QUIT} = 'IGNORE';
213 local $SIG{TERM} = 'IGNORE';
214 local $SIG{TSTP} = 'IGNORE';
215 local $SIG{PIPE} = 'IGNORE';
217 my $oldAutoCommit = $FS::UID::AutoCommit;
218 local $FS::UID::AutoCommit = 0;
222 if ( $self->invnum ) {
223 $cust_bill = qsearchs('cust_bill', { 'invnum' => $self->invnum } )
225 $dbh->rollback if $oldAutoCommit;
226 return "Unknown cust_bill.invnum: ". $self->invnum;
228 $self->custnum($cust_bill->custnum );
231 my $error = $self->check;
232 return $error if $error;
234 my $cust_main = $self->cust_main;
235 my $old_balance = $cust_main->balance;
237 $error = $self->SUPER::insert;
239 $dbh->rollback if $oldAutoCommit;
240 return "error inserting cust_pay: $error";
243 if ( my $credit_type = $conf->config('prepayment_discounts-credit_type') ) {
244 if ( my $months = $self->discount_term ) {
245 # XXX this should be moved out somewhere, but discount_term_values
247 my ($cust_bill) = ($cust_main->cust_bill)[-1]; # most recent invoice
248 return "can't accept prepayment for an unbilled customer" if !$cust_bill;
250 # %billing_pkgs contains this customer's active monthly packages.
251 # Recurring fees for those packages will be credited and then rebilled
252 # for the full discount term. Other packages on the last invoice
253 # (canceled, non-monthly recurring, or one-time charges) will be
255 my %billing_pkgs = map { $_->pkgnum => $_ }
256 grep { $_->part_pkg->freq eq '1' }
257 $cust_main->billing_pkgs;
258 my $credit = 0; # sum of recurring charges from that invoice
259 my $last_bill_date = 0; # the real bill date
260 foreach my $item ( $cust_bill->cust_bill_pkg ) {
261 next if !exists($billing_pkgs{$item->pkgnum}); # skip inactive packages
262 $credit += $item->recur;
263 $last_bill_date = $item->cust_pkg->last_bill
264 if defined($item->cust_pkg)
265 and $item->cust_pkg->last_bill > $last_bill_date
268 my $cust_credit = new FS::cust_credit {
269 'custnum' => $self->custnum,
270 'amount' => sprintf('%.2f', $credit),
271 'reason' => 'customer chose to prepay for discount',
273 $error = $cust_credit->insert('reason_type' => $credit_type);
275 $dbh->rollback if $oldAutoCommit;
276 return "error inserting prepayment credit: $error";
280 # bill for the entire term
281 $_->bill($_->last_bill) foreach (values %billing_pkgs);
282 $error = $cust_main->bill(
283 # no recurring_only, we want unbilled packages with start dates to
285 'no_usage_reset' => 1,
286 'time' => $last_bill_date, # not $cust_bill->_date
287 'pkg_list' => [ values %billing_pkgs ],
288 'freq_override' => $months,
291 $dbh->rollback if $oldAutoCommit;
292 return "error inserting cust_pay: $error";
294 $error = $cust_main->apply_payments_and_credits;
296 $dbh->rollback if $oldAutoCommit;
297 return "error inserting cust_pay: $error";
299 my $new_balance = $cust_main->balance;
300 if ($new_balance > 0) {
301 $dbh->rollback if $oldAutoCommit;
302 return "balance after prepay discount attempt: $new_balance";
304 # user friendly: override the "apply only to this invoice" mode
311 if ( $self->invnum ) {
312 my $cust_bill_pay = new FS::cust_bill_pay {
313 'invnum' => $self->invnum,
314 'paynum' => $self->paynum,
315 'amount' => $self->paid,
316 '_date' => $self->_date,
318 $error = $cust_bill_pay->insert(%options);
320 if ( $ignore_noapply ) {
321 warn "warning: error inserting cust_bill_pay: $error ".
322 "(ignore_noapply flag set; inserting cust_pay record anyway)\n";
324 $dbh->rollback if $oldAutoCommit;
325 return "error inserting cust_bill_pay: $error";
330 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
332 #false laziness w/ cust_credit::insert
333 if ( $unsuspendauto && $old_balance && $cust_main->balance <= 0 ) {
334 my @errors = $cust_main->unsuspend;
336 # side-fx with nested transactions? upstack rolls back?
337 warn "WARNING:Errors unsuspending customer ". $cust_main->custnum. ": ".
343 #bill setup fees for voip_cdr bill_every_call packages
344 #some false laziness w/search in freeside-cdrd
346 'LEFT JOIN part_pkg USING ( pkgpart ) '.
347 "LEFT JOIN part_pkg_option
348 ON ( cust_pkg.pkgpart = part_pkg_option.pkgpart
349 AND part_pkg_option.optionname = 'bill_every_call' )";
351 my $extra_sql = " AND plan = 'voip_cdr' AND optionvalue = '1' ".
352 " AND ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 ) ";
354 my @cust_pkg = qsearch({
355 'table' => 'cust_pkg',
356 'addl_from' => $addl_from,
357 'hashref' => { 'custnum' => $self->custnum,
361 'extra_sql' => $extra_sql,
365 warn "voip_cdr bill_every_call packages found; billing customer\n";
366 my $bill_error = $self->cust_main->bill_and_collect( 'fatal' => 'return' );
368 warn "WARNING: Error billing customer: $bill_error\n";
371 #end of billing setup fees for voip_cdr bill_every_call packages
373 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
376 my $trigger = $conf->config('payment_receipt-trigger',
377 $self->cust_main->agentnum) || 'cust_pay';
378 if ( $trigger eq 'cust_pay' ) {
379 my $error = $self->send_receipt(
380 'manual' => $options{'manual'},
381 'cust_bill' => $cust_bill,
382 'cust_main' => $cust_main,
384 warn "can't send payment receipt/statement: $error" if $error;
391 =item void [ REASON ]
393 Voids this payment: deletes the payment and all associated applications and
394 adds a record of the voided payment to the FS::cust_pay_void table.
401 local $SIG{HUP} = 'IGNORE';
402 local $SIG{INT} = 'IGNORE';
403 local $SIG{QUIT} = 'IGNORE';
404 local $SIG{TERM} = 'IGNORE';
405 local $SIG{TSTP} = 'IGNORE';
406 local $SIG{PIPE} = 'IGNORE';
408 my $oldAutoCommit = $FS::UID::AutoCommit;
409 local $FS::UID::AutoCommit = 0;
412 my $cust_pay_void = new FS::cust_pay_void ( {
413 map { $_ => $self->get($_) } $self->fields
415 $cust_pay_void->reason(shift) if scalar(@_);
416 my $error = $cust_pay_void->insert;
418 my $cust_pay_pending =
419 qsearchs('cust_pay_pending', { paynum => $self->paynum });
420 if ( $cust_pay_pending ) {
421 $cust_pay_pending->set('void_paynum', $self->paynum);
422 $cust_pay_pending->set('paynum', '');
423 $error ||= $cust_pay_pending->replace;
426 $error ||= $self->delete;
429 $dbh->rollback if $oldAutoCommit;
433 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
441 Unless the closed flag is set, deletes this payment and all associated
442 applications (see L<FS::cust_bill_pay> and L<FS::cust_pay_refund>). In most
443 cases, you want to use the void method instead to leave a record of the
448 # very similar to FS::cust_credit::delete
451 return "Can't delete closed payment" if $self->closed =~ /^Y/i;
453 local $SIG{HUP} = 'IGNORE';
454 local $SIG{INT} = 'IGNORE';
455 local $SIG{QUIT} = 'IGNORE';
456 local $SIG{TERM} = 'IGNORE';
457 local $SIG{TSTP} = 'IGNORE';
458 local $SIG{PIPE} = 'IGNORE';
460 my $oldAutoCommit = $FS::UID::AutoCommit;
461 local $FS::UID::AutoCommit = 0;
464 foreach my $app ( $self->cust_bill_pay, $self->cust_pay_refund ) {
465 my $error = $app->delete;
467 $dbh->rollback if $oldAutoCommit;
472 my $error = $self->SUPER::delete(@_);
474 $dbh->rollback if $oldAutoCommit;
478 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
484 =item replace [ OLD_RECORD ]
486 You can, but probably shouldn't modify payments...
488 Replaces the OLD_RECORD with this one in the database, or, if OLD_RECORD is not
489 supplied, replaces this record. If there is an error, returns the error,
490 otherwise returns false.
496 return "Can't modify closed payment" if $self->closed =~ /^Y/i;
497 $self->SUPER::replace(@_);
502 Checks all fields to make sure this is a valid payment. If there is an error,
503 returns the error, otherwise returns false. Called by the insert method.
510 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
513 $self->ut_numbern('paynum')
514 || $self->ut_numbern('custnum')
515 || $self->ut_numbern('_date')
516 || $self->ut_money('paid')
517 || $self->ut_alphan('otaker')
518 || $self->ut_textn('paybatch')
519 || $self->ut_textn('payunique')
520 || $self->ut_enum('closed', [ '', 'Y' ])
521 || $self->ut_foreign_keyn('pkgnum', 'cust_pkg', 'pkgnum')
522 || $self->ut_textn('bank')
523 || $self->ut_alphan('depositor')
524 || $self->ut_numbern('account')
525 || $self->ut_numbern('teller')
526 || $self->ut_foreign_keyn('batchnum', 'pay_batch', 'batchnum')
527 || $self->payinfo_check()
529 return $error if $error;
531 return "paid must be > 0 " if $self->paid <= 0;
533 return "unknown cust_main.custnum: ". $self->custnum
535 || qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
537 $self->_date(time) unless $self->_date;
539 return "invalid discount_term"
540 if ($self->discount_term && $self->discount_term < 2);
542 if ( $self->payby eq 'CASH' and $conf->exists('require_cash_deposit_info') ) {
543 foreach (qw(bank depositor account teller)) {
544 return "$_ required" if $self->get($_) eq '';
548 #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it
549 # # UNIQUE index should catch this too, without race conditions, but this
550 # # should give a better error message the other 99.9% of the time...
551 # if ( length($self->payunique)
552 # && qsearchs('cust_pay', { 'payunique' => $self->payunique } ) ) {
553 # #well, it *could* be a better error message
554 # return "duplicate transaction".
555 # " - a payment with unique identifer ". $self->payunique.
562 =item send_receipt HASHREF | OPTION => VALUE ...
564 Sends a payment receipt for this payment..
572 Flag indicating the payment is being made manually.
576 Invoice (FS::cust_bill) object. If not specified, the most recent invoice
581 Customer (FS::cust_main) object (for efficiency).
589 my $opt = ref($_[0]) ? shift : { @_ };
591 my $cust_bill = $opt->{'cust_bill'};
592 my $cust_main = $opt->{'cust_main'} || $self->cust_main;
594 my $conf = new FS::Conf;
596 return '' unless $conf->config_bool('payment_receipt', $cust_main->agentnum);
598 my @invoicing_list = $cust_main->invoicing_list_emailonly;
599 return '' unless @invoicing_list;
601 $cust_bill ||= ($cust_main->cust_bill)[-1]; #rather inefficient though?
605 if ( ( exists($opt->{'manual'}) && $opt->{'manual'} )
606 #|| ! $conf->exists('invoice_html_statement')
610 my $msgnum = $conf->config('payment_receipt_msgnum', $cust_main->agentnum);
613 my $queue = new FS::queue {
614 'job' => 'FS::Misc::process_send_email',
615 'paynum' => $self->paynum,
616 'custnum' => $cust_main->custnum,
618 $error = $queue->insert(
619 FS::msg_template->by_key($msgnum)->prepare(
620 'cust_main' => $cust_main,
622 'from_config' => 'payment_receipt_from',
624 'msgtype' => 'receipt', # override msg_template's default
627 } elsif ( $conf->exists('payment_receipt_email') ) {
629 my $receipt_template = new Text::Template (
631 SOURCE => [ map "$_\n", $conf->config('payment_receipt_email') ],
633 warn "can't create payment receipt template: $Text::Template::ERROR";
637 my $payby = $self->payby;
638 my $payinfo = $self->payinfo;
639 $payby =~ s/^BILL$/Check/ if $payinfo;
640 if ( $payby eq 'CARD' || $payby eq 'CHEK' ) {
641 $payinfo = $self->paymask
643 $payinfo = $self->decrypt($payinfo);
645 $payby =~ s/^CHEK$/Electronic check/;
648 'date' => time2str("%a %B %o, %Y", $self->_date),
649 'name' => $cust_main->name,
650 'paynum' => $self->paynum,
651 'paid' => sprintf("%.2f", $self->paid),
652 'payby' => ucfirst(lc($payby)),
653 'payinfo' => $payinfo,
654 'balance' => $cust_main->balance,
655 'company_name' => $conf->config('company_name', $cust_main->agentnum),
658 $fill_in{'invnum'} = $opt->{cust_bill}->invnum if $opt->{cust_bill};
660 if ( $opt->{'cust_pkg'} ) {
661 $fill_in{'pkg'} = $opt->{'cust_pkg'}->part_pkg->pkg;
662 #setup date, other things?
665 my $queue = new FS::queue {
666 'job' => 'FS::Misc::process_send_generated_email',
667 'paynum' => $self->paynum,
668 'custnum' => $cust_main->custnum,
669 'msgtype' => 'receipt',
671 $error = $queue->insert(
672 'from' => $conf->config('invoice_from', $cust_main->agentnum),
673 #invoice_from??? well as good as any
674 'to' => \@invoicing_list,
675 'subject' => 'Payment receipt',
676 'body' => [ $receipt_template->fill_in( HASH => \%fill_in ) ],
681 warn "payment_receipt is on, but no payment_receipt_msgnum\n";
685 } elsif ( ! $cust_main->invoice_noemail ) { #not manual
687 my $queue = new FS::queue {
688 'job' => 'FS::cust_bill::queueable_email',
689 'paynum' => $self->paynum,
690 'custnum' => $cust_main->custnum,
693 $error = $queue->insert(
694 'invnum' => $cust_bill->invnum,
695 'template' => 'statement',
696 'notice_name' => 'Statement',
702 warn "send_receipt: $error\n" if $error;
707 Returns all applications to invoices (see L<FS::cust_bill_pay>) for this
714 map { $_ } #return $self->num_cust_bill_pay unless wantarray;
715 sort { $a->_date <=> $b->_date
716 || $a->invnum <=> $b->invnum }
717 qsearch( 'cust_bill_pay', { 'paynum' => $self->paynum } )
721 =item cust_pay_refund
723 Returns all applications of refunds (see L<FS::cust_pay_refund>) to this
728 sub cust_pay_refund {
730 map { $_ } #return $self->num_cust_pay_refund unless wantarray;
731 sort { $a->_date <=> $b->_date }
732 qsearch( 'cust_pay_refund', { 'paynum' => $self->paynum } )
739 Returns the amount of this payment that is still unapplied; which is
740 paid minus all payment applications (see L<FS::cust_bill_pay>) and refund
741 applications (see L<FS::cust_pay_refund>).
747 my $amount = $self->paid;
748 $amount -= $_->amount foreach ( $self->cust_bill_pay );
749 $amount -= $_->amount foreach ( $self->cust_pay_refund );
750 sprintf("%.2f", $amount );
755 Returns the amount of this payment that has not been refuned; which is
756 paid minus all refund applications (see L<FS::cust_pay_refund>).
762 my $amount = $self->paid;
763 $amount -= $_->amount foreach ( $self->cust_pay_refund );
764 sprintf("%.2f", $amount );
769 Returns the "paid" field.
784 =item batch_insert CUST_PAY_OBJECT, ...
786 Class method which inserts multiple payments. Takes a list of FS::cust_pay
787 objects. Returns a list, each element representing the status of inserting the
788 corresponding payment - empty. If there is an error inserting any payment, the
789 entire transaction is rolled back, i.e. all payments are inserted or none are.
791 FS::cust_pay objects may have the pseudo-field 'apply_to', containing a
792 reference to an array of (uninserted) FS::cust_bill_pay objects. If so,
793 those objects will be inserted with the paynum of the payment, and for
794 each one, an error message or an empty string will be inserted into the
799 my @errors = FS::cust_pay->batch_insert(@cust_pay);
800 my $num_errors = scalar(grep $_, @errors);
801 if ( $num_errors == 0 ) {
802 #success; all payments were inserted
804 #failure; no payments were inserted.
810 my $self = shift; #class method
812 local $SIG{HUP} = 'IGNORE';
813 local $SIG{INT} = 'IGNORE';
814 local $SIG{QUIT} = 'IGNORE';
815 local $SIG{TERM} = 'IGNORE';
816 local $SIG{TSTP} = 'IGNORE';
817 local $SIG{PIPE} = 'IGNORE';
819 my $oldAutoCommit = $FS::UID::AutoCommit;
820 local $FS::UID::AutoCommit = 0;
826 foreach my $cust_pay (@_) {
827 my $error = $cust_pay->insert( 'manual' => 1 );
828 push @errors, $error;
829 $num_errors++ if $error;
831 if ( ref($cust_pay->get('apply_to')) eq 'ARRAY' ) {
833 foreach my $cust_bill_pay ( @{ $cust_pay->apply_to } ) {
834 if ( $error ) { # insert placeholders if cust_pay wasn't inserted
838 $cust_bill_pay->set('paynum', $cust_pay->paynum);
839 my $apply_error = $cust_bill_pay->insert;
840 push @errors, $apply_error || '';
841 $num_errors++ if $apply_error;
845 } elsif ( !$error ) { #normal case: apply payments as usual
846 $cust_pay->cust_main->apply_payments;
852 $dbh->rollback if $oldAutoCommit;
854 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
863 Returns an SQL fragment to retreive the unapplied amount.
868 my ($class, $start, $end) = @_;
869 my $bill_start = $start ? "AND cust_bill_pay._date <= $start" : '';
870 my $bill_end = $end ? "AND cust_bill_pay._date > $end" : '';
871 my $refund_start = $start ? "AND cust_pay_refund._date <= $start" : '';
872 my $refund_end = $end ? "AND cust_pay_refund._date > $end" : '';
876 ( SELECT SUM(amount) FROM cust_bill_pay
877 WHERE cust_pay.paynum = cust_bill_pay.paynum
878 $bill_start $bill_end )
882 ( SELECT SUM(amount) FROM cust_pay_refund
883 WHERE cust_pay.paynum = cust_pay_refund.paynum
884 $refund_start $refund_end )
893 # Used by FS::Upgrade to migrate to a new database.
897 sub _upgrade_data { #class method
898 my ($class, %opts) = @_;
900 warn "$me upgrading $class\n" if $DEBUG;
902 local $FS::payinfo_Mixin::ignore_masked_payinfo = 1;
905 # otaker/ivan upgrade
908 unless ( FS::upgrade_journal->is_done('cust_pay__otaker_ivan') ) {
910 #not the most efficient, but hey, it only has to run once
912 my $where = "WHERE ( otaker IS NULL OR otaker = '' OR otaker = 'ivan' ) ".
913 " AND usernum IS NULL ".
914 " AND 0 < ( SELECT COUNT(*) FROM cust_main ".
915 " WHERE cust_main.custnum = cust_pay.custnum ) ";
917 my $count_sql = "SELECT COUNT(*) FROM cust_pay $where";
919 my $sth = dbh->prepare($count_sql) or die dbh->errstr;
920 $sth->execute or die $sth->errstr;
921 my $total = $sth->fetchrow_arrayref->[0];
922 #warn "$total cust_pay records to update\n"
924 local($DEBUG) = 2 if $total > 1000; #could be a while, force progress info
929 my @cust_pay = qsearch( {
930 'table' => 'cust_pay',
932 'extra_sql' => $where,
933 'order_by' => 'ORDER BY paynum',
936 foreach my $cust_pay (@cust_pay) {
938 my $h_cust_pay = $cust_pay->h_search('insert');
940 next if $cust_pay->otaker eq $h_cust_pay->history_user;
941 #$cust_pay->otaker($h_cust_pay->history_user);
942 $cust_pay->set('otaker', $h_cust_pay->history_user);
944 $cust_pay->set('otaker', 'legacy');
947 delete $FS::payby::hash{'COMP'}->{cust_pay}; #quelle kludge
948 my $error = $cust_pay->replace;
951 warn " *** WARNING: Error updating order taker for payment paynum ".
952 $cust_pay->paynun. ": $error\n";
956 $FS::payby::hash{'COMP'}->{cust_pay} = ''; #restore it
959 if ( $DEBUG > 1 && $lastprog + 30 < time ) {
960 warn "$me $count/$total (".sprintf('%.2f',100*$count/$total). '%)'."\n";
966 FS::upgrade_journal->set_done('cust_pay__otaker_ivan');
970 # payinfo N/A upgrade
973 unless ( FS::upgrade_journal->is_done('cust_pay__payinfo_na') ) {
975 #XXX remove the 'N/A (tokenized)' part (or just this entire thing)
977 my @na_cust_pay = qsearch( {
978 'table' => 'cust_pay',
979 'hashref' => {}, #could be encrypted# { 'payinfo' => 'N/A' },
980 'extra_sql' => "WHERE ( payinfo = 'N/A' OR paymask = 'N/AA' OR paymask = 'N/A (tokenized)' ) AND payby IN ( 'CARD', 'CHEK' )",
983 foreach my $na ( @na_cust_pay ) {
985 next unless $na->payinfo eq 'N/A';
987 my $cust_pay_pending =
988 qsearchs('cust_pay_pending', { 'paynum' => $na->paynum } );
989 unless ( $cust_pay_pending ) {
990 warn " *** WARNING: not-yet recoverable N/A card for payment ".
991 $na->paynum. " (no cust_pay_pending)\n";
994 $na->$_($cust_pay_pending->$_) for qw( payinfo paymask );
995 my $error = $na->replace;
997 warn " *** WARNING: Error updating payinfo for payment paynum ".
998 $na->paynun. ": $error\n";
1004 FS::upgrade_journal->set_done('cust_pay__payinfo_na');
1008 # otaker->usernum upgrade
1011 delete $FS::payby::hash{'COMP'}->{cust_pay}; #quelle kludge
1012 $class->_upgrade_otaker(%opts);
1013 $FS::payby::hash{'COMP'}->{cust_pay} = ''; #restore it
1016 # migrate batchnums from the misused 'paybatch' field to 'batchnum'
1018 my $search = FS::Cursor->new( {
1019 'table' => 'cust_pay',
1020 'addl_from' => ' JOIN pay_batch ON cust_pay.paybatch = CAST(pay_batch.batchnum AS text) ',
1022 while (my $cust_pay = $search->fetch) {
1023 $cust_pay->set('batchnum' => $cust_pay->paybatch);
1024 $cust_pay->set('paybatch' => '');
1025 my $error = $cust_pay->replace;
1026 warn "error setting batchnum on cust_pay #".$cust_pay->paynum.":\n $error"
1031 # migrate gateway info from the misused 'paybatch' field
1034 # not only cust_pay, but also voided and refunded payments
1035 if (!FS::upgrade_journal->is_done('cust_pay__parse_paybatch_1')) {
1036 local $FS::Record::nowarn_classload=1;
1037 # really inefficient, but again, only has to run once
1038 foreach my $table (qw(cust_pay cust_pay_void cust_refund)) {
1039 my $and_batchnum_is_null =
1040 ( $table =~ /^cust_pay/ ? ' AND batchnum IS NULL' : '' );
1041 my $search = FS::Cursor->new({
1043 extra_sql => "WHERE payby IN('CARD','CHEK') ".
1044 "AND (paybatch IS NOT NULL ".
1045 "OR (paybatch IS NULL AND auth IS NULL
1046 $and_batchnum_is_null ) )",
1048 while ( my $object = $search->fetch ) {
1049 if ( $object->paybatch eq '' ) {
1050 # repair for a previous upgrade that didn't save 'auth'
1051 my $pkey = $object->primary_key;
1052 # find the last history record that had a paybatch value
1054 table => "h_$table",
1056 $pkey => $object->$pkey,
1057 paybatch => { op=>'!=', value=>''},
1058 history_action => 'replace_old',
1060 order_by => 'ORDER BY history_date DESC LIMIT 1',
1063 warn "couldn't find paybatch history record for $table ".$object->$pkey."\n";
1066 # if the paybatch didn't have an auth string, then it's fine
1067 $h->paybatch =~ /:(\w+):/ or next;
1068 # set paybatch to what it was in that record
1069 $object->set('paybatch', $h->paybatch)
1070 # and then upgrade it like the old records
1073 my $parsed = $object->_parse_paybatch;
1074 if (keys %$parsed) {
1075 $object->set($_ => $parsed->{$_}) foreach keys %$parsed;
1076 $object->set('auth' => $parsed->{authorization});
1077 $object->set('paybatch', '');
1078 my $error = $object->replace;
1079 warn "error parsing CARD/CHEK paybatch fields on $object #".
1080 $object->get($object->primary_key).":\n $error\n"
1085 FS::upgrade_journal->set_done('cust_pay__parse_paybatch_1');
1095 =item batch_import HASHREF
1097 Inserts new payments.
1104 my $fh = $param->{filehandle};
1105 my $format = $param->{'format'};
1107 my $agentnum = $param->{agentnum};
1108 my $_date = $param->{_date};
1109 $_date = parse_datetime($_date) if $_date && $_date =~ /\D/;
1110 my $paybatch = $param->{'paybatch'};
1112 my $custnum_prefix = $conf->config('cust_main-custnum-display_prefix');
1113 my $custnum_length = $conf->config('cust_main-custnum-display_length') || 8;
1115 # here is the agent virtualization
1116 my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
1120 if ( $format eq 'simple' ) {
1121 @fields = qw( custnum agent_custid paid payinfo );
1123 } elsif ( $format eq 'extended' ) {
1124 die "unimplemented\n";
1128 die "unknown format $format";
1131 eval "use Text::CSV_XS;";
1134 my $csv = new Text::CSV_XS;
1138 local $SIG{HUP} = 'IGNORE';
1139 local $SIG{INT} = 'IGNORE';
1140 local $SIG{QUIT} = 'IGNORE';
1141 local $SIG{TERM} = 'IGNORE';
1142 local $SIG{TSTP} = 'IGNORE';
1143 local $SIG{PIPE} = 'IGNORE';
1145 my $oldAutoCommit = $FS::UID::AutoCommit;
1146 local $FS::UID::AutoCommit = 0;
1150 while ( defined($line=<$fh>) ) {
1152 $csv->parse($line) or do {
1153 $dbh->rollback if $oldAutoCommit;
1154 return "can't parse: ". $csv->error_input();
1157 my @columns = $csv->fields();
1161 paybatch => $paybatch,
1163 $cust_pay{_date} = $_date if $_date;
1166 foreach my $field ( @fields ) {
1168 if ( $field eq 'agent_custid'
1170 && $columns[0] =~ /\S+/ )
1173 my $agent_custid = $columns[0];
1174 my %hash = ( 'agent_custid' => $agent_custid,
1175 'agentnum' => $agentnum,
1178 if ( $cust_pay{'custnum'} !~ /^\s*$/ ) {
1179 $dbh->rollback if $oldAutoCommit;
1180 return "can't specify custnum with agent_custid $agent_custid";
1183 $cust_main = qsearchs({
1184 'table' => 'cust_main',
1185 'hashref' => \%hash,
1186 'extra_sql' => $extra_sql,
1189 unless ( $cust_main ) {
1190 $dbh->rollback if $oldAutoCommit;
1191 return "can't find customer with agent_custid $agent_custid";
1195 $columns[0] = $cust_main->custnum;
1198 $cust_pay{$field} = shift @columns;
1201 if ( $custnum_prefix && $cust_pay{custnum} =~ /^$custnum_prefix(0*([1-9]\d*))$/
1202 && length($1) == $custnum_length ) {
1203 $cust_pay{custnum} = $2;
1206 my $cust_pay = new FS::cust_pay( \%cust_pay );
1207 my $error = $cust_pay->insert;
1210 $dbh->rollback if $oldAutoCommit;
1211 return "can't insert payment for $line: $error";
1214 if ( $format eq 'simple' ) {
1215 # include agentnum for less surprise?
1216 $cust_main = qsearchs({
1217 'table' => 'cust_main',
1218 'hashref' => { 'custnum' => $cust_pay->custnum },
1219 'extra_sql' => $extra_sql,
1223 unless ( $cust_main ) {
1224 $dbh->rollback if $oldAutoCommit;
1225 return "can't find customer to which payments apply at line: $line";
1228 $error = $cust_main->apply_payments_and_credits;
1230 $dbh->rollback if $oldAutoCommit;
1231 return "can't apply payments to customer for $line: $error";
1239 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1241 return "Empty file!" unless $imported;
1251 Delete and replace methods.
1255 L<FS::cust_pay_pending>, L<FS::cust_bill_pay>, L<FS::cust_bill>, L<FS::Record>,
1256 schema.html from the base documentation.