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;
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 By default, warns on errors and continues with the next operation (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; }
133 elsif ( $options{fatal} ) { die $error; }
134 else { warn $error; }
137 $log->debug('suspending adjourned packages', %logopt);
138 $error = $self->suspend_adjourned_pkgs( $actual_time );
140 $error = "Error adjourning custnum ". $self->custnum. ": $error";
141 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
142 elsif ( $options{fatal} ) { die $error; }
143 else { warn $error; }
146 $log->debug('unsuspending resumed packages', %logopt);
147 $error = $self->unsuspend_resumed_pkgs( $actual_time );
149 $error = "Error resuming custnum ".$self->custnum. ": $error";
150 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
151 elsif ( $options{fatal} ) { die $error; }
152 else { warn $error; }
155 $job->update_statustext('20,billing packages') if $job;
156 $log->debug('billing packages', %logopt);
157 $error = $self->bill( %options );
159 $error = "Error billing custnum ". $self->custnum. ": $error";
160 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
161 elsif ( $options{fatal} ) { die $error; }
162 else { warn $error; }
165 $job->update_statustext('50,applying payments and credits') if $job;
166 $log->debug('applying payments and credits', %logopt);
167 $error = $self->apply_payments_and_credits;
169 $error = "Error applying custnum ". $self->custnum. ": $error";
170 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
171 elsif ( $options{fatal} ) { die $error; }
172 else { warn $error; }
175 # In a batch tax environment, do not run collection if any pending
176 # invoices were created. Collection will run after the next tax batch.
177 my $tax = FS::TaxEngine->new;
178 if ( $tax->info->{batch} and
179 qsearch('cust_bill', { custnum => $self->custnum, pending => 'Y' })
182 warn "skipped collection for custnum ".$self->custnum.
183 " due to pending invoices\n" if $DEBUG;
184 } elsif ( $conf->exists('cancelled_cust-noevents')
185 && ! $self->num_ncancelled_pkgs )
187 warn "skipped collection for custnum ".$self->custnum.
188 " because they have no active packages\n" if $DEBUG;
190 # run collection normally
191 $job->update_statustext('70,running collection events') if $job;
192 $log->debug('running collection events', %logopt);
193 $error = $self->collect( %options );
195 $error = "Error collecting custnum ". $self->custnum. ": $error";
196 if ($options{fatal} && $options{fatal} eq 'return') { return $error; }
197 elsif ($options{fatal} ) { die $error; }
198 else { warn $error; }
202 $job->update_statustext('100,finished') if $job;
203 $log->debug('finish', %logopt);
209 sub cancel_expired_pkgs {
210 my ( $self, $time, %options ) = @_;
212 my @cancel_pkgs = $self->ncancelled_pkgs( {
213 'extra_sql' => " AND expire IS NOT NULL AND expire > 0 AND expire <= $time "
218 CUST_PKG: foreach my $cust_pkg ( @cancel_pkgs ) {
219 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
222 if ( $cust_pkg->change_to_pkgnum ) {
224 my $new_pkg = FS::cust_pkg->by_key($cust_pkg->change_to_pkgnum);
226 push @errors, 'can\'t change pkgnum '.$cust_pkg->pkgnum.' to pkgnum '.
227 $cust_pkg->change_to_pkgnum.'; not expiring';
230 $error = $cust_pkg->change( 'cust_pkg' => $new_pkg,
231 'unprotect_svcs' => 1 );
232 $error = '' if ref $error eq 'FS::cust_pkg';
234 } else { # just cancel it
235 $error = $cust_pkg->cancel($cpr ? ( 'reason' => $cpr->reasonnum,
236 'reason_otaker' => $cpr->otaker,
242 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
245 join(' / ', @errors);
249 sub suspend_adjourned_pkgs {
250 my ( $self, $time, %options ) = @_;
252 my @susp_pkgs = $self->ncancelled_pkgs( {
254 " AND ( susp IS NULL OR susp = 0 )
255 AND ( ( bill IS NOT NULL AND bill != 0 AND bill < $time )
256 OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
261 #only because there's no SQL test for is_prepaid :/
263 grep { ( $_->part_pkg->is_prepaid
268 && $_->adjourn <= $time
276 foreach my $cust_pkg ( @susp_pkgs ) {
277 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
278 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
279 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
280 'reason_otaker' => $cpr->otaker
284 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
287 join(' / ', @errors);
291 sub unsuspend_resumed_pkgs {
292 my ( $self, $time, %options ) = @_;
294 my @unsusp_pkgs = $self->ncancelled_pkgs( {
295 'extra_sql' => " AND resume IS NOT NULL AND resume > 0 AND resume <= $time "
300 foreach my $cust_pkg ( @unsusp_pkgs ) {
301 my $error = $cust_pkg->unsuspend( 'time' => $time );
302 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
305 join(' / ', @errors);
311 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
312 conjunction with the collect method by calling B<bill_and_collect>.
314 If there is an error, returns the error, otherwise returns false.
316 Options are passed as name-value pairs. Currently available options are:
322 If set true, re-charges setup fees.
326 If set true then only bill recurring charges, not setup, usage, one time
331 If set, then override the normal frequency and look for a part_pkg_discount
332 to take at that frequency. This is appropriate only when the normal
333 frequency for all packages is monthly, and is an error otherwise. Use
334 C<pkg_list> to limit the set of packages included in billing.
338 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:
342 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
346 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
348 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
352 A hashref of pkgparts to exclude from this billing run (can also be specified as a comma-separated scalar).
356 Do not bill prepaid packages. Used by freeside-daily.
360 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.
364 This boolean value informs the us that the package is being cancelled. This
365 typically might mean not charging the normal recurring fee but only usage
366 fees since the last billing. Setup charges may be charged. Not all package
367 plans support this feature (they tend to charge 0).
371 Prevent the resetting of usage limits during this call.
375 Do not save the generated bill in the database. Useful with return_bill
379 A list reference on which the generated bill(s) will be returned.
383 Optional terms to be printed on this invoice. Otherwise, customer-specific
384 terms or the default terms are used.
391 my( $self, %options ) = @_;
393 return '' if $self->complimentary eq 'Y';
395 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
396 my $log = FS::Log->new('FS::cust_main::Billing::bill');
397 my %logopt = (object => $self);
399 $log->debug('start', %logopt);
400 warn "$me bill customer ". $self->custnum. "\n"
403 my $time = $options{'time'} || time;
404 my $invoice_time = $options{'invoice_time'} || $time;
406 my $cmp_time = ( $conf->exists('next-bill-ignore-time')
411 $options{'not_pkgpart'} ||= {};
412 $options{'not_pkgpart'} = { map { $_ => 1 }
413 split(/\s*,\s*/, $options{'not_pkgpart'})
415 unless ref($options{'not_pkgpart'});
417 local $SIG{HUP} = 'IGNORE';
418 local $SIG{INT} = 'IGNORE';
419 local $SIG{QUIT} = 'IGNORE';
420 local $SIG{TERM} = 'IGNORE';
421 local $SIG{TSTP} = 'IGNORE';
422 local $SIG{PIPE} = 'IGNORE';
424 my $oldAutoCommit = $FS::UID::AutoCommit;
425 local $FS::UID::AutoCommit = 0;
428 $log->debug('acquiring lock', %logopt);
429 warn "$me acquiring lock on customer ". $self->custnum. "\n"
432 $self->select_for_update; #mutex
434 $log->debug('running pre-bill events', %logopt);
435 warn "$me running pre-bill events for customer ". $self->custnum. "\n"
438 my $error = $self->do_cust_event(
439 'debug' => ( $options{'debug'} || 0 ),
440 'time' => $invoice_time,
441 'check_freq' => $options{'check_freq'},
442 'stage' => 'pre-bill',
444 unless $options{no_commit};
446 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
450 $log->debug('done running pre-bill events', %logopt);
451 warn "$me done running pre-bill events for customer ". $self->custnum. "\n"
454 #keep auto-charge and non-auto-charge line items separate
455 my @passes = ( '', 'no_auto' );
457 my %cust_bill_pkg = map { $_ => [] } @passes;
460 # find the packages which are due for billing, find out how much they are
461 # & generate invoice database.
464 my %total_setup = map { my $z = 0; $_ => \$z; } @passes;
465 my %total_recur = map { my $z = 0; $_ => \$z; } @passes;
467 my @precommit_hooks = ();
469 $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ]; #param checks?
472 my $tax_is_batch = '';
474 $tax_engines{$_} = FS::TaxEngine->new(cust_main => $self,
475 invoice_time => $invoice_time,
476 cancel => $options{cancel}
478 $tax_is_batch ||= $tax_engines{$_}->info->{batch};
481 foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
483 next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
485 my $part_pkg = $cust_pkg->part_pkg;
487 next if $options{'no_prepaid'} && $part_pkg->is_prepaid;
489 $log->debug('bill package '. $cust_pkg->pkgnum, %logopt);
490 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG;
492 #? to avoid use of uninitialized value errors... ?
493 $cust_pkg->setfield('bill', '')
494 unless defined($cust_pkg->bill);
496 my $real_pkgpart = $cust_pkg->pkgpart;
497 my %hash = $cust_pkg->hash;
499 # we could implement this bit as FS::part_pkg::has_hidden, but we already
500 # suffer from performance issues
501 $options{has_hidden} = 0;
502 my @part_pkg = $part_pkg->self_and_bill_linked;
503 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
505 # if this package was changed from another package,
506 # and it hasn't been billed since then,
507 # and package balances are enabled,
508 if ( $cust_pkg->change_pkgnum
509 and $cust_pkg->change_date >= ($cust_pkg->last_bill || 0)
510 and $cust_pkg->change_date < $invoice_time
511 and $conf->exists('pkg-balances') )
513 # _transfer_balance will also create the appropriate credit
514 my @transfer_items = $self->_transfer_balance($cust_pkg);
515 # $part_pkg[0] is the "real" part_pkg
516 my $pass = ($cust_pkg->no_auto || $part_pkg[0]->no_auto) ?
518 push @{ $cust_bill_pkg{$pass} }, @transfer_items;
519 # treating this as recur, just because most charges are recur...
520 ${$total_recur{$pass}} += $_->recur foreach @transfer_items;
522 # currently not considering separate_bill here, as it's for
523 # one-time charges only
526 foreach my $part_pkg ( @part_pkg ) {
528 $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
531 if ( $cust_pkg->separate_bill ) {
532 # if no_auto is also set, that's fine. we just need to not have
533 # invoices that are both auto and no_auto, and since the package
534 # gets an invoice all to itself, it will only be one or the other.
535 $pass = $cust_pkg->pkgnum;
536 if (!exists $cust_bill_pkg{$pass}) { # it may not exist yet
538 $total_setup{$pass} = do { my $z = 0; \$z };
539 $total_recur{$pass} = do { my $z = 0; \$z };
540 # it also needs its own tax context
541 $tax_engines{$pass} = FS::TaxEngine->new(
543 invoice_time => $invoice_time,
544 cancel => $options{cancel}
546 $cust_bill_pkg{$pass} = [];
548 } elsif ( ($cust_pkg->no_auto || $part_pkg->no_auto) ) {
552 my $next_bill = $cust_pkg->getfield('bill') || 0;
554 # let this run once if this is the last bill upon cancellation
555 while ( $next_bill <= $cmp_time or $options{cancel} ) {
557 $self->_make_lines( 'part_pkg' => $part_pkg,
558 'cust_pkg' => $cust_pkg,
559 'precommit_hooks' => \@precommit_hooks,
560 'line_items' => $cust_bill_pkg{$pass},
561 'setup' => $total_setup{$pass},
562 'recur' => $total_recur{$pass},
563 'tax_engine' => $tax_engines{$pass},
565 'real_pkgpart' => $real_pkgpart,
566 'options' => \%options,
569 # Stop if anything goes wrong
572 # or if we're not incrementing the bill date.
573 last if ($cust_pkg->getfield('bill') || 0) == $next_bill;
575 # or if we're letting it run only once
576 last if $options{cancel};
578 $next_bill = $cust_pkg->getfield('bill') || 0;
580 #stop if -o was passed to freeside-daily
581 last if $options{'one_recur'};
584 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
588 } #foreach my $part_pkg
590 } #foreach my $cust_pkg
592 foreach my $pass (@passes) { # keys %cust_bill_pkg )
594 my @cust_bill_pkg = _omit_zero_value_bundles(@{ $cust_bill_pkg{$pass} });
596 warn "$me billing pass $pass\n"
597 #.Dumper(\@cust_bill_pkg)."\n"
604 my @pending_event_fees = FS::cust_event_fee->by_cust($self->custnum,
605 hashref => { 'billpkgnum' => '' }
607 warn "$me found pending fee events:\n".Dumper(\@pending_event_fees)."\n"
608 if @pending_event_fees and $DEBUG > 1;
610 # determine whether to generate an invoice
611 my $generate_bill = scalar(@cust_bill_pkg) > 0;
613 foreach my $event_fee (@pending_event_fees) {
614 $generate_bill = 1 unless $event_fee->nextbill;
617 # don't create an invoice with no line items, or where the only line
618 # items are fees that are supposed to be held until the next invoice
619 next if !$generate_bill;
623 foreach my $event_fee (@pending_event_fees) {
624 my $object = $event_fee->cust_event->cust_X;
625 my $part_fee = $event_fee->part_fee;
627 if ( $object->isa('FS::cust_main')
628 or $object->isa('FS::cust_pkg')
629 or $object->isa('FS::cust_pay_batch') )
631 # Not the real cust_bill object that will be inserted--in particular
632 # there are no taxes yet. If you want to charge a fee on the total
633 # invoice amount including taxes, you have to put the fee on the next
635 $cust_bill = FS::cust_bill->new({
636 'custnum' => $self->custnum,
637 'cust_bill_pkg' => \@cust_bill_pkg,
638 'charged' => ${ $total_setup{$pass} } +
639 ${ $total_recur{$pass} },
642 # If this is a package event, only apply the fee to line items
644 if ($object->isa('FS::cust_pkg')) {
645 $cust_bill->set('cust_bill_pkg',
646 [ grep { $_->pkgnum == $object->pkgnum } @cust_bill_pkg ]
650 } elsif ( $object->isa('FS::cust_bill') ) {
651 # simple case: applying the fee to a previous invoice (late fee,
653 $cust_bill = $object;
655 # if the fee def belongs to a different agent, don't charge the fee.
656 # event conditions should prevent this, but just in case they don't,
658 if ( $part_fee->agentnum and $part_fee->agentnum != $self->agentnum ) {
659 warn "tried to charge fee#".$part_fee->feepart .
660 " on customer#".$self->custnum." from a different agent.\n";
663 # also skip if it's disabled
664 next if $part_fee->disabled eq 'Y';
666 my $fee_item = $part_fee->lineitem($cust_bill) or next;
667 # link this so that we can clear the marker on inserting the line item
668 $fee_item->set('cust_event_fee', $event_fee);
669 push @fee_items, $fee_item;
673 # add fees to the invoice
674 foreach my $fee_item (@fee_items) {
676 push @cust_bill_pkg, $fee_item;
677 ${ $total_setup{$pass} } += $fee_item->setup;
678 ${ $total_recur{$pass} } += $fee_item->recur;
680 my $part_fee = $fee_item->part_fee;
681 my $fee_location = $self->ship_location; # I think?
683 my $error = $tax_engines{''}->add_sale($fee_item);
685 return $error if $error;
689 # XXX implementation of fees is supposed to make this go away...
690 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
691 !$conf->exists('postal_invoice-recurring_only')
695 my $postal_pkg = $self->charge_postal_fee();
696 if ( $postal_pkg && !ref( $postal_pkg ) ) {
698 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
699 return "can't charge postal invoice fee for customer ".
700 $self->custnum. ": $postal_pkg";
702 } elsif ( $postal_pkg ) {
704 my $real_pkgpart = $postal_pkg->pkgpart;
705 # we could implement this bit as FS::part_pkg::has_hidden, but we already
706 # suffer from performance issues
707 $options{has_hidden} = 0;
708 my @part_pkg = $postal_pkg->part_pkg->self_and_bill_linked;
709 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
711 foreach my $part_pkg ( @part_pkg ) {
712 my %postal_options = %options;
713 delete $postal_options{cancel};
715 $self->_make_lines( 'part_pkg' => $part_pkg,
716 'cust_pkg' => $postal_pkg,
717 'precommit_hooks' => \@precommit_hooks,
718 'line_items' => \@cust_bill_pkg,
719 'setup' => $total_setup{$pass},
720 'recur' => $total_recur{$pass},
721 'tax_engine' => $tax_engines{$pass},
723 'real_pkgpart' => $real_pkgpart,
724 'options' => \%postal_options,
727 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
732 # it's silly to have a zero value postal_pkg, but....
733 @cust_bill_pkg = _omit_zero_value_bundles(@cust_bill_pkg);
740 #XXX does this work with batch tax engines?
741 warn "adding tax adjustments...\n" if $DEBUG > 2;
742 foreach my $cust_tax_adjustment (
743 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
749 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
751 my $itemdesc = $cust_tax_adjustment->taxname;
752 $itemdesc = '' if $itemdesc eq 'Tax';
754 push @cust_bill_pkg, new FS::cust_bill_pkg {
760 'itemdesc' => $itemdesc,
761 'itemcomment' => $cust_tax_adjustment->comment,
762 'cust_tax_adjustment' => $cust_tax_adjustment,
763 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
768 my $charged = sprintf('%.2f', ${ $total_setup{$pass} } + ${ $total_recur{$pass} } );
770 my $balance = $self->balance;
772 my $previous_bill = qsearchs({ 'table' => 'cust_bill',
773 'hashref' => { custnum=>$self->custnum },
774 'extra_sql' => 'ORDER BY _date DESC LIMIT 1',
776 my $previous_balance =
778 ? ( $previous_bill->billing_balance + $previous_bill->charged )
781 $log->debug('creating the new invoice', %logopt);
782 warn "creating the new invoice\n" if $DEBUG;
783 #create the new invoice
784 my $cust_bill = new FS::cust_bill ( {
785 'custnum' => $self->custnum,
786 '_date' => $invoice_time,
787 'charged' => $charged,
788 'billing_balance' => $balance,
789 'previous_balance' => $previous_balance,
790 'invoice_terms' => $options{'invoice_terms'},
791 'cust_bill_pkg' => \@cust_bill_pkg,
792 'pending' => 'Y', # clear this after doing taxes
795 if (!$options{no_commit}) {
796 # probably we ought to insert it as pending, and then rollback
797 # without ever un-pending it
798 $error = $cust_bill->insert;
800 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
801 return "can't create invoice for customer #". $self->custnum. ": $error";
806 # calculate and append taxes
807 if ( ! $tax_is_batch) {
808 my $arrayref_or_error = $tax_engines{$pass}->calculate_taxes($cust_bill);
810 unless ( ref( $arrayref_or_error ) ) {
811 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
812 return $arrayref_or_error;
815 # or should this be in TaxEngine?
817 foreach my $taxline ( @$arrayref_or_error ) {
818 $total_tax += $taxline->setup;
819 $taxline->set('invnum' => $cust_bill->invnum); # just to be sure
820 push @cust_bill_pkg, $taxline; # for return_bill
822 if (!$options{no_commit}) {
823 my $error = $taxline->insert;
825 $dbh->rollback if $oldAutoCommit;
832 # add tax to the invoice amount and finalize it
833 ${ $total_setup{$pass} } = sprintf('%.2f', ${ $total_setup{$pass} } + $total_tax);
834 $charged = sprintf('%.2f', $charged + $total_tax);
835 $cust_bill->set('charged', $charged);
836 $cust_bill->set('pending', '');
838 if (!$options{no_commit}) {
839 my $error = $cust_bill->replace;
841 $dbh->rollback if $oldAutoCommit;
846 } # if !$tax_is_batch
847 # if it IS batch, then we'll do all this in process_tax_batch
849 push @{$options{return_bill}}, $cust_bill if $options{return_bill};
851 } #foreach my $pass ( keys %cust_bill_pkg )
853 foreach my $hook ( @precommit_hooks ) {
856 } unless $options{no_commit};
858 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
859 return "$@ running precommit hook $hook\n";
863 $dbh->commit or die $dbh->errstr if $oldAutoCommit && !$options{no_commit};
868 #discard bundled packages of 0 value
869 sub _omit_zero_value_bundles {
872 my @cust_bill_pkg = ();
873 my @cust_bill_pkg_bundle = ();
875 my $discount_show_always = 0;
877 foreach my $cust_bill_pkg ( @in ) {
879 $discount_show_always = ($cust_bill_pkg->get('discounts')
880 && scalar(@{$cust_bill_pkg->get('discounts')})
881 && $conf->exists('discount-show-always'));
883 warn " pkgnum ". $cust_bill_pkg->pkgnum. " sum $sum, ".
884 "setup_show_zero ". $cust_bill_pkg->setup_show_zero.
885 "recur_show_zero ". $cust_bill_pkg->recur_show_zero. "\n"
888 if (scalar(@cust_bill_pkg_bundle) && !$cust_bill_pkg->pkgpart_override) {
889 push @cust_bill_pkg, @cust_bill_pkg_bundle
891 || ($sum == 0 && ( $discount_show_always
892 || grep {$_->recur_show_zero || $_->setup_show_zero}
893 @cust_bill_pkg_bundle
896 @cust_bill_pkg_bundle = ();
900 $sum += $cust_bill_pkg->setup + $cust_bill_pkg->recur;
901 push @cust_bill_pkg_bundle, $cust_bill_pkg;
905 push @cust_bill_pkg, @cust_bill_pkg_bundle
907 || ($sum == 0 && ( $discount_show_always
908 || grep {$_->recur_show_zero || $_->setup_show_zero}
909 @cust_bill_pkg_bundle
913 warn " _omit_zero_value_bundles: ". scalar(@in).
914 '->'. scalar(@cust_bill_pkg). "\n" #. Dumper(@cust_bill_pkg). "\n"
922 my ($self, %params) = @_;
924 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
926 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
927 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
928 my $cust_location = $cust_pkg->tax_location;
929 my $precommit_hooks = $params{precommit_hooks} or die "no precommit_hooks specified";
930 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
931 my $total_setup = $params{setup} or die "no setup accumulator specified";
932 my $total_recur = $params{recur} or die "no recur accumulator specified";
933 my $time = $params{'time'} or die "no time specified";
934 my (%options) = %{$params{options}};
936 my $tax_engine = $params{tax_engine};
938 if ( $part_pkg->freq ne '1' and ($options{'freq_override'} || 0) > 0 ) {
939 # this should never happen
940 die 'freq_override billing attempted on non-monthly package '.
945 my $real_pkgpart = $params{real_pkgpart};
946 my %hash = $cust_pkg->hash;
947 my $old_cust_pkg = new FS::cust_pkg \%hash;
952 $cust_pkg->pkgpart($part_pkg->pkgpart);
954 my $cmp_time = ( $conf->exists('next-bill-ignore-time')
965 my @setup_discounts = ();
966 my %setup_param = ( 'discounts' => \@setup_discounts,
967 'real_pkgpart' => $params{real_pkgpart}
969 my $setup_billed_currency = '';
970 my $setup_billed_amount = 0;
971 # Conditions for setting setup date and charging the setup fee:
972 # - this is not a recurring-only billing run
973 # - and the package is not currently being canceled
974 # - and, unless we're specifically told otherwise via 'resetup':
975 # - it doesn't already HAVE a setup date
976 # - or a start date in the future
977 # - and it's not suspended
979 # The last condition used to check the "disable_setup_suspended" option but
980 # that's obsolete. We now never set the setup date on a suspended package.
981 if ( ! $options{recurring_only}
982 and ! $options{cancel}
983 and ( $options{'resetup'}
984 || ( ! $cust_pkg->setup
985 && ( ! $cust_pkg->start_date
986 || $cust_pkg->start_date <= $cmp_time
988 && ( ! $cust_pkg->getfield('susp') )
994 warn " bill setup\n" if $DEBUG > 1;
996 unless ( $cust_pkg->waive_setup ) {
999 $setup = eval { $cust_pkg->calc_setup( $time, \@details, \%setup_param ) };
1000 return "$@ running calc_setup for $cust_pkg\n"
1003 $unitsetup = $cust_pkg->base_setup()
1006 if ( $setup_param{'billed_currency'} ) {
1007 $setup_billed_currency = delete $setup_param{'billed_currency'};
1008 $setup_billed_amount = delete $setup_param{'billed_amount'};
1012 $cust_pkg->setfield('setup', $time)
1013 unless $cust_pkg->setup;
1014 #do need it, but it won't get written to the db
1015 #|| $cust_pkg->pkgpart != $real_pkgpart;
1017 $cust_pkg->setfield('start_date', '')
1018 if $cust_pkg->start_date;
1023 # bill recurring fee
1028 my @recur_discounts = ();
1029 my $recur_billed_currency = '';
1030 my $recur_billed_amount = 0;
1032 if ( ! $cust_pkg->start_date
1035 || ( $cust_pkg->susp != $cust_pkg->order_date
1036 && ( $cust_pkg->option('suspend_bill',1)
1037 || ( $part_pkg->option('suspend_bill', 1)
1038 && ! $cust_pkg->option('no_suspend_bill',1)
1044 ( $part_pkg->freq ne '0' && ( $cust_pkg->bill || 0 ) <= $cmp_time )
1045 || ( $part_pkg->plan eq 'voip_cdr'
1046 && $part_pkg->option('bill_every_call')
1051 # XXX should this be a package event? probably. events are called
1052 # at collection time at the moment, though...
1053 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
1054 if $part_pkg->can('reset_usage') && !$options{'no_usage_reset'};
1055 #don't want to reset usage just cause we want a line item??
1056 #&& $part_pkg->pkgpart == $real_pkgpart;
1058 warn " bill recur\n" if $DEBUG > 1;
1061 # XXX shared with $recur_prog
1062 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
1066 #over two params! lets at least switch to a hashref for the rest...
1067 my $increment_next_bill = ( $part_pkg->freq ne '0'
1068 && ( $cust_pkg->getfield('bill') || 0 ) <= $cmp_time
1069 && !$options{cancel}
1071 my %param = ( %setup_param,
1072 'precommit_hooks' => $precommit_hooks,
1073 'increment_next_bill' => $increment_next_bill,
1074 'discounts' => \@recur_discounts,
1075 'real_pkgpart' => $real_pkgpart,
1076 'freq_override' => $options{freq_override} || '',
1080 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
1082 # There may be some part_pkg for which this is wrong. Only those
1083 # which can_discount are supported.
1084 # (the UI should prevent adding discounts to these at the moment)
1086 warn "calling $method on cust_pkg ". $cust_pkg->pkgnum.
1087 " for pkgpart ". $cust_pkg->pkgpart.
1088 " with params ". join(' / ', map "$_=>$param{$_}", keys %param). "\n"
1091 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
1092 return "$@ running $method for $cust_pkg\n"
1096 $unitrecur = $cust_pkg->base_recur( \$sdate ) || $recur; #XXX uuh, better
1098 if ( $param{'billed_currency'} ) {
1099 $recur_billed_currency = delete $param{'billed_currency'};
1100 $recur_billed_amount = delete $param{'billed_amount'};
1103 if ( $increment_next_bill ) {
1107 if ( my $main_pkg = $cust_pkg->main_pkg ) {
1108 # supplemental package
1109 # to keep in sync with the main package, simulate billing at
1111 my $main_pkg_freq = $main_pkg->part_pkg->freq;
1112 my $supp_pkg_freq = $part_pkg->freq;
1113 my $ratio = $supp_pkg_freq / $main_pkg_freq;
1114 if ( $ratio != int($ratio) ) {
1115 # the UI should prevent setting up packages like this, but just
1117 return "supplemental package period is not an integer multiple of main package period";
1119 $next_bill = $sdate;
1121 $next_bill = $part_pkg->add_freq( $next_bill, $main_pkg_freq );
1126 $next_bill = $part_pkg->add_freq($sdate, $options{freq_override} || 0);
1127 return "unparsable frequency: ". $part_pkg->freq
1128 if $next_bill == -1;
1131 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
1132 # only for figuring next bill date, nothing else, so, reset $sdate again
1134 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1135 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
1136 $cust_pkg->last_bill($sdate);
1138 $cust_pkg->setfield('bill', $next_bill );
1142 if ( $param{'setup_fee'} ) {
1143 # Add an additional setup fee at the billing stage.
1144 # Used for prorate_defer_bill.
1145 $setup += $param{'setup_fee'};
1146 $unitsetup += $param{'setup_fee'};
1150 if ( defined $param{'discount_left_setup'} ) {
1151 foreach my $discount_setup ( values %{$param{'discount_left_setup'}} ) {
1152 $setup -= $discount_setup;
1158 warn "\$setup is undefined" unless defined($setup);
1159 warn "\$recur is undefined" unless defined($recur);
1160 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1163 # If there's line items, create em cust_bill_pkg records
1164 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
1169 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
1170 # hmm.. and if just the options are modified in some weird price plan?
1172 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
1175 my $error = $cust_pkg->replace( $old_cust_pkg,
1176 'depend_jobnum'=>$options{depend_jobnum},
1177 'options' => { $cust_pkg->options },
1179 unless $options{no_commit};
1180 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
1181 if $error; #just in case
1184 $setup = sprintf( "%.2f", $setup );
1185 $recur = sprintf( "%.2f", $recur );
1186 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
1187 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1189 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
1190 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
1193 my $discount_show_always = $conf->exists('discount-show-always')
1194 && ( ($setup == 0 && scalar(@setup_discounts))
1195 || ($recur == 0 && scalar(@recur_discounts))
1200 || (!$part_pkg->hidden && $options{has_hidden}) #include some $0 lines
1201 || $discount_show_always
1202 || ($setup == 0 && $cust_pkg->_X_show_zero('setup'))
1203 || ($recur == 0 && $cust_pkg->_X_show_zero('recur'))
1207 warn " charges (setup=$setup, recur=$recur); adding line items\n"
1210 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
1212 warn " adding customer package invoice detail: $_\n"
1213 foreach @cust_pkg_detail;
1215 push @details, @cust_pkg_detail;
1217 my $cust_bill_pkg = new FS::cust_bill_pkg {
1218 'pkgnum' => $cust_pkg->pkgnum,
1220 'unitsetup' => $unitsetup,
1221 'setup_billed_currency' => $setup_billed_currency,
1222 'setup_billed_amount' => $setup_billed_amount,
1224 'unitrecur' => $unitrecur,
1225 'recur_billed_currency' => $recur_billed_currency,
1226 'recur_billed_amount' => $recur_billed_amount,
1227 'quantity' => $cust_pkg->quantity,
1228 'details' => \@details,
1229 'discounts' => [ @setup_discounts, @recur_discounts ],
1230 'hidden' => $part_pkg->hidden,
1231 'freq' => $part_pkg->freq,
1234 if ( $part_pkg->option('prorate_defer_bill',1)
1235 and !$hash{last_bill} ) {
1236 # both preceding and upcoming, technically
1237 $cust_bill_pkg->sdate( $cust_pkg->setup );
1238 $cust_bill_pkg->edate( $cust_pkg->bill );
1239 } elsif ( $part_pkg->recur_temporality eq 'preceding' ) {
1240 $cust_bill_pkg->sdate( $hash{last_bill} );
1241 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
1242 $cust_bill_pkg->edate( $time ) if $options{cancel};
1243 } else { #if ( $part_pkg->recur_temporality eq 'upcoming' )
1244 $cust_bill_pkg->sdate( $sdate );
1245 $cust_bill_pkg->edate( $cust_pkg->bill );
1246 #$cust_bill_pkg->edate( $time ) if $options{cancel};
1249 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
1250 unless $part_pkg->pkgpart == $real_pkgpart;
1252 $$total_setup += $setup;
1253 $$total_recur += $recur;
1259 my $error = $tax_engine->add_sale($cust_bill_pkg);
1260 return $error if $error;
1262 $cust_bill_pkg->set_display(
1263 part_pkg => $part_pkg,
1264 real_pkgpart => $real_pkgpart,
1267 push @$cust_bill_pkgs, $cust_bill_pkg;
1269 } #if $setup != 0 || $recur != 0
1277 =item _transfer_balance TO_PKG [ FROM_PKGNUM ]
1279 Takes one argument, a cust_pkg object that is being billed. This will
1280 be called only if the package was created by a package change, and has
1281 not been billed since the package change, and package balance tracking
1282 is enabled. The second argument can be an alternate package number to
1283 transfer the balance from; this should not be used externally.
1285 Transfers the balance from the previous package (now canceled) to
1286 this package, by crediting one package and creating an invoice item for
1287 the other. Inserts the credit and returns the invoice item (so that it
1288 can be added to an invoice that's being built).
1290 If the previous package was never billed, and was also created by a package
1291 change, then this will also transfer the balance from I<its> previous
1292 package, and so on, until reaching a package that either has been billed
1293 or was not created by a package change.
1297 my $balance_transfer_reason;
1299 sub _transfer_balance {
1301 my $cust_pkg = shift;
1302 my $from_pkgnum = shift || $cust_pkg->change_pkgnum;
1303 my $from_pkg = FS::cust_pkg->by_key($from_pkgnum);
1307 # if $from_pkg is not the first package in the chain, and it was never
1309 if ( $from_pkg->change_pkgnum and scalar($from_pkg->cust_bill_pkg) == 0 ) {
1310 @transfers = $self->_transfer_balance($cust_pkg, $from_pkg->change_pkgnum);
1313 my $prev_balance = $self->balance_pkgnum($from_pkgnum);
1314 if ( $prev_balance != 0 ) {
1315 $balance_transfer_reason ||= FS::reason->new_or_existing(
1316 'reason' => 'Package balance transfer',
1317 'type' => 'Internal adjustment',
1321 my $credit = FS::cust_credit->new({
1322 'custnum' => $self->custnum,
1323 'amount' => abs($prev_balance),
1324 'reasonnum' => $balance_transfer_reason->reasonnum,
1325 '_date' => $cust_pkg->change_date,
1328 my $cust_bill_pkg = FS::cust_bill_pkg->new({
1330 'recur' => abs($prev_balance),
1331 #'sdate' => $from_pkg->last_bill, # not sure about this
1332 #'edate' => $cust_pkg->change_date,
1333 'itemdesc' => $self->mt('Previous Balance, [_1]',
1334 $from_pkg->part_pkg->pkg),
1337 if ( $prev_balance > 0 ) {
1338 # credit the old package, charge the new one
1339 $credit->set('pkgnum', $from_pkgnum);
1340 $cust_bill_pkg->set('pkgnum', $cust_pkg->pkgnum);
1343 $credit->set('pkgnum', $cust_pkg->pkgnum);
1344 $cust_bill_pkg->set('pkgnum', $from_pkgnum);
1346 my $error = $credit->insert;
1347 die "error transferring package balance from #".$from_pkgnum.
1348 " to #".$cust_pkg->pkgnum.": $error\n" if $error;
1350 push @transfers, $cust_bill_pkg;
1351 } # $prev_balance != 0
1356 #### vestigial code ####
1358 =item handle_taxes TAXLISTHASH CUST_BILL_PKG [ OPTIONS ]
1360 This is _handle_taxes. It's called once for each cust_bill_pkg generated
1363 TAXLISTHASH is a hashref shared across the entire invoice. It looks like
1366 'cust_main_county 1001' => [ [FS::cust_main_county], ... ],
1367 'cust_main_county 1002' => [ [FS::cust_main_county], ... ],
1370 'cust_main_county' can also be 'tax_rate'. The first object in the array
1371 is always the cust_main_county or tax_rate identified by the key.
1373 That "..." is a list of FS::cust_bill_pkg objects that will be fed to
1374 the 'taxline' method to calculate the amount of the tax. This doesn't
1375 happen until calculate_taxes, though.
1377 OPTIONS may include:
1378 - part_item: a part_pkg or part_fee object to be used as the package/fee
1380 - location: a cust_location to be used as the billing location.
1381 - cancel: true if this package is being billed on cancellation. This
1382 allows tax to be calculated on usage charges only.
1384 If not supplied, part_item will be inferred from the pkgnum or feepart of the
1385 cust_bill_pkg, and location from the pkgnum (or, for fees, the invnum and
1386 the customer's default service location).
1392 my $taxlisthash = shift;
1393 my $cust_bill_pkg = shift;
1396 # at this point I realize that we have enough information to infer all this
1397 # stuff, instead of passing around giant honking argument lists
1398 my $location = $options{location} || $cust_bill_pkg->tax_location;
1399 my $part_item = $options{part_item} || $cust_bill_pkg->part_X;
1401 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1403 return if ( $self->payby eq 'COMP' ); #dubious
1405 if ( $conf->exists('enable_taxproducts')
1406 && ( scalar($part_item->part_pkg_taxoverride)
1407 || $part_item->has_taxproduct
1412 # EXTERNAL TAX RATES (via tax_rate)
1413 my %cust_bill_pkg = ();
1417 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
1418 push @classes, 'setup' if $cust_bill_pkg->setup and !$options{cancel};
1419 push @classes, 'recur' if $cust_bill_pkg->recur and !$options{cancel};
1421 my $exempt = $conf->exists('cust_class-tax_exempt')
1422 ? ( $self->cust_class ? $self->cust_class->tax : '' )
1424 # standardize this just to be sure
1425 $exempt = ($exempt eq 'Y') ? 'Y' : '';
1429 foreach my $class (@classes) {
1430 my $err_or_ref = $self->_gather_taxes($part_item, $class, $location);
1431 return $err_or_ref unless ref($err_or_ref);
1432 $taxes{$class} = $err_or_ref;
1435 unless (exists $taxes{''}) {
1436 my $err_or_ref = $self->_gather_taxes($part_item, '', $location);
1437 return $err_or_ref unless ref($err_or_ref);
1438 $taxes{''} = $err_or_ref;
1443 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate; # grrr
1444 foreach my $key (keys %tax_cust_bill_pkg) {
1445 # $key is "setup", "recur", or a usage class name. ('' is a usage class.)
1446 # $tax_cust_bill_pkg{$key} is a cust_bill_pkg for that component of
1448 # $taxes{$key} is an arrayref of cust_main_county or tax_rate objects that
1449 # apply to $key-class charges.
1450 my @taxes = @{ $taxes{$key} || [] };
1451 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
1453 my %localtaxlisthash = ();
1454 foreach my $tax ( @taxes ) {
1456 # this is the tax identifier, not the taxname
1457 my $taxname = ref( $tax ). ' '. $tax->taxnum;
1458 # $taxlisthash: keys are "setup", "recur", and usage classes.
1459 # Values are arrayrefs, first the tax object (cust_main_county
1460 # or tax_rate) and then any cust_bill_pkg objects that the
1462 $taxlisthash->{ $taxname } ||= [ $tax ];
1463 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
1465 $localtaxlisthash{ $taxname } ||= [ $tax ];
1466 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
1470 warn "finding taxed taxes...\n" if $DEBUG > 2;
1471 foreach my $tax ( keys %localtaxlisthash ) {
1472 my $tax_object = shift @{ $localtaxlisthash{$tax} };
1473 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
1475 next unless $tax_object->can('tax_on_tax');
1477 foreach my $tot ( $tax_object->tax_on_tax( $location ) ) {
1478 my $totname = ref( $tot ). ' '. $tot->taxnum;
1480 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
1482 next unless exists( $localtaxlisthash{ $totname } ); # only increase
1484 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
1485 # calculate the tax amount that the tax_on_tax will apply to
1486 my $hashref_or_error =
1487 $tax_object->taxline( $localtaxlisthash{$tax} );
1488 return $hashref_or_error
1489 unless ref($hashref_or_error);
1491 # and append it to the list of taxable items
1492 $taxlisthash->{ $totname } ||= [ $tot ];
1493 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
1501 # INTERNAL TAX RATES (cust_main_county)
1503 # We fetch taxes even if the customer is completely exempt,
1504 # because we need to record that fact.
1506 my @loc_keys = qw( district city county state country );
1507 my %taxhash = map { $_ => $location->$_ } @loc_keys;
1509 $taxhash{'taxclass'} = $part_item->taxclass;
1511 warn "taxhash:\n". Dumper(\%taxhash) if $DEBUG > 2;
1513 my @taxes = (); # entries are cust_main_county objects
1514 my %taxhash_elim = %taxhash;
1515 my @elim = qw( district city county state );
1518 #first try a match with taxclass
1519 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1521 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1522 #then try a match without taxclass
1523 my %no_taxclass = %taxhash_elim;
1524 $no_taxclass{ 'taxclass' } = '';
1525 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1528 $taxhash_elim{ shift(@elim) } = '';
1530 } while ( !scalar(@taxes) && scalar(@elim) );
1533 my $tax_id = 'cust_main_county '.$_->taxnum;
1534 $taxlisthash->{$tax_id} ||= [ $_ ];
1535 push @{ $taxlisthash->{$tax_id} }, $cust_bill_pkg;
1542 =item _gather_taxes PART_ITEM CLASS CUST_LOCATION
1544 Internal method used with vendor-provided tax tables. PART_ITEM is a part_pkg
1545 or part_fee (which will define the tax eligibility of the product), CLASS is
1546 'setup', 'recur', null, or a C<usage_class> number, and CUST_LOCATION is the
1547 location where the service was provided (or billed, depending on
1548 configuration). Returns an arrayref of L<FS::tax_rate> objects that
1549 can apply to this line item.
1555 my $part_item = shift;
1557 my $location = shift;
1559 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1561 my $geocode = $location->geocode('cch');
1563 [ $part_item->tax_rates('cch', $geocode, $class) ]
1567 #### end vestigial code ####
1569 =item collect [ HASHREF | OPTION => VALUE ... ]
1571 (Attempt to) collect money for this customer's outstanding invoices (see
1572 L<FS::cust_bill>). Usually used after the bill method.
1574 Actions are now triggered by billing events; see L<FS::part_event> and the
1575 billing events web interface. Old-style invoice events (see
1576 L<FS::part_bill_event>) have been deprecated.
1578 If there is an error, returns the error, otherwise returns false.
1580 Options are passed as name-value pairs.
1582 Currently available options are:
1588 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.
1592 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1596 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1600 set true to surpress email card/ACH decline notices.
1604 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)
1610 # allows for one time override of normal customer billing method
1615 my( $self, %options ) = @_;
1617 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1619 my $invoice_time = $options{'invoice_time'} || time;
1622 local $SIG{HUP} = 'IGNORE';
1623 local $SIG{INT} = 'IGNORE';
1624 local $SIG{QUIT} = 'IGNORE';
1625 local $SIG{TERM} = 'IGNORE';
1626 local $SIG{TSTP} = 'IGNORE';
1627 local $SIG{PIPE} = 'IGNORE';
1629 my $oldAutoCommit = $FS::UID::AutoCommit;
1630 local $FS::UID::AutoCommit = 0;
1633 $self->select_for_update; #mutex
1636 my $balance = $self->balance;
1637 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
1640 if ( exists($options{'retry_card'}) ) {
1641 carp 'retry_card option passed to collect is deprecated; use retry';
1642 $options{'retry'} ||= $options{'retry_card'};
1644 if ( exists($options{'retry'}) && $options{'retry'} ) {
1645 my $error = $self->retry_realtime;
1647 $dbh->rollback if $oldAutoCommit;
1652 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1654 #never want to roll back an event just because it returned an error
1655 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1657 $self->do_cust_event(
1658 'debug' => ( $options{'debug'} || 0 ),
1659 'time' => $invoice_time,
1660 'check_freq' => $options{'check_freq'},
1661 'stage' => 'collect',
1666 =item retry_realtime
1668 Schedules realtime / batch credit card / electronic check / LEC billing
1669 events for for retry. Useful if card information has changed or manual
1670 retry is desired. The 'collect' method must be called to actually retry
1673 Implementation details: For either this customer, or for each of this
1674 customer's open invoices, changes the status of the first "done" (with
1675 statustext error) realtime processing event to "failed".
1679 sub retry_realtime {
1682 local $SIG{HUP} = 'IGNORE';
1683 local $SIG{INT} = 'IGNORE';
1684 local $SIG{QUIT} = 'IGNORE';
1685 local $SIG{TERM} = 'IGNORE';
1686 local $SIG{TSTP} = 'IGNORE';
1687 local $SIG{PIPE} = 'IGNORE';
1689 my $oldAutoCommit = $FS::UID::AutoCommit;
1690 local $FS::UID::AutoCommit = 0;
1693 #a little false laziness w/due_cust_event (not too bad, really)
1695 # I guess this is always as of now?
1696 my $join = FS::part_event_condition->join_conditions_sql('', 'time' => time);
1697 my $order = FS::part_event_condition->order_conditions_sql;
1700 . join ( ' OR ' , map {
1701 my $cust_join = FS::part_event->eventtables_cust_join->{$_} || '';
1702 my $custnum = FS::part_event->eventtables_custnum->{$_};
1703 "( part_event.eventtable = " . dbh->quote($_)
1704 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key
1705 . " from $_ $cust_join"
1706 . " where $custnum = " . dbh->quote( $self->custnum ) . "))" ;
1707 } FS::part_event->eventtables)
1710 #here is the agent virtualization
1711 my $agent_virt = " ( part_event.agentnum IS NULL
1712 OR part_event.agentnum = ". $self->agentnum. ' )';
1714 #XXX this shouldn't be hardcoded, actions should declare it...
1715 my @realtime_events = qw(
1716 cust_bill_realtime_card
1717 cust_bill_realtime_check
1718 cust_bill_realtime_lec
1722 my $is_realtime_event =
1723 ' part_event.action IN ( '.
1724 join(',', map "'$_'", @realtime_events ).
1727 my $batch_or_statustext =
1728 "( part_event.action = 'cust_bill_batch'
1729 OR ( statustext IS NOT NULL AND statustext != '' )
1733 my @cust_event = qsearch({
1734 'table' => 'cust_event',
1735 'select' => 'cust_event.*',
1736 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
1737 'hashref' => { 'status' => 'done' },
1738 'extra_sql' => " AND $batch_or_statustext ".
1739 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
1742 my %seen_invnum = ();
1743 foreach my $cust_event (@cust_event) {
1745 #max one for the customer, one for each open invoice
1746 my $cust_X = $cust_event->cust_X;
1747 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
1751 or $cust_event->part_event->eventtable eq 'cust_bill'
1754 my $error = $cust_event->retry;
1756 $dbh->rollback if $oldAutoCommit;
1757 return "error scheduling event for retry: $error";
1762 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1767 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
1769 Runs billing events; see L<FS::part_event> and the billing events web
1772 If there is an error, returns the error, otherwise returns false.
1774 Options are passed as name-value pairs.
1776 Currently available options are:
1782 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.
1786 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1790 "collect" (the default) or "pre-bill"
1794 set true to surpress email card/ACH decline notices.
1798 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)
1805 # allows for one time override of normal customer billing method
1809 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1812 my( $self, %options ) = @_;
1814 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1816 my $time = $options{'time'} || time;
1819 local $SIG{HUP} = 'IGNORE';
1820 local $SIG{INT} = 'IGNORE';
1821 local $SIG{QUIT} = 'IGNORE';
1822 local $SIG{TERM} = 'IGNORE';
1823 local $SIG{TSTP} = 'IGNORE';
1824 local $SIG{PIPE} = 'IGNORE';
1826 my $oldAutoCommit = $FS::UID::AutoCommit;
1827 local $FS::UID::AutoCommit = 0;
1830 $self->select_for_update; #mutex
1833 my $balance = $self->balance;
1834 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
1837 # if ( exists($options{'retry_card'}) ) {
1838 # carp 'retry_card option passed to collect is deprecated; use retry';
1839 # $options{'retry'} ||= $options{'retry_card'};
1841 # if ( exists($options{'retry'}) && $options{'retry'} ) {
1842 # my $error = $self->retry_realtime;
1844 # $dbh->rollback if $oldAutoCommit;
1849 # false laziness w/pay_batch::import_results
1851 my $due_cust_event = $self->due_cust_event(
1852 'debug' => ( $options{'debug'} || 0 ),
1854 'check_freq' => $options{'check_freq'},
1855 'stage' => ( $options{'stage'} || 'collect' ),
1857 unless( ref($due_cust_event) ) {
1858 $dbh->rollback if $oldAutoCommit;
1859 return $due_cust_event;
1862 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1863 #never want to roll back an event just because it or a different one
1865 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1867 foreach my $cust_event ( @$due_cust_event ) {
1871 #re-eval event conditions (a previous event could have changed things)
1872 unless ( $cust_event->test_conditions ) {
1873 #don't leave stray "new/locked" records around
1874 my $error = $cust_event->delete;
1875 return $error if $error;
1880 local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
1881 if $options{'quiet'};
1882 warn " running cust_event ". $cust_event->eventnum. "\n"
1885 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
1886 if ( my $error = $cust_event->do_event( 'time' => $time ) ) {
1887 #XXX wtf is this? figure out a proper dealio with return value
1899 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
1901 Inserts database records for and returns an ordered listref of new events due
1902 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
1903 events are due, an empty listref is returned. If there is an error, returns a
1904 scalar error message.
1906 To actually run the events, call each event's test_condition method, and if
1907 still true, call the event's do_event method.
1909 Options are passed as a hashref or as a list of name-value pairs. Available
1916 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.
1920 "collect" (the default) or "pre-bill"
1924 "Current time" for the events.
1928 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)
1932 Only return events for the specified eventtable (by default, events of all eventtables are returned)
1936 Explicitly pass the objects to be tested (typically used with eventtable).
1940 Set to true to return the objects, but not actually insert them into the
1947 sub due_cust_event {
1949 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
1952 #my $DEBUG = $opt{'debug'}
1953 $opt{'debug'} ||= 0; # silence some warnings
1954 local($DEBUG) = $opt{'debug'}
1955 if $opt{'debug'} > $DEBUG;
1956 $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1958 warn "$me due_cust_event called with options ".
1959 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
1962 $opt{'time'} ||= time;
1964 local $SIG{HUP} = 'IGNORE';
1965 local $SIG{INT} = 'IGNORE';
1966 local $SIG{QUIT} = 'IGNORE';
1967 local $SIG{TERM} = 'IGNORE';
1968 local $SIG{TSTP} = 'IGNORE';
1969 local $SIG{PIPE} = 'IGNORE';
1971 my $oldAutoCommit = $FS::UID::AutoCommit;
1972 local $FS::UID::AutoCommit = 0;
1975 $self->select_for_update #mutex
1976 unless $opt{testonly};
1979 # find possible events (initial search)
1982 my @cust_event = ();
1984 my @eventtable = $opt{'eventtable'}
1985 ? ( $opt{'eventtable'} )
1986 : FS::part_event->eventtables_runorder;
1988 my $check_freq = $opt{'check_freq'} || '1d';
1990 foreach my $eventtable ( @eventtable ) {
1993 if ( $opt{'objects'} ) {
1995 @objects = @{ $opt{'objects'} };
1997 } elsif ( $eventtable eq 'cust_main' ) {
1999 @objects = ( $self );
2003 my $cm_join = " LEFT JOIN cust_main USING ( custnum )";
2004 # linkage not needed here because FS::cust_main->$eventtable will
2007 #some false laziness w/Cron::bill bill_where
2009 my $join = FS::part_event_condition->join_conditions_sql( $eventtable,
2010 'time' => $opt{'time'});
2011 my $where = FS::part_event_condition->where_conditions_sql($eventtable,
2012 'time'=>$opt{'time'},
2014 $where = $where ? "AND $where" : '';
2016 my $are_part_event =
2017 "EXISTS ( SELECT 1 FROM part_event $join
2018 WHERE check_freq = '$check_freq'
2019 AND eventtable = '$eventtable'
2020 AND ( disabled = '' OR disabled IS NULL )
2026 @objects = $self->$eventtable(
2027 'addl_from' => $cm_join,
2028 'extra_sql' => " AND $are_part_event",
2030 } # if ( !$opt{objects} and $eventtable ne 'cust_main' )
2032 my @e_cust_event = ();
2034 my $linkage = FS::part_event->eventtables_cust_join->{$eventtable} || '';
2036 my $cross = "CROSS JOIN $eventtable $linkage";
2037 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
2038 unless $eventtable eq 'cust_main';
2040 foreach my $object ( @objects ) {
2042 #this first search uses the condition_sql magic for optimization.
2043 #the more possible events we can eliminate in this step the better
2045 my $cross_where = '';
2046 my $pkey = $object->primary_key;
2047 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
2049 my $join = FS::part_event_condition->join_conditions_sql( $eventtable,
2050 'time' => $opt{'time'});
2052 FS::part_event_condition->where_conditions_sql( $eventtable,
2053 'time'=>$opt{'time'}
2055 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
2057 $extra_sql = "AND $extra_sql" if $extra_sql;
2059 #here is the agent virtualization
2060 $extra_sql .= " AND ( part_event.agentnum IS NULL
2061 OR part_event.agentnum = ". $self->agentnum. ' )';
2063 $extra_sql .= " $order";
2065 warn "searching for events for $eventtable ". $object->$pkey. "\n"
2066 if $opt{'debug'} > 2;
2067 my @part_event = qsearch( {
2068 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
2069 'select' => 'part_event.*',
2070 'table' => 'part_event',
2071 'addl_from' => "$cross $join",
2072 'hashref' => { 'check_freq' => $check_freq,
2073 'eventtable' => $eventtable,
2076 'extra_sql' => "AND $cross_where $extra_sql",
2080 my $pkey = $object->primary_key;
2081 warn " ". scalar(@part_event).
2082 " possible events found for $eventtable ". $object->$pkey(). "\n";
2085 push @e_cust_event, map {
2086 $_->new_cust_event($object, 'time' => $opt{'time'})
2091 warn " ". scalar(@e_cust_event).
2092 " subtotal possible cust events found for $eventtable\n"
2095 push @cust_event, @e_cust_event;
2099 warn " ". scalar(@cust_event).
2100 " total possible cust events found in initial search\n"
2108 $opt{stage} ||= 'collect';
2110 grep { my $stage = $_->part_event->event_stage;
2111 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
2121 @cust_event = grep $_->test_conditions( 'stats_hashref' => \%unsat ),
2124 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
2127 warn " invalid conditions not eliminated with condition_sql:\n".
2128 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
2129 if keys %unsat && $DEBUG; # > 1;
2135 unless( $opt{testonly} ) {
2136 foreach my $cust_event ( @cust_event ) {
2138 my $error = $cust_event->insert();
2140 $dbh->rollback if $oldAutoCommit;
2147 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2153 warn " returning events: ". Dumper(@cust_event). "\n"
2160 =item apply_payments_and_credits [ OPTION => VALUE ... ]
2162 Applies unapplied payments and credits.
2164 In most cases, this new method should be used in place of sequential
2165 apply_payments and apply_credits methods.
2167 A hash of optional arguments may be passed. Currently "manual" is supported.
2168 If true, a payment receipt is sent instead of a statement when
2169 'payment_receipt_email' configuration option is set.
2171 If there is an error, returns the error, otherwise returns false.
2175 sub apply_payments_and_credits {
2176 my( $self, %options ) = @_;
2178 local $SIG{HUP} = 'IGNORE';
2179 local $SIG{INT} = 'IGNORE';
2180 local $SIG{QUIT} = 'IGNORE';
2181 local $SIG{TERM} = 'IGNORE';
2182 local $SIG{TSTP} = 'IGNORE';
2183 local $SIG{PIPE} = 'IGNORE';
2185 my $oldAutoCommit = $FS::UID::AutoCommit;
2186 local $FS::UID::AutoCommit = 0;
2189 $self->select_for_update; #mutex
2191 foreach my $cust_bill ( $self->open_cust_bill ) {
2192 my $error = $cust_bill->apply_payments_and_credits(%options);
2194 $dbh->rollback if $oldAutoCommit;
2195 return "Error applying: $error";
2199 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2204 =item apply_credits OPTION => VALUE ...
2206 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
2207 to outstanding invoice balances in chronological order (or reverse
2208 chronological order if the I<order> option is set to B<newest>) and returns the
2209 value of any remaining unapplied credits available for refund (see
2210 L<FS::cust_refund>).
2212 Dies if there is an error.
2220 local $SIG{HUP} = 'IGNORE';
2221 local $SIG{INT} = 'IGNORE';
2222 local $SIG{QUIT} = 'IGNORE';
2223 local $SIG{TERM} = 'IGNORE';
2224 local $SIG{TSTP} = 'IGNORE';
2225 local $SIG{PIPE} = 'IGNORE';
2227 my $oldAutoCommit = $FS::UID::AutoCommit;
2228 local $FS::UID::AutoCommit = 0;
2231 $self->select_for_update; #mutex
2233 unless ( $self->total_unapplied_credits ) {
2234 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2238 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
2239 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
2241 my @invoices = $self->open_cust_bill;
2242 @invoices = sort { $b->_date <=> $a->_date } @invoices
2243 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
2245 if ( $conf->exists('pkg-balances') ) {
2246 # limit @credits to those w/ a pkgnum grepped from $self
2248 foreach my $i (@invoices) {
2249 foreach my $li ( $i->cust_bill_pkg ) {
2250 $pkgnums{$li->pkgnum} = 1;
2253 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
2258 foreach my $cust_bill ( @invoices ) {
2260 if ( !defined($credit) || $credit->credited == 0) {
2261 $credit = pop @credits or last;
2265 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
2266 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
2268 $owed = $cust_bill->owed;
2270 unless ( $owed > 0 ) {
2271 push @credits, $credit;
2275 my $amount = min( $credit->credited, $owed );
2277 my $cust_credit_bill = new FS::cust_credit_bill ( {
2278 'crednum' => $credit->crednum,
2279 'invnum' => $cust_bill->invnum,
2280 'amount' => $amount,
2282 $cust_credit_bill->pkgnum( $credit->pkgnum )
2283 if $conf->exists('pkg-balances') && $credit->pkgnum;
2284 my $error = $cust_credit_bill->insert;
2286 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2290 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2294 my $total_unapplied_credits = $self->total_unapplied_credits;
2296 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2298 return $total_unapplied_credits;
2301 =item apply_payments [ OPTION => VALUE ... ]
2303 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2304 to outstanding invoice balances in chronological order.
2306 #and returns the value of any remaining unapplied payments.
2308 A hash of optional arguments may be passed. Currently "manual" is supported.
2309 If true, a payment receipt is sent instead of a statement when
2310 'payment_receipt_email' configuration option is set.
2312 Dies if there is an error.
2316 sub apply_payments {
2317 my( $self, %options ) = @_;
2319 local $SIG{HUP} = 'IGNORE';
2320 local $SIG{INT} = 'IGNORE';
2321 local $SIG{QUIT} = 'IGNORE';
2322 local $SIG{TERM} = 'IGNORE';
2323 local $SIG{TSTP} = 'IGNORE';
2324 local $SIG{PIPE} = 'IGNORE';
2326 my $oldAutoCommit = $FS::UID::AutoCommit;
2327 local $FS::UID::AutoCommit = 0;
2330 $self->select_for_update; #mutex
2334 my @payments = $self->unapplied_cust_pay;
2336 my @invoices = $self->open_cust_bill;
2338 if ( $conf->exists('pkg-balances') ) {
2339 # limit @payments to those w/ a pkgnum grepped from $self
2341 foreach my $i (@invoices) {
2342 foreach my $li ( $i->cust_bill_pkg ) {
2343 $pkgnums{$li->pkgnum} = 1;
2346 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
2351 foreach my $cust_bill ( @invoices ) {
2353 if ( !defined($payment) || $payment->unapplied == 0 ) {
2354 $payment = pop @payments or last;
2358 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
2359 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
2361 $owed = $cust_bill->owed;
2363 unless ( $owed > 0 ) {
2364 push @payments, $payment;
2368 my $amount = min( $payment->unapplied, $owed );
2371 'paynum' => $payment->paynum,
2372 'invnum' => $cust_bill->invnum,
2373 'amount' => $amount,
2375 $cbp->{_date} = $payment->_date
2376 if $options{'manual'} && $options{'backdate_application'};
2377 my $cust_bill_pay = new FS::cust_bill_pay($cbp);
2378 $cust_bill_pay->pkgnum( $payment->pkgnum )
2379 if $conf->exists('pkg-balances') && $payment->pkgnum;
2380 my $error = $cust_bill_pay->insert(%options);
2382 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2386 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2390 my $total_unapplied_payments = $self->total_unapplied_payments;
2392 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2394 return $total_unapplied_payments;
2404 suspend_adjourned_pkgs
2405 unsuspend_resumed_pkgs
2408 (do_cust_event pre-bill)
2410 _omit_zero_value_bundles
2413 apply_payments_and_credits
2422 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>