4 use base qw( FS::otaker_Mixin FS::payinfo_transaction_Mixin FS::cust_main_Mixin
5 FS::reason_Mixin FS::Record);
6 use vars qw( $DEBUG $me $conf @encrypted_fields
10 use Business::CreditCard;
12 use FS::Misc::DateTime qw( parse_datetime ); #for batch_import
13 use FS::Record qw( dbh qsearch qsearchs );
14 use FS::UID qw( driver_name );
17 use FS::cust_main_Mixin;
18 use FS::payinfo_transaction_Mixin;
20 use FS::cust_bill_pay;
21 use FS::cust_pay_refund;
24 use FS::cust_pay_void;
25 use FS::upgrade_journal;
32 $me = '[FS::cust_pay]';
36 #ask FS::UID to run this stuff for us later
37 FS::UID->install_callback( sub {
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 Credit card type, if appropriate; autodetected.
106 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
110 obsolete text field for tracking card processing or other batch grouping
114 Optional unique identifer to prevent duplicate transactions.
118 books closed flag, empty or `Y'
122 Desired pkgnum when using experimental package balances.
126 Flag to only allow manual application of payment, empty or 'Y'
130 The bank where the payment was deposited.
134 The name of the depositor.
138 The deposit account number.
146 The number of the batch this payment came from (see L<FS::pay_batch>),
147 or null if it was processed through a realtime gateway or entered manually.
151 The number of the realtime or batch gateway L<FS::payment_gateway>) this
152 payment was processed through. Null if it was entered manually or processed
153 by the "system default" gateway, which doesn't have a number.
157 The name of the processor module (Business::OnlinePayment, ::BatchPayment,
158 or ::OnlineThirdPartyPayment subclass) used for this payment. Slightly
159 redundant with C<gatewaynum>.
163 The authorization number returned by the credit card network.
167 The transaction ID returned by the gateway, if any. This is usually what
168 you would use to initiate a void or refund of the payment.
178 Creates a new payment. To add the payment to the databse, see L<"insert">.
182 sub table { 'cust_pay'; }
183 sub cust_linked { $_[0]->cust_main_custnum || $_[0]->custnum; }
184 sub cust_unlinked_msg {
186 "WARNING: can't find cust_main.custnum ". $self->custnum.
187 ' (cust_pay.paynum '. $self->paynum. ')';
190 =item insert [ OPTION => VALUE ... ]
192 Adds this payment to the database.
194 For backwards-compatibility and convenience, if the additional field invnum
195 is defined, an FS::cust_bill_pay record for the full amount of the payment
196 will be created. In this case, custnum is optional.
198 If the additional field discount_term is defined then a prepayment discount
199 is taken for that length of time. It is an error for the customer to owe
200 after this payment is made.
202 A hash of optional arguments may be passed. The following arguments are
209 If true, a payment receipt is sent instead of a statement when
210 'payment_receipt_email' configuration option is set.
212 About the "manual" flag: Normally, if the 'payment_receipt' config option
213 is set, and the customer has an invoice email address, inserting a payment
214 causes a I<statement> to be emailed to the customer. If the payment is
215 considered "manual" (or if the customer has no invoices), then it will
216 instead send a I<payment receipt>. "manual" should be true whenever a
217 payment is created directly from the web interface, from a user-initiated
218 realtime payment, or from a third-party payment via self-service. It should
219 be I<false> when creating a payment from a billing event or from a batch.
223 Don't send an email receipt. (Note: does not currently work when
224 payment_receipt-trigger is set to something other than default / cust_bill)
231 my($self, %options) = @_;
233 local $SIG{HUP} = 'IGNORE';
234 local $SIG{INT} = 'IGNORE';
235 local $SIG{QUIT} = 'IGNORE';
236 local $SIG{TERM} = 'IGNORE';
237 local $SIG{TSTP} = 'IGNORE';
238 local $SIG{PIPE} = 'IGNORE';
240 my $oldAutoCommit = $FS::UID::AutoCommit;
241 local $FS::UID::AutoCommit = 0;
245 if ( $self->invnum ) {
246 $cust_bill = qsearchs('cust_bill', { 'invnum' => $self->invnum } )
248 $dbh->rollback if $oldAutoCommit;
249 return "Unknown cust_bill.invnum: ". $self->invnum;
251 if ($self->custnum && ($cust_bill->custnum ne $self->custnum)) {
252 $dbh->rollback if $oldAutoCommit;
253 return "Invoice custnum ".$cust_bill->custnum
254 ." does not match specified custnum ".$self->custnum
255 ." for invoice ".$self->invnum;
257 $self->custnum($cust_bill->custnum );
260 my $error = $self->check;
261 return $error if $error;
263 my $cust_main = $self->cust_main;
264 my $old_balance = $cust_main->balance;
266 $error = $self->SUPER::insert;
268 $dbh->rollback if $oldAutoCommit;
269 return "error inserting cust_pay: $error";
272 if ( my $credit_type = $conf->config('prepayment_discounts-credit_type') ) {
273 if ( my $months = $self->discount_term ) {
274 # XXX this should be moved out somewhere, but discount_term_values
276 my ($cust_bill) = ($cust_main->cust_bill)[-1]; # most recent invoice
277 return "can't accept prepayment for an unbilled customer" if !$cust_bill;
279 # %billing_pkgs contains this customer's active monthly packages.
280 # Recurring fees for those packages will be credited and then rebilled
281 # for the full discount term. Other packages on the last invoice
282 # (canceled, non-monthly recurring, or one-time charges) will be
284 my %billing_pkgs = map { $_->pkgnum => $_ }
285 grep { $_->part_pkg->freq eq '1' }
286 $cust_main->billing_pkgs;
287 my $credit = 0; # sum of recurring charges from that invoice
288 my $last_bill_date = 0; # the real bill date
289 foreach my $item ( $cust_bill->cust_bill_pkg ) {
290 next if !exists($billing_pkgs{$item->pkgnum}); # skip inactive packages
291 $credit += $item->recur;
292 $last_bill_date = $item->cust_pkg->last_bill
293 if defined($item->cust_pkg)
294 and $item->cust_pkg->last_bill > $last_bill_date
297 my $cust_credit = new FS::cust_credit {
298 'custnum' => $self->custnum,
299 'amount' => sprintf('%.2f', $credit),
300 'reason' => 'customer chose to prepay for discount',
302 $error = $cust_credit->insert('reason_type' => $credit_type);
304 $dbh->rollback if $oldAutoCommit;
305 return "error inserting prepayment credit: $error";
309 # bill for the entire term
310 $_->bill($_->last_bill) foreach (values %billing_pkgs);
311 $error = $cust_main->bill(
312 # no recurring_only, we want unbilled packages with start dates to
314 'no_usage_reset' => 1,
315 'time' => $last_bill_date, # not $cust_bill->_date
316 'pkg_list' => [ values %billing_pkgs ],
317 'freq_override' => $months,
320 $dbh->rollback if $oldAutoCommit;
321 return "error inserting cust_pay: $error";
323 $error = $cust_main->apply_payments_and_credits;
325 $dbh->rollback if $oldAutoCommit;
326 return "error inserting cust_pay: $error";
328 my $new_balance = $cust_main->balance;
329 if ($new_balance > 0) {
330 $dbh->rollback if $oldAutoCommit;
331 return "balance after prepay discount attempt: $new_balance";
333 # user friendly: override the "apply only to this invoice" mode
340 if ( $self->invnum ) {
341 my $cust_bill_pay = new FS::cust_bill_pay {
342 'invnum' => $self->invnum,
343 'paynum' => $self->paynum,
344 'amount' => $self->paid,
345 '_date' => $self->_date,
347 $error = $cust_bill_pay->insert(%options);
349 if ( $ignore_noapply ) {
350 warn "warning: error inserting cust_bill_pay: $error ".
351 "(ignore_noapply flag set; inserting cust_pay record anyway)\n";
353 $dbh->rollback if $oldAutoCommit;
354 return "error inserting cust_bill_pay: $error";
359 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
361 # possibly trigger package unsuspend, doesn't abort transaction on failure
362 $self->unsuspend_balance if $old_balance;
364 #bill setup fees for voip_cdr bill_every_call packages
365 #some false laziness w/search in freeside-cdrd
367 'LEFT JOIN part_pkg USING ( pkgpart ) '.
368 "LEFT JOIN part_pkg_option
369 ON ( cust_pkg.pkgpart = part_pkg_option.pkgpart
370 AND part_pkg_option.optionname = 'bill_every_call' )";
372 my $extra_sql = " AND plan = 'voip_cdr' AND optionvalue = '1' ".
373 " AND ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 ) ";
375 my @cust_pkg = qsearch({
376 'table' => 'cust_pkg',
377 'addl_from' => $addl_from,
378 'hashref' => { 'custnum' => $self->custnum,
382 'extra_sql' => $extra_sql,
386 warn "voip_cdr bill_every_call packages found; billing customer\n";
387 my $bill_error = $self->cust_main->bill_and_collect( 'fatal' => 'return' );
389 warn "WARNING: Error billing customer: $bill_error\n";
392 #end of billing setup fees for voip_cdr bill_every_call packages
394 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
397 my $trigger = $conf->config('payment_receipt-trigger',
398 $self->cust_main->agentnum) || 'cust_pay';
399 if ( $trigger eq 'cust_pay' ) {
400 my $error = $self->send_receipt(
401 'manual' => $options{'manual'},
402 'noemail' => $options{'noemail'},
403 'cust_bill' => $cust_bill,
404 'cust_main' => $cust_main,
406 warn "can't send payment receipt/statement: $error" if $error;
409 #run payment events immediately
410 my $due_cust_event = $self->cust_main->due_cust_event(
411 'eventtable' => 'cust_pay',
412 'objects' => [ $self ],
414 if ( !ref($due_cust_event) ) {
415 warn "Error searching for cust_pay billing events: $due_cust_event\n";
417 foreach my $cust_event (@$due_cust_event) {
418 next unless $cust_event->test_conditions;
419 if ( my $error = $cust_event->do_event() ) {
420 warn "Error running cust_pay billing event: $error\n";
429 =item void [ REASON ]
431 Voids this payment: deletes the payment and all associated applications and
432 adds a record of the voided payment to the FS::cust_pay_void table.
440 unless (ref($reason) || !$reason) {
441 $reason = FS::reason->new_or_existing(
443 'type' => 'Void payment',
448 local $SIG{HUP} = 'IGNORE';
449 local $SIG{INT} = 'IGNORE';
450 local $SIG{QUIT} = 'IGNORE';
451 local $SIG{TERM} = 'IGNORE';
452 local $SIG{TSTP} = 'IGNORE';
453 local $SIG{PIPE} = 'IGNORE';
455 my $oldAutoCommit = $FS::UID::AutoCommit;
456 local $FS::UID::AutoCommit = 0;
459 my $cust_pay_void = new FS::cust_pay_void ( {
460 map { $_ => $self->get($_) } $self->fields
462 $cust_pay_void->reasonnum($reason->reasonnum) if $reason;
463 my $error = $cust_pay_void->insert;
465 my $cust_pay_pending =
466 qsearchs('cust_pay_pending', { paynum => $self->paynum });
467 if ( $cust_pay_pending ) {
468 $cust_pay_pending->set('void_paynum', $self->paynum);
469 $cust_pay_pending->set('paynum', '');
470 $error ||= $cust_pay_pending->replace;
473 $error ||= $self->delete;
476 $dbh->rollback if $oldAutoCommit;
480 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
488 Unless the closed flag is set, deletes this payment and all associated
489 applications (see L<FS::cust_bill_pay> and L<FS::cust_pay_refund>). In most
490 cases, you want to use the void method instead to leave a record of the
495 # very similar to FS::cust_credit::delete
498 return "Can't delete closed payment" if $self->closed =~ /^Y/i;
500 local $SIG{HUP} = 'IGNORE';
501 local $SIG{INT} = 'IGNORE';
502 local $SIG{QUIT} = 'IGNORE';
503 local $SIG{TERM} = 'IGNORE';
504 local $SIG{TSTP} = 'IGNORE';
505 local $SIG{PIPE} = 'IGNORE';
507 my $oldAutoCommit = $FS::UID::AutoCommit;
508 local $FS::UID::AutoCommit = 0;
511 foreach my $app ( $self->cust_bill_pay, $self->cust_pay_refund ) {
512 my $error = $app->delete;
514 $dbh->rollback if $oldAutoCommit;
519 my $error = $self->SUPER::delete(@_);
521 $dbh->rollback if $oldAutoCommit;
525 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
531 =item replace [ OLD_RECORD ]
533 You can, but probably shouldn't modify payments...
535 Replaces the OLD_RECORD with this one in the database, or, if OLD_RECORD is not
536 supplied, replaces this record. If there is an error, returns the error,
537 otherwise returns false.
543 return "Can't modify closed payment"
544 if $self->closed =~ /^Y/i && !$FS::payinfo_Mixin::allow_closed_replace;
545 $self->SUPER::replace(@_);
550 Checks all fields to make sure this is a valid payment. If there is an error,
551 returns the error, otherwise returns false. Called by the insert method.
558 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
561 $self->ut_numbern('paynum')
562 || $self->ut_numbern('custnum')
563 || $self->ut_numbern('_date')
564 || $self->ut_money('paid')
565 || $self->ut_alphan('otaker')
566 || $self->ut_textn('paybatch')
567 || $self->ut_textn('payunique')
568 || $self->ut_enum('closed', [ '', 'Y' ])
569 || $self->ut_flag('no_auto_apply')
570 || $self->ut_foreign_keyn('pkgnum', 'cust_pkg', 'pkgnum')
571 || $self->ut_textn('bank')
572 || $self->ut_alphan('depositor')
573 || $self->ut_numbern('account')
574 || $self->ut_numbern('teller')
575 || $self->ut_foreign_keyn('batchnum', 'pay_batch', 'batchnum')
576 || $self->payinfo_check()
578 return $error if $error;
580 return "paid must be > 0 " if $self->paid <= 0;
582 return "unknown cust_main.custnum: ". $self->custnum
584 || qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
586 $self->_date(time) unless $self->_date;
588 return "invalid discount_term"
589 if ($self->discount_term && $self->discount_term < 2);
591 if ( $self->payby eq 'CASH' and $conf->exists('require_cash_deposit_info') ) {
592 foreach (qw(bank depositor account teller)) {
593 return "$_ required" if $self->get($_) eq '';
597 #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it
598 # # UNIQUE index should catch this too, without race conditions, but this
599 # # should give a better error message the other 99.9% of the time...
600 # if ( length($self->payunique)
601 # && qsearchs('cust_pay', { 'payunique' => $self->payunique } ) ) {
602 # #well, it *could* be a better error message
603 # return "duplicate transaction".
604 # " - a payment with unique identifer ". $self->payunique.
611 =item send_receipt HASHREF | OPTION => VALUE ...
613 Sends a payment receipt for this payment..
621 Flag indicating the payment is being made manually.
625 Invoice (FS::cust_bill) object. If not specified, the most recent invoice
630 Customer (FS::cust_main) object (for efficiency).
634 Don't send an email receipt.
644 my $opt = ref($_[0]) ? shift : { @_ };
646 my $cust_bill = $opt->{'cust_bill'};
647 my $cust_main = $opt->{'cust_main'} || $self->cust_main;
649 my $conf = new FS::Conf;
651 return '' unless $conf->config_bool('payment_receipt', $cust_main->agentnum);
653 my @invoicing_list = $cust_main->invoicing_list_emailonly;
654 return '' unless @invoicing_list;
656 $cust_bill ||= ($cust_main->cust_bill)[-1]; #rather inefficient though?
660 if ( ( exists($opt->{'manual'}) && $opt->{'manual'} )
661 #|| ! $conf->exists('invoice_html_statement')
665 my $msgnum = $conf->config('payment_receipt_msgnum', $cust_main->agentnum);
668 my %substitutions = ();
669 $substitutions{invnum} = $opt->{cust_bill}->invnum if $opt->{cust_bill};
671 my $msg_template = qsearchs('msg_template',{ msgnum => $msgnum});
672 unless ($msg_template) {
673 warn "send_receipt could not load msg_template";
677 my $cust_msg = $msg_template->prepare(
678 'cust_main' => $cust_main,
680 'from_config' => 'payment_receipt_from',
681 'substitutions' => \%substitutions,
682 'msgtype' => 'receipt',
684 $error = $cust_msg ? $cust_msg->insert : 'error preparing msg_template';
686 warn "send_receipt: $error";
690 my $queue = new FS::queue {
691 'job' => 'FS::cust_msg::process_send',
692 'paynum' => $self->paynum,
693 'custnum' => $cust_main->custnum,
695 $error = $queue->insert( $cust_msg->custmsgnum );
699 warn "payment_receipt is on, but no payment_receipt_msgnum\n";
703 #not manual and no noemail flag (here or on the customer)
704 } elsif ( ! $opt->{'noemail'} && ! $cust_main->invoice_noemail ) {
706 my $queue = new FS::queue {
707 'job' => 'FS::cust_bill::queueable_email',
708 'paynum' => $self->paynum,
709 'custnum' => $cust_main->custnum,
713 'invnum' => $cust_bill->invnum,
717 if ( my $mode = $conf->config('payment_receipt_statement_mode') ) {
718 $opt{'mode'} = $mode;
720 # backward compatibility, no good fix for this yet as some people may
721 # still have "invoice_latex_statement" and such options
722 $opt{'template'} = 'statement';
723 $opt{'notice_name'} = 'Statement';
726 $error = $queue->insert(%opt);
730 warn "send_receipt: $error\n" if $error;
735 Returns all applications to invoices (see L<FS::cust_bill_pay>) for this
742 map { $_ } #return $self->num_cust_bill_pay unless wantarray;
743 sort { $a->_date <=> $b->_date
744 || $a->invnum <=> $b->invnum }
745 qsearch( 'cust_bill_pay', { 'paynum' => $self->paynum } )
749 =item cust_pay_refund
751 Returns all applications of refunds (see L<FS::cust_pay_refund>) to this
756 sub cust_pay_refund {
758 map { $_ } #return $self->num_cust_pay_refund unless wantarray;
759 sort { $a->_date <=> $b->_date }
760 qsearch( 'cust_pay_refund', { 'paynum' => $self->paynum } )
767 Returns the amount of this payment that is still unapplied; which is
768 paid minus all payment applications (see L<FS::cust_bill_pay>) and refund
769 applications (see L<FS::cust_pay_refund>).
775 my $amount = $self->paid;
776 $amount -= $_->amount foreach ( $self->cust_bill_pay );
777 $amount -= $_->amount foreach ( $self->cust_pay_refund );
778 sprintf("%.2f", $amount );
783 Returns the amount of this payment that has not been refuned; which is
784 paid minus all refund applications (see L<FS::cust_pay_refund>).
790 my $amount = $self->paid;
791 $amount -= $_->amount foreach ( $self->cust_pay_refund );
792 sprintf("%.2f", $amount );
797 Returns the "paid" field.
806 =item delete_cust_bill_pay OPTIONS
808 Deletes all associated cust_bill_pay records.
810 If option 'unapplied' is a specified, only deletes until
811 this object's 'unapplied' value is >= the specified amount.
812 (Deletes in order returned by L</cust_bill_pay>.)
816 sub delete_cust_bill_pay {
820 local $SIG{HUP} = 'IGNORE';
821 local $SIG{INT} = 'IGNORE';
822 local $SIG{QUIT} = 'IGNORE';
823 local $SIG{TERM} = 'IGNORE';
824 local $SIG{TSTP} = 'IGNORE';
825 local $SIG{PIPE} = 'IGNORE';
827 my $oldAutoCommit = $FS::UID::AutoCommit;
828 local $FS::UID::AutoCommit = 0;
831 my $unapplied = $self->unapplied; #only need to look it up once
835 # Maybe we should reverse the order these get deleted in?
836 # ie delete newest first?
837 # keeping consistent with how bop refunds work, for now...
838 foreach my $cust_bill_pay ( $self->cust_bill_pay ) {
839 last if $opt{'unapplied'} && ($unapplied > $opt{'unapplied'});
840 $unapplied += $cust_bill_pay->amount;
841 $error = $cust_bill_pay->delete;
846 $dbh->rollback if $oldAutoCommit;
850 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
856 Accepts input for creating a new FS::cust_refund object.
857 Unapplies payment from invoices up to the amount of the refund,
858 creates the refund and applies payment to refund. Allows entire
859 process to be handled in one transaction.
861 Causes a fatal error if called on CARD or CHEK payments.
868 die "Cannot call cust_pay->refund on " . $self->payby
869 if grep { $_ eq $self->payby } qw(CARD CHEK);
871 local $SIG{HUP} = 'IGNORE';
872 local $SIG{INT} = 'IGNORE';
873 local $SIG{QUIT} = 'IGNORE';
874 local $SIG{TERM} = 'IGNORE';
875 local $SIG{TSTP} = 'IGNORE';
876 local $SIG{PIPE} = 'IGNORE';
878 my $oldAutoCommit = $FS::UID::AutoCommit;
879 local $FS::UID::AutoCommit = 0;
882 my $error = $self->delete_cust_bill_pay('amount' => $hash->{'amount'});
885 $dbh->rollback if $oldAutoCommit;
889 $hash->{'paynum'} = $self->paynum;
890 my $new = new FS::cust_refund ( $hash );
891 $error = $new->insert;
894 $dbh->rollback if $oldAutoCommit;
898 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
902 ### refund_to_unapply/unapply_refund false laziness with FS::cust_credit
904 =item refund_to_unapply
906 Returns L<FS::cust_pay_refund> objects that will be deleted by L</unapply_refund>
907 (all currently applied refunds that aren't closed.)
908 Returns empty list if payment itself is closed.
912 sub refund_to_unapply {
914 return () if $self->closed;
916 'table' => 'cust_pay_refund',
917 'hashref' => { 'paynum' => $self->paynum },
918 'addl_from' => 'LEFT JOIN cust_refund USING (refundnum)',
919 'extra_sql' => "AND cust_refund.closed IS NULL AND cust_refund.source_paynum IS NULL",
925 Deletes all objects returned by L</refund_to_unapply>.
932 local $SIG{HUP} = 'IGNORE';
933 local $SIG{INT} = 'IGNORE';
934 local $SIG{QUIT} = 'IGNORE';
935 local $SIG{TERM} = 'IGNORE';
936 local $SIG{TSTP} = 'IGNORE';
937 local $SIG{PIPE} = 'IGNORE';
939 my $oldAutoCommit = $FS::UID::AutoCommit;
940 local $FS::UID::AutoCommit = 0;
942 foreach my $cust_pay_refund ($self->refund_to_unapply) {
943 my $error = $cust_pay_refund->delete;
945 dbh->rollback if $oldAutoCommit;
950 dbh->commit or die dbh->errstr if $oldAutoCommit;
960 =item batch_insert CUST_PAY_OBJECT, ...
962 Class method which inserts multiple payments. Takes a list of FS::cust_pay
963 objects. Returns a list, each element representing the status of inserting the
964 corresponding payment - empty. If there is an error inserting any payment, the
965 entire transaction is rolled back, i.e. all payments are inserted or none are.
967 FS::cust_pay objects may have the pseudo-field 'apply_to', containing a
968 reference to an array of (uninserted) FS::cust_bill_pay objects. If so,
969 those objects will be inserted with the paynum of the payment, and for
970 each one, an error message or an empty string will be inserted into the
975 my @errors = FS::cust_pay->batch_insert(@cust_pay);
976 my $num_errors = scalar(grep $_, @errors);
977 if ( $num_errors == 0 ) {
978 #success; all payments were inserted
980 #failure; no payments were inserted.
986 my $self = shift; #class method
988 local $SIG{HUP} = 'IGNORE';
989 local $SIG{INT} = 'IGNORE';
990 local $SIG{QUIT} = 'IGNORE';
991 local $SIG{TERM} = 'IGNORE';
992 local $SIG{TSTP} = 'IGNORE';
993 local $SIG{PIPE} = 'IGNORE';
995 my $oldAutoCommit = $FS::UID::AutoCommit;
996 local $FS::UID::AutoCommit = 0;
1002 foreach my $cust_pay (@_) {
1003 my $error = $cust_pay->insert( 'manual' => 1 );
1004 push @errors, $error;
1005 $num_errors++ if $error;
1007 if ( ref($cust_pay->get('apply_to')) eq 'ARRAY' ) {
1009 foreach my $cust_bill_pay ( @{ $cust_pay->apply_to } ) {
1010 if ( $error ) { # insert placeholders if cust_pay wasn't inserted
1014 $cust_bill_pay->set('paynum', $cust_pay->paynum);
1015 my $apply_error = $cust_bill_pay->insert;
1016 push @errors, $apply_error || '';
1017 $num_errors++ if $apply_error;
1021 } elsif ( !$error ) { #normal case: apply payments as usual
1022 $cust_pay->cust_main->apply_payments( 'manual'=>1 );
1027 if ( $num_errors ) {
1028 $dbh->rollback if $oldAutoCommit;
1030 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1039 Returns an SQL fragment to retreive the unapplied amount.
1044 my ($class, $start, $end) = @_;
1045 my $bill_start = $start ? "AND cust_bill_pay._date <= $start" : '';
1046 my $bill_end = $end ? "AND cust_bill_pay._date > $end" : '';
1047 my $refund_start = $start ? "AND cust_pay_refund._date <= $start" : '';
1048 my $refund_end = $end ? "AND cust_pay_refund._date > $end" : '';
1052 ( SELECT SUM(amount) FROM cust_bill_pay
1053 WHERE cust_pay.paynum = cust_bill_pay.paynum
1054 $bill_start $bill_end )
1058 ( SELECT SUM(amount) FROM cust_pay_refund
1059 WHERE cust_pay.paynum = cust_pay_refund.paynum
1060 $refund_start $refund_end )
1069 my @fields = grep { $_ ne 'payinfo' } $self->fields;
1070 +{ ( map { $_=>$self->$_ } @fields ),
1076 # Used by FS::Upgrade to migrate to a new database.
1080 sub _upgrade_data { #class method
1081 my ($class, %opt) = @_;
1083 warn "$me upgrading $class\n" if $DEBUG;
1085 $class->_upgrade_reasonnum(%opt);
1087 local $FS::payinfo_Mixin::ignore_masked_payinfo = 1;
1090 # otaker/ivan upgrade
1093 unless ( FS::upgrade_journal->is_done('cust_pay__otaker_ivan') ) {
1095 #not the most efficient, but hey, it only has to run once
1097 my $where = " WHERE ( otaker IS NULL OR otaker = '' OR otaker = 'ivan' )
1099 AND EXISTS ( SELECT 1 FROM cust_main
1100 WHERE cust_main.custnum = cust_pay.custnum )
1103 my $count_sql = "SELECT COUNT(*) FROM cust_pay $where";
1105 my $sth = dbh->prepare($count_sql) or die dbh->errstr;
1106 $sth->execute or die $sth->errstr;
1107 my $total = $sth->fetchrow_arrayref->[0];
1108 #warn "$total cust_pay records to update\n"
1110 local($DEBUG) = 2 if $total > 1000; #could be a while, force progress info
1115 my @cust_pay = qsearch( {
1116 'table' => 'cust_pay',
1118 'extra_sql' => $where,
1119 'order_by' => 'ORDER BY paynum',
1122 foreach my $cust_pay (@cust_pay) {
1124 my $h_cust_pay = $cust_pay->h_search('insert');
1125 if ( $h_cust_pay ) {
1126 next if $cust_pay->otaker eq $h_cust_pay->history_user;
1127 #$cust_pay->otaker($h_cust_pay->history_user);
1128 $cust_pay->set('otaker', $h_cust_pay->history_user);
1130 $cust_pay->set('otaker', 'legacy');
1133 my $error = $cust_pay->replace;
1136 warn " *** WARNING: Error updating order taker for payment paynum ".
1137 $cust_pay->paynun. ": $error\n";
1142 if ( $DEBUG > 1 && $lastprog + 30 < time ) {
1143 warn "$me $count/$total (".sprintf('%.2f',100*$count/$total). '%)'."\n";
1149 FS::upgrade_journal->set_done('cust_pay__otaker_ivan');
1153 # payinfo N/A upgrade
1156 unless ( FS::upgrade_journal->is_done('cust_pay__payinfo_na') ) {
1158 #XXX remove the 'N/A (tokenized)' part (or just this entire thing)
1160 my @na_cust_pay = qsearch( {
1161 'table' => 'cust_pay',
1162 'hashref' => {}, #could be encrypted# { 'payinfo' => 'N/A' },
1163 'extra_sql' => "WHERE ( payinfo = 'N/A' OR paymask = 'N/AA' OR paymask = 'N/A (tokenized)' ) AND payby IN ( 'CARD', 'CHEK' )",
1166 foreach my $na ( @na_cust_pay ) {
1168 next unless $na->payinfo eq 'N/A';
1170 my $cust_pay_pending =
1171 qsearchs('cust_pay_pending', { 'paynum' => $na->paynum } );
1172 unless ( $cust_pay_pending ) {
1173 warn " *** WARNING: not-yet recoverable N/A card for payment ".
1174 $na->paynum. " (no cust_pay_pending)\n";
1177 $na->$_($cust_pay_pending->$_) for qw( payinfo paymask );
1178 my $error = $na->replace;
1180 warn " *** WARNING: Error updating payinfo for payment paynum ".
1181 $na->paynun. ": $error\n";
1187 FS::upgrade_journal->set_done('cust_pay__payinfo_na');
1191 # otaker->usernum upgrade
1194 $class->_upgrade_otaker(%opt);
1196 # if we do this anywhere else, it should become an FS::Upgrade method
1197 my $num_to_upgrade = $class->count('paybatch is not null');
1198 my $num_jobs = FS::queue->count('job = \'FS::cust_pay::process_upgrade_paybatch\' and status != \'failed\'');
1199 if ( $num_to_upgrade > 0 ) {
1200 warn "Need to migrate paybatch field in $num_to_upgrade payments.\n";
1201 if ( $opt{queue} ) {
1202 if ( $num_jobs > 0 ) {
1203 warn "Upgrade already queued.\n";
1205 warn "Scheduling upgrade.\n";
1206 my $job = FS::queue->new({ job => 'FS::cust_pay::process_upgrade_paybatch' });
1210 process_upgrade_paybatch();
1217 $class->upgrade_set_cardtype;
1219 # for batch payments, make sure paymask is set
1221 local $FS::payinfo_Mixin::allow_closed_replace = 1;
1222 local $FS::payinfo_Mixin::ignore_masked_payinfo = 1;
1224 my $cursor = FS::Cursor->new({
1225 table => 'cust_pay',
1226 extra_sql => ' WHERE paymask IS NULL AND payinfo IS NOT NULL
1227 AND payby IN(\'CARD\', \'CHEK\')
1228 AND batchnum IS NOT NULL',
1231 # records from cursors for some reason don't decrypt payinfo, so
1232 # call replace_old to fetch the record "normally"
1233 while (my $cust_pay = $cursor->fetch) {
1234 $cust_pay = $cust_pay->replace_old;
1235 $cust_pay->set('paymask', $cust_pay->mask_payinfo);
1236 my $error = $cust_pay->replace;
1238 die "$error (setting masked payinfo on payment#". $cust_pay->paynum.
1245 sub process_upgrade_paybatch {
1247 local $FS::payinfo_Mixin::ignore_masked_payinfo = 1;
1248 local $FS::UID::AutoCommit = 1;
1251 # migrate batchnums from the misused 'paybatch' field to 'batchnum'
1253 my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
1254 my $search = FS::Cursor->new( {
1255 'table' => 'cust_pay',
1256 'addl_from' => " JOIN pay_batch ON cust_pay.paybatch = CAST(pay_batch.batchnum AS $text) ",
1258 while (my $cust_pay = $search->fetch) {
1259 $cust_pay->set('batchnum' => $cust_pay->paybatch);
1260 $cust_pay->set('paybatch' => '');
1261 my $error = $cust_pay->replace;
1262 warn "error setting batchnum on cust_pay #".$cust_pay->paynum.":\n $error"
1267 # migrate gateway info from the misused 'paybatch' field
1270 # not only cust_pay, but also voided and refunded payments
1271 if (!FS::upgrade_journal->is_done('cust_pay__parse_paybatch_1')) {
1272 local $FS::Record::nowarn_classload=1;
1273 # really inefficient, but again, only has to run once
1274 foreach my $table (qw(cust_pay cust_pay_void cust_refund)) {
1275 my $and_batchnum_is_null =
1276 ( $table =~ /^cust_pay/ ? ' AND batchnum IS NULL' : '' );
1277 my $pkey = ($table =~ /^cust_pay/ ? 'paynum' : 'refundnum');
1278 my $search = FS::Cursor->new({
1280 extra_sql => "WHERE payby IN('CARD','CHEK') ".
1281 "AND (paybatch IS NOT NULL ".
1282 "OR (paybatch IS NULL AND auth IS NULL
1283 $and_batchnum_is_null ) )
1284 ORDER BY $pkey DESC"
1286 while ( my $object = $search->fetch ) {
1287 if ( $object->paybatch eq '' ) {
1288 # repair for a previous upgrade that didn't save 'auth'
1289 my $pkey = $object->primary_key;
1290 # find the last history record that had a paybatch value
1292 table => "h_$table",
1294 $pkey => $object->$pkey,
1295 paybatch => { op=>'!=', value=>''},
1296 history_action => 'replace_old',
1298 order_by => 'ORDER BY history_date DESC LIMIT 1',
1301 warn "couldn't find paybatch history record for $table ".$object->$pkey."\n";
1304 # if the paybatch didn't have an auth string, then it's fine
1305 $h->paybatch =~ /:(\w+):/ or next;
1306 # set paybatch to what it was in that record
1307 $object->set('paybatch', $h->paybatch)
1308 # and then upgrade it like the old records
1311 my $parsed = $object->_parse_paybatch;
1312 if (keys %$parsed) {
1313 $object->set($_ => $parsed->{$_}) foreach keys %$parsed;
1314 $object->set('auth' => $parsed->{authorization});
1315 $object->set('paybatch', '');
1316 my $error = $object->replace;
1317 warn "error parsing CARD/CHEK paybatch fields on $object #".
1318 $object->get($object->primary_key).":\n $error\n"
1323 FS::upgrade_journal->set_done('cust_pay__parse_paybatch_1');
1333 =item process_batch_import
1337 sub process_batch_import {
1342 my $custnum = $hash{'custnum'};
1343 my $agentnum = $hash{'agentnum'};
1344 my $agent_custid = $hash{'agent_custid'};
1346 $hash{'_date'} = parse_datetime($hash{'_date'})
1347 if $hash{'_date'} && $hash{'_date'} =~ /\D/;
1348 #remove custnum_prefix
1349 my $custnum_prefix = $conf->config('cust_main-custnum-display_prefix');
1350 my $custnum_length = $conf->config('cust_main-custnum-display_length') || 8;
1353 && $custnum =~ /^$custnum_prefix(0*([1-9]\d*))$/
1354 && length($1) == $custnum_length
1358 # check agentnum against custnum and
1359 # translate agent_custid into regular custnum
1360 if ($custnum && $agent_custid) {
1361 die "can't specify both custnum and agent_custid\n";
1362 } elsif ($agentnum || $agent_custid) {
1363 # here is the agent virtualization
1364 my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
1366 $search{'agentnum'} = $agentnum
1368 $search{'agent_custid'} = $agent_custid
1370 $search{'custnum'} = $custnum
1372 my $cust_main = qsearchs({
1373 'table' => 'cust_main',
1374 'hashref' => \%search,
1375 'extra_sql' => $extra_sql,
1377 die "can't find customer with" .
1378 ($agentnum ? " agentnum $agentnum" : '') .
1379 ($custnum ? " custnum $custnum" : '') .
1380 ($agent_custid ? " agent_custid $agent_custid" : '') . "\n"
1382 die "mismatched customer number\n"
1383 if $custnum && ($custnum ne $cust_main->custnum);
1384 $custnum = $cust_main->custnum;
1386 $hash{'custnum'} = $custnum;
1387 delete($hash{'agent_custid'});
1392 'table' => 'cust_pay',
1393 'params' => [ '_date', 'agentnum', 'payby', 'paybatch' ],
1394 #agent_custid isn't a cust_pay field, see hash callback
1395 'formats' => { 'simple' =>
1396 [ qw(custnum agent_custid paid payinfo invnum) ] },
1397 'format_types' => { 'simple' => '' }, #force infer from file extension
1398 'default_csv' => 1, #if not .xls, will read as csv, regardless of extension
1399 'format_hash_callbacks' => { 'simple' => $hashcb },
1400 'insert_args_callback' => sub { ( 'manual'=>1 ); },
1401 'postinsert_callback' => sub {
1402 my $cust_pay = shift;
1403 my $cust_main = $cust_pay->cust_main
1404 or return "can't find customer to which payments apply";
1405 my $error = $cust_main->apply_payments_and_credits( 'manual'=>1 );
1407 ? "can't apply payments to customer ".$cust_pay->custnum."$error"
1412 FS::Record::process_batch_import( $job, $opt, @_ );
1416 =item batch_import HASHREF
1418 Inserts new payments.
1425 my $fh = $param->{filehandle};
1426 my $format = $param->{'format'};
1428 my $agentnum = $param->{agentnum};
1429 my $_date = $param->{_date};
1430 $_date = parse_datetime($_date) if $_date && $_date =~ /\D/;
1431 my $paybatch = $param->{'paybatch'};
1433 my $custnum_prefix = $conf->config('cust_main-custnum-display_prefix');
1434 my $custnum_length = $conf->config('cust_main-custnum-display_length') || 8;
1436 # here is the agent virtualization
1437 my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
1441 if ( $format eq 'simple' ) {
1442 @fields = qw( custnum agent_custid paid payinfo invnum );
1444 } elsif ( $format eq 'extended' ) {
1445 die "unimplemented\n";
1449 die "unknown format $format";
1452 eval "use Text::CSV_XS;";
1455 my $csv = new Text::CSV_XS;
1459 local $SIG{HUP} = 'IGNORE';
1460 local $SIG{INT} = 'IGNORE';
1461 local $SIG{QUIT} = 'IGNORE';
1462 local $SIG{TERM} = 'IGNORE';
1463 local $SIG{TSTP} = 'IGNORE';
1464 local $SIG{PIPE} = 'IGNORE';
1466 my $oldAutoCommit = $FS::UID::AutoCommit;
1467 local $FS::UID::AutoCommit = 0;
1471 while ( defined($line=<$fh>) ) {
1473 $csv->parse($line) or do {
1474 $dbh->rollback if $oldAutoCommit;
1475 return "can't parse: ". $csv->error_input();
1478 my @columns = $csv->fields();
1482 paybatch => $paybatch,
1484 $cust_pay{_date} = $_date if $_date;
1487 foreach my $field ( @fields ) {
1489 if ( $field eq 'agent_custid'
1491 && $columns[0] =~ /\S+/ )
1494 my $agent_custid = $columns[0];
1495 my %hash = ( 'agent_custid' => $agent_custid,
1496 'agentnum' => $agentnum,
1499 if ( $cust_pay{'custnum'} !~ /^\s*$/ ) {
1500 $dbh->rollback if $oldAutoCommit;
1501 return "can't specify custnum with agent_custid $agent_custid";
1504 $cust_main = qsearchs({
1505 'table' => 'cust_main',
1506 'hashref' => \%hash,
1507 'extra_sql' => $extra_sql,
1510 unless ( $cust_main ) {
1511 $dbh->rollback if $oldAutoCommit;
1512 return "can't find customer with agent_custid $agent_custid";
1516 $columns[0] = $cust_main->custnum;
1519 $cust_pay{$field} = shift @columns;
1522 if ( $custnum_prefix && $cust_pay{custnum} =~ /^$custnum_prefix(0*([1-9]\d*))$/
1523 && length($1) == $custnum_length ) {
1524 $cust_pay{custnum} = $2;
1527 my $custnum = $cust_pay{custnum};
1529 my $cust_pay = new FS::cust_pay( \%cust_pay );
1530 my $error = $cust_pay->insert;
1532 if ( ! $error && $cust_pay->custnum != $custnum ) {
1533 #invnum was defined, and ->insert set custnum to the customer for that
1534 #invoice, but it wasn't the one the import specified.
1535 $dbh->rollback if $oldAutoCommit;
1536 $error = "specified invoice #". $cust_pay{invnum}.
1537 " is for custnum ". $cust_pay->custnum.
1538 ", not specified custnum $custnum";
1542 $dbh->rollback if $oldAutoCommit;
1543 return "can't insert payment for $line: $error";
1546 if ( $format eq 'simple' ) {
1547 # include agentnum for less surprise?
1548 $cust_main = qsearchs({
1549 'table' => 'cust_main',
1550 'hashref' => { 'custnum' => $cust_pay->custnum },
1551 'extra_sql' => $extra_sql,
1555 unless ( $cust_main ) {
1556 $dbh->rollback if $oldAutoCommit;
1557 return "can't find customer to which payments apply at line: $line";
1560 $error = $cust_main->apply_payments_and_credits;
1562 $dbh->rollback if $oldAutoCommit;
1563 return "can't apply payments to customer for $line: $error";
1571 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1573 return "Empty file!" unless $imported;
1583 Delete and replace methods.
1587 L<FS::cust_pay_pending>, L<FS::cust_bill_pay>, L<FS::cust_bill>, L<FS::Record>,
1588 schema.html from the base documentation.