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 );
13 use FS::cust_bill_pkg;
14 use FS::cust_bill_pkg_display;
15 use FS::cust_bill_pay;
16 use FS::cust_credit_bill;
17 use FS::cust_tax_adjustment;
19 use FS::tax_rate_location;
20 use FS::cust_bill_pkg_tax_location;
21 use FS::cust_bill_pkg_tax_rate_location;
23 use FS::part_event_condition;
25 use FS::FeeOrigin_Mixin;
28 # 1 is mostly method/subroutine entry and options
29 # 2 traces progress of some operations
30 # 3 is even more information including possibly sensitive data
32 $me = '[FS::cust_main::Billing]';
34 install_callback FS::UID sub {
36 #yes, need it for stuff below (prolly should be cached)
41 FS::cust_main::Billing - Billing mixin for cust_main
47 These methods are available on FS::cust_main objects.
53 =item bill_and_collect
55 Cancels and suspends any packages due, generates bills, applies payments and
56 credits, and applies collection events to run cards, send bills and notices,
59 Any errors prevent subsequent operations from continuing and die (but see the
62 Options are passed as name-value pairs. Currently available options are:
68 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:
72 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
76 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.
80 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
84 If set true, re-charges setup fees.
88 If set any errors prevent subsequent operations from continusing. If set
89 specifically to "return", returns the error (or false, if there is no error).
90 Any other true value causes errors to die.
94 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)
98 Optional FS::queue entry to receive status updates.
102 Options are passed to the B<bill> and B<collect> methods verbatim, so all
103 options of those methods are also available.
107 sub bill_and_collect {
108 my( $self, %options ) = @_;
110 my $log = FS::Log->new('FS::cust_main::Billing::bill_and_collect');
111 my %logopt = (object => $self);
112 $log->debug('start', %logopt);
116 #$options{actual_time} not $options{time} because freeside-daily -d is for
117 #pre-printing invoices
119 $options{'actual_time'} ||= time;
120 my $job = $options{'job'};
122 my $actual_time = ( $conf->exists('next-bill-ignore-time')
123 ? day_end( $options{actual_time} )
124 : $options{actual_time}
127 $job->update_statustext('0,cleaning expired packages') if $job;
128 $log->debug('canceling expired packages', %logopt);
129 $error = $self->cancel_expired_pkgs( $actual_time );
131 $error = "Error expiring custnum ". $self->custnum. ": $error";
132 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
136 $log->debug('suspending adjourned packages', %logopt);
137 $error = $self->suspend_adjourned_pkgs( $actual_time );
139 $error = "Error adjourning custnum ". $self->custnum. ": $error";
140 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
144 $log->debug('unsuspending resumed packages', %logopt);
145 $error = $self->unsuspend_resumed_pkgs( $actual_time );
147 $error = "Error resuming custnum ".$self->custnum. ": $error";
148 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
152 $job->update_statustext('20,billing packages') if $job;
153 $log->debug('billing packages', %logopt);
154 $error = $self->bill( %options );
156 $error = "Error billing custnum ". $self->custnum. ": $error";
157 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
161 $job->update_statustext('50,applying payments and credits') if $job;
162 $log->debug('applying payments and credits', %logopt);
163 $error = $self->apply_payments_and_credits;
165 $error = "Error applying custnum ". $self->custnum. ": $error";
166 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
170 unless ( $conf->exists('cancelled_cust-noevents')
171 && ! $self->num_ncancelled_pkgs
173 $job->update_statustext('70,running collection events') if $job;
174 $log->debug('running collection events', %logopt);
175 $error = $self->collect( %options );
177 $error = "Error collecting custnum ". $self->custnum. ": $error";
178 if ($options{fatal} && $options{fatal} eq 'return') { return $error; }
183 $job->update_statustext('100,finished') if $job;
184 $log->debug('finish', %logopt);
190 sub cancel_expired_pkgs {
191 my ( $self, $time, %options ) = @_;
193 my @cancel_pkgs = $self->ncancelled_pkgs( {
194 'extra_sql' => " AND expire IS NOT NULL AND expire > 0 AND expire <= $time "
199 my @really_cancel_pkgs = ();
200 my @cancel_reasons = ();
202 CUST_PKG: foreach my $cust_pkg ( @cancel_pkgs ) {
203 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
205 if ( $cust_pkg->change_to_pkgnum ) {
207 my $new_pkg = FS::cust_pkg->by_key($cust_pkg->change_to_pkgnum);
209 push @errors, 'can\'t change pkgnum '.$cust_pkg->pkgnum.' to pkgnum '.
210 $cust_pkg->change_to_pkgnum.'; not expiring';
213 my $error = $cust_pkg->change( 'cust_pkg' => $new_pkg,
214 'unprotect_svcs' => 1,
216 push @errors, $error if $error && ref($error) ne 'FS::cust_pkg';
218 } else { # just cancel it
220 push @really_cancel_pkgs, $cust_pkg;
221 push @cancel_reasons, $cpr;
226 if (@really_cancel_pkgs) {
228 my %cancel_opt = ( 'cust_pkg' => \@really_cancel_pkgs,
229 'cust_pkg_reason' => \@cancel_reasons,
233 push @errors, $self->cancel_pkgs(%cancel_opt);
237 join(' / ', @errors);
241 sub suspend_adjourned_pkgs {
242 my ( $self, $time, %options ) = @_;
244 my @susp_pkgs = $self->ncancelled_pkgs( {
246 " AND ( susp IS NULL OR susp = 0 )
247 AND ( ( bill IS NOT NULL AND bill != 0 AND bill < $time )
248 OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
253 #only because there's no SQL test for is_prepaid :/
255 grep { ( $_->part_pkg->is_prepaid
260 && $_->adjourn <= $time
268 foreach my $cust_pkg ( @susp_pkgs ) {
269 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
270 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
271 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
272 'reason_otaker' => $cpr->otaker
276 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
279 join(' / ', @errors);
283 sub unsuspend_resumed_pkgs {
284 my ( $self, $time, %options ) = @_;
286 my @unsusp_pkgs = $self->ncancelled_pkgs( {
287 'extra_sql' => " AND resume IS NOT NULL AND resume > 0 AND resume <= $time "
292 foreach my $cust_pkg ( @unsusp_pkgs ) {
293 my $error = $cust_pkg->unsuspend( 'time' => $time );
294 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
297 join(' / ', @errors);
303 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
304 conjunction with the collect method by calling B<bill_and_collect>.
306 If there is an error, returns the error, otherwise returns false.
308 Options are passed as name-value pairs. Currently available options are:
314 If set true, re-charges setup fees.
318 If set true then only bill recurring charges, not setup, usage, one time
323 If set, then override the normal frequency and look for a part_pkg_discount
324 to take at that frequency. This is appropriate only when the normal
325 frequency for all packages is monthly, and is an error otherwise. Use
326 C<pkg_list> to limit the set of packages included in billing.
330 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:
334 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
338 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
340 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
344 A hashref of pkgparts to exclude from this billing run (can also be specified as a comma-separated scalar).
348 Do not bill prepaid packages. Used by freeside-daily.
352 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.
356 This boolean value informs the us that the package is being cancelled. This
357 typically might mean not charging the normal recurring fee but only usage
358 fees since the last billing. Setup charges may be charged. Not all package
359 plans support this feature (they tend to charge 0).
363 Prevent the resetting of usage limits during this call.
367 Do not save the generated bill in the database. Useful with return_bill
371 A list reference on which the generated bill(s) will be returned.
375 Optional terms to be printed on this invoice. Otherwise, customer-specific
376 terms or the default terms are used.
383 my( $self, %options ) = @_;
385 return '' if $self->payby eq 'COMP';
387 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
388 my $log = FS::Log->new('FS::cust_main::Billing::bill');
389 my %logopt = (object => $self);
391 $log->debug('start', %logopt);
392 warn "$me bill customer ". $self->custnum. "\n"
395 my $time = $options{'time'} || time;
396 my $invoice_time = $options{'invoice_time'} || $time;
398 my $cmp_time = ( $conf->exists('next-bill-ignore-time')
403 $options{'not_pkgpart'} ||= {};
404 $options{'not_pkgpart'} = { map { $_ => 1 }
405 split(/\s*,\s*/, $options{'not_pkgpart'})
407 unless ref($options{'not_pkgpart'});
409 local $SIG{HUP} = 'IGNORE';
410 local $SIG{INT} = 'IGNORE';
411 local $SIG{QUIT} = 'IGNORE';
412 local $SIG{TERM} = 'IGNORE';
413 local $SIG{TSTP} = 'IGNORE';
414 local $SIG{PIPE} = 'IGNORE';
416 my $oldAutoCommit = $FS::UID::AutoCommit;
417 local $FS::UID::AutoCommit = 0;
420 $log->debug('acquiring lock', %logopt);
421 warn "$me acquiring lock on customer ". $self->custnum. "\n"
424 $self->select_for_update; #mutex
426 $log->debug('running pre-bill events', %logopt);
427 warn "$me running pre-bill events for customer ". $self->custnum. "\n"
430 my $error = $self->do_cust_event(
431 'debug' => ( $options{'debug'} || 0 ),
432 'time' => $invoice_time,
433 'check_freq' => $options{'check_freq'},
434 'stage' => 'pre-bill',
436 unless $options{no_commit};
438 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
442 $log->debug('done running pre-bill events', %logopt);
443 warn "$me done running pre-bill events for customer ". $self->custnum. "\n"
446 #keep auto-charge and non-auto-charge line items separate
447 my @passes = ( '', 'no_auto' );
449 my %cust_bill_pkg = map { $_ => [] } @passes;
452 # find the packages which are due for billing, find out how much they are
453 # & generate invoice database.
456 my %total_setup = map { my $z = 0; $_ => \$z; } @passes;
457 my %total_recur = map { my $z = 0; $_ => \$z; } @passes;
459 my %taxlisthash = map { $_ => {} } @passes;
461 my @precommit_hooks = ();
463 $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ]; #param checks?
465 foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
467 next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
469 my $part_pkg = $cust_pkg->part_pkg;
471 next if $options{'no_prepaid'} && $part_pkg->is_prepaid;
473 $log->debug('bill package '. $cust_pkg->pkgnum, %logopt);
474 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG;
476 #? to avoid use of uninitialized value errors... ?
477 $cust_pkg->setfield('bill', '')
478 unless defined($cust_pkg->bill);
480 my $real_pkgpart = $cust_pkg->pkgpart;
481 my %hash = $cust_pkg->hash;
483 # we could implement this bit as FS::part_pkg::has_hidden, but we already
484 # suffer from performance issues
485 $options{has_hidden} = 0;
486 my @part_pkg = $part_pkg->self_and_bill_linked;
487 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
489 # if this package was changed from another package,
490 # and it hasn't been billed since then,
491 # and package balances are enabled,
492 if ( $cust_pkg->change_pkgnum
493 and $cust_pkg->change_date >= ($cust_pkg->last_bill || 0)
494 and $cust_pkg->change_date < $invoice_time
495 and $conf->exists('pkg-balances') )
497 # _transfer_balance will also create the appropriate credit
498 my @transfer_items = $self->_transfer_balance($cust_pkg);
499 # $part_pkg[0] is the "real" part_pkg
500 my $pass = ($cust_pkg->no_auto || $part_pkg[0]->no_auto) ?
502 push @{ $cust_bill_pkg{$pass} }, @transfer_items;
503 # treating this as recur, just because most charges are recur...
504 ${$total_recur{$pass}} += $_->recur foreach @transfer_items;
506 # currently not considering separate_bill here, as it's for
507 # one-time charges only
510 foreach my $part_pkg ( @part_pkg ) {
512 my $this_cust_pkg = $cust_pkg;
513 # for add-on packages, copy the object to avoid leaking changes back to
514 # the caller if pkg_list is in use; see RT#73607
515 if ( $part_pkg->get('pkgpart') != $real_pkgpart ) {
516 $this_cust_pkg = FS::cust_pkg->new({ %hash });
520 if ( $this_cust_pkg->separate_bill ) {
521 # if no_auto is also set, that's fine. we just need to not have
522 # invoices that are both auto and no_auto, and since the package
523 # gets an invoice all to itself, it will only be one or the other.
524 $pass = $this_cust_pkg->pkgnum;
525 if (!exists $cust_bill_pkg{$pass}) { # it may not exist yet
527 $total_setup{$pass} = do { my $z = 0; \$z };
528 $total_recur{$pass} = do { my $z = 0; \$z };
529 $taxlisthash{$pass} = {};
530 $cust_bill_pkg{$pass} = [];
532 } elsif ( ($this_cust_pkg->no_auto || $part_pkg->no_auto) ) {
536 my $next_bill = $this_cust_pkg->getfield('bill') || 0;
538 # let this run once if this is the last bill upon cancellation
539 while ( $next_bill <= $cmp_time or $options{cancel} ) {
541 $self->_make_lines( 'part_pkg' => $part_pkg,
542 'cust_pkg' => $this_cust_pkg,
543 'precommit_hooks' => \@precommit_hooks,
544 'line_items' => $cust_bill_pkg{$pass},
545 'setup' => $total_setup{$pass},
546 'recur' => $total_recur{$pass},
547 'tax_matrix' => $taxlisthash{$pass},
549 'real_pkgpart' => $real_pkgpart,
550 'options' => \%options,
553 # Stop if anything goes wrong
556 # or if we're not incrementing the bill date.
557 last if ($this_cust_pkg->getfield('bill') || 0) == $next_bill;
559 # or if we're letting it run only once
560 last if $options{cancel};
562 $next_bill = $this_cust_pkg->getfield('bill') || 0;
564 #stop if -o was passed to freeside-daily
565 last if $options{'one_recur'};
568 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
572 } #foreach my $part_pkg
574 } #foreach my $cust_pkg
576 foreach my $pass (@passes) { # keys %cust_bill_pkg )
578 my @cust_bill_pkg = _omit_zero_value_bundles(@{ $cust_bill_pkg{$pass} });
580 warn "$me billing pass $pass\n"
581 #.Dumper(\@cust_bill_pkg)."\n"
588 my @pending_fees = FS::FeeOrigin_Mixin->by_cust($self->custnum,
589 hashref => { 'billpkgnum' => '' }
591 warn "$me found pending fees:\n".Dumper(\@pending_fees)."\n"
592 if @pending_fees and $DEBUG > 1;
594 # determine whether to generate an invoice
595 my $generate_bill = scalar(@cust_bill_pkg) > 0;
597 foreach my $fee (@pending_fees) {
598 $generate_bill = 1 unless $fee->nextbill;
601 # don't create an invoice with no line items, or where the only line
602 # items are fees that are supposed to be held until the next invoice
603 next if !$generate_bill;
607 foreach my $fee_origin (@pending_fees) {
608 my $part_fee = $fee_origin->part_fee;
610 # check whether the fee is applicable before doing anything expensive:
612 # if the fee def belongs to a different agent, don't charge the fee.
613 # event conditions should prevent this, but just in case they don't,
615 if ( $part_fee->agentnum and $part_fee->agentnum != $self->agentnum ) {
616 warn "tried to charge fee#".$part_fee->feepart .
617 " on customer#".$self->custnum." from a different agent.\n";
620 # also skip if it's disabled
621 next if $part_fee->disabled eq 'Y';
623 # Decide which invoice to base the fee on.
624 my $cust_bill = $fee_origin->cust_bill;
626 # Then link it to the current invoice. This isn't the real cust_bill
627 # object that will be inserted--in particular there are no taxes yet.
628 # If you want to charge a fee on the total invoice amount including
629 # taxes, you have to put the fee on the next invoice.
630 $cust_bill = FS::cust_bill->new({
631 'custnum' => $self->custnum,
632 'cust_bill_pkg' => \@cust_bill_pkg,
633 'charged' => ${ $total_setup{$pass} } +
634 ${ $total_recur{$pass} },
637 # If the origin is for a specific package, then only apply the fee to
638 # line items from that package.
639 if ( my $cust_pkg = $fee_origin->cust_pkg ) {
640 my @charge_fee_on_item;
641 my $charge_fee_on_amount = 0;
642 foreach (@cust_bill_pkg) {
643 if ($_->pkgnum == $cust_pkg->pkgnum) {
644 push @charge_fee_on_item, $_;
645 $charge_fee_on_amount += $_->setup + $_->recur;
648 $cust_bill->set('cust_bill_pkg', \@charge_fee_on_item);
649 $cust_bill->set('charged', $charge_fee_on_amount);
652 } # $cust_bill is now set
654 my $fee_item = $part_fee->lineitem($cust_bill) or next;
655 # link this so that we can clear the marker on inserting the line item
656 $fee_item->set('fee_origin', $fee_origin);
657 push @fee_items, $fee_item;
661 # add fees to the invoice
662 foreach my $fee_item (@fee_items) {
664 push @cust_bill_pkg, $fee_item;
665 ${ $total_setup{$pass} } += $fee_item->setup;
666 ${ $total_recur{$pass} } += $fee_item->recur;
668 my $part_fee = $fee_item->part_fee;
669 my $fee_location = $self->ship_location; # I think?
671 my $error = $self->_handle_taxes(
674 location => $fee_location
675 # probably not right to pass cancel => 1 for fees
677 return $error if $error;
681 # XXX implementation of fees is supposed to make this go away...
682 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
683 !$conf->exists('postal_invoice-recurring_only')
687 my $postal_pkg = $self->charge_postal_fee();
688 if ( $postal_pkg && !ref( $postal_pkg ) ) {
690 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
691 return "can't charge postal invoice fee for customer ".
692 $self->custnum. ": $postal_pkg";
694 } elsif ( $postal_pkg ) {
696 my $real_pkgpart = $postal_pkg->pkgpart;
697 # we could implement this bit as FS::part_pkg::has_hidden, but we already
698 # suffer from performance issues
699 $options{has_hidden} = 0;
700 my @part_pkg = $postal_pkg->part_pkg->self_and_bill_linked;
701 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
703 foreach my $part_pkg ( @part_pkg ) {
704 my %postal_options = %options;
705 delete $postal_options{cancel};
707 $self->_make_lines( 'part_pkg' => $part_pkg,
708 'cust_pkg' => $postal_pkg,
709 'precommit_hooks' => \@precommit_hooks,
710 'line_items' => \@cust_bill_pkg,
711 'setup' => $total_setup{$pass},
712 'recur' => $total_recur{$pass},
713 'tax_matrix' => $taxlisthash{$pass},
715 'real_pkgpart' => $real_pkgpart,
716 'options' => \%postal_options,
719 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
724 # it's silly to have a zero value postal_pkg, but....
725 @cust_bill_pkg = _omit_zero_value_bundles(@cust_bill_pkg);
731 my $listref_or_error =
732 $self->calculate_taxes( \@cust_bill_pkg, $taxlisthash{$pass}, $invoice_time);
734 unless ( ref( $listref_or_error ) ) {
735 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
736 return $listref_or_error;
739 foreach my $taxline ( @$listref_or_error ) {
740 ${ $total_setup{$pass} } =
741 sprintf('%.2f', ${ $total_setup{$pass} } + $taxline->setup );
742 push @cust_bill_pkg, $taxline;
746 warn "adding tax adjustments...\n" if $DEBUG > 2;
747 foreach my $cust_tax_adjustment (
748 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
754 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
756 my $itemdesc = $cust_tax_adjustment->taxname;
757 $itemdesc = '' if $itemdesc eq 'Tax';
759 push @cust_bill_pkg, new FS::cust_bill_pkg {
765 'itemdesc' => $itemdesc,
766 'itemcomment' => $cust_tax_adjustment->comment,
767 'cust_tax_adjustment' => $cust_tax_adjustment,
768 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
773 my $charged = sprintf('%.2f', ${ $total_setup{$pass} } + ${ $total_recur{$pass} } );
775 my $balance = $self->balance;
777 my $previous_bill = qsearchs({ 'table' => 'cust_bill',
778 'hashref' => { custnum=>$self->custnum },
779 'extra_sql' => 'ORDER BY _date DESC LIMIT 1',
781 my $previous_balance =
783 ? ( $previous_bill->billing_balance + $previous_bill->charged )
786 $log->debug('creating the new invoice', %logopt);
787 warn "creating the new invoice\n" if $DEBUG;
788 #create the new invoice
789 my $cust_bill = new FS::cust_bill ( {
790 'custnum' => $self->custnum,
791 '_date' => $invoice_time,
792 'charged' => $charged,
793 'billing_balance' => $balance,
794 'previous_balance' => $previous_balance,
795 'invoice_terms' => $options{'invoice_terms'},
796 'cust_bill_pkg' => \@cust_bill_pkg,
798 $error = $cust_bill->insert unless $options{no_commit};
800 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
801 return "can't create invoice for customer #". $self->custnum. ": $error";
803 push @{$options{return_bill}}, $cust_bill if $options{return_bill};
805 } #foreach my $pass ( keys %cust_bill_pkg )
807 foreach my $hook ( @precommit_hooks ) {
810 } unless $options{no_commit};
812 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
813 return "$@ running precommit hook $hook\n";
817 $dbh->commit or die $dbh->errstr if $oldAutoCommit && !$options{no_commit};
822 #discard bundled packages of 0 value
823 # XXX we should reconsider whether we even need this
824 sub _omit_zero_value_bundles {
829 my $discount_show_always = $conf->exists('discount-show-always');
832 # Sort @in the same way we do during invoice rendering, so we can identify
833 # bundles. See FS::Template_Mixin::_items_nontax.
834 @in = sort { $a->pkgnum <=> $b->pkgnum or
835 $a->sdate <=> $b->sdate or
836 ($a->pkgpart_override ? 0 : -1) or
837 ($b->pkgpart_override ? 0 : 1) or
838 $b->hidden cmp $a->hidden or
839 $a->pkgpart_override <=> $b->pkgpart_override
842 # this is a pack-and-deliver pattern. every time there's a cust_bill_pkg
843 # _without_ pkgpart_override, that's the start of the new bundle. if there's
844 # an existing bundle, and it contains a nonzero amount (or a zero amount
845 # that's displayable anyway), push all line items in the bundle.
846 foreach my $cust_bill_pkg ( @in ) {
848 if (scalar(@bundle) and !$cust_bill_pkg->pkgpart_override) {
849 # ship out this bundle and reset it
857 # add this item to the current bundle
858 push @bundle, $cust_bill_pkg;
860 # determine if it makes the bundle displayable
861 if ( $cust_bill_pkg->setup > 0
862 or $cust_bill_pkg->recur > 0
863 or $cust_bill_pkg->setup_show_zero
864 or $cust_bill_pkg->recur_show_zero
865 or ($discount_show_always
866 and scalar(@{ $cust_bill_pkg->get('discounts')})
878 warn " _omit_zero_value_bundles: ". scalar(@in).
879 '->'. scalar(@out). "\n" #. Dumper(@out). "\n"
885 =item calculate_taxes LINEITEMREF TAXHASHREF INVOICE_TIME
887 Generates tax line items (see L<FS::cust_bill_pkg>) for this customer.
888 Usually used internally by bill method B<bill>.
890 If there is an error, returns the error, otherwise returns reference to a
891 list of line items suitable for insertion.
897 An array ref of the line items being billed.
901 A strange beast. The keys to this hash are internal identifiers consisting
902 of the name of the tax object type, a space, and its unique identifier ( e.g.
903 'cust_main_county 23' ). The values of the hash are listrefs. The first
904 item in the list is the tax object. The remaining items are either line
905 items or floating point values (currency amounts).
907 The taxes are calculated on this entity. Calculated exemption records are
908 transferred to the LINEITEMREF items on the assumption that they are related.
914 This specifies the date appearing on the associated invoice. Some
915 jurisdictions (i.e. Texas) have tax exemptions which are date sensitive.
921 sub calculate_taxes {
922 my ($self, $cust_bill_pkg, $taxlisthash, $invoice_time) = @_;
924 # $taxlisthash is a hashref
925 # keys are identifiers, values are arrayrefs
926 # each arrayref starts with a tax object (cust_main_county or tax_rate)
927 # then a cust_bill_pkg object the tax applies to, then the charge class
928 # on that object (setup, recur, a usage class number, or '')
929 # For internal taxes the charge class is always undef.
931 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
933 warn "$me calculate_taxes\n"
934 #.Dumper($self, $cust_bill_pkg, $taxlisthash, $invoice_time). "\n"
937 my $custnum = $self->custnum;
938 # The main tax accumulator. One bin for each tax name (itemdesc).
939 # For each subdivision of tax under this name, push a cust_bill_pkg item
940 # for the calculated tax into the arrayref.
942 # values are arrayrefs of tax lines
945 # keys are taxlisthash keys (internal identifiers)
946 # values are (cumulative) amounts
949 # keys are taxlisthash keys
950 # values are arrayrefs of cust_tax_exempt_pkg objects
953 # For tax on tax calculation, we need to remember which taxable items
954 # (and charge classes) had which taxes applied to them.
956 # keys are cust_bill_pkg objects (taxable items)
957 # values are hashrefs
958 # keys are charge classes
959 # values are hashrefs
960 # keys are taxnums (in tax_rate only; cust_main_county doesn't use this)
961 # values are the taxlines generated for those taxes
962 tie my %item_has_tax, 'Tie::RefHash',
963 map { $_ => {} } @$cust_bill_pkg;
965 foreach my $tax_id ( keys %$taxlisthash ) {
966 # $tax_id: the identifier of the tax we are calculating in this pass
968 my $taxables = $taxlisthash->{$tax_id};
969 my $tax_object = shift @$taxables;
970 my $taxnum = $tax_object->taxnum;
971 # $tax_object is a cust_main_county or tax_rate
972 # (with billpkgnum, pkgnum, locationnum set)
973 # the rest of @{ $taxlisthash->{$tax_id} } is cust_bill_pkg objects,
974 # optionally followed by their charge classes.
975 warn "found ". $tax_object->taxname. " as $tax_id\n" if $DEBUG > 2;
977 # taxline calculates the tax on all cust_bill_pkgs in the
978 # first (arrayref) argument.
980 # Note that non-monthly exemptions have already been calculated and
981 # attached to the items. Monthly exemptions will be attached in this
983 my $exemptions = $tax_exemption{$tax_id} ||= [];
984 if ( $tax_object->isa('FS::tax_rate') ) { # EXTERNAL TAXES
985 # STILL have tax_rate-specific crap in here...
986 my @taxlines = $tax_object->taxline( $taxables,
987 'custnum' => $custnum,
988 'invoice_time' => $invoice_time,
989 'exemptions' => $exemptions,
992 if (!ref $taxlines[0]) {
993 # it's an error string
994 warn "error evaluating $tax_id on custnum $custnum\n";
997 foreach my $taxline (@taxlines) {
998 push @{ $taxname{ $taxline->itemdesc } }, $taxline;
999 my $link = $taxline->get('cust_bill_pkg_tax_rate_location')->[0];
1000 my $taxable_item = $link->taxable_cust_bill_pkg;
1001 $item_has_tax{$taxable_item}{$taxline->_class}{$taxnum} = $taxline;
1004 } else { # INTERNAL TAXES
1005 # we can do this in a single taxline, because it's not stupid
1007 my $taxline = $tax_object->taxline( $taxables,
1008 'custnum' => $custnum,
1009 'invoice_time' => $invoice_time,
1010 'exemptions' => $exemptions,
1013 if (!ref $taxline) {
1014 # it's an error string
1015 warn "error evaluating $tax_id on custnum $custnum\n";
1018 # if the calculated tax is zero, don't even keep it
1019 next if $taxline->setup < 0.001;
1020 push @{ $taxname{ $taxline->itemdesc } }, $taxline;
1023 $DB::single = 1; # XXX
1025 # all first-tier taxes are calculated. now for tax on tax:
1027 foreach my $taxable_item ( @$cust_bill_pkg ) {
1028 # taxes that apply to this item
1029 my $this_has_tax = $item_has_tax{$taxable_item};
1031 my $location = $taxable_item->tax_location;
1033 foreach my $charge_class (keys %$this_has_tax) {
1034 # taxes that apply to this item and charge class
1035 my $this_class_has_tax = $this_has_tax->{$charge_class};
1036 foreach my $taxnum (keys %$this_class_has_tax) {
1038 # for each tax item that was calculated in phase 1, get the
1040 my $tax_object = FS::tax_rate->by_key($taxnum);
1041 # and find all taxes that apply to it in this location
1042 my @tot = $tax_object->tax_on_tax( $location );
1044 warn "found possible taxed taxnum $taxnum\n"
1046 # Calculate ToT separately for each taxable item and class, and only
1047 # if _that class on the item_ is already taxed under the ToT. This is
1049 # See RT#5243 and RT#36380.
1050 foreach my $tot (@tot) {
1051 my $totnum = $tot->taxnum;
1052 warn "checking taxnum $totnum which we call ". $tot->taxname ."\n"
1054 # note: if the _null class_ on this item is taxed under the ToT,
1055 # then this specific class is taxed also (because null class
1056 # includes all classes) and so ToT is applicable.
1058 exists $this_class_has_tax->{ $totnum }
1059 or exists $this_has_tax->{''}{ $totnum }
1062 warn "calculating tax on tax: taxnum $totnum on $taxnum\n"
1064 my @taxlines = $tot->taxline(
1065 $this_class_has_tax->{ $taxnum }, # the first-stage tax
1066 'custnum' => $custnum,
1067 'invoice_time' => $invoice_time,
1069 next if (!@taxlines); # it didn't apply after all
1070 if (!ref($taxlines[0])) {
1071 warn "error evaluating taxnum $totnum TOT on custnum $custnum\n";
1072 return $taxlines[0];
1074 foreach my $taxline (@taxlines) {
1075 push @{ $taxname{ $taxline->itemdesc } }, $taxline;
1078 } # foreach my $tot (tax-on-tax rate definition)
1079 } # foreach $taxnum (first-tier rate definition)
1080 } # foreach $charge_class
1081 } # foreach $taxable_item
1083 #consolidate and create tax line items
1084 warn "consolidating and generating...\n" if $DEBUG > 2;
1085 my %final_tax_items; # taxname => item
1086 foreach my $taxname ( keys %taxname ) {
1087 my @cust_bill_pkg_tax_location;
1088 my @cust_bill_pkg_tax_rate_location;
1089 my $tax_cust_bill_pkg = FS::cust_bill_pkg->new({
1094 'itemdesc' => $taxname,
1095 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
1096 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
1101 warn "adding $taxname\n" if $DEBUG > 1;
1102 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
1103 next if $taxitem->get('setup') == 0;
1104 # if ( ref($taxitem) eq 'FS::cust_bill_pkg' ) # always true
1105 # then we need to transfer the amount and the links from the
1106 # line item to the new one we're creating.
1107 $tax_total += $taxitem->setup;
1109 $taxitem->get('cust_bill_pkg_tax_location') ||
1110 $taxitem->get('cust_bill_pkg_tax_rate_location') ||
1113 foreach my $link ( @links ) {
1114 $link->set('tax_cust_bill_pkg', $tax_cust_bill_pkg);
1115 if ($link->isa('FS::cust_bill_pkg_tax_location')) {
1116 push @cust_bill_pkg_tax_location, $link;
1117 } elsif ($link->isa('FS::cust_bill_pkg_tax_rate_location')) {
1118 push @cust_bill_pkg_tax_rate_location, $link;
1122 next unless $tax_total;
1124 # we should really neverround this up...I guess it's okay if taxline
1125 # already returns amounts with 2 decimal places
1126 $tax_total = sprintf('%.2f', $tax_total );
1127 $tax_cust_bill_pkg->set('setup', $tax_total);
1129 my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
1135 if ( $pkg_category and
1136 $conf->config('invoice_latexsummary') ||
1137 $conf->config('invoice_htmlsummary')
1141 my %hash = ( 'section' => $pkg_category->categoryname );
1142 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
1145 $tax_cust_bill_pkg->set('display', \@display);
1147 $final_tax_items{$taxname} = $tax_cust_bill_pkg;
1148 } # foreach $taxname
1150 # fix ToT backlinks for taxes that have been consolidated
1151 # (has to be done in a separate pass)
1152 foreach my $tax_item (values %final_tax_items) {
1153 foreach my $taxable_link (@{ $tax_item->cust_bill_pkg_tax_rate_location }) {
1154 my $taxed_item = $taxable_link->taxable_cust_bill_pkg;
1155 next if $taxed_item->pkgnum > 0; # primary taxes
1156 my $taxname = $taxed_item->itemdesc;
1157 $taxable_link->set('taxable_cust_bill_pkg', $final_tax_items{ $taxname });
1161 [ values %final_tax_items ]
1165 my ($self, %params) = @_;
1167 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1169 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
1170 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
1171 my $cust_location = $cust_pkg->tax_location;
1172 my $precommit_hooks = $params{precommit_hooks} or die "no precommit_hooks specified";
1173 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
1174 my $total_setup = $params{setup} or die "no setup accumulator specified";
1175 my $total_recur = $params{recur} or die "no recur accumulator specified";
1176 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
1177 my $time = $params{'time'} or die "no time specified";
1178 my (%options) = %{$params{options}};
1180 if ( $part_pkg->freq ne '1' and ($options{'freq_override'} || 0) > 0 ) {
1181 # this should never happen
1182 die 'freq_override billing attempted on non-monthly package '.
1187 my $real_pkgpart = $params{real_pkgpart};
1188 my %hash = $cust_pkg->hash;
1189 my $old_cust_pkg = new FS::cust_pkg \%hash;
1194 $cust_pkg->pkgpart($part_pkg->pkgpart);
1196 my $cmp_time = ( $conf->exists('next-bill-ignore-time')
1207 my @setup_discounts = ();
1208 my %setup_param = ( 'discounts' => \@setup_discounts,
1209 'real_pkgpart' => $params{real_pkgpart}
1211 # Conditions for setting setup date and charging the setup fee:
1212 # - this is not a recurring-only billing run
1213 # - and the package is not currently being canceled
1214 # - and, unless we're specifically told otherwise via 'resetup':
1215 # - it doesn't already HAVE a setup date
1216 # - or a start date in the future
1217 # - and it's not suspended
1218 # - and it doesn't have an expire date in the past
1220 # The "disable_setup_suspended" option is now obsolete; we never set the
1221 # setup date on a suspended package.
1222 if ( ! $options{recurring_only}
1223 and ! $options{cancel}
1224 and ( $options{'resetup'}
1225 || ( ! $cust_pkg->setup
1226 && ( ! $cust_pkg->start_date
1227 || $cust_pkg->start_date <= $cmp_time
1229 && ( ! $cust_pkg->getfield('susp') )
1232 and ( ! $cust_pkg->expire
1233 || $cust_pkg->expire > $cmp_time )
1237 warn " bill setup\n" if $DEBUG > 1;
1239 unless ( $cust_pkg->waive_setup ) {
1242 $setup = eval { $cust_pkg->calc_setup( $time, \@details, \%setup_param ) };
1243 return "$@ running calc_setup for $cust_pkg\n"
1246 # Only increment unitsetup here if there IS a setup fee.
1247 # prorate_defer_bill may cause calc_setup on a setup-stage package
1248 # to return zero, and the setup fee to be charged later. (This happens
1249 # when it's first billed on the prorate cutoff day. RT#31276.)
1251 $unitsetup = $cust_pkg->base_setup()
1257 if $cust_pkg->waive_setup && $part_pkg->can('prorate_setup') && $part_pkg->prorate_setup($cust_pkg, $time);
1259 $cust_pkg->setfield('setup', $time)
1260 unless $cust_pkg->setup;
1261 #do need it, but it won't get written to the db
1262 #|| $cust_pkg->pkgpart != $real_pkgpart;
1264 $cust_pkg->setfield('start_date', '')
1265 if $cust_pkg->start_date;
1270 # bill recurring fee
1275 my @recur_discounts = ();
1278 my $override_quantity;
1280 # Conditions for billing the recurring fee:
1281 # - the package doesn't have a future start date
1282 # - and it's not suspended
1283 # - unless suspend_bill is enabled on the package or package def
1284 # - but still not, if the package is on hold
1285 # - or it's suspended for a delayed cancellation
1286 # - and its next bill date is in the past
1287 # - or it doesn't have a next bill date yet
1288 # - or it's a one-time charge
1289 # - or it's a CDR plan with the "bill_every_call" option
1290 # - or it's being canceled
1291 # - and it doesn't have an expire date in the past (this can happen with
1293 # - again, unless it's being canceled
1294 if ( ! $cust_pkg->start_date
1297 || ( $cust_pkg->susp != $cust_pkg->order_date
1298 && ( $cust_pkg->option('suspend_bill',1)
1299 || ( $part_pkg->option('suspend_bill', 1)
1300 && ! $cust_pkg->option('no_suspend_bill',1)
1304 || $cust_pkg->is_status_delay_cancel
1307 ( $part_pkg->freq ne '0' && ( $cust_pkg->bill || 0 ) <= $cmp_time )
1308 || ( $part_pkg->plan eq 'voip_cdr'
1309 && $part_pkg->option('bill_every_call')
1314 ( ! $cust_pkg->expire
1315 || $cust_pkg->expire > $cmp_time
1320 # XXX should this be a package event? probably. events are called
1321 # at collection time at the moment, though...
1322 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
1323 if $part_pkg->can('reset_usage') && !$options{'no_usage_reset'};
1324 #don't want to reset usage just cause we want a line item??
1325 #&& $part_pkg->pkgpart == $real_pkgpart;
1327 warn " bill recur\n" if $DEBUG > 1;
1330 # XXX shared with $recur_prog
1331 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
1335 #over two params! lets at least switch to a hashref for the rest...
1336 my $increment_next_bill = ( $part_pkg->freq ne '0'
1337 && ( $cust_pkg->getfield('bill') || 0 ) <= $cmp_time
1338 && !$options{cancel}
1340 my %param = ( %setup_param,
1341 'precommit_hooks' => $precommit_hooks,
1342 'increment_next_bill' => $increment_next_bill,
1343 'discounts' => \@recur_discounts,
1344 'real_pkgpart' => $real_pkgpart,
1345 'freq_override' => $options{freq_override} || '',
1349 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
1351 # There may be some part_pkg for which this is wrong. Only those
1352 # which can_discount are supported.
1353 # (the UI should prevent adding discounts to these at the moment)
1355 warn "calling $method on cust_pkg ". $cust_pkg->pkgnum.
1356 " for pkgpart ". $cust_pkg->pkgpart.
1357 " with params ". join(' / ', map "$_=>$param{$_}", keys %param). "\n"
1360 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
1361 return "$@ running $method for $cust_pkg\n"
1364 if ($recur eq 'NOTHING') {
1365 # then calc_cancel (or calc_recur but that's not used) has declined to
1366 # generate a recurring lineitem at all. treat this as zero, but also
1367 # try not to generate a lineitem.
1373 $unitrecur = $cust_pkg->base_recur( \$sdate ) || $recur; #XXX uuh, better
1375 if ( $param{'override_quantity'} ) {
1376 $override_quantity = $param{'override_quantity'};
1377 $unitrecur = $recur / $override_quantity;
1380 if ( $increment_next_bill ) {
1384 if ( my $main_pkg = $cust_pkg->main_pkg ) {
1385 # supplemental package
1386 # to keep in sync with the main package, simulate billing at
1388 my $main_pkg_freq = $main_pkg->part_pkg->freq;
1389 my $supp_pkg_freq = $part_pkg->freq;
1390 my $ratio = $supp_pkg_freq / $main_pkg_freq;
1391 if ( $ratio != int($ratio) ) {
1392 # the UI should prevent setting up packages like this, but just
1394 return "supplemental package period is not an integer multiple of main package period";
1396 $next_bill = $sdate;
1398 $next_bill = $part_pkg->add_freq( $next_bill, $main_pkg_freq );
1403 $next_bill = $part_pkg->add_freq($sdate, $options{freq_override} || 0);
1404 return "unparsable frequency: ".
1405 ($options{freq_override} || $part_pkg->freq)
1406 if $next_bill == -1;
1409 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
1410 # only for figuring next bill date, nothing else, so, reset $sdate again
1412 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1413 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
1414 $cust_pkg->last_bill($sdate);
1416 $cust_pkg->setfield('bill', $next_bill );
1420 if ( $param{'setup_fee'} ) {
1421 # Add an additional setup fee at the billing stage.
1422 # Used for prorate_defer_bill.
1423 $setup += $param{'setup_fee'};
1424 $unitsetup = $cust_pkg->base_setup();
1428 if ( defined $param{'discount_left_setup'} ) {
1429 foreach my $discount_setup ( values %{$param{'discount_left_setup'}} ) {
1430 $setup -= $discount_setup;
1434 } # end of recurring fee
1436 warn "\$setup is undefined" unless defined($setup);
1437 warn "\$recur is undefined" unless defined($recur);
1438 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1441 # If there's line items, create em cust_bill_pkg records
1442 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
1447 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
1448 # hmm.. and if just the options are modified in some weird price plan?
1450 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
1453 my $error = $cust_pkg->replace( $old_cust_pkg,
1454 'depend_jobnum'=>$options{depend_jobnum},
1455 'options' => { $cust_pkg->options },
1457 unless $options{no_commit};
1458 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
1459 if $error; #just in case
1462 $setup = sprintf( "%.2f", $setup );
1463 $recur = sprintf( "%.2f", $recur );
1464 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
1465 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1467 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
1468 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
1471 my $discount_show_always = $conf->exists('discount-show-always')
1472 && ( ($setup == 0 && scalar(@setup_discounts))
1473 || ($recur == 0 && scalar(@recur_discounts))
1478 || (!$part_pkg->hidden && $options{has_hidden}) #include some $0 lines
1479 || $discount_show_always
1480 || ($setup == 0 && $cust_pkg->_X_show_zero('setup'))
1481 || ($recur == 0 && $cust_pkg->_X_show_zero('recur'))
1485 warn " charges (setup=$setup, recur=$recur); adding line items\n"
1488 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
1490 warn " adding customer package invoice detail: $_\n"
1491 foreach @cust_pkg_detail;
1493 push @details, @cust_pkg_detail;
1495 my $cust_bill_pkg = new FS::cust_bill_pkg {
1496 'pkgnum' => $cust_pkg->pkgnum,
1498 'unitsetup' => sprintf('%.2f', $unitsetup),
1500 'unitrecur' => sprintf('%.2f', $unitrecur),
1501 'quantity' => $override_quantity || $cust_pkg->quantity,
1502 'details' => \@details,
1503 'discounts' => [ @setup_discounts, @recur_discounts ],
1504 'hidden' => $part_pkg->hidden,
1505 'freq' => $part_pkg->freq,
1508 if ( $part_pkg->option('prorate_defer_bill',1)
1509 and !$hash{last_bill} ) {
1510 # both preceding and upcoming, technically
1511 $cust_bill_pkg->sdate( $cust_pkg->setup );
1512 $cust_bill_pkg->edate( $cust_pkg->bill );
1513 } elsif ( $part_pkg->recur_temporality eq 'preceding' ) {
1514 $cust_bill_pkg->sdate( $hash{last_bill} );
1515 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
1516 $cust_bill_pkg->edate( $time ) if $options{cancel};
1517 } else { #if ( $part_pkg->recur_temporality eq 'upcoming' ) {
1518 $cust_bill_pkg->sdate( $sdate );
1519 $cust_bill_pkg->edate( $cust_pkg->bill );
1520 #$cust_bill_pkg->edate( $time ) if $options{cancel};
1523 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
1524 unless $part_pkg->pkgpart == $real_pkgpart;
1526 $$total_setup += $setup;
1527 $$total_recur += $recur;
1533 my $error = $self->_handle_taxes( $taxlisthash, $cust_bill_pkg,
1534 cancel => $options{cancel} );
1535 return $error if $error;
1537 $cust_bill_pkg->set_display(
1538 part_pkg => $part_pkg,
1539 real_pkgpart => $real_pkgpart,
1542 push @$cust_bill_pkgs, $cust_bill_pkg;
1544 } #if $setup != 0 || $recur != 0
1552 =item _transfer_balance TO_PKG [ FROM_PKGNUM ]
1554 Takes one argument, a cust_pkg object that is being billed. This will
1555 be called only if the package was created by a package change, and has
1556 not been billed since the package change, and package balance tracking
1557 is enabled. The second argument can be an alternate package number to
1558 transfer the balance from; this should not be used externally.
1560 Transfers the balance from the previous package (now canceled) to
1561 this package, by crediting one package and creating an invoice item for
1562 the other. Inserts the credit and returns the invoice item (so that it
1563 can be added to an invoice that's being built).
1565 If the previous package was never billed, and was also created by a package
1566 change, then this will also transfer the balance from I<its> previous
1567 package, and so on, until reaching a package that either has been billed
1568 or was not created by a package change.
1572 my $balance_transfer_reason;
1574 sub _transfer_balance {
1576 my $cust_pkg = shift;
1577 my $from_pkgnum = shift || $cust_pkg->change_pkgnum;
1578 my $from_pkg = FS::cust_pkg->by_key($from_pkgnum);
1582 # if $from_pkg is not the first package in the chain, and it was never
1584 if ( $from_pkg->change_pkgnum and scalar($from_pkg->cust_bill_pkg) == 0 ) {
1585 @transfers = $self->_transfer_balance($cust_pkg, $from_pkg->change_pkgnum);
1588 my $prev_balance = $self->balance_pkgnum($from_pkgnum);
1589 if ( $prev_balance != 0 ) {
1590 $balance_transfer_reason ||= FS::reason->new_or_existing(
1591 'reason' => 'Package balance transfer',
1592 'type' => 'Internal adjustment',
1596 my $credit = FS::cust_credit->new({
1597 'custnum' => $self->custnum,
1598 'amount' => abs($prev_balance),
1599 'reasonnum' => $balance_transfer_reason->reasonnum,
1600 '_date' => $cust_pkg->change_date,
1603 my $cust_bill_pkg = FS::cust_bill_pkg->new({
1605 'recur' => abs($prev_balance),
1606 #'sdate' => $from_pkg->last_bill, # not sure about this
1607 #'edate' => $cust_pkg->change_date,
1608 'itemdesc' => $self->mt('Previous Balance, [_1]',
1609 $from_pkg->part_pkg->pkg),
1612 if ( $prev_balance > 0 ) {
1613 # credit the old package, charge the new one
1614 $credit->set('pkgnum', $from_pkgnum);
1615 $cust_bill_pkg->set('pkgnum', $cust_pkg->pkgnum);
1618 $credit->set('pkgnum', $cust_pkg->pkgnum);
1619 $cust_bill_pkg->set('pkgnum', $from_pkgnum);
1621 my $error = $credit->insert;
1622 die "error transferring package balance from #".$from_pkgnum.
1623 " to #".$cust_pkg->pkgnum.": $error\n" if $error;
1625 push @transfers, $cust_bill_pkg;
1626 } # $prev_balance != 0
1631 =item handle_taxes TAXLISTHASH CUST_BILL_PKG [ OPTIONS ]
1633 This is _handle_taxes. It's called once for each cust_bill_pkg generated
1636 TAXLISTHASH is a hashref shared across the entire invoice. It looks like
1639 'cust_main_county 1001' => [ [FS::cust_main_county], ... ],
1640 'cust_main_county 1002' => [ [FS::cust_main_county], ... ],
1643 'cust_main_county' can also be 'tax_rate'. The first object in the array
1644 is always the cust_main_county or tax_rate identified by the key.
1646 That "..." is a list of FS::cust_bill_pkg objects that will be fed to
1647 the 'taxline' method to calculate the amount of the tax. This doesn't
1648 happen until calculate_taxes, though.
1650 OPTIONS may include:
1651 - part_item: a part_pkg or part_fee object to be used as the package/fee
1653 - location: a cust_location to be used as the billing location.
1654 - cancel: true if this package is being billed on cancellation. This
1655 allows tax to be calculated on usage charges only.
1657 If not supplied, part_item will be inferred from the pkgnum or feepart of the
1658 cust_bill_pkg, and location from the pkgnum (or, for fees, the invnum and
1659 the customer's default service location).
1661 This method will also calculate exemptions for any taxes that apply to the
1662 line item (using the C<set_exemptions> method of L<FS::cust_bill_pkg>) and
1663 attach them. This is the only place C<set_exemptions> is called in normal
1670 my $taxlisthash = shift;
1671 my $cust_bill_pkg = shift;
1674 # at this point I realize that we have enough information to infer all this
1675 # stuff, instead of passing around giant honking argument lists
1676 my $location = $options{location} || $cust_bill_pkg->tax_location;
1677 my $part_item = $options{part_item} || $cust_bill_pkg->part_X;
1679 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1681 return if ( $self->payby eq 'COMP' ); #dubious
1683 if ( $conf->exists('enable_taxproducts')
1684 && ( scalar($part_item->part_pkg_taxoverride)
1685 || $part_item->has_taxproduct
1690 # EXTERNAL TAX RATES (via tax_rate)
1691 my %cust_bill_pkg = ();
1695 my $usage = $cust_bill_pkg->usage || 0;
1696 push @classes, $cust_bill_pkg->usage_classes if $usage;
1697 push @classes, 'setup' if $cust_bill_pkg->setup and !$options{cancel};
1698 push @classes, 'recur' if ($cust_bill_pkg->recur - $usage)
1699 and !$options{cancel};
1700 # that's better--probably don't even need $options{cancel} now
1701 # but leave it for now, just to be safe
1703 # About $options{cancel}: This protects against charging per-line or
1704 # per-customer or other flat-rate surcharges on a package that's being
1705 # billed on cancellation (which is an out-of-cycle bill and should only
1706 # have usage charges). See RT#29443.
1708 # customer exemption is now handled in the 'taxline' method
1709 #my $exempt = $conf->exists('cust_class-tax_exempt')
1710 # ? ( $self->cust_class ? $self->cust_class->tax : '' )
1712 # standardize this just to be sure
1713 #$exempt = ($exempt eq 'Y') ? 'Y' : '';
1717 unless (exists $taxes{''}) {
1718 # unsure what purpose this serves, but last time I deleted something
1719 # from here just because I didn't see the point, it actually did
1720 # something important.
1721 my $err_or_ref = $self->_gather_taxes($part_item, '', $location);
1722 return $err_or_ref unless ref($err_or_ref);
1723 $taxes{''} = $err_or_ref;
1726 # NO DISINTEGRATIONS.
1727 # my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
1729 # do not call taxline() with any argument except the entire set of
1730 # cust_bill_pkgs on an invoice that are eligible for the tax.
1732 # only calculate exemptions once for each tax rate, even if it's used
1733 # for multiple classes
1736 foreach my $class (@classes) {
1737 my $err_or_ref = $self->_gather_taxes($part_item, $class, $location);
1738 return $err_or_ref unless ref($err_or_ref);
1739 my @taxes = @$err_or_ref;
1743 foreach my $tax ( @taxes ) {
1745 my $tax_id = ref( $tax ). ' '. $tax->taxnum;
1746 # $taxlisthash: keys are tax identifiers ('FS::tax_rate 123456').
1747 # Values are arrayrefs, first the tax object (cust_main_county
1748 # or tax_rate), then the cust_bill_pkg object that the
1749 # tax applies to, then the tax class (setup, recur, usage classnum).
1750 $taxlisthash->{ $tax_id } ||= [ $tax ];
1751 push @{ $taxlisthash->{ $tax_id } }, $cust_bill_pkg, $class;
1753 # determine any exemptions that apply
1754 if (!$tax_seen{$tax_id}) {
1755 $cust_bill_pkg->set_exemptions( $tax, custnum => $self->custnum );
1756 $tax_seen{$tax_id} = 1;
1759 # tax on tax will be done later, when we actually create the tax
1767 # INTERNAL TAX RATES (cust_main_county)
1769 # We fetch taxes even if the customer is completely exempt,
1770 # because we need to record that fact.
1772 my %taxhash = map { $_ => $location->get($_) }
1773 qw( district county state country );
1774 # city names in cust_main_county are uppercase
1775 $taxhash{'city'} = uc($location->get('city'));
1777 $taxhash{'taxclass'} = $part_item->taxclass;
1779 warn "taxhash:\n". Dumper(\%taxhash) if $DEBUG > 2;
1781 my @taxes = (); # entries are cust_main_county objects
1782 my %taxhash_elim = %taxhash;
1783 my @elim = qw( district city county state );
1786 #first try a match with taxclass
1787 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1789 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1790 #then try a match without taxclass
1791 my %no_taxclass = %taxhash_elim;
1792 $no_taxclass{ 'taxclass' } = '';
1793 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1796 $taxhash_elim{ shift(@elim) } = '';
1798 } while ( !scalar(@taxes) && scalar(@elim) );
1801 my $tax_id = 'cust_main_county '.$_->taxnum;
1802 $taxlisthash->{$tax_id} ||= [ $_ ];
1803 $cust_bill_pkg->set_exemptions($_, custnum => $self->custnum);
1804 push @{ $taxlisthash->{$tax_id} }, $cust_bill_pkg;
1811 =item _gather_taxes PART_ITEM CLASS CUST_LOCATION
1813 Internal method used with vendor-provided tax tables. PART_ITEM is a part_pkg
1814 or part_fee (which will define the tax eligibility of the product), CLASS is
1815 'setup', 'recur', null, or a C<usage_class> number, and CUST_LOCATION is the
1816 location where the service was provided (or billed, depending on
1817 configuration). Returns an arrayref of L<FS::tax_rate> objects that
1818 can apply to this line item.
1824 my $part_item = shift;
1826 my $location = shift;
1828 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1830 my $geocode = $location->geocode('cch');
1832 [ $part_item->tax_rates('cch', $geocode, $class) ]
1836 =item collect [ HASHREF | OPTION => VALUE ... ]
1838 (Attempt to) collect money for this customer's outstanding invoices (see
1839 L<FS::cust_bill>). Usually used after the bill method.
1841 Actions are now triggered by billing events; see L<FS::part_event> and the
1842 billing events web interface. Old-style invoice events (see
1843 L<FS::part_bill_event>) have been deprecated.
1845 If there is an error, returns the error, otherwise returns false.
1847 Options are passed as name-value pairs.
1849 Currently available options are:
1855 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.
1859 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1863 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1867 set true to surpress email card/ACH decline notices.
1871 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)
1877 # allows for one time override of normal customer billing method
1882 my( $self, %options ) = @_;
1884 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1886 my $invoice_time = $options{'invoice_time'} || time;
1889 local $SIG{HUP} = 'IGNORE';
1890 local $SIG{INT} = 'IGNORE';
1891 local $SIG{QUIT} = 'IGNORE';
1892 local $SIG{TERM} = 'IGNORE';
1893 local $SIG{TSTP} = 'IGNORE';
1894 local $SIG{PIPE} = 'IGNORE';
1896 my $oldAutoCommit = $FS::UID::AutoCommit;
1897 local $FS::UID::AutoCommit = 0;
1900 $self->select_for_update; #mutex
1903 my $balance = $self->balance;
1904 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
1907 if ( exists($options{'retry_card'}) ) {
1908 carp 'retry_card option passed to collect is deprecated; use retry';
1909 $options{'retry'} ||= $options{'retry_card'};
1911 if ( exists($options{'retry'}) && $options{'retry'} ) {
1912 my $error = $self->retry_realtime;
1914 $dbh->rollback if $oldAutoCommit;
1919 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1921 #never want to roll back an event just because it returned an error
1922 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1924 $self->do_cust_event(
1925 'debug' => ( $options{'debug'} || 0 ),
1926 'time' => $invoice_time,
1927 'check_freq' => $options{'check_freq'},
1928 'stage' => 'collect',
1933 =item retry_realtime
1935 Schedules realtime / batch credit card / electronic check / LEC billing
1936 events for for retry. Useful if card information has changed or manual
1937 retry is desired. The 'collect' method must be called to actually retry
1940 Implementation details: For either this customer, or for each of this
1941 customer's open invoices, changes the status of the first "done" (with
1942 statustext error) realtime processing event to "failed".
1946 sub retry_realtime {
1949 local $SIG{HUP} = 'IGNORE';
1950 local $SIG{INT} = 'IGNORE';
1951 local $SIG{QUIT} = 'IGNORE';
1952 local $SIG{TERM} = 'IGNORE';
1953 local $SIG{TSTP} = 'IGNORE';
1954 local $SIG{PIPE} = 'IGNORE';
1956 my $oldAutoCommit = $FS::UID::AutoCommit;
1957 local $FS::UID::AutoCommit = 0;
1960 #a little false laziness w/due_cust_event (not too bad, really)
1962 # I guess this is always as of now?
1963 my $join = FS::part_event_condition->join_conditions_sql('', 'time' => time);
1964 my $order = FS::part_event_condition->order_conditions_sql;
1967 . join ( ' OR ' , map {
1968 my $cust_join = FS::part_event->eventtables_cust_join->{$_} || '';
1969 my $custnum = FS::part_event->eventtables_custnum->{$_};
1970 "( part_event.eventtable = " . dbh->quote($_)
1971 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key
1972 . " from $_ $cust_join"
1973 . " where $custnum = " . dbh->quote( $self->custnum ) . "))" ;
1974 } FS::part_event->eventtables)
1977 #here is the agent virtualization
1978 my $agent_virt = " ( part_event.agentnum IS NULL
1979 OR part_event.agentnum = ". $self->agentnum. ' )';
1981 #XXX this shouldn't be hardcoded, actions should declare it...
1982 my @realtime_events = qw(
1983 cust_bill_realtime_card
1984 cust_bill_realtime_check
1985 cust_bill_realtime_lec
1989 my $is_realtime_event =
1990 ' part_event.action IN ( '.
1991 join(',', map "'$_'", @realtime_events ).
1994 my $batch_or_statustext =
1995 "( part_event.action = 'cust_bill_batch'
1996 OR ( statustext IS NOT NULL AND statustext != '' )
2000 my @cust_event = qsearch({
2001 'table' => 'cust_event',
2002 'select' => 'cust_event.*',
2003 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
2004 'hashref' => { 'status' => 'done' },
2005 'extra_sql' => " AND $batch_or_statustext ".
2006 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
2009 my %seen_invnum = ();
2010 foreach my $cust_event (@cust_event) {
2012 #max one for the customer, one for each open invoice
2013 my $cust_X = $cust_event->cust_X;
2014 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
2018 or $cust_event->part_event->eventtable eq 'cust_bill'
2021 my $error = $cust_event->retry;
2023 $dbh->rollback if $oldAutoCommit;
2024 return "error scheduling event for retry: $error";
2029 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2034 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
2036 Runs billing events; see L<FS::part_event> and the billing events web
2039 If there is an error, returns the error, otherwise returns false.
2041 Options are passed as name-value pairs.
2043 Currently available options are:
2049 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.
2053 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
2057 "collect" (the default) or "pre-bill"
2061 set true to surpress email card/ACH decline notices.
2065 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)
2072 # allows for one time override of normal customer billing method
2076 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
2079 my( $self, %options ) = @_;
2081 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
2083 my $time = $options{'time'} || time;
2086 local $SIG{HUP} = 'IGNORE';
2087 local $SIG{INT} = 'IGNORE';
2088 local $SIG{QUIT} = 'IGNORE';
2089 local $SIG{TERM} = 'IGNORE';
2090 local $SIG{TSTP} = 'IGNORE';
2091 local $SIG{PIPE} = 'IGNORE';
2093 my $oldAutoCommit = $FS::UID::AutoCommit;
2094 local $FS::UID::AutoCommit = 0;
2097 $self->select_for_update; #mutex
2100 my $balance = $self->balance;
2101 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
2104 # if ( exists($options{'retry_card'}) ) {
2105 # carp 'retry_card option passed to collect is deprecated; use retry';
2106 # $options{'retry'} ||= $options{'retry_card'};
2108 # if ( exists($options{'retry'}) && $options{'retry'} ) {
2109 # my $error = $self->retry_realtime;
2111 # $dbh->rollback if $oldAutoCommit;
2116 # false laziness w/pay_batch::import_results
2118 my $due_cust_event = $self->due_cust_event(
2119 'debug' => ( $options{'debug'} || 0 ),
2121 'check_freq' => $options{'check_freq'},
2122 'stage' => ( $options{'stage'} || 'collect' ),
2124 unless( ref($due_cust_event) ) {
2125 $dbh->rollback if $oldAutoCommit;
2126 return $due_cust_event;
2129 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2130 #never want to roll back an event just because it or a different one
2132 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
2134 foreach my $cust_event ( @$due_cust_event ) {
2138 #re-eval event conditions (a previous event could have changed things)
2139 unless ( $cust_event->test_conditions ) {
2140 #don't leave stray "new/locked" records around
2141 my $error = $cust_event->delete;
2142 return $error if $error;
2147 local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
2148 if $options{'quiet'};
2149 warn " running cust_event ". $cust_event->eventnum. "\n"
2152 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
2153 if ( my $error = $cust_event->do_event( 'time' => $time ) ) {
2154 #XXX wtf is this? figure out a proper dealio with return value
2166 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
2168 Inserts database records for and returns an ordered listref of new events due
2169 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
2170 events are due, an empty listref is returned. If there is an error, returns a
2171 scalar error message.
2173 To actually run the events, call each event's test_condition method, and if
2174 still true, call the event's do_event method.
2176 Options are passed as a hashref or as a list of name-value pairs. Available
2183 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.
2187 "collect" (the default) or "pre-bill"
2191 "Current time" for the events.
2195 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)
2199 Only return events for the specified eventtable (by default, events of all eventtables are returned)
2203 Explicitly pass the objects to be tested (typically used with eventtable).
2207 Set to true to return the objects, but not actually insert them into the
2214 sub due_cust_event {
2216 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
2219 #my $DEBUG = $opt{'debug'}
2220 $opt{'debug'} ||= 0; # silence some warnings
2221 local($DEBUG) = $opt{'debug'}
2222 if $opt{'debug'} > $DEBUG;
2223 $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
2225 warn "$me due_cust_event called with options ".
2226 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
2229 $opt{'time'} ||= time;
2231 local $SIG{HUP} = 'IGNORE';
2232 local $SIG{INT} = 'IGNORE';
2233 local $SIG{QUIT} = 'IGNORE';
2234 local $SIG{TERM} = 'IGNORE';
2235 local $SIG{TSTP} = 'IGNORE';
2236 local $SIG{PIPE} = 'IGNORE';
2238 my $oldAutoCommit = $FS::UID::AutoCommit;
2239 local $FS::UID::AutoCommit = 0;
2242 $self->select_for_update #mutex
2243 unless $opt{testonly};
2246 # find possible events (initial search)
2249 my @cust_event = ();
2251 my @eventtable = $opt{'eventtable'}
2252 ? ( $opt{'eventtable'} )
2253 : FS::part_event->eventtables_runorder;
2255 my $check_freq = $opt{'check_freq'} || '1d';
2257 foreach my $eventtable ( @eventtable ) {
2260 if ( $opt{'objects'} ) {
2262 @objects = @{ $opt{'objects'} };
2264 } elsif ( $eventtable eq 'cust_main' ) {
2266 @objects = ( $self );
2270 my $cm_join = " LEFT JOIN cust_main USING ( custnum )";
2271 # linkage not needed here because FS::cust_main->$eventtable will
2274 #some false laziness w/Cron::bill bill_where
2276 my $join = FS::part_event_condition->join_conditions_sql( $eventtable,
2277 'time' => $opt{'time'});
2278 my $where = FS::part_event_condition->where_conditions_sql($eventtable,
2279 'time'=>$opt{'time'},
2281 $where = $where ? "AND $where" : '';
2283 my $are_part_event =
2284 "EXISTS ( SELECT 1 FROM part_event $join
2285 WHERE check_freq = '$check_freq'
2286 AND eventtable = '$eventtable'
2287 AND ( disabled = '' OR disabled IS NULL )
2293 @objects = $self->$eventtable(
2294 'addl_from' => $cm_join,
2295 'extra_sql' => " AND $are_part_event",
2297 } # if ( !$opt{objects} and $eventtable ne 'cust_main' )
2299 my @e_cust_event = ();
2301 my $linkage = FS::part_event->eventtables_cust_join->{$eventtable} || '';
2303 my $cross = "CROSS JOIN $eventtable $linkage";
2304 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
2305 unless $eventtable eq 'cust_main';
2307 foreach my $object ( @objects ) {
2309 #this first search uses the condition_sql magic for optimization.
2310 #the more possible events we can eliminate in this step the better
2312 my $cross_where = '';
2313 my $pkey = $object->primary_key;
2314 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
2316 my $join = FS::part_event_condition->join_conditions_sql( $eventtable,
2317 'time' => $opt{'time'});
2319 FS::part_event_condition->where_conditions_sql( $eventtable,
2320 'time'=>$opt{'time'}
2322 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
2324 $extra_sql = "AND $extra_sql" if $extra_sql;
2326 #here is the agent virtualization
2327 $extra_sql .= " AND ( part_event.agentnum IS NULL
2328 OR part_event.agentnum = ". $self->agentnum. ' )';
2330 $extra_sql .= " $order";
2332 warn "searching for events for $eventtable ". $object->$pkey. "\n"
2333 if $opt{'debug'} > 2;
2334 my @part_event = qsearch( {
2335 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
2336 'select' => 'part_event.*',
2337 'table' => 'part_event',
2338 'addl_from' => "$cross $join",
2339 'hashref' => { 'check_freq' => $check_freq,
2340 'eventtable' => $eventtable,
2343 'extra_sql' => "AND $cross_where $extra_sql",
2347 my $pkey = $object->primary_key;
2348 warn " ". scalar(@part_event).
2349 " possible events found for $eventtable ". $object->$pkey(). "\n";
2352 push @e_cust_event, map {
2353 $_->new_cust_event($object, 'time' => $opt{'time'})
2358 warn " ". scalar(@e_cust_event).
2359 " subtotal possible cust events found for $eventtable\n"
2362 push @cust_event, @e_cust_event;
2366 warn " ". scalar(@cust_event).
2367 " total possible cust events found in initial search\n"
2375 $opt{stage} ||= 'collect';
2377 grep { my $stage = $_->part_event->event_stage;
2378 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
2388 @cust_event = grep $_->test_conditions( 'stats_hashref' => \%unsat ),
2391 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
2394 warn " invalid conditions not eliminated with condition_sql:\n".
2395 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
2396 if keys %unsat && $DEBUG; # > 1;
2402 unless( $opt{testonly} ) {
2403 foreach my $cust_event ( @cust_event ) {
2405 my $error = $cust_event->insert();
2407 $dbh->rollback if $oldAutoCommit;
2414 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2420 warn " returning events: ". Dumper(@cust_event). "\n"
2427 =item apply_payments_and_credits [ OPTION => VALUE ... ]
2429 Applies unapplied payments and credits.
2430 Payments with the no_auto_apply flag set will not be applied.
2432 In most cases, this new method should be used in place of sequential
2433 apply_payments and apply_credits methods.
2435 A hash of optional arguments may be passed. Currently "manual" is supported.
2436 If true, a payment receipt is sent instead of a statement when
2437 'payment_receipt_email' configuration option is set.
2439 If there is an error, returns the error, otherwise returns false.
2443 sub apply_payments_and_credits {
2444 my( $self, %options ) = @_;
2446 local $SIG{HUP} = 'IGNORE';
2447 local $SIG{INT} = 'IGNORE';
2448 local $SIG{QUIT} = 'IGNORE';
2449 local $SIG{TERM} = 'IGNORE';
2450 local $SIG{TSTP} = 'IGNORE';
2451 local $SIG{PIPE} = 'IGNORE';
2453 my $oldAutoCommit = $FS::UID::AutoCommit;
2454 local $FS::UID::AutoCommit = 0;
2457 $self->select_for_update; #mutex
2459 foreach my $cust_bill ( $self->open_cust_bill ) {
2460 my $error = $cust_bill->apply_payments_and_credits(%options);
2462 $dbh->rollback if $oldAutoCommit;
2463 return "Error applying: $error";
2467 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2472 =item apply_credits OPTION => VALUE ...
2474 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
2475 to outstanding invoice balances in chronological order (or reverse
2476 chronological order if the I<order> option is set to B<newest>) and returns the
2477 value of any remaining unapplied credits available for refund (see
2478 L<FS::cust_refund>).
2480 Dies if there is an error.
2488 local $SIG{HUP} = 'IGNORE';
2489 local $SIG{INT} = 'IGNORE';
2490 local $SIG{QUIT} = 'IGNORE';
2491 local $SIG{TERM} = 'IGNORE';
2492 local $SIG{TSTP} = 'IGNORE';
2493 local $SIG{PIPE} = 'IGNORE';
2495 my $oldAutoCommit = $FS::UID::AutoCommit;
2496 local $FS::UID::AutoCommit = 0;
2499 $self->select_for_update; #mutex
2501 unless ( $self->total_unapplied_credits ) {
2502 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2506 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
2507 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
2509 my @invoices = $self->open_cust_bill;
2510 @invoices = sort { $b->_date <=> $a->_date } @invoices
2511 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
2513 if ( $conf->exists('pkg-balances') ) {
2514 # limit @credits to those w/ a pkgnum grepped from $self
2516 foreach my $i (@invoices) {
2517 foreach my $li ( $i->cust_bill_pkg ) {
2518 $pkgnums{$li->pkgnum} = 1;
2521 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
2526 foreach my $cust_bill ( @invoices ) {
2528 if ( !defined($credit) || $credit->credited == 0) {
2529 $credit = pop @credits or last;
2533 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
2534 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
2536 $owed = $cust_bill->owed;
2538 unless ( $owed > 0 ) {
2539 push @credits, $credit;
2543 my $amount = min( $credit->credited, $owed );
2545 my $cust_credit_bill = new FS::cust_credit_bill ( {
2546 'crednum' => $credit->crednum,
2547 'invnum' => $cust_bill->invnum,
2548 'amount' => $amount,
2550 $cust_credit_bill->pkgnum( $credit->pkgnum )
2551 if $conf->exists('pkg-balances') && $credit->pkgnum;
2552 my $error = $cust_credit_bill->insert;
2554 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2558 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2562 my $total_unapplied_credits = $self->total_unapplied_credits;
2564 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2566 return $total_unapplied_credits;
2569 =item apply_payments [ OPTION => VALUE ... ]
2571 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2572 to outstanding invoice balances in chronological order.
2573 Payments with the no_auto_apply flag set will not be applied.
2575 #and returns the value of any remaining unapplied payments.
2577 A hash of optional arguments may be passed. Currently "manual" is supported.
2578 If true, a payment receipt is sent instead of a statement when
2579 'payment_receipt_email' configuration option is set.
2581 Dies if there is an error.
2585 sub apply_payments {
2586 my( $self, %options ) = @_;
2588 local $SIG{HUP} = 'IGNORE';
2589 local $SIG{INT} = 'IGNORE';
2590 local $SIG{QUIT} = 'IGNORE';
2591 local $SIG{TERM} = 'IGNORE';
2592 local $SIG{TSTP} = 'IGNORE';
2593 local $SIG{PIPE} = 'IGNORE';
2595 my $oldAutoCommit = $FS::UID::AutoCommit;
2596 local $FS::UID::AutoCommit = 0;
2599 $self->select_for_update; #mutex
2603 my @payments = grep { !$_->no_auto_apply } $self->unapplied_cust_pay;
2605 my @invoices = $self->open_cust_bill;
2607 if ( $conf->exists('pkg-balances') ) {
2608 # limit @payments to those w/ a pkgnum grepped from $self
2610 foreach my $i (@invoices) {
2611 foreach my $li ( $i->cust_bill_pkg ) {
2612 $pkgnums{$li->pkgnum} = 1;
2615 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
2620 foreach my $cust_bill ( @invoices ) {
2622 if ( !defined($payment) || $payment->unapplied == 0 ) {
2623 $payment = pop @payments or last;
2627 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
2628 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
2630 $owed = $cust_bill->owed;
2632 unless ( $owed > 0 ) {
2633 push @payments, $payment;
2637 my $amount = min( $payment->unapplied, $owed );
2640 'paynum' => $payment->paynum,
2641 'invnum' => $cust_bill->invnum,
2642 'amount' => $amount,
2644 $cbp->{_date} = $payment->_date
2645 if $options{'manual'} && $options{'backdate_application'};
2646 my $cust_bill_pay = new FS::cust_bill_pay($cbp);
2647 $cust_bill_pay->pkgnum( $payment->pkgnum )
2648 if $conf->exists('pkg-balances') && $payment->pkgnum;
2649 my $error = $cust_bill_pay->insert(%options);
2651 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2655 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2659 my $total_unapplied_payments = $self->total_unapplied_payments;
2661 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2663 return $total_unapplied_payments;
2673 suspend_adjourned_pkgs
2674 unsuspend_resumed_pkgs
2677 (do_cust_event pre-bill)
2680 (vendor-only) _gather_taxes
2681 _omit_zero_value_bundles
2682 _handle_taxes (for fees)
2685 apply_payments_and_credits
2694 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>