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 );
11 use FS::cust_bill_pkg;
12 use FS::cust_bill_pkg_display;
13 use FS::cust_bill_pay;
14 use FS::cust_credit_bill;
15 use FS::cust_tax_adjustment;
17 use FS::tax_rate_location;
18 use FS::cust_bill_pkg_tax_location;
19 use FS::cust_bill_pkg_tax_rate_location;
21 use FS::part_event_condition;
24 # 1 is mostly method/subroutine entry and options
25 # 2 traces progress of some operations
26 # 3 is even more information including possibly sensitive data
28 $me = '[FS::cust_main::Billing]';
30 install_callback FS::UID sub {
32 #yes, need it for stuff below (prolly should be cached)
37 FS::cust_main::Billing - Billing mixin for cust_main
43 These methods are available on FS::cust_main objects.
49 =item bill_and_collect
51 Cancels and suspends any packages due, generates bills, applies payments and
52 credits, and applies collection events to run cards, send bills and notices,
55 By default, warns on errors and continues with the next operation (but see the
58 Options are passed as name-value pairs. Currently available options are:
64 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:
68 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
72 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.
76 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
80 If set true, re-charges setup fees.
84 If set any errors prevent subsequent operations from continusing. If set
85 specifically to "return", returns the error (or false, if there is no error).
86 Any other true value causes errors to die.
90 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)
94 Optional FS::queue entry to receive status updates.
98 Options are passed to the B<bill> and B<collect> methods verbatim, so all
99 options of those methods are also available.
103 sub bill_and_collect {
104 my( $self, %options ) = @_;
108 #$options{actual_time} not $options{time} because freeside-daily -d is for
109 #pre-printing invoices
111 $options{'actual_time'} ||= time;
112 my $job = $options{'job'};
114 $job->update_statustext('0,cleaning expired packages') if $job;
115 $error = $self->cancel_expired_pkgs( $options{actual_time} );
117 $error = "Error expiring custnum ". $self->custnum. ": $error";
118 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
119 elsif ( $options{fatal} ) { die $error; }
120 else { warn $error; }
123 $error = $self->suspend_adjourned_pkgs( $options{actual_time} );
125 $error = "Error adjourning custnum ". $self->custnum. ": $error";
126 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
127 elsif ( $options{fatal} ) { die $error; }
128 else { warn $error; }
131 $job->update_statustext('20,billing packages') if $job;
132 $error = $self->bill( %options );
134 $error = "Error billing custnum ". $self->custnum. ": $error";
135 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
136 elsif ( $options{fatal} ) { die $error; }
137 else { warn $error; }
140 $job->update_statustext('50,applying payments and credits') if $job;
141 $error = $self->apply_payments_and_credits;
143 $error = "Error applying custnum ". $self->custnum. ": $error";
144 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
145 elsif ( $options{fatal} ) { die $error; }
146 else { warn $error; }
149 $job->update_statustext('70,running collection events') if $job;
150 unless ( $conf->exists('cancelled_cust-noevents')
151 && ! $self->num_ncancelled_pkgs
153 $error = $self->collect( %options );
155 $error = "Error collecting custnum ". $self->custnum. ": $error";
156 if ($options{fatal} && $options{fatal} eq 'return') { return $error; }
157 elsif ($options{fatal} ) { die $error; }
158 else { warn $error; }
161 $job->update_statustext('100,finished') if $job;
167 sub cancel_expired_pkgs {
168 my ( $self, $time, %options ) = @_;
170 my @cancel_pkgs = $self->ncancelled_pkgs( {
171 'extra_sql' => " AND expire IS NOT NULL AND expire > 0 AND expire <= $time "
176 foreach my $cust_pkg ( @cancel_pkgs ) {
177 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
178 my $error = $cust_pkg->cancel($cpr ? ( 'reason' => $cpr->reasonnum,
179 'reason_otaker' => $cpr->otaker
183 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
186 scalar(@errors) ? join(' / ', @errors) : '';
190 sub suspend_adjourned_pkgs {
191 my ( $self, $time, %options ) = @_;
193 my @susp_pkgs = $self->ncancelled_pkgs( {
195 " AND ( susp IS NULL OR susp = 0 )
196 AND ( ( bill IS NOT NULL AND bill != 0 AND bill < $time )
197 OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
202 #only because there's no SQL test for is_prepaid :/
204 grep { ( $_->part_pkg->is_prepaid
209 && $_->adjourn <= $time
217 foreach my $cust_pkg ( @susp_pkgs ) {
218 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
219 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
220 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
221 'reason_otaker' => $cpr->otaker
225 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
228 scalar(@errors) ? join(' / ', @errors) : '';
234 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
235 conjunction with the collect method by calling B<bill_and_collect>.
237 If there is an error, returns the error, otherwise returns false.
239 Options are passed as name-value pairs. Currently available options are:
245 If set true, re-charges setup fees.
249 If set true then only bill recurring charges, not setup, usage, one time
254 If set, then override the normal frequency and look for a part_pkg_discount
255 to take at that frequency.
259 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:
263 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
267 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
269 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
273 A hashref of pkgparts to exclude from this billing run (can also be specified as a comma-separated scalar).
277 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.
281 This boolean value informs the us that the package is being cancelled. This
282 typically might mean not charging the normal recurring fee but only usage
283 fees since the last billing. Setup charges may be charged. Not all package
284 plans support this feature (they tend to charge 0).
288 Prevent the resetting of usage limits during this call.
292 Do not save the generated bill in the database. Useful with return_bill
296 A list reference on which the generated bill(s) will be returned.
300 Optional terms to be printed on this invoice. Otherwise, customer-specific
301 terms or the default terms are used.
308 my( $self, %options ) = @_;
310 return '' if $self->payby eq 'COMP';
312 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
314 warn "$me bill customer ". $self->custnum. "\n"
317 my $time = $options{'time'} || time;
318 my $invoice_time = $options{'invoice_time'} || $time;
320 $options{'not_pkgpart'} ||= {};
321 $options{'not_pkgpart'} = { map { $_ => 1 }
322 split(/\s*,\s*/, $options{'not_pkgpart'})
324 unless ref($options{'not_pkgpart'});
326 local $SIG{HUP} = 'IGNORE';
327 local $SIG{INT} = 'IGNORE';
328 local $SIG{QUIT} = 'IGNORE';
329 local $SIG{TERM} = 'IGNORE';
330 local $SIG{TSTP} = 'IGNORE';
331 local $SIG{PIPE} = 'IGNORE';
333 my $oldAutoCommit = $FS::UID::AutoCommit;
334 local $FS::UID::AutoCommit = 0;
337 warn "$me acquiring lock on customer ". $self->custnum. "\n"
340 $self->select_for_update; #mutex
342 warn "$me running pre-bill events for customer ". $self->custnum. "\n"
345 my $error = $self->do_cust_event(
346 'debug' => ( $options{'debug'} || 0 ),
347 'time' => $invoice_time,
348 'check_freq' => $options{'check_freq'},
349 'stage' => 'pre-bill',
351 unless $options{no_commit};
353 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
357 warn "$me done running pre-bill events for customer ". $self->custnum. "\n"
360 #keep auto-charge and non-auto-charge line items separate
361 my @passes = ( '', 'no_auto' );
363 my %cust_bill_pkg = map { $_ => [] } @passes;
366 # find the packages which are due for billing, find out how much they are
367 # & generate invoice database.
370 my %total_setup = map { my $z = 0; $_ => \$z; } @passes;
371 my %total_recur = map { my $z = 0; $_ => \$z; } @passes;
373 my %taxlisthash = map { $_ => {} } @passes;
375 my @precommit_hooks = ();
377 $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ]; #param checks?
378 foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
380 next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
382 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
384 #? to avoid use of uninitialized value errors... ?
385 $cust_pkg->setfield('bill', '')
386 unless defined($cust_pkg->bill);
388 #my $part_pkg = $cust_pkg->part_pkg;
390 my $real_pkgpart = $cust_pkg->pkgpart;
391 my %hash = $cust_pkg->hash;
393 # we could implement this bit as FS::part_pkg::has_hidden, but we already
394 # suffer from performance issues
395 $options{has_hidden} = 0;
396 my @part_pkg = $cust_pkg->part_pkg->self_and_bill_linked;
397 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
399 foreach my $part_pkg ( @part_pkg ) {
401 $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
403 my $pass = ($cust_pkg->no_auto || $part_pkg->no_auto) ? 'no_auto' : '';
406 $self->_make_lines( 'part_pkg' => $part_pkg,
407 'cust_pkg' => $cust_pkg,
408 'precommit_hooks' => \@precommit_hooks,
409 'line_items' => $cust_bill_pkg{$pass},
410 'setup' => $total_setup{$pass},
411 'recur' => $total_recur{$pass},
412 'tax_matrix' => $taxlisthash{$pass},
414 'real_pkgpart' => $real_pkgpart,
415 'options' => \%options,
418 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
422 } #foreach my $part_pkg
424 } #foreach my $cust_pkg
426 #if the customer isn't on an automatic payby, everything can go on a single
428 #if ( $cust_main->payby !~ /^(CARD|CHEK)$/ ) {
429 #merge everything into one list
432 foreach my $pass (@passes) { # keys %cust_bill_pkg ) {
434 my @cust_bill_pkg = _omit_zero_value_bundles(@{ $cust_bill_pkg{$pass} });
436 next unless @cust_bill_pkg; #don't create an invoice w/o line items
438 warn "$me billing pass $pass\n"
439 #.Dumper(\@cust_bill_pkg)."\n"
442 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
443 !$conf->exists('postal_invoice-recurring_only')
447 my $postal_pkg = $self->charge_postal_fee();
448 if ( $postal_pkg && !ref( $postal_pkg ) ) {
450 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
451 return "can't charge postal invoice fee for customer ".
452 $self->custnum. ": $postal_pkg";
454 } elsif ( $postal_pkg ) {
456 my $real_pkgpart = $postal_pkg->pkgpart;
457 # we could implement this bit as FS::part_pkg::has_hidden, but we already
458 # suffer from performance issues
459 $options{has_hidden} = 0;
460 my @part_pkg = $postal_pkg->part_pkg->self_and_bill_linked;
461 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
463 foreach my $part_pkg ( @part_pkg ) {
464 my %postal_options = %options;
465 delete $postal_options{cancel};
467 $self->_make_lines( 'part_pkg' => $part_pkg,
468 'cust_pkg' => $postal_pkg,
469 'precommit_hooks' => \@precommit_hooks,
470 'line_items' => \@cust_bill_pkg,
471 'setup' => $total_setup{$pass},
472 'recur' => $total_recur{$pass},
473 'tax_matrix' => $taxlisthash{$pass},
475 'real_pkgpart' => $real_pkgpart,
476 'options' => \%postal_options,
479 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
484 # it's silly to have a zero value postal_pkg, but....
485 @cust_bill_pkg = _omit_zero_value_bundles(@cust_bill_pkg);
491 my $listref_or_error =
492 $self->calculate_taxes( \@cust_bill_pkg, $taxlisthash{$pass}, $invoice_time);
494 unless ( ref( $listref_or_error ) ) {
495 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
496 return $listref_or_error;
499 foreach my $taxline ( @$listref_or_error ) {
500 ${ $total_setup{$pass} } =
501 sprintf('%.2f', ${ $total_setup{$pass} } + $taxline->setup );
502 push @cust_bill_pkg, $taxline;
506 warn "adding tax adjustments...\n" if $DEBUG > 2;
507 foreach my $cust_tax_adjustment (
508 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
514 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
516 my $itemdesc = $cust_tax_adjustment->taxname;
517 $itemdesc = '' if $itemdesc eq 'Tax';
519 push @cust_bill_pkg, new FS::cust_bill_pkg {
525 'itemdesc' => $itemdesc,
526 'itemcomment' => $cust_tax_adjustment->comment,
527 'cust_tax_adjustment' => $cust_tax_adjustment,
528 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
533 my $charged = sprintf('%.2f', ${ $total_setup{$pass} } + ${ $total_recur{$pass} } );
535 my @cust_bill = $self->cust_bill;
536 my $balance = $self->balance;
537 my $previous_balance = scalar(@cust_bill)
538 ? ( $cust_bill[$#cust_bill]->billing_balance || 0 )
541 $previous_balance += $cust_bill[$#cust_bill]->charged
542 if scalar(@cust_bill);
543 #my $balance_adjustments =
544 # sprintf('%.2f', $balance - $prior_prior_balance - $prior_charged);
546 warn "creating the new invoice\n" if $DEBUG;
547 #create the new invoice
548 my $cust_bill = new FS::cust_bill ( {
549 'custnum' => $self->custnum,
550 '_date' => $invoice_time,
551 'charged' => $charged,
552 'billing_balance' => $balance,
553 'previous_balance' => $previous_balance,
554 'invoice_terms' => $options{'invoice_terms'},
555 'cust_bill_pkg' => \@cust_bill_pkg,
557 $error = $cust_bill->insert unless $options{no_commit};
559 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
560 return "can't create invoice for customer #". $self->custnum. ": $error";
562 push @{$options{return_bill}}, $cust_bill if $options{return_bill};
564 } #foreach my $pass ( keys %cust_bill_pkg )
566 foreach my $hook ( @precommit_hooks ) {
569 } unless $options{no_commit};
571 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
572 return "$@ running precommit hook $hook\n";
576 $dbh->commit or die $dbh->errstr if $oldAutoCommit && !$options{no_commit};
581 #discard bundled packages of 0 value
582 sub _omit_zero_value_bundles {
584 my @cust_bill_pkg = ();
585 my @cust_bill_pkg_bundle = ();
587 my $discount_show_always = 0;
589 foreach my $cust_bill_pkg ( @_ ) {
590 $discount_show_always = ($cust_bill_pkg->get('discounts')
591 && scalar(@{$cust_bill_pkg->get('discounts')})
592 && $conf->exists('discount-show-always'));
593 if (scalar(@cust_bill_pkg_bundle) && !$cust_bill_pkg->pkgpart_override) {
594 push @cust_bill_pkg, @cust_bill_pkg_bundle
595 if ($sum > 0 || ($sum == 0 && $discount_show_always));
596 @cust_bill_pkg_bundle = ();
599 $sum += $cust_bill_pkg->setup + $cust_bill_pkg->recur;
600 push @cust_bill_pkg_bundle, $cust_bill_pkg;
602 push @cust_bill_pkg, @cust_bill_pkg_bundle
603 if ($sum > 0 || ($sum == 0 && $discount_show_always));
609 =item calculate_taxes LINEITEMREF TAXHASHREF INVOICE_TIME
611 This is a weird one. Perhaps it should not even be exposed.
613 Generates tax line items (see L<FS::cust_bill_pkg>) for this customer.
614 Usually used internally by bill method B<bill>.
616 If there is an error, returns the error, otherwise returns reference to a
617 list of line items suitable for insertion.
623 An array ref of the line items being billed.
627 A strange beast. The keys to this hash are internal identifiers consisting
628 of the name of the tax object type, a space, and its unique identifier ( e.g.
629 'cust_main_county 23' ). The values of the hash are listrefs. The first
630 item in the list is the tax object. The remaining items are either line
631 items or floating point values (currency amounts).
633 The taxes are calculated on this entity. Calculated exemption records are
634 transferred to the LINEITEMREF items on the assumption that they are related.
640 This specifies the date appearing on the associated invoice. Some
641 jurisdictions (i.e. Texas) have tax exemptions which are date sensitive.
647 sub calculate_taxes {
648 my ($self, $cust_bill_pkg, $taxlisthash, $invoice_time) = @_;
650 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
652 warn "$me calculate_taxes\n"
653 #.Dumper($self, $cust_bill_pkg, $taxlisthash, $invoice_time). "\n"
656 my @tax_line_items = ();
658 # keys are tax names (as printed on invoices / itemdesc )
659 # values are listrefs of taxlisthash keys (internal identifiers)
662 # keys are taxlisthash keys (internal identifiers)
663 # values are (cumulative) amounts
666 # keys are taxlisthash keys (internal identifiers)
667 # values are listrefs of cust_bill_pkg_tax_location hashrefs
668 my %tax_location = ();
670 # keys are taxlisthash keys (internal identifiers)
671 # values are listrefs of cust_bill_pkg_tax_rate_location hashrefs
672 my %tax_rate_location = ();
674 foreach my $tax ( keys %$taxlisthash ) {
675 my $tax_object = shift @{ $taxlisthash->{$tax} };
676 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
677 warn " ". join('/', @{ $taxlisthash->{$tax} } ). "\n" if $DEBUG > 2;
678 my $hashref_or_error =
679 $tax_object->taxline( $taxlisthash->{$tax},
680 'custnum' => $self->custnum,
681 'invoice_time' => $invoice_time
683 return $hashref_or_error unless ref($hashref_or_error);
685 unshift @{ $taxlisthash->{$tax} }, $tax_object;
687 my $name = $hashref_or_error->{'name'};
688 my $amount = $hashref_or_error->{'amount'};
690 #warn "adding $amount as $name\n";
691 $taxname{ $name } ||= [];
692 push @{ $taxname{ $name } }, $tax;
694 $tax{ $tax } += $amount;
696 $tax_location{ $tax } ||= [];
697 if ( $tax_object->get('pkgnum') || $tax_object->get('locationnum') ) {
698 push @{ $tax_location{ $tax } },
700 'taxnum' => $tax_object->taxnum,
701 'taxtype' => ref($tax_object),
702 'pkgnum' => $tax_object->get('pkgnum'),
703 'locationnum' => $tax_object->get('locationnum'),
704 'amount' => sprintf('%.2f', $amount ),
708 $tax_rate_location{ $tax } ||= [];
709 if ( ref($tax_object) eq 'FS::tax_rate' ) {
710 my $taxratelocationnum =
711 $tax_object->tax_rate_location->taxratelocationnum;
712 push @{ $tax_rate_location{ $tax } },
714 'taxnum' => $tax_object->taxnum,
715 'taxtype' => ref($tax_object),
716 'amount' => sprintf('%.2f', $amount ),
717 'locationtaxid' => $tax_object->location,
718 'taxratelocationnum' => $taxratelocationnum,
724 #move the cust_tax_exempt_pkg records to the cust_bill_pkgs we will commit
725 my %packagemap = map { $_->pkgnum => $_ } @$cust_bill_pkg;
726 foreach my $tax ( keys %$taxlisthash ) {
727 foreach ( @{ $taxlisthash->{$tax} }[1 ... scalar(@{ $taxlisthash->{$tax} })] ) {
728 next unless ref($_) eq 'FS::cust_bill_pkg';
729 push @{ $packagemap{$_->pkgnum}->_cust_tax_exempt_pkg },
730 splice( @{ $_->_cust_tax_exempt_pkg } );
734 #consolidate and create tax line items
735 warn "consolidating and generating...\n" if $DEBUG > 2;
736 foreach my $taxname ( keys %taxname ) {
739 my @cust_bill_pkg_tax_location = ();
740 my @cust_bill_pkg_tax_rate_location = ();
741 warn "adding $taxname\n" if $DEBUG > 1;
742 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
743 next if $seen{$taxitem}++;
744 warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
745 $tax += $tax{$taxitem};
746 push @cust_bill_pkg_tax_location,
747 map { new FS::cust_bill_pkg_tax_location $_ }
748 @{ $tax_location{ $taxitem } };
749 push @cust_bill_pkg_tax_rate_location,
750 map { new FS::cust_bill_pkg_tax_rate_location $_ }
751 @{ $tax_rate_location{ $taxitem } };
755 $tax = sprintf('%.2f', $tax );
757 my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
763 if ( $pkg_category and
764 $conf->config('invoice_latexsummary') ||
765 $conf->config('invoice_htmlsummary')
769 my %hash = ( 'section' => $pkg_category->categoryname );
770 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
774 push @tax_line_items, new FS::cust_bill_pkg {
780 'itemdesc' => $taxname,
781 'display' => \@display,
782 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
783 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
792 my ($self, %params) = @_;
794 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
796 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
797 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
798 my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
799 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
800 my $total_setup = $params{setup} or die "no setup accumulator specified";
801 my $total_recur = $params{recur} or die "no recur accumulator specified";
802 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
803 my $time = $params{'time'} or die "no time specified";
804 my (%options) = %{$params{options}};
807 my $real_pkgpart = $params{real_pkgpart};
808 my %hash = $cust_pkg->hash;
809 my $old_cust_pkg = new FS::cust_pkg \%hash;
815 $cust_pkg->pkgpart($part_pkg->pkgpart);
823 if ( ! $options{recurring_only}
824 and ! $options{cancel}
825 and ( $options{'resetup'}
826 || ( ! $cust_pkg->setup
827 && ( ! $cust_pkg->start_date
828 || $cust_pkg->start_date <= $time
830 && ( ! $conf->exists('disable_setup_suspended_pkgs')
831 || ( $conf->exists('disable_setup_suspended_pkgs') &&
832 ! $cust_pkg->getfield('susp')
840 warn " bill setup\n" if $DEBUG > 1;
843 $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
844 return "$@ running calc_setup for $cust_pkg\n"
847 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
849 $cust_pkg->setfield('setup', $time)
850 unless $cust_pkg->setup;
851 #do need it, but it won't get written to the db
852 #|| $cust_pkg->pkgpart != $real_pkgpart;
854 $cust_pkg->setfield('start_date', '')
855 if $cust_pkg->start_date;
863 #XXX unit stuff here too
867 if ( ! $cust_pkg->start_date
868 and ( ! $cust_pkg->susp || $part_pkg->option('suspend_bill', 1) )
870 ( $part_pkg->freq ne '0' && ( $cust_pkg->bill || 0 ) <= $time )
871 || ( $part_pkg->plan eq 'voip_cdr'
872 && $part_pkg->option('bill_every_call')
877 # XXX should this be a package event? probably. events are called
878 # at collection time at the moment, though...
879 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
880 if $part_pkg->can('reset_usage') && !$options{'no_usage_reset'};
881 #don't want to reset usage just cause we want a line item??
882 #&& $part_pkg->pkgpart == $real_pkgpart;
884 warn " bill recur\n" if $DEBUG > 1;
887 # XXX shared with $recur_prog
888 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
892 #over two params! lets at least switch to a hashref for the rest...
893 my $increment_next_bill = ( $part_pkg->freq ne '0'
894 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
897 my %param = ( 'precommit_hooks' => $precommit_hooks,
898 'increment_next_bill' => $increment_next_bill,
899 'discounts' => \@discounts,
900 'real_pkgpart' => $real_pkgpart,
901 'freq_override' => $options{freq_override} || '',
904 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
906 # There may be some part_pkg for which this is wrong. Only those
907 # which can_discount are supported.
908 # (the UI should prevent adding discounts to these at the moment)
910 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
911 return "$@ running $method for $cust_pkg\n"
914 if ( $increment_next_bill ) {
916 my $next_bill = $part_pkg->add_freq($sdate, $options{freq_override} || 0);
917 return "unparsable frequency: ". $part_pkg->freq
920 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
921 # only for figuring next bill date, nothing else, so, reset $sdate again
923 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
924 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
925 $cust_pkg->last_bill($sdate);
927 $cust_pkg->setfield('bill', $next_bill );
933 warn "\$setup is undefined" unless defined($setup);
934 warn "\$recur is undefined" unless defined($recur);
935 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
938 # If there's line items, create em cust_bill_pkg records
939 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
944 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
945 # hmm.. and if just the options are modified in some weird price plan?
947 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
950 my $error = $cust_pkg->replace( $old_cust_pkg,
951 'depend_jobnum'=>$options{depend_jobnum},
952 'options' => { $cust_pkg->options },
954 unless $options{no_commit};
955 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
956 if $error; #just in case
959 $setup = sprintf( "%.2f", $setup );
960 $recur = sprintf( "%.2f", $recur );
961 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
962 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
964 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
965 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
968 my $discount_show_always = ($recur == 0 && scalar(@discounts)
969 && $conf->exists('discount-show-always'));
973 (!$part_pkg->hidden && $options{has_hidden}) || #include some $0 lines
974 $discount_show_always )
977 warn " charges (setup=$setup, recur=$recur); adding line items\n"
980 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
982 warn " adding customer package invoice detail: $_\n"
983 foreach @cust_pkg_detail;
985 push @details, @cust_pkg_detail;
987 my $cust_bill_pkg = new FS::cust_bill_pkg {
988 'pkgnum' => $cust_pkg->pkgnum,
990 'unitsetup' => $unitsetup,
992 'unitrecur' => $unitrecur,
993 'quantity' => $cust_pkg->quantity,
994 'details' => \@details,
995 'discounts' => \@discounts,
996 'hidden' => $part_pkg->hidden,
997 'freq' => $part_pkg->freq,
1000 if ( $part_pkg->option('recur_temporality', 1) eq 'preceding' ) {
1001 $cust_bill_pkg->sdate( $hash{last_bill} );
1002 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
1003 $cust_bill_pkg->edate( $time ) if $options{cancel};
1004 } else { #if ( $part_pkg->option('recur_temporality', 1) eq 'upcoming' ) {
1005 $cust_bill_pkg->sdate( $sdate );
1006 $cust_bill_pkg->edate( $cust_pkg->bill );
1007 #$cust_bill_pkg->edate( $time ) if $options{cancel};
1010 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
1011 unless $part_pkg->pkgpart == $real_pkgpart;
1013 $$total_setup += $setup;
1014 $$total_recur += $recur;
1020 unless ( $discount_show_always ) {
1022 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart, \%options);
1023 return $error if $error;
1026 push @$cust_bill_pkgs, $cust_bill_pkg;
1028 } #if $setup != 0 || $recur != 0
1038 my $part_pkg = shift;
1039 my $taxlisthash = shift;
1040 my $cust_bill_pkg = shift;
1041 my $cust_pkg = shift;
1042 my $invoice_time = shift;
1043 my $real_pkgpart = shift;
1044 my $options = shift;
1046 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1048 my %cust_bill_pkg = ();
1052 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
1053 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
1054 push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
1055 push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
1057 if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
1059 if ( $conf->exists('enable_taxproducts')
1060 && ( scalar($part_pkg->part_pkg_taxoverride)
1061 || $part_pkg->has_taxproduct
1066 foreach my $class (@classes) {
1067 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class, $cust_pkg );
1068 return $err_or_ref unless ref($err_or_ref);
1069 $taxes{$class} = $err_or_ref;
1072 unless (exists $taxes{''}) {
1073 my $err_or_ref = $self->_gather_taxes( $part_pkg, '', $cust_pkg );
1074 return $err_or_ref unless ref($err_or_ref);
1075 $taxes{''} = $err_or_ref;
1080 my @loc_keys = qw( city county state country );
1082 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1083 my $cust_location = $cust_pkg->cust_location;
1084 %taxhash = map { $_ => $cust_location->$_() } @loc_keys;
1087 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
1090 %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
1093 $taxhash{'taxclass'} = $part_pkg->taxclass;
1096 my %taxhash_elim = %taxhash;
1097 my @elim = qw( city county state );
1100 #first try a match with taxclass
1101 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1103 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1104 #then try a match without taxclass
1105 my %no_taxclass = %taxhash_elim;
1106 $no_taxclass{ 'taxclass' } = '';
1107 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1110 $taxhash_elim{ shift(@elim) } = '';
1112 } while ( !scalar(@taxes) && scalar(@elim) );
1114 @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
1116 if $self->cust_main_exemption; #just to be safe
1118 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1120 $_->set('pkgnum', $cust_pkg->pkgnum );
1121 $_->set('locationnum', $cust_pkg->locationnum );
1125 $taxes{''} = [ @taxes ];
1126 $taxes{'setup'} = [ @taxes ];
1127 $taxes{'recur'} = [ @taxes ];
1128 $taxes{$_} = [ @taxes ] foreach (@classes);
1130 # # maybe eliminate this entirely, along with all the 0% records
1131 # unless ( @taxes ) {
1133 # "fatal: can't find tax rate for state/county/country/taxclass ".
1134 # join('/', map $taxhash{$_}, qw(state county country taxclass) );
1137 } #if $conf->exists('enable_taxproducts') ...
1142 my $separate = $conf->exists('separate_usage');
1143 my $temp_pkg = new FS::cust_pkg { pkgpart => $real_pkgpart };
1144 my $usage_mandate = $temp_pkg->part_pkg->option('usage_mandate', 'Hush!');
1145 my $section = $temp_pkg->part_pkg->categoryname;
1146 if ( $separate || $section || $usage_mandate ) {
1148 my %hash = ( 'section' => $section );
1150 $section = $temp_pkg->part_pkg->option('usage_section', 'Hush!');
1151 my $summary = $temp_pkg->part_pkg->option('summarize_usage', 'Hush!');
1153 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
1154 push @display, new FS::cust_bill_pkg_display { type => 'R', %hash };
1156 push @display, new FS::cust_bill_pkg_display
1159 ( ( $usage_mandate ) ? ( 'summary' => 'Y' ) : () ),
1163 if ($separate && $section && $summary) {
1164 push @display, new FS::cust_bill_pkg_display { type => 'U',
1169 if ($usage_mandate || $section && $summary) {
1170 $hash{post_total} = 'Y';
1173 if ($separate || $usage_mandate) {
1174 $hash{section} = $section if ($separate || $usage_mandate);
1175 push @display, new FS::cust_bill_pkg_display { type => 'U', %hash };
1179 $cust_bill_pkg->set('display', \@display);
1181 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
1182 foreach my $key (keys %tax_cust_bill_pkg) {
1183 my @taxes = @{ $taxes{$key} || [] };
1184 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
1186 my %localtaxlisthash = ();
1187 foreach my $tax ( @taxes ) {
1189 my $taxname = ref( $tax ). ' '. $tax->taxnum;
1190 # $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
1191 # ' locationnum'. $cust_pkg->locationnum
1192 # if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
1194 $taxlisthash->{ $taxname } ||= [ $tax ];
1195 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
1197 $localtaxlisthash{ $taxname } ||= [ $tax ];
1198 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
1202 warn "finding taxed taxes...\n" if $DEBUG > 2;
1203 foreach my $tax ( keys %localtaxlisthash ) {
1204 my $tax_object = shift @{ $localtaxlisthash{$tax} };
1205 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
1207 next unless $tax_object->can('tax_on_tax');
1209 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
1210 my $totname = ref( $tot ). ' '. $tot->taxnum;
1212 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
1214 next unless exists( $localtaxlisthash{ $totname } ); # only increase
1216 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
1217 my $hashref_or_error =
1218 $tax_object->taxline( $localtaxlisthash{$tax},
1219 'custnum' => $self->custnum,
1220 'invoice_time' => $invoice_time,
1222 return $hashref_or_error
1223 unless ref($hashref_or_error);
1225 $taxlisthash->{ $totname } ||= [ $tot ];
1226 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
1238 my $part_pkg = shift;
1240 my $cust_pkg = shift;
1242 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1245 if ( $cust_pkg->locationnum && $conf->exists('tax-pkg_address') ) {
1246 $geocode = $cust_pkg->cust_location->geocode('cch');
1248 $geocode = $self->geocode('cch');
1253 my @taxclassnums = map { $_->taxclassnum }
1254 $part_pkg->part_pkg_taxoverride($class);
1256 unless (@taxclassnums) {
1257 @taxclassnums = map { $_->taxclassnum }
1258 grep { $_->taxable eq 'Y' }
1259 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
1261 warn "Found taxclassnum values of ". join(',', @taxclassnums)
1266 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
1268 @taxes = qsearch({ 'table' => 'tax_rate',
1269 'hashref' => { 'geocode' => $geocode, },
1270 'extra_sql' => $extra_sql,
1272 if scalar(@taxclassnums);
1274 warn "Found taxes ".
1275 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
1282 =item collect [ HASHREF | OPTION => VALUE ... ]
1284 (Attempt to) collect money for this customer's outstanding invoices (see
1285 L<FS::cust_bill>). Usually used after the bill method.
1287 Actions are now triggered by billing events; see L<FS::part_event> and the
1288 billing events web interface. Old-style invoice events (see
1289 L<FS::part_bill_event>) have been deprecated.
1291 If there is an error, returns the error, otherwise returns false.
1293 Options are passed as name-value pairs.
1295 Currently available options are:
1301 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.
1305 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1309 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1313 set true to surpress email card/ACH decline notices.
1317 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)
1323 # allows for one time override of normal customer billing method
1328 my( $self, %options ) = @_;
1330 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1332 my $invoice_time = $options{'invoice_time'} || time;
1335 local $SIG{HUP} = 'IGNORE';
1336 local $SIG{INT} = 'IGNORE';
1337 local $SIG{QUIT} = 'IGNORE';
1338 local $SIG{TERM} = 'IGNORE';
1339 local $SIG{TSTP} = 'IGNORE';
1340 local $SIG{PIPE} = 'IGNORE';
1342 my $oldAutoCommit = $FS::UID::AutoCommit;
1343 local $FS::UID::AutoCommit = 0;
1346 $self->select_for_update; #mutex
1349 my $balance = $self->balance;
1350 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
1353 if ( exists($options{'retry_card'}) ) {
1354 carp 'retry_card option passed to collect is deprecated; use retry';
1355 $options{'retry'} ||= $options{'retry_card'};
1357 if ( exists($options{'retry'}) && $options{'retry'} ) {
1358 my $error = $self->retry_realtime;
1360 $dbh->rollback if $oldAutoCommit;
1365 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1367 #never want to roll back an event just because it returned an error
1368 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1370 $self->do_cust_event(
1371 'debug' => ( $options{'debug'} || 0 ),
1372 'time' => $invoice_time,
1373 'check_freq' => $options{'check_freq'},
1374 'stage' => 'collect',
1379 =item retry_realtime
1381 Schedules realtime / batch credit card / electronic check / LEC billing
1382 events for for retry. Useful if card information has changed or manual
1383 retry is desired. The 'collect' method must be called to actually retry
1386 Implementation details: For either this customer, or for each of this
1387 customer's open invoices, changes the status of the first "done" (with
1388 statustext error) realtime processing event to "failed".
1392 sub retry_realtime {
1395 local $SIG{HUP} = 'IGNORE';
1396 local $SIG{INT} = 'IGNORE';
1397 local $SIG{QUIT} = 'IGNORE';
1398 local $SIG{TERM} = 'IGNORE';
1399 local $SIG{TSTP} = 'IGNORE';
1400 local $SIG{PIPE} = 'IGNORE';
1402 my $oldAutoCommit = $FS::UID::AutoCommit;
1403 local $FS::UID::AutoCommit = 0;
1406 #a little false laziness w/due_cust_event (not too bad, really)
1408 my $join = FS::part_event_condition->join_conditions_sql;
1409 my $order = FS::part_event_condition->order_conditions_sql;
1412 . join ( ' OR ' , map {
1413 "( part_event.eventtable = " . dbh->quote($_)
1414 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
1415 } FS::part_event->eventtables)
1418 #here is the agent virtualization
1419 my $agent_virt = " ( part_event.agentnum IS NULL
1420 OR part_event.agentnum = ". $self->agentnum. ' )';
1422 #XXX this shouldn't be hardcoded, actions should declare it...
1423 my @realtime_events = qw(
1424 cust_bill_realtime_card
1425 cust_bill_realtime_check
1426 cust_bill_realtime_lec
1430 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
1435 my @cust_event = qsearchs({
1436 'table' => 'cust_event',
1437 'select' => 'cust_event.*',
1438 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
1439 'hashref' => { 'status' => 'done' },
1440 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
1441 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
1444 my %seen_invnum = ();
1445 foreach my $cust_event (@cust_event) {
1447 #max one for the customer, one for each open invoice
1448 my $cust_X = $cust_event->cust_X;
1449 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
1453 or $cust_event->part_event->eventtable eq 'cust_bill'
1456 my $error = $cust_event->retry;
1458 $dbh->rollback if $oldAutoCommit;
1459 return "error scheduling event for retry: $error";
1464 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1469 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
1471 Runs billing events; see L<FS::part_event> and the billing events web
1474 If there is an error, returns the error, otherwise returns false.
1476 Options are passed as name-value pairs.
1478 Currently available options are:
1484 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.
1488 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1492 "collect" (the default) or "pre-bill"
1496 set true to surpress email card/ACH decline notices.
1500 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)
1507 # allows for one time override of normal customer billing method
1511 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1514 my( $self, %options ) = @_;
1516 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1518 my $time = $options{'time'} || time;
1521 local $SIG{HUP} = 'IGNORE';
1522 local $SIG{INT} = 'IGNORE';
1523 local $SIG{QUIT} = 'IGNORE';
1524 local $SIG{TERM} = 'IGNORE';
1525 local $SIG{TSTP} = 'IGNORE';
1526 local $SIG{PIPE} = 'IGNORE';
1528 my $oldAutoCommit = $FS::UID::AutoCommit;
1529 local $FS::UID::AutoCommit = 0;
1532 $self->select_for_update; #mutex
1535 my $balance = $self->balance;
1536 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
1539 # if ( exists($options{'retry_card'}) ) {
1540 # carp 'retry_card option passed to collect is deprecated; use retry';
1541 # $options{'retry'} ||= $options{'retry_card'};
1543 # if ( exists($options{'retry'}) && $options{'retry'} ) {
1544 # my $error = $self->retry_realtime;
1546 # $dbh->rollback if $oldAutoCommit;
1551 # false laziness w/pay_batch::import_results
1553 my $due_cust_event = $self->due_cust_event(
1554 'debug' => ( $options{'debug'} || 0 ),
1556 'check_freq' => $options{'check_freq'},
1557 'stage' => ( $options{'stage'} || 'collect' ),
1559 unless( ref($due_cust_event) ) {
1560 $dbh->rollback if $oldAutoCommit;
1561 return $due_cust_event;
1564 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1565 #never want to roll back an event just because it or a different one
1567 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1569 foreach my $cust_event ( @$due_cust_event ) {
1573 #re-eval event conditions (a previous event could have changed things)
1574 unless ( $cust_event->test_conditions( 'time' => $time ) ) {
1575 #don't leave stray "new/locked" records around
1576 my $error = $cust_event->delete;
1577 return $error if $error;
1582 local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
1583 if $options{'quiet'};
1584 warn " running cust_event ". $cust_event->eventnum. "\n"
1587 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
1588 if ( my $error = $cust_event->do_event() ) {
1589 #XXX wtf is this? figure out a proper dealio with return value
1601 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
1603 Inserts database records for and returns an ordered listref of new events due
1604 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
1605 events are due, an empty listref is returned. If there is an error, returns a
1606 scalar error message.
1608 To actually run the events, call each event's test_condition method, and if
1609 still true, call the event's do_event method.
1611 Options are passed as a hashref or as a list of name-value pairs. Available
1618 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.
1622 "collect" (the default) or "pre-bill"
1626 "Current time" for the events.
1630 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)
1634 Only return events for the specified eventtable (by default, events of all eventtables are returned)
1638 Explicitly pass the objects to be tested (typically used with eventtable).
1642 Set to true to return the objects, but not actually insert them into the
1649 sub due_cust_event {
1651 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
1654 #my $DEBUG = $opt{'debug'}
1655 local($DEBUG) = $opt{'debug'}
1656 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
1657 $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1659 warn "$me due_cust_event called with options ".
1660 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
1663 $opt{'time'} ||= time;
1665 local $SIG{HUP} = 'IGNORE';
1666 local $SIG{INT} = 'IGNORE';
1667 local $SIG{QUIT} = 'IGNORE';
1668 local $SIG{TERM} = 'IGNORE';
1669 local $SIG{TSTP} = 'IGNORE';
1670 local $SIG{PIPE} = 'IGNORE';
1672 my $oldAutoCommit = $FS::UID::AutoCommit;
1673 local $FS::UID::AutoCommit = 0;
1676 $self->select_for_update #mutex
1677 unless $opt{testonly};
1680 # find possible events (initial search)
1683 my @cust_event = ();
1685 my @eventtable = $opt{'eventtable'}
1686 ? ( $opt{'eventtable'} )
1687 : FS::part_event->eventtables_runorder;
1689 my $check_freq = $opt{'check_freq'} || '1d';
1691 foreach my $eventtable ( @eventtable ) {
1694 if ( $opt{'objects'} ) {
1696 @objects = @{ $opt{'objects'} };
1700 #my @objects = $self->$eventtable(); # sub cust_main { @{ [ $self ] }; }
1701 if ( $eventtable eq 'cust_main' ) {
1702 @objects = ( $self );
1706 "LEFT JOIN cust_main USING ( custnum )";
1708 #some false laziness w/Cron::bill bill_where
1710 my $join = FS::part_event_condition->join_conditions_sql( $eventtable);
1711 my $where = FS::part_event_condition->where_conditions_sql($eventtable,
1712 'time'=>$opt{'time'},
1714 $where = $where ? "AND $where" : '';
1716 my $are_part_event =
1717 "EXISTS ( SELECT 1 FROM part_event $join
1718 WHERE check_freq = '$check_freq'
1719 AND eventtable = '$eventtable'
1720 AND ( disabled = '' OR disabled IS NULL )
1726 @objects = $self->$eventtable(
1727 'addl_from' => $cm_join,
1728 'extra_sql' => " AND $are_part_event",
1734 my @e_cust_event = ();
1736 my $cross = "CROSS JOIN $eventtable";
1737 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
1738 unless $eventtable eq 'cust_main';
1740 foreach my $object ( @objects ) {
1742 #this first search uses the condition_sql magic for optimization.
1743 #the more possible events we can eliminate in this step the better
1745 my $cross_where = '';
1746 my $pkey = $object->primary_key;
1747 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
1749 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
1751 FS::part_event_condition->where_conditions_sql( $eventtable,
1752 'time'=>$opt{'time'}
1754 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
1756 $extra_sql = "AND $extra_sql" if $extra_sql;
1758 #here is the agent virtualization
1759 $extra_sql .= " AND ( part_event.agentnum IS NULL
1760 OR part_event.agentnum = ". $self->agentnum. ' )';
1762 $extra_sql .= " $order";
1764 warn "searching for events for $eventtable ". $object->$pkey. "\n"
1765 if $opt{'debug'} > 2;
1766 my @part_event = qsearch( {
1767 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
1768 'select' => 'part_event.*',
1769 'table' => 'part_event',
1770 'addl_from' => "$cross $join",
1771 'hashref' => { 'check_freq' => $check_freq,
1772 'eventtable' => $eventtable,
1775 'extra_sql' => "AND $cross_where $extra_sql",
1779 my $pkey = $object->primary_key;
1780 warn " ". scalar(@part_event).
1781 " possible events found for $eventtable ". $object->$pkey(). "\n";
1784 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
1788 warn " ". scalar(@e_cust_event).
1789 " subtotal possible cust events found for $eventtable\n"
1792 push @cust_event, @e_cust_event;
1796 warn " ". scalar(@cust_event).
1797 " total possible cust events found in initial search\n"
1805 $opt{stage} ||= 'collect';
1807 grep { my $stage = $_->part_event->event_stage;
1808 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
1818 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
1819 'stats_hashref' => \%unsat ),
1822 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
1825 warn " invalid conditions not eliminated with condition_sql:\n".
1826 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
1827 if keys %unsat && $DEBUG; # > 1;
1833 unless( $opt{testonly} ) {
1834 foreach my $cust_event ( @cust_event ) {
1836 my $error = $cust_event->insert();
1838 $dbh->rollback if $oldAutoCommit;
1845 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1851 warn " returning events: ". Dumper(@cust_event). "\n"
1858 =item apply_payments_and_credits [ OPTION => VALUE ... ]
1860 Applies unapplied payments and credits.
1862 In most cases, this new method should be used in place of sequential
1863 apply_payments and apply_credits methods.
1865 A hash of optional arguments may be passed. Currently "manual" is supported.
1866 If true, a payment receipt is sent instead of a statement when
1867 'payment_receipt_email' configuration option is set.
1869 If there is an error, returns the error, otherwise returns false.
1873 sub apply_payments_and_credits {
1874 my( $self, %options ) = @_;
1876 local $SIG{HUP} = 'IGNORE';
1877 local $SIG{INT} = 'IGNORE';
1878 local $SIG{QUIT} = 'IGNORE';
1879 local $SIG{TERM} = 'IGNORE';
1880 local $SIG{TSTP} = 'IGNORE';
1881 local $SIG{PIPE} = 'IGNORE';
1883 my $oldAutoCommit = $FS::UID::AutoCommit;
1884 local $FS::UID::AutoCommit = 0;
1887 $self->select_for_update; #mutex
1889 foreach my $cust_bill ( $self->open_cust_bill ) {
1890 my $error = $cust_bill->apply_payments_and_credits(%options);
1892 $dbh->rollback if $oldAutoCommit;
1893 return "Error applying: $error";
1897 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1902 =item apply_credits OPTION => VALUE ...
1904 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
1905 to outstanding invoice balances in chronological order (or reverse
1906 chronological order if the I<order> option is set to B<newest>) and returns the
1907 value of any remaining unapplied credits available for refund (see
1908 L<FS::cust_refund>).
1910 Dies if there is an error.
1918 local $SIG{HUP} = 'IGNORE';
1919 local $SIG{INT} = 'IGNORE';
1920 local $SIG{QUIT} = 'IGNORE';
1921 local $SIG{TERM} = 'IGNORE';
1922 local $SIG{TSTP} = 'IGNORE';
1923 local $SIG{PIPE} = 'IGNORE';
1925 my $oldAutoCommit = $FS::UID::AutoCommit;
1926 local $FS::UID::AutoCommit = 0;
1929 $self->select_for_update; #mutex
1931 unless ( $self->total_unapplied_credits ) {
1932 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1936 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
1937 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
1939 my @invoices = $self->open_cust_bill;
1940 @invoices = sort { $b->_date <=> $a->_date } @invoices
1941 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
1943 if ( $conf->exists('pkg-balances') ) {
1944 # limit @credits to those w/ a pkgnum grepped from $self
1946 foreach my $i (@invoices) {
1947 foreach my $li ( $i->cust_bill_pkg ) {
1948 $pkgnums{$li->pkgnum} = 1;
1951 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
1956 foreach my $cust_bill ( @invoices ) {
1958 if ( !defined($credit) || $credit->credited == 0) {
1959 $credit = pop @credits or last;
1963 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
1964 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
1966 $owed = $cust_bill->owed;
1968 unless ( $owed > 0 ) {
1969 push @credits, $credit;
1973 my $amount = min( $credit->credited, $owed );
1975 my $cust_credit_bill = new FS::cust_credit_bill ( {
1976 'crednum' => $credit->crednum,
1977 'invnum' => $cust_bill->invnum,
1978 'amount' => $amount,
1980 $cust_credit_bill->pkgnum( $credit->pkgnum )
1981 if $conf->exists('pkg-balances') && $credit->pkgnum;
1982 my $error = $cust_credit_bill->insert;
1984 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
1988 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
1992 my $total_unapplied_credits = $self->total_unapplied_credits;
1994 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1996 return $total_unapplied_credits;
1999 =item apply_payments [ OPTION => VALUE ... ]
2001 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2002 to outstanding invoice balances in chronological order.
2004 #and returns the value of any remaining unapplied payments.
2006 A hash of optional arguments may be passed. Currently "manual" is supported.
2007 If true, a payment receipt is sent instead of a statement when
2008 'payment_receipt_email' configuration option is set.
2010 Dies if there is an error.
2014 sub apply_payments {
2015 my( $self, %options ) = @_;
2017 local $SIG{HUP} = 'IGNORE';
2018 local $SIG{INT} = 'IGNORE';
2019 local $SIG{QUIT} = 'IGNORE';
2020 local $SIG{TERM} = 'IGNORE';
2021 local $SIG{TSTP} = 'IGNORE';
2022 local $SIG{PIPE} = 'IGNORE';
2024 my $oldAutoCommit = $FS::UID::AutoCommit;
2025 local $FS::UID::AutoCommit = 0;
2028 $self->select_for_update; #mutex
2032 my @payments = sort { $b->_date <=> $a->_date }
2033 grep { $_->unapplied > 0 }
2036 my @invoices = sort { $a->_date <=> $b->_date}
2037 grep { $_->owed > 0 }
2040 if ( $conf->exists('pkg-balances') ) {
2041 # limit @payments to those w/ a pkgnum grepped from $self
2043 foreach my $i (@invoices) {
2044 foreach my $li ( $i->cust_bill_pkg ) {
2045 $pkgnums{$li->pkgnum} = 1;
2048 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
2053 foreach my $cust_bill ( @invoices ) {
2055 if ( !defined($payment) || $payment->unapplied == 0 ) {
2056 $payment = pop @payments or last;
2060 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
2061 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
2063 $owed = $cust_bill->owed;
2065 unless ( $owed > 0 ) {
2066 push @payments, $payment;
2070 my $amount = min( $payment->unapplied, $owed );
2072 my $cust_bill_pay = new FS::cust_bill_pay ( {
2073 'paynum' => $payment->paynum,
2074 'invnum' => $cust_bill->invnum,
2075 'amount' => $amount,
2077 $cust_bill_pay->pkgnum( $payment->pkgnum )
2078 if $conf->exists('pkg-balances') && $payment->pkgnum;
2079 my $error = $cust_bill_pay->insert(%options);
2081 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2085 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2089 my $total_unapplied_payments = $self->total_unapplied_payments;
2091 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2093 return $total_unapplied_payments;
2102 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>