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.
260 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:
264 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
268 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
270 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
274 A hashref of pkgparts to exclude from this billing run (can also be specified as a comma-separated scalar).
278 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.
282 This boolean value informs the us that the package is being cancelled. This
283 typically might mean not charging the normal recurring fee but only usage
284 fees since the last billing. Setup charges may be charged. Not all package
285 plans support this feature (they tend to charge 0).
289 Prevent the resetting of usage limits during this call.
293 Do not save the generated bill in the database. Useful with return_bill
297 A list reference on which the generated bill(s) will be returned.
301 Optional terms to be printed on this invoice. Otherwise, customer-specific
302 terms or the default terms are used.
309 my( $self, %options ) = @_;
311 return '' if $self->payby eq 'COMP';
313 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
315 warn "$me bill customer ". $self->custnum. "\n"
318 my $time = $options{'time'} || time;
319 my $invoice_time = $options{'invoice_time'} || $time;
321 $options{'not_pkgpart'} ||= {};
322 $options{'not_pkgpart'} = { map { $_ => 1 }
323 split(/\s*,\s*/, $options{'not_pkgpart'})
325 unless ref($options{'not_pkgpart'});
327 local $SIG{HUP} = 'IGNORE';
328 local $SIG{INT} = 'IGNORE';
329 local $SIG{QUIT} = 'IGNORE';
330 local $SIG{TERM} = 'IGNORE';
331 local $SIG{TSTP} = 'IGNORE';
332 local $SIG{PIPE} = 'IGNORE';
334 my $oldAutoCommit = $FS::UID::AutoCommit;
335 local $FS::UID::AutoCommit = 0;
338 warn "$me acquiring lock on customer ". $self->custnum. "\n"
341 $self->select_for_update; #mutex
343 warn "$me running pre-bill events for customer ". $self->custnum. "\n"
346 my $error = $self->do_cust_event(
347 'debug' => ( $options{'debug'} || 0 ),
348 'time' => $invoice_time,
349 'check_freq' => $options{'check_freq'},
350 'stage' => 'pre-bill',
352 unless $options{no_commit};
354 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
358 warn "$me done running pre-bill events for customer ". $self->custnum. "\n"
361 #keep auto-charge and non-auto-charge line items separate
362 my @passes = ( '', 'no_auto' );
364 my %cust_bill_pkg = map { $_ => [] } @passes;
367 # find the packages which are due for billing, find out how much they are
368 # & generate invoice database.
371 my %total_setup = map { my $z = 0; $_ => \$z; } @passes;
372 my %total_recur = map { my $z = 0; $_ => \$z; } @passes;
374 my %taxlisthash = map { $_ => {} } @passes;
376 my @precommit_hooks = ();
378 $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ]; #param checks?
379 foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
381 next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
383 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
385 #? to avoid use of uninitialized value errors... ?
386 $cust_pkg->setfield('bill', '')
387 unless defined($cust_pkg->bill);
389 #my $part_pkg = $cust_pkg->part_pkg;
391 my $real_pkgpart = $cust_pkg->pkgpart;
392 my %hash = $cust_pkg->hash;
394 # we could implement this bit as FS::part_pkg::has_hidden, but we already
395 # suffer from performance issues
396 $options{has_hidden} = 0;
397 my @part_pkg = $cust_pkg->part_pkg->self_and_bill_linked;
398 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
400 foreach my $part_pkg ( @part_pkg ) {
402 $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
404 my $pass = ($cust_pkg->no_auto || $part_pkg->no_auto) ? 'no_auto' : '';
406 my $next_bill = $cust_pkg->getfield('bill') || 0;
408 while ( $next_bill <= $time ) {
410 $self->_make_lines( 'part_pkg' => $part_pkg,
411 'cust_pkg' => $cust_pkg,
412 'precommit_hooks' => \@precommit_hooks,
413 'line_items' => $cust_bill_pkg{$pass},
414 'setup' => $total_setup{$pass},
415 'recur' => $total_recur{$pass},
416 'tax_matrix' => $taxlisthash{$pass},
418 'real_pkgpart' => $real_pkgpart,
419 'options' => \%options,
421 # Stop if anything goes wrong, or if we're not incrementing
424 last if ($cust_pkg->getfield('bill') || 0) == $next_bill;
425 $next_bill = $cust_pkg->getfield('bill') || 0;
428 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
432 } #foreach my $part_pkg
434 } #foreach my $cust_pkg
436 #if the customer isn't on an automatic payby, everything can go on a single
438 #if ( $cust_main->payby !~ /^(CARD|CHEK)$/ ) {
439 #merge everything into one list
442 foreach my $pass (@passes) { # keys %cust_bill_pkg ) {
444 my @cust_bill_pkg = _omit_zero_value_bundles(@{ $cust_bill_pkg{$pass} });
446 next unless @cust_bill_pkg; #don't create an invoice w/o line items
448 warn "$me billing pass $pass\n"
449 #.Dumper(\@cust_bill_pkg)."\n"
452 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
453 !$conf->exists('postal_invoice-recurring_only')
457 my $postal_pkg = $self->charge_postal_fee();
458 if ( $postal_pkg && !ref( $postal_pkg ) ) {
460 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
461 return "can't charge postal invoice fee for customer ".
462 $self->custnum. ": $postal_pkg";
464 } elsif ( $postal_pkg ) {
466 my $real_pkgpart = $postal_pkg->pkgpart;
467 # we could implement this bit as FS::part_pkg::has_hidden, but we already
468 # suffer from performance issues
469 $options{has_hidden} = 0;
470 my @part_pkg = $postal_pkg->part_pkg->self_and_bill_linked;
471 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
473 foreach my $part_pkg ( @part_pkg ) {
474 my %postal_options = %options;
475 delete $postal_options{cancel};
477 $self->_make_lines( 'part_pkg' => $part_pkg,
478 'cust_pkg' => $postal_pkg,
479 'precommit_hooks' => \@precommit_hooks,
480 'line_items' => \@cust_bill_pkg,
481 'setup' => $total_setup{$pass},
482 'recur' => $total_recur{$pass},
483 'tax_matrix' => $taxlisthash{$pass},
485 'real_pkgpart' => $real_pkgpart,
486 'options' => \%postal_options,
489 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
494 # it's silly to have a zero value postal_pkg, but....
495 @cust_bill_pkg = _omit_zero_value_bundles(@cust_bill_pkg);
501 my $listref_or_error =
502 $self->calculate_taxes( \@cust_bill_pkg, $taxlisthash{$pass}, $invoice_time);
504 unless ( ref( $listref_or_error ) ) {
505 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
506 return $listref_or_error;
509 foreach my $taxline ( @$listref_or_error ) {
510 ${ $total_setup{$pass} } =
511 sprintf('%.2f', ${ $total_setup{$pass} } + $taxline->setup );
512 push @cust_bill_pkg, $taxline;
516 warn "adding tax adjustments...\n" if $DEBUG > 2;
517 foreach my $cust_tax_adjustment (
518 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
524 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
526 my $itemdesc = $cust_tax_adjustment->taxname;
527 $itemdesc = '' if $itemdesc eq 'Tax';
529 push @cust_bill_pkg, new FS::cust_bill_pkg {
535 'itemdesc' => $itemdesc,
536 'itemcomment' => $cust_tax_adjustment->comment,
537 'cust_tax_adjustment' => $cust_tax_adjustment,
538 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
543 my $charged = sprintf('%.2f', ${ $total_setup{$pass} } + ${ $total_recur{$pass} } );
545 my @cust_bill = $self->cust_bill;
546 my $balance = $self->balance;
547 my $previous_balance = scalar(@cust_bill)
548 ? ( $cust_bill[$#cust_bill]->billing_balance || 0 )
551 $previous_balance += $cust_bill[$#cust_bill]->charged
552 if scalar(@cust_bill);
553 #my $balance_adjustments =
554 # sprintf('%.2f', $balance - $prior_prior_balance - $prior_charged);
556 warn "creating the new invoice\n" if $DEBUG;
557 #create the new invoice
558 my $cust_bill = new FS::cust_bill ( {
559 'custnum' => $self->custnum,
560 '_date' => $invoice_time,
561 'charged' => $charged,
562 'billing_balance' => $balance,
563 'previous_balance' => $previous_balance,
564 'invoice_terms' => $options{'invoice_terms'},
565 'cust_bill_pkg' => \@cust_bill_pkg,
567 $error = $cust_bill->insert unless $options{no_commit};
569 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
570 return "can't create invoice for customer #". $self->custnum. ": $error";
572 push @{$options{return_bill}}, $cust_bill if $options{return_bill};
574 } #foreach my $pass ( keys %cust_bill_pkg )
576 foreach my $hook ( @precommit_hooks ) {
579 } unless $options{no_commit};
581 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
582 return "$@ running precommit hook $hook\n";
586 $dbh->commit or die $dbh->errstr if $oldAutoCommit && !$options{no_commit};
591 #discard bundled packages of 0 value
592 sub _omit_zero_value_bundles {
595 my @cust_bill_pkg = ();
596 my @cust_bill_pkg_bundle = ();
598 my $discount_show_always = 0;
600 foreach my $cust_bill_pkg ( @in ) {
602 $discount_show_always = ($cust_bill_pkg->get('discounts')
603 && scalar(@{$cust_bill_pkg->get('discounts')})
604 && $conf->exists('discount-show-always'));
606 warn " pkgnum ". $cust_bill_pkg->pkgnum. " sum $sum, ".
607 "setup_show_zero ". $cust_bill_pkg->setup_show_zero.
608 "recur_show_zero ". $cust_bill_pkg->recur_show_zero. "\n"
611 if (scalar(@cust_bill_pkg_bundle) && !$cust_bill_pkg->pkgpart_override) {
612 push @cust_bill_pkg, @cust_bill_pkg_bundle
614 || ($sum == 0 && ( $discount_show_always
615 || grep {$_->recur_show_zero || $_->setup_show_zero}
616 @cust_bill_pkg_bundle
619 @cust_bill_pkg_bundle = ();
623 $sum += $cust_bill_pkg->setup + $cust_bill_pkg->recur;
624 push @cust_bill_pkg_bundle, $cust_bill_pkg;
628 push @cust_bill_pkg, @cust_bill_pkg_bundle
630 || ($sum == 0 && ( $discount_show_always
631 || grep {$_->recur_show_zero || $_->setup_show_zero}
632 @cust_bill_pkg_bundle
636 warn " _omit_zero_value_bundles: ". scalar(@in).
637 '->'. scalar(@cust_bill_pkg). "\n" #. Dumper(@cust_bill_pkg). "\n"
644 =item calculate_taxes LINEITEMREF TAXHASHREF INVOICE_TIME
646 This is a weird one. Perhaps it should not even be exposed.
648 Generates tax line items (see L<FS::cust_bill_pkg>) for this customer.
649 Usually used internally by bill method B<bill>.
651 If there is an error, returns the error, otherwise returns reference to a
652 list of line items suitable for insertion.
658 An array ref of the line items being billed.
662 A strange beast. The keys to this hash are internal identifiers consisting
663 of the name of the tax object type, a space, and its unique identifier ( e.g.
664 'cust_main_county 23' ). The values of the hash are listrefs. The first
665 item in the list is the tax object. The remaining items are either line
666 items or floating point values (currency amounts).
668 The taxes are calculated on this entity. Calculated exemption records are
669 transferred to the LINEITEMREF items on the assumption that they are related.
675 This specifies the date appearing on the associated invoice. Some
676 jurisdictions (i.e. Texas) have tax exemptions which are date sensitive.
682 sub calculate_taxes {
683 my ($self, $cust_bill_pkg, $taxlisthash, $invoice_time) = @_;
685 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
687 warn "$me calculate_taxes\n"
688 #.Dumper($self, $cust_bill_pkg, $taxlisthash, $invoice_time). "\n"
691 my @tax_line_items = ();
693 # keys are tax names (as printed on invoices / itemdesc )
694 # values are listrefs of taxlisthash keys (internal identifiers)
697 # keys are taxlisthash keys (internal identifiers)
698 # values are (cumulative) amounts
701 # keys are taxlisthash keys (internal identifiers)
702 # values are listrefs of cust_bill_pkg_tax_location hashrefs
703 my %tax_location = ();
705 # keys are taxlisthash keys (internal identifiers)
706 # values are listrefs of cust_bill_pkg_tax_rate_location hashrefs
707 my %tax_rate_location = ();
709 foreach my $tax ( keys %$taxlisthash ) {
710 my $tax_object = shift @{ $taxlisthash->{$tax} };
711 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
712 warn " ". join('/', @{ $taxlisthash->{$tax} } ). "\n" if $DEBUG > 2;
713 my $hashref_or_error =
714 $tax_object->taxline( $taxlisthash->{$tax},
715 'custnum' => $self->custnum,
716 'invoice_time' => $invoice_time
718 return $hashref_or_error unless ref($hashref_or_error);
720 unshift @{ $taxlisthash->{$tax} }, $tax_object;
722 my $name = $hashref_or_error->{'name'};
723 my $amount = $hashref_or_error->{'amount'};
725 #warn "adding $amount as $name\n";
726 $taxname{ $name } ||= [];
727 push @{ $taxname{ $name } }, $tax;
729 $tax{ $tax } += $amount;
731 $tax_location{ $tax } ||= [];
732 if ( $tax_object->get('pkgnum') || $tax_object->get('locationnum') ) {
733 push @{ $tax_location{ $tax } },
735 'taxnum' => $tax_object->taxnum,
736 'taxtype' => ref($tax_object),
737 'pkgnum' => $tax_object->get('pkgnum'),
738 'locationnum' => $tax_object->get('locationnum'),
739 'amount' => sprintf('%.2f', $amount ),
743 $tax_rate_location{ $tax } ||= [];
744 if ( ref($tax_object) eq 'FS::tax_rate' ) {
745 my $taxratelocationnum =
746 $tax_object->tax_rate_location->taxratelocationnum;
747 push @{ $tax_rate_location{ $tax } },
749 'taxnum' => $tax_object->taxnum,
750 'taxtype' => ref($tax_object),
751 'amount' => sprintf('%.2f', $amount ),
752 'locationtaxid' => $tax_object->location,
753 'taxratelocationnum' => $taxratelocationnum,
759 #move the cust_tax_exempt_pkg records to the cust_bill_pkgs we will commit
760 my %packagemap = map { $_->pkgnum => $_ } @$cust_bill_pkg;
761 foreach my $tax ( keys %$taxlisthash ) {
762 foreach ( @{ $taxlisthash->{$tax} }[1 ... scalar(@{ $taxlisthash->{$tax} })] ) {
763 next unless ref($_) eq 'FS::cust_bill_pkg';
765 my @cust_tax_exempt_pkg = splice( @{ $_->_cust_tax_exempt_pkg } );
767 next unless @cust_tax_exempt_pkg; #just avoiding the prob when irrelevant?
768 die "can't distribute tax exemptions: no line item for ". Dumper($_).
769 " in packagemap ". join(',', sort {$a<=>$b} keys %packagemap). "\n"
770 unless $packagemap{$_->pkgnum};
772 push @{ $packagemap{$_->pkgnum}->_cust_tax_exempt_pkg },
773 @cust_tax_exempt_pkg;
777 #consolidate and create tax line items
778 warn "consolidating and generating...\n" if $DEBUG > 2;
779 foreach my $taxname ( keys %taxname ) {
782 my @cust_bill_pkg_tax_location = ();
783 my @cust_bill_pkg_tax_rate_location = ();
784 warn "adding $taxname\n" if $DEBUG > 1;
785 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
786 next if $seen{$taxitem}++;
787 warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
788 $tax += $tax{$taxitem};
789 push @cust_bill_pkg_tax_location,
790 map { new FS::cust_bill_pkg_tax_location $_ }
791 @{ $tax_location{ $taxitem } };
792 push @cust_bill_pkg_tax_rate_location,
793 map { new FS::cust_bill_pkg_tax_rate_location $_ }
794 @{ $tax_rate_location{ $taxitem } };
798 $tax = sprintf('%.2f', $tax );
800 my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
806 if ( $pkg_category and
807 $conf->config('invoice_latexsummary') ||
808 $conf->config('invoice_htmlsummary')
812 my %hash = ( 'section' => $pkg_category->categoryname );
813 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
817 push @tax_line_items, new FS::cust_bill_pkg {
823 'itemdesc' => $taxname,
824 'display' => \@display,
825 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
826 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
835 my ($self, %params) = @_;
837 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
839 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
840 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
841 my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
842 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
843 my $total_setup = $params{setup} or die "no setup accumulator specified";
844 my $total_recur = $params{recur} or die "no recur accumulator specified";
845 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
846 my $time = $params{'time'} or die "no time specified";
847 my (%options) = %{$params{options}};
850 my $real_pkgpart = $params{real_pkgpart};
851 my %hash = $cust_pkg->hash;
852 my $old_cust_pkg = new FS::cust_pkg \%hash;
858 $cust_pkg->pkgpart($part_pkg->pkgpart);
866 my %setup_param = ();
867 if ( ! $options{recurring_only}
868 and ! $options{cancel}
869 and ( $options{'resetup'}
870 || ( ! $cust_pkg->setup
871 && ( ! $cust_pkg->start_date
872 || $cust_pkg->start_date <= day_end($time)
874 && ( ! $conf->exists('disable_setup_suspended_pkgs')
875 || ( $conf->exists('disable_setup_suspended_pkgs') &&
876 ! $cust_pkg->getfield('susp')
884 warn " bill setup\n" if $DEBUG > 1;
886 unless ( $cust_pkg->waive_setup ) {
889 $setup = eval { $cust_pkg->calc_setup( $time, \@details, \%setup_param ) };
890 return "$@ running calc_setup for $cust_pkg\n"
893 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
896 $cust_pkg->setfield('setup', $time)
897 unless $cust_pkg->setup;
898 #do need it, but it won't get written to the db
899 #|| $cust_pkg->pkgpart != $real_pkgpart;
901 $cust_pkg->setfield('start_date', '')
902 if $cust_pkg->start_date;
910 #XXX unit stuff here too
914 if ( ! $cust_pkg->start_date
915 and ( ! $cust_pkg->susp || $part_pkg->option('suspend_bill', 1) )
917 ( $part_pkg->freq ne '0' && ( $cust_pkg->bill || 0 ) <= day_end($time) )
918 || ( $part_pkg->plan eq 'voip_cdr'
919 && $part_pkg->option('bill_every_call')
924 # XXX should this be a package event? probably. events are called
925 # at collection time at the moment, though...
926 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
927 if $part_pkg->can('reset_usage') && !$options{'no_usage_reset'};
928 #don't want to reset usage just cause we want a line item??
929 #&& $part_pkg->pkgpart == $real_pkgpart;
931 warn " bill recur\n" if $DEBUG > 1;
934 # XXX shared with $recur_prog
935 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
939 #over two params! lets at least switch to a hashref for the rest...
940 my $increment_next_bill = ( $part_pkg->freq ne '0'
941 && ( $cust_pkg->getfield('bill') || 0 ) <= day_end($time)
944 my %param = ( 'precommit_hooks' => $precommit_hooks,
945 'increment_next_bill' => $increment_next_bill,
946 'discounts' => \@discounts,
947 'real_pkgpart' => $real_pkgpart,
948 'freq_override' => $options{freq_override} || '',
953 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
955 # There may be some part_pkg for which this is wrong. Only those
956 # which can_discount are supported.
957 # (the UI should prevent adding discounts to these at the moment)
959 warn "calling $method on cust_pkg ". $cust_pkg->pkgnum.
960 " for pkgpart ". $cust_pkg->pkgpart.
961 " with params ". join(' / ', map "$_=>$param{$_}", keys %param). "\n"
964 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
965 return "$@ running $method for $cust_pkg\n"
968 if ( $increment_next_bill ) {
970 my $next_bill = $part_pkg->add_freq($sdate, $options{freq_override} || 0);
971 return "unparsable frequency: ". $part_pkg->freq
974 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
975 # only for figuring next bill date, nothing else, so, reset $sdate again
977 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
978 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
979 $cust_pkg->last_bill($sdate);
981 $cust_pkg->setfield('bill', $next_bill );
985 if ( $param{'setup_fee'} ) {
986 # Add an additional setup fee at the billing stage.
987 # Used for prorate_defer_bill.
988 $setup += $param{'setup_fee'};
989 $unitsetup += $param{'setup_fee'};
993 if ( defined $param{'discount_left_setup'} ) {
994 foreach my $discount_setup ( values %{$param{'discount_left_setup'}} ) {
995 $setup -= $discount_setup;
1001 warn "\$setup is undefined" unless defined($setup);
1002 warn "\$recur is undefined" unless defined($recur);
1003 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1006 # If there's line items, create em cust_bill_pkg records
1007 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
1012 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
1013 # hmm.. and if just the options are modified in some weird price plan?
1015 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
1018 my $error = $cust_pkg->replace( $old_cust_pkg,
1019 'depend_jobnum'=>$options{depend_jobnum},
1020 'options' => { $cust_pkg->options },
1022 unless $options{no_commit};
1023 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
1024 if $error; #just in case
1027 $setup = sprintf( "%.2f", $setup );
1028 $recur = sprintf( "%.2f", $recur );
1029 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
1030 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1032 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
1033 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
1036 my $discount_show_always = ($recur == 0 && scalar(@discounts)
1037 && $conf->exists('discount-show-always'));
1041 || (!$part_pkg->hidden && $options{has_hidden}) #include some $0 lines
1042 || $discount_show_always
1043 || ($setup == 0 && $cust_pkg->_X_show_zero('setup'))
1044 || ($recur == 0 && $cust_pkg->_X_show_zero('recur'))
1048 warn " charges (setup=$setup, recur=$recur); adding line items\n"
1051 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
1053 warn " adding customer package invoice detail: $_\n"
1054 foreach @cust_pkg_detail;
1056 push @details, @cust_pkg_detail;
1058 my $cust_bill_pkg = new FS::cust_bill_pkg {
1059 'pkgnum' => $cust_pkg->pkgnum,
1061 'unitsetup' => $unitsetup,
1063 'unitrecur' => $unitrecur,
1064 'quantity' => $cust_pkg->quantity,
1065 'details' => \@details,
1066 'discounts' => \@discounts,
1067 'hidden' => $part_pkg->hidden,
1068 'freq' => $part_pkg->freq,
1071 if ( $part_pkg->recur_temporality eq 'preceding' ) {
1072 $cust_bill_pkg->sdate( $hash{last_bill} );
1073 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
1074 $cust_bill_pkg->edate( $time ) if $options{cancel};
1075 } else { #if ( $part_pkg->recur_temporality eq 'upcoming' ) {
1076 $cust_bill_pkg->sdate( $sdate );
1077 $cust_bill_pkg->edate( $cust_pkg->bill );
1078 #$cust_bill_pkg->edate( $time ) if $options{cancel};
1081 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
1082 unless $part_pkg->pkgpart == $real_pkgpart;
1084 $$total_setup += $setup;
1085 $$total_recur += $recur;
1091 unless ( $discount_show_always ) {
1093 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart, \%options);
1094 return $error if $error;
1097 push @$cust_bill_pkgs, $cust_bill_pkg;
1099 } #if $setup != 0 || $recur != 0
1109 my $part_pkg = shift;
1110 my $taxlisthash = shift;
1111 my $cust_bill_pkg = shift;
1112 my $cust_pkg = shift;
1113 my $invoice_time = shift;
1114 my $real_pkgpart = shift;
1115 my $options = shift;
1117 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1119 my %cust_bill_pkg = ();
1123 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
1124 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
1125 push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
1126 push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
1128 if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
1130 if ( $conf->exists('enable_taxproducts')
1131 && ( scalar($part_pkg->part_pkg_taxoverride)
1132 || $part_pkg->has_taxproduct
1137 foreach my $class (@classes) {
1138 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class, $cust_pkg );
1139 return $err_or_ref unless ref($err_or_ref);
1140 $taxes{$class} = $err_or_ref;
1143 unless (exists $taxes{''}) {
1144 my $err_or_ref = $self->_gather_taxes( $part_pkg, '', $cust_pkg );
1145 return $err_or_ref unless ref($err_or_ref);
1146 $taxes{''} = $err_or_ref;
1151 my @loc_keys = qw( city county state country );
1153 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1154 my $cust_location = $cust_pkg->cust_location;
1155 %taxhash = map { $_ => $cust_location->$_() } @loc_keys;
1158 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
1161 %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
1164 $taxhash{'taxclass'} = $part_pkg->taxclass;
1167 my %taxhash_elim = %taxhash;
1168 my @elim = qw( city county state );
1171 #first try a match with taxclass
1172 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1174 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1175 #then try a match without taxclass
1176 my %no_taxclass = %taxhash_elim;
1177 $no_taxclass{ 'taxclass' } = '';
1178 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1181 $taxhash_elim{ shift(@elim) } = '';
1183 } while ( !scalar(@taxes) && scalar(@elim) );
1185 @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
1187 if $self->cust_main_exemption; #just to be safe
1189 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1191 $_->set('pkgnum', $cust_pkg->pkgnum );
1192 $_->set('locationnum', $cust_pkg->locationnum );
1196 $taxes{''} = [ @taxes ];
1197 $taxes{'setup'} = [ @taxes ];
1198 $taxes{'recur'} = [ @taxes ];
1199 $taxes{$_} = [ @taxes ] foreach (@classes);
1201 # # maybe eliminate this entirely, along with all the 0% records
1202 # unless ( @taxes ) {
1204 # "fatal: can't find tax rate for state/county/country/taxclass ".
1205 # join('/', map $taxhash{$_}, qw(state county country taxclass) );
1208 } #if $conf->exists('enable_taxproducts') ...
1212 #what's this doing in the middle of _handle_taxes? probably should split
1213 #this into three parts above in _make_lines
1214 $cust_bill_pkg->set_display( part_pkg => $part_pkg,
1215 real_pkgpart => $real_pkgpart,
1218 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
1219 foreach my $key (keys %tax_cust_bill_pkg) {
1220 my @taxes = @{ $taxes{$key} || [] };
1221 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
1223 my %localtaxlisthash = ();
1224 foreach my $tax ( @taxes ) {
1226 my $taxname = ref( $tax ). ' '. $tax->taxnum;
1227 # $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
1228 # ' locationnum'. $cust_pkg->locationnum
1229 # if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
1231 $taxlisthash->{ $taxname } ||= [ $tax ];
1232 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
1234 $localtaxlisthash{ $taxname } ||= [ $tax ];
1235 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
1239 warn "finding taxed taxes...\n" if $DEBUG > 2;
1240 foreach my $tax ( keys %localtaxlisthash ) {
1241 my $tax_object = shift @{ $localtaxlisthash{$tax} };
1242 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
1244 next unless $tax_object->can('tax_on_tax');
1246 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
1247 my $totname = ref( $tot ). ' '. $tot->taxnum;
1249 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
1251 next unless exists( $localtaxlisthash{ $totname } ); # only increase
1253 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
1254 my $hashref_or_error =
1255 $tax_object->taxline( $localtaxlisthash{$tax},
1256 'custnum' => $self->custnum,
1257 'invoice_time' => $invoice_time,
1259 return $hashref_or_error
1260 unless ref($hashref_or_error);
1262 $taxlisthash->{ $totname } ||= [ $tot ];
1263 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
1275 my $part_pkg = shift;
1277 my $cust_pkg = shift;
1279 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1282 if ( $cust_pkg->locationnum && $conf->exists('tax-pkg_address') ) {
1283 $geocode = $cust_pkg->cust_location->geocode('cch');
1285 $geocode = $self->geocode('cch');
1290 my @taxclassnums = map { $_->taxclassnum }
1291 $part_pkg->part_pkg_taxoverride($class);
1293 unless (@taxclassnums) {
1294 @taxclassnums = map { $_->taxclassnum }
1295 grep { $_->taxable eq 'Y' }
1296 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
1298 warn "Found taxclassnum values of ". join(',', @taxclassnums)
1303 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
1305 @taxes = qsearch({ 'table' => 'tax_rate',
1306 'hashref' => { 'geocode' => $geocode, },
1307 'extra_sql' => $extra_sql,
1309 if scalar(@taxclassnums);
1311 warn "Found taxes ".
1312 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
1319 =item collect [ HASHREF | OPTION => VALUE ... ]
1321 (Attempt to) collect money for this customer's outstanding invoices (see
1322 L<FS::cust_bill>). Usually used after the bill method.
1324 Actions are now triggered by billing events; see L<FS::part_event> and the
1325 billing events web interface. Old-style invoice events (see
1326 L<FS::part_bill_event>) have been deprecated.
1328 If there is an error, returns the error, otherwise returns false.
1330 Options are passed as name-value pairs.
1332 Currently available options are:
1338 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.
1342 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1346 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1350 set true to surpress email card/ACH decline notices.
1354 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)
1360 # allows for one time override of normal customer billing method
1365 my( $self, %options ) = @_;
1367 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1369 my $invoice_time = $options{'invoice_time'} || time;
1372 local $SIG{HUP} = 'IGNORE';
1373 local $SIG{INT} = 'IGNORE';
1374 local $SIG{QUIT} = 'IGNORE';
1375 local $SIG{TERM} = 'IGNORE';
1376 local $SIG{TSTP} = 'IGNORE';
1377 local $SIG{PIPE} = 'IGNORE';
1379 my $oldAutoCommit = $FS::UID::AutoCommit;
1380 local $FS::UID::AutoCommit = 0;
1383 $self->select_for_update; #mutex
1386 my $balance = $self->balance;
1387 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
1390 if ( exists($options{'retry_card'}) ) {
1391 carp 'retry_card option passed to collect is deprecated; use retry';
1392 $options{'retry'} ||= $options{'retry_card'};
1394 if ( exists($options{'retry'}) && $options{'retry'} ) {
1395 my $error = $self->retry_realtime;
1397 $dbh->rollback if $oldAutoCommit;
1402 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1404 #never want to roll back an event just because it returned an error
1405 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1407 $self->do_cust_event(
1408 'debug' => ( $options{'debug'} || 0 ),
1409 'time' => $invoice_time,
1410 'check_freq' => $options{'check_freq'},
1411 'stage' => 'collect',
1416 =item retry_realtime
1418 Schedules realtime / batch credit card / electronic check / LEC billing
1419 events for for retry. Useful if card information has changed or manual
1420 retry is desired. The 'collect' method must be called to actually retry
1423 Implementation details: For either this customer, or for each of this
1424 customer's open invoices, changes the status of the first "done" (with
1425 statustext error) realtime processing event to "failed".
1429 sub retry_realtime {
1432 local $SIG{HUP} = 'IGNORE';
1433 local $SIG{INT} = 'IGNORE';
1434 local $SIG{QUIT} = 'IGNORE';
1435 local $SIG{TERM} = 'IGNORE';
1436 local $SIG{TSTP} = 'IGNORE';
1437 local $SIG{PIPE} = 'IGNORE';
1439 my $oldAutoCommit = $FS::UID::AutoCommit;
1440 local $FS::UID::AutoCommit = 0;
1443 #a little false laziness w/due_cust_event (not too bad, really)
1445 my $join = FS::part_event_condition->join_conditions_sql;
1446 my $order = FS::part_event_condition->order_conditions_sql;
1449 . join ( ' OR ' , map {
1450 "( part_event.eventtable = " . dbh->quote($_)
1451 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
1452 } FS::part_event->eventtables)
1455 #here is the agent virtualization
1456 my $agent_virt = " ( part_event.agentnum IS NULL
1457 OR part_event.agentnum = ". $self->agentnum. ' )';
1459 #XXX this shouldn't be hardcoded, actions should declare it...
1460 my @realtime_events = qw(
1461 cust_bill_realtime_card
1462 cust_bill_realtime_check
1463 cust_bill_realtime_lec
1467 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
1472 my @cust_event = qsearchs({
1473 'table' => 'cust_event',
1474 'select' => 'cust_event.*',
1475 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
1476 'hashref' => { 'status' => 'done' },
1477 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
1478 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
1481 my %seen_invnum = ();
1482 foreach my $cust_event (@cust_event) {
1484 #max one for the customer, one for each open invoice
1485 my $cust_X = $cust_event->cust_X;
1486 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
1490 or $cust_event->part_event->eventtable eq 'cust_bill'
1493 my $error = $cust_event->retry;
1495 $dbh->rollback if $oldAutoCommit;
1496 return "error scheduling event for retry: $error";
1501 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1506 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
1508 Runs billing events; see L<FS::part_event> and the billing events web
1511 If there is an error, returns the error, otherwise returns false.
1513 Options are passed as name-value pairs.
1515 Currently available options are:
1521 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.
1525 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1529 "collect" (the default) or "pre-bill"
1533 set true to surpress email card/ACH decline notices.
1537 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)
1544 # allows for one time override of normal customer billing method
1548 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1551 my( $self, %options ) = @_;
1553 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1555 my $time = $options{'time'} || time;
1558 local $SIG{HUP} = 'IGNORE';
1559 local $SIG{INT} = 'IGNORE';
1560 local $SIG{QUIT} = 'IGNORE';
1561 local $SIG{TERM} = 'IGNORE';
1562 local $SIG{TSTP} = 'IGNORE';
1563 local $SIG{PIPE} = 'IGNORE';
1565 my $oldAutoCommit = $FS::UID::AutoCommit;
1566 local $FS::UID::AutoCommit = 0;
1569 $self->select_for_update; #mutex
1572 my $balance = $self->balance;
1573 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
1576 # if ( exists($options{'retry_card'}) ) {
1577 # carp 'retry_card option passed to collect is deprecated; use retry';
1578 # $options{'retry'} ||= $options{'retry_card'};
1580 # if ( exists($options{'retry'}) && $options{'retry'} ) {
1581 # my $error = $self->retry_realtime;
1583 # $dbh->rollback if $oldAutoCommit;
1588 # false laziness w/pay_batch::import_results
1590 my $due_cust_event = $self->due_cust_event(
1591 'debug' => ( $options{'debug'} || 0 ),
1593 'check_freq' => $options{'check_freq'},
1594 'stage' => ( $options{'stage'} || 'collect' ),
1596 unless( ref($due_cust_event) ) {
1597 $dbh->rollback if $oldAutoCommit;
1598 return $due_cust_event;
1601 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1602 #never want to roll back an event just because it or a different one
1604 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1606 foreach my $cust_event ( @$due_cust_event ) {
1610 #re-eval event conditions (a previous event could have changed things)
1611 unless ( $cust_event->test_conditions( 'time' => $time ) ) {
1612 #don't leave stray "new/locked" records around
1613 my $error = $cust_event->delete;
1614 return $error if $error;
1619 local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
1620 if $options{'quiet'};
1621 warn " running cust_event ". $cust_event->eventnum. "\n"
1624 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
1625 if ( my $error = $cust_event->do_event( 'time' => $time ) ) {
1626 #XXX wtf is this? figure out a proper dealio with return value
1638 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
1640 Inserts database records for and returns an ordered listref of new events due
1641 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
1642 events are due, an empty listref is returned. If there is an error, returns a
1643 scalar error message.
1645 To actually run the events, call each event's test_condition method, and if
1646 still true, call the event's do_event method.
1648 Options are passed as a hashref or as a list of name-value pairs. Available
1655 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.
1659 "collect" (the default) or "pre-bill"
1663 "Current time" for the events.
1667 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)
1671 Only return events for the specified eventtable (by default, events of all eventtables are returned)
1675 Explicitly pass the objects to be tested (typically used with eventtable).
1679 Set to true to return the objects, but not actually insert them into the
1686 sub due_cust_event {
1688 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
1691 #my $DEBUG = $opt{'debug'}
1692 local($DEBUG) = $opt{'debug'}
1693 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
1694 $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1696 warn "$me due_cust_event called with options ".
1697 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
1700 $opt{'time'} ||= time;
1702 local $SIG{HUP} = 'IGNORE';
1703 local $SIG{INT} = 'IGNORE';
1704 local $SIG{QUIT} = 'IGNORE';
1705 local $SIG{TERM} = 'IGNORE';
1706 local $SIG{TSTP} = 'IGNORE';
1707 local $SIG{PIPE} = 'IGNORE';
1709 my $oldAutoCommit = $FS::UID::AutoCommit;
1710 local $FS::UID::AutoCommit = 0;
1713 $self->select_for_update #mutex
1714 unless $opt{testonly};
1717 # find possible events (initial search)
1720 my @cust_event = ();
1722 my @eventtable = $opt{'eventtable'}
1723 ? ( $opt{'eventtable'} )
1724 : FS::part_event->eventtables_runorder;
1726 my $check_freq = $opt{'check_freq'} || '1d';
1728 foreach my $eventtable ( @eventtable ) {
1731 if ( $opt{'objects'} ) {
1733 @objects = @{ $opt{'objects'} };
1737 #my @objects = $self->$eventtable(); # sub cust_main { @{ [ $self ] }; }
1738 if ( $eventtable eq 'cust_main' ) {
1739 @objects = ( $self );
1743 "LEFT JOIN cust_main USING ( custnum )";
1745 #some false laziness w/Cron::bill bill_where
1747 my $join = FS::part_event_condition->join_conditions_sql( $eventtable);
1748 my $where = FS::part_event_condition->where_conditions_sql($eventtable,
1749 'time'=>$opt{'time'},
1751 $where = $where ? "AND $where" : '';
1753 my $are_part_event =
1754 "EXISTS ( SELECT 1 FROM part_event $join
1755 WHERE check_freq = '$check_freq'
1756 AND eventtable = '$eventtable'
1757 AND ( disabled = '' OR disabled IS NULL )
1763 @objects = $self->$eventtable(
1764 'addl_from' => $cm_join,
1765 'extra_sql' => " AND $are_part_event",
1771 my @e_cust_event = ();
1773 my $cross = "CROSS JOIN $eventtable";
1774 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
1775 unless $eventtable eq 'cust_main';
1777 foreach my $object ( @objects ) {
1779 #this first search uses the condition_sql magic for optimization.
1780 #the more possible events we can eliminate in this step the better
1782 my $cross_where = '';
1783 my $pkey = $object->primary_key;
1784 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
1786 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
1788 FS::part_event_condition->where_conditions_sql( $eventtable,
1789 'time'=>$opt{'time'}
1791 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
1793 $extra_sql = "AND $extra_sql" if $extra_sql;
1795 #here is the agent virtualization
1796 $extra_sql .= " AND ( part_event.agentnum IS NULL
1797 OR part_event.agentnum = ". $self->agentnum. ' )';
1799 $extra_sql .= " $order";
1801 warn "searching for events for $eventtable ". $object->$pkey. "\n"
1802 if $opt{'debug'} > 2;
1803 my @part_event = qsearch( {
1804 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
1805 'select' => 'part_event.*',
1806 'table' => 'part_event',
1807 'addl_from' => "$cross $join",
1808 'hashref' => { 'check_freq' => $check_freq,
1809 'eventtable' => $eventtable,
1812 'extra_sql' => "AND $cross_where $extra_sql",
1816 my $pkey = $object->primary_key;
1817 warn " ". scalar(@part_event).
1818 " possible events found for $eventtable ". $object->$pkey(). "\n";
1821 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
1825 warn " ". scalar(@e_cust_event).
1826 " subtotal possible cust events found for $eventtable\n"
1829 push @cust_event, @e_cust_event;
1833 warn " ". scalar(@cust_event).
1834 " total possible cust events found in initial search\n"
1842 $opt{stage} ||= 'collect';
1844 grep { my $stage = $_->part_event->event_stage;
1845 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
1855 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
1856 'stats_hashref' => \%unsat ),
1859 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
1862 warn " invalid conditions not eliminated with condition_sql:\n".
1863 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
1864 if keys %unsat && $DEBUG; # > 1;
1870 unless( $opt{testonly} ) {
1871 foreach my $cust_event ( @cust_event ) {
1873 my $error = $cust_event->insert();
1875 $dbh->rollback if $oldAutoCommit;
1882 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1888 warn " returning events: ". Dumper(@cust_event). "\n"
1895 =item apply_payments_and_credits [ OPTION => VALUE ... ]
1897 Applies unapplied payments and credits.
1899 In most cases, this new method should be used in place of sequential
1900 apply_payments and apply_credits methods.
1902 A hash of optional arguments may be passed. Currently "manual" is supported.
1903 If true, a payment receipt is sent instead of a statement when
1904 'payment_receipt_email' configuration option is set.
1906 If there is an error, returns the error, otherwise returns false.
1910 sub apply_payments_and_credits {
1911 my( $self, %options ) = @_;
1913 local $SIG{HUP} = 'IGNORE';
1914 local $SIG{INT} = 'IGNORE';
1915 local $SIG{QUIT} = 'IGNORE';
1916 local $SIG{TERM} = 'IGNORE';
1917 local $SIG{TSTP} = 'IGNORE';
1918 local $SIG{PIPE} = 'IGNORE';
1920 my $oldAutoCommit = $FS::UID::AutoCommit;
1921 local $FS::UID::AutoCommit = 0;
1924 $self->select_for_update; #mutex
1926 foreach my $cust_bill ( $self->open_cust_bill ) {
1927 my $error = $cust_bill->apply_payments_and_credits(%options);
1929 $dbh->rollback if $oldAutoCommit;
1930 return "Error applying: $error";
1934 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1939 =item apply_credits OPTION => VALUE ...
1941 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
1942 to outstanding invoice balances in chronological order (or reverse
1943 chronological order if the I<order> option is set to B<newest>) and returns the
1944 value of any remaining unapplied credits available for refund (see
1945 L<FS::cust_refund>).
1947 Dies if there is an error.
1955 local $SIG{HUP} = 'IGNORE';
1956 local $SIG{INT} = 'IGNORE';
1957 local $SIG{QUIT} = 'IGNORE';
1958 local $SIG{TERM} = 'IGNORE';
1959 local $SIG{TSTP} = 'IGNORE';
1960 local $SIG{PIPE} = 'IGNORE';
1962 my $oldAutoCommit = $FS::UID::AutoCommit;
1963 local $FS::UID::AutoCommit = 0;
1966 $self->select_for_update; #mutex
1968 unless ( $self->total_unapplied_credits ) {
1969 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1973 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
1974 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
1976 my @invoices = $self->open_cust_bill;
1977 @invoices = sort { $b->_date <=> $a->_date } @invoices
1978 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
1980 if ( $conf->exists('pkg-balances') ) {
1981 # limit @credits to those w/ a pkgnum grepped from $self
1983 foreach my $i (@invoices) {
1984 foreach my $li ( $i->cust_bill_pkg ) {
1985 $pkgnums{$li->pkgnum} = 1;
1988 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
1993 foreach my $cust_bill ( @invoices ) {
1995 if ( !defined($credit) || $credit->credited == 0) {
1996 $credit = pop @credits or last;
2000 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
2001 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
2003 $owed = $cust_bill->owed;
2005 unless ( $owed > 0 ) {
2006 push @credits, $credit;
2010 my $amount = min( $credit->credited, $owed );
2012 my $cust_credit_bill = new FS::cust_credit_bill ( {
2013 'crednum' => $credit->crednum,
2014 'invnum' => $cust_bill->invnum,
2015 'amount' => $amount,
2017 $cust_credit_bill->pkgnum( $credit->pkgnum )
2018 if $conf->exists('pkg-balances') && $credit->pkgnum;
2019 my $error = $cust_credit_bill->insert;
2021 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2025 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2029 my $total_unapplied_credits = $self->total_unapplied_credits;
2031 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2033 return $total_unapplied_credits;
2036 =item apply_payments [ OPTION => VALUE ... ]
2038 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2039 to outstanding invoice balances in chronological order.
2041 #and returns the value of any remaining unapplied payments.
2043 A hash of optional arguments may be passed. Currently "manual" is supported.
2044 If true, a payment receipt is sent instead of a statement when
2045 'payment_receipt_email' configuration option is set.
2047 Dies if there is an error.
2051 sub apply_payments {
2052 my( $self, %options ) = @_;
2054 local $SIG{HUP} = 'IGNORE';
2055 local $SIG{INT} = 'IGNORE';
2056 local $SIG{QUIT} = 'IGNORE';
2057 local $SIG{TERM} = 'IGNORE';
2058 local $SIG{TSTP} = 'IGNORE';
2059 local $SIG{PIPE} = 'IGNORE';
2061 my $oldAutoCommit = $FS::UID::AutoCommit;
2062 local $FS::UID::AutoCommit = 0;
2065 $self->select_for_update; #mutex
2069 my @payments = sort { $b->_date <=> $a->_date }
2070 grep { $_->unapplied > 0 }
2073 my @invoices = sort { $a->_date <=> $b->_date}
2074 grep { $_->owed > 0 }
2077 if ( $conf->exists('pkg-balances') ) {
2078 # limit @payments to those w/ a pkgnum grepped from $self
2080 foreach my $i (@invoices) {
2081 foreach my $li ( $i->cust_bill_pkg ) {
2082 $pkgnums{$li->pkgnum} = 1;
2085 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
2090 foreach my $cust_bill ( @invoices ) {
2092 if ( !defined($payment) || $payment->unapplied == 0 ) {
2093 $payment = pop @payments or last;
2097 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
2098 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
2100 $owed = $cust_bill->owed;
2102 unless ( $owed > 0 ) {
2103 push @payments, $payment;
2107 my $amount = min( $payment->unapplied, $owed );
2110 'paynum' => $payment->paynum,
2111 'invnum' => $cust_bill->invnum,
2112 'amount' => $amount,
2114 $cbp->{_date} = $payment->_date
2115 if $options{'manual'} && $options{'backdate_application'};
2116 my $cust_bill_pay = new FS::cust_bill_pay($cbp);
2117 $cust_bill_pay->pkgnum( $payment->pkgnum )
2118 if $conf->exists('pkg-balances') && $payment->pkgnum;
2119 my $error = $cust_bill_pay->insert(%options);
2121 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2125 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2129 my $total_unapplied_payments = $self->total_unapplied_payments;
2131 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2133 return $total_unapplied_payments;
2143 suspend_adjourned_pkgs
2146 (do_cust_event pre-bill)
2149 (vendor-only) _gather_taxes
2150 _omit_zero_value_bundles
2153 apply_payments_and_credits
2162 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>