1 package FS::cust_main::Billing;
4 use vars qw( $conf $DEBUG $me );
7 use List::Util qw( min );
9 use FS::Record qw( qsearch qsearchs dbdef );
10 use FS::Misc::DateTime qw( day_end );
13 use FS::cust_bill_pkg;
14 use FS::cust_bill_pkg_display;
15 use FS::cust_bill_pay;
16 use FS::cust_credit_bill;
17 use FS::cust_tax_adjustment;
19 use FS::tax_rate_location;
20 use FS::cust_bill_pkg_tax_location;
21 use FS::cust_bill_pkg_tax_rate_location;
23 use FS::part_event_condition;
25 use FS::FeeOrigin_Mixin;
28 # 1 is mostly method/subroutine entry and options
29 # 2 traces progress of some operations
30 # 3 is even more information including possibly sensitive data
32 $me = '[FS::cust_main::Billing]';
34 install_callback FS::UID sub {
36 #yes, need it for stuff below (prolly should be cached)
41 FS::cust_main::Billing - Billing mixin for cust_main
47 These methods are available on FS::cust_main objects.
53 =item bill_and_collect
55 Cancels and suspends any packages due, generates bills, applies payments and
56 credits, and applies collection events to run cards, send bills and notices,
59 By default, warns on errors and continues with the next operation (but see the
62 Options are passed as name-value pairs. Currently available options are:
68 Bills the customer as if it were that time. Specified as a UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion functions. For example:
72 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
76 Used in conjunction with the I<time> option, this option specifies the date of for the generated invoices. Other calculations, such as whether or not to generate the invoice in the first place, are not affected.
80 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
84 If set true, re-charges setup fees.
88 If set any errors prevent subsequent operations from continusing. If set
89 specifically to "return", returns the error (or false, if there is no error).
90 Any other true value causes errors to die.
94 Debugging level. Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
98 Optional FS::queue entry to receive status updates.
102 Options are passed to the B<bill> and B<collect> methods verbatim, so all
103 options of those methods are also available.
107 sub bill_and_collect {
108 my( $self, %options ) = @_;
110 my $log = FS::Log->new('FS::cust_main::Billing::bill_and_collect');
111 my %logopt = (object => $self);
112 $log->debug('start', %logopt);
116 #$options{actual_time} not $options{time} because freeside-daily -d is for
117 #pre-printing invoices
119 $options{'actual_time'} ||= time;
120 my $job = $options{'job'};
122 my $actual_time = ( $conf->exists('next-bill-ignore-time')
123 ? day_end( $options{actual_time} )
124 : $options{actual_time}
127 $job->update_statustext('0,cleaning expired packages') if $job;
128 $log->debug('canceling expired packages', %logopt);
129 $error = $self->cancel_expired_pkgs( $actual_time );
131 $error = "Error expiring custnum ". $self->custnum. ": $error";
132 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
133 elsif ( $options{fatal} ) { die $error; }
134 else { warn $error; }
137 $log->debug('suspending adjourned packages', %logopt);
138 $error = $self->suspend_adjourned_pkgs( $actual_time );
140 $error = "Error adjourning custnum ". $self->custnum. ": $error";
141 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
142 elsif ( $options{fatal} ) { die $error; }
143 else { warn $error; }
146 $log->debug('unsuspending resumed packages', %logopt);
147 $error = $self->unsuspend_resumed_pkgs( $actual_time );
149 $error = "Error resuming custnum ".$self->custnum. ": $error";
150 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
151 elsif ( $options{fatal} ) { die $error; }
152 else { warn $error; }
155 $job->update_statustext('20,billing packages') if $job;
156 $log->debug('billing packages', %logopt);
157 $error = $self->bill( %options );
159 $error = "Error billing custnum ". $self->custnum. ": $error";
160 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
161 elsif ( $options{fatal} ) { die $error; }
162 else { warn $error; }
165 $job->update_statustext('50,applying payments and credits') if $job;
166 $log->debug('applying payments and credits', %logopt);
167 $error = $self->apply_payments_and_credits;
169 $error = "Error applying custnum ". $self->custnum. ": $error";
170 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
171 elsif ( $options{fatal} ) { die $error; }
172 else { warn $error; }
175 unless ( $conf->exists('cancelled_cust-noevents')
176 && ! $self->num_ncancelled_pkgs
178 $job->update_statustext('70,running collection events') if $job;
179 $log->debug('running collection events', %logopt);
180 $error = $self->collect( %options );
182 $error = "Error collecting custnum ". $self->custnum. ": $error";
183 if ($options{fatal} && $options{fatal} eq 'return') { return $error; }
184 elsif ($options{fatal} ) { die $error; }
185 else { warn $error; }
189 $job->update_statustext('100,finished') if $job;
190 $log->debug('finish', %logopt);
196 sub cancel_expired_pkgs {
197 my ( $self, $time, %options ) = @_;
199 my @cancel_pkgs = $self->ncancelled_pkgs( {
200 'extra_sql' => " AND expire IS NOT NULL AND expire > 0 AND expire <= $time "
205 CUST_PKG: foreach my $cust_pkg ( @cancel_pkgs ) {
206 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
209 if ( $cust_pkg->change_to_pkgnum ) {
211 my $new_pkg = FS::cust_pkg->by_key($cust_pkg->change_to_pkgnum);
213 push @errors, 'can\'t change pkgnum '.$cust_pkg->pkgnum.' to pkgnum '.
214 $cust_pkg->change_to_pkgnum.'; not expiring';
217 $error = $cust_pkg->change( 'cust_pkg' => $new_pkg,
218 'unprotect_svcs' => 1 );
219 $error = '' if ref $error eq 'FS::cust_pkg';
221 } else { # just cancel it
222 $error = $cust_pkg->cancel($cpr ? ( 'reason' => $cpr->reasonnum,
223 'reason_otaker' => $cpr->otaker,
229 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
232 join(' / ', @errors);
236 sub suspend_adjourned_pkgs {
237 my ( $self, $time, %options ) = @_;
239 my @susp_pkgs = $self->ncancelled_pkgs( {
241 " AND ( susp IS NULL OR susp = 0 )
242 AND ( ( bill IS NOT NULL AND bill != 0 AND bill < $time )
243 OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
248 #only because there's no SQL test for is_prepaid :/
250 grep { ( $_->part_pkg->is_prepaid
255 && $_->adjourn <= $time
263 foreach my $cust_pkg ( @susp_pkgs ) {
264 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
265 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
266 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
267 'reason_otaker' => $cpr->otaker
271 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
274 join(' / ', @errors);
278 sub unsuspend_resumed_pkgs {
279 my ( $self, $time, %options ) = @_;
281 my @unsusp_pkgs = $self->ncancelled_pkgs( {
282 'extra_sql' => " AND resume IS NOT NULL AND resume > 0 AND resume <= $time "
287 foreach my $cust_pkg ( @unsusp_pkgs ) {
288 my $error = $cust_pkg->unsuspend( 'time' => $time );
289 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
292 join(' / ', @errors);
298 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
299 conjunction with the collect method by calling B<bill_and_collect>.
301 If there is an error, returns the error, otherwise returns false.
303 Options are passed as name-value pairs. Currently available options are:
309 If set true, re-charges setup fees.
313 If set true then only bill recurring charges, not setup, usage, one time
318 If set, then override the normal frequency and look for a part_pkg_discount
319 to take at that frequency. This is appropriate only when the normal
320 frequency for all packages is monthly, and is an error otherwise. Use
321 C<pkg_list> to limit the set of packages included in billing.
325 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:
329 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
333 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
335 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
339 A hashref of pkgparts to exclude from this billing run (can also be specified as a comma-separated scalar).
343 Do not bill prepaid packages. Used by freeside-daily.
347 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.
351 This boolean value informs the us that the package is being cancelled. This
352 typically might mean not charging the normal recurring fee but only usage
353 fees since the last billing. Setup charges may be charged. Not all package
354 plans support this feature (they tend to charge 0).
358 Prevent the resetting of usage limits during this call.
362 Do not save the generated bill in the database. Useful with return_bill
366 A list reference on which the generated bill(s) will be returned.
370 Optional terms to be printed on this invoice. Otherwise, customer-specific
371 terms or the default terms are used.
378 my( $self, %options ) = @_;
380 return '' if $self->payby eq 'COMP';
382 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
383 my $log = FS::Log->new('FS::cust_main::Billing::bill');
384 my %logopt = (object => $self);
386 $log->debug('start', %logopt);
387 warn "$me bill customer ". $self->custnum. "\n"
390 my $time = $options{'time'} || time;
391 my $invoice_time = $options{'invoice_time'} || $time;
393 my $cmp_time = ( $conf->exists('next-bill-ignore-time')
398 $options{'not_pkgpart'} ||= {};
399 $options{'not_pkgpart'} = { map { $_ => 1 }
400 split(/\s*,\s*/, $options{'not_pkgpart'})
402 unless ref($options{'not_pkgpart'});
404 local $SIG{HUP} = 'IGNORE';
405 local $SIG{INT} = 'IGNORE';
406 local $SIG{QUIT} = 'IGNORE';
407 local $SIG{TERM} = 'IGNORE';
408 local $SIG{TSTP} = 'IGNORE';
409 local $SIG{PIPE} = 'IGNORE';
411 my $oldAutoCommit = $FS::UID::AutoCommit;
412 local $FS::UID::AutoCommit = 0;
415 $log->debug('acquiring lock', %logopt);
416 warn "$me acquiring lock on customer ". $self->custnum. "\n"
419 $self->select_for_update; #mutex
421 $log->debug('running pre-bill events', %logopt);
422 warn "$me running pre-bill events for customer ". $self->custnum. "\n"
425 my $error = $self->do_cust_event(
426 'debug' => ( $options{'debug'} || 0 ),
427 'time' => $invoice_time,
428 'check_freq' => $options{'check_freq'},
429 'stage' => 'pre-bill',
431 unless $options{no_commit};
433 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
437 $log->debug('done running pre-bill events', %logopt);
438 warn "$me done running pre-bill events for customer ". $self->custnum. "\n"
441 #keep auto-charge and non-auto-charge line items separate
442 my @passes = ( '', 'no_auto' );
444 my %cust_bill_pkg = map { $_ => [] } @passes;
447 # find the packages which are due for billing, find out how much they are
448 # & generate invoice database.
451 my %total_setup = map { my $z = 0; $_ => \$z; } @passes;
452 my %total_recur = map { my $z = 0; $_ => \$z; } @passes;
454 my %taxlisthash = map { $_ => {} } @passes;
456 my @precommit_hooks = ();
458 $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ]; #param checks?
460 foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
462 next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
464 my $part_pkg = $cust_pkg->part_pkg;
466 next if $options{'no_prepaid'} && $part_pkg->is_prepaid;
468 $log->debug('bill package '. $cust_pkg->pkgnum, %logopt);
469 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG;
471 #? to avoid use of uninitialized value errors... ?
472 $cust_pkg->setfield('bill', '')
473 unless defined($cust_pkg->bill);
475 my $real_pkgpart = $cust_pkg->pkgpart;
476 my %hash = $cust_pkg->hash;
478 # we could implement this bit as FS::part_pkg::has_hidden, but we already
479 # suffer from performance issues
480 $options{has_hidden} = 0;
481 my @part_pkg = $part_pkg->self_and_bill_linked;
482 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
484 # if this package was changed from another package,
485 # and it hasn't been billed since then,
486 # and package balances are enabled,
487 if ( $cust_pkg->change_pkgnum
488 and $cust_pkg->change_date >= ($cust_pkg->last_bill || 0)
489 and $cust_pkg->change_date < $invoice_time
490 and $conf->exists('pkg-balances') )
492 # _transfer_balance will also create the appropriate credit
493 my @transfer_items = $self->_transfer_balance($cust_pkg);
494 # $part_pkg[0] is the "real" part_pkg
495 my $pass = ($cust_pkg->no_auto || $part_pkg[0]->no_auto) ?
497 push @{ $cust_bill_pkg{$pass} }, @transfer_items;
498 # treating this as recur, just because most charges are recur...
499 ${$total_recur{$pass}} += $_->recur foreach @transfer_items;
501 # currently not considering separate_bill here, as it's for
502 # one-time charges only
505 foreach my $part_pkg ( @part_pkg ) {
507 $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
510 if ( $cust_pkg->separate_bill ) {
511 # if no_auto is also set, that's fine. we just need to not have
512 # invoices that are both auto and no_auto, and since the package
513 # gets an invoice all to itself, it will only be one or the other.
514 $pass = $cust_pkg->pkgnum;
515 if (!exists $cust_bill_pkg{$pass}) { # it may not exist yet
517 $total_setup{$pass} = do { my $z = 0; \$z };
518 $total_recur{$pass} = do { my $z = 0; \$z };
519 $taxlisthash{$pass} = {};
520 $cust_bill_pkg{$pass} = [];
522 } elsif ( ($cust_pkg->no_auto || $part_pkg->no_auto) ) {
526 my $next_bill = $cust_pkg->getfield('bill') || 0;
528 # let this run once if this is the last bill upon cancellation
529 while ( $next_bill <= $cmp_time or $options{cancel} ) {
531 $self->_make_lines( 'part_pkg' => $part_pkg,
532 'cust_pkg' => $cust_pkg,
533 'precommit_hooks' => \@precommit_hooks,
534 'line_items' => $cust_bill_pkg{$pass},
535 'setup' => $total_setup{$pass},
536 'recur' => $total_recur{$pass},
537 'tax_matrix' => $taxlisthash{$pass},
539 'real_pkgpart' => $real_pkgpart,
540 'options' => \%options,
543 # Stop if anything goes wrong
546 # or if we're not incrementing the bill date.
547 last if ($cust_pkg->getfield('bill') || 0) == $next_bill;
549 # or if we're letting it run only once
550 last if $options{cancel};
552 $next_bill = $cust_pkg->getfield('bill') || 0;
554 #stop if -o was passed to freeside-daily
555 last if $options{'one_recur'};
558 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
562 } #foreach my $part_pkg
564 } #foreach my $cust_pkg
566 foreach my $pass (@passes) { # keys %cust_bill_pkg )
568 my @cust_bill_pkg = _omit_zero_value_bundles(@{ $cust_bill_pkg{$pass} });
570 warn "$me billing pass $pass\n"
571 #.Dumper(\@cust_bill_pkg)."\n"
578 my @pending_fees = FS::FeeOrigin_Mixin->by_cust($self->custnum,
579 hashref => { 'billpkgnum' => '' }
581 warn "$me found pending fees:\n".Dumper(\@pending_fees)."\n"
582 if @pending_fees and $DEBUG > 1;
584 # determine whether to generate an invoice
585 my $generate_bill = scalar(@cust_bill_pkg) > 0;
587 foreach my $fee (@pending_fees) {
588 $generate_bill = 1 unless $fee->nextbill;
591 # don't create an invoice with no line items, or where the only line
592 # items are fees that are supposed to be held until the next invoice
593 next if !$generate_bill;
597 foreach my $fee_origin (@pending_fees) {
598 my $part_fee = $fee_origin->part_fee;
600 # check whether the fee is applicable before doing anything expensive:
602 # if the fee def belongs to a different agent, don't charge the fee.
603 # event conditions should prevent this, but just in case they don't,
605 if ( $part_fee->agentnum and $part_fee->agentnum != $self->agentnum ) {
606 warn "tried to charge fee#".$part_fee->feepart .
607 " on customer#".$self->custnum." from a different agent.\n";
610 # also skip if it's disabled
611 next if $part_fee->disabled eq 'Y';
613 # Decide which invoice to base the fee on.
614 my $cust_bill = $fee_origin->cust_bill;
616 # Then link it to the current invoice. This isn't the real cust_bill
617 # object that will be inserted--in particular there are no taxes yet.
618 # If you want to charge a fee on the total invoice amount including
619 # taxes, you have to put the fee on the next invoice.
620 $cust_bill = FS::cust_bill->new({
621 'custnum' => $self->custnum,
622 'cust_bill_pkg' => \@cust_bill_pkg,
623 'charged' => ${ $total_setup{$pass} } +
624 ${ $total_recur{$pass} },
627 # If the origin is for a specific package, then only apply the fee to
628 # line items from that package.
629 if ( my $cust_pkg = $fee_origin->cust_pkg ) {
630 my @charge_fee_on_item;
631 my $charge_fee_on_amount = 0;
632 foreach (@cust_bill_pkg) {
633 if ($_->pkgnum == $cust_pkg->pkgnum) {
634 push @charge_fee_on_item, $_;
635 $charge_fee_on_amount += $_->setup + $_->recur;
638 $cust_bill->set('cust_bill_pkg', \@charge_fee_on_item);
639 $cust_bill->set('charged', $charge_fee_on_amount);
642 } # $cust_bill is now set
644 my $fee_item = $part_fee->lineitem($cust_bill) or next;
645 # link this so that we can clear the marker on inserting the line item
646 $fee_item->set('fee_origin', $fee_origin);
647 push @fee_items, $fee_item;
651 # add fees to the invoice
652 foreach my $fee_item (@fee_items) {
654 push @cust_bill_pkg, $fee_item;
655 ${ $total_setup{$pass} } += $fee_item->setup;
656 ${ $total_recur{$pass} } += $fee_item->recur;
658 my $part_fee = $fee_item->part_fee;
659 my $fee_location = $self->ship_location; # I think?
661 my $error = $self->_handle_taxes(
664 location => $fee_location
665 # probably not right to pass cancel => 1 for fees
667 return $error if $error;
671 # XXX implementation of fees is supposed to make this go away...
672 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
673 !$conf->exists('postal_invoice-recurring_only')
677 my $postal_pkg = $self->charge_postal_fee();
678 if ( $postal_pkg && !ref( $postal_pkg ) ) {
680 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
681 return "can't charge postal invoice fee for customer ".
682 $self->custnum. ": $postal_pkg";
684 } elsif ( $postal_pkg ) {
686 my $real_pkgpart = $postal_pkg->pkgpart;
687 # we could implement this bit as FS::part_pkg::has_hidden, but we already
688 # suffer from performance issues
689 $options{has_hidden} = 0;
690 my @part_pkg = $postal_pkg->part_pkg->self_and_bill_linked;
691 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
693 foreach my $part_pkg ( @part_pkg ) {
694 my %postal_options = %options;
695 delete $postal_options{cancel};
697 $self->_make_lines( 'part_pkg' => $part_pkg,
698 'cust_pkg' => $postal_pkg,
699 'precommit_hooks' => \@precommit_hooks,
700 'line_items' => \@cust_bill_pkg,
701 'setup' => $total_setup{$pass},
702 'recur' => $total_recur{$pass},
703 'tax_matrix' => $taxlisthash{$pass},
705 'real_pkgpart' => $real_pkgpart,
706 'options' => \%postal_options,
709 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
714 # it's silly to have a zero value postal_pkg, but....
715 @cust_bill_pkg = _omit_zero_value_bundles(@cust_bill_pkg);
721 my $listref_or_error =
722 $self->calculate_taxes( \@cust_bill_pkg, $taxlisthash{$pass}, $invoice_time);
724 unless ( ref( $listref_or_error ) ) {
725 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
726 return $listref_or_error;
729 foreach my $taxline ( @$listref_or_error ) {
730 ${ $total_setup{$pass} } =
731 sprintf('%.2f', ${ $total_setup{$pass} } + $taxline->setup );
732 push @cust_bill_pkg, $taxline;
736 warn "adding tax adjustments...\n" if $DEBUG > 2;
737 foreach my $cust_tax_adjustment (
738 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
744 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
746 my $itemdesc = $cust_tax_adjustment->taxname;
747 $itemdesc = '' if $itemdesc eq 'Tax';
749 push @cust_bill_pkg, new FS::cust_bill_pkg {
755 'itemdesc' => $itemdesc,
756 'itemcomment' => $cust_tax_adjustment->comment,
757 'cust_tax_adjustment' => $cust_tax_adjustment,
758 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
763 my $charged = sprintf('%.2f', ${ $total_setup{$pass} } + ${ $total_recur{$pass} } );
765 my $balance = $self->balance;
767 my $previous_bill = qsearchs({ 'table' => 'cust_bill',
768 'hashref' => { custnum=>$self->custnum },
769 'extra_sql' => 'ORDER BY _date DESC LIMIT 1',
771 my $previous_balance =
773 ? ( $previous_bill->billing_balance + $previous_bill->charged )
776 $log->debug('creating the new invoice', %logopt);
777 warn "creating the new invoice\n" if $DEBUG;
778 #create the new invoice
779 my $cust_bill = new FS::cust_bill ( {
780 'custnum' => $self->custnum,
781 '_date' => $invoice_time,
782 'charged' => $charged,
783 'billing_balance' => $balance,
784 'previous_balance' => $previous_balance,
785 'invoice_terms' => $options{'invoice_terms'},
786 'cust_bill_pkg' => \@cust_bill_pkg,
788 $error = $cust_bill->insert unless $options{no_commit};
790 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
791 return "can't create invoice for customer #". $self->custnum. ": $error";
793 push @{$options{return_bill}}, $cust_bill if $options{return_bill};
795 } #foreach my $pass ( keys %cust_bill_pkg )
797 foreach my $hook ( @precommit_hooks ) {
800 } unless $options{no_commit};
802 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
803 return "$@ running precommit hook $hook\n";
807 $dbh->commit or die $dbh->errstr if $oldAutoCommit && !$options{no_commit};
812 #discard bundled packages of 0 value
813 # XXX we should reconsider whether we even need this
814 sub _omit_zero_value_bundles {
819 my $discount_show_always = $conf->exists('discount-show-always');
822 # Sort @in the same way we do during invoice rendering, so we can identify
823 # bundles. See FS::Template_Mixin::_items_nontax.
824 @in = sort { $a->pkgnum <=> $b->pkgnum or
825 $a->sdate <=> $b->sdate or
826 ($a->pkgpart_override ? 0 : -1) or
827 ($b->pkgpart_override ? 0 : 1) or
828 $b->hidden cmp $a->hidden or
829 $a->pkgpart_override <=> $b->pkgpart_override
832 # this is a pack-and-deliver pattern. every time there's a cust_bill_pkg
833 # _without_ pkgpart_override, that's the start of the new bundle. if there's
834 # an existing bundle, and it contains a nonzero amount (or a zero amount
835 # that's displayable anyway), push all line items in the bundle.
836 foreach my $cust_bill_pkg ( @in ) {
838 if (scalar(@bundle) and !$cust_bill_pkg->pkgpart_override) {
839 # ship out this bundle and reset it
847 # add this item to the current bundle
848 push @bundle, $cust_bill_pkg;
850 # determine if it makes the bundle displayable
851 if ( $cust_bill_pkg->setup > 0
852 or $cust_bill_pkg->recur > 0
853 or $cust_bill_pkg->setup_show_zero
854 or $cust_bill_pkg->recur_show_zero
855 or ($discount_show_always
856 and scalar(@{ $cust_bill_pkg->get('discounts')})
868 warn " _omit_zero_value_bundles: ". scalar(@in).
869 '->'. scalar(@out). "\n" #. Dumper(@out). "\n"
875 =item calculate_taxes LINEITEMREF TAXHASHREF INVOICE_TIME
877 Generates tax line items (see L<FS::cust_bill_pkg>) for this customer.
878 Usually used internally by bill method B<bill>.
880 If there is an error, returns the error, otherwise returns reference to a
881 list of line items suitable for insertion.
887 An array ref of the line items being billed.
891 A strange beast. The keys to this hash are internal identifiers consisting
892 of the name of the tax object type, a space, and its unique identifier ( e.g.
893 'cust_main_county 23' ). The values of the hash are listrefs. The first
894 item in the list is the tax object. The remaining items are either line
895 items or floating point values (currency amounts).
897 The taxes are calculated on this entity. Calculated exemption records are
898 transferred to the LINEITEMREF items on the assumption that they are related.
904 This specifies the date appearing on the associated invoice. Some
905 jurisdictions (i.e. Texas) have tax exemptions which are date sensitive.
911 sub calculate_taxes {
912 my ($self, $cust_bill_pkg, $taxlisthash, $invoice_time) = @_;
914 # $taxlisthash is a hashref
915 # keys are identifiers, values are arrayrefs
916 # each arrayref starts with a tax object (cust_main_county or tax_rate)
917 # then a cust_bill_pkg object the tax applies to, then the charge class
918 # on that object (setup, recur, a usage class number, or '')
919 # For internal taxes the charge class is always undef.
921 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
923 warn "$me calculate_taxes\n"
924 #.Dumper($self, $cust_bill_pkg, $taxlisthash, $invoice_time). "\n"
927 my $custnum = $self->custnum;
928 # The main tax accumulator. One bin for each tax name (itemdesc).
929 # For each subdivision of tax under this name, push a cust_bill_pkg item
930 # for the calculated tax into the arrayref.
932 # values are arrayrefs of tax lines
935 # keys are taxlisthash keys (internal identifiers)
936 # values are (cumulative) amounts
939 # keys are taxlisthash keys
940 # values are arrayrefs of cust_tax_exempt_pkg objects
943 # For tax on tax calculation, we need to remember which taxable items
944 # (and charge classes) had which taxes applied to them.
946 # keys are cust_bill_pkg objects (taxable items)
947 # values are hashrefs
948 # keys are charge classes
949 # values are hashrefs
950 # keys are taxnums (in tax_rate only; cust_main_county doesn't use this)
951 # values are the taxlines generated for those taxes
952 tie my %item_has_tax, 'Tie::RefHash',
953 map { $_ => {} } @$cust_bill_pkg;
955 foreach my $tax_id ( keys %$taxlisthash ) {
956 # $tax_id: the identifier of the tax we are calculating in this pass
958 my $taxables = $taxlisthash->{$tax_id};
959 my $tax_object = shift @$taxables;
960 my $taxnum = $tax_object->taxnum;
961 # $tax_object is a cust_main_county or tax_rate
962 # (with billpkgnum, pkgnum, locationnum set)
963 # the rest of @{ $taxlisthash->{$tax_id} } is cust_bill_pkg objects,
964 # optionally followed by their charge classes.
965 warn "found ". $tax_object->taxname. " as $tax_id\n" if $DEBUG > 2;
967 # taxline calculates the tax on all cust_bill_pkgs in the
968 # first (arrayref) argument.
970 # Note that non-monthly exemptions have already been calculated and
971 # attached to the items. Monthly exemptions will be attached in this
973 my $exemptions = $tax_exemption{$tax_id} ||= [];
974 if ( $tax_object->isa('FS::tax_rate') ) { # EXTERNAL TAXES
975 # STILL have tax_rate-specific crap in here...
976 my @taxlines = $tax_object->taxline( $taxables,
977 'custnum' => $custnum,
978 'invoice_time' => $invoice_time,
979 'exemptions' => $exemptions,
982 if (!ref $taxlines[0]) {
983 # it's an error string
984 warn "error evaluating $tax_id on custnum $custnum\n";
987 foreach my $taxline (@taxlines) {
988 push @{ $taxname{ $taxline->itemdesc } }, $taxline;
989 my $link = $taxline->get('cust_bill_pkg_tax_rate_location')->[0];
990 my $taxable_item = $link->taxable_cust_bill_pkg;
991 $item_has_tax{$taxable_item}{$taxline->_class}{$taxnum} = $taxline;
994 } else { # INTERNAL TAXES
995 # we can do this in a single taxline, because it's not stupid
997 my $taxline = $tax_object->taxline( $taxables,
998 'custnum' => $custnum,
999 'invoice_time' => $invoice_time,
1000 'exemptions' => $exemptions,
1003 if (!ref $taxline) {
1004 # it's an error string
1005 warn "error evaluating $tax_id on custnum $custnum\n";
1008 # if the calculated tax is zero, don't even keep it
1009 next if $taxline->setup < 0.001;
1010 push @{ $taxname{ $taxline->itemdesc } }, $taxline;
1013 $DB::single = 1; # XXX
1015 # all first-tier taxes are calculated. now for tax on tax:
1017 foreach my $taxable_item ( @$cust_bill_pkg ) {
1018 # taxes that apply to this item
1019 my $this_has_tax = $item_has_tax{$taxable_item};
1021 my $location = $taxable_item->tax_location;
1023 foreach my $charge_class (keys %$this_has_tax) {
1024 # taxes that apply to this item and charge class
1025 my $this_class_has_tax = $this_has_tax->{$charge_class};
1026 foreach my $taxnum (keys %$this_class_has_tax) {
1028 # for each tax item that was calculated in phase 1, get the
1030 my $tax_object = FS::tax_rate->by_key($taxnum);
1031 # and find all taxes that apply to it in this location
1032 my @tot = $tax_object->tax_on_tax( $location );
1034 warn "found possible taxed taxnum $taxnum\n"
1036 # Calculate ToT separately for each taxable item and class, and only
1037 # if _that class on the item_ is already taxed under the ToT. This is
1039 # See RT#5243 and RT#36380.
1040 foreach my $tot (@tot) {
1041 my $totnum = $tot->taxnum;
1042 warn "checking taxnum $totnum which we call ". $tot->taxname ."\n"
1044 # note: if the _null class_ on this item is taxed under the ToT,
1045 # then this specific class is taxed also (because null class
1046 # includes all classes) and so ToT is applicable.
1048 exists $this_class_has_tax->{ $totnum }
1049 or exists $this_has_tax->{''}{ $totnum }
1052 warn "calculating tax on tax: taxnum $totnum on $taxnum\n"
1054 my @taxlines = $tot->taxline(
1055 $this_class_has_tax->{ $taxnum }, # the first-stage tax
1056 'custnum' => $custnum,
1057 'invoice_time' => $invoice_time,
1059 next if (!@taxlines); # it didn't apply after all
1060 if (!ref($taxlines[0])) {
1061 warn "error evaluating taxnum $totnum TOT on custnum $custnum\n";
1062 return $taxlines[0];
1064 foreach my $taxline (@taxlines) {
1065 push @{ $taxname{ $taxline->itemdesc } }, $taxline;
1068 } # foreach my $tot (tax-on-tax rate definition)
1069 } # foreach $taxnum (first-tier rate definition)
1070 } # foreach $charge_class
1071 } # foreach $taxable_item
1073 #consolidate and create tax line items
1074 warn "consolidating and generating...\n" if $DEBUG > 2;
1075 my %final_tax_items; # taxname => item
1076 foreach my $taxname ( keys %taxname ) {
1077 my @cust_bill_pkg_tax_location;
1078 my @cust_bill_pkg_tax_rate_location;
1079 my $tax_cust_bill_pkg = FS::cust_bill_pkg->new({
1084 'itemdesc' => $taxname,
1085 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
1086 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
1091 warn "adding $taxname\n" if $DEBUG > 1;
1092 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
1093 next if $taxitem->get('setup') == 0;
1094 # if ( ref($taxitem) eq 'FS::cust_bill_pkg' ) # always true
1095 # then we need to transfer the amount and the links from the
1096 # line item to the new one we're creating.
1097 $tax_total += $taxitem->setup;
1099 $taxitem->get('cust_bill_pkg_tax_location') ||
1100 $taxitem->get('cust_bill_pkg_tax_rate_location') ||
1103 foreach my $link ( @links ) {
1104 $link->set('tax_cust_bill_pkg', $tax_cust_bill_pkg);
1105 if ($link->isa('FS::cust_bill_pkg_tax_location')) {
1106 push @cust_bill_pkg_tax_location, $link;
1107 } elsif ($link->isa('FS::cust_bill_pkg_tax_rate_location')) {
1108 push @cust_bill_pkg_tax_rate_location, $link;
1112 next unless $tax_total;
1114 # we should really neverround this up...I guess it's okay if taxline
1115 # already returns amounts with 2 decimal places
1116 $tax_total = sprintf('%.2f', $tax_total );
1117 $tax_cust_bill_pkg->set('setup', $tax_total);
1119 my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
1125 if ( $pkg_category and
1126 $conf->config('invoice_latexsummary') ||
1127 $conf->config('invoice_htmlsummary')
1131 my %hash = ( 'section' => $pkg_category->categoryname );
1132 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
1135 $tax_cust_bill_pkg->set('display', \@display);
1137 $final_tax_items{$taxname} = $tax_cust_bill_pkg;
1138 } # foreach $taxname
1140 # fix ToT backlinks for taxes that have been consolidated
1141 # (has to be done in a separate pass)
1142 foreach my $tax_item (values %final_tax_items) {
1143 foreach my $taxable_link (@{ $tax_item->cust_bill_pkg_tax_rate_location }) {
1144 my $taxed_item = $taxable_link->taxable_cust_bill_pkg;
1145 next if $taxed_item->pkgnum > 0; # primary taxes
1146 my $taxname = $taxed_item->itemdesc;
1147 $taxable_link->set('taxable_cust_bill_pkg', $final_tax_items{ $taxname });
1151 [ values %final_tax_items ]
1155 my ($self, %params) = @_;
1157 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1159 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
1160 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
1161 my $cust_location = $cust_pkg->tax_location;
1162 my $precommit_hooks = $params{precommit_hooks} or die "no precommit_hooks specified";
1163 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
1164 my $total_setup = $params{setup} or die "no setup accumulator specified";
1165 my $total_recur = $params{recur} or die "no recur accumulator specified";
1166 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
1167 my $time = $params{'time'} or die "no time specified";
1168 my (%options) = %{$params{options}};
1170 if ( $part_pkg->freq ne '1' and ($options{'freq_override'} || 0) > 0 ) {
1171 # this should never happen
1172 die 'freq_override billing attempted on non-monthly package '.
1177 my $real_pkgpart = $params{real_pkgpart};
1178 my %hash = $cust_pkg->hash;
1179 my $old_cust_pkg = new FS::cust_pkg \%hash;
1184 $cust_pkg->pkgpart($part_pkg->pkgpart);
1186 my $cmp_time = ( $conf->exists('next-bill-ignore-time')
1197 my @setup_discounts = ();
1198 my %setup_param = ( 'discounts' => \@setup_discounts,
1199 'real_pkgpart' => $params{real_pkgpart}
1201 # Conditions for setting setup date and charging the setup fee:
1202 # - this is not a recurring-only billing run
1203 # - and the package is not currently being canceled
1204 # - and, unless we're specifically told otherwise via 'resetup':
1205 # - it doesn't already HAVE a setup date
1206 # - or a start date in the future
1207 # - and it's not suspended
1208 # - and it doesn't have an expire date in the past
1210 # The "disable_setup_suspended" option is now obsolete; we never set the
1211 # setup date on a suspended package.
1212 if ( ! $options{recurring_only}
1213 and ! $options{cancel}
1214 and ( $options{'resetup'}
1215 || ( ! $cust_pkg->setup
1216 && ( ! $cust_pkg->start_date
1217 || $cust_pkg->start_date <= $cmp_time
1219 && ( ! $cust_pkg->getfield('susp') )
1222 and ( ! $cust_pkg->expire
1223 || $cust_pkg->expire > $cmp_time )
1227 warn " bill setup\n" if $DEBUG > 1;
1229 unless ( $cust_pkg->waive_setup ) {
1232 $setup = eval { $cust_pkg->calc_setup( $time, \@details, \%setup_param ) };
1233 return "$@ running calc_setup for $cust_pkg\n"
1236 # Only increment unitsetup here if there IS a setup fee.
1237 # prorate_defer_bill may cause calc_setup on a setup-stage package
1238 # to return zero, and the setup fee to be charged later. (This happens
1239 # when it's first billed on the prorate cutoff day. RT#31276.)
1241 $unitsetup = $cust_pkg->base_setup()
1246 $cust_pkg->setfield('setup', $time)
1247 unless $cust_pkg->setup;
1248 #do need it, but it won't get written to the db
1249 #|| $cust_pkg->pkgpart != $real_pkgpart;
1251 $cust_pkg->setfield('start_date', '')
1252 if $cust_pkg->start_date;
1257 # bill recurring fee
1262 my @recur_discounts = ();
1265 my $override_quantity;
1267 # Conditions for billing the recurring fee:
1268 # - the package doesn't have a future start date
1269 # - and it's not suspended
1270 # - unless suspend_bill is enabled on the package or package def
1271 # - but still not, if the package is on hold
1272 # - or it's suspended for a delayed cancellation
1273 # - and its next bill date is in the past
1274 # - or it doesn't have a next bill date yet
1275 # - or it's a one-time charge
1276 # - or it's a CDR plan with the "bill_every_call" option
1277 # - or it's being canceled
1278 # - and it doesn't have an expire date in the past (this can happen with
1280 # - again, unless it's being canceled
1281 if ( ! $cust_pkg->start_date
1284 || ( $cust_pkg->susp != $cust_pkg->order_date
1285 && ( $cust_pkg->option('suspend_bill',1)
1286 || ( $part_pkg->option('suspend_bill', 1)
1287 && ! $cust_pkg->option('no_suspend_bill',1)
1291 || $cust_pkg->is_status_delay_cancel
1294 ( $part_pkg->freq ne '0' && ( $cust_pkg->bill || 0 ) <= $cmp_time )
1295 || ( $part_pkg->plan eq 'voip_cdr'
1296 && $part_pkg->option('bill_every_call')
1301 ( ! $cust_pkg->expire
1302 || $cust_pkg->expire > $cmp_time
1307 # XXX should this be a package event? probably. events are called
1308 # at collection time at the moment, though...
1309 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
1310 if $part_pkg->can('reset_usage') && !$options{'no_usage_reset'};
1311 #don't want to reset usage just cause we want a line item??
1312 #&& $part_pkg->pkgpart == $real_pkgpart;
1314 warn " bill recur\n" if $DEBUG > 1;
1317 # XXX shared with $recur_prog
1318 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
1322 #over two params! lets at least switch to a hashref for the rest...
1323 my $increment_next_bill = ( $part_pkg->freq ne '0'
1324 && ( $cust_pkg->getfield('bill') || 0 ) <= $cmp_time
1325 && !$options{cancel}
1327 my %param = ( %setup_param,
1328 'precommit_hooks' => $precommit_hooks,
1329 'increment_next_bill' => $increment_next_bill,
1330 'discounts' => \@recur_discounts,
1331 'real_pkgpart' => $real_pkgpart,
1332 'freq_override' => $options{freq_override} || '',
1336 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
1338 # There may be some part_pkg for which this is wrong. Only those
1339 # which can_discount are supported.
1340 # (the UI should prevent adding discounts to these at the moment)
1342 warn "calling $method on cust_pkg ". $cust_pkg->pkgnum.
1343 " for pkgpart ". $cust_pkg->pkgpart.
1344 " with params ". join(' / ', map "$_=>$param{$_}", keys %param). "\n"
1347 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
1348 return "$@ running $method for $cust_pkg\n"
1351 if ($recur eq 'NOTHING') {
1352 # then calc_cancel (or calc_recur but that's not used) has declined to
1353 # generate a recurring lineitem at all. treat this as zero, but also
1354 # try not to generate a lineitem.
1360 $unitrecur = $cust_pkg->base_recur( \$sdate ) || $recur; #XXX uuh, better
1362 if ( $param{'override_quantity'} ) {
1363 $override_quantity = $param{'override_quantity'};
1364 $unitrecur = $recur / $override_quantity;
1367 if ( $increment_next_bill ) {
1371 if ( my $main_pkg = $cust_pkg->main_pkg ) {
1372 # supplemental package
1373 # to keep in sync with the main package, simulate billing at
1375 my $main_pkg_freq = $main_pkg->part_pkg->freq;
1376 my $supp_pkg_freq = $part_pkg->freq;
1377 my $ratio = $supp_pkg_freq / $main_pkg_freq;
1378 if ( $ratio != int($ratio) ) {
1379 # the UI should prevent setting up packages like this, but just
1381 return "supplemental package period is not an integer multiple of main package period";
1383 $next_bill = $sdate;
1385 $next_bill = $part_pkg->add_freq( $next_bill, $main_pkg_freq );
1390 $next_bill = $part_pkg->add_freq($sdate, $options{freq_override} || 0);
1391 return "unparsable frequency: ".
1392 ($options{freq_override} || $part_pkg->freq)
1393 if $next_bill == -1;
1396 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
1397 # only for figuring next bill date, nothing else, so, reset $sdate again
1399 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1400 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
1401 $cust_pkg->last_bill($sdate);
1403 $cust_pkg->setfield('bill', $next_bill );
1407 if ( $param{'setup_fee'} ) {
1408 # Add an additional setup fee at the billing stage.
1409 # Used for prorate_defer_bill.
1410 $setup += $param{'setup_fee'};
1411 $unitsetup = $cust_pkg->base_setup();
1415 if ( defined $param{'discount_left_setup'} ) {
1416 foreach my $discount_setup ( values %{$param{'discount_left_setup'}} ) {
1417 $setup -= $discount_setup;
1421 } # end of recurring fee
1423 warn "\$setup is undefined" unless defined($setup);
1424 warn "\$recur is undefined" unless defined($recur);
1425 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1428 # If there's line items, create em cust_bill_pkg records
1429 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
1434 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
1435 # hmm.. and if just the options are modified in some weird price plan?
1437 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
1440 my $error = $cust_pkg->replace( $old_cust_pkg,
1441 'depend_jobnum'=>$options{depend_jobnum},
1442 'options' => { $cust_pkg->options },
1444 unless $options{no_commit};
1445 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
1446 if $error; #just in case
1449 $setup = sprintf( "%.2f", $setup );
1450 $recur = sprintf( "%.2f", $recur );
1451 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
1452 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1454 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
1455 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
1458 my $discount_show_always = $conf->exists('discount-show-always')
1459 && ( ($setup == 0 && scalar(@setup_discounts))
1460 || ($recur == 0 && scalar(@recur_discounts))
1465 || (!$part_pkg->hidden && $options{has_hidden}) #include some $0 lines
1466 || $discount_show_always
1467 || ($setup == 0 && $cust_pkg->_X_show_zero('setup'))
1468 || ($recur == 0 && $cust_pkg->_X_show_zero('recur'))
1472 warn " charges (setup=$setup, recur=$recur); adding line items\n"
1475 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
1477 warn " adding customer package invoice detail: $_\n"
1478 foreach @cust_pkg_detail;
1480 push @details, @cust_pkg_detail;
1482 my $cust_bill_pkg = new FS::cust_bill_pkg {
1483 'pkgnum' => $cust_pkg->pkgnum,
1485 'unitsetup' => sprintf('%.2f', $unitsetup),
1487 'unitrecur' => sprintf('%.2f', $unitrecur),
1488 'quantity' => $override_quantity || $cust_pkg->quantity,
1489 'details' => \@details,
1490 'discounts' => [ @setup_discounts, @recur_discounts ],
1491 'hidden' => $part_pkg->hidden,
1492 'freq' => $part_pkg->freq,
1495 if ( $part_pkg->option('prorate_defer_bill',1)
1496 and !$hash{last_bill} ) {
1497 # both preceding and upcoming, technically
1498 $cust_bill_pkg->sdate( $cust_pkg->setup );
1499 $cust_bill_pkg->edate( $cust_pkg->bill );
1500 } elsif ( $part_pkg->recur_temporality eq 'preceding' ) {
1501 $cust_bill_pkg->sdate( $hash{last_bill} );
1502 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
1503 $cust_bill_pkg->edate( $time ) if $options{cancel};
1504 } else { #if ( $part_pkg->recur_temporality eq 'upcoming' ) {
1505 $cust_bill_pkg->sdate( $sdate );
1506 $cust_bill_pkg->edate( $cust_pkg->bill );
1507 #$cust_bill_pkg->edate( $time ) if $options{cancel};
1510 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
1511 unless $part_pkg->pkgpart == $real_pkgpart;
1513 $$total_setup += $setup;
1514 $$total_recur += $recur;
1520 my $error = $self->_handle_taxes( $taxlisthash, $cust_bill_pkg,
1521 cancel => $options{cancel} );
1522 return $error if $error;
1524 $cust_bill_pkg->set_display(
1525 part_pkg => $part_pkg,
1526 real_pkgpart => $real_pkgpart,
1529 push @$cust_bill_pkgs, $cust_bill_pkg;
1531 } #if $setup != 0 || $recur != 0
1539 =item _transfer_balance TO_PKG [ FROM_PKGNUM ]
1541 Takes one argument, a cust_pkg object that is being billed. This will
1542 be called only if the package was created by a package change, and has
1543 not been billed since the package change, and package balance tracking
1544 is enabled. The second argument can be an alternate package number to
1545 transfer the balance from; this should not be used externally.
1547 Transfers the balance from the previous package (now canceled) to
1548 this package, by crediting one package and creating an invoice item for
1549 the other. Inserts the credit and returns the invoice item (so that it
1550 can be added to an invoice that's being built).
1552 If the previous package was never billed, and was also created by a package
1553 change, then this will also transfer the balance from I<its> previous
1554 package, and so on, until reaching a package that either has been billed
1555 or was not created by a package change.
1559 my $balance_transfer_reason;
1561 sub _transfer_balance {
1563 my $cust_pkg = shift;
1564 my $from_pkgnum = shift || $cust_pkg->change_pkgnum;
1565 my $from_pkg = FS::cust_pkg->by_key($from_pkgnum);
1569 # if $from_pkg is not the first package in the chain, and it was never
1571 if ( $from_pkg->change_pkgnum and scalar($from_pkg->cust_bill_pkg) == 0 ) {
1572 @transfers = $self->_transfer_balance($cust_pkg, $from_pkg->change_pkgnum);
1575 my $prev_balance = $self->balance_pkgnum($from_pkgnum);
1576 if ( $prev_balance != 0 ) {
1577 $balance_transfer_reason ||= FS::reason->new_or_existing(
1578 'reason' => 'Package balance transfer',
1579 'type' => 'Internal adjustment',
1583 my $credit = FS::cust_credit->new({
1584 'custnum' => $self->custnum,
1585 'amount' => abs($prev_balance),
1586 'reasonnum' => $balance_transfer_reason->reasonnum,
1587 '_date' => $cust_pkg->change_date,
1590 my $cust_bill_pkg = FS::cust_bill_pkg->new({
1592 'recur' => abs($prev_balance),
1593 #'sdate' => $from_pkg->last_bill, # not sure about this
1594 #'edate' => $cust_pkg->change_date,
1595 'itemdesc' => $self->mt('Previous Balance, [_1]',
1596 $from_pkg->part_pkg->pkg),
1599 if ( $prev_balance > 0 ) {
1600 # credit the old package, charge the new one
1601 $credit->set('pkgnum', $from_pkgnum);
1602 $cust_bill_pkg->set('pkgnum', $cust_pkg->pkgnum);
1605 $credit->set('pkgnum', $cust_pkg->pkgnum);
1606 $cust_bill_pkg->set('pkgnum', $from_pkgnum);
1608 my $error = $credit->insert;
1609 die "error transferring package balance from #".$from_pkgnum.
1610 " to #".$cust_pkg->pkgnum.": $error\n" if $error;
1612 push @transfers, $cust_bill_pkg;
1613 } # $prev_balance != 0
1618 =item handle_taxes TAXLISTHASH CUST_BILL_PKG [ OPTIONS ]
1620 This is _handle_taxes. It's called once for each cust_bill_pkg generated
1623 TAXLISTHASH is a hashref shared across the entire invoice. It looks like
1626 'cust_main_county 1001' => [ [FS::cust_main_county], ... ],
1627 'cust_main_county 1002' => [ [FS::cust_main_county], ... ],
1630 'cust_main_county' can also be 'tax_rate'. The first object in the array
1631 is always the cust_main_county or tax_rate identified by the key.
1633 That "..." is a list of FS::cust_bill_pkg objects that will be fed to
1634 the 'taxline' method to calculate the amount of the tax. This doesn't
1635 happen until calculate_taxes, though.
1637 OPTIONS may include:
1638 - part_item: a part_pkg or part_fee object to be used as the package/fee
1640 - location: a cust_location to be used as the billing location.
1641 - cancel: true if this package is being billed on cancellation. This
1642 allows tax to be calculated on usage charges only.
1644 If not supplied, part_item will be inferred from the pkgnum or feepart of the
1645 cust_bill_pkg, and location from the pkgnum (or, for fees, the invnum and
1646 the customer's default service location).
1648 This method will also calculate exemptions for any taxes that apply to the
1649 line item (using the C<set_exemptions> method of L<FS::cust_bill_pkg>) and
1650 attach them. This is the only place C<set_exemptions> is called in normal
1657 my $taxlisthash = shift;
1658 my $cust_bill_pkg = shift;
1661 # at this point I realize that we have enough information to infer all this
1662 # stuff, instead of passing around giant honking argument lists
1663 my $location = $options{location} || $cust_bill_pkg->tax_location;
1664 my $part_item = $options{part_item} || $cust_bill_pkg->part_X;
1666 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1668 return if ( $self->payby eq 'COMP' ); #dubious
1670 if ( $conf->exists('enable_taxproducts')
1671 && ( scalar($part_item->part_pkg_taxoverride)
1672 || $part_item->has_taxproduct
1677 # EXTERNAL TAX RATES (via tax_rate)
1678 my %cust_bill_pkg = ();
1682 my $usage = $cust_bill_pkg->usage || 0;
1683 push @classes, $cust_bill_pkg->usage_classes if $usage;
1684 push @classes, 'setup' if $cust_bill_pkg->setup and !$options{cancel};
1685 push @classes, 'recur' if ($cust_bill_pkg->recur - $usage)
1686 and !$options{cancel};
1687 # that's better--probably don't even need $options{cancel} now
1688 # but leave it for now, just to be safe
1690 # About $options{cancel}: This protects against charging per-line or
1691 # per-customer or other flat-rate surcharges on a package that's being
1692 # billed on cancellation (which is an out-of-cycle bill and should only
1693 # have usage charges). See RT#29443.
1695 # customer exemption is now handled in the 'taxline' method
1696 #my $exempt = $conf->exists('cust_class-tax_exempt')
1697 # ? ( $self->cust_class ? $self->cust_class->tax : '' )
1699 # standardize this just to be sure
1700 #$exempt = ($exempt eq 'Y') ? 'Y' : '';
1704 unless (exists $taxes{''}) {
1705 # unsure what purpose this serves, but last time I deleted something
1706 # from here just because I didn't see the point, it actually did
1707 # something important.
1708 my $err_or_ref = $self->_gather_taxes($part_item, '', $location);
1709 return $err_or_ref unless ref($err_or_ref);
1710 $taxes{''} = $err_or_ref;
1713 # NO DISINTEGRATIONS.
1714 # my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
1716 # do not call taxline() with any argument except the entire set of
1717 # cust_bill_pkgs on an invoice that are eligible for the tax.
1719 # only calculate exemptions once for each tax rate, even if it's used
1720 # for multiple classes
1723 foreach my $class (@classes) {
1724 my $err_or_ref = $self->_gather_taxes($part_item, $class, $location);
1725 return $err_or_ref unless ref($err_or_ref);
1726 my @taxes = @$err_or_ref;
1730 foreach my $tax ( @taxes ) {
1732 my $tax_id = ref( $tax ). ' '. $tax->taxnum;
1733 # $taxlisthash: keys are tax identifiers ('FS::tax_rate 123456').
1734 # Values are arrayrefs, first the tax object (cust_main_county
1735 # or tax_rate), then the cust_bill_pkg object that the
1736 # tax applies to, then the tax class (setup, recur, usage classnum).
1737 $taxlisthash->{ $tax_id } ||= [ $tax ];
1738 push @{ $taxlisthash->{ $tax_id } }, $cust_bill_pkg, $class;
1740 # determine any exemptions that apply
1741 if (!$tax_seen{$tax_id}) {
1742 $cust_bill_pkg->set_exemptions( $tax, custnum => $self->custnum );
1743 $tax_seen{$tax_id} = 1;
1746 # tax on tax will be done later, when we actually create the tax
1754 # INTERNAL TAX RATES (cust_main_county)
1756 # We fetch taxes even if the customer is completely exempt,
1757 # because we need to record that fact.
1759 my @loc_keys = qw( district city county state country );
1760 my %taxhash = map { $_ => $location->$_ } @loc_keys;
1762 $taxhash{'taxclass'} = $part_item->taxclass;
1764 warn "taxhash:\n". Dumper(\%taxhash) if $DEBUG > 2;
1766 my @taxes = (); # entries are cust_main_county objects
1767 my %taxhash_elim = %taxhash;
1768 my @elim = qw( district city county state );
1771 #first try a match with taxclass
1772 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1774 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1775 #then try a match without taxclass
1776 my %no_taxclass = %taxhash_elim;
1777 $no_taxclass{ 'taxclass' } = '';
1778 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1781 $taxhash_elim{ shift(@elim) } = '';
1783 } while ( !scalar(@taxes) && scalar(@elim) );
1786 my $tax_id = 'cust_main_county '.$_->taxnum;
1787 $taxlisthash->{$tax_id} ||= [ $_ ];
1788 $cust_bill_pkg->set_exemptions($_, custnum => $self->custnum);
1789 push @{ $taxlisthash->{$tax_id} }, $cust_bill_pkg;
1796 =item _gather_taxes PART_ITEM CLASS CUST_LOCATION
1798 Internal method used with vendor-provided tax tables. PART_ITEM is a part_pkg
1799 or part_fee (which will define the tax eligibility of the product), CLASS is
1800 'setup', 'recur', null, or a C<usage_class> number, and CUST_LOCATION is the
1801 location where the service was provided (or billed, depending on
1802 configuration). Returns an arrayref of L<FS::tax_rate> objects that
1803 can apply to this line item.
1809 my $part_item = shift;
1811 my $location = shift;
1813 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1815 my $geocode = $location->geocode('cch');
1817 [ $part_item->tax_rates('cch', $geocode, $class) ]
1821 =item collect [ HASHREF | OPTION => VALUE ... ]
1823 (Attempt to) collect money for this customer's outstanding invoices (see
1824 L<FS::cust_bill>). Usually used after the bill method.
1826 Actions are now triggered by billing events; see L<FS::part_event> and the
1827 billing events web interface. Old-style invoice events (see
1828 L<FS::part_bill_event>) have been deprecated.
1830 If there is an error, returns the error, otherwise returns false.
1832 Options are passed as name-value pairs.
1834 Currently available options are:
1840 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.
1844 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1848 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1852 set true to surpress email card/ACH decline notices.
1856 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)
1862 # allows for one time override of normal customer billing method
1867 my( $self, %options ) = @_;
1869 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1871 my $invoice_time = $options{'invoice_time'} || time;
1874 local $SIG{HUP} = 'IGNORE';
1875 local $SIG{INT} = 'IGNORE';
1876 local $SIG{QUIT} = 'IGNORE';
1877 local $SIG{TERM} = 'IGNORE';
1878 local $SIG{TSTP} = 'IGNORE';
1879 local $SIG{PIPE} = 'IGNORE';
1881 my $oldAutoCommit = $FS::UID::AutoCommit;
1882 local $FS::UID::AutoCommit = 0;
1885 $self->select_for_update; #mutex
1888 my $balance = $self->balance;
1889 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
1892 if ( exists($options{'retry_card'}) ) {
1893 carp 'retry_card option passed to collect is deprecated; use retry';
1894 $options{'retry'} ||= $options{'retry_card'};
1896 if ( exists($options{'retry'}) && $options{'retry'} ) {
1897 my $error = $self->retry_realtime;
1899 $dbh->rollback if $oldAutoCommit;
1904 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1906 #never want to roll back an event just because it returned an error
1907 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1909 $self->do_cust_event(
1910 'debug' => ( $options{'debug'} || 0 ),
1911 'time' => $invoice_time,
1912 'check_freq' => $options{'check_freq'},
1913 'stage' => 'collect',
1918 =item retry_realtime
1920 Schedules realtime / batch credit card / electronic check / LEC billing
1921 events for for retry. Useful if card information has changed or manual
1922 retry is desired. The 'collect' method must be called to actually retry
1925 Implementation details: For either this customer, or for each of this
1926 customer's open invoices, changes the status of the first "done" (with
1927 statustext error) realtime processing event to "failed".
1931 sub retry_realtime {
1934 local $SIG{HUP} = 'IGNORE';
1935 local $SIG{INT} = 'IGNORE';
1936 local $SIG{QUIT} = 'IGNORE';
1937 local $SIG{TERM} = 'IGNORE';
1938 local $SIG{TSTP} = 'IGNORE';
1939 local $SIG{PIPE} = 'IGNORE';
1941 my $oldAutoCommit = $FS::UID::AutoCommit;
1942 local $FS::UID::AutoCommit = 0;
1945 #a little false laziness w/due_cust_event (not too bad, really)
1947 # I guess this is always as of now?
1948 my $join = FS::part_event_condition->join_conditions_sql('', 'time' => time);
1949 my $order = FS::part_event_condition->order_conditions_sql;
1952 . join ( ' OR ' , map {
1953 my $cust_join = FS::part_event->eventtables_cust_join->{$_} || '';
1954 my $custnum = FS::part_event->eventtables_custnum->{$_};
1955 "( part_event.eventtable = " . dbh->quote($_)
1956 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key
1957 . " from $_ $cust_join"
1958 . " where $custnum = " . dbh->quote( $self->custnum ) . "))" ;
1959 } FS::part_event->eventtables)
1962 #here is the agent virtualization
1963 my $agent_virt = " ( part_event.agentnum IS NULL
1964 OR part_event.agentnum = ". $self->agentnum. ' )';
1966 #XXX this shouldn't be hardcoded, actions should declare it...
1967 my @realtime_events = qw(
1968 cust_bill_realtime_card
1969 cust_bill_realtime_check
1970 cust_bill_realtime_lec
1974 my $is_realtime_event =
1975 ' part_event.action IN ( '.
1976 join(',', map "'$_'", @realtime_events ).
1979 my $batch_or_statustext =
1980 "( part_event.action = 'cust_bill_batch'
1981 OR ( statustext IS NOT NULL AND statustext != '' )
1985 my @cust_event = qsearch({
1986 'table' => 'cust_event',
1987 'select' => 'cust_event.*',
1988 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
1989 'hashref' => { 'status' => 'done' },
1990 'extra_sql' => " AND $batch_or_statustext ".
1991 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
1994 my %seen_invnum = ();
1995 foreach my $cust_event (@cust_event) {
1997 #max one for the customer, one for each open invoice
1998 my $cust_X = $cust_event->cust_X;
1999 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
2003 or $cust_event->part_event->eventtable eq 'cust_bill'
2006 my $error = $cust_event->retry;
2008 $dbh->rollback if $oldAutoCommit;
2009 return "error scheduling event for retry: $error";
2014 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2019 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
2021 Runs billing events; see L<FS::part_event> and the billing events web
2024 If there is an error, returns the error, otherwise returns false.
2026 Options are passed as name-value pairs.
2028 Currently available options are:
2034 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.
2038 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
2042 "collect" (the default) or "pre-bill"
2046 set true to surpress email card/ACH decline notices.
2050 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)
2057 # allows for one time override of normal customer billing method
2061 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
2064 my( $self, %options ) = @_;
2066 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
2068 my $time = $options{'time'} || time;
2071 local $SIG{HUP} = 'IGNORE';
2072 local $SIG{INT} = 'IGNORE';
2073 local $SIG{QUIT} = 'IGNORE';
2074 local $SIG{TERM} = 'IGNORE';
2075 local $SIG{TSTP} = 'IGNORE';
2076 local $SIG{PIPE} = 'IGNORE';
2078 my $oldAutoCommit = $FS::UID::AutoCommit;
2079 local $FS::UID::AutoCommit = 0;
2082 $self->select_for_update; #mutex
2085 my $balance = $self->balance;
2086 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
2089 # if ( exists($options{'retry_card'}) ) {
2090 # carp 'retry_card option passed to collect is deprecated; use retry';
2091 # $options{'retry'} ||= $options{'retry_card'};
2093 # if ( exists($options{'retry'}) && $options{'retry'} ) {
2094 # my $error = $self->retry_realtime;
2096 # $dbh->rollback if $oldAutoCommit;
2101 # false laziness w/pay_batch::import_results
2103 my $due_cust_event = $self->due_cust_event(
2104 'debug' => ( $options{'debug'} || 0 ),
2106 'check_freq' => $options{'check_freq'},
2107 'stage' => ( $options{'stage'} || 'collect' ),
2109 unless( ref($due_cust_event) ) {
2110 $dbh->rollback if $oldAutoCommit;
2111 return $due_cust_event;
2114 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2115 #never want to roll back an event just because it or a different one
2117 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
2119 foreach my $cust_event ( @$due_cust_event ) {
2123 #re-eval event conditions (a previous event could have changed things)
2124 unless ( $cust_event->test_conditions ) {
2125 #don't leave stray "new/locked" records around
2126 my $error = $cust_event->delete;
2127 return $error if $error;
2132 local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
2133 if $options{'quiet'};
2134 warn " running cust_event ". $cust_event->eventnum. "\n"
2137 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
2138 if ( my $error = $cust_event->do_event( 'time' => $time ) ) {
2139 #XXX wtf is this? figure out a proper dealio with return value
2151 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
2153 Inserts database records for and returns an ordered listref of new events due
2154 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
2155 events are due, an empty listref is returned. If there is an error, returns a
2156 scalar error message.
2158 To actually run the events, call each event's test_condition method, and if
2159 still true, call the event's do_event method.
2161 Options are passed as a hashref or as a list of name-value pairs. Available
2168 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.
2172 "collect" (the default) or "pre-bill"
2176 "Current time" for the events.
2180 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)
2184 Only return events for the specified eventtable (by default, events of all eventtables are returned)
2188 Explicitly pass the objects to be tested (typically used with eventtable).
2192 Set to true to return the objects, but not actually insert them into the
2199 sub due_cust_event {
2201 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
2204 #my $DEBUG = $opt{'debug'}
2205 $opt{'debug'} ||= 0; # silence some warnings
2206 local($DEBUG) = $opt{'debug'}
2207 if $opt{'debug'} > $DEBUG;
2208 $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
2210 warn "$me due_cust_event called with options ".
2211 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
2214 $opt{'time'} ||= time;
2216 local $SIG{HUP} = 'IGNORE';
2217 local $SIG{INT} = 'IGNORE';
2218 local $SIG{QUIT} = 'IGNORE';
2219 local $SIG{TERM} = 'IGNORE';
2220 local $SIG{TSTP} = 'IGNORE';
2221 local $SIG{PIPE} = 'IGNORE';
2223 my $oldAutoCommit = $FS::UID::AutoCommit;
2224 local $FS::UID::AutoCommit = 0;
2227 $self->select_for_update #mutex
2228 unless $opt{testonly};
2231 # find possible events (initial search)
2234 my @cust_event = ();
2236 my @eventtable = $opt{'eventtable'}
2237 ? ( $opt{'eventtable'} )
2238 : FS::part_event->eventtables_runorder;
2240 my $check_freq = $opt{'check_freq'} || '1d';
2242 foreach my $eventtable ( @eventtable ) {
2245 if ( $opt{'objects'} ) {
2247 @objects = @{ $opt{'objects'} };
2249 } elsif ( $eventtable eq 'cust_main' ) {
2251 @objects = ( $self );
2255 my $cm_join = " LEFT JOIN cust_main USING ( custnum )";
2256 # linkage not needed here because FS::cust_main->$eventtable will
2259 #some false laziness w/Cron::bill bill_where
2261 my $join = FS::part_event_condition->join_conditions_sql( $eventtable,
2262 'time' => $opt{'time'});
2263 my $where = FS::part_event_condition->where_conditions_sql($eventtable,
2264 'time'=>$opt{'time'},
2266 $where = $where ? "AND $where" : '';
2268 my $are_part_event =
2269 "EXISTS ( SELECT 1 FROM part_event $join
2270 WHERE check_freq = '$check_freq'
2271 AND eventtable = '$eventtable'
2272 AND ( disabled = '' OR disabled IS NULL )
2278 @objects = $self->$eventtable(
2279 'addl_from' => $cm_join,
2280 'extra_sql' => " AND $are_part_event",
2282 } # if ( !$opt{objects} and $eventtable ne 'cust_main' )
2284 my @e_cust_event = ();
2286 my $linkage = FS::part_event->eventtables_cust_join->{$eventtable} || '';
2288 my $cross = "CROSS JOIN $eventtable $linkage";
2289 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
2290 unless $eventtable eq 'cust_main';
2292 foreach my $object ( @objects ) {
2294 #this first search uses the condition_sql magic for optimization.
2295 #the more possible events we can eliminate in this step the better
2297 my $cross_where = '';
2298 my $pkey = $object->primary_key;
2299 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
2301 my $join = FS::part_event_condition->join_conditions_sql( $eventtable,
2302 'time' => $opt{'time'});
2304 FS::part_event_condition->where_conditions_sql( $eventtable,
2305 'time'=>$opt{'time'}
2307 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
2309 $extra_sql = "AND $extra_sql" if $extra_sql;
2311 #here is the agent virtualization
2312 $extra_sql .= " AND ( part_event.agentnum IS NULL
2313 OR part_event.agentnum = ". $self->agentnum. ' )';
2315 $extra_sql .= " $order";
2317 warn "searching for events for $eventtable ". $object->$pkey. "\n"
2318 if $opt{'debug'} > 2;
2319 my @part_event = qsearch( {
2320 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
2321 'select' => 'part_event.*',
2322 'table' => 'part_event',
2323 'addl_from' => "$cross $join",
2324 'hashref' => { 'check_freq' => $check_freq,
2325 'eventtable' => $eventtable,
2328 'extra_sql' => "AND $cross_where $extra_sql",
2332 my $pkey = $object->primary_key;
2333 warn " ". scalar(@part_event).
2334 " possible events found for $eventtable ". $object->$pkey(). "\n";
2337 push @e_cust_event, map {
2338 $_->new_cust_event($object, 'time' => $opt{'time'})
2343 warn " ". scalar(@e_cust_event).
2344 " subtotal possible cust events found for $eventtable\n"
2347 push @cust_event, @e_cust_event;
2351 warn " ". scalar(@cust_event).
2352 " total possible cust events found in initial search\n"
2360 $opt{stage} ||= 'collect';
2362 grep { my $stage = $_->part_event->event_stage;
2363 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
2373 @cust_event = grep $_->test_conditions( 'stats_hashref' => \%unsat ),
2376 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
2379 warn " invalid conditions not eliminated with condition_sql:\n".
2380 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
2381 if keys %unsat && $DEBUG; # > 1;
2387 unless( $opt{testonly} ) {
2388 foreach my $cust_event ( @cust_event ) {
2390 my $error = $cust_event->insert();
2392 $dbh->rollback if $oldAutoCommit;
2399 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2405 warn " returning events: ". Dumper(@cust_event). "\n"
2412 =item apply_payments_and_credits [ OPTION => VALUE ... ]
2414 Applies unapplied payments and credits.
2415 Payments with the no_auto_apply flag set will not be applied.
2417 In most cases, this new method should be used in place of sequential
2418 apply_payments and apply_credits methods.
2420 A hash of optional arguments may be passed. Currently "manual" is supported.
2421 If true, a payment receipt is sent instead of a statement when
2422 'payment_receipt_email' configuration option is set.
2424 If there is an error, returns the error, otherwise returns false.
2428 sub apply_payments_and_credits {
2429 my( $self, %options ) = @_;
2431 local $SIG{HUP} = 'IGNORE';
2432 local $SIG{INT} = 'IGNORE';
2433 local $SIG{QUIT} = 'IGNORE';
2434 local $SIG{TERM} = 'IGNORE';
2435 local $SIG{TSTP} = 'IGNORE';
2436 local $SIG{PIPE} = 'IGNORE';
2438 my $oldAutoCommit = $FS::UID::AutoCommit;
2439 local $FS::UID::AutoCommit = 0;
2442 $self->select_for_update; #mutex
2444 foreach my $cust_bill ( $self->open_cust_bill ) {
2445 my $error = $cust_bill->apply_payments_and_credits(%options);
2447 $dbh->rollback if $oldAutoCommit;
2448 return "Error applying: $error";
2452 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2457 =item apply_credits OPTION => VALUE ...
2459 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
2460 to outstanding invoice balances in chronological order (or reverse
2461 chronological order if the I<order> option is set to B<newest>) and returns the
2462 value of any remaining unapplied credits available for refund (see
2463 L<FS::cust_refund>).
2465 Dies if there is an error.
2473 local $SIG{HUP} = 'IGNORE';
2474 local $SIG{INT} = 'IGNORE';
2475 local $SIG{QUIT} = 'IGNORE';
2476 local $SIG{TERM} = 'IGNORE';
2477 local $SIG{TSTP} = 'IGNORE';
2478 local $SIG{PIPE} = 'IGNORE';
2480 my $oldAutoCommit = $FS::UID::AutoCommit;
2481 local $FS::UID::AutoCommit = 0;
2484 $self->select_for_update; #mutex
2486 unless ( $self->total_unapplied_credits ) {
2487 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2491 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
2492 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
2494 my @invoices = $self->open_cust_bill;
2495 @invoices = sort { $b->_date <=> $a->_date } @invoices
2496 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
2498 if ( $conf->exists('pkg-balances') ) {
2499 # limit @credits to those w/ a pkgnum grepped from $self
2501 foreach my $i (@invoices) {
2502 foreach my $li ( $i->cust_bill_pkg ) {
2503 $pkgnums{$li->pkgnum} = 1;
2506 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
2511 foreach my $cust_bill ( @invoices ) {
2513 if ( !defined($credit) || $credit->credited == 0) {
2514 $credit = pop @credits or last;
2518 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
2519 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
2521 $owed = $cust_bill->owed;
2523 unless ( $owed > 0 ) {
2524 push @credits, $credit;
2528 my $amount = min( $credit->credited, $owed );
2530 my $cust_credit_bill = new FS::cust_credit_bill ( {
2531 'crednum' => $credit->crednum,
2532 'invnum' => $cust_bill->invnum,
2533 'amount' => $amount,
2535 $cust_credit_bill->pkgnum( $credit->pkgnum )
2536 if $conf->exists('pkg-balances') && $credit->pkgnum;
2537 my $error = $cust_credit_bill->insert;
2539 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2543 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2547 my $total_unapplied_credits = $self->total_unapplied_credits;
2549 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2551 return $total_unapplied_credits;
2554 =item apply_payments [ OPTION => VALUE ... ]
2556 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2557 to outstanding invoice balances in chronological order.
2558 Payments with the no_auto_apply flag set will not be applied.
2560 #and returns the value of any remaining unapplied payments.
2562 A hash of optional arguments may be passed. Currently "manual" is supported.
2563 If true, a payment receipt is sent instead of a statement when
2564 'payment_receipt_email' configuration option is set.
2566 Dies if there is an error.
2570 sub apply_payments {
2571 my( $self, %options ) = @_;
2573 local $SIG{HUP} = 'IGNORE';
2574 local $SIG{INT} = 'IGNORE';
2575 local $SIG{QUIT} = 'IGNORE';
2576 local $SIG{TERM} = 'IGNORE';
2577 local $SIG{TSTP} = 'IGNORE';
2578 local $SIG{PIPE} = 'IGNORE';
2580 my $oldAutoCommit = $FS::UID::AutoCommit;
2581 local $FS::UID::AutoCommit = 0;
2584 $self->select_for_update; #mutex
2588 my @payments = grep { !$_->no_auto_apply } $self->unapplied_cust_pay;
2590 my @invoices = $self->open_cust_bill;
2592 if ( $conf->exists('pkg-balances') ) {
2593 # limit @payments to those w/ a pkgnum grepped from $self
2595 foreach my $i (@invoices) {
2596 foreach my $li ( $i->cust_bill_pkg ) {
2597 $pkgnums{$li->pkgnum} = 1;
2600 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
2605 foreach my $cust_bill ( @invoices ) {
2607 if ( !defined($payment) || $payment->unapplied == 0 ) {
2608 $payment = pop @payments or last;
2612 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
2613 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
2615 $owed = $cust_bill->owed;
2617 unless ( $owed > 0 ) {
2618 push @payments, $payment;
2622 my $amount = min( $payment->unapplied, $owed );
2625 'paynum' => $payment->paynum,
2626 'invnum' => $cust_bill->invnum,
2627 'amount' => $amount,
2629 $cbp->{_date} = $payment->_date
2630 if $options{'manual'} && $options{'backdate_application'};
2631 my $cust_bill_pay = new FS::cust_bill_pay($cbp);
2632 $cust_bill_pay->pkgnum( $payment->pkgnum )
2633 if $conf->exists('pkg-balances') && $payment->pkgnum;
2634 my $error = $cust_bill_pay->insert(%options);
2636 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2640 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2644 my $total_unapplied_payments = $self->total_unapplied_payments;
2646 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2648 return $total_unapplied_payments;
2658 suspend_adjourned_pkgs
2659 unsuspend_resumed_pkgs
2662 (do_cust_event pre-bill)
2665 (vendor-only) _gather_taxes
2666 _omit_zero_value_bundles
2667 _handle_taxes (for fees)
2670 apply_payments_and_credits
2679 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>