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;
29 # 1 is mostly method/subroutine entry and options
30 # 2 traces progress of some operations
31 # 3 is even more information including possibly sensitive data
33 $me = '[FS::cust_main::Billing]';
35 install_callback FS::UID sub {
37 #yes, need it for stuff below (prolly should be cached)
42 FS::cust_main::Billing - Billing mixin for cust_main
48 These methods are available on FS::cust_main objects.
54 =item bill_and_collect
56 Cancels and suspends any packages due, generates bills, applies payments and
57 credits, and applies collection events to run cards, send bills and notices,
60 By default, warns on errors and continues with the next operation (but see the
63 Options are passed as name-value pairs. Currently available options are:
69 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:
73 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
77 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.
81 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
85 If set true, re-charges setup fees.
89 If set any errors prevent subsequent operations from continusing. If set
90 specifically to "return", returns the error (or false, if there is no error).
91 Any other true value causes errors to die.
95 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)
99 Optional FS::queue entry to receive status updates.
103 Options are passed to the B<bill> and B<collect> methods verbatim, so all
104 options of those methods are also available.
108 sub bill_and_collect {
109 my( $self, %options ) = @_;
111 my $log = FS::Log->new('FS::cust_main::Billing::bill_and_collect');
112 my %logopt = (object => $self);
113 $log->debug('start', %logopt);
117 #$options{actual_time} not $options{time} because freeside-daily -d is for
118 #pre-printing invoices
120 $options{'actual_time'} ||= time;
121 my $job = $options{'job'};
123 my $actual_time = ( $conf->exists('next-bill-ignore-time')
124 ? day_end( $options{actual_time} )
125 : $options{actual_time}
128 $job->update_statustext('0,cleaning expired packages') if $job;
129 $log->debug('canceling expired packages', %logopt);
130 $error = $self->cancel_expired_pkgs( $actual_time );
132 $error = "Error expiring custnum ". $self->custnum. ": $error";
133 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
134 elsif ( $options{fatal} ) { die $error; }
135 else { warn $error; }
138 $log->debug('suspending adjourned packages', %logopt);
139 $error = $self->suspend_adjourned_pkgs( $actual_time );
141 $error = "Error adjourning custnum ". $self->custnum. ": $error";
142 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
143 elsif ( $options{fatal} ) { die $error; }
144 else { warn $error; }
147 $log->debug('unsuspending resumed packages', %logopt);
148 $error = $self->unsuspend_resumed_pkgs( $actual_time );
150 $error = "Error resuming custnum ".$self->custnum. ": $error";
151 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
152 elsif ( $options{fatal} ) { die $error; }
153 else { warn $error; }
156 $job->update_statustext('20,billing packages') if $job;
157 $log->debug('billing packages', %logopt);
158 $error = $self->bill( %options );
160 $error = "Error billing custnum ". $self->custnum. ": $error";
161 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
162 elsif ( $options{fatal} ) { die $error; }
163 else { warn $error; }
166 $job->update_statustext('50,applying payments and credits') if $job;
167 $log->debug('applying payments and credits', %logopt);
168 $error = $self->apply_payments_and_credits;
170 $error = "Error applying custnum ". $self->custnum. ": $error";
171 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
172 elsif ( $options{fatal} ) { die $error; }
173 else { warn $error; }
176 # In a batch tax environment, do not run collection if any pending
177 # invoices were created. Collection will run after the next tax batch.
178 my $tax = FS::TaxEngine->new;
179 if ( $tax->info->{batch} and
180 qsearch('cust_bill', { custnum => $self->custnum, pending => 'Y' })
183 warn "skipped collection for custnum ".$self->custnum.
184 " due to pending invoices\n" if $DEBUG;
185 } elsif ( $conf->exists('cancelled_cust-noevents')
186 && ! $self->num_ncancelled_pkgs )
188 warn "skipped collection for custnum ".$self->custnum.
189 " because they have no active packages\n" if $DEBUG;
191 # run collection normally
192 $job->update_statustext('70,running collection events') if $job;
193 $log->debug('running collection events', %logopt);
194 $error = $self->collect( %options );
196 $error = "Error collecting custnum ". $self->custnum. ": $error";
197 if ($options{fatal} && $options{fatal} eq 'return') { return $error; }
198 elsif ($options{fatal} ) { die $error; }
199 else { warn $error; }
203 $job->update_statustext('100,finished') if $job;
204 $log->debug('finish', %logopt);
210 sub cancel_expired_pkgs {
211 my ( $self, $time, %options ) = @_;
213 my @cancel_pkgs = $self->ncancelled_pkgs( {
214 'extra_sql' => " AND expire IS NOT NULL AND expire > 0 AND expire <= $time "
219 CUST_PKG: foreach my $cust_pkg ( @cancel_pkgs ) {
220 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
223 if ( $cust_pkg->change_to_pkgnum ) {
225 my $new_pkg = FS::cust_pkg->by_key($cust_pkg->change_to_pkgnum);
227 push @errors, 'can\'t change pkgnum '.$cust_pkg->pkgnum.' to pkgnum '.
228 $cust_pkg->change_to_pkgnum.'; not expiring';
231 $error = $cust_pkg->change( 'cust_pkg' => $new_pkg,
232 'unprotect_svcs' => 1 );
233 $error = '' if ref $error eq 'FS::cust_pkg';
235 } else { # just cancel it
236 $error = $cust_pkg->cancel($cpr ? ( 'reason' => $cpr->reasonnum,
237 'reason_otaker' => $cpr->otaker,
243 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
246 join(' / ', @errors);
250 sub suspend_adjourned_pkgs {
251 my ( $self, $time, %options ) = @_;
253 my @susp_pkgs = $self->ncancelled_pkgs( {
255 " AND ( susp IS NULL OR susp = 0 )
256 AND ( ( bill IS NOT NULL AND bill != 0 AND bill < $time )
257 OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
262 #only because there's no SQL test for is_prepaid :/
264 grep { ( $_->part_pkg->is_prepaid
269 && $_->adjourn <= $time
277 foreach my $cust_pkg ( @susp_pkgs ) {
278 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
279 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
280 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
281 'reason_otaker' => $cpr->otaker
285 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
288 join(' / ', @errors);
292 sub unsuspend_resumed_pkgs {
293 my ( $self, $time, %options ) = @_;
295 my @unsusp_pkgs = $self->ncancelled_pkgs( {
296 'extra_sql' => " AND resume IS NOT NULL AND resume > 0 AND resume <= $time "
301 foreach my $cust_pkg ( @unsusp_pkgs ) {
302 my $error = $cust_pkg->unsuspend( 'time' => $time );
303 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
306 join(' / ', @errors);
312 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
313 conjunction with the collect method by calling B<bill_and_collect>.
315 If there is an error, returns the error, otherwise returns false.
317 Options are passed as name-value pairs. Currently available options are:
323 If set true, re-charges setup fees.
327 If set true then only bill recurring charges, not setup, usage, one time
332 If set, then override the normal frequency and look for a part_pkg_discount
333 to take at that frequency. This is appropriate only when the normal
334 frequency for all packages is monthly, and is an error otherwise. Use
335 C<pkg_list> to limit the set of packages included in billing.
339 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:
343 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
347 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
349 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
353 A hashref of pkgparts to exclude from this billing run (can also be specified as a comma-separated scalar).
357 Do not bill prepaid packages. Used by freeside-daily.
361 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.
365 This boolean value informs the us that the package is being cancelled. This
366 typically might mean not charging the normal recurring fee but only usage
367 fees since the last billing. Setup charges may be charged. Not all package
368 plans support this feature (they tend to charge 0).
372 Prevent the resetting of usage limits during this call.
376 Do not save the generated bill in the database. Useful with return_bill
380 A list reference on which the generated bill(s) will be returned.
384 Boolean value; indicates that this is an estimate rather than a "tax invoice".
385 This will be passed through to the tax engine, as online tax services
386 sometimes need to know it for reporting purposes. Otherwise it has no effect.
390 Optional terms to be printed on this invoice. Otherwise, customer-specific
391 terms or the default terms are used.
398 my( $self, %options ) = @_;
400 return '' if $self->complimentary eq 'Y';
402 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
403 my $log = FS::Log->new('FS::cust_main::Billing::bill');
404 my %logopt = (object => $self);
406 $log->debug('start', %logopt);
407 warn "$me bill customer ". $self->custnum. "\n"
410 my $time = $options{'time'} || time;
411 my $invoice_time = $options{'invoice_time'} || $time;
413 my $cmp_time = ( $conf->exists('next-bill-ignore-time')
418 $options{'not_pkgpart'} ||= {};
419 $options{'not_pkgpart'} = { map { $_ => 1 }
420 split(/\s*,\s*/, $options{'not_pkgpart'})
422 unless ref($options{'not_pkgpart'});
424 local $SIG{HUP} = 'IGNORE';
425 local $SIG{INT} = 'IGNORE';
426 local $SIG{QUIT} = 'IGNORE';
427 local $SIG{TERM} = 'IGNORE';
428 local $SIG{TSTP} = 'IGNORE';
429 local $SIG{PIPE} = 'IGNORE';
431 my $oldAutoCommit = $FS::UID::AutoCommit;
432 local $FS::UID::AutoCommit = 0;
435 $log->debug('acquiring lock', %logopt);
436 warn "$me acquiring lock on customer ". $self->custnum. "\n"
439 $self->select_for_update; #mutex
441 $log->debug('running pre-bill events', %logopt);
442 warn "$me running pre-bill events for customer ". $self->custnum. "\n"
445 my $error = $self->do_cust_event(
446 'debug' => ( $options{'debug'} || 0 ),
447 'time' => $invoice_time,
448 'check_freq' => $options{'check_freq'},
449 'stage' => 'pre-bill',
451 unless $options{no_commit};
453 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
457 $log->debug('done running pre-bill events', %logopt);
458 warn "$me done running pre-bill events for customer ". $self->custnum. "\n"
461 #keep auto-charge and non-auto-charge line items separate
462 my @passes = ( '', 'no_auto' );
464 my %cust_bill_pkg = map { $_ => [] } @passes;
467 # find the packages which are due for billing, find out how much they are
468 # & generate invoice database.
471 my %total_setup = map { my $z = 0; $_ => \$z; } @passes;
472 my %total_recur = map { my $z = 0; $_ => \$z; } @passes;
474 my @precommit_hooks = ();
476 $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ]; #param checks?
479 my $tax_is_batch = '';
481 $tax_engines{$_} = FS::TaxEngine->new(cust_main => $self,
482 invoice_time => $invoice_time,
483 cancel => $options{cancel},
484 estimate => $options{estimate},
486 $tax_is_batch ||= $tax_engines{$_}->info->{batch};
489 foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
491 next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
493 my $part_pkg = $cust_pkg->part_pkg;
495 next if $options{'no_prepaid'} && $part_pkg->is_prepaid;
497 $log->debug('bill package '. $cust_pkg->pkgnum, %logopt);
498 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG;
500 #? to avoid use of uninitialized value errors... ?
501 $cust_pkg->setfield('bill', '')
502 unless defined($cust_pkg->bill);
504 my $real_pkgpart = $cust_pkg->pkgpart;
505 my %hash = $cust_pkg->hash;
507 # we could implement this bit as FS::part_pkg::has_hidden, but we already
508 # suffer from performance issues
509 $options{has_hidden} = 0;
510 my @part_pkg = $part_pkg->self_and_bill_linked;
511 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
513 # if this package was changed from another package,
514 # and it hasn't been billed since then,
515 # and package balances are enabled,
516 if ( $cust_pkg->change_pkgnum
517 and $cust_pkg->change_date >= ($cust_pkg->last_bill || 0)
518 and $cust_pkg->change_date < $invoice_time
519 and $conf->exists('pkg-balances') )
521 # _transfer_balance will also create the appropriate credit
522 my @transfer_items = $self->_transfer_balance($cust_pkg);
523 # $part_pkg[0] is the "real" part_pkg
524 my $pass = ($cust_pkg->no_auto || $part_pkg[0]->no_auto) ?
526 push @{ $cust_bill_pkg{$pass} }, @transfer_items;
527 # treating this as recur, just because most charges are recur...
528 ${$total_recur{$pass}} += $_->recur foreach @transfer_items;
530 # currently not considering separate_bill here, as it's for
531 # one-time charges only
534 foreach my $part_pkg ( @part_pkg ) {
536 $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
539 if ( $cust_pkg->separate_bill ) {
540 # if no_auto is also set, that's fine. we just need to not have
541 # invoices that are both auto and no_auto, and since the package
542 # gets an invoice all to itself, it will only be one or the other.
543 $pass = $cust_pkg->pkgnum;
544 if (!exists $cust_bill_pkg{$pass}) { # it may not exist yet
546 $total_setup{$pass} = do { my $z = 0; \$z };
547 $total_recur{$pass} = do { my $z = 0; \$z };
548 # it also needs its own tax context
549 $tax_engines{$pass} = FS::TaxEngine->new(
551 invoice_time => $invoice_time,
552 cancel => $options{cancel},
553 estimate => $options{estimate},
555 $cust_bill_pkg{$pass} = [];
557 } elsif ( ($cust_pkg->no_auto || $part_pkg->no_auto) ) {
561 my $next_bill = $cust_pkg->getfield('bill') || 0;
563 # let this run once if this is the last bill upon cancellation
564 while ( $next_bill <= $cmp_time or $options{cancel} ) {
566 $self->_make_lines( 'part_pkg' => $part_pkg,
567 'cust_pkg' => $cust_pkg,
568 'precommit_hooks' => \@precommit_hooks,
569 'line_items' => $cust_bill_pkg{$pass},
570 'setup' => $total_setup{$pass},
571 'recur' => $total_recur{$pass},
572 'tax_engine' => $tax_engines{$pass},
574 'real_pkgpart' => $real_pkgpart,
575 'options' => \%options,
578 # Stop if anything goes wrong
581 # or if we're not incrementing the bill date.
582 last if ($cust_pkg->getfield('bill') || 0) == $next_bill;
584 # or if we're letting it run only once
585 last if $options{cancel};
587 $next_bill = $cust_pkg->getfield('bill') || 0;
589 #stop if -o was passed to freeside-daily
590 last if $options{'one_recur'};
593 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
597 } #foreach my $part_pkg
599 } #foreach my $cust_pkg
601 foreach my $pass (@passes) { # keys %cust_bill_pkg )
603 my @cust_bill_pkg = _omit_zero_value_bundles(@{ $cust_bill_pkg{$pass} });
605 warn "$me billing pass $pass\n"
606 #.Dumper(\@cust_bill_pkg)."\n"
613 my @pending_fees = FS::FeeOrigin_Mixin->by_cust($self->custnum,
614 hashref => { 'billpkgnum' => '' }
616 warn "$me found pending fees:\n".Dumper(\@pending_fees)."\n"
617 if @pending_fees and $DEBUG > 1;
619 # determine whether to generate an invoice
620 my $generate_bill = scalar(@cust_bill_pkg) > 0;
622 foreach my $fee (@pending_fees) {
623 $generate_bill = 1 unless $fee->nextbill;
626 # don't create an invoice with no line items, or where the only line
627 # items are fees that are supposed to be held until the next invoice
628 next if !$generate_bill;
632 foreach my $fee_origin (@pending_fees) {
633 my $part_fee = $fee_origin->part_fee;
635 # check whether the fee is applicable before doing anything expensive:
637 # if the fee def belongs to a different agent, don't charge the fee.
638 # event conditions should prevent this, but just in case they don't,
640 if ( $part_fee->agentnum and $part_fee->agentnum != $self->agentnum ) {
641 warn "tried to charge fee#".$part_fee->feepart .
642 " on customer#".$self->custnum." from a different agent.\n";
645 # also skip if it's disabled
646 next if $part_fee->disabled eq 'Y';
648 # Decide which invoice to base the fee on.
649 my $cust_bill = $fee_origin->cust_bill;
651 # Then link it to the current invoice. This isn't the real cust_bill
652 # object that will be inserted--in particular there are no taxes yet.
653 # If you want to charge a fee on the total invoice amount including
654 # taxes, you have to put the fee on the next invoice.
655 $cust_bill = FS::cust_bill->new({
656 'custnum' => $self->custnum,
657 'cust_bill_pkg' => \@cust_bill_pkg,
658 'charged' => ${ $total_setup{$pass} } +
659 ${ $total_recur{$pass} },
662 # If the origin is for a specific package, then only apply the fee to
663 # line items from that package.
664 if ( my $cust_pkg = $fee_origin->cust_pkg ) {
665 my @charge_fee_on_item;
666 my $charge_fee_on_amount = 0;
667 foreach (@cust_bill_pkg) {
668 if ($_->pkgnum == $cust_pkg->pkgnum) {
669 push @charge_fee_on_item, $_;
670 $charge_fee_on_amount += $_->setup + $_->recur;
673 $cust_bill->set('cust_bill_pkg', \@charge_fee_on_item);
674 $cust_bill->set('charged', $charge_fee_on_amount);
677 } # $cust_bill is now set
679 my $fee_item = $part_fee->lineitem($cust_bill) or next;
680 # link this so that we can clear the marker on inserting the line item
681 $fee_item->set('fee_origin', $fee_origin);
682 push @fee_items, $fee_item;
686 # add fees to the invoice
687 foreach my $fee_item (@fee_items) {
689 push @cust_bill_pkg, $fee_item;
690 ${ $total_setup{$pass} } += $fee_item->setup;
691 ${ $total_recur{$pass} } += $fee_item->recur;
693 my $part_fee = $fee_item->part_fee;
694 my $fee_location = $self->ship_location; # I think?
696 my $error = $tax_engines{''}->add_sale($fee_item);
698 return $error if $error;
702 # XXX implementation of fees is supposed to make this go away...
703 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
704 !$conf->exists('postal_invoice-recurring_only')
708 my $postal_pkg = $self->charge_postal_fee();
709 if ( $postal_pkg && !ref( $postal_pkg ) ) {
711 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
712 return "can't charge postal invoice fee for customer ".
713 $self->custnum. ": $postal_pkg";
715 } elsif ( $postal_pkg ) {
717 my $real_pkgpart = $postal_pkg->pkgpart;
718 # we could implement this bit as FS::part_pkg::has_hidden, but we already
719 # suffer from performance issues
720 $options{has_hidden} = 0;
721 my @part_pkg = $postal_pkg->part_pkg->self_and_bill_linked;
722 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
724 foreach my $part_pkg ( @part_pkg ) {
725 my %postal_options = %options;
726 delete $postal_options{cancel};
728 $self->_make_lines( 'part_pkg' => $part_pkg,
729 'cust_pkg' => $postal_pkg,
730 'precommit_hooks' => \@precommit_hooks,
731 'line_items' => \@cust_bill_pkg,
732 'setup' => $total_setup{$pass},
733 'recur' => $total_recur{$pass},
734 'tax_engine' => $tax_engines{$pass},
736 'real_pkgpart' => $real_pkgpart,
737 'options' => \%postal_options,
740 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
745 # it's silly to have a zero value postal_pkg, but....
746 @cust_bill_pkg = _omit_zero_value_bundles(@cust_bill_pkg);
753 #XXX does this work with batch tax engines?
754 warn "adding tax adjustments...\n" if $DEBUG > 2;
755 foreach my $cust_tax_adjustment (
756 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
762 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
764 my $itemdesc = $cust_tax_adjustment->taxname;
765 $itemdesc = '' if $itemdesc eq 'Tax';
767 push @cust_bill_pkg, new FS::cust_bill_pkg {
773 'itemdesc' => $itemdesc,
774 'itemcomment' => $cust_tax_adjustment->comment,
775 'cust_tax_adjustment' => $cust_tax_adjustment,
776 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
781 my $charged = sprintf('%.2f', ${ $total_setup{$pass} } + ${ $total_recur{$pass} } );
783 my $balance = $self->balance;
785 my $previous_bill = qsearchs({ 'table' => 'cust_bill',
786 'hashref' => { custnum=>$self->custnum },
787 'extra_sql' => 'ORDER BY _date DESC LIMIT 1',
789 my $previous_balance =
791 ? ( $previous_bill->billing_balance + $previous_bill->charged )
794 $log->debug('creating the new invoice', %logopt);
795 warn "creating the new invoice\n" if $DEBUG;
796 #create the new invoice
797 my $cust_bill = new FS::cust_bill ( {
798 'custnum' => $self->custnum,
799 '_date' => $invoice_time,
800 'charged' => $charged,
801 'billing_balance' => $balance,
802 'previous_balance' => $previous_balance,
803 'invoice_terms' => $options{'invoice_terms'},
804 'cust_bill_pkg' => \@cust_bill_pkg,
805 'pending' => 'Y', # clear this after doing taxes
808 if (!$options{no_commit}) {
809 # probably we ought to insert it as pending, and then rollback
810 # without ever un-pending it
811 $error = $cust_bill->insert;
813 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
814 return "can't create invoice for customer #". $self->custnum. ": $error";
819 # calculate and append taxes
820 if ( ! $tax_is_batch) {
822 my $arrayref = eval { $tax_engines{$pass}->calculate_taxes($cust_bill) };
825 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
829 # or should this be in TaxEngine?
831 foreach my $taxline ( @$arrayref ) {
832 $total_tax += $taxline->setup;
833 $taxline->set('invnum' => $cust_bill->invnum); # just to be sure
834 push @cust_bill_pkg, $taxline; # for return_bill
836 if (!$options{no_commit}) {
837 my $error = $taxline->insert;
839 $dbh->rollback if $oldAutoCommit;
846 # add tax to the invoice amount and finalize it
847 ${ $total_setup{$pass} } = sprintf('%.2f', ${ $total_setup{$pass} } + $total_tax);
848 $charged = sprintf('%.2f', $charged + $total_tax);
849 $cust_bill->set('charged', $charged);
850 $cust_bill->set('pending', '');
852 if (!$options{no_commit}) {
853 my $error = $cust_bill->replace;
855 $dbh->rollback if $oldAutoCommit;
860 } # if !$tax_is_batch
861 # if it IS batch, then we'll do all this in process_tax_batch
863 push @{$options{return_bill}}, $cust_bill if $options{return_bill};
865 } #foreach my $pass ( keys %cust_bill_pkg )
867 foreach my $hook ( @precommit_hooks ) {
870 } unless $options{no_commit};
872 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
873 return "$@ running precommit hook $hook\n";
877 $dbh->commit or die $dbh->errstr if $oldAutoCommit && !$options{no_commit};
882 #discard bundled packages of 0 value
883 sub _omit_zero_value_bundles {
886 my @cust_bill_pkg = ();
887 my @cust_bill_pkg_bundle = ();
889 my $discount_show_always = 0;
891 foreach my $cust_bill_pkg ( @in ) {
893 $discount_show_always = ($cust_bill_pkg->get('discounts')
894 && scalar(@{$cust_bill_pkg->get('discounts')})
895 && $conf->exists('discount-show-always'));
897 warn " pkgnum ". $cust_bill_pkg->pkgnum. " sum $sum, ".
898 "setup_show_zero ". $cust_bill_pkg->setup_show_zero.
899 "recur_show_zero ". $cust_bill_pkg->recur_show_zero. "\n"
902 if (scalar(@cust_bill_pkg_bundle) && !$cust_bill_pkg->pkgpart_override) {
903 push @cust_bill_pkg, @cust_bill_pkg_bundle
905 || ($sum == 0 && ( $discount_show_always
906 || grep {$_->recur_show_zero || $_->setup_show_zero}
907 @cust_bill_pkg_bundle
910 @cust_bill_pkg_bundle = ();
914 $sum += $cust_bill_pkg->setup + $cust_bill_pkg->recur;
915 push @cust_bill_pkg_bundle, $cust_bill_pkg;
919 push @cust_bill_pkg, @cust_bill_pkg_bundle
921 || ($sum == 0 && ( $discount_show_always
922 || grep {$_->recur_show_zero || $_->setup_show_zero}
923 @cust_bill_pkg_bundle
927 warn " _omit_zero_value_bundles: ". scalar(@in).
928 '->'. scalar(@cust_bill_pkg). "\n" #. Dumper(@cust_bill_pkg). "\n"
936 my ($self, %params) = @_;
938 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
940 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
941 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
942 my $cust_location = $cust_pkg->tax_location;
943 my $precommit_hooks = $params{precommit_hooks} or die "no precommit_hooks specified";
944 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
945 my $total_setup = $params{setup} or die "no setup accumulator specified";
946 my $total_recur = $params{recur} or die "no recur accumulator specified";
947 my $time = $params{'time'} or die "no time specified";
948 my (%options) = %{$params{options}};
950 my $tax_engine = $params{tax_engine};
952 if ( $part_pkg->freq ne '1' and ($options{'freq_override'} || 0) > 0 ) {
953 # this should never happen
954 die 'freq_override billing attempted on non-monthly package '.
959 my $real_pkgpart = $params{real_pkgpart};
960 my %hash = $cust_pkg->hash;
961 my $old_cust_pkg = new FS::cust_pkg \%hash;
966 $cust_pkg->pkgpart($part_pkg->pkgpart);
968 my $cmp_time = ( $conf->exists('next-bill-ignore-time')
979 my @setup_discounts = ();
980 my %setup_param = ( 'discounts' => \@setup_discounts,
981 'real_pkgpart' => $params{real_pkgpart}
983 my $setup_billed_currency = '';
984 my $setup_billed_amount = 0;
985 # Conditions for setting setup date and charging the setup fee:
986 # - this is not a recurring-only billing run
987 # - and the package is not currently being canceled
988 # - and, unless we're specifically told otherwise via 'resetup':
989 # - it doesn't already HAVE a setup date
990 # - or a start date in the future
991 # - and it's not suspended
993 # The last condition used to check the "disable_setup_suspended" option but
994 # that's obsolete. We now never set the setup date on a suspended package.
995 if ( ! $options{recurring_only}
996 and ! $options{cancel}
997 and ( $options{'resetup'}
998 || ( ! $cust_pkg->setup
999 && ( ! $cust_pkg->start_date
1000 || $cust_pkg->start_date <= $cmp_time
1002 && ( ! $cust_pkg->getfield('susp') )
1008 warn " bill setup\n" if $DEBUG > 1;
1010 unless ( $cust_pkg->waive_setup ) {
1013 $setup = eval { $cust_pkg->calc_setup( $time, \@details, \%setup_param ) };
1014 return "$@ running calc_setup for $cust_pkg\n"
1017 $unitsetup = $cust_pkg->base_setup()
1020 if ( $setup_param{'billed_currency'} ) {
1021 $setup_billed_currency = delete $setup_param{'billed_currency'};
1022 $setup_billed_amount = delete $setup_param{'billed_amount'};
1026 $cust_pkg->setfield('setup', $time)
1027 unless $cust_pkg->setup;
1028 #do need it, but it won't get written to the db
1029 #|| $cust_pkg->pkgpart != $real_pkgpart;
1031 $cust_pkg->setfield('start_date', '')
1032 if $cust_pkg->start_date;
1037 # bill recurring fee
1042 my @recur_discounts = ();
1043 my $recur_billed_currency = '';
1044 my $recur_billed_amount = 0;
1046 if ( ! $cust_pkg->start_date
1049 || ( $cust_pkg->susp != $cust_pkg->order_date
1050 && ( $cust_pkg->option('suspend_bill',1)
1051 || ( $part_pkg->option('suspend_bill', 1)
1052 && ! $cust_pkg->option('no_suspend_bill',1)
1056 || $cust_pkg->is_status_delay_cancel
1059 ( $part_pkg->freq ne '0' && ( $cust_pkg->bill || 0 ) <= $cmp_time )
1060 || ( $part_pkg->plan eq 'voip_cdr'
1061 && $part_pkg->option('bill_every_call')
1066 # XXX should this be a package event? probably. events are called
1067 # at collection time at the moment, though...
1068 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
1069 if $part_pkg->can('reset_usage') && !$options{'no_usage_reset'};
1070 #don't want to reset usage just cause we want a line item??
1071 #&& $part_pkg->pkgpart == $real_pkgpart;
1073 warn " bill recur\n" if $DEBUG > 1;
1076 # XXX shared with $recur_prog
1077 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
1081 #over two params! lets at least switch to a hashref for the rest...
1082 my $increment_next_bill = ( $part_pkg->freq ne '0'
1083 && ( $cust_pkg->getfield('bill') || 0 ) <= $cmp_time
1084 && !$options{cancel}
1086 my %param = ( %setup_param,
1087 'precommit_hooks' => $precommit_hooks,
1088 'increment_next_bill' => $increment_next_bill,
1089 'discounts' => \@recur_discounts,
1090 'real_pkgpart' => $real_pkgpart,
1091 'freq_override' => $options{freq_override} || '',
1095 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
1097 # There may be some part_pkg for which this is wrong. Only those
1098 # which can_discount are supported.
1099 # (the UI should prevent adding discounts to these at the moment)
1101 warn "calling $method on cust_pkg ". $cust_pkg->pkgnum.
1102 " for pkgpart ". $cust_pkg->pkgpart.
1103 " with params ". join(' / ', map "$_=>$param{$_}", keys %param). "\n"
1106 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
1107 return "$@ running $method for $cust_pkg\n"
1110 if ($recur eq 'NOTHING') {
1111 # then calc_cancel (or calc_recur but that's not used) has declined to
1112 # generate a recurring lineitem at all. treat this as zero, but also
1113 # try not to generate a lineitem.
1119 $unitrecur = $cust_pkg->base_recur( \$sdate ) || $recur; #XXX uuh, better
1121 if ( $param{'billed_currency'} ) {
1122 $recur_billed_currency = delete $param{'billed_currency'};
1123 $recur_billed_amount = delete $param{'billed_amount'};
1126 if ( $increment_next_bill ) {
1130 if ( my $main_pkg = $cust_pkg->main_pkg ) {
1131 # supplemental package
1132 # to keep in sync with the main package, simulate billing at
1134 my $main_pkg_freq = $main_pkg->part_pkg->freq;
1135 my $supp_pkg_freq = $part_pkg->freq;
1136 my $ratio = $supp_pkg_freq / $main_pkg_freq;
1137 if ( $ratio != int($ratio) ) {
1138 # the UI should prevent setting up packages like this, but just
1140 return "supplemental package period is not an integer multiple of main package period";
1142 $next_bill = $sdate;
1144 $next_bill = $part_pkg->add_freq( $next_bill, $main_pkg_freq );
1149 $next_bill = $part_pkg->add_freq($sdate, $options{freq_override} || 0);
1150 return "unparsable frequency: ". $part_pkg->freq
1151 if $next_bill == -1;
1154 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
1155 # only for figuring next bill date, nothing else, so, reset $sdate again
1157 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1158 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
1159 $cust_pkg->last_bill($sdate);
1161 $cust_pkg->setfield('bill', $next_bill );
1165 if ( $param{'setup_fee'} ) {
1166 # Add an additional setup fee at the billing stage.
1167 # Used for prorate_defer_bill.
1168 $setup += $param{'setup_fee'};
1169 $unitsetup += $param{'setup_fee'};
1173 if ( defined $param{'discount_left_setup'} ) {
1174 foreach my $discount_setup ( values %{$param{'discount_left_setup'}} ) {
1175 $setup -= $discount_setup;
1181 warn "\$setup is undefined" unless defined($setup);
1182 warn "\$recur is undefined" unless defined($recur);
1183 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1186 # If there's line items, create em cust_bill_pkg records
1187 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
1192 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
1193 # hmm.. and if just the options are modified in some weird price plan?
1195 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
1198 my $error = $cust_pkg->replace( $old_cust_pkg,
1199 'depend_jobnum'=>$options{depend_jobnum},
1200 'options' => { $cust_pkg->options },
1202 unless $options{no_commit};
1203 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
1204 if $error; #just in case
1207 $setup = sprintf( "%.2f", $setup );
1208 $recur = sprintf( "%.2f", $recur );
1209 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
1210 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1212 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
1213 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
1216 my $discount_show_always = $conf->exists('discount-show-always')
1217 && ( ($setup == 0 && scalar(@setup_discounts))
1218 || ($recur == 0 && scalar(@recur_discounts))
1223 || (!$part_pkg->hidden && $options{has_hidden}) #include some $0 lines
1224 || $discount_show_always
1225 || ($setup == 0 && $cust_pkg->_X_show_zero('setup'))
1226 || ($recur == 0 && $cust_pkg->_X_show_zero('recur'))
1230 warn " charges (setup=$setup, recur=$recur); adding line items\n"
1233 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
1235 warn " adding customer package invoice detail: $_\n"
1236 foreach @cust_pkg_detail;
1238 push @details, @cust_pkg_detail;
1240 my $cust_bill_pkg = new FS::cust_bill_pkg {
1241 'pkgnum' => $cust_pkg->pkgnum,
1243 'unitsetup' => $unitsetup,
1244 'setup_billed_currency' => $setup_billed_currency,
1245 'setup_billed_amount' => $setup_billed_amount,
1247 'unitrecur' => $unitrecur,
1248 'recur_billed_currency' => $recur_billed_currency,
1249 'recur_billed_amount' => $recur_billed_amount,
1250 'quantity' => $cust_pkg->quantity,
1251 'details' => \@details,
1252 'discounts' => [ @setup_discounts, @recur_discounts ],
1253 'hidden' => $part_pkg->hidden,
1254 'freq' => $part_pkg->freq,
1257 if ( $part_pkg->option('prorate_defer_bill',1)
1258 and !$hash{last_bill} ) {
1259 # both preceding and upcoming, technically
1260 $cust_bill_pkg->sdate( $cust_pkg->setup );
1261 $cust_bill_pkg->edate( $cust_pkg->bill );
1262 } elsif ( $part_pkg->recur_temporality eq 'preceding' ) {
1263 $cust_bill_pkg->sdate( $hash{last_bill} );
1264 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
1265 $cust_bill_pkg->edate( $time ) if $options{cancel};
1266 } else { #if ( $part_pkg->recur_temporality eq 'upcoming' )
1267 $cust_bill_pkg->sdate( $sdate );
1268 $cust_bill_pkg->edate( $cust_pkg->bill );
1269 #$cust_bill_pkg->edate( $time ) if $options{cancel};
1272 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
1273 unless $part_pkg->pkgpart == $real_pkgpart;
1275 $$total_setup += $setup;
1276 $$total_recur += $recur;
1282 my $error = $tax_engine->add_sale($cust_bill_pkg);
1283 return $error if $error;
1285 $cust_bill_pkg->set_display(
1286 part_pkg => $part_pkg,
1287 real_pkgpart => $real_pkgpart,
1290 push @$cust_bill_pkgs, $cust_bill_pkg;
1292 } #if $setup != 0 || $recur != 0
1300 =item _transfer_balance TO_PKG [ FROM_PKGNUM ]
1302 Takes one argument, a cust_pkg object that is being billed. This will
1303 be called only if the package was created by a package change, and has
1304 not been billed since the package change, and package balance tracking
1305 is enabled. The second argument can be an alternate package number to
1306 transfer the balance from; this should not be used externally.
1308 Transfers the balance from the previous package (now canceled) to
1309 this package, by crediting one package and creating an invoice item for
1310 the other. Inserts the credit and returns the invoice item (so that it
1311 can be added to an invoice that's being built).
1313 If the previous package was never billed, and was also created by a package
1314 change, then this will also transfer the balance from I<its> previous
1315 package, and so on, until reaching a package that either has been billed
1316 or was not created by a package change.
1320 my $balance_transfer_reason;
1322 sub _transfer_balance {
1324 my $cust_pkg = shift;
1325 my $from_pkgnum = shift || $cust_pkg->change_pkgnum;
1326 my $from_pkg = FS::cust_pkg->by_key($from_pkgnum);
1330 # if $from_pkg is not the first package in the chain, and it was never
1332 if ( $from_pkg->change_pkgnum and scalar($from_pkg->cust_bill_pkg) == 0 ) {
1333 @transfers = $self->_transfer_balance($cust_pkg, $from_pkg->change_pkgnum);
1336 my $prev_balance = $self->balance_pkgnum($from_pkgnum);
1337 if ( $prev_balance != 0 ) {
1338 $balance_transfer_reason ||= FS::reason->new_or_existing(
1339 'reason' => 'Package balance transfer',
1340 'type' => 'Internal adjustment',
1344 my $credit = FS::cust_credit->new({
1345 'custnum' => $self->custnum,
1346 'amount' => abs($prev_balance),
1347 'reasonnum' => $balance_transfer_reason->reasonnum,
1348 '_date' => $cust_pkg->change_date,
1351 my $cust_bill_pkg = FS::cust_bill_pkg->new({
1353 'recur' => abs($prev_balance),
1354 #'sdate' => $from_pkg->last_bill, # not sure about this
1355 #'edate' => $cust_pkg->change_date,
1356 'itemdesc' => $self->mt('Previous Balance, [_1]',
1357 $from_pkg->part_pkg->pkg),
1360 if ( $prev_balance > 0 ) {
1361 # credit the old package, charge the new one
1362 $credit->set('pkgnum', $from_pkgnum);
1363 $cust_bill_pkg->set('pkgnum', $cust_pkg->pkgnum);
1366 $credit->set('pkgnum', $cust_pkg->pkgnum);
1367 $cust_bill_pkg->set('pkgnum', $from_pkgnum);
1369 my $error = $credit->insert;
1370 die "error transferring package balance from #".$from_pkgnum.
1371 " to #".$cust_pkg->pkgnum.": $error\n" if $error;
1373 push @transfers, $cust_bill_pkg;
1374 } # $prev_balance != 0
1379 #### vestigial code ####
1381 =item handle_taxes TAXLISTHASH CUST_BILL_PKG [ OPTIONS ]
1383 This is _handle_taxes. It's called once for each cust_bill_pkg generated
1386 TAXLISTHASH is a hashref shared across the entire invoice. It looks like
1389 'cust_main_county 1001' => [ [FS::cust_main_county], ... ],
1390 'cust_main_county 1002' => [ [FS::cust_main_county], ... ],
1393 'cust_main_county' can also be 'tax_rate'. The first object in the array
1394 is always the cust_main_county or tax_rate identified by the key.
1396 That "..." is a list of FS::cust_bill_pkg objects that will be fed to
1397 the 'taxline' method to calculate the amount of the tax. This doesn't
1398 happen until calculate_taxes, though.
1400 OPTIONS may include:
1401 - part_item: a part_pkg or part_fee object to be used as the package/fee
1403 - location: a cust_location to be used as the billing location.
1404 - cancel: true if this package is being billed on cancellation. This
1405 allows tax to be calculated on usage charges only.
1407 If not supplied, part_item will be inferred from the pkgnum or feepart of the
1408 cust_bill_pkg, and location from the pkgnum (or, for fees, the invnum and
1409 the customer's default service location).
1411 This method will also calculate exemptions for any taxes that apply to the
1412 line item (using the C<set_exemptions> method of L<FS::cust_bill_pkg>) and
1413 attach them. This is the only place C<set_exemptions> is called in normal
1420 my $taxlisthash = shift;
1421 my $cust_bill_pkg = shift;
1424 # at this point I realize that we have enough information to infer all this
1425 # stuff, instead of passing around giant honking argument lists
1426 my $location = $options{location} || $cust_bill_pkg->tax_location;
1427 my $part_item = $options{part_item} || $cust_bill_pkg->part_X;
1429 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1431 return if ( $self->payby eq 'COMP' ); #dubious
1433 if ( $conf->config('enable_taxproducts')
1434 && ( scalar($part_item->part_pkg_taxoverride)
1435 || $part_item->has_taxproduct
1440 # EXTERNAL TAX RATES (via tax_rate)
1441 my %cust_bill_pkg = ();
1445 my $usage = $cust_bill_pkg->usage || 0;
1446 push @classes, $cust_bill_pkg->usage_classes if $usage;
1447 push @classes, 'setup' if $cust_bill_pkg->setup and !$options{cancel};
1448 push @classes, 'recur' if ($cust_bill_pkg->recur - $usage)
1449 and !$options{cancel};
1450 # that's better--probably don't even need $options{cancel} now
1451 # but leave it for now, just to be safe
1453 # About $options{cancel}: This protects against charging per-line or
1454 # per-customer or other flat-rate surcharges on a package that's being
1455 # billed on cancellation (which is an out-of-cycle bill and should only
1456 # have usage charges). See RT#29443.
1458 # customer exemption is now handled in the 'taxline' method
1459 #my $exempt = $conf->exists('cust_class-tax_exempt')
1460 # ? ( $self->cust_class ? $self->cust_class->tax : '' )
1462 # standardize this just to be sure
1463 #$exempt = ($exempt eq 'Y') ? 'Y' : '';
1467 unless (exists $taxes{''}) {
1468 # unsure what purpose this serves, but last time I deleted something
1469 # from here just because I didn't see the point, it actually did
1470 # something important.
1471 my $err_or_ref = $self->_gather_taxes($part_item, '', $location);
1472 return $err_or_ref unless ref($err_or_ref);
1473 $taxes{''} = $err_or_ref;
1476 # NO DISINTEGRATIONS.
1477 # my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
1479 # do not call taxline() with any argument except the entire set of
1480 # cust_bill_pkgs on an invoice that are eligible for the tax.
1482 # only calculate exemptions once for each tax rate, even if it's used
1483 # for multiple classes
1486 foreach my $class (@classes) {
1487 my $err_or_ref = $self->_gather_taxes($part_item, $class, $location);
1488 return $err_or_ref unless ref($err_or_ref);
1489 my @taxes = @$err_or_ref;
1493 foreach my $tax ( @taxes ) {
1495 my $tax_id = ref( $tax ). ' '. $tax->taxnum;
1496 # $taxlisthash: keys are tax identifiers ('FS::tax_rate 123456').
1497 # Values are arrayrefs, first the tax object (cust_main_county
1498 # or tax_rate), then the cust_bill_pkg object that the
1499 # tax applies to, then the tax class (setup, recur, usage classnum).
1500 $taxlisthash->{ $tax_id } ||= [ $tax ];
1501 push @{ $taxlisthash->{ $tax_id } }, $cust_bill_pkg, $class;
1503 # determine any exemptions that apply
1504 if (!$tax_seen{$tax_id}) {
1505 $cust_bill_pkg->set_exemptions( $tax, custnum => $self->custnum );
1506 $tax_seen{$tax_id} = 1;
1509 # tax on tax will be done later, when we actually create the tax
1517 # INTERNAL TAX RATES (cust_main_county)
1519 # We fetch taxes even if the customer is completely exempt,
1520 # because we need to record that fact.
1522 my @loc_keys = qw( district city county state country );
1523 my %taxhash = map { $_ => $location->$_ } @loc_keys;
1525 $taxhash{'taxclass'} = $part_item->taxclass;
1527 warn "taxhash:\n". Dumper(\%taxhash) if $DEBUG > 2;
1529 my @taxes = (); # entries are cust_main_county objects
1530 my %taxhash_elim = %taxhash;
1531 my @elim = qw( district city county state );
1534 #first try a match with taxclass
1535 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1537 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1538 #then try a match without taxclass
1539 my %no_taxclass = %taxhash_elim;
1540 $no_taxclass{ 'taxclass' } = '';
1541 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1544 $taxhash_elim{ shift(@elim) } = '';
1546 } while ( !scalar(@taxes) && scalar(@elim) );
1549 my $tax_id = 'cust_main_county '.$_->taxnum;
1550 $taxlisthash->{$tax_id} ||= [ $_ ];
1551 $cust_bill_pkg->set_exemptions($_, custnum => $self->custnum);
1552 push @{ $taxlisthash->{$tax_id} }, $cust_bill_pkg;
1559 =item _gather_taxes PART_ITEM CLASS CUST_LOCATION
1561 Internal method used with vendor-provided tax tables. PART_ITEM is a part_pkg
1562 or part_fee (which will define the tax eligibility of the product), CLASS is
1563 'setup', 'recur', null, or a C<usage_class> number, and CUST_LOCATION is the
1564 location where the service was provided (or billed, depending on
1565 configuration). Returns an arrayref of L<FS::tax_rate> objects that
1566 can apply to this line item.
1572 my $part_item = shift;
1574 my $location = shift;
1576 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1578 my $geocode = $location->geocode('cch');
1580 [ $part_item->tax_rates('cch', $geocode, $class) ]
1584 #### end vestigial code ####
1586 =item collect [ HASHREF | OPTION => VALUE ... ]
1588 (Attempt to) collect money for this customer's outstanding invoices (see
1589 L<FS::cust_bill>). Usually used after the bill method.
1591 Actions are now triggered by billing events; see L<FS::part_event> and the
1592 billing events web interface. Old-style invoice events (see
1593 L<FS::part_bill_event>) have been deprecated.
1595 If there is an error, returns the error, otherwise returns false.
1597 Options are passed as name-value pairs.
1599 Currently available options are:
1605 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.
1609 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1613 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1617 set true to surpress email card/ACH decline notices.
1621 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)
1627 # allows for one time override of normal customer billing method
1632 my( $self, %options ) = @_;
1634 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1636 my $invoice_time = $options{'invoice_time'} || time;
1639 local $SIG{HUP} = 'IGNORE';
1640 local $SIG{INT} = 'IGNORE';
1641 local $SIG{QUIT} = 'IGNORE';
1642 local $SIG{TERM} = 'IGNORE';
1643 local $SIG{TSTP} = 'IGNORE';
1644 local $SIG{PIPE} = 'IGNORE';
1646 my $oldAutoCommit = $FS::UID::AutoCommit;
1647 local $FS::UID::AutoCommit = 0;
1650 $self->select_for_update; #mutex
1653 my $balance = $self->balance;
1654 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
1657 if ( exists($options{'retry_card'}) ) {
1658 carp 'retry_card option passed to collect is deprecated; use retry';
1659 $options{'retry'} ||= $options{'retry_card'};
1661 if ( exists($options{'retry'}) && $options{'retry'} ) {
1662 my $error = $self->retry_realtime;
1664 $dbh->rollback if $oldAutoCommit;
1669 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1671 #never want to roll back an event just because it returned an error
1672 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1674 $self->do_cust_event(
1675 'debug' => ( $options{'debug'} || 0 ),
1676 'time' => $invoice_time,
1677 'check_freq' => $options{'check_freq'},
1678 'stage' => 'collect',
1683 =item retry_realtime
1685 Schedules realtime / batch credit card / electronic check / LEC billing
1686 events for for retry. Useful if card information has changed or manual
1687 retry is desired. The 'collect' method must be called to actually retry
1690 Implementation details: For either this customer, or for each of this
1691 customer's open invoices, changes the status of the first "done" (with
1692 statustext error) realtime processing event to "failed".
1696 sub retry_realtime {
1699 local $SIG{HUP} = 'IGNORE';
1700 local $SIG{INT} = 'IGNORE';
1701 local $SIG{QUIT} = 'IGNORE';
1702 local $SIG{TERM} = 'IGNORE';
1703 local $SIG{TSTP} = 'IGNORE';
1704 local $SIG{PIPE} = 'IGNORE';
1706 my $oldAutoCommit = $FS::UID::AutoCommit;
1707 local $FS::UID::AutoCommit = 0;
1710 #a little false laziness w/due_cust_event (not too bad, really)
1712 # I guess this is always as of now?
1713 my $join = FS::part_event_condition->join_conditions_sql('', 'time' => time);
1714 my $order = FS::part_event_condition->order_conditions_sql;
1717 . join ( ' OR ' , map {
1718 my $cust_join = FS::part_event->eventtables_cust_join->{$_} || '';
1719 my $custnum = FS::part_event->eventtables_custnum->{$_};
1720 "( part_event.eventtable = " . dbh->quote($_)
1721 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key
1722 . " from $_ $cust_join"
1723 . " where $custnum = " . dbh->quote( $self->custnum ) . "))" ;
1724 } FS::part_event->eventtables)
1727 #here is the agent virtualization
1728 my $agent_virt = " ( part_event.agentnum IS NULL
1729 OR part_event.agentnum = ". $self->agentnum. ' )';
1731 #XXX this shouldn't be hardcoded, actions should declare it...
1732 my @realtime_events = qw(
1733 cust_bill_realtime_card
1734 cust_bill_realtime_check
1735 cust_bill_realtime_lec
1739 my $is_realtime_event =
1740 ' part_event.action IN ( '.
1741 join(',', map "'$_'", @realtime_events ).
1744 my $batch_or_statustext =
1745 "( part_event.action = 'cust_bill_batch'
1746 OR ( statustext IS NOT NULL AND statustext != '' )
1750 my @cust_event = qsearch({
1751 'table' => 'cust_event',
1752 'select' => 'cust_event.*',
1753 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
1754 'hashref' => { 'status' => 'done' },
1755 'extra_sql' => " AND $batch_or_statustext ".
1756 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
1759 my %seen_invnum = ();
1760 foreach my $cust_event (@cust_event) {
1762 #max one for the customer, one for each open invoice
1763 my $cust_X = $cust_event->cust_X;
1764 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
1768 or $cust_event->part_event->eventtable eq 'cust_bill'
1771 my $error = $cust_event->retry;
1773 $dbh->rollback if $oldAutoCommit;
1774 return "error scheduling event for retry: $error";
1779 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1784 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
1786 Runs billing events; see L<FS::part_event> and the billing events web
1789 If there is an error, returns the error, otherwise returns false.
1791 Options are passed as name-value pairs.
1793 Currently available options are:
1799 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.
1803 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1807 "collect" (the default) or "pre-bill"
1811 set true to surpress email card/ACH decline notices.
1815 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)
1822 # allows for one time override of normal customer billing method
1826 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1829 my( $self, %options ) = @_;
1831 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1833 my $time = $options{'time'} || time;
1836 local $SIG{HUP} = 'IGNORE';
1837 local $SIG{INT} = 'IGNORE';
1838 local $SIG{QUIT} = 'IGNORE';
1839 local $SIG{TERM} = 'IGNORE';
1840 local $SIG{TSTP} = 'IGNORE';
1841 local $SIG{PIPE} = 'IGNORE';
1843 my $oldAutoCommit = $FS::UID::AutoCommit;
1844 local $FS::UID::AutoCommit = 0;
1847 $self->select_for_update; #mutex
1850 my $balance = $self->balance;
1851 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
1854 # if ( exists($options{'retry_card'}) ) {
1855 # carp 'retry_card option passed to collect is deprecated; use retry';
1856 # $options{'retry'} ||= $options{'retry_card'};
1858 # if ( exists($options{'retry'}) && $options{'retry'} ) {
1859 # my $error = $self->retry_realtime;
1861 # $dbh->rollback if $oldAutoCommit;
1866 # false laziness w/pay_batch::import_results
1868 my $due_cust_event = $self->due_cust_event(
1869 'debug' => ( $options{'debug'} || 0 ),
1871 'check_freq' => $options{'check_freq'},
1872 'stage' => ( $options{'stage'} || 'collect' ),
1874 unless( ref($due_cust_event) ) {
1875 $dbh->rollback if $oldAutoCommit;
1876 return $due_cust_event;
1879 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1880 #never want to roll back an event just because it or a different one
1882 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1884 foreach my $cust_event ( @$due_cust_event ) {
1888 #re-eval event conditions (a previous event could have changed things)
1889 unless ( $cust_event->test_conditions ) {
1890 #don't leave stray "new/locked" records around
1891 my $error = $cust_event->delete;
1892 return $error if $error;
1897 local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
1898 if $options{'quiet'};
1899 warn " running cust_event ". $cust_event->eventnum. "\n"
1902 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
1903 if ( my $error = $cust_event->do_event( 'time' => $time ) ) {
1904 #XXX wtf is this? figure out a proper dealio with return value
1916 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
1918 Inserts database records for and returns an ordered listref of new events due
1919 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
1920 events are due, an empty listref is returned. If there is an error, returns a
1921 scalar error message.
1923 To actually run the events, call each event's test_condition method, and if
1924 still true, call the event's do_event method.
1926 Options are passed as a hashref or as a list of name-value pairs. Available
1933 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.
1937 "collect" (the default) or "pre-bill"
1941 "Current time" for the events.
1945 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)
1949 Only return events for the specified eventtable (by default, events of all eventtables are returned)
1953 Explicitly pass the objects to be tested (typically used with eventtable).
1957 Set to true to return the objects, but not actually insert them into the
1964 sub due_cust_event {
1966 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
1969 #my $DEBUG = $opt{'debug'}
1970 $opt{'debug'} ||= 0; # silence some warnings
1971 local($DEBUG) = $opt{'debug'}
1972 if $opt{'debug'} > $DEBUG;
1973 $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1975 warn "$me due_cust_event called with options ".
1976 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
1979 $opt{'time'} ||= time;
1981 local $SIG{HUP} = 'IGNORE';
1982 local $SIG{INT} = 'IGNORE';
1983 local $SIG{QUIT} = 'IGNORE';
1984 local $SIG{TERM} = 'IGNORE';
1985 local $SIG{TSTP} = 'IGNORE';
1986 local $SIG{PIPE} = 'IGNORE';
1988 my $oldAutoCommit = $FS::UID::AutoCommit;
1989 local $FS::UID::AutoCommit = 0;
1992 $self->select_for_update #mutex
1993 unless $opt{testonly};
1996 # find possible events (initial search)
1999 my @cust_event = ();
2001 my @eventtable = $opt{'eventtable'}
2002 ? ( $opt{'eventtable'} )
2003 : FS::part_event->eventtables_runorder;
2005 my $check_freq = $opt{'check_freq'} || '1d';
2007 foreach my $eventtable ( @eventtable ) {
2010 if ( $opt{'objects'} ) {
2012 @objects = @{ $opt{'objects'} };
2014 } elsif ( $eventtable eq 'cust_main' ) {
2016 @objects = ( $self );
2020 my $cm_join = " LEFT JOIN cust_main USING ( custnum )";
2021 # linkage not needed here because FS::cust_main->$eventtable will
2024 #some false laziness w/Cron::bill bill_where
2026 my $join = FS::part_event_condition->join_conditions_sql( $eventtable,
2027 'time' => $opt{'time'});
2028 my $where = FS::part_event_condition->where_conditions_sql($eventtable,
2029 'time'=>$opt{'time'},
2031 $where = $where ? "AND $where" : '';
2033 my $are_part_event =
2034 "EXISTS ( SELECT 1 FROM part_event $join
2035 WHERE check_freq = '$check_freq'
2036 AND eventtable = '$eventtable'
2037 AND ( disabled = '' OR disabled IS NULL )
2043 @objects = $self->$eventtable(
2044 'addl_from' => $cm_join,
2045 'extra_sql' => " AND $are_part_event",
2047 } # if ( !$opt{objects} and $eventtable ne 'cust_main' )
2049 my @e_cust_event = ();
2051 my $linkage = FS::part_event->eventtables_cust_join->{$eventtable} || '';
2053 my $cross = "CROSS JOIN $eventtable $linkage";
2054 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
2055 unless $eventtable eq 'cust_main';
2057 foreach my $object ( @objects ) {
2059 #this first search uses the condition_sql magic for optimization.
2060 #the more possible events we can eliminate in this step the better
2062 my $cross_where = '';
2063 my $pkey = $object->primary_key;
2064 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
2066 my $join = FS::part_event_condition->join_conditions_sql( $eventtable,
2067 'time' => $opt{'time'});
2069 FS::part_event_condition->where_conditions_sql( $eventtable,
2070 'time'=>$opt{'time'}
2072 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
2074 $extra_sql = "AND $extra_sql" if $extra_sql;
2076 #here is the agent virtualization
2077 $extra_sql .= " AND ( part_event.agentnum IS NULL
2078 OR part_event.agentnum = ". $self->agentnum. ' )';
2080 $extra_sql .= " $order";
2082 warn "searching for events for $eventtable ". $object->$pkey. "\n"
2083 if $opt{'debug'} > 2;
2084 my @part_event = qsearch( {
2085 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
2086 'select' => 'part_event.*',
2087 'table' => 'part_event',
2088 'addl_from' => "$cross $join",
2089 'hashref' => { 'check_freq' => $check_freq,
2090 'eventtable' => $eventtable,
2093 'extra_sql' => "AND $cross_where $extra_sql",
2097 my $pkey = $object->primary_key;
2098 warn " ". scalar(@part_event).
2099 " possible events found for $eventtable ". $object->$pkey(). "\n";
2102 push @e_cust_event, map {
2103 $_->new_cust_event($object, 'time' => $opt{'time'})
2108 warn " ". scalar(@e_cust_event).
2109 " subtotal possible cust events found for $eventtable\n"
2112 push @cust_event, @e_cust_event;
2116 warn " ". scalar(@cust_event).
2117 " total possible cust events found in initial search\n"
2125 $opt{stage} ||= 'collect';
2127 grep { my $stage = $_->part_event->event_stage;
2128 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
2138 @cust_event = grep $_->test_conditions( 'stats_hashref' => \%unsat ),
2141 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
2144 warn " invalid conditions not eliminated with condition_sql:\n".
2145 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
2146 if keys %unsat && $DEBUG; # > 1;
2152 unless( $opt{testonly} ) {
2153 foreach my $cust_event ( @cust_event ) {
2155 my $error = $cust_event->insert();
2157 $dbh->rollback if $oldAutoCommit;
2164 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2170 warn " returning events: ". Dumper(@cust_event). "\n"
2177 =item apply_payments_and_credits [ OPTION => VALUE ... ]
2179 Applies unapplied payments and credits.
2181 In most cases, this new method should be used in place of sequential
2182 apply_payments and apply_credits methods.
2184 A hash of optional arguments may be passed. Currently "manual" is supported.
2185 If true, a payment receipt is sent instead of a statement when
2186 'payment_receipt_email' configuration option is set.
2188 If there is an error, returns the error, otherwise returns false.
2192 sub apply_payments_and_credits {
2193 my( $self, %options ) = @_;
2195 local $SIG{HUP} = 'IGNORE';
2196 local $SIG{INT} = 'IGNORE';
2197 local $SIG{QUIT} = 'IGNORE';
2198 local $SIG{TERM} = 'IGNORE';
2199 local $SIG{TSTP} = 'IGNORE';
2200 local $SIG{PIPE} = 'IGNORE';
2202 my $oldAutoCommit = $FS::UID::AutoCommit;
2203 local $FS::UID::AutoCommit = 0;
2206 $self->select_for_update; #mutex
2208 foreach my $cust_bill ( $self->open_cust_bill ) {
2209 my $error = $cust_bill->apply_payments_and_credits(%options);
2211 $dbh->rollback if $oldAutoCommit;
2212 return "Error applying: $error";
2216 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2221 =item apply_credits OPTION => VALUE ...
2223 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
2224 to outstanding invoice balances in chronological order (or reverse
2225 chronological order if the I<order> option is set to B<newest>) and returns the
2226 value of any remaining unapplied credits available for refund (see
2227 L<FS::cust_refund>).
2229 Dies if there is an error.
2237 local $SIG{HUP} = 'IGNORE';
2238 local $SIG{INT} = 'IGNORE';
2239 local $SIG{QUIT} = 'IGNORE';
2240 local $SIG{TERM} = 'IGNORE';
2241 local $SIG{TSTP} = 'IGNORE';
2242 local $SIG{PIPE} = 'IGNORE';
2244 my $oldAutoCommit = $FS::UID::AutoCommit;
2245 local $FS::UID::AutoCommit = 0;
2248 $self->select_for_update; #mutex
2250 unless ( $self->total_unapplied_credits ) {
2251 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2255 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
2256 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
2258 my @invoices = $self->open_cust_bill;
2259 @invoices = sort { $b->_date <=> $a->_date } @invoices
2260 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
2262 if ( $conf->exists('pkg-balances') ) {
2263 # limit @credits to those w/ a pkgnum grepped from $self
2265 foreach my $i (@invoices) {
2266 foreach my $li ( $i->cust_bill_pkg ) {
2267 $pkgnums{$li->pkgnum} = 1;
2270 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
2275 foreach my $cust_bill ( @invoices ) {
2277 if ( !defined($credit) || $credit->credited == 0) {
2278 $credit = pop @credits or last;
2282 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
2283 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
2285 $owed = $cust_bill->owed;
2287 unless ( $owed > 0 ) {
2288 push @credits, $credit;
2292 my $amount = min( $credit->credited, $owed );
2294 my $cust_credit_bill = new FS::cust_credit_bill ( {
2295 'crednum' => $credit->crednum,
2296 'invnum' => $cust_bill->invnum,
2297 'amount' => $amount,
2299 $cust_credit_bill->pkgnum( $credit->pkgnum )
2300 if $conf->exists('pkg-balances') && $credit->pkgnum;
2301 my $error = $cust_credit_bill->insert;
2303 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2307 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2311 my $total_unapplied_credits = $self->total_unapplied_credits;
2313 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2315 return $total_unapplied_credits;
2318 =item apply_payments [ OPTION => VALUE ... ]
2320 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2321 to outstanding invoice balances in chronological order.
2323 #and returns the value of any remaining unapplied payments.
2325 A hash of optional arguments may be passed. Currently "manual" is supported.
2326 If true, a payment receipt is sent instead of a statement when
2327 'payment_receipt_email' configuration option is set.
2329 Dies if there is an error.
2333 sub apply_payments {
2334 my( $self, %options ) = @_;
2336 local $SIG{HUP} = 'IGNORE';
2337 local $SIG{INT} = 'IGNORE';
2338 local $SIG{QUIT} = 'IGNORE';
2339 local $SIG{TERM} = 'IGNORE';
2340 local $SIG{TSTP} = 'IGNORE';
2341 local $SIG{PIPE} = 'IGNORE';
2343 my $oldAutoCommit = $FS::UID::AutoCommit;
2344 local $FS::UID::AutoCommit = 0;
2347 $self->select_for_update; #mutex
2351 my @payments = $self->unapplied_cust_pay;
2353 my @invoices = $self->open_cust_bill;
2355 if ( $conf->exists('pkg-balances') ) {
2356 # limit @payments to those w/ a pkgnum grepped from $self
2358 foreach my $i (@invoices) {
2359 foreach my $li ( $i->cust_bill_pkg ) {
2360 $pkgnums{$li->pkgnum} = 1;
2363 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
2368 foreach my $cust_bill ( @invoices ) {
2370 if ( !defined($payment) || $payment->unapplied == 0 ) {
2371 $payment = pop @payments or last;
2375 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
2376 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
2378 $owed = $cust_bill->owed;
2380 unless ( $owed > 0 ) {
2381 push @payments, $payment;
2385 my $amount = min( $payment->unapplied, $owed );
2388 'paynum' => $payment->paynum,
2389 'invnum' => $cust_bill->invnum,
2390 'amount' => $amount,
2392 $cbp->{_date} = $payment->_date
2393 if $options{'manual'} && $options{'backdate_application'};
2394 my $cust_bill_pay = new FS::cust_bill_pay($cbp);
2395 $cust_bill_pay->pkgnum( $payment->pkgnum )
2396 if $conf->exists('pkg-balances') && $payment->pkgnum;
2397 my $error = $cust_bill_pay->insert(%options);
2399 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2403 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2407 my $total_unapplied_payments = $self->total_unapplied_payments;
2409 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2411 return $total_unapplied_payments;
2421 suspend_adjourned_pkgs
2422 unsuspend_resumed_pkgs
2425 (do_cust_event pre-bill)
2427 _omit_zero_value_bundles
2430 apply_payments_and_credits
2439 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>