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::cust_event_fee;
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_event_fees = FS::cust_event_fee->by_cust($self->custnum,
579 hashref => { 'billpkgnum' => '' }
581 warn "$me found pending fee events:\n".Dumper(\@pending_event_fees)."\n"
582 if @pending_event_fees and $DEBUG > 1;
584 # determine whether to generate an invoice
585 my $generate_bill = scalar(@cust_bill_pkg) > 0;
587 foreach my $event_fee (@pending_event_fees) {
588 $generate_bill = 1 unless $event_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 $event_fee (@pending_event_fees) {
598 my $object = $event_fee->cust_event->cust_X;
599 my $part_fee = $event_fee->part_fee;
601 if ( $object->isa('FS::cust_main')
602 or $object->isa('FS::cust_pkg')
603 or $object->isa('FS::cust_pay_batch') )
605 # Not the real cust_bill object that will be inserted--in particular
606 # there are no taxes yet. If you want to charge a fee on the total
607 # invoice amount including taxes, you have to put the fee on the next
609 $cust_bill = FS::cust_bill->new({
610 'custnum' => $self->custnum,
611 'cust_bill_pkg' => \@cust_bill_pkg,
612 'charged' => ${ $total_setup{$pass} } +
613 ${ $total_recur{$pass} },
616 # If this is a package event, only apply the fee to line items
618 if ($object->isa('FS::cust_pkg')) {
619 $cust_bill->set('cust_bill_pkg',
620 [ grep { $_->pkgnum == $object->pkgnum } @cust_bill_pkg ]
624 } elsif ( $object->isa('FS::cust_bill') ) {
625 # simple case: applying the fee to a previous invoice (late fee,
627 $cust_bill = $object;
629 # if the fee def belongs to a different agent, don't charge the fee.
630 # event conditions should prevent this, but just in case they don't,
632 if ( $part_fee->agentnum and $part_fee->agentnum != $self->agentnum ) {
633 warn "tried to charge fee#".$part_fee->feepart .
634 " on customer#".$self->custnum." from a different agent.\n";
637 # also skip if it's disabled
638 next if $part_fee->disabled eq 'Y';
640 my $fee_item = $part_fee->lineitem($cust_bill) or next;
641 # link this so that we can clear the marker on inserting the line item
642 $fee_item->set('cust_event_fee', $event_fee);
643 push @fee_items, $fee_item;
647 # add fees to the invoice
648 foreach my $fee_item (@fee_items) {
650 push @cust_bill_pkg, $fee_item;
651 ${ $total_setup{$pass} } += $fee_item->setup;
652 ${ $total_recur{$pass} } += $fee_item->recur;
654 my $part_fee = $fee_item->part_fee;
655 my $fee_location = $self->ship_location; # I think?
657 my $error = $self->_handle_taxes(
660 location => $fee_location
661 # probably not right to pass cancel => 1 for fees
663 return $error if $error;
667 # XXX implementation of fees is supposed to make this go away...
668 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
669 !$conf->exists('postal_invoice-recurring_only')
673 my $postal_pkg = $self->charge_postal_fee();
674 if ( $postal_pkg && !ref( $postal_pkg ) ) {
676 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
677 return "can't charge postal invoice fee for customer ".
678 $self->custnum. ": $postal_pkg";
680 } elsif ( $postal_pkg ) {
682 my $real_pkgpart = $postal_pkg->pkgpart;
683 # we could implement this bit as FS::part_pkg::has_hidden, but we already
684 # suffer from performance issues
685 $options{has_hidden} = 0;
686 my @part_pkg = $postal_pkg->part_pkg->self_and_bill_linked;
687 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
689 foreach my $part_pkg ( @part_pkg ) {
690 my %postal_options = %options;
691 delete $postal_options{cancel};
693 $self->_make_lines( 'part_pkg' => $part_pkg,
694 'cust_pkg' => $postal_pkg,
695 'precommit_hooks' => \@precommit_hooks,
696 'line_items' => \@cust_bill_pkg,
697 'setup' => $total_setup{$pass},
698 'recur' => $total_recur{$pass},
699 'tax_matrix' => $taxlisthash{$pass},
701 'real_pkgpart' => $real_pkgpart,
702 'options' => \%postal_options,
705 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
710 # it's silly to have a zero value postal_pkg, but....
711 @cust_bill_pkg = _omit_zero_value_bundles(@cust_bill_pkg);
717 my $listref_or_error =
718 $self->calculate_taxes( \@cust_bill_pkg, $taxlisthash{$pass}, $invoice_time);
720 unless ( ref( $listref_or_error ) ) {
721 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
722 return $listref_or_error;
725 foreach my $taxline ( @$listref_or_error ) {
726 ${ $total_setup{$pass} } =
727 sprintf('%.2f', ${ $total_setup{$pass} } + $taxline->setup );
728 push @cust_bill_pkg, $taxline;
732 warn "adding tax adjustments...\n" if $DEBUG > 2;
733 foreach my $cust_tax_adjustment (
734 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
740 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
742 my $itemdesc = $cust_tax_adjustment->taxname;
743 $itemdesc = '' if $itemdesc eq 'Tax';
745 push @cust_bill_pkg, new FS::cust_bill_pkg {
751 'itemdesc' => $itemdesc,
752 'itemcomment' => $cust_tax_adjustment->comment,
753 'cust_tax_adjustment' => $cust_tax_adjustment,
754 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
759 my $charged = sprintf('%.2f', ${ $total_setup{$pass} } + ${ $total_recur{$pass} } );
761 my $balance = $self->balance;
763 my $previous_bill = qsearchs({ 'table' => 'cust_bill',
764 'hashref' => { custnum=>$self->custnum },
765 'extra_sql' => 'ORDER BY _date DESC LIMIT 1',
767 my $previous_balance =
769 ? ( $previous_bill->billing_balance + $previous_bill->charged )
772 $log->debug('creating the new invoice', %logopt);
773 warn "creating the new invoice\n" if $DEBUG;
774 #create the new invoice
775 my $cust_bill = new FS::cust_bill ( {
776 'custnum' => $self->custnum,
777 '_date' => $invoice_time,
778 'charged' => $charged,
779 'billing_balance' => $balance,
780 'previous_balance' => $previous_balance,
781 'invoice_terms' => $options{'invoice_terms'},
782 'cust_bill_pkg' => \@cust_bill_pkg,
784 $error = $cust_bill->insert unless $options{no_commit};
786 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
787 return "can't create invoice for customer #". $self->custnum. ": $error";
789 push @{$options{return_bill}}, $cust_bill if $options{return_bill};
791 } #foreach my $pass ( keys %cust_bill_pkg )
793 foreach my $hook ( @precommit_hooks ) {
796 } unless $options{no_commit};
798 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
799 return "$@ running precommit hook $hook\n";
803 $dbh->commit or die $dbh->errstr if $oldAutoCommit && !$options{no_commit};
808 #discard bundled packages of 0 value
809 sub _omit_zero_value_bundles {
812 my @cust_bill_pkg = ();
813 my @cust_bill_pkg_bundle = ();
815 my $discount_show_always = 0;
817 foreach my $cust_bill_pkg ( @in ) {
819 $discount_show_always = ($cust_bill_pkg->get('discounts')
820 && scalar(@{$cust_bill_pkg->get('discounts')})
821 && $conf->exists('discount-show-always'));
823 warn " pkgnum ". $cust_bill_pkg->pkgnum. " sum $sum, ".
824 "setup_show_zero ". $cust_bill_pkg->setup_show_zero.
825 "recur_show_zero ". $cust_bill_pkg->recur_show_zero. "\n"
828 if (scalar(@cust_bill_pkg_bundle) && !$cust_bill_pkg->pkgpart_override) {
829 push @cust_bill_pkg, @cust_bill_pkg_bundle
831 || ($sum == 0 && ( $discount_show_always
832 || grep {$_->recur_show_zero || $_->setup_show_zero}
833 @cust_bill_pkg_bundle
836 @cust_bill_pkg_bundle = ();
840 $sum += $cust_bill_pkg->setup + $cust_bill_pkg->recur;
841 push @cust_bill_pkg_bundle, $cust_bill_pkg;
845 push @cust_bill_pkg, @cust_bill_pkg_bundle
847 || ($sum == 0 && ( $discount_show_always
848 || grep {$_->recur_show_zero || $_->setup_show_zero}
849 @cust_bill_pkg_bundle
853 warn " _omit_zero_value_bundles: ". scalar(@in).
854 '->'. scalar(@cust_bill_pkg). "\n" #. Dumper(@cust_bill_pkg). "\n"
861 =item calculate_taxes LINEITEMREF TAXHASHREF INVOICE_TIME
863 Generates tax line items (see L<FS::cust_bill_pkg>) for this customer.
864 Usually used internally by bill method B<bill>.
866 If there is an error, returns the error, otherwise returns reference to a
867 list of line items suitable for insertion.
873 An array ref of the line items being billed.
877 A strange beast. The keys to this hash are internal identifiers consisting
878 of the name of the tax object type, a space, and its unique identifier ( e.g.
879 'cust_main_county 23' ). The values of the hash are listrefs. The first
880 item in the list is the tax object. The remaining items are either line
881 items or floating point values (currency amounts).
883 The taxes are calculated on this entity. Calculated exemption records are
884 transferred to the LINEITEMREF items on the assumption that they are related.
890 This specifies the date appearing on the associated invoice. Some
891 jurisdictions (i.e. Texas) have tax exemptions which are date sensitive.
897 sub calculate_taxes {
898 my ($self, $cust_bill_pkg, $taxlisthash, $invoice_time) = @_;
900 # $taxlisthash is a hashref
901 # keys are identifiers, values are arrayrefs
902 # each arrayref starts with a tax object (cust_main_county or tax_rate)
903 # then a cust_bill_pkg object the tax applies to, then the charge class
904 # on that object (setup, recur, a usage class number, or '')
905 # For internal taxes the charge class is always undef.
907 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
909 warn "$me calculate_taxes\n"
910 #.Dumper($self, $cust_bill_pkg, $taxlisthash, $invoice_time). "\n"
913 # The main tax accumulator. One bin for each tax name (itemdesc).
914 # For each subdivision of tax under this name, push a cust_bill_pkg item
915 # for the calculated tax into the arrayref.
917 # values are arrayrefs of tax lines
920 # keys are taxlisthash keys (internal identifiers)
921 # values are (cumulative) amounts
924 # keys are taxlisthash keys
925 # values are arrayrefs of cust_tax_exempt_pkg objects
928 # keys are cust_bill_pkg objects (taxable items)
929 # values are hashrefs
930 # keys are taxlisthash keys
931 # values are the taxlines generated for those taxes
932 tie my %item_has_tax, 'Tie::RefHash',
933 map { $_ => {} } @$cust_bill_pkg;
935 foreach my $tax_id ( keys %$taxlisthash ) {
936 # $tax_id: the identifier of the tax we are calculating in this pass
938 my $taxables = $taxlisthash->{$tax_id};
939 my $tax_object = shift @$taxables;
940 # $tax_object is a cust_main_county or tax_rate
941 # (with billpkgnum, pkgnum, locationnum set)
942 # the rest of @{ $taxlisthash->{$tax_id} } is cust_bill_pkg objects,
943 # optionally followed by their charge classes.
944 warn "found ". $tax_object->taxname. " as $tax_id\n" if $DEBUG > 2;
946 # taxline calculates the tax on all cust_bill_pkgs in the
947 # first (arrayref) argument.
949 # Note that non-monthly exemptions have already been calculated and
950 # attached to the items. Monthly exemptions will be attached in this
952 my $exemptions = $tax_exemption{$tax_id} ||= [];
953 if ( $tax_object->isa('FS::tax_rate') ) { # EXTERNAL TAXES
954 # STILL have tax_rate-specific crap in here...
955 my @taxlines = $tax_object->taxline( $taxables,
956 'custnum' => $self->custnum,
957 'invoice_time' => $invoice_time,
958 'exemptions' => $exemptions,
961 if (!ref $taxlines[0]) {
962 # it's an error string
963 warn "error evaluating $tax_id on custnum ".$self->custnum."\n";
966 foreach my $taxline (@taxlines) {
967 push @{ $taxname{ $taxline->itemdesc } }, $taxline;
968 my $link = $taxline->get('cust_bill_pkg_tax_rate_location')->[0];
969 my $taxable_item = $link->taxable_cust_bill_pkg;
970 $item_has_tax{$taxable_item}->{$tax_id} = $taxline;
972 } else { # INTERNAL TAXES
973 # we can do this in a single taxline, because it's not stupid
975 my $taxline = $tax_object->taxline( $taxables,
976 'custnum' => $self->custnum,
977 'invoice_time' => $invoice_time,
978 'exemptions' => $exemptions,
982 # it's an error string
983 warn "error evaluating $tax_id on custnum ".$self->custnum."\n";
986 # if the calculated tax is zero, don't even keep it
987 next if $taxline->setup < 0.001;
988 push @{ $taxname{ $taxline->itemdesc } }, $taxline;
991 $DB::single = 1; # XXX
993 # all first-tier taxes are calculated. now for tax on tax:
995 foreach my $taxable_item ( @$cust_bill_pkg ) {
996 # taxes that apply to this item
997 my $this_has_tax = $item_has_tax{$taxable_item};
999 my $location = $taxable_item->tax_location;
1000 foreach my $tax_id (keys %$this_has_tax) {
1001 my ($class, $taxnum) = split(' ', $tax_id);
1002 # internal taxes don't support tax_on_tax, so we don't bother with
1004 next unless $class eq 'FS::tax_rate';
1006 # for each tax item that was calculated in phase 1, get the
1008 my $tax_object = FS::tax_rate->by_key($taxnum);
1009 # and find all taxes that apply to it in this location
1010 my @tot = $tax_object->tax_on_tax( $location );
1012 warn "found possible taxed taxnum $taxnum\n"
1014 # Calculate ToT separately for each taxable item, and only if _that
1015 # item_ is already taxed under the ToT. This is counterintuitive.
1017 foreach my $tot (@tot) {
1018 my $tot_id = ref($tot) . ' ' . $tot->taxnum;
1019 warn "checking taxnum ".$tot->taxnum.
1020 " which we call ". $tot->taxname ."\n"
1022 if ( exists $this_has_tax->{ $tot_id } ) {
1023 warn "calculating tax on tax: taxnum ".$tot->taxnum." on $taxnum\n"
1025 my @taxlines = $tot->taxline(
1026 $this_has_tax->{ $tax_id }, # the first-stage tax
1027 'custnum' => $self->custnum,
1028 'invoice_time' => $invoice_time,
1030 next if (!@taxlines); # it didn't apply after all
1031 if (!ref($taxlines[0])) {
1032 warn "error evaluating $tot_id TOT on custnum ".
1033 $self->custnum."\n";
1034 return $taxlines[0];
1036 foreach my $taxline (@taxlines) {
1037 push @{ $taxname{ $taxline->itemdesc } }, $taxline;
1040 } # foreach my $tot (tax-on-tax rate definition)
1041 } # foreach $taxnum (first-tier rate definition)
1042 } # foreach $taxable_item
1044 #consolidate and create tax line items
1045 warn "consolidating and generating...\n" if $DEBUG > 2;
1046 my %final_tax_items; # taxname => item
1047 foreach my $taxname ( keys %taxname ) {
1048 my @cust_bill_pkg_tax_location;
1049 my @cust_bill_pkg_tax_rate_location;
1050 my $tax_cust_bill_pkg = FS::cust_bill_pkg->new({
1055 'itemdesc' => $taxname,
1056 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
1057 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
1062 warn "adding $taxname\n" if $DEBUG > 1;
1063 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
1064 next if $taxitem->get('setup') == 0;
1065 # if ( ref($taxitem) eq 'FS::cust_bill_pkg' ) # always true
1066 # then we need to transfer the amount and the links from the
1067 # line item to the new one we're creating.
1068 $tax_total += $taxitem->setup;
1070 $taxitem->get('cust_bill_pkg_tax_location') ||
1071 $taxitem->get('cust_bill_pkg_tax_rate_location') ||
1074 foreach my $link ( @links ) {
1075 $link->set('tax_cust_bill_pkg', $tax_cust_bill_pkg);
1076 if ($link->isa('FS::cust_bill_pkg_tax_location')) {
1077 push @cust_bill_pkg_tax_location, $link;
1078 } elsif ($link->isa('FS::cust_bill_pkg_tax_rate_location')) {
1079 push @cust_bill_pkg_tax_rate_location, $link;
1083 next unless $tax_total;
1085 # we should really neverround this up...I guess it's okay if taxline
1086 # already returns amounts with 2 decimal places
1087 $tax_total = sprintf('%.2f', $tax_total );
1088 $tax_cust_bill_pkg->set('setup', $tax_total);
1090 my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
1096 if ( $pkg_category and
1097 $conf->config('invoice_latexsummary') ||
1098 $conf->config('invoice_htmlsummary')
1102 my %hash = ( 'section' => $pkg_category->categoryname );
1103 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
1106 $tax_cust_bill_pkg->set('display', \@display);
1108 $final_tax_items{$taxname} = $tax_cust_bill_pkg;
1109 } # foreach $taxname
1111 # fix ToT backlinks for taxes that have been consolidated
1112 # (has to be done in a separate pass)
1113 foreach my $tax_item (values %final_tax_items) {
1114 foreach my $taxable_link (@{ $tax_item->cust_bill_pkg_tax_rate_location }) {
1115 my $taxed_item = $taxable_link->taxable_cust_bill_pkg;
1116 next if $taxed_item->pkgnum > 0; # primary taxes
1117 my $taxname = $taxed_item->itemdesc;
1118 $taxable_link->set('taxable_cust_bill_pkg', $final_tax_items{ $taxname });
1122 [ values %final_tax_items ]
1126 my ($self, %params) = @_;
1128 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1130 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
1131 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
1132 my $cust_location = $cust_pkg->tax_location;
1133 my $precommit_hooks = $params{precommit_hooks} or die "no precommit_hooks specified";
1134 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
1135 my $total_setup = $params{setup} or die "no setup accumulator specified";
1136 my $total_recur = $params{recur} or die "no recur accumulator specified";
1137 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
1138 my $time = $params{'time'} or die "no time specified";
1139 my (%options) = %{$params{options}};
1141 if ( $part_pkg->freq ne '1' and ($options{'freq_override'} || 0) > 0 ) {
1142 # this should never happen
1143 die 'freq_override billing attempted on non-monthly package '.
1148 my $real_pkgpart = $params{real_pkgpart};
1149 my %hash = $cust_pkg->hash;
1150 my $old_cust_pkg = new FS::cust_pkg \%hash;
1155 $cust_pkg->pkgpart($part_pkg->pkgpart);
1157 my $cmp_time = ( $conf->exists('next-bill-ignore-time')
1168 my @setup_discounts = ();
1169 my %setup_param = ( 'discounts' => \@setup_discounts,
1170 'real_pkgpart' => $params{real_pkgpart}
1172 # Conditions for setting setup date and charging the setup fee:
1173 # - this is not a recurring-only billing run
1174 # - and the package is not currently being canceled
1175 # - and, unless we're specifically told otherwise via 'resetup':
1176 # - it doesn't already HAVE a setup date
1177 # - or a start date in the future
1178 # - and it's not suspended
1180 # The last condition used to check the "disable_setup_suspended" option but
1181 # that's obsolete. We now never set the setup date on a suspended package.
1182 if ( ! $options{recurring_only}
1183 and ! $options{cancel}
1184 and ( $options{'resetup'}
1185 || ( ! $cust_pkg->setup
1186 && ( ! $cust_pkg->start_date
1187 || $cust_pkg->start_date <= $cmp_time
1189 && ( ! $cust_pkg->getfield('susp') )
1195 warn " bill setup\n" if $DEBUG > 1;
1197 unless ( $cust_pkg->waive_setup ) {
1200 $setup = eval { $cust_pkg->calc_setup( $time, \@details, \%setup_param ) };
1201 return "$@ running calc_setup for $cust_pkg\n"
1204 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
1207 $cust_pkg->setfield('setup', $time)
1208 unless $cust_pkg->setup;
1209 #do need it, but it won't get written to the db
1210 #|| $cust_pkg->pkgpart != $real_pkgpart;
1212 $cust_pkg->setfield('start_date', '')
1213 if $cust_pkg->start_date;
1218 # bill recurring fee
1223 my @recur_discounts = ();
1225 if ( ! $cust_pkg->start_date
1228 || ( $cust_pkg->susp != $cust_pkg->order_date
1229 && ( $cust_pkg->option('suspend_bill',1)
1230 || ( $part_pkg->option('suspend_bill', 1)
1231 && ! $cust_pkg->option('no_suspend_bill',1)
1237 ( $part_pkg->freq ne '0' && ( $cust_pkg->bill || 0 ) <= $cmp_time )
1238 || ( $part_pkg->plan eq 'voip_cdr'
1239 && $part_pkg->option('bill_every_call')
1244 # XXX should this be a package event? probably. events are called
1245 # at collection time at the moment, though...
1246 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
1247 if $part_pkg->can('reset_usage') && !$options{'no_usage_reset'};
1248 #don't want to reset usage just cause we want a line item??
1249 #&& $part_pkg->pkgpart == $real_pkgpart;
1251 warn " bill recur\n" if $DEBUG > 1;
1254 # XXX shared with $recur_prog
1255 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
1259 #over two params! lets at least switch to a hashref for the rest...
1260 my $increment_next_bill = ( $part_pkg->freq ne '0'
1261 && ( $cust_pkg->getfield('bill') || 0 ) <= $cmp_time
1262 && !$options{cancel}
1264 my %param = ( %setup_param,
1265 'precommit_hooks' => $precommit_hooks,
1266 'increment_next_bill' => $increment_next_bill,
1267 'discounts' => \@recur_discounts,
1268 'real_pkgpart' => $real_pkgpart,
1269 'freq_override' => $options{freq_override} || '',
1273 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
1275 # There may be some part_pkg for which this is wrong. Only those
1276 # which can_discount are supported.
1277 # (the UI should prevent adding discounts to these at the moment)
1279 warn "calling $method on cust_pkg ". $cust_pkg->pkgnum.
1280 " for pkgpart ". $cust_pkg->pkgpart.
1281 " with params ". join(' / ', map "$_=>$param{$_}", keys %param). "\n"
1284 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
1285 return "$@ running $method for $cust_pkg\n"
1289 $unitrecur = $cust_pkg->base_recur( \$sdate ) || $recur; #XXX uuh, better
1291 if ( $increment_next_bill ) {
1295 if ( my $main_pkg = $cust_pkg->main_pkg ) {
1296 # supplemental package
1297 # to keep in sync with the main package, simulate billing at
1299 my $main_pkg_freq = $main_pkg->part_pkg->freq;
1300 my $supp_pkg_freq = $part_pkg->freq;
1301 my $ratio = $supp_pkg_freq / $main_pkg_freq;
1302 if ( $ratio != int($ratio) ) {
1303 # the UI should prevent setting up packages like this, but just
1305 return "supplemental package period is not an integer multiple of main package period";
1307 $next_bill = $sdate;
1309 $next_bill = $part_pkg->add_freq( $next_bill, $main_pkg_freq );
1314 $next_bill = $part_pkg->add_freq($sdate, $options{freq_override} || 0);
1315 return "unparsable frequency: ". $part_pkg->freq
1316 if $next_bill == -1;
1319 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
1320 # only for figuring next bill date, nothing else, so, reset $sdate again
1322 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1323 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
1324 $cust_pkg->last_bill($sdate);
1326 $cust_pkg->setfield('bill', $next_bill );
1330 if ( $param{'setup_fee'} ) {
1331 # Add an additional setup fee at the billing stage.
1332 # Used for prorate_defer_bill.
1333 $setup += $param{'setup_fee'};
1334 $unitsetup += $param{'setup_fee'};
1338 if ( defined $param{'discount_left_setup'} ) {
1339 foreach my $discount_setup ( values %{$param{'discount_left_setup'}} ) {
1340 $setup -= $discount_setup;
1346 warn "\$setup is undefined" unless defined($setup);
1347 warn "\$recur is undefined" unless defined($recur);
1348 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1351 # If there's line items, create em cust_bill_pkg records
1352 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
1357 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
1358 # hmm.. and if just the options are modified in some weird price plan?
1360 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
1363 my $error = $cust_pkg->replace( $old_cust_pkg,
1364 'depend_jobnum'=>$options{depend_jobnum},
1365 'options' => { $cust_pkg->options },
1367 unless $options{no_commit};
1368 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
1369 if $error; #just in case
1372 $setup = sprintf( "%.2f", $setup );
1373 $recur = sprintf( "%.2f", $recur );
1374 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
1375 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1377 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
1378 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
1381 my $discount_show_always = $conf->exists('discount-show-always')
1382 && ( ($setup == 0 && scalar(@setup_discounts))
1383 || ($recur == 0 && scalar(@recur_discounts))
1388 || (!$part_pkg->hidden && $options{has_hidden}) #include some $0 lines
1389 || $discount_show_always
1390 || ($setup == 0 && $cust_pkg->_X_show_zero('setup'))
1391 || ($recur == 0 && $cust_pkg->_X_show_zero('recur'))
1395 warn " charges (setup=$setup, recur=$recur); adding line items\n"
1398 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
1400 warn " adding customer package invoice detail: $_\n"
1401 foreach @cust_pkg_detail;
1403 push @details, @cust_pkg_detail;
1405 my $cust_bill_pkg = new FS::cust_bill_pkg {
1406 'pkgnum' => $cust_pkg->pkgnum,
1408 'unitsetup' => $unitsetup,
1410 'unitrecur' => $unitrecur,
1411 'quantity' => $cust_pkg->quantity,
1412 'details' => \@details,
1413 'discounts' => [ @setup_discounts, @recur_discounts ],
1414 'hidden' => $part_pkg->hidden,
1415 'freq' => $part_pkg->freq,
1418 if ( $part_pkg->option('prorate_defer_bill',1)
1419 and !$hash{last_bill} ) {
1420 # both preceding and upcoming, technically
1421 $cust_bill_pkg->sdate( $cust_pkg->setup );
1422 $cust_bill_pkg->edate( $cust_pkg->bill );
1423 } elsif ( $part_pkg->recur_temporality eq 'preceding' ) {
1424 $cust_bill_pkg->sdate( $hash{last_bill} );
1425 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
1426 $cust_bill_pkg->edate( $time ) if $options{cancel};
1427 } else { #if ( $part_pkg->recur_temporality eq 'upcoming' ) {
1428 $cust_bill_pkg->sdate( $sdate );
1429 $cust_bill_pkg->edate( $cust_pkg->bill );
1430 #$cust_bill_pkg->edate( $time ) if $options{cancel};
1433 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
1434 unless $part_pkg->pkgpart == $real_pkgpart;
1436 $$total_setup += $setup;
1437 $$total_recur += $recur;
1443 my $error = $self->_handle_taxes( $taxlisthash, $cust_bill_pkg,
1444 cancel => $options{cancel} );
1445 return $error if $error;
1447 $cust_bill_pkg->set_display(
1448 part_pkg => $part_pkg,
1449 real_pkgpart => $real_pkgpart,
1452 push @$cust_bill_pkgs, $cust_bill_pkg;
1454 } #if $setup != 0 || $recur != 0
1462 =item _transfer_balance TO_PKG [ FROM_PKGNUM ]
1464 Takes one argument, a cust_pkg object that is being billed. This will
1465 be called only if the package was created by a package change, and has
1466 not been billed since the package change, and package balance tracking
1467 is enabled. The second argument can be an alternate package number to
1468 transfer the balance from; this should not be used externally.
1470 Transfers the balance from the previous package (now canceled) to
1471 this package, by crediting one package and creating an invoice item for
1472 the other. Inserts the credit and returns the invoice item (so that it
1473 can be added to an invoice that's being built).
1475 If the previous package was never billed, and was also created by a package
1476 change, then this will also transfer the balance from I<its> previous
1477 package, and so on, until reaching a package that either has been billed
1478 or was not created by a package change.
1482 my $balance_transfer_reason;
1484 sub _transfer_balance {
1486 my $cust_pkg = shift;
1487 my $from_pkgnum = shift || $cust_pkg->change_pkgnum;
1488 my $from_pkg = FS::cust_pkg->by_key($from_pkgnum);
1492 # if $from_pkg is not the first package in the chain, and it was never
1494 if ( $from_pkg->change_pkgnum and scalar($from_pkg->cust_bill_pkg) == 0 ) {
1495 @transfers = $self->_transfer_balance($cust_pkg, $from_pkg->change_pkgnum);
1498 my $prev_balance = $self->balance_pkgnum($from_pkgnum);
1499 if ( $prev_balance != 0 ) {
1500 $balance_transfer_reason ||= FS::reason->new_or_existing(
1501 'reason' => 'Package balance transfer',
1502 'type' => 'Internal adjustment',
1506 my $credit = FS::cust_credit->new({
1507 'custnum' => $self->custnum,
1508 'amount' => abs($prev_balance),
1509 'reasonnum' => $balance_transfer_reason->reasonnum,
1510 '_date' => $cust_pkg->change_date,
1513 my $cust_bill_pkg = FS::cust_bill_pkg->new({
1515 'recur' => abs($prev_balance),
1516 #'sdate' => $from_pkg->last_bill, # not sure about this
1517 #'edate' => $cust_pkg->change_date,
1518 'itemdesc' => $self->mt('Previous Balance, [_1]',
1519 $from_pkg->part_pkg->pkg),
1522 if ( $prev_balance > 0 ) {
1523 # credit the old package, charge the new one
1524 $credit->set('pkgnum', $from_pkgnum);
1525 $cust_bill_pkg->set('pkgnum', $cust_pkg->pkgnum);
1528 $credit->set('pkgnum', $cust_pkg->pkgnum);
1529 $cust_bill_pkg->set('pkgnum', $from_pkgnum);
1531 my $error = $credit->insert;
1532 die "error transferring package balance from #".$from_pkgnum.
1533 " to #".$cust_pkg->pkgnum.": $error\n" if $error;
1535 push @transfers, $cust_bill_pkg;
1536 } # $prev_balance != 0
1541 =item handle_taxes TAXLISTHASH CUST_BILL_PKG [ OPTIONS ]
1543 This is _handle_taxes. It's called once for each cust_bill_pkg generated
1546 TAXLISTHASH is a hashref shared across the entire invoice. It looks like
1549 'cust_main_county 1001' => [ [FS::cust_main_county], ... ],
1550 'cust_main_county 1002' => [ [FS::cust_main_county], ... ],
1553 'cust_main_county' can also be 'tax_rate'. The first object in the array
1554 is always the cust_main_county or tax_rate identified by the key.
1556 That "..." is a list of FS::cust_bill_pkg objects that will be fed to
1557 the 'taxline' method to calculate the amount of the tax. This doesn't
1558 happen until calculate_taxes, though.
1560 OPTIONS may include:
1561 - part_item: a part_pkg or part_fee object to be used as the package/fee
1563 - location: a cust_location to be used as the billing location.
1564 - cancel: true if this package is being billed on cancellation. This
1565 allows tax to be calculated on usage charges only.
1567 If not supplied, part_item will be inferred from the pkgnum or feepart of the
1568 cust_bill_pkg, and location from the pkgnum (or, for fees, the invnum and
1569 the customer's default service location).
1571 This method will also calculate exemptions for any taxes that apply to the
1572 line item (using the C<set_exemptions> method of L<FS::cust_bill_pkg>) and
1573 attach them. This is the only place C<set_exemptions> is called in normal
1580 my $taxlisthash = shift;
1581 my $cust_bill_pkg = shift;
1584 # at this point I realize that we have enough information to infer all this
1585 # stuff, instead of passing around giant honking argument lists
1586 my $location = $options{location} || $cust_bill_pkg->tax_location;
1587 my $part_item = $options{part_item} || $cust_bill_pkg->part_X;
1589 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1591 return if ( $self->payby eq 'COMP' ); #dubious
1593 if ( $conf->exists('enable_taxproducts')
1594 && ( scalar($part_item->part_pkg_taxoverride)
1595 || $part_item->has_taxproduct
1600 # EXTERNAL TAX RATES (via tax_rate)
1601 my %cust_bill_pkg = ();
1605 my $usage = $cust_bill_pkg->usage || 0;
1606 push @classes, $cust_bill_pkg->usage_classes if $usage;
1607 push @classes, 'setup' if $cust_bill_pkg->setup and !$options{cancel};
1608 push @classes, 'recur' if ($cust_bill_pkg->recur - $usage)
1609 and !$options{cancel};
1610 # that's better--probably don't even need $options{cancel} now
1611 # but leave it for now, just to be safe
1613 # About $options{cancel}: This protects against charging per-line or
1614 # per-customer or other flat-rate surcharges on a package that's being
1615 # billed on cancellation (which is an out-of-cycle bill and should only
1616 # have usage charges). See RT#29443.
1618 # customer exemption is now handled in the 'taxline' method
1619 #my $exempt = $conf->exists('cust_class-tax_exempt')
1620 # ? ( $self->cust_class ? $self->cust_class->tax : '' )
1622 # standardize this just to be sure
1623 #$exempt = ($exempt eq 'Y') ? 'Y' : '';
1627 unless (exists $taxes{''}) {
1628 # unsure what purpose this serves, but last time I deleted something
1629 # from here just because I didn't see the point, it actually did
1630 # something important.
1631 my $err_or_ref = $self->_gather_taxes($part_item, '', $location);
1632 return $err_or_ref unless ref($err_or_ref);
1633 $taxes{''} = $err_or_ref;
1636 # NO DISINTEGRATIONS.
1637 # my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
1639 # do not call taxline() with any argument except the entire set of
1640 # cust_bill_pkgs on an invoice that are eligible for the tax.
1642 # only calculate exemptions once for each tax rate, even if it's used
1643 # for multiple classes
1646 foreach my $class (@classes) {
1647 my $err_or_ref = $self->_gather_taxes($part_item, $class, $location);
1648 return $err_or_ref unless ref($err_or_ref);
1649 my @taxes = @$err_or_ref;
1653 foreach my $tax ( @taxes ) {
1655 my $tax_id = ref( $tax ). ' '. $tax->taxnum;
1656 # $taxlisthash: keys are tax identifiers ('FS::tax_rate 123456').
1657 # Values are arrayrefs, first the tax object (cust_main_county
1658 # or tax_rate), then the cust_bill_pkg object that the
1659 # tax applies to, then the tax class (setup, recur, usage classnum).
1660 $taxlisthash->{ $tax_id } ||= [ $tax ];
1661 push @{ $taxlisthash->{ $tax_id } }, $cust_bill_pkg, $class;
1663 # determine any exemptions that apply
1664 if (!$tax_seen{$tax_id}) {
1665 $cust_bill_pkg->set_exemptions( $tax, custnum => $self->custnum );
1666 $tax_seen{$tax_id} = 1;
1669 # tax on tax will be done later, when we actually create the tax
1677 # INTERNAL TAX RATES (cust_main_county)
1679 # We fetch taxes even if the customer is completely exempt,
1680 # because we need to record that fact.
1682 my @loc_keys = qw( district city county state country );
1683 my %taxhash = map { $_ => $location->$_ } @loc_keys;
1685 $taxhash{'taxclass'} = $part_item->taxclass;
1687 warn "taxhash:\n". Dumper(\%taxhash) if $DEBUG > 2;
1689 my @taxes = (); # entries are cust_main_county objects
1690 my %taxhash_elim = %taxhash;
1691 my @elim = qw( district city county state );
1694 #first try a match with taxclass
1695 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1697 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1698 #then try a match without taxclass
1699 my %no_taxclass = %taxhash_elim;
1700 $no_taxclass{ 'taxclass' } = '';
1701 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1704 $taxhash_elim{ shift(@elim) } = '';
1706 } while ( !scalar(@taxes) && scalar(@elim) );
1709 my $tax_id = 'cust_main_county '.$_->taxnum;
1710 $taxlisthash->{$tax_id} ||= [ $_ ];
1711 $cust_bill_pkg->set_exemptions($_, custnum => $self->custnum);
1712 push @{ $taxlisthash->{$tax_id} }, $cust_bill_pkg;
1719 =item _gather_taxes PART_ITEM CLASS CUST_LOCATION
1721 Internal method used with vendor-provided tax tables. PART_ITEM is a part_pkg
1722 or part_fee (which will define the tax eligibility of the product), CLASS is
1723 'setup', 'recur', null, or a C<usage_class> number, and CUST_LOCATION is the
1724 location where the service was provided (or billed, depending on
1725 configuration). Returns an arrayref of L<FS::tax_rate> objects that
1726 can apply to this line item.
1732 my $part_item = shift;
1734 my $location = shift;
1736 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1738 my $geocode = $location->geocode('cch');
1740 [ $part_item->tax_rates('cch', $geocode, $class) ]
1744 =item collect [ HASHREF | OPTION => VALUE ... ]
1746 (Attempt to) collect money for this customer's outstanding invoices (see
1747 L<FS::cust_bill>). Usually used after the bill method.
1749 Actions are now triggered by billing events; see L<FS::part_event> and the
1750 billing events web interface. Old-style invoice events (see
1751 L<FS::part_bill_event>) have been deprecated.
1753 If there is an error, returns the error, otherwise returns false.
1755 Options are passed as name-value pairs.
1757 Currently available options are:
1763 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.
1767 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1771 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1775 set true to surpress email card/ACH decline notices.
1779 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)
1785 # allows for one time override of normal customer billing method
1790 my( $self, %options ) = @_;
1792 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1794 my $invoice_time = $options{'invoice_time'} || time;
1797 local $SIG{HUP} = 'IGNORE';
1798 local $SIG{INT} = 'IGNORE';
1799 local $SIG{QUIT} = 'IGNORE';
1800 local $SIG{TERM} = 'IGNORE';
1801 local $SIG{TSTP} = 'IGNORE';
1802 local $SIG{PIPE} = 'IGNORE';
1804 my $oldAutoCommit = $FS::UID::AutoCommit;
1805 local $FS::UID::AutoCommit = 0;
1808 $self->select_for_update; #mutex
1811 my $balance = $self->balance;
1812 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
1815 if ( exists($options{'retry_card'}) ) {
1816 carp 'retry_card option passed to collect is deprecated; use retry';
1817 $options{'retry'} ||= $options{'retry_card'};
1819 if ( exists($options{'retry'}) && $options{'retry'} ) {
1820 my $error = $self->retry_realtime;
1822 $dbh->rollback if $oldAutoCommit;
1827 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1829 #never want to roll back an event just because it returned an error
1830 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1832 $self->do_cust_event(
1833 'debug' => ( $options{'debug'} || 0 ),
1834 'time' => $invoice_time,
1835 'check_freq' => $options{'check_freq'},
1836 'stage' => 'collect',
1841 =item retry_realtime
1843 Schedules realtime / batch credit card / electronic check / LEC billing
1844 events for for retry. Useful if card information has changed or manual
1845 retry is desired. The 'collect' method must be called to actually retry
1848 Implementation details: For either this customer, or for each of this
1849 customer's open invoices, changes the status of the first "done" (with
1850 statustext error) realtime processing event to "failed".
1854 sub retry_realtime {
1857 local $SIG{HUP} = 'IGNORE';
1858 local $SIG{INT} = 'IGNORE';
1859 local $SIG{QUIT} = 'IGNORE';
1860 local $SIG{TERM} = 'IGNORE';
1861 local $SIG{TSTP} = 'IGNORE';
1862 local $SIG{PIPE} = 'IGNORE';
1864 my $oldAutoCommit = $FS::UID::AutoCommit;
1865 local $FS::UID::AutoCommit = 0;
1868 #a little false laziness w/due_cust_event (not too bad, really)
1870 # I guess this is always as of now?
1871 my $join = FS::part_event_condition->join_conditions_sql('', 'time' => time);
1872 my $order = FS::part_event_condition->order_conditions_sql;
1875 . join ( ' OR ' , map {
1876 my $cust_join = FS::part_event->eventtables_cust_join->{$_} || '';
1877 my $custnum = FS::part_event->eventtables_custnum->{$_};
1878 "( part_event.eventtable = " . dbh->quote($_)
1879 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key
1880 . " from $_ $cust_join"
1881 . " where $custnum = " . dbh->quote( $self->custnum ) . "))" ;
1882 } FS::part_event->eventtables)
1885 #here is the agent virtualization
1886 my $agent_virt = " ( part_event.agentnum IS NULL
1887 OR part_event.agentnum = ". $self->agentnum. ' )';
1889 #XXX this shouldn't be hardcoded, actions should declare it...
1890 my @realtime_events = qw(
1891 cust_bill_realtime_card
1892 cust_bill_realtime_check
1893 cust_bill_realtime_lec
1897 my $is_realtime_event =
1898 ' part_event.action IN ( '.
1899 join(',', map "'$_'", @realtime_events ).
1902 my $batch_or_statustext =
1903 "( part_event.action = 'cust_bill_batch'
1904 OR ( statustext IS NOT NULL AND statustext != '' )
1908 my @cust_event = qsearch({
1909 'table' => 'cust_event',
1910 'select' => 'cust_event.*',
1911 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
1912 'hashref' => { 'status' => 'done' },
1913 'extra_sql' => " AND $batch_or_statustext ".
1914 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
1917 my %seen_invnum = ();
1918 foreach my $cust_event (@cust_event) {
1920 #max one for the customer, one for each open invoice
1921 my $cust_X = $cust_event->cust_X;
1922 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
1926 or $cust_event->part_event->eventtable eq 'cust_bill'
1929 my $error = $cust_event->retry;
1931 $dbh->rollback if $oldAutoCommit;
1932 return "error scheduling event for retry: $error";
1937 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1942 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
1944 Runs billing events; see L<FS::part_event> and the billing events web
1947 If there is an error, returns the error, otherwise returns false.
1949 Options are passed as name-value pairs.
1951 Currently available options are:
1957 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.
1961 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1965 "collect" (the default) or "pre-bill"
1969 set true to surpress email card/ACH decline notices.
1973 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)
1980 # allows for one time override of normal customer billing method
1984 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1987 my( $self, %options ) = @_;
1989 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1991 my $time = $options{'time'} || time;
1994 local $SIG{HUP} = 'IGNORE';
1995 local $SIG{INT} = 'IGNORE';
1996 local $SIG{QUIT} = 'IGNORE';
1997 local $SIG{TERM} = 'IGNORE';
1998 local $SIG{TSTP} = 'IGNORE';
1999 local $SIG{PIPE} = 'IGNORE';
2001 my $oldAutoCommit = $FS::UID::AutoCommit;
2002 local $FS::UID::AutoCommit = 0;
2005 $self->select_for_update; #mutex
2008 my $balance = $self->balance;
2009 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
2012 # if ( exists($options{'retry_card'}) ) {
2013 # carp 'retry_card option passed to collect is deprecated; use retry';
2014 # $options{'retry'} ||= $options{'retry_card'};
2016 # if ( exists($options{'retry'}) && $options{'retry'} ) {
2017 # my $error = $self->retry_realtime;
2019 # $dbh->rollback if $oldAutoCommit;
2024 # false laziness w/pay_batch::import_results
2026 my $due_cust_event = $self->due_cust_event(
2027 'debug' => ( $options{'debug'} || 0 ),
2029 'check_freq' => $options{'check_freq'},
2030 'stage' => ( $options{'stage'} || 'collect' ),
2032 unless( ref($due_cust_event) ) {
2033 $dbh->rollback if $oldAutoCommit;
2034 return $due_cust_event;
2037 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2038 #never want to roll back an event just because it or a different one
2040 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
2042 foreach my $cust_event ( @$due_cust_event ) {
2046 #re-eval event conditions (a previous event could have changed things)
2047 unless ( $cust_event->test_conditions ) {
2048 #don't leave stray "new/locked" records around
2049 my $error = $cust_event->delete;
2050 return $error if $error;
2055 local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
2056 if $options{'quiet'};
2057 warn " running cust_event ". $cust_event->eventnum. "\n"
2060 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
2061 if ( my $error = $cust_event->do_event( 'time' => $time ) ) {
2062 #XXX wtf is this? figure out a proper dealio with return value
2074 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
2076 Inserts database records for and returns an ordered listref of new events due
2077 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
2078 events are due, an empty listref is returned. If there is an error, returns a
2079 scalar error message.
2081 To actually run the events, call each event's test_condition method, and if
2082 still true, call the event's do_event method.
2084 Options are passed as a hashref or as a list of name-value pairs. Available
2091 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.
2095 "collect" (the default) or "pre-bill"
2099 "Current time" for the events.
2103 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)
2107 Only return events for the specified eventtable (by default, events of all eventtables are returned)
2111 Explicitly pass the objects to be tested (typically used with eventtable).
2115 Set to true to return the objects, but not actually insert them into the
2122 sub due_cust_event {
2124 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
2127 #my $DEBUG = $opt{'debug'}
2128 $opt{'debug'} ||= 0; # silence some warnings
2129 local($DEBUG) = $opt{'debug'}
2130 if $opt{'debug'} > $DEBUG;
2131 $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
2133 warn "$me due_cust_event called with options ".
2134 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
2137 $opt{'time'} ||= time;
2139 local $SIG{HUP} = 'IGNORE';
2140 local $SIG{INT} = 'IGNORE';
2141 local $SIG{QUIT} = 'IGNORE';
2142 local $SIG{TERM} = 'IGNORE';
2143 local $SIG{TSTP} = 'IGNORE';
2144 local $SIG{PIPE} = 'IGNORE';
2146 my $oldAutoCommit = $FS::UID::AutoCommit;
2147 local $FS::UID::AutoCommit = 0;
2150 $self->select_for_update #mutex
2151 unless $opt{testonly};
2154 # find possible events (initial search)
2157 my @cust_event = ();
2159 my @eventtable = $opt{'eventtable'}
2160 ? ( $opt{'eventtable'} )
2161 : FS::part_event->eventtables_runorder;
2163 my $check_freq = $opt{'check_freq'} || '1d';
2165 foreach my $eventtable ( @eventtable ) {
2168 if ( $opt{'objects'} ) {
2170 @objects = @{ $opt{'objects'} };
2172 } elsif ( $eventtable eq 'cust_main' ) {
2174 @objects = ( $self );
2178 my $cm_join = " LEFT JOIN cust_main USING ( custnum )";
2179 # linkage not needed here because FS::cust_main->$eventtable will
2182 #some false laziness w/Cron::bill bill_where
2184 my $join = FS::part_event_condition->join_conditions_sql( $eventtable,
2185 'time' => $opt{'time'});
2186 my $where = FS::part_event_condition->where_conditions_sql($eventtable,
2187 'time'=>$opt{'time'},
2189 $where = $where ? "AND $where" : '';
2191 my $are_part_event =
2192 "EXISTS ( SELECT 1 FROM part_event $join
2193 WHERE check_freq = '$check_freq'
2194 AND eventtable = '$eventtable'
2195 AND ( disabled = '' OR disabled IS NULL )
2201 @objects = $self->$eventtable(
2202 'addl_from' => $cm_join,
2203 'extra_sql' => " AND $are_part_event",
2205 } # if ( !$opt{objects} and $eventtable ne 'cust_main' )
2207 my @e_cust_event = ();
2209 my $linkage = FS::part_event->eventtables_cust_join->{$eventtable} || '';
2211 my $cross = "CROSS JOIN $eventtable $linkage";
2212 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
2213 unless $eventtable eq 'cust_main';
2215 foreach my $object ( @objects ) {
2217 #this first search uses the condition_sql magic for optimization.
2218 #the more possible events we can eliminate in this step the better
2220 my $cross_where = '';
2221 my $pkey = $object->primary_key;
2222 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
2224 my $join = FS::part_event_condition->join_conditions_sql( $eventtable,
2225 'time' => $opt{'time'});
2227 FS::part_event_condition->where_conditions_sql( $eventtable,
2228 'time'=>$opt{'time'}
2230 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
2232 $extra_sql = "AND $extra_sql" if $extra_sql;
2234 #here is the agent virtualization
2235 $extra_sql .= " AND ( part_event.agentnum IS NULL
2236 OR part_event.agentnum = ". $self->agentnum. ' )';
2238 $extra_sql .= " $order";
2240 warn "searching for events for $eventtable ". $object->$pkey. "\n"
2241 if $opt{'debug'} > 2;
2242 my @part_event = qsearch( {
2243 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
2244 'select' => 'part_event.*',
2245 'table' => 'part_event',
2246 'addl_from' => "$cross $join",
2247 'hashref' => { 'check_freq' => $check_freq,
2248 'eventtable' => $eventtable,
2251 'extra_sql' => "AND $cross_where $extra_sql",
2255 my $pkey = $object->primary_key;
2256 warn " ". scalar(@part_event).
2257 " possible events found for $eventtable ". $object->$pkey(). "\n";
2260 push @e_cust_event, map {
2261 $_->new_cust_event($object, 'time' => $opt{'time'})
2266 warn " ". scalar(@e_cust_event).
2267 " subtotal possible cust events found for $eventtable\n"
2270 push @cust_event, @e_cust_event;
2274 warn " ". scalar(@cust_event).
2275 " total possible cust events found in initial search\n"
2283 $opt{stage} ||= 'collect';
2285 grep { my $stage = $_->part_event->event_stage;
2286 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
2296 @cust_event = grep $_->test_conditions( 'stats_hashref' => \%unsat ),
2299 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
2302 warn " invalid conditions not eliminated with condition_sql:\n".
2303 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
2304 if keys %unsat && $DEBUG; # > 1;
2310 unless( $opt{testonly} ) {
2311 foreach my $cust_event ( @cust_event ) {
2313 my $error = $cust_event->insert();
2315 $dbh->rollback if $oldAutoCommit;
2322 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2328 warn " returning events: ". Dumper(@cust_event). "\n"
2335 =item apply_payments_and_credits [ OPTION => VALUE ... ]
2337 Applies unapplied payments and credits.
2339 In most cases, this new method should be used in place of sequential
2340 apply_payments and apply_credits methods.
2342 A hash of optional arguments may be passed. Currently "manual" is supported.
2343 If true, a payment receipt is sent instead of a statement when
2344 'payment_receipt_email' configuration option is set.
2346 If there is an error, returns the error, otherwise returns false.
2350 sub apply_payments_and_credits {
2351 my( $self, %options ) = @_;
2353 local $SIG{HUP} = 'IGNORE';
2354 local $SIG{INT} = 'IGNORE';
2355 local $SIG{QUIT} = 'IGNORE';
2356 local $SIG{TERM} = 'IGNORE';
2357 local $SIG{TSTP} = 'IGNORE';
2358 local $SIG{PIPE} = 'IGNORE';
2360 my $oldAutoCommit = $FS::UID::AutoCommit;
2361 local $FS::UID::AutoCommit = 0;
2364 $self->select_for_update; #mutex
2366 foreach my $cust_bill ( $self->open_cust_bill ) {
2367 my $error = $cust_bill->apply_payments_and_credits(%options);
2369 $dbh->rollback if $oldAutoCommit;
2370 return "Error applying: $error";
2374 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2379 =item apply_credits OPTION => VALUE ...
2381 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
2382 to outstanding invoice balances in chronological order (or reverse
2383 chronological order if the I<order> option is set to B<newest>) and returns the
2384 value of any remaining unapplied credits available for refund (see
2385 L<FS::cust_refund>).
2387 Dies if there is an error.
2395 local $SIG{HUP} = 'IGNORE';
2396 local $SIG{INT} = 'IGNORE';
2397 local $SIG{QUIT} = 'IGNORE';
2398 local $SIG{TERM} = 'IGNORE';
2399 local $SIG{TSTP} = 'IGNORE';
2400 local $SIG{PIPE} = 'IGNORE';
2402 my $oldAutoCommit = $FS::UID::AutoCommit;
2403 local $FS::UID::AutoCommit = 0;
2406 $self->select_for_update; #mutex
2408 unless ( $self->total_unapplied_credits ) {
2409 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2413 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
2414 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
2416 my @invoices = $self->open_cust_bill;
2417 @invoices = sort { $b->_date <=> $a->_date } @invoices
2418 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
2420 if ( $conf->exists('pkg-balances') ) {
2421 # limit @credits to those w/ a pkgnum grepped from $self
2423 foreach my $i (@invoices) {
2424 foreach my $li ( $i->cust_bill_pkg ) {
2425 $pkgnums{$li->pkgnum} = 1;
2428 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
2433 foreach my $cust_bill ( @invoices ) {
2435 if ( !defined($credit) || $credit->credited == 0) {
2436 $credit = pop @credits or last;
2440 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
2441 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
2443 $owed = $cust_bill->owed;
2445 unless ( $owed > 0 ) {
2446 push @credits, $credit;
2450 my $amount = min( $credit->credited, $owed );
2452 my $cust_credit_bill = new FS::cust_credit_bill ( {
2453 'crednum' => $credit->crednum,
2454 'invnum' => $cust_bill->invnum,
2455 'amount' => $amount,
2457 $cust_credit_bill->pkgnum( $credit->pkgnum )
2458 if $conf->exists('pkg-balances') && $credit->pkgnum;
2459 my $error = $cust_credit_bill->insert;
2461 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2465 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2469 my $total_unapplied_credits = $self->total_unapplied_credits;
2471 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2473 return $total_unapplied_credits;
2476 =item apply_payments [ OPTION => VALUE ... ]
2478 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2479 to outstanding invoice balances in chronological order.
2481 #and returns the value of any remaining unapplied payments.
2483 A hash of optional arguments may be passed. Currently "manual" is supported.
2484 If true, a payment receipt is sent instead of a statement when
2485 'payment_receipt_email' configuration option is set.
2487 Dies if there is an error.
2491 sub apply_payments {
2492 my( $self, %options ) = @_;
2494 local $SIG{HUP} = 'IGNORE';
2495 local $SIG{INT} = 'IGNORE';
2496 local $SIG{QUIT} = 'IGNORE';
2497 local $SIG{TERM} = 'IGNORE';
2498 local $SIG{TSTP} = 'IGNORE';
2499 local $SIG{PIPE} = 'IGNORE';
2501 my $oldAutoCommit = $FS::UID::AutoCommit;
2502 local $FS::UID::AutoCommit = 0;
2505 $self->select_for_update; #mutex
2509 my @payments = $self->unapplied_cust_pay;
2511 my @invoices = $self->open_cust_bill;
2513 if ( $conf->exists('pkg-balances') ) {
2514 # limit @payments to those w/ a pkgnum grepped from $self
2516 foreach my $i (@invoices) {
2517 foreach my $li ( $i->cust_bill_pkg ) {
2518 $pkgnums{$li->pkgnum} = 1;
2521 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
2526 foreach my $cust_bill ( @invoices ) {
2528 if ( !defined($payment) || $payment->unapplied == 0 ) {
2529 $payment = pop @payments or last;
2533 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
2534 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
2536 $owed = $cust_bill->owed;
2538 unless ( $owed > 0 ) {
2539 push @payments, $payment;
2543 my $amount = min( $payment->unapplied, $owed );
2546 'paynum' => $payment->paynum,
2547 'invnum' => $cust_bill->invnum,
2548 'amount' => $amount,
2550 $cbp->{_date} = $payment->_date
2551 if $options{'manual'} && $options{'backdate_application'};
2552 my $cust_bill_pay = new FS::cust_bill_pay($cbp);
2553 $cust_bill_pay->pkgnum( $payment->pkgnum )
2554 if $conf->exists('pkg-balances') && $payment->pkgnum;
2555 my $error = $cust_bill_pay->insert(%options);
2557 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2561 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2565 my $total_unapplied_payments = $self->total_unapplied_payments;
2567 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2569 return $total_unapplied_payments;
2579 suspend_adjourned_pkgs
2580 unsuspend_resumed_pkgs
2583 (do_cust_event pre-bill)
2586 (vendor-only) _gather_taxes
2587 _omit_zero_value_bundles
2588 _handle_taxes (for fees)
2591 apply_payments_and_credits
2600 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>