1 package FS::cust_main::Billing;
4 use vars qw( $conf $DEBUG $me );
7 use List::Util qw( min );
9 use FS::Record qw( qsearch qsearchs dbdef );
10 use FS::Misc::DateTime qw( day_end );
12 use FS::cust_bill_pkg;
13 use FS::cust_bill_pkg_display;
14 use FS::cust_bill_pay;
15 use FS::cust_credit_bill;
16 use FS::cust_tax_adjustment;
18 use FS::tax_rate_location;
19 use FS::cust_bill_pkg_tax_location;
20 use FS::cust_bill_pkg_tax_rate_location;
22 use FS::part_event_condition;
24 use FS::cust_event_fee;
27 # 1 is mostly method/subroutine entry and options
28 # 2 traces progress of some operations
29 # 3 is even more information including possibly sensitive data
31 $me = '[FS::cust_main::Billing]';
33 install_callback FS::UID sub {
35 #yes, need it for stuff below (prolly should be cached)
40 FS::cust_main::Billing - Billing mixin for cust_main
46 These methods are available on FS::cust_main objects.
52 =item bill_and_collect
54 Cancels and suspends any packages due, generates bills, applies payments and
55 credits, and applies collection events to run cards, send bills and notices,
58 By default, warns on errors and continues with the next operation (but see the
61 Options are passed as name-value pairs. Currently available options are:
67 Bills the customer as if it were that time. Specified as a UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion functions. For example:
71 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
75 Used in conjunction with the I<time> option, this option specifies the date of for the generated invoices. Other calculations, such as whether or not to generate the invoice in the first place, are not affected.
79 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
83 If set true, re-charges setup fees.
87 If set any errors prevent subsequent operations from continusing. If set
88 specifically to "return", returns the error (or false, if there is no error).
89 Any other true value causes errors to die.
93 Debugging level. Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
97 Optional FS::queue entry to receive status updates.
101 Options are passed to the B<bill> and B<collect> methods verbatim, so all
102 options of those methods are also available.
106 sub bill_and_collect {
107 my( $self, %options ) = @_;
109 my $log = FS::Log->new('bill_and_collect');
110 $log->debug('start', object => $self, agentnum => $self->agentnum);
114 #$options{actual_time} not $options{time} because freeside-daily -d is for
115 #pre-printing invoices
117 $options{'actual_time'} ||= time;
118 my $job = $options{'job'};
120 my $actual_time = ( $conf->exists('next-bill-ignore-time')
121 ? day_end( $options{actual_time} )
122 : $options{actual_time}
125 $job->update_statustext('0,cleaning expired packages') if $job;
126 $error = $self->cancel_expired_pkgs( $actual_time );
128 $error = "Error expiring custnum ". $self->custnum. ": $error";
129 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
130 elsif ( $options{fatal} ) { die $error; }
131 else { warn $error; }
134 $error = $self->suspend_adjourned_pkgs( $actual_time );
136 $error = "Error adjourning custnum ". $self->custnum. ": $error";
137 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
138 elsif ( $options{fatal} ) { die $error; }
139 else { warn $error; }
142 $error = $self->unsuspend_resumed_pkgs( $actual_time );
144 $error = "Error resuming custnum ".$self->custnum. ": $error";
145 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
146 elsif ( $options{fatal} ) { die $error; }
147 else { warn $error; }
150 $job->update_statustext('20,billing packages') if $job;
151 $error = $self->bill( %options );
153 $error = "Error billing custnum ". $self->custnum. ": $error";
154 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
155 elsif ( $options{fatal} ) { die $error; }
156 else { warn $error; }
159 $job->update_statustext('50,applying payments and credits') if $job;
160 $error = $self->apply_payments_and_credits;
162 $error = "Error applying custnum ". $self->custnum. ": $error";
163 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
164 elsif ( $options{fatal} ) { die $error; }
165 else { warn $error; }
168 $job->update_statustext('70,running collection events') if $job;
169 unless ( $conf->exists('cancelled_cust-noevents')
170 && ! $self->num_ncancelled_pkgs
172 $error = $self->collect( %options );
174 $error = "Error collecting custnum ". $self->custnum. ": $error";
175 if ($options{fatal} && $options{fatal} eq 'return') { return $error; }
176 elsif ($options{fatal} ) { die $error; }
177 else { warn $error; }
180 $job->update_statustext('100,finished') if $job;
181 $log->debug('finish', object => $self, agentnum => $self->agentnum);
187 sub cancel_expired_pkgs {
188 my ( $self, $time, %options ) = @_;
190 my @cancel_pkgs = $self->ncancelled_pkgs( {
191 'extra_sql' => " AND expire IS NOT NULL AND expire > 0 AND expire <= $time "
196 CUST_PKG: foreach my $cust_pkg ( @cancel_pkgs ) {
197 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
200 if ( $cust_pkg->change_to_pkgnum ) {
202 my $new_pkg = FS::cust_pkg->by_key($cust_pkg->change_to_pkgnum);
204 push @errors, 'can\'t change pkgnum '.$cust_pkg->pkgnum.' to pkgnum '.
205 $cust_pkg->change_to_pkgnum.'; not expiring';
208 $error = $cust_pkg->change( 'cust_pkg' => $new_pkg,
209 'unprotect_svcs' => 1 );
210 $error = '' if ref $error eq 'FS::cust_pkg';
212 } else { # just cancel it
213 $error = $cust_pkg->cancel($cpr ? ( 'reason' => $cpr->reasonnum,
214 'reason_otaker' => $cpr->otaker,
220 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
223 join(' / ', @errors);
227 sub suspend_adjourned_pkgs {
228 my ( $self, $time, %options ) = @_;
230 my @susp_pkgs = $self->ncancelled_pkgs( {
232 " AND ( susp IS NULL OR susp = 0 )
233 AND ( ( bill IS NOT NULL AND bill != 0 AND bill < $time )
234 OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
239 #only because there's no SQL test for is_prepaid :/
241 grep { ( $_->part_pkg->is_prepaid
246 && $_->adjourn <= $time
254 foreach my $cust_pkg ( @susp_pkgs ) {
255 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
256 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
257 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
258 'reason_otaker' => $cpr->otaker
262 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
265 join(' / ', @errors);
269 sub unsuspend_resumed_pkgs {
270 my ( $self, $time, %options ) = @_;
272 my @unsusp_pkgs = $self->ncancelled_pkgs( {
273 'extra_sql' => " AND resume IS NOT NULL AND resume > 0 AND resume <= $time "
278 foreach my $cust_pkg ( @unsusp_pkgs ) {
279 my $error = $cust_pkg->unsuspend( 'time' => $time );
280 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
283 join(' / ', @errors);
289 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
290 conjunction with the collect method by calling B<bill_and_collect>.
292 If there is an error, returns the error, otherwise returns false.
294 Options are passed as name-value pairs. Currently available options are:
300 If set true, re-charges setup fees.
304 If set true then only bill recurring charges, not setup, usage, one time
309 If set, then override the normal frequency and look for a part_pkg_discount
310 to take at that frequency. This is appropriate only when the normal
311 frequency for all packages is monthly, and is an error otherwise. Use
312 C<pkg_list> to limit the set of packages included in billing.
316 Bills the customer as if it were that time. Specified as a UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion functions. For example:
320 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
324 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
326 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
330 A hashref of pkgparts to exclude from this billing run (can also be specified as a comma-separated scalar).
334 Do not bill prepaid packages. Used by freeside-daily.
338 Used in conjunction with the I<time> option, this option specifies the date of for the generated invoices. Other calculations, such as whether or not to generate the invoice in the first place, are not affected.
342 This boolean value informs the us that the package is being cancelled. This
343 typically might mean not charging the normal recurring fee but only usage
344 fees since the last billing. Setup charges may be charged. Not all package
345 plans support this feature (they tend to charge 0).
349 Prevent the resetting of usage limits during this call.
353 Do not save the generated bill in the database. Useful with return_bill
357 A list reference on which the generated bill(s) will be returned.
361 Optional terms to be printed on this invoice. Otherwise, customer-specific
362 terms or the default terms are used.
369 my( $self, %options ) = @_;
371 return '' if $self->payby eq 'COMP';
373 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
375 warn "$me bill customer ". $self->custnum. "\n"
378 my $time = $options{'time'} || time;
379 my $invoice_time = $options{'invoice_time'} || $time;
381 my $cmp_time = ( $conf->exists('next-bill-ignore-time')
386 $options{'not_pkgpart'} ||= {};
387 $options{'not_pkgpart'} = { map { $_ => 1 }
388 split(/\s*,\s*/, $options{'not_pkgpart'})
390 unless ref($options{'not_pkgpart'});
392 local $SIG{HUP} = 'IGNORE';
393 local $SIG{INT} = 'IGNORE';
394 local $SIG{QUIT} = 'IGNORE';
395 local $SIG{TERM} = 'IGNORE';
396 local $SIG{TSTP} = 'IGNORE';
397 local $SIG{PIPE} = 'IGNORE';
399 my $oldAutoCommit = $FS::UID::AutoCommit;
400 local $FS::UID::AutoCommit = 0;
403 warn "$me acquiring lock on customer ". $self->custnum. "\n"
406 $self->select_for_update; #mutex
408 warn "$me running pre-bill events for customer ". $self->custnum. "\n"
411 my $error = $self->do_cust_event(
412 'debug' => ( $options{'debug'} || 0 ),
413 'time' => $invoice_time,
414 'check_freq' => $options{'check_freq'},
415 'stage' => 'pre-bill',
417 unless $options{no_commit};
419 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
423 warn "$me done running pre-bill events for customer ". $self->custnum. "\n"
426 #keep auto-charge and non-auto-charge line items separate
427 my @passes = ( '', 'no_auto' );
429 my %cust_bill_pkg = map { $_ => [] } @passes;
432 # find the packages which are due for billing, find out how much they are
433 # & generate invoice database.
436 my %total_setup = map { my $z = 0; $_ => \$z; } @passes;
437 my %total_recur = map { my $z = 0; $_ => \$z; } @passes;
439 my %taxlisthash = map { $_ => {} } @passes;
441 my @precommit_hooks = ();
443 $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ]; #param checks?
445 foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
447 next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
449 my $part_pkg = $cust_pkg->part_pkg;
451 next if $options{'no_prepaid'} && $part_pkg->is_prepaid;
453 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG;
455 #? to avoid use of uninitialized value errors... ?
456 $cust_pkg->setfield('bill', '')
457 unless defined($cust_pkg->bill);
459 my $real_pkgpart = $cust_pkg->pkgpart;
460 my %hash = $cust_pkg->hash;
462 # we could implement this bit as FS::part_pkg::has_hidden, but we already
463 # suffer from performance issues
464 $options{has_hidden} = 0;
465 my @part_pkg = $part_pkg->self_and_bill_linked;
466 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
468 # if this package was changed from another package,
469 # and it hasn't been billed since then,
470 # and package balances are enabled,
471 if ( $cust_pkg->change_pkgnum
472 and $cust_pkg->change_date >= ($cust_pkg->last_bill || 0)
473 and $cust_pkg->change_date < $invoice_time
474 and $conf->exists('pkg-balances') )
476 # _transfer_balance will also create the appropriate credit
477 my @transfer_items = $self->_transfer_balance($cust_pkg);
478 # $part_pkg[0] is the "real" part_pkg
479 my $pass = ($cust_pkg->no_auto || $part_pkg[0]->no_auto) ?
481 push @{ $cust_bill_pkg{$pass} }, @transfer_items;
482 # treating this as recur, just because most charges are recur...
483 ${$total_recur{$pass}} += $_->recur foreach @transfer_items;
486 foreach my $part_pkg ( @part_pkg ) {
488 $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
490 my $pass = ($cust_pkg->no_auto || $part_pkg->no_auto) ? 'no_auto' : '';
492 my $next_bill = $cust_pkg->getfield('bill') || 0;
494 # let this run once if this is the last bill upon cancellation
495 while ( $next_bill <= $cmp_time or $options{cancel} ) {
497 $self->_make_lines( 'part_pkg' => $part_pkg,
498 'cust_pkg' => $cust_pkg,
499 'precommit_hooks' => \@precommit_hooks,
500 'line_items' => $cust_bill_pkg{$pass},
501 'setup' => $total_setup{$pass},
502 'recur' => $total_recur{$pass},
503 'tax_matrix' => $taxlisthash{$pass},
505 'real_pkgpart' => $real_pkgpart,
506 'options' => \%options,
509 # Stop if anything goes wrong
512 # or if we're not incrementing the bill date.
513 last if ($cust_pkg->getfield('bill') || 0) == $next_bill;
515 # or if we're letting it run only once
516 last if $options{cancel};
518 $next_bill = $cust_pkg->getfield('bill') || 0;
520 #stop if -o was passed to freeside-daily
521 last if $options{'one_recur'};
524 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
528 } #foreach my $part_pkg
530 } #foreach my $cust_pkg
532 #if the customer isn't on an automatic payby, everything can go on a single
534 #if ( $cust_main->payby !~ /^(CARD|CHEK)$/ ) {
535 #merge everything into one list
538 foreach my $pass (@passes) { # keys %cust_bill_pkg ) {
540 my @cust_bill_pkg = _omit_zero_value_bundles(@{ $cust_bill_pkg{$pass} });
542 warn "$me billing pass $pass\n"
543 #.Dumper(\@cust_bill_pkg)."\n"
550 my @pending_event_fees = FS::cust_event_fee->by_cust($self->custnum,
551 hashref => { 'billpkgnum' => '' }
553 warn "$me found pending fee events:\n".Dumper(\@pending_event_fees)."\n"
554 if @pending_event_fees and $DEBUG > 1;
556 # determine whether to generate an invoice
557 my $generate_bill = scalar(@cust_bill_pkg) > 0;
559 foreach my $event_fee (@pending_event_fees) {
560 $generate_bill = 1 unless $event_fee->nextbill;
563 # don't create an invoice with no line items, or where the only line
564 # items are fees that are supposed to be held until the next invoice
565 next if !$generate_bill;
569 foreach my $event_fee (@pending_event_fees) {
570 my $object = $event_fee->cust_event->cust_X;
571 my $part_fee = $event_fee->part_fee;
573 if ( $object->isa('FS::cust_main')
574 or $object->isa('FS::cust_pkg')
575 or $object->isa('FS::cust_pay_batch') )
577 # Not the real cust_bill object that will be inserted--in particular
578 # there are no taxes yet. If you want to charge a fee on the total
579 # invoice amount including taxes, you have to put the fee on the next
581 $cust_bill = FS::cust_bill->new({
582 'custnum' => $self->custnum,
583 'cust_bill_pkg' => \@cust_bill_pkg,
584 'charged' => ${ $total_setup{$pass} } +
585 ${ $total_recur{$pass} },
588 # If this is a package event, only apply the fee to line items
590 if ($object->isa('FS::cust_pkg')) {
591 $cust_bill->set('cust_bill_pkg',
592 [ grep { $_->pkgnum == $object->pkgnum } @cust_bill_pkg ]
596 } elsif ( $object->isa('FS::cust_bill') ) {
597 # simple case: applying the fee to a previous invoice (late fee,
599 $cust_bill = $object;
601 # if the fee def belongs to a different agent, don't charge the fee.
602 # event conditions should prevent this, but just in case they don't,
604 if ( $part_fee->agentnum and $part_fee->agentnum != $self->agentnum ) {
605 warn "tried to charge fee#".$part_fee->feepart .
606 " on customer#".$self->custnum." from a different agent.\n";
609 # also skip if it's disabled
610 next if $part_fee->disabled eq 'Y';
612 my $fee_item = $part_fee->lineitem($cust_bill) or next;
613 # link this so that we can clear the marker on inserting the line item
614 $fee_item->set('cust_event_fee', $event_fee);
615 push @fee_items, $fee_item;
619 # add fees to the invoice
620 foreach my $fee_item (@fee_items) {
622 push @cust_bill_pkg, $fee_item;
623 ${ $total_setup{$pass} } += $fee_item->setup;
624 ${ $total_recur{$pass} } += $fee_item->recur;
626 my $part_fee = $fee_item->part_fee;
627 my $fee_location = $self->ship_location; # I think?
629 my $error = $self->_handle_taxes(
632 location => $fee_location
633 # probably not right to pass cancel => 1 for fees
635 return $error if $error;
639 # XXX implementation of fees is supposed to make this go away...
640 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
641 !$conf->exists('postal_invoice-recurring_only')
645 my $postal_pkg = $self->charge_postal_fee();
646 if ( $postal_pkg && !ref( $postal_pkg ) ) {
648 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
649 return "can't charge postal invoice fee for customer ".
650 $self->custnum. ": $postal_pkg";
652 } elsif ( $postal_pkg ) {
654 my $real_pkgpart = $postal_pkg->pkgpart;
655 # we could implement this bit as FS::part_pkg::has_hidden, but we already
656 # suffer from performance issues
657 $options{has_hidden} = 0;
658 my @part_pkg = $postal_pkg->part_pkg->self_and_bill_linked;
659 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
661 foreach my $part_pkg ( @part_pkg ) {
662 my %postal_options = %options;
663 delete $postal_options{cancel};
665 $self->_make_lines( 'part_pkg' => $part_pkg,
666 'cust_pkg' => $postal_pkg,
667 'precommit_hooks' => \@precommit_hooks,
668 'line_items' => \@cust_bill_pkg,
669 'setup' => $total_setup{$pass},
670 'recur' => $total_recur{$pass},
671 'tax_matrix' => $taxlisthash{$pass},
673 'real_pkgpart' => $real_pkgpart,
674 'options' => \%postal_options,
677 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
682 # it's silly to have a zero value postal_pkg, but....
683 @cust_bill_pkg = _omit_zero_value_bundles(@cust_bill_pkg);
689 my $listref_or_error =
690 $self->calculate_taxes( \@cust_bill_pkg, $taxlisthash{$pass}, $invoice_time);
692 unless ( ref( $listref_or_error ) ) {
693 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
694 return $listref_or_error;
697 foreach my $taxline ( @$listref_or_error ) {
698 ${ $total_setup{$pass} } =
699 sprintf('%.2f', ${ $total_setup{$pass} } + $taxline->setup );
700 push @cust_bill_pkg, $taxline;
704 warn "adding tax adjustments...\n" if $DEBUG > 2;
705 foreach my $cust_tax_adjustment (
706 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
712 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
714 my $itemdesc = $cust_tax_adjustment->taxname;
715 $itemdesc = '' if $itemdesc eq 'Tax';
717 push @cust_bill_pkg, new FS::cust_bill_pkg {
723 'itemdesc' => $itemdesc,
724 'itemcomment' => $cust_tax_adjustment->comment,
725 'cust_tax_adjustment' => $cust_tax_adjustment,
726 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
731 my $charged = sprintf('%.2f', ${ $total_setup{$pass} } + ${ $total_recur{$pass} } );
733 my @cust_bill = $self->cust_bill;
734 my $balance = $self->balance;
735 my $previous_bill = $cust_bill[-1] if @cust_bill;
736 my $previous_balance = 0;
737 if ( $previous_bill ) {
738 $previous_balance = $previous_bill->billing_balance
739 + $previous_bill->charged;
742 warn "creating the new invoice\n" if $DEBUG;
743 #create the new invoice
744 my $cust_bill = new FS::cust_bill ( {
745 'custnum' => $self->custnum,
746 '_date' => $invoice_time,
747 'charged' => $charged,
748 'billing_balance' => $balance,
749 'previous_balance' => $previous_balance,
750 'invoice_terms' => $options{'invoice_terms'},
751 'cust_bill_pkg' => \@cust_bill_pkg,
753 $error = $cust_bill->insert unless $options{no_commit};
755 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
756 return "can't create invoice for customer #". $self->custnum. ": $error";
758 push @{$options{return_bill}}, $cust_bill if $options{return_bill};
760 } #foreach my $pass ( keys %cust_bill_pkg )
762 foreach my $hook ( @precommit_hooks ) {
765 } unless $options{no_commit};
767 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
768 return "$@ running precommit hook $hook\n";
772 $dbh->commit or die $dbh->errstr if $oldAutoCommit && !$options{no_commit};
777 #discard bundled packages of 0 value
778 sub _omit_zero_value_bundles {
781 my @cust_bill_pkg = ();
782 my @cust_bill_pkg_bundle = ();
784 my $discount_show_always = 0;
786 foreach my $cust_bill_pkg ( @in ) {
788 $discount_show_always = ($cust_bill_pkg->get('discounts')
789 && scalar(@{$cust_bill_pkg->get('discounts')})
790 && $conf->exists('discount-show-always'));
792 warn " pkgnum ". $cust_bill_pkg->pkgnum. " sum $sum, ".
793 "setup_show_zero ". $cust_bill_pkg->setup_show_zero.
794 "recur_show_zero ". $cust_bill_pkg->recur_show_zero. "\n"
797 if (scalar(@cust_bill_pkg_bundle) && !$cust_bill_pkg->pkgpart_override) {
798 push @cust_bill_pkg, @cust_bill_pkg_bundle
800 || ($sum == 0 && ( $discount_show_always
801 || grep {$_->recur_show_zero || $_->setup_show_zero}
802 @cust_bill_pkg_bundle
805 @cust_bill_pkg_bundle = ();
809 $sum += $cust_bill_pkg->setup + $cust_bill_pkg->recur;
810 push @cust_bill_pkg_bundle, $cust_bill_pkg;
814 push @cust_bill_pkg, @cust_bill_pkg_bundle
816 || ($sum == 0 && ( $discount_show_always
817 || grep {$_->recur_show_zero || $_->setup_show_zero}
818 @cust_bill_pkg_bundle
822 warn " _omit_zero_value_bundles: ". scalar(@in).
823 '->'. scalar(@cust_bill_pkg). "\n" #. Dumper(@cust_bill_pkg). "\n"
830 =item calculate_taxes LINEITEMREF TAXHASHREF INVOICE_TIME
832 Generates tax line items (see L<FS::cust_bill_pkg>) for this customer.
833 Usually used internally by bill method B<bill>.
835 If there is an error, returns the error, otherwise returns reference to a
836 list of line items suitable for insertion.
842 An array ref of the line items being billed.
846 A strange beast. The keys to this hash are internal identifiers consisting
847 of the name of the tax object type, a space, and its unique identifier ( e.g.
848 'cust_main_county 23' ). The values of the hash are listrefs. The first
849 item in the list is the tax object. The remaining items are either line
850 items or floating point values (currency amounts).
852 The taxes are calculated on this entity. Calculated exemption records are
853 transferred to the LINEITEMREF items on the assumption that they are related.
859 This specifies the date appearing on the associated invoice. Some
860 jurisdictions (i.e. Texas) have tax exemptions which are date sensitive.
866 sub calculate_taxes {
867 my ($self, $cust_bill_pkg, $taxlisthash, $invoice_time) = @_;
869 # $taxlisthash is a hashref
870 # keys are identifiers, values are arrayrefs
871 # each arrayref starts with a tax object (cust_main_county or tax_rate)
872 # then any cust_bill_pkg objects the tax applies to
874 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
876 warn "$me calculate_taxes\n"
877 #.Dumper($self, $cust_bill_pkg, $taxlisthash, $invoice_time). "\n"
880 my @tax_line_items = ();
882 # keys are tax names (as printed on invoices / itemdesc )
883 # values are arrayrefs of taxlisthash keys (internal identifiers)
886 # keys are taxlisthash keys (internal identifiers)
887 # values are (cumulative) amounts
890 # keys are taxlisthash keys (internal identifiers)
891 # values are arrayrefs of cust_bill_pkg_tax_location hashrefs
892 my %tax_location = ();
894 # keys are taxlisthash keys (internal identifiers)
895 # values are arrayrefs of cust_bill_pkg_tax_rate_location hashrefs
896 my %tax_rate_location = ();
898 # keys are taxlisthash keys (internal identifiers!)
899 # values are arrayrefs of cust_tax_exempt_pkg objects
902 foreach my $tax ( keys %$taxlisthash ) {
903 # $tax is a tax identifier (intersection of a tax definition record
904 # and a cust_bill_pkg record)
905 my $tax_object = shift @{ $taxlisthash->{$tax} };
906 # $tax_object is a cust_main_county or tax_rate
907 # (with billpkgnum, pkgnum, locationnum set)
908 # the rest of @{ $taxlisthash->{$tax} } is cust_bill_pkg component objects
909 # (setup, recurring, usage classes)
910 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
911 warn " ". join('/', @{ $taxlisthash->{$tax} } ). "\n" if $DEBUG > 2;
912 # taxline calculates the tax on all cust_bill_pkgs in the
913 # first (arrayref) argument, and returns a hashref of 'name'
914 # (the line item description) and 'amount'.
915 # It also calculates exemptions and attaches them to the cust_bill_pkgs
917 my $taxables = $taxlisthash->{$tax};
918 my $exemptions = $tax_exemption{$tax} ||= [];
919 my $taxline = $tax_object->taxline(
921 'custnum' => $self->custnum,
922 'invoice_time' => $invoice_time,
923 'exemptions' => $exemptions,
925 return $taxline unless ref($taxline);
927 unshift @{ $taxlisthash->{$tax} }, $tax_object;
929 if ( $tax_object->isa('FS::cust_main_county') ) {
930 # then $taxline is a real line item
931 push @{ $taxname{ $taxline->itemdesc } }, $taxline;
934 # leave this as is for now
936 my $name = $taxline->{'name'};
937 my $amount = $taxline->{'amount'};
939 #warn "adding $amount as $name\n";
940 $taxname{ $name } ||= [];
941 push @{ $taxname{ $name } }, $tax;
943 $tax_amount{ $tax } += $amount;
945 # link records between cust_main_county/tax_rate and cust_location
946 $tax_rate_location{ $tax } ||= [];
947 my $taxratelocationnum =
948 $tax_object->tax_rate_location->taxratelocationnum;
949 push @{ $tax_rate_location{ $tax } },
951 'taxnum' => $tax_object->taxnum,
952 'taxtype' => ref($tax_object),
953 'amount' => sprintf('%.2f', $amount ),
954 'locationtaxid' => $tax_object->location,
955 'taxratelocationnum' => $taxratelocationnum,
957 } #if ref($tax_object)...
958 } #foreach keys %$taxlisthash
960 #consolidate and create tax line items
961 warn "consolidating and generating...\n" if $DEBUG > 2;
962 foreach my $taxname ( keys %taxname ) {
963 my @cust_bill_pkg_tax_location;
964 my @cust_bill_pkg_tax_rate_location;
965 my $tax_cust_bill_pkg = FS::cust_bill_pkg->new({
970 'itemdesc' => $taxname,
971 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
972 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
977 warn "adding $taxname\n" if $DEBUG > 1;
978 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
979 if ( ref($taxitem) eq 'FS::cust_bill_pkg' ) {
980 # then we need to transfer the amount and the links from the
981 # line item to the new one we're creating.
982 $tax_total += $taxitem->setup;
983 foreach my $link ( @{ $taxitem->get('cust_bill_pkg_tax_location') } ) {
984 $link->set('tax_cust_bill_pkg', $tax_cust_bill_pkg);
985 push @cust_bill_pkg_tax_location, $link;
989 next if $seen{$taxitem}++;
990 warn "adding $tax_amount{$taxitem}\n" if $DEBUG > 1;
991 $tax_total += $tax_amount{$taxitem};
992 push @cust_bill_pkg_tax_rate_location,
993 map { new FS::cust_bill_pkg_tax_rate_location $_ }
994 @{ $tax_rate_location{ $taxitem } };
997 next unless $tax_total;
999 # we should really neverround this up...I guess it's okay if taxline
1000 # already returns amounts with 2 decimal places
1001 $tax_total = sprintf('%.2f', $tax_total );
1002 $tax_cust_bill_pkg->set('setup', $tax_total);
1004 my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
1010 if ( $pkg_category and
1011 $conf->config('invoice_latexsummary') ||
1012 $conf->config('invoice_htmlsummary')
1016 my %hash = ( 'section' => $pkg_category->categoryname );
1017 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
1020 $tax_cust_bill_pkg->set('display', \@display);
1022 push @tax_line_items, $tax_cust_bill_pkg;
1029 my ($self, %params) = @_;
1031 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1033 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
1034 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
1035 my $cust_location = $cust_pkg->tax_location;
1036 my $precommit_hooks = $params{precommit_hooks} or die "no precommit_hooks specified";
1037 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
1038 my $total_setup = $params{setup} or die "no setup accumulator specified";
1039 my $total_recur = $params{recur} or die "no recur accumulator specified";
1040 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
1041 my $time = $params{'time'} or die "no time specified";
1042 my (%options) = %{$params{options}};
1044 if ( $part_pkg->freq ne '1' and ($options{'freq_override'} || 0) > 0 ) {
1045 # this should never happen
1046 die 'freq_override billing attempted on non-monthly package '.
1051 my $real_pkgpart = $params{real_pkgpart};
1052 my %hash = $cust_pkg->hash;
1053 my $old_cust_pkg = new FS::cust_pkg \%hash;
1058 $cust_pkg->pkgpart($part_pkg->pkgpart);
1060 my $cmp_time = ( $conf->exists('next-bill-ignore-time')
1071 my @setup_discounts = ();
1072 my %setup_param = ( 'discounts' => \@setup_discounts );
1073 my $setup_billed_currency = '';
1074 my $setup_billed_amount = 0;
1075 if ( ! $options{recurring_only}
1076 and ! $options{cancel}
1077 and ( $options{'resetup'}
1078 || ( ! $cust_pkg->setup
1079 && ( ! $cust_pkg->start_date
1080 || $cust_pkg->start_date <= $cmp_time
1082 && ( ! $conf->exists('disable_setup_suspended_pkgs')
1083 || ( $conf->exists('disable_setup_suspended_pkgs') &&
1084 ! $cust_pkg->getfield('susp')
1092 warn " bill setup\n" if $DEBUG > 1;
1094 unless ( $cust_pkg->waive_setup ) {
1097 $setup = eval { $cust_pkg->calc_setup( $time, \@details, \%setup_param ) };
1098 return "$@ running calc_setup for $cust_pkg\n"
1101 $unitsetup = $cust_pkg->base_setup()
1104 if ( $setup_param{'billed_currency'} ) {
1105 $setup_billed_currency = delete $setup_param{'billed_currency'};
1106 $setup_billed_amount = delete $setup_param{'billed_amount'};
1110 $cust_pkg->setfield('setup', $time)
1111 unless $cust_pkg->setup;
1112 #do need it, but it won't get written to the db
1113 #|| $cust_pkg->pkgpart != $real_pkgpart;
1115 $cust_pkg->setfield('start_date', '')
1116 if $cust_pkg->start_date;
1121 # bill recurring fee
1126 my @recur_discounts = ();
1127 my $recur_billed_currency = '';
1128 my $recur_billed_amount = 0;
1130 if ( ! $cust_pkg->start_date
1133 || ( $cust_pkg->susp != $cust_pkg->order_date
1134 && ( $cust_pkg->option('suspend_bill',1)
1135 || ( $part_pkg->option('suspend_bill', 1)
1136 && ! $cust_pkg->option('no_suspend_bill',1)
1142 ( $part_pkg->freq ne '0' && ( $cust_pkg->bill || 0 ) <= $cmp_time )
1143 || ( $part_pkg->plan eq 'voip_cdr'
1144 && $part_pkg->option('bill_every_call')
1149 # XXX should this be a package event? probably. events are called
1150 # at collection time at the moment, though...
1151 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
1152 if $part_pkg->can('reset_usage') && !$options{'no_usage_reset'};
1153 #don't want to reset usage just cause we want a line item??
1154 #&& $part_pkg->pkgpart == $real_pkgpart;
1156 warn " bill recur\n" if $DEBUG > 1;
1159 # XXX shared with $recur_prog
1160 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
1164 #over two params! lets at least switch to a hashref for the rest...
1165 my $increment_next_bill = ( $part_pkg->freq ne '0'
1166 && ( $cust_pkg->getfield('bill') || 0 ) <= $cmp_time
1167 && !$options{cancel}
1169 my %param = ( %setup_param,
1170 'precommit_hooks' => $precommit_hooks,
1171 'increment_next_bill' => $increment_next_bill,
1172 'discounts' => \@recur_discounts,
1173 'real_pkgpart' => $real_pkgpart,
1174 'freq_override' => $options{freq_override} || '',
1178 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
1180 # There may be some part_pkg for which this is wrong. Only those
1181 # which can_discount are supported.
1182 # (the UI should prevent adding discounts to these at the moment)
1184 warn "calling $method on cust_pkg ". $cust_pkg->pkgnum.
1185 " for pkgpart ". $cust_pkg->pkgpart.
1186 " with params ". join(' / ', map "$_=>$param{$_}", keys %param). "\n"
1189 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
1190 return "$@ running $method for $cust_pkg\n"
1194 $unitrecur = $cust_pkg->base_recur( \$sdate ) || $recur; #XXX uuh, better
1196 if ( $param{'billed_currency'} ) {
1197 $recur_billed_currency = delete $param{'billed_currency'};
1198 $recur_billed_amount = delete $param{'billed_amount'};
1201 if ( $increment_next_bill ) {
1205 if ( my $main_pkg = $cust_pkg->main_pkg ) {
1206 # supplemental package
1207 # to keep in sync with the main package, simulate billing at
1209 my $main_pkg_freq = $main_pkg->part_pkg->freq;
1210 my $supp_pkg_freq = $part_pkg->freq;
1211 my $ratio = $supp_pkg_freq / $main_pkg_freq;
1212 if ( $ratio != int($ratio) ) {
1213 # the UI should prevent setting up packages like this, but just
1215 return "supplemental package period is not an integer multiple of main package period";
1217 $next_bill = $sdate;
1219 $next_bill = $part_pkg->add_freq( $next_bill, $main_pkg_freq );
1224 $next_bill = $part_pkg->add_freq($sdate, $options{freq_override} || 0);
1225 return "unparsable frequency: ". $part_pkg->freq
1226 if $next_bill == -1;
1229 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
1230 # only for figuring next bill date, nothing else, so, reset $sdate again
1232 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1233 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
1234 $cust_pkg->last_bill($sdate);
1236 $cust_pkg->setfield('bill', $next_bill );
1240 if ( $param{'setup_fee'} ) {
1241 # Add an additional setup fee at the billing stage.
1242 # Used for prorate_defer_bill.
1243 $setup += $param{'setup_fee'};
1244 $unitsetup += $param{'setup_fee'};
1248 if ( defined $param{'discount_left_setup'} ) {
1249 foreach my $discount_setup ( values %{$param{'discount_left_setup'}} ) {
1250 $setup -= $discount_setup;
1256 warn "\$setup is undefined" unless defined($setup);
1257 warn "\$recur is undefined" unless defined($recur);
1258 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1261 # If there's line items, create em cust_bill_pkg records
1262 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
1267 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
1268 # hmm.. and if just the options are modified in some weird price plan?
1270 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
1273 my $error = $cust_pkg->replace( $old_cust_pkg,
1274 'depend_jobnum'=>$options{depend_jobnum},
1275 'options' => { $cust_pkg->options },
1277 unless $options{no_commit};
1278 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
1279 if $error; #just in case
1282 $setup = sprintf( "%.2f", $setup );
1283 $recur = sprintf( "%.2f", $recur );
1284 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
1285 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1287 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
1288 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
1291 my $discount_show_always = $conf->exists('discount-show-always')
1292 && ( ($setup == 0 && scalar(@setup_discounts))
1293 || ($recur == 0 && scalar(@recur_discounts))
1298 || (!$part_pkg->hidden && $options{has_hidden}) #include some $0 lines
1299 || $discount_show_always
1300 || ($setup == 0 && $cust_pkg->_X_show_zero('setup'))
1301 || ($recur == 0 && $cust_pkg->_X_show_zero('recur'))
1305 warn " charges (setup=$setup, recur=$recur); adding line items\n"
1308 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
1310 warn " adding customer package invoice detail: $_\n"
1311 foreach @cust_pkg_detail;
1313 push @details, @cust_pkg_detail;
1315 my $cust_bill_pkg = new FS::cust_bill_pkg {
1316 'pkgnum' => $cust_pkg->pkgnum,
1318 'unitsetup' => $unitsetup,
1319 'setup_billed_currency' => $setup_billed_currency,
1320 'setup_billed_amount' => $setup_billed_amount,
1322 'unitrecur' => $unitrecur,
1323 'recur_billed_currency' => $recur_billed_currency,
1324 'recur_billed_amount' => $recur_billed_amount,
1325 'quantity' => $cust_pkg->quantity,
1326 'details' => \@details,
1327 'discounts' => [ @setup_discounts, @recur_discounts ],
1328 'hidden' => $part_pkg->hidden,
1329 'freq' => $part_pkg->freq,
1332 if ( $part_pkg->option('prorate_defer_bill',1)
1333 and !$hash{last_bill} ) {
1334 # both preceding and upcoming, technically
1335 $cust_bill_pkg->sdate( $cust_pkg->setup );
1336 $cust_bill_pkg->edate( $cust_pkg->bill );
1337 } elsif ( $part_pkg->recur_temporality eq 'preceding' ) {
1338 $cust_bill_pkg->sdate( $hash{last_bill} );
1339 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
1340 $cust_bill_pkg->edate( $time ) if $options{cancel};
1341 } else { #if ( $part_pkg->recur_temporality eq 'upcoming' )
1342 $cust_bill_pkg->sdate( $sdate );
1343 $cust_bill_pkg->edate( $cust_pkg->bill );
1344 #$cust_bill_pkg->edate( $time ) if $options{cancel};
1347 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
1348 unless $part_pkg->pkgpart == $real_pkgpart;
1350 $$total_setup += $setup;
1351 $$total_recur += $recur;
1357 my $error = $self->_handle_taxes( $taxlisthash, $cust_bill_pkg,
1358 cancel => $options{cancel} );
1359 return $error if $error;
1361 $cust_bill_pkg->set_display(
1362 part_pkg => $part_pkg,
1363 real_pkgpart => $real_pkgpart,
1366 push @$cust_bill_pkgs, $cust_bill_pkg;
1368 } #if $setup != 0 || $recur != 0
1376 =item _transfer_balance TO_PKG [ FROM_PKGNUM ]
1378 Takes one argument, a cust_pkg object that is being billed. This will
1379 be called only if the package was created by a package change, and has
1380 not been billed since the package change, and package balance tracking
1381 is enabled. The second argument can be an alternate package number to
1382 transfer the balance from; this should not be used externally.
1384 Transfers the balance from the previous package (now canceled) to
1385 this package, by crediting one package and creating an invoice item for
1386 the other. Inserts the credit and returns the invoice item (so that it
1387 can be added to an invoice that's being built).
1389 If the previous package was never billed, and was also created by a package
1390 change, then this will also transfer the balance from I<its> previous
1391 package, and so on, until reaching a package that either has been billed
1392 or was not created by a package change.
1396 my $balance_transfer_reason;
1398 sub _transfer_balance {
1400 my $cust_pkg = shift;
1401 my $from_pkgnum = shift || $cust_pkg->change_pkgnum;
1402 my $from_pkg = FS::cust_pkg->by_key($from_pkgnum);
1406 # if $from_pkg is not the first package in the chain, and it was never
1408 if ( $from_pkg->change_pkgnum and scalar($from_pkg->cust_bill_pkg) == 0 ) {
1409 @transfers = $self->_transfer_balance($cust_pkg, $from_pkg->change_pkgnum);
1412 my $prev_balance = $self->balance_pkgnum($from_pkgnum);
1413 if ( $prev_balance != 0 ) {
1414 $balance_transfer_reason ||= FS::reason->new_or_existing(
1415 'reason' => 'Package balance transfer',
1416 'type' => 'Internal adjustment',
1420 my $credit = FS::cust_credit->new({
1421 'custnum' => $self->custnum,
1422 'amount' => abs($prev_balance),
1423 'reasonnum' => $balance_transfer_reason->reasonnum,
1424 '_date' => $cust_pkg->change_date,
1427 my $cust_bill_pkg = FS::cust_bill_pkg->new({
1429 'recur' => abs($prev_balance),
1430 #'sdate' => $from_pkg->last_bill, # not sure about this
1431 #'edate' => $cust_pkg->change_date,
1432 'itemdesc' => $self->mt('Previous Balance, [_1]',
1433 $from_pkg->part_pkg->pkg),
1436 if ( $prev_balance > 0 ) {
1437 # credit the old package, charge the new one
1438 $credit->set('pkgnum', $from_pkgnum);
1439 $cust_bill_pkg->set('pkgnum', $cust_pkg->pkgnum);
1442 $credit->set('pkgnum', $cust_pkg->pkgnum);
1443 $cust_bill_pkg->set('pkgnum', $from_pkgnum);
1445 my $error = $credit->insert;
1446 die "error transferring package balance from #".$from_pkgnum.
1447 " to #".$cust_pkg->pkgnum.": $error\n" if $error;
1449 push @transfers, $cust_bill_pkg;
1450 } # $prev_balance != 0
1455 =item handle_taxes TAXLISTHASH CUST_BILL_PKG [ OPTIONS ]
1457 This is _handle_taxes. It's called once for each cust_bill_pkg generated
1460 TAXLISTHASH is a hashref shared across the entire invoice. It looks like
1463 'cust_main_county 1001' => [ [FS::cust_main_county], ... ],
1464 'cust_main_county 1002' => [ [FS::cust_main_county], ... ],
1467 'cust_main_county' can also be 'tax_rate'. The first object in the array
1468 is always the cust_main_county or tax_rate identified by the key.
1470 That "..." is a list of FS::cust_bill_pkg objects that will be fed to
1471 the 'taxline' method to calculate the amount of the tax. This doesn't
1472 happen until calculate_taxes, though.
1474 OPTIONS may include:
1475 - part_item: a part_pkg or part_fee object to be used as the package/fee
1477 - location: a cust_location to be used as the billing location.
1478 - cancel: true if this package is being billed on cancellation. This
1479 allows tax to be calculated on usage charges only.
1481 If not supplied, part_item will be inferred from the pkgnum or feepart of the
1482 cust_bill_pkg, and location from the pkgnum (or, for fees, the invnum and
1483 the customer's default service location).
1489 my $taxlisthash = shift;
1490 my $cust_bill_pkg = shift;
1493 # at this point I realize that we have enough information to infer all this
1494 # stuff, instead of passing around giant honking argument lists
1495 my $location = $options{location} || $cust_bill_pkg->tax_location;
1496 my $part_item = $options{part_item} || $cust_bill_pkg->part_X;
1498 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1500 return if ( $self->payby eq 'COMP' ); #dubious
1502 if ( $conf->exists('enable_taxproducts')
1503 && ( scalar($part_item->part_pkg_taxoverride)
1504 || $part_item->has_taxproduct
1509 # EXTERNAL TAX RATES (via tax_rate)
1510 my %cust_bill_pkg = ();
1514 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
1515 push @classes, 'setup' if $cust_bill_pkg->setup and !$options{cancel};
1516 push @classes, 'recur' if $cust_bill_pkg->recur and !$options{cancel};
1518 my $exempt = $conf->exists('cust_class-tax_exempt')
1519 ? ( $self->cust_class ? $self->cust_class->tax : '' )
1521 # standardize this just to be sure
1522 $exempt = ($exempt eq 'Y') ? 'Y' : '';
1526 foreach my $class (@classes) {
1527 my $err_or_ref = $self->_gather_taxes($part_item, $class, $location);
1528 return $err_or_ref unless ref($err_or_ref);
1529 $taxes{$class} = $err_or_ref;
1532 unless (exists $taxes{''}) {
1533 my $err_or_ref = $self->_gather_taxes($part_item, '', $location);
1534 return $err_or_ref unless ref($err_or_ref);
1535 $taxes{''} = $err_or_ref;
1540 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate; # grrr
1541 foreach my $key (keys %tax_cust_bill_pkg) {
1542 # $key is "setup", "recur", or a usage class name. ('' is a usage class.)
1543 # $tax_cust_bill_pkg{$key} is a cust_bill_pkg for that component of
1545 # $taxes{$key} is an arrayref of cust_main_county or tax_rate objects that
1546 # apply to $key-class charges.
1547 my @taxes = @{ $taxes{$key} || [] };
1548 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
1550 my %localtaxlisthash = ();
1551 foreach my $tax ( @taxes ) {
1553 # this is the tax identifier, not the taxname
1554 my $taxname = ref( $tax ). ' '. $tax->taxnum;
1555 # $taxlisthash: keys are "setup", "recur", and usage classes.
1556 # Values are arrayrefs, first the tax object (cust_main_county
1557 # or tax_rate) and then any cust_bill_pkg objects that the
1559 $taxlisthash->{ $taxname } ||= [ $tax ];
1560 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
1562 $localtaxlisthash{ $taxname } ||= [ $tax ];
1563 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
1567 warn "finding taxed taxes...\n" if $DEBUG > 2;
1568 foreach my $tax ( keys %localtaxlisthash ) {
1569 my $tax_object = shift @{ $localtaxlisthash{$tax} };
1570 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
1572 next unless $tax_object->can('tax_on_tax');
1574 foreach my $tot ( $tax_object->tax_on_tax( $location ) ) {
1575 my $totname = ref( $tot ). ' '. $tot->taxnum;
1577 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
1579 next unless exists( $localtaxlisthash{ $totname } ); # only increase
1581 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
1582 # calculate the tax amount that the tax_on_tax will apply to
1583 my $hashref_or_error =
1584 $tax_object->taxline( $localtaxlisthash{$tax} );
1585 return $hashref_or_error
1586 unless ref($hashref_or_error);
1588 # and append it to the list of taxable items
1589 $taxlisthash->{ $totname } ||= [ $tot ];
1590 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
1598 # INTERNAL TAX RATES (cust_main_county)
1600 # We fetch taxes even if the customer is completely exempt,
1601 # because we need to record that fact.
1603 my @loc_keys = qw( district city county state country );
1604 my %taxhash = map { $_ => $location->$_ } @loc_keys;
1606 $taxhash{'taxclass'} = $part_item->taxclass;
1608 warn "taxhash:\n". Dumper(\%taxhash) if $DEBUG > 2;
1610 my @taxes = (); # entries are cust_main_county objects
1611 my %taxhash_elim = %taxhash;
1612 my @elim = qw( district city county state );
1615 #first try a match with taxclass
1616 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1618 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1619 #then try a match without taxclass
1620 my %no_taxclass = %taxhash_elim;
1621 $no_taxclass{ 'taxclass' } = '';
1622 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1625 $taxhash_elim{ shift(@elim) } = '';
1627 } while ( !scalar(@taxes) && scalar(@elim) );
1630 my $tax_id = 'cust_main_county '.$_->taxnum;
1631 $taxlisthash->{$tax_id} ||= [ $_ ];
1632 push @{ $taxlisthash->{$tax_id} }, $cust_bill_pkg;
1639 =item _gather_taxes PART_ITEM CLASS CUST_LOCATION
1641 Internal method used with vendor-provided tax tables. PART_ITEM is a part_pkg
1642 or part_fee (which will define the tax eligibility of the product), CLASS is
1643 'setup', 'recur', null, or a C<usage_class> number, and CUST_LOCATION is the
1644 location where the service was provided (or billed, depending on
1645 configuration). Returns an arrayref of L<FS::tax_rate> objects that
1646 can apply to this line item.
1652 my $part_item = shift;
1654 my $location = shift;
1656 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1658 my $geocode = $location->geocode('cch');
1660 [ $part_item->tax_rates('cch', $geocode, $class) ]
1664 =item collect [ HASHREF | OPTION => VALUE ... ]
1666 (Attempt to) collect money for this customer's outstanding invoices (see
1667 L<FS::cust_bill>). Usually used after the bill method.
1669 Actions are now triggered by billing events; see L<FS::part_event> and the
1670 billing events web interface. Old-style invoice events (see
1671 L<FS::part_bill_event>) have been deprecated.
1673 If there is an error, returns the error, otherwise returns false.
1675 Options are passed as name-value pairs.
1677 Currently available options are:
1683 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.
1687 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1691 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1695 set true to surpress email card/ACH decline notices.
1699 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)
1705 # allows for one time override of normal customer billing method
1710 my( $self, %options ) = @_;
1712 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1714 my $invoice_time = $options{'invoice_time'} || time;
1717 local $SIG{HUP} = 'IGNORE';
1718 local $SIG{INT} = 'IGNORE';
1719 local $SIG{QUIT} = 'IGNORE';
1720 local $SIG{TERM} = 'IGNORE';
1721 local $SIG{TSTP} = 'IGNORE';
1722 local $SIG{PIPE} = 'IGNORE';
1724 my $oldAutoCommit = $FS::UID::AutoCommit;
1725 local $FS::UID::AutoCommit = 0;
1728 $self->select_for_update; #mutex
1731 my $balance = $self->balance;
1732 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
1735 if ( exists($options{'retry_card'}) ) {
1736 carp 'retry_card option passed to collect is deprecated; use retry';
1737 $options{'retry'} ||= $options{'retry_card'};
1739 if ( exists($options{'retry'}) && $options{'retry'} ) {
1740 my $error = $self->retry_realtime;
1742 $dbh->rollback if $oldAutoCommit;
1747 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1749 #never want to roll back an event just because it returned an error
1750 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1752 $self->do_cust_event(
1753 'debug' => ( $options{'debug'} || 0 ),
1754 'time' => $invoice_time,
1755 'check_freq' => $options{'check_freq'},
1756 'stage' => 'collect',
1761 =item retry_realtime
1763 Schedules realtime / batch credit card / electronic check / LEC billing
1764 events for for retry. Useful if card information has changed or manual
1765 retry is desired. The 'collect' method must be called to actually retry
1768 Implementation details: For either this customer, or for each of this
1769 customer's open invoices, changes the status of the first "done" (with
1770 statustext error) realtime processing event to "failed".
1774 sub retry_realtime {
1777 local $SIG{HUP} = 'IGNORE';
1778 local $SIG{INT} = 'IGNORE';
1779 local $SIG{QUIT} = 'IGNORE';
1780 local $SIG{TERM} = 'IGNORE';
1781 local $SIG{TSTP} = 'IGNORE';
1782 local $SIG{PIPE} = 'IGNORE';
1784 my $oldAutoCommit = $FS::UID::AutoCommit;
1785 local $FS::UID::AutoCommit = 0;
1788 #a little false laziness w/due_cust_event (not too bad, really)
1790 # I guess this is always as of now?
1791 my $join = FS::part_event_condition->join_conditions_sql('', 'time' => time);
1792 my $order = FS::part_event_condition->order_conditions_sql;
1795 . join ( ' OR ' , map {
1796 my $cust_join = FS::part_event->eventtables_cust_join->{$_} || '';
1797 my $custnum = FS::part_event->eventtables_custnum->{$_};
1798 "( part_event.eventtable = " . dbh->quote($_)
1799 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key
1800 . " from $_ $cust_join"
1801 . " where $custnum = " . dbh->quote( $self->custnum ) . "))" ;
1802 } FS::part_event->eventtables)
1805 #here is the agent virtualization
1806 my $agent_virt = " ( part_event.agentnum IS NULL
1807 OR part_event.agentnum = ". $self->agentnum. ' )';
1809 #XXX this shouldn't be hardcoded, actions should declare it...
1810 my @realtime_events = qw(
1811 cust_bill_realtime_card
1812 cust_bill_realtime_check
1813 cust_bill_realtime_lec
1817 my $is_realtime_event =
1818 ' part_event.action IN ( '.
1819 join(',', map "'$_'", @realtime_events ).
1822 my $batch_or_statustext =
1823 "( part_event.action = 'cust_bill_batch'
1824 OR ( statustext IS NOT NULL AND statustext != '' )
1828 my @cust_event = qsearch({
1829 'table' => 'cust_event',
1830 'select' => 'cust_event.*',
1831 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
1832 'hashref' => { 'status' => 'done' },
1833 'extra_sql' => " AND $batch_or_statustext ".
1834 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
1837 my %seen_invnum = ();
1838 foreach my $cust_event (@cust_event) {
1840 #max one for the customer, one for each open invoice
1841 my $cust_X = $cust_event->cust_X;
1842 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
1846 or $cust_event->part_event->eventtable eq 'cust_bill'
1849 my $error = $cust_event->retry;
1851 $dbh->rollback if $oldAutoCommit;
1852 return "error scheduling event for retry: $error";
1857 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1862 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
1864 Runs billing events; see L<FS::part_event> and the billing events web
1867 If there is an error, returns the error, otherwise returns false.
1869 Options are passed as name-value pairs.
1871 Currently available options are:
1877 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.
1881 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1885 "collect" (the default) or "pre-bill"
1889 set true to surpress email card/ACH decline notices.
1893 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)
1900 # allows for one time override of normal customer billing method
1904 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1907 my( $self, %options ) = @_;
1909 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1911 my $time = $options{'time'} || time;
1914 local $SIG{HUP} = 'IGNORE';
1915 local $SIG{INT} = 'IGNORE';
1916 local $SIG{QUIT} = 'IGNORE';
1917 local $SIG{TERM} = 'IGNORE';
1918 local $SIG{TSTP} = 'IGNORE';
1919 local $SIG{PIPE} = 'IGNORE';
1921 my $oldAutoCommit = $FS::UID::AutoCommit;
1922 local $FS::UID::AutoCommit = 0;
1925 $self->select_for_update; #mutex
1928 my $balance = $self->balance;
1929 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
1932 # if ( exists($options{'retry_card'}) ) {
1933 # carp 'retry_card option passed to collect is deprecated; use retry';
1934 # $options{'retry'} ||= $options{'retry_card'};
1936 # if ( exists($options{'retry'}) && $options{'retry'} ) {
1937 # my $error = $self->retry_realtime;
1939 # $dbh->rollback if $oldAutoCommit;
1944 # false laziness w/pay_batch::import_results
1946 my $due_cust_event = $self->due_cust_event(
1947 'debug' => ( $options{'debug'} || 0 ),
1949 'check_freq' => $options{'check_freq'},
1950 'stage' => ( $options{'stage'} || 'collect' ),
1952 unless( ref($due_cust_event) ) {
1953 $dbh->rollback if $oldAutoCommit;
1954 return $due_cust_event;
1957 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1958 #never want to roll back an event just because it or a different one
1960 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1962 foreach my $cust_event ( @$due_cust_event ) {
1966 #re-eval event conditions (a previous event could have changed things)
1967 unless ( $cust_event->test_conditions ) {
1968 #don't leave stray "new/locked" records around
1969 my $error = $cust_event->delete;
1970 return $error if $error;
1975 local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
1976 if $options{'quiet'};
1977 warn " running cust_event ". $cust_event->eventnum. "\n"
1980 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
1981 if ( my $error = $cust_event->do_event( 'time' => $time ) ) {
1982 #XXX wtf is this? figure out a proper dealio with return value
1994 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
1996 Inserts database records for and returns an ordered listref of new events due
1997 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
1998 events are due, an empty listref is returned. If there is an error, returns a
1999 scalar error message.
2001 To actually run the events, call each event's test_condition method, and if
2002 still true, call the event's do_event method.
2004 Options are passed as a hashref or as a list of name-value pairs. Available
2011 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.
2015 "collect" (the default) or "pre-bill"
2019 "Current time" for the events.
2023 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)
2027 Only return events for the specified eventtable (by default, events of all eventtables are returned)
2031 Explicitly pass the objects to be tested (typically used with eventtable).
2035 Set to true to return the objects, but not actually insert them into the
2042 sub due_cust_event {
2044 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
2047 #my $DEBUG = $opt{'debug'}
2048 $opt{'debug'} ||= 0; # silence some warnings
2049 local($DEBUG) = $opt{'debug'}
2050 if $opt{'debug'} > $DEBUG;
2051 $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
2053 warn "$me due_cust_event called with options ".
2054 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
2057 $opt{'time'} ||= time;
2059 local $SIG{HUP} = 'IGNORE';
2060 local $SIG{INT} = 'IGNORE';
2061 local $SIG{QUIT} = 'IGNORE';
2062 local $SIG{TERM} = 'IGNORE';
2063 local $SIG{TSTP} = 'IGNORE';
2064 local $SIG{PIPE} = 'IGNORE';
2066 my $oldAutoCommit = $FS::UID::AutoCommit;
2067 local $FS::UID::AutoCommit = 0;
2070 $self->select_for_update #mutex
2071 unless $opt{testonly};
2074 # find possible events (initial search)
2077 my @cust_event = ();
2079 my @eventtable = $opt{'eventtable'}
2080 ? ( $opt{'eventtable'} )
2081 : FS::part_event->eventtables_runorder;
2083 my $check_freq = $opt{'check_freq'} || '1d';
2085 foreach my $eventtable ( @eventtable ) {
2088 if ( $opt{'objects'} ) {
2090 @objects = @{ $opt{'objects'} };
2092 } elsif ( $eventtable eq 'cust_main' ) {
2094 @objects = ( $self );
2098 my $cm_join = " LEFT JOIN cust_main USING ( custnum )";
2099 # linkage not needed here because FS::cust_main->$eventtable will
2102 #some false laziness w/Cron::bill bill_where
2104 my $join = FS::part_event_condition->join_conditions_sql( $eventtable,
2105 'time' => $opt{'time'});
2106 my $where = FS::part_event_condition->where_conditions_sql($eventtable,
2107 'time'=>$opt{'time'},
2109 $where = $where ? "AND $where" : '';
2111 my $are_part_event =
2112 "EXISTS ( SELECT 1 FROM part_event $join
2113 WHERE check_freq = '$check_freq'
2114 AND eventtable = '$eventtable'
2115 AND ( disabled = '' OR disabled IS NULL )
2121 @objects = $self->$eventtable(
2122 'addl_from' => $cm_join,
2123 'extra_sql' => " AND $are_part_event",
2125 } # if ( !$opt{objects} and $eventtable ne 'cust_main' )
2127 my @e_cust_event = ();
2129 my $linkage = FS::part_event->eventtables_cust_join->{$eventtable} || '';
2131 my $cross = "CROSS JOIN $eventtable $linkage";
2132 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
2133 unless $eventtable eq 'cust_main';
2135 foreach my $object ( @objects ) {
2137 #this first search uses the condition_sql magic for optimization.
2138 #the more possible events we can eliminate in this step the better
2140 my $cross_where = '';
2141 my $pkey = $object->primary_key;
2142 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
2144 my $join = FS::part_event_condition->join_conditions_sql( $eventtable,
2145 'time' => $opt{'time'});
2147 FS::part_event_condition->where_conditions_sql( $eventtable,
2148 'time'=>$opt{'time'}
2150 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
2152 $extra_sql = "AND $extra_sql" if $extra_sql;
2154 #here is the agent virtualization
2155 $extra_sql .= " AND ( part_event.agentnum IS NULL
2156 OR part_event.agentnum = ". $self->agentnum. ' )';
2158 $extra_sql .= " $order";
2160 warn "searching for events for $eventtable ". $object->$pkey. "\n"
2161 if $opt{'debug'} > 2;
2162 my @part_event = qsearch( {
2163 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
2164 'select' => 'part_event.*',
2165 'table' => 'part_event',
2166 'addl_from' => "$cross $join",
2167 'hashref' => { 'check_freq' => $check_freq,
2168 'eventtable' => $eventtable,
2171 'extra_sql' => "AND $cross_where $extra_sql",
2175 my $pkey = $object->primary_key;
2176 warn " ". scalar(@part_event).
2177 " possible events found for $eventtable ". $object->$pkey(). "\n";
2180 push @e_cust_event, map {
2181 $_->new_cust_event($object, 'time' => $opt{'time'})
2186 warn " ". scalar(@e_cust_event).
2187 " subtotal possible cust events found for $eventtable\n"
2190 push @cust_event, @e_cust_event;
2194 warn " ". scalar(@cust_event).
2195 " total possible cust events found in initial search\n"
2203 $opt{stage} ||= 'collect';
2205 grep { my $stage = $_->part_event->event_stage;
2206 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
2216 @cust_event = grep $_->test_conditions( 'stats_hashref' => \%unsat ),
2219 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
2222 warn " invalid conditions not eliminated with condition_sql:\n".
2223 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
2224 if keys %unsat && $DEBUG; # > 1;
2230 unless( $opt{testonly} ) {
2231 foreach my $cust_event ( @cust_event ) {
2233 my $error = $cust_event->insert();
2235 $dbh->rollback if $oldAutoCommit;
2242 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2248 warn " returning events: ". Dumper(@cust_event). "\n"
2255 =item apply_payments_and_credits [ OPTION => VALUE ... ]
2257 Applies unapplied payments and credits.
2259 In most cases, this new method should be used in place of sequential
2260 apply_payments and apply_credits methods.
2262 A hash of optional arguments may be passed. Currently "manual" is supported.
2263 If true, a payment receipt is sent instead of a statement when
2264 'payment_receipt_email' configuration option is set.
2266 If there is an error, returns the error, otherwise returns false.
2270 sub apply_payments_and_credits {
2271 my( $self, %options ) = @_;
2273 local $SIG{HUP} = 'IGNORE';
2274 local $SIG{INT} = 'IGNORE';
2275 local $SIG{QUIT} = 'IGNORE';
2276 local $SIG{TERM} = 'IGNORE';
2277 local $SIG{TSTP} = 'IGNORE';
2278 local $SIG{PIPE} = 'IGNORE';
2280 my $oldAutoCommit = $FS::UID::AutoCommit;
2281 local $FS::UID::AutoCommit = 0;
2284 $self->select_for_update; #mutex
2286 foreach my $cust_bill ( $self->open_cust_bill ) {
2287 my $error = $cust_bill->apply_payments_and_credits(%options);
2289 $dbh->rollback if $oldAutoCommit;
2290 return "Error applying: $error";
2294 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2299 =item apply_credits OPTION => VALUE ...
2301 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
2302 to outstanding invoice balances in chronological order (or reverse
2303 chronological order if the I<order> option is set to B<newest>) and returns the
2304 value of any remaining unapplied credits available for refund (see
2305 L<FS::cust_refund>).
2307 Dies if there is an error.
2315 local $SIG{HUP} = 'IGNORE';
2316 local $SIG{INT} = 'IGNORE';
2317 local $SIG{QUIT} = 'IGNORE';
2318 local $SIG{TERM} = 'IGNORE';
2319 local $SIG{TSTP} = 'IGNORE';
2320 local $SIG{PIPE} = 'IGNORE';
2322 my $oldAutoCommit = $FS::UID::AutoCommit;
2323 local $FS::UID::AutoCommit = 0;
2326 $self->select_for_update; #mutex
2328 unless ( $self->total_unapplied_credits ) {
2329 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2333 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
2334 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
2336 my @invoices = $self->open_cust_bill;
2337 @invoices = sort { $b->_date <=> $a->_date } @invoices
2338 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
2340 if ( $conf->exists('pkg-balances') ) {
2341 # limit @credits to those w/ a pkgnum grepped from $self
2343 foreach my $i (@invoices) {
2344 foreach my $li ( $i->cust_bill_pkg ) {
2345 $pkgnums{$li->pkgnum} = 1;
2348 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
2353 foreach my $cust_bill ( @invoices ) {
2355 if ( !defined($credit) || $credit->credited == 0) {
2356 $credit = pop @credits or last;
2360 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
2361 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
2363 $owed = $cust_bill->owed;
2365 unless ( $owed > 0 ) {
2366 push @credits, $credit;
2370 my $amount = min( $credit->credited, $owed );
2372 my $cust_credit_bill = new FS::cust_credit_bill ( {
2373 'crednum' => $credit->crednum,
2374 'invnum' => $cust_bill->invnum,
2375 'amount' => $amount,
2377 $cust_credit_bill->pkgnum( $credit->pkgnum )
2378 if $conf->exists('pkg-balances') && $credit->pkgnum;
2379 my $error = $cust_credit_bill->insert;
2381 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2385 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2389 my $total_unapplied_credits = $self->total_unapplied_credits;
2391 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2393 return $total_unapplied_credits;
2396 =item apply_payments [ OPTION => VALUE ... ]
2398 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2399 to outstanding invoice balances in chronological order.
2401 #and returns the value of any remaining unapplied payments.
2403 A hash of optional arguments may be passed. Currently "manual" is supported.
2404 If true, a payment receipt is sent instead of a statement when
2405 'payment_receipt_email' configuration option is set.
2407 Dies if there is an error.
2411 sub apply_payments {
2412 my( $self, %options ) = @_;
2414 local $SIG{HUP} = 'IGNORE';
2415 local $SIG{INT} = 'IGNORE';
2416 local $SIG{QUIT} = 'IGNORE';
2417 local $SIG{TERM} = 'IGNORE';
2418 local $SIG{TSTP} = 'IGNORE';
2419 local $SIG{PIPE} = 'IGNORE';
2421 my $oldAutoCommit = $FS::UID::AutoCommit;
2422 local $FS::UID::AutoCommit = 0;
2425 $self->select_for_update; #mutex
2429 my @payments = sort { $b->_date <=> $a->_date }
2430 grep { $_->unapplied > 0 }
2433 my @invoices = sort { $a->_date <=> $b->_date}
2434 grep { $_->owed > 0 }
2437 if ( $conf->exists('pkg-balances') ) {
2438 # limit @payments to those w/ a pkgnum grepped from $self
2440 foreach my $i (@invoices) {
2441 foreach my $li ( $i->cust_bill_pkg ) {
2442 $pkgnums{$li->pkgnum} = 1;
2445 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
2450 foreach my $cust_bill ( @invoices ) {
2452 if ( !defined($payment) || $payment->unapplied == 0 ) {
2453 $payment = pop @payments or last;
2457 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
2458 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
2460 $owed = $cust_bill->owed;
2462 unless ( $owed > 0 ) {
2463 push @payments, $payment;
2467 my $amount = min( $payment->unapplied, $owed );
2470 'paynum' => $payment->paynum,
2471 'invnum' => $cust_bill->invnum,
2472 'amount' => $amount,
2474 $cbp->{_date} = $payment->_date
2475 if $options{'manual'} && $options{'backdate_application'};
2476 my $cust_bill_pay = new FS::cust_bill_pay($cbp);
2477 $cust_bill_pay->pkgnum( $payment->pkgnum )
2478 if $conf->exists('pkg-balances') && $payment->pkgnum;
2479 my $error = $cust_bill_pay->insert(%options);
2481 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2485 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2489 my $total_unapplied_payments = $self->total_unapplied_payments;
2491 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2493 return $total_unapplied_payments;
2503 suspend_adjourned_pkgs
2504 unsuspend_resumed_pkgs
2507 (do_cust_event pre-bill)
2510 (vendor-only) _gather_taxes
2511 _omit_zero_value_bundles
2512 _handle_taxes (for fees)
2515 apply_payments_and_credits
2524 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>