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
634 return $error if $error;
638 # XXX implementation of fees is supposed to make this go away...
639 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
640 !$conf->exists('postal_invoice-recurring_only')
644 my $postal_pkg = $self->charge_postal_fee();
645 if ( $postal_pkg && !ref( $postal_pkg ) ) {
647 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
648 return "can't charge postal invoice fee for customer ".
649 $self->custnum. ": $postal_pkg";
651 } elsif ( $postal_pkg ) {
653 my $real_pkgpart = $postal_pkg->pkgpart;
654 # we could implement this bit as FS::part_pkg::has_hidden, but we already
655 # suffer from performance issues
656 $options{has_hidden} = 0;
657 my @part_pkg = $postal_pkg->part_pkg->self_and_bill_linked;
658 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
660 foreach my $part_pkg ( @part_pkg ) {
661 my %postal_options = %options;
662 delete $postal_options{cancel};
664 $self->_make_lines( 'part_pkg' => $part_pkg,
665 'cust_pkg' => $postal_pkg,
666 'precommit_hooks' => \@precommit_hooks,
667 'line_items' => \@cust_bill_pkg,
668 'setup' => $total_setup{$pass},
669 'recur' => $total_recur{$pass},
670 'tax_matrix' => $taxlisthash{$pass},
672 'real_pkgpart' => $real_pkgpart,
673 'options' => \%postal_options,
676 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
681 # it's silly to have a zero value postal_pkg, but....
682 @cust_bill_pkg = _omit_zero_value_bundles(@cust_bill_pkg);
688 my $listref_or_error =
689 $self->calculate_taxes( \@cust_bill_pkg, $taxlisthash{$pass}, $invoice_time);
691 unless ( ref( $listref_or_error ) ) {
692 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
693 return $listref_or_error;
696 foreach my $taxline ( @$listref_or_error ) {
697 ${ $total_setup{$pass} } =
698 sprintf('%.2f', ${ $total_setup{$pass} } + $taxline->setup );
699 push @cust_bill_pkg, $taxline;
703 warn "adding tax adjustments...\n" if $DEBUG > 2;
704 foreach my $cust_tax_adjustment (
705 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
711 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
713 my $itemdesc = $cust_tax_adjustment->taxname;
714 $itemdesc = '' if $itemdesc eq 'Tax';
716 push @cust_bill_pkg, new FS::cust_bill_pkg {
722 'itemdesc' => $itemdesc,
723 'itemcomment' => $cust_tax_adjustment->comment,
724 'cust_tax_adjustment' => $cust_tax_adjustment,
725 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
730 my $charged = sprintf('%.2f', ${ $total_setup{$pass} } + ${ $total_recur{$pass} } );
732 my @cust_bill = $self->cust_bill;
733 my $balance = $self->balance;
734 my $previous_bill = $cust_bill[-1] if @cust_bill;
735 my $previous_balance = 0;
736 if ( $previous_bill ) {
737 $previous_balance = $previous_bill->billing_balance
738 + $previous_bill->charged;
741 warn "creating the new invoice\n" if $DEBUG;
742 #create the new invoice
743 my $cust_bill = new FS::cust_bill ( {
744 'custnum' => $self->custnum,
745 '_date' => $invoice_time,
746 'charged' => $charged,
747 'billing_balance' => $balance,
748 'previous_balance' => $previous_balance,
749 'invoice_terms' => $options{'invoice_terms'},
750 'cust_bill_pkg' => \@cust_bill_pkg,
752 $error = $cust_bill->insert unless $options{no_commit};
754 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
755 return "can't create invoice for customer #". $self->custnum. ": $error";
757 push @{$options{return_bill}}, $cust_bill if $options{return_bill};
759 } #foreach my $pass ( keys %cust_bill_pkg )
761 foreach my $hook ( @precommit_hooks ) {
764 } unless $options{no_commit};
766 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
767 return "$@ running precommit hook $hook\n";
771 $dbh->commit or die $dbh->errstr if $oldAutoCommit && !$options{no_commit};
776 #discard bundled packages of 0 value
777 sub _omit_zero_value_bundles {
780 my @cust_bill_pkg = ();
781 my @cust_bill_pkg_bundle = ();
783 my $discount_show_always = 0;
785 foreach my $cust_bill_pkg ( @in ) {
787 $discount_show_always = ($cust_bill_pkg->get('discounts')
788 && scalar(@{$cust_bill_pkg->get('discounts')})
789 && $conf->exists('discount-show-always'));
791 warn " pkgnum ". $cust_bill_pkg->pkgnum. " sum $sum, ".
792 "setup_show_zero ". $cust_bill_pkg->setup_show_zero.
793 "recur_show_zero ". $cust_bill_pkg->recur_show_zero. "\n"
796 if (scalar(@cust_bill_pkg_bundle) && !$cust_bill_pkg->pkgpart_override) {
797 push @cust_bill_pkg, @cust_bill_pkg_bundle
799 || ($sum == 0 && ( $discount_show_always
800 || grep {$_->recur_show_zero || $_->setup_show_zero}
801 @cust_bill_pkg_bundle
804 @cust_bill_pkg_bundle = ();
808 $sum += $cust_bill_pkg->setup + $cust_bill_pkg->recur;
809 push @cust_bill_pkg_bundle, $cust_bill_pkg;
813 push @cust_bill_pkg, @cust_bill_pkg_bundle
815 || ($sum == 0 && ( $discount_show_always
816 || grep {$_->recur_show_zero || $_->setup_show_zero}
817 @cust_bill_pkg_bundle
821 warn " _omit_zero_value_bundles: ". scalar(@in).
822 '->'. scalar(@cust_bill_pkg). "\n" #. Dumper(@cust_bill_pkg). "\n"
829 =item calculate_taxes LINEITEMREF TAXHASHREF INVOICE_TIME
831 Generates tax line items (see L<FS::cust_bill_pkg>) for this customer.
832 Usually used internally by bill method B<bill>.
834 If there is an error, returns the error, otherwise returns reference to a
835 list of line items suitable for insertion.
841 An array ref of the line items being billed.
845 A strange beast. The keys to this hash are internal identifiers consisting
846 of the name of the tax object type, a space, and its unique identifier ( e.g.
847 'cust_main_county 23' ). The values of the hash are listrefs. The first
848 item in the list is the tax object. The remaining items are either line
849 items or floating point values (currency amounts).
851 The taxes are calculated on this entity. Calculated exemption records are
852 transferred to the LINEITEMREF items on the assumption that they are related.
858 This specifies the date appearing on the associated invoice. Some
859 jurisdictions (i.e. Texas) have tax exemptions which are date sensitive.
865 sub calculate_taxes {
866 my ($self, $cust_bill_pkg, $taxlisthash, $invoice_time) = @_;
868 # $taxlisthash is a hashref
869 # keys are identifiers, values are arrayrefs
870 # each arrayref starts with a tax object (cust_main_county or tax_rate)
871 # then any cust_bill_pkg objects the tax applies to
873 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
875 warn "$me calculate_taxes\n"
876 #.Dumper($self, $cust_bill_pkg, $taxlisthash, $invoice_time). "\n"
879 my @tax_line_items = ();
881 # keys are tax names (as printed on invoices / itemdesc )
882 # values are arrayrefs of taxlisthash keys (internal identifiers)
885 # keys are taxlisthash keys (internal identifiers)
886 # values are (cumulative) amounts
889 # keys are taxlisthash keys (internal identifiers)
890 # values are arrayrefs of cust_bill_pkg_tax_location hashrefs
891 my %tax_location = ();
893 # keys are taxlisthash keys (internal identifiers)
894 # values are arrayrefs of cust_bill_pkg_tax_rate_location hashrefs
895 my %tax_rate_location = ();
897 # keys are taxlisthash keys (internal identifiers!)
898 # values are arrayrefs of cust_tax_exempt_pkg objects
901 foreach my $tax ( keys %$taxlisthash ) {
902 # $tax is a tax identifier (intersection of a tax definition record
903 # and a cust_bill_pkg record)
904 my $tax_object = shift @{ $taxlisthash->{$tax} };
905 # $tax_object is a cust_main_county or tax_rate
906 # (with billpkgnum, pkgnum, locationnum set)
907 # the rest of @{ $taxlisthash->{$tax} } is cust_bill_pkg component objects
908 # (setup, recurring, usage classes)
909 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
910 warn " ". join('/', @{ $taxlisthash->{$tax} } ). "\n" if $DEBUG > 2;
911 # taxline calculates the tax on all cust_bill_pkgs in the
912 # first (arrayref) argument, and returns a hashref of 'name'
913 # (the line item description) and 'amount'.
914 # It also calculates exemptions and attaches them to the cust_bill_pkgs
916 my $taxables = $taxlisthash->{$tax};
917 my $exemptions = $tax_exemption{$tax} ||= [];
918 my $taxline = $tax_object->taxline(
920 'custnum' => $self->custnum,
921 'invoice_time' => $invoice_time,
922 'exemptions' => $exemptions,
924 return $taxline unless ref($taxline);
926 unshift @{ $taxlisthash->{$tax} }, $tax_object;
928 if ( $tax_object->isa('FS::cust_main_county') ) {
929 # then $taxline is a real line item
930 push @{ $taxname{ $taxline->itemdesc } }, $taxline;
933 # leave this as is for now
935 my $name = $taxline->{'name'};
936 my $amount = $taxline->{'amount'};
938 #warn "adding $amount as $name\n";
939 $taxname{ $name } ||= [];
940 push @{ $taxname{ $name } }, $tax;
942 $tax_amount{ $tax } += $amount;
944 # link records between cust_main_county/tax_rate and cust_location
945 $tax_rate_location{ $tax } ||= [];
946 my $taxratelocationnum =
947 $tax_object->tax_rate_location->taxratelocationnum;
948 push @{ $tax_rate_location{ $tax } },
950 'taxnum' => $tax_object->taxnum,
951 'taxtype' => ref($tax_object),
952 'amount' => sprintf('%.2f', $amount ),
953 'locationtaxid' => $tax_object->location,
954 'taxratelocationnum' => $taxratelocationnum,
956 } #if ref($tax_object)...
957 } #foreach keys %$taxlisthash
959 #consolidate and create tax line items
960 warn "consolidating and generating...\n" if $DEBUG > 2;
961 foreach my $taxname ( keys %taxname ) {
962 my @cust_bill_pkg_tax_location;
963 my @cust_bill_pkg_tax_rate_location;
964 my $tax_cust_bill_pkg = FS::cust_bill_pkg->new({
969 'itemdesc' => $taxname,
970 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
971 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
976 warn "adding $taxname\n" if $DEBUG > 1;
977 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
978 if ( ref($taxitem) eq 'FS::cust_bill_pkg' ) {
979 # then we need to transfer the amount and the links from the
980 # line item to the new one we're creating.
981 $tax_total += $taxitem->setup;
982 foreach my $link ( @{ $taxitem->get('cust_bill_pkg_tax_location') } ) {
983 $link->set('tax_cust_bill_pkg', $tax_cust_bill_pkg);
984 push @cust_bill_pkg_tax_location, $link;
988 next if $seen{$taxitem}++;
989 warn "adding $tax_amount{$taxitem}\n" if $DEBUG > 1;
990 $tax_total += $tax_amount{$taxitem};
991 push @cust_bill_pkg_tax_rate_location,
992 map { new FS::cust_bill_pkg_tax_rate_location $_ }
993 @{ $tax_rate_location{ $taxitem } };
996 next unless $tax_total;
998 # we should really neverround this up...I guess it's okay if taxline
999 # already returns amounts with 2 decimal places
1000 $tax_total = sprintf('%.2f', $tax_total );
1001 $tax_cust_bill_pkg->set('setup', $tax_total);
1003 my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
1009 if ( $pkg_category and
1010 $conf->config('invoice_latexsummary') ||
1011 $conf->config('invoice_htmlsummary')
1015 my %hash = ( 'section' => $pkg_category->categoryname );
1016 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
1019 $tax_cust_bill_pkg->set('display', \@display);
1021 push @tax_line_items, $tax_cust_bill_pkg;
1028 my ($self, %params) = @_;
1030 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1032 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
1033 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
1034 my $cust_location = $cust_pkg->tax_location;
1035 my $precommit_hooks = $params{precommit_hooks} or die "no precommit_hooks specified";
1036 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
1037 my $total_setup = $params{setup} or die "no setup accumulator specified";
1038 my $total_recur = $params{recur} or die "no recur accumulator specified";
1039 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
1040 my $time = $params{'time'} or die "no time specified";
1041 my (%options) = %{$params{options}};
1043 if ( $part_pkg->freq ne '1' and ($options{'freq_override'} || 0) > 0 ) {
1044 # this should never happen
1045 die 'freq_override billing attempted on non-monthly package '.
1050 my $real_pkgpart = $params{real_pkgpart};
1051 my %hash = $cust_pkg->hash;
1052 my $old_cust_pkg = new FS::cust_pkg \%hash;
1057 $cust_pkg->pkgpart($part_pkg->pkgpart);
1059 my $cmp_time = ( $conf->exists('next-bill-ignore-time')
1070 my @setup_discounts = ();
1071 my %setup_param = ( 'discounts' => \@setup_discounts );
1072 my $setup_billed_currency = '';
1073 my $setup_billed_amount = 0;
1074 if ( ! $options{recurring_only}
1075 and ! $options{cancel}
1076 and ( $options{'resetup'}
1077 || ( ! $cust_pkg->setup
1078 && ( ! $cust_pkg->start_date
1079 || $cust_pkg->start_date <= $cmp_time
1081 && ( ! $conf->exists('disable_setup_suspended_pkgs')
1082 || ( $conf->exists('disable_setup_suspended_pkgs') &&
1083 ! $cust_pkg->getfield('susp')
1091 warn " bill setup\n" if $DEBUG > 1;
1093 unless ( $cust_pkg->waive_setup ) {
1096 $setup = eval { $cust_pkg->calc_setup( $time, \@details, \%setup_param ) };
1097 return "$@ running calc_setup for $cust_pkg\n"
1100 $unitsetup = $cust_pkg->base_setup()
1103 if ( $setup_param{'billed_currency'} ) {
1104 $setup_billed_currency = delete $setup_param{'billed_currency'};
1105 $setup_billed_amount = delete $setup_param{'billed_amount'};
1109 $cust_pkg->setfield('setup', $time)
1110 unless $cust_pkg->setup;
1111 #do need it, but it won't get written to the db
1112 #|| $cust_pkg->pkgpart != $real_pkgpart;
1114 $cust_pkg->setfield('start_date', '')
1115 if $cust_pkg->start_date;
1120 # bill recurring fee
1125 my @recur_discounts = ();
1126 my $recur_billed_currency = '';
1127 my $recur_billed_amount = 0;
1129 if ( ! $cust_pkg->start_date
1130 and ( ! $cust_pkg->susp || $cust_pkg->option('suspend_bill',1)
1131 || ( $part_pkg->option('suspend_bill', 1) )
1132 && ! $cust_pkg->option('no_suspend_bill',1)
1135 ( $part_pkg->freq ne '0' && ( $cust_pkg->bill || 0 ) <= $cmp_time )
1136 || ( $part_pkg->plan eq 'voip_cdr'
1137 && $part_pkg->option('bill_every_call')
1142 # XXX should this be a package event? probably. events are called
1143 # at collection time at the moment, though...
1144 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
1145 if $part_pkg->can('reset_usage') && !$options{'no_usage_reset'};
1146 #don't want to reset usage just cause we want a line item??
1147 #&& $part_pkg->pkgpart == $real_pkgpart;
1149 warn " bill recur\n" if $DEBUG > 1;
1152 # XXX shared with $recur_prog
1153 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
1157 #over two params! lets at least switch to a hashref for the rest...
1158 my $increment_next_bill = ( $part_pkg->freq ne '0'
1159 && ( $cust_pkg->getfield('bill') || 0 ) <= $cmp_time
1160 && !$options{cancel}
1162 my %param = ( %setup_param,
1163 'precommit_hooks' => $precommit_hooks,
1164 'increment_next_bill' => $increment_next_bill,
1165 'discounts' => \@recur_discounts,
1166 'real_pkgpart' => $real_pkgpart,
1167 'freq_override' => $options{freq_override} || '',
1171 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
1173 # There may be some part_pkg for which this is wrong. Only those
1174 # which can_discount are supported.
1175 # (the UI should prevent adding discounts to these at the moment)
1177 warn "calling $method on cust_pkg ". $cust_pkg->pkgnum.
1178 " for pkgpart ". $cust_pkg->pkgpart.
1179 " with params ". join(' / ', map "$_=>$param{$_}", keys %param). "\n"
1182 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
1183 return "$@ running $method for $cust_pkg\n"
1187 $unitrecur = $cust_pkg->base_recur( \$sdate ) || $recur; #XXX uuh, better
1189 if ( $param{'billed_currency'} ) {
1190 $recur_billed_currency = delete $param{'billed_currency'};
1191 $recur_billed_amount = delete $param{'billed_amount'};
1194 if ( $increment_next_bill ) {
1198 if ( my $main_pkg = $cust_pkg->main_pkg ) {
1199 # supplemental package
1200 # to keep in sync with the main package, simulate billing at
1202 my $main_pkg_freq = $main_pkg->part_pkg->freq;
1203 my $supp_pkg_freq = $part_pkg->freq;
1204 my $ratio = $supp_pkg_freq / $main_pkg_freq;
1205 if ( $ratio != int($ratio) ) {
1206 # the UI should prevent setting up packages like this, but just
1208 return "supplemental package period is not an integer multiple of main package period";
1210 $next_bill = $sdate;
1212 $next_bill = $part_pkg->add_freq( $next_bill, $main_pkg_freq );
1217 $next_bill = $part_pkg->add_freq($sdate, $options{freq_override} || 0);
1218 return "unparsable frequency: ". $part_pkg->freq
1219 if $next_bill == -1;
1222 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
1223 # only for figuring next bill date, nothing else, so, reset $sdate again
1225 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1226 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
1227 $cust_pkg->last_bill($sdate);
1229 $cust_pkg->setfield('bill', $next_bill );
1233 if ( $param{'setup_fee'} ) {
1234 # Add an additional setup fee at the billing stage.
1235 # Used for prorate_defer_bill.
1236 $setup += $param{'setup_fee'};
1237 $unitsetup += $param{'setup_fee'};
1241 if ( defined $param{'discount_left_setup'} ) {
1242 foreach my $discount_setup ( values %{$param{'discount_left_setup'}} ) {
1243 $setup -= $discount_setup;
1249 warn "\$setup is undefined" unless defined($setup);
1250 warn "\$recur is undefined" unless defined($recur);
1251 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1254 # If there's line items, create em cust_bill_pkg records
1255 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
1260 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
1261 # hmm.. and if just the options are modified in some weird price plan?
1263 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
1266 my $error = $cust_pkg->replace( $old_cust_pkg,
1267 'depend_jobnum'=>$options{depend_jobnum},
1268 'options' => { $cust_pkg->options },
1270 unless $options{no_commit};
1271 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
1272 if $error; #just in case
1275 $setup = sprintf( "%.2f", $setup );
1276 $recur = sprintf( "%.2f", $recur );
1277 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
1278 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1280 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
1281 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
1284 my $discount_show_always = $conf->exists('discount-show-always')
1285 && ( ($setup == 0 && scalar(@setup_discounts))
1286 || ($recur == 0 && scalar(@recur_discounts))
1291 || (!$part_pkg->hidden && $options{has_hidden}) #include some $0 lines
1292 || $discount_show_always
1293 || ($setup == 0 && $cust_pkg->_X_show_zero('setup'))
1294 || ($recur == 0 && $cust_pkg->_X_show_zero('recur'))
1298 warn " charges (setup=$setup, recur=$recur); adding line items\n"
1301 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
1303 warn " adding customer package invoice detail: $_\n"
1304 foreach @cust_pkg_detail;
1306 push @details, @cust_pkg_detail;
1308 my $cust_bill_pkg = new FS::cust_bill_pkg {
1309 'pkgnum' => $cust_pkg->pkgnum,
1311 'unitsetup' => $unitsetup,
1312 'setup_billed_currency' => $setup_billed_currency,
1313 'setup_billed_amount' => $setup_billed_amount,
1315 'unitrecur' => $unitrecur,
1316 'recur_billed_currency' => $recur_billed_currency,
1317 'recur_billed_amount' => $recur_billed_amount,
1318 'quantity' => $cust_pkg->quantity,
1319 'details' => \@details,
1320 'discounts' => [ @setup_discounts, @recur_discounts ],
1321 'hidden' => $part_pkg->hidden,
1322 'freq' => $part_pkg->freq,
1325 if ( $part_pkg->option('prorate_defer_bill',1)
1326 and !$hash{last_bill} ) {
1327 # both preceding and upcoming, technically
1328 $cust_bill_pkg->sdate( $cust_pkg->setup );
1329 $cust_bill_pkg->edate( $cust_pkg->bill );
1330 } elsif ( $part_pkg->recur_temporality eq 'preceding' ) {
1331 $cust_bill_pkg->sdate( $hash{last_bill} );
1332 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
1333 $cust_bill_pkg->edate( $time ) if $options{cancel};
1334 } else { #if ( $part_pkg->recur_temporality eq 'upcoming' )
1335 $cust_bill_pkg->sdate( $sdate );
1336 $cust_bill_pkg->edate( $cust_pkg->bill );
1337 #$cust_bill_pkg->edate( $time ) if $options{cancel};
1340 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
1341 unless $part_pkg->pkgpart == $real_pkgpart;
1343 $$total_setup += $setup;
1344 $$total_recur += $recur;
1350 my $error = $self->_handle_taxes( $taxlisthash, $cust_bill_pkg );
1351 return $error if $error;
1353 $cust_bill_pkg->set_display(
1354 part_pkg => $part_pkg,
1355 real_pkgpart => $real_pkgpart,
1358 push @$cust_bill_pkgs, $cust_bill_pkg;
1360 } #if $setup != 0 || $recur != 0
1368 =item _transfer_balance TO_PKG [ FROM_PKGNUM ]
1370 Takes one argument, a cust_pkg object that is being billed. This will
1371 be called only if the package was created by a package change, and has
1372 not been billed since the package change, and package balance tracking
1373 is enabled. The second argument can be an alternate package number to
1374 transfer the balance from; this should not be used externally.
1376 Transfers the balance from the previous package (now canceled) to
1377 this package, by crediting one package and creating an invoice item for
1378 the other. Inserts the credit and returns the invoice item (so that it
1379 can be added to an invoice that's being built).
1381 If the previous package was never billed, and was also created by a package
1382 change, then this will also transfer the balance from I<its> previous
1383 package, and so on, until reaching a package that either has been billed
1384 or was not created by a package change.
1388 my $balance_transfer_reason;
1390 sub _transfer_balance {
1392 my $cust_pkg = shift;
1393 my $from_pkgnum = shift || $cust_pkg->change_pkgnum;
1394 my $from_pkg = FS::cust_pkg->by_key($from_pkgnum);
1398 # if $from_pkg is not the first package in the chain, and it was never
1400 if ( $from_pkg->change_pkgnum and scalar($from_pkg->cust_bill_pkg) == 0 ) {
1401 @transfers = $self->_transfer_balance($cust_pkg, $from_pkg->change_pkgnum);
1404 my $prev_balance = $self->balance_pkgnum($from_pkgnum);
1405 if ( $prev_balance != 0 ) {
1406 $balance_transfer_reason ||= FS::reason->new_or_existing(
1407 'reason' => 'Package balance transfer',
1408 'type' => 'Internal adjustment',
1412 my $credit = FS::cust_credit->new({
1413 'custnum' => $self->custnum,
1414 'amount' => abs($prev_balance),
1415 'reasonnum' => $balance_transfer_reason->reasonnum,
1416 '_date' => $cust_pkg->change_date,
1419 my $cust_bill_pkg = FS::cust_bill_pkg->new({
1421 'recur' => abs($prev_balance),
1422 #'sdate' => $from_pkg->last_bill, # not sure about this
1423 #'edate' => $cust_pkg->change_date,
1424 'itemdesc' => $self->mt('Previous Balance, [_1]',
1425 $from_pkg->part_pkg->pkg),
1428 if ( $prev_balance > 0 ) {
1429 # credit the old package, charge the new one
1430 $credit->set('pkgnum', $from_pkgnum);
1431 $cust_bill_pkg->set('pkgnum', $cust_pkg->pkgnum);
1434 $credit->set('pkgnum', $cust_pkg->pkgnum);
1435 $cust_bill_pkg->set('pkgnum', $from_pkgnum);
1437 my $error = $credit->insert;
1438 die "error transferring package balance from #".$from_pkgnum.
1439 " to #".$cust_pkg->pkgnum.": $error\n" if $error;
1441 push @transfers, $cust_bill_pkg;
1442 } # $prev_balance != 0
1447 =item handle_taxes TAXLISTHASH CUST_BILL_PKG [ OPTIONS ]
1449 This is _handle_taxes. It's called once for each cust_bill_pkg generated
1452 TAXLISTHASH is a hashref shared across the entire invoice. It looks like
1455 'cust_main_county 1001' => [ [FS::cust_main_county], ... ],
1456 'cust_main_county 1002' => [ [FS::cust_main_county], ... ],
1459 'cust_main_county' can also be 'tax_rate'. The first object in the array
1460 is always the cust_main_county or tax_rate identified by the key.
1462 That "..." is a list of FS::cust_bill_pkg objects that will be fed to
1463 the 'taxline' method to calculate the amount of the tax. This doesn't
1464 happen until calculate_taxes, though.
1466 OPTIONS may include:
1467 - part_item: a part_pkg or part_fee object to be used as the package/fee
1469 - location: a cust_location to be used as the billing location.
1471 If not supplied, part_item will be inferred from the pkgnum or feepart of the
1472 cust_bill_pkg, and location from the pkgnum (or, for fees, the invnum and
1473 the customer's default service location).
1479 my $taxlisthash = shift;
1480 my $cust_bill_pkg = shift;
1483 # at this point I realize that we have enough information to infer all this
1484 # stuff, instead of passing around giant honking argument lists
1485 my $location = $options{location} || $cust_bill_pkg->tax_location;
1486 my $part_item = $options{part_item} || $cust_bill_pkg->part_X;
1488 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1490 return if ( $self->payby eq 'COMP' ); #dubious
1492 if ( $conf->exists('enable_taxproducts')
1493 && ( scalar($part_item->part_pkg_taxoverride)
1494 || $part_item->has_taxproduct
1499 # EXTERNAL TAX RATES (via tax_rate)
1500 my %cust_bill_pkg = ();
1504 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
1505 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
1506 push @classes, 'setup' if $cust_bill_pkg->setup;
1507 push @classes, 'recur' if $cust_bill_pkg->recur;
1509 my $exempt = $conf->exists('cust_class-tax_exempt')
1510 ? ( $self->cust_class ? $self->cust_class->tax : '' )
1512 # standardize this just to be sure
1513 $exempt = ($exempt eq 'Y') ? 'Y' : '';
1517 foreach my $class (@classes) {
1518 my $err_or_ref = $self->_gather_taxes($part_item, $class, $location);
1519 return $err_or_ref unless ref($err_or_ref);
1520 $taxes{$class} = $err_or_ref;
1523 unless (exists $taxes{''}) {
1524 my $err_or_ref = $self->_gather_taxes($part_item, '', $location);
1525 return $err_or_ref unless ref($err_or_ref);
1526 $taxes{''} = $err_or_ref;
1531 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate; # grrr
1532 foreach my $key (keys %tax_cust_bill_pkg) {
1533 # $key is "setup", "recur", or a usage class name. ('' is a usage class.)
1534 # $tax_cust_bill_pkg{$key} is a cust_bill_pkg for that component of
1536 # $taxes{$key} is an arrayref of cust_main_county or tax_rate objects that
1537 # apply to $key-class charges.
1538 my @taxes = @{ $taxes{$key} || [] };
1539 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
1541 my %localtaxlisthash = ();
1542 foreach my $tax ( @taxes ) {
1544 # this is the tax identifier, not the taxname
1545 my $taxname = ref( $tax ). ' '. $tax->taxnum;
1546 # $taxlisthash: keys are "setup", "recur", and usage classes.
1547 # Values are arrayrefs, first the tax object (cust_main_county
1548 # or tax_rate) and then any cust_bill_pkg objects that the
1550 $taxlisthash->{ $taxname } ||= [ $tax ];
1551 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
1553 $localtaxlisthash{ $taxname } ||= [ $tax ];
1554 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
1558 warn "finding taxed taxes...\n" if $DEBUG > 2;
1559 foreach my $tax ( keys %localtaxlisthash ) {
1560 my $tax_object = shift @{ $localtaxlisthash{$tax} };
1561 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
1563 next unless $tax_object->can('tax_on_tax');
1565 foreach my $tot ( $tax_object->tax_on_tax( $location ) ) {
1566 my $totname = ref( $tot ). ' '. $tot->taxnum;
1568 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
1570 next unless exists( $localtaxlisthash{ $totname } ); # only increase
1572 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
1573 # calculate the tax amount that the tax_on_tax will apply to
1574 my $hashref_or_error =
1575 $tax_object->taxline( $localtaxlisthash{$tax} );
1576 return $hashref_or_error
1577 unless ref($hashref_or_error);
1579 # and append it to the list of taxable items
1580 $taxlisthash->{ $totname } ||= [ $tot ];
1581 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
1589 # INTERNAL TAX RATES (cust_main_county)
1591 # We fetch taxes even if the customer is completely exempt,
1592 # because we need to record that fact.
1594 my @loc_keys = qw( district city county state country );
1595 my %taxhash = map { $_ => $location->$_ } @loc_keys;
1597 $taxhash{'taxclass'} = $part_item->taxclass;
1599 warn "taxhash:\n". Dumper(\%taxhash) if $DEBUG > 2;
1601 my @taxes = (); # entries are cust_main_county objects
1602 my %taxhash_elim = %taxhash;
1603 my @elim = qw( district city county state );
1606 #first try a match with taxclass
1607 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1609 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1610 #then try a match without taxclass
1611 my %no_taxclass = %taxhash_elim;
1612 $no_taxclass{ 'taxclass' } = '';
1613 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1616 $taxhash_elim{ shift(@elim) } = '';
1618 } while ( !scalar(@taxes) && scalar(@elim) );
1621 my $tax_id = 'cust_main_county '.$_->taxnum;
1622 $taxlisthash->{$tax_id} ||= [ $_ ];
1623 push @{ $taxlisthash->{$tax_id} }, $cust_bill_pkg;
1630 =item _gather_taxes PART_ITEM CLASS CUST_LOCATION
1632 Internal method used with vendor-provided tax tables. PART_ITEM is a part_pkg
1633 or part_fee (which will define the tax eligibility of the product), CLASS is
1634 'setup', 'recur', null, or a C<usage_class> number, and CUST_LOCATION is the
1635 location where the service was provided (or billed, depending on
1636 configuration). Returns an arrayref of L<FS::tax_rate> objects that
1637 can apply to this line item.
1643 my $part_item = shift;
1645 my $location = shift;
1647 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1649 my $geocode = $location->geocode('cch');
1651 [ $part_item->tax_rates('cch', $geocode, $class) ]
1655 =item collect [ HASHREF | OPTION => VALUE ... ]
1657 (Attempt to) collect money for this customer's outstanding invoices (see
1658 L<FS::cust_bill>). Usually used after the bill method.
1660 Actions are now triggered by billing events; see L<FS::part_event> and the
1661 billing events web interface. Old-style invoice events (see
1662 L<FS::part_bill_event>) have been deprecated.
1664 If there is an error, returns the error, otherwise returns false.
1666 Options are passed as name-value pairs.
1668 Currently available options are:
1674 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.
1678 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1682 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1686 set true to surpress email card/ACH decline notices.
1690 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)
1696 # allows for one time override of normal customer billing method
1701 my( $self, %options ) = @_;
1703 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1705 my $invoice_time = $options{'invoice_time'} || time;
1708 local $SIG{HUP} = 'IGNORE';
1709 local $SIG{INT} = 'IGNORE';
1710 local $SIG{QUIT} = 'IGNORE';
1711 local $SIG{TERM} = 'IGNORE';
1712 local $SIG{TSTP} = 'IGNORE';
1713 local $SIG{PIPE} = 'IGNORE';
1715 my $oldAutoCommit = $FS::UID::AutoCommit;
1716 local $FS::UID::AutoCommit = 0;
1719 $self->select_for_update; #mutex
1722 my $balance = $self->balance;
1723 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
1726 if ( exists($options{'retry_card'}) ) {
1727 carp 'retry_card option passed to collect is deprecated; use retry';
1728 $options{'retry'} ||= $options{'retry_card'};
1730 if ( exists($options{'retry'}) && $options{'retry'} ) {
1731 my $error = $self->retry_realtime;
1733 $dbh->rollback if $oldAutoCommit;
1738 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1740 #never want to roll back an event just because it returned an error
1741 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1743 $self->do_cust_event(
1744 'debug' => ( $options{'debug'} || 0 ),
1745 'time' => $invoice_time,
1746 'check_freq' => $options{'check_freq'},
1747 'stage' => 'collect',
1752 =item retry_realtime
1754 Schedules realtime / batch credit card / electronic check / LEC billing
1755 events for for retry. Useful if card information has changed or manual
1756 retry is desired. The 'collect' method must be called to actually retry
1759 Implementation details: For either this customer, or for each of this
1760 customer's open invoices, changes the status of the first "done" (with
1761 statustext error) realtime processing event to "failed".
1765 sub retry_realtime {
1768 local $SIG{HUP} = 'IGNORE';
1769 local $SIG{INT} = 'IGNORE';
1770 local $SIG{QUIT} = 'IGNORE';
1771 local $SIG{TERM} = 'IGNORE';
1772 local $SIG{TSTP} = 'IGNORE';
1773 local $SIG{PIPE} = 'IGNORE';
1775 my $oldAutoCommit = $FS::UID::AutoCommit;
1776 local $FS::UID::AutoCommit = 0;
1779 #a little false laziness w/due_cust_event (not too bad, really)
1781 my $join = FS::part_event_condition->join_conditions_sql;
1782 my $order = FS::part_event_condition->order_conditions_sql;
1785 . join ( ' OR ' , map {
1786 my $cust_join = FS::part_event->eventtables_cust_join->{$_} || '';
1787 my $custnum = FS::part_event->eventtables_custnum->{$_};
1788 "( part_event.eventtable = " . dbh->quote($_)
1789 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key
1790 . " from $_ $cust_join"
1791 . " where $custnum = " . dbh->quote( $self->custnum ) . "))" ;
1792 } FS::part_event->eventtables)
1795 #here is the agent virtualization
1796 my $agent_virt = " ( part_event.agentnum IS NULL
1797 OR part_event.agentnum = ". $self->agentnum. ' )';
1799 #XXX this shouldn't be hardcoded, actions should declare it...
1800 my @realtime_events = qw(
1801 cust_bill_realtime_card
1802 cust_bill_realtime_check
1803 cust_bill_realtime_lec
1807 my $is_realtime_event =
1808 ' part_event.action IN ( '.
1809 join(',', map "'$_'", @realtime_events ).
1812 my $batch_or_statustext =
1813 "( part_event.action = 'cust_bill_batch'
1814 OR ( statustext IS NOT NULL AND statustext != '' )
1818 my @cust_event = qsearch({
1819 'table' => 'cust_event',
1820 'select' => 'cust_event.*',
1821 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
1822 'hashref' => { 'status' => 'done' },
1823 'extra_sql' => " AND $batch_or_statustext ".
1824 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
1827 my %seen_invnum = ();
1828 foreach my $cust_event (@cust_event) {
1830 #max one for the customer, one for each open invoice
1831 my $cust_X = $cust_event->cust_X;
1832 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
1836 or $cust_event->part_event->eventtable eq 'cust_bill'
1839 my $error = $cust_event->retry;
1841 $dbh->rollback if $oldAutoCommit;
1842 return "error scheduling event for retry: $error";
1847 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1852 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
1854 Runs billing events; see L<FS::part_event> and the billing events web
1857 If there is an error, returns the error, otherwise returns false.
1859 Options are passed as name-value pairs.
1861 Currently available options are:
1867 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.
1871 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1875 "collect" (the default) or "pre-bill"
1879 set true to surpress email card/ACH decline notices.
1883 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)
1890 # allows for one time override of normal customer billing method
1894 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1897 my( $self, %options ) = @_;
1899 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1901 my $time = $options{'time'} || time;
1904 local $SIG{HUP} = 'IGNORE';
1905 local $SIG{INT} = 'IGNORE';
1906 local $SIG{QUIT} = 'IGNORE';
1907 local $SIG{TERM} = 'IGNORE';
1908 local $SIG{TSTP} = 'IGNORE';
1909 local $SIG{PIPE} = 'IGNORE';
1911 my $oldAutoCommit = $FS::UID::AutoCommit;
1912 local $FS::UID::AutoCommit = 0;
1915 $self->select_for_update; #mutex
1918 my $balance = $self->balance;
1919 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
1922 # if ( exists($options{'retry_card'}) ) {
1923 # carp 'retry_card option passed to collect is deprecated; use retry';
1924 # $options{'retry'} ||= $options{'retry_card'};
1926 # if ( exists($options{'retry'}) && $options{'retry'} ) {
1927 # my $error = $self->retry_realtime;
1929 # $dbh->rollback if $oldAutoCommit;
1934 # false laziness w/pay_batch::import_results
1936 my $due_cust_event = $self->due_cust_event(
1937 'debug' => ( $options{'debug'} || 0 ),
1939 'check_freq' => $options{'check_freq'},
1940 'stage' => ( $options{'stage'} || 'collect' ),
1942 unless( ref($due_cust_event) ) {
1943 $dbh->rollback if $oldAutoCommit;
1944 return $due_cust_event;
1947 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1948 #never want to roll back an event just because it or a different one
1950 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1952 foreach my $cust_event ( @$due_cust_event ) {
1956 #re-eval event conditions (a previous event could have changed things)
1957 unless ( $cust_event->test_conditions ) {
1958 #don't leave stray "new/locked" records around
1959 my $error = $cust_event->delete;
1960 return $error if $error;
1965 local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
1966 if $options{'quiet'};
1967 warn " running cust_event ". $cust_event->eventnum. "\n"
1970 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
1971 if ( my $error = $cust_event->do_event( 'time' => $time ) ) {
1972 #XXX wtf is this? figure out a proper dealio with return value
1984 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
1986 Inserts database records for and returns an ordered listref of new events due
1987 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
1988 events are due, an empty listref is returned. If there is an error, returns a
1989 scalar error message.
1991 To actually run the events, call each event's test_condition method, and if
1992 still true, call the event's do_event method.
1994 Options are passed as a hashref or as a list of name-value pairs. Available
2001 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.
2005 "collect" (the default) or "pre-bill"
2009 "Current time" for the events.
2013 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)
2017 Only return events for the specified eventtable (by default, events of all eventtables are returned)
2021 Explicitly pass the objects to be tested (typically used with eventtable).
2025 Set to true to return the objects, but not actually insert them into the
2032 sub due_cust_event {
2034 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
2037 #my $DEBUG = $opt{'debug'}
2038 $opt{'debug'} ||= 0; # silence some warnings
2039 local($DEBUG) = $opt{'debug'}
2040 if $opt{'debug'} > $DEBUG;
2041 $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
2043 warn "$me due_cust_event called with options ".
2044 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
2047 $opt{'time'} ||= time;
2049 local $SIG{HUP} = 'IGNORE';
2050 local $SIG{INT} = 'IGNORE';
2051 local $SIG{QUIT} = 'IGNORE';
2052 local $SIG{TERM} = 'IGNORE';
2053 local $SIG{TSTP} = 'IGNORE';
2054 local $SIG{PIPE} = 'IGNORE';
2056 my $oldAutoCommit = $FS::UID::AutoCommit;
2057 local $FS::UID::AutoCommit = 0;
2060 $self->select_for_update #mutex
2061 unless $opt{testonly};
2064 # find possible events (initial search)
2067 my @cust_event = ();
2069 my @eventtable = $opt{'eventtable'}
2070 ? ( $opt{'eventtable'} )
2071 : FS::part_event->eventtables_runorder;
2073 my $check_freq = $opt{'check_freq'} || '1d';
2075 foreach my $eventtable ( @eventtable ) {
2078 if ( $opt{'objects'} ) {
2080 @objects = @{ $opt{'objects'} };
2082 } elsif ( $eventtable eq 'cust_main' ) {
2084 @objects = ( $self );
2088 my $cm_join = " LEFT JOIN cust_main USING ( custnum )";
2089 # linkage not needed here because FS::cust_main->$eventtable will
2092 #some false laziness w/Cron::bill bill_where
2094 my $join = FS::part_event_condition->join_conditions_sql( $eventtable);
2095 my $where = FS::part_event_condition->where_conditions_sql($eventtable,
2096 'time'=>$opt{'time'},
2098 $where = $where ? "AND $where" : '';
2100 my $are_part_event =
2101 "EXISTS ( SELECT 1 FROM part_event $join
2102 WHERE check_freq = '$check_freq'
2103 AND eventtable = '$eventtable'
2104 AND ( disabled = '' OR disabled IS NULL )
2110 @objects = $self->$eventtable(
2111 'addl_from' => $cm_join,
2112 'extra_sql' => " AND $are_part_event",
2114 } # if ( !$opt{objects} and $eventtable ne 'cust_main' )
2116 my @e_cust_event = ();
2118 my $linkage = FS::part_event->eventtables_cust_join->{$eventtable} || '';
2120 my $cross = "CROSS JOIN $eventtable $linkage";
2121 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
2122 unless $eventtable eq 'cust_main';
2124 foreach my $object ( @objects ) {
2126 #this first search uses the condition_sql magic for optimization.
2127 #the more possible events we can eliminate in this step the better
2129 my $cross_where = '';
2130 my $pkey = $object->primary_key;
2131 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
2133 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
2135 FS::part_event_condition->where_conditions_sql( $eventtable,
2136 'time'=>$opt{'time'}
2138 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
2140 $extra_sql = "AND $extra_sql" if $extra_sql;
2142 #here is the agent virtualization
2143 $extra_sql .= " AND ( part_event.agentnum IS NULL
2144 OR part_event.agentnum = ". $self->agentnum. ' )';
2146 $extra_sql .= " $order";
2148 warn "searching for events for $eventtable ". $object->$pkey. "\n"
2149 if $opt{'debug'} > 2;
2150 my @part_event = qsearch( {
2151 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
2152 'select' => 'part_event.*',
2153 'table' => 'part_event',
2154 'addl_from' => "$cross $join",
2155 'hashref' => { 'check_freq' => $check_freq,
2156 'eventtable' => $eventtable,
2159 'extra_sql' => "AND $cross_where $extra_sql",
2163 my $pkey = $object->primary_key;
2164 warn " ". scalar(@part_event).
2165 " possible events found for $eventtable ". $object->$pkey(). "\n";
2168 push @e_cust_event, map {
2169 $_->new_cust_event($object, 'time' => $opt{'time'})
2174 warn " ". scalar(@e_cust_event).
2175 " subtotal possible cust events found for $eventtable\n"
2178 push @cust_event, @e_cust_event;
2182 warn " ". scalar(@cust_event).
2183 " total possible cust events found in initial search\n"
2191 $opt{stage} ||= 'collect';
2193 grep { my $stage = $_->part_event->event_stage;
2194 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
2204 @cust_event = grep $_->test_conditions( 'stats_hashref' => \%unsat ),
2207 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
2210 warn " invalid conditions not eliminated with condition_sql:\n".
2211 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
2212 if keys %unsat && $DEBUG; # > 1;
2218 unless( $opt{testonly} ) {
2219 foreach my $cust_event ( @cust_event ) {
2221 my $error = $cust_event->insert();
2223 $dbh->rollback if $oldAutoCommit;
2230 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2236 warn " returning events: ". Dumper(@cust_event). "\n"
2243 =item apply_payments_and_credits [ OPTION => VALUE ... ]
2245 Applies unapplied payments and credits.
2247 In most cases, this new method should be used in place of sequential
2248 apply_payments and apply_credits methods.
2250 A hash of optional arguments may be passed. Currently "manual" is supported.
2251 If true, a payment receipt is sent instead of a statement when
2252 'payment_receipt_email' configuration option is set.
2254 If there is an error, returns the error, otherwise returns false.
2258 sub apply_payments_and_credits {
2259 my( $self, %options ) = @_;
2261 local $SIG{HUP} = 'IGNORE';
2262 local $SIG{INT} = 'IGNORE';
2263 local $SIG{QUIT} = 'IGNORE';
2264 local $SIG{TERM} = 'IGNORE';
2265 local $SIG{TSTP} = 'IGNORE';
2266 local $SIG{PIPE} = 'IGNORE';
2268 my $oldAutoCommit = $FS::UID::AutoCommit;
2269 local $FS::UID::AutoCommit = 0;
2272 $self->select_for_update; #mutex
2274 foreach my $cust_bill ( $self->open_cust_bill ) {
2275 my $error = $cust_bill->apply_payments_and_credits(%options);
2277 $dbh->rollback if $oldAutoCommit;
2278 return "Error applying: $error";
2282 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2287 =item apply_credits OPTION => VALUE ...
2289 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
2290 to outstanding invoice balances in chronological order (or reverse
2291 chronological order if the I<order> option is set to B<newest>) and returns the
2292 value of any remaining unapplied credits available for refund (see
2293 L<FS::cust_refund>).
2295 Dies if there is an error.
2303 local $SIG{HUP} = 'IGNORE';
2304 local $SIG{INT} = 'IGNORE';
2305 local $SIG{QUIT} = 'IGNORE';
2306 local $SIG{TERM} = 'IGNORE';
2307 local $SIG{TSTP} = 'IGNORE';
2308 local $SIG{PIPE} = 'IGNORE';
2310 my $oldAutoCommit = $FS::UID::AutoCommit;
2311 local $FS::UID::AutoCommit = 0;
2314 $self->select_for_update; #mutex
2316 unless ( $self->total_unapplied_credits ) {
2317 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2321 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
2322 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
2324 my @invoices = $self->open_cust_bill;
2325 @invoices = sort { $b->_date <=> $a->_date } @invoices
2326 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
2328 if ( $conf->exists('pkg-balances') ) {
2329 # limit @credits to those w/ a pkgnum grepped from $self
2331 foreach my $i (@invoices) {
2332 foreach my $li ( $i->cust_bill_pkg ) {
2333 $pkgnums{$li->pkgnum} = 1;
2336 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
2341 foreach my $cust_bill ( @invoices ) {
2343 if ( !defined($credit) || $credit->credited == 0) {
2344 $credit = pop @credits or last;
2348 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
2349 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
2351 $owed = $cust_bill->owed;
2353 unless ( $owed > 0 ) {
2354 push @credits, $credit;
2358 my $amount = min( $credit->credited, $owed );
2360 my $cust_credit_bill = new FS::cust_credit_bill ( {
2361 'crednum' => $credit->crednum,
2362 'invnum' => $cust_bill->invnum,
2363 'amount' => $amount,
2365 $cust_credit_bill->pkgnum( $credit->pkgnum )
2366 if $conf->exists('pkg-balances') && $credit->pkgnum;
2367 my $error = $cust_credit_bill->insert;
2369 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2373 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2377 my $total_unapplied_credits = $self->total_unapplied_credits;
2379 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2381 return $total_unapplied_credits;
2384 =item apply_payments [ OPTION => VALUE ... ]
2386 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2387 to outstanding invoice balances in chronological order.
2389 #and returns the value of any remaining unapplied payments.
2391 A hash of optional arguments may be passed. Currently "manual" is supported.
2392 If true, a payment receipt is sent instead of a statement when
2393 'payment_receipt_email' configuration option is set.
2395 Dies if there is an error.
2399 sub apply_payments {
2400 my( $self, %options ) = @_;
2402 local $SIG{HUP} = 'IGNORE';
2403 local $SIG{INT} = 'IGNORE';
2404 local $SIG{QUIT} = 'IGNORE';
2405 local $SIG{TERM} = 'IGNORE';
2406 local $SIG{TSTP} = 'IGNORE';
2407 local $SIG{PIPE} = 'IGNORE';
2409 my $oldAutoCommit = $FS::UID::AutoCommit;
2410 local $FS::UID::AutoCommit = 0;
2413 $self->select_for_update; #mutex
2417 my @payments = sort { $b->_date <=> $a->_date }
2418 grep { $_->unapplied > 0 }
2421 my @invoices = sort { $a->_date <=> $b->_date}
2422 grep { $_->owed > 0 }
2425 if ( $conf->exists('pkg-balances') ) {
2426 # limit @payments to those w/ a pkgnum grepped from $self
2428 foreach my $i (@invoices) {
2429 foreach my $li ( $i->cust_bill_pkg ) {
2430 $pkgnums{$li->pkgnum} = 1;
2433 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
2438 foreach my $cust_bill ( @invoices ) {
2440 if ( !defined($payment) || $payment->unapplied == 0 ) {
2441 $payment = pop @payments or last;
2445 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
2446 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
2448 $owed = $cust_bill->owed;
2450 unless ( $owed > 0 ) {
2451 push @payments, $payment;
2455 my $amount = min( $payment->unapplied, $owed );
2458 'paynum' => $payment->paynum,
2459 'invnum' => $cust_bill->invnum,
2460 'amount' => $amount,
2462 $cbp->{_date} = $payment->_date
2463 if $options{'manual'} && $options{'backdate_application'};
2464 my $cust_bill_pay = new FS::cust_bill_pay($cbp);
2465 $cust_bill_pay->pkgnum( $payment->pkgnum )
2466 if $conf->exists('pkg-balances') && $payment->pkgnum;
2467 my $error = $cust_bill_pay->insert(%options);
2469 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2473 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2477 my $total_unapplied_payments = $self->total_unapplied_payments;
2479 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2481 return $total_unapplied_payments;
2491 suspend_adjourned_pkgs
2492 unsuspend_resumed_pkgs
2495 (do_cust_event pre-bill)
2498 (vendor-only) _gather_taxes
2499 _omit_zero_value_bundles
2500 _handle_taxes (for fees)
2503 apply_payments_and_credits
2512 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>