1 package FS::cust_main::Billing;
4 use vars qw( $conf $DEBUG $me );
7 use List::Util qw( min );
9 use FS::Record qw( qsearch qsearchs dbdef );
10 use FS::Misc::DateTime qw( day_end );
12 use FS::cust_bill_pkg;
13 use FS::cust_bill_pkg_display;
14 use FS::cust_bill_pay;
15 use FS::cust_credit_bill;
16 use FS::cust_tax_adjustment;
18 use FS::tax_rate_location;
19 use FS::cust_bill_pkg_tax_location;
20 use FS::cust_bill_pkg_tax_rate_location;
22 use FS::part_event_condition;
24 use FS::cust_event_fee;
27 # 1 is mostly method/subroutine entry and options
28 # 2 traces progress of some operations
29 # 3 is even more information including possibly sensitive data
31 $me = '[FS::cust_main::Billing]';
33 install_callback FS::UID sub {
35 #yes, need it for stuff below (prolly should be cached)
40 FS::cust_main::Billing - Billing mixin for cust_main
46 These methods are available on FS::cust_main objects.
52 =item bill_and_collect
54 Cancels and suspends any packages due, generates bills, applies payments and
55 credits, and applies collection events to run cards, send bills and notices,
58 By default, warns on errors and continues with the next operation (but see the
61 Options are passed as name-value pairs. Currently available options are:
67 Bills the customer as if it were that time. Specified as a UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion functions. For example:
71 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
75 Used in conjunction with the I<time> option, this option specifies the date of for the generated invoices. Other calculations, such as whether or not to generate the invoice in the first place, are not affected.
79 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
83 If set true, re-charges setup fees.
87 If set any errors prevent subsequent operations from continusing. If set
88 specifically to "return", returns the error (or false, if there is no error).
89 Any other true value causes errors to die.
93 Debugging level. Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
97 Optional FS::queue entry to receive status updates.
101 Options are passed to the B<bill> and B<collect> methods verbatim, so all
102 options of those methods are also available.
106 sub bill_and_collect {
107 my( $self, %options ) = @_;
109 my $log = FS::Log->new('bill_and_collect');
110 $log->debug('start', object => $self, agentnum => $self->agentnum);
114 #$options{actual_time} not $options{time} because freeside-daily -d is for
115 #pre-printing invoices
117 $options{'actual_time'} ||= time;
118 my $job = $options{'job'};
120 my $actual_time = ( $conf->exists('next-bill-ignore-time')
121 ? day_end( $options{actual_time} )
122 : $options{actual_time}
125 $job->update_statustext('0,cleaning expired packages') if $job;
126 $error = $self->cancel_expired_pkgs( $actual_time );
128 $error = "Error expiring custnum ". $self->custnum. ": $error";
129 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
130 elsif ( $options{fatal} ) { die $error; }
131 else { warn $error; }
134 $error = $self->suspend_adjourned_pkgs( $actual_time );
136 $error = "Error adjourning custnum ". $self->custnum. ": $error";
137 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
138 elsif ( $options{fatal} ) { die $error; }
139 else { warn $error; }
142 $error = $self->unsuspend_resumed_pkgs( $actual_time );
144 $error = "Error resuming custnum ".$self->custnum. ": $error";
145 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
146 elsif ( $options{fatal} ) { die $error; }
147 else { warn $error; }
150 $job->update_statustext('20,billing packages') if $job;
151 $error = $self->bill( %options );
153 $error = "Error billing custnum ". $self->custnum. ": $error";
154 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
155 elsif ( $options{fatal} ) { die $error; }
156 else { warn $error; }
159 $job->update_statustext('50,applying payments and credits') if $job;
160 $error = $self->apply_payments_and_credits;
162 $error = "Error applying custnum ". $self->custnum. ": $error";
163 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
164 elsif ( $options{fatal} ) { die $error; }
165 else { warn $error; }
168 $job->update_statustext('70,running collection events') if $job;
169 unless ( $conf->exists('cancelled_cust-noevents')
170 && ! $self->num_ncancelled_pkgs
172 $error = $self->collect( %options );
174 $error = "Error collecting custnum ". $self->custnum. ": $error";
175 if ($options{fatal} && $options{fatal} eq 'return') { return $error; }
176 elsif ($options{fatal} ) { die $error; }
177 else { warn $error; }
180 $job->update_statustext('100,finished') if $job;
181 $log->debug('finish', object => $self, agentnum => $self->agentnum);
187 sub cancel_expired_pkgs {
188 my ( $self, $time, %options ) = @_;
190 my @cancel_pkgs = $self->ncancelled_pkgs( {
191 'extra_sql' => " AND expire IS NOT NULL AND expire > 0 AND expire <= $time "
196 CUST_PKG: foreach my $cust_pkg ( @cancel_pkgs ) {
197 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
200 if ( $cust_pkg->change_to_pkgnum ) {
202 my $new_pkg = FS::cust_pkg->by_key($cust_pkg->change_to_pkgnum);
204 push @errors, 'can\'t change pkgnum '.$cust_pkg->pkgnum.' to pkgnum '.
205 $cust_pkg->change_to_pkgnum.'; not expiring';
208 $error = $cust_pkg->change( 'cust_pkg' => $new_pkg,
209 'unprotect_svcs' => 1 );
210 $error = '' if ref $error eq 'FS::cust_pkg';
212 } else { # just cancel it
213 $error = $cust_pkg->cancel($cpr ? ( 'reason' => $cpr->reasonnum,
214 'reason_otaker' => $cpr->otaker,
220 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
223 join(' / ', @errors);
227 sub suspend_adjourned_pkgs {
228 my ( $self, $time, %options ) = @_;
230 my @susp_pkgs = $self->ncancelled_pkgs( {
232 " AND ( susp IS NULL OR susp = 0 )
233 AND ( ( bill IS NOT NULL AND bill != 0 AND bill < $time )
234 OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
239 #only because there's no SQL test for is_prepaid :/
241 grep { ( $_->part_pkg->is_prepaid
246 && $_->adjourn <= $time
254 foreach my $cust_pkg ( @susp_pkgs ) {
255 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
256 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
257 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
258 'reason_otaker' => $cpr->otaker
262 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
265 join(' / ', @errors);
269 sub unsuspend_resumed_pkgs {
270 my ( $self, $time, %options ) = @_;
272 my @unsusp_pkgs = $self->ncancelled_pkgs( {
273 'extra_sql' => " AND resume IS NOT NULL AND resume > 0 AND resume <= $time "
278 foreach my $cust_pkg ( @unsusp_pkgs ) {
279 my $error = $cust_pkg->unsuspend( 'time' => $time );
280 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
283 join(' / ', @errors);
289 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
290 conjunction with the collect method by calling B<bill_and_collect>.
292 If there is an error, returns the error, otherwise returns false.
294 Options are passed as name-value pairs. Currently available options are:
300 If set true, re-charges setup fees.
304 If set true then only bill recurring charges, not setup, usage, one time
309 If set, then override the normal frequency and look for a part_pkg_discount
310 to take at that frequency. This is appropriate only when the normal
311 frequency for all packages is monthly, and is an error otherwise. Use
312 C<pkg_list> to limit the set of packages included in billing.
316 Bills the customer as if it were that time. Specified as a UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion functions. For example:
320 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
324 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
326 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
330 A hashref of pkgparts to exclude from this billing run (can also be specified as a comma-separated scalar).
334 Do not bill prepaid packages. Used by freeside-daily.
338 Used in conjunction with the I<time> option, this option specifies the date of for the generated invoices. Other calculations, such as whether or not to generate the invoice in the first place, are not affected.
342 This boolean value informs the us that the package is being cancelled. This
343 typically might mean not charging the normal recurring fee but only usage
344 fees since the last billing. Setup charges may be charged. Not all package
345 plans support this feature (they tend to charge 0).
349 Prevent the resetting of usage limits during this call.
353 Do not save the generated bill in the database. Useful with return_bill
357 A list reference on which the generated bill(s) will be returned.
361 Optional terms to be printed on this invoice. Otherwise, customer-specific
362 terms or the default terms are used.
369 my( $self, %options ) = @_;
371 return '' if $self->payby eq 'COMP';
373 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
375 warn "$me bill customer ". $self->custnum. "\n"
378 my $time = $options{'time'} || time;
379 my $invoice_time = $options{'invoice_time'} || $time;
381 my $cmp_time = ( $conf->exists('next-bill-ignore-time')
386 $options{'not_pkgpart'} ||= {};
387 $options{'not_pkgpart'} = { map { $_ => 1 }
388 split(/\s*,\s*/, $options{'not_pkgpart'})
390 unless ref($options{'not_pkgpart'});
392 local $SIG{HUP} = 'IGNORE';
393 local $SIG{INT} = 'IGNORE';
394 local $SIG{QUIT} = 'IGNORE';
395 local $SIG{TERM} = 'IGNORE';
396 local $SIG{TSTP} = 'IGNORE';
397 local $SIG{PIPE} = 'IGNORE';
399 my $oldAutoCommit = $FS::UID::AutoCommit;
400 local $FS::UID::AutoCommit = 0;
403 warn "$me acquiring lock on customer ". $self->custnum. "\n"
406 $self->select_for_update; #mutex
408 warn "$me running pre-bill events for customer ". $self->custnum. "\n"
411 my $error = $self->do_cust_event(
412 'debug' => ( $options{'debug'} || 0 ),
413 'time' => $invoice_time,
414 'check_freq' => $options{'check_freq'},
415 'stage' => 'pre-bill',
417 unless $options{no_commit};
419 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
423 warn "$me done running pre-bill events for customer ". $self->custnum. "\n"
426 #keep auto-charge and non-auto-charge line items separate
427 my @passes = ( '', 'no_auto' );
429 my %cust_bill_pkg = map { $_ => [] } @passes;
432 # find the packages which are due for billing, find out how much they are
433 # & generate invoice database.
436 my %total_setup = map { my $z = 0; $_ => \$z; } @passes;
437 my %total_recur = map { my $z = 0; $_ => \$z; } @passes;
439 my %taxlisthash = map { $_ => {} } @passes;
441 my @precommit_hooks = ();
443 $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ]; #param checks?
445 foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
447 next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
449 my $part_pkg = $cust_pkg->part_pkg;
451 next if $options{'no_prepaid'} && $part_pkg->is_prepaid;
453 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG;
455 #? to avoid use of uninitialized value errors... ?
456 $cust_pkg->setfield('bill', '')
457 unless defined($cust_pkg->bill);
459 my $real_pkgpart = $cust_pkg->pkgpart;
460 my %hash = $cust_pkg->hash;
462 # we could implement this bit as FS::part_pkg::has_hidden, but we already
463 # suffer from performance issues
464 $options{has_hidden} = 0;
465 my @part_pkg = $part_pkg->self_and_bill_linked;
466 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
468 # if this package was changed from another package,
469 # and it hasn't been billed since then,
470 # and package balances are enabled,
471 if ( $cust_pkg->change_pkgnum
472 and $cust_pkg->change_date >= ($cust_pkg->last_bill || 0)
473 and $cust_pkg->change_date < $invoice_time
474 and $conf->exists('pkg-balances') )
476 # _transfer_balance will also create the appropriate credit
477 my @transfer_items = $self->_transfer_balance($cust_pkg);
478 # $part_pkg[0] is the "real" part_pkg
479 my $pass = ($cust_pkg->no_auto || $part_pkg[0]->no_auto) ?
481 push @{ $cust_bill_pkg{$pass} }, @transfer_items;
482 # treating this as recur, just because most charges are recur...
483 ${$total_recur{$pass}} += $_->recur foreach @transfer_items;
486 foreach my $part_pkg ( @part_pkg ) {
488 $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
490 my $pass = ($cust_pkg->no_auto || $part_pkg->no_auto) ? 'no_auto' : '';
492 my $next_bill = $cust_pkg->getfield('bill') || 0;
494 # let this run once if this is the last bill upon cancellation
495 while ( $next_bill <= $cmp_time or $options{cancel} ) {
497 $self->_make_lines( 'part_pkg' => $part_pkg,
498 'cust_pkg' => $cust_pkg,
499 'precommit_hooks' => \@precommit_hooks,
500 'line_items' => $cust_bill_pkg{$pass},
501 'setup' => $total_setup{$pass},
502 'recur' => $total_recur{$pass},
503 'tax_matrix' => $taxlisthash{$pass},
505 'real_pkgpart' => $real_pkgpart,
506 'options' => \%options,
509 # Stop if anything goes wrong
512 # or if we're not incrementing the bill date.
513 last if ($cust_pkg->getfield('bill') || 0) == $next_bill;
515 # or if we're letting it run only once
516 last if $options{cancel};
518 $next_bill = $cust_pkg->getfield('bill') || 0;
520 #stop if -o was passed to freeside-daily
521 last if $options{'one_recur'};
524 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
528 } #foreach my $part_pkg
530 } #foreach my $cust_pkg
532 #if the customer isn't on an automatic payby, everything can go on a single
534 #if ( $cust_main->payby !~ /^(CARD|CHEK)$/ ) {
535 #merge everything into one list
538 foreach my $pass (@passes) { # keys %cust_bill_pkg ) {
540 my @cust_bill_pkg = _omit_zero_value_bundles(@{ $cust_bill_pkg{$pass} });
542 warn "$me billing pass $pass\n"
543 #.Dumper(\@cust_bill_pkg)."\n"
550 my @pending_event_fees = FS::cust_event_fee->by_cust($self->custnum,
551 hashref => { 'billpkgnum' => '' }
553 warn "$me found pending fee events:\n".Dumper(\@pending_event_fees)."\n"
554 if @pending_event_fees and $DEBUG > 1;
556 # determine whether to generate an invoice
557 my $generate_bill = scalar(@cust_bill_pkg) > 0;
559 foreach my $event_fee (@pending_event_fees) {
560 $generate_bill = 1 unless $event_fee->nextbill;
563 # don't create an invoice with no line items, or where the only line
564 # items are fees that are supposed to be held until the next invoice
565 next if !$generate_bill;
569 foreach my $event_fee (@pending_event_fees) {
570 my $object = $event_fee->cust_event->cust_X;
571 my $part_fee = $event_fee->part_fee;
573 if ( $object->isa('FS::cust_main')
574 or $object->isa('FS::cust_pkg')
575 or $object->isa('FS::cust_pay_batch') )
577 # Not the real cust_bill object that will be inserted--in particular
578 # there are no taxes yet. If you want to charge a fee on the total
579 # invoice amount including taxes, you have to put the fee on the next
581 $cust_bill = FS::cust_bill->new({
582 'custnum' => $self->custnum,
583 'cust_bill_pkg' => \@cust_bill_pkg,
584 'charged' => ${ $total_setup{$pass} } +
585 ${ $total_recur{$pass} },
588 # If this is a package event, only apply the fee to line items
590 if ($object->isa('FS::cust_pkg')) {
591 $cust_bill->set('cust_bill_pkg',
592 [ grep { $_->pkgnum == $object->pkgnum } @cust_bill_pkg ]
596 } elsif ( $object->isa('FS::cust_bill') ) {
597 # simple case: applying the fee to a previous invoice (late fee,
599 $cust_bill = $object;
601 # if the fee def belongs to a different agent, don't charge the fee.
602 # event conditions should prevent this, but just in case they don't,
604 if ( $part_fee->agentnum and $part_fee->agentnum != $self->agentnum ) {
605 warn "tried to charge fee#".$part_fee->feepart .
606 " on customer#".$self->custnum." from a different agent.\n";
609 # also skip if it's disabled
610 next if $part_fee->disabled eq 'Y';
612 my $fee_item = $part_fee->lineitem($cust_bill) or next;
613 # link this so that we can clear the marker on inserting the line item
614 $fee_item->set('cust_event_fee', $event_fee);
615 push @fee_items, $fee_item;
619 # add fees to the invoice
620 foreach my $fee_item (@fee_items) {
622 push @cust_bill_pkg, $fee_item;
623 ${ $total_setup{$pass} } += $fee_item->setup;
624 ${ $total_recur{$pass} } += $fee_item->recur;
626 my $part_fee = $fee_item->part_fee;
627 my $fee_location = $self->ship_location; # I think?
629 my $error = $self->_handle_taxes(
632 location => $fee_location
633 # probably not right to pass cancel => 1 for fees
635 return $error if $error;
639 # XXX implementation of fees is supposed to make this go away...
640 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
641 !$conf->exists('postal_invoice-recurring_only')
645 my $postal_pkg = $self->charge_postal_fee();
646 if ( $postal_pkg && !ref( $postal_pkg ) ) {
648 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
649 return "can't charge postal invoice fee for customer ".
650 $self->custnum. ": $postal_pkg";
652 } elsif ( $postal_pkg ) {
654 my $real_pkgpart = $postal_pkg->pkgpart;
655 # we could implement this bit as FS::part_pkg::has_hidden, but we already
656 # suffer from performance issues
657 $options{has_hidden} = 0;
658 my @part_pkg = $postal_pkg->part_pkg->self_and_bill_linked;
659 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
661 foreach my $part_pkg ( @part_pkg ) {
662 my %postal_options = %options;
663 delete $postal_options{cancel};
665 $self->_make_lines( 'part_pkg' => $part_pkg,
666 'cust_pkg' => $postal_pkg,
667 'precommit_hooks' => \@precommit_hooks,
668 'line_items' => \@cust_bill_pkg,
669 'setup' => $total_setup{$pass},
670 'recur' => $total_recur{$pass},
671 'tax_matrix' => $taxlisthash{$pass},
673 'real_pkgpart' => $real_pkgpart,
674 'options' => \%postal_options,
677 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
682 # it's silly to have a zero value postal_pkg, but....
683 @cust_bill_pkg = _omit_zero_value_bundles(@cust_bill_pkg);
689 my $listref_or_error =
690 $self->calculate_taxes( \@cust_bill_pkg, $taxlisthash{$pass}, $invoice_time);
692 unless ( ref( $listref_or_error ) ) {
693 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
694 return $listref_or_error;
697 foreach my $taxline ( @$listref_or_error ) {
698 ${ $total_setup{$pass} } =
699 sprintf('%.2f', ${ $total_setup{$pass} } + $taxline->setup );
700 push @cust_bill_pkg, $taxline;
704 warn "adding tax adjustments...\n" if $DEBUG > 2;
705 foreach my $cust_tax_adjustment (
706 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
712 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
714 my $itemdesc = $cust_tax_adjustment->taxname;
715 $itemdesc = '' if $itemdesc eq 'Tax';
717 push @cust_bill_pkg, new FS::cust_bill_pkg {
723 'itemdesc' => $itemdesc,
724 'itemcomment' => $cust_tax_adjustment->comment,
725 'cust_tax_adjustment' => $cust_tax_adjustment,
726 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
731 my $charged = sprintf('%.2f', ${ $total_setup{$pass} } + ${ $total_recur{$pass} } );
733 my @cust_bill = $self->cust_bill;
734 my $balance = $self->balance;
735 my $previous_bill = $cust_bill[-1] if @cust_bill;
736 my $previous_balance = 0;
737 if ( $previous_bill ) {
738 $previous_balance = $previous_bill->billing_balance
739 + $previous_bill->charged;
742 warn "creating the new invoice\n" if $DEBUG;
743 #create the new invoice
744 my $cust_bill = new FS::cust_bill ( {
745 'custnum' => $self->custnum,
746 '_date' => $invoice_time,
747 'charged' => $charged,
748 'billing_balance' => $balance,
749 'previous_balance' => $previous_balance,
750 'invoice_terms' => $options{'invoice_terms'},
751 'cust_bill_pkg' => \@cust_bill_pkg,
753 $error = $cust_bill->insert unless $options{no_commit};
755 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
756 return "can't create invoice for customer #". $self->custnum. ": $error";
758 push @{$options{return_bill}}, $cust_bill if $options{return_bill};
760 } #foreach my $pass ( keys %cust_bill_pkg )
762 foreach my $hook ( @precommit_hooks ) {
765 } unless $options{no_commit};
767 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
768 return "$@ running precommit hook $hook\n";
772 $dbh->commit or die $dbh->errstr if $oldAutoCommit && !$options{no_commit};
777 #discard bundled packages of 0 value
778 sub _omit_zero_value_bundles {
781 my @cust_bill_pkg = ();
782 my @cust_bill_pkg_bundle = ();
784 my $discount_show_always = 0;
786 foreach my $cust_bill_pkg ( @in ) {
788 $discount_show_always = ($cust_bill_pkg->get('discounts')
789 && scalar(@{$cust_bill_pkg->get('discounts')})
790 && $conf->exists('discount-show-always'));
792 warn " pkgnum ". $cust_bill_pkg->pkgnum. " sum $sum, ".
793 "setup_show_zero ". $cust_bill_pkg->setup_show_zero.
794 "recur_show_zero ". $cust_bill_pkg->recur_show_zero. "\n"
797 if (scalar(@cust_bill_pkg_bundle) && !$cust_bill_pkg->pkgpart_override) {
798 push @cust_bill_pkg, @cust_bill_pkg_bundle
800 || ($sum == 0 && ( $discount_show_always
801 || grep {$_->recur_show_zero || $_->setup_show_zero}
802 @cust_bill_pkg_bundle
805 @cust_bill_pkg_bundle = ();
809 $sum += $cust_bill_pkg->setup + $cust_bill_pkg->recur;
810 push @cust_bill_pkg_bundle, $cust_bill_pkg;
814 push @cust_bill_pkg, @cust_bill_pkg_bundle
816 || ($sum == 0 && ( $discount_show_always
817 || grep {$_->recur_show_zero || $_->setup_show_zero}
818 @cust_bill_pkg_bundle
822 warn " _omit_zero_value_bundles: ". scalar(@in).
823 '->'. scalar(@cust_bill_pkg). "\n" #. Dumper(@cust_bill_pkg). "\n"
830 =item calculate_taxes LINEITEMREF TAXHASHREF INVOICE_TIME
832 Generates tax line items (see L<FS::cust_bill_pkg>) for this customer.
833 Usually used internally by bill method B<bill>.
835 If there is an error, returns the error, otherwise returns reference to a
836 list of line items suitable for insertion.
842 An array ref of the line items being billed.
846 A strange beast. The keys to this hash are internal identifiers consisting
847 of the name of the tax object type, a space, and its unique identifier ( e.g.
848 'cust_main_county 23' ). The values of the hash are listrefs. The first
849 item in the list is the tax object. The remaining items are either line
850 items or floating point values (currency amounts).
852 The taxes are calculated on this entity. Calculated exemption records are
853 transferred to the LINEITEMREF items on the assumption that they are related.
859 This specifies the date appearing on the associated invoice. Some
860 jurisdictions (i.e. Texas) have tax exemptions which are date sensitive.
866 sub calculate_taxes {
867 my ($self, $cust_bill_pkg, $taxlisthash, $invoice_time) = @_;
869 # $taxlisthash is a hashref
870 # keys are identifiers, values are arrayrefs
871 # each arrayref starts with a tax object (cust_main_county or tax_rate)
872 # then any cust_bill_pkg objects the tax applies to
874 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
876 warn "$me calculate_taxes\n"
877 #.Dumper($self, $cust_bill_pkg, $taxlisthash, $invoice_time). "\n"
880 my @tax_line_items = ();
882 # keys are tax names (as printed on invoices / itemdesc )
883 # values are arrayrefs of taxlisthash keys (internal identifiers)
886 # keys are taxlisthash keys (internal identifiers)
887 # values are (cumulative) amounts
890 # keys are taxlisthash keys (internal identifiers)
891 # values are arrayrefs of cust_bill_pkg_tax_location hashrefs
892 my %tax_location = ();
894 # keys are taxlisthash keys (internal identifiers)
895 # values are arrayrefs of cust_bill_pkg_tax_rate_location hashrefs
896 my %tax_rate_location = ();
898 # keys are taxlisthash keys (internal identifiers!)
899 # values are arrayrefs of cust_tax_exempt_pkg objects
902 foreach my $tax ( keys %$taxlisthash ) {
903 # $tax is a tax identifier (intersection of a tax definition record
904 # and a cust_bill_pkg record)
905 my $tax_object = shift @{ $taxlisthash->{$tax} };
906 # $tax_object is a cust_main_county or tax_rate
907 # (with billpkgnum, pkgnum, locationnum set)
908 # the rest of @{ $taxlisthash->{$tax} } is cust_bill_pkg component objects
909 # (setup, recurring, usage classes)
910 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
911 warn " ". join('/', @{ $taxlisthash->{$tax} } ). "\n" if $DEBUG > 2;
912 # taxline calculates the tax on all cust_bill_pkgs in the
913 # first (arrayref) argument, and returns a hashref of 'name'
914 # (the line item description) and 'amount'.
915 # It also calculates exemptions and attaches them to the cust_bill_pkgs
917 my $taxables = $taxlisthash->{$tax};
918 my $exemptions = $tax_exemption{$tax} ||= [];
919 my $taxline = $tax_object->taxline(
921 'custnum' => $self->custnum,
922 'invoice_time' => $invoice_time,
923 'exemptions' => $exemptions,
925 return $taxline unless ref($taxline);
927 unshift @{ $taxlisthash->{$tax} }, $tax_object;
929 if ( $tax_object->isa('FS::cust_main_county') ) {
930 # then $taxline is a real line item
931 push @{ $taxname{ $taxline->itemdesc } }, $taxline;
934 # leave this as is for now
936 my $name = $taxline->{'name'};
937 my $amount = $taxline->{'amount'};
939 #warn "adding $amount as $name\n";
940 $taxname{ $name } ||= [];
941 push @{ $taxname{ $name } }, $tax;
943 $tax_amount{ $tax } += $amount;
945 # link records between cust_main_county/tax_rate and cust_location
946 $tax_rate_location{ $tax } ||= [];
947 my $taxratelocationnum =
948 $tax_object->tax_rate_location->taxratelocationnum;
949 push @{ $tax_rate_location{ $tax } },
951 'taxnum' => $tax_object->taxnum,
952 'taxtype' => ref($tax_object),
953 'amount' => sprintf('%.2f', $amount ),
954 'locationtaxid' => $tax_object->location,
955 'taxratelocationnum' => $taxratelocationnum,
957 } #if ref($tax_object)...
958 } #foreach keys %$taxlisthash
960 #consolidate and create tax line items
961 warn "consolidating and generating...\n" if $DEBUG > 2;
962 foreach my $taxname ( keys %taxname ) {
963 my @cust_bill_pkg_tax_location;
964 my @cust_bill_pkg_tax_rate_location;
965 my $tax_cust_bill_pkg = FS::cust_bill_pkg->new({
970 'itemdesc' => $taxname,
971 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
972 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
977 warn "adding $taxname\n" if $DEBUG > 1;
978 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
979 if ( ref($taxitem) eq 'FS::cust_bill_pkg' ) {
980 # then we need to transfer the amount and the links from the
981 # line item to the new one we're creating.
982 $tax_total += $taxitem->setup;
983 foreach my $link ( @{ $taxitem->get('cust_bill_pkg_tax_location') } ) {
984 $link->set('tax_cust_bill_pkg', $tax_cust_bill_pkg);
985 push @cust_bill_pkg_tax_location, $link;
989 next if $seen{$taxitem}++;
990 warn "adding $tax_amount{$taxitem}\n" if $DEBUG > 1;
991 $tax_total += $tax_amount{$taxitem};
992 push @cust_bill_pkg_tax_rate_location,
993 map { new FS::cust_bill_pkg_tax_rate_location $_ }
994 @{ $tax_rate_location{ $taxitem } };
997 next unless $tax_total;
999 # we should really neverround this up...I guess it's okay if taxline
1000 # already returns amounts with 2 decimal places
1001 $tax_total = sprintf('%.2f', $tax_total );
1002 $tax_cust_bill_pkg->set('setup', $tax_total);
1004 my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
1010 if ( $pkg_category and
1011 $conf->config('invoice_latexsummary') ||
1012 $conf->config('invoice_htmlsummary')
1016 my %hash = ( 'section' => $pkg_category->categoryname );
1017 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
1020 $tax_cust_bill_pkg->set('display', \@display);
1022 push @tax_line_items, $tax_cust_bill_pkg;
1029 my ($self, %params) = @_;
1031 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1033 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
1034 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
1035 my $cust_location = $cust_pkg->tax_location;
1036 my $precommit_hooks = $params{precommit_hooks} or die "no precommit_hooks specified";
1037 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
1038 my $total_setup = $params{setup} or die "no setup accumulator specified";
1039 my $total_recur = $params{recur} or die "no recur accumulator specified";
1040 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
1041 my $time = $params{'time'} or die "no time specified";
1042 my (%options) = %{$params{options}};
1044 if ( $part_pkg->freq ne '1' and ($options{'freq_override'} || 0) > 0 ) {
1045 # this should never happen
1046 die 'freq_override billing attempted on non-monthly package '.
1051 my $real_pkgpart = $params{real_pkgpart};
1052 my %hash = $cust_pkg->hash;
1053 my $old_cust_pkg = new FS::cust_pkg \%hash;
1058 $cust_pkg->pkgpart($part_pkg->pkgpart);
1060 my $cmp_time = ( $conf->exists('next-bill-ignore-time')
1071 my @setup_discounts = ();
1072 my %setup_param = ( 'discounts' => \@setup_discounts );
1073 if ( ! $options{recurring_only}
1074 and ! $options{cancel}
1075 and ( $options{'resetup'}
1076 || ( ! $cust_pkg->setup
1077 && ( ! $cust_pkg->start_date
1078 || $cust_pkg->start_date <= $cmp_time
1080 && ( ! $conf->exists('disable_setup_suspended_pkgs')
1081 || ( $conf->exists('disable_setup_suspended_pkgs') &&
1082 ! $cust_pkg->getfield('susp')
1090 warn " bill setup\n" if $DEBUG > 1;
1092 unless ( $cust_pkg->waive_setup ) {
1095 $setup = eval { $cust_pkg->calc_setup( $time, \@details, \%setup_param ) };
1096 return "$@ running calc_setup for $cust_pkg\n"
1099 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
1102 $cust_pkg->setfield('setup', $time)
1103 unless $cust_pkg->setup;
1104 #do need it, but it won't get written to the db
1105 #|| $cust_pkg->pkgpart != $real_pkgpart;
1107 $cust_pkg->setfield('start_date', '')
1108 if $cust_pkg->start_date;
1113 # bill recurring fee
1118 my @recur_discounts = ();
1120 if ( ! $cust_pkg->start_date
1123 || ( $cust_pkg->susp != $cust_pkg->order_date
1124 && ( $cust_pkg->option('suspend_bill',1)
1125 || ( $part_pkg->option('suspend_bill', 1)
1126 && ! $cust_pkg->option('no_suspend_bill',1)
1132 ( $part_pkg->freq ne '0' && ( $cust_pkg->bill || 0 ) <= $cmp_time )
1133 || ( $part_pkg->plan eq 'voip_cdr'
1134 && $part_pkg->option('bill_every_call')
1139 # XXX should this be a package event? probably. events are called
1140 # at collection time at the moment, though...
1141 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
1142 if $part_pkg->can('reset_usage') && !$options{'no_usage_reset'};
1143 #don't want to reset usage just cause we want a line item??
1144 #&& $part_pkg->pkgpart == $real_pkgpart;
1146 warn " bill recur\n" if $DEBUG > 1;
1149 # XXX shared with $recur_prog
1150 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
1154 #over two params! lets at least switch to a hashref for the rest...
1155 my $increment_next_bill = ( $part_pkg->freq ne '0'
1156 && ( $cust_pkg->getfield('bill') || 0 ) <= $cmp_time
1157 && !$options{cancel}
1159 my %param = ( %setup_param,
1160 'precommit_hooks' => $precommit_hooks,
1161 'increment_next_bill' => $increment_next_bill,
1162 'discounts' => \@recur_discounts,
1163 'real_pkgpart' => $real_pkgpart,
1164 'freq_override' => $options{freq_override} || '',
1168 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
1170 # There may be some part_pkg for which this is wrong. Only those
1171 # which can_discount are supported.
1172 # (the UI should prevent adding discounts to these at the moment)
1174 warn "calling $method on cust_pkg ". $cust_pkg->pkgnum.
1175 " for pkgpart ". $cust_pkg->pkgpart.
1176 " with params ". join(' / ', map "$_=>$param{$_}", keys %param). "\n"
1179 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
1180 return "$@ running $method for $cust_pkg\n"
1184 $unitrecur = $cust_pkg->base_recur( \$sdate ) || $recur; #XXX uuh, better
1186 if ( $increment_next_bill ) {
1190 if ( my $main_pkg = $cust_pkg->main_pkg ) {
1191 # supplemental package
1192 # to keep in sync with the main package, simulate billing at
1194 my $main_pkg_freq = $main_pkg->part_pkg->freq;
1195 my $supp_pkg_freq = $part_pkg->freq;
1196 my $ratio = $supp_pkg_freq / $main_pkg_freq;
1197 if ( $ratio != int($ratio) ) {
1198 # the UI should prevent setting up packages like this, but just
1200 return "supplemental package period is not an integer multiple of main package period";
1202 $next_bill = $sdate;
1204 $next_bill = $part_pkg->add_freq( $next_bill, $main_pkg_freq );
1209 $next_bill = $part_pkg->add_freq($sdate, $options{freq_override} || 0);
1210 return "unparsable frequency: ". $part_pkg->freq
1211 if $next_bill == -1;
1214 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
1215 # only for figuring next bill date, nothing else, so, reset $sdate again
1217 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1218 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
1219 $cust_pkg->last_bill($sdate);
1221 $cust_pkg->setfield('bill', $next_bill );
1225 if ( $param{'setup_fee'} ) {
1226 # Add an additional setup fee at the billing stage.
1227 # Used for prorate_defer_bill.
1228 $setup += $param{'setup_fee'};
1229 $unitsetup += $param{'setup_fee'};
1233 if ( defined $param{'discount_left_setup'} ) {
1234 foreach my $discount_setup ( values %{$param{'discount_left_setup'}} ) {
1235 $setup -= $discount_setup;
1241 warn "\$setup is undefined" unless defined($setup);
1242 warn "\$recur is undefined" unless defined($recur);
1243 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1246 # If there's line items, create em cust_bill_pkg records
1247 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
1252 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
1253 # hmm.. and if just the options are modified in some weird price plan?
1255 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
1258 my $error = $cust_pkg->replace( $old_cust_pkg,
1259 'depend_jobnum'=>$options{depend_jobnum},
1260 'options' => { $cust_pkg->options },
1262 unless $options{no_commit};
1263 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
1264 if $error; #just in case
1267 $setup = sprintf( "%.2f", $setup );
1268 $recur = sprintf( "%.2f", $recur );
1269 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
1270 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1272 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
1273 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
1276 my $discount_show_always = $conf->exists('discount-show-always')
1277 && ( ($setup == 0 && scalar(@setup_discounts))
1278 || ($recur == 0 && scalar(@recur_discounts))
1283 || (!$part_pkg->hidden && $options{has_hidden}) #include some $0 lines
1284 || $discount_show_always
1285 || ($setup == 0 && $cust_pkg->_X_show_zero('setup'))
1286 || ($recur == 0 && $cust_pkg->_X_show_zero('recur'))
1290 warn " charges (setup=$setup, recur=$recur); adding line items\n"
1293 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
1295 warn " adding customer package invoice detail: $_\n"
1296 foreach @cust_pkg_detail;
1298 push @details, @cust_pkg_detail;
1300 my $cust_bill_pkg = new FS::cust_bill_pkg {
1301 'pkgnum' => $cust_pkg->pkgnum,
1303 'unitsetup' => $unitsetup,
1305 'unitrecur' => $unitrecur,
1306 'quantity' => $cust_pkg->quantity,
1307 'details' => \@details,
1308 'discounts' => [ @setup_discounts, @recur_discounts ],
1309 'hidden' => $part_pkg->hidden,
1310 'freq' => $part_pkg->freq,
1313 if ( $part_pkg->option('prorate_defer_bill',1)
1314 and !$hash{last_bill} ) {
1315 # both preceding and upcoming, technically
1316 $cust_bill_pkg->sdate( $cust_pkg->setup );
1317 $cust_bill_pkg->edate( $cust_pkg->bill );
1318 } elsif ( $part_pkg->recur_temporality eq 'preceding' ) {
1319 $cust_bill_pkg->sdate( $hash{last_bill} );
1320 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
1321 $cust_bill_pkg->edate( $time ) if $options{cancel};
1322 } else { #if ( $part_pkg->recur_temporality eq 'upcoming' ) {
1323 $cust_bill_pkg->sdate( $sdate );
1324 $cust_bill_pkg->edate( $cust_pkg->bill );
1325 #$cust_bill_pkg->edate( $time ) if $options{cancel};
1328 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
1329 unless $part_pkg->pkgpart == $real_pkgpart;
1331 $$total_setup += $setup;
1332 $$total_recur += $recur;
1338 my $error = $self->_handle_taxes( $taxlisthash, $cust_bill_pkg,
1339 cancel => $options{cancel} );
1340 return $error if $error;
1342 $cust_bill_pkg->set_display(
1343 part_pkg => $part_pkg,
1344 real_pkgpart => $real_pkgpart,
1347 push @$cust_bill_pkgs, $cust_bill_pkg;
1349 } #if $setup != 0 || $recur != 0
1357 =item _transfer_balance TO_PKG [ FROM_PKGNUM ]
1359 Takes one argument, a cust_pkg object that is being billed. This will
1360 be called only if the package was created by a package change, and has
1361 not been billed since the package change, and package balance tracking
1362 is enabled. The second argument can be an alternate package number to
1363 transfer the balance from; this should not be used externally.
1365 Transfers the balance from the previous package (now canceled) to
1366 this package, by crediting one package and creating an invoice item for
1367 the other. Inserts the credit and returns the invoice item (so that it
1368 can be added to an invoice that's being built).
1370 If the previous package was never billed, and was also created by a package
1371 change, then this will also transfer the balance from I<its> previous
1372 package, and so on, until reaching a package that either has been billed
1373 or was not created by a package change.
1377 my $balance_transfer_reason;
1379 sub _transfer_balance {
1381 my $cust_pkg = shift;
1382 my $from_pkgnum = shift || $cust_pkg->change_pkgnum;
1383 my $from_pkg = FS::cust_pkg->by_key($from_pkgnum);
1387 # if $from_pkg is not the first package in the chain, and it was never
1389 if ( $from_pkg->change_pkgnum and scalar($from_pkg->cust_bill_pkg) == 0 ) {
1390 @transfers = $self->_transfer_balance($cust_pkg, $from_pkg->change_pkgnum);
1393 my $prev_balance = $self->balance_pkgnum($from_pkgnum);
1394 if ( $prev_balance != 0 ) {
1395 $balance_transfer_reason ||= FS::reason->new_or_existing(
1396 'reason' => 'Package balance transfer',
1397 'type' => 'Internal adjustment',
1401 my $credit = FS::cust_credit->new({
1402 'custnum' => $self->custnum,
1403 'amount' => abs($prev_balance),
1404 'reasonnum' => $balance_transfer_reason->reasonnum,
1405 '_date' => $cust_pkg->change_date,
1408 my $cust_bill_pkg = FS::cust_bill_pkg->new({
1410 'recur' => abs($prev_balance),
1411 #'sdate' => $from_pkg->last_bill, # not sure about this
1412 #'edate' => $cust_pkg->change_date,
1413 'itemdesc' => $self->mt('Previous Balance, [_1]',
1414 $from_pkg->part_pkg->pkg),
1417 if ( $prev_balance > 0 ) {
1418 # credit the old package, charge the new one
1419 $credit->set('pkgnum', $from_pkgnum);
1420 $cust_bill_pkg->set('pkgnum', $cust_pkg->pkgnum);
1423 $credit->set('pkgnum', $cust_pkg->pkgnum);
1424 $cust_bill_pkg->set('pkgnum', $from_pkgnum);
1426 my $error = $credit->insert;
1427 die "error transferring package balance from #".$from_pkgnum.
1428 " to #".$cust_pkg->pkgnum.": $error\n" if $error;
1430 push @transfers, $cust_bill_pkg;
1431 } # $prev_balance != 0
1436 =item handle_taxes TAXLISTHASH CUST_BILL_PKG [ OPTIONS ]
1438 This is _handle_taxes. It's called once for each cust_bill_pkg generated
1441 TAXLISTHASH is a hashref shared across the entire invoice. It looks like
1444 'cust_main_county 1001' => [ [FS::cust_main_county], ... ],
1445 'cust_main_county 1002' => [ [FS::cust_main_county], ... ],
1448 'cust_main_county' can also be 'tax_rate'. The first object in the array
1449 is always the cust_main_county or tax_rate identified by the key.
1451 That "..." is a list of FS::cust_bill_pkg objects that will be fed to
1452 the 'taxline' method to calculate the amount of the tax. This doesn't
1453 happen until calculate_taxes, though.
1455 OPTIONS may include:
1456 - part_item: a part_pkg or part_fee object to be used as the package/fee
1458 - location: a cust_location to be used as the billing location.
1459 - cancel: true if this package is being billed on cancellation. This
1460 allows tax to be calculated on usage charges only.
1462 If not supplied, part_item will be inferred from the pkgnum or feepart of the
1463 cust_bill_pkg, and location from the pkgnum (or, for fees, the invnum and
1464 the customer's default service location).
1470 my $taxlisthash = shift;
1471 my $cust_bill_pkg = shift;
1474 # at this point I realize that we have enough information to infer all this
1475 # stuff, instead of passing around giant honking argument lists
1476 my $location = $options{location} || $cust_bill_pkg->tax_location;
1477 my $part_item = $options{part_item} || $cust_bill_pkg->part_X;
1479 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1481 return if ( $self->payby eq 'COMP' ); #dubious
1483 if ( $conf->exists('enable_taxproducts')
1484 && ( scalar($part_item->part_pkg_taxoverride)
1485 || $part_item->has_taxproduct
1490 # EXTERNAL TAX RATES (via tax_rate)
1491 my %cust_bill_pkg = ();
1495 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
1496 push @classes, 'setup' if $cust_bill_pkg->setup and !$options{cancel};
1497 push @classes, 'recur' if $cust_bill_pkg->recur and !$options{cancel};
1499 my $exempt = $conf->exists('cust_class-tax_exempt')
1500 ? ( $self->cust_class ? $self->cust_class->tax : '' )
1502 # standardize this just to be sure
1503 $exempt = ($exempt eq 'Y') ? 'Y' : '';
1507 foreach my $class (@classes) {
1508 my $err_or_ref = $self->_gather_taxes($part_item, $class, $location);
1509 return $err_or_ref unless ref($err_or_ref);
1510 $taxes{$class} = $err_or_ref;
1513 unless (exists $taxes{''}) {
1514 my $err_or_ref = $self->_gather_taxes($part_item, '', $location);
1515 return $err_or_ref unless ref($err_or_ref);
1516 $taxes{''} = $err_or_ref;
1521 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate; # grrr
1522 foreach my $key (keys %tax_cust_bill_pkg) {
1523 # $key is "setup", "recur", or a usage class name. ('' is a usage class.)
1524 # $tax_cust_bill_pkg{$key} is a cust_bill_pkg for that component of
1526 # $taxes{$key} is an arrayref of cust_main_county or tax_rate objects that
1527 # apply to $key-class charges.
1528 my @taxes = @{ $taxes{$key} || [] };
1529 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
1531 my %localtaxlisthash = ();
1532 foreach my $tax ( @taxes ) {
1534 # this is the tax identifier, not the taxname
1535 my $taxname = ref( $tax ). ' '. $tax->taxnum;
1536 # $taxlisthash: keys are "setup", "recur", and usage classes.
1537 # Values are arrayrefs, first the tax object (cust_main_county
1538 # or tax_rate) and then any cust_bill_pkg objects that the
1540 $taxlisthash->{ $taxname } ||= [ $tax ];
1541 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
1543 $localtaxlisthash{ $taxname } ||= [ $tax ];
1544 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
1548 warn "finding taxed taxes...\n" if $DEBUG > 2;
1549 foreach my $tax ( keys %localtaxlisthash ) {
1550 my $tax_object = shift @{ $localtaxlisthash{$tax} };
1551 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
1553 next unless $tax_object->can('tax_on_tax');
1555 foreach my $tot ( $tax_object->tax_on_tax( $location ) ) {
1556 my $totname = ref( $tot ). ' '. $tot->taxnum;
1558 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
1560 next unless exists( $localtaxlisthash{ $totname } ); # only increase
1562 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
1563 # calculate the tax amount that the tax_on_tax will apply to
1564 my $hashref_or_error =
1565 $tax_object->taxline( $localtaxlisthash{$tax} );
1566 return $hashref_or_error
1567 unless ref($hashref_or_error);
1569 # and append it to the list of taxable items
1570 $taxlisthash->{ $totname } ||= [ $tot ];
1571 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
1579 # INTERNAL TAX RATES (cust_main_county)
1581 # We fetch taxes even if the customer is completely exempt,
1582 # because we need to record that fact.
1584 my @loc_keys = qw( district city county state country );
1585 my %taxhash = map { $_ => $location->$_ } @loc_keys;
1587 $taxhash{'taxclass'} = $part_item->taxclass;
1589 warn "taxhash:\n". Dumper(\%taxhash) if $DEBUG > 2;
1591 my @taxes = (); # entries are cust_main_county objects
1592 my %taxhash_elim = %taxhash;
1593 my @elim = qw( district city county state );
1596 #first try a match with taxclass
1597 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1599 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1600 #then try a match without taxclass
1601 my %no_taxclass = %taxhash_elim;
1602 $no_taxclass{ 'taxclass' } = '';
1603 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1606 $taxhash_elim{ shift(@elim) } = '';
1608 } while ( !scalar(@taxes) && scalar(@elim) );
1611 my $tax_id = 'cust_main_county '.$_->taxnum;
1612 $taxlisthash->{$tax_id} ||= [ $_ ];
1613 push @{ $taxlisthash->{$tax_id} }, $cust_bill_pkg;
1620 =item _gather_taxes PART_ITEM CLASS CUST_LOCATION
1622 Internal method used with vendor-provided tax tables. PART_ITEM is a part_pkg
1623 or part_fee (which will define the tax eligibility of the product), CLASS is
1624 'setup', 'recur', null, or a C<usage_class> number, and CUST_LOCATION is the
1625 location where the service was provided (or billed, depending on
1626 configuration). Returns an arrayref of L<FS::tax_rate> objects that
1627 can apply to this line item.
1633 my $part_item = shift;
1635 my $location = shift;
1637 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1639 my $geocode = $location->geocode('cch');
1641 [ $part_item->tax_rates('cch', $geocode, $class) ]
1645 =item collect [ HASHREF | OPTION => VALUE ... ]
1647 (Attempt to) collect money for this customer's outstanding invoices (see
1648 L<FS::cust_bill>). Usually used after the bill method.
1650 Actions are now triggered by billing events; see L<FS::part_event> and the
1651 billing events web interface. Old-style invoice events (see
1652 L<FS::part_bill_event>) have been deprecated.
1654 If there is an error, returns the error, otherwise returns false.
1656 Options are passed as name-value pairs.
1658 Currently available options are:
1664 Use this time when deciding when to print invoices and late notices on those invoices. The default is now. It is specified as a UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion functions.
1668 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1672 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1676 set true to surpress email card/ACH decline notices.
1680 Debugging level. Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
1686 # allows for one time override of normal customer billing method
1691 my( $self, %options ) = @_;
1693 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1695 my $invoice_time = $options{'invoice_time'} || time;
1698 local $SIG{HUP} = 'IGNORE';
1699 local $SIG{INT} = 'IGNORE';
1700 local $SIG{QUIT} = 'IGNORE';
1701 local $SIG{TERM} = 'IGNORE';
1702 local $SIG{TSTP} = 'IGNORE';
1703 local $SIG{PIPE} = 'IGNORE';
1705 my $oldAutoCommit = $FS::UID::AutoCommit;
1706 local $FS::UID::AutoCommit = 0;
1709 $self->select_for_update; #mutex
1712 my $balance = $self->balance;
1713 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
1716 if ( exists($options{'retry_card'}) ) {
1717 carp 'retry_card option passed to collect is deprecated; use retry';
1718 $options{'retry'} ||= $options{'retry_card'};
1720 if ( exists($options{'retry'}) && $options{'retry'} ) {
1721 my $error = $self->retry_realtime;
1723 $dbh->rollback if $oldAutoCommit;
1728 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1730 #never want to roll back an event just because it returned an error
1731 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1733 $self->do_cust_event(
1734 'debug' => ( $options{'debug'} || 0 ),
1735 'time' => $invoice_time,
1736 'check_freq' => $options{'check_freq'},
1737 'stage' => 'collect',
1742 =item retry_realtime
1744 Schedules realtime / batch credit card / electronic check / LEC billing
1745 events for for retry. Useful if card information has changed or manual
1746 retry is desired. The 'collect' method must be called to actually retry
1749 Implementation details: For either this customer, or for each of this
1750 customer's open invoices, changes the status of the first "done" (with
1751 statustext error) realtime processing event to "failed".
1755 sub retry_realtime {
1758 local $SIG{HUP} = 'IGNORE';
1759 local $SIG{INT} = 'IGNORE';
1760 local $SIG{QUIT} = 'IGNORE';
1761 local $SIG{TERM} = 'IGNORE';
1762 local $SIG{TSTP} = 'IGNORE';
1763 local $SIG{PIPE} = 'IGNORE';
1765 my $oldAutoCommit = $FS::UID::AutoCommit;
1766 local $FS::UID::AutoCommit = 0;
1769 #a little false laziness w/due_cust_event (not too bad, really)
1771 # I guess this is always as of now?
1772 my $join = FS::part_event_condition->join_conditions_sql('', 'time' => time);
1773 my $order = FS::part_event_condition->order_conditions_sql;
1776 . join ( ' OR ' , map {
1777 my $cust_join = FS::part_event->eventtables_cust_join->{$_} || '';
1778 my $custnum = FS::part_event->eventtables_custnum->{$_};
1779 "( part_event.eventtable = " . dbh->quote($_)
1780 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key
1781 . " from $_ $cust_join"
1782 . " where $custnum = " . dbh->quote( $self->custnum ) . "))" ;
1783 } FS::part_event->eventtables)
1786 #here is the agent virtualization
1787 my $agent_virt = " ( part_event.agentnum IS NULL
1788 OR part_event.agentnum = ". $self->agentnum. ' )';
1790 #XXX this shouldn't be hardcoded, actions should declare it...
1791 my @realtime_events = qw(
1792 cust_bill_realtime_card
1793 cust_bill_realtime_check
1794 cust_bill_realtime_lec
1798 my $is_realtime_event =
1799 ' part_event.action IN ( '.
1800 join(',', map "'$_'", @realtime_events ).
1803 my $batch_or_statustext =
1804 "( part_event.action = 'cust_bill_batch'
1805 OR ( statustext IS NOT NULL AND statustext != '' )
1809 my @cust_event = qsearch({
1810 'table' => 'cust_event',
1811 'select' => 'cust_event.*',
1812 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
1813 'hashref' => { 'status' => 'done' },
1814 'extra_sql' => " AND $batch_or_statustext ".
1815 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
1818 my %seen_invnum = ();
1819 foreach my $cust_event (@cust_event) {
1821 #max one for the customer, one for each open invoice
1822 my $cust_X = $cust_event->cust_X;
1823 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
1827 or $cust_event->part_event->eventtable eq 'cust_bill'
1830 my $error = $cust_event->retry;
1832 $dbh->rollback if $oldAutoCommit;
1833 return "error scheduling event for retry: $error";
1838 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1843 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
1845 Runs billing events; see L<FS::part_event> and the billing events web
1848 If there is an error, returns the error, otherwise returns false.
1850 Options are passed as name-value pairs.
1852 Currently available options are:
1858 Use this time when deciding when to print invoices and late notices on those invoices. The default is now. It is specified as a UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion functions.
1862 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1866 "collect" (the default) or "pre-bill"
1870 set true to surpress email card/ACH decline notices.
1874 Debugging level. Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
1881 # allows for one time override of normal customer billing method
1885 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1888 my( $self, %options ) = @_;
1890 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1892 my $time = $options{'time'} || time;
1895 local $SIG{HUP} = 'IGNORE';
1896 local $SIG{INT} = 'IGNORE';
1897 local $SIG{QUIT} = 'IGNORE';
1898 local $SIG{TERM} = 'IGNORE';
1899 local $SIG{TSTP} = 'IGNORE';
1900 local $SIG{PIPE} = 'IGNORE';
1902 my $oldAutoCommit = $FS::UID::AutoCommit;
1903 local $FS::UID::AutoCommit = 0;
1906 $self->select_for_update; #mutex
1909 my $balance = $self->balance;
1910 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
1913 # if ( exists($options{'retry_card'}) ) {
1914 # carp 'retry_card option passed to collect is deprecated; use retry';
1915 # $options{'retry'} ||= $options{'retry_card'};
1917 # if ( exists($options{'retry'}) && $options{'retry'} ) {
1918 # my $error = $self->retry_realtime;
1920 # $dbh->rollback if $oldAutoCommit;
1925 # false laziness w/pay_batch::import_results
1927 my $due_cust_event = $self->due_cust_event(
1928 'debug' => ( $options{'debug'} || 0 ),
1930 'check_freq' => $options{'check_freq'},
1931 'stage' => ( $options{'stage'} || 'collect' ),
1933 unless( ref($due_cust_event) ) {
1934 $dbh->rollback if $oldAutoCommit;
1935 return $due_cust_event;
1938 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1939 #never want to roll back an event just because it or a different one
1941 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1943 foreach my $cust_event ( @$due_cust_event ) {
1947 #re-eval event conditions (a previous event could have changed things)
1948 unless ( $cust_event->test_conditions ) {
1949 #don't leave stray "new/locked" records around
1950 my $error = $cust_event->delete;
1951 return $error if $error;
1956 local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
1957 if $options{'quiet'};
1958 warn " running cust_event ". $cust_event->eventnum. "\n"
1961 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
1962 if ( my $error = $cust_event->do_event( 'time' => $time ) ) {
1963 #XXX wtf is this? figure out a proper dealio with return value
1975 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
1977 Inserts database records for and returns an ordered listref of new events due
1978 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
1979 events are due, an empty listref is returned. If there is an error, returns a
1980 scalar error message.
1982 To actually run the events, call each event's test_condition method, and if
1983 still true, call the event's do_event method.
1985 Options are passed as a hashref or as a list of name-value pairs. Available
1992 Search only for events of this check frequency (how often events of this type are checked); currently "1d" (daily, the default) and "1m" (monthly) are recognized.
1996 "collect" (the default) or "pre-bill"
2000 "Current time" for the events.
2004 Debugging level. Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
2008 Only return events for the specified eventtable (by default, events of all eventtables are returned)
2012 Explicitly pass the objects to be tested (typically used with eventtable).
2016 Set to true to return the objects, but not actually insert them into the
2023 sub due_cust_event {
2025 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
2028 #my $DEBUG = $opt{'debug'}
2029 $opt{'debug'} ||= 0; # silence some warnings
2030 local($DEBUG) = $opt{'debug'}
2031 if $opt{'debug'} > $DEBUG;
2032 $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
2034 warn "$me due_cust_event called with options ".
2035 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
2038 $opt{'time'} ||= time;
2040 local $SIG{HUP} = 'IGNORE';
2041 local $SIG{INT} = 'IGNORE';
2042 local $SIG{QUIT} = 'IGNORE';
2043 local $SIG{TERM} = 'IGNORE';
2044 local $SIG{TSTP} = 'IGNORE';
2045 local $SIG{PIPE} = 'IGNORE';
2047 my $oldAutoCommit = $FS::UID::AutoCommit;
2048 local $FS::UID::AutoCommit = 0;
2051 $self->select_for_update #mutex
2052 unless $opt{testonly};
2055 # find possible events (initial search)
2058 my @cust_event = ();
2060 my @eventtable = $opt{'eventtable'}
2061 ? ( $opt{'eventtable'} )
2062 : FS::part_event->eventtables_runorder;
2064 my $check_freq = $opt{'check_freq'} || '1d';
2066 foreach my $eventtable ( @eventtable ) {
2069 if ( $opt{'objects'} ) {
2071 @objects = @{ $opt{'objects'} };
2073 } elsif ( $eventtable eq 'cust_main' ) {
2075 @objects = ( $self );
2079 my $cm_join = " LEFT JOIN cust_main USING ( custnum )";
2080 # linkage not needed here because FS::cust_main->$eventtable will
2083 #some false laziness w/Cron::bill bill_where
2085 my $join = FS::part_event_condition->join_conditions_sql( $eventtable,
2086 'time' => $opt{'time'});
2087 my $where = FS::part_event_condition->where_conditions_sql($eventtable,
2088 'time'=>$opt{'time'},
2090 $where = $where ? "AND $where" : '';
2092 my $are_part_event =
2093 "EXISTS ( SELECT 1 FROM part_event $join
2094 WHERE check_freq = '$check_freq'
2095 AND eventtable = '$eventtable'
2096 AND ( disabled = '' OR disabled IS NULL )
2102 @objects = $self->$eventtable(
2103 'addl_from' => $cm_join,
2104 'extra_sql' => " AND $are_part_event",
2106 } # if ( !$opt{objects} and $eventtable ne 'cust_main' )
2108 my @e_cust_event = ();
2110 my $linkage = FS::part_event->eventtables_cust_join->{$eventtable} || '';
2112 my $cross = "CROSS JOIN $eventtable $linkage";
2113 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
2114 unless $eventtable eq 'cust_main';
2116 foreach my $object ( @objects ) {
2118 #this first search uses the condition_sql magic for optimization.
2119 #the more possible events we can eliminate in this step the better
2121 my $cross_where = '';
2122 my $pkey = $object->primary_key;
2123 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
2125 my $join = FS::part_event_condition->join_conditions_sql( $eventtable,
2126 'time' => $opt{'time'});
2128 FS::part_event_condition->where_conditions_sql( $eventtable,
2129 'time'=>$opt{'time'}
2131 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
2133 $extra_sql = "AND $extra_sql" if $extra_sql;
2135 #here is the agent virtualization
2136 $extra_sql .= " AND ( part_event.agentnum IS NULL
2137 OR part_event.agentnum = ". $self->agentnum. ' )';
2139 $extra_sql .= " $order";
2141 warn "searching for events for $eventtable ". $object->$pkey. "\n"
2142 if $opt{'debug'} > 2;
2143 my @part_event = qsearch( {
2144 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
2145 'select' => 'part_event.*',
2146 'table' => 'part_event',
2147 'addl_from' => "$cross $join",
2148 'hashref' => { 'check_freq' => $check_freq,
2149 'eventtable' => $eventtable,
2152 'extra_sql' => "AND $cross_where $extra_sql",
2156 my $pkey = $object->primary_key;
2157 warn " ". scalar(@part_event).
2158 " possible events found for $eventtable ". $object->$pkey(). "\n";
2161 push @e_cust_event, map {
2162 $_->new_cust_event($object, 'time' => $opt{'time'})
2167 warn " ". scalar(@e_cust_event).
2168 " subtotal possible cust events found for $eventtable\n"
2171 push @cust_event, @e_cust_event;
2175 warn " ". scalar(@cust_event).
2176 " total possible cust events found in initial search\n"
2184 $opt{stage} ||= 'collect';
2186 grep { my $stage = $_->part_event->event_stage;
2187 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
2197 @cust_event = grep $_->test_conditions( 'stats_hashref' => \%unsat ),
2200 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
2203 warn " invalid conditions not eliminated with condition_sql:\n".
2204 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
2205 if keys %unsat && $DEBUG; # > 1;
2211 unless( $opt{testonly} ) {
2212 foreach my $cust_event ( @cust_event ) {
2214 my $error = $cust_event->insert();
2216 $dbh->rollback if $oldAutoCommit;
2223 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2229 warn " returning events: ". Dumper(@cust_event). "\n"
2236 =item apply_payments_and_credits [ OPTION => VALUE ... ]
2238 Applies unapplied payments and credits.
2240 In most cases, this new method should be used in place of sequential
2241 apply_payments and apply_credits methods.
2243 A hash of optional arguments may be passed. Currently "manual" is supported.
2244 If true, a payment receipt is sent instead of a statement when
2245 'payment_receipt_email' configuration option is set.
2247 If there is an error, returns the error, otherwise returns false.
2251 sub apply_payments_and_credits {
2252 my( $self, %options ) = @_;
2254 local $SIG{HUP} = 'IGNORE';
2255 local $SIG{INT} = 'IGNORE';
2256 local $SIG{QUIT} = 'IGNORE';
2257 local $SIG{TERM} = 'IGNORE';
2258 local $SIG{TSTP} = 'IGNORE';
2259 local $SIG{PIPE} = 'IGNORE';
2261 my $oldAutoCommit = $FS::UID::AutoCommit;
2262 local $FS::UID::AutoCommit = 0;
2265 $self->select_for_update; #mutex
2267 foreach my $cust_bill ( $self->open_cust_bill ) {
2268 my $error = $cust_bill->apply_payments_and_credits(%options);
2270 $dbh->rollback if $oldAutoCommit;
2271 return "Error applying: $error";
2275 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2280 =item apply_credits OPTION => VALUE ...
2282 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
2283 to outstanding invoice balances in chronological order (or reverse
2284 chronological order if the I<order> option is set to B<newest>) and returns the
2285 value of any remaining unapplied credits available for refund (see
2286 L<FS::cust_refund>).
2288 Dies if there is an error.
2296 local $SIG{HUP} = 'IGNORE';
2297 local $SIG{INT} = 'IGNORE';
2298 local $SIG{QUIT} = 'IGNORE';
2299 local $SIG{TERM} = 'IGNORE';
2300 local $SIG{TSTP} = 'IGNORE';
2301 local $SIG{PIPE} = 'IGNORE';
2303 my $oldAutoCommit = $FS::UID::AutoCommit;
2304 local $FS::UID::AutoCommit = 0;
2307 $self->select_for_update; #mutex
2309 unless ( $self->total_unapplied_credits ) {
2310 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2314 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
2315 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
2317 my @invoices = $self->open_cust_bill;
2318 @invoices = sort { $b->_date <=> $a->_date } @invoices
2319 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
2321 if ( $conf->exists('pkg-balances') ) {
2322 # limit @credits to those w/ a pkgnum grepped from $self
2324 foreach my $i (@invoices) {
2325 foreach my $li ( $i->cust_bill_pkg ) {
2326 $pkgnums{$li->pkgnum} = 1;
2329 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
2334 foreach my $cust_bill ( @invoices ) {
2336 if ( !defined($credit) || $credit->credited == 0) {
2337 $credit = pop @credits or last;
2341 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
2342 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
2344 $owed = $cust_bill->owed;
2346 unless ( $owed > 0 ) {
2347 push @credits, $credit;
2351 my $amount = min( $credit->credited, $owed );
2353 my $cust_credit_bill = new FS::cust_credit_bill ( {
2354 'crednum' => $credit->crednum,
2355 'invnum' => $cust_bill->invnum,
2356 'amount' => $amount,
2358 $cust_credit_bill->pkgnum( $credit->pkgnum )
2359 if $conf->exists('pkg-balances') && $credit->pkgnum;
2360 my $error = $cust_credit_bill->insert;
2362 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2366 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2370 my $total_unapplied_credits = $self->total_unapplied_credits;
2372 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2374 return $total_unapplied_credits;
2377 =item apply_payments [ OPTION => VALUE ... ]
2379 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2380 to outstanding invoice balances in chronological order.
2382 #and returns the value of any remaining unapplied payments.
2384 A hash of optional arguments may be passed. Currently "manual" is supported.
2385 If true, a payment receipt is sent instead of a statement when
2386 'payment_receipt_email' configuration option is set.
2388 Dies if there is an error.
2392 sub apply_payments {
2393 my( $self, %options ) = @_;
2395 local $SIG{HUP} = 'IGNORE';
2396 local $SIG{INT} = 'IGNORE';
2397 local $SIG{QUIT} = 'IGNORE';
2398 local $SIG{TERM} = 'IGNORE';
2399 local $SIG{TSTP} = 'IGNORE';
2400 local $SIG{PIPE} = 'IGNORE';
2402 my $oldAutoCommit = $FS::UID::AutoCommit;
2403 local $FS::UID::AutoCommit = 0;
2406 $self->select_for_update; #mutex
2410 my @payments = sort { $b->_date <=> $a->_date }
2411 grep { $_->unapplied > 0 }
2414 my @invoices = sort { $a->_date <=> $b->_date}
2415 grep { $_->owed > 0 }
2418 if ( $conf->exists('pkg-balances') ) {
2419 # limit @payments to those w/ a pkgnum grepped from $self
2421 foreach my $i (@invoices) {
2422 foreach my $li ( $i->cust_bill_pkg ) {
2423 $pkgnums{$li->pkgnum} = 1;
2426 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
2431 foreach my $cust_bill ( @invoices ) {
2433 if ( !defined($payment) || $payment->unapplied == 0 ) {
2434 $payment = pop @payments or last;
2438 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
2439 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
2441 $owed = $cust_bill->owed;
2443 unless ( $owed > 0 ) {
2444 push @payments, $payment;
2448 my $amount = min( $payment->unapplied, $owed );
2451 'paynum' => $payment->paynum,
2452 'invnum' => $cust_bill->invnum,
2453 'amount' => $amount,
2455 $cbp->{_date} = $payment->_date
2456 if $options{'manual'} && $options{'backdate_application'};
2457 my $cust_bill_pay = new FS::cust_bill_pay($cbp);
2458 $cust_bill_pay->pkgnum( $payment->pkgnum )
2459 if $conf->exists('pkg-balances') && $payment->pkgnum;
2460 my $error = $cust_bill_pay->insert(%options);
2462 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2466 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2470 my $total_unapplied_payments = $self->total_unapplied_payments;
2472 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2474 return $total_unapplied_payments;
2484 suspend_adjourned_pkgs
2485 unsuspend_resumed_pkgs
2488 (do_cust_event pre-bill)
2491 (vendor-only) _gather_taxes
2492 _omit_zero_value_bundles
2493 _handle_taxes (for fees)
2496 apply_payments_and_credits
2505 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>