4 use base qw( FS::otaker_Mixin FS::payinfo_transaction_Mixin FS::cust_main_Mixin
6 use vars qw( $DEBUG $me $conf @encrypted_fields
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 {
40 @encrypted_fields = ('payinfo');
41 sub nohistory_fields { ('payinfo'); }
45 FS::cust_pay - Object methods for cust_pay objects
51 $record = new FS::cust_pay \%hash;
52 $record = new FS::cust_pay { 'column' => 'value' };
54 $error = $record->insert;
56 $error = $new_record->replace($old_record);
58 $error = $record->delete;
60 $error = $record->check;
64 An FS::cust_pay object represents a payment; the transfer of money from a
65 customer. FS::cust_pay inherits from FS::Record. The following fields are
72 primary key (assigned automatically for new payments)
76 customer (see L<FS::cust_main>)
80 specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
81 L<Time::Local> and L<Date::Parse> for conversion functions.
85 Amount of this payment
89 order taker (see L<FS::access_user>)
93 Payment Type (See L<FS::payinfo_Mixin> for valid values)
97 Payment Information (See L<FS::payinfo_Mixin> for data format)
101 Credit card type, if appropriate; autodetected.
105 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
109 obsolete text field for tracking card processing or other batch grouping
113 Optional unique identifer to prevent duplicate transactions.
117 books closed flag, empty or `Y'
121 Desired pkgnum when using experimental package balances.
125 Flag to only allow manual application of payment, empty or 'Y'
129 The bank where the payment was deposited.
133 The name of the depositor.
137 The deposit account number.
145 The number of the batch this payment came from (see L<FS::pay_batch>),
146 or null if it was processed through a realtime gateway or entered manually.
150 The number of the realtime or batch gateway L<FS::payment_gateway>) this
151 payment was processed through. Null if it was entered manually or processed
152 by the "system default" gateway, which doesn't have a number.
156 The name of the processor module (Business::OnlinePayment, ::BatchPayment,
157 or ::OnlineThirdPartyPayment subclass) used for this payment. Slightly
158 redundant with C<gatewaynum>.
162 The authorization number returned by the credit card network.
166 The transaction ID returned by the gateway, if any. This is usually what
167 you would use to initiate a void or refund of the payment.
177 Creates a new payment. To add the payment to the databse, see L<"insert">.
181 sub table { 'cust_pay'; }
182 sub cust_linked { $_[0]->cust_main_custnum; }
183 sub cust_unlinked_msg {
185 "WARNING: can't find cust_main.custnum ". $self->custnum.
186 ' (cust_pay.paynum '. $self->paynum. ')';
189 =item insert [ OPTION => VALUE ... ]
191 Adds this payment to the database.
193 For backwards-compatibility and convenience, if the additional field invnum
194 is defined, an FS::cust_bill_pay record for the full amount of the payment
195 will be created. In this case, custnum is optional.
197 If the additional field discount_term is defined then a prepayment discount
198 is taken for that length of time. It is an error for the customer to owe
199 after this payment is made.
201 A hash of optional arguments may be passed. Currently "manual" is supported.
202 If true, a payment receipt is sent instead of a statement when
203 'payment_receipt_email' configuration option is set.
205 About the "manual" flag: Normally, if the 'payment_receipt' config option
206 is set, and the customer has an invoice email address, inserting a payment
207 causes a I<statement> to be emailed to the customer. If the payment is
208 considered "manual" (or if the customer has no invoices), then it will
209 instead send a I<payment receipt>. "manual" should be true whenever a
210 payment is created directly from the web interface, from a user-initiated
211 realtime payment, or from a third-party payment via self-service. It should
212 be I<false> when creating a payment from a billing event or from a batch.
217 my($self, %options) = @_;
219 local $SIG{HUP} = 'IGNORE';
220 local $SIG{INT} = 'IGNORE';
221 local $SIG{QUIT} = 'IGNORE';
222 local $SIG{TERM} = 'IGNORE';
223 local $SIG{TSTP} = 'IGNORE';
224 local $SIG{PIPE} = 'IGNORE';
226 my $oldAutoCommit = $FS::UID::AutoCommit;
227 local $FS::UID::AutoCommit = 0;
231 if ( $self->invnum ) {
232 $cust_bill = qsearchs('cust_bill', { 'invnum' => $self->invnum } )
234 $dbh->rollback if $oldAutoCommit;
235 return "Unknown cust_bill.invnum: ". $self->invnum;
237 if ($self->custnum && ($cust_bill->custnum ne $self->custnum)) {
238 $dbh->rollback if $oldAutoCommit;
239 return "Invoice custnum ".$cust_bill->custnum
240 ." does not match specified custnum ".$self->custnum
241 ." for invoice ".$self->invnum;
243 $self->custnum($cust_bill->custnum );
246 my $error = $self->check;
247 return $error if $error;
249 my $cust_main = $self->cust_main;
250 my $old_balance = $cust_main->balance;
252 $error = $self->SUPER::insert;
254 $dbh->rollback if $oldAutoCommit;
255 return "error inserting cust_pay: $error";
258 if ( my $credit_type = $conf->config('prepayment_discounts-credit_type') ) {
259 if ( my $months = $self->discount_term ) {
260 # XXX this should be moved out somewhere, but discount_term_values
262 my ($cust_bill) = ($cust_main->cust_bill)[-1]; # most recent invoice
263 return "can't accept prepayment for an unbilled customer" if !$cust_bill;
265 # %billing_pkgs contains this customer's active monthly packages.
266 # Recurring fees for those packages will be credited and then rebilled
267 # for the full discount term. Other packages on the last invoice
268 # (canceled, non-monthly recurring, or one-time charges) will be
270 my %billing_pkgs = map { $_->pkgnum => $_ }
271 grep { $_->part_pkg->freq eq '1' }
272 $cust_main->billing_pkgs;
273 my $credit = 0; # sum of recurring charges from that invoice
274 my $last_bill_date = 0; # the real bill date
275 foreach my $item ( $cust_bill->cust_bill_pkg ) {
276 next if !exists($billing_pkgs{$item->pkgnum}); # skip inactive packages
277 $credit += $item->recur;
278 $last_bill_date = $item->cust_pkg->last_bill
279 if defined($item->cust_pkg)
280 and $item->cust_pkg->last_bill > $last_bill_date
283 my $cust_credit = new FS::cust_credit {
284 'custnum' => $self->custnum,
285 'amount' => sprintf('%.2f', $credit),
286 'reason' => 'customer chose to prepay for discount',
288 $error = $cust_credit->insert('reason_type' => $credit_type);
290 $dbh->rollback if $oldAutoCommit;
291 return "error inserting prepayment credit: $error";
295 # bill for the entire term
296 $_->bill($_->last_bill) foreach (values %billing_pkgs);
297 $error = $cust_main->bill(
298 # no recurring_only, we want unbilled packages with start dates to
300 'no_usage_reset' => 1,
301 'time' => $last_bill_date, # not $cust_bill->_date
302 'pkg_list' => [ values %billing_pkgs ],
303 'freq_override' => $months,
306 $dbh->rollback if $oldAutoCommit;
307 return "error inserting cust_pay: $error";
309 $error = $cust_main->apply_payments_and_credits;
311 $dbh->rollback if $oldAutoCommit;
312 return "error inserting cust_pay: $error";
314 my $new_balance = $cust_main->balance;
315 if ($new_balance > 0) {
316 $dbh->rollback if $oldAutoCommit;
317 return "balance after prepay discount attempt: $new_balance";
319 # user friendly: override the "apply only to this invoice" mode
326 if ( $self->invnum ) {
327 my $cust_bill_pay = new FS::cust_bill_pay {
328 'invnum' => $self->invnum,
329 'paynum' => $self->paynum,
330 'amount' => $self->paid,
331 '_date' => $self->_date,
333 $error = $cust_bill_pay->insert(%options);
335 if ( $ignore_noapply ) {
336 warn "warning: error inserting cust_bill_pay: $error ".
337 "(ignore_noapply flag set; inserting cust_pay record anyway)\n";
339 $dbh->rollback if $oldAutoCommit;
340 return "error inserting cust_bill_pay: $error";
345 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
347 # possibly trigger package unsuspend, doesn't abort transaction on failure
348 $self->unsuspend_balance if $old_balance;
350 #bill setup fees for voip_cdr bill_every_call packages
351 #some false laziness w/search in freeside-cdrd
353 'LEFT JOIN part_pkg USING ( pkgpart ) '.
354 "LEFT JOIN part_pkg_option
355 ON ( cust_pkg.pkgpart = part_pkg_option.pkgpart
356 AND part_pkg_option.optionname = 'bill_every_call' )";
358 my $extra_sql = " AND plan = 'voip_cdr' AND optionvalue = '1' ".
359 " AND ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 ) ";
361 my @cust_pkg = qsearch({
362 'table' => 'cust_pkg',
363 'addl_from' => $addl_from,
364 'hashref' => { 'custnum' => $self->custnum,
368 'extra_sql' => $extra_sql,
372 warn "voip_cdr bill_every_call packages found; billing customer\n";
373 my $bill_error = $self->cust_main->bill_and_collect( 'fatal' => 'return' );
375 warn "WARNING: Error billing customer: $bill_error\n";
378 #end of billing setup fees for voip_cdr bill_every_call packages
380 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
383 my $trigger = $conf->config('payment_receipt-trigger',
384 $self->cust_main->agentnum) || 'cust_pay';
385 if ( $trigger eq 'cust_pay' ) {
386 my $error = $self->send_receipt(
387 'manual' => $options{'manual'},
388 'cust_bill' => $cust_bill,
389 'cust_main' => $cust_main,
391 warn "can't send payment receipt/statement: $error" if $error;
394 #run payment events immediately
395 my $due_cust_event = $self->cust_main->due_cust_event(
396 'eventtable' => 'cust_pay',
397 'objects' => [ $self ],
399 if ( !ref($due_cust_event) ) {
400 warn "Error searching for cust_pay billing events: $due_cust_event\n";
402 foreach my $cust_event (@$due_cust_event) {
403 next unless $cust_event->test_conditions;
404 if ( my $error = $cust_event->do_event() ) {
405 warn "Error running cust_pay billing event: $error\n";
414 =item void [ REASON ]
416 Voids this payment: deletes the payment and all associated applications and
417 adds a record of the voided payment to the FS::cust_pay_void table.
424 local $SIG{HUP} = 'IGNORE';
425 local $SIG{INT} = 'IGNORE';
426 local $SIG{QUIT} = 'IGNORE';
427 local $SIG{TERM} = 'IGNORE';
428 local $SIG{TSTP} = 'IGNORE';
429 local $SIG{PIPE} = 'IGNORE';
431 my $oldAutoCommit = $FS::UID::AutoCommit;
432 local $FS::UID::AutoCommit = 0;
435 my $cust_pay_void = new FS::cust_pay_void ( {
436 map { $_ => $self->get($_) } $self->fields
438 $cust_pay_void->reason(shift) if scalar(@_);
439 my $error = $cust_pay_void->insert;
441 my $cust_pay_pending =
442 qsearchs('cust_pay_pending', { paynum => $self->paynum });
443 if ( $cust_pay_pending ) {
444 $cust_pay_pending->set('void_paynum', $self->paynum);
445 $cust_pay_pending->set('paynum', '');
446 $error ||= $cust_pay_pending->replace;
449 $error ||= $self->delete;
452 $dbh->rollback if $oldAutoCommit;
456 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
464 Unless the closed flag is set, deletes this payment and all associated
465 applications (see L<FS::cust_bill_pay> and L<FS::cust_pay_refund>). In most
466 cases, you want to use the void method instead to leave a record of the
471 # very similar to FS::cust_credit::delete
474 return "Can't delete closed payment" if $self->closed =~ /^Y/i;
476 local $SIG{HUP} = 'IGNORE';
477 local $SIG{INT} = 'IGNORE';
478 local $SIG{QUIT} = 'IGNORE';
479 local $SIG{TERM} = 'IGNORE';
480 local $SIG{TSTP} = 'IGNORE';
481 local $SIG{PIPE} = 'IGNORE';
483 my $oldAutoCommit = $FS::UID::AutoCommit;
484 local $FS::UID::AutoCommit = 0;
487 foreach my $app ( $self->cust_bill_pay, $self->cust_pay_refund ) {
488 my $error = $app->delete;
490 $dbh->rollback if $oldAutoCommit;
495 my $error = $self->SUPER::delete(@_);
497 $dbh->rollback if $oldAutoCommit;
501 if ( $conf->exists('deletepayments')
502 && $conf->config('deletepayments') ne '' ) {
504 my $cust_main = $self->cust_main;
506 my $error = send_email(
507 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
508 #invoice_from??? well as good as any
509 'to' => $conf->config('deletepayments'),
510 'subject' => 'FREESIDE NOTIFICATION: Payment deleted',
512 "This is an automatic message from your Freeside installation\n",
513 "informing you that the following payment has been deleted:\n",
515 'paynum: '. $self->paynum. "\n",
516 'custnum: '. $self->custnum.
517 " (". $cust_main->last. ", ". $cust_main->first. ")\n",
518 'paid: $'. sprintf("%.2f", $self->paid). "\n",
519 'date: '. time2str("%a %b %e %T %Y", $self->_date). "\n",
520 'payby: '. $self->payby. "\n",
521 'payinfo: '. $self->paymask. "\n",
522 'paybatch: '. $self->paybatch. "\n",
527 $dbh->rollback if $oldAutoCommit;
528 return "can't send payment deletion notification: $error";
533 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
539 =item replace [ OLD_RECORD ]
541 You can, but probably shouldn't modify payments...
543 Replaces the OLD_RECORD with this one in the database, or, if OLD_RECORD is not
544 supplied, replaces this record. If there is an error, returns the error,
545 otherwise returns false.
551 return "Can't modify closed payment"
552 if $self->closed =~ /^Y/i && !$FS::payinfo_Mixin::allow_closed_replace;
553 $self->SUPER::replace(@_);
558 Checks all fields to make sure this is a valid payment. If there is an error,
559 returns the error, otherwise returns false. Called by the insert method.
566 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
569 $self->ut_numbern('paynum')
570 || $self->ut_numbern('custnum')
571 || $self->ut_numbern('_date')
572 || $self->ut_money('paid')
573 || $self->ut_alphan('otaker')
574 || $self->ut_textn('paybatch')
575 || $self->ut_textn('payunique')
576 || $self->ut_enum('closed', [ '', 'Y' ])
577 || $self->ut_flag('no_auto_apply')
578 || $self->ut_foreign_keyn('pkgnum', 'cust_pkg', 'pkgnum')
579 || $self->ut_textn('bank')
580 || $self->ut_alphan('depositor')
581 || $self->ut_numbern('account')
582 || $self->ut_numbern('teller')
583 || $self->ut_foreign_keyn('batchnum', 'pay_batch', 'batchnum')
584 || $self->payinfo_check()
586 return $error if $error;
588 return "paid must be > 0 " if $self->paid <= 0;
590 return "unknown cust_main.custnum: ". $self->custnum
592 || qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
594 $self->_date(time) unless $self->_date;
596 return "invalid discount_term"
597 if ($self->discount_term && $self->discount_term < 2);
599 if ( $self->payby eq 'CASH' and $conf->exists('require_cash_deposit_info') ) {
600 foreach (qw(bank depositor account teller)) {
601 return "$_ required" if $self->get($_) eq '';
605 #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it
606 # # UNIQUE index should catch this too, without race conditions, but this
607 # # should give a better error message the other 99.9% of the time...
608 # if ( length($self->payunique)
609 # && qsearchs('cust_pay', { 'payunique' => $self->payunique } ) ) {
610 # #well, it *could* be a better error message
611 # return "duplicate transaction".
612 # " - a payment with unique identifer ". $self->payunique.
619 =item send_receipt HASHREF | OPTION => VALUE ...
621 Sends a payment receipt for this payment..
629 Flag indicating the payment is being made manually.
633 Invoice (FS::cust_bill) object. If not specified, the most recent invoice
638 Customer (FS::cust_main) object (for efficiency).
646 my $opt = ref($_[0]) ? shift : { @_ };
648 my $cust_bill = $opt->{'cust_bill'};
649 my $cust_main = $opt->{'cust_main'} || $self->cust_main;
651 my $conf = new FS::Conf;
653 return '' unless $conf->config_bool('payment_receipt', $cust_main->agentnum);
655 my @invoicing_list = $cust_main->invoicing_list_emailonly;
656 return '' unless @invoicing_list;
658 $cust_bill ||= ($cust_main->cust_bill)[-1]; #rather inefficient though?
662 if ( ( exists($opt->{'manual'}) && $opt->{'manual'} )
663 #|| ! $conf->exists('invoice_html_statement')
667 my $msgnum = $conf->config('payment_receipt_msgnum', $cust_main->agentnum);
670 my %substitutions = ();
671 $substitutions{invnum} = $opt->{cust_bill}->invnum if $opt->{cust_bill};
673 my $queue = new FS::queue {
674 'job' => 'FS::Misc::process_send_email',
675 'paynum' => $self->paynum,
676 'custnum' => $cust_main->custnum,
678 $error = $queue->insert(
679 FS::msg_template->by_key($msgnum)->prepare(
680 'cust_main' => $cust_main,
682 'from_config' => 'payment_receipt_from',
683 'substitutions' => \%substitutions,
685 'msgtype' => 'receipt', # override msg_template's default
688 } elsif ( $conf->exists('payment_receipt_email') ) {
690 my $receipt_template = new Text::Template (
692 SOURCE => [ map "$_\n", $conf->config('payment_receipt_email') ],
694 warn "can't create payment receipt template: $Text::Template::ERROR";
698 my $payby = $self->payby;
699 my $payinfo = $self->payinfo;
700 $payby =~ s/^BILL$/Check/ if $payinfo;
701 if ( $payby eq 'CARD' || $payby eq 'CHEK' ) {
702 $payinfo = $self->paymask
704 $payinfo = $self->decrypt($payinfo);
706 $payby =~ s/^CHEK$/Electronic check/;
709 'date' => time2str("%a %B %o, %Y", $self->_date),
710 'name' => $cust_main->name,
711 'paynum' => $self->paynum,
712 'paid' => sprintf("%.2f", $self->paid),
713 'payby' => ucfirst(lc($payby)),
714 'payinfo' => $payinfo,
715 'balance' => $cust_main->balance,
716 'company_name' => $conf->config('company_name', $cust_main->agentnum),
719 $fill_in{'invnum'} = $opt->{cust_bill}->invnum if $opt->{cust_bill};
721 if ( $opt->{'cust_pkg'} ) {
722 $fill_in{'pkg'} = $opt->{'cust_pkg'}->part_pkg->pkg;
723 #setup date, other things?
726 my $queue = new FS::queue {
727 'job' => 'FS::Misc::process_send_generated_email',
728 'paynum' => $self->paynum,
729 'custnum' => $cust_main->custnum,
730 'msgtype' => 'receipt',
732 $error = $queue->insert(
733 'from' => $conf->invoice_from_full( $cust_main->agentnum ),
734 #invoice_from??? well as good as any
735 'to' => \@invoicing_list,
736 'subject' => 'Payment receipt',
737 'body' => [ $receipt_template->fill_in( HASH => \%fill_in ) ],
742 warn "payment_receipt is on, but no payment_receipt_msgnum\n";
746 } elsif ( ! $cust_main->invoice_noemail ) { #not manual
748 my $queue = new FS::queue {
749 'job' => 'FS::cust_bill::queueable_email',
750 'paynum' => $self->paynum,
751 'custnum' => $cust_main->custnum,
755 'invnum' => $cust_bill->invnum,
759 if ( my $mode = $conf->config('payment_receipt_statement_mode') ) {
760 $opt{'mode'} = $mode;
762 # backward compatibility, no good fix for this yet as some people may
763 # still have "invoice_latex_statement" and such options
764 $opt{'template'} = 'statement';
765 $opt{'notice_name'} = 'Statement';
768 $error = $queue->insert(%opt);
772 warn "send_receipt: $error\n" if $error;
777 Returns all applications to invoices (see L<FS::cust_bill_pay>) for this
784 map { $_ } #return $self->num_cust_bill_pay unless wantarray;
785 sort { $a->_date <=> $b->_date
786 || $a->invnum <=> $b->invnum }
787 qsearch( 'cust_bill_pay', { 'paynum' => $self->paynum } )
791 =item cust_pay_refund
793 Returns all applications of refunds (see L<FS::cust_pay_refund>) to this
798 sub cust_pay_refund {
800 map { $_ } #return $self->num_cust_pay_refund unless wantarray;
801 sort { $a->_date <=> $b->_date }
802 qsearch( 'cust_pay_refund', { 'paynum' => $self->paynum } )
809 Returns the amount of this payment that is still unapplied; which is
810 paid minus all payment applications (see L<FS::cust_bill_pay>) and refund
811 applications (see L<FS::cust_pay_refund>).
817 my $amount = $self->paid;
818 $amount -= $_->amount foreach ( $self->cust_bill_pay );
819 $amount -= $_->amount foreach ( $self->cust_pay_refund );
820 sprintf("%.2f", $amount );
825 Returns the amount of this payment that has not been refuned; which is
826 paid minus all refund applications (see L<FS::cust_pay_refund>).
832 my $amount = $self->paid;
833 $amount -= $_->amount foreach ( $self->cust_pay_refund );
834 sprintf("%.2f", $amount );
839 Returns the "paid" field.
848 =item delete_cust_bill_pay OPTIONS
850 Deletes all associated cust_bill_pay records.
852 If option 'unapplied' is a specified, only deletes until
853 this object's 'unapplied' value is >= the specified amount.
854 (Deletes in order returned by L</cust_bill_pay>.)
858 sub delete_cust_bill_pay {
862 local $SIG{HUP} = 'IGNORE';
863 local $SIG{INT} = 'IGNORE';
864 local $SIG{QUIT} = 'IGNORE';
865 local $SIG{TERM} = 'IGNORE';
866 local $SIG{TSTP} = 'IGNORE';
867 local $SIG{PIPE} = 'IGNORE';
869 my $oldAutoCommit = $FS::UID::AutoCommit;
870 local $FS::UID::AutoCommit = 0;
873 my $unapplied = $self->unapplied; #only need to look it up once
877 # Maybe we should reverse the order these get deleted in?
878 # ie delete newest first?
879 # keeping consistent with how bop refunds work, for now...
880 foreach my $cust_bill_pay ( $self->cust_bill_pay ) {
881 last if $opt{'unapplied'} && ($unapplied > $opt{'unapplied'});
882 $unapplied += $cust_bill_pay->amount;
883 $error = $cust_bill_pay->delete;
888 $dbh->rollback if $oldAutoCommit;
892 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
898 Accepts input for creating a new FS::cust_refund object.
899 Unapplies payment from invoices up to the amount of the refund,
900 creates the refund and applies payment to refund. Allows entire
901 process to be handled in one transaction.
903 Causes a fatal error if called on CARD or CHEK payments.
910 die "Cannot call cust_pay->refund on " . $self->payby
911 if grep { $_ eq $self->payby } qw(CARD CHEK);
913 local $SIG{HUP} = 'IGNORE';
914 local $SIG{INT} = 'IGNORE';
915 local $SIG{QUIT} = 'IGNORE';
916 local $SIG{TERM} = 'IGNORE';
917 local $SIG{TSTP} = 'IGNORE';
918 local $SIG{PIPE} = 'IGNORE';
920 my $oldAutoCommit = $FS::UID::AutoCommit;
921 local $FS::UID::AutoCommit = 0;
924 my $error = $self->delete_cust_bill_pay('amount' => $hash->{'amount'});
927 $dbh->rollback if $oldAutoCommit;
931 $hash->{'paynum'} = $self->paynum;
932 my $new = new FS::cust_refund ( $hash );
933 $error = $new->insert;
936 $dbh->rollback if $oldAutoCommit;
940 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
944 ### refund_to_unapply/unapply_refund false laziness with FS::cust_credit
946 =item refund_to_unapply
948 Returns L<FS::cust_pay_refund> objects that will be deleted by L</unapply_refund>
949 (all currently applied refunds that aren't closed.)
950 Returns empty list if payment itself is closed.
954 sub refund_to_unapply {
956 return () if $self->closed;
958 'table' => 'cust_pay_refund',
959 'hashref' => { 'paynum' => $self->paynum },
960 'addl_from' => 'LEFT JOIN cust_refund USING (refundnum)',
961 'extra_sql' => "AND cust_refund.closed IS NULL AND cust_refund.source_paynum IS NULL",
967 Deletes all objects returned by L</refund_to_unapply>.
974 local $SIG{HUP} = 'IGNORE';
975 local $SIG{INT} = 'IGNORE';
976 local $SIG{QUIT} = 'IGNORE';
977 local $SIG{TERM} = 'IGNORE';
978 local $SIG{TSTP} = 'IGNORE';
979 local $SIG{PIPE} = 'IGNORE';
981 my $oldAutoCommit = $FS::UID::AutoCommit;
982 local $FS::UID::AutoCommit = 0;
984 foreach my $cust_pay_refund ($self->refund_to_unapply) {
985 my $error = $cust_pay_refund->delete;
987 dbh->rollback if $oldAutoCommit;
992 dbh->commit or die dbh->errstr if $oldAutoCommit;
1002 =item batch_insert CUST_PAY_OBJECT, ...
1004 Class method which inserts multiple payments. Takes a list of FS::cust_pay
1005 objects. Returns a list, each element representing the status of inserting the
1006 corresponding payment - empty. If there is an error inserting any payment, the
1007 entire transaction is rolled back, i.e. all payments are inserted or none are.
1009 FS::cust_pay objects may have the pseudo-field 'apply_to', containing a
1010 reference to an array of (uninserted) FS::cust_bill_pay objects. If so,
1011 those objects will be inserted with the paynum of the payment, and for
1012 each one, an error message or an empty string will be inserted into the
1017 my @errors = FS::cust_pay->batch_insert(@cust_pay);
1018 my $num_errors = scalar(grep $_, @errors);
1019 if ( $num_errors == 0 ) {
1020 #success; all payments were inserted
1022 #failure; no payments were inserted.
1028 my $self = shift; #class method
1030 local $SIG{HUP} = 'IGNORE';
1031 local $SIG{INT} = 'IGNORE';
1032 local $SIG{QUIT} = 'IGNORE';
1033 local $SIG{TERM} = 'IGNORE';
1034 local $SIG{TSTP} = 'IGNORE';
1035 local $SIG{PIPE} = 'IGNORE';
1037 my $oldAutoCommit = $FS::UID::AutoCommit;
1038 local $FS::UID::AutoCommit = 0;
1044 foreach my $cust_pay (@_) {
1045 my $error = $cust_pay->insert( 'manual' => 1 );
1046 push @errors, $error;
1047 $num_errors++ if $error;
1049 if ( ref($cust_pay->get('apply_to')) eq 'ARRAY' ) {
1051 foreach my $cust_bill_pay ( @{ $cust_pay->apply_to } ) {
1052 if ( $error ) { # insert placeholders if cust_pay wasn't inserted
1056 $cust_bill_pay->set('paynum', $cust_pay->paynum);
1057 my $apply_error = $cust_bill_pay->insert;
1058 push @errors, $apply_error || '';
1059 $num_errors++ if $apply_error;
1063 } elsif ( !$error ) { #normal case: apply payments as usual
1064 $cust_pay->cust_main->apply_payments( 'manual'=>1 );
1069 if ( $num_errors ) {
1070 $dbh->rollback if $oldAutoCommit;
1072 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1081 Returns an SQL fragment to retreive the unapplied amount.
1086 my ($class, $start, $end) = @_;
1087 my $bill_start = $start ? "AND cust_bill_pay._date <= $start" : '';
1088 my $bill_end = $end ? "AND cust_bill_pay._date > $end" : '';
1089 my $refund_start = $start ? "AND cust_pay_refund._date <= $start" : '';
1090 my $refund_end = $end ? "AND cust_pay_refund._date > $end" : '';
1094 ( SELECT SUM(amount) FROM cust_bill_pay
1095 WHERE cust_pay.paynum = cust_bill_pay.paynum
1096 $bill_start $bill_end )
1100 ( SELECT SUM(amount) FROM cust_pay_refund
1101 WHERE cust_pay.paynum = cust_pay_refund.paynum
1102 $refund_start $refund_end )
1111 # Used by FS::Upgrade to migrate to a new database.
1115 sub _upgrade_data { #class method
1116 my ($class, %opt) = @_;
1118 warn "$me upgrading $class\n" if $DEBUG;
1120 local $FS::payinfo_Mixin::ignore_masked_payinfo = 1;
1123 # otaker/ivan upgrade
1126 unless ( FS::upgrade_journal->is_done('cust_pay__otaker_ivan') ) {
1128 #not the most efficient, but hey, it only has to run once
1130 my $where = "WHERE ( otaker IS NULL OR otaker = '' OR otaker = 'ivan' ) ".
1131 " AND usernum IS NULL ".
1132 " AND 0 < ( SELECT COUNT(*) FROM cust_main ".
1133 " WHERE cust_main.custnum = cust_pay.custnum ) ";
1135 my $count_sql = "SELECT COUNT(*) FROM cust_pay $where";
1137 my $sth = dbh->prepare($count_sql) or die dbh->errstr;
1138 $sth->execute or die $sth->errstr;
1139 my $total = $sth->fetchrow_arrayref->[0];
1140 #warn "$total cust_pay records to update\n"
1142 local($DEBUG) = 2 if $total > 1000; #could be a while, force progress info
1147 my @cust_pay = qsearch( {
1148 'table' => 'cust_pay',
1150 'extra_sql' => $where,
1151 'order_by' => 'ORDER BY paynum',
1154 foreach my $cust_pay (@cust_pay) {
1156 my $h_cust_pay = $cust_pay->h_search('insert');
1157 if ( $h_cust_pay ) {
1158 next if $cust_pay->otaker eq $h_cust_pay->history_user;
1159 #$cust_pay->otaker($h_cust_pay->history_user);
1160 $cust_pay->set('otaker', $h_cust_pay->history_user);
1162 $cust_pay->set('otaker', 'legacy');
1165 delete $FS::payby::hash{'COMP'}->{cust_pay}; #quelle kludge
1166 my $error = $cust_pay->replace;
1169 warn " *** WARNING: Error updating order taker for payment paynum ".
1170 $cust_pay->paynun. ": $error\n";
1174 $FS::payby::hash{'COMP'}->{cust_pay} = ''; #restore it
1177 if ( $DEBUG > 1 && $lastprog + 30 < time ) {
1178 warn "$me $count/$total (".sprintf('%.2f',100*$count/$total). '%)'."\n";
1184 FS::upgrade_journal->set_done('cust_pay__otaker_ivan');
1188 # payinfo N/A upgrade
1191 unless ( FS::upgrade_journal->is_done('cust_pay__payinfo_na') ) {
1193 #XXX remove the 'N/A (tokenized)' part (or just this entire thing)
1195 my @na_cust_pay = qsearch( {
1196 'table' => 'cust_pay',
1197 'hashref' => {}, #could be encrypted# { 'payinfo' => 'N/A' },
1198 'extra_sql' => "WHERE ( payinfo = 'N/A' OR paymask = 'N/AA' OR paymask = 'N/A (tokenized)' ) AND payby IN ( 'CARD', 'CHEK' )",
1201 foreach my $na ( @na_cust_pay ) {
1203 next unless $na->payinfo eq 'N/A';
1205 my $cust_pay_pending =
1206 qsearchs('cust_pay_pending', { 'paynum' => $na->paynum } );
1207 unless ( $cust_pay_pending ) {
1208 warn " *** WARNING: not-yet recoverable N/A card for payment ".
1209 $na->paynum. " (no cust_pay_pending)\n";
1212 $na->$_($cust_pay_pending->$_) for qw( payinfo paymask );
1213 my $error = $na->replace;
1215 warn " *** WARNING: Error updating payinfo for payment paynum ".
1216 $na->paynun. ": $error\n";
1222 FS::upgrade_journal->set_done('cust_pay__payinfo_na');
1226 # otaker->usernum upgrade
1229 delete $FS::payby::hash{'COMP'}->{cust_pay}; #quelle kludge
1230 $class->_upgrade_otaker(%opt);
1231 $FS::payby::hash{'COMP'}->{cust_pay} = ''; #restore it
1233 # if we do this anywhere else, it should become an FS::Upgrade method
1234 my $num_to_upgrade = $class->count('paybatch is not null');
1235 my $num_jobs = FS::queue->count('job = \'FS::cust_pay::process_upgrade_paybatch\' and status != \'failed\'');
1236 if ( $num_to_upgrade > 0 ) {
1237 warn "Need to migrate paybatch field in $num_to_upgrade payments.\n";
1238 if ( $opt{queue} ) {
1239 if ( $num_jobs > 0 ) {
1240 warn "Upgrade already queued.\n";
1242 warn "Scheduling upgrade.\n";
1243 my $job = FS::queue->new({ job => 'FS::cust_pay::process_upgrade_paybatch' });
1247 process_upgrade_paybatch();
1252 # don't set paycardtype until 4.x
1254 #$class->upgrade_set_cardtype;
1256 # for batch payments, make sure paymask is set
1258 local $FS::payinfo_Mixin::allow_closed_replace = 1;
1259 local $FS::payinfo_Mixin::ignore_masked_payinfo = 1;
1261 my $cursor = FS::Cursor->new({
1262 table => 'cust_pay',
1263 extra_sql => ' WHERE paymask IS NULL AND payinfo IS NOT NULL
1264 AND payby IN(\'CARD\', \'CHEK\')
1265 AND batchnum IS NOT NULL',
1268 # records from cursors for some reason don't decrypt payinfo, so
1269 # call replace_old to fetch the record "normally"
1270 while (my $cust_pay = $cursor->fetch) {
1271 $cust_pay = $cust_pay->replace_old;
1272 $cust_pay->set('paymask', $cust_pay->mask_payinfo);
1273 my $error = $cust_pay->replace;
1275 die "$error (setting masked payinfo on payment#". $cust_pay->paynum.
1282 sub process_upgrade_paybatch {
1284 local $FS::payinfo_Mixin::ignore_masked_payinfo = 1;
1285 local $FS::UID::AutoCommit = 1;
1288 # migrate batchnums from the misused 'paybatch' field to 'batchnum'
1290 my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
1291 my $search = FS::Cursor->new( {
1292 'table' => 'cust_pay',
1293 'addl_from' => " JOIN pay_batch ON cust_pay.paybatch = CAST(pay_batch.batchnum AS $text) ",
1295 while (my $cust_pay = $search->fetch) {
1296 $cust_pay->set('batchnum' => $cust_pay->paybatch);
1297 $cust_pay->set('paybatch' => '');
1298 my $error = $cust_pay->replace;
1299 warn "error setting batchnum on cust_pay #".$cust_pay->paynum.":\n $error"
1304 # migrate gateway info from the misused 'paybatch' field
1307 # not only cust_pay, but also voided and refunded payments
1308 if (!FS::upgrade_journal->is_done('cust_pay__parse_paybatch_1')) {
1309 local $FS::Record::nowarn_classload=1;
1310 # really inefficient, but again, only has to run once
1311 foreach my $table (qw(cust_pay cust_pay_void cust_refund)) {
1312 my $and_batchnum_is_null =
1313 ( $table =~ /^cust_pay/ ? ' AND batchnum IS NULL' : '' );
1314 my $pkey = ($table =~ /^cust_pay/ ? 'paynum' : 'refundnum');
1315 my $search = FS::Cursor->new({
1317 extra_sql => "WHERE payby IN('CARD','CHEK') ".
1318 "AND (paybatch IS NOT NULL ".
1319 "OR (paybatch IS NULL AND auth IS NULL
1320 $and_batchnum_is_null ) )
1321 ORDER BY $pkey DESC"
1323 while ( my $object = $search->fetch ) {
1324 if ( $object->paybatch eq '' ) {
1325 # repair for a previous upgrade that didn't save 'auth'
1326 my $pkey = $object->primary_key;
1327 # find the last history record that had a paybatch value
1329 table => "h_$table",
1331 $pkey => $object->$pkey,
1332 paybatch => { op=>'!=', value=>''},
1333 history_action => 'replace_old',
1335 order_by => 'ORDER BY history_date DESC LIMIT 1',
1338 warn "couldn't find paybatch history record for $table ".$object->$pkey."\n";
1341 # if the paybatch didn't have an auth string, then it's fine
1342 $h->paybatch =~ /:(\w+):/ or next;
1343 # set paybatch to what it was in that record
1344 $object->set('paybatch', $h->paybatch)
1345 # and then upgrade it like the old records
1348 my $parsed = $object->_parse_paybatch;
1349 if (keys %$parsed) {
1350 $object->set($_ => $parsed->{$_}) foreach keys %$parsed;
1351 $object->set('auth' => $parsed->{authorization});
1352 $object->set('paybatch', '');
1353 my $error = $object->replace;
1354 warn "error parsing CARD/CHEK paybatch fields on $object #".
1355 $object->get($object->primary_key).":\n $error\n"
1360 FS::upgrade_journal->set_done('cust_pay__parse_paybatch_1');
1370 =item process_batch_import
1374 sub process_batch_import {
1379 my $custnum = $hash{'custnum'};
1380 my $agentnum = $hash{'agentnum'};
1381 my $agent_custid = $hash{'agent_custid'};
1383 $hash{'_date'} = parse_datetime($hash{'_date'})
1384 if $hash{'_date'} && $hash{'_date'} =~ /\D/;
1385 #remove custnum_prefix
1386 my $custnum_prefix = $conf->config('cust_main-custnum-display_prefix');
1387 my $custnum_length = $conf->config('cust_main-custnum-display_length') || 8;
1390 && $custnum =~ /^$custnum_prefix(0*([1-9]\d*))$/
1391 && length($1) == $custnum_length
1395 # check agentnum against custnum and
1396 # translate agent_custid into regular custnum
1397 if ($custnum && $agent_custid) {
1398 die "can't specify both custnum and agent_custid\n";
1399 } elsif ($agentnum || $agent_custid) {
1400 # here is the agent virtualization
1401 my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
1403 $search{'agentnum'} = $agentnum
1405 $search{'agent_custid'} = $agent_custid
1407 $search{'custnum'} = $custnum
1409 my $cust_main = qsearchs({
1410 'table' => 'cust_main',
1411 'hashref' => \%search,
1412 'extra_sql' => $extra_sql,
1414 die "can't find customer with" .
1415 ($agentnum ? " agentnum $agentnum" : '') .
1416 ($custnum ? " custnum $custnum" : '') .
1417 ($agent_custid ? " agent_custid $agent_custid" : '') . "\n"
1419 die "mismatched customer number\n"
1420 if $custnum && ($custnum ne $cust_main->custnum);
1421 $custnum = $cust_main->custnum;
1423 $hash{'custnum'} = $custnum;
1424 delete($hash{'agent_custid'});
1429 'table' => 'cust_pay',
1430 'params' => [ '_date', 'agentnum', 'payby', 'paybatch' ],
1431 #agent_custid isn't a cust_pay field, see hash callback
1432 'formats' => { 'simple' =>
1433 [ qw(custnum agent_custid paid payinfo invnum) ] },
1434 'format_types' => { 'simple' => '' }, #force infer from file extension
1435 'default_csv' => 1, #if not .xls, will read as csv, regardless of extension
1436 'format_hash_callbacks' => { 'simple' => $hashcb },
1437 'insert_args_callback' => sub { ( 'manual'=>1 ); },
1438 'postinsert_callback' => sub {
1439 my $cust_pay = shift;
1440 my $cust_main = $cust_pay->cust_main
1441 or return "can't find customer to which payments apply";
1442 my $error = $cust_main->apply_payments_and_credits( 'manual'=>1 );
1444 ? "can't apply payments to customer ".$cust_pay->custnum."$error"
1449 FS::Record::process_batch_import( $job, $opt, @_ );
1453 =item batch_import HASHREF
1455 Inserts new payments.
1462 my $fh = $param->{filehandle};
1463 my $format = $param->{'format'};
1465 my $agentnum = $param->{agentnum};
1466 my $_date = $param->{_date};
1467 $_date = parse_datetime($_date) if $_date && $_date =~ /\D/;
1468 my $paybatch = $param->{'paybatch'};
1470 my $custnum_prefix = $conf->config('cust_main-custnum-display_prefix');
1471 my $custnum_length = $conf->config('cust_main-custnum-display_length') || 8;
1473 # here is the agent virtualization
1474 my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
1478 if ( $format eq 'simple' ) {
1479 @fields = qw( custnum agent_custid paid payinfo invnum );
1481 } elsif ( $format eq 'extended' ) {
1482 die "unimplemented\n";
1486 die "unknown format $format";
1489 eval "use Text::CSV_XS;";
1492 my $csv = new Text::CSV_XS;
1496 local $SIG{HUP} = 'IGNORE';
1497 local $SIG{INT} = 'IGNORE';
1498 local $SIG{QUIT} = 'IGNORE';
1499 local $SIG{TERM} = 'IGNORE';
1500 local $SIG{TSTP} = 'IGNORE';
1501 local $SIG{PIPE} = 'IGNORE';
1503 my $oldAutoCommit = $FS::UID::AutoCommit;
1504 local $FS::UID::AutoCommit = 0;
1508 while ( defined($line=<$fh>) ) {
1510 $csv->parse($line) or do {
1511 $dbh->rollback if $oldAutoCommit;
1512 return "can't parse: ". $csv->error_input();
1515 my @columns = $csv->fields();
1519 paybatch => $paybatch,
1521 $cust_pay{_date} = $_date if $_date;
1524 foreach my $field ( @fields ) {
1526 if ( $field eq 'agent_custid'
1528 && $columns[0] =~ /\S+/ )
1531 my $agent_custid = $columns[0];
1532 my %hash = ( 'agent_custid' => $agent_custid,
1533 'agentnum' => $agentnum,
1536 if ( $cust_pay{'custnum'} !~ /^\s*$/ ) {
1537 $dbh->rollback if $oldAutoCommit;
1538 return "can't specify custnum with agent_custid $agent_custid";
1541 $cust_main = qsearchs({
1542 'table' => 'cust_main',
1543 'hashref' => \%hash,
1544 'extra_sql' => $extra_sql,
1547 unless ( $cust_main ) {
1548 $dbh->rollback if $oldAutoCommit;
1549 return "can't find customer with agent_custid $agent_custid";
1553 $columns[0] = $cust_main->custnum;
1556 $cust_pay{$field} = shift @columns;
1559 if ( $custnum_prefix && $cust_pay{custnum} =~ /^$custnum_prefix(0*([1-9]\d*))$/
1560 && length($1) == $custnum_length ) {
1561 $cust_pay{custnum} = $2;
1564 my $custnum = $cust_pay{custnum};
1566 my $cust_pay = new FS::cust_pay( \%cust_pay );
1567 my $error = $cust_pay->insert;
1569 if ( ! $error && $cust_pay->custnum != $custnum ) {
1570 #invnum was defined, and ->insert set custnum to the customer for that
1571 #invoice, but it wasn't the one the import specified.
1572 $dbh->rollback if $oldAutoCommit;
1573 $error = "specified invoice #". $cust_pay{invnum}.
1574 " is for custnum ". $cust_pay->custnum.
1575 ", not specified custnum $custnum";
1579 $dbh->rollback if $oldAutoCommit;
1580 return "can't insert payment for $line: $error";
1583 if ( $format eq 'simple' ) {
1584 # include agentnum for less surprise?
1585 $cust_main = qsearchs({
1586 'table' => 'cust_main',
1587 'hashref' => { 'custnum' => $cust_pay->custnum },
1588 'extra_sql' => $extra_sql,
1592 unless ( $cust_main ) {
1593 $dbh->rollback if $oldAutoCommit;
1594 return "can't find customer to which payments apply at line: $line";
1597 $error = $cust_main->apply_payments_and_credits;
1599 $dbh->rollback if $oldAutoCommit;
1600 return "can't apply payments to customer for $line: $error";
1608 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1610 return "Empty file!" unless $imported;
1620 Delete and replace methods.
1624 L<FS::cust_pay_pending>, L<FS::cust_bill_pay>, L<FS::cust_bill>, L<FS::Record>,
1625 schema.html from the base documentation.