1 package FS::cust_main::Billing;
4 use vars qw( $conf $DEBUG $me );
7 use List::Util qw( min );
9 use FS::Record qw( qsearch qsearchs dbdef );
10 use FS::Misc::DateTime qw( day_end );
12 use FS::cust_bill_pkg;
13 use FS::cust_bill_pkg_display;
14 use FS::cust_bill_pay;
15 use FS::cust_credit_bill;
16 use FS::cust_tax_adjustment;
18 use FS::tax_rate_location;
19 use FS::cust_bill_pkg_tax_location;
20 use FS::cust_bill_pkg_tax_rate_location;
22 use FS::part_event_condition;
24 use FS::cust_event_fee;
27 # 1 is mostly method/subroutine entry and options
28 # 2 traces progress of some operations
29 # 3 is even more information including possibly sensitive data
31 $me = '[FS::cust_main::Billing]';
33 install_callback FS::UID sub {
35 #yes, need it for stuff below (prolly should be cached)
40 FS::cust_main::Billing - Billing mixin for cust_main
46 These methods are available on FS::cust_main objects.
52 =item bill_and_collect
54 Cancels and suspends any packages due, generates bills, applies payments and
55 credits, and applies collection events to run cards, send bills and notices,
58 By default, warns on errors and continues with the next operation (but see the
61 Options are passed as name-value pairs. Currently available options are:
67 Bills the customer as if it were that time. Specified as a UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion functions. For example:
71 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
75 Used in conjunction with the I<time> option, this option specifies the date of for the generated invoices. Other calculations, such as whether or not to generate the invoice in the first place, are not affected.
79 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
83 If set true, re-charges setup fees.
87 If set any errors prevent subsequent operations from continusing. If set
88 specifically to "return", returns the error (or false, if there is no error).
89 Any other true value causes errors to die.
93 Debugging level. Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
97 Optional FS::queue entry to receive status updates.
101 Options are passed to the B<bill> and B<collect> methods verbatim, so all
102 options of those methods are also available.
106 sub bill_and_collect {
107 my( $self, %options ) = @_;
109 my $log = FS::Log->new('bill_and_collect');
110 $log->debug('start', object => $self, agentnum => $self->agentnum);
114 #$options{actual_time} not $options{time} because freeside-daily -d is for
115 #pre-printing invoices
117 $options{'actual_time'} ||= time;
118 my $job = $options{'job'};
120 my $actual_time = ( $conf->exists('next-bill-ignore-time')
121 ? day_end( $options{actual_time} )
122 : $options{actual_time}
125 $job->update_statustext('0,cleaning expired packages') if $job;
126 $error = $self->cancel_expired_pkgs( $actual_time );
128 $error = "Error expiring custnum ". $self->custnum. ": $error";
129 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
130 elsif ( $options{fatal} ) { die $error; }
131 else { warn $error; }
134 $error = $self->suspend_adjourned_pkgs( $actual_time );
136 $error = "Error adjourning custnum ". $self->custnum. ": $error";
137 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
138 elsif ( $options{fatal} ) { die $error; }
139 else { warn $error; }
142 $error = $self->unsuspend_resumed_pkgs( $actual_time );
144 $error = "Error resuming custnum ".$self->custnum. ": $error";
145 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
146 elsif ( $options{fatal} ) { die $error; }
147 else { warn $error; }
150 $job->update_statustext('20,billing packages') if $job;
151 $error = $self->bill( %options );
153 $error = "Error billing custnum ". $self->custnum. ": $error";
154 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
155 elsif ( $options{fatal} ) { die $error; }
156 else { warn $error; }
159 $job->update_statustext('50,applying payments and credits') if $job;
160 $error = $self->apply_payments_and_credits;
162 $error = "Error applying custnum ". $self->custnum. ": $error";
163 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
164 elsif ( $options{fatal} ) { die $error; }
165 else { warn $error; }
168 $job->update_statustext('70,running collection events') if $job;
169 unless ( $conf->exists('cancelled_cust-noevents')
170 && ! $self->num_ncancelled_pkgs
172 $error = $self->collect( %options );
174 $error = "Error collecting custnum ". $self->custnum. ": $error";
175 if ($options{fatal} && $options{fatal} eq 'return') { return $error; }
176 elsif ($options{fatal} ) { die $error; }
177 else { warn $error; }
180 $job->update_statustext('100,finished') if $job;
181 $log->debug('finish', object => $self, agentnum => $self->agentnum);
187 sub cancel_expired_pkgs {
188 my ( $self, $time, %options ) = @_;
190 my @cancel_pkgs = $self->ncancelled_pkgs( {
191 'extra_sql' => " AND expire IS NOT NULL AND expire > 0 AND expire <= $time "
196 CUST_PKG: foreach my $cust_pkg ( @cancel_pkgs ) {
197 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
200 if ( $cust_pkg->change_to_pkgnum ) {
202 my $new_pkg = FS::cust_pkg->by_key($cust_pkg->change_to_pkgnum);
204 push @errors, 'can\'t change pkgnum '.$cust_pkg->pkgnum.' to pkgnum '.
205 $cust_pkg->change_to_pkgnum.'; not expiring';
208 $error = $cust_pkg->change( 'cust_pkg' => $new_pkg,
209 'unprotect_svcs' => 1 );
210 $error = '' if ref $error eq 'FS::cust_pkg';
212 } else { # just cancel it
213 $error = $cust_pkg->cancel($cpr ? ( 'reason' => $cpr->reasonnum,
214 'reason_otaker' => $cpr->otaker,
220 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
223 join(' / ', @errors);
227 sub suspend_adjourned_pkgs {
228 my ( $self, $time, %options ) = @_;
230 my @susp_pkgs = $self->ncancelled_pkgs( {
232 " AND ( susp IS NULL OR susp = 0 )
233 AND ( ( bill IS NOT NULL AND bill != 0 AND bill < $time )
234 OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
239 #only because there's no SQL test for is_prepaid :/
241 grep { ( $_->part_pkg->is_prepaid
246 && $_->adjourn <= $time
254 foreach my $cust_pkg ( @susp_pkgs ) {
255 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
256 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
257 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
258 'reason_otaker' => $cpr->otaker
262 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
265 join(' / ', @errors);
269 sub unsuspend_resumed_pkgs {
270 my ( $self, $time, %options ) = @_;
272 my @unsusp_pkgs = $self->ncancelled_pkgs( {
273 'extra_sql' => " AND resume IS NOT NULL AND resume > 0 AND resume <= $time "
278 foreach my $cust_pkg ( @unsusp_pkgs ) {
279 my $error = $cust_pkg->unsuspend( 'time' => $time );
280 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
283 join(' / ', @errors);
289 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
290 conjunction with the collect method by calling B<bill_and_collect>.
292 If there is an error, returns the error, otherwise returns false.
294 Options are passed as name-value pairs. Currently available options are:
300 If set true, re-charges setup fees.
304 If set true then only bill recurring charges, not setup, usage, one time
309 If set, then override the normal frequency and look for a part_pkg_discount
310 to take at that frequency. This is appropriate only when the normal
311 frequency for all packages is monthly, and is an error otherwise. Use
312 C<pkg_list> to limit the set of packages included in billing.
316 Bills the customer as if it were that time. Specified as a UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion functions. For example:
320 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
324 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
326 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
330 A hashref of pkgparts to exclude from this billing run (can also be specified as a comma-separated scalar).
334 Do not bill prepaid packages. Used by freeside-daily.
338 Used in conjunction with the I<time> option, this option specifies the date of for the generated invoices. Other calculations, such as whether or not to generate the invoice in the first place, are not affected.
342 This boolean value informs the us that the package is being cancelled. This
343 typically might mean not charging the normal recurring fee but only usage
344 fees since the last billing. Setup charges may be charged. Not all package
345 plans support this feature (they tend to charge 0).
349 Prevent the resetting of usage limits during this call.
353 Do not save the generated bill in the database. Useful with return_bill
357 A list reference on which the generated bill(s) will be returned.
361 Optional terms to be printed on this invoice. Otherwise, customer-specific
362 terms or the default terms are used.
369 my( $self, %options ) = @_;
371 return '' if $self->payby eq 'COMP';
373 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
375 warn "$me bill customer ". $self->custnum. "\n"
378 my $time = $options{'time'} || time;
379 my $invoice_time = $options{'invoice_time'} || $time;
381 my $cmp_time = ( $conf->exists('next-bill-ignore-time')
386 $options{'not_pkgpart'} ||= {};
387 $options{'not_pkgpart'} = { map { $_ => 1 }
388 split(/\s*,\s*/, $options{'not_pkgpart'})
390 unless ref($options{'not_pkgpart'});
392 local $SIG{HUP} = 'IGNORE';
393 local $SIG{INT} = 'IGNORE';
394 local $SIG{QUIT} = 'IGNORE';
395 local $SIG{TERM} = 'IGNORE';
396 local $SIG{TSTP} = 'IGNORE';
397 local $SIG{PIPE} = 'IGNORE';
399 my $oldAutoCommit = $FS::UID::AutoCommit;
400 local $FS::UID::AutoCommit = 0;
403 warn "$me acquiring lock on customer ". $self->custnum. "\n"
406 $self->select_for_update; #mutex
408 warn "$me running pre-bill events for customer ". $self->custnum. "\n"
411 my $error = $self->do_cust_event(
412 'debug' => ( $options{'debug'} || 0 ),
413 'time' => $invoice_time,
414 'check_freq' => $options{'check_freq'},
415 'stage' => 'pre-bill',
417 unless $options{no_commit};
419 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
423 warn "$me done running pre-bill events for customer ". $self->custnum. "\n"
426 #keep auto-charge and non-auto-charge line items separate
427 my @passes = ( '', 'no_auto' );
429 my %cust_bill_pkg = map { $_ => [] } @passes;
432 # find the packages which are due for billing, find out how much they are
433 # & generate invoice database.
436 my %total_setup = map { my $z = 0; $_ => \$z; } @passes;
437 my %total_recur = map { my $z = 0; $_ => \$z; } @passes;
439 my %taxlisthash = map { $_ => {} } @passes;
441 my @precommit_hooks = ();
443 $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ]; #param checks?
445 foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
447 next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
449 my $part_pkg = $cust_pkg->part_pkg;
451 next if $options{'no_prepaid'} && $part_pkg->is_prepaid;
453 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG;
455 #? to avoid use of uninitialized value errors... ?
456 $cust_pkg->setfield('bill', '')
457 unless defined($cust_pkg->bill);
459 my $real_pkgpart = $cust_pkg->pkgpart;
460 my %hash = $cust_pkg->hash;
462 # we could implement this bit as FS::part_pkg::has_hidden, but we already
463 # suffer from performance issues
464 $options{has_hidden} = 0;
465 my @part_pkg = $part_pkg->self_and_bill_linked;
466 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
468 # if this package was changed from another package,
469 # and it hasn't been billed since then,
470 # and package balances are enabled,
471 if ( $cust_pkg->change_pkgnum
472 and $cust_pkg->change_date >= ($cust_pkg->last_bill || 0)
473 and $cust_pkg->change_date < $invoice_time
474 and $conf->exists('pkg-balances') )
476 # _transfer_balance will also create the appropriate credit
477 my @transfer_items = $self->_transfer_balance($cust_pkg);
478 # $part_pkg[0] is the "real" part_pkg
479 my $pass = ($cust_pkg->no_auto || $part_pkg[0]->no_auto) ?
481 push @{ $cust_bill_pkg{$pass} }, @transfer_items;
482 # treating this as recur, just because most charges are recur...
483 ${$total_recur{$pass}} += $_->recur foreach @transfer_items;
486 foreach my $part_pkg ( @part_pkg ) {
488 $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
490 my $pass = ($cust_pkg->no_auto || $part_pkg->no_auto) ? 'no_auto' : '';
492 my $next_bill = $cust_pkg->getfield('bill') || 0;
494 # let this run once if this is the last bill upon cancellation
495 while ( $next_bill <= $cmp_time or $options{cancel} ) {
497 $self->_make_lines( 'part_pkg' => $part_pkg,
498 'cust_pkg' => $cust_pkg,
499 'precommit_hooks' => \@precommit_hooks,
500 'line_items' => $cust_bill_pkg{$pass},
501 'setup' => $total_setup{$pass},
502 'recur' => $total_recur{$pass},
503 'tax_matrix' => $taxlisthash{$pass},
505 'real_pkgpart' => $real_pkgpart,
506 'options' => \%options,
509 # Stop if anything goes wrong
512 # or if we're not incrementing the bill date.
513 last if ($cust_pkg->getfield('bill') || 0) == $next_bill;
515 # or if we're letting it run only once
516 last if $options{cancel};
518 $next_bill = $cust_pkg->getfield('bill') || 0;
520 #stop if -o was passed to freeside-daily
521 last if $options{'one_recur'};
524 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
528 } #foreach my $part_pkg
530 } #foreach my $cust_pkg
532 #if the customer isn't on an automatic payby, everything can go on a single
534 #if ( $cust_main->payby !~ /^(CARD|CHEK)$/ ) {
535 #merge everything into one list
538 foreach my $pass (@passes) { # keys %cust_bill_pkg ) {
540 my @cust_bill_pkg = _omit_zero_value_bundles(@{ $cust_bill_pkg{$pass} });
542 warn "$me billing pass $pass\n"
543 #.Dumper(\@cust_bill_pkg)."\n"
550 my @pending_event_fees = FS::cust_event_fee->by_cust($self->custnum,
551 hashref => { 'billpkgnum' => '' }
553 warn "$me found pending fee events:\n".Dumper(\@pending_event_fees)."\n"
554 if @pending_event_fees and $DEBUG > 1;
556 # determine whether to generate an invoice
557 my $generate_bill = scalar(@cust_bill_pkg) > 0;
559 foreach my $event_fee (@pending_event_fees) {
560 $generate_bill = 1 unless $event_fee->nextbill;
563 # don't create an invoice with no line items, or where the only line
564 # items are fees that are supposed to be held until the next invoice
565 next if !$generate_bill;
569 foreach my $event_fee (@pending_event_fees) {
570 my $object = $event_fee->cust_event->cust_X;
571 my $part_fee = $event_fee->part_fee;
573 if ( $object->isa('FS::cust_main')
574 or $object->isa('FS::cust_pkg')
575 or $object->isa('FS::cust_pay_batch') )
577 # Not the real cust_bill object that will be inserted--in particular
578 # there are no taxes yet. If you want to charge a fee on the total
579 # invoice amount including taxes, you have to put the fee on the next
581 $cust_bill = FS::cust_bill->new({
582 'custnum' => $self->custnum,
583 'cust_bill_pkg' => \@cust_bill_pkg,
584 'charged' => ${ $total_setup{$pass} } +
585 ${ $total_recur{$pass} },
588 # If this is a package event, only apply the fee to line items
590 if ($object->isa('FS::cust_pkg')) {
591 $cust_bill->set('cust_bill_pkg',
592 [ grep { $_->pkgnum == $object->pkgnum } @cust_bill_pkg ]
596 } elsif ( $object->isa('FS::cust_bill') ) {
597 # simple case: applying the fee to a previous invoice (late fee,
599 $cust_bill = $object;
601 # if the fee def belongs to a different agent, don't charge the fee.
602 # event conditions should prevent this, but just in case they don't,
604 if ( $part_fee->agentnum and $part_fee->agentnum != $self->agentnum ) {
605 warn "tried to charge fee#".$part_fee->feepart .
606 " on customer#".$self->custnum." from a different agent.\n";
609 # also skip if it's disabled
610 next if $part_fee->disabled eq 'Y';
612 my $fee_item = $part_fee->lineitem($cust_bill) or next;
613 # link this so that we can clear the marker on inserting the line item
614 $fee_item->set('cust_event_fee', $event_fee);
615 push @fee_items, $fee_item;
619 # add fees to the invoice
620 foreach my $fee_item (@fee_items) {
622 push @cust_bill_pkg, $fee_item;
623 ${ $total_setup{$pass} } += $fee_item->setup;
624 ${ $total_recur{$pass} } += $fee_item->recur;
626 my $part_fee = $fee_item->part_fee;
627 my $fee_location = $self->ship_location; # I think?
629 my $error = $self->_handle_taxes(
632 location => $fee_location
633 # probably not right to pass cancel => 1 for fees
635 return $error if $error;
639 # XXX implementation of fees is supposed to make this go away...
640 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
641 !$conf->exists('postal_invoice-recurring_only')
645 my $postal_pkg = $self->charge_postal_fee();
646 if ( $postal_pkg && !ref( $postal_pkg ) ) {
648 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
649 return "can't charge postal invoice fee for customer ".
650 $self->custnum. ": $postal_pkg";
652 } elsif ( $postal_pkg ) {
654 my $real_pkgpart = $postal_pkg->pkgpart;
655 # we could implement this bit as FS::part_pkg::has_hidden, but we already
656 # suffer from performance issues
657 $options{has_hidden} = 0;
658 my @part_pkg = $postal_pkg->part_pkg->self_and_bill_linked;
659 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
661 foreach my $part_pkg ( @part_pkg ) {
662 my %postal_options = %options;
663 delete $postal_options{cancel};
665 $self->_make_lines( 'part_pkg' => $part_pkg,
666 'cust_pkg' => $postal_pkg,
667 'precommit_hooks' => \@precommit_hooks,
668 'line_items' => \@cust_bill_pkg,
669 'setup' => $total_setup{$pass},
670 'recur' => $total_recur{$pass},
671 'tax_matrix' => $taxlisthash{$pass},
673 'real_pkgpart' => $real_pkgpart,
674 'options' => \%postal_options,
677 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
682 # it's silly to have a zero value postal_pkg, but....
683 @cust_bill_pkg = _omit_zero_value_bundles(@cust_bill_pkg);
689 my $listref_or_error =
690 $self->calculate_taxes( \@cust_bill_pkg, $taxlisthash{$pass}, $invoice_time);
692 unless ( ref( $listref_or_error ) ) {
693 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
694 return $listref_or_error;
697 foreach my $taxline ( @$listref_or_error ) {
698 ${ $total_setup{$pass} } =
699 sprintf('%.2f', ${ $total_setup{$pass} } + $taxline->setup );
700 push @cust_bill_pkg, $taxline;
704 warn "adding tax adjustments...\n" if $DEBUG > 2;
705 foreach my $cust_tax_adjustment (
706 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
712 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
714 my $itemdesc = $cust_tax_adjustment->taxname;
715 $itemdesc = '' if $itemdesc eq 'Tax';
717 push @cust_bill_pkg, new FS::cust_bill_pkg {
723 'itemdesc' => $itemdesc,
724 'itemcomment' => $cust_tax_adjustment->comment,
725 'cust_tax_adjustment' => $cust_tax_adjustment,
726 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
731 my $charged = sprintf('%.2f', ${ $total_setup{$pass} } + ${ $total_recur{$pass} } );
733 my $balance = $self->balance;
735 my $previous_bill = qsearchs({ 'table' => 'cust_bill',
736 'hashref' => { custnum=>$self->custnum },
737 'extra_sql' => 'ORDER BY _date DESC LIMIT 1',
739 my $previous_balance =
741 ? ( $previous_bill->billing_balance + $previous_bill->charged )
744 warn "creating the new invoice\n" if $DEBUG;
745 #create the new invoice
746 my $cust_bill = new FS::cust_bill ( {
747 'custnum' => $self->custnum,
748 '_date' => $invoice_time,
749 'charged' => $charged,
750 'billing_balance' => $balance,
751 'previous_balance' => $previous_balance,
752 'invoice_terms' => $options{'invoice_terms'},
753 'cust_bill_pkg' => \@cust_bill_pkg,
755 $error = $cust_bill->insert unless $options{no_commit};
757 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
758 return "can't create invoice for customer #". $self->custnum. ": $error";
760 push @{$options{return_bill}}, $cust_bill if $options{return_bill};
762 } #foreach my $pass ( keys %cust_bill_pkg )
764 foreach my $hook ( @precommit_hooks ) {
767 } unless $options{no_commit};
769 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
770 return "$@ running precommit hook $hook\n";
774 $dbh->commit or die $dbh->errstr if $oldAutoCommit && !$options{no_commit};
779 #discard bundled packages of 0 value
780 sub _omit_zero_value_bundles {
783 my @cust_bill_pkg = ();
784 my @cust_bill_pkg_bundle = ();
786 my $discount_show_always = 0;
788 foreach my $cust_bill_pkg ( @in ) {
790 $discount_show_always = ($cust_bill_pkg->get('discounts')
791 && scalar(@{$cust_bill_pkg->get('discounts')})
792 && $conf->exists('discount-show-always'));
794 warn " pkgnum ". $cust_bill_pkg->pkgnum. " sum $sum, ".
795 "setup_show_zero ". $cust_bill_pkg->setup_show_zero.
796 "recur_show_zero ". $cust_bill_pkg->recur_show_zero. "\n"
799 if (scalar(@cust_bill_pkg_bundle) && !$cust_bill_pkg->pkgpart_override) {
800 push @cust_bill_pkg, @cust_bill_pkg_bundle
802 || ($sum == 0 && ( $discount_show_always
803 || grep {$_->recur_show_zero || $_->setup_show_zero}
804 @cust_bill_pkg_bundle
807 @cust_bill_pkg_bundle = ();
811 $sum += $cust_bill_pkg->setup + $cust_bill_pkg->recur;
812 push @cust_bill_pkg_bundle, $cust_bill_pkg;
816 push @cust_bill_pkg, @cust_bill_pkg_bundle
818 || ($sum == 0 && ( $discount_show_always
819 || grep {$_->recur_show_zero || $_->setup_show_zero}
820 @cust_bill_pkg_bundle
824 warn " _omit_zero_value_bundles: ". scalar(@in).
825 '->'. scalar(@cust_bill_pkg). "\n" #. Dumper(@cust_bill_pkg). "\n"
832 =item calculate_taxes LINEITEMREF TAXHASHREF INVOICE_TIME
834 Generates tax line items (see L<FS::cust_bill_pkg>) for this customer.
835 Usually used internally by bill method B<bill>.
837 If there is an error, returns the error, otherwise returns reference to a
838 list of line items suitable for insertion.
844 An array ref of the line items being billed.
848 A strange beast. The keys to this hash are internal identifiers consisting
849 of the name of the tax object type, a space, and its unique identifier ( e.g.
850 'cust_main_county 23' ). The values of the hash are listrefs. The first
851 item in the list is the tax object. The remaining items are either line
852 items or floating point values (currency amounts).
854 The taxes are calculated on this entity. Calculated exemption records are
855 transferred to the LINEITEMREF items on the assumption that they are related.
861 This specifies the date appearing on the associated invoice. Some
862 jurisdictions (i.e. Texas) have tax exemptions which are date sensitive.
868 sub calculate_taxes {
869 my ($self, $cust_bill_pkg, $taxlisthash, $invoice_time) = @_;
871 # $taxlisthash is a hashref
872 # keys are identifiers, values are arrayrefs
873 # each arrayref starts with a tax object (cust_main_county or tax_rate)
874 # then any cust_bill_pkg objects the tax applies to
876 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
878 warn "$me calculate_taxes\n"
879 #.Dumper($self, $cust_bill_pkg, $taxlisthash, $invoice_time). "\n"
882 my @tax_line_items = ();
884 # keys are tax names (as printed on invoices / itemdesc )
885 # values are arrayrefs of taxlisthash keys (internal identifiers)
888 # keys are taxlisthash keys (internal identifiers)
889 # values are (cumulative) amounts
892 # keys are taxlisthash keys (internal identifiers)
893 # values are arrayrefs of cust_bill_pkg_tax_location hashrefs
894 my %tax_location = ();
896 # keys are taxlisthash keys (internal identifiers)
897 # values are arrayrefs of cust_bill_pkg_tax_rate_location hashrefs
898 my %tax_rate_location = ();
900 # keys are taxlisthash keys (internal identifiers!)
901 # values are arrayrefs of cust_tax_exempt_pkg objects
904 foreach my $tax ( keys %$taxlisthash ) {
905 # $tax is a tax identifier (intersection of a tax definition record
906 # and a cust_bill_pkg record)
907 my $tax_object = shift @{ $taxlisthash->{$tax} };
908 # $tax_object is a cust_main_county or tax_rate
909 # (with billpkgnum, pkgnum, locationnum set)
910 # the rest of @{ $taxlisthash->{$tax} } is cust_bill_pkg component objects
911 # (setup, recurring, usage classes)
912 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
913 warn " ". join('/', @{ $taxlisthash->{$tax} } ). "\n" if $DEBUG > 2;
914 # taxline calculates the tax on all cust_bill_pkgs in the
915 # first (arrayref) argument, and returns a hashref of 'name'
916 # (the line item description) and 'amount'.
917 # It also calculates exemptions and attaches them to the cust_bill_pkgs
919 my $taxables = $taxlisthash->{$tax};
920 my $exemptions = $tax_exemption{$tax} ||= [];
921 my $taxline = $tax_object->taxline(
923 'custnum' => $self->custnum,
924 'invoice_time' => $invoice_time,
925 'exemptions' => $exemptions,
927 return $taxline unless ref($taxline);
929 unshift @{ $taxlisthash->{$tax} }, $tax_object;
931 if ( $tax_object->isa('FS::cust_main_county') ) {
932 # then $taxline is a real line item
933 push @{ $taxname{ $taxline->itemdesc } }, $taxline;
936 # leave this as is for now
938 my $name = $taxline->{'name'};
939 my $amount = $taxline->{'amount'};
941 #warn "adding $amount as $name\n";
942 $taxname{ $name } ||= [];
943 push @{ $taxname{ $name } }, $tax;
945 $tax_amount{ $tax } += $amount;
947 # link records between cust_main_county/tax_rate and cust_location
948 $tax_rate_location{ $tax } ||= [];
949 my $taxratelocationnum =
950 $tax_object->tax_rate_location->taxratelocationnum;
951 push @{ $tax_rate_location{ $tax } },
953 'taxnum' => $tax_object->taxnum,
954 'taxtype' => ref($tax_object),
955 'amount' => sprintf('%.2f', $amount ),
956 'locationtaxid' => $tax_object->location,
957 'taxratelocationnum' => $taxratelocationnum,
959 } #if ref($tax_object)...
960 } #foreach keys %$taxlisthash
962 #consolidate and create tax line items
963 warn "consolidating and generating...\n" if $DEBUG > 2;
964 foreach my $taxname ( keys %taxname ) {
965 my @cust_bill_pkg_tax_location;
966 my @cust_bill_pkg_tax_rate_location;
967 my $tax_cust_bill_pkg = FS::cust_bill_pkg->new({
972 'itemdesc' => $taxname,
973 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
974 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
979 warn "adding $taxname\n" if $DEBUG > 1;
980 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
981 if ( ref($taxitem) eq 'FS::cust_bill_pkg' ) {
982 # then we need to transfer the amount and the links from the
983 # line item to the new one we're creating.
984 $tax_total += $taxitem->setup;
985 foreach my $link ( @{ $taxitem->get('cust_bill_pkg_tax_location') } ) {
986 $link->set('tax_cust_bill_pkg', $tax_cust_bill_pkg);
987 push @cust_bill_pkg_tax_location, $link;
991 next if $seen{$taxitem}++;
992 warn "adding $tax_amount{$taxitem}\n" if $DEBUG > 1;
993 $tax_total += $tax_amount{$taxitem};
994 push @cust_bill_pkg_tax_rate_location,
995 map { new FS::cust_bill_pkg_tax_rate_location $_ }
996 @{ $tax_rate_location{ $taxitem } };
999 next unless $tax_total;
1001 # we should really neverround this up...I guess it's okay if taxline
1002 # already returns amounts with 2 decimal places
1003 $tax_total = sprintf('%.2f', $tax_total );
1004 $tax_cust_bill_pkg->set('setup', $tax_total);
1006 my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
1012 if ( $pkg_category and
1013 $conf->config('invoice_latexsummary') ||
1014 $conf->config('invoice_htmlsummary')
1018 my %hash = ( 'section' => $pkg_category->categoryname );
1019 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
1022 $tax_cust_bill_pkg->set('display', \@display);
1024 push @tax_line_items, $tax_cust_bill_pkg;
1031 my ($self, %params) = @_;
1033 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1035 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
1036 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
1037 my $cust_location = $cust_pkg->tax_location;
1038 my $precommit_hooks = $params{precommit_hooks} or die "no precommit_hooks specified";
1039 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
1040 my $total_setup = $params{setup} or die "no setup accumulator specified";
1041 my $total_recur = $params{recur} or die "no recur accumulator specified";
1042 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
1043 my $time = $params{'time'} or die "no time specified";
1044 my (%options) = %{$params{options}};
1046 if ( $part_pkg->freq ne '1' and ($options{'freq_override'} || 0) > 0 ) {
1047 # this should never happen
1048 die 'freq_override billing attempted on non-monthly package '.
1053 my $real_pkgpart = $params{real_pkgpart};
1054 my %hash = $cust_pkg->hash;
1055 my $old_cust_pkg = new FS::cust_pkg \%hash;
1060 $cust_pkg->pkgpart($part_pkg->pkgpart);
1062 my $cmp_time = ( $conf->exists('next-bill-ignore-time')
1073 my @setup_discounts = ();
1074 my %setup_param = ( 'discounts' => \@setup_discounts );
1075 if ( ! $options{recurring_only}
1076 and ! $options{cancel}
1077 and ( $options{'resetup'}
1078 || ( ! $cust_pkg->setup
1079 && ( ! $cust_pkg->start_date
1080 || $cust_pkg->start_date <= $cmp_time
1082 && ( ! $conf->exists('disable_setup_suspended_pkgs')
1083 || ( $conf->exists('disable_setup_suspended_pkgs') &&
1084 ! $cust_pkg->getfield('susp')
1092 warn " bill setup\n" if $DEBUG > 1;
1094 unless ( $cust_pkg->waive_setup ) {
1097 $setup = eval { $cust_pkg->calc_setup( $time, \@details, \%setup_param ) };
1098 return "$@ running calc_setup for $cust_pkg\n"
1101 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
1104 $cust_pkg->setfield('setup', $time)
1105 unless $cust_pkg->setup;
1106 #do need it, but it won't get written to the db
1107 #|| $cust_pkg->pkgpart != $real_pkgpart;
1109 $cust_pkg->setfield('start_date', '')
1110 if $cust_pkg->start_date;
1115 # bill recurring fee
1120 my @recur_discounts = ();
1122 if ( ! $cust_pkg->start_date
1125 || ( $cust_pkg->susp != $cust_pkg->order_date
1126 && ( $cust_pkg->option('suspend_bill',1)
1127 || ( $part_pkg->option('suspend_bill', 1)
1128 && ! $cust_pkg->option('no_suspend_bill',1)
1134 ( $part_pkg->freq ne '0' && ( $cust_pkg->bill || 0 ) <= $cmp_time )
1135 || ( $part_pkg->plan eq 'voip_cdr'
1136 && $part_pkg->option('bill_every_call')
1141 # XXX should this be a package event? probably. events are called
1142 # at collection time at the moment, though...
1143 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
1144 if $part_pkg->can('reset_usage') && !$options{'no_usage_reset'};
1145 #don't want to reset usage just cause we want a line item??
1146 #&& $part_pkg->pkgpart == $real_pkgpart;
1148 warn " bill recur\n" if $DEBUG > 1;
1151 # XXX shared with $recur_prog
1152 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
1156 #over two params! lets at least switch to a hashref for the rest...
1157 my $increment_next_bill = ( $part_pkg->freq ne '0'
1158 && ( $cust_pkg->getfield('bill') || 0 ) <= $cmp_time
1159 && !$options{cancel}
1161 my %param = ( %setup_param,
1162 'precommit_hooks' => $precommit_hooks,
1163 'increment_next_bill' => $increment_next_bill,
1164 'discounts' => \@recur_discounts,
1165 'real_pkgpart' => $real_pkgpart,
1166 'freq_override' => $options{freq_override} || '',
1170 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
1172 # There may be some part_pkg for which this is wrong. Only those
1173 # which can_discount are supported.
1174 # (the UI should prevent adding discounts to these at the moment)
1176 warn "calling $method on cust_pkg ". $cust_pkg->pkgnum.
1177 " for pkgpart ". $cust_pkg->pkgpart.
1178 " with params ". join(' / ', map "$_=>$param{$_}", keys %param). "\n"
1181 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
1182 return "$@ running $method for $cust_pkg\n"
1186 $unitrecur = $cust_pkg->base_recur( \$sdate ) || $recur; #XXX uuh, better
1188 if ( $increment_next_bill ) {
1192 if ( my $main_pkg = $cust_pkg->main_pkg ) {
1193 # supplemental package
1194 # to keep in sync with the main package, simulate billing at
1196 my $main_pkg_freq = $main_pkg->part_pkg->freq;
1197 my $supp_pkg_freq = $part_pkg->freq;
1198 my $ratio = $supp_pkg_freq / $main_pkg_freq;
1199 if ( $ratio != int($ratio) ) {
1200 # the UI should prevent setting up packages like this, but just
1202 return "supplemental package period is not an integer multiple of main package period";
1204 $next_bill = $sdate;
1206 $next_bill = $part_pkg->add_freq( $next_bill, $main_pkg_freq );
1211 $next_bill = $part_pkg->add_freq($sdate, $options{freq_override} || 0);
1212 return "unparsable frequency: ". $part_pkg->freq
1213 if $next_bill == -1;
1216 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
1217 # only for figuring next bill date, nothing else, so, reset $sdate again
1219 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1220 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
1221 $cust_pkg->last_bill($sdate);
1223 $cust_pkg->setfield('bill', $next_bill );
1227 if ( $param{'setup_fee'} ) {
1228 # Add an additional setup fee at the billing stage.
1229 # Used for prorate_defer_bill.
1230 $setup += $param{'setup_fee'};
1231 $unitsetup += $param{'setup_fee'};
1235 if ( defined $param{'discount_left_setup'} ) {
1236 foreach my $discount_setup ( values %{$param{'discount_left_setup'}} ) {
1237 $setup -= $discount_setup;
1243 warn "\$setup is undefined" unless defined($setup);
1244 warn "\$recur is undefined" unless defined($recur);
1245 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1248 # If there's line items, create em cust_bill_pkg records
1249 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
1254 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
1255 # hmm.. and if just the options are modified in some weird price plan?
1257 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
1260 my $error = $cust_pkg->replace( $old_cust_pkg,
1261 'depend_jobnum'=>$options{depend_jobnum},
1262 'options' => { $cust_pkg->options },
1264 unless $options{no_commit};
1265 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
1266 if $error; #just in case
1269 $setup = sprintf( "%.2f", $setup );
1270 $recur = sprintf( "%.2f", $recur );
1271 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
1272 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1274 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
1275 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
1278 my $discount_show_always = $conf->exists('discount-show-always')
1279 && ( ($setup == 0 && scalar(@setup_discounts))
1280 || ($recur == 0 && scalar(@recur_discounts))
1285 || (!$part_pkg->hidden && $options{has_hidden}) #include some $0 lines
1286 || $discount_show_always
1287 || ($setup == 0 && $cust_pkg->_X_show_zero('setup'))
1288 || ($recur == 0 && $cust_pkg->_X_show_zero('recur'))
1292 warn " charges (setup=$setup, recur=$recur); adding line items\n"
1295 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
1297 warn " adding customer package invoice detail: $_\n"
1298 foreach @cust_pkg_detail;
1300 push @details, @cust_pkg_detail;
1302 my $cust_bill_pkg = new FS::cust_bill_pkg {
1303 'pkgnum' => $cust_pkg->pkgnum,
1305 'unitsetup' => $unitsetup,
1307 'unitrecur' => $unitrecur,
1308 'quantity' => $cust_pkg->quantity,
1309 'details' => \@details,
1310 'discounts' => [ @setup_discounts, @recur_discounts ],
1311 'hidden' => $part_pkg->hidden,
1312 'freq' => $part_pkg->freq,
1315 if ( $part_pkg->option('prorate_defer_bill',1)
1316 and !$hash{last_bill} ) {
1317 # both preceding and upcoming, technically
1318 $cust_bill_pkg->sdate( $cust_pkg->setup );
1319 $cust_bill_pkg->edate( $cust_pkg->bill );
1320 } elsif ( $part_pkg->recur_temporality eq 'preceding' ) {
1321 $cust_bill_pkg->sdate( $hash{last_bill} );
1322 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
1323 $cust_bill_pkg->edate( $time ) if $options{cancel};
1324 } else { #if ( $part_pkg->recur_temporality eq 'upcoming' ) {
1325 $cust_bill_pkg->sdate( $sdate );
1326 $cust_bill_pkg->edate( $cust_pkg->bill );
1327 #$cust_bill_pkg->edate( $time ) if $options{cancel};
1330 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
1331 unless $part_pkg->pkgpart == $real_pkgpart;
1333 $$total_setup += $setup;
1334 $$total_recur += $recur;
1340 my $error = $self->_handle_taxes( $taxlisthash, $cust_bill_pkg,
1341 cancel => $options{cancel} );
1342 return $error if $error;
1344 $cust_bill_pkg->set_display(
1345 part_pkg => $part_pkg,
1346 real_pkgpart => $real_pkgpart,
1349 push @$cust_bill_pkgs, $cust_bill_pkg;
1351 } #if $setup != 0 || $recur != 0
1359 =item _transfer_balance TO_PKG [ FROM_PKGNUM ]
1361 Takes one argument, a cust_pkg object that is being billed. This will
1362 be called only if the package was created by a package change, and has
1363 not been billed since the package change, and package balance tracking
1364 is enabled. The second argument can be an alternate package number to
1365 transfer the balance from; this should not be used externally.
1367 Transfers the balance from the previous package (now canceled) to
1368 this package, by crediting one package and creating an invoice item for
1369 the other. Inserts the credit and returns the invoice item (so that it
1370 can be added to an invoice that's being built).
1372 If the previous package was never billed, and was also created by a package
1373 change, then this will also transfer the balance from I<its> previous
1374 package, and so on, until reaching a package that either has been billed
1375 or was not created by a package change.
1379 my $balance_transfer_reason;
1381 sub _transfer_balance {
1383 my $cust_pkg = shift;
1384 my $from_pkgnum = shift || $cust_pkg->change_pkgnum;
1385 my $from_pkg = FS::cust_pkg->by_key($from_pkgnum);
1389 # if $from_pkg is not the first package in the chain, and it was never
1391 if ( $from_pkg->change_pkgnum and scalar($from_pkg->cust_bill_pkg) == 0 ) {
1392 @transfers = $self->_transfer_balance($cust_pkg, $from_pkg->change_pkgnum);
1395 my $prev_balance = $self->balance_pkgnum($from_pkgnum);
1396 if ( $prev_balance != 0 ) {
1397 $balance_transfer_reason ||= FS::reason->new_or_existing(
1398 'reason' => 'Package balance transfer',
1399 'type' => 'Internal adjustment',
1403 my $credit = FS::cust_credit->new({
1404 'custnum' => $self->custnum,
1405 'amount' => abs($prev_balance),
1406 'reasonnum' => $balance_transfer_reason->reasonnum,
1407 '_date' => $cust_pkg->change_date,
1410 my $cust_bill_pkg = FS::cust_bill_pkg->new({
1412 'recur' => abs($prev_balance),
1413 #'sdate' => $from_pkg->last_bill, # not sure about this
1414 #'edate' => $cust_pkg->change_date,
1415 'itemdesc' => $self->mt('Previous Balance, [_1]',
1416 $from_pkg->part_pkg->pkg),
1419 if ( $prev_balance > 0 ) {
1420 # credit the old package, charge the new one
1421 $credit->set('pkgnum', $from_pkgnum);
1422 $cust_bill_pkg->set('pkgnum', $cust_pkg->pkgnum);
1425 $credit->set('pkgnum', $cust_pkg->pkgnum);
1426 $cust_bill_pkg->set('pkgnum', $from_pkgnum);
1428 my $error = $credit->insert;
1429 die "error transferring package balance from #".$from_pkgnum.
1430 " to #".$cust_pkg->pkgnum.": $error\n" if $error;
1432 push @transfers, $cust_bill_pkg;
1433 } # $prev_balance != 0
1438 =item handle_taxes TAXLISTHASH CUST_BILL_PKG [ OPTIONS ]
1440 This is _handle_taxes. It's called once for each cust_bill_pkg generated
1443 TAXLISTHASH is a hashref shared across the entire invoice. It looks like
1446 'cust_main_county 1001' => [ [FS::cust_main_county], ... ],
1447 'cust_main_county 1002' => [ [FS::cust_main_county], ... ],
1450 'cust_main_county' can also be 'tax_rate'. The first object in the array
1451 is always the cust_main_county or tax_rate identified by the key.
1453 That "..." is a list of FS::cust_bill_pkg objects that will be fed to
1454 the 'taxline' method to calculate the amount of the tax. This doesn't
1455 happen until calculate_taxes, though.
1457 OPTIONS may include:
1458 - part_item: a part_pkg or part_fee object to be used as the package/fee
1460 - location: a cust_location to be used as the billing location.
1461 - cancel: true if this package is being billed on cancellation. This
1462 allows tax to be calculated on usage charges only.
1464 If not supplied, part_item will be inferred from the pkgnum or feepart of the
1465 cust_bill_pkg, and location from the pkgnum (or, for fees, the invnum and
1466 the customer's default service location).
1472 my $taxlisthash = shift;
1473 my $cust_bill_pkg = shift;
1476 # at this point I realize that we have enough information to infer all this
1477 # stuff, instead of passing around giant honking argument lists
1478 my $location = $options{location} || $cust_bill_pkg->tax_location;
1479 my $part_item = $options{part_item} || $cust_bill_pkg->part_X;
1481 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1483 return if ( $self->payby eq 'COMP' ); #dubious
1485 if ( $conf->exists('enable_taxproducts')
1486 && ( scalar($part_item->part_pkg_taxoverride)
1487 || $part_item->has_taxproduct
1492 # EXTERNAL TAX RATES (via tax_rate)
1493 my %cust_bill_pkg = ();
1497 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
1498 push @classes, 'setup' if $cust_bill_pkg->setup and !$options{cancel};
1499 push @classes, 'recur' if $cust_bill_pkg->recur and !$options{cancel};
1501 my $exempt = $conf->exists('cust_class-tax_exempt')
1502 ? ( $self->cust_class ? $self->cust_class->tax : '' )
1504 # standardize this just to be sure
1505 $exempt = ($exempt eq 'Y') ? 'Y' : '';
1509 foreach my $class (@classes) {
1510 my $err_or_ref = $self->_gather_taxes($part_item, $class, $location);
1511 return $err_or_ref unless ref($err_or_ref);
1512 $taxes{$class} = $err_or_ref;
1515 unless (exists $taxes{''}) {
1516 my $err_or_ref = $self->_gather_taxes($part_item, '', $location);
1517 return $err_or_ref unless ref($err_or_ref);
1518 $taxes{''} = $err_or_ref;
1523 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate; # grrr
1524 foreach my $key (keys %tax_cust_bill_pkg) {
1525 # $key is "setup", "recur", or a usage class name. ('' is a usage class.)
1526 # $tax_cust_bill_pkg{$key} is a cust_bill_pkg for that component of
1528 # $taxes{$key} is an arrayref of cust_main_county or tax_rate objects that
1529 # apply to $key-class charges.
1530 my @taxes = @{ $taxes{$key} || [] };
1531 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
1533 my %localtaxlisthash = ();
1534 foreach my $tax ( @taxes ) {
1536 # this is the tax identifier, not the taxname
1537 my $taxname = ref( $tax ). ' '. $tax->taxnum;
1538 # $taxlisthash: keys are "setup", "recur", and usage classes.
1539 # Values are arrayrefs, first the tax object (cust_main_county
1540 # or tax_rate) and then any cust_bill_pkg objects that the
1542 $taxlisthash->{ $taxname } ||= [ $tax ];
1543 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
1545 $localtaxlisthash{ $taxname } ||= [ $tax ];
1546 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
1550 warn "finding taxed taxes...\n" if $DEBUG > 2;
1551 foreach my $tax ( keys %localtaxlisthash ) {
1552 my $tax_object = shift @{ $localtaxlisthash{$tax} };
1553 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
1555 next unless $tax_object->can('tax_on_tax');
1557 foreach my $tot ( $tax_object->tax_on_tax( $location ) ) {
1558 my $totname = ref( $tot ). ' '. $tot->taxnum;
1560 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
1562 next unless exists( $localtaxlisthash{ $totname } ); # only increase
1564 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
1565 # calculate the tax amount that the tax_on_tax will apply to
1566 my $hashref_or_error =
1567 $tax_object->taxline( $localtaxlisthash{$tax} );
1568 return $hashref_or_error
1569 unless ref($hashref_or_error);
1571 # and append it to the list of taxable items
1572 $taxlisthash->{ $totname } ||= [ $tot ];
1573 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
1581 # INTERNAL TAX RATES (cust_main_county)
1583 # We fetch taxes even if the customer is completely exempt,
1584 # because we need to record that fact.
1586 my @loc_keys = qw( district city county state country );
1587 my %taxhash = map { $_ => $location->$_ } @loc_keys;
1589 $taxhash{'taxclass'} = $part_item->taxclass;
1591 warn "taxhash:\n". Dumper(\%taxhash) if $DEBUG > 2;
1593 my @taxes = (); # entries are cust_main_county objects
1594 my %taxhash_elim = %taxhash;
1595 my @elim = qw( district city county state );
1598 #first try a match with taxclass
1599 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1601 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1602 #then try a match without taxclass
1603 my %no_taxclass = %taxhash_elim;
1604 $no_taxclass{ 'taxclass' } = '';
1605 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1608 $taxhash_elim{ shift(@elim) } = '';
1610 } while ( !scalar(@taxes) && scalar(@elim) );
1613 my $tax_id = 'cust_main_county '.$_->taxnum;
1614 $taxlisthash->{$tax_id} ||= [ $_ ];
1615 push @{ $taxlisthash->{$tax_id} }, $cust_bill_pkg;
1622 =item _gather_taxes PART_ITEM CLASS CUST_LOCATION
1624 Internal method used with vendor-provided tax tables. PART_ITEM is a part_pkg
1625 or part_fee (which will define the tax eligibility of the product), CLASS is
1626 'setup', 'recur', null, or a C<usage_class> number, and CUST_LOCATION is the
1627 location where the service was provided (or billed, depending on
1628 configuration). Returns an arrayref of L<FS::tax_rate> objects that
1629 can apply to this line item.
1635 my $part_item = shift;
1637 my $location = shift;
1639 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1641 my $geocode = $location->geocode('cch');
1643 [ $part_item->tax_rates('cch', $geocode, $class) ]
1647 =item collect [ HASHREF | OPTION => VALUE ... ]
1649 (Attempt to) collect money for this customer's outstanding invoices (see
1650 L<FS::cust_bill>). Usually used after the bill method.
1652 Actions are now triggered by billing events; see L<FS::part_event> and the
1653 billing events web interface. Old-style invoice events (see
1654 L<FS::part_bill_event>) have been deprecated.
1656 If there is an error, returns the error, otherwise returns false.
1658 Options are passed as name-value pairs.
1660 Currently available options are:
1666 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.
1670 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1674 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1678 set true to surpress email card/ACH decline notices.
1682 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)
1688 # allows for one time override of normal customer billing method
1693 my( $self, %options ) = @_;
1695 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1697 my $invoice_time = $options{'invoice_time'} || time;
1700 local $SIG{HUP} = 'IGNORE';
1701 local $SIG{INT} = 'IGNORE';
1702 local $SIG{QUIT} = 'IGNORE';
1703 local $SIG{TERM} = 'IGNORE';
1704 local $SIG{TSTP} = 'IGNORE';
1705 local $SIG{PIPE} = 'IGNORE';
1707 my $oldAutoCommit = $FS::UID::AutoCommit;
1708 local $FS::UID::AutoCommit = 0;
1711 $self->select_for_update; #mutex
1714 my $balance = $self->balance;
1715 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
1718 if ( exists($options{'retry_card'}) ) {
1719 carp 'retry_card option passed to collect is deprecated; use retry';
1720 $options{'retry'} ||= $options{'retry_card'};
1722 if ( exists($options{'retry'}) && $options{'retry'} ) {
1723 my $error = $self->retry_realtime;
1725 $dbh->rollback if $oldAutoCommit;
1730 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1732 #never want to roll back an event just because it returned an error
1733 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1735 $self->do_cust_event(
1736 'debug' => ( $options{'debug'} || 0 ),
1737 'time' => $invoice_time,
1738 'check_freq' => $options{'check_freq'},
1739 'stage' => 'collect',
1744 =item retry_realtime
1746 Schedules realtime / batch credit card / electronic check / LEC billing
1747 events for for retry. Useful if card information has changed or manual
1748 retry is desired. The 'collect' method must be called to actually retry
1751 Implementation details: For either this customer, or for each of this
1752 customer's open invoices, changes the status of the first "done" (with
1753 statustext error) realtime processing event to "failed".
1757 sub retry_realtime {
1760 local $SIG{HUP} = 'IGNORE';
1761 local $SIG{INT} = 'IGNORE';
1762 local $SIG{QUIT} = 'IGNORE';
1763 local $SIG{TERM} = 'IGNORE';
1764 local $SIG{TSTP} = 'IGNORE';
1765 local $SIG{PIPE} = 'IGNORE';
1767 my $oldAutoCommit = $FS::UID::AutoCommit;
1768 local $FS::UID::AutoCommit = 0;
1771 #a little false laziness w/due_cust_event (not too bad, really)
1773 # I guess this is always as of now?
1774 my $join = FS::part_event_condition->join_conditions_sql('', 'time' => time);
1775 my $order = FS::part_event_condition->order_conditions_sql;
1778 . join ( ' OR ' , map {
1779 my $cust_join = FS::part_event->eventtables_cust_join->{$_} || '';
1780 my $custnum = FS::part_event->eventtables_custnum->{$_};
1781 "( part_event.eventtable = " . dbh->quote($_)
1782 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key
1783 . " from $_ $cust_join"
1784 . " where $custnum = " . dbh->quote( $self->custnum ) . "))" ;
1785 } FS::part_event->eventtables)
1788 #here is the agent virtualization
1789 my $agent_virt = " ( part_event.agentnum IS NULL
1790 OR part_event.agentnum = ". $self->agentnum. ' )';
1792 #XXX this shouldn't be hardcoded, actions should declare it...
1793 my @realtime_events = qw(
1794 cust_bill_realtime_card
1795 cust_bill_realtime_check
1796 cust_bill_realtime_lec
1800 my $is_realtime_event =
1801 ' part_event.action IN ( '.
1802 join(',', map "'$_'", @realtime_events ).
1805 my $batch_or_statustext =
1806 "( part_event.action = 'cust_bill_batch'
1807 OR ( statustext IS NOT NULL AND statustext != '' )
1811 my @cust_event = qsearch({
1812 'table' => 'cust_event',
1813 'select' => 'cust_event.*',
1814 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
1815 'hashref' => { 'status' => 'done' },
1816 'extra_sql' => " AND $batch_or_statustext ".
1817 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
1820 my %seen_invnum = ();
1821 foreach my $cust_event (@cust_event) {
1823 #max one for the customer, one for each open invoice
1824 my $cust_X = $cust_event->cust_X;
1825 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
1829 or $cust_event->part_event->eventtable eq 'cust_bill'
1832 my $error = $cust_event->retry;
1834 $dbh->rollback if $oldAutoCommit;
1835 return "error scheduling event for retry: $error";
1840 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1845 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
1847 Runs billing events; see L<FS::part_event> and the billing events web
1850 If there is an error, returns the error, otherwise returns false.
1852 Options are passed as name-value pairs.
1854 Currently available options are:
1860 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.
1864 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1868 "collect" (the default) or "pre-bill"
1872 set true to surpress email card/ACH decline notices.
1876 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)
1883 # allows for one time override of normal customer billing method
1887 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1890 my( $self, %options ) = @_;
1892 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1894 my $time = $options{'time'} || time;
1897 local $SIG{HUP} = 'IGNORE';
1898 local $SIG{INT} = 'IGNORE';
1899 local $SIG{QUIT} = 'IGNORE';
1900 local $SIG{TERM} = 'IGNORE';
1901 local $SIG{TSTP} = 'IGNORE';
1902 local $SIG{PIPE} = 'IGNORE';
1904 my $oldAutoCommit = $FS::UID::AutoCommit;
1905 local $FS::UID::AutoCommit = 0;
1908 $self->select_for_update; #mutex
1911 my $balance = $self->balance;
1912 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
1915 # if ( exists($options{'retry_card'}) ) {
1916 # carp 'retry_card option passed to collect is deprecated; use retry';
1917 # $options{'retry'} ||= $options{'retry_card'};
1919 # if ( exists($options{'retry'}) && $options{'retry'} ) {
1920 # my $error = $self->retry_realtime;
1922 # $dbh->rollback if $oldAutoCommit;
1927 # false laziness w/pay_batch::import_results
1929 my $due_cust_event = $self->due_cust_event(
1930 'debug' => ( $options{'debug'} || 0 ),
1932 'check_freq' => $options{'check_freq'},
1933 'stage' => ( $options{'stage'} || 'collect' ),
1935 unless( ref($due_cust_event) ) {
1936 $dbh->rollback if $oldAutoCommit;
1937 return $due_cust_event;
1940 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1941 #never want to roll back an event just because it or a different one
1943 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1945 foreach my $cust_event ( @$due_cust_event ) {
1949 #re-eval event conditions (a previous event could have changed things)
1950 unless ( $cust_event->test_conditions ) {
1951 #don't leave stray "new/locked" records around
1952 my $error = $cust_event->delete;
1953 return $error if $error;
1958 local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
1959 if $options{'quiet'};
1960 warn " running cust_event ". $cust_event->eventnum. "\n"
1963 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
1964 if ( my $error = $cust_event->do_event( 'time' => $time ) ) {
1965 #XXX wtf is this? figure out a proper dealio with return value
1977 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
1979 Inserts database records for and returns an ordered listref of new events due
1980 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
1981 events are due, an empty listref is returned. If there is an error, returns a
1982 scalar error message.
1984 To actually run the events, call each event's test_condition method, and if
1985 still true, call the event's do_event method.
1987 Options are passed as a hashref or as a list of name-value pairs. Available
1994 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.
1998 "collect" (the default) or "pre-bill"
2002 "Current time" for the events.
2006 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)
2010 Only return events for the specified eventtable (by default, events of all eventtables are returned)
2014 Explicitly pass the objects to be tested (typically used with eventtable).
2018 Set to true to return the objects, but not actually insert them into the
2025 sub due_cust_event {
2027 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
2030 #my $DEBUG = $opt{'debug'}
2031 $opt{'debug'} ||= 0; # silence some warnings
2032 local($DEBUG) = $opt{'debug'}
2033 if $opt{'debug'} > $DEBUG;
2034 $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
2036 warn "$me due_cust_event called with options ".
2037 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
2040 $opt{'time'} ||= time;
2042 local $SIG{HUP} = 'IGNORE';
2043 local $SIG{INT} = 'IGNORE';
2044 local $SIG{QUIT} = 'IGNORE';
2045 local $SIG{TERM} = 'IGNORE';
2046 local $SIG{TSTP} = 'IGNORE';
2047 local $SIG{PIPE} = 'IGNORE';
2049 my $oldAutoCommit = $FS::UID::AutoCommit;
2050 local $FS::UID::AutoCommit = 0;
2053 $self->select_for_update #mutex
2054 unless $opt{testonly};
2057 # find possible events (initial search)
2060 my @cust_event = ();
2062 my @eventtable = $opt{'eventtable'}
2063 ? ( $opt{'eventtable'} )
2064 : FS::part_event->eventtables_runorder;
2066 my $check_freq = $opt{'check_freq'} || '1d';
2068 foreach my $eventtable ( @eventtable ) {
2071 if ( $opt{'objects'} ) {
2073 @objects = @{ $opt{'objects'} };
2075 } elsif ( $eventtable eq 'cust_main' ) {
2077 @objects = ( $self );
2081 my $cm_join = " LEFT JOIN cust_main USING ( custnum )";
2082 # linkage not needed here because FS::cust_main->$eventtable will
2085 #some false laziness w/Cron::bill bill_where
2087 my $join = FS::part_event_condition->join_conditions_sql( $eventtable,
2088 'time' => $opt{'time'});
2089 my $where = FS::part_event_condition->where_conditions_sql($eventtable,
2090 'time'=>$opt{'time'},
2092 $where = $where ? "AND $where" : '';
2094 my $are_part_event =
2095 "EXISTS ( SELECT 1 FROM part_event $join
2096 WHERE check_freq = '$check_freq'
2097 AND eventtable = '$eventtable'
2098 AND ( disabled = '' OR disabled IS NULL )
2104 @objects = $self->$eventtable(
2105 'addl_from' => $cm_join,
2106 'extra_sql' => " AND $are_part_event",
2108 } # if ( !$opt{objects} and $eventtable ne 'cust_main' )
2110 my @e_cust_event = ();
2112 my $linkage = FS::part_event->eventtables_cust_join->{$eventtable} || '';
2114 my $cross = "CROSS JOIN $eventtable $linkage";
2115 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
2116 unless $eventtable eq 'cust_main';
2118 foreach my $object ( @objects ) {
2120 #this first search uses the condition_sql magic for optimization.
2121 #the more possible events we can eliminate in this step the better
2123 my $cross_where = '';
2124 my $pkey = $object->primary_key;
2125 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
2127 my $join = FS::part_event_condition->join_conditions_sql( $eventtable,
2128 'time' => $opt{'time'});
2130 FS::part_event_condition->where_conditions_sql( $eventtable,
2131 'time'=>$opt{'time'}
2133 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
2135 $extra_sql = "AND $extra_sql" if $extra_sql;
2137 #here is the agent virtualization
2138 $extra_sql .= " AND ( part_event.agentnum IS NULL
2139 OR part_event.agentnum = ". $self->agentnum. ' )';
2141 $extra_sql .= " $order";
2143 warn "searching for events for $eventtable ". $object->$pkey. "\n"
2144 if $opt{'debug'} > 2;
2145 my @part_event = qsearch( {
2146 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
2147 'select' => 'part_event.*',
2148 'table' => 'part_event',
2149 'addl_from' => "$cross $join",
2150 'hashref' => { 'check_freq' => $check_freq,
2151 'eventtable' => $eventtable,
2154 'extra_sql' => "AND $cross_where $extra_sql",
2158 my $pkey = $object->primary_key;
2159 warn " ". scalar(@part_event).
2160 " possible events found for $eventtable ". $object->$pkey(). "\n";
2163 push @e_cust_event, map {
2164 $_->new_cust_event($object, 'time' => $opt{'time'})
2169 warn " ". scalar(@e_cust_event).
2170 " subtotal possible cust events found for $eventtable\n"
2173 push @cust_event, @e_cust_event;
2177 warn " ". scalar(@cust_event).
2178 " total possible cust events found in initial search\n"
2186 $opt{stage} ||= 'collect';
2188 grep { my $stage = $_->part_event->event_stage;
2189 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
2199 @cust_event = grep $_->test_conditions( 'stats_hashref' => \%unsat ),
2202 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
2205 warn " invalid conditions not eliminated with condition_sql:\n".
2206 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
2207 if keys %unsat && $DEBUG; # > 1;
2213 unless( $opt{testonly} ) {
2214 foreach my $cust_event ( @cust_event ) {
2216 my $error = $cust_event->insert();
2218 $dbh->rollback if $oldAutoCommit;
2225 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2231 warn " returning events: ". Dumper(@cust_event). "\n"
2238 =item apply_payments_and_credits [ OPTION => VALUE ... ]
2240 Applies unapplied payments and credits.
2242 In most cases, this new method should be used in place of sequential
2243 apply_payments and apply_credits methods.
2245 A hash of optional arguments may be passed. Currently "manual" is supported.
2246 If true, a payment receipt is sent instead of a statement when
2247 'payment_receipt_email' configuration option is set.
2249 If there is an error, returns the error, otherwise returns false.
2253 sub apply_payments_and_credits {
2254 my( $self, %options ) = @_;
2256 local $SIG{HUP} = 'IGNORE';
2257 local $SIG{INT} = 'IGNORE';
2258 local $SIG{QUIT} = 'IGNORE';
2259 local $SIG{TERM} = 'IGNORE';
2260 local $SIG{TSTP} = 'IGNORE';
2261 local $SIG{PIPE} = 'IGNORE';
2263 my $oldAutoCommit = $FS::UID::AutoCommit;
2264 local $FS::UID::AutoCommit = 0;
2267 $self->select_for_update; #mutex
2269 foreach my $cust_bill ( $self->open_cust_bill ) {
2270 my $error = $cust_bill->apply_payments_and_credits(%options);
2272 $dbh->rollback if $oldAutoCommit;
2273 return "Error applying: $error";
2277 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2282 =item apply_credits OPTION => VALUE ...
2284 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
2285 to outstanding invoice balances in chronological order (or reverse
2286 chronological order if the I<order> option is set to B<newest>) and returns the
2287 value of any remaining unapplied credits available for refund (see
2288 L<FS::cust_refund>).
2290 Dies if there is an error.
2298 local $SIG{HUP} = 'IGNORE';
2299 local $SIG{INT} = 'IGNORE';
2300 local $SIG{QUIT} = 'IGNORE';
2301 local $SIG{TERM} = 'IGNORE';
2302 local $SIG{TSTP} = 'IGNORE';
2303 local $SIG{PIPE} = 'IGNORE';
2305 my $oldAutoCommit = $FS::UID::AutoCommit;
2306 local $FS::UID::AutoCommit = 0;
2309 $self->select_for_update; #mutex
2311 unless ( $self->total_unapplied_credits ) {
2312 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2316 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
2317 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
2319 my @invoices = $self->open_cust_bill;
2320 @invoices = sort { $b->_date <=> $a->_date } @invoices
2321 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
2323 if ( $conf->exists('pkg-balances') ) {
2324 # limit @credits to those w/ a pkgnum grepped from $self
2326 foreach my $i (@invoices) {
2327 foreach my $li ( $i->cust_bill_pkg ) {
2328 $pkgnums{$li->pkgnum} = 1;
2331 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
2336 foreach my $cust_bill ( @invoices ) {
2338 if ( !defined($credit) || $credit->credited == 0) {
2339 $credit = pop @credits or last;
2343 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
2344 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
2346 $owed = $cust_bill->owed;
2348 unless ( $owed > 0 ) {
2349 push @credits, $credit;
2353 my $amount = min( $credit->credited, $owed );
2355 my $cust_credit_bill = new FS::cust_credit_bill ( {
2356 'crednum' => $credit->crednum,
2357 'invnum' => $cust_bill->invnum,
2358 'amount' => $amount,
2360 $cust_credit_bill->pkgnum( $credit->pkgnum )
2361 if $conf->exists('pkg-balances') && $credit->pkgnum;
2362 my $error = $cust_credit_bill->insert;
2364 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2368 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2372 my $total_unapplied_credits = $self->total_unapplied_credits;
2374 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2376 return $total_unapplied_credits;
2379 =item apply_payments [ OPTION => VALUE ... ]
2381 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2382 to outstanding invoice balances in chronological order.
2384 #and returns the value of any remaining unapplied payments.
2386 A hash of optional arguments may be passed. Currently "manual" is supported.
2387 If true, a payment receipt is sent instead of a statement when
2388 'payment_receipt_email' configuration option is set.
2390 Dies if there is an error.
2394 sub apply_payments {
2395 my( $self, %options ) = @_;
2397 local $SIG{HUP} = 'IGNORE';
2398 local $SIG{INT} = 'IGNORE';
2399 local $SIG{QUIT} = 'IGNORE';
2400 local $SIG{TERM} = 'IGNORE';
2401 local $SIG{TSTP} = 'IGNORE';
2402 local $SIG{PIPE} = 'IGNORE';
2404 my $oldAutoCommit = $FS::UID::AutoCommit;
2405 local $FS::UID::AutoCommit = 0;
2408 $self->select_for_update; #mutex
2412 my @payments = $self->unapplied_cust_pay;
2414 my @invoices = $self->open_cust_bill;
2416 if ( $conf->exists('pkg-balances') ) {
2417 # limit @payments to those w/ a pkgnum grepped from $self
2419 foreach my $i (@invoices) {
2420 foreach my $li ( $i->cust_bill_pkg ) {
2421 $pkgnums{$li->pkgnum} = 1;
2424 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
2429 foreach my $cust_bill ( @invoices ) {
2431 if ( !defined($payment) || $payment->unapplied == 0 ) {
2432 $payment = pop @payments or last;
2436 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
2437 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
2439 $owed = $cust_bill->owed;
2441 unless ( $owed > 0 ) {
2442 push @payments, $payment;
2446 my $amount = min( $payment->unapplied, $owed );
2449 'paynum' => $payment->paynum,
2450 'invnum' => $cust_bill->invnum,
2451 'amount' => $amount,
2453 $cbp->{_date} = $payment->_date
2454 if $options{'manual'} && $options{'backdate_application'};
2455 my $cust_bill_pay = new FS::cust_bill_pay($cbp);
2456 $cust_bill_pay->pkgnum( $payment->pkgnum )
2457 if $conf->exists('pkg-balances') && $payment->pkgnum;
2458 my $error = $cust_bill_pay->insert(%options);
2460 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2464 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2468 my $total_unapplied_payments = $self->total_unapplied_payments;
2470 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2472 return $total_unapplied_payments;
2482 suspend_adjourned_pkgs
2483 unsuspend_resumed_pkgs
2486 (do_cust_event pre-bill)
2489 (vendor-only) _gather_taxes
2490 _omit_zero_value_bundles
2491 _handle_taxes (for fees)
2494 apply_payments_and_credits
2503 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>