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('FS::cust_main::Billing::bill_and_collect');
110 my %logopt = (object => $self);
111 $log->debug('start', %logopt);
115 #$options{actual_time} not $options{time} because freeside-daily -d is for
116 #pre-printing invoices
118 $options{'actual_time'} ||= time;
119 my $job = $options{'job'};
121 my $actual_time = ( $conf->exists('next-bill-ignore-time')
122 ? day_end( $options{actual_time} )
123 : $options{actual_time}
126 $job->update_statustext('0,cleaning expired packages') if $job;
127 $log->debug('canceling expired packages', %logopt);
128 $error = $self->cancel_expired_pkgs( $actual_time );
130 $error = "Error expiring custnum ". $self->custnum. ": $error";
131 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
132 elsif ( $options{fatal} ) { die $error; }
133 else { warn $error; }
136 $log->debug('suspending adjourned packages', %logopt);
137 $error = $self->suspend_adjourned_pkgs( $actual_time );
139 $error = "Error adjourning custnum ". $self->custnum. ": $error";
140 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
141 elsif ( $options{fatal} ) { die $error; }
142 else { warn $error; }
145 $log->debug('unsuspending resumed packages', %logopt);
146 $error = $self->unsuspend_resumed_pkgs( $actual_time );
148 $error = "Error resuming custnum ".$self->custnum. ": $error";
149 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
150 elsif ( $options{fatal} ) { die $error; }
151 else { warn $error; }
154 $job->update_statustext('20,billing packages') if $job;
155 $log->debug('billing packages', %logopt);
156 $error = $self->bill( %options );
158 $error = "Error billing custnum ". $self->custnum. ": $error";
159 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
160 elsif ( $options{fatal} ) { die $error; }
161 else { warn $error; }
164 $job->update_statustext('50,applying payments and credits') if $job;
165 $log->debug('applying payments and credits', %logopt);
166 $error = $self->apply_payments_and_credits;
168 $error = "Error applying custnum ". $self->custnum. ": $error";
169 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
170 elsif ( $options{fatal} ) { die $error; }
171 else { warn $error; }
174 unless ( $conf->exists('cancelled_cust-noevents')
175 && ! $self->num_ncancelled_pkgs
177 $job->update_statustext('70,running collection events') if $job;
178 $log->debug('running collection events', %logopt);
179 $error = $self->collect( %options );
181 $error = "Error collecting custnum ". $self->custnum. ": $error";
182 if ($options{fatal} && $options{fatal} eq 'return') { return $error; }
183 elsif ($options{fatal} ) { die $error; }
184 else { warn $error; }
188 $job->update_statustext('100,finished') if $job;
189 $log->debug('finish', %logopt);
195 sub cancel_expired_pkgs {
196 my ( $self, $time, %options ) = @_;
198 my @cancel_pkgs = $self->ncancelled_pkgs( {
199 'extra_sql' => " AND expire IS NOT NULL AND expire > 0 AND expire <= $time "
204 CUST_PKG: foreach my $cust_pkg ( @cancel_pkgs ) {
205 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
208 if ( $cust_pkg->change_to_pkgnum ) {
210 my $new_pkg = FS::cust_pkg->by_key($cust_pkg->change_to_pkgnum);
212 push @errors, 'can\'t change pkgnum '.$cust_pkg->pkgnum.' to pkgnum '.
213 $cust_pkg->change_to_pkgnum.'; not expiring';
216 $error = $cust_pkg->change( 'cust_pkg' => $new_pkg,
217 'unprotect_svcs' => 1 );
218 $error = '' if ref $error eq 'FS::cust_pkg';
220 } else { # just cancel it
221 $error = $cust_pkg->cancel($cpr ? ( 'reason' => $cpr->reasonnum,
222 'reason_otaker' => $cpr->otaker,
228 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
231 join(' / ', @errors);
235 sub suspend_adjourned_pkgs {
236 my ( $self, $time, %options ) = @_;
238 my @susp_pkgs = $self->ncancelled_pkgs( {
240 " AND ( susp IS NULL OR susp = 0 )
241 AND ( ( bill IS NOT NULL AND bill != 0 AND bill < $time )
242 OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
247 #only because there's no SQL test for is_prepaid :/
249 grep { ( $_->part_pkg->is_prepaid
254 && $_->adjourn <= $time
262 foreach my $cust_pkg ( @susp_pkgs ) {
263 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
264 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
265 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
266 'reason_otaker' => $cpr->otaker
270 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
273 join(' / ', @errors);
277 sub unsuspend_resumed_pkgs {
278 my ( $self, $time, %options ) = @_;
280 my @unsusp_pkgs = $self->ncancelled_pkgs( {
281 'extra_sql' => " AND resume IS NOT NULL AND resume > 0 AND resume <= $time "
286 foreach my $cust_pkg ( @unsusp_pkgs ) {
287 my $error = $cust_pkg->unsuspend( 'time' => $time );
288 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
291 join(' / ', @errors);
297 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
298 conjunction with the collect method by calling B<bill_and_collect>.
300 If there is an error, returns the error, otherwise returns false.
302 Options are passed as name-value pairs. Currently available options are:
308 If set true, re-charges setup fees.
312 If set true then only bill recurring charges, not setup, usage, one time
317 If set, then override the normal frequency and look for a part_pkg_discount
318 to take at that frequency. This is appropriate only when the normal
319 frequency for all packages is monthly, and is an error otherwise. Use
320 C<pkg_list> to limit the set of packages included in billing.
324 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:
328 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
332 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
334 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
338 A hashref of pkgparts to exclude from this billing run (can also be specified as a comma-separated scalar).
342 Do not bill prepaid packages. Used by freeside-daily.
346 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.
350 This boolean value informs the us that the package is being cancelled. This
351 typically might mean not charging the normal recurring fee but only usage
352 fees since the last billing. Setup charges may be charged. Not all package
353 plans support this feature (they tend to charge 0).
357 Prevent the resetting of usage limits during this call.
361 Do not save the generated bill in the database. Useful with return_bill
365 A list reference on which the generated bill(s) will be returned.
369 Optional terms to be printed on this invoice. Otherwise, customer-specific
370 terms or the default terms are used.
377 my( $self, %options ) = @_;
379 return '' if $self->payby eq 'COMP';
381 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
382 my $log = FS::Log->new('FS::cust_main::Billing::bill');
383 my %logopt = (object => $self);
385 $log->debug('start', %logopt);
386 warn "$me bill customer ". $self->custnum. "\n"
389 my $time = $options{'time'} || time;
390 my $invoice_time = $options{'invoice_time'} || $time;
392 my $cmp_time = ( $conf->exists('next-bill-ignore-time')
397 $options{'not_pkgpart'} ||= {};
398 $options{'not_pkgpart'} = { map { $_ => 1 }
399 split(/\s*,\s*/, $options{'not_pkgpart'})
401 unless ref($options{'not_pkgpart'});
403 local $SIG{HUP} = 'IGNORE';
404 local $SIG{INT} = 'IGNORE';
405 local $SIG{QUIT} = 'IGNORE';
406 local $SIG{TERM} = 'IGNORE';
407 local $SIG{TSTP} = 'IGNORE';
408 local $SIG{PIPE} = 'IGNORE';
410 my $oldAutoCommit = $FS::UID::AutoCommit;
411 local $FS::UID::AutoCommit = 0;
414 $log->debug('acquiring lock', %logopt);
415 warn "$me acquiring lock on customer ". $self->custnum. "\n"
418 $self->select_for_update; #mutex
420 $log->debug('running pre-bill events', %logopt);
421 warn "$me running pre-bill events for customer ". $self->custnum. "\n"
424 my $error = $self->do_cust_event(
425 'debug' => ( $options{'debug'} || 0 ),
426 'time' => $invoice_time,
427 'check_freq' => $options{'check_freq'},
428 'stage' => 'pre-bill',
430 unless $options{no_commit};
432 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
436 $log->debug('done running pre-bill events', %logopt);
437 warn "$me done running pre-bill events for customer ". $self->custnum. "\n"
440 #keep auto-charge and non-auto-charge line items separate
441 my @passes = ( '', 'no_auto' );
443 my %cust_bill_pkg = map { $_ => [] } @passes;
446 # find the packages which are due for billing, find out how much they are
447 # & generate invoice database.
450 my %total_setup = map { my $z = 0; $_ => \$z; } @passes;
451 my %total_recur = map { my $z = 0; $_ => \$z; } @passes;
453 my %taxlisthash = map { $_ => {} } @passes;
455 my @precommit_hooks = ();
457 $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ]; #param checks?
459 foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
461 next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
463 my $part_pkg = $cust_pkg->part_pkg;
465 next if $options{'no_prepaid'} && $part_pkg->is_prepaid;
467 $log->debug('bill package '. $cust_pkg->pkgnum, %logopt);
468 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG;
470 #? to avoid use of uninitialized value errors... ?
471 $cust_pkg->setfield('bill', '')
472 unless defined($cust_pkg->bill);
474 my $real_pkgpart = $cust_pkg->pkgpart;
475 my %hash = $cust_pkg->hash;
477 # we could implement this bit as FS::part_pkg::has_hidden, but we already
478 # suffer from performance issues
479 $options{has_hidden} = 0;
480 my @part_pkg = $part_pkg->self_and_bill_linked;
481 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
483 # if this package was changed from another package,
484 # and it hasn't been billed since then,
485 # and package balances are enabled,
486 if ( $cust_pkg->change_pkgnum
487 and $cust_pkg->change_date >= ($cust_pkg->last_bill || 0)
488 and $cust_pkg->change_date < $invoice_time
489 and $conf->exists('pkg-balances') )
491 # _transfer_balance will also create the appropriate credit
492 my @transfer_items = $self->_transfer_balance($cust_pkg);
493 # $part_pkg[0] is the "real" part_pkg
494 my $pass = ($cust_pkg->no_auto || $part_pkg[0]->no_auto) ?
496 push @{ $cust_bill_pkg{$pass} }, @transfer_items;
497 # treating this as recur, just because most charges are recur...
498 ${$total_recur{$pass}} += $_->recur foreach @transfer_items;
501 foreach my $part_pkg ( @part_pkg ) {
503 $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
505 my $pass = ($cust_pkg->no_auto || $part_pkg->no_auto) ? 'no_auto' : '';
507 my $next_bill = $cust_pkg->getfield('bill') || 0;
509 # let this run once if this is the last bill upon cancellation
510 while ( $next_bill <= $cmp_time or $options{cancel} ) {
512 $self->_make_lines( 'part_pkg' => $part_pkg,
513 'cust_pkg' => $cust_pkg,
514 'precommit_hooks' => \@precommit_hooks,
515 'line_items' => $cust_bill_pkg{$pass},
516 'setup' => $total_setup{$pass},
517 'recur' => $total_recur{$pass},
518 'tax_matrix' => $taxlisthash{$pass},
520 'real_pkgpart' => $real_pkgpart,
521 'options' => \%options,
524 # Stop if anything goes wrong
527 # or if we're not incrementing the bill date.
528 last if ($cust_pkg->getfield('bill') || 0) == $next_bill;
530 # or if we're letting it run only once
531 last if $options{cancel};
533 $next_bill = $cust_pkg->getfield('bill') || 0;
535 #stop if -o was passed to freeside-daily
536 last if $options{'one_recur'};
539 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
543 } #foreach my $part_pkg
545 } #foreach my $cust_pkg
547 #if the customer isn't on an automatic payby, everything can go on a single
549 #if ( $cust_main->payby !~ /^(CARD|CHEK)$/ ) {
550 #merge everything into one list
553 foreach my $pass (@passes) { # keys %cust_bill_pkg ) {
555 my @cust_bill_pkg = _omit_zero_value_bundles(@{ $cust_bill_pkg{$pass} });
557 warn "$me billing pass $pass\n"
558 #.Dumper(\@cust_bill_pkg)."\n"
565 my @pending_event_fees = FS::cust_event_fee->by_cust($self->custnum,
566 hashref => { 'billpkgnum' => '' }
568 warn "$me found pending fee events:\n".Dumper(\@pending_event_fees)."\n"
569 if @pending_event_fees and $DEBUG > 1;
571 # determine whether to generate an invoice
572 my $generate_bill = scalar(@cust_bill_pkg) > 0;
574 foreach my $event_fee (@pending_event_fees) {
575 $generate_bill = 1 unless $event_fee->nextbill;
578 # don't create an invoice with no line items, or where the only line
579 # items are fees that are supposed to be held until the next invoice
580 next if !$generate_bill;
584 foreach my $event_fee (@pending_event_fees) {
585 my $object = $event_fee->cust_event->cust_X;
586 my $part_fee = $event_fee->part_fee;
588 if ( $object->isa('FS::cust_main')
589 or $object->isa('FS::cust_pkg')
590 or $object->isa('FS::cust_pay_batch') )
592 # Not the real cust_bill object that will be inserted--in particular
593 # there are no taxes yet. If you want to charge a fee on the total
594 # invoice amount including taxes, you have to put the fee on the next
596 $cust_bill = FS::cust_bill->new({
597 'custnum' => $self->custnum,
598 'cust_bill_pkg' => \@cust_bill_pkg,
599 'charged' => ${ $total_setup{$pass} } +
600 ${ $total_recur{$pass} },
603 # If this is a package event, only apply the fee to line items
605 if ($object->isa('FS::cust_pkg')) {
606 $cust_bill->set('cust_bill_pkg',
607 [ grep { $_->pkgnum == $object->pkgnum } @cust_bill_pkg ]
611 } elsif ( $object->isa('FS::cust_bill') ) {
612 # simple case: applying the fee to a previous invoice (late fee,
614 $cust_bill = $object;
616 # if the fee def belongs to a different agent, don't charge the fee.
617 # event conditions should prevent this, but just in case they don't,
619 if ( $part_fee->agentnum and $part_fee->agentnum != $self->agentnum ) {
620 warn "tried to charge fee#".$part_fee->feepart .
621 " on customer#".$self->custnum." from a different agent.\n";
624 # also skip if it's disabled
625 next if $part_fee->disabled eq 'Y';
627 my $fee_item = $part_fee->lineitem($cust_bill) or next;
628 # link this so that we can clear the marker on inserting the line item
629 $fee_item->set('cust_event_fee', $event_fee);
630 push @fee_items, $fee_item;
634 # add fees to the invoice
635 foreach my $fee_item (@fee_items) {
637 push @cust_bill_pkg, $fee_item;
638 ${ $total_setup{$pass} } += $fee_item->setup;
639 ${ $total_recur{$pass} } += $fee_item->recur;
641 my $part_fee = $fee_item->part_fee;
642 my $fee_location = $self->ship_location; # I think?
644 my $error = $self->_handle_taxes(
647 location => $fee_location
648 # probably not right to pass cancel => 1 for fees
650 return $error if $error;
654 # XXX implementation of fees is supposed to make this go away...
655 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
656 !$conf->exists('postal_invoice-recurring_only')
660 my $postal_pkg = $self->charge_postal_fee();
661 if ( $postal_pkg && !ref( $postal_pkg ) ) {
663 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
664 return "can't charge postal invoice fee for customer ".
665 $self->custnum. ": $postal_pkg";
667 } elsif ( $postal_pkg ) {
669 my $real_pkgpart = $postal_pkg->pkgpart;
670 # we could implement this bit as FS::part_pkg::has_hidden, but we already
671 # suffer from performance issues
672 $options{has_hidden} = 0;
673 my @part_pkg = $postal_pkg->part_pkg->self_and_bill_linked;
674 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
676 foreach my $part_pkg ( @part_pkg ) {
677 my %postal_options = %options;
678 delete $postal_options{cancel};
680 $self->_make_lines( 'part_pkg' => $part_pkg,
681 'cust_pkg' => $postal_pkg,
682 'precommit_hooks' => \@precommit_hooks,
683 'line_items' => \@cust_bill_pkg,
684 'setup' => $total_setup{$pass},
685 'recur' => $total_recur{$pass},
686 'tax_matrix' => $taxlisthash{$pass},
688 'real_pkgpart' => $real_pkgpart,
689 'options' => \%postal_options,
692 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
697 # it's silly to have a zero value postal_pkg, but....
698 @cust_bill_pkg = _omit_zero_value_bundles(@cust_bill_pkg);
704 my $listref_or_error =
705 $self->calculate_taxes( \@cust_bill_pkg, $taxlisthash{$pass}, $invoice_time);
707 unless ( ref( $listref_or_error ) ) {
708 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
709 return $listref_or_error;
712 foreach my $taxline ( @$listref_or_error ) {
713 ${ $total_setup{$pass} } =
714 sprintf('%.2f', ${ $total_setup{$pass} } + $taxline->setup );
715 push @cust_bill_pkg, $taxline;
719 warn "adding tax adjustments...\n" if $DEBUG > 2;
720 foreach my $cust_tax_adjustment (
721 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
727 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
729 my $itemdesc = $cust_tax_adjustment->taxname;
730 $itemdesc = '' if $itemdesc eq 'Tax';
732 push @cust_bill_pkg, new FS::cust_bill_pkg {
738 'itemdesc' => $itemdesc,
739 'itemcomment' => $cust_tax_adjustment->comment,
740 'cust_tax_adjustment' => $cust_tax_adjustment,
741 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
746 my $charged = sprintf('%.2f', ${ $total_setup{$pass} } + ${ $total_recur{$pass} } );
748 my $balance = $self->balance;
750 my $previous_bill = qsearchs({ 'table' => 'cust_bill',
751 'hashref' => { custnum=>$self->custnum },
752 'extra_sql' => 'ORDER BY _date DESC LIMIT 1',
754 my $previous_balance =
756 ? ( $previous_bill->billing_balance + $previous_bill->charged )
759 $log->debug('creating the new invoice', %logopt);
760 warn "creating the new invoice\n" if $DEBUG;
761 #create the new invoice
762 my $cust_bill = new FS::cust_bill ( {
763 'custnum' => $self->custnum,
764 '_date' => $invoice_time,
765 'charged' => $charged,
766 'billing_balance' => $balance,
767 'previous_balance' => $previous_balance,
768 'invoice_terms' => $options{'invoice_terms'},
769 'cust_bill_pkg' => \@cust_bill_pkg,
771 $error = $cust_bill->insert unless $options{no_commit};
773 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
774 return "can't create invoice for customer #". $self->custnum. ": $error";
776 push @{$options{return_bill}}, $cust_bill if $options{return_bill};
778 } #foreach my $pass ( keys %cust_bill_pkg )
780 foreach my $hook ( @precommit_hooks ) {
783 } unless $options{no_commit};
785 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
786 return "$@ running precommit hook $hook\n";
790 $dbh->commit or die $dbh->errstr if $oldAutoCommit && !$options{no_commit};
795 #discard bundled packages of 0 value
796 sub _omit_zero_value_bundles {
799 my @cust_bill_pkg = ();
800 my @cust_bill_pkg_bundle = ();
802 my $discount_show_always = 0;
804 foreach my $cust_bill_pkg ( @in ) {
806 $discount_show_always = ($cust_bill_pkg->get('discounts')
807 && scalar(@{$cust_bill_pkg->get('discounts')})
808 && $conf->exists('discount-show-always'));
810 warn " pkgnum ". $cust_bill_pkg->pkgnum. " sum $sum, ".
811 "setup_show_zero ". $cust_bill_pkg->setup_show_zero.
812 "recur_show_zero ". $cust_bill_pkg->recur_show_zero. "\n"
815 if (scalar(@cust_bill_pkg_bundle) && !$cust_bill_pkg->pkgpart_override) {
816 push @cust_bill_pkg, @cust_bill_pkg_bundle
818 || ($sum == 0 && ( $discount_show_always
819 || grep {$_->recur_show_zero || $_->setup_show_zero}
820 @cust_bill_pkg_bundle
823 @cust_bill_pkg_bundle = ();
827 $sum += $cust_bill_pkg->setup + $cust_bill_pkg->recur;
828 push @cust_bill_pkg_bundle, $cust_bill_pkg;
832 push @cust_bill_pkg, @cust_bill_pkg_bundle
834 || ($sum == 0 && ( $discount_show_always
835 || grep {$_->recur_show_zero || $_->setup_show_zero}
836 @cust_bill_pkg_bundle
840 warn " _omit_zero_value_bundles: ". scalar(@in).
841 '->'. scalar(@cust_bill_pkg). "\n" #. Dumper(@cust_bill_pkg). "\n"
848 =item calculate_taxes LINEITEMREF TAXHASHREF INVOICE_TIME
850 Generates tax line items (see L<FS::cust_bill_pkg>) for this customer.
851 Usually used internally by bill method B<bill>.
853 If there is an error, returns the error, otherwise returns reference to a
854 list of line items suitable for insertion.
860 An array ref of the line items being billed.
864 A strange beast. The keys to this hash are internal identifiers consisting
865 of the name of the tax object type, a space, and its unique identifier ( e.g.
866 'cust_main_county 23' ). The values of the hash are listrefs. The first
867 item in the list is the tax object. The remaining items are either line
868 items or floating point values (currency amounts).
870 The taxes are calculated on this entity. Calculated exemption records are
871 transferred to the LINEITEMREF items on the assumption that they are related.
877 This specifies the date appearing on the associated invoice. Some
878 jurisdictions (i.e. Texas) have tax exemptions which are date sensitive.
884 sub calculate_taxes {
885 my ($self, $cust_bill_pkg, $taxlisthash, $invoice_time) = @_;
887 # $taxlisthash is a hashref
888 # keys are identifiers, values are arrayrefs
889 # each arrayref starts with a tax object (cust_main_county or tax_rate)
890 # then any cust_bill_pkg objects the tax applies to
892 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
894 warn "$me calculate_taxes\n"
895 #.Dumper($self, $cust_bill_pkg, $taxlisthash, $invoice_time). "\n"
898 my @tax_line_items = ();
900 # keys are tax names (as printed on invoices / itemdesc )
901 # values are arrayrefs of taxlisthash keys (internal identifiers)
904 # keys are taxlisthash keys (internal identifiers)
905 # values are (cumulative) amounts
908 # keys are taxlisthash keys (internal identifiers)
909 # values are arrayrefs of cust_bill_pkg_tax_location hashrefs
910 my %tax_location = ();
912 # keys are taxlisthash keys (internal identifiers)
913 # values are arrayrefs of cust_bill_pkg_tax_rate_location hashrefs
914 my %tax_rate_location = ();
916 # keys are taxlisthash keys (internal identifiers!)
917 # values are arrayrefs of cust_tax_exempt_pkg objects
920 foreach my $tax ( keys %$taxlisthash ) {
921 # $tax is a tax identifier (intersection of a tax definition record
922 # and a cust_bill_pkg record)
923 my $tax_object = shift @{ $taxlisthash->{$tax} };
924 # $tax_object is a cust_main_county or tax_rate
925 # (with billpkgnum, pkgnum, locationnum set)
926 # the rest of @{ $taxlisthash->{$tax} } is cust_bill_pkg component objects
927 # (setup, recurring, usage classes)
928 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
929 warn " ". join('/', @{ $taxlisthash->{$tax} } ). "\n" if $DEBUG > 2;
930 # taxline calculates the tax on all cust_bill_pkgs in the
931 # first (arrayref) argument, and returns a hashref of 'name'
932 # (the line item description) and 'amount'.
933 # It also calculates exemptions and attaches them to the cust_bill_pkgs
935 my $taxables = $taxlisthash->{$tax};
936 my $exemptions = $tax_exemption{$tax} ||= [];
937 my $taxline = $tax_object->taxline(
939 'custnum' => $self->custnum,
940 'invoice_time' => $invoice_time,
941 'exemptions' => $exemptions,
943 return $taxline unless ref($taxline);
945 unshift @{ $taxlisthash->{$tax} }, $tax_object;
947 if ( $tax_object->isa('FS::cust_main_county') ) {
948 # then $taxline is a real line item
949 push @{ $taxname{ $taxline->itemdesc } }, $taxline;
952 # leave this as is for now
954 my $name = $taxline->{'name'};
955 my $amount = $taxline->{'amount'};
957 #warn "adding $amount as $name\n";
958 $taxname{ $name } ||= [];
959 push @{ $taxname{ $name } }, $tax;
961 $tax_amount{ $tax } += $amount;
963 # link records between cust_main_county/tax_rate and cust_location
964 $tax_rate_location{ $tax } ||= [];
965 my $taxratelocationnum =
966 $tax_object->tax_rate_location->taxratelocationnum;
967 push @{ $tax_rate_location{ $tax } },
969 'taxnum' => $tax_object->taxnum,
970 'taxtype' => ref($tax_object),
971 'amount' => sprintf('%.2f', $amount ),
972 'locationtaxid' => $tax_object->location,
973 'taxratelocationnum' => $taxratelocationnum,
975 } #if ref($tax_object)...
976 } #foreach keys %$taxlisthash
978 #consolidate and create tax line items
979 warn "consolidating and generating...\n" if $DEBUG > 2;
980 foreach my $taxname ( keys %taxname ) {
981 my @cust_bill_pkg_tax_location;
982 my @cust_bill_pkg_tax_rate_location;
983 my $tax_cust_bill_pkg = FS::cust_bill_pkg->new({
988 'itemdesc' => $taxname,
989 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
990 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
995 warn "adding $taxname\n" if $DEBUG > 1;
996 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
997 if ( ref($taxitem) eq 'FS::cust_bill_pkg' ) {
998 # then we need to transfer the amount and the links from the
999 # line item to the new one we're creating.
1000 $tax_total += $taxitem->setup;
1001 foreach my $link ( @{ $taxitem->get('cust_bill_pkg_tax_location') } ) {
1002 $link->set('tax_cust_bill_pkg', $tax_cust_bill_pkg);
1003 push @cust_bill_pkg_tax_location, $link;
1007 next if $seen{$taxitem}++;
1008 warn "adding $tax_amount{$taxitem}\n" if $DEBUG > 1;
1009 $tax_total += $tax_amount{$taxitem};
1010 push @cust_bill_pkg_tax_rate_location,
1011 map { new FS::cust_bill_pkg_tax_rate_location $_ }
1012 @{ $tax_rate_location{ $taxitem } };
1015 next unless $tax_total;
1017 # we should really neverround this up...I guess it's okay if taxline
1018 # already returns amounts with 2 decimal places
1019 $tax_total = sprintf('%.2f', $tax_total );
1020 $tax_cust_bill_pkg->set('setup', $tax_total);
1022 my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
1028 if ( $pkg_category and
1029 $conf->config('invoice_latexsummary') ||
1030 $conf->config('invoice_htmlsummary')
1034 my %hash = ( 'section' => $pkg_category->categoryname );
1035 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
1038 $tax_cust_bill_pkg->set('display', \@display);
1040 push @tax_line_items, $tax_cust_bill_pkg;
1047 my ($self, %params) = @_;
1049 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1051 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
1052 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
1053 my $cust_location = $cust_pkg->tax_location;
1054 my $precommit_hooks = $params{precommit_hooks} or die "no precommit_hooks specified";
1055 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
1056 my $total_setup = $params{setup} or die "no setup accumulator specified";
1057 my $total_recur = $params{recur} or die "no recur accumulator specified";
1058 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
1059 my $time = $params{'time'} or die "no time specified";
1060 my (%options) = %{$params{options}};
1062 if ( $part_pkg->freq ne '1' and ($options{'freq_override'} || 0) > 0 ) {
1063 # this should never happen
1064 die 'freq_override billing attempted on non-monthly package '.
1069 my $real_pkgpart = $params{real_pkgpart};
1070 my %hash = $cust_pkg->hash;
1071 my $old_cust_pkg = new FS::cust_pkg \%hash;
1076 $cust_pkg->pkgpart($part_pkg->pkgpart);
1078 my $cmp_time = ( $conf->exists('next-bill-ignore-time')
1089 my @setup_discounts = ();
1090 my %setup_param = ( 'discounts' => \@setup_discounts,
1091 'real_pkgpart' => $params{real_pkgpart}
1093 # Conditions for setting setup date and charging the setup fee:
1094 # - this is not a recurring-only billing run
1095 # - and the package is not currently being canceled
1096 # - and, unless we're specifically told otherwise via 'resetup':
1097 # - it doesn't already HAVE a setup date
1098 # - or a start date in the future
1099 # - and it's not suspended
1101 # The last condition used to check the "disable_setup_suspended" option but
1102 # that's obsolete. We now never set the setup date on a suspended package.
1103 if ( ! $options{recurring_only}
1104 and ! $options{cancel}
1105 and ( $options{'resetup'}
1106 || ( ! $cust_pkg->setup
1107 && ( ! $cust_pkg->start_date
1108 || $cust_pkg->start_date <= $cmp_time
1110 && ( ! $cust_pkg->getfield('susp') )
1116 warn " bill setup\n" if $DEBUG > 1;
1118 unless ( $cust_pkg->waive_setup ) {
1121 $setup = eval { $cust_pkg->calc_setup( $time, \@details, \%setup_param ) };
1122 return "$@ running calc_setup for $cust_pkg\n"
1125 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
1128 $cust_pkg->setfield('setup', $time)
1129 unless $cust_pkg->setup;
1130 #do need it, but it won't get written to the db
1131 #|| $cust_pkg->pkgpart != $real_pkgpart;
1133 $cust_pkg->setfield('start_date', '')
1134 if $cust_pkg->start_date;
1139 # bill recurring fee
1144 my @recur_discounts = ();
1146 if ( ! $cust_pkg->start_date
1149 || ( $cust_pkg->susp != $cust_pkg->order_date
1150 && ( $cust_pkg->option('suspend_bill',1)
1151 || ( $part_pkg->option('suspend_bill', 1)
1152 && ! $cust_pkg->option('no_suspend_bill',1)
1158 ( $part_pkg->freq ne '0' && ( $cust_pkg->bill || 0 ) <= $cmp_time )
1159 || ( $part_pkg->plan eq 'voip_cdr'
1160 && $part_pkg->option('bill_every_call')
1165 # XXX should this be a package event? probably. events are called
1166 # at collection time at the moment, though...
1167 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
1168 if $part_pkg->can('reset_usage') && !$options{'no_usage_reset'};
1169 #don't want to reset usage just cause we want a line item??
1170 #&& $part_pkg->pkgpart == $real_pkgpart;
1172 warn " bill recur\n" if $DEBUG > 1;
1175 # XXX shared with $recur_prog
1176 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
1180 #over two params! lets at least switch to a hashref for the rest...
1181 my $increment_next_bill = ( $part_pkg->freq ne '0'
1182 && ( $cust_pkg->getfield('bill') || 0 ) <= $cmp_time
1183 && !$options{cancel}
1185 my %param = ( %setup_param,
1186 'precommit_hooks' => $precommit_hooks,
1187 'increment_next_bill' => $increment_next_bill,
1188 'discounts' => \@recur_discounts,
1189 'real_pkgpart' => $real_pkgpart,
1190 'freq_override' => $options{freq_override} || '',
1194 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
1196 # There may be some part_pkg for which this is wrong. Only those
1197 # which can_discount are supported.
1198 # (the UI should prevent adding discounts to these at the moment)
1200 warn "calling $method on cust_pkg ". $cust_pkg->pkgnum.
1201 " for pkgpart ". $cust_pkg->pkgpart.
1202 " with params ". join(' / ', map "$_=>$param{$_}", keys %param). "\n"
1205 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
1206 return "$@ running $method for $cust_pkg\n"
1210 $unitrecur = $cust_pkg->base_recur( \$sdate ) || $recur; #XXX uuh, better
1212 if ( $increment_next_bill ) {
1216 if ( my $main_pkg = $cust_pkg->main_pkg ) {
1217 # supplemental package
1218 # to keep in sync with the main package, simulate billing at
1220 my $main_pkg_freq = $main_pkg->part_pkg->freq;
1221 my $supp_pkg_freq = $part_pkg->freq;
1222 my $ratio = $supp_pkg_freq / $main_pkg_freq;
1223 if ( $ratio != int($ratio) ) {
1224 # the UI should prevent setting up packages like this, but just
1226 return "supplemental package period is not an integer multiple of main package period";
1228 $next_bill = $sdate;
1230 $next_bill = $part_pkg->add_freq( $next_bill, $main_pkg_freq );
1235 $next_bill = $part_pkg->add_freq($sdate, $options{freq_override} || 0);
1236 return "unparsable frequency: ". $part_pkg->freq
1237 if $next_bill == -1;
1240 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
1241 # only for figuring next bill date, nothing else, so, reset $sdate again
1243 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1244 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
1245 $cust_pkg->last_bill($sdate);
1247 $cust_pkg->setfield('bill', $next_bill );
1251 if ( $param{'setup_fee'} ) {
1252 # Add an additional setup fee at the billing stage.
1253 # Used for prorate_defer_bill.
1254 $setup += $param{'setup_fee'};
1255 $unitsetup += $param{'setup_fee'};
1259 if ( defined $param{'discount_left_setup'} ) {
1260 foreach my $discount_setup ( values %{$param{'discount_left_setup'}} ) {
1261 $setup -= $discount_setup;
1267 warn "\$setup is undefined" unless defined($setup);
1268 warn "\$recur is undefined" unless defined($recur);
1269 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1272 # If there's line items, create em cust_bill_pkg records
1273 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
1278 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
1279 # hmm.. and if just the options are modified in some weird price plan?
1281 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
1284 my $error = $cust_pkg->replace( $old_cust_pkg,
1285 'depend_jobnum'=>$options{depend_jobnum},
1286 'options' => { $cust_pkg->options },
1288 unless $options{no_commit};
1289 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
1290 if $error; #just in case
1293 $setup = sprintf( "%.2f", $setup );
1294 $recur = sprintf( "%.2f", $recur );
1295 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
1296 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1298 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
1299 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
1302 my $discount_show_always = $conf->exists('discount-show-always')
1303 && ( ($setup == 0 && scalar(@setup_discounts))
1304 || ($recur == 0 && scalar(@recur_discounts))
1309 || (!$part_pkg->hidden && $options{has_hidden}) #include some $0 lines
1310 || $discount_show_always
1311 || ($setup == 0 && $cust_pkg->_X_show_zero('setup'))
1312 || ($recur == 0 && $cust_pkg->_X_show_zero('recur'))
1316 warn " charges (setup=$setup, recur=$recur); adding line items\n"
1319 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
1321 warn " adding customer package invoice detail: $_\n"
1322 foreach @cust_pkg_detail;
1324 push @details, @cust_pkg_detail;
1326 my $cust_bill_pkg = new FS::cust_bill_pkg {
1327 'pkgnum' => $cust_pkg->pkgnum,
1329 'unitsetup' => $unitsetup,
1331 'unitrecur' => $unitrecur,
1332 'quantity' => $cust_pkg->quantity,
1333 'details' => \@details,
1334 'discounts' => [ @setup_discounts, @recur_discounts ],
1335 'hidden' => $part_pkg->hidden,
1336 'freq' => $part_pkg->freq,
1339 if ( $part_pkg->option('prorate_defer_bill',1)
1340 and !$hash{last_bill} ) {
1341 # both preceding and upcoming, technically
1342 $cust_bill_pkg->sdate( $cust_pkg->setup );
1343 $cust_bill_pkg->edate( $cust_pkg->bill );
1344 } elsif ( $part_pkg->recur_temporality eq 'preceding' ) {
1345 $cust_bill_pkg->sdate( $hash{last_bill} );
1346 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
1347 $cust_bill_pkg->edate( $time ) if $options{cancel};
1348 } else { #if ( $part_pkg->recur_temporality eq 'upcoming' ) {
1349 $cust_bill_pkg->sdate( $sdate );
1350 $cust_bill_pkg->edate( $cust_pkg->bill );
1351 #$cust_bill_pkg->edate( $time ) if $options{cancel};
1354 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
1355 unless $part_pkg->pkgpart == $real_pkgpart;
1357 $$total_setup += $setup;
1358 $$total_recur += $recur;
1364 my $error = $self->_handle_taxes( $taxlisthash, $cust_bill_pkg,
1365 cancel => $options{cancel} );
1366 return $error if $error;
1368 $cust_bill_pkg->set_display(
1369 part_pkg => $part_pkg,
1370 real_pkgpart => $real_pkgpart,
1373 push @$cust_bill_pkgs, $cust_bill_pkg;
1375 } #if $setup != 0 || $recur != 0
1383 =item _transfer_balance TO_PKG [ FROM_PKGNUM ]
1385 Takes one argument, a cust_pkg object that is being billed. This will
1386 be called only if the package was created by a package change, and has
1387 not been billed since the package change, and package balance tracking
1388 is enabled. The second argument can be an alternate package number to
1389 transfer the balance from; this should not be used externally.
1391 Transfers the balance from the previous package (now canceled) to
1392 this package, by crediting one package and creating an invoice item for
1393 the other. Inserts the credit and returns the invoice item (so that it
1394 can be added to an invoice that's being built).
1396 If the previous package was never billed, and was also created by a package
1397 change, then this will also transfer the balance from I<its> previous
1398 package, and so on, until reaching a package that either has been billed
1399 or was not created by a package change.
1403 my $balance_transfer_reason;
1405 sub _transfer_balance {
1407 my $cust_pkg = shift;
1408 my $from_pkgnum = shift || $cust_pkg->change_pkgnum;
1409 my $from_pkg = FS::cust_pkg->by_key($from_pkgnum);
1413 # if $from_pkg is not the first package in the chain, and it was never
1415 if ( $from_pkg->change_pkgnum and scalar($from_pkg->cust_bill_pkg) == 0 ) {
1416 @transfers = $self->_transfer_balance($cust_pkg, $from_pkg->change_pkgnum);
1419 my $prev_balance = $self->balance_pkgnum($from_pkgnum);
1420 if ( $prev_balance != 0 ) {
1421 $balance_transfer_reason ||= FS::reason->new_or_existing(
1422 'reason' => 'Package balance transfer',
1423 'type' => 'Internal adjustment',
1427 my $credit = FS::cust_credit->new({
1428 'custnum' => $self->custnum,
1429 'amount' => abs($prev_balance),
1430 'reasonnum' => $balance_transfer_reason->reasonnum,
1431 '_date' => $cust_pkg->change_date,
1434 my $cust_bill_pkg = FS::cust_bill_pkg->new({
1436 'recur' => abs($prev_balance),
1437 #'sdate' => $from_pkg->last_bill, # not sure about this
1438 #'edate' => $cust_pkg->change_date,
1439 'itemdesc' => $self->mt('Previous Balance, [_1]',
1440 $from_pkg->part_pkg->pkg),
1443 if ( $prev_balance > 0 ) {
1444 # credit the old package, charge the new one
1445 $credit->set('pkgnum', $from_pkgnum);
1446 $cust_bill_pkg->set('pkgnum', $cust_pkg->pkgnum);
1449 $credit->set('pkgnum', $cust_pkg->pkgnum);
1450 $cust_bill_pkg->set('pkgnum', $from_pkgnum);
1452 my $error = $credit->insert;
1453 die "error transferring package balance from #".$from_pkgnum.
1454 " to #".$cust_pkg->pkgnum.": $error\n" if $error;
1456 push @transfers, $cust_bill_pkg;
1457 } # $prev_balance != 0
1462 =item handle_taxes TAXLISTHASH CUST_BILL_PKG [ OPTIONS ]
1464 This is _handle_taxes. It's called once for each cust_bill_pkg generated
1467 TAXLISTHASH is a hashref shared across the entire invoice. It looks like
1470 'cust_main_county 1001' => [ [FS::cust_main_county], ... ],
1471 'cust_main_county 1002' => [ [FS::cust_main_county], ... ],
1474 'cust_main_county' can also be 'tax_rate'. The first object in the array
1475 is always the cust_main_county or tax_rate identified by the key.
1477 That "..." is a list of FS::cust_bill_pkg objects that will be fed to
1478 the 'taxline' method to calculate the amount of the tax. This doesn't
1479 happen until calculate_taxes, though.
1481 OPTIONS may include:
1482 - part_item: a part_pkg or part_fee object to be used as the package/fee
1484 - location: a cust_location to be used as the billing location.
1485 - cancel: true if this package is being billed on cancellation. This
1486 allows tax to be calculated on usage charges only.
1488 If not supplied, part_item will be inferred from the pkgnum or feepart of the
1489 cust_bill_pkg, and location from the pkgnum (or, for fees, the invnum and
1490 the customer's default service location).
1496 my $taxlisthash = shift;
1497 my $cust_bill_pkg = shift;
1500 # at this point I realize that we have enough information to infer all this
1501 # stuff, instead of passing around giant honking argument lists
1502 my $location = $options{location} || $cust_bill_pkg->tax_location;
1503 my $part_item = $options{part_item} || $cust_bill_pkg->part_X;
1505 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1507 return if ( $self->payby eq 'COMP' ); #dubious
1509 if ( $conf->exists('enable_taxproducts')
1510 && ( scalar($part_item->part_pkg_taxoverride)
1511 || $part_item->has_taxproduct
1516 # EXTERNAL TAX RATES (via tax_rate)
1517 my %cust_bill_pkg = ();
1521 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
1522 push @classes, 'setup' if $cust_bill_pkg->setup and !$options{cancel};
1523 push @classes, 'recur' if $cust_bill_pkg->recur and !$options{cancel};
1525 my $exempt = $conf->exists('cust_class-tax_exempt')
1526 ? ( $self->cust_class ? $self->cust_class->tax : '' )
1528 # standardize this just to be sure
1529 $exempt = ($exempt eq 'Y') ? 'Y' : '';
1533 foreach my $class (@classes) {
1534 my $err_or_ref = $self->_gather_taxes($part_item, $class, $location);
1535 return $err_or_ref unless ref($err_or_ref);
1536 $taxes{$class} = $err_or_ref;
1539 unless (exists $taxes{''}) {
1540 my $err_or_ref = $self->_gather_taxes($part_item, '', $location);
1541 return $err_or_ref unless ref($err_or_ref);
1542 $taxes{''} = $err_or_ref;
1547 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate; # grrr
1548 foreach my $key (keys %tax_cust_bill_pkg) {
1549 # $key is "setup", "recur", or a usage class name. ('' is a usage class.)
1550 # $tax_cust_bill_pkg{$key} is a cust_bill_pkg for that component of
1552 # $taxes{$key} is an arrayref of cust_main_county or tax_rate objects that
1553 # apply to $key-class charges.
1554 my @taxes = @{ $taxes{$key} || [] };
1555 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
1557 my %localtaxlisthash = ();
1558 foreach my $tax ( @taxes ) {
1560 # this is the tax identifier, not the taxname
1561 my $taxname = ref( $tax ). ' '. $tax->taxnum;
1562 # $taxlisthash: keys are "setup", "recur", and usage classes.
1563 # Values are arrayrefs, first the tax object (cust_main_county
1564 # or tax_rate) and then any cust_bill_pkg objects that the
1566 $taxlisthash->{ $taxname } ||= [ $tax ];
1567 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
1569 $localtaxlisthash{ $taxname } ||= [ $tax ];
1570 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
1574 warn "finding taxed taxes...\n" if $DEBUG > 2;
1575 foreach my $tax ( keys %localtaxlisthash ) {
1576 my $tax_object = shift @{ $localtaxlisthash{$tax} };
1577 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
1579 next unless $tax_object->can('tax_on_tax');
1581 foreach my $tot ( $tax_object->tax_on_tax( $location ) ) {
1582 my $totname = ref( $tot ). ' '. $tot->taxnum;
1584 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
1586 next unless exists( $localtaxlisthash{ $totname } ); # only increase
1588 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
1589 # calculate the tax amount that the tax_on_tax will apply to
1590 my $hashref_or_error =
1591 $tax_object->taxline( $localtaxlisthash{$tax} );
1592 return $hashref_or_error
1593 unless ref($hashref_or_error);
1595 # and append it to the list of taxable items
1596 $taxlisthash->{ $totname } ||= [ $tot ];
1597 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
1605 # INTERNAL TAX RATES (cust_main_county)
1607 # We fetch taxes even if the customer is completely exempt,
1608 # because we need to record that fact.
1610 my @loc_keys = qw( district city county state country );
1611 my %taxhash = map { $_ => $location->$_ } @loc_keys;
1613 $taxhash{'taxclass'} = $part_item->taxclass;
1615 warn "taxhash:\n". Dumper(\%taxhash) if $DEBUG > 2;
1617 my @taxes = (); # entries are cust_main_county objects
1618 my %taxhash_elim = %taxhash;
1619 my @elim = qw( district city county state );
1622 #first try a match with taxclass
1623 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1625 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1626 #then try a match without taxclass
1627 my %no_taxclass = %taxhash_elim;
1628 $no_taxclass{ 'taxclass' } = '';
1629 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1632 $taxhash_elim{ shift(@elim) } = '';
1634 } while ( !scalar(@taxes) && scalar(@elim) );
1637 my $tax_id = 'cust_main_county '.$_->taxnum;
1638 $taxlisthash->{$tax_id} ||= [ $_ ];
1639 push @{ $taxlisthash->{$tax_id} }, $cust_bill_pkg;
1646 =item _gather_taxes PART_ITEM CLASS CUST_LOCATION
1648 Internal method used with vendor-provided tax tables. PART_ITEM is a part_pkg
1649 or part_fee (which will define the tax eligibility of the product), CLASS is
1650 'setup', 'recur', null, or a C<usage_class> number, and CUST_LOCATION is the
1651 location where the service was provided (or billed, depending on
1652 configuration). Returns an arrayref of L<FS::tax_rate> objects that
1653 can apply to this line item.
1659 my $part_item = shift;
1661 my $location = shift;
1663 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1665 my $geocode = $location->geocode('cch');
1667 [ $part_item->tax_rates('cch', $geocode, $class) ]
1671 =item collect [ HASHREF | OPTION => VALUE ... ]
1673 (Attempt to) collect money for this customer's outstanding invoices (see
1674 L<FS::cust_bill>). Usually used after the bill method.
1676 Actions are now triggered by billing events; see L<FS::part_event> and the
1677 billing events web interface. Old-style invoice events (see
1678 L<FS::part_bill_event>) have been deprecated.
1680 If there is an error, returns the error, otherwise returns false.
1682 Options are passed as name-value pairs.
1684 Currently available options are:
1690 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.
1694 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1698 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1702 set true to surpress email card/ACH decline notices.
1706 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)
1712 # allows for one time override of normal customer billing method
1717 my( $self, %options ) = @_;
1719 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1721 my $invoice_time = $options{'invoice_time'} || time;
1724 local $SIG{HUP} = 'IGNORE';
1725 local $SIG{INT} = 'IGNORE';
1726 local $SIG{QUIT} = 'IGNORE';
1727 local $SIG{TERM} = 'IGNORE';
1728 local $SIG{TSTP} = 'IGNORE';
1729 local $SIG{PIPE} = 'IGNORE';
1731 my $oldAutoCommit = $FS::UID::AutoCommit;
1732 local $FS::UID::AutoCommit = 0;
1735 $self->select_for_update; #mutex
1738 my $balance = $self->balance;
1739 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
1742 if ( exists($options{'retry_card'}) ) {
1743 carp 'retry_card option passed to collect is deprecated; use retry';
1744 $options{'retry'} ||= $options{'retry_card'};
1746 if ( exists($options{'retry'}) && $options{'retry'} ) {
1747 my $error = $self->retry_realtime;
1749 $dbh->rollback if $oldAutoCommit;
1754 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1756 #never want to roll back an event just because it returned an error
1757 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1759 $self->do_cust_event(
1760 'debug' => ( $options{'debug'} || 0 ),
1761 'time' => $invoice_time,
1762 'check_freq' => $options{'check_freq'},
1763 'stage' => 'collect',
1768 =item retry_realtime
1770 Schedules realtime / batch credit card / electronic check / LEC billing
1771 events for for retry. Useful if card information has changed or manual
1772 retry is desired. The 'collect' method must be called to actually retry
1775 Implementation details: For either this customer, or for each of this
1776 customer's open invoices, changes the status of the first "done" (with
1777 statustext error) realtime processing event to "failed".
1781 sub retry_realtime {
1784 local $SIG{HUP} = 'IGNORE';
1785 local $SIG{INT} = 'IGNORE';
1786 local $SIG{QUIT} = 'IGNORE';
1787 local $SIG{TERM} = 'IGNORE';
1788 local $SIG{TSTP} = 'IGNORE';
1789 local $SIG{PIPE} = 'IGNORE';
1791 my $oldAutoCommit = $FS::UID::AutoCommit;
1792 local $FS::UID::AutoCommit = 0;
1795 #a little false laziness w/due_cust_event (not too bad, really)
1797 # I guess this is always as of now?
1798 my $join = FS::part_event_condition->join_conditions_sql('', 'time' => time);
1799 my $order = FS::part_event_condition->order_conditions_sql;
1802 . join ( ' OR ' , map {
1803 my $cust_join = FS::part_event->eventtables_cust_join->{$_} || '';
1804 my $custnum = FS::part_event->eventtables_custnum->{$_};
1805 "( part_event.eventtable = " . dbh->quote($_)
1806 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key
1807 . " from $_ $cust_join"
1808 . " where $custnum = " . dbh->quote( $self->custnum ) . "))" ;
1809 } FS::part_event->eventtables)
1812 #here is the agent virtualization
1813 my $agent_virt = " ( part_event.agentnum IS NULL
1814 OR part_event.agentnum = ". $self->agentnum. ' )';
1816 #XXX this shouldn't be hardcoded, actions should declare it...
1817 my @realtime_events = qw(
1818 cust_bill_realtime_card
1819 cust_bill_realtime_check
1820 cust_bill_realtime_lec
1824 my $is_realtime_event =
1825 ' part_event.action IN ( '.
1826 join(',', map "'$_'", @realtime_events ).
1829 my $batch_or_statustext =
1830 "( part_event.action = 'cust_bill_batch'
1831 OR ( statustext IS NOT NULL AND statustext != '' )
1835 my @cust_event = qsearch({
1836 'table' => 'cust_event',
1837 'select' => 'cust_event.*',
1838 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
1839 'hashref' => { 'status' => 'done' },
1840 'extra_sql' => " AND $batch_or_statustext ".
1841 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
1844 my %seen_invnum = ();
1845 foreach my $cust_event (@cust_event) {
1847 #max one for the customer, one for each open invoice
1848 my $cust_X = $cust_event->cust_X;
1849 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
1853 or $cust_event->part_event->eventtable eq 'cust_bill'
1856 my $error = $cust_event->retry;
1858 $dbh->rollback if $oldAutoCommit;
1859 return "error scheduling event for retry: $error";
1864 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1869 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
1871 Runs billing events; see L<FS::part_event> and the billing events web
1874 If there is an error, returns the error, otherwise returns false.
1876 Options are passed as name-value pairs.
1878 Currently available options are:
1884 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.
1888 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1892 "collect" (the default) or "pre-bill"
1896 set true to surpress email card/ACH decline notices.
1900 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)
1907 # allows for one time override of normal customer billing method
1911 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1914 my( $self, %options ) = @_;
1916 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1918 my $time = $options{'time'} || time;
1921 local $SIG{HUP} = 'IGNORE';
1922 local $SIG{INT} = 'IGNORE';
1923 local $SIG{QUIT} = 'IGNORE';
1924 local $SIG{TERM} = 'IGNORE';
1925 local $SIG{TSTP} = 'IGNORE';
1926 local $SIG{PIPE} = 'IGNORE';
1928 my $oldAutoCommit = $FS::UID::AutoCommit;
1929 local $FS::UID::AutoCommit = 0;
1932 $self->select_for_update; #mutex
1935 my $balance = $self->balance;
1936 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
1939 # if ( exists($options{'retry_card'}) ) {
1940 # carp 'retry_card option passed to collect is deprecated; use retry';
1941 # $options{'retry'} ||= $options{'retry_card'};
1943 # if ( exists($options{'retry'}) && $options{'retry'} ) {
1944 # my $error = $self->retry_realtime;
1946 # $dbh->rollback if $oldAutoCommit;
1951 # false laziness w/pay_batch::import_results
1953 my $due_cust_event = $self->due_cust_event(
1954 'debug' => ( $options{'debug'} || 0 ),
1956 'check_freq' => $options{'check_freq'},
1957 'stage' => ( $options{'stage'} || 'collect' ),
1959 unless( ref($due_cust_event) ) {
1960 $dbh->rollback if $oldAutoCommit;
1961 return $due_cust_event;
1964 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1965 #never want to roll back an event just because it or a different one
1967 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1969 foreach my $cust_event ( @$due_cust_event ) {
1973 #re-eval event conditions (a previous event could have changed things)
1974 unless ( $cust_event->test_conditions ) {
1975 #don't leave stray "new/locked" records around
1976 my $error = $cust_event->delete;
1977 return $error if $error;
1982 local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
1983 if $options{'quiet'};
1984 warn " running cust_event ". $cust_event->eventnum. "\n"
1987 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
1988 if ( my $error = $cust_event->do_event( 'time' => $time ) ) {
1989 #XXX wtf is this? figure out a proper dealio with return value
2001 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
2003 Inserts database records for and returns an ordered listref of new events due
2004 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
2005 events are due, an empty listref is returned. If there is an error, returns a
2006 scalar error message.
2008 To actually run the events, call each event's test_condition method, and if
2009 still true, call the event's do_event method.
2011 Options are passed as a hashref or as a list of name-value pairs. Available
2018 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.
2022 "collect" (the default) or "pre-bill"
2026 "Current time" for the events.
2030 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)
2034 Only return events for the specified eventtable (by default, events of all eventtables are returned)
2038 Explicitly pass the objects to be tested (typically used with eventtable).
2042 Set to true to return the objects, but not actually insert them into the
2049 sub due_cust_event {
2051 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
2054 #my $DEBUG = $opt{'debug'}
2055 $opt{'debug'} ||= 0; # silence some warnings
2056 local($DEBUG) = $opt{'debug'}
2057 if $opt{'debug'} > $DEBUG;
2058 $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
2060 warn "$me due_cust_event called with options ".
2061 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
2064 $opt{'time'} ||= time;
2066 local $SIG{HUP} = 'IGNORE';
2067 local $SIG{INT} = 'IGNORE';
2068 local $SIG{QUIT} = 'IGNORE';
2069 local $SIG{TERM} = 'IGNORE';
2070 local $SIG{TSTP} = 'IGNORE';
2071 local $SIG{PIPE} = 'IGNORE';
2073 my $oldAutoCommit = $FS::UID::AutoCommit;
2074 local $FS::UID::AutoCommit = 0;
2077 $self->select_for_update #mutex
2078 unless $opt{testonly};
2081 # find possible events (initial search)
2084 my @cust_event = ();
2086 my @eventtable = $opt{'eventtable'}
2087 ? ( $opt{'eventtable'} )
2088 : FS::part_event->eventtables_runorder;
2090 my $check_freq = $opt{'check_freq'} || '1d';
2092 foreach my $eventtable ( @eventtable ) {
2095 if ( $opt{'objects'} ) {
2097 @objects = @{ $opt{'objects'} };
2099 } elsif ( $eventtable eq 'cust_main' ) {
2101 @objects = ( $self );
2105 my $cm_join = " LEFT JOIN cust_main USING ( custnum )";
2106 # linkage not needed here because FS::cust_main->$eventtable will
2109 #some false laziness w/Cron::bill bill_where
2111 my $join = FS::part_event_condition->join_conditions_sql( $eventtable,
2112 'time' => $opt{'time'});
2113 my $where = FS::part_event_condition->where_conditions_sql($eventtable,
2114 'time'=>$opt{'time'},
2116 $where = $where ? "AND $where" : '';
2118 my $are_part_event =
2119 "EXISTS ( SELECT 1 FROM part_event $join
2120 WHERE check_freq = '$check_freq'
2121 AND eventtable = '$eventtable'
2122 AND ( disabled = '' OR disabled IS NULL )
2128 @objects = $self->$eventtable(
2129 'addl_from' => $cm_join,
2130 'extra_sql' => " AND $are_part_event",
2132 } # if ( !$opt{objects} and $eventtable ne 'cust_main' )
2134 my @e_cust_event = ();
2136 my $linkage = FS::part_event->eventtables_cust_join->{$eventtable} || '';
2138 my $cross = "CROSS JOIN $eventtable $linkage";
2139 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
2140 unless $eventtable eq 'cust_main';
2142 foreach my $object ( @objects ) {
2144 #this first search uses the condition_sql magic for optimization.
2145 #the more possible events we can eliminate in this step the better
2147 my $cross_where = '';
2148 my $pkey = $object->primary_key;
2149 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
2151 my $join = FS::part_event_condition->join_conditions_sql( $eventtable,
2152 'time' => $opt{'time'});
2154 FS::part_event_condition->where_conditions_sql( $eventtable,
2155 'time'=>$opt{'time'}
2157 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
2159 $extra_sql = "AND $extra_sql" if $extra_sql;
2161 #here is the agent virtualization
2162 $extra_sql .= " AND ( part_event.agentnum IS NULL
2163 OR part_event.agentnum = ". $self->agentnum. ' )';
2165 $extra_sql .= " $order";
2167 warn "searching for events for $eventtable ". $object->$pkey. "\n"
2168 if $opt{'debug'} > 2;
2169 my @part_event = qsearch( {
2170 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
2171 'select' => 'part_event.*',
2172 'table' => 'part_event',
2173 'addl_from' => "$cross $join",
2174 'hashref' => { 'check_freq' => $check_freq,
2175 'eventtable' => $eventtable,
2178 'extra_sql' => "AND $cross_where $extra_sql",
2182 my $pkey = $object->primary_key;
2183 warn " ". scalar(@part_event).
2184 " possible events found for $eventtable ". $object->$pkey(). "\n";
2187 push @e_cust_event, map {
2188 $_->new_cust_event($object, 'time' => $opt{'time'})
2193 warn " ". scalar(@e_cust_event).
2194 " subtotal possible cust events found for $eventtable\n"
2197 push @cust_event, @e_cust_event;
2201 warn " ". scalar(@cust_event).
2202 " total possible cust events found in initial search\n"
2210 $opt{stage} ||= 'collect';
2212 grep { my $stage = $_->part_event->event_stage;
2213 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
2223 @cust_event = grep $_->test_conditions( 'stats_hashref' => \%unsat ),
2226 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
2229 warn " invalid conditions not eliminated with condition_sql:\n".
2230 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
2231 if keys %unsat && $DEBUG; # > 1;
2237 unless( $opt{testonly} ) {
2238 foreach my $cust_event ( @cust_event ) {
2240 my $error = $cust_event->insert();
2242 $dbh->rollback if $oldAutoCommit;
2249 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2255 warn " returning events: ". Dumper(@cust_event). "\n"
2262 =item apply_payments_and_credits [ OPTION => VALUE ... ]
2264 Applies unapplied payments and credits.
2266 In most cases, this new method should be used in place of sequential
2267 apply_payments and apply_credits methods.
2269 A hash of optional arguments may be passed. Currently "manual" is supported.
2270 If true, a payment receipt is sent instead of a statement when
2271 'payment_receipt_email' configuration option is set.
2273 If there is an error, returns the error, otherwise returns false.
2277 sub apply_payments_and_credits {
2278 my( $self, %options ) = @_;
2280 local $SIG{HUP} = 'IGNORE';
2281 local $SIG{INT} = 'IGNORE';
2282 local $SIG{QUIT} = 'IGNORE';
2283 local $SIG{TERM} = 'IGNORE';
2284 local $SIG{TSTP} = 'IGNORE';
2285 local $SIG{PIPE} = 'IGNORE';
2287 my $oldAutoCommit = $FS::UID::AutoCommit;
2288 local $FS::UID::AutoCommit = 0;
2291 $self->select_for_update; #mutex
2293 foreach my $cust_bill ( $self->open_cust_bill ) {
2294 my $error = $cust_bill->apply_payments_and_credits(%options);
2296 $dbh->rollback if $oldAutoCommit;
2297 return "Error applying: $error";
2301 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2306 =item apply_credits OPTION => VALUE ...
2308 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
2309 to outstanding invoice balances in chronological order (or reverse
2310 chronological order if the I<order> option is set to B<newest>) and returns the
2311 value of any remaining unapplied credits available for refund (see
2312 L<FS::cust_refund>).
2314 Dies if there is an error.
2322 local $SIG{HUP} = 'IGNORE';
2323 local $SIG{INT} = 'IGNORE';
2324 local $SIG{QUIT} = 'IGNORE';
2325 local $SIG{TERM} = 'IGNORE';
2326 local $SIG{TSTP} = 'IGNORE';
2327 local $SIG{PIPE} = 'IGNORE';
2329 my $oldAutoCommit = $FS::UID::AutoCommit;
2330 local $FS::UID::AutoCommit = 0;
2333 $self->select_for_update; #mutex
2335 unless ( $self->total_unapplied_credits ) {
2336 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2340 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
2341 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
2343 my @invoices = $self->open_cust_bill;
2344 @invoices = sort { $b->_date <=> $a->_date } @invoices
2345 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
2347 if ( $conf->exists('pkg-balances') ) {
2348 # limit @credits to those w/ a pkgnum grepped from $self
2350 foreach my $i (@invoices) {
2351 foreach my $li ( $i->cust_bill_pkg ) {
2352 $pkgnums{$li->pkgnum} = 1;
2355 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
2360 foreach my $cust_bill ( @invoices ) {
2362 if ( !defined($credit) || $credit->credited == 0) {
2363 $credit = pop @credits or last;
2367 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
2368 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
2370 $owed = $cust_bill->owed;
2372 unless ( $owed > 0 ) {
2373 push @credits, $credit;
2377 my $amount = min( $credit->credited, $owed );
2379 my $cust_credit_bill = new FS::cust_credit_bill ( {
2380 'crednum' => $credit->crednum,
2381 'invnum' => $cust_bill->invnum,
2382 'amount' => $amount,
2384 $cust_credit_bill->pkgnum( $credit->pkgnum )
2385 if $conf->exists('pkg-balances') && $credit->pkgnum;
2386 my $error = $cust_credit_bill->insert;
2388 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2392 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2396 my $total_unapplied_credits = $self->total_unapplied_credits;
2398 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2400 return $total_unapplied_credits;
2403 =item apply_payments [ OPTION => VALUE ... ]
2405 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2406 to outstanding invoice balances in chronological order.
2408 #and returns the value of any remaining unapplied payments.
2410 A hash of optional arguments may be passed. Currently "manual" is supported.
2411 If true, a payment receipt is sent instead of a statement when
2412 'payment_receipt_email' configuration option is set.
2414 Dies if there is an error.
2418 sub apply_payments {
2419 my( $self, %options ) = @_;
2421 local $SIG{HUP} = 'IGNORE';
2422 local $SIG{INT} = 'IGNORE';
2423 local $SIG{QUIT} = 'IGNORE';
2424 local $SIG{TERM} = 'IGNORE';
2425 local $SIG{TSTP} = 'IGNORE';
2426 local $SIG{PIPE} = 'IGNORE';
2428 my $oldAutoCommit = $FS::UID::AutoCommit;
2429 local $FS::UID::AutoCommit = 0;
2432 $self->select_for_update; #mutex
2436 my @payments = $self->unapplied_cust_pay;
2438 my @invoices = $self->open_cust_bill;
2440 if ( $conf->exists('pkg-balances') ) {
2441 # limit @payments to those w/ a pkgnum grepped from $self
2443 foreach my $i (@invoices) {
2444 foreach my $li ( $i->cust_bill_pkg ) {
2445 $pkgnums{$li->pkgnum} = 1;
2448 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
2453 foreach my $cust_bill ( @invoices ) {
2455 if ( !defined($payment) || $payment->unapplied == 0 ) {
2456 $payment = pop @payments or last;
2460 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
2461 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
2463 $owed = $cust_bill->owed;
2465 unless ( $owed > 0 ) {
2466 push @payments, $payment;
2470 my $amount = min( $payment->unapplied, $owed );
2473 'paynum' => $payment->paynum,
2474 'invnum' => $cust_bill->invnum,
2475 'amount' => $amount,
2477 $cbp->{_date} = $payment->_date
2478 if $options{'manual'} && $options{'backdate_application'};
2479 my $cust_bill_pay = new FS::cust_bill_pay($cbp);
2480 $cust_bill_pay->pkgnum( $payment->pkgnum )
2481 if $conf->exists('pkg-balances') && $payment->pkgnum;
2482 my $error = $cust_bill_pay->insert(%options);
2484 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2488 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2492 my $total_unapplied_payments = $self->total_unapplied_payments;
2494 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2496 return $total_unapplied_payments;
2506 suspend_adjourned_pkgs
2507 unsuspend_resumed_pkgs
2510 (do_cust_event pre-bill)
2513 (vendor-only) _gather_taxes
2514 _omit_zero_value_bundles
2515 _handle_taxes (for fees)
2518 apply_payments_and_credits
2527 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>