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 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.
338 This boolean value informs the us that the package is being cancelled. This
339 typically might mean not charging the normal recurring fee but only usage
340 fees since the last billing. Setup charges may be charged. Not all package
341 plans support this feature (they tend to charge 0).
345 Prevent the resetting of usage limits during this call.
349 Do not save the generated bill in the database. Useful with return_bill
353 A list reference on which the generated bill(s) will be returned.
357 Optional terms to be printed on this invoice. Otherwise, customer-specific
358 terms or the default terms are used.
365 my( $self, %options ) = @_;
367 return '' if $self->payby eq 'COMP';
369 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
371 warn "$me bill customer ". $self->custnum. "\n"
374 my $time = $options{'time'} || time;
375 my $invoice_time = $options{'invoice_time'} || $time;
377 my $cmp_time = ( $conf->exists('next-bill-ignore-time')
382 $options{'not_pkgpart'} ||= {};
383 $options{'not_pkgpart'} = { map { $_ => 1 }
384 split(/\s*,\s*/, $options{'not_pkgpart'})
386 unless ref($options{'not_pkgpart'});
388 local $SIG{HUP} = 'IGNORE';
389 local $SIG{INT} = 'IGNORE';
390 local $SIG{QUIT} = 'IGNORE';
391 local $SIG{TERM} = 'IGNORE';
392 local $SIG{TSTP} = 'IGNORE';
393 local $SIG{PIPE} = 'IGNORE';
395 my $oldAutoCommit = $FS::UID::AutoCommit;
396 local $FS::UID::AutoCommit = 0;
399 warn "$me acquiring lock on customer ". $self->custnum. "\n"
402 $self->select_for_update; #mutex
404 warn "$me running pre-bill events for customer ". $self->custnum. "\n"
407 my $error = $self->do_cust_event(
408 'debug' => ( $options{'debug'} || 0 ),
409 'time' => $invoice_time,
410 'check_freq' => $options{'check_freq'},
411 'stage' => 'pre-bill',
413 unless $options{no_commit};
415 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
419 warn "$me done running pre-bill events for customer ". $self->custnum. "\n"
422 #keep auto-charge and non-auto-charge line items separate
423 my @passes = ( '', 'no_auto' );
425 my %cust_bill_pkg = map { $_ => [] } @passes;
428 # find the packages which are due for billing, find out how much they are
429 # & generate invoice database.
432 my %total_setup = map { my $z = 0; $_ => \$z; } @passes;
433 my %total_recur = map { my $z = 0; $_ => \$z; } @passes;
435 my %taxlisthash = map { $_ => {} } @passes;
437 my @precommit_hooks = ();
439 $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ]; #param checks?
441 foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
443 next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
445 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG;
447 #? to avoid use of uninitialized value errors... ?
448 $cust_pkg->setfield('bill', '')
449 unless defined($cust_pkg->bill);
451 #my $part_pkg = $cust_pkg->part_pkg;
453 my $real_pkgpart = $cust_pkg->pkgpart;
454 my %hash = $cust_pkg->hash;
456 # we could implement this bit as FS::part_pkg::has_hidden, but we already
457 # suffer from performance issues
458 $options{has_hidden} = 0;
459 my @part_pkg = $cust_pkg->part_pkg->self_and_bill_linked;
460 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
462 # if this package was changed from another package,
463 # and it hasn't been billed since then,
464 # and package balances are enabled,
465 if ( $cust_pkg->change_pkgnum
466 and $cust_pkg->change_date >= ($cust_pkg->last_bill || 0)
467 and $cust_pkg->change_date < $invoice_time
468 and $conf->exists('pkg-balances') )
470 # _transfer_balance will also create the appropriate credit
471 my @transfer_items = $self->_transfer_balance($cust_pkg);
472 # $part_pkg[0] is the "real" part_pkg
473 my $pass = ($cust_pkg->no_auto || $part_pkg[0]->no_auto) ?
475 push @{ $cust_bill_pkg{$pass} }, @transfer_items;
476 # treating this as recur, just because most charges are recur...
477 ${$total_recur{$pass}} += $_->recur foreach @transfer_items;
480 foreach my $part_pkg ( @part_pkg ) {
482 $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
484 my $pass = ($cust_pkg->no_auto || $part_pkg->no_auto) ? 'no_auto' : '';
486 my $next_bill = $cust_pkg->getfield('bill') || 0;
488 # let this run once if this is the last bill upon cancellation
489 while ( $next_bill <= $cmp_time or $options{cancel} ) {
491 $self->_make_lines( 'part_pkg' => $part_pkg,
492 'cust_pkg' => $cust_pkg,
493 'precommit_hooks' => \@precommit_hooks,
494 'line_items' => $cust_bill_pkg{$pass},
495 'setup' => $total_setup{$pass},
496 'recur' => $total_recur{$pass},
497 'tax_matrix' => $taxlisthash{$pass},
499 'real_pkgpart' => $real_pkgpart,
500 'options' => \%options,
503 # Stop if anything goes wrong
506 # or if we're not incrementing the bill date.
507 last if ($cust_pkg->getfield('bill') || 0) == $next_bill;
509 # or if we're letting it run only once
510 last if $options{cancel};
512 $next_bill = $cust_pkg->getfield('bill') || 0;
514 #stop if -o was passed to freeside-daily
515 last if $options{'one_recur'};
518 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
522 } #foreach my $part_pkg
524 } #foreach my $cust_pkg
526 #if the customer isn't on an automatic payby, everything can go on a single
528 #if ( $cust_main->payby !~ /^(CARD|CHEK)$/ ) {
529 #merge everything into one list
532 foreach my $pass (@passes) { # keys %cust_bill_pkg ) {
534 my @cust_bill_pkg = _omit_zero_value_bundles(@{ $cust_bill_pkg{$pass} });
536 next unless @cust_bill_pkg; #don't create an invoice w/o line items
538 warn "$me billing pass $pass\n"
539 #.Dumper(\@cust_bill_pkg)."\n"
546 my @pending_event_fees = FS::cust_event_fee->by_cust($self->custnum,
547 hashref => { 'billpkgnum' => '' }
549 warn "$me found pending fee events:\n".Dumper(\@pending_event_fees)."\n"
550 if @pending_event_fees;
553 foreach my $event_fee (@pending_event_fees) {
554 my $object = $event_fee->cust_event->cust_X;
556 if ( $object->isa('FS::cust_main') ) {
557 # Not the real cust_bill object that will be inserted--in particular
558 # there are no taxes yet. If you want to charge a fee on the total
559 # invoice amount including taxes, you have to put the fee on the next
561 $cust_bill = FS::cust_bill->new({
562 'custnum' => $self->custnum,
563 'cust_bill_pkg' => \@cust_bill_pkg,
564 'charged' => ${ $total_setup{$pass} } +
565 ${ $total_recur{$pass} },
567 } elsif ( $object->isa('FS::cust_bill') ) {
568 # simple case: applying the fee to a previous invoice (late fee,
570 $cust_bill = $object;
572 my $part_fee = $event_fee->part_fee;
573 # if the fee def belongs to a different agent, don't charge the fee.
574 # event conditions should prevent this, but just in case they don't,
576 if ( $part_fee->agentnum and $part_fee->agentnum != $self->agentnum ) {
577 warn "tried to charge fee#".$part_fee->feepart .
578 " on customer#".$self->custnum." from a different agent.\n";
581 # also skip if it's disabled
582 next if $part_fee->disabled eq 'Y';
584 my $fee_item = $event_fee->part_fee->lineitem($cust_bill);
585 # link this so that we can clear the marker on inserting the line item
586 $fee_item->set('cust_event_fee', $event_fee);
587 push @fee_items, $fee_item;
589 foreach my $fee_item (@fee_items) {
591 push @cust_bill_pkg, $fee_item;
592 ${ $total_setup{$pass} } += $fee_item->setup;
593 ${ $total_recur{$pass} } += $fee_item->recur;
595 my $part_fee = $fee_item->part_fee;
596 my $fee_location = $self->ship_location; # I think?
598 my $error = $self->_handle_taxes(
601 location => $fee_location
603 return $error if $error;
607 # XXX implementation of fees is supposed to make this go away...
608 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
609 !$conf->exists('postal_invoice-recurring_only')
613 my $postal_pkg = $self->charge_postal_fee();
614 if ( $postal_pkg && !ref( $postal_pkg ) ) {
616 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
617 return "can't charge postal invoice fee for customer ".
618 $self->custnum. ": $postal_pkg";
620 } elsif ( $postal_pkg ) {
622 my $real_pkgpart = $postal_pkg->pkgpart;
623 # we could implement this bit as FS::part_pkg::has_hidden, but we already
624 # suffer from performance issues
625 $options{has_hidden} = 0;
626 my @part_pkg = $postal_pkg->part_pkg->self_and_bill_linked;
627 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
629 foreach my $part_pkg ( @part_pkg ) {
630 my %postal_options = %options;
631 delete $postal_options{cancel};
633 $self->_make_lines( 'part_pkg' => $part_pkg,
634 'cust_pkg' => $postal_pkg,
635 'precommit_hooks' => \@precommit_hooks,
636 'line_items' => \@cust_bill_pkg,
637 'setup' => $total_setup{$pass},
638 'recur' => $total_recur{$pass},
639 'tax_matrix' => $taxlisthash{$pass},
641 'real_pkgpart' => $real_pkgpart,
642 'options' => \%postal_options,
645 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
650 # it's silly to have a zero value postal_pkg, but....
651 @cust_bill_pkg = _omit_zero_value_bundles(@cust_bill_pkg);
657 my $listref_or_error =
658 $self->calculate_taxes( \@cust_bill_pkg, $taxlisthash{$pass}, $invoice_time);
660 unless ( ref( $listref_or_error ) ) {
661 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
662 return $listref_or_error;
665 foreach my $taxline ( @$listref_or_error ) {
666 ${ $total_setup{$pass} } =
667 sprintf('%.2f', ${ $total_setup{$pass} } + $taxline->setup );
668 push @cust_bill_pkg, $taxline;
672 warn "adding tax adjustments...\n" if $DEBUG > 2;
673 foreach my $cust_tax_adjustment (
674 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
680 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
682 my $itemdesc = $cust_tax_adjustment->taxname;
683 $itemdesc = '' if $itemdesc eq 'Tax';
685 push @cust_bill_pkg, new FS::cust_bill_pkg {
691 'itemdesc' => $itemdesc,
692 'itemcomment' => $cust_tax_adjustment->comment,
693 'cust_tax_adjustment' => $cust_tax_adjustment,
694 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
699 my $charged = sprintf('%.2f', ${ $total_setup{$pass} } + ${ $total_recur{$pass} } );
701 my @cust_bill = $self->cust_bill;
702 my $balance = $self->balance;
703 my $previous_bill = $cust_bill[-1] if @cust_bill;
704 my $previous_balance = 0;
705 if ( $previous_bill ) {
706 $previous_balance = $previous_bill->billing_balance
707 + $previous_bill->charged;
710 warn "creating the new invoice\n" if $DEBUG;
711 #create the new invoice
712 my $cust_bill = new FS::cust_bill ( {
713 'custnum' => $self->custnum,
714 '_date' => $invoice_time,
715 'charged' => $charged,
716 'billing_balance' => $balance,
717 'previous_balance' => $previous_balance,
718 'invoice_terms' => $options{'invoice_terms'},
719 'cust_bill_pkg' => \@cust_bill_pkg,
721 $error = $cust_bill->insert unless $options{no_commit};
723 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
724 return "can't create invoice for customer #". $self->custnum. ": $error";
726 push @{$options{return_bill}}, $cust_bill if $options{return_bill};
728 } #foreach my $pass ( keys %cust_bill_pkg )
730 foreach my $hook ( @precommit_hooks ) {
733 } unless $options{no_commit};
735 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
736 return "$@ running precommit hook $hook\n";
740 $dbh->commit or die $dbh->errstr if $oldAutoCommit && !$options{no_commit};
745 #discard bundled packages of 0 value
746 sub _omit_zero_value_bundles {
749 my @cust_bill_pkg = ();
750 my @cust_bill_pkg_bundle = ();
752 my $discount_show_always = 0;
754 foreach my $cust_bill_pkg ( @in ) {
756 $discount_show_always = ($cust_bill_pkg->get('discounts')
757 && scalar(@{$cust_bill_pkg->get('discounts')})
758 && $conf->exists('discount-show-always'));
760 warn " pkgnum ". $cust_bill_pkg->pkgnum. " sum $sum, ".
761 "setup_show_zero ". $cust_bill_pkg->setup_show_zero.
762 "recur_show_zero ". $cust_bill_pkg->recur_show_zero. "\n"
765 if (scalar(@cust_bill_pkg_bundle) && !$cust_bill_pkg->pkgpart_override) {
766 push @cust_bill_pkg, @cust_bill_pkg_bundle
768 || ($sum == 0 && ( $discount_show_always
769 || grep {$_->recur_show_zero || $_->setup_show_zero}
770 @cust_bill_pkg_bundle
773 @cust_bill_pkg_bundle = ();
777 $sum += $cust_bill_pkg->setup + $cust_bill_pkg->recur;
778 push @cust_bill_pkg_bundle, $cust_bill_pkg;
782 push @cust_bill_pkg, @cust_bill_pkg_bundle
784 || ($sum == 0 && ( $discount_show_always
785 || grep {$_->recur_show_zero || $_->setup_show_zero}
786 @cust_bill_pkg_bundle
790 warn " _omit_zero_value_bundles: ". scalar(@in).
791 '->'. scalar(@cust_bill_pkg). "\n" #. Dumper(@cust_bill_pkg). "\n"
798 =item calculate_taxes LINEITEMREF TAXHASHREF INVOICE_TIME
800 Generates tax line items (see L<FS::cust_bill_pkg>) for this customer.
801 Usually used internally by bill method B<bill>.
803 If there is an error, returns the error, otherwise returns reference to a
804 list of line items suitable for insertion.
810 An array ref of the line items being billed.
814 A strange beast. The keys to this hash are internal identifiers consisting
815 of the name of the tax object type, a space, and its unique identifier ( e.g.
816 'cust_main_county 23' ). The values of the hash are listrefs. The first
817 item in the list is the tax object. The remaining items are either line
818 items or floating point values (currency amounts).
820 The taxes are calculated on this entity. Calculated exemption records are
821 transferred to the LINEITEMREF items on the assumption that they are related.
827 This specifies the date appearing on the associated invoice. Some
828 jurisdictions (i.e. Texas) have tax exemptions which are date sensitive.
834 sub calculate_taxes {
835 my ($self, $cust_bill_pkg, $taxlisthash, $invoice_time) = @_;
837 # $taxlisthash is a hashref
838 # keys are identifiers, values are arrayrefs
839 # each arrayref starts with a tax object (cust_main_county or tax_rate)
840 # then any cust_bill_pkg objects the tax applies to
842 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
844 warn "$me calculate_taxes\n"
845 #.Dumper($self, $cust_bill_pkg, $taxlisthash, $invoice_time). "\n"
848 my @tax_line_items = ();
850 # keys are tax names (as printed on invoices / itemdesc )
851 # values are arrayrefs of taxlisthash keys (internal identifiers)
854 # keys are taxlisthash keys (internal identifiers)
855 # values are (cumulative) amounts
858 # keys are taxlisthash keys (internal identifiers)
859 # values are arrayrefs of cust_bill_pkg_tax_location hashrefs
860 my %tax_location = ();
862 # keys are taxlisthash keys (internal identifiers)
863 # values are arrayrefs of cust_bill_pkg_tax_rate_location hashrefs
864 my %tax_rate_location = ();
866 # keys are taxlisthash keys (internal identifiers!)
867 # values are arrayrefs of cust_tax_exempt_pkg objects
870 foreach my $tax ( keys %$taxlisthash ) {
871 # $tax is a tax identifier (intersection of a tax definition record
872 # and a cust_bill_pkg record)
873 my $tax_object = shift @{ $taxlisthash->{$tax} };
874 # $tax_object is a cust_main_county or tax_rate
875 # (with billpkgnum, pkgnum, locationnum set)
876 # the rest of @{ $taxlisthash->{$tax} } is cust_bill_pkg component objects
877 # (setup, recurring, usage classes)
878 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
879 warn " ". join('/', @{ $taxlisthash->{$tax} } ). "\n" if $DEBUG > 2;
880 # taxline calculates the tax on all cust_bill_pkgs in the
881 # first (arrayref) argument, and returns a hashref of 'name'
882 # (the line item description) and 'amount'.
883 # It also calculates exemptions and attaches them to the cust_bill_pkgs
885 my $taxables = $taxlisthash->{$tax};
886 my $exemptions = $tax_exemption{$tax} ||= [];
887 my $taxline = $tax_object->taxline(
889 'custnum' => $self->custnum,
890 'invoice_time' => $invoice_time,
891 'exemptions' => $exemptions,
893 return $taxline unless ref($taxline);
895 unshift @{ $taxlisthash->{$tax} }, $tax_object;
897 if ( $tax_object->isa('FS::cust_main_county') ) {
898 # then $taxline is a real line item
899 push @{ $taxname{ $taxline->itemdesc } }, $taxline;
902 # leave this as is for now
904 my $name = $taxline->{'name'};
905 my $amount = $taxline->{'amount'};
907 #warn "adding $amount as $name\n";
908 $taxname{ $name } ||= [];
909 push @{ $taxname{ $name } }, $tax;
911 $tax_amount{ $tax } += $amount;
913 # link records between cust_main_county/tax_rate and cust_location
914 $tax_rate_location{ $tax } ||= [];
915 my $taxratelocationnum =
916 $tax_object->tax_rate_location->taxratelocationnum;
917 push @{ $tax_rate_location{ $tax } },
919 'taxnum' => $tax_object->taxnum,
920 'taxtype' => ref($tax_object),
921 'amount' => sprintf('%.2f', $amount ),
922 'locationtaxid' => $tax_object->location,
923 'taxratelocationnum' => $taxratelocationnum,
925 } #if ref($tax_object)...
926 } #foreach keys %$taxlisthash
928 #consolidate and create tax line items
929 warn "consolidating and generating...\n" if $DEBUG > 2;
930 foreach my $taxname ( keys %taxname ) {
931 my @cust_bill_pkg_tax_location;
932 my @cust_bill_pkg_tax_rate_location;
933 my $tax_cust_bill_pkg = FS::cust_bill_pkg->new({
938 'itemdesc' => $taxname,
939 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
940 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
945 warn "adding $taxname\n" if $DEBUG > 1;
946 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
947 if ( ref($taxitem) eq 'FS::cust_bill_pkg' ) {
948 # then we need to transfer the amount and the links from the
949 # line item to the new one we're creating.
950 $tax_total += $taxitem->setup;
951 foreach my $link ( @{ $taxitem->get('cust_bill_pkg_tax_location') } ) {
952 $link->set('tax_cust_bill_pkg', $tax_cust_bill_pkg);
953 push @cust_bill_pkg_tax_location, $link;
957 next if $seen{$taxitem}++;
958 warn "adding $tax_amount{$taxitem}\n" if $DEBUG > 1;
959 $tax_total += $tax_amount{$taxitem};
960 push @cust_bill_pkg_tax_rate_location,
961 map { new FS::cust_bill_pkg_tax_rate_location $_ }
962 @{ $tax_rate_location{ $taxitem } };
965 next unless $tax_total;
967 # we should really neverround this up...I guess it's okay if taxline
968 # already returns amounts with 2 decimal places
969 $tax_total = sprintf('%.2f', $tax_total );
970 $tax_cust_bill_pkg->set('setup', $tax_total);
972 my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
978 if ( $pkg_category and
979 $conf->config('invoice_latexsummary') ||
980 $conf->config('invoice_htmlsummary')
984 my %hash = ( 'section' => $pkg_category->categoryname );
985 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
988 $tax_cust_bill_pkg->set('display', \@display);
990 push @tax_line_items, $tax_cust_bill_pkg;
997 my ($self, %params) = @_;
999 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1001 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
1002 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
1003 my $cust_location = $cust_pkg->tax_location;
1004 my $precommit_hooks = $params{precommit_hooks} or die "no precommit_hooks specified";
1005 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
1006 my $total_setup = $params{setup} or die "no setup accumulator specified";
1007 my $total_recur = $params{recur} or die "no recur accumulator specified";
1008 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
1009 my $time = $params{'time'} or die "no time specified";
1010 my (%options) = %{$params{options}};
1012 if ( $part_pkg->freq ne '1' and ($options{'freq_override'} || 0) > 0 ) {
1013 # this should never happen
1014 die 'freq_override billing attempted on non-monthly package '.
1019 my $real_pkgpart = $params{real_pkgpart};
1020 my %hash = $cust_pkg->hash;
1021 my $old_cust_pkg = new FS::cust_pkg \%hash;
1026 $cust_pkg->pkgpart($part_pkg->pkgpart);
1028 my $cmp_time = ( $conf->exists('next-bill-ignore-time')
1039 my @setup_discounts = ();
1040 my %setup_param = ( 'discounts' => \@setup_discounts );
1041 my $setup_billed_currency = '';
1042 my $setup_billed_amount = 0;
1043 if ( ! $options{recurring_only}
1044 and ! $options{cancel}
1045 and ( $options{'resetup'}
1046 || ( ! $cust_pkg->setup
1047 && ( ! $cust_pkg->start_date
1048 || $cust_pkg->start_date <= $cmp_time
1050 && ( ! $conf->exists('disable_setup_suspended_pkgs')
1051 || ( $conf->exists('disable_setup_suspended_pkgs') &&
1052 ! $cust_pkg->getfield('susp')
1060 warn " bill setup\n" if $DEBUG > 1;
1062 unless ( $cust_pkg->waive_setup ) {
1065 $setup = eval { $cust_pkg->calc_setup( $time, \@details, \%setup_param ) };
1066 return "$@ running calc_setup for $cust_pkg\n"
1069 $unitsetup = $cust_pkg->base_setup()
1072 if ( $setup_param{'billed_currency'} ) {
1073 $setup_billed_currency = delete $setup_param{'billed_currency'};
1074 $setup_billed_amount = delete $setup_param{'billed_amount'};
1078 $cust_pkg->setfield('setup', $time)
1079 unless $cust_pkg->setup;
1080 #do need it, but it won't get written to the db
1081 #|| $cust_pkg->pkgpart != $real_pkgpart;
1083 $cust_pkg->setfield('start_date', '')
1084 if $cust_pkg->start_date;
1089 # bill recurring fee
1094 my @recur_discounts = ();
1095 my $recur_billed_currency = '';
1096 my $recur_billed_amount = 0;
1098 if ( ! $cust_pkg->start_date
1099 and ( ! $cust_pkg->susp || $cust_pkg->option('suspend_bill',1)
1100 || ( $part_pkg->option('suspend_bill', 1) )
1101 && ! $cust_pkg->option('no_suspend_bill',1)
1104 ( $part_pkg->freq ne '0' && ( $cust_pkg->bill || 0 ) <= $cmp_time )
1105 || ( $part_pkg->plan eq 'voip_cdr'
1106 && $part_pkg->option('bill_every_call')
1111 # XXX should this be a package event? probably. events are called
1112 # at collection time at the moment, though...
1113 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
1114 if $part_pkg->can('reset_usage') && !$options{'no_usage_reset'};
1115 #don't want to reset usage just cause we want a line item??
1116 #&& $part_pkg->pkgpart == $real_pkgpart;
1118 warn " bill recur\n" if $DEBUG > 1;
1121 # XXX shared with $recur_prog
1122 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
1126 #over two params! lets at least switch to a hashref for the rest...
1127 my $increment_next_bill = ( $part_pkg->freq ne '0'
1128 && ( $cust_pkg->getfield('bill') || 0 ) <= $cmp_time
1129 && !$options{cancel}
1131 my %param = ( %setup_param,
1132 'precommit_hooks' => $precommit_hooks,
1133 'increment_next_bill' => $increment_next_bill,
1134 'discounts' => \@recur_discounts,
1135 'real_pkgpart' => $real_pkgpart,
1136 'freq_override' => $options{freq_override} || '',
1140 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
1142 # There may be some part_pkg for which this is wrong. Only those
1143 # which can_discount are supported.
1144 # (the UI should prevent adding discounts to these at the moment)
1146 warn "calling $method on cust_pkg ". $cust_pkg->pkgnum.
1147 " for pkgpart ". $cust_pkg->pkgpart.
1148 " with params ". join(' / ', map "$_=>$param{$_}", keys %param). "\n"
1151 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
1152 return "$@ running $method for $cust_pkg\n"
1156 $unitrecur = $cust_pkg->base_recur( \$sdate ) || $recur; #XXX uuh, better
1158 if ( $param{'billed_currency'} ) {
1159 $recur_billed_currency = delete $param{'billed_currency'};
1160 $recur_billed_amount = delete $param{'billed_amount'};
1163 if ( $increment_next_bill ) {
1167 if ( my $main_pkg = $cust_pkg->main_pkg ) {
1168 # supplemental package
1169 # to keep in sync with the main package, simulate billing at
1171 my $main_pkg_freq = $main_pkg->part_pkg->freq;
1172 my $supp_pkg_freq = $part_pkg->freq;
1173 my $ratio = $supp_pkg_freq / $main_pkg_freq;
1174 if ( $ratio != int($ratio) ) {
1175 # the UI should prevent setting up packages like this, but just
1177 return "supplemental package period is not an integer multiple of main package period";
1179 $next_bill = $sdate;
1181 $next_bill = $part_pkg->add_freq( $next_bill, $main_pkg_freq );
1186 $next_bill = $part_pkg->add_freq($sdate, $options{freq_override} || 0);
1187 return "unparsable frequency: ". $part_pkg->freq
1188 if $next_bill == -1;
1191 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
1192 # only for figuring next bill date, nothing else, so, reset $sdate again
1194 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1195 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
1196 $cust_pkg->last_bill($sdate);
1198 $cust_pkg->setfield('bill', $next_bill );
1202 if ( $param{'setup_fee'} ) {
1203 # Add an additional setup fee at the billing stage.
1204 # Used for prorate_defer_bill.
1205 $setup += $param{'setup_fee'};
1206 $unitsetup += $param{'setup_fee'};
1210 if ( defined $param{'discount_left_setup'} ) {
1211 foreach my $discount_setup ( values %{$param{'discount_left_setup'}} ) {
1212 $setup -= $discount_setup;
1218 warn "\$setup is undefined" unless defined($setup);
1219 warn "\$recur is undefined" unless defined($recur);
1220 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1223 # If there's line items, create em cust_bill_pkg records
1224 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
1229 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
1230 # hmm.. and if just the options are modified in some weird price plan?
1232 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
1235 my $error = $cust_pkg->replace( $old_cust_pkg,
1236 'depend_jobnum'=>$options{depend_jobnum},
1237 'options' => { $cust_pkg->options },
1239 unless $options{no_commit};
1240 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
1241 if $error; #just in case
1244 $setup = sprintf( "%.2f", $setup );
1245 $recur = sprintf( "%.2f", $recur );
1246 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
1247 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1249 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
1250 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
1253 my $discount_show_always = $conf->exists('discount-show-always')
1254 && ( ($setup == 0 && scalar(@setup_discounts))
1255 || ($recur == 0 && scalar(@recur_discounts))
1260 || (!$part_pkg->hidden && $options{has_hidden}) #include some $0 lines
1261 || $discount_show_always
1262 || ($setup == 0 && $cust_pkg->_X_show_zero('setup'))
1263 || ($recur == 0 && $cust_pkg->_X_show_zero('recur'))
1267 warn " charges (setup=$setup, recur=$recur); adding line items\n"
1270 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
1272 warn " adding customer package invoice detail: $_\n"
1273 foreach @cust_pkg_detail;
1275 push @details, @cust_pkg_detail;
1277 my $cust_bill_pkg = new FS::cust_bill_pkg {
1278 'pkgnum' => $cust_pkg->pkgnum,
1280 'unitsetup' => $unitsetup,
1281 'setup_billed_currency' => $setup_billed_currency,
1282 'setup_billed_amount' => $setup_billed_amount,
1284 'unitrecur' => $unitrecur,
1285 'recur_billed_currency' => $recur_billed_currency,
1286 'recur_billed_amount' => $recur_billed_amount,
1287 'quantity' => $cust_pkg->quantity,
1288 'details' => \@details,
1289 'discounts' => [ @setup_discounts, @recur_discounts ],
1290 'hidden' => $part_pkg->hidden,
1291 'freq' => $part_pkg->freq,
1294 if ( $part_pkg->option('prorate_defer_bill',1)
1295 and !$hash{last_bill} ) {
1296 # both preceding and upcoming, technically
1297 $cust_bill_pkg->sdate( $cust_pkg->setup );
1298 $cust_bill_pkg->edate( $cust_pkg->bill );
1299 } elsif ( $part_pkg->recur_temporality eq 'preceding' ) {
1300 $cust_bill_pkg->sdate( $hash{last_bill} );
1301 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
1302 $cust_bill_pkg->edate( $time ) if $options{cancel};
1303 } else { #if ( $part_pkg->recur_temporality eq 'upcoming' )
1304 $cust_bill_pkg->sdate( $sdate );
1305 $cust_bill_pkg->edate( $cust_pkg->bill );
1306 #$cust_bill_pkg->edate( $time ) if $options{cancel};
1309 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
1310 unless $part_pkg->pkgpart == $real_pkgpart;
1312 $$total_setup += $setup;
1313 $$total_recur += $recur;
1319 my $error = $self->_handle_taxes( $taxlisthash, $cust_bill_pkg );
1320 return $error if $error;
1322 $cust_bill_pkg->set_display(
1323 part_pkg => $part_pkg,
1324 real_pkgpart => $real_pkgpart,
1327 push @$cust_bill_pkgs, $cust_bill_pkg;
1329 } #if $setup != 0 || $recur != 0
1337 =item _transfer_balance TO_PKG [ FROM_PKGNUM ]
1339 Takes one argument, a cust_pkg object that is being billed. This will
1340 be called only if the package was created by a package change, and has
1341 not been billed since the package change, and package balance tracking
1342 is enabled. The second argument can be an alternate package number to
1343 transfer the balance from; this should not be used externally.
1345 Transfers the balance from the previous package (now canceled) to
1346 this package, by crediting one package and creating an invoice item for
1347 the other. Inserts the credit and returns the invoice item (so that it
1348 can be added to an invoice that's being built).
1350 If the previous package was never billed, and was also created by a package
1351 change, then this will also transfer the balance from I<its> previous
1352 package, and so on, until reaching a package that either has been billed
1353 or was not created by a package change.
1357 my $balance_transfer_reason;
1359 sub _transfer_balance {
1361 my $cust_pkg = shift;
1362 my $from_pkgnum = shift || $cust_pkg->change_pkgnum;
1363 my $from_pkg = FS::cust_pkg->by_key($from_pkgnum);
1367 # if $from_pkg is not the first package in the chain, and it was never
1369 if ( $from_pkg->change_pkgnum and scalar($from_pkg->cust_bill_pkg) == 0 ) {
1370 @transfers = $self->_transfer_balance($cust_pkg, $from_pkg->change_pkgnum);
1373 my $prev_balance = $self->balance_pkgnum($from_pkgnum);
1374 if ( $prev_balance != 0 ) {
1375 $balance_transfer_reason ||= FS::reason->new_or_existing(
1376 'reason' => 'Package balance transfer',
1377 'type' => 'Internal adjustment',
1381 my $credit = FS::cust_credit->new({
1382 'custnum' => $self->custnum,
1383 'amount' => abs($prev_balance),
1384 'reasonnum' => $balance_transfer_reason->reasonnum,
1385 '_date' => $cust_pkg->change_date,
1388 my $cust_bill_pkg = FS::cust_bill_pkg->new({
1390 'recur' => abs($prev_balance),
1391 #'sdate' => $from_pkg->last_bill, # not sure about this
1392 #'edate' => $cust_pkg->change_date,
1393 'itemdesc' => $self->mt('Previous Balance, [_1]',
1394 $from_pkg->part_pkg->pkg),
1397 if ( $prev_balance > 0 ) {
1398 # credit the old package, charge the new one
1399 $credit->set('pkgnum', $from_pkgnum);
1400 $cust_bill_pkg->set('pkgnum', $cust_pkg->pkgnum);
1403 $credit->set('pkgnum', $cust_pkg->pkgnum);
1404 $cust_bill_pkg->set('pkgnum', $from_pkgnum);
1406 my $error = $credit->insert;
1407 die "error transferring package balance from #".$from_pkgnum.
1408 " to #".$cust_pkg->pkgnum.": $error\n" if $error;
1410 push @transfers, $cust_bill_pkg;
1411 } # $prev_balance != 0
1416 =item handle_taxes TAXLISTHASH CUST_BILL_PKG [ OPTIONS ]
1418 This is _handle_taxes. It's called once for each cust_bill_pkg generated
1421 TAXLISTHASH is a hashref shared across the entire invoice. It looks like
1424 'cust_main_county 1001' => [ [FS::cust_main_county], ... ],
1425 'cust_main_county 1002' => [ [FS::cust_main_county], ... ],
1428 'cust_main_county' can also be 'tax_rate'. The first object in the array
1429 is always the cust_main_county or tax_rate identified by the key.
1431 That "..." is a list of FS::cust_bill_pkg objects that will be fed to
1432 the 'taxline' method to calculate the amount of the tax. This doesn't
1433 happen until calculate_taxes, though.
1435 OPTIONS may include:
1436 - part_item: a part_pkg or part_fee object to be used as the package/fee
1438 - location: a cust_location to be used as the billing location.
1440 If not supplied, part_item will be inferred from the pkgnum or feepart of the
1441 cust_bill_pkg, and location from the pkgnum (or, for fees, the invnum and
1442 the customer's default service location).
1448 my $taxlisthash = shift;
1449 my $cust_bill_pkg = shift;
1452 # at this point I realize that we have enough information to infer all this
1453 # stuff, instead of passing around giant honking argument lists
1454 my $location = $options{location} || $cust_bill_pkg->tax_location;
1455 my $part_item = $options{part_item} || $cust_bill_pkg->part_X;
1457 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1459 return if ( $self->payby eq 'COMP' ); #dubious
1461 if ( $conf->exists('enable_taxproducts')
1462 && ( scalar($part_item->part_pkg_taxoverride)
1463 || $part_item->has_taxproduct
1468 # EXTERNAL TAX RATES (via tax_rate)
1469 my %cust_bill_pkg = ();
1473 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
1474 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
1475 push @classes, 'setup' if $cust_bill_pkg->setup;
1476 push @classes, 'recur' if $cust_bill_pkg->recur;
1478 my $exempt = $conf->exists('cust_class-tax_exempt')
1479 ? ( $self->cust_class ? $self->cust_class->tax : '' )
1481 # standardize this just to be sure
1482 $exempt = ($exempt eq 'Y') ? 'Y' : '';
1486 foreach my $class (@classes) {
1487 my $err_or_ref = $self->_gather_taxes($part_item, $class, $location);
1488 return $err_or_ref unless ref($err_or_ref);
1489 $taxes{$class} = $err_or_ref;
1492 unless (exists $taxes{''}) {
1493 my $err_or_ref = $self->_gather_taxes($part_item, '', $location);
1494 return $err_or_ref unless ref($err_or_ref);
1495 $taxes{''} = $err_or_ref;
1500 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate; # grrr
1501 foreach my $key (keys %tax_cust_bill_pkg) {
1502 # $key is "setup", "recur", or a usage class name. ('' is a usage class.)
1503 # $tax_cust_bill_pkg{$key} is a cust_bill_pkg for that component of
1505 # $taxes{$key} is an arrayref of cust_main_county or tax_rate objects that
1506 # apply to $key-class charges.
1507 my @taxes = @{ $taxes{$key} || [] };
1508 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
1510 my %localtaxlisthash = ();
1511 foreach my $tax ( @taxes ) {
1513 # this is the tax identifier, not the taxname
1514 my $taxname = ref( $tax ). ' '. $tax->taxnum;
1515 # $taxlisthash: keys are "setup", "recur", and usage classes.
1516 # Values are arrayrefs, first the tax object (cust_main_county
1517 # or tax_rate) and then any cust_bill_pkg objects that the
1519 $taxlisthash->{ $taxname } ||= [ $tax ];
1520 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
1522 $localtaxlisthash{ $taxname } ||= [ $tax ];
1523 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
1527 warn "finding taxed taxes...\n" if $DEBUG > 2;
1528 foreach my $tax ( keys %localtaxlisthash ) {
1529 my $tax_object = shift @{ $localtaxlisthash{$tax} };
1530 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
1532 next unless $tax_object->can('tax_on_tax');
1534 foreach my $tot ( $tax_object->tax_on_tax( $location ) ) {
1535 my $totname = ref( $tot ). ' '. $tot->taxnum;
1537 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
1539 next unless exists( $localtaxlisthash{ $totname } ); # only increase
1541 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
1542 # calculate the tax amount that the tax_on_tax will apply to
1543 my $hashref_or_error =
1544 $tax_object->taxline( $localtaxlisthash{$tax} );
1545 return $hashref_or_error
1546 unless ref($hashref_or_error);
1548 # and append it to the list of taxable items
1549 $taxlisthash->{ $totname } ||= [ $tot ];
1550 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
1558 # INTERNAL TAX RATES (cust_main_county)
1560 # We fetch taxes even if the customer is completely exempt,
1561 # because we need to record that fact.
1563 my @loc_keys = qw( district city county state country );
1564 my %taxhash = map { $_ => $location->$_ } @loc_keys;
1566 $taxhash{'taxclass'} = $part_item->taxclass;
1568 warn "taxhash:\n". Dumper(\%taxhash) if $DEBUG > 2;
1570 my @taxes = (); # entries are cust_main_county objects
1571 my %taxhash_elim = %taxhash;
1572 my @elim = qw( district city county state );
1575 #first try a match with taxclass
1576 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1578 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1579 #then try a match without taxclass
1580 my %no_taxclass = %taxhash_elim;
1581 $no_taxclass{ 'taxclass' } = '';
1582 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1585 $taxhash_elim{ shift(@elim) } = '';
1587 } while ( !scalar(@taxes) && scalar(@elim) );
1590 my $tax_id = 'cust_main_county '.$_->taxnum;
1591 $taxlisthash->{$tax_id} ||= [ $_ ];
1592 push @{ $taxlisthash->{$tax_id} }, $cust_bill_pkg;
1599 =item _gather_taxes PART_ITEM CLASS CUST_LOCATION
1601 Internal method used with vendor-provided tax tables. PART_ITEM is a part_pkg
1602 or part_fee (which will define the tax eligibility of the product), CLASS is
1603 'setup', 'recur', null, or a C<usage_class> number, and CUST_LOCATION is the
1604 location where the service was provided (or billed, depending on
1605 configuration). Returns an arrayref of L<FS::tax_rate> objects that
1606 can apply to this line item.
1612 my $part_item = shift;
1614 my $location = shift;
1616 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1618 my $geocode = $location->geocode('cch');
1620 [ $part_item->tax_rates('cch', $geocode, $class) ]
1624 =item collect [ HASHREF | OPTION => VALUE ... ]
1626 (Attempt to) collect money for this customer's outstanding invoices (see
1627 L<FS::cust_bill>). Usually used after the bill method.
1629 Actions are now triggered by billing events; see L<FS::part_event> and the
1630 billing events web interface. Old-style invoice events (see
1631 L<FS::part_bill_event>) have been deprecated.
1633 If there is an error, returns the error, otherwise returns false.
1635 Options are passed as name-value pairs.
1637 Currently available options are:
1643 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.
1647 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1651 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1655 set true to surpress email card/ACH decline notices.
1659 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)
1665 # allows for one time override of normal customer billing method
1670 my( $self, %options ) = @_;
1672 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1674 my $invoice_time = $options{'invoice_time'} || time;
1677 local $SIG{HUP} = 'IGNORE';
1678 local $SIG{INT} = 'IGNORE';
1679 local $SIG{QUIT} = 'IGNORE';
1680 local $SIG{TERM} = 'IGNORE';
1681 local $SIG{TSTP} = 'IGNORE';
1682 local $SIG{PIPE} = 'IGNORE';
1684 my $oldAutoCommit = $FS::UID::AutoCommit;
1685 local $FS::UID::AutoCommit = 0;
1688 $self->select_for_update; #mutex
1691 my $balance = $self->balance;
1692 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
1695 if ( exists($options{'retry_card'}) ) {
1696 carp 'retry_card option passed to collect is deprecated; use retry';
1697 $options{'retry'} ||= $options{'retry_card'};
1699 if ( exists($options{'retry'}) && $options{'retry'} ) {
1700 my $error = $self->retry_realtime;
1702 $dbh->rollback if $oldAutoCommit;
1707 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1709 #never want to roll back an event just because it returned an error
1710 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1712 $self->do_cust_event(
1713 'debug' => ( $options{'debug'} || 0 ),
1714 'time' => $invoice_time,
1715 'check_freq' => $options{'check_freq'},
1716 'stage' => 'collect',
1721 =item retry_realtime
1723 Schedules realtime / batch credit card / electronic check / LEC billing
1724 events for for retry. Useful if card information has changed or manual
1725 retry is desired. The 'collect' method must be called to actually retry
1728 Implementation details: For either this customer, or for each of this
1729 customer's open invoices, changes the status of the first "done" (with
1730 statustext error) realtime processing event to "failed".
1734 sub retry_realtime {
1737 local $SIG{HUP} = 'IGNORE';
1738 local $SIG{INT} = 'IGNORE';
1739 local $SIG{QUIT} = 'IGNORE';
1740 local $SIG{TERM} = 'IGNORE';
1741 local $SIG{TSTP} = 'IGNORE';
1742 local $SIG{PIPE} = 'IGNORE';
1744 my $oldAutoCommit = $FS::UID::AutoCommit;
1745 local $FS::UID::AutoCommit = 0;
1748 #a little false laziness w/due_cust_event (not too bad, really)
1750 my $join = FS::part_event_condition->join_conditions_sql;
1751 my $order = FS::part_event_condition->order_conditions_sql;
1754 . join ( ' OR ' , map {
1755 my $cust_join = FS::part_event->eventtables_cust_join->{$_} || '';
1756 my $custnum = FS::part_event->eventtables_custnum->{$_};
1757 "( part_event.eventtable = " . dbh->quote($_)
1758 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key
1759 . " from $_ $cust_join"
1760 . " where $custnum = " . dbh->quote( $self->custnum ) . "))" ;
1761 } FS::part_event->eventtables)
1764 #here is the agent virtualization
1765 my $agent_virt = " ( part_event.agentnum IS NULL
1766 OR part_event.agentnum = ". $self->agentnum. ' )';
1768 #XXX this shouldn't be hardcoded, actions should declare it...
1769 my @realtime_events = qw(
1770 cust_bill_realtime_card
1771 cust_bill_realtime_check
1772 cust_bill_realtime_lec
1776 my $is_realtime_event =
1777 ' part_event.action IN ( '.
1778 join(',', map "'$_'", @realtime_events ).
1781 my $batch_or_statustext =
1782 "( part_event.action = 'cust_bill_batch'
1783 OR ( statustext IS NOT NULL AND statustext != '' )
1787 my @cust_event = qsearch({
1788 'table' => 'cust_event',
1789 'select' => 'cust_event.*',
1790 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
1791 'hashref' => { 'status' => 'done' },
1792 'extra_sql' => " AND $batch_or_statustext ".
1793 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
1796 my %seen_invnum = ();
1797 foreach my $cust_event (@cust_event) {
1799 #max one for the customer, one for each open invoice
1800 my $cust_X = $cust_event->cust_X;
1801 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
1805 or $cust_event->part_event->eventtable eq 'cust_bill'
1808 my $error = $cust_event->retry;
1810 $dbh->rollback if $oldAutoCommit;
1811 return "error scheduling event for retry: $error";
1816 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1821 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
1823 Runs billing events; see L<FS::part_event> and the billing events web
1826 If there is an error, returns the error, otherwise returns false.
1828 Options are passed as name-value pairs.
1830 Currently available options are:
1836 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.
1840 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1844 "collect" (the default) or "pre-bill"
1848 set true to surpress email card/ACH decline notices.
1852 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)
1859 # allows for one time override of normal customer billing method
1863 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1866 my( $self, %options ) = @_;
1868 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1870 my $time = $options{'time'} || time;
1873 local $SIG{HUP} = 'IGNORE';
1874 local $SIG{INT} = 'IGNORE';
1875 local $SIG{QUIT} = 'IGNORE';
1876 local $SIG{TERM} = 'IGNORE';
1877 local $SIG{TSTP} = 'IGNORE';
1878 local $SIG{PIPE} = 'IGNORE';
1880 my $oldAutoCommit = $FS::UID::AutoCommit;
1881 local $FS::UID::AutoCommit = 0;
1884 $self->select_for_update; #mutex
1887 my $balance = $self->balance;
1888 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
1891 # if ( exists($options{'retry_card'}) ) {
1892 # carp 'retry_card option passed to collect is deprecated; use retry';
1893 # $options{'retry'} ||= $options{'retry_card'};
1895 # if ( exists($options{'retry'}) && $options{'retry'} ) {
1896 # my $error = $self->retry_realtime;
1898 # $dbh->rollback if $oldAutoCommit;
1903 # false laziness w/pay_batch::import_results
1905 my $due_cust_event = $self->due_cust_event(
1906 'debug' => ( $options{'debug'} || 0 ),
1908 'check_freq' => $options{'check_freq'},
1909 'stage' => ( $options{'stage'} || 'collect' ),
1911 unless( ref($due_cust_event) ) {
1912 $dbh->rollback if $oldAutoCommit;
1913 return $due_cust_event;
1916 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1917 #never want to roll back an event just because it or a different one
1919 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1921 foreach my $cust_event ( @$due_cust_event ) {
1925 #re-eval event conditions (a previous event could have changed things)
1926 unless ( $cust_event->test_conditions ) {
1927 #don't leave stray "new/locked" records around
1928 my $error = $cust_event->delete;
1929 return $error if $error;
1934 local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
1935 if $options{'quiet'};
1936 warn " running cust_event ". $cust_event->eventnum. "\n"
1939 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
1940 if ( my $error = $cust_event->do_event( 'time' => $time ) ) {
1941 #XXX wtf is this? figure out a proper dealio with return value
1953 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
1955 Inserts database records for and returns an ordered listref of new events due
1956 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
1957 events are due, an empty listref is returned. If there is an error, returns a
1958 scalar error message.
1960 To actually run the events, call each event's test_condition method, and if
1961 still true, call the event's do_event method.
1963 Options are passed as a hashref or as a list of name-value pairs. Available
1970 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.
1974 "collect" (the default) or "pre-bill"
1978 "Current time" for the events.
1982 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)
1986 Only return events for the specified eventtable (by default, events of all eventtables are returned)
1990 Explicitly pass the objects to be tested (typically used with eventtable).
1994 Set to true to return the objects, but not actually insert them into the
2001 sub due_cust_event {
2003 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
2006 #my $DEBUG = $opt{'debug'}
2007 $opt{'debug'} ||= 0; # silence some warnings
2008 local($DEBUG) = $opt{'debug'}
2009 if $opt{'debug'} > $DEBUG;
2010 $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
2012 warn "$me due_cust_event called with options ".
2013 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
2016 $opt{'time'} ||= time;
2018 local $SIG{HUP} = 'IGNORE';
2019 local $SIG{INT} = 'IGNORE';
2020 local $SIG{QUIT} = 'IGNORE';
2021 local $SIG{TERM} = 'IGNORE';
2022 local $SIG{TSTP} = 'IGNORE';
2023 local $SIG{PIPE} = 'IGNORE';
2025 my $oldAutoCommit = $FS::UID::AutoCommit;
2026 local $FS::UID::AutoCommit = 0;
2029 $self->select_for_update #mutex
2030 unless $opt{testonly};
2033 # find possible events (initial search)
2036 my @cust_event = ();
2038 my @eventtable = $opt{'eventtable'}
2039 ? ( $opt{'eventtable'} )
2040 : FS::part_event->eventtables_runorder;
2042 my $check_freq = $opt{'check_freq'} || '1d';
2044 foreach my $eventtable ( @eventtable ) {
2047 if ( $opt{'objects'} ) {
2049 @objects = @{ $opt{'objects'} };
2051 } elsif ( $eventtable eq 'cust_main' ) {
2053 @objects = ( $self );
2057 my $cm_join = " LEFT JOIN cust_main USING ( custnum )";
2058 # linkage not needed here because FS::cust_main->$eventtable will
2061 #some false laziness w/Cron::bill bill_where
2063 my $join = FS::part_event_condition->join_conditions_sql( $eventtable);
2064 my $where = FS::part_event_condition->where_conditions_sql($eventtable,
2065 'time'=>$opt{'time'},
2067 $where = $where ? "AND $where" : '';
2069 my $are_part_event =
2070 "EXISTS ( SELECT 1 FROM part_event $join
2071 WHERE check_freq = '$check_freq'
2072 AND eventtable = '$eventtable'
2073 AND ( disabled = '' OR disabled IS NULL )
2079 @objects = $self->$eventtable(
2080 'addl_from' => $cm_join,
2081 'extra_sql' => " AND $are_part_event",
2083 } # if ( !$opt{objects} and $eventtable ne 'cust_main' )
2085 my @e_cust_event = ();
2087 my $linkage = FS::part_event->eventtables_cust_join->{$eventtable} || '';
2089 my $cross = "CROSS JOIN $eventtable $linkage";
2090 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
2091 unless $eventtable eq 'cust_main';
2093 foreach my $object ( @objects ) {
2095 #this first search uses the condition_sql magic for optimization.
2096 #the more possible events we can eliminate in this step the better
2098 my $cross_where = '';
2099 my $pkey = $object->primary_key;
2100 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
2102 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
2104 FS::part_event_condition->where_conditions_sql( $eventtable,
2105 'time'=>$opt{'time'}
2107 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
2109 $extra_sql = "AND $extra_sql" if $extra_sql;
2111 #here is the agent virtualization
2112 $extra_sql .= " AND ( part_event.agentnum IS NULL
2113 OR part_event.agentnum = ". $self->agentnum. ' )';
2115 $extra_sql .= " $order";
2117 warn "searching for events for $eventtable ". $object->$pkey. "\n"
2118 if $opt{'debug'} > 2;
2119 my @part_event = qsearch( {
2120 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
2121 'select' => 'part_event.*',
2122 'table' => 'part_event',
2123 'addl_from' => "$cross $join",
2124 'hashref' => { 'check_freq' => $check_freq,
2125 'eventtable' => $eventtable,
2128 'extra_sql' => "AND $cross_where $extra_sql",
2132 my $pkey = $object->primary_key;
2133 warn " ". scalar(@part_event).
2134 " possible events found for $eventtable ". $object->$pkey(). "\n";
2137 push @e_cust_event, map {
2138 $_->new_cust_event($object, 'time' => $opt{'time'})
2143 warn " ". scalar(@e_cust_event).
2144 " subtotal possible cust events found for $eventtable\n"
2147 push @cust_event, @e_cust_event;
2151 warn " ". scalar(@cust_event).
2152 " total possible cust events found in initial search\n"
2160 $opt{stage} ||= 'collect';
2162 grep { my $stage = $_->part_event->event_stage;
2163 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
2173 @cust_event = grep $_->test_conditions( 'stats_hashref' => \%unsat ),
2176 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
2179 warn " invalid conditions not eliminated with condition_sql:\n".
2180 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
2181 if keys %unsat && $DEBUG; # > 1;
2187 unless( $opt{testonly} ) {
2188 foreach my $cust_event ( @cust_event ) {
2190 my $error = $cust_event->insert();
2192 $dbh->rollback if $oldAutoCommit;
2199 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2205 warn " returning events: ". Dumper(@cust_event). "\n"
2212 =item apply_payments_and_credits [ OPTION => VALUE ... ]
2214 Applies unapplied payments and credits.
2216 In most cases, this new method should be used in place of sequential
2217 apply_payments and apply_credits methods.
2219 A hash of optional arguments may be passed. Currently "manual" is supported.
2220 If true, a payment receipt is sent instead of a statement when
2221 'payment_receipt_email' configuration option is set.
2223 If there is an error, returns the error, otherwise returns false.
2227 sub apply_payments_and_credits {
2228 my( $self, %options ) = @_;
2230 local $SIG{HUP} = 'IGNORE';
2231 local $SIG{INT} = 'IGNORE';
2232 local $SIG{QUIT} = 'IGNORE';
2233 local $SIG{TERM} = 'IGNORE';
2234 local $SIG{TSTP} = 'IGNORE';
2235 local $SIG{PIPE} = 'IGNORE';
2237 my $oldAutoCommit = $FS::UID::AutoCommit;
2238 local $FS::UID::AutoCommit = 0;
2241 $self->select_for_update; #mutex
2243 foreach my $cust_bill ( $self->open_cust_bill ) {
2244 my $error = $cust_bill->apply_payments_and_credits(%options);
2246 $dbh->rollback if $oldAutoCommit;
2247 return "Error applying: $error";
2251 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2256 =item apply_credits OPTION => VALUE ...
2258 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
2259 to outstanding invoice balances in chronological order (or reverse
2260 chronological order if the I<order> option is set to B<newest>) and returns the
2261 value of any remaining unapplied credits available for refund (see
2262 L<FS::cust_refund>).
2264 Dies if there is an error.
2272 local $SIG{HUP} = 'IGNORE';
2273 local $SIG{INT} = 'IGNORE';
2274 local $SIG{QUIT} = 'IGNORE';
2275 local $SIG{TERM} = 'IGNORE';
2276 local $SIG{TSTP} = 'IGNORE';
2277 local $SIG{PIPE} = 'IGNORE';
2279 my $oldAutoCommit = $FS::UID::AutoCommit;
2280 local $FS::UID::AutoCommit = 0;
2283 $self->select_for_update; #mutex
2285 unless ( $self->total_unapplied_credits ) {
2286 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2290 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
2291 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
2293 my @invoices = $self->open_cust_bill;
2294 @invoices = sort { $b->_date <=> $a->_date } @invoices
2295 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
2297 if ( $conf->exists('pkg-balances') ) {
2298 # limit @credits to those w/ a pkgnum grepped from $self
2300 foreach my $i (@invoices) {
2301 foreach my $li ( $i->cust_bill_pkg ) {
2302 $pkgnums{$li->pkgnum} = 1;
2305 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
2310 foreach my $cust_bill ( @invoices ) {
2312 if ( !defined($credit) || $credit->credited == 0) {
2313 $credit = pop @credits or last;
2317 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
2318 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
2320 $owed = $cust_bill->owed;
2322 unless ( $owed > 0 ) {
2323 push @credits, $credit;
2327 my $amount = min( $credit->credited, $owed );
2329 my $cust_credit_bill = new FS::cust_credit_bill ( {
2330 'crednum' => $credit->crednum,
2331 'invnum' => $cust_bill->invnum,
2332 'amount' => $amount,
2334 $cust_credit_bill->pkgnum( $credit->pkgnum )
2335 if $conf->exists('pkg-balances') && $credit->pkgnum;
2336 my $error = $cust_credit_bill->insert;
2338 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2342 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2346 my $total_unapplied_credits = $self->total_unapplied_credits;
2348 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2350 return $total_unapplied_credits;
2353 =item apply_payments [ OPTION => VALUE ... ]
2355 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2356 to outstanding invoice balances in chronological order.
2358 #and returns the value of any remaining unapplied payments.
2360 A hash of optional arguments may be passed. Currently "manual" is supported.
2361 If true, a payment receipt is sent instead of a statement when
2362 'payment_receipt_email' configuration option is set.
2364 Dies if there is an error.
2368 sub apply_payments {
2369 my( $self, %options ) = @_;
2371 local $SIG{HUP} = 'IGNORE';
2372 local $SIG{INT} = 'IGNORE';
2373 local $SIG{QUIT} = 'IGNORE';
2374 local $SIG{TERM} = 'IGNORE';
2375 local $SIG{TSTP} = 'IGNORE';
2376 local $SIG{PIPE} = 'IGNORE';
2378 my $oldAutoCommit = $FS::UID::AutoCommit;
2379 local $FS::UID::AutoCommit = 0;
2382 $self->select_for_update; #mutex
2386 my @payments = sort { $b->_date <=> $a->_date }
2387 grep { $_->unapplied > 0 }
2390 my @invoices = sort { $a->_date <=> $b->_date}
2391 grep { $_->owed > 0 }
2394 if ( $conf->exists('pkg-balances') ) {
2395 # limit @payments to those w/ a pkgnum grepped from $self
2397 foreach my $i (@invoices) {
2398 foreach my $li ( $i->cust_bill_pkg ) {
2399 $pkgnums{$li->pkgnum} = 1;
2402 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
2407 foreach my $cust_bill ( @invoices ) {
2409 if ( !defined($payment) || $payment->unapplied == 0 ) {
2410 $payment = pop @payments or last;
2414 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
2415 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
2417 $owed = $cust_bill->owed;
2419 unless ( $owed > 0 ) {
2420 push @payments, $payment;
2424 my $amount = min( $payment->unapplied, $owed );
2427 'paynum' => $payment->paynum,
2428 'invnum' => $cust_bill->invnum,
2429 'amount' => $amount,
2431 $cbp->{_date} = $payment->_date
2432 if $options{'manual'} && $options{'backdate_application'};
2433 my $cust_bill_pay = new FS::cust_bill_pay($cbp);
2434 $cust_bill_pay->pkgnum( $payment->pkgnum )
2435 if $conf->exists('pkg-balances') && $payment->pkgnum;
2436 my $error = $cust_bill_pay->insert(%options);
2438 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2442 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2446 my $total_unapplied_payments = $self->total_unapplied_payments;
2448 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2450 return $total_unapplied_payments;
2460 suspend_adjourned_pkgs
2461 unsuspend_resumed_pkgs
2464 (do_cust_event pre-bill)
2467 (vendor-only) _gather_taxes
2468 _omit_zero_value_bundles
2469 _handle_taxes (for fees)
2472 apply_payments_and_credits
2481 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>