1 package FS::cust_main::Billing;
4 use vars qw( $conf $DEBUG $me );
7 use List::Util qw( min );
9 use FS::Record qw( qsearch qsearchs dbdef );
10 use FS::Misc::DateTime qw( day_end );
13 use FS::cust_bill_pkg;
14 use FS::cust_bill_pkg_display;
15 use FS::cust_bill_pay;
16 use FS::cust_credit_bill;
17 use FS::cust_tax_adjustment;
19 use FS::tax_rate_location;
20 use FS::cust_bill_pkg_tax_location;
21 use FS::cust_bill_pkg_tax_rate_location;
23 use FS::part_event_condition;
25 use FS::FeeOrigin_Mixin;
29 # 1 is mostly method/subroutine entry and options
30 # 2 traces progress of some operations
31 # 3 is even more information including possibly sensitive data
33 $me = '[FS::cust_main::Billing]';
35 install_callback FS::UID sub {
37 #yes, need it for stuff below (prolly should be cached)
42 FS::cust_main::Billing - Billing mixin for cust_main
48 These methods are available on FS::cust_main objects.
54 =item bill_and_collect
56 Cancels and suspends any packages due, generates bills, applies payments and
57 credits, and applies collection events to run cards, send bills and notices,
60 Any errors prevent subsequent operations from continuing and die (but see the
63 Options are passed as name-value pairs. Currently available options are:
69 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:
73 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
77 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.
81 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
85 If set true, re-charges setup fees.
89 If set any errors prevent subsequent operations from continusing. If set
90 specifically to "return", returns the error (or false, if there is no error).
91 Any other true value causes errors to die.
95 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)
99 Optional FS::queue entry to receive status updates.
103 Options are passed to the B<bill> and B<collect> methods verbatim, so all
104 options of those methods are also available.
108 sub bill_and_collect {
109 my( $self, %options ) = @_;
111 my $log = FS::Log->new('FS::cust_main::Billing::bill_and_collect');
112 my %logopt = (object => $self);
113 $log->debug('start', %logopt);
117 #$options{actual_time} not $options{time} because freeside-daily -d is for
118 #pre-printing invoices
120 $options{'actual_time'} ||= time;
121 my $job = $options{'job'};
123 my $actual_time = ( $conf->exists('next-bill-ignore-time')
124 ? day_end( $options{actual_time} )
125 : $options{actual_time}
128 $job->update_statustext('0,cleaning expired packages') if $job;
129 $log->debug('canceling expired packages', %logopt);
130 $error = $self->cancel_expired_pkgs( $actual_time );
132 $error = "Error expiring custnum ". $self->custnum. ": $error";
133 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
137 $log->debug('suspending adjourned packages', %logopt);
138 $error = $self->suspend_adjourned_pkgs( $actual_time );
140 $error = "Error adjourning custnum ". $self->custnum. ": $error";
141 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
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; }
153 $job->update_statustext('20,billing packages') if $job;
154 $log->debug('billing packages', %logopt);
155 $error = $self->bill( %options );
157 $error = "Error billing custnum ". $self->custnum. ": $error";
158 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
162 $job->update_statustext('50,applying payments and credits') if $job;
163 $log->debug('applying payments and credits', %logopt);
164 $error = $self->apply_payments_and_credits;
166 $error = "Error applying custnum ". $self->custnum. ": $error";
167 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
171 # In a batch tax environment, do not run collection if any pending
172 # invoices were created. Collection will run after the next tax batch.
173 my $tax = FS::TaxEngine->new;
174 if ( $tax->info->{batch} and
175 qsearch('cust_bill', { custnum => $self->custnum, pending => 'Y' })
178 warn "skipped collection for custnum ".$self->custnum.
179 " due to pending invoices\n" if $DEBUG;
180 } elsif ( $conf->exists('cancelled_cust-noevents')
181 && ! $self->num_ncancelled_pkgs )
183 warn "skipped collection for custnum ".$self->custnum.
184 " because they have no active packages\n" if $DEBUG;
186 # run collection normally
187 $job->update_statustext('70,running collection events') if $job;
188 $log->debug('running collection events', %logopt);
189 $error = $self->collect( %options );
191 $error = "Error collecting custnum ". $self->custnum. ": $error";
192 if ($options{fatal} && $options{fatal} eq 'return') { return $error; }
197 $job->update_statustext('100,finished') if $job;
198 $log->debug('finish', %logopt);
204 sub cancel_expired_pkgs {
205 my ( $self, $time, %options ) = @_;
207 my @cancel_pkgs = $self->ncancelled_pkgs( {
208 'extra_sql' => " AND expire IS NOT NULL AND expire > 0 AND expire <= $time "
213 my @really_cancel_pkgs = ();
214 my @cancel_reasons = ();
216 CUST_PKG: foreach my $cust_pkg ( @cancel_pkgs ) {
217 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
219 if ( $cust_pkg->change_to_pkgnum ) {
221 my $new_pkg = FS::cust_pkg->by_key($cust_pkg->change_to_pkgnum);
223 push @errors, 'can\'t change pkgnum '.$cust_pkg->pkgnum.' to pkgnum '.
224 $cust_pkg->change_to_pkgnum.'; not expiring';
227 my $error = $cust_pkg->change( 'cust_pkg' => $new_pkg,
228 'unprotect_svcs' => 1,
230 push @errors, $error if $error && ref($error) ne 'FS::cust_pkg';
232 } else { # just cancel it
234 push @really_cancel_pkgs, $cust_pkg;
235 push @cancel_reasons, $cpr;
240 if (@really_cancel_pkgs) {
242 my %cancel_opt = ( 'cust_pkg' => \@really_cancel_pkgs,
243 'cust_pkg_reason' => \@cancel_reasons,
247 push @errors, $self->cancel_pkgs(%cancel_opt);
251 join(' / ', @errors);
255 sub suspend_adjourned_pkgs {
256 my ( $self, $time, %options ) = @_;
258 my @susp_pkgs = $self->ncancelled_pkgs( {
260 " AND ( susp IS NULL OR susp = 0 )
261 AND ( ( bill IS NOT NULL AND bill != 0 AND bill < $time )
262 OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
267 #only because there's no SQL test for is_prepaid :/
269 grep { ( $_->part_pkg->is_prepaid
274 && $_->adjourn <= $time
282 foreach my $cust_pkg ( @susp_pkgs ) {
283 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
284 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
285 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
286 'reason_otaker' => $cpr->otaker
290 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
293 join(' / ', @errors);
297 sub unsuspend_resumed_pkgs {
298 my ( $self, $time, %options ) = @_;
300 my @unsusp_pkgs = $self->ncancelled_pkgs( {
301 'extra_sql' => " AND resume IS NOT NULL AND resume > 0 AND resume <= $time "
306 foreach my $cust_pkg ( @unsusp_pkgs ) {
307 my $error = $cust_pkg->unsuspend( 'time' => $time );
308 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
311 join(' / ', @errors);
317 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
318 conjunction with the collect method by calling B<bill_and_collect>.
320 If there is an error, returns the error, otherwise returns false.
322 Options are passed as name-value pairs. Currently available options are:
328 If set true, re-charges setup fees.
332 If set true then only bill recurring charges, not setup, usage, one time
337 If set, then override the normal frequency and look for a part_pkg_discount
338 to take at that frequency. This is appropriate only when the normal
339 frequency for all packages is monthly, and is an error otherwise. Use
340 C<pkg_list> to limit the set of packages included in billing.
344 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:
348 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
352 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
354 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
358 A hashref of pkgparts to exclude from this billing run (can also be specified as a comma-separated scalar).
362 Do not bill prepaid packages. Used by freeside-daily.
366 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.
370 This boolean value informs the us that the package is being cancelled. This
371 typically might mean not charging the normal recurring fee but only usage
372 fees since the last billing. Setup charges may be charged. Not all package
373 plans support this feature (they tend to charge 0).
377 Prevent the resetting of usage limits during this call.
381 Do not save the generated bill in the database. Useful with return_bill
385 A list reference on which the generated bill(s) will be returned.
389 Boolean value; indicates that this is an estimate rather than a "tax invoice".
390 This will be passed through to the tax engine, as online tax services
391 sometimes need to know it for reporting purposes. Otherwise it has no effect.
395 Optional terms to be printed on this invoice. Otherwise, customer-specific
396 terms or the default terms are used.
403 my( $self, %options ) = @_;
405 return '' if $self->complimentary eq 'Y';
407 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
408 my $log = FS::Log->new('FS::cust_main::Billing::bill');
409 my %logopt = (object => $self);
411 $log->debug('start', %logopt);
412 warn "$me bill customer ". $self->custnum. "\n"
415 my $time = $options{'time'} || time;
416 my $invoice_time = $options{'invoice_time'} || $time;
418 my $cmp_time = ( $conf->exists('next-bill-ignore-time')
423 $options{'not_pkgpart'} ||= {};
424 $options{'not_pkgpart'} = { map { $_ => 1 }
425 split(/\s*,\s*/, $options{'not_pkgpart'})
427 unless ref($options{'not_pkgpart'});
429 local $SIG{HUP} = 'IGNORE';
430 local $SIG{INT} = 'IGNORE';
431 local $SIG{QUIT} = 'IGNORE';
432 local $SIG{TERM} = 'IGNORE';
433 local $SIG{TSTP} = 'IGNORE';
434 local $SIG{PIPE} = 'IGNORE';
436 my $oldAutoCommit = $FS::UID::AutoCommit;
437 local $FS::UID::AutoCommit = 0;
440 $log->debug('acquiring lock', %logopt);
441 warn "$me acquiring lock on customer ". $self->custnum. "\n"
444 $self->select_for_update; #mutex
446 $log->debug('running pre-bill events', %logopt);
447 warn "$me running pre-bill events for customer ". $self->custnum. "\n"
450 my $error = $self->do_cust_event(
451 'debug' => ( $options{'debug'} || 0 ),
452 'time' => $invoice_time,
453 'check_freq' => $options{'check_freq'},
454 'stage' => 'pre-bill',
456 unless $options{no_commit};
458 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
462 $log->debug('done running pre-bill events', %logopt);
463 warn "$me done running pre-bill events for customer ". $self->custnum. "\n"
466 #keep auto-charge and non-auto-charge line items separate
467 my @passes = ( '', 'no_auto' );
469 my %cust_bill_pkg = map { $_ => [] } @passes;
472 # find the packages which are due for billing, find out how much they are
473 # & generate invoice database.
476 my %total_setup = map { my $z = 0; $_ => \$z; } @passes;
477 my %total_recur = map { my $z = 0; $_ => \$z; } @passes;
479 my @precommit_hooks = ();
481 $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ]; #param checks?
484 my $tax_is_batch = '';
486 $tax_engines{$_} = FS::TaxEngine->new(cust_main => $self,
487 invoice_time => $invoice_time,
488 cancel => $options{cancel},
489 estimate => $options{estimate},
491 $tax_is_batch ||= $tax_engines{$_}->info->{batch};
494 foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
496 next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
498 my $part_pkg = $cust_pkg->part_pkg;
500 next if $options{'no_prepaid'} && $part_pkg->is_prepaid;
502 $log->debug('bill package '. $cust_pkg->pkgnum, %logopt);
503 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG;
505 #? to avoid use of uninitialized value errors... ?
506 $cust_pkg->setfield('bill', '')
507 unless defined($cust_pkg->bill);
509 my $real_pkgpart = $cust_pkg->pkgpart;
510 my %hash = $cust_pkg->hash;
512 # we could implement this bit as FS::part_pkg::has_hidden, but we already
513 # suffer from performance issues
514 $options{has_hidden} = 0;
515 my @part_pkg = $part_pkg->self_and_bill_linked;
516 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
518 # if this package was changed from another package,
519 # and it hasn't been billed since then,
520 # and package balances are enabled,
521 if ( $cust_pkg->change_pkgnum
522 and $cust_pkg->change_date >= ($cust_pkg->last_bill || 0)
523 and $cust_pkg->change_date < $invoice_time
524 and $conf->exists('pkg-balances') )
526 # _transfer_balance will also create the appropriate credit
527 my @transfer_items = $self->_transfer_balance($cust_pkg);
528 # $part_pkg[0] is the "real" part_pkg
529 my $pass = ($cust_pkg->no_auto || $part_pkg[0]->no_auto) ?
531 push @{ $cust_bill_pkg{$pass} }, @transfer_items;
532 # treating this as recur, just because most charges are recur...
533 ${$total_recur{$pass}} += $_->recur foreach @transfer_items;
535 # currently not considering separate_bill here, as it's for
536 # one-time charges only
539 foreach my $part_pkg ( @part_pkg ) {
541 my $this_cust_pkg = $cust_pkg;
542 # for add-on packages, copy the object to avoid leaking changes back to
543 # the caller if pkg_list is in use; see RT#73607
544 if ( $part_pkg->get('pkgpart') != $real_pkgpart ) {
545 $this_cust_pkg = FS::cust_pkg->new({ %hash });
549 if ( $this_cust_pkg->separate_bill ) {
550 # if no_auto is also set, that's fine. we just need to not have
551 # invoices that are both auto and no_auto, and since the package
552 # gets an invoice all to itself, it will only be one or the other.
553 $pass = $this_cust_pkg->pkgnum;
554 if (!exists $cust_bill_pkg{$pass}) { # it may not exist yet
556 $total_setup{$pass} = do { my $z = 0; \$z };
557 $total_recur{$pass} = do { my $z = 0; \$z };
558 # it also needs its own tax context
559 $tax_engines{$pass} = FS::TaxEngine->new(
561 invoice_time => $invoice_time,
562 cancel => $options{cancel},
563 estimate => $options{estimate},
565 $cust_bill_pkg{$pass} = [];
567 } elsif ( ($this_cust_pkg->no_auto || $part_pkg->no_auto) ) {
571 my $next_bill = $this_cust_pkg->getfield('bill') || 0;
573 # let this run once if this is the last bill upon cancellation
574 while ( $next_bill <= $cmp_time or $options{cancel} ) {
576 $self->_make_lines( 'part_pkg' => $part_pkg,
577 'cust_pkg' => $this_cust_pkg,
578 'precommit_hooks' => \@precommit_hooks,
579 'line_items' => $cust_bill_pkg{$pass},
580 'setup' => $total_setup{$pass},
581 'recur' => $total_recur{$pass},
582 'tax_engine' => $tax_engines{$pass},
584 'real_pkgpart' => $real_pkgpart,
585 'options' => \%options,
588 # Stop if anything goes wrong
591 # or if we're not incrementing the bill date.
592 last if ($this_cust_pkg->getfield('bill') || 0) == $next_bill;
594 # or if we're letting it run only once
595 last if $options{cancel};
597 $next_bill = $this_cust_pkg->getfield('bill') || 0;
599 #stop if -o was passed to freeside-daily
600 last if $options{'one_recur'};
603 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
607 } #foreach my $part_pkg
609 } #foreach my $cust_pkg
611 foreach my $pass (@passes) { # keys %cust_bill_pkg )
613 my @cust_bill_pkg = _omit_zero_value_bundles(@{ $cust_bill_pkg{$pass} });
615 warn "$me billing pass $pass\n"
616 #.Dumper(\@cust_bill_pkg)."\n"
623 my @pending_fees = FS::FeeOrigin_Mixin->by_cust($self->custnum,
624 hashref => { 'billpkgnum' => '' }
626 warn "$me found pending fees:\n".Dumper(\@pending_fees)."\n"
627 if @pending_fees and $DEBUG > 1;
629 # determine whether to generate an invoice
630 my $generate_bill = scalar(@cust_bill_pkg) > 0;
632 foreach my $fee (@pending_fees) {
633 $generate_bill = 1 unless $fee->nextbill;
636 # don't create an invoice with no line items, or where the only line
637 # items are fees that are supposed to be held until the next invoice
638 next if !$generate_bill;
642 foreach my $fee_origin (@pending_fees) {
643 my $part_fee = $fee_origin->part_fee;
645 # check whether the fee is applicable before doing anything expensive:
647 # if the fee def belongs to a different agent, don't charge the fee.
648 # event conditions should prevent this, but just in case they don't,
650 if ( $part_fee->agentnum and $part_fee->agentnum != $self->agentnum ) {
651 warn "tried to charge fee#".$part_fee->feepart .
652 " on customer#".$self->custnum." from a different agent.\n";
655 # also skip if it's disabled
656 next if $part_fee->disabled eq 'Y';
658 # Decide which invoice to base the fee on.
659 my $cust_bill = $fee_origin->cust_bill;
661 # Then link it to the current invoice. This isn't the real cust_bill
662 # object that will be inserted--in particular there are no taxes yet.
663 # If you want to charge a fee on the total invoice amount including
664 # taxes, you have to put the fee on the next invoice.
665 $cust_bill = FS::cust_bill->new({
666 'custnum' => $self->custnum,
667 'cust_bill_pkg' => \@cust_bill_pkg,
668 'charged' => ${ $total_setup{$pass} } +
669 ${ $total_recur{$pass} },
672 # If the origin is for a specific package, then only apply the fee to
673 # line items from that package.
674 if ( my $cust_pkg = $fee_origin->cust_pkg ) {
675 my @charge_fee_on_item;
676 my $charge_fee_on_amount = 0;
677 foreach (@cust_bill_pkg) {
678 if ($_->pkgnum == $cust_pkg->pkgnum) {
679 push @charge_fee_on_item, $_;
680 $charge_fee_on_amount += $_->setup + $_->recur;
683 $cust_bill->set('cust_bill_pkg', \@charge_fee_on_item);
684 $cust_bill->set('charged', $charge_fee_on_amount);
687 } # $cust_bill is now set
689 my $fee_item = $part_fee->lineitem($cust_bill) or next;
690 # link this so that we can clear the marker on inserting the line item
691 $fee_item->set('fee_origin', $fee_origin);
692 push @fee_items, $fee_item;
696 # add fees to the invoice
697 foreach my $fee_item (@fee_items) {
699 push @cust_bill_pkg, $fee_item;
700 ${ $total_setup{$pass} } += $fee_item->setup;
701 ${ $total_recur{$pass} } += $fee_item->recur;
703 my $part_fee = $fee_item->part_fee;
704 my $fee_location = $self->ship_location; # I think?
706 my $error = $tax_engines{''}->add_sale($fee_item);
708 return $error if $error;
712 # XXX implementation of fees is supposed to make this go away...
713 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
714 !$conf->exists('postal_invoice-recurring_only')
718 my $postal_pkg = $self->charge_postal_fee();
719 if ( $postal_pkg && !ref( $postal_pkg ) ) {
721 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
722 return "can't charge postal invoice fee for customer ".
723 $self->custnum. ": $postal_pkg";
725 } elsif ( $postal_pkg ) {
727 my $real_pkgpart = $postal_pkg->pkgpart;
728 # we could implement this bit as FS::part_pkg::has_hidden, but we already
729 # suffer from performance issues
730 $options{has_hidden} = 0;
731 my @part_pkg = $postal_pkg->part_pkg->self_and_bill_linked;
732 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
734 foreach my $part_pkg ( @part_pkg ) {
735 my %postal_options = %options;
736 delete $postal_options{cancel};
738 $self->_make_lines( 'part_pkg' => $part_pkg,
739 'cust_pkg' => $postal_pkg,
740 'precommit_hooks' => \@precommit_hooks,
741 'line_items' => \@cust_bill_pkg,
742 'setup' => $total_setup{$pass},
743 'recur' => $total_recur{$pass},
744 'tax_engine' => $tax_engines{$pass},
746 'real_pkgpart' => $real_pkgpart,
747 'options' => \%postal_options,
750 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
755 # it's silly to have a zero value postal_pkg, but....
756 @cust_bill_pkg = _omit_zero_value_bundles(@cust_bill_pkg);
763 #XXX does this work with batch tax engines?
764 warn "adding tax adjustments...\n" if $DEBUG > 2;
765 foreach my $cust_tax_adjustment (
766 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
772 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
774 my $itemdesc = $cust_tax_adjustment->taxname;
775 $itemdesc = '' if $itemdesc eq 'Tax';
777 push @cust_bill_pkg, new FS::cust_bill_pkg {
783 'itemdesc' => $itemdesc,
784 'itemcomment' => $cust_tax_adjustment->comment,
785 'cust_tax_adjustment' => $cust_tax_adjustment,
786 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
791 my $charged = sprintf('%.2f', ${ $total_setup{$pass} } + ${ $total_recur{$pass} } );
793 my $balance = $self->balance;
795 my $previous_bill = qsearchs({ 'table' => 'cust_bill',
796 'hashref' => { custnum=>$self->custnum },
797 'extra_sql' => 'ORDER BY _date DESC LIMIT 1',
799 my $previous_balance =
801 ? ( $previous_bill->billing_balance + $previous_bill->charged )
804 $log->debug('creating the new invoice', %logopt);
805 warn "creating the new invoice\n" if $DEBUG;
806 #create the new invoice
807 my $cust_bill = new FS::cust_bill ( {
808 'custnum' => $self->custnum,
809 '_date' => $invoice_time,
810 'charged' => $charged,
811 'billing_balance' => $balance,
812 'previous_balance' => $previous_balance,
813 'invoice_terms' => $options{'invoice_terms'},
814 'cust_bill_pkg' => \@cust_bill_pkg,
815 'pending' => 'Y', # clear this after doing taxes
818 if (!$options{no_commit}) {
819 # probably we ought to insert it as pending, and then rollback
820 # without ever un-pending it
821 $error = $cust_bill->insert;
823 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
824 return "can't create invoice for customer #". $self->custnum. ": $error";
829 # calculate and append taxes
830 if ( ! $tax_is_batch) {
832 my $arrayref = eval { $tax_engines{$pass}->calculate_taxes($cust_bill) };
835 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
839 # or should this be in TaxEngine?
841 foreach my $taxline ( @$arrayref ) {
842 $total_tax += $taxline->setup;
843 $taxline->set('invnum' => $cust_bill->invnum); # just to be sure
844 push @cust_bill_pkg, $taxline; # for return_bill
846 if (!$options{no_commit}) {
847 my $error = $taxline->insert;
849 $dbh->rollback if $oldAutoCommit;
856 # add tax to the invoice amount and finalize it
857 ${ $total_setup{$pass} } = sprintf('%.2f', ${ $total_setup{$pass} } + $total_tax);
858 $charged = sprintf('%.2f', $charged + $total_tax);
859 $cust_bill->set('charged', $charged);
860 $cust_bill->set('pending', '');
862 if (!$options{no_commit}) {
863 my $error = $cust_bill->replace;
865 $dbh->rollback if $oldAutoCommit;
870 } # if !$tax_is_batch
871 # if it IS batch, then we'll do all this in process_tax_batch
873 push @{$options{return_bill}}, $cust_bill if $options{return_bill};
875 } #foreach my $pass ( keys %cust_bill_pkg )
877 foreach my $hook ( @precommit_hooks ) {
880 } unless $options{no_commit};
882 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
883 return "$@ running precommit hook $hook\n";
887 $dbh->commit or die $dbh->errstr if $oldAutoCommit && !$options{no_commit};
892 #discard bundled packages of 0 value
893 # XXX we should reconsider whether we even need this
894 sub _omit_zero_value_bundles {
899 my $discount_show_always = $conf->exists('discount-show-always');
902 # Sort @in the same way we do during invoice rendering, so we can identify
903 # bundles. See FS::Template_Mixin::_items_nontax.
904 @in = sort { $a->pkgnum <=> $b->pkgnum or
905 $a->sdate <=> $b->sdate or
906 ($a->pkgpart_override ? 0 : -1) or
907 ($b->pkgpart_override ? 0 : 1) or
908 $b->hidden cmp $a->hidden or
909 $a->pkgpart_override <=> $b->pkgpart_override
912 # this is a pack-and-deliver pattern. every time there's a cust_bill_pkg
913 # _without_ pkgpart_override, that's the start of the new bundle. if there's
914 # an existing bundle, and it contains a nonzero amount (or a zero amount
915 # that's displayable anyway), push all line items in the bundle.
916 foreach my $cust_bill_pkg ( @in ) {
918 if (scalar(@bundle) and !$cust_bill_pkg->pkgpart_override) {
919 # ship out this bundle and reset it
927 # add this item to the current bundle
928 push @bundle, $cust_bill_pkg;
930 # determine if it makes the bundle displayable
931 if ( $cust_bill_pkg->setup > 0
932 or $cust_bill_pkg->recur > 0
933 or $cust_bill_pkg->setup_show_zero
934 or $cust_bill_pkg->recur_show_zero
935 or ($discount_show_always
936 and scalar(@{ $cust_bill_pkg->get('discounts')})
948 warn " _omit_zero_value_bundles: ". scalar(@in).
949 '->'. scalar(@out). "\n" #. Dumper(@out). "\n"
956 my ($self, %params) = @_;
958 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
960 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
961 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
962 my $cust_location = $cust_pkg->tax_location;
963 my $precommit_hooks = $params{precommit_hooks} or die "no precommit_hooks specified";
964 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
965 my $total_setup = $params{setup} or die "no setup accumulator specified";
966 my $total_recur = $params{recur} or die "no recur accumulator specified";
967 my $time = $params{'time'} or die "no time specified";
968 my (%options) = %{$params{options}};
970 my $tax_engine = $params{tax_engine};
972 if ( $part_pkg->freq ne '1' and ($options{'freq_override'} || 0) > 0 ) {
973 # this should never happen
974 die 'freq_override billing attempted on non-monthly package '.
979 my $real_pkgpart = $params{real_pkgpart};
980 my %hash = $cust_pkg->hash;
981 my $old_cust_pkg = new FS::cust_pkg \%hash;
986 $cust_pkg->pkgpart($part_pkg->pkgpart);
988 my $cmp_time = ( $conf->exists('next-bill-ignore-time')
999 my @setup_discounts = ();
1000 my %setup_param = ( 'discounts' => \@setup_discounts,
1001 'real_pkgpart' => $params{real_pkgpart}
1003 my $setup_billed_currency = '';
1004 my $setup_billed_amount = 0;
1005 # Conditions for setting setup date and charging the setup fee:
1006 # - this is not a recurring-only billing run
1007 # - and the package is not currently being canceled
1008 # - and, unless we're specifically told otherwise via 'resetup':
1009 # - it doesn't already HAVE a setup date
1010 # - or a start date in the future
1011 # - and it's not suspended
1012 # - and it doesn't have an expire date in the past
1014 # The "disable_setup_suspended" option is now obsolete; we never set the
1015 # setup date on a suspended package.
1016 if ( ! $options{recurring_only}
1017 and ! $options{cancel}
1018 and ( $options{'resetup'}
1019 || ( ! $cust_pkg->setup
1020 && ( ! $cust_pkg->start_date
1021 || $cust_pkg->start_date <= $cmp_time
1023 && ( ! $cust_pkg->getfield('susp') )
1026 and ( ! $cust_pkg->expire
1027 || $cust_pkg->expire > $cmp_time )
1031 warn " bill setup\n" if $DEBUG > 1;
1033 unless ( $cust_pkg->waive_setup ) {
1036 $setup = eval { $cust_pkg->calc_setup( $time, \@details, \%setup_param ) };
1037 return "$@ running calc_setup for $cust_pkg\n"
1040 # Only increment unitsetup here if there IS a setup fee.
1041 # prorate_defer_bill may cause calc_setup on a setup-stage package
1042 # to return zero, and the setup fee to be charged later. (This happens
1043 # when it's first billed on the prorate cutoff day. RT#31276.)
1045 $unitsetup = $cust_pkg->base_setup()
1049 if ( $setup_param{'billed_currency'} ) {
1050 $setup_billed_currency = delete $setup_param{'billed_currency'};
1051 $setup_billed_amount = delete $setup_param{'billed_amount'};
1055 if ( $cust_pkg->get('setup') ) {
1057 } elsif ( $cust_pkg->get('start_date') ) {
1058 # this allows start_date to be used to set the first bill date
1059 $cust_pkg->set('setup', $cust_pkg->get('start_date'));
1061 # if unspecified, start it right now
1062 $cust_pkg->set('setup', $time);
1065 $cust_pkg->setfield('start_date', '')
1066 if $cust_pkg->start_date;
1071 # bill recurring fee
1076 my @recur_discounts = ();
1077 my $recur_billed_currency = '';
1078 my $recur_billed_amount = 0;
1081 my $override_quantity;
1083 # Conditions for billing the recurring fee:
1084 # - the package doesn't have a future start date
1085 # - and it's not suspended
1086 # - unless suspend_bill is enabled on the package or package def
1087 # - but still not, if the package is on hold
1088 # - or it's suspended for a delayed cancellation
1089 # - and its next bill date is in the past
1090 # - or it doesn't have a next bill date yet
1091 # - or it's a one-time charge
1092 # - or it's a CDR plan with the "bill_every_call" option
1093 # - or it's being canceled
1094 # - and it doesn't have an expire date in the past (this can happen with
1096 # - again, unless it's being canceled
1097 if ( ! $cust_pkg->start_date
1100 || ( $cust_pkg->susp != $cust_pkg->order_date
1101 && ( $cust_pkg->option('suspend_bill',1)
1102 || ( $part_pkg->option('suspend_bill', 1)
1103 && ! $cust_pkg->option('no_suspend_bill',1)
1107 || $cust_pkg->is_status_delay_cancel
1110 ( $part_pkg->freq ne '0' && ( $cust_pkg->bill || 0 ) <= $cmp_time )
1111 || ( $part_pkg->plan eq 'voip_cdr'
1112 && $part_pkg->option('bill_every_call')
1117 ( ! $cust_pkg->expire
1118 || $cust_pkg->expire > $cmp_time
1123 # XXX should this be a package event? probably. events are called
1124 # at collection time at the moment, though...
1125 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
1126 if $part_pkg->can('reset_usage') && !$options{'no_usage_reset'};
1127 #don't want to reset usage just cause we want a line item??
1128 #&& $part_pkg->pkgpart == $real_pkgpart;
1130 warn " bill recur\n" if $DEBUG > 1;
1133 # XXX shared with $recur_prog
1134 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
1138 #over two params! lets at least switch to a hashref for the rest...
1139 my $increment_next_bill = ( $part_pkg->freq ne '0'
1140 && ( $cust_pkg->getfield('bill') || 0 ) <= $cmp_time
1141 && !$options{cancel}
1143 my %param = ( %setup_param,
1144 'precommit_hooks' => $precommit_hooks,
1145 'increment_next_bill' => $increment_next_bill,
1146 'discounts' => \@recur_discounts,
1147 'real_pkgpart' => $real_pkgpart,
1148 'freq_override' => $options{freq_override} || '',
1152 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
1154 # There may be some part_pkg for which this is wrong. Only those
1155 # which can_discount are supported.
1156 # (the UI should prevent adding discounts to these at the moment)
1158 warn "calling $method on cust_pkg ". $cust_pkg->pkgnum.
1159 " for pkgpart ". $cust_pkg->pkgpart.
1160 " with params ". join(' / ', map "$_=>$param{$_}", keys %param). "\n"
1163 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
1164 return "$@ running $method for $cust_pkg\n"
1167 if ($recur eq 'NOTHING') {
1168 # then calc_cancel (or calc_recur but that's not used) has declined to
1169 # generate a recurring lineitem at all. treat this as zero, but also
1170 # try not to generate a lineitem.
1176 $unitrecur = $cust_pkg->base_recur( \$sdate ) || $recur; #XXX uuh, better
1178 if ( $param{'billed_currency'} ) {
1179 $recur_billed_currency = delete $param{'billed_currency'};
1180 $recur_billed_amount = delete $param{'billed_amount'};
1183 if ( $param{'override_quantity'} ) {
1184 $override_quantity = $param{'override_quantity'};
1185 $unitrecur = $recur / $override_quantity;
1188 if ( $increment_next_bill ) {
1192 if ( my $main_pkg = $cust_pkg->main_pkg ) {
1193 # supplemental package
1194 # to keep in sync with the main package, simulate billing at
1196 my $main_pkg_freq = $main_pkg->part_pkg->freq;
1197 my $supp_pkg_freq = $part_pkg->freq;
1198 if ( $supp_pkg_freq == 0 or $main_pkg_freq == 0 ) {
1199 # the UI should prevent setting up packages like this, but just
1201 return "unable to calculate supplemental package period ratio";
1203 my $ratio = $supp_pkg_freq / $main_pkg_freq;
1204 if ( $ratio == int($ratio) ) {
1205 # simple case: main package is X months, supp package is X*A months,
1206 # advance supp package to where the main package will be in A cycles.
1207 $next_bill = $sdate;
1209 $next_bill = $part_pkg->add_freq( $next_bill, $main_pkg_freq );
1212 # harder case: main package is X months, supp package is Y months.
1213 # advance supp package by Y months. then if they're within half a
1214 # month of each other, resync them. this may result in the period
1215 # not being exactly Y months.
1216 $next_bill = $part_pkg->add_freq( $sdate, $supp_pkg_freq );
1217 my $main_next_bill = $main_pkg->bill;
1218 if ( $main_pkg->bill <= $time ) {
1219 # then the main package has not yet been billed on this cycle;
1220 # predict what its bill date will be.
1222 $part_pkg->add_freq( $main_next_bill, $main_pkg_freq );
1224 if ( abs($main_next_bill - $next_bill) < 86400*15 ) {
1225 $next_bill = $main_next_bill;
1230 # the normal case, not a supplemental package
1231 $next_bill = $part_pkg->add_freq($sdate, $options{freq_override} || 0);
1232 return "unparsable frequency: ".
1233 ($options{freq_override} || $part_pkg->freq)
1234 if $next_bill == -1;
1237 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
1238 # only for figuring next bill date, nothing else, so, reset $sdate again
1240 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1241 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
1242 $cust_pkg->last_bill($sdate);
1244 $cust_pkg->setfield('bill', $next_bill );
1248 if ( $param{'setup_fee'} ) {
1249 # Add an additional setup fee at the billing stage.
1250 # Used for prorate_defer_bill.
1251 $setup += $param{'setup_fee'};
1252 $unitsetup = $cust_pkg->base_setup();
1256 if ( defined $param{'discount_left_setup'} ) {
1257 foreach my $discount_setup ( values %{$param{'discount_left_setup'}} ) {
1258 $setup -= $discount_setup;
1262 } # end of recurring fee
1264 warn "\$setup is undefined" unless defined($setup);
1265 warn "\$recur is undefined" unless defined($recur);
1266 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1269 # If there's line items, create em cust_bill_pkg records
1270 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
1275 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
1276 # hmm.. and if just the options are modified in some weird price plan?
1278 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
1281 my $error = $cust_pkg->replace( $old_cust_pkg,
1282 'depend_jobnum'=>$options{depend_jobnum},
1283 'options' => { $cust_pkg->options },
1285 unless $options{no_commit};
1286 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
1287 if $error; #just in case
1290 $setup = sprintf( "%.2f", $setup );
1291 $recur = sprintf( "%.2f", $recur );
1292 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
1293 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1295 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
1296 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
1299 my $discount_show_always = $conf->exists('discount-show-always')
1300 && ( ($setup == 0 && scalar(@setup_discounts))
1301 || ($recur == 0 && scalar(@recur_discounts))
1306 || (!$part_pkg->hidden && $options{has_hidden}) #include some $0 lines
1307 || $discount_show_always
1308 || ($setup == 0 && $cust_pkg->_X_show_zero('setup'))
1309 || ($recur == 0 && $cust_pkg->_X_show_zero('recur'))
1313 warn " charges (setup=$setup, recur=$recur); adding line items\n"
1316 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
1318 warn " adding customer package invoice detail: $_\n"
1319 foreach @cust_pkg_detail;
1321 push @details, @cust_pkg_detail;
1323 my $cust_bill_pkg = new FS::cust_bill_pkg {
1324 'pkgnum' => $cust_pkg->pkgnum,
1326 'unitsetup' => sprintf('%.2f', $unitsetup),
1327 'setup_billed_currency' => $setup_billed_currency,
1328 'setup_billed_amount' => $setup_billed_amount,
1330 'unitrecur' => sprintf('%.2f', $unitrecur),
1331 'recur_billed_currency' => $recur_billed_currency,
1332 'recur_billed_amount' => $recur_billed_amount,
1333 'quantity' => $override_quantity || $cust_pkg->quantity,
1334 'details' => \@details,
1335 'discounts' => [ @setup_discounts, @recur_discounts ],
1336 'hidden' => $part_pkg->hidden,
1337 'freq' => $part_pkg->freq,
1340 if ( $part_pkg->option('prorate_defer_bill',1)
1341 and !$hash{last_bill} ) {
1342 # both preceding and upcoming, technically
1343 $cust_bill_pkg->sdate( $cust_pkg->setup );
1344 $cust_bill_pkg->edate( $cust_pkg->bill );
1345 } elsif ( $part_pkg->recur_temporality eq 'preceding' ) {
1346 $cust_bill_pkg->sdate( $hash{last_bill} );
1347 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
1348 $cust_bill_pkg->edate( $time ) if $options{cancel};
1349 } else { #if ( $part_pkg->recur_temporality eq 'upcoming' )
1350 $cust_bill_pkg->sdate( $sdate );
1351 $cust_bill_pkg->edate( $cust_pkg->bill );
1352 #$cust_bill_pkg->edate( $time ) if $options{cancel};
1355 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
1356 unless $part_pkg->pkgpart == $real_pkgpart;
1358 $$total_setup += $setup;
1359 $$total_recur += $recur;
1365 my $error = $tax_engine->add_sale($cust_bill_pkg);
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 #### vestigial code ####
1464 =item handle_taxes TAXLISTHASH CUST_BILL_PKG [ OPTIONS ]
1466 This is _handle_taxes. It's called once for each cust_bill_pkg generated
1469 TAXLISTHASH is a hashref shared across the entire invoice. It looks like
1472 'cust_main_county 1001' => [ [FS::cust_main_county], ... ],
1473 'cust_main_county 1002' => [ [FS::cust_main_county], ... ],
1476 'cust_main_county' can also be 'tax_rate'. The first object in the array
1477 is always the cust_main_county or tax_rate identified by the key.
1479 That "..." is a list of FS::cust_bill_pkg objects that will be fed to
1480 the 'taxline' method to calculate the amount of the tax. This doesn't
1481 happen until calculate_taxes, though.
1483 OPTIONS may include:
1484 - part_item: a part_pkg or part_fee object to be used as the package/fee
1486 - location: a cust_location to be used as the billing location.
1487 - cancel: true if this package is being billed on cancellation. This
1488 allows tax to be calculated on usage charges only.
1490 If not supplied, part_item will be inferred from the pkgnum or feepart of the
1491 cust_bill_pkg, and location from the pkgnum (or, for fees, the invnum and
1492 the customer's default service location).
1494 This method will also calculate exemptions for any taxes that apply to the
1495 line item (using the C<set_exemptions> method of L<FS::cust_bill_pkg>) and
1496 attach them. This is the only place C<set_exemptions> is called in normal
1503 my $taxlisthash = shift;
1504 my $cust_bill_pkg = shift;
1507 # at this point I realize that we have enough information to infer all this
1508 # stuff, instead of passing around giant honking argument lists
1509 my $location = $options{location} || $cust_bill_pkg->tax_location;
1510 my $part_item = $options{part_item} || $cust_bill_pkg->part_X;
1512 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1514 return if ( $self->payby eq 'COMP' ); #dubious
1516 if ( $conf->config('enable_taxproducts')
1517 && ( scalar($part_item->part_pkg_taxoverride)
1518 || $part_item->has_taxproduct
1523 # EXTERNAL TAX RATES (via tax_rate)
1524 my %cust_bill_pkg = ();
1528 my $usage = $cust_bill_pkg->usage || 0;
1529 push @classes, $cust_bill_pkg->usage_classes if $usage;
1530 push @classes, 'setup' if $cust_bill_pkg->setup and !$options{cancel};
1531 push @classes, 'recur' if ($cust_bill_pkg->recur - $usage)
1532 and !$options{cancel};
1533 # that's better--probably don't even need $options{cancel} now
1534 # but leave it for now, just to be safe
1536 # About $options{cancel}: This protects against charging per-line or
1537 # per-customer or other flat-rate surcharges on a package that's being
1538 # billed on cancellation (which is an out-of-cycle bill and should only
1539 # have usage charges). See RT#29443.
1541 # customer exemption is now handled in the 'taxline' method
1542 #my $exempt = $conf->exists('cust_class-tax_exempt')
1543 # ? ( $self->cust_class ? $self->cust_class->tax : '' )
1545 # standardize this just to be sure
1546 #$exempt = ($exempt eq 'Y') ? 'Y' : '';
1550 unless (exists $taxes{''}) {
1551 # unsure what purpose this serves, but last time I deleted something
1552 # from here just because I didn't see the point, it actually did
1553 # something important.
1554 my $err_or_ref = $self->_gather_taxes($part_item, '', $location);
1555 return $err_or_ref unless ref($err_or_ref);
1556 $taxes{''} = $err_or_ref;
1559 # NO DISINTEGRATIONS.
1560 # my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
1562 # do not call taxline() with any argument except the entire set of
1563 # cust_bill_pkgs on an invoice that are eligible for the tax.
1565 # only calculate exemptions once for each tax rate, even if it's used
1566 # for multiple classes
1569 foreach my $class (@classes) {
1570 my $err_or_ref = $self->_gather_taxes($part_item, $class, $location);
1571 return $err_or_ref unless ref($err_or_ref);
1572 my @taxes = @$err_or_ref;
1576 foreach my $tax ( @taxes ) {
1578 my $tax_id = ref( $tax ). ' '. $tax->taxnum;
1579 # $taxlisthash: keys are tax identifiers ('FS::tax_rate 123456').
1580 # Values are arrayrefs, first the tax object (cust_main_county
1581 # or tax_rate), then the cust_bill_pkg object that the
1582 # tax applies to, then the tax class (setup, recur, usage classnum).
1583 $taxlisthash->{ $tax_id } ||= [ $tax ];
1584 push @{ $taxlisthash->{ $tax_id } }, $cust_bill_pkg, $class;
1586 # determine any exemptions that apply
1587 if (!$tax_seen{$tax_id}) {
1588 $cust_bill_pkg->set_exemptions( $tax, custnum => $self->custnum );
1589 $tax_seen{$tax_id} = 1;
1592 # tax on tax will be done later, when we actually create the tax
1600 # INTERNAL TAX RATES (cust_main_county)
1602 # We fetch taxes even if the customer is completely exempt,
1603 # because we need to record that fact.
1605 my @loc_keys = qw( district city county state country );
1606 my %taxhash = map { $_ => $location->$_ } @loc_keys;
1608 $taxhash{'taxclass'} = $part_item->taxclass;
1610 warn "taxhash:\n". Dumper(\%taxhash) if $DEBUG > 2;
1612 my @taxes = (); # entries are cust_main_county objects
1613 my %taxhash_elim = %taxhash;
1614 my @elim = qw( district city county state );
1617 #first try a match with taxclass
1618 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1620 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1621 #then try a match without taxclass
1622 my %no_taxclass = %taxhash_elim;
1623 $no_taxclass{ 'taxclass' } = '';
1624 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1627 $taxhash_elim{ shift(@elim) } = '';
1629 } while ( !scalar(@taxes) && scalar(@elim) );
1632 my $tax_id = 'cust_main_county '.$_->taxnum;
1633 $taxlisthash->{$tax_id} ||= [ $_ ];
1634 $cust_bill_pkg->set_exemptions($_, custnum => $self->custnum);
1635 push @{ $taxlisthash->{$tax_id} }, $cust_bill_pkg;
1642 =item _gather_taxes PART_ITEM CLASS CUST_LOCATION
1644 Internal method used with vendor-provided tax tables. PART_ITEM is a part_pkg
1645 or part_fee (which will define the tax eligibility of the product), CLASS is
1646 'setup', 'recur', null, or a C<usage_class> number, and CUST_LOCATION is the
1647 location where the service was provided (or billed, depending on
1648 configuration). Returns an arrayref of L<FS::tax_rate> objects that
1649 can apply to this line item.
1655 my $part_item = shift;
1657 my $location = shift;
1659 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1661 my $geocode = $location->geocode('cch');
1663 [ $part_item->tax_rates('cch', $geocode, $class) ]
1667 #### end vestigial code ####
1669 =item collect [ HASHREF | OPTION => VALUE ... ]
1671 (Attempt to) collect money for this customer's outstanding invoices (see
1672 L<FS::cust_bill>). Usually used after the bill method.
1674 Actions are now triggered by billing events; see L<FS::part_event> and the
1675 billing events web interface. Old-style invoice events (see
1676 L<FS::part_bill_event>) have been deprecated.
1678 If there is an error, returns the error, otherwise returns false.
1680 Options are passed as name-value pairs.
1682 Currently available options are:
1688 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.
1692 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1696 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1700 set true to surpress email card/ACH decline notices.
1704 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)
1710 # allows for one time override of normal customer billing method
1715 my( $self, %options ) = @_;
1717 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1719 my $invoice_time = $options{'invoice_time'} || time;
1722 local $SIG{HUP} = 'IGNORE';
1723 local $SIG{INT} = 'IGNORE';
1724 local $SIG{QUIT} = 'IGNORE';
1725 local $SIG{TERM} = 'IGNORE';
1726 local $SIG{TSTP} = 'IGNORE';
1727 local $SIG{PIPE} = 'IGNORE';
1729 my $oldAutoCommit = $FS::UID::AutoCommit;
1730 local $FS::UID::AutoCommit = 0;
1733 $self->select_for_update; #mutex
1736 my $balance = $self->balance;
1737 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
1740 if ( exists($options{'retry_card'}) ) {
1741 carp 'retry_card option passed to collect is deprecated; use retry';
1742 $options{'retry'} ||= $options{'retry_card'};
1744 if ( exists($options{'retry'}) && $options{'retry'} ) {
1745 my $error = $self->retry_realtime;
1747 $dbh->rollback if $oldAutoCommit;
1752 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1754 #never want to roll back an event just because it returned an error
1755 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1757 $self->do_cust_event(
1758 'debug' => ( $options{'debug'} || 0 ),
1759 'time' => $invoice_time,
1760 'check_freq' => $options{'check_freq'},
1761 'stage' => 'collect',
1766 =item retry_realtime
1768 Schedules realtime / batch credit card / electronic check / LEC billing
1769 events for for retry. Useful if card information has changed or manual
1770 retry is desired. The 'collect' method must be called to actually retry
1773 Implementation details: For either this customer, or for each of this
1774 customer's open invoices, changes the status of the first "done" (with
1775 statustext error) realtime processing event to "failed".
1779 sub retry_realtime {
1782 local $SIG{HUP} = 'IGNORE';
1783 local $SIG{INT} = 'IGNORE';
1784 local $SIG{QUIT} = 'IGNORE';
1785 local $SIG{TERM} = 'IGNORE';
1786 local $SIG{TSTP} = 'IGNORE';
1787 local $SIG{PIPE} = 'IGNORE';
1789 my $oldAutoCommit = $FS::UID::AutoCommit;
1790 local $FS::UID::AutoCommit = 0;
1793 #a little false laziness w/due_cust_event (not too bad, really)
1795 # I guess this is always as of now?
1796 my $join = FS::part_event_condition->join_conditions_sql('', 'time' => time);
1797 my $order = FS::part_event_condition->order_conditions_sql;
1800 . join ( ' OR ' , map {
1801 my $cust_join = FS::part_event->eventtables_cust_join->{$_} || '';
1802 my $custnum = FS::part_event->eventtables_custnum->{$_};
1803 "( part_event.eventtable = " . dbh->quote($_)
1804 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key
1805 . " from $_ $cust_join"
1806 . " where $custnum = " . dbh->quote( $self->custnum ) . "))" ;
1807 } FS::part_event->eventtables)
1810 #here is the agent virtualization
1811 my $agent_virt = " ( part_event.agentnum IS NULL
1812 OR part_event.agentnum = ". $self->agentnum. ' )';
1814 #XXX this shouldn't be hardcoded, actions should declare it...
1815 my @realtime_events = qw(
1816 cust_bill_realtime_card
1817 cust_bill_realtime_check
1818 cust_bill_realtime_lec
1822 my $is_realtime_event =
1823 ' part_event.action IN ( '.
1824 join(',', map "'$_'", @realtime_events ).
1827 my $batch_or_statustext =
1828 "( part_event.action = 'cust_bill_batch'
1829 OR ( statustext IS NOT NULL AND statustext != '' )
1833 my @cust_event = qsearch({
1834 'table' => 'cust_event',
1835 'select' => 'cust_event.*',
1836 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
1837 'hashref' => { 'status' => 'done' },
1838 'extra_sql' => " AND $batch_or_statustext ".
1839 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
1842 my %seen_invnum = ();
1843 foreach my $cust_event (@cust_event) {
1845 #max one for the customer, one for each open invoice
1846 my $cust_X = $cust_event->cust_X;
1847 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
1851 or $cust_event->part_event->eventtable eq 'cust_bill'
1854 my $error = $cust_event->retry;
1856 $dbh->rollback if $oldAutoCommit;
1857 return "error scheduling event for retry: $error";
1862 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1867 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
1869 Runs billing events; see L<FS::part_event> and the billing events web
1872 If there is an error, returns the error, otherwise returns false.
1874 Options are passed as name-value pairs.
1876 Currently available options are:
1882 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.
1886 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1890 "collect" (the default) or "pre-bill"
1894 set true to surpress email card/ACH decline notices.
1898 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)
1905 # allows for one time override of normal customer billing method
1909 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1912 my( $self, %options ) = @_;
1914 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1916 my $time = $options{'time'} || time;
1919 local $SIG{HUP} = 'IGNORE';
1920 local $SIG{INT} = 'IGNORE';
1921 local $SIG{QUIT} = 'IGNORE';
1922 local $SIG{TERM} = 'IGNORE';
1923 local $SIG{TSTP} = 'IGNORE';
1924 local $SIG{PIPE} = 'IGNORE';
1926 my $oldAutoCommit = $FS::UID::AutoCommit;
1927 local $FS::UID::AutoCommit = 0;
1930 $self->select_for_update; #mutex
1933 my $balance = $self->balance;
1934 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
1937 # if ( exists($options{'retry_card'}) ) {
1938 # carp 'retry_card option passed to collect is deprecated; use retry';
1939 # $options{'retry'} ||= $options{'retry_card'};
1941 # if ( exists($options{'retry'}) && $options{'retry'} ) {
1942 # my $error = $self->retry_realtime;
1944 # $dbh->rollback if $oldAutoCommit;
1949 # false laziness w/pay_batch::import_results
1951 my $due_cust_event = $self->due_cust_event(
1952 'debug' => ( $options{'debug'} || 0 ),
1954 'check_freq' => $options{'check_freq'},
1955 'stage' => ( $options{'stage'} || 'collect' ),
1957 unless( ref($due_cust_event) ) {
1958 $dbh->rollback if $oldAutoCommit;
1959 return $due_cust_event;
1962 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1963 #never want to roll back an event just because it or a different one
1965 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1967 foreach my $cust_event ( @$due_cust_event ) {
1971 #re-eval event conditions (a previous event could have changed things)
1972 unless ( $cust_event->test_conditions ) {
1973 #don't leave stray "new/locked" records around
1974 my $error = $cust_event->delete;
1975 return $error if $error;
1980 local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
1981 if $options{'quiet'};
1982 warn " running cust_event ". $cust_event->eventnum. "\n"
1985 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
1986 if ( my $error = $cust_event->do_event( 'time' => $time ) ) {
1987 #XXX wtf is this? figure out a proper dealio with return value
1999 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
2001 Inserts database records for and returns an ordered listref of new events due
2002 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
2003 events are due, an empty listref is returned. If there is an error, returns a
2004 scalar error message.
2006 To actually run the events, call each event's test_condition method, and if
2007 still true, call the event's do_event method.
2009 Options are passed as a hashref or as a list of name-value pairs. Available
2016 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.
2020 "collect" (the default) or "pre-bill"
2024 "Current time" for the events.
2028 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)
2032 Only return events for the specified eventtable (by default, events of all eventtables are returned)
2036 Explicitly pass the objects to be tested (typically used with eventtable).
2040 Set to true to return the objects, but not actually insert them into the
2047 sub due_cust_event {
2049 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
2052 #my $DEBUG = $opt{'debug'}
2053 $opt{'debug'} ||= 0; # silence some warnings
2054 local($DEBUG) = $opt{'debug'}
2055 if $opt{'debug'} > $DEBUG;
2056 $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
2058 warn "$me due_cust_event called with options ".
2059 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
2062 $opt{'time'} ||= time;
2064 local $SIG{HUP} = 'IGNORE';
2065 local $SIG{INT} = 'IGNORE';
2066 local $SIG{QUIT} = 'IGNORE';
2067 local $SIG{TERM} = 'IGNORE';
2068 local $SIG{TSTP} = 'IGNORE';
2069 local $SIG{PIPE} = 'IGNORE';
2071 my $oldAutoCommit = $FS::UID::AutoCommit;
2072 local $FS::UID::AutoCommit = 0;
2075 $self->select_for_update #mutex
2076 unless $opt{testonly};
2079 # find possible events (initial search)
2082 my @cust_event = ();
2084 my @eventtable = $opt{'eventtable'}
2085 ? ( $opt{'eventtable'} )
2086 : FS::part_event->eventtables_runorder;
2088 my $check_freq = $opt{'check_freq'} || '1d';
2090 foreach my $eventtable ( @eventtable ) {
2093 if ( $opt{'objects'} ) {
2095 @objects = @{ $opt{'objects'} };
2097 } elsif ( $eventtable eq 'cust_main' ) {
2099 @objects = ( $self );
2103 my $cm_join = " LEFT JOIN cust_main USING ( custnum )";
2104 # linkage not needed here because FS::cust_main->$eventtable will
2107 #some false laziness w/Cron::bill bill_where
2109 my $join = FS::part_event_condition->join_conditions_sql( $eventtable,
2110 'time' => $opt{'time'});
2111 my $where = FS::part_event_condition->where_conditions_sql($eventtable,
2112 'time'=>$opt{'time'},
2114 $where = $where ? "AND $where" : '';
2116 my $are_part_event =
2117 "EXISTS ( SELECT 1 FROM part_event $join
2118 WHERE check_freq = '$check_freq'
2119 AND eventtable = '$eventtable'
2120 AND ( disabled = '' OR disabled IS NULL )
2126 @objects = $self->$eventtable(
2127 'addl_from' => $cm_join,
2128 'extra_sql' => " AND $are_part_event",
2130 } # if ( !$opt{objects} and $eventtable ne 'cust_main' )
2132 my @e_cust_event = ();
2134 my $linkage = FS::part_event->eventtables_cust_join->{$eventtable} || '';
2136 my $cross = "CROSS JOIN $eventtable $linkage";
2137 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
2138 unless $eventtable eq 'cust_main';
2140 foreach my $object ( @objects ) {
2142 #this first search uses the condition_sql magic for optimization.
2143 #the more possible events we can eliminate in this step the better
2145 my $cross_where = '';
2146 my $pkey = $object->primary_key;
2147 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
2149 my $join = FS::part_event_condition->join_conditions_sql( $eventtable,
2150 'time' => $opt{'time'});
2152 FS::part_event_condition->where_conditions_sql( $eventtable,
2153 'time'=>$opt{'time'}
2155 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
2157 $extra_sql = "AND $extra_sql" if $extra_sql;
2159 #here is the agent virtualization
2160 $extra_sql .= " AND ( part_event.agentnum IS NULL
2161 OR part_event.agentnum = ". $self->agentnum. ' )';
2163 $extra_sql .= " $order";
2165 warn "searching for events for $eventtable ". $object->$pkey. "\n"
2166 if $opt{'debug'} > 2;
2167 my @part_event = qsearch( {
2168 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
2169 'select' => 'part_event.*',
2170 'table' => 'part_event',
2171 'addl_from' => "$cross $join",
2172 'hashref' => { 'check_freq' => $check_freq,
2173 'eventtable' => $eventtable,
2176 'extra_sql' => "AND $cross_where $extra_sql",
2180 my $pkey = $object->primary_key;
2181 warn " ". scalar(@part_event).
2182 " possible events found for $eventtable ". $object->$pkey(). "\n";
2185 push @e_cust_event, map {
2186 $_->new_cust_event($object, 'time' => $opt{'time'})
2191 warn " ". scalar(@e_cust_event).
2192 " subtotal possible cust events found for $eventtable\n"
2195 push @cust_event, @e_cust_event;
2199 warn " ". scalar(@cust_event).
2200 " total possible cust events found in initial search\n"
2208 $opt{stage} ||= 'collect';
2210 grep { my $stage = $_->part_event->event_stage;
2211 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
2221 @cust_event = grep $_->test_conditions( 'stats_hashref' => \%unsat ),
2224 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
2227 warn " invalid conditions not eliminated with condition_sql:\n".
2228 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
2229 if keys %unsat && $DEBUG; # > 1;
2235 unless( $opt{testonly} ) {
2236 foreach my $cust_event ( @cust_event ) {
2238 my $error = $cust_event->insert();
2240 $dbh->rollback if $oldAutoCommit;
2247 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2253 warn " returning events: ". Dumper(@cust_event). "\n"
2260 =item apply_payments_and_credits [ OPTION => VALUE ... ]
2262 Applies unapplied payments and credits.
2263 Payments with the no_auto_apply flag set will not be applied.
2265 In most cases, this new method should be used in place of sequential
2266 apply_payments and apply_credits methods.
2268 A hash of optional arguments may be passed. Currently "manual" is supported.
2269 If true, a payment receipt is sent instead of a statement when
2270 'payment_receipt_email' configuration option is set.
2272 If there is an error, returns the error, otherwise returns false.
2276 sub apply_payments_and_credits {
2277 my( $self, %options ) = @_;
2279 local $SIG{HUP} = 'IGNORE';
2280 local $SIG{INT} = 'IGNORE';
2281 local $SIG{QUIT} = 'IGNORE';
2282 local $SIG{TERM} = 'IGNORE';
2283 local $SIG{TSTP} = 'IGNORE';
2284 local $SIG{PIPE} = 'IGNORE';
2286 my $oldAutoCommit = $FS::UID::AutoCommit;
2287 local $FS::UID::AutoCommit = 0;
2290 $self->select_for_update; #mutex
2292 foreach my $cust_bill ( $self->open_cust_bill ) {
2293 my $error = $cust_bill->apply_payments_and_credits(%options);
2295 $dbh->rollback if $oldAutoCommit;
2296 return "Error applying: $error";
2300 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2305 =item apply_credits OPTION => VALUE ...
2307 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
2308 to outstanding invoice balances in chronological order (or reverse
2309 chronological order if the I<order> option is set to B<newest>) and returns the
2310 value of any remaining unapplied credits available for refund (see
2311 L<FS::cust_refund>).
2313 Dies if there is an error.
2321 local $SIG{HUP} = 'IGNORE';
2322 local $SIG{INT} = 'IGNORE';
2323 local $SIG{QUIT} = 'IGNORE';
2324 local $SIG{TERM} = 'IGNORE';
2325 local $SIG{TSTP} = 'IGNORE';
2326 local $SIG{PIPE} = 'IGNORE';
2328 my $oldAutoCommit = $FS::UID::AutoCommit;
2329 local $FS::UID::AutoCommit = 0;
2332 $self->select_for_update; #mutex
2334 unless ( $self->total_unapplied_credits ) {
2335 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2339 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
2340 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
2342 my @invoices = $self->open_cust_bill;
2343 @invoices = sort { $b->_date <=> $a->_date } @invoices
2344 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
2346 if ( $conf->exists('pkg-balances') ) {
2347 # limit @credits to those w/ a pkgnum grepped from $self
2349 foreach my $i (@invoices) {
2350 foreach my $li ( $i->cust_bill_pkg ) {
2351 $pkgnums{$li->pkgnum} = 1;
2354 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
2359 foreach my $cust_bill ( @invoices ) {
2361 if ( !defined($credit) || $credit->credited == 0) {
2362 $credit = pop @credits or last;
2366 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
2367 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
2369 $owed = $cust_bill->owed;
2371 unless ( $owed > 0 ) {
2372 push @credits, $credit;
2376 my $amount = min( $credit->credited, $owed );
2378 my $cust_credit_bill = new FS::cust_credit_bill ( {
2379 'crednum' => $credit->crednum,
2380 'invnum' => $cust_bill->invnum,
2381 'amount' => $amount,
2383 $cust_credit_bill->pkgnum( $credit->pkgnum )
2384 if $conf->exists('pkg-balances') && $credit->pkgnum;
2385 my $error = $cust_credit_bill->insert;
2387 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2391 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2395 my $total_unapplied_credits = $self->total_unapplied_credits;
2397 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2399 return $total_unapplied_credits;
2402 =item apply_payments [ OPTION => VALUE ... ]
2404 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2405 to outstanding invoice balances in chronological order.
2406 Payments with the no_auto_apply flag set will not be applied.
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 = grep { !$_->no_auto_apply } $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)
2512 _omit_zero_value_bundles
2515 apply_payments_and_credits
2524 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>