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" if $self->closed =~ /^Y/i;
544 $self->SUPER::replace(@_);
549 Checks all fields to make sure this is a valid payment. If there is an error,
550 returns the error, otherwise returns false. Called by the insert method.
557 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
560 $self->ut_numbern('paynum')
561 || $self->ut_numbern('custnum')
562 || $self->ut_numbern('_date')
563 || $self->ut_money('paid')
564 || $self->ut_alphan('otaker')
565 || $self->ut_textn('paybatch')
566 || $self->ut_textn('payunique')
567 || $self->ut_enum('closed', [ '', 'Y' ])
568 || $self->ut_flag('no_auto_apply')
569 || $self->ut_foreign_keyn('pkgnum', 'cust_pkg', 'pkgnum')
570 || $self->ut_textn('bank')
571 || $self->ut_alphan('depositor')
572 || $self->ut_numbern('account')
573 || $self->ut_numbern('teller')
574 || $self->ut_foreign_keyn('batchnum', 'pay_batch', 'batchnum')
575 || $self->payinfo_check()
577 return $error if $error;
579 return "paid must be > 0 " if $self->paid <= 0;
581 return "unknown cust_main.custnum: ". $self->custnum
583 || qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
585 $self->_date(time) unless $self->_date;
587 return "invalid discount_term"
588 if ($self->discount_term && $self->discount_term < 2);
590 if ( $self->payby eq 'CASH' and $conf->exists('require_cash_deposit_info') ) {
591 foreach (qw(bank depositor account teller)) {
592 return "$_ required" if $self->get($_) eq '';
596 #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it
597 # # UNIQUE index should catch this too, without race conditions, but this
598 # # should give a better error message the other 99.9% of the time...
599 # if ( length($self->payunique)
600 # && qsearchs('cust_pay', { 'payunique' => $self->payunique } ) ) {
601 # #well, it *could* be a better error message
602 # return "duplicate transaction".
603 # " - a payment with unique identifer ". $self->payunique.
610 =item send_receipt HASHREF | OPTION => VALUE ...
612 Sends a payment receipt for this payment..
620 Flag indicating the payment is being made manually.
624 Invoice (FS::cust_bill) object. If not specified, the most recent invoice
629 Customer (FS::cust_main) object (for efficiency).
633 Don't send an email receipt.
643 my $opt = ref($_[0]) ? shift : { @_ };
645 my $cust_bill = $opt->{'cust_bill'};
646 my $cust_main = $opt->{'cust_main'} || $self->cust_main;
648 my $conf = new FS::Conf;
650 return '' unless $conf->config_bool('payment_receipt', $cust_main->agentnum);
652 my @invoicing_list = $cust_main->invoicing_list_emailonly;
653 return '' unless @invoicing_list;
655 $cust_bill ||= ($cust_main->cust_bill)[-1]; #rather inefficient though?
659 if ( ( exists($opt->{'manual'}) && $opt->{'manual'} )
660 #|| ! $conf->exists('invoice_html_statement')
664 my $msgnum = $conf->config('payment_receipt_msgnum', $cust_main->agentnum);
667 my %substitutions = ();
668 $substitutions{invnum} = $opt->{cust_bill}->invnum if $opt->{cust_bill};
670 my $msg_template = qsearchs('msg_template',{ msgnum => $msgnum});
671 unless ($msg_template) {
672 warn "send_receipt could not load msg_template";
676 my $cust_msg = $msg_template->prepare(
677 'cust_main' => $cust_main,
679 'from_config' => 'payment_receipt_from',
680 'substitutions' => \%substitutions,
681 'msgtype' => 'receipt',
683 $error = $cust_msg ? $cust_msg->insert : 'error preparing msg_template';
685 warn "send_receipt: $error";
689 my $queue = new FS::queue {
690 'job' => 'FS::cust_msg::process_send',
691 'paynum' => $self->paynum,
692 'custnum' => $cust_main->custnum,
694 $error = $queue->insert( $cust_msg->custmsgnum );
698 warn "payment_receipt is on, but no payment_receipt_msgnum\n";
702 #not manual and no noemail flag (here or on the customer)
703 } elsif ( ! $opt->{'noemail'} && ! $cust_main->invoice_noemail ) {
705 my $queue = new FS::queue {
706 'job' => 'FS::cust_bill::queueable_email',
707 'paynum' => $self->paynum,
708 'custnum' => $cust_main->custnum,
712 'invnum' => $cust_bill->invnum,
716 if ( my $mode = $conf->config('payment_receipt_statement_mode') ) {
717 $opt{'mode'} = $mode;
719 # backward compatibility, no good fix for this yet as some people may
720 # still have "invoice_latex_statement" and such options
721 $opt{'template'} = 'statement';
722 $opt{'notice_name'} = 'Statement';
725 $error = $queue->insert(%opt);
729 warn "send_receipt: $error\n" if $error;
734 Returns all applications to invoices (see L<FS::cust_bill_pay>) for this
741 map { $_ } #return $self->num_cust_bill_pay unless wantarray;
742 sort { $a->_date <=> $b->_date
743 || $a->invnum <=> $b->invnum }
744 qsearch( 'cust_bill_pay', { 'paynum' => $self->paynum } )
748 =item cust_pay_refund
750 Returns all applications of refunds (see L<FS::cust_pay_refund>) to this
755 sub cust_pay_refund {
757 map { $_ } #return $self->num_cust_pay_refund unless wantarray;
758 sort { $a->_date <=> $b->_date }
759 qsearch( 'cust_pay_refund', { 'paynum' => $self->paynum } )
766 Returns the amount of this payment that is still unapplied; which is
767 paid minus all payment applications (see L<FS::cust_bill_pay>) and refund
768 applications (see L<FS::cust_pay_refund>).
774 my $amount = $self->paid;
775 $amount -= $_->amount foreach ( $self->cust_bill_pay );
776 $amount -= $_->amount foreach ( $self->cust_pay_refund );
777 sprintf("%.2f", $amount );
782 Returns the amount of this payment that has not been refuned; which is
783 paid minus all refund applications (see L<FS::cust_pay_refund>).
789 my $amount = $self->paid;
790 $amount -= $_->amount foreach ( $self->cust_pay_refund );
791 sprintf("%.2f", $amount );
796 Returns the "paid" field.
805 =item delete_cust_bill_pay OPTIONS
807 Deletes all associated cust_bill_pay records.
809 If option 'unapplied' is a specified, only deletes until
810 this object's 'unapplied' value is >= the specified amount.
811 (Deletes in order returned by L</cust_bill_pay>.)
815 sub delete_cust_bill_pay {
819 local $SIG{HUP} = 'IGNORE';
820 local $SIG{INT} = 'IGNORE';
821 local $SIG{QUIT} = 'IGNORE';
822 local $SIG{TERM} = 'IGNORE';
823 local $SIG{TSTP} = 'IGNORE';
824 local $SIG{PIPE} = 'IGNORE';
826 my $oldAutoCommit = $FS::UID::AutoCommit;
827 local $FS::UID::AutoCommit = 0;
830 my $unapplied = $self->unapplied; #only need to look it up once
834 # Maybe we should reverse the order these get deleted in?
835 # ie delete newest first?
836 # keeping consistent with how bop refunds work, for now...
837 foreach my $cust_bill_pay ( $self->cust_bill_pay ) {
838 last if $opt{'unapplied'} && ($unapplied > $opt{'unapplied'});
839 $unapplied += $cust_bill_pay->amount;
840 $error = $cust_bill_pay->delete;
845 $dbh->rollback if $oldAutoCommit;
849 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
855 Accepts input for creating a new FS::cust_refund object.
856 Unapplies payment from invoices up to the amount of the refund,
857 creates the refund and applies payment to refund. Allows entire
858 process to be handled in one transaction.
860 Causes a fatal error if called on CARD or CHEK payments.
867 die "Cannot call cust_pay->refund on " . $self->payby
868 if grep { $_ eq $self->payby } qw(CARD CHEK);
870 local $SIG{HUP} = 'IGNORE';
871 local $SIG{INT} = 'IGNORE';
872 local $SIG{QUIT} = 'IGNORE';
873 local $SIG{TERM} = 'IGNORE';
874 local $SIG{TSTP} = 'IGNORE';
875 local $SIG{PIPE} = 'IGNORE';
877 my $oldAutoCommit = $FS::UID::AutoCommit;
878 local $FS::UID::AutoCommit = 0;
881 my $error = $self->delete_cust_bill_pay('amount' => $hash->{'amount'});
884 $dbh->rollback if $oldAutoCommit;
888 $hash->{'paynum'} = $self->paynum;
889 my $new = new FS::cust_refund ( $hash );
890 $error = $new->insert;
893 $dbh->rollback if $oldAutoCommit;
897 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
901 ### refund_to_unapply/unapply_refund false laziness with FS::cust_credit
903 =item refund_to_unapply
905 Returns L<FS::cust_pay_refund> objects that will be deleted by L</unapply_refund>
906 (all currently applied refunds that aren't closed.)
907 Returns empty list if payment itself is closed.
911 sub refund_to_unapply {
913 return () if $self->closed;
915 'table' => 'cust_pay_refund',
916 'hashref' => { 'paynum' => $self->paynum },
917 'addl_from' => 'LEFT JOIN cust_refund USING (refundnum)',
918 'extra_sql' => "AND cust_refund.closed IS NULL AND cust_refund.source_paynum IS NULL",
924 Deletes all objects returned by L</refund_to_unapply>.
931 local $SIG{HUP} = 'IGNORE';
932 local $SIG{INT} = 'IGNORE';
933 local $SIG{QUIT} = 'IGNORE';
934 local $SIG{TERM} = 'IGNORE';
935 local $SIG{TSTP} = 'IGNORE';
936 local $SIG{PIPE} = 'IGNORE';
938 my $oldAutoCommit = $FS::UID::AutoCommit;
939 local $FS::UID::AutoCommit = 0;
941 foreach my $cust_pay_refund ($self->refund_to_unapply) {
942 my $error = $cust_pay_refund->delete;
944 dbh->rollback if $oldAutoCommit;
949 dbh->commit or die dbh->errstr if $oldAutoCommit;
959 =item batch_insert CUST_PAY_OBJECT, ...
961 Class method which inserts multiple payments. Takes a list of FS::cust_pay
962 objects. Returns a list, each element representing the status of inserting the
963 corresponding payment - empty. If there is an error inserting any payment, the
964 entire transaction is rolled back, i.e. all payments are inserted or none are.
966 FS::cust_pay objects may have the pseudo-field 'apply_to', containing a
967 reference to an array of (uninserted) FS::cust_bill_pay objects. If so,
968 those objects will be inserted with the paynum of the payment, and for
969 each one, an error message or an empty string will be inserted into the
974 my @errors = FS::cust_pay->batch_insert(@cust_pay);
975 my $num_errors = scalar(grep $_, @errors);
976 if ( $num_errors == 0 ) {
977 #success; all payments were inserted
979 #failure; no payments were inserted.
985 my $self = shift; #class method
987 local $SIG{HUP} = 'IGNORE';
988 local $SIG{INT} = 'IGNORE';
989 local $SIG{QUIT} = 'IGNORE';
990 local $SIG{TERM} = 'IGNORE';
991 local $SIG{TSTP} = 'IGNORE';
992 local $SIG{PIPE} = 'IGNORE';
994 my $oldAutoCommit = $FS::UID::AutoCommit;
995 local $FS::UID::AutoCommit = 0;
1001 foreach my $cust_pay (@_) {
1002 my $error = $cust_pay->insert( 'manual' => 1 );
1003 push @errors, $error;
1004 $num_errors++ if $error;
1006 if ( ref($cust_pay->get('apply_to')) eq 'ARRAY' ) {
1008 foreach my $cust_bill_pay ( @{ $cust_pay->apply_to } ) {
1009 if ( $error ) { # insert placeholders if cust_pay wasn't inserted
1013 $cust_bill_pay->set('paynum', $cust_pay->paynum);
1014 my $apply_error = $cust_bill_pay->insert;
1015 push @errors, $apply_error || '';
1016 $num_errors++ if $apply_error;
1020 } elsif ( !$error ) { #normal case: apply payments as usual
1021 $cust_pay->cust_main->apply_payments( 'manual'=>1 );
1026 if ( $num_errors ) {
1027 $dbh->rollback if $oldAutoCommit;
1029 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1038 Returns an SQL fragment to retreive the unapplied amount.
1043 my ($class, $start, $end) = @_;
1044 my $bill_start = $start ? "AND cust_bill_pay._date <= $start" : '';
1045 my $bill_end = $end ? "AND cust_bill_pay._date > $end" : '';
1046 my $refund_start = $start ? "AND cust_pay_refund._date <= $start" : '';
1047 my $refund_end = $end ? "AND cust_pay_refund._date > $end" : '';
1051 ( SELECT SUM(amount) FROM cust_bill_pay
1052 WHERE cust_pay.paynum = cust_bill_pay.paynum
1053 $bill_start $bill_end )
1057 ( SELECT SUM(amount) FROM cust_pay_refund
1058 WHERE cust_pay.paynum = cust_pay_refund.paynum
1059 $refund_start $refund_end )
1068 my @fields = grep { $_ ne 'payinfo' } $self->fields;
1069 +{ ( map { $_=>$self->$_ } @fields ),
1075 # Used by FS::Upgrade to migrate to a new database.
1079 sub _upgrade_data { #class method
1080 my ($class, %opt) = @_;
1082 warn "$me upgrading $class\n" if $DEBUG;
1084 $class->_upgrade_reasonnum(%opt);
1086 local $FS::payinfo_Mixin::ignore_masked_payinfo = 1;
1089 # otaker/ivan upgrade
1092 unless ( FS::upgrade_journal->is_done('cust_pay__otaker_ivan') ) {
1094 #not the most efficient, but hey, it only has to run once
1096 my $where = " WHERE ( otaker IS NULL OR otaker = '' OR otaker = 'ivan' )
1098 AND EXISTS ( SELECT 1 FROM cust_main
1099 WHERE cust_main.custnum = cust_pay.custnum )
1102 my $count_sql = "SELECT COUNT(*) FROM cust_pay $where";
1104 my $sth = dbh->prepare($count_sql) or die dbh->errstr;
1105 $sth->execute or die $sth->errstr;
1106 my $total = $sth->fetchrow_arrayref->[0];
1107 #warn "$total cust_pay records to update\n"
1109 local($DEBUG) = 2 if $total > 1000; #could be a while, force progress info
1114 my @cust_pay = qsearch( {
1115 'table' => 'cust_pay',
1117 'extra_sql' => $where,
1118 'order_by' => 'ORDER BY paynum',
1121 foreach my $cust_pay (@cust_pay) {
1123 my $h_cust_pay = $cust_pay->h_search('insert');
1124 if ( $h_cust_pay ) {
1125 next if $cust_pay->otaker eq $h_cust_pay->history_user;
1126 #$cust_pay->otaker($h_cust_pay->history_user);
1127 $cust_pay->set('otaker', $h_cust_pay->history_user);
1129 $cust_pay->set('otaker', 'legacy');
1132 my $error = $cust_pay->replace;
1135 warn " *** WARNING: Error updating order taker for payment paynum ".
1136 $cust_pay->paynun. ": $error\n";
1141 if ( $DEBUG > 1 && $lastprog + 30 < time ) {
1142 warn "$me $count/$total (".sprintf('%.2f',100*$count/$total). '%)'."\n";
1148 FS::upgrade_journal->set_done('cust_pay__otaker_ivan');
1152 # payinfo N/A upgrade
1155 unless ( FS::upgrade_journal->is_done('cust_pay__payinfo_na') ) {
1157 #XXX remove the 'N/A (tokenized)' part (or just this entire thing)
1159 my @na_cust_pay = qsearch( {
1160 'table' => 'cust_pay',
1161 'hashref' => {}, #could be encrypted# { 'payinfo' => 'N/A' },
1162 'extra_sql' => "WHERE ( payinfo = 'N/A' OR paymask = 'N/AA' OR paymask = 'N/A (tokenized)' ) AND payby IN ( 'CARD', 'CHEK' )",
1165 foreach my $na ( @na_cust_pay ) {
1167 next unless $na->payinfo eq 'N/A';
1169 my $cust_pay_pending =
1170 qsearchs('cust_pay_pending', { 'paynum' => $na->paynum } );
1171 unless ( $cust_pay_pending ) {
1172 warn " *** WARNING: not-yet recoverable N/A card for payment ".
1173 $na->paynum. " (no cust_pay_pending)\n";
1176 $na->$_($cust_pay_pending->$_) for qw( payinfo paymask );
1177 my $error = $na->replace;
1179 warn " *** WARNING: Error updating payinfo for payment paynum ".
1180 $na->paynun. ": $error\n";
1186 FS::upgrade_journal->set_done('cust_pay__payinfo_na');
1190 # otaker->usernum upgrade
1193 $class->_upgrade_otaker(%opt);
1195 # if we do this anywhere else, it should become an FS::Upgrade method
1196 my $num_to_upgrade = $class->count('paybatch is not null');
1197 my $num_jobs = FS::queue->count('job = \'FS::cust_pay::process_upgrade_paybatch\' and status != \'failed\'');
1198 if ( $num_to_upgrade > 0 ) {
1199 warn "Need to migrate paybatch field in $num_to_upgrade payments.\n";
1200 if ( $opt{queue} ) {
1201 if ( $num_jobs > 0 ) {
1202 warn "Upgrade already queued.\n";
1204 warn "Scheduling upgrade.\n";
1205 my $job = FS::queue->new({ job => 'FS::cust_pay::process_upgrade_paybatch' });
1209 process_upgrade_paybatch();
1216 $class->upgrade_set_cardtype;
1220 sub process_upgrade_paybatch {
1222 local $FS::payinfo_Mixin::ignore_masked_payinfo = 1;
1223 local $FS::UID::AutoCommit = 1;
1226 # migrate batchnums from the misused 'paybatch' field to 'batchnum'
1228 my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
1229 my $search = FS::Cursor->new( {
1230 'table' => 'cust_pay',
1231 'addl_from' => " JOIN pay_batch ON cust_pay.paybatch = CAST(pay_batch.batchnum AS $text) ",
1233 while (my $cust_pay = $search->fetch) {
1234 $cust_pay->set('batchnum' => $cust_pay->paybatch);
1235 $cust_pay->set('paybatch' => '');
1236 my $error = $cust_pay->replace;
1237 warn "error setting batchnum on cust_pay #".$cust_pay->paynum.":\n $error"
1242 # migrate gateway info from the misused 'paybatch' field
1245 # not only cust_pay, but also voided and refunded payments
1246 if (!FS::upgrade_journal->is_done('cust_pay__parse_paybatch_1')) {
1247 local $FS::Record::nowarn_classload=1;
1248 # really inefficient, but again, only has to run once
1249 foreach my $table (qw(cust_pay cust_pay_void cust_refund)) {
1250 my $and_batchnum_is_null =
1251 ( $table =~ /^cust_pay/ ? ' AND batchnum IS NULL' : '' );
1252 my $pkey = ($table =~ /^cust_pay/ ? 'paynum' : 'refundnum');
1253 my $search = FS::Cursor->new({
1255 extra_sql => "WHERE payby IN('CARD','CHEK') ".
1256 "AND (paybatch IS NOT NULL ".
1257 "OR (paybatch IS NULL AND auth IS NULL
1258 $and_batchnum_is_null ) )
1259 ORDER BY $pkey DESC"
1261 while ( my $object = $search->fetch ) {
1262 if ( $object->paybatch eq '' ) {
1263 # repair for a previous upgrade that didn't save 'auth'
1264 my $pkey = $object->primary_key;
1265 # find the last history record that had a paybatch value
1267 table => "h_$table",
1269 $pkey => $object->$pkey,
1270 paybatch => { op=>'!=', value=>''},
1271 history_action => 'replace_old',
1273 order_by => 'ORDER BY history_date DESC LIMIT 1',
1276 warn "couldn't find paybatch history record for $table ".$object->$pkey."\n";
1279 # if the paybatch didn't have an auth string, then it's fine
1280 $h->paybatch =~ /:(\w+):/ or next;
1281 # set paybatch to what it was in that record
1282 $object->set('paybatch', $h->paybatch)
1283 # and then upgrade it like the old records
1286 my $parsed = $object->_parse_paybatch;
1287 if (keys %$parsed) {
1288 $object->set($_ => $parsed->{$_}) foreach keys %$parsed;
1289 $object->set('auth' => $parsed->{authorization});
1290 $object->set('paybatch', '');
1291 my $error = $object->replace;
1292 warn "error parsing CARD/CHEK paybatch fields on $object #".
1293 $object->get($object->primary_key).":\n $error\n"
1298 FS::upgrade_journal->set_done('cust_pay__parse_paybatch_1');
1308 =item process_batch_import
1312 sub process_batch_import {
1317 my $custnum = $hash{'custnum'};
1318 my $agentnum = $hash{'agentnum'};
1319 my $agent_custid = $hash{'agent_custid'};
1321 $hash{'_date'} = parse_datetime($hash{'_date'})
1322 if $hash{'_date'} && $hash{'_date'} =~ /\D/;
1323 #remove custnum_prefix
1324 my $custnum_prefix = $conf->config('cust_main-custnum-display_prefix');
1325 my $custnum_length = $conf->config('cust_main-custnum-display_length') || 8;
1328 && $custnum =~ /^$custnum_prefix(0*([1-9]\d*))$/
1329 && length($1) == $custnum_length
1333 # check agentnum against custnum and
1334 # translate agent_custid into regular custnum
1335 if ($custnum && $agent_custid) {
1336 die "can't specify both custnum and agent_custid\n";
1337 } elsif ($agentnum || $agent_custid) {
1338 # here is the agent virtualization
1339 my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
1341 $search{'agentnum'} = $agentnum
1343 $search{'agent_custid'} = $agent_custid
1345 $search{'custnum'} = $custnum
1347 my $cust_main = qsearchs({
1348 'table' => 'cust_main',
1349 'hashref' => \%search,
1350 'extra_sql' => $extra_sql,
1352 die "can't find customer with" .
1353 ($agentnum ? " agentnum $agentnum" : '') .
1354 ($custnum ? " custnum $custnum" : '') .
1355 ($agent_custid ? " agent_custid $agent_custid" : '') . "\n"
1357 die "mismatched customer number\n"
1358 if $custnum && ($custnum ne $cust_main->custnum);
1359 $custnum = $cust_main->custnum;
1361 $hash{'custnum'} = $custnum;
1362 delete($hash{'agent_custid'});
1367 'table' => 'cust_pay',
1368 'params' => [ '_date', 'agentnum', 'payby', 'paybatch' ],
1369 #agent_custid isn't a cust_pay field, see hash callback
1370 'formats' => { 'simple' =>
1371 [ qw(custnum agent_custid paid payinfo invnum) ] },
1372 'format_types' => { 'simple' => '' }, #force infer from file extension
1373 'default_csv' => 1, #if not .xls, will read as csv, regardless of extension
1374 'format_hash_callbacks' => { 'simple' => $hashcb },
1375 'insert_args_callback' => sub { ( 'manual'=>1 ); },
1376 'postinsert_callback' => sub {
1377 my $cust_pay = shift;
1378 my $cust_main = $cust_pay->cust_main
1379 or return "can't find customer to which payments apply";
1380 my $error = $cust_main->apply_payments_and_credits( 'manual'=>1 );
1382 ? "can't apply payments to customer ".$cust_pay->custnum."$error"
1387 FS::Record::process_batch_import( $job, $opt, @_ );
1391 =item batch_import HASHREF
1393 Inserts new payments.
1400 my $fh = $param->{filehandle};
1401 my $format = $param->{'format'};
1403 my $agentnum = $param->{agentnum};
1404 my $_date = $param->{_date};
1405 $_date = parse_datetime($_date) if $_date && $_date =~ /\D/;
1406 my $paybatch = $param->{'paybatch'};
1408 my $custnum_prefix = $conf->config('cust_main-custnum-display_prefix');
1409 my $custnum_length = $conf->config('cust_main-custnum-display_length') || 8;
1411 # here is the agent virtualization
1412 my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
1416 if ( $format eq 'simple' ) {
1417 @fields = qw( custnum agent_custid paid payinfo invnum );
1419 } elsif ( $format eq 'extended' ) {
1420 die "unimplemented\n";
1424 die "unknown format $format";
1427 eval "use Text::CSV_XS;";
1430 my $csv = new Text::CSV_XS;
1434 local $SIG{HUP} = 'IGNORE';
1435 local $SIG{INT} = 'IGNORE';
1436 local $SIG{QUIT} = 'IGNORE';
1437 local $SIG{TERM} = 'IGNORE';
1438 local $SIG{TSTP} = 'IGNORE';
1439 local $SIG{PIPE} = 'IGNORE';
1441 my $oldAutoCommit = $FS::UID::AutoCommit;
1442 local $FS::UID::AutoCommit = 0;
1446 while ( defined($line=<$fh>) ) {
1448 $csv->parse($line) or do {
1449 $dbh->rollback if $oldAutoCommit;
1450 return "can't parse: ". $csv->error_input();
1453 my @columns = $csv->fields();
1457 paybatch => $paybatch,
1459 $cust_pay{_date} = $_date if $_date;
1462 foreach my $field ( @fields ) {
1464 if ( $field eq 'agent_custid'
1466 && $columns[0] =~ /\S+/ )
1469 my $agent_custid = $columns[0];
1470 my %hash = ( 'agent_custid' => $agent_custid,
1471 'agentnum' => $agentnum,
1474 if ( $cust_pay{'custnum'} !~ /^\s*$/ ) {
1475 $dbh->rollback if $oldAutoCommit;
1476 return "can't specify custnum with agent_custid $agent_custid";
1479 $cust_main = qsearchs({
1480 'table' => 'cust_main',
1481 'hashref' => \%hash,
1482 'extra_sql' => $extra_sql,
1485 unless ( $cust_main ) {
1486 $dbh->rollback if $oldAutoCommit;
1487 return "can't find customer with agent_custid $agent_custid";
1491 $columns[0] = $cust_main->custnum;
1494 $cust_pay{$field} = shift @columns;
1497 if ( $custnum_prefix && $cust_pay{custnum} =~ /^$custnum_prefix(0*([1-9]\d*))$/
1498 && length($1) == $custnum_length ) {
1499 $cust_pay{custnum} = $2;
1502 my $custnum = $cust_pay{custnum};
1504 my $cust_pay = new FS::cust_pay( \%cust_pay );
1505 my $error = $cust_pay->insert;
1507 if ( ! $error && $cust_pay->custnum != $custnum ) {
1508 #invnum was defined, and ->insert set custnum to the customer for that
1509 #invoice, but it wasn't the one the import specified.
1510 $dbh->rollback if $oldAutoCommit;
1511 $error = "specified invoice #". $cust_pay{invnum}.
1512 " is for custnum ". $cust_pay->custnum.
1513 ", not specified custnum $custnum";
1517 $dbh->rollback if $oldAutoCommit;
1518 return "can't insert payment for $line: $error";
1521 if ( $format eq 'simple' ) {
1522 # include agentnum for less surprise?
1523 $cust_main = qsearchs({
1524 'table' => 'cust_main',
1525 'hashref' => { 'custnum' => $cust_pay->custnum },
1526 'extra_sql' => $extra_sql,
1530 unless ( $cust_main ) {
1531 $dbh->rollback if $oldAutoCommit;
1532 return "can't find customer to which payments apply at line: $line";
1535 $error = $cust_main->apply_payments_and_credits;
1537 $dbh->rollback if $oldAutoCommit;
1538 return "can't apply payments to customer for $line: $error";
1546 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1548 return "Empty file!" unless $imported;
1558 Delete and replace methods.
1562 L<FS::cust_pay_pending>, L<FS::cust_bill_pay>, L<FS::cust_bill>, L<FS::Record>,
1563 schema.html from the base documentation.