1 package FS::cust_main::Billing;
4 use vars qw( $conf $DEBUG $me );
7 use List::Util qw( min );
9 use FS::Record qw( qsearch qsearchs dbdef );
10 use FS::Misc::DateTime qw( day_end );
12 use FS::cust_bill_pkg;
13 use FS::cust_bill_pkg_display;
14 use FS::cust_bill_pay;
15 use FS::cust_credit_bill;
16 use FS::cust_tax_adjustment;
18 use FS::tax_rate_location;
19 use FS::cust_bill_pkg_tax_location;
20 use FS::cust_bill_pkg_tax_rate_location;
22 use FS::part_event_condition;
25 # 1 is mostly method/subroutine entry and options
26 # 2 traces progress of some operations
27 # 3 is even more information including possibly sensitive data
29 $me = '[FS::cust_main::Billing]';
31 install_callback FS::UID sub {
33 #yes, need it for stuff below (prolly should be cached)
38 FS::cust_main::Billing - Billing mixin for cust_main
44 These methods are available on FS::cust_main objects.
50 =item bill_and_collect
52 Cancels and suspends any packages due, generates bills, applies payments and
53 credits, and applies collection events to run cards, send bills and notices,
56 By default, warns on errors and continues with the next operation (but see the
59 Options are passed as name-value pairs. Currently available options are:
65 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:
69 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
73 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.
77 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
81 If set true, re-charges setup fees.
85 If set any errors prevent subsequent operations from continusing. If set
86 specifically to "return", returns the error (or false, if there is no error).
87 Any other true value causes errors to die.
91 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)
95 Optional FS::queue entry to receive status updates.
99 Options are passed to the B<bill> and B<collect> methods verbatim, so all
100 options of those methods are also available.
104 sub bill_and_collect {
105 my( $self, %options ) = @_;
109 #$options{actual_time} not $options{time} because freeside-daily -d is for
110 #pre-printing invoices
112 $options{'actual_time'} ||= time;
113 my $job = $options{'job'};
115 $job->update_statustext('0,cleaning expired packages') if $job;
116 $error = $self->cancel_expired_pkgs( day_end( $options{actual_time} ) );
118 $error = "Error expiring custnum ". $self->custnum. ": $error";
119 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
120 elsif ( $options{fatal} ) { die $error; }
121 else { warn $error; }
124 $error = $self->suspend_adjourned_pkgs( day_end( $options{actual_time} ) );
126 $error = "Error adjourning custnum ". $self->custnum. ": $error";
127 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
128 elsif ( $options{fatal} ) { die $error; }
129 else { warn $error; }
132 $job->update_statustext('20,billing packages') if $job;
133 $error = $self->bill( %options );
135 $error = "Error billing custnum ". $self->custnum. ": $error";
136 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
137 elsif ( $options{fatal} ) { die $error; }
138 else { warn $error; }
141 $job->update_statustext('50,applying payments and credits') if $job;
142 $error = $self->apply_payments_and_credits;
144 $error = "Error applying custnum ". $self->custnum. ": $error";
145 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
146 elsif ( $options{fatal} ) { die $error; }
147 else { warn $error; }
150 $job->update_statustext('70,running collection events') if $job;
151 unless ( $conf->exists('cancelled_cust-noevents')
152 && ! $self->num_ncancelled_pkgs
154 $error = $self->collect( %options );
156 $error = "Error collecting custnum ". $self->custnum. ": $error";
157 if ($options{fatal} && $options{fatal} eq 'return') { return $error; }
158 elsif ($options{fatal} ) { die $error; }
159 else { warn $error; }
162 $job->update_statustext('100,finished') if $job;
168 sub cancel_expired_pkgs {
169 my ( $self, $time, %options ) = @_;
171 my @cancel_pkgs = $self->ncancelled_pkgs( {
172 'extra_sql' => " AND expire IS NOT NULL AND expire > 0 AND expire <= $time "
177 foreach my $cust_pkg ( @cancel_pkgs ) {
178 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
179 my $error = $cust_pkg->cancel($cpr ? ( 'reason' => $cpr->reasonnum,
180 'reason_otaker' => $cpr->otaker
184 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
187 scalar(@errors) ? join(' / ', @errors) : '';
191 sub suspend_adjourned_pkgs {
192 my ( $self, $time, %options ) = @_;
194 my @susp_pkgs = $self->ncancelled_pkgs( {
196 " AND ( susp IS NULL OR susp = 0 )
197 AND ( ( bill IS NOT NULL AND bill != 0 AND bill < $time )
198 OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
203 #only because there's no SQL test for is_prepaid :/
205 grep { ( $_->part_pkg->is_prepaid
210 && $_->adjourn <= $time
218 foreach my $cust_pkg ( @susp_pkgs ) {
219 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
220 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
221 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
222 'reason_otaker' => $cpr->otaker
226 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
229 scalar(@errors) ? join(' / ', @errors) : '';
235 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
236 conjunction with the collect method by calling B<bill_and_collect>.
238 If there is an error, returns the error, otherwise returns false.
240 Options are passed as name-value pairs. Currently available options are:
246 If set true, re-charges setup fees.
250 If set true then only bill recurring charges, not setup, usage, one time
255 If set, then override the normal frequency and look for a part_pkg_discount
256 to take at that frequency. This will exclude any packages that aren't billed
261 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:
265 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
269 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
271 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
275 A hashref of pkgparts to exclude from this billing run (can also be specified as a comma-separated scalar).
279 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.
283 This boolean value informs the us that the package is being cancelled. This
284 typically might mean not charging the normal recurring fee but only usage
285 fees since the last billing. Setup charges may be charged. Not all package
286 plans support this feature (they tend to charge 0).
290 Prevent the resetting of usage limits during this call.
294 Do not save the generated bill in the database. Useful with return_bill
298 A list reference on which the generated bill(s) will be returned.
302 Optional terms to be printed on this invoice. Otherwise, customer-specific
303 terms or the default terms are used.
310 my( $self, %options ) = @_;
312 return '' if $self->payby eq 'COMP';
314 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
316 warn "$me bill customer ". $self->custnum. "\n"
319 my $time = $options{'time'} || time;
320 my $invoice_time = $options{'invoice_time'} || $time;
322 $options{'not_pkgpart'} ||= {};
323 $options{'not_pkgpart'} = { map { $_ => 1 }
324 split(/\s*,\s*/, $options{'not_pkgpart'})
326 unless ref($options{'not_pkgpart'});
328 local $SIG{HUP} = 'IGNORE';
329 local $SIG{INT} = 'IGNORE';
330 local $SIG{QUIT} = 'IGNORE';
331 local $SIG{TERM} = 'IGNORE';
332 local $SIG{TSTP} = 'IGNORE';
333 local $SIG{PIPE} = 'IGNORE';
335 my $oldAutoCommit = $FS::UID::AutoCommit;
336 local $FS::UID::AutoCommit = 0;
339 warn "$me acquiring lock on customer ". $self->custnum. "\n"
342 $self->select_for_update; #mutex
344 warn "$me running pre-bill events for customer ". $self->custnum. "\n"
347 my $error = $self->do_cust_event(
348 'debug' => ( $options{'debug'} || 0 ),
349 'time' => $invoice_time,
350 'check_freq' => $options{'check_freq'},
351 'stage' => 'pre-bill',
353 unless $options{no_commit};
355 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
359 warn "$me done running pre-bill events for customer ". $self->custnum. "\n"
362 #keep auto-charge and non-auto-charge line items separate
363 my @passes = ( '', 'no_auto' );
365 my %cust_bill_pkg = map { $_ => [] } @passes;
368 # find the packages which are due for billing, find out how much they are
369 # & generate invoice database.
372 my %total_setup = map { my $z = 0; $_ => \$z; } @passes;
373 my %total_recur = map { my $z = 0; $_ => \$z; } @passes;
375 my %taxlisthash = map { $_ => {} } @passes;
377 my @precommit_hooks = ();
379 $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ]; #param checks?
380 foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
382 next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
384 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
386 #? to avoid use of uninitialized value errors... ?
387 $cust_pkg->setfield('bill', '')
388 unless defined($cust_pkg->bill);
390 #my $part_pkg = $cust_pkg->part_pkg;
392 my $real_pkgpart = $cust_pkg->pkgpart;
393 my %hash = $cust_pkg->hash;
395 # we could implement this bit as FS::part_pkg::has_hidden, but we already
396 # suffer from performance issues
397 $options{has_hidden} = 0;
398 my @part_pkg = $cust_pkg->part_pkg->self_and_bill_linked;
399 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
401 foreach my $part_pkg ( @part_pkg ) {
403 $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
405 my $pass = ($cust_pkg->no_auto || $part_pkg->no_auto) ? 'no_auto' : '';
407 my $next_bill = $cust_pkg->getfield('bill') || 0;
409 while ( $next_bill <= $time ) {
411 $self->_make_lines( 'part_pkg' => $part_pkg,
412 'cust_pkg' => $cust_pkg,
413 'precommit_hooks' => \@precommit_hooks,
414 'line_items' => $cust_bill_pkg{$pass},
415 'setup' => $total_setup{$pass},
416 'recur' => $total_recur{$pass},
417 'tax_matrix' => $taxlisthash{$pass},
419 'real_pkgpart' => $real_pkgpart,
420 'options' => \%options,
422 # Stop if anything goes wrong, or if we're not incrementing
425 last if ($cust_pkg->getfield('bill') || 0) == $next_bill;
426 $next_bill = $cust_pkg->getfield('bill') || 0;
429 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
433 } #foreach my $part_pkg
435 } #foreach my $cust_pkg
437 #if the customer isn't on an automatic payby, everything can go on a single
439 #if ( $cust_main->payby !~ /^(CARD|CHEK)$/ ) {
440 #merge everything into one list
443 foreach my $pass (@passes) { # keys %cust_bill_pkg ) {
445 my @cust_bill_pkg = _omit_zero_value_bundles(@{ $cust_bill_pkg{$pass} });
447 next unless @cust_bill_pkg; #don't create an invoice w/o line items
449 warn "$me billing pass $pass\n"
450 #.Dumper(\@cust_bill_pkg)."\n"
453 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
454 !$conf->exists('postal_invoice-recurring_only')
458 my $postal_pkg = $self->charge_postal_fee();
459 if ( $postal_pkg && !ref( $postal_pkg ) ) {
461 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
462 return "can't charge postal invoice fee for customer ".
463 $self->custnum. ": $postal_pkg";
465 } elsif ( $postal_pkg ) {
467 my $real_pkgpart = $postal_pkg->pkgpart;
468 # we could implement this bit as FS::part_pkg::has_hidden, but we already
469 # suffer from performance issues
470 $options{has_hidden} = 0;
471 my @part_pkg = $postal_pkg->part_pkg->self_and_bill_linked;
472 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
474 foreach my $part_pkg ( @part_pkg ) {
475 my %postal_options = %options;
476 delete $postal_options{cancel};
478 $self->_make_lines( 'part_pkg' => $part_pkg,
479 'cust_pkg' => $postal_pkg,
480 'precommit_hooks' => \@precommit_hooks,
481 'line_items' => \@cust_bill_pkg,
482 'setup' => $total_setup{$pass},
483 'recur' => $total_recur{$pass},
484 'tax_matrix' => $taxlisthash{$pass},
486 'real_pkgpart' => $real_pkgpart,
487 'options' => \%postal_options,
490 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
495 # it's silly to have a zero value postal_pkg, but....
496 @cust_bill_pkg = _omit_zero_value_bundles(@cust_bill_pkg);
502 my $listref_or_error =
503 $self->calculate_taxes( \@cust_bill_pkg, $taxlisthash{$pass}, $invoice_time);
505 unless ( ref( $listref_or_error ) ) {
506 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
507 return $listref_or_error;
510 foreach my $taxline ( @$listref_or_error ) {
511 ${ $total_setup{$pass} } =
512 sprintf('%.2f', ${ $total_setup{$pass} } + $taxline->setup );
513 push @cust_bill_pkg, $taxline;
517 warn "adding tax adjustments...\n" if $DEBUG > 2;
518 foreach my $cust_tax_adjustment (
519 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
525 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
527 my $itemdesc = $cust_tax_adjustment->taxname;
528 $itemdesc = '' if $itemdesc eq 'Tax';
530 push @cust_bill_pkg, new FS::cust_bill_pkg {
536 'itemdesc' => $itemdesc,
537 'itemcomment' => $cust_tax_adjustment->comment,
538 'cust_tax_adjustment' => $cust_tax_adjustment,
539 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
544 my $charged = sprintf('%.2f', ${ $total_setup{$pass} } + ${ $total_recur{$pass} } );
546 my @cust_bill = $self->cust_bill;
547 my $balance = $self->balance;
548 my $previous_balance = scalar(@cust_bill)
549 ? ( $cust_bill[$#cust_bill]->billing_balance || 0 )
552 $previous_balance += $cust_bill[$#cust_bill]->charged
553 if scalar(@cust_bill);
554 #my $balance_adjustments =
555 # sprintf('%.2f', $balance - $prior_prior_balance - $prior_charged);
557 warn "creating the new invoice\n" if $DEBUG;
558 #create the new invoice
559 my $cust_bill = new FS::cust_bill ( {
560 'custnum' => $self->custnum,
561 '_date' => $invoice_time,
562 'charged' => $charged,
563 'billing_balance' => $balance,
564 'previous_balance' => $previous_balance,
565 'invoice_terms' => $options{'invoice_terms'},
566 'cust_bill_pkg' => \@cust_bill_pkg,
568 $error = $cust_bill->insert unless $options{no_commit};
570 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
571 return "can't create invoice for customer #". $self->custnum. ": $error";
573 push @{$options{return_bill}}, $cust_bill if $options{return_bill};
575 } #foreach my $pass ( keys %cust_bill_pkg )
577 foreach my $hook ( @precommit_hooks ) {
580 } unless $options{no_commit};
582 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
583 return "$@ running precommit hook $hook\n";
587 $dbh->commit or die $dbh->errstr if $oldAutoCommit && !$options{no_commit};
592 #discard bundled packages of 0 value
593 sub _omit_zero_value_bundles {
596 my @cust_bill_pkg = ();
597 my @cust_bill_pkg_bundle = ();
599 my $discount_show_always = 0;
601 foreach my $cust_bill_pkg ( @in ) {
603 $discount_show_always = ($cust_bill_pkg->get('discounts')
604 && scalar(@{$cust_bill_pkg->get('discounts')})
605 && $conf->exists('discount-show-always'));
607 warn " pkgnum ". $cust_bill_pkg->pkgnum. " sum $sum, ".
608 "setup_show_zero ". $cust_bill_pkg->setup_show_zero.
609 "recur_show_zero ". $cust_bill_pkg->recur_show_zero. "\n"
612 if (scalar(@cust_bill_pkg_bundle) && !$cust_bill_pkg->pkgpart_override) {
613 push @cust_bill_pkg, @cust_bill_pkg_bundle
615 || ($sum == 0 && ( $discount_show_always
616 || grep {$_->recur_show_zero || $_->setup_show_zero}
617 @cust_bill_pkg_bundle
620 @cust_bill_pkg_bundle = ();
624 $sum += $cust_bill_pkg->setup + $cust_bill_pkg->recur;
625 push @cust_bill_pkg_bundle, $cust_bill_pkg;
629 push @cust_bill_pkg, @cust_bill_pkg_bundle
631 || ($sum == 0 && ( $discount_show_always
632 || grep {$_->recur_show_zero || $_->setup_show_zero}
633 @cust_bill_pkg_bundle
637 warn " _omit_zero_value_bundles: ". scalar(@in).
638 '->'. scalar(@cust_bill_pkg). "\n" #. Dumper(@cust_bill_pkg). "\n"
645 =item calculate_taxes LINEITEMREF TAXHASHREF INVOICE_TIME
647 This is a weird one. Perhaps it should not even be exposed.
649 Generates tax line items (see L<FS::cust_bill_pkg>) for this customer.
650 Usually used internally by bill method B<bill>.
652 If there is an error, returns the error, otherwise returns reference to a
653 list of line items suitable for insertion.
659 An array ref of the line items being billed.
663 A strange beast. The keys to this hash are internal identifiers consisting
664 of the name of the tax object type, a space, and its unique identifier ( e.g.
665 'cust_main_county 23' ). The values of the hash are listrefs. The first
666 item in the list is the tax object. The remaining items are either line
667 items or floating point values (currency amounts).
669 The taxes are calculated on this entity. Calculated exemption records are
670 transferred to the LINEITEMREF items on the assumption that they are related.
676 This specifies the date appearing on the associated invoice. Some
677 jurisdictions (i.e. Texas) have tax exemptions which are date sensitive.
683 sub calculate_taxes {
684 my ($self, $cust_bill_pkg, $taxlisthash, $invoice_time) = @_;
686 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
688 warn "$me calculate_taxes\n"
689 #.Dumper($self, $cust_bill_pkg, $taxlisthash, $invoice_time). "\n"
692 my @tax_line_items = ();
694 # keys are tax names (as printed on invoices / itemdesc )
695 # values are listrefs of taxlisthash keys (internal identifiers)
698 # keys are taxlisthash keys (internal identifiers)
699 # values are (cumulative) amounts
702 # keys are taxlisthash keys (internal identifiers)
703 # values are listrefs of cust_bill_pkg_tax_location hashrefs
704 my %tax_location = ();
706 # keys are taxlisthash keys (internal identifiers)
707 # values are listrefs of cust_bill_pkg_tax_rate_location hashrefs
708 my %tax_rate_location = ();
710 foreach my $tax ( keys %$taxlisthash ) {
711 my $tax_object = shift @{ $taxlisthash->{$tax} };
712 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
713 warn " ". join('/', @{ $taxlisthash->{$tax} } ). "\n" if $DEBUG > 2;
714 my $hashref_or_error =
715 $tax_object->taxline( $taxlisthash->{$tax},
716 'custnum' => $self->custnum,
717 'invoice_time' => $invoice_time
719 return $hashref_or_error unless ref($hashref_or_error);
721 unshift @{ $taxlisthash->{$tax} }, $tax_object;
723 my $name = $hashref_or_error->{'name'};
724 my $amount = $hashref_or_error->{'amount'};
726 #warn "adding $amount as $name\n";
727 $taxname{ $name } ||= [];
728 push @{ $taxname{ $name } }, $tax;
730 $tax{ $tax } += $amount;
732 $tax_location{ $tax } ||= [];
733 if ( $tax_object->get('pkgnum') || $tax_object->get('locationnum') ) {
734 push @{ $tax_location{ $tax } },
736 'taxnum' => $tax_object->taxnum,
737 'taxtype' => ref($tax_object),
738 'pkgnum' => $tax_object->get('pkgnum'),
739 'locationnum' => $tax_object->get('locationnum'),
740 'amount' => sprintf('%.2f', $amount ),
744 $tax_rate_location{ $tax } ||= [];
745 if ( ref($tax_object) eq 'FS::tax_rate' ) {
746 my $taxratelocationnum =
747 $tax_object->tax_rate_location->taxratelocationnum;
748 push @{ $tax_rate_location{ $tax } },
750 'taxnum' => $tax_object->taxnum,
751 'taxtype' => ref($tax_object),
752 'amount' => sprintf('%.2f', $amount ),
753 'locationtaxid' => $tax_object->location,
754 'taxratelocationnum' => $taxratelocationnum,
760 #move the cust_tax_exempt_pkg records to the cust_bill_pkgs we will commit
761 my %packagemap = map { $_->pkgnum => $_ } @$cust_bill_pkg;
762 foreach my $tax ( keys %$taxlisthash ) {
763 foreach ( @{ $taxlisthash->{$tax} }[1 ... scalar(@{ $taxlisthash->{$tax} })] ) {
764 next unless ref($_) eq 'FS::cust_bill_pkg';
766 my @cust_tax_exempt_pkg = splice( @{ $_->_cust_tax_exempt_pkg } );
768 next unless @cust_tax_exempt_pkg; #just avoiding the prob when irrelevant?
769 die "can't distribute tax exemptions: no line item for ". Dumper($_).
770 " in packagemap ". join(',', sort {$a<=>$b} keys %packagemap). "\n"
771 unless $packagemap{$_->pkgnum};
773 push @{ $packagemap{$_->pkgnum}->_cust_tax_exempt_pkg },
774 @cust_tax_exempt_pkg;
778 #consolidate and create tax line items
779 warn "consolidating and generating...\n" if $DEBUG > 2;
780 foreach my $taxname ( keys %taxname ) {
783 my @cust_bill_pkg_tax_location = ();
784 my @cust_bill_pkg_tax_rate_location = ();
785 warn "adding $taxname\n" if $DEBUG > 1;
786 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
787 next if $seen{$taxitem}++;
788 warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
789 $tax += $tax{$taxitem};
790 push @cust_bill_pkg_tax_location,
791 map { new FS::cust_bill_pkg_tax_location $_ }
792 @{ $tax_location{ $taxitem } };
793 push @cust_bill_pkg_tax_rate_location,
794 map { new FS::cust_bill_pkg_tax_rate_location $_ }
795 @{ $tax_rate_location{ $taxitem } };
799 $tax = sprintf('%.2f', $tax );
801 my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
807 if ( $pkg_category and
808 $conf->config('invoice_latexsummary') ||
809 $conf->config('invoice_htmlsummary')
813 my %hash = ( 'section' => $pkg_category->categoryname );
814 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
818 push @tax_line_items, new FS::cust_bill_pkg {
824 'itemdesc' => $taxname,
825 'display' => \@display,
826 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
827 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
836 my ($self, %params) = @_;
838 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
840 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
841 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
842 my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
843 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
844 my $total_setup = $params{setup} or die "no setup accumulator specified";
845 my $total_recur = $params{recur} or die "no recur accumulator specified";
846 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
847 my $time = $params{'time'} or die "no time specified";
848 my (%options) = %{$params{options}};
850 if ( $part_pkg->freq ne '1' and ($options{'freq_override'} || 0) > 0 ) {
851 # this should never happen
852 die 'freq_override billing attempted on non-monthly package '.
857 my $real_pkgpart = $params{real_pkgpart};
858 my %hash = $cust_pkg->hash;
859 my $old_cust_pkg = new FS::cust_pkg \%hash;
864 $cust_pkg->pkgpart($part_pkg->pkgpart);
872 my @setup_discounts = ();
873 my %setup_param = ( 'discounts' => \@setup_discounts );
874 if ( ! $options{recurring_only}
875 and ! $options{cancel}
876 and ( $options{'resetup'}
877 || ( ! $cust_pkg->setup
878 && ( ! $cust_pkg->start_date
879 || $cust_pkg->start_date <= day_end($time)
881 && ( ! $conf->exists('disable_setup_suspended_pkgs')
882 || ( $conf->exists('disable_setup_suspended_pkgs') &&
883 ! $cust_pkg->getfield('susp')
891 warn " bill setup\n" if $DEBUG > 1;
893 unless ( $cust_pkg->waive_setup ) {
896 $setup = eval { $cust_pkg->calc_setup( $time, \@details, \%setup_param ) };
897 return "$@ running calc_setup for $cust_pkg\n"
900 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
903 $cust_pkg->setfield('setup', $time)
904 unless $cust_pkg->setup;
905 #do need it, but it won't get written to the db
906 #|| $cust_pkg->pkgpart != $real_pkgpart;
908 $cust_pkg->setfield('start_date', '')
909 if $cust_pkg->start_date;
917 #XXX unit stuff here too
920 my @recur_discounts = ();
922 if ( ! $cust_pkg->start_date
923 and ( ! $cust_pkg->susp || $part_pkg->option('suspend_bill', 1) )
925 ( $part_pkg->freq ne '0' && ( $cust_pkg->bill || 0 ) <= day_end($time) )
926 || ( $part_pkg->plan eq 'voip_cdr'
927 && $part_pkg->option('bill_every_call')
932 # XXX should this be a package event? probably. events are called
933 # at collection time at the moment, though...
934 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
935 if $part_pkg->can('reset_usage') && !$options{'no_usage_reset'};
936 #don't want to reset usage just cause we want a line item??
937 #&& $part_pkg->pkgpart == $real_pkgpart;
939 warn " bill recur\n" if $DEBUG > 1;
942 # XXX shared with $recur_prog
943 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
947 #over two params! lets at least switch to a hashref for the rest...
948 my $increment_next_bill = ( $part_pkg->freq ne '0'
949 && ( $cust_pkg->getfield('bill') || 0 ) <= day_end($time)
952 my %param = ( %setup_param,
953 'precommit_hooks' => $precommit_hooks,
954 'increment_next_bill' => $increment_next_bill,
955 'discounts' => \@recur_discounts,
956 'real_pkgpart' => $real_pkgpart,
957 'freq_override' => $options{freq_override} || '',
961 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
963 # There may be some part_pkg for which this is wrong. Only those
964 # which can_discount are supported.
965 # (the UI should prevent adding discounts to these at the moment)
967 warn "calling $method on cust_pkg ". $cust_pkg->pkgnum.
968 " for pkgpart ". $cust_pkg->pkgpart.
969 " with params ". join(' / ', map "$_=>$param{$_}", keys %param). "\n"
972 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
973 return "$@ running $method for $cust_pkg\n"
976 if ( $increment_next_bill ) {
978 my $next_bill = $part_pkg->add_freq($sdate, $options{freq_override} || 0);
979 return "unparsable frequency: ". $part_pkg->freq
982 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
983 # only for figuring next bill date, nothing else, so, reset $sdate again
985 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
986 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
987 $cust_pkg->last_bill($sdate);
989 $cust_pkg->setfield('bill', $next_bill );
993 if ( $param{'setup_fee'} ) {
994 # Add an additional setup fee at the billing stage.
995 # Used for prorate_defer_bill.
996 $setup += $param{'setup_fee'};
997 $unitsetup += $param{'setup_fee'};
1001 if ( defined $param{'discount_left_setup'} ) {
1002 foreach my $discount_setup ( values %{$param{'discount_left_setup'}} ) {
1003 $setup -= $discount_setup;
1009 warn "\$setup is undefined" unless defined($setup);
1010 warn "\$recur is undefined" unless defined($recur);
1011 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1014 # If there's line items, create em cust_bill_pkg records
1015 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
1020 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
1021 # hmm.. and if just the options are modified in some weird price plan?
1023 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
1026 my $error = $cust_pkg->replace( $old_cust_pkg,
1027 'depend_jobnum'=>$options{depend_jobnum},
1028 'options' => { $cust_pkg->options },
1030 unless $options{no_commit};
1031 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
1032 if $error; #just in case
1035 $setup = sprintf( "%.2f", $setup );
1036 $recur = sprintf( "%.2f", $recur );
1037 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
1038 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1040 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
1041 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
1044 my $discount_show_always = $conf->exists('discount-show-always')
1045 && ( ($setup == 0 && scalar(@setup_discounts))
1046 || ($recur == 0 && scalar(@recur_discounts))
1051 || (!$part_pkg->hidden && $options{has_hidden}) #include some $0 lines
1052 || $discount_show_always
1053 || ($setup == 0 && $cust_pkg->_X_show_zero('setup'))
1054 || ($recur == 0 && $cust_pkg->_X_show_zero('recur'))
1058 warn " charges (setup=$setup, recur=$recur); adding line items\n"
1061 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
1063 warn " adding customer package invoice detail: $_\n"
1064 foreach @cust_pkg_detail;
1066 push @details, @cust_pkg_detail;
1068 my $cust_bill_pkg = new FS::cust_bill_pkg {
1069 'pkgnum' => $cust_pkg->pkgnum,
1071 'unitsetup' => $unitsetup,
1073 'unitrecur' => $unitrecur,
1074 'quantity' => $cust_pkg->quantity,
1075 'details' => \@details,
1076 'discounts' => [ @setup_discounts, @recur_discounts ],
1077 'hidden' => $part_pkg->hidden,
1078 'freq' => $part_pkg->freq,
1081 if ( $part_pkg->recur_temporality eq 'preceding' ) {
1082 $cust_bill_pkg->sdate( $hash{last_bill} );
1083 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
1084 $cust_bill_pkg->edate( $time ) if $options{cancel};
1085 } else { #if ( $part_pkg->recur_temporality eq 'upcoming' ) {
1086 $cust_bill_pkg->sdate( $sdate );
1087 $cust_bill_pkg->edate( $cust_pkg->bill );
1088 #$cust_bill_pkg->edate( $time ) if $options{cancel};
1091 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
1092 unless $part_pkg->pkgpart == $real_pkgpart;
1094 $$total_setup += $setup;
1095 $$total_recur += $recur;
1101 unless ( $discount_show_always ) {
1103 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart, \%options);
1104 return $error if $error;
1107 push @$cust_bill_pkgs, $cust_bill_pkg;
1109 } #if $setup != 0 || $recur != 0
1119 my $part_pkg = shift;
1120 my $taxlisthash = shift;
1121 my $cust_bill_pkg = shift;
1122 my $cust_pkg = shift;
1123 my $invoice_time = shift;
1124 my $real_pkgpart = shift;
1125 my $options = shift;
1127 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1129 my %cust_bill_pkg = ();
1133 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
1134 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
1135 push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
1136 push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
1138 if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
1140 if ( $conf->exists('enable_taxproducts')
1141 && ( scalar($part_pkg->part_pkg_taxoverride)
1142 || $part_pkg->has_taxproduct
1147 foreach my $class (@classes) {
1148 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class, $cust_pkg );
1149 return $err_or_ref unless ref($err_or_ref);
1150 $taxes{$class} = $err_or_ref;
1153 unless (exists $taxes{''}) {
1154 my $err_or_ref = $self->_gather_taxes( $part_pkg, '', $cust_pkg );
1155 return $err_or_ref unless ref($err_or_ref);
1156 $taxes{''} = $err_or_ref;
1161 my @loc_keys = qw( city county state country );
1163 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1164 my $cust_location = $cust_pkg->cust_location;
1165 %taxhash = map { $_ => $cust_location->$_() } @loc_keys;
1168 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
1171 %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
1174 $taxhash{'taxclass'} = $part_pkg->taxclass;
1177 my %taxhash_elim = %taxhash;
1178 my @elim = qw( city county state );
1181 #first try a match with taxclass
1182 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1184 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1185 #then try a match without taxclass
1186 my %no_taxclass = %taxhash_elim;
1187 $no_taxclass{ 'taxclass' } = '';
1188 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1191 $taxhash_elim{ shift(@elim) } = '';
1193 } while ( !scalar(@taxes) && scalar(@elim) );
1195 @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
1197 if $self->cust_main_exemption; #just to be safe
1199 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1201 $_->set('pkgnum', $cust_pkg->pkgnum );
1202 $_->set('locationnum', $cust_pkg->locationnum );
1206 $taxes{''} = [ @taxes ];
1207 $taxes{'setup'} = [ @taxes ];
1208 $taxes{'recur'} = [ @taxes ];
1209 $taxes{$_} = [ @taxes ] foreach (@classes);
1211 # # maybe eliminate this entirely, along with all the 0% records
1212 # unless ( @taxes ) {
1214 # "fatal: can't find tax rate for state/county/country/taxclass ".
1215 # join('/', map $taxhash{$_}, qw(state county country taxclass) );
1218 } #if $conf->exists('enable_taxproducts') ...
1222 #what's this doing in the middle of _handle_taxes? probably should split
1223 #this into three parts above in _make_lines
1224 $cust_bill_pkg->set_display( part_pkg => $part_pkg,
1225 real_pkgpart => $real_pkgpart,
1228 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
1229 foreach my $key (keys %tax_cust_bill_pkg) {
1230 my @taxes = @{ $taxes{$key} || [] };
1231 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
1233 my %localtaxlisthash = ();
1234 foreach my $tax ( @taxes ) {
1236 my $taxname = ref( $tax ). ' '. $tax->taxnum;
1237 # $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
1238 # ' locationnum'. $cust_pkg->locationnum
1239 # if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
1241 $taxlisthash->{ $taxname } ||= [ $tax ];
1242 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
1244 $localtaxlisthash{ $taxname } ||= [ $tax ];
1245 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
1249 warn "finding taxed taxes...\n" if $DEBUG > 2;
1250 foreach my $tax ( keys %localtaxlisthash ) {
1251 my $tax_object = shift @{ $localtaxlisthash{$tax} };
1252 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
1254 next unless $tax_object->can('tax_on_tax');
1256 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
1257 my $totname = ref( $tot ). ' '. $tot->taxnum;
1259 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
1261 next unless exists( $localtaxlisthash{ $totname } ); # only increase
1263 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
1264 my $hashref_or_error =
1265 $tax_object->taxline( $localtaxlisthash{$tax},
1266 'custnum' => $self->custnum,
1267 'invoice_time' => $invoice_time,
1269 return $hashref_or_error
1270 unless ref($hashref_or_error);
1272 $taxlisthash->{ $totname } ||= [ $tot ];
1273 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
1285 my $part_pkg = shift;
1287 my $cust_pkg = shift;
1289 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1292 if ( $cust_pkg->locationnum && $conf->exists('tax-pkg_address') ) {
1293 $geocode = $cust_pkg->cust_location->geocode('cch');
1295 $geocode = $self->geocode('cch');
1300 my @taxclassnums = map { $_->taxclassnum }
1301 $part_pkg->part_pkg_taxoverride($class);
1303 unless (@taxclassnums) {
1304 @taxclassnums = map { $_->taxclassnum }
1305 grep { $_->taxable eq 'Y' }
1306 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
1308 warn "Found taxclassnum values of ". join(',', @taxclassnums)
1313 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
1315 @taxes = qsearch({ 'table' => 'tax_rate',
1316 'hashref' => { 'geocode' => $geocode, },
1317 'extra_sql' => $extra_sql,
1319 if scalar(@taxclassnums);
1321 warn "Found taxes ".
1322 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
1329 =item collect [ HASHREF | OPTION => VALUE ... ]
1331 (Attempt to) collect money for this customer's outstanding invoices (see
1332 L<FS::cust_bill>). Usually used after the bill method.
1334 Actions are now triggered by billing events; see L<FS::part_event> and the
1335 billing events web interface. Old-style invoice events (see
1336 L<FS::part_bill_event>) have been deprecated.
1338 If there is an error, returns the error, otherwise returns false.
1340 Options are passed as name-value pairs.
1342 Currently available options are:
1348 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.
1352 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1356 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1360 set true to surpress email card/ACH decline notices.
1364 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)
1370 # allows for one time override of normal customer billing method
1375 my( $self, %options ) = @_;
1377 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1379 my $invoice_time = $options{'invoice_time'} || time;
1382 local $SIG{HUP} = 'IGNORE';
1383 local $SIG{INT} = 'IGNORE';
1384 local $SIG{QUIT} = 'IGNORE';
1385 local $SIG{TERM} = 'IGNORE';
1386 local $SIG{TSTP} = 'IGNORE';
1387 local $SIG{PIPE} = 'IGNORE';
1389 my $oldAutoCommit = $FS::UID::AutoCommit;
1390 local $FS::UID::AutoCommit = 0;
1393 $self->select_for_update; #mutex
1396 my $balance = $self->balance;
1397 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
1400 if ( exists($options{'retry_card'}) ) {
1401 carp 'retry_card option passed to collect is deprecated; use retry';
1402 $options{'retry'} ||= $options{'retry_card'};
1404 if ( exists($options{'retry'}) && $options{'retry'} ) {
1405 my $error = $self->retry_realtime;
1407 $dbh->rollback if $oldAutoCommit;
1412 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1414 #never want to roll back an event just because it returned an error
1415 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1417 $self->do_cust_event(
1418 'debug' => ( $options{'debug'} || 0 ),
1419 'time' => $invoice_time,
1420 'check_freq' => $options{'check_freq'},
1421 'stage' => 'collect',
1426 =item retry_realtime
1428 Schedules realtime / batch credit card / electronic check / LEC billing
1429 events for for retry. Useful if card information has changed or manual
1430 retry is desired. The 'collect' method must be called to actually retry
1433 Implementation details: For either this customer, or for each of this
1434 customer's open invoices, changes the status of the first "done" (with
1435 statustext error) realtime processing event to "failed".
1439 sub retry_realtime {
1442 local $SIG{HUP} = 'IGNORE';
1443 local $SIG{INT} = 'IGNORE';
1444 local $SIG{QUIT} = 'IGNORE';
1445 local $SIG{TERM} = 'IGNORE';
1446 local $SIG{TSTP} = 'IGNORE';
1447 local $SIG{PIPE} = 'IGNORE';
1449 my $oldAutoCommit = $FS::UID::AutoCommit;
1450 local $FS::UID::AutoCommit = 0;
1453 #a little false laziness w/due_cust_event (not too bad, really)
1455 my $join = FS::part_event_condition->join_conditions_sql;
1456 my $order = FS::part_event_condition->order_conditions_sql;
1459 . join ( ' OR ' , map {
1460 my $cust_join = FS::part_event->eventtables_cust_join->{$_} || '';
1461 my $custnum = FS::part_event->eventtables_custnum->{$_};
1462 "( part_event.eventtable = " . dbh->quote($_)
1463 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key
1464 . " from $_ $cust_join"
1465 . " where $custnum = " . dbh->quote( $self->custnum ) . "))" ;
1466 } FS::part_event->eventtables)
1469 #here is the agent virtualization
1470 my $agent_virt = " ( part_event.agentnum IS NULL
1471 OR part_event.agentnum = ". $self->agentnum. ' )';
1473 #XXX this shouldn't be hardcoded, actions should declare it...
1474 my @realtime_events = qw(
1475 cust_bill_realtime_card
1476 cust_bill_realtime_check
1477 cust_bill_realtime_lec
1481 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
1486 my @cust_event = qsearchs({
1487 'table' => 'cust_event',
1488 'select' => 'cust_event.*',
1489 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
1490 'hashref' => { 'status' => 'done' },
1491 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
1492 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
1495 my %seen_invnum = ();
1496 foreach my $cust_event (@cust_event) {
1498 #max one for the customer, one for each open invoice
1499 my $cust_X = $cust_event->cust_X;
1500 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
1504 or $cust_event->part_event->eventtable eq 'cust_bill'
1507 my $error = $cust_event->retry;
1509 $dbh->rollback if $oldAutoCommit;
1510 return "error scheduling event for retry: $error";
1515 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1520 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
1522 Runs billing events; see L<FS::part_event> and the billing events web
1525 If there is an error, returns the error, otherwise returns false.
1527 Options are passed as name-value pairs.
1529 Currently available options are:
1535 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.
1539 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1543 "collect" (the default) or "pre-bill"
1547 set true to surpress email card/ACH decline notices.
1551 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)
1558 # allows for one time override of normal customer billing method
1562 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1565 my( $self, %options ) = @_;
1567 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1569 my $time = $options{'time'} || time;
1572 local $SIG{HUP} = 'IGNORE';
1573 local $SIG{INT} = 'IGNORE';
1574 local $SIG{QUIT} = 'IGNORE';
1575 local $SIG{TERM} = 'IGNORE';
1576 local $SIG{TSTP} = 'IGNORE';
1577 local $SIG{PIPE} = 'IGNORE';
1579 my $oldAutoCommit = $FS::UID::AutoCommit;
1580 local $FS::UID::AutoCommit = 0;
1583 $self->select_for_update; #mutex
1586 my $balance = $self->balance;
1587 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
1590 # if ( exists($options{'retry_card'}) ) {
1591 # carp 'retry_card option passed to collect is deprecated; use retry';
1592 # $options{'retry'} ||= $options{'retry_card'};
1594 # if ( exists($options{'retry'}) && $options{'retry'} ) {
1595 # my $error = $self->retry_realtime;
1597 # $dbh->rollback if $oldAutoCommit;
1602 # false laziness w/pay_batch::import_results
1604 my $due_cust_event = $self->due_cust_event(
1605 'debug' => ( $options{'debug'} || 0 ),
1607 'check_freq' => $options{'check_freq'},
1608 'stage' => ( $options{'stage'} || 'collect' ),
1610 unless( ref($due_cust_event) ) {
1611 $dbh->rollback if $oldAutoCommit;
1612 return $due_cust_event;
1615 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1616 #never want to roll back an event just because it or a different one
1618 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1620 foreach my $cust_event ( @$due_cust_event ) {
1624 #re-eval event conditions (a previous event could have changed things)
1625 unless ( $cust_event->test_conditions ) {
1626 #don't leave stray "new/locked" records around
1627 my $error = $cust_event->delete;
1628 return $error if $error;
1633 local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
1634 if $options{'quiet'};
1635 warn " running cust_event ". $cust_event->eventnum. "\n"
1638 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
1639 if ( my $error = $cust_event->do_event( 'time' => $time ) ) {
1640 #XXX wtf is this? figure out a proper dealio with return value
1652 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
1654 Inserts database records for and returns an ordered listref of new events due
1655 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
1656 events are due, an empty listref is returned. If there is an error, returns a
1657 scalar error message.
1659 To actually run the events, call each event's test_condition method, and if
1660 still true, call the event's do_event method.
1662 Options are passed as a hashref or as a list of name-value pairs. Available
1669 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.
1673 "collect" (the default) or "pre-bill"
1677 "Current time" for the events.
1681 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)
1685 Only return events for the specified eventtable (by default, events of all eventtables are returned)
1689 Explicitly pass the objects to be tested (typically used with eventtable).
1693 Set to true to return the objects, but not actually insert them into the
1700 sub due_cust_event {
1702 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
1705 #my $DEBUG = $opt{'debug'}
1706 local($DEBUG) = $opt{'debug'}
1707 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
1708 $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1710 warn "$me due_cust_event called with options ".
1711 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
1714 $opt{'time'} ||= time;
1716 local $SIG{HUP} = 'IGNORE';
1717 local $SIG{INT} = 'IGNORE';
1718 local $SIG{QUIT} = 'IGNORE';
1719 local $SIG{TERM} = 'IGNORE';
1720 local $SIG{TSTP} = 'IGNORE';
1721 local $SIG{PIPE} = 'IGNORE';
1723 my $oldAutoCommit = $FS::UID::AutoCommit;
1724 local $FS::UID::AutoCommit = 0;
1727 $self->select_for_update #mutex
1728 unless $opt{testonly};
1731 # find possible events (initial search)
1734 my @cust_event = ();
1736 my @eventtable = $opt{'eventtable'}
1737 ? ( $opt{'eventtable'} )
1738 : FS::part_event->eventtables_runorder;
1740 my $check_freq = $opt{'check_freq'} || '1d';
1742 foreach my $eventtable ( @eventtable ) {
1745 if ( $opt{'objects'} ) {
1747 @objects = @{ $opt{'objects'} };
1749 } elsif ( $eventtable eq 'cust_main' ) {
1751 @objects = ( $self );
1755 my $cm_join = " LEFT JOIN cust_main USING ( custnum )";
1756 # linkage not needed here because FS::cust_main->$eventtable will
1759 #some false laziness w/Cron::bill bill_where
1761 my $join = FS::part_event_condition->join_conditions_sql( $eventtable);
1762 my $where = FS::part_event_condition->where_conditions_sql($eventtable,
1763 'time'=>$opt{'time'},
1765 $where = $where ? "AND $where" : '';
1767 my $are_part_event =
1768 "EXISTS ( SELECT 1 FROM part_event $join
1769 WHERE check_freq = '$check_freq'
1770 AND eventtable = '$eventtable'
1771 AND ( disabled = '' OR disabled IS NULL )
1777 @objects = $self->$eventtable(
1778 'addl_from' => $cm_join,
1779 'extra_sql' => " AND $are_part_event",
1781 } # if ( !$opt{objects} and $eventtable ne 'cust_main' )
1783 my @e_cust_event = ();
1785 my $linkage = FS::part_event->eventtables_cust_join->{$eventtable} || '';
1787 my $cross = "CROSS JOIN $eventtable $linkage";
1788 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
1789 unless $eventtable eq 'cust_main';
1791 foreach my $object ( @objects ) {
1793 #this first search uses the condition_sql magic for optimization.
1794 #the more possible events we can eliminate in this step the better
1796 my $cross_where = '';
1797 my $pkey = $object->primary_key;
1798 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
1800 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
1802 FS::part_event_condition->where_conditions_sql( $eventtable,
1803 'time'=>$opt{'time'}
1805 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
1807 $extra_sql = "AND $extra_sql" if $extra_sql;
1809 #here is the agent virtualization
1810 $extra_sql .= " AND ( part_event.agentnum IS NULL
1811 OR part_event.agentnum = ". $self->agentnum. ' )';
1813 $extra_sql .= " $order";
1815 warn "searching for events for $eventtable ". $object->$pkey. "\n"
1816 if $opt{'debug'} > 2;
1817 my @part_event = qsearch( {
1818 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
1819 'select' => 'part_event.*',
1820 'table' => 'part_event',
1821 'addl_from' => "$cross $join",
1822 'hashref' => { 'check_freq' => $check_freq,
1823 'eventtable' => $eventtable,
1826 'extra_sql' => "AND $cross_where $extra_sql",
1830 my $pkey = $object->primary_key;
1831 warn " ". scalar(@part_event).
1832 " possible events found for $eventtable ". $object->$pkey(). "\n";
1835 push @e_cust_event, map {
1836 $_->new_cust_event($object, 'time' => $opt{'time'})
1841 warn " ". scalar(@e_cust_event).
1842 " subtotal possible cust events found for $eventtable\n"
1845 push @cust_event, @e_cust_event;
1849 warn " ". scalar(@cust_event).
1850 " total possible cust events found in initial search\n"
1858 $opt{stage} ||= 'collect';
1860 grep { my $stage = $_->part_event->event_stage;
1861 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
1871 @cust_event = grep $_->test_conditions( 'stats_hashref' => \%unsat ),
1874 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
1877 warn " invalid conditions not eliminated with condition_sql:\n".
1878 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
1879 if keys %unsat && $DEBUG; # > 1;
1885 unless( $opt{testonly} ) {
1886 foreach my $cust_event ( @cust_event ) {
1888 my $error = $cust_event->insert();
1890 $dbh->rollback if $oldAutoCommit;
1897 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1903 warn " returning events: ". Dumper(@cust_event). "\n"
1910 =item apply_payments_and_credits [ OPTION => VALUE ... ]
1912 Applies unapplied payments and credits.
1914 In most cases, this new method should be used in place of sequential
1915 apply_payments and apply_credits methods.
1917 A hash of optional arguments may be passed. Currently "manual" is supported.
1918 If true, a payment receipt is sent instead of a statement when
1919 'payment_receipt_email' configuration option is set.
1921 If there is an error, returns the error, otherwise returns false.
1925 sub apply_payments_and_credits {
1926 my( $self, %options ) = @_;
1928 local $SIG{HUP} = 'IGNORE';
1929 local $SIG{INT} = 'IGNORE';
1930 local $SIG{QUIT} = 'IGNORE';
1931 local $SIG{TERM} = 'IGNORE';
1932 local $SIG{TSTP} = 'IGNORE';
1933 local $SIG{PIPE} = 'IGNORE';
1935 my $oldAutoCommit = $FS::UID::AutoCommit;
1936 local $FS::UID::AutoCommit = 0;
1939 $self->select_for_update; #mutex
1941 foreach my $cust_bill ( $self->open_cust_bill ) {
1942 my $error = $cust_bill->apply_payments_and_credits(%options);
1944 $dbh->rollback if $oldAutoCommit;
1945 return "Error applying: $error";
1949 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1954 =item apply_credits OPTION => VALUE ...
1956 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
1957 to outstanding invoice balances in chronological order (or reverse
1958 chronological order if the I<order> option is set to B<newest>) and returns the
1959 value of any remaining unapplied credits available for refund (see
1960 L<FS::cust_refund>).
1962 Dies if there is an error.
1970 local $SIG{HUP} = 'IGNORE';
1971 local $SIG{INT} = 'IGNORE';
1972 local $SIG{QUIT} = 'IGNORE';
1973 local $SIG{TERM} = 'IGNORE';
1974 local $SIG{TSTP} = 'IGNORE';
1975 local $SIG{PIPE} = 'IGNORE';
1977 my $oldAutoCommit = $FS::UID::AutoCommit;
1978 local $FS::UID::AutoCommit = 0;
1981 $self->select_for_update; #mutex
1983 unless ( $self->total_unapplied_credits ) {
1984 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1988 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
1989 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
1991 my @invoices = $self->open_cust_bill;
1992 @invoices = sort { $b->_date <=> $a->_date } @invoices
1993 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
1995 if ( $conf->exists('pkg-balances') ) {
1996 # limit @credits to those w/ a pkgnum grepped from $self
1998 foreach my $i (@invoices) {
1999 foreach my $li ( $i->cust_bill_pkg ) {
2000 $pkgnums{$li->pkgnum} = 1;
2003 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
2008 foreach my $cust_bill ( @invoices ) {
2010 if ( !defined($credit) || $credit->credited == 0) {
2011 $credit = pop @credits or last;
2015 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
2016 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
2018 $owed = $cust_bill->owed;
2020 unless ( $owed > 0 ) {
2021 push @credits, $credit;
2025 my $amount = min( $credit->credited, $owed );
2027 my $cust_credit_bill = new FS::cust_credit_bill ( {
2028 'crednum' => $credit->crednum,
2029 'invnum' => $cust_bill->invnum,
2030 'amount' => $amount,
2032 $cust_credit_bill->pkgnum( $credit->pkgnum )
2033 if $conf->exists('pkg-balances') && $credit->pkgnum;
2034 my $error = $cust_credit_bill->insert;
2036 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2040 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2044 my $total_unapplied_credits = $self->total_unapplied_credits;
2046 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2048 return $total_unapplied_credits;
2051 =item apply_payments [ OPTION => VALUE ... ]
2053 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2054 to outstanding invoice balances in chronological order.
2056 #and returns the value of any remaining unapplied payments.
2058 A hash of optional arguments may be passed. Currently "manual" is supported.
2059 If true, a payment receipt is sent instead of a statement when
2060 'payment_receipt_email' configuration option is set.
2062 Dies if there is an error.
2066 sub apply_payments {
2067 my( $self, %options ) = @_;
2069 local $SIG{HUP} = 'IGNORE';
2070 local $SIG{INT} = 'IGNORE';
2071 local $SIG{QUIT} = 'IGNORE';
2072 local $SIG{TERM} = 'IGNORE';
2073 local $SIG{TSTP} = 'IGNORE';
2074 local $SIG{PIPE} = 'IGNORE';
2076 my $oldAutoCommit = $FS::UID::AutoCommit;
2077 local $FS::UID::AutoCommit = 0;
2080 $self->select_for_update; #mutex
2084 my @payments = sort { $b->_date <=> $a->_date }
2085 grep { $_->unapplied > 0 }
2088 my @invoices = sort { $a->_date <=> $b->_date}
2089 grep { $_->owed > 0 }
2092 if ( $conf->exists('pkg-balances') ) {
2093 # limit @payments to those w/ a pkgnum grepped from $self
2095 foreach my $i (@invoices) {
2096 foreach my $li ( $i->cust_bill_pkg ) {
2097 $pkgnums{$li->pkgnum} = 1;
2100 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
2105 foreach my $cust_bill ( @invoices ) {
2107 if ( !defined($payment) || $payment->unapplied == 0 ) {
2108 $payment = pop @payments or last;
2112 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
2113 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
2115 $owed = $cust_bill->owed;
2117 unless ( $owed > 0 ) {
2118 push @payments, $payment;
2122 my $amount = min( $payment->unapplied, $owed );
2125 'paynum' => $payment->paynum,
2126 'invnum' => $cust_bill->invnum,
2127 'amount' => $amount,
2129 $cbp->{_date} = $payment->_date
2130 if $options{'manual'} && $options{'backdate_application'};
2131 my $cust_bill_pay = new FS::cust_bill_pay($cbp);
2132 $cust_bill_pay->pkgnum( $payment->pkgnum )
2133 if $conf->exists('pkg-balances') && $payment->pkgnum;
2134 my $error = $cust_bill_pay->insert(%options);
2136 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2140 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2144 my $total_unapplied_payments = $self->total_unapplied_payments;
2146 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2148 return $total_unapplied_payments;
2158 suspend_adjourned_pkgs
2161 (do_cust_event pre-bill)
2164 (vendor-only) _gather_taxes
2165 _omit_zero_value_bundles
2168 apply_payments_and_credits
2177 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>