1 package FS::cust_main::Billing;
5 use vars qw( $conf $DEBUG $me );
8 use List::Util qw( min );
10 use FS::Record qw( qsearch qsearchs dbdef );
11 use FS::Misc::DateTime qw( day_end );
14 use FS::cust_bill_pkg;
15 use FS::cust_bill_pkg_display;
16 use FS::cust_bill_pay;
17 use FS::cust_credit_bill;
18 use FS::cust_tax_adjustment;
20 use FS::tax_rate_location;
21 use FS::cust_bill_pkg_tax_location;
22 use FS::cust_bill_pkg_tax_rate_location;
24 use FS::part_event_condition;
26 use FS::FeeOrigin_Mixin;
29 use FS::Misc::Savepoint;
31 # 1 is mostly method/subroutine entry and options
32 # 2 traces progress of some operations
33 # 3 is even more information including possibly sensitive data
35 $me = '[FS::cust_main::Billing]';
37 install_callback FS::UID sub {
39 #yes, need it for stuff below (prolly should be cached)
44 FS::cust_main::Billing - Billing mixin for cust_main
50 These methods are available on FS::cust_main objects.
56 =item bill_and_collect
58 Cancels and suspends any packages due, generates bills, applies payments and
59 credits, and applies collection events to run cards, send bills and notices,
62 Any errors prevent subsequent operations from continuing and die (but see the
65 Options are passed as name-value pairs. Currently available options are:
71 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:
75 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
79 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.
83 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
87 If set true, re-charges setup fees.
91 If set any errors prevent subsequent operations from continusing. If set
92 specifically to "return", returns the error (or false, if there is no error).
93 Any other true value causes errors to die.
97 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)
101 Optional FS::queue entry to receive status updates.
105 Options are passed to the B<bill> and B<collect> methods verbatim, so all
106 options of those methods are also available.
110 sub bill_and_collect {
111 my( $self, %options ) = @_;
113 my $log = FS::Log->new('FS::cust_main::Billing::bill_and_collect');
114 my %logopt = (object => $self);
115 $log->debug('start', %logopt);
119 #$options{actual_time} not $options{time} because freeside-daily -d is for
120 #pre-printing invoices
122 $options{'actual_time'} ||= time;
123 my $job = $options{'job'};
125 my $actual_time = ( $conf->exists('next-bill-ignore-time')
126 ? day_end( $options{actual_time} )
127 : $options{actual_time}
130 $job->update_statustext('0,cleaning expired packages') if $job;
131 $log->debug('canceling expired packages', %logopt);
132 $error = $self->cancel_expired_pkgs( $actual_time );
134 $error = "Error expiring custnum ". $self->custnum. ": $error";
135 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
139 $log->debug('suspending adjourned packages', %logopt);
140 $error = $self->suspend_adjourned_pkgs( $actual_time );
142 $error = "Error adjourning custnum ". $self->custnum. ": $error";
143 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
147 $log->debug('unsuspending resumed packages', %logopt);
148 $error = $self->unsuspend_resumed_pkgs( $actual_time );
150 $error = "Error resuming custnum ".$self->custnum. ": $error";
151 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
155 my $tax_district_method = $conf->config('tax_district_method');
156 if ( $tax_district_method && $tax_district_method eq 'wa_sales' ) {
157 # When using Washington State Sales Tax Districts,
158 # Bail out of billing customer if sales tax district for location is missing
160 $log->debug('checking cust_location tax districts', %logopt);
163 my @cust_locations_missing_district =
164 $self->cust_locations_missing_district
167 'cust_location missing tax district: '.
172 'locationnum(%s) %s %s %s %s',
179 @cust_locations_missing_district
185 $error = "Error calculating taxes ".$self->custnum. ": $error";
186 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
190 $job->update_statustext('20,billing packages') if $job;
191 $log->debug('billing packages', %logopt);
192 $error = $self->bill( %options );
194 $error = "Error billing custnum ". $self->custnum. ": $error";
195 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
199 $job->update_statustext('50,applying payments and credits') if $job;
200 $log->debug('applying payments and credits', %logopt);
201 $error = $self->apply_payments_and_credits;
203 $error = "Error applying custnum ". $self->custnum. ": $error";
204 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
208 # In a batch tax environment, do not run collection if any pending
209 # invoices were created. Collection will run after the next tax batch.
210 state $is_batch_tax = FS::TaxEngine->new->info->{batch} ? 1 : 0;
211 if ( $is_batch_tax && $self->pending_invoice_count ) {
212 warn "skipped collection for custnum ".$self->custnum.
213 " due to pending invoices\n" if $DEBUG;
214 } elsif ( $conf->exists('cancelled_cust-noevents')
215 && ! $self->num_ncancelled_pkgs )
217 warn "skipped collection for custnum ".$self->custnum.
218 " because they have no active packages\n" if $DEBUG;
220 # run collection normally
221 $job->update_statustext('70,running collection events') if $job;
222 $log->debug('running collection events', %logopt);
223 $error = $self->collect( %options );
225 $error = "Error collecting custnum ". $self->custnum. ": $error";
226 if ($options{fatal} && $options{fatal} eq 'return') { return $error; }
231 $job->update_statustext('100,finished') if $job;
232 $log->debug('finish', %logopt);
238 sub cancel_expired_pkgs {
239 my ( $self, $time, %options ) = @_;
241 my @cancel_pkgs = $self->ncancelled_pkgs( {
242 'extra_sql' => " AND expire IS NOT NULL AND expire > 0 AND expire <= $time "
247 my @really_cancel_pkgs = ();
248 my @cancel_reasons = ();
250 CUST_PKG: foreach my $cust_pkg ( @cancel_pkgs ) {
251 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
253 if ( $cust_pkg->change_to_pkgnum ) {
255 my $new_pkg = FS::cust_pkg->by_key($cust_pkg->change_to_pkgnum);
257 push @errors, 'can\'t change pkgnum '.$cust_pkg->pkgnum.' to pkgnum '.
258 $cust_pkg->change_to_pkgnum.'; not expiring';
261 my $error = $cust_pkg->change( 'cust_pkg' => $new_pkg,
262 'unprotect_svcs' => 1,
264 push @errors, $error if $error && ref($error) ne 'FS::cust_pkg';
266 } else { # just cancel it
268 push @really_cancel_pkgs, $cust_pkg;
269 push @cancel_reasons, $cpr;
274 if (@really_cancel_pkgs) {
276 my %cancel_opt = ( 'cust_pkg' => \@really_cancel_pkgs,
277 'cust_pkg_reason' => \@cancel_reasons,
281 push @errors, $self->cancel_pkgs(%cancel_opt);
285 join(' / ', @errors);
289 sub suspend_adjourned_pkgs {
290 my ( $self, $time, %options ) = @_;
292 my @susp_pkgs = $self->ncancelled_pkgs( {
294 " AND ( susp IS NULL OR susp = 0 )
295 AND ( ( bill IS NOT NULL AND bill != 0 AND bill < $time )
296 OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
301 #only because there's no SQL test for is_prepaid :/
303 grep { ( $_->part_pkg->is_prepaid
308 && $_->adjourn <= $time
316 foreach my $cust_pkg ( @susp_pkgs ) {
317 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
318 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
319 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
320 'reason_otaker' => $cpr->otaker
324 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
327 join(' / ', @errors);
331 sub unsuspend_resumed_pkgs {
332 my ( $self, $time, %options ) = @_;
334 my @unsusp_pkgs = $self->ncancelled_pkgs( {
335 'extra_sql' => " AND resume IS NOT NULL AND resume > 0 AND resume <= $time "
340 foreach my $cust_pkg ( @unsusp_pkgs ) {
341 my $error = $cust_pkg->unsuspend( 'time' => $time );
342 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
345 join(' / ', @errors);
351 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
352 conjunction with the collect method by calling B<bill_and_collect>.
354 If there is an error, returns the error, otherwise returns false.
356 Options are passed as name-value pairs. Currently available options are:
362 If set true, re-charges setup fees.
366 If set true then only bill recurring charges, not setup, usage, one time
371 If set, then override the normal frequency and look for a part_pkg_discount
372 to take at that frequency. This is appropriate only when the normal
373 frequency for all packages is monthly, and is an error otherwise. Use
374 C<pkg_list> to limit the set of packages included in billing.
378 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:
382 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
386 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
388 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
392 A hashref of pkgparts to exclude from this billing run (can also be specified as a comma-separated scalar).
396 Do not bill prepaid packages. Used by freeside-daily.
400 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.
404 This boolean value informs the us that the package is being cancelled. This
405 typically might mean not charging the normal recurring fee but only usage
406 fees since the last billing. Setup charges may be charged. Not all package
407 plans support this feature (they tend to charge 0).
411 Prevent the resetting of usage limits during this call.
415 Do not save the generated bill in the database. Useful with return_bill
419 A list reference on which the generated bill(s) will be returned.
423 Boolean value; indicates that this is an estimate rather than a "tax invoice".
424 This will be passed through to the tax engine, as online tax services
425 sometimes need to know it for reporting purposes. Otherwise it has no effect.
429 Optional terms to be printed on this invoice. Otherwise, customer-specific
430 terms or the default terms are used.
437 my( $self, %options ) = @_;
439 return '' if $self->complimentary eq 'Y';
441 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
442 my $log = FS::Log->new('FS::cust_main::Billing::bill');
443 my %logopt = (object => $self);
445 $log->debug('start', %logopt);
446 warn "$me bill customer ". $self->custnum. "\n"
449 my $time = $options{'time'} || time;
450 my $invoice_time = $options{'invoice_time'} || $time;
452 my $cmp_time = ( $conf->exists('next-bill-ignore-time')
457 $options{'not_pkgpart'} ||= {};
458 $options{'not_pkgpart'} = { map { $_ => 1 }
459 split(/\s*,\s*/, $options{'not_pkgpart'})
461 unless ref($options{'not_pkgpart'});
463 local $SIG{HUP} = 'IGNORE';
464 local $SIG{INT} = 'IGNORE';
465 local $SIG{QUIT} = 'IGNORE';
466 local $SIG{TERM} = 'IGNORE';
467 local $SIG{TSTP} = 'IGNORE';
468 local $SIG{PIPE} = 'IGNORE';
470 my $oldAutoCommit = $FS::UID::AutoCommit;
471 local $FS::UID::AutoCommit = 0;
474 $log->debug('acquiring lock', %logopt);
475 warn "$me acquiring lock on customer ". $self->custnum. "\n"
478 $self->select_for_update; #mutex
480 $log->debug('running pre-bill events', %logopt);
481 warn "$me running pre-bill events for customer ". $self->custnum. "\n"
484 my $error = $self->do_cust_event(
485 'debug' => ( $options{'debug'} || 0 ),
486 'time' => $invoice_time,
487 'check_freq' => $options{'check_freq'},
488 'stage' => 'pre-bill',
490 unless $options{no_commit};
492 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
496 $log->debug('done running pre-bill events', %logopt);
497 warn "$me done running pre-bill events for customer ". $self->custnum. "\n"
500 #keep auto-charge and non-auto-charge line items separate
501 my @passes = ( '', 'no_auto' );
503 my %cust_bill_pkg = map { $_ => [] } @passes;
506 # find the packages which are due for billing, find out how much they are
507 # & generate invoice database.
510 my %total_setup = map { my $z = 0; $_ => \$z; } @passes;
511 my %total_recur = map { my $z = 0; $_ => \$z; } @passes;
513 my @precommit_hooks = ();
515 $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ]; #param checks?
518 my $tax_is_batch = '';
520 $tax_engines{$_} = FS::TaxEngine->new(cust_main => $self,
521 invoice_time => $invoice_time,
522 cancel => $options{cancel},
523 estimate => $options{estimate},
525 $tax_is_batch ||= $tax_engines{$_}->info->{batch};
528 foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
530 next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
532 my $part_pkg = $cust_pkg->part_pkg;
534 next if $options{'no_prepaid'} && $part_pkg->is_prepaid;
536 $log->debug('bill package '. $cust_pkg->pkgnum, %logopt);
537 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG;
539 #? to avoid use of uninitialized value errors... ?
540 $cust_pkg->setfield('bill', '')
541 unless defined($cust_pkg->bill);
543 my $real_pkgpart = $cust_pkg->pkgpart;
544 my %hash = $cust_pkg->hash;
546 # we could implement this bit as FS::part_pkg::has_hidden, but we already
547 # suffer from performance issues
548 $options{has_hidden} = 0;
549 my @part_pkg = $part_pkg->self_and_bill_linked;
550 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
552 # if this package was changed from another package,
553 # and it hasn't been billed since then,
554 # and package balances are enabled,
555 if ( $cust_pkg->change_pkgnum
556 and $cust_pkg->change_date >= ($cust_pkg->last_bill || 0)
557 and $cust_pkg->change_date < $invoice_time
558 and $conf->exists('pkg-balances') )
560 # _transfer_balance will also create the appropriate credit
561 my @transfer_items = $self->_transfer_balance($cust_pkg);
562 # $part_pkg[0] is the "real" part_pkg
563 my $pass = ($cust_pkg->no_auto || $part_pkg[0]->no_auto) ?
565 push @{ $cust_bill_pkg{$pass} }, @transfer_items;
566 # treating this as recur, just because most charges are recur...
567 ${$total_recur{$pass}} += $_->recur foreach @transfer_items;
569 # currently not considering separate_bill here, as it's for
570 # one-time charges only
573 foreach my $part_pkg ( @part_pkg ) {
575 my $this_cust_pkg = $cust_pkg;
576 # for add-on packages, copy the object to avoid leaking changes back to
577 # the caller if pkg_list is in use; see RT#73607
578 if ( $part_pkg->get('pkgpart') != $real_pkgpart ) {
579 $this_cust_pkg = FS::cust_pkg->new({ %hash });
583 if ( $this_cust_pkg->separate_bill ) {
584 # if no_auto is also set, that's fine. we just need to not have
585 # invoices that are both auto and no_auto, and since the package
586 # gets an invoice all to itself, it will only be one or the other.
587 $pass = $this_cust_pkg->pkgnum;
588 if (!exists $cust_bill_pkg{$pass}) { # it may not exist yet
590 $total_setup{$pass} = do { my $z = 0; \$z };
591 $total_recur{$pass} = do { my $z = 0; \$z };
592 # it also needs its own tax context
593 $tax_engines{$pass} = FS::TaxEngine->new(
595 invoice_time => $invoice_time,
596 cancel => $options{cancel},
597 estimate => $options{estimate},
599 $cust_bill_pkg{$pass} = [];
601 } elsif ( ($this_cust_pkg->no_auto || $part_pkg->no_auto) ) {
605 my $next_bill = $this_cust_pkg->getfield('bill') || 0;
607 # let this run once if this is the last bill upon cancellation
608 while ( $next_bill <= $cmp_time or $options{cancel} ) {
610 $self->_make_lines( 'part_pkg' => $part_pkg,
611 'cust_pkg' => $this_cust_pkg,
612 'precommit_hooks' => \@precommit_hooks,
613 'line_items' => $cust_bill_pkg{$pass},
614 'setup' => $total_setup{$pass},
615 'recur' => $total_recur{$pass},
616 'tax_engine' => $tax_engines{$pass},
618 'real_pkgpart' => $real_pkgpart,
619 'options' => \%options,
622 # Stop if anything goes wrong
625 # or if we're not incrementing the bill date.
626 last if ($this_cust_pkg->getfield('bill') || 0) == $next_bill;
628 # or if we're letting it run only once
629 last if $options{cancel};
631 $next_bill = $this_cust_pkg->getfield('bill') || 0;
633 #stop if -o was passed to freeside-daily
634 last if $options{'one_recur'};
637 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
641 } #foreach my $part_pkg
643 } #foreach my $cust_pkg
645 foreach my $pass (@passes) { # keys %cust_bill_pkg )
647 my @cust_bill_pkg = _omit_zero_value_bundles(@{ $cust_bill_pkg{$pass} });
649 warn "$me billing pass $pass\n"
650 #.Dumper(\@cust_bill_pkg)."\n"
657 my @pending_fees = FS::FeeOrigin_Mixin->by_cust($self->custnum,
658 hashref => { 'billpkgnum' => '' }
660 warn "$me found pending fees:\n".Dumper(\@pending_fees)."\n"
661 if @pending_fees and $DEBUG > 1;
663 # determine whether to generate an invoice
664 my $generate_bill = scalar(@cust_bill_pkg) > 0;
666 foreach my $fee (@pending_fees) {
667 $generate_bill = 1 unless $fee->nextbill;
670 # don't create an invoice with no line items, or where the only line
671 # items are fees that are supposed to be held until the next invoice
672 next if !$generate_bill;
676 foreach my $fee_origin (@pending_fees) {
677 my $part_fee = $fee_origin->part_fee;
679 # check whether the fee is applicable before doing anything expensive:
681 # if the fee def belongs to a different agent, don't charge the fee.
682 # event conditions should prevent this, but just in case they don't,
684 if ( $part_fee->agentnum and $part_fee->agentnum != $self->agentnum ) {
685 warn "tried to charge fee#".$part_fee->feepart .
686 " on customer#".$self->custnum." from a different agent.\n";
689 # also skip if it's disabled
690 next if $part_fee->disabled eq 'Y';
692 # Decide which invoice to base the fee on.
693 my $cust_bill = $fee_origin->cust_bill;
695 # Then link it to the current invoice. This isn't the real cust_bill
696 # object that will be inserted--in particular there are no taxes yet.
697 # If you want to charge a fee on the total invoice amount including
698 # taxes, you have to put the fee on the next invoice.
699 $cust_bill = FS::cust_bill->new({
700 'custnum' => $self->custnum,
701 'cust_bill_pkg' => \@cust_bill_pkg,
702 'charged' => ${ $total_setup{$pass} } +
703 ${ $total_recur{$pass} },
706 # If the origin is for a specific package, then only apply the fee to
707 # line items from that package.
708 if ( my $cust_pkg = $fee_origin->cust_pkg ) {
709 my @charge_fee_on_item;
710 my $charge_fee_on_amount = 0;
711 foreach (@cust_bill_pkg) {
712 if ($_->pkgnum == $cust_pkg->pkgnum) {
713 push @charge_fee_on_item, $_;
714 $charge_fee_on_amount += $_->setup + $_->recur;
717 $cust_bill->set('cust_bill_pkg', \@charge_fee_on_item);
718 $cust_bill->set('charged', $charge_fee_on_amount);
721 } # $cust_bill is now set
723 my $fee_item = $part_fee->lineitem($cust_bill) or next;
724 # link this so that we can clear the marker on inserting the line item
725 $fee_item->set('fee_origin', $fee_origin);
726 push @fee_items, $fee_item;
730 # add fees to the invoice
731 foreach my $fee_item (@fee_items) {
733 push @cust_bill_pkg, $fee_item;
734 ${ $total_setup{$pass} } += $fee_item->setup;
735 ${ $total_recur{$pass} } += $fee_item->recur;
737 my $part_fee = $fee_item->part_fee;
738 my $fee_location = $self->ship_location; # I think?
740 my $error = $tax_engines{''}->add_sale($fee_item);
742 return $error if $error;
746 # XXX implementation of fees is supposed to make this go away...
747 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
748 !$conf->exists('postal_invoice-recurring_only')
752 my $postal_pkg = $self->charge_postal_fee();
753 if ( $postal_pkg && !ref( $postal_pkg ) ) {
755 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
756 return "can't charge postal invoice fee for customer ".
757 $self->custnum. ": $postal_pkg";
759 } elsif ( $postal_pkg ) {
761 my $real_pkgpart = $postal_pkg->pkgpart;
762 # we could implement this bit as FS::part_pkg::has_hidden, but we already
763 # suffer from performance issues
764 $options{has_hidden} = 0;
765 my @part_pkg = $postal_pkg->part_pkg->self_and_bill_linked;
766 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
768 foreach my $part_pkg ( @part_pkg ) {
769 my %postal_options = %options;
770 delete $postal_options{cancel};
772 $self->_make_lines( 'part_pkg' => $part_pkg,
773 'cust_pkg' => $postal_pkg,
774 'precommit_hooks' => \@precommit_hooks,
775 'line_items' => \@cust_bill_pkg,
776 'setup' => $total_setup{$pass},
777 'recur' => $total_recur{$pass},
778 'tax_engine' => $tax_engines{$pass},
780 'real_pkgpart' => $real_pkgpart,
781 'options' => \%postal_options,
784 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
789 # it's silly to have a zero value postal_pkg, but....
790 @cust_bill_pkg = _omit_zero_value_bundles(@cust_bill_pkg);
797 #XXX does this work with batch tax engines?
798 warn "adding tax adjustments...\n" if $DEBUG > 2;
799 foreach my $cust_tax_adjustment (
800 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
806 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
808 my $itemdesc = $cust_tax_adjustment->taxname;
809 $itemdesc = '' if $itemdesc eq 'Tax';
811 push @cust_bill_pkg, new FS::cust_bill_pkg {
817 'itemdesc' => $itemdesc,
818 'itemcomment' => $cust_tax_adjustment->comment,
819 'cust_tax_adjustment' => $cust_tax_adjustment,
820 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
825 my $charged = sprintf('%.2f', ${ $total_setup{$pass} } + ${ $total_recur{$pass} } );
827 my $balance = $self->balance;
829 my $previous_bill = qsearchs({ 'table' => 'cust_bill',
830 'hashref' => { custnum=>$self->custnum },
831 'extra_sql' => 'ORDER BY _date DESC LIMIT 1',
833 my $previous_balance =
835 ? ( $previous_bill->billing_balance + $previous_bill->charged )
838 $log->debug('creating the new invoice', %logopt);
839 warn "creating the new invoice\n" if $DEBUG;
840 #create the new invoice
841 my $cust_bill = new FS::cust_bill ( {
842 'custnum' => $self->custnum,
843 '_date' => $invoice_time,
844 'charged' => $charged,
845 'billing_balance' => $balance,
846 'previous_balance' => $previous_balance,
847 'invoice_terms' => $options{'invoice_terms'},
848 'cust_bill_pkg' => \@cust_bill_pkg,
849 'pending' => 'Y', # clear this after doing taxes
852 if (!$options{no_commit}) {
853 # probably we ought to insert it as pending, and then rollback
854 # without ever un-pending it
855 $error = $cust_bill->insert;
857 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
858 return "can't create invoice for customer #". $self->custnum. ": $error";
863 # calculate and append taxes
864 if ( ! $tax_is_batch) {
866 my $arrayref = eval { $tax_engines{$pass}->calculate_taxes($cust_bill) };
869 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
873 # or should this be in TaxEngine?
875 foreach my $taxline ( @$arrayref ) {
876 $total_tax += $taxline->setup;
877 $taxline->set('invnum' => $cust_bill->invnum); # just to be sure
878 push @cust_bill_pkg, $taxline; # for return_bill
880 if (!$options{no_commit}) {
881 my $error = $taxline->insert;
883 $dbh->rollback if $oldAutoCommit;
890 # add tax to the invoice amount and finalize it
891 ${ $total_setup{$pass} } = sprintf('%.2f', ${ $total_setup{$pass} } + $total_tax);
892 $charged = sprintf('%.2f', $charged + $total_tax);
893 $cust_bill->set('charged', $charged);
894 $cust_bill->set('pending', '');
896 if (!$options{no_commit}) {
897 my $error = $cust_bill->replace;
899 $dbh->rollback if $oldAutoCommit;
904 } # if !$tax_is_batch
905 # if it IS batch, then we'll do all this in process_tax_batch
907 push @{$options{return_bill}}, $cust_bill if $options{return_bill};
909 } #foreach my $pass ( keys %cust_bill_pkg )
911 foreach my $hook ( @precommit_hooks ) {
914 } unless $options{no_commit};
916 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
917 return "$@ running precommit hook $hook\n";
921 $dbh->commit or die $dbh->errstr if $oldAutoCommit && !$options{no_commit};
926 #discard bundled packages of 0 value
927 # XXX we should reconsider whether we even need this
928 sub _omit_zero_value_bundles {
933 my $discount_show_always = $conf->exists('discount-show-always');
936 # Sort @in the same way we do during invoice rendering, so we can identify
937 # bundles. See FS::Template_Mixin::_items_nontax.
938 @in = sort { $a->pkgnum <=> $b->pkgnum or
939 $a->sdate <=> $b->sdate or
940 ($a->pkgpart_override ? 0 : -1) or
941 ($b->pkgpart_override ? 0 : 1) or
942 $b->hidden cmp $a->hidden or
943 $a->pkgpart_override <=> $b->pkgpart_override
946 # this is a pack-and-deliver pattern. every time there's a cust_bill_pkg
947 # _without_ pkgpart_override, that's the start of the new bundle. if there's
948 # an existing bundle, and it contains a nonzero amount (or a zero amount
949 # that's displayable anyway), push all line items in the bundle.
950 foreach my $cust_bill_pkg ( @in ) {
952 if (scalar(@bundle) and !$cust_bill_pkg->pkgpart_override) {
953 # ship out this bundle and reset it
961 # add this item to the current bundle
962 push @bundle, $cust_bill_pkg;
964 # determine if it makes the bundle displayable
965 if ( $cust_bill_pkg->setup > 0
966 or $cust_bill_pkg->recur > 0
967 or $cust_bill_pkg->setup_show_zero
968 or $cust_bill_pkg->recur_show_zero
969 or ($discount_show_always
970 and scalar(@{ $cust_bill_pkg->get('discounts')})
982 warn " _omit_zero_value_bundles: ". scalar(@in).
983 '->'. scalar(@out). "\n" #. Dumper(@out). "\n"
990 my ($self, %params) = @_;
992 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
994 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
995 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
996 my $cust_location = $cust_pkg->tax_location;
997 my $precommit_hooks = $params{precommit_hooks} or die "no precommit_hooks specified";
998 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
999 my $total_setup = $params{setup} or die "no setup accumulator specified";
1000 my $total_recur = $params{recur} or die "no recur accumulator specified";
1001 my $time = $params{'time'} or die "no time specified";
1002 my (%options) = %{$params{options}};
1004 my $tax_engine = $params{tax_engine};
1006 if ( $part_pkg->freq ne '1' and ($options{'freq_override'} || 0) > 0 ) {
1007 # this should never happen
1008 die 'freq_override billing attempted on non-monthly package '.
1013 my $real_pkgpart = $params{real_pkgpart};
1014 my %hash = $cust_pkg->hash;
1015 my $old_cust_pkg = new FS::cust_pkg \%hash;
1020 $cust_pkg->pkgpart($part_pkg->pkgpart);
1022 my $cmp_time = ( $conf->exists('next-bill-ignore-time')
1033 my @setup_discounts = ();
1034 my %setup_param = ( 'discounts' => \@setup_discounts,
1035 'real_pkgpart' => $params{real_pkgpart}
1037 my $setup_billed_currency = '';
1038 my $setup_billed_amount = 0;
1039 # Conditions for setting setup date and charging the setup fee:
1040 # - this is not a recurring-only billing run
1041 # - and the package is not currently being canceled
1042 # - and, unless we're specifically told otherwise via 'resetup':
1043 # - it doesn't already HAVE a setup date
1044 # - or a start date in the future
1045 # - and it's not suspended
1046 # - and it doesn't have an expire date in the past
1048 # The "disable_setup_suspended" option is now obsolete; we never set the
1049 # setup date on a suspended package.
1050 if ( ! $options{recurring_only}
1051 and ! $options{cancel}
1052 and ( $options{'resetup'}
1053 || ( ! $cust_pkg->setup
1054 && ( ! $cust_pkg->start_date
1055 || $cust_pkg->start_date <= $cmp_time
1057 && ( ! $cust_pkg->getfield('susp') )
1060 and ( ! $cust_pkg->expire
1061 || $cust_pkg->expire > $cmp_time )
1065 warn " bill setup\n" if $DEBUG > 1;
1067 unless ( $cust_pkg->waive_setup ) {
1070 $setup = eval { $cust_pkg->calc_setup( $time, \@details, \%setup_param ) };
1071 return "$@ running calc_setup for $cust_pkg\n"
1074 # Only increment unitsetup here if there IS a setup fee.
1075 # prorate_defer_bill may cause calc_setup on a setup-stage package
1076 # to return zero, and the setup fee to be charged later. (This happens
1077 # when it's first billed on the prorate cutoff day. RT#31276.)
1079 $unitsetup = $cust_pkg->base_setup()
1083 if ( $setup_param{'billed_currency'} ) {
1084 $setup_billed_currency = delete $setup_param{'billed_currency'};
1085 $setup_billed_amount = delete $setup_param{'billed_amount'};
1090 if $cust_pkg->waive_setup
1091 && $part_pkg->can('prorate_setup')
1092 && $part_pkg->prorate_setup($cust_pkg, $time);
1094 if ( $cust_pkg->get('setup') ) {
1096 } elsif ( $cust_pkg->get('start_date') ) {
1097 # this allows start_date to be used to set the first bill date
1098 $cust_pkg->set('setup', $cust_pkg->get('start_date'));
1100 # if unspecified, start it right now
1101 $cust_pkg->set('setup', $time);
1104 $cust_pkg->setfield('start_date', '')
1105 if $cust_pkg->start_date;
1110 # bill recurring fee
1115 my @recur_discounts = ();
1116 my $recur_billed_currency = '';
1117 my $recur_billed_amount = 0;
1120 my $override_quantity;
1122 # Conditions for billing the recurring fee:
1123 # - the package doesn't have a future start date
1124 # - and it's not suspended
1125 # - unless suspend_bill is enabled on the package or package def
1126 # - but still not, if the package is on hold
1127 # - or it's suspended for a delayed cancellation
1128 # - and its next bill date is in the past
1129 # - or it doesn't have a next bill date yet
1130 # - or it's a one-time charge
1131 # - or it's a CDR plan with the "bill_every_call" option
1132 # - or it's being canceled
1133 # - and it doesn't have an expire date in the past (this can happen with
1135 # - again, unless it's being canceled
1136 if ( ! $cust_pkg->start_date
1139 || ( $cust_pkg->susp != $cust_pkg->order_date
1140 && ( $cust_pkg->option('suspend_bill',1)
1141 || ( $part_pkg->option('suspend_bill', 1)
1142 && ! $cust_pkg->option('no_suspend_bill',1)
1146 || $cust_pkg->is_status_delay_cancel
1149 ( $part_pkg->freq ne '0' && ( $cust_pkg->bill || 0 ) <= $cmp_time )
1150 || ( $part_pkg->plan eq 'voip_cdr'
1151 && $part_pkg->option('bill_every_call')
1156 ( ! $cust_pkg->expire
1157 || $cust_pkg->expire > $cmp_time
1162 # XXX should this be a package event? probably. events are called
1163 # at collection time at the moment, though...
1164 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
1165 if $part_pkg->can('reset_usage') && !$options{'no_usage_reset'};
1166 #don't want to reset usage just cause we want a line item??
1167 #&& $part_pkg->pkgpart == $real_pkgpart;
1169 warn " bill recur\n" if $DEBUG > 1;
1172 # XXX shared with $recur_prog
1173 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
1177 #over two params! lets at least switch to a hashref for the rest...
1178 my $increment_next_bill = ( $part_pkg->freq ne '0'
1179 && ( $cust_pkg->getfield('bill') || 0 ) <= $cmp_time
1180 && !$options{cancel}
1182 my %param = ( %setup_param,
1183 'precommit_hooks' => $precommit_hooks,
1184 'increment_next_bill' => $increment_next_bill,
1185 'discounts' => \@recur_discounts,
1186 'real_pkgpart' => $real_pkgpart,
1187 'freq_override' => $options{freq_override} || '',
1191 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
1193 # There may be some part_pkg for which this is wrong. Only those
1194 # which can_discount are supported.
1195 # (the UI should prevent adding discounts to these at the moment)
1197 warn "calling $method on cust_pkg ". $cust_pkg->pkgnum.
1198 " for pkgpart ". $cust_pkg->pkgpart.
1199 " with params ". join(' / ', map "$_=>$param{$_}", keys %param). "\n"
1202 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
1203 return "$@ running $method for $cust_pkg\n"
1206 if ($recur eq 'NOTHING') {
1207 # then calc_cancel (or calc_recur but that's not used) has declined to
1208 # generate a recurring lineitem at all. treat this as zero, but also
1209 # try not to generate a lineitem.
1215 $unitrecur = $cust_pkg->base_recur( \$sdate ) || $recur; #XXX uuh, better
1217 if ( $param{'billed_currency'} ) {
1218 $recur_billed_currency = delete $param{'billed_currency'};
1219 $recur_billed_amount = delete $param{'billed_amount'};
1222 if ( $param{'override_quantity'} ) {
1223 $override_quantity = $param{'override_quantity'};
1224 $unitrecur = $recur / $override_quantity;
1227 if ( $increment_next_bill ) {
1231 if ( my $main_pkg = $cust_pkg->main_pkg ) {
1232 # supplemental package
1233 # to keep in sync with the main package, simulate billing at
1235 my $main_pkg_freq = $main_pkg->part_pkg->freq;
1236 my $supp_pkg_freq = $part_pkg->freq;
1237 if ( $supp_pkg_freq == 0 or $main_pkg_freq == 0 ) {
1238 # the UI should prevent setting up packages like this, but just
1240 return "unable to calculate supplemental package period ratio";
1242 my $ratio = $supp_pkg_freq / $main_pkg_freq;
1243 if ( $ratio == int($ratio) ) {
1244 # simple case: main package is X months, supp package is X*A months,
1245 # advance supp package to where the main package will be in A cycles.
1246 $next_bill = $sdate;
1248 $next_bill = $part_pkg->add_freq( $next_bill, $main_pkg_freq );
1251 # harder case: main package is X months, supp package is Y months.
1252 # advance supp package by Y months. then if they're within half a
1253 # month of each other, resync them. this may result in the period
1254 # not being exactly Y months.
1255 $next_bill = $part_pkg->add_freq( $sdate, $supp_pkg_freq );
1256 my $main_next_bill = $main_pkg->bill;
1257 if ( $main_pkg->bill <= $time ) {
1258 # then the main package has not yet been billed on this cycle;
1259 # predict what its bill date will be.
1261 $part_pkg->add_freq( $main_next_bill, $main_pkg_freq );
1263 if ( abs($main_next_bill - $next_bill) < 86400*15 ) {
1264 $next_bill = $main_next_bill;
1269 # the normal case, not a supplemental package
1270 $next_bill = $part_pkg->add_freq($sdate, $options{freq_override} || 0);
1271 return "unparsable frequency: ".
1272 ($options{freq_override} || $part_pkg->freq)
1273 if $next_bill == -1;
1276 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
1277 # only for figuring next bill date, nothing else, so, reset $sdate again
1279 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1280 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
1281 $cust_pkg->last_bill($sdate);
1283 $cust_pkg->setfield('bill', $next_bill );
1287 if ( $param{'setup_fee'} ) {
1288 # Add an additional setup fee at the billing stage.
1289 # Used for prorate_defer_bill.
1290 $setup += $param{'setup_fee'};
1291 $unitsetup = $cust_pkg->base_setup();
1295 if ( defined $param{'discount_left_setup'} ) {
1296 foreach my $discount_setup ( values %{$param{'discount_left_setup'}} ) {
1297 $setup -= $discount_setup;
1301 } # end of recurring fee
1303 warn "\$setup is undefined" unless defined($setup);
1304 warn "\$recur is undefined" unless defined($recur);
1305 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1308 # If there's line items, create em cust_bill_pkg records
1309 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
1314 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
1315 # hmm.. and if just the options are modified in some weird price plan?
1317 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
1320 my $error = $cust_pkg->replace( $old_cust_pkg,
1321 'depend_jobnum'=>$options{depend_jobnum},
1322 'options' => { $cust_pkg->options },
1324 unless $options{no_commit};
1325 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
1326 if $error; #just in case
1329 $setup = sprintf( "%.2f", $setup );
1330 $recur = sprintf( "%.2f", $recur );
1331 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
1332 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1334 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
1335 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
1338 my $discount_show_always = $conf->exists('discount-show-always')
1339 && ( ($setup == 0 && scalar(@setup_discounts))
1340 || ($recur == 0 && scalar(@recur_discounts))
1345 || (!$part_pkg->hidden && $options{has_hidden}) #include some $0 lines
1346 || $discount_show_always
1347 || ($setup == 0 && $cust_pkg->_X_show_zero('setup'))
1348 || ($recur == 0 && $cust_pkg->_X_show_zero('recur'))
1352 warn " charges (setup=$setup, recur=$recur); adding line items\n"
1355 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
1357 warn " adding customer package invoice detail: $_\n"
1358 foreach @cust_pkg_detail;
1360 push @details, @cust_pkg_detail;
1362 my $cust_bill_pkg = new FS::cust_bill_pkg {
1363 'pkgnum' => $cust_pkg->pkgnum,
1365 'unitsetup' => sprintf('%.2f', $unitsetup),
1366 'setup_billed_currency' => $setup_billed_currency,
1367 'setup_billed_amount' => $setup_billed_amount,
1369 'unitrecur' => sprintf('%.2f', $unitrecur),
1370 'recur_billed_currency' => $recur_billed_currency,
1371 'recur_billed_amount' => $recur_billed_amount,
1372 'quantity' => $override_quantity || $cust_pkg->quantity,
1373 'details' => \@details,
1374 'discounts' => [ @setup_discounts, @recur_discounts ],
1375 'hidden' => $part_pkg->hidden,
1376 'freq' => $part_pkg->freq,
1379 if ( $part_pkg->option('prorate_defer_bill',1)
1380 and !$hash{last_bill} ) {
1381 # both preceding and upcoming, technically
1382 $cust_bill_pkg->sdate( $cust_pkg->setup );
1383 $cust_bill_pkg->edate( $cust_pkg->bill );
1384 } elsif ( $part_pkg->recur_temporality eq 'preceding' ) {
1385 $cust_bill_pkg->sdate( $hash{last_bill} );
1386 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
1387 $cust_bill_pkg->edate( $time ) if $options{cancel};
1388 } else { #if ( $part_pkg->recur_temporality eq 'upcoming' )
1389 $cust_bill_pkg->sdate( $sdate );
1390 $cust_bill_pkg->edate( $cust_pkg->bill );
1391 #$cust_bill_pkg->edate( $time ) if $options{cancel};
1394 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
1395 unless $part_pkg->pkgpart == $real_pkgpart;
1397 $$total_setup += $setup;
1398 $$total_recur += $recur;
1404 my $error = $tax_engine->add_sale($cust_bill_pkg);
1405 return $error if $error;
1407 $cust_bill_pkg->set_display(
1408 part_pkg => $part_pkg,
1409 real_pkgpart => $real_pkgpart,
1412 push @$cust_bill_pkgs, $cust_bill_pkg;
1414 } #if $setup != 0 || $recur != 0
1422 =item _transfer_balance TO_PKG [ FROM_PKGNUM ]
1424 Takes one argument, a cust_pkg object that is being billed. This will
1425 be called only if the package was created by a package change, and has
1426 not been billed since the package change, and package balance tracking
1427 is enabled. The second argument can be an alternate package number to
1428 transfer the balance from; this should not be used externally.
1430 Transfers the balance from the previous package (now canceled) to
1431 this package, by crediting one package and creating an invoice item for
1432 the other. Inserts the credit and returns the invoice item (so that it
1433 can be added to an invoice that's being built).
1435 If the previous package was never billed, and was also created by a package
1436 change, then this will also transfer the balance from I<its> previous
1437 package, and so on, until reaching a package that either has been billed
1438 or was not created by a package change.
1442 my $balance_transfer_reason;
1444 sub _transfer_balance {
1446 my $cust_pkg = shift;
1447 my $from_pkgnum = shift || $cust_pkg->change_pkgnum;
1448 my $from_pkg = FS::cust_pkg->by_key($from_pkgnum);
1452 # if $from_pkg is not the first package in the chain, and it was never
1454 if ( $from_pkg->change_pkgnum and scalar($from_pkg->cust_bill_pkg) == 0 ) {
1455 @transfers = $self->_transfer_balance($cust_pkg, $from_pkg->change_pkgnum);
1458 my $prev_balance = $self->balance_pkgnum($from_pkgnum);
1459 if ( $prev_balance != 0 ) {
1460 $balance_transfer_reason ||= FS::reason->new_or_existing(
1461 'reason' => 'Package balance transfer',
1462 'type' => 'Internal adjustment',
1466 my $credit = FS::cust_credit->new({
1467 'custnum' => $self->custnum,
1468 'amount' => abs($prev_balance),
1469 'reasonnum' => $balance_transfer_reason->reasonnum,
1470 '_date' => $cust_pkg->change_date,
1473 my $cust_bill_pkg = FS::cust_bill_pkg->new({
1475 'recur' => abs($prev_balance),
1476 #'sdate' => $from_pkg->last_bill, # not sure about this
1477 #'edate' => $cust_pkg->change_date,
1478 'itemdesc' => $self->mt('Previous Balance, [_1]',
1479 $from_pkg->part_pkg->pkg),
1482 if ( $prev_balance > 0 ) {
1483 # credit the old package, charge the new one
1484 $credit->set('pkgnum', $from_pkgnum);
1485 $cust_bill_pkg->set('pkgnum', $cust_pkg->pkgnum);
1488 $credit->set('pkgnum', $cust_pkg->pkgnum);
1489 $cust_bill_pkg->set('pkgnum', $from_pkgnum);
1491 my $error = $credit->insert;
1492 die "error transferring package balance from #".$from_pkgnum.
1493 " to #".$cust_pkg->pkgnum.": $error\n" if $error;
1495 push @transfers, $cust_bill_pkg;
1496 } # $prev_balance != 0
1501 #### vestigial code ####
1503 =item handle_taxes TAXLISTHASH CUST_BILL_PKG [ OPTIONS ]
1505 This is _handle_taxes. It's called once for each cust_bill_pkg generated
1508 TAXLISTHASH is a hashref shared across the entire invoice. It looks like
1511 'cust_main_county 1001' => [ [FS::cust_main_county], ... ],
1512 'cust_main_county 1002' => [ [FS::cust_main_county], ... ],
1515 'cust_main_county' can also be 'tax_rate'. The first object in the array
1516 is always the cust_main_county or tax_rate identified by the key.
1518 That "..." is a list of FS::cust_bill_pkg objects that will be fed to
1519 the 'taxline' method to calculate the amount of the tax. This doesn't
1520 happen until calculate_taxes, though.
1522 OPTIONS may include:
1523 - part_item: a part_pkg or part_fee object to be used as the package/fee
1525 - location: a cust_location to be used as the billing location.
1526 - cancel: true if this package is being billed on cancellation. This
1527 allows tax to be calculated on usage charges only.
1529 If not supplied, part_item will be inferred from the pkgnum or feepart of the
1530 cust_bill_pkg, and location from the pkgnum (or, for fees, the invnum and
1531 the customer's default service location).
1533 This method will also calculate exemptions for any taxes that apply to the
1534 line item (using the C<set_exemptions> method of L<FS::cust_bill_pkg>) and
1535 attach them. This is the only place C<set_exemptions> is called in normal
1542 my $taxlisthash = shift;
1543 my $cust_bill_pkg = shift;
1546 # at this point I realize that we have enough information to infer all this
1547 # stuff, instead of passing around giant honking argument lists
1548 my $location = $options{location} || $cust_bill_pkg->tax_location;
1549 my $part_item = $options{part_item} || $cust_bill_pkg->part_X;
1551 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1553 return if ( $self->payby eq 'COMP' ); #dubious
1555 if ( $conf->config('enable_taxproducts')
1556 && ( scalar($part_item->part_pkg_taxoverride)
1557 || $part_item->has_taxproduct
1562 # EXTERNAL TAX RATES (via tax_rate)
1563 my %cust_bill_pkg = ();
1567 my $usage = $cust_bill_pkg->usage || 0;
1568 push @classes, $cust_bill_pkg->usage_classes if $usage;
1569 push @classes, 'setup' if $cust_bill_pkg->setup and !$options{cancel};
1570 push @classes, 'recur' if ($cust_bill_pkg->recur - $usage)
1571 and !$options{cancel};
1572 # that's better--probably don't even need $options{cancel} now
1573 # but leave it for now, just to be safe
1575 # About $options{cancel}: This protects against charging per-line or
1576 # per-customer or other flat-rate surcharges on a package that's being
1577 # billed on cancellation (which is an out-of-cycle bill and should only
1578 # have usage charges). See RT#29443.
1580 # customer exemption is now handled in the 'taxline' method
1581 #my $exempt = $conf->exists('cust_class-tax_exempt')
1582 # ? ( $self->cust_class ? $self->cust_class->tax : '' )
1584 # standardize this just to be sure
1585 #$exempt = ($exempt eq 'Y') ? 'Y' : '';
1589 unless (exists $taxes{''}) {
1590 # unsure what purpose this serves, but last time I deleted something
1591 # from here just because I didn't see the point, it actually did
1592 # something important.
1593 my $err_or_ref = $self->_gather_taxes($part_item, '', $location);
1594 return $err_or_ref unless ref($err_or_ref);
1595 $taxes{''} = $err_or_ref;
1598 # NO DISINTEGRATIONS.
1599 # my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
1601 # do not call taxline() with any argument except the entire set of
1602 # cust_bill_pkgs on an invoice that are eligible for the tax.
1604 # only calculate exemptions once for each tax rate, even if it's used
1605 # for multiple classes
1608 foreach my $class (@classes) {
1609 my $err_or_ref = $self->_gather_taxes($part_item, $class, $location);
1610 return $err_or_ref unless ref($err_or_ref);
1611 my @taxes = @$err_or_ref;
1615 foreach my $tax ( @taxes ) {
1617 my $tax_id = ref( $tax ). ' '. $tax->taxnum;
1618 # $taxlisthash: keys are tax identifiers ('FS::tax_rate 123456').
1619 # Values are arrayrefs, first the tax object (cust_main_county
1620 # or tax_rate), then the cust_bill_pkg object that the
1621 # tax applies to, then the tax class (setup, recur, usage classnum).
1622 $taxlisthash->{ $tax_id } ||= [ $tax ];
1623 push @{ $taxlisthash->{ $tax_id } }, $cust_bill_pkg, $class;
1625 # determine any exemptions that apply
1626 if (!$tax_seen{$tax_id}) {
1627 $cust_bill_pkg->set_exemptions( $tax, custnum => $self->custnum );
1628 $tax_seen{$tax_id} = 1;
1631 # tax on tax will be done later, when we actually create the tax
1639 # INTERNAL TAX RATES (cust_main_county)
1641 # We fetch taxes even if the customer is completely exempt,
1642 # because we need to record that fact.
1644 my @loc_keys = qw( district city county state country );
1645 my %taxhash = map { $_ => $location->$_ } @loc_keys;
1647 $taxhash{'taxclass'} = $part_item->taxclass;
1649 warn "taxhash:\n". Dumper(\%taxhash) if $DEBUG > 2;
1651 my @taxes = (); # entries are cust_main_county objects
1652 my %taxhash_elim = %taxhash;
1653 my @elim = qw( district city county state );
1655 # WA state district city names are not stable in the WA tax tables
1656 # Allow districts to match with just a district id
1657 if ( $taxhash{district} ) {
1658 @taxes = qsearch( cust_main_county => {
1659 district => $taxhash{district},
1660 taxclass => $taxhash{taxclass},
1662 if ( !scalar(@taxes) && $taxhash{taxclass} ) {
1663 qsearch( cust_main_county => {
1664 district => $taxhash{district},
1672 #first try a match with taxclass
1673 if ( !scalar(@taxes) ) {
1674 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1677 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1678 #then try a match without taxclass
1679 my %no_taxclass = %taxhash_elim;
1680 $no_taxclass{ 'taxclass' } = '';
1681 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1684 $taxhash_elim{ shift(@elim) } = '';
1686 } while ( !scalar(@taxes) && scalar(@elim) );
1689 my $tax_id = 'cust_main_county '.$_->taxnum;
1690 $taxlisthash->{$tax_id} ||= [ $_ ];
1691 $cust_bill_pkg->set_exemptions($_, custnum => $self->custnum);
1692 push @{ $taxlisthash->{$tax_id} }, $cust_bill_pkg;
1699 =item _gather_taxes PART_ITEM CLASS CUST_LOCATION
1701 Internal method used with vendor-provided tax tables. PART_ITEM is a part_pkg
1702 or part_fee (which will define the tax eligibility of the product), CLASS is
1703 'setup', 'recur', null, or a C<usage_class> number, and CUST_LOCATION is the
1704 location where the service was provided (or billed, depending on
1705 configuration). Returns an arrayref of L<FS::tax_rate> objects that
1706 can apply to this line item.
1712 my $part_item = shift;
1714 my $location = shift;
1716 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1718 my $geocode = $location->geocode('cch');
1720 [ $part_item->tax_rates('cch', $geocode, $class) ]
1724 #### end vestigial code ####
1726 =item collect [ HASHREF | OPTION => VALUE ... ]
1728 (Attempt to) collect money for this customer's outstanding invoices (see
1729 L<FS::cust_bill>). Usually used after the bill method.
1731 Actions are now triggered by billing events; see L<FS::part_event> and the
1732 billing events web interface. Old-style invoice events (see
1733 L<FS::part_bill_event>) have been deprecated.
1735 If there is an error, returns the error, otherwise returns false.
1737 Options are passed as name-value pairs.
1739 Currently available options are:
1745 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.
1749 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1753 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1757 set true to surpress email card/ACH decline notices.
1761 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)
1767 # allows for one time override of normal customer billing method
1772 my( $self, %options ) = @_;
1774 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1776 my $invoice_time = $options{'invoice_time'} || time;
1779 local $SIG{HUP} = 'IGNORE';
1780 local $SIG{INT} = 'IGNORE';
1781 local $SIG{QUIT} = 'IGNORE';
1782 local $SIG{TERM} = 'IGNORE';
1783 local $SIG{TSTP} = 'IGNORE';
1784 local $SIG{PIPE} = 'IGNORE';
1786 my $oldAutoCommit = $FS::UID::AutoCommit;
1787 local $FS::UID::AutoCommit = 0;
1790 $self->select_for_update; #mutex
1793 my $balance = $self->balance;
1794 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
1797 if ( exists($options{'retry_card'}) ) {
1798 carp 'retry_card option passed to collect is deprecated; use retry';
1799 $options{'retry'} ||= $options{'retry_card'};
1801 if ( exists($options{'retry'}) && $options{'retry'} ) {
1802 my $error = $self->retry_realtime;
1804 $dbh->rollback if $oldAutoCommit;
1809 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1811 #never want to roll back an event just because it returned an error
1812 # unless $FS::UID::ForceObeyAutoCommit is set
1813 local $FS::UID::AutoCommit = 1
1814 unless !$oldAutoCommit
1815 && $FS::UID::ForceObeyAutoCommit;
1817 $self->do_cust_event(
1818 'debug' => ( $options{'debug'} || 0 ),
1819 'time' => $invoice_time,
1820 'check_freq' => $options{'check_freq'},
1821 'stage' => 'collect',
1826 =item retry_realtime
1828 Schedules realtime / batch credit card / electronic check / LEC billing
1829 events for for retry. Useful if card information has changed or manual
1830 retry is desired. The 'collect' method must be called to actually retry
1833 Implementation details: For either this customer, or for each of this
1834 customer's open invoices, changes the status of the first "done" (with
1835 statustext error) realtime processing event to "failed".
1839 sub retry_realtime {
1842 local $SIG{HUP} = 'IGNORE';
1843 local $SIG{INT} = 'IGNORE';
1844 local $SIG{QUIT} = 'IGNORE';
1845 local $SIG{TERM} = 'IGNORE';
1846 local $SIG{TSTP} = 'IGNORE';
1847 local $SIG{PIPE} = 'IGNORE';
1849 my $oldAutoCommit = $FS::UID::AutoCommit;
1850 local $FS::UID::AutoCommit = 0;
1853 #a little false laziness w/due_cust_event (not too bad, really)
1855 # I guess this is always as of now?
1856 my $join = FS::part_event_condition->join_conditions_sql('', 'time' => time);
1857 my $order = FS::part_event_condition->order_conditions_sql;
1860 . join ( ' OR ' , map {
1861 my $cust_join = FS::part_event->eventtables_cust_join->{$_} || '';
1862 my $custnum = FS::part_event->eventtables_custnum->{$_};
1863 "( part_event.eventtable = " . dbh->quote($_)
1864 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key
1865 . " from $_ $cust_join"
1866 . " where $custnum = " . dbh->quote( $self->custnum ) . "))" ;
1867 } FS::part_event->eventtables)
1870 #here is the agent virtualization
1871 my $agent_virt = " ( part_event.agentnum IS NULL
1872 OR part_event.agentnum = ". $self->agentnum. ' )';
1874 #XXX this shouldn't be hardcoded, actions should declare it...
1875 my @realtime_events = qw(
1876 cust_bill_realtime_card
1877 cust_bill_realtime_check
1878 cust_bill_realtime_lec
1882 my $is_realtime_event =
1883 ' part_event.action IN ( '.
1884 join(',', map "'$_'", @realtime_events ).
1887 my $batch_or_statustext =
1888 "( part_event.action = 'cust_bill_batch'
1889 OR ( statustext IS NOT NULL AND statustext != '' )
1893 my @cust_event = qsearch({
1894 'table' => 'cust_event',
1895 'select' => 'cust_event.*',
1896 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
1897 'hashref' => { 'status' => 'done' },
1898 'extra_sql' => " AND $batch_or_statustext ".
1899 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
1902 my %seen_invnum = ();
1903 foreach my $cust_event (@cust_event) {
1905 #max one for the customer, one for each open invoice
1906 my $cust_X = $cust_event->cust_X;
1907 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
1911 or $cust_event->part_event->eventtable eq 'cust_bill'
1914 my $error = $cust_event->retry;
1916 $dbh->rollback if $oldAutoCommit;
1917 return "error scheduling event for retry: $error";
1922 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1927 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
1929 Runs billing events; see L<FS::part_event> and the billing events web
1932 If there is an error, returns the error, otherwise returns false.
1934 Options are passed as name-value pairs.
1936 Currently available options are:
1942 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.
1946 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1950 "collect" (the default) or "pre-bill"
1954 set true to surpress email card/ACH decline notices.
1958 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)
1965 # allows for one time override of normal customer billing method
1969 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1972 my( $self, %options ) = @_;
1974 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1976 my $time = $options{'time'} || time;
1979 local $SIG{HUP} = 'IGNORE';
1980 local $SIG{INT} = 'IGNORE';
1981 local $SIG{QUIT} = 'IGNORE';
1982 local $SIG{TERM} = 'IGNORE';
1983 local $SIG{TSTP} = 'IGNORE';
1984 local $SIG{PIPE} = 'IGNORE';
1986 my $oldAutoCommit = $FS::UID::AutoCommit;
1987 local $FS::UID::AutoCommit = 0;
1990 $self->select_for_update; #mutex
1993 my $balance = $self->balance;
1994 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
1997 # if ( exists($options{'retry_card'}) ) {
1998 # carp 'retry_card option passed to collect is deprecated; use retry';
1999 # $options{'retry'} ||= $options{'retry_card'};
2001 # if ( exists($options{'retry'}) && $options{'retry'} ) {
2002 # my $error = $self->retry_realtime;
2004 # $dbh->rollback if $oldAutoCommit;
2009 # false laziness w/pay_batch::import_results
2011 my $due_cust_event = $self->due_cust_event(
2012 'debug' => ( $options{'debug'} || 0 ),
2014 'check_freq' => $options{'check_freq'},
2015 'stage' => ( $options{'stage'} || 'collect' ),
2017 unless( ref($due_cust_event) ) {
2018 $dbh->rollback if $oldAutoCommit;
2019 return $due_cust_event;
2022 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2024 #never want to roll back an event just because it or a different one
2026 # unless $FS::UID::ForceObeyAutoCommit is set
2027 local $FS::UID::AutoCommit = 1
2028 unless !$oldAutoCommit
2029 && $FS::UID::ForceObeyAutoCommit;
2031 foreach my $cust_event ( @$due_cust_event ) {
2035 #re-eval event conditions (a previous event could have changed things)
2036 unless ( $cust_event->test_conditions ) {
2037 #don't leave stray "new/locked" records around
2038 my $error = $cust_event->delete;
2039 return $error if $error;
2044 local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
2045 if $options{'quiet'};
2046 warn " running cust_event ". $cust_event->eventnum. "\n"
2049 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
2050 if ( my $error = $cust_event->do_event( 'time' => $time ) ) {
2051 #XXX wtf is this? figure out a proper dealio with return value
2063 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
2065 Inserts database records for and returns an ordered listref of new events due
2066 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
2067 events are due, an empty listref is returned. If there is an error, returns a
2068 scalar error message.
2070 To actually run the events, call each event's test_condition method, and if
2071 still true, call the event's do_event method.
2073 Options are passed as a hashref or as a list of name-value pairs. Available
2080 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.
2084 "collect" (the default) or "pre-bill"
2088 "Current time" for the events.
2092 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)
2096 Only return events for the specified eventtable (by default, events of all eventtables are returned)
2100 Explicitly pass the objects to be tested (typically used with eventtable).
2104 Set to true to return the objects, but not actually insert them into the
2111 sub due_cust_event {
2113 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
2116 #my $DEBUG = $opt{'debug'}
2117 $opt{'debug'} ||= 0; # silence some warnings
2118 local($DEBUG) = $opt{'debug'}
2119 if $opt{'debug'} > $DEBUG;
2120 $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
2122 warn "$me due_cust_event called with options ".
2123 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
2126 $opt{'time'} ||= time;
2128 local $SIG{HUP} = 'IGNORE';
2129 local $SIG{INT} = 'IGNORE';
2130 local $SIG{QUIT} = 'IGNORE';
2131 local $SIG{TERM} = 'IGNORE';
2132 local $SIG{TSTP} = 'IGNORE';
2133 local $SIG{PIPE} = 'IGNORE';
2135 my $oldAutoCommit = $FS::UID::AutoCommit;
2136 local $FS::UID::AutoCommit = 0;
2139 $self->select_for_update #mutex
2140 unless $opt{testonly};
2143 # find possible events (initial search)
2146 my @cust_event = ();
2148 my @eventtable = $opt{'eventtable'}
2149 ? ( $opt{'eventtable'} )
2150 : FS::part_event->eventtables_runorder;
2152 my $check_freq = $opt{'check_freq'} || '1d';
2154 foreach my $eventtable ( @eventtable ) {
2157 if ( $opt{'objects'} ) {
2159 @objects = @{ $opt{'objects'} };
2161 } elsif ( $eventtable eq 'cust_main' ) {
2163 @objects = ( $self );
2167 my $cm_join = " LEFT JOIN cust_main USING ( custnum )";
2168 # linkage not needed here because FS::cust_main->$eventtable will
2171 #some false laziness w/Cron::bill bill_where
2173 my $join = FS::part_event_condition->join_conditions_sql( $eventtable,
2174 'time' => $opt{'time'});
2175 my $where = FS::part_event_condition->where_conditions_sql($eventtable,
2176 'time'=>$opt{'time'},
2178 $where = $where ? "AND $where" : '';
2180 my $are_part_event =
2181 "EXISTS ( SELECT 1 FROM part_event $join
2182 WHERE check_freq = '$check_freq'
2183 AND eventtable = '$eventtable'
2184 AND ( disabled = '' OR disabled IS NULL )
2190 @objects = $self->$eventtable(
2191 'addl_from' => $cm_join,
2192 'extra_sql' => " AND $are_part_event",
2194 } # if ( !$opt{objects} and $eventtable ne 'cust_main' )
2196 my @e_cust_event = ();
2198 my $linkage = FS::part_event->eventtables_cust_join->{$eventtable} || '';
2200 my $cross = "CROSS JOIN $eventtable $linkage";
2201 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
2202 unless $eventtable eq 'cust_main';
2204 foreach my $object ( @objects ) {
2206 #this first search uses the condition_sql magic for optimization.
2207 #the more possible events we can eliminate in this step the better
2209 my $cross_where = '';
2210 my $pkey = $object->primary_key;
2211 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
2213 my $join = FS::part_event_condition->join_conditions_sql( $eventtable,
2214 'time' => $opt{'time'});
2216 FS::part_event_condition->where_conditions_sql( $eventtable,
2217 'time'=>$opt{'time'}
2219 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
2221 $extra_sql = "AND $extra_sql" if $extra_sql;
2223 #here is the agent virtualization
2224 $extra_sql .= " AND ( part_event.agentnum IS NULL
2225 OR part_event.agentnum = ". $self->agentnum. ' )';
2227 $extra_sql .= " $order";
2229 warn "searching for events for $eventtable ". $object->$pkey. "\n"
2230 if $opt{'debug'} > 2;
2231 my @part_event = qsearch( {
2232 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
2233 'select' => 'part_event.*',
2234 'table' => 'part_event',
2235 'addl_from' => "$cross $join",
2236 'hashref' => { 'check_freq' => $check_freq,
2237 'eventtable' => $eventtable,
2240 'extra_sql' => "AND $cross_where $extra_sql",
2244 my $pkey = $object->primary_key;
2245 warn " ". scalar(@part_event).
2246 " possible events found for $eventtable ". $object->$pkey(). "\n";
2249 push @e_cust_event, map {
2250 $_->new_cust_event($object, 'time' => $opt{'time'})
2255 warn " ". scalar(@e_cust_event).
2256 " subtotal possible cust events found for $eventtable\n"
2259 push @cust_event, @e_cust_event;
2263 warn " ". scalar(@cust_event).
2264 " total possible cust events found in initial search\n"
2272 $opt{stage} ||= 'collect';
2274 grep { my $stage = $_->part_event->event_stage;
2275 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
2285 @cust_event = grep $_->test_conditions( 'stats_hashref' => \%unsat ),
2288 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
2291 warn " invalid conditions not eliminated with condition_sql:\n".
2292 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
2293 if keys %unsat && $DEBUG; # > 1;
2299 unless( $opt{testonly} ) {
2300 foreach my $cust_event ( @cust_event ) {
2302 my $error = $cust_event->insert();
2304 $dbh->rollback if $oldAutoCommit;
2311 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2317 warn " returning events: ". Dumper(@cust_event). "\n"
2324 =item apply_payments_and_credits [ OPTION => VALUE ... ]
2326 Applies unapplied payments and credits.
2327 Payments with the no_auto_apply flag set will not be applied.
2329 In most cases, this new method should be used in place of sequential
2330 apply_payments and apply_credits methods.
2332 A hash of optional arguments may be passed. Currently "manual" is supported.
2333 If true, a payment receipt is sent instead of a statement when
2334 'payment_receipt_email' configuration option is set.
2336 If there is an error, returns the error, otherwise returns false.
2340 sub apply_payments_and_credits {
2341 my( $self, %options ) = @_;
2343 local $SIG{HUP} = 'IGNORE';
2344 local $SIG{INT} = 'IGNORE';
2345 local $SIG{QUIT} = 'IGNORE';
2346 local $SIG{TERM} = 'IGNORE';
2347 local $SIG{TSTP} = 'IGNORE';
2348 local $SIG{PIPE} = 'IGNORE';
2350 my $oldAutoCommit = $FS::UID::AutoCommit;
2351 local $FS::UID::AutoCommit = 0;
2354 my $savepoint_label = 'Billing__apply_payments_and_credits';
2355 savepoint_create( $savepoint_label );
2357 $self->select_for_update; #mutex
2359 foreach my $cust_bill ( $self->open_cust_bill ) {
2360 my $error = $cust_bill->apply_payments_and_credits(%options);
2362 savepoint_rollback_and_release( $savepoint_label );
2363 $dbh->rollback if $oldAutoCommit;
2364 return "Error applying: $error";
2368 savepoint_release( $savepoint_label );
2369 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2374 =item apply_credits OPTION => VALUE ...
2376 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
2377 to outstanding invoice balances in chronological order (or reverse
2378 chronological order if the I<order> option is set to B<newest>) and returns the
2379 value of any remaining unapplied credits available for refund (see
2380 L<FS::cust_refund>).
2382 Dies if there is an error.
2390 local $SIG{HUP} = 'IGNORE';
2391 local $SIG{INT} = 'IGNORE';
2392 local $SIG{QUIT} = 'IGNORE';
2393 local $SIG{TERM} = 'IGNORE';
2394 local $SIG{TSTP} = 'IGNORE';
2395 local $SIG{PIPE} = 'IGNORE';
2397 my $oldAutoCommit = $FS::UID::AutoCommit;
2398 local $FS::UID::AutoCommit = 0;
2401 $self->select_for_update; #mutex
2403 unless ( $self->total_unapplied_credits ) {
2404 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2408 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
2409 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
2411 my @invoices = $self->open_cust_bill;
2412 @invoices = sort { $b->_date <=> $a->_date } @invoices
2413 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
2415 if ( $conf->exists('pkg-balances') ) {
2416 # limit @credits to those w/ a pkgnum grepped from $self
2418 foreach my $i (@invoices) {
2419 foreach my $li ( $i->cust_bill_pkg ) {
2420 $pkgnums{$li->pkgnum} = 1;
2423 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
2428 foreach my $cust_bill ( @invoices ) {
2430 if ( !defined($credit) || $credit->credited == 0) {
2431 $credit = pop @credits or last;
2435 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
2436 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
2438 $owed = $cust_bill->owed;
2440 unless ( $owed > 0 ) {
2441 push @credits, $credit;
2445 my $amount = min( $credit->credited, $owed );
2447 my $cust_credit_bill = new FS::cust_credit_bill ( {
2448 'crednum' => $credit->crednum,
2449 'invnum' => $cust_bill->invnum,
2450 'amount' => $amount,
2452 $cust_credit_bill->pkgnum( $credit->pkgnum )
2453 if $conf->exists('pkg-balances') && $credit->pkgnum;
2454 my $error = $cust_credit_bill->insert;
2456 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2460 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2464 my $total_unapplied_credits = $self->total_unapplied_credits;
2466 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2468 return $total_unapplied_credits;
2471 =item apply_payments [ OPTION => VALUE ... ]
2473 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2474 to outstanding invoice balances in chronological order.
2475 Payments with the no_auto_apply flag set will not be applied.
2477 #and returns the value of any remaining unapplied payments.
2479 A hash of optional arguments may be passed. Currently "manual" is supported.
2480 If true, a payment receipt is sent instead of a statement when
2481 'payment_receipt_email' configuration option is set.
2483 Dies if there is an error.
2487 sub apply_payments {
2488 my( $self, %options ) = @_;
2490 local $SIG{HUP} = 'IGNORE';
2491 local $SIG{INT} = 'IGNORE';
2492 local $SIG{QUIT} = 'IGNORE';
2493 local $SIG{TERM} = 'IGNORE';
2494 local $SIG{TSTP} = 'IGNORE';
2495 local $SIG{PIPE} = 'IGNORE';
2497 my $oldAutoCommit = $FS::UID::AutoCommit;
2498 local $FS::UID::AutoCommit = 0;
2501 $self->select_for_update; #mutex
2505 my @payments = grep { !$_->no_auto_apply } $self->unapplied_cust_pay;
2507 my @invoices = $self->open_cust_bill;
2509 if ( $conf->exists('pkg-balances') ) {
2510 # limit @payments to those w/ a pkgnum grepped from $self
2512 foreach my $i (@invoices) {
2513 foreach my $li ( $i->cust_bill_pkg ) {
2514 $pkgnums{$li->pkgnum} = 1;
2517 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
2522 foreach my $cust_bill ( @invoices ) {
2524 if ( !defined($payment) || $payment->unapplied == 0 ) {
2525 $payment = pop @payments or last;
2529 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
2530 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
2532 $owed = $cust_bill->owed;
2534 unless ( $owed > 0 ) {
2535 push @payments, $payment;
2539 my $amount = min( $payment->unapplied, $owed );
2542 'paynum' => $payment->paynum,
2543 'invnum' => $cust_bill->invnum,
2544 'amount' => $amount,
2546 $cbp->{_date} = $payment->_date
2547 if $options{'manual'} && $options{'backdate_application'};
2548 my $cust_bill_pay = new FS::cust_bill_pay($cbp);
2549 $cust_bill_pay->pkgnum( $payment->pkgnum )
2550 if $conf->exists('pkg-balances') && $payment->pkgnum;
2551 my $error = $cust_bill_pay->insert(%options);
2553 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2557 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2561 my $total_unapplied_payments = $self->total_unapplied_payments;
2563 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2565 return $total_unapplied_payments;
2575 suspend_adjourned_pkgs
2576 unsuspend_resumed_pkgs
2579 (do_cust_event pre-bill)
2581 _omit_zero_value_bundles
2584 apply_payments_and_credits
2593 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>