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 if ( ! $options{recurring_only}
1073 and ! $options{cancel}
1074 and ( $options{'resetup'}
1075 || ( ! $cust_pkg->setup
1076 && ( ! $cust_pkg->start_date
1077 || $cust_pkg->start_date <= $cmp_time
1079 && ( ! $conf->exists('disable_setup_suspended_pkgs')
1080 || ( $conf->exists('disable_setup_suspended_pkgs') &&
1081 ! $cust_pkg->getfield('susp')
1089 warn " bill setup\n" if $DEBUG > 1;
1091 unless ( $cust_pkg->waive_setup ) {
1094 $setup = eval { $cust_pkg->calc_setup( $time, \@details, \%setup_param ) };
1095 return "$@ running calc_setup for $cust_pkg\n"
1098 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
1101 $cust_pkg->setfield('setup', $time)
1102 unless $cust_pkg->setup;
1103 #do need it, but it won't get written to the db
1104 #|| $cust_pkg->pkgpart != $real_pkgpart;
1106 $cust_pkg->setfield('start_date', '')
1107 if $cust_pkg->start_date;
1112 # bill recurring fee
1117 my @recur_discounts = ();
1119 if ( ! $cust_pkg->start_date
1120 and ( ! $cust_pkg->susp || $cust_pkg->option('suspend_bill',1)
1121 || ( $part_pkg->option('suspend_bill', 1) )
1122 && ! $cust_pkg->option('no_suspend_bill',1)
1125 ( $part_pkg->freq ne '0' && ( $cust_pkg->bill || 0 ) <= $cmp_time )
1126 || ( $part_pkg->plan eq 'voip_cdr'
1127 && $part_pkg->option('bill_every_call')
1132 # XXX should this be a package event? probably. events are called
1133 # at collection time at the moment, though...
1134 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
1135 if $part_pkg->can('reset_usage') && !$options{'no_usage_reset'};
1136 #don't want to reset usage just cause we want a line item??
1137 #&& $part_pkg->pkgpart == $real_pkgpart;
1139 warn " bill recur\n" if $DEBUG > 1;
1142 # XXX shared with $recur_prog
1143 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
1147 #over two params! lets at least switch to a hashref for the rest...
1148 my $increment_next_bill = ( $part_pkg->freq ne '0'
1149 && ( $cust_pkg->getfield('bill') || 0 ) <= $cmp_time
1150 && !$options{cancel}
1152 my %param = ( %setup_param,
1153 'precommit_hooks' => $precommit_hooks,
1154 'increment_next_bill' => $increment_next_bill,
1155 'discounts' => \@recur_discounts,
1156 'real_pkgpart' => $real_pkgpart,
1157 'freq_override' => $options{freq_override} || '',
1161 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
1163 # There may be some part_pkg for which this is wrong. Only those
1164 # which can_discount are supported.
1165 # (the UI should prevent adding discounts to these at the moment)
1167 warn "calling $method on cust_pkg ". $cust_pkg->pkgnum.
1168 " for pkgpart ". $cust_pkg->pkgpart.
1169 " with params ". join(' / ', map "$_=>$param{$_}", keys %param). "\n"
1172 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
1173 return "$@ running $method for $cust_pkg\n"
1177 $unitrecur = $cust_pkg->base_recur( \$sdate ) || $recur; #XXX uuh, better
1179 if ( $increment_next_bill ) {
1183 if ( my $main_pkg = $cust_pkg->main_pkg ) {
1184 # supplemental package
1185 # to keep in sync with the main package, simulate billing at
1187 my $main_pkg_freq = $main_pkg->part_pkg->freq;
1188 my $supp_pkg_freq = $part_pkg->freq;
1189 my $ratio = $supp_pkg_freq / $main_pkg_freq;
1190 if ( $ratio != int($ratio) ) {
1191 # the UI should prevent setting up packages like this, but just
1193 return "supplemental package period is not an integer multiple of main package period";
1195 $next_bill = $sdate;
1197 $next_bill = $part_pkg->add_freq( $next_bill, $main_pkg_freq );
1202 $next_bill = $part_pkg->add_freq($sdate, $options{freq_override} || 0);
1203 return "unparsable frequency: ". $part_pkg->freq
1204 if $next_bill == -1;
1207 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
1208 # only for figuring next bill date, nothing else, so, reset $sdate again
1210 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1211 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
1212 $cust_pkg->last_bill($sdate);
1214 $cust_pkg->setfield('bill', $next_bill );
1218 if ( $param{'setup_fee'} ) {
1219 # Add an additional setup fee at the billing stage.
1220 # Used for prorate_defer_bill.
1221 $setup += $param{'setup_fee'};
1222 $unitsetup += $param{'setup_fee'};
1226 if ( defined $param{'discount_left_setup'} ) {
1227 foreach my $discount_setup ( values %{$param{'discount_left_setup'}} ) {
1228 $setup -= $discount_setup;
1234 warn "\$setup is undefined" unless defined($setup);
1235 warn "\$recur is undefined" unless defined($recur);
1236 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1239 # If there's line items, create em cust_bill_pkg records
1240 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
1245 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
1246 # hmm.. and if just the options are modified in some weird price plan?
1248 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
1251 my $error = $cust_pkg->replace( $old_cust_pkg,
1252 'depend_jobnum'=>$options{depend_jobnum},
1253 'options' => { $cust_pkg->options },
1255 unless $options{no_commit};
1256 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
1257 if $error; #just in case
1260 $setup = sprintf( "%.2f", $setup );
1261 $recur = sprintf( "%.2f", $recur );
1262 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
1263 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1265 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
1266 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
1269 my $discount_show_always = $conf->exists('discount-show-always')
1270 && ( ($setup == 0 && scalar(@setup_discounts))
1271 || ($recur == 0 && scalar(@recur_discounts))
1276 || (!$part_pkg->hidden && $options{has_hidden}) #include some $0 lines
1277 || $discount_show_always
1278 || ($setup == 0 && $cust_pkg->_X_show_zero('setup'))
1279 || ($recur == 0 && $cust_pkg->_X_show_zero('recur'))
1283 warn " charges (setup=$setup, recur=$recur); adding line items\n"
1286 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
1288 warn " adding customer package invoice detail: $_\n"
1289 foreach @cust_pkg_detail;
1291 push @details, @cust_pkg_detail;
1293 my $cust_bill_pkg = new FS::cust_bill_pkg {
1294 'pkgnum' => $cust_pkg->pkgnum,
1296 'unitsetup' => $unitsetup,
1298 'unitrecur' => $unitrecur,
1299 'quantity' => $cust_pkg->quantity,
1300 'details' => \@details,
1301 'discounts' => [ @setup_discounts, @recur_discounts ],
1302 'hidden' => $part_pkg->hidden,
1303 'freq' => $part_pkg->freq,
1306 if ( $part_pkg->option('prorate_defer_bill',1)
1307 and !$hash{last_bill} ) {
1308 # both preceding and upcoming, technically
1309 $cust_bill_pkg->sdate( $cust_pkg->setup );
1310 $cust_bill_pkg->edate( $cust_pkg->bill );
1311 } elsif ( $part_pkg->recur_temporality eq 'preceding' ) {
1312 $cust_bill_pkg->sdate( $hash{last_bill} );
1313 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
1314 $cust_bill_pkg->edate( $time ) if $options{cancel};
1315 } else { #if ( $part_pkg->recur_temporality eq 'upcoming' ) {
1316 $cust_bill_pkg->sdate( $sdate );
1317 $cust_bill_pkg->edate( $cust_pkg->bill );
1318 #$cust_bill_pkg->edate( $time ) if $options{cancel};
1321 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
1322 unless $part_pkg->pkgpart == $real_pkgpart;
1324 $$total_setup += $setup;
1325 $$total_recur += $recur;
1331 my $error = $self->_handle_taxes( $taxlisthash, $cust_bill_pkg );
1332 return $error if $error;
1334 $cust_bill_pkg->set_display(
1335 part_pkg => $part_pkg,
1336 real_pkgpart => $real_pkgpart,
1339 push @$cust_bill_pkgs, $cust_bill_pkg;
1341 } #if $setup != 0 || $recur != 0
1349 =item _transfer_balance TO_PKG [ FROM_PKGNUM ]
1351 Takes one argument, a cust_pkg object that is being billed. This will
1352 be called only if the package was created by a package change, and has
1353 not been billed since the package change, and package balance tracking
1354 is enabled. The second argument can be an alternate package number to
1355 transfer the balance from; this should not be used externally.
1357 Transfers the balance from the previous package (now canceled) to
1358 this package, by crediting one package and creating an invoice item for
1359 the other. Inserts the credit and returns the invoice item (so that it
1360 can be added to an invoice that's being built).
1362 If the previous package was never billed, and was also created by a package
1363 change, then this will also transfer the balance from I<its> previous
1364 package, and so on, until reaching a package that either has been billed
1365 or was not created by a package change.
1369 my $balance_transfer_reason;
1371 sub _transfer_balance {
1373 my $cust_pkg = shift;
1374 my $from_pkgnum = shift || $cust_pkg->change_pkgnum;
1375 my $from_pkg = FS::cust_pkg->by_key($from_pkgnum);
1379 # if $from_pkg is not the first package in the chain, and it was never
1381 if ( $from_pkg->change_pkgnum and scalar($from_pkg->cust_bill_pkg) == 0 ) {
1382 @transfers = $self->_transfer_balance($cust_pkg, $from_pkg->change_pkgnum);
1385 my $prev_balance = $self->balance_pkgnum($from_pkgnum);
1386 if ( $prev_balance != 0 ) {
1387 $balance_transfer_reason ||= FS::reason->new_or_existing(
1388 'reason' => 'Package balance transfer',
1389 'type' => 'Internal adjustment',
1393 my $credit = FS::cust_credit->new({
1394 'custnum' => $self->custnum,
1395 'amount' => abs($prev_balance),
1396 'reasonnum' => $balance_transfer_reason->reasonnum,
1397 '_date' => $cust_pkg->change_date,
1400 my $cust_bill_pkg = FS::cust_bill_pkg->new({
1402 'recur' => abs($prev_balance),
1403 #'sdate' => $from_pkg->last_bill, # not sure about this
1404 #'edate' => $cust_pkg->change_date,
1405 'itemdesc' => $self->mt('Previous Balance, [_1]',
1406 $from_pkg->part_pkg->pkg),
1409 if ( $prev_balance > 0 ) {
1410 # credit the old package, charge the new one
1411 $credit->set('pkgnum', $from_pkgnum);
1412 $cust_bill_pkg->set('pkgnum', $cust_pkg->pkgnum);
1415 $credit->set('pkgnum', $cust_pkg->pkgnum);
1416 $cust_bill_pkg->set('pkgnum', $from_pkgnum);
1418 my $error = $credit->insert;
1419 die "error transferring package balance from #".$from_pkgnum.
1420 " to #".$cust_pkg->pkgnum.": $error\n" if $error;
1422 push @transfers, $cust_bill_pkg;
1423 } # $prev_balance != 0
1428 =item handle_taxes TAXLISTHASH CUST_BILL_PKG [ OPTIONS ]
1430 This is _handle_taxes. It's called once for each cust_bill_pkg generated
1433 TAXLISTHASH is a hashref shared across the entire invoice. It looks like
1436 'cust_main_county 1001' => [ [FS::cust_main_county], ... ],
1437 'cust_main_county 1002' => [ [FS::cust_main_county], ... ],
1440 'cust_main_county' can also be 'tax_rate'. The first object in the array
1441 is always the cust_main_county or tax_rate identified by the key.
1443 That "..." is a list of FS::cust_bill_pkg objects that will be fed to
1444 the 'taxline' method to calculate the amount of the tax. This doesn't
1445 happen until calculate_taxes, though.
1447 OPTIONS may include:
1448 - part_item: a part_pkg or part_fee object to be used as the package/fee
1450 - location: a cust_location to be used as the billing location.
1452 If not supplied, part_item will be inferred from the pkgnum or feepart of the
1453 cust_bill_pkg, and location from the pkgnum (or, for fees, the invnum and
1454 the customer's default service location).
1460 my $taxlisthash = shift;
1461 my $cust_bill_pkg = shift;
1464 # at this point I realize that we have enough information to infer all this
1465 # stuff, instead of passing around giant honking argument lists
1466 my $location = $options{location} || $cust_bill_pkg->tax_location;
1467 my $part_item = $options{part_item} || $cust_bill_pkg->part_X;
1469 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1471 return if ( $self->payby eq 'COMP' ); #dubious
1473 if ( $conf->exists('enable_taxproducts')
1474 && ( scalar($part_item->part_pkg_taxoverride)
1475 || $part_item->has_taxproduct
1480 # EXTERNAL TAX RATES (via tax_rate)
1481 my %cust_bill_pkg = ();
1485 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
1486 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
1487 push @classes, 'setup' if $cust_bill_pkg->setup;
1488 push @classes, 'recur' if $cust_bill_pkg->recur;
1490 my $exempt = $conf->exists('cust_class-tax_exempt')
1491 ? ( $self->cust_class ? $self->cust_class->tax : '' )
1493 # standardize this just to be sure
1494 $exempt = ($exempt eq 'Y') ? 'Y' : '';
1498 foreach my $class (@classes) {
1499 my $err_or_ref = $self->_gather_taxes($part_item, $class, $location);
1500 return $err_or_ref unless ref($err_or_ref);
1501 $taxes{$class} = $err_or_ref;
1504 unless (exists $taxes{''}) {
1505 my $err_or_ref = $self->_gather_taxes($part_item, '', $location);
1506 return $err_or_ref unless ref($err_or_ref);
1507 $taxes{''} = $err_or_ref;
1512 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate; # grrr
1513 foreach my $key (keys %tax_cust_bill_pkg) {
1514 # $key is "setup", "recur", or a usage class name. ('' is a usage class.)
1515 # $tax_cust_bill_pkg{$key} is a cust_bill_pkg for that component of
1517 # $taxes{$key} is an arrayref of cust_main_county or tax_rate objects that
1518 # apply to $key-class charges.
1519 my @taxes = @{ $taxes{$key} || [] };
1520 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
1522 my %localtaxlisthash = ();
1523 foreach my $tax ( @taxes ) {
1525 # this is the tax identifier, not the taxname
1526 my $taxname = ref( $tax ). ' '. $tax->taxnum;
1527 # $taxlisthash: keys are "setup", "recur", and usage classes.
1528 # Values are arrayrefs, first the tax object (cust_main_county
1529 # or tax_rate) and then any cust_bill_pkg objects that the
1531 $taxlisthash->{ $taxname } ||= [ $tax ];
1532 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
1534 $localtaxlisthash{ $taxname } ||= [ $tax ];
1535 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
1539 warn "finding taxed taxes...\n" if $DEBUG > 2;
1540 foreach my $tax ( keys %localtaxlisthash ) {
1541 my $tax_object = shift @{ $localtaxlisthash{$tax} };
1542 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
1544 next unless $tax_object->can('tax_on_tax');
1546 foreach my $tot ( $tax_object->tax_on_tax( $location ) ) {
1547 my $totname = ref( $tot ). ' '. $tot->taxnum;
1549 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
1551 next unless exists( $localtaxlisthash{ $totname } ); # only increase
1553 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
1554 # calculate the tax amount that the tax_on_tax will apply to
1555 my $hashref_or_error =
1556 $tax_object->taxline( $localtaxlisthash{$tax} );
1557 return $hashref_or_error
1558 unless ref($hashref_or_error);
1560 # and append it to the list of taxable items
1561 $taxlisthash->{ $totname } ||= [ $tot ];
1562 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
1570 # INTERNAL TAX RATES (cust_main_county)
1572 # We fetch taxes even if the customer is completely exempt,
1573 # because we need to record that fact.
1575 my @loc_keys = qw( district city county state country );
1576 my %taxhash = map { $_ => $location->$_ } @loc_keys;
1578 $taxhash{'taxclass'} = $part_item->taxclass;
1580 warn "taxhash:\n". Dumper(\%taxhash) if $DEBUG > 2;
1582 my @taxes = (); # entries are cust_main_county objects
1583 my %taxhash_elim = %taxhash;
1584 my @elim = qw( district city county state );
1587 #first try a match with taxclass
1588 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1590 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1591 #then try a match without taxclass
1592 my %no_taxclass = %taxhash_elim;
1593 $no_taxclass{ 'taxclass' } = '';
1594 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1597 $taxhash_elim{ shift(@elim) } = '';
1599 } while ( !scalar(@taxes) && scalar(@elim) );
1602 my $tax_id = 'cust_main_county '.$_->taxnum;
1603 $taxlisthash->{$tax_id} ||= [ $_ ];
1604 push @{ $taxlisthash->{$tax_id} }, $cust_bill_pkg;
1611 =item _gather_taxes PART_ITEM CLASS CUST_LOCATION
1613 Internal method used with vendor-provided tax tables. PART_ITEM is a part_pkg
1614 or part_fee (which will define the tax eligibility of the product), CLASS is
1615 'setup', 'recur', null, or a C<usage_class> number, and CUST_LOCATION is the
1616 location where the service was provided (or billed, depending on
1617 configuration). Returns an arrayref of L<FS::tax_rate> objects that
1618 can apply to this line item.
1624 my $part_item = shift;
1626 my $location = shift;
1628 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1630 my $geocode = $location->geocode('cch');
1632 [ $part_item->tax_rates('cch', $geocode, $class) ]
1636 =item collect [ HASHREF | OPTION => VALUE ... ]
1638 (Attempt to) collect money for this customer's outstanding invoices (see
1639 L<FS::cust_bill>). Usually used after the bill method.
1641 Actions are now triggered by billing events; see L<FS::part_event> and the
1642 billing events web interface. Old-style invoice events (see
1643 L<FS::part_bill_event>) have been deprecated.
1645 If there is an error, returns the error, otherwise returns false.
1647 Options are passed as name-value pairs.
1649 Currently available options are:
1655 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.
1659 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1663 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1667 set true to surpress email card/ACH decline notices.
1671 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)
1677 # allows for one time override of normal customer billing method
1682 my( $self, %options ) = @_;
1684 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1686 my $invoice_time = $options{'invoice_time'} || time;
1689 local $SIG{HUP} = 'IGNORE';
1690 local $SIG{INT} = 'IGNORE';
1691 local $SIG{QUIT} = 'IGNORE';
1692 local $SIG{TERM} = 'IGNORE';
1693 local $SIG{TSTP} = 'IGNORE';
1694 local $SIG{PIPE} = 'IGNORE';
1696 my $oldAutoCommit = $FS::UID::AutoCommit;
1697 local $FS::UID::AutoCommit = 0;
1700 $self->select_for_update; #mutex
1703 my $balance = $self->balance;
1704 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
1707 if ( exists($options{'retry_card'}) ) {
1708 carp 'retry_card option passed to collect is deprecated; use retry';
1709 $options{'retry'} ||= $options{'retry_card'};
1711 if ( exists($options{'retry'}) && $options{'retry'} ) {
1712 my $error = $self->retry_realtime;
1714 $dbh->rollback if $oldAutoCommit;
1719 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1721 #never want to roll back an event just because it returned an error
1722 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1724 $self->do_cust_event(
1725 'debug' => ( $options{'debug'} || 0 ),
1726 'time' => $invoice_time,
1727 'check_freq' => $options{'check_freq'},
1728 'stage' => 'collect',
1733 =item retry_realtime
1735 Schedules realtime / batch credit card / electronic check / LEC billing
1736 events for for retry. Useful if card information has changed or manual
1737 retry is desired. The 'collect' method must be called to actually retry
1740 Implementation details: For either this customer, or for each of this
1741 customer's open invoices, changes the status of the first "done" (with
1742 statustext error) realtime processing event to "failed".
1746 sub retry_realtime {
1749 local $SIG{HUP} = 'IGNORE';
1750 local $SIG{INT} = 'IGNORE';
1751 local $SIG{QUIT} = 'IGNORE';
1752 local $SIG{TERM} = 'IGNORE';
1753 local $SIG{TSTP} = 'IGNORE';
1754 local $SIG{PIPE} = 'IGNORE';
1756 my $oldAutoCommit = $FS::UID::AutoCommit;
1757 local $FS::UID::AutoCommit = 0;
1760 #a little false laziness w/due_cust_event (not too bad, really)
1762 my $join = FS::part_event_condition->join_conditions_sql;
1763 my $order = FS::part_event_condition->order_conditions_sql;
1766 . join ( ' OR ' , map {
1767 my $cust_join = FS::part_event->eventtables_cust_join->{$_} || '';
1768 my $custnum = FS::part_event->eventtables_custnum->{$_};
1769 "( part_event.eventtable = " . dbh->quote($_)
1770 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key
1771 . " from $_ $cust_join"
1772 . " where $custnum = " . dbh->quote( $self->custnum ) . "))" ;
1773 } FS::part_event->eventtables)
1776 #here is the agent virtualization
1777 my $agent_virt = " ( part_event.agentnum IS NULL
1778 OR part_event.agentnum = ". $self->agentnum. ' )';
1780 #XXX this shouldn't be hardcoded, actions should declare it...
1781 my @realtime_events = qw(
1782 cust_bill_realtime_card
1783 cust_bill_realtime_check
1784 cust_bill_realtime_lec
1788 my $is_realtime_event =
1789 ' part_event.action IN ( '.
1790 join(',', map "'$_'", @realtime_events ).
1793 my $batch_or_statustext =
1794 "( part_event.action = 'cust_bill_batch'
1795 OR ( statustext IS NOT NULL AND statustext != '' )
1799 my @cust_event = qsearch({
1800 'table' => 'cust_event',
1801 'select' => 'cust_event.*',
1802 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
1803 'hashref' => { 'status' => 'done' },
1804 'extra_sql' => " AND $batch_or_statustext ".
1805 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
1808 my %seen_invnum = ();
1809 foreach my $cust_event (@cust_event) {
1811 #max one for the customer, one for each open invoice
1812 my $cust_X = $cust_event->cust_X;
1813 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
1817 or $cust_event->part_event->eventtable eq 'cust_bill'
1820 my $error = $cust_event->retry;
1822 $dbh->rollback if $oldAutoCommit;
1823 return "error scheduling event for retry: $error";
1828 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1833 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
1835 Runs billing events; see L<FS::part_event> and the billing events web
1838 If there is an error, returns the error, otherwise returns false.
1840 Options are passed as name-value pairs.
1842 Currently available options are:
1848 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.
1852 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1856 "collect" (the default) or "pre-bill"
1860 set true to surpress email card/ACH decline notices.
1864 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)
1871 # allows for one time override of normal customer billing method
1875 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1878 my( $self, %options ) = @_;
1880 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1882 my $time = $options{'time'} || time;
1885 local $SIG{HUP} = 'IGNORE';
1886 local $SIG{INT} = 'IGNORE';
1887 local $SIG{QUIT} = 'IGNORE';
1888 local $SIG{TERM} = 'IGNORE';
1889 local $SIG{TSTP} = 'IGNORE';
1890 local $SIG{PIPE} = 'IGNORE';
1892 my $oldAutoCommit = $FS::UID::AutoCommit;
1893 local $FS::UID::AutoCommit = 0;
1896 $self->select_for_update; #mutex
1899 my $balance = $self->balance;
1900 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
1903 # if ( exists($options{'retry_card'}) ) {
1904 # carp 'retry_card option passed to collect is deprecated; use retry';
1905 # $options{'retry'} ||= $options{'retry_card'};
1907 # if ( exists($options{'retry'}) && $options{'retry'} ) {
1908 # my $error = $self->retry_realtime;
1910 # $dbh->rollback if $oldAutoCommit;
1915 # false laziness w/pay_batch::import_results
1917 my $due_cust_event = $self->due_cust_event(
1918 'debug' => ( $options{'debug'} || 0 ),
1920 'check_freq' => $options{'check_freq'},
1921 'stage' => ( $options{'stage'} || 'collect' ),
1923 unless( ref($due_cust_event) ) {
1924 $dbh->rollback if $oldAutoCommit;
1925 return $due_cust_event;
1928 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1929 #never want to roll back an event just because it or a different one
1931 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1933 foreach my $cust_event ( @$due_cust_event ) {
1937 #re-eval event conditions (a previous event could have changed things)
1938 unless ( $cust_event->test_conditions ) {
1939 #don't leave stray "new/locked" records around
1940 my $error = $cust_event->delete;
1941 return $error if $error;
1946 local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
1947 if $options{'quiet'};
1948 warn " running cust_event ". $cust_event->eventnum. "\n"
1951 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
1952 if ( my $error = $cust_event->do_event( 'time' => $time ) ) {
1953 #XXX wtf is this? figure out a proper dealio with return value
1965 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
1967 Inserts database records for and returns an ordered listref of new events due
1968 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
1969 events are due, an empty listref is returned. If there is an error, returns a
1970 scalar error message.
1972 To actually run the events, call each event's test_condition method, and if
1973 still true, call the event's do_event method.
1975 Options are passed as a hashref or as a list of name-value pairs. Available
1982 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.
1986 "collect" (the default) or "pre-bill"
1990 "Current time" for the events.
1994 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)
1998 Only return events for the specified eventtable (by default, events of all eventtables are returned)
2002 Explicitly pass the objects to be tested (typically used with eventtable).
2006 Set to true to return the objects, but not actually insert them into the
2013 sub due_cust_event {
2015 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
2018 #my $DEBUG = $opt{'debug'}
2019 $opt{'debug'} ||= 0; # silence some warnings
2020 local($DEBUG) = $opt{'debug'}
2021 if $opt{'debug'} > $DEBUG;
2022 $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
2024 warn "$me due_cust_event called with options ".
2025 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
2028 $opt{'time'} ||= time;
2030 local $SIG{HUP} = 'IGNORE';
2031 local $SIG{INT} = 'IGNORE';
2032 local $SIG{QUIT} = 'IGNORE';
2033 local $SIG{TERM} = 'IGNORE';
2034 local $SIG{TSTP} = 'IGNORE';
2035 local $SIG{PIPE} = 'IGNORE';
2037 my $oldAutoCommit = $FS::UID::AutoCommit;
2038 local $FS::UID::AutoCommit = 0;
2041 $self->select_for_update #mutex
2042 unless $opt{testonly};
2045 # find possible events (initial search)
2048 my @cust_event = ();
2050 my @eventtable = $opt{'eventtable'}
2051 ? ( $opt{'eventtable'} )
2052 : FS::part_event->eventtables_runorder;
2054 my $check_freq = $opt{'check_freq'} || '1d';
2056 foreach my $eventtable ( @eventtable ) {
2059 if ( $opt{'objects'} ) {
2061 @objects = @{ $opt{'objects'} };
2063 } elsif ( $eventtable eq 'cust_main' ) {
2065 @objects = ( $self );
2069 my $cm_join = " LEFT JOIN cust_main USING ( custnum )";
2070 # linkage not needed here because FS::cust_main->$eventtable will
2073 #some false laziness w/Cron::bill bill_where
2075 my $join = FS::part_event_condition->join_conditions_sql( $eventtable);
2076 my $where = FS::part_event_condition->where_conditions_sql($eventtable,
2077 'time'=>$opt{'time'},
2079 $where = $where ? "AND $where" : '';
2081 my $are_part_event =
2082 "EXISTS ( SELECT 1 FROM part_event $join
2083 WHERE check_freq = '$check_freq'
2084 AND eventtable = '$eventtable'
2085 AND ( disabled = '' OR disabled IS NULL )
2091 @objects = $self->$eventtable(
2092 'addl_from' => $cm_join,
2093 'extra_sql' => " AND $are_part_event",
2095 } # if ( !$opt{objects} and $eventtable ne 'cust_main' )
2097 my @e_cust_event = ();
2099 my $linkage = FS::part_event->eventtables_cust_join->{$eventtable} || '';
2101 my $cross = "CROSS JOIN $eventtable $linkage";
2102 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
2103 unless $eventtable eq 'cust_main';
2105 foreach my $object ( @objects ) {
2107 #this first search uses the condition_sql magic for optimization.
2108 #the more possible events we can eliminate in this step the better
2110 my $cross_where = '';
2111 my $pkey = $object->primary_key;
2112 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
2114 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
2116 FS::part_event_condition->where_conditions_sql( $eventtable,
2117 'time'=>$opt{'time'}
2119 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
2121 $extra_sql = "AND $extra_sql" if $extra_sql;
2123 #here is the agent virtualization
2124 $extra_sql .= " AND ( part_event.agentnum IS NULL
2125 OR part_event.agentnum = ". $self->agentnum. ' )';
2127 $extra_sql .= " $order";
2129 warn "searching for events for $eventtable ". $object->$pkey. "\n"
2130 if $opt{'debug'} > 2;
2131 my @part_event = qsearch( {
2132 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
2133 'select' => 'part_event.*',
2134 'table' => 'part_event',
2135 'addl_from' => "$cross $join",
2136 'hashref' => { 'check_freq' => $check_freq,
2137 'eventtable' => $eventtable,
2140 'extra_sql' => "AND $cross_where $extra_sql",
2144 my $pkey = $object->primary_key;
2145 warn " ". scalar(@part_event).
2146 " possible events found for $eventtable ". $object->$pkey(). "\n";
2149 push @e_cust_event, map {
2150 $_->new_cust_event($object, 'time' => $opt{'time'})
2155 warn " ". scalar(@e_cust_event).
2156 " subtotal possible cust events found for $eventtable\n"
2159 push @cust_event, @e_cust_event;
2163 warn " ". scalar(@cust_event).
2164 " total possible cust events found in initial search\n"
2172 $opt{stage} ||= 'collect';
2174 grep { my $stage = $_->part_event->event_stage;
2175 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
2185 @cust_event = grep $_->test_conditions( 'stats_hashref' => \%unsat ),
2188 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
2191 warn " invalid conditions not eliminated with condition_sql:\n".
2192 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
2193 if keys %unsat && $DEBUG; # > 1;
2199 unless( $opt{testonly} ) {
2200 foreach my $cust_event ( @cust_event ) {
2202 my $error = $cust_event->insert();
2204 $dbh->rollback if $oldAutoCommit;
2211 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2217 warn " returning events: ". Dumper(@cust_event). "\n"
2224 =item apply_payments_and_credits [ OPTION => VALUE ... ]
2226 Applies unapplied payments and credits.
2228 In most cases, this new method should be used in place of sequential
2229 apply_payments and apply_credits methods.
2231 A hash of optional arguments may be passed. Currently "manual" is supported.
2232 If true, a payment receipt is sent instead of a statement when
2233 'payment_receipt_email' configuration option is set.
2235 If there is an error, returns the error, otherwise returns false.
2239 sub apply_payments_and_credits {
2240 my( $self, %options ) = @_;
2242 local $SIG{HUP} = 'IGNORE';
2243 local $SIG{INT} = 'IGNORE';
2244 local $SIG{QUIT} = 'IGNORE';
2245 local $SIG{TERM} = 'IGNORE';
2246 local $SIG{TSTP} = 'IGNORE';
2247 local $SIG{PIPE} = 'IGNORE';
2249 my $oldAutoCommit = $FS::UID::AutoCommit;
2250 local $FS::UID::AutoCommit = 0;
2253 $self->select_for_update; #mutex
2255 foreach my $cust_bill ( $self->open_cust_bill ) {
2256 my $error = $cust_bill->apply_payments_and_credits(%options);
2258 $dbh->rollback if $oldAutoCommit;
2259 return "Error applying: $error";
2263 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2268 =item apply_credits OPTION => VALUE ...
2270 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
2271 to outstanding invoice balances in chronological order (or reverse
2272 chronological order if the I<order> option is set to B<newest>) and returns the
2273 value of any remaining unapplied credits available for refund (see
2274 L<FS::cust_refund>).
2276 Dies if there is an error.
2284 local $SIG{HUP} = 'IGNORE';
2285 local $SIG{INT} = 'IGNORE';
2286 local $SIG{QUIT} = 'IGNORE';
2287 local $SIG{TERM} = 'IGNORE';
2288 local $SIG{TSTP} = 'IGNORE';
2289 local $SIG{PIPE} = 'IGNORE';
2291 my $oldAutoCommit = $FS::UID::AutoCommit;
2292 local $FS::UID::AutoCommit = 0;
2295 $self->select_for_update; #mutex
2297 unless ( $self->total_unapplied_credits ) {
2298 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2302 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
2303 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
2305 my @invoices = $self->open_cust_bill;
2306 @invoices = sort { $b->_date <=> $a->_date } @invoices
2307 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
2309 if ( $conf->exists('pkg-balances') ) {
2310 # limit @credits to those w/ a pkgnum grepped from $self
2312 foreach my $i (@invoices) {
2313 foreach my $li ( $i->cust_bill_pkg ) {
2314 $pkgnums{$li->pkgnum} = 1;
2317 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
2322 foreach my $cust_bill ( @invoices ) {
2324 if ( !defined($credit) || $credit->credited == 0) {
2325 $credit = pop @credits or last;
2329 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
2330 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
2332 $owed = $cust_bill->owed;
2334 unless ( $owed > 0 ) {
2335 push @credits, $credit;
2339 my $amount = min( $credit->credited, $owed );
2341 my $cust_credit_bill = new FS::cust_credit_bill ( {
2342 'crednum' => $credit->crednum,
2343 'invnum' => $cust_bill->invnum,
2344 'amount' => $amount,
2346 $cust_credit_bill->pkgnum( $credit->pkgnum )
2347 if $conf->exists('pkg-balances') && $credit->pkgnum;
2348 my $error = $cust_credit_bill->insert;
2350 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2354 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2358 my $total_unapplied_credits = $self->total_unapplied_credits;
2360 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2362 return $total_unapplied_credits;
2365 =item apply_payments [ OPTION => VALUE ... ]
2367 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2368 to outstanding invoice balances in chronological order.
2370 #and returns the value of any remaining unapplied payments.
2372 A hash of optional arguments may be passed. Currently "manual" is supported.
2373 If true, a payment receipt is sent instead of a statement when
2374 'payment_receipt_email' configuration option is set.
2376 Dies if there is an error.
2380 sub apply_payments {
2381 my( $self, %options ) = @_;
2383 local $SIG{HUP} = 'IGNORE';
2384 local $SIG{INT} = 'IGNORE';
2385 local $SIG{QUIT} = 'IGNORE';
2386 local $SIG{TERM} = 'IGNORE';
2387 local $SIG{TSTP} = 'IGNORE';
2388 local $SIG{PIPE} = 'IGNORE';
2390 my $oldAutoCommit = $FS::UID::AutoCommit;
2391 local $FS::UID::AutoCommit = 0;
2394 $self->select_for_update; #mutex
2398 my @payments = sort { $b->_date <=> $a->_date }
2399 grep { $_->unapplied > 0 }
2402 my @invoices = sort { $a->_date <=> $b->_date}
2403 grep { $_->owed > 0 }
2406 if ( $conf->exists('pkg-balances') ) {
2407 # limit @payments to those w/ a pkgnum grepped from $self
2409 foreach my $i (@invoices) {
2410 foreach my $li ( $i->cust_bill_pkg ) {
2411 $pkgnums{$li->pkgnum} = 1;
2414 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
2419 foreach my $cust_bill ( @invoices ) {
2421 if ( !defined($payment) || $payment->unapplied == 0 ) {
2422 $payment = pop @payments or last;
2426 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
2427 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
2429 $owed = $cust_bill->owed;
2431 unless ( $owed > 0 ) {
2432 push @payments, $payment;
2436 my $amount = min( $payment->unapplied, $owed );
2439 'paynum' => $payment->paynum,
2440 'invnum' => $cust_bill->invnum,
2441 'amount' => $amount,
2443 $cbp->{_date} = $payment->_date
2444 if $options{'manual'} && $options{'backdate_application'};
2445 my $cust_bill_pay = new FS::cust_bill_pay($cbp);
2446 $cust_bill_pay->pkgnum( $payment->pkgnum )
2447 if $conf->exists('pkg-balances') && $payment->pkgnum;
2448 my $error = $cust_bill_pay->insert(%options);
2450 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2454 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2458 my $total_unapplied_payments = $self->total_unapplied_payments;
2460 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2462 return $total_unapplied_payments;
2472 suspend_adjourned_pkgs
2473 unsuspend_resumed_pkgs
2476 (do_cust_event pre-bill)
2479 (vendor-only) _gather_taxes
2480 _omit_zero_value_bundles
2481 _handle_taxes (for fees)
2484 apply_payments_and_credits
2493 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>