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;
26 # 1 is mostly method/subroutine entry and options
27 # 2 traces progress of some operations
28 # 3 is even more information including possibly sensitive data
30 $me = '[FS::cust_main::Billing]';
32 install_callback FS::UID sub {
34 #yes, need it for stuff below (prolly should be cached)
39 FS::cust_main::Billing - Billing mixin for cust_main
45 These methods are available on FS::cust_main objects.
51 =item bill_and_collect
53 Cancels and suspends any packages due, generates bills, applies payments and
54 credits, and applies collection events to run cards, send bills and notices,
57 By default, warns on errors and continues with the next operation (but see the
60 Options are passed as name-value pairs. Currently available options are:
66 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:
70 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
74 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.
78 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
82 If set true, re-charges setup fees.
86 If set any errors prevent subsequent operations from continusing. If set
87 specifically to "return", returns the error (or false, if there is no error).
88 Any other true value causes errors to die.
92 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)
96 Optional FS::queue entry to receive status updates.
100 Options are passed to the B<bill> and B<collect> methods verbatim, so all
101 options of those methods are also available.
105 sub bill_and_collect {
106 my( $self, %options ) = @_;
108 my $log = FS::Log->new('bill_and_collect');
109 $log->debug('start', object => $self, agentnum => $self->agentnum);
113 #$options{actual_time} not $options{time} because freeside-daily -d is for
114 #pre-printing invoices
116 $options{'actual_time'} ||= time;
117 my $job = $options{'job'};
119 my $actual_time = ( $conf->exists('next-bill-ignore-time')
120 ? day_end( $options{actual_time} )
121 : $options{actual_time}
124 $job->update_statustext('0,cleaning expired packages') if $job;
125 $error = $self->cancel_expired_pkgs( $actual_time );
127 $error = "Error expiring custnum ". $self->custnum. ": $error";
128 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
129 elsif ( $options{fatal} ) { die $error; }
130 else { warn $error; }
133 $error = $self->suspend_adjourned_pkgs( $actual_time );
135 $error = "Error adjourning custnum ". $self->custnum. ": $error";
136 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
137 elsif ( $options{fatal} ) { die $error; }
138 else { warn $error; }
141 $error = $self->unsuspend_resumed_pkgs( $actual_time );
143 $error = "Error resuming custnum ".$self->custnum. ": $error";
144 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
145 elsif ( $options{fatal} ) { die $error; }
146 else { warn $error; }
149 $job->update_statustext('20,billing packages') if $job;
150 $error = $self->bill( %options );
152 $error = "Error billing custnum ". $self->custnum. ": $error";
153 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
154 elsif ( $options{fatal} ) { die $error; }
155 else { warn $error; }
158 $job->update_statustext('50,applying payments and credits') if $job;
159 $error = $self->apply_payments_and_credits;
161 $error = "Error applying custnum ". $self->custnum. ": $error";
162 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
163 elsif ( $options{fatal} ) { die $error; }
164 else { warn $error; }
167 $job->update_statustext('70,running collection events') if $job;
168 unless ( $conf->exists('cancelled_cust-noevents')
169 && ! $self->num_ncancelled_pkgs
171 $error = $self->collect( %options );
173 $error = "Error collecting custnum ". $self->custnum. ": $error";
174 if ($options{fatal} && $options{fatal} eq 'return') { return $error; }
175 elsif ($options{fatal} ) { die $error; }
176 else { warn $error; }
179 $job->update_statustext('100,finished') if $job;
180 $log->debug('finish', object => $self, agentnum => $self->agentnum);
186 sub cancel_expired_pkgs {
187 my ( $self, $time, %options ) = @_;
189 my @cancel_pkgs = $self->ncancelled_pkgs( {
190 'extra_sql' => " AND expire IS NOT NULL AND expire > 0 AND expire <= $time "
195 foreach my $cust_pkg ( @cancel_pkgs ) {
196 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
197 my $error = $cust_pkg->cancel($cpr ? ( 'reason' => $cpr->reasonnum,
198 'reason_otaker' => $cpr->otaker,
203 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
206 join(' / ', @errors);
210 sub suspend_adjourned_pkgs {
211 my ( $self, $time, %options ) = @_;
213 my @susp_pkgs = $self->ncancelled_pkgs( {
215 " AND ( susp IS NULL OR susp = 0 )
216 AND ( ( bill IS NOT NULL AND bill != 0 AND bill < $time )
217 OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
222 #only because there's no SQL test for is_prepaid :/
224 grep { ( $_->part_pkg->is_prepaid
229 && $_->adjourn <= $time
237 foreach my $cust_pkg ( @susp_pkgs ) {
238 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
239 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
240 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
241 'reason_otaker' => $cpr->otaker
245 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
248 join(' / ', @errors);
252 sub unsuspend_resumed_pkgs {
253 my ( $self, $time, %options ) = @_;
255 my @unsusp_pkgs = $self->ncancelled_pkgs( {
256 'extra_sql' => " AND resume IS NOT NULL AND resume > 0 AND resume <= $time "
261 foreach my $cust_pkg ( @unsusp_pkgs ) {
262 my $error = $cust_pkg->unsuspend( 'time' => $time );
263 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
266 join(' / ', @errors);
272 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
273 conjunction with the collect method by calling B<bill_and_collect>.
275 If there is an error, returns the error, otherwise returns false.
277 Options are passed as name-value pairs. Currently available options are:
283 If set true, re-charges setup fees.
287 If set true then only bill recurring charges, not setup, usage, one time
292 If set, then override the normal frequency and look for a part_pkg_discount
293 to take at that frequency. This is appropriate only when the normal
294 frequency for all packages is monthly, and is an error otherwise. Use
295 C<pkg_list> to limit the set of packages included in billing.
299 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:
303 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
307 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
309 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
313 A hashref of pkgparts to exclude from this billing run (can also be specified as a comma-separated scalar).
317 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.
321 This boolean value informs the us that the package is being cancelled. This
322 typically might mean not charging the normal recurring fee but only usage
323 fees since the last billing. Setup charges may be charged. Not all package
324 plans support this feature (they tend to charge 0).
328 Prevent the resetting of usage limits during this call.
332 Do not save the generated bill in the database. Useful with return_bill
336 A list reference on which the generated bill(s) will be returned.
340 Optional terms to be printed on this invoice. Otherwise, customer-specific
341 terms or the default terms are used.
348 my( $self, %options ) = @_;
350 return '' if $self->payby eq 'COMP';
352 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
354 warn "$me bill customer ". $self->custnum. "\n"
357 my $time = $options{'time'} || time;
358 my $invoice_time = $options{'invoice_time'} || $time;
360 $options{'not_pkgpart'} ||= {};
361 $options{'not_pkgpart'} = { map { $_ => 1 }
362 split(/\s*,\s*/, $options{'not_pkgpart'})
364 unless ref($options{'not_pkgpart'});
366 local $SIG{HUP} = 'IGNORE';
367 local $SIG{INT} = 'IGNORE';
368 local $SIG{QUIT} = 'IGNORE';
369 local $SIG{TERM} = 'IGNORE';
370 local $SIG{TSTP} = 'IGNORE';
371 local $SIG{PIPE} = 'IGNORE';
373 my $oldAutoCommit = $FS::UID::AutoCommit;
374 local $FS::UID::AutoCommit = 0;
377 warn "$me acquiring lock on customer ". $self->custnum. "\n"
380 $self->select_for_update; #mutex
382 warn "$me running pre-bill events for customer ". $self->custnum. "\n"
385 my $error = $self->do_cust_event(
386 'debug' => ( $options{'debug'} || 0 ),
387 'time' => $invoice_time,
388 'check_freq' => $options{'check_freq'},
389 'stage' => 'pre-bill',
391 unless $options{no_commit};
393 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
397 warn "$me done running pre-bill events for customer ". $self->custnum. "\n"
400 #keep auto-charge and non-auto-charge line items separate
401 my @passes = ( '', 'no_auto' );
403 my %cust_bill_pkg = map { $_ => [] } @passes;
406 # find the packages which are due for billing, find out how much they are
407 # & generate invoice database.
410 my %total_setup = map { my $z = 0; $_ => \$z; } @passes;
411 my %total_recur = map { my $z = 0; $_ => \$z; } @passes;
413 my %taxlisthash = map { $_ => {} } @passes;
415 my @precommit_hooks = ();
417 $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ]; #param checks?
419 foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
421 next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
423 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG;
425 #? to avoid use of uninitialized value errors... ?
426 $cust_pkg->setfield('bill', '')
427 unless defined($cust_pkg->bill);
429 #my $part_pkg = $cust_pkg->part_pkg;
431 my $real_pkgpart = $cust_pkg->pkgpart;
432 my %hash = $cust_pkg->hash;
434 # we could implement this bit as FS::part_pkg::has_hidden, but we already
435 # suffer from performance issues
436 $options{has_hidden} = 0;
437 my @part_pkg = $cust_pkg->part_pkg->self_and_bill_linked;
438 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
440 # if this package was changed from another package,
441 # and it hasn't been billed since then,
442 # and package balances are enabled,
443 if ( $cust_pkg->change_pkgnum
444 and $cust_pkg->change_date >= ($cust_pkg->last_bill || 0)
445 and $cust_pkg->change_date < $invoice_time
446 and $conf->exists('pkg-balances') )
448 # _transfer_balance will also create the appropriate credit
449 my @transfer_items = $self->_transfer_balance($cust_pkg);
450 # $part_pkg[0] is the "real" part_pkg
451 my $pass = ($cust_pkg->no_auto || $part_pkg[0]->no_auto) ?
453 push @{ $cust_bill_pkg{$pass} }, @transfer_items;
454 # treating this as recur, just because most charges are recur...
455 ${$total_recur{$pass}} += $_->recur foreach @transfer_items;
458 foreach my $part_pkg ( @part_pkg ) {
460 $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
462 my $pass = ($cust_pkg->no_auto || $part_pkg->no_auto) ? 'no_auto' : '';
464 my $next_bill = $cust_pkg->getfield('bill') || 0;
466 # let this run once if this is the last bill upon cancellation
467 while ( $next_bill <= $time or $options{cancel} ) {
469 $self->_make_lines( 'part_pkg' => $part_pkg,
470 'cust_pkg' => $cust_pkg,
471 'precommit_hooks' => \@precommit_hooks,
472 'line_items' => $cust_bill_pkg{$pass},
473 'setup' => $total_setup{$pass},
474 'recur' => $total_recur{$pass},
475 'tax_matrix' => $taxlisthash{$pass},
477 'real_pkgpart' => $real_pkgpart,
478 'options' => \%options,
481 # Stop if anything goes wrong
484 # or if we're not incrementing the bill date.
485 last if ($cust_pkg->getfield('bill') || 0) == $next_bill;
487 # or if we're letting it run only once
488 last if $options{cancel};
490 $next_bill = $cust_pkg->getfield('bill') || 0;
492 #stop if -o was passed to freeside-daily
493 last if $options{'one_recur'};
496 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
500 } #foreach my $part_pkg
502 } #foreach my $cust_pkg
504 #if the customer isn't on an automatic payby, everything can go on a single
506 #if ( $cust_main->payby !~ /^(CARD|CHEK)$/ ) {
507 #merge everything into one list
510 foreach my $pass (@passes) { # keys %cust_bill_pkg ) {
512 my @cust_bill_pkg = _omit_zero_value_bundles(@{ $cust_bill_pkg{$pass} });
514 next unless @cust_bill_pkg; #don't create an invoice w/o line items
516 warn "$me billing pass $pass\n"
517 #.Dumper(\@cust_bill_pkg)."\n"
520 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
521 !$conf->exists('postal_invoice-recurring_only')
525 my $postal_pkg = $self->charge_postal_fee();
526 if ( $postal_pkg && !ref( $postal_pkg ) ) {
528 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
529 return "can't charge postal invoice fee for customer ".
530 $self->custnum. ": $postal_pkg";
532 } elsif ( $postal_pkg ) {
534 my $real_pkgpart = $postal_pkg->pkgpart;
535 # we could implement this bit as FS::part_pkg::has_hidden, but we already
536 # suffer from performance issues
537 $options{has_hidden} = 0;
538 my @part_pkg = $postal_pkg->part_pkg->self_and_bill_linked;
539 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
541 foreach my $part_pkg ( @part_pkg ) {
542 my %postal_options = %options;
543 delete $postal_options{cancel};
545 $self->_make_lines( 'part_pkg' => $part_pkg,
546 'cust_pkg' => $postal_pkg,
547 'precommit_hooks' => \@precommit_hooks,
548 'line_items' => \@cust_bill_pkg,
549 'setup' => $total_setup{$pass},
550 'recur' => $total_recur{$pass},
551 'tax_matrix' => $taxlisthash{$pass},
553 'real_pkgpart' => $real_pkgpart,
554 'options' => \%postal_options,
557 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
562 # it's silly to have a zero value postal_pkg, but....
563 @cust_bill_pkg = _omit_zero_value_bundles(@cust_bill_pkg);
569 my $listref_or_error =
570 $self->calculate_taxes( \@cust_bill_pkg, $taxlisthash{$pass}, $invoice_time);
572 unless ( ref( $listref_or_error ) ) {
573 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
574 return $listref_or_error;
577 foreach my $taxline ( @$listref_or_error ) {
578 ${ $total_setup{$pass} } =
579 sprintf('%.2f', ${ $total_setup{$pass} } + $taxline->setup );
580 push @cust_bill_pkg, $taxline;
584 warn "adding tax adjustments...\n" if $DEBUG > 2;
585 foreach my $cust_tax_adjustment (
586 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
592 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
594 my $itemdesc = $cust_tax_adjustment->taxname;
595 $itemdesc = '' if $itemdesc eq 'Tax';
597 push @cust_bill_pkg, new FS::cust_bill_pkg {
603 'itemdesc' => $itemdesc,
604 'itemcomment' => $cust_tax_adjustment->comment,
605 'cust_tax_adjustment' => $cust_tax_adjustment,
606 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
611 my $charged = sprintf('%.2f', ${ $total_setup{$pass} } + ${ $total_recur{$pass} } );
613 my @cust_bill = $self->cust_bill;
614 my $balance = $self->balance;
615 my $previous_balance = scalar(@cust_bill)
616 ? ( $cust_bill[$#cust_bill]->billing_balance || 0 )
619 $previous_balance += $cust_bill[$#cust_bill]->charged
620 if scalar(@cust_bill);
621 #my $balance_adjustments =
622 # sprintf('%.2f', $balance - $prior_prior_balance - $prior_charged);
624 warn "creating the new invoice\n" if $DEBUG;
625 #create the new invoice
626 my $cust_bill = new FS::cust_bill ( {
627 'custnum' => $self->custnum,
628 '_date' => $invoice_time,
629 'charged' => $charged,
630 'billing_balance' => $balance,
631 'previous_balance' => $previous_balance,
632 'invoice_terms' => $options{'invoice_terms'},
633 'cust_bill_pkg' => \@cust_bill_pkg,
635 $error = $cust_bill->insert unless $options{no_commit};
637 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
638 return "can't create invoice for customer #". $self->custnum. ": $error";
640 push @{$options{return_bill}}, $cust_bill if $options{return_bill};
642 } #foreach my $pass ( keys %cust_bill_pkg )
644 foreach my $hook ( @precommit_hooks ) {
647 } unless $options{no_commit};
649 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
650 return "$@ running precommit hook $hook\n";
654 $dbh->commit or die $dbh->errstr if $oldAutoCommit && !$options{no_commit};
659 #discard bundled packages of 0 value
660 sub _omit_zero_value_bundles {
663 my @cust_bill_pkg = ();
664 my @cust_bill_pkg_bundle = ();
666 my $discount_show_always = 0;
668 foreach my $cust_bill_pkg ( @in ) {
670 $discount_show_always = ($cust_bill_pkg->get('discounts')
671 && scalar(@{$cust_bill_pkg->get('discounts')})
672 && $conf->exists('discount-show-always'));
674 warn " pkgnum ". $cust_bill_pkg->pkgnum. " sum $sum, ".
675 "setup_show_zero ". $cust_bill_pkg->setup_show_zero.
676 "recur_show_zero ". $cust_bill_pkg->recur_show_zero. "\n"
679 if (scalar(@cust_bill_pkg_bundle) && !$cust_bill_pkg->pkgpart_override) {
680 push @cust_bill_pkg, @cust_bill_pkg_bundle
682 || ($sum == 0 && ( $discount_show_always
683 || grep {$_->recur_show_zero || $_->setup_show_zero}
684 @cust_bill_pkg_bundle
687 @cust_bill_pkg_bundle = ();
691 $sum += $cust_bill_pkg->setup + $cust_bill_pkg->recur;
692 push @cust_bill_pkg_bundle, $cust_bill_pkg;
696 push @cust_bill_pkg, @cust_bill_pkg_bundle
698 || ($sum == 0 && ( $discount_show_always
699 || grep {$_->recur_show_zero || $_->setup_show_zero}
700 @cust_bill_pkg_bundle
704 warn " _omit_zero_value_bundles: ". scalar(@in).
705 '->'. scalar(@cust_bill_pkg). "\n" #. Dumper(@cust_bill_pkg). "\n"
712 =item calculate_taxes LINEITEMREF TAXHASHREF INVOICE_TIME
714 Generates tax line items (see L<FS::cust_bill_pkg>) for this customer.
715 Usually used internally by bill method B<bill>.
717 If there is an error, returns the error, otherwise returns reference to a
718 list of line items suitable for insertion.
724 An array ref of the line items being billed.
728 A strange beast. The keys to this hash are internal identifiers consisting
729 of the name of the tax object type, a space, and its unique identifier ( e.g.
730 'cust_main_county 23' ). The values of the hash are listrefs. The first
731 item in the list is the tax object. The remaining items are either line
732 items or floating point values (currency amounts).
734 The taxes are calculated on this entity. Calculated exemption records are
735 transferred to the LINEITEMREF items on the assumption that they are related.
741 This specifies the date appearing on the associated invoice. Some
742 jurisdictions (i.e. Texas) have tax exemptions which are date sensitive.
748 sub calculate_taxes {
749 my ($self, $cust_bill_pkg, $taxlisthash, $invoice_time) = @_;
751 # $taxlisthash is a hashref
752 # keys are identifiers, values are arrayrefs
753 # each arrayref starts with a tax object (cust_main_county or tax_rate)
754 # then any cust_bill_pkg objects the tax applies to
756 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
758 warn "$me calculate_taxes\n"
759 #.Dumper($self, $cust_bill_pkg, $taxlisthash, $invoice_time). "\n"
762 my @tax_line_items = ();
764 # keys are tax names (as printed on invoices / itemdesc )
765 # values are arrayrefs of taxlisthash keys (internal identifiers)
768 # keys are taxlisthash keys (internal identifiers)
769 # values are (cumulative) amounts
772 # keys are taxlisthash keys (internal identifiers)
773 # values are arrayrefs of cust_bill_pkg_tax_location hashrefs
774 my %tax_location = ();
776 # keys are taxlisthash keys (internal identifiers)
777 # values are arrayrefs of cust_bill_pkg_tax_rate_location hashrefs
778 my %tax_rate_location = ();
780 # keys are taxlisthash keys (internal identifiers!)
781 # values are arrayrefs of cust_tax_exempt_pkg objects
784 foreach my $tax ( keys %$taxlisthash ) {
785 # $tax is a tax identifier (intersection of a tax definition record
786 # and a cust_bill_pkg record)
787 my $tax_object = shift @{ $taxlisthash->{$tax} };
788 # $tax_object is a cust_main_county or tax_rate
789 # (with billpkgnum, pkgnum, locationnum set)
790 # the rest of @{ $taxlisthash->{$tax} } is cust_bill_pkg component objects
791 # (setup, recurring, usage classes)
792 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
793 warn " ". join('/', @{ $taxlisthash->{$tax} } ). "\n" if $DEBUG > 2;
794 # taxline calculates the tax on all cust_bill_pkgs in the
795 # first (arrayref) argument, and returns a hashref of 'name'
796 # (the line item description) and 'amount'.
797 # It also calculates exemptions and attaches them to the cust_bill_pkgs
799 my $taxables = $taxlisthash->{$tax};
800 my $exemptions = $tax_exemption{$tax} ||= [];
801 my $taxline = $tax_object->taxline(
803 'custnum' => $self->custnum,
804 'invoice_time' => $invoice_time,
805 'exemptions' => $exemptions,
807 return $taxline unless ref($taxline);
809 unshift @{ $taxlisthash->{$tax} }, $tax_object;
811 if ( $tax_object->isa('FS::cust_main_county') ) {
812 # then $taxline is a real line item
813 push @{ $taxname{ $taxline->itemdesc } }, $taxline;
816 # leave this as is for now
818 my $name = $taxline->{'name'};
819 my $amount = $taxline->{'amount'};
821 #warn "adding $amount as $name\n";
822 $taxname{ $name } ||= [];
823 push @{ $taxname{ $name } }, $tax;
825 $tax_amount{ $tax } += $amount;
827 # link records between cust_main_county/tax_rate and cust_location
828 $tax_rate_location{ $tax } ||= [];
829 my $taxratelocationnum =
830 $tax_object->tax_rate_location->taxratelocationnum;
831 push @{ $tax_rate_location{ $tax } },
833 'taxnum' => $tax_object->taxnum,
834 'taxtype' => ref($tax_object),
835 'amount' => sprintf('%.2f', $amount ),
836 'locationtaxid' => $tax_object->location,
837 'taxratelocationnum' => $taxratelocationnum,
839 } #if ref($tax_object)...
840 } #foreach keys %$taxlisthash
842 #consolidate and create tax line items
843 warn "consolidating and generating...\n" if $DEBUG > 2;
844 foreach my $taxname ( keys %taxname ) {
845 my @cust_bill_pkg_tax_location;
846 my @cust_bill_pkg_tax_rate_location;
847 my $tax_cust_bill_pkg = FS::cust_bill_pkg->new({
852 'itemdesc' => $taxname,
853 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
854 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
859 warn "adding $taxname\n" if $DEBUG > 1;
860 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
861 if ( ref($taxitem) eq 'FS::cust_bill_pkg' ) {
862 # then we need to transfer the amount and the links from the
863 # line item to the new one we're creating.
864 $tax_total += $taxitem->setup;
865 foreach my $link ( @{ $taxitem->get('cust_bill_pkg_tax_location') } ) {
866 $link->set('tax_cust_bill_pkg', $tax_cust_bill_pkg);
867 push @cust_bill_pkg_tax_location, $link;
871 next if $seen{$taxitem}++;
872 warn "adding $tax_amount{$taxitem}\n" if $DEBUG > 1;
873 $tax_total += $tax_amount{$taxitem};
874 push @cust_bill_pkg_tax_rate_location,
875 map { new FS::cust_bill_pkg_tax_rate_location $_ }
876 @{ $tax_rate_location{ $taxitem } };
879 next unless $tax_total;
881 # we should really neverround this up...I guess it's okay if taxline
882 # already returns amounts with 2 decimal places
883 $tax_total = sprintf('%.2f', $tax_total );
884 $tax_cust_bill_pkg->set('setup', $tax_total);
886 my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
892 if ( $pkg_category and
893 $conf->config('invoice_latexsummary') ||
894 $conf->config('invoice_htmlsummary')
898 my %hash = ( 'section' => $pkg_category->categoryname );
899 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
902 $tax_cust_bill_pkg->set('display', \@display);
904 push @tax_line_items, $tax_cust_bill_pkg;
911 my ($self, %params) = @_;
913 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
915 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
916 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
917 my $precommit_hooks = $params{precommit_hooks} or die "no precommit_hooks specified";
918 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
919 my $total_setup = $params{setup} or die "no setup accumulator specified";
920 my $total_recur = $params{recur} or die "no recur accumulator specified";
921 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
922 my $time = $params{'time'} or die "no time specified";
923 my (%options) = %{$params{options}};
925 if ( $part_pkg->freq ne '1' and ($options{'freq_override'} || 0) > 0 ) {
926 # this should never happen
927 die 'freq_override billing attempted on non-monthly package '.
932 my $real_pkgpart = $params{real_pkgpart};
933 my %hash = $cust_pkg->hash;
934 my $old_cust_pkg = new FS::cust_pkg \%hash;
939 $cust_pkg->pkgpart($part_pkg->pkgpart);
941 my $cmp_time = ( $conf->exists('next-bill-ignore-time')
952 my @setup_discounts = ();
953 my %setup_param = ( 'discounts' => \@setup_discounts );
954 my $setup_billed_currency = '';
955 my $setup_billed_amount = 0;
956 if ( ! $options{recurring_only}
957 and ! $options{cancel}
958 and ( $options{'resetup'}
959 || ( ! $cust_pkg->setup
960 && ( ! $cust_pkg->start_date
961 || $cust_pkg->start_date <= $cmp_time
963 && ( ! $conf->exists('disable_setup_suspended_pkgs')
964 || ( $conf->exists('disable_setup_suspended_pkgs') &&
965 ! $cust_pkg->getfield('susp')
973 warn " bill setup\n" if $DEBUG > 1;
975 unless ( $cust_pkg->waive_setup ) {
978 $setup = eval { $cust_pkg->calc_setup( $time, \@details, \%setup_param ) };
979 return "$@ running calc_setup for $cust_pkg\n"
982 $unitsetup = $cust_pkg->base_setup()
985 if ( $setup_param{'billed_currency'} ) {
986 $setup_billed_currency = delete $setup_param{'billed_currency'};
987 $setup_billed_amount = delete $setup_param{'billed_amount'};
991 $cust_pkg->setfield('setup', $time)
992 unless $cust_pkg->setup;
993 #do need it, but it won't get written to the db
994 #|| $cust_pkg->pkgpart != $real_pkgpart;
996 $cust_pkg->setfield('start_date', '')
997 if $cust_pkg->start_date;
1002 # bill recurring fee
1007 my @recur_discounts = ();
1008 my $recur_billed_currency = '';
1009 my $recur_billed_amount = 0;
1011 if ( ! $cust_pkg->start_date
1012 and ( ! $cust_pkg->susp || $cust_pkg->option('suspend_bill',1)
1013 || ( $part_pkg->option('suspend_bill', 1) )
1014 && ! $cust_pkg->option('no_suspend_bill',1)
1017 ( $part_pkg->freq ne '0' && ( $cust_pkg->bill || 0 ) <= $cmp_time )
1018 || ( $part_pkg->plan eq 'voip_cdr'
1019 && $part_pkg->option('bill_every_call')
1024 # XXX should this be a package event? probably. events are called
1025 # at collection time at the moment, though...
1026 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
1027 if $part_pkg->can('reset_usage') && !$options{'no_usage_reset'};
1028 #don't want to reset usage just cause we want a line item??
1029 #&& $part_pkg->pkgpart == $real_pkgpart;
1031 warn " bill recur\n" if $DEBUG > 1;
1034 # XXX shared with $recur_prog
1035 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
1039 #over two params! lets at least switch to a hashref for the rest...
1040 my $increment_next_bill = ( $part_pkg->freq ne '0'
1041 && ( $cust_pkg->getfield('bill') || 0 ) <= $cmp_time
1042 && !$options{cancel}
1044 my %param = ( %setup_param,
1045 'precommit_hooks' => $precommit_hooks,
1046 'increment_next_bill' => $increment_next_bill,
1047 'discounts' => \@recur_discounts,
1048 'real_pkgpart' => $real_pkgpart,
1049 'freq_override' => $options{freq_override} || '',
1053 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
1055 # There may be some part_pkg for which this is wrong. Only those
1056 # which can_discount are supported.
1057 # (the UI should prevent adding discounts to these at the moment)
1059 warn "calling $method on cust_pkg ". $cust_pkg->pkgnum.
1060 " for pkgpart ". $cust_pkg->pkgpart.
1061 " with params ". join(' / ', map "$_=>$param{$_}", keys %param). "\n"
1064 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
1065 return "$@ running $method for $cust_pkg\n"
1069 $unitrecur = $cust_pkg->base_recur( \$sdate ) || $recur; #XXX uuh, better
1071 if ( $param{'billed_currency'} ) {
1072 $recur_billed_currency = delete $param{'billed_currency'};
1073 $recur_billed_amount = delete $param{'billed_amount'};
1076 if ( $increment_next_bill ) {
1080 if ( my $main_pkg = $cust_pkg->main_pkg ) {
1081 # supplemental package
1082 # to keep in sync with the main package, simulate billing at
1084 my $main_pkg_freq = $main_pkg->part_pkg->freq;
1085 my $supp_pkg_freq = $part_pkg->freq;
1086 my $ratio = $supp_pkg_freq / $main_pkg_freq;
1087 if ( $ratio != int($ratio) ) {
1088 # the UI should prevent setting up packages like this, but just
1090 return "supplemental package period is not an integer multiple of main package period";
1092 $next_bill = $sdate;
1094 $next_bill = $part_pkg->add_freq( $next_bill, $main_pkg_freq );
1099 $next_bill = $part_pkg->add_freq($sdate, $options{freq_override} || 0);
1100 return "unparsable frequency: ". $part_pkg->freq
1101 if $next_bill == -1;
1104 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
1105 # only for figuring next bill date, nothing else, so, reset $sdate again
1107 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1108 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
1109 $cust_pkg->last_bill($sdate);
1111 $cust_pkg->setfield('bill', $next_bill );
1115 if ( $param{'setup_fee'} ) {
1116 # Add an additional setup fee at the billing stage.
1117 # Used for prorate_defer_bill.
1118 $setup += $param{'setup_fee'};
1119 $unitsetup += $param{'setup_fee'};
1123 if ( defined $param{'discount_left_setup'} ) {
1124 foreach my $discount_setup ( values %{$param{'discount_left_setup'}} ) {
1125 $setup -= $discount_setup;
1131 warn "\$setup is undefined" unless defined($setup);
1132 warn "\$recur is undefined" unless defined($recur);
1133 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1136 # If there's line items, create em cust_bill_pkg records
1137 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
1142 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
1143 # hmm.. and if just the options are modified in some weird price plan?
1145 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
1148 my $error = $cust_pkg->replace( $old_cust_pkg,
1149 'depend_jobnum'=>$options{depend_jobnum},
1150 'options' => { $cust_pkg->options },
1152 unless $options{no_commit};
1153 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
1154 if $error; #just in case
1157 $setup = sprintf( "%.2f", $setup );
1158 $recur = sprintf( "%.2f", $recur );
1159 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
1160 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1162 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
1163 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
1166 my $discount_show_always = $conf->exists('discount-show-always')
1167 && ( ($setup == 0 && scalar(@setup_discounts))
1168 || ($recur == 0 && scalar(@recur_discounts))
1173 || (!$part_pkg->hidden && $options{has_hidden}) #include some $0 lines
1174 || $discount_show_always
1175 || ($setup == 0 && $cust_pkg->_X_show_zero('setup'))
1176 || ($recur == 0 && $cust_pkg->_X_show_zero('recur'))
1180 warn " charges (setup=$setup, recur=$recur); adding line items\n"
1183 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
1185 warn " adding customer package invoice detail: $_\n"
1186 foreach @cust_pkg_detail;
1188 push @details, @cust_pkg_detail;
1190 my $cust_bill_pkg = new FS::cust_bill_pkg {
1191 'pkgnum' => $cust_pkg->pkgnum,
1193 'unitsetup' => $unitsetup,
1194 'setup_billed_currency' => $setup_billed_currency,
1195 'setup_billed_amount' => $setup_billed_amount,
1197 'unitrecur' => $unitrecur,
1198 'recur_billed_currency' => $recur_billed_currency,
1199 'recur_billed_amount' => $recur_billed_amount,
1200 'quantity' => $cust_pkg->quantity,
1201 'details' => \@details,
1202 'discounts' => [ @setup_discounts, @recur_discounts ],
1203 'hidden' => $part_pkg->hidden,
1204 'freq' => $part_pkg->freq,
1207 if ( $part_pkg->option('prorate_defer_bill',1)
1208 and !$hash{last_bill} ) {
1209 # both preceding and upcoming, technically
1210 $cust_bill_pkg->sdate( $cust_pkg->setup );
1211 $cust_bill_pkg->edate( $cust_pkg->bill );
1212 } elsif ( $part_pkg->recur_temporality eq 'preceding' ) {
1213 $cust_bill_pkg->sdate( $hash{last_bill} );
1214 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
1215 $cust_bill_pkg->edate( $time ) if $options{cancel};
1216 } else { #if ( $part_pkg->recur_temporality eq 'upcoming' )
1217 $cust_bill_pkg->sdate( $sdate );
1218 $cust_bill_pkg->edate( $cust_pkg->bill );
1219 #$cust_bill_pkg->edate( $time ) if $options{cancel};
1222 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
1223 unless $part_pkg->pkgpart == $real_pkgpart;
1225 $$total_setup += $setup;
1226 $$total_recur += $recur;
1232 #unless ( $discount_show_always ) { # oh, for god's sake
1233 my $error = $self->_handle_taxes(
1238 $options{invoice_time},
1240 \%options # I have serious objections to this
1242 return $error if $error;
1245 $cust_bill_pkg->set_display(
1246 part_pkg => $part_pkg,
1247 real_pkgpart => $real_pkgpart,
1250 push @$cust_bill_pkgs, $cust_bill_pkg;
1252 } #if $setup != 0 || $recur != 0
1260 =item _transfer_balance TO_PKG [ FROM_PKGNUM ]
1262 Takes one argument, a cust_pkg object that is being billed. This will
1263 be called only if the package was created by a package change, and has
1264 not been billed since the package change, and package balance tracking
1265 is enabled. The second argument can be an alternate package number to
1266 transfer the balance from; this should not be used externally.
1268 Transfers the balance from the previous package (now canceled) to
1269 this package, by crediting one package and creating an invoice item for
1270 the other. Inserts the credit and returns the invoice item (so that it
1271 can be added to an invoice that's being built).
1273 If the previous package was never billed, and was also created by a package
1274 change, then this will also transfer the balance from I<its> previous
1275 package, and so on, until reaching a package that either has been billed
1276 or was not created by a package change.
1280 my $balance_transfer_reason;
1282 sub _transfer_balance {
1284 my $cust_pkg = shift;
1285 my $from_pkgnum = shift || $cust_pkg->change_pkgnum;
1286 my $from_pkg = FS::cust_pkg->by_key($from_pkgnum);
1290 # if $from_pkg is not the first package in the chain, and it was never
1292 if ( $from_pkg->change_pkgnum and scalar($from_pkg->cust_bill_pkg) == 0 ) {
1293 @transfers = $self->_transfer_balance($cust_pkg, $from_pkg->change_pkgnum);
1296 my $prev_balance = $self->balance_pkgnum($from_pkgnum);
1297 if ( $prev_balance != 0 ) {
1298 $balance_transfer_reason ||= FS::reason->new_or_existing(
1299 'reason' => 'Package balance transfer',
1300 'type' => 'Internal adjustment',
1304 my $credit = FS::cust_credit->new({
1305 'custnum' => $self->custnum,
1306 'amount' => abs($prev_balance),
1307 'reasonnum' => $balance_transfer_reason->reasonnum,
1308 '_date' => $cust_pkg->change_date,
1311 my $cust_bill_pkg = FS::cust_bill_pkg->new({
1313 'recur' => abs($prev_balance),
1314 #'sdate' => $from_pkg->last_bill, # not sure about this
1315 #'edate' => $cust_pkg->change_date,
1316 'itemdesc' => $self->mt('Previous Balance, [_1]',
1317 $from_pkg->part_pkg->pkg),
1320 if ( $prev_balance > 0 ) {
1321 # credit the old package, charge the new one
1322 $credit->set('pkgnum', $from_pkgnum);
1323 $cust_bill_pkg->set('pkgnum', $cust_pkg->pkgnum);
1326 $credit->set('pkgnum', $cust_pkg->pkgnum);
1327 $cust_bill_pkg->set('pkgnum', $from_pkgnum);
1329 my $error = $credit->insert;
1330 die "error transferring package balance from #".$from_pkgnum.
1331 " to #".$cust_pkg->pkgnum.": $error\n" if $error;
1333 push @transfers, $cust_bill_pkg;
1334 } # $prev_balance != 0
1339 =item _handle_taxes PART_PKG TAXLISTHASH CUST_BILL_PKG CUST_PKG TIME PKGPART [ OPTIONS ]
1341 This is _handle_taxes. It's called once for each cust_bill_pkg generated
1342 from _make_lines, along with the part_pkg, cust_pkg, invoice time, the
1343 non-overridden pkgpart, a flag indicating whether the package is being
1344 canceled, and a partridge in a pear tree.
1346 The most important argument is 'taxlisthash'. This is shared across the
1347 entire invoice. It looks like this:
1349 'cust_main_county 1001' => [ [FS::cust_main_county], ... ],
1350 'cust_main_county 1002' => [ [FS::cust_main_county], ... ],
1353 'cust_main_county' can also be 'tax_rate'. The first object in the array
1354 is always the cust_main_county or tax_rate identified by the key.
1356 That "..." is a list of FS::cust_bill_pkg objects that will be fed to
1357 the 'taxline' method to calculate the amount of the tax. This doesn't
1358 happen until calculate_taxes, though.
1364 my $part_pkg = shift;
1365 my $taxlisthash = shift;
1366 my $cust_bill_pkg = shift;
1367 my $cust_pkg = shift;
1368 my $invoice_time = shift;
1369 my $real_pkgpart = shift;
1370 my $options = shift;
1372 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1374 return if ( $self->payby eq 'COMP' ); #dubious
1376 if ( $conf->exists('enable_taxproducts')
1377 && ( scalar($part_pkg->part_pkg_taxoverride)
1378 || $part_pkg->has_taxproduct
1383 # EXTERNAL TAX RATES (via tax_rate)
1384 my %cust_bill_pkg = ();
1388 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
1389 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
1391 push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
1392 push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
1394 my $exempt = $conf->exists('cust_class-tax_exempt')
1395 ? ( $self->cust_class ? $self->cust_class->tax : '' )
1397 # standardize this just to be sure
1398 $exempt = ($exempt eq 'Y') ? 'Y' : '';
1402 foreach my $class (@classes) {
1403 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class, $cust_pkg );
1404 return $err_or_ref unless ref($err_or_ref);
1405 $taxes{$class} = $err_or_ref;
1408 unless (exists $taxes{''}) {
1409 my $err_or_ref = $self->_gather_taxes( $part_pkg, '', $cust_pkg );
1410 return $err_or_ref unless ref($err_or_ref);
1411 $taxes{''} = $err_or_ref;
1416 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
1417 foreach my $key (keys %tax_cust_bill_pkg) {
1418 # $key is "setup", "recur", or a usage class name. ('' is a usage class.)
1419 # $tax_cust_bill_pkg{$key} is a cust_bill_pkg for that component of
1421 # $taxes{$key} is an arrayref of cust_main_county or tax_rate objects that
1422 # apply to $key-class charges.
1423 my @taxes = @{ $taxes{$key} || [] };
1424 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
1426 my %localtaxlisthash = ();
1427 foreach my $tax ( @taxes ) {
1429 # this is the tax identifier, not the taxname
1430 my $taxname = ref( $tax ). ' '. $tax->taxnum;
1431 $taxname .= ' billpkgnum'. $cust_bill_pkg->billpkgnum;
1432 # We need to create a separate $taxlisthash entry for each billpkgnum
1433 # on the invoice, so that cust_bill_pkg_tax_location records will
1434 # be linked correctly.
1436 # $taxlisthash: keys are "setup", "recur", and usage classes.
1437 # Values are arrayrefs, first the tax object (cust_main_county
1438 # or tax_rate) and then any cust_bill_pkg objects that the
1440 $taxlisthash->{ $taxname } ||= [ $tax ];
1441 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
1443 $localtaxlisthash{ $taxname } ||= [ $tax ];
1444 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
1448 warn "finding taxed taxes...\n" if $DEBUG > 2;
1449 foreach my $tax ( keys %localtaxlisthash ) {
1450 my $tax_object = shift @{ $localtaxlisthash{$tax} };
1451 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
1453 next unless $tax_object->can('tax_on_tax');
1455 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
1456 my $totname = ref( $tot ). ' '. $tot->taxnum;
1458 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
1460 next unless exists( $localtaxlisthash{ $totname } ); # only increase
1462 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
1463 # we're calling taxline() right here? wtf?
1464 my $hashref_or_error =
1465 $tax_object->taxline( $localtaxlisthash{$tax},
1466 'custnum' => $self->custnum,
1467 'invoice_time' => $invoice_time,
1469 return $hashref_or_error
1470 unless ref($hashref_or_error);
1472 $taxlisthash->{ $totname } ||= [ $tot ];
1473 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
1481 # INTERNAL TAX RATES (cust_main_county)
1483 # We fetch taxes even if the customer is completely exempt,
1484 # because we need to record that fact.
1486 my @loc_keys = qw( district city county state country );
1487 my $location = $cust_pkg->tax_location;
1488 my %taxhash = map { $_ => $location->$_ } @loc_keys;
1490 $taxhash{'taxclass'} = $part_pkg->taxclass;
1492 warn "taxhash:\n". Dumper(\%taxhash) if $DEBUG > 2;
1494 my @taxes = (); # entries are cust_main_county objects
1495 my %taxhash_elim = %taxhash;
1496 my @elim = qw( district city county state );
1499 #first try a match with taxclass
1500 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1502 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1503 #then try a match without taxclass
1504 my %no_taxclass = %taxhash_elim;
1505 $no_taxclass{ 'taxclass' } = '';
1506 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1509 $taxhash_elim{ shift(@elim) } = '';
1511 } while ( !scalar(@taxes) && scalar(@elim) );
1514 my $tax_id = 'cust_main_county '.$_->taxnum;
1515 $taxlisthash->{$tax_id} ||= [ $_ ];
1516 push @{ $taxlisthash->{$tax_id} }, $cust_bill_pkg;
1525 my $part_pkg = shift;
1527 my $cust_pkg = shift;
1529 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1532 if ( $cust_pkg->locationnum && $conf->exists('tax-pkg_address') ) {
1533 $geocode = $cust_pkg->cust_location->geocode('cch');
1535 $geocode = $self->geocode('cch');
1540 my @taxclassnums = map { $_->taxclassnum }
1541 $part_pkg->part_pkg_taxoverride($class);
1543 unless (@taxclassnums) {
1544 @taxclassnums = map { $_->taxclassnum }
1545 grep { $_->taxable eq 'Y' }
1546 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
1548 warn "Found taxclassnum values of ". join(',', @taxclassnums)
1553 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
1555 @taxes = qsearch({ 'table' => 'tax_rate',
1556 'hashref' => { 'geocode' => $geocode, },
1557 'extra_sql' => $extra_sql,
1559 if scalar(@taxclassnums);
1561 warn "Found taxes ".
1562 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
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 my $join = FS::part_event_condition->join_conditions_sql;
1696 my $order = FS::part_event_condition->order_conditions_sql;
1699 . join ( ' OR ' , map {
1700 my $cust_join = FS::part_event->eventtables_cust_join->{$_} || '';
1701 my $custnum = FS::part_event->eventtables_custnum->{$_};
1702 "( part_event.eventtable = " . dbh->quote($_)
1703 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key
1704 . " from $_ $cust_join"
1705 . " where $custnum = " . dbh->quote( $self->custnum ) . "))" ;
1706 } FS::part_event->eventtables)
1709 #here is the agent virtualization
1710 my $agent_virt = " ( part_event.agentnum IS NULL
1711 OR part_event.agentnum = ". $self->agentnum. ' )';
1713 #XXX this shouldn't be hardcoded, actions should declare it...
1714 my @realtime_events = qw(
1715 cust_bill_realtime_card
1716 cust_bill_realtime_check
1717 cust_bill_realtime_lec
1721 my $is_realtime_event =
1722 ' part_event.action IN ( '.
1723 join(',', map "'$_'", @realtime_events ).
1726 my $batch_or_statustext =
1727 "( part_event.action = 'cust_bill_batch'
1728 OR ( statustext IS NOT NULL AND statustext != '' )
1732 my @cust_event = qsearch({
1733 'table' => 'cust_event',
1734 'select' => 'cust_event.*',
1735 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
1736 'hashref' => { 'status' => 'done' },
1737 'extra_sql' => " AND $batch_or_statustext ".
1738 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
1741 my %seen_invnum = ();
1742 foreach my $cust_event (@cust_event) {
1744 #max one for the customer, one for each open invoice
1745 my $cust_X = $cust_event->cust_X;
1746 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
1750 or $cust_event->part_event->eventtable eq 'cust_bill'
1753 my $error = $cust_event->retry;
1755 $dbh->rollback if $oldAutoCommit;
1756 return "error scheduling event for retry: $error";
1761 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1766 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
1768 Runs billing events; see L<FS::part_event> and the billing events web
1771 If there is an error, returns the error, otherwise returns false.
1773 Options are passed as name-value pairs.
1775 Currently available options are:
1781 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.
1785 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1789 "collect" (the default) or "pre-bill"
1793 set true to surpress email card/ACH decline notices.
1797 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)
1804 # allows for one time override of normal customer billing method
1808 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1811 my( $self, %options ) = @_;
1813 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1815 my $time = $options{'time'} || time;
1818 local $SIG{HUP} = 'IGNORE';
1819 local $SIG{INT} = 'IGNORE';
1820 local $SIG{QUIT} = 'IGNORE';
1821 local $SIG{TERM} = 'IGNORE';
1822 local $SIG{TSTP} = 'IGNORE';
1823 local $SIG{PIPE} = 'IGNORE';
1825 my $oldAutoCommit = $FS::UID::AutoCommit;
1826 local $FS::UID::AutoCommit = 0;
1829 $self->select_for_update; #mutex
1832 my $balance = $self->balance;
1833 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
1836 # if ( exists($options{'retry_card'}) ) {
1837 # carp 'retry_card option passed to collect is deprecated; use retry';
1838 # $options{'retry'} ||= $options{'retry_card'};
1840 # if ( exists($options{'retry'}) && $options{'retry'} ) {
1841 # my $error = $self->retry_realtime;
1843 # $dbh->rollback if $oldAutoCommit;
1848 # false laziness w/pay_batch::import_results
1850 my $due_cust_event = $self->due_cust_event(
1851 'debug' => ( $options{'debug'} || 0 ),
1853 'check_freq' => $options{'check_freq'},
1854 'stage' => ( $options{'stage'} || 'collect' ),
1856 unless( ref($due_cust_event) ) {
1857 $dbh->rollback if $oldAutoCommit;
1858 return $due_cust_event;
1861 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1862 #never want to roll back an event just because it or a different one
1864 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1866 foreach my $cust_event ( @$due_cust_event ) {
1870 #re-eval event conditions (a previous event could have changed things)
1871 unless ( $cust_event->test_conditions ) {
1872 #don't leave stray "new/locked" records around
1873 my $error = $cust_event->delete;
1874 return $error if $error;
1879 local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
1880 if $options{'quiet'};
1881 warn " running cust_event ". $cust_event->eventnum. "\n"
1884 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
1885 if ( my $error = $cust_event->do_event( 'time' => $time ) ) {
1886 #XXX wtf is this? figure out a proper dealio with return value
1898 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
1900 Inserts database records for and returns an ordered listref of new events due
1901 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
1902 events are due, an empty listref is returned. If there is an error, returns a
1903 scalar error message.
1905 To actually run the events, call each event's test_condition method, and if
1906 still true, call the event's do_event method.
1908 Options are passed as a hashref or as a list of name-value pairs. Available
1915 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.
1919 "collect" (the default) or "pre-bill"
1923 "Current time" for the events.
1927 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)
1931 Only return events for the specified eventtable (by default, events of all eventtables are returned)
1935 Explicitly pass the objects to be tested (typically used with eventtable).
1939 Set to true to return the objects, but not actually insert them into the
1946 sub due_cust_event {
1948 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
1951 #my $DEBUG = $opt{'debug'}
1952 $opt{'debug'} ||= 0; # silence some warnings
1953 local($DEBUG) = $opt{'debug'}
1954 if $opt{'debug'} > $DEBUG;
1955 $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1957 warn "$me due_cust_event called with options ".
1958 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
1961 $opt{'time'} ||= time;
1963 local $SIG{HUP} = 'IGNORE';
1964 local $SIG{INT} = 'IGNORE';
1965 local $SIG{QUIT} = 'IGNORE';
1966 local $SIG{TERM} = 'IGNORE';
1967 local $SIG{TSTP} = 'IGNORE';
1968 local $SIG{PIPE} = 'IGNORE';
1970 my $oldAutoCommit = $FS::UID::AutoCommit;
1971 local $FS::UID::AutoCommit = 0;
1974 $self->select_for_update #mutex
1975 unless $opt{testonly};
1978 # find possible events (initial search)
1981 my @cust_event = ();
1983 my @eventtable = $opt{'eventtable'}
1984 ? ( $opt{'eventtable'} )
1985 : FS::part_event->eventtables_runorder;
1987 my $check_freq = $opt{'check_freq'} || '1d';
1989 foreach my $eventtable ( @eventtable ) {
1992 if ( $opt{'objects'} ) {
1994 @objects = @{ $opt{'objects'} };
1996 } elsif ( $eventtable eq 'cust_main' ) {
1998 @objects = ( $self );
2002 my $cm_join = " LEFT JOIN cust_main USING ( custnum )";
2003 # linkage not needed here because FS::cust_main->$eventtable will
2006 #some false laziness w/Cron::bill bill_where
2008 my $join = FS::part_event_condition->join_conditions_sql( $eventtable);
2009 my $where = FS::part_event_condition->where_conditions_sql($eventtable,
2010 'time'=>$opt{'time'},
2012 $where = $where ? "AND $where" : '';
2014 my $are_part_event =
2015 "EXISTS ( SELECT 1 FROM part_event $join
2016 WHERE check_freq = '$check_freq'
2017 AND eventtable = '$eventtable'
2018 AND ( disabled = '' OR disabled IS NULL )
2024 @objects = $self->$eventtable(
2025 'addl_from' => $cm_join,
2026 'extra_sql' => " AND $are_part_event",
2028 } # if ( !$opt{objects} and $eventtable ne 'cust_main' )
2030 my @e_cust_event = ();
2032 my $linkage = FS::part_event->eventtables_cust_join->{$eventtable} || '';
2034 my $cross = "CROSS JOIN $eventtable $linkage";
2035 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
2036 unless $eventtable eq 'cust_main';
2038 foreach my $object ( @objects ) {
2040 #this first search uses the condition_sql magic for optimization.
2041 #the more possible events we can eliminate in this step the better
2043 my $cross_where = '';
2044 my $pkey = $object->primary_key;
2045 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
2047 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
2049 FS::part_event_condition->where_conditions_sql( $eventtable,
2050 'time'=>$opt{'time'}
2052 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
2054 $extra_sql = "AND $extra_sql" if $extra_sql;
2056 #here is the agent virtualization
2057 $extra_sql .= " AND ( part_event.agentnum IS NULL
2058 OR part_event.agentnum = ". $self->agentnum. ' )';
2060 $extra_sql .= " $order";
2062 warn "searching for events for $eventtable ". $object->$pkey. "\n"
2063 if $opt{'debug'} > 2;
2064 my @part_event = qsearch( {
2065 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
2066 'select' => 'part_event.*',
2067 'table' => 'part_event',
2068 'addl_from' => "$cross $join",
2069 'hashref' => { 'check_freq' => $check_freq,
2070 'eventtable' => $eventtable,
2073 'extra_sql' => "AND $cross_where $extra_sql",
2077 my $pkey = $object->primary_key;
2078 warn " ". scalar(@part_event).
2079 " possible events found for $eventtable ". $object->$pkey(). "\n";
2082 push @e_cust_event, map {
2083 $_->new_cust_event($object, 'time' => $opt{'time'})
2088 warn " ". scalar(@e_cust_event).
2089 " subtotal possible cust events found for $eventtable\n"
2092 push @cust_event, @e_cust_event;
2096 warn " ". scalar(@cust_event).
2097 " total possible cust events found in initial search\n"
2105 $opt{stage} ||= 'collect';
2107 grep { my $stage = $_->part_event->event_stage;
2108 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
2118 @cust_event = grep $_->test_conditions( 'stats_hashref' => \%unsat ),
2121 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
2124 warn " invalid conditions not eliminated with condition_sql:\n".
2125 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
2126 if keys %unsat && $DEBUG; # > 1;
2132 unless( $opt{testonly} ) {
2133 foreach my $cust_event ( @cust_event ) {
2135 my $error = $cust_event->insert();
2137 $dbh->rollback if $oldAutoCommit;
2144 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2150 warn " returning events: ". Dumper(@cust_event). "\n"
2157 =item apply_payments_and_credits [ OPTION => VALUE ... ]
2159 Applies unapplied payments and credits.
2161 In most cases, this new method should be used in place of sequential
2162 apply_payments and apply_credits methods.
2164 A hash of optional arguments may be passed. Currently "manual" is supported.
2165 If true, a payment receipt is sent instead of a statement when
2166 'payment_receipt_email' configuration option is set.
2168 If there is an error, returns the error, otherwise returns false.
2172 sub apply_payments_and_credits {
2173 my( $self, %options ) = @_;
2175 local $SIG{HUP} = 'IGNORE';
2176 local $SIG{INT} = 'IGNORE';
2177 local $SIG{QUIT} = 'IGNORE';
2178 local $SIG{TERM} = 'IGNORE';
2179 local $SIG{TSTP} = 'IGNORE';
2180 local $SIG{PIPE} = 'IGNORE';
2182 my $oldAutoCommit = $FS::UID::AutoCommit;
2183 local $FS::UID::AutoCommit = 0;
2186 $self->select_for_update; #mutex
2188 foreach my $cust_bill ( $self->open_cust_bill ) {
2189 my $error = $cust_bill->apply_payments_and_credits(%options);
2191 $dbh->rollback if $oldAutoCommit;
2192 return "Error applying: $error";
2196 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2201 =item apply_credits OPTION => VALUE ...
2203 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
2204 to outstanding invoice balances in chronological order (or reverse
2205 chronological order if the I<order> option is set to B<newest>) and returns the
2206 value of any remaining unapplied credits available for refund (see
2207 L<FS::cust_refund>).
2209 Dies if there is an error.
2217 local $SIG{HUP} = 'IGNORE';
2218 local $SIG{INT} = 'IGNORE';
2219 local $SIG{QUIT} = 'IGNORE';
2220 local $SIG{TERM} = 'IGNORE';
2221 local $SIG{TSTP} = 'IGNORE';
2222 local $SIG{PIPE} = 'IGNORE';
2224 my $oldAutoCommit = $FS::UID::AutoCommit;
2225 local $FS::UID::AutoCommit = 0;
2228 $self->select_for_update; #mutex
2230 unless ( $self->total_unapplied_credits ) {
2231 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2235 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
2236 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
2238 my @invoices = $self->open_cust_bill;
2239 @invoices = sort { $b->_date <=> $a->_date } @invoices
2240 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
2242 if ( $conf->exists('pkg-balances') ) {
2243 # limit @credits to those w/ a pkgnum grepped from $self
2245 foreach my $i (@invoices) {
2246 foreach my $li ( $i->cust_bill_pkg ) {
2247 $pkgnums{$li->pkgnum} = 1;
2250 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
2255 foreach my $cust_bill ( @invoices ) {
2257 if ( !defined($credit) || $credit->credited == 0) {
2258 $credit = pop @credits or last;
2262 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
2263 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
2265 $owed = $cust_bill->owed;
2267 unless ( $owed > 0 ) {
2268 push @credits, $credit;
2272 my $amount = min( $credit->credited, $owed );
2274 my $cust_credit_bill = new FS::cust_credit_bill ( {
2275 'crednum' => $credit->crednum,
2276 'invnum' => $cust_bill->invnum,
2277 'amount' => $amount,
2279 $cust_credit_bill->pkgnum( $credit->pkgnum )
2280 if $conf->exists('pkg-balances') && $credit->pkgnum;
2281 my $error = $cust_credit_bill->insert;
2283 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2287 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2291 my $total_unapplied_credits = $self->total_unapplied_credits;
2293 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2295 return $total_unapplied_credits;
2298 =item apply_payments [ OPTION => VALUE ... ]
2300 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2301 to outstanding invoice balances in chronological order.
2303 #and returns the value of any remaining unapplied payments.
2305 A hash of optional arguments may be passed. Currently "manual" is supported.
2306 If true, a payment receipt is sent instead of a statement when
2307 'payment_receipt_email' configuration option is set.
2309 Dies if there is an error.
2313 sub apply_payments {
2314 my( $self, %options ) = @_;
2316 local $SIG{HUP} = 'IGNORE';
2317 local $SIG{INT} = 'IGNORE';
2318 local $SIG{QUIT} = 'IGNORE';
2319 local $SIG{TERM} = 'IGNORE';
2320 local $SIG{TSTP} = 'IGNORE';
2321 local $SIG{PIPE} = 'IGNORE';
2323 my $oldAutoCommit = $FS::UID::AutoCommit;
2324 local $FS::UID::AutoCommit = 0;
2327 $self->select_for_update; #mutex
2331 my @payments = sort { $b->_date <=> $a->_date }
2332 grep { $_->unapplied > 0 }
2335 my @invoices = sort { $a->_date <=> $b->_date}
2336 grep { $_->owed > 0 }
2339 if ( $conf->exists('pkg-balances') ) {
2340 # limit @payments to those w/ a pkgnum grepped from $self
2342 foreach my $i (@invoices) {
2343 foreach my $li ( $i->cust_bill_pkg ) {
2344 $pkgnums{$li->pkgnum} = 1;
2347 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
2352 foreach my $cust_bill ( @invoices ) {
2354 if ( !defined($payment) || $payment->unapplied == 0 ) {
2355 $payment = pop @payments or last;
2359 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
2360 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
2362 $owed = $cust_bill->owed;
2364 unless ( $owed > 0 ) {
2365 push @payments, $payment;
2369 my $amount = min( $payment->unapplied, $owed );
2372 'paynum' => $payment->paynum,
2373 'invnum' => $cust_bill->invnum,
2374 'amount' => $amount,
2376 $cbp->{_date} = $payment->_date
2377 if $options{'manual'} && $options{'backdate_application'};
2378 my $cust_bill_pay = new FS::cust_bill_pay($cbp);
2379 $cust_bill_pay->pkgnum( $payment->pkgnum )
2380 if $conf->exists('pkg-balances') && $payment->pkgnum;
2381 my $error = $cust_bill_pay->insert(%options);
2383 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2387 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2391 my $total_unapplied_payments = $self->total_unapplied_payments;
2393 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2395 return $total_unapplied_payments;
2405 suspend_adjourned_pkgs
2406 unsuspend_resumed_pkgs
2409 (do_cust_event pre-bill)
2412 (vendor-only) _gather_taxes
2413 _omit_zero_value_bundles
2416 apply_payments_and_credits
2425 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>