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 if ( ! $options{recurring_only}
1092 and ! $options{cancel}
1093 and ( $options{'resetup'}
1094 || ( ! $cust_pkg->setup
1095 && ( ! $cust_pkg->start_date
1096 || $cust_pkg->start_date <= $cmp_time
1098 && ( ! $conf->exists('disable_setup_suspended_pkgs')
1099 || ( $conf->exists('disable_setup_suspended_pkgs') &&
1100 ! $cust_pkg->getfield('susp')
1108 warn " bill setup\n" if $DEBUG > 1;
1110 unless ( $cust_pkg->waive_setup ) {
1113 $setup = eval { $cust_pkg->calc_setup( $time, \@details, \%setup_param ) };
1114 return "$@ running calc_setup for $cust_pkg\n"
1117 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
1120 $cust_pkg->setfield('setup', $time)
1121 unless $cust_pkg->setup;
1122 #do need it, but it won't get written to the db
1123 #|| $cust_pkg->pkgpart != $real_pkgpart;
1125 $cust_pkg->setfield('start_date', '')
1126 if $cust_pkg->start_date;
1131 # bill recurring fee
1136 my @recur_discounts = ();
1138 if ( ! $cust_pkg->start_date
1141 || ( $cust_pkg->susp != $cust_pkg->order_date
1142 && ( $cust_pkg->option('suspend_bill',1)
1143 || ( $part_pkg->option('suspend_bill', 1)
1144 && ! $cust_pkg->option('no_suspend_bill',1)
1150 ( $part_pkg->freq ne '0' && ( $cust_pkg->bill || 0 ) <= $cmp_time )
1151 || ( $part_pkg->plan eq 'voip_cdr'
1152 && $part_pkg->option('bill_every_call')
1157 # XXX should this be a package event? probably. events are called
1158 # at collection time at the moment, though...
1159 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
1160 if $part_pkg->can('reset_usage') && !$options{'no_usage_reset'};
1161 #don't want to reset usage just cause we want a line item??
1162 #&& $part_pkg->pkgpart == $real_pkgpart;
1164 warn " bill recur\n" if $DEBUG > 1;
1167 # XXX shared with $recur_prog
1168 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
1172 #over two params! lets at least switch to a hashref for the rest...
1173 my $increment_next_bill = ( $part_pkg->freq ne '0'
1174 && ( $cust_pkg->getfield('bill') || 0 ) <= $cmp_time
1175 && !$options{cancel}
1177 my %param = ( %setup_param,
1178 'precommit_hooks' => $precommit_hooks,
1179 'increment_next_bill' => $increment_next_bill,
1180 'discounts' => \@recur_discounts,
1181 'real_pkgpart' => $real_pkgpart,
1182 'freq_override' => $options{freq_override} || '',
1186 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
1188 # There may be some part_pkg for which this is wrong. Only those
1189 # which can_discount are supported.
1190 # (the UI should prevent adding discounts to these at the moment)
1192 warn "calling $method on cust_pkg ". $cust_pkg->pkgnum.
1193 " for pkgpart ". $cust_pkg->pkgpart.
1194 " with params ". join(' / ', map "$_=>$param{$_}", keys %param). "\n"
1197 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
1198 return "$@ running $method for $cust_pkg\n"
1202 $unitrecur = $cust_pkg->base_recur( \$sdate ) || $recur; #XXX uuh, better
1204 if ( $increment_next_bill ) {
1208 if ( my $main_pkg = $cust_pkg->main_pkg ) {
1209 # supplemental package
1210 # to keep in sync with the main package, simulate billing at
1212 my $main_pkg_freq = $main_pkg->part_pkg->freq;
1213 my $supp_pkg_freq = $part_pkg->freq;
1214 my $ratio = $supp_pkg_freq / $main_pkg_freq;
1215 if ( $ratio != int($ratio) ) {
1216 # the UI should prevent setting up packages like this, but just
1218 return "supplemental package period is not an integer multiple of main package period";
1220 $next_bill = $sdate;
1222 $next_bill = $part_pkg->add_freq( $next_bill, $main_pkg_freq );
1227 $next_bill = $part_pkg->add_freq($sdate, $options{freq_override} || 0);
1228 return "unparsable frequency: ". $part_pkg->freq
1229 if $next_bill == -1;
1232 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
1233 # only for figuring next bill date, nothing else, so, reset $sdate again
1235 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1236 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
1237 $cust_pkg->last_bill($sdate);
1239 $cust_pkg->setfield('bill', $next_bill );
1243 if ( $param{'setup_fee'} ) {
1244 # Add an additional setup fee at the billing stage.
1245 # Used for prorate_defer_bill.
1246 $setup += $param{'setup_fee'};
1247 $unitsetup += $param{'setup_fee'};
1251 if ( defined $param{'discount_left_setup'} ) {
1252 foreach my $discount_setup ( values %{$param{'discount_left_setup'}} ) {
1253 $setup -= $discount_setup;
1259 warn "\$setup is undefined" unless defined($setup);
1260 warn "\$recur is undefined" unless defined($recur);
1261 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1264 # If there's line items, create em cust_bill_pkg records
1265 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
1270 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
1271 # hmm.. and if just the options are modified in some weird price plan?
1273 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
1276 my $error = $cust_pkg->replace( $old_cust_pkg,
1277 'depend_jobnum'=>$options{depend_jobnum},
1278 'options' => { $cust_pkg->options },
1280 unless $options{no_commit};
1281 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
1282 if $error; #just in case
1285 $setup = sprintf( "%.2f", $setup );
1286 $recur = sprintf( "%.2f", $recur );
1287 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
1288 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1290 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
1291 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
1294 my $discount_show_always = $conf->exists('discount-show-always')
1295 && ( ($setup == 0 && scalar(@setup_discounts))
1296 || ($recur == 0 && scalar(@recur_discounts))
1301 || (!$part_pkg->hidden && $options{has_hidden}) #include some $0 lines
1302 || $discount_show_always
1303 || ($setup == 0 && $cust_pkg->_X_show_zero('setup'))
1304 || ($recur == 0 && $cust_pkg->_X_show_zero('recur'))
1308 warn " charges (setup=$setup, recur=$recur); adding line items\n"
1311 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
1313 warn " adding customer package invoice detail: $_\n"
1314 foreach @cust_pkg_detail;
1316 push @details, @cust_pkg_detail;
1318 my $cust_bill_pkg = new FS::cust_bill_pkg {
1319 'pkgnum' => $cust_pkg->pkgnum,
1321 'unitsetup' => $unitsetup,
1323 'unitrecur' => $unitrecur,
1324 'quantity' => $cust_pkg->quantity,
1325 'details' => \@details,
1326 'discounts' => [ @setup_discounts, @recur_discounts ],
1327 'hidden' => $part_pkg->hidden,
1328 'freq' => $part_pkg->freq,
1331 if ( $part_pkg->option('prorate_defer_bill',1)
1332 and !$hash{last_bill} ) {
1333 # both preceding and upcoming, technically
1334 $cust_bill_pkg->sdate( $cust_pkg->setup );
1335 $cust_bill_pkg->edate( $cust_pkg->bill );
1336 } elsif ( $part_pkg->recur_temporality eq 'preceding' ) {
1337 $cust_bill_pkg->sdate( $hash{last_bill} );
1338 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
1339 $cust_bill_pkg->edate( $time ) if $options{cancel};
1340 } else { #if ( $part_pkg->recur_temporality eq 'upcoming' ) {
1341 $cust_bill_pkg->sdate( $sdate );
1342 $cust_bill_pkg->edate( $cust_pkg->bill );
1343 #$cust_bill_pkg->edate( $time ) if $options{cancel};
1346 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
1347 unless $part_pkg->pkgpart == $real_pkgpart;
1349 $$total_setup += $setup;
1350 $$total_recur += $recur;
1356 my $error = $self->_handle_taxes( $taxlisthash, $cust_bill_pkg,
1357 cancel => $options{cancel} );
1358 return $error if $error;
1360 $cust_bill_pkg->set_display(
1361 part_pkg => $part_pkg,
1362 real_pkgpart => $real_pkgpart,
1365 push @$cust_bill_pkgs, $cust_bill_pkg;
1367 } #if $setup != 0 || $recur != 0
1375 =item _transfer_balance TO_PKG [ FROM_PKGNUM ]
1377 Takes one argument, a cust_pkg object that is being billed. This will
1378 be called only if the package was created by a package change, and has
1379 not been billed since the package change, and package balance tracking
1380 is enabled. The second argument can be an alternate package number to
1381 transfer the balance from; this should not be used externally.
1383 Transfers the balance from the previous package (now canceled) to
1384 this package, by crediting one package and creating an invoice item for
1385 the other. Inserts the credit and returns the invoice item (so that it
1386 can be added to an invoice that's being built).
1388 If the previous package was never billed, and was also created by a package
1389 change, then this will also transfer the balance from I<its> previous
1390 package, and so on, until reaching a package that either has been billed
1391 or was not created by a package change.
1395 my $balance_transfer_reason;
1397 sub _transfer_balance {
1399 my $cust_pkg = shift;
1400 my $from_pkgnum = shift || $cust_pkg->change_pkgnum;
1401 my $from_pkg = FS::cust_pkg->by_key($from_pkgnum);
1405 # if $from_pkg is not the first package in the chain, and it was never
1407 if ( $from_pkg->change_pkgnum and scalar($from_pkg->cust_bill_pkg) == 0 ) {
1408 @transfers = $self->_transfer_balance($cust_pkg, $from_pkg->change_pkgnum);
1411 my $prev_balance = $self->balance_pkgnum($from_pkgnum);
1412 if ( $prev_balance != 0 ) {
1413 $balance_transfer_reason ||= FS::reason->new_or_existing(
1414 'reason' => 'Package balance transfer',
1415 'type' => 'Internal adjustment',
1419 my $credit = FS::cust_credit->new({
1420 'custnum' => $self->custnum,
1421 'amount' => abs($prev_balance),
1422 'reasonnum' => $balance_transfer_reason->reasonnum,
1423 '_date' => $cust_pkg->change_date,
1426 my $cust_bill_pkg = FS::cust_bill_pkg->new({
1428 'recur' => abs($prev_balance),
1429 #'sdate' => $from_pkg->last_bill, # not sure about this
1430 #'edate' => $cust_pkg->change_date,
1431 'itemdesc' => $self->mt('Previous Balance, [_1]',
1432 $from_pkg->part_pkg->pkg),
1435 if ( $prev_balance > 0 ) {
1436 # credit the old package, charge the new one
1437 $credit->set('pkgnum', $from_pkgnum);
1438 $cust_bill_pkg->set('pkgnum', $cust_pkg->pkgnum);
1441 $credit->set('pkgnum', $cust_pkg->pkgnum);
1442 $cust_bill_pkg->set('pkgnum', $from_pkgnum);
1444 my $error = $credit->insert;
1445 die "error transferring package balance from #".$from_pkgnum.
1446 " to #".$cust_pkg->pkgnum.": $error\n" if $error;
1448 push @transfers, $cust_bill_pkg;
1449 } # $prev_balance != 0
1454 =item handle_taxes TAXLISTHASH CUST_BILL_PKG [ OPTIONS ]
1456 This is _handle_taxes. It's called once for each cust_bill_pkg generated
1459 TAXLISTHASH is a hashref shared across the entire invoice. It looks like
1462 'cust_main_county 1001' => [ [FS::cust_main_county], ... ],
1463 'cust_main_county 1002' => [ [FS::cust_main_county], ... ],
1466 'cust_main_county' can also be 'tax_rate'. The first object in the array
1467 is always the cust_main_county or tax_rate identified by the key.
1469 That "..." is a list of FS::cust_bill_pkg objects that will be fed to
1470 the 'taxline' method to calculate the amount of the tax. This doesn't
1471 happen until calculate_taxes, though.
1473 OPTIONS may include:
1474 - part_item: a part_pkg or part_fee object to be used as the package/fee
1476 - location: a cust_location to be used as the billing location.
1477 - cancel: true if this package is being billed on cancellation. This
1478 allows tax to be calculated on usage charges only.
1480 If not supplied, part_item will be inferred from the pkgnum or feepart of the
1481 cust_bill_pkg, and location from the pkgnum (or, for fees, the invnum and
1482 the customer's default service location).
1488 my $taxlisthash = shift;
1489 my $cust_bill_pkg = shift;
1492 # at this point I realize that we have enough information to infer all this
1493 # stuff, instead of passing around giant honking argument lists
1494 my $location = $options{location} || $cust_bill_pkg->tax_location;
1495 my $part_item = $options{part_item} || $cust_bill_pkg->part_X;
1497 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1499 return if ( $self->payby eq 'COMP' ); #dubious
1501 if ( $conf->exists('enable_taxproducts')
1502 && ( scalar($part_item->part_pkg_taxoverride)
1503 || $part_item->has_taxproduct
1508 # EXTERNAL TAX RATES (via tax_rate)
1509 my %cust_bill_pkg = ();
1513 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
1514 push @classes, 'setup' if $cust_bill_pkg->setup and !$options{cancel};
1515 push @classes, 'recur' if $cust_bill_pkg->recur and !$options{cancel};
1517 my $exempt = $conf->exists('cust_class-tax_exempt')
1518 ? ( $self->cust_class ? $self->cust_class->tax : '' )
1520 # standardize this just to be sure
1521 $exempt = ($exempt eq 'Y') ? 'Y' : '';
1525 foreach my $class (@classes) {
1526 my $err_or_ref = $self->_gather_taxes($part_item, $class, $location);
1527 return $err_or_ref unless ref($err_or_ref);
1528 $taxes{$class} = $err_or_ref;
1531 unless (exists $taxes{''}) {
1532 my $err_or_ref = $self->_gather_taxes($part_item, '', $location);
1533 return $err_or_ref unless ref($err_or_ref);
1534 $taxes{''} = $err_or_ref;
1539 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate; # grrr
1540 foreach my $key (keys %tax_cust_bill_pkg) {
1541 # $key is "setup", "recur", or a usage class name. ('' is a usage class.)
1542 # $tax_cust_bill_pkg{$key} is a cust_bill_pkg for that component of
1544 # $taxes{$key} is an arrayref of cust_main_county or tax_rate objects that
1545 # apply to $key-class charges.
1546 my @taxes = @{ $taxes{$key} || [] };
1547 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
1549 my %localtaxlisthash = ();
1550 foreach my $tax ( @taxes ) {
1552 # this is the tax identifier, not the taxname
1553 my $taxname = ref( $tax ). ' '. $tax->taxnum;
1554 # $taxlisthash: keys are "setup", "recur", and usage classes.
1555 # Values are arrayrefs, first the tax object (cust_main_county
1556 # or tax_rate) and then any cust_bill_pkg objects that the
1558 $taxlisthash->{ $taxname } ||= [ $tax ];
1559 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
1561 $localtaxlisthash{ $taxname } ||= [ $tax ];
1562 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
1566 warn "finding taxed taxes...\n" if $DEBUG > 2;
1567 foreach my $tax ( keys %localtaxlisthash ) {
1568 my $tax_object = shift @{ $localtaxlisthash{$tax} };
1569 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
1571 next unless $tax_object->can('tax_on_tax');
1573 foreach my $tot ( $tax_object->tax_on_tax( $location ) ) {
1574 my $totname = ref( $tot ). ' '. $tot->taxnum;
1576 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
1578 next unless exists( $localtaxlisthash{ $totname } ); # only increase
1580 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
1581 # calculate the tax amount that the tax_on_tax will apply to
1582 my $hashref_or_error =
1583 $tax_object->taxline( $localtaxlisthash{$tax} );
1584 return $hashref_or_error
1585 unless ref($hashref_or_error);
1587 # and append it to the list of taxable items
1588 $taxlisthash->{ $totname } ||= [ $tot ];
1589 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
1597 # INTERNAL TAX RATES (cust_main_county)
1599 # We fetch taxes even if the customer is completely exempt,
1600 # because we need to record that fact.
1602 my @loc_keys = qw( district city county state country );
1603 my %taxhash = map { $_ => $location->$_ } @loc_keys;
1605 $taxhash{'taxclass'} = $part_item->taxclass;
1607 warn "taxhash:\n". Dumper(\%taxhash) if $DEBUG > 2;
1609 my @taxes = (); # entries are cust_main_county objects
1610 my %taxhash_elim = %taxhash;
1611 my @elim = qw( district city county state );
1614 #first try a match with taxclass
1615 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1617 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1618 #then try a match without taxclass
1619 my %no_taxclass = %taxhash_elim;
1620 $no_taxclass{ 'taxclass' } = '';
1621 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1624 $taxhash_elim{ shift(@elim) } = '';
1626 } while ( !scalar(@taxes) && scalar(@elim) );
1629 my $tax_id = 'cust_main_county '.$_->taxnum;
1630 $taxlisthash->{$tax_id} ||= [ $_ ];
1631 push @{ $taxlisthash->{$tax_id} }, $cust_bill_pkg;
1638 =item _gather_taxes PART_ITEM CLASS CUST_LOCATION
1640 Internal method used with vendor-provided tax tables. PART_ITEM is a part_pkg
1641 or part_fee (which will define the tax eligibility of the product), CLASS is
1642 'setup', 'recur', null, or a C<usage_class> number, and CUST_LOCATION is the
1643 location where the service was provided (or billed, depending on
1644 configuration). Returns an arrayref of L<FS::tax_rate> objects that
1645 can apply to this line item.
1651 my $part_item = shift;
1653 my $location = shift;
1655 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1657 my $geocode = $location->geocode('cch');
1659 [ $part_item->tax_rates('cch', $geocode, $class) ]
1663 =item collect [ HASHREF | OPTION => VALUE ... ]
1665 (Attempt to) collect money for this customer's outstanding invoices (see
1666 L<FS::cust_bill>). Usually used after the bill method.
1668 Actions are now triggered by billing events; see L<FS::part_event> and the
1669 billing events web interface. Old-style invoice events (see
1670 L<FS::part_bill_event>) have been deprecated.
1672 If there is an error, returns the error, otherwise returns false.
1674 Options are passed as name-value pairs.
1676 Currently available options are:
1682 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.
1686 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1690 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1694 set true to surpress email card/ACH decline notices.
1698 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)
1704 # allows for one time override of normal customer billing method
1709 my( $self, %options ) = @_;
1711 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1713 my $invoice_time = $options{'invoice_time'} || time;
1716 local $SIG{HUP} = 'IGNORE';
1717 local $SIG{INT} = 'IGNORE';
1718 local $SIG{QUIT} = 'IGNORE';
1719 local $SIG{TERM} = 'IGNORE';
1720 local $SIG{TSTP} = 'IGNORE';
1721 local $SIG{PIPE} = 'IGNORE';
1723 my $oldAutoCommit = $FS::UID::AutoCommit;
1724 local $FS::UID::AutoCommit = 0;
1727 $self->select_for_update; #mutex
1730 my $balance = $self->balance;
1731 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
1734 if ( exists($options{'retry_card'}) ) {
1735 carp 'retry_card option passed to collect is deprecated; use retry';
1736 $options{'retry'} ||= $options{'retry_card'};
1738 if ( exists($options{'retry'}) && $options{'retry'} ) {
1739 my $error = $self->retry_realtime;
1741 $dbh->rollback if $oldAutoCommit;
1746 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1748 #never want to roll back an event just because it returned an error
1749 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1751 $self->do_cust_event(
1752 'debug' => ( $options{'debug'} || 0 ),
1753 'time' => $invoice_time,
1754 'check_freq' => $options{'check_freq'},
1755 'stage' => 'collect',
1760 =item retry_realtime
1762 Schedules realtime / batch credit card / electronic check / LEC billing
1763 events for for retry. Useful if card information has changed or manual
1764 retry is desired. The 'collect' method must be called to actually retry
1767 Implementation details: For either this customer, or for each of this
1768 customer's open invoices, changes the status of the first "done" (with
1769 statustext error) realtime processing event to "failed".
1773 sub retry_realtime {
1776 local $SIG{HUP} = 'IGNORE';
1777 local $SIG{INT} = 'IGNORE';
1778 local $SIG{QUIT} = 'IGNORE';
1779 local $SIG{TERM} = 'IGNORE';
1780 local $SIG{TSTP} = 'IGNORE';
1781 local $SIG{PIPE} = 'IGNORE';
1783 my $oldAutoCommit = $FS::UID::AutoCommit;
1784 local $FS::UID::AutoCommit = 0;
1787 #a little false laziness w/due_cust_event (not too bad, really)
1789 # I guess this is always as of now?
1790 my $join = FS::part_event_condition->join_conditions_sql('', 'time' => time);
1791 my $order = FS::part_event_condition->order_conditions_sql;
1794 . join ( ' OR ' , map {
1795 my $cust_join = FS::part_event->eventtables_cust_join->{$_} || '';
1796 my $custnum = FS::part_event->eventtables_custnum->{$_};
1797 "( part_event.eventtable = " . dbh->quote($_)
1798 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key
1799 . " from $_ $cust_join"
1800 . " where $custnum = " . dbh->quote( $self->custnum ) . "))" ;
1801 } FS::part_event->eventtables)
1804 #here is the agent virtualization
1805 my $agent_virt = " ( part_event.agentnum IS NULL
1806 OR part_event.agentnum = ". $self->agentnum. ' )';
1808 #XXX this shouldn't be hardcoded, actions should declare it...
1809 my @realtime_events = qw(
1810 cust_bill_realtime_card
1811 cust_bill_realtime_check
1812 cust_bill_realtime_lec
1816 my $is_realtime_event =
1817 ' part_event.action IN ( '.
1818 join(',', map "'$_'", @realtime_events ).
1821 my $batch_or_statustext =
1822 "( part_event.action = 'cust_bill_batch'
1823 OR ( statustext IS NOT NULL AND statustext != '' )
1827 my @cust_event = qsearch({
1828 'table' => 'cust_event',
1829 'select' => 'cust_event.*',
1830 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
1831 'hashref' => { 'status' => 'done' },
1832 'extra_sql' => " AND $batch_or_statustext ".
1833 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
1836 my %seen_invnum = ();
1837 foreach my $cust_event (@cust_event) {
1839 #max one for the customer, one for each open invoice
1840 my $cust_X = $cust_event->cust_X;
1841 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
1845 or $cust_event->part_event->eventtable eq 'cust_bill'
1848 my $error = $cust_event->retry;
1850 $dbh->rollback if $oldAutoCommit;
1851 return "error scheduling event for retry: $error";
1856 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1861 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
1863 Runs billing events; see L<FS::part_event> and the billing events web
1866 If there is an error, returns the error, otherwise returns false.
1868 Options are passed as name-value pairs.
1870 Currently available options are:
1876 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.
1880 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1884 "collect" (the default) or "pre-bill"
1888 set true to surpress email card/ACH decline notices.
1892 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)
1899 # allows for one time override of normal customer billing method
1903 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1906 my( $self, %options ) = @_;
1908 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1910 my $time = $options{'time'} || time;
1913 local $SIG{HUP} = 'IGNORE';
1914 local $SIG{INT} = 'IGNORE';
1915 local $SIG{QUIT} = 'IGNORE';
1916 local $SIG{TERM} = 'IGNORE';
1917 local $SIG{TSTP} = 'IGNORE';
1918 local $SIG{PIPE} = 'IGNORE';
1920 my $oldAutoCommit = $FS::UID::AutoCommit;
1921 local $FS::UID::AutoCommit = 0;
1924 $self->select_for_update; #mutex
1927 my $balance = $self->balance;
1928 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
1931 # if ( exists($options{'retry_card'}) ) {
1932 # carp 'retry_card option passed to collect is deprecated; use retry';
1933 # $options{'retry'} ||= $options{'retry_card'};
1935 # if ( exists($options{'retry'}) && $options{'retry'} ) {
1936 # my $error = $self->retry_realtime;
1938 # $dbh->rollback if $oldAutoCommit;
1943 # false laziness w/pay_batch::import_results
1945 my $due_cust_event = $self->due_cust_event(
1946 'debug' => ( $options{'debug'} || 0 ),
1948 'check_freq' => $options{'check_freq'},
1949 'stage' => ( $options{'stage'} || 'collect' ),
1951 unless( ref($due_cust_event) ) {
1952 $dbh->rollback if $oldAutoCommit;
1953 return $due_cust_event;
1956 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1957 #never want to roll back an event just because it or a different one
1959 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1961 foreach my $cust_event ( @$due_cust_event ) {
1965 #re-eval event conditions (a previous event could have changed things)
1966 unless ( $cust_event->test_conditions ) {
1967 #don't leave stray "new/locked" records around
1968 my $error = $cust_event->delete;
1969 return $error if $error;
1974 local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
1975 if $options{'quiet'};
1976 warn " running cust_event ". $cust_event->eventnum. "\n"
1979 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
1980 if ( my $error = $cust_event->do_event( 'time' => $time ) ) {
1981 #XXX wtf is this? figure out a proper dealio with return value
1993 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
1995 Inserts database records for and returns an ordered listref of new events due
1996 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
1997 events are due, an empty listref is returned. If there is an error, returns a
1998 scalar error message.
2000 To actually run the events, call each event's test_condition method, and if
2001 still true, call the event's do_event method.
2003 Options are passed as a hashref or as a list of name-value pairs. Available
2010 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.
2014 "collect" (the default) or "pre-bill"
2018 "Current time" for the events.
2022 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)
2026 Only return events for the specified eventtable (by default, events of all eventtables are returned)
2030 Explicitly pass the objects to be tested (typically used with eventtable).
2034 Set to true to return the objects, but not actually insert them into the
2041 sub due_cust_event {
2043 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
2046 #my $DEBUG = $opt{'debug'}
2047 $opt{'debug'} ||= 0; # silence some warnings
2048 local($DEBUG) = $opt{'debug'}
2049 if $opt{'debug'} > $DEBUG;
2050 $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
2052 warn "$me due_cust_event called with options ".
2053 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
2056 $opt{'time'} ||= time;
2058 local $SIG{HUP} = 'IGNORE';
2059 local $SIG{INT} = 'IGNORE';
2060 local $SIG{QUIT} = 'IGNORE';
2061 local $SIG{TERM} = 'IGNORE';
2062 local $SIG{TSTP} = 'IGNORE';
2063 local $SIG{PIPE} = 'IGNORE';
2065 my $oldAutoCommit = $FS::UID::AutoCommit;
2066 local $FS::UID::AutoCommit = 0;
2069 $self->select_for_update #mutex
2070 unless $opt{testonly};
2073 # find possible events (initial search)
2076 my @cust_event = ();
2078 my @eventtable = $opt{'eventtable'}
2079 ? ( $opt{'eventtable'} )
2080 : FS::part_event->eventtables_runorder;
2082 my $check_freq = $opt{'check_freq'} || '1d';
2084 foreach my $eventtable ( @eventtable ) {
2087 if ( $opt{'objects'} ) {
2089 @objects = @{ $opt{'objects'} };
2091 } elsif ( $eventtable eq 'cust_main' ) {
2093 @objects = ( $self );
2097 my $cm_join = " LEFT JOIN cust_main USING ( custnum )";
2098 # linkage not needed here because FS::cust_main->$eventtable will
2101 #some false laziness w/Cron::bill bill_where
2103 my $join = FS::part_event_condition->join_conditions_sql( $eventtable,
2104 'time' => $opt{'time'});
2105 my $where = FS::part_event_condition->where_conditions_sql($eventtable,
2106 'time'=>$opt{'time'},
2108 $where = $where ? "AND $where" : '';
2110 my $are_part_event =
2111 "EXISTS ( SELECT 1 FROM part_event $join
2112 WHERE check_freq = '$check_freq'
2113 AND eventtable = '$eventtable'
2114 AND ( disabled = '' OR disabled IS NULL )
2120 @objects = $self->$eventtable(
2121 'addl_from' => $cm_join,
2122 'extra_sql' => " AND $are_part_event",
2124 } # if ( !$opt{objects} and $eventtable ne 'cust_main' )
2126 my @e_cust_event = ();
2128 my $linkage = FS::part_event->eventtables_cust_join->{$eventtable} || '';
2130 my $cross = "CROSS JOIN $eventtable $linkage";
2131 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
2132 unless $eventtable eq 'cust_main';
2134 foreach my $object ( @objects ) {
2136 #this first search uses the condition_sql magic for optimization.
2137 #the more possible events we can eliminate in this step the better
2139 my $cross_where = '';
2140 my $pkey = $object->primary_key;
2141 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
2143 my $join = FS::part_event_condition->join_conditions_sql( $eventtable,
2144 'time' => $opt{'time'});
2146 FS::part_event_condition->where_conditions_sql( $eventtable,
2147 'time'=>$opt{'time'}
2149 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
2151 $extra_sql = "AND $extra_sql" if $extra_sql;
2153 #here is the agent virtualization
2154 $extra_sql .= " AND ( part_event.agentnum IS NULL
2155 OR part_event.agentnum = ". $self->agentnum. ' )';
2157 $extra_sql .= " $order";
2159 warn "searching for events for $eventtable ". $object->$pkey. "\n"
2160 if $opt{'debug'} > 2;
2161 my @part_event = qsearch( {
2162 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
2163 'select' => 'part_event.*',
2164 'table' => 'part_event',
2165 'addl_from' => "$cross $join",
2166 'hashref' => { 'check_freq' => $check_freq,
2167 'eventtable' => $eventtable,
2170 'extra_sql' => "AND $cross_where $extra_sql",
2174 my $pkey = $object->primary_key;
2175 warn " ". scalar(@part_event).
2176 " possible events found for $eventtable ". $object->$pkey(). "\n";
2179 push @e_cust_event, map {
2180 $_->new_cust_event($object, 'time' => $opt{'time'})
2185 warn " ". scalar(@e_cust_event).
2186 " subtotal possible cust events found for $eventtable\n"
2189 push @cust_event, @e_cust_event;
2193 warn " ". scalar(@cust_event).
2194 " total possible cust events found in initial search\n"
2202 $opt{stage} ||= 'collect';
2204 grep { my $stage = $_->part_event->event_stage;
2205 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
2215 @cust_event = grep $_->test_conditions( 'stats_hashref' => \%unsat ),
2218 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
2221 warn " invalid conditions not eliminated with condition_sql:\n".
2222 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
2223 if keys %unsat && $DEBUG; # > 1;
2229 unless( $opt{testonly} ) {
2230 foreach my $cust_event ( @cust_event ) {
2232 my $error = $cust_event->insert();
2234 $dbh->rollback if $oldAutoCommit;
2241 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2247 warn " returning events: ". Dumper(@cust_event). "\n"
2254 =item apply_payments_and_credits [ OPTION => VALUE ... ]
2256 Applies unapplied payments and credits.
2258 In most cases, this new method should be used in place of sequential
2259 apply_payments and apply_credits methods.
2261 A hash of optional arguments may be passed. Currently "manual" is supported.
2262 If true, a payment receipt is sent instead of a statement when
2263 'payment_receipt_email' configuration option is set.
2265 If there is an error, returns the error, otherwise returns false.
2269 sub apply_payments_and_credits {
2270 my( $self, %options ) = @_;
2272 local $SIG{HUP} = 'IGNORE';
2273 local $SIG{INT} = 'IGNORE';
2274 local $SIG{QUIT} = 'IGNORE';
2275 local $SIG{TERM} = 'IGNORE';
2276 local $SIG{TSTP} = 'IGNORE';
2277 local $SIG{PIPE} = 'IGNORE';
2279 my $oldAutoCommit = $FS::UID::AutoCommit;
2280 local $FS::UID::AutoCommit = 0;
2283 $self->select_for_update; #mutex
2285 foreach my $cust_bill ( $self->open_cust_bill ) {
2286 my $error = $cust_bill->apply_payments_and_credits(%options);
2288 $dbh->rollback if $oldAutoCommit;
2289 return "Error applying: $error";
2293 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2298 =item apply_credits OPTION => VALUE ...
2300 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
2301 to outstanding invoice balances in chronological order (or reverse
2302 chronological order if the I<order> option is set to B<newest>) and returns the
2303 value of any remaining unapplied credits available for refund (see
2304 L<FS::cust_refund>).
2306 Dies if there is an error.
2314 local $SIG{HUP} = 'IGNORE';
2315 local $SIG{INT} = 'IGNORE';
2316 local $SIG{QUIT} = 'IGNORE';
2317 local $SIG{TERM} = 'IGNORE';
2318 local $SIG{TSTP} = 'IGNORE';
2319 local $SIG{PIPE} = 'IGNORE';
2321 my $oldAutoCommit = $FS::UID::AutoCommit;
2322 local $FS::UID::AutoCommit = 0;
2325 $self->select_for_update; #mutex
2327 unless ( $self->total_unapplied_credits ) {
2328 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2332 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
2333 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
2335 my @invoices = $self->open_cust_bill;
2336 @invoices = sort { $b->_date <=> $a->_date } @invoices
2337 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
2339 if ( $conf->exists('pkg-balances') ) {
2340 # limit @credits to those w/ a pkgnum grepped from $self
2342 foreach my $i (@invoices) {
2343 foreach my $li ( $i->cust_bill_pkg ) {
2344 $pkgnums{$li->pkgnum} = 1;
2347 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
2352 foreach my $cust_bill ( @invoices ) {
2354 if ( !defined($credit) || $credit->credited == 0) {
2355 $credit = pop @credits or last;
2359 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
2360 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
2362 $owed = $cust_bill->owed;
2364 unless ( $owed > 0 ) {
2365 push @credits, $credit;
2369 my $amount = min( $credit->credited, $owed );
2371 my $cust_credit_bill = new FS::cust_credit_bill ( {
2372 'crednum' => $credit->crednum,
2373 'invnum' => $cust_bill->invnum,
2374 'amount' => $amount,
2376 $cust_credit_bill->pkgnum( $credit->pkgnum )
2377 if $conf->exists('pkg-balances') && $credit->pkgnum;
2378 my $error = $cust_credit_bill->insert;
2380 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2384 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2388 my $total_unapplied_credits = $self->total_unapplied_credits;
2390 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2392 return $total_unapplied_credits;
2395 =item apply_payments [ OPTION => VALUE ... ]
2397 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2398 to outstanding invoice balances in chronological order.
2400 #and returns the value of any remaining unapplied payments.
2402 A hash of optional arguments may be passed. Currently "manual" is supported.
2403 If true, a payment receipt is sent instead of a statement when
2404 'payment_receipt_email' configuration option is set.
2406 Dies if there is an error.
2410 sub apply_payments {
2411 my( $self, %options ) = @_;
2413 local $SIG{HUP} = 'IGNORE';
2414 local $SIG{INT} = 'IGNORE';
2415 local $SIG{QUIT} = 'IGNORE';
2416 local $SIG{TERM} = 'IGNORE';
2417 local $SIG{TSTP} = 'IGNORE';
2418 local $SIG{PIPE} = 'IGNORE';
2420 my $oldAutoCommit = $FS::UID::AutoCommit;
2421 local $FS::UID::AutoCommit = 0;
2424 $self->select_for_update; #mutex
2428 my @payments = $self->unapplied_cust_pay;
2430 my @invoices = $self->open_cust_bill;
2432 if ( $conf->exists('pkg-balances') ) {
2433 # limit @payments to those w/ a pkgnum grepped from $self
2435 foreach my $i (@invoices) {
2436 foreach my $li ( $i->cust_bill_pkg ) {
2437 $pkgnums{$li->pkgnum} = 1;
2440 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
2445 foreach my $cust_bill ( @invoices ) {
2447 if ( !defined($payment) || $payment->unapplied == 0 ) {
2448 $payment = pop @payments or last;
2452 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
2453 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
2455 $owed = $cust_bill->owed;
2457 unless ( $owed > 0 ) {
2458 push @payments, $payment;
2462 my $amount = min( $payment->unapplied, $owed );
2465 'paynum' => $payment->paynum,
2466 'invnum' => $cust_bill->invnum,
2467 'amount' => $amount,
2469 $cbp->{_date} = $payment->_date
2470 if $options{'manual'} && $options{'backdate_application'};
2471 my $cust_bill_pay = new FS::cust_bill_pay($cbp);
2472 $cust_bill_pay->pkgnum( $payment->pkgnum )
2473 if $conf->exists('pkg-balances') && $payment->pkgnum;
2474 my $error = $cust_bill_pay->insert(%options);
2476 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2480 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2484 my $total_unapplied_payments = $self->total_unapplied_payments;
2486 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2488 return $total_unapplied_payments;
2498 suspend_adjourned_pkgs
2499 unsuspend_resumed_pkgs
2502 (do_cust_event pre-bill)
2505 (vendor-only) _gather_taxes
2506 _omit_zero_value_bundles
2507 _handle_taxes (for fees)
2510 apply_payments_and_credits
2519 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>