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{'resetup'}
824 || ( ! $cust_pkg->setup
825 && ( ! $cust_pkg->start_date
826 || $cust_pkg->start_date <= $time
828 && ( ! $conf->exists('disable_setup_suspended_pkgs')
829 || ( $conf->exists('disable_setup_suspended_pkgs') &&
830 ! $cust_pkg->getfield('susp')
834 and !$options{recurring_only}
838 warn " bill setup\n" if $DEBUG > 1;
841 $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
842 return "$@ running calc_setup for $cust_pkg\n"
845 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
847 $cust_pkg->setfield('setup', $time)
848 unless $cust_pkg->setup;
849 #do need it, but it won't get written to the db
850 #|| $cust_pkg->pkgpart != $real_pkgpart;
852 $cust_pkg->setfield('start_date', '')
853 if $cust_pkg->start_date;
861 #XXX unit stuff here too
865 if ( ! $cust_pkg->start_date
866 and ( ! $cust_pkg->susp || $part_pkg->option('suspend_bill', 1) )
868 ( $part_pkg->freq ne '0' && ( $cust_pkg->bill || 0 ) <= $time )
869 || ( $part_pkg->plan eq 'voip_cdr'
870 && $part_pkg->option('bill_every_call')
875 # XXX should this be a package event? probably. events are called
876 # at collection time at the moment, though...
877 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
878 if $part_pkg->can('reset_usage') && !$options{'no_usage_reset'};
879 #don't want to reset usage just cause we want a line item??
880 #&& $part_pkg->pkgpart == $real_pkgpart;
882 warn " bill recur\n" if $DEBUG > 1;
885 # XXX shared with $recur_prog
886 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
890 #over two params! lets at least switch to a hashref for the rest...
891 my $increment_next_bill = ( $part_pkg->freq ne '0'
892 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
895 my %param = ( 'precommit_hooks' => $precommit_hooks,
896 'increment_next_bill' => $increment_next_bill,
897 'discounts' => \@discounts,
898 'real_pkgpart' => $real_pkgpart,
899 'freq_override' => $options{freq_override} || '',
903 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
905 # There may be some part_pkg for which this is wrong. Only those
906 # which can_discount are supported.
907 # (the UI should prevent adding discounts to these at the moment)
909 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
910 return "$@ running $method for $cust_pkg\n"
913 if ( $increment_next_bill ) {
915 my $next_bill = $part_pkg->add_freq($sdate, $options{freq_override} || 0);
916 return "unparsable frequency: ". $part_pkg->freq
919 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
920 # only for figuring next bill date, nothing else, so, reset $sdate again
922 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
923 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
924 $cust_pkg->last_bill($sdate);
926 $cust_pkg->setfield('bill', $next_bill );
930 if ( $param{'setup_fee'} ) {
931 # Add an additional setup fee at the billing stage.
932 # Used for prorate_defer_bill.
933 $setup += $param{'setup_fee'};
934 $unitsetup += $param{'setup_fee'};
940 warn "\$setup is undefined" unless defined($setup);
941 warn "\$recur is undefined" unless defined($recur);
942 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
945 # If there's line items, create em cust_bill_pkg records
946 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
951 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
952 # hmm.. and if just the options are modified in some weird price plan?
954 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
957 my $error = $cust_pkg->replace( $old_cust_pkg,
958 'depend_jobnum'=>$options{depend_jobnum},
959 'options' => { $cust_pkg->options },
961 unless $options{no_commit};
962 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
963 if $error; #just in case
966 $setup = sprintf( "%.2f", $setup );
967 $recur = sprintf( "%.2f", $recur );
968 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
969 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
971 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
972 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
975 my $discount_show_always = ($recur == 0 && scalar(@discounts)
976 && $conf->exists('discount-show-always'));
980 (!$part_pkg->hidden && $options{has_hidden}) || #include some $0 lines
981 $discount_show_always )
984 warn " charges (setup=$setup, recur=$recur); adding line items\n"
987 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
989 warn " adding customer package invoice detail: $_\n"
990 foreach @cust_pkg_detail;
992 push @details, @cust_pkg_detail;
994 my $cust_bill_pkg = new FS::cust_bill_pkg {
995 'pkgnum' => $cust_pkg->pkgnum,
997 'unitsetup' => $unitsetup,
999 'unitrecur' => $unitrecur,
1000 'quantity' => $cust_pkg->quantity,
1001 'details' => \@details,
1002 'discounts' => \@discounts,
1003 'hidden' => $part_pkg->hidden,
1004 'freq' => $part_pkg->freq,
1007 if ( $part_pkg->option('recur_temporality', 1) eq 'preceding' ) {
1008 $cust_bill_pkg->sdate( $hash{last_bill} );
1009 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
1010 $cust_bill_pkg->edate( $time ) if $options{cancel};
1011 } else { #if ( $part_pkg->option('recur_temporality', 1) eq 'upcoming' ) {
1012 $cust_bill_pkg->sdate( $sdate );
1013 $cust_bill_pkg->edate( $cust_pkg->bill );
1014 #$cust_bill_pkg->edate( $time ) if $options{cancel};
1017 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
1018 unless $part_pkg->pkgpart == $real_pkgpart;
1020 $$total_setup += $setup;
1021 $$total_recur += $recur;
1027 unless ( $discount_show_always ) {
1029 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart, \%options);
1030 return $error if $error;
1033 push @$cust_bill_pkgs, $cust_bill_pkg;
1035 } #if $setup != 0 || $recur != 0
1045 my $part_pkg = shift;
1046 my $taxlisthash = shift;
1047 my $cust_bill_pkg = shift;
1048 my $cust_pkg = shift;
1049 my $invoice_time = shift;
1050 my $real_pkgpart = shift;
1051 my $options = shift;
1053 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1055 my %cust_bill_pkg = ();
1059 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
1060 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
1061 push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
1062 push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
1064 if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
1066 if ( $conf->exists('enable_taxproducts')
1067 && ( scalar($part_pkg->part_pkg_taxoverride)
1068 || $part_pkg->has_taxproduct
1073 foreach my $class (@classes) {
1074 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class, $cust_pkg );
1075 return $err_or_ref unless ref($err_or_ref);
1076 $taxes{$class} = $err_or_ref;
1079 unless (exists $taxes{''}) {
1080 my $err_or_ref = $self->_gather_taxes( $part_pkg, '', $cust_pkg );
1081 return $err_or_ref unless ref($err_or_ref);
1082 $taxes{''} = $err_or_ref;
1087 my @loc_keys = qw( city county state country );
1089 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1090 my $cust_location = $cust_pkg->cust_location;
1091 %taxhash = map { $_ => $cust_location->$_() } @loc_keys;
1094 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
1097 %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
1100 $taxhash{'taxclass'} = $part_pkg->taxclass;
1103 my %taxhash_elim = %taxhash;
1104 my @elim = qw( city county state );
1107 #first try a match with taxclass
1108 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1110 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1111 #then try a match without taxclass
1112 my %no_taxclass = %taxhash_elim;
1113 $no_taxclass{ 'taxclass' } = '';
1114 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1117 $taxhash_elim{ shift(@elim) } = '';
1119 } while ( !scalar(@taxes) && scalar(@elim) );
1121 @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
1123 if $self->cust_main_exemption; #just to be safe
1125 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1127 $_->set('pkgnum', $cust_pkg->pkgnum );
1128 $_->set('locationnum', $cust_pkg->locationnum );
1132 $taxes{''} = [ @taxes ];
1133 $taxes{'setup'} = [ @taxes ];
1134 $taxes{'recur'} = [ @taxes ];
1135 $taxes{$_} = [ @taxes ] foreach (@classes);
1137 # # maybe eliminate this entirely, along with all the 0% records
1138 # unless ( @taxes ) {
1140 # "fatal: can't find tax rate for state/county/country/taxclass ".
1141 # join('/', map $taxhash{$_}, qw(state county country taxclass) );
1144 } #if $conf->exists('enable_taxproducts') ...
1149 my $separate = $conf->exists('separate_usage');
1150 my $temp_pkg = new FS::cust_pkg { pkgpart => $real_pkgpart };
1151 my $usage_mandate = $temp_pkg->part_pkg->option('usage_mandate', 'Hush!');
1152 my $section = $temp_pkg->part_pkg->categoryname;
1153 if ( $separate || $section || $usage_mandate ) {
1155 my %hash = ( 'section' => $section );
1157 $section = $temp_pkg->part_pkg->option('usage_section', 'Hush!');
1158 my $summary = $temp_pkg->part_pkg->option('summarize_usage', 'Hush!');
1160 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
1161 push @display, new FS::cust_bill_pkg_display { type => 'R', %hash };
1163 push @display, new FS::cust_bill_pkg_display
1166 ( ( $usage_mandate ) ? ( 'summary' => 'Y' ) : () ),
1170 if ($separate && $section && $summary) {
1171 push @display, new FS::cust_bill_pkg_display { type => 'U',
1176 if ($usage_mandate || $section && $summary) {
1177 $hash{post_total} = 'Y';
1180 if ($separate || $usage_mandate) {
1181 $hash{section} = $section if ($separate || $usage_mandate);
1182 push @display, new FS::cust_bill_pkg_display { type => 'U', %hash };
1186 $cust_bill_pkg->set('display', \@display);
1188 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
1189 foreach my $key (keys %tax_cust_bill_pkg) {
1190 my @taxes = @{ $taxes{$key} || [] };
1191 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
1193 my %localtaxlisthash = ();
1194 foreach my $tax ( @taxes ) {
1196 my $taxname = ref( $tax ). ' '. $tax->taxnum;
1197 # $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
1198 # ' locationnum'. $cust_pkg->locationnum
1199 # if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
1201 $taxlisthash->{ $taxname } ||= [ $tax ];
1202 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
1204 $localtaxlisthash{ $taxname } ||= [ $tax ];
1205 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
1209 warn "finding taxed taxes...\n" if $DEBUG > 2;
1210 foreach my $tax ( keys %localtaxlisthash ) {
1211 my $tax_object = shift @{ $localtaxlisthash{$tax} };
1212 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
1214 next unless $tax_object->can('tax_on_tax');
1216 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
1217 my $totname = ref( $tot ). ' '. $tot->taxnum;
1219 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
1221 next unless exists( $localtaxlisthash{ $totname } ); # only increase
1223 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
1224 my $hashref_or_error =
1225 $tax_object->taxline( $localtaxlisthash{$tax},
1226 'custnum' => $self->custnum,
1227 'invoice_time' => $invoice_time,
1229 return $hashref_or_error
1230 unless ref($hashref_or_error);
1232 $taxlisthash->{ $totname } ||= [ $tot ];
1233 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
1245 my $part_pkg = shift;
1247 my $cust_pkg = shift;
1249 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1252 if ( $cust_pkg->locationnum && $conf->exists('tax-pkg_address') ) {
1253 $geocode = $cust_pkg->cust_location->geocode('cch');
1255 $geocode = $self->geocode('cch');
1260 my @taxclassnums = map { $_->taxclassnum }
1261 $part_pkg->part_pkg_taxoverride($class);
1263 unless (@taxclassnums) {
1264 @taxclassnums = map { $_->taxclassnum }
1265 grep { $_->taxable eq 'Y' }
1266 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
1268 warn "Found taxclassnum values of ". join(',', @taxclassnums)
1273 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
1275 @taxes = qsearch({ 'table' => 'tax_rate',
1276 'hashref' => { 'geocode' => $geocode, },
1277 'extra_sql' => $extra_sql,
1279 if scalar(@taxclassnums);
1281 warn "Found taxes ".
1282 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
1289 =item collect [ HASHREF | OPTION => VALUE ... ]
1291 (Attempt to) collect money for this customer's outstanding invoices (see
1292 L<FS::cust_bill>). Usually used after the bill method.
1294 Actions are now triggered by billing events; see L<FS::part_event> and the
1295 billing events web interface. Old-style invoice events (see
1296 L<FS::part_bill_event>) have been deprecated.
1298 If there is an error, returns the error, otherwise returns false.
1300 Options are passed as name-value pairs.
1302 Currently available options are:
1308 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.
1312 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1316 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1320 set true to surpress email card/ACH decline notices.
1324 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)
1330 # allows for one time override of normal customer billing method
1335 my( $self, %options ) = @_;
1337 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1339 my $invoice_time = $options{'invoice_time'} || time;
1342 local $SIG{HUP} = 'IGNORE';
1343 local $SIG{INT} = 'IGNORE';
1344 local $SIG{QUIT} = 'IGNORE';
1345 local $SIG{TERM} = 'IGNORE';
1346 local $SIG{TSTP} = 'IGNORE';
1347 local $SIG{PIPE} = 'IGNORE';
1349 my $oldAutoCommit = $FS::UID::AutoCommit;
1350 local $FS::UID::AutoCommit = 0;
1353 $self->select_for_update; #mutex
1356 my $balance = $self->balance;
1357 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
1360 if ( exists($options{'retry_card'}) ) {
1361 carp 'retry_card option passed to collect is deprecated; use retry';
1362 $options{'retry'} ||= $options{'retry_card'};
1364 if ( exists($options{'retry'}) && $options{'retry'} ) {
1365 my $error = $self->retry_realtime;
1367 $dbh->rollback if $oldAutoCommit;
1372 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1374 #never want to roll back an event just because it returned an error
1375 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1377 $self->do_cust_event(
1378 'debug' => ( $options{'debug'} || 0 ),
1379 'time' => $invoice_time,
1380 'check_freq' => $options{'check_freq'},
1381 'stage' => 'collect',
1386 =item retry_realtime
1388 Schedules realtime / batch credit card / electronic check / LEC billing
1389 events for for retry. Useful if card information has changed or manual
1390 retry is desired. The 'collect' method must be called to actually retry
1393 Implementation details: For either this customer, or for each of this
1394 customer's open invoices, changes the status of the first "done" (with
1395 statustext error) realtime processing event to "failed".
1399 sub retry_realtime {
1402 local $SIG{HUP} = 'IGNORE';
1403 local $SIG{INT} = 'IGNORE';
1404 local $SIG{QUIT} = 'IGNORE';
1405 local $SIG{TERM} = 'IGNORE';
1406 local $SIG{TSTP} = 'IGNORE';
1407 local $SIG{PIPE} = 'IGNORE';
1409 my $oldAutoCommit = $FS::UID::AutoCommit;
1410 local $FS::UID::AutoCommit = 0;
1413 #a little false laziness w/due_cust_event (not too bad, really)
1415 my $join = FS::part_event_condition->join_conditions_sql;
1416 my $order = FS::part_event_condition->order_conditions_sql;
1419 . join ( ' OR ' , map {
1420 "( part_event.eventtable = " . dbh->quote($_)
1421 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
1422 } FS::part_event->eventtables)
1425 #here is the agent virtualization
1426 my $agent_virt = " ( part_event.agentnum IS NULL
1427 OR part_event.agentnum = ". $self->agentnum. ' )';
1429 #XXX this shouldn't be hardcoded, actions should declare it...
1430 my @realtime_events = qw(
1431 cust_bill_realtime_card
1432 cust_bill_realtime_check
1433 cust_bill_realtime_lec
1437 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
1442 my @cust_event = qsearchs({
1443 'table' => 'cust_event',
1444 'select' => 'cust_event.*',
1445 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
1446 'hashref' => { 'status' => 'done' },
1447 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
1448 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
1451 my %seen_invnum = ();
1452 foreach my $cust_event (@cust_event) {
1454 #max one for the customer, one for each open invoice
1455 my $cust_X = $cust_event->cust_X;
1456 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
1460 or $cust_event->part_event->eventtable eq 'cust_bill'
1463 my $error = $cust_event->retry;
1465 $dbh->rollback if $oldAutoCommit;
1466 return "error scheduling event for retry: $error";
1471 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1476 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
1478 Runs billing events; see L<FS::part_event> and the billing events web
1481 If there is an error, returns the error, otherwise returns false.
1483 Options are passed as name-value pairs.
1485 Currently available options are:
1491 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.
1495 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1499 "collect" (the default) or "pre-bill"
1503 set true to surpress email card/ACH decline notices.
1507 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)
1514 # allows for one time override of normal customer billing method
1518 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1521 my( $self, %options ) = @_;
1523 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1525 my $time = $options{'time'} || time;
1528 local $SIG{HUP} = 'IGNORE';
1529 local $SIG{INT} = 'IGNORE';
1530 local $SIG{QUIT} = 'IGNORE';
1531 local $SIG{TERM} = 'IGNORE';
1532 local $SIG{TSTP} = 'IGNORE';
1533 local $SIG{PIPE} = 'IGNORE';
1535 my $oldAutoCommit = $FS::UID::AutoCommit;
1536 local $FS::UID::AutoCommit = 0;
1539 $self->select_for_update; #mutex
1542 my $balance = $self->balance;
1543 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
1546 # if ( exists($options{'retry_card'}) ) {
1547 # carp 'retry_card option passed to collect is deprecated; use retry';
1548 # $options{'retry'} ||= $options{'retry_card'};
1550 # if ( exists($options{'retry'}) && $options{'retry'} ) {
1551 # my $error = $self->retry_realtime;
1553 # $dbh->rollback if $oldAutoCommit;
1558 # false laziness w/pay_batch::import_results
1560 my $due_cust_event = $self->due_cust_event(
1561 'debug' => ( $options{'debug'} || 0 ),
1563 'check_freq' => $options{'check_freq'},
1564 'stage' => ( $options{'stage'} || 'collect' ),
1566 unless( ref($due_cust_event) ) {
1567 $dbh->rollback if $oldAutoCommit;
1568 return $due_cust_event;
1571 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1572 #never want to roll back an event just because it or a different one
1574 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1576 foreach my $cust_event ( @$due_cust_event ) {
1580 #re-eval event conditions (a previous event could have changed things)
1581 unless ( $cust_event->test_conditions( 'time' => $time ) ) {
1582 #don't leave stray "new/locked" records around
1583 my $error = $cust_event->delete;
1584 return $error if $error;
1589 local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
1590 if $options{'quiet'};
1591 warn " running cust_event ". $cust_event->eventnum. "\n"
1594 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
1595 if ( my $error = $cust_event->do_event() ) {
1596 #XXX wtf is this? figure out a proper dealio with return value
1608 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
1610 Inserts database records for and returns an ordered listref of new events due
1611 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
1612 events are due, an empty listref is returned. If there is an error, returns a
1613 scalar error message.
1615 To actually run the events, call each event's test_condition method, and if
1616 still true, call the event's do_event method.
1618 Options are passed as a hashref or as a list of name-value pairs. Available
1625 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.
1629 "collect" (the default) or "pre-bill"
1633 "Current time" for the events.
1637 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)
1641 Only return events for the specified eventtable (by default, events of all eventtables are returned)
1645 Explicitly pass the objects to be tested (typically used with eventtable).
1649 Set to true to return the objects, but not actually insert them into the
1656 sub due_cust_event {
1658 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
1661 #my $DEBUG = $opt{'debug'}
1662 local($DEBUG) = $opt{'debug'}
1663 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
1664 $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1666 warn "$me due_cust_event called with options ".
1667 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
1670 $opt{'time'} ||= time;
1672 local $SIG{HUP} = 'IGNORE';
1673 local $SIG{INT} = 'IGNORE';
1674 local $SIG{QUIT} = 'IGNORE';
1675 local $SIG{TERM} = 'IGNORE';
1676 local $SIG{TSTP} = 'IGNORE';
1677 local $SIG{PIPE} = 'IGNORE';
1679 my $oldAutoCommit = $FS::UID::AutoCommit;
1680 local $FS::UID::AutoCommit = 0;
1683 $self->select_for_update #mutex
1684 unless $opt{testonly};
1687 # find possible events (initial search)
1690 my @cust_event = ();
1692 my @eventtable = $opt{'eventtable'}
1693 ? ( $opt{'eventtable'} )
1694 : FS::part_event->eventtables_runorder;
1696 my $check_freq = $opt{'check_freq'} || '1d';
1698 foreach my $eventtable ( @eventtable ) {
1701 if ( $opt{'objects'} ) {
1703 @objects = @{ $opt{'objects'} };
1707 #my @objects = $self->$eventtable(); # sub cust_main { @{ [ $self ] }; }
1708 if ( $eventtable eq 'cust_main' ) {
1709 @objects = ( $self );
1713 "LEFT JOIN cust_main USING ( custnum )";
1715 #some false laziness w/Cron::bill bill_where
1717 my $join = FS::part_event_condition->join_conditions_sql( $eventtable);
1718 my $where = FS::part_event_condition->where_conditions_sql($eventtable,
1719 'time'=>$opt{'time'},
1721 $where = $where ? "AND $where" : '';
1723 my $are_part_event =
1724 "EXISTS ( SELECT 1 FROM part_event $join
1725 WHERE check_freq = '$check_freq'
1726 AND eventtable = '$eventtable'
1727 AND ( disabled = '' OR disabled IS NULL )
1733 @objects = $self->$eventtable(
1734 'addl_from' => $cm_join,
1735 'extra_sql' => " AND $are_part_event",
1741 my @e_cust_event = ();
1743 my $cross = "CROSS JOIN $eventtable";
1744 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
1745 unless $eventtable eq 'cust_main';
1747 foreach my $object ( @objects ) {
1749 #this first search uses the condition_sql magic for optimization.
1750 #the more possible events we can eliminate in this step the better
1752 my $cross_where = '';
1753 my $pkey = $object->primary_key;
1754 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
1756 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
1758 FS::part_event_condition->where_conditions_sql( $eventtable,
1759 'time'=>$opt{'time'}
1761 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
1763 $extra_sql = "AND $extra_sql" if $extra_sql;
1765 #here is the agent virtualization
1766 $extra_sql .= " AND ( part_event.agentnum IS NULL
1767 OR part_event.agentnum = ". $self->agentnum. ' )';
1769 $extra_sql .= " $order";
1771 warn "searching for events for $eventtable ". $object->$pkey. "\n"
1772 if $opt{'debug'} > 2;
1773 my @part_event = qsearch( {
1774 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
1775 'select' => 'part_event.*',
1776 'table' => 'part_event',
1777 'addl_from' => "$cross $join",
1778 'hashref' => { 'check_freq' => $check_freq,
1779 'eventtable' => $eventtable,
1782 'extra_sql' => "AND $cross_where $extra_sql",
1786 my $pkey = $object->primary_key;
1787 warn " ". scalar(@part_event).
1788 " possible events found for $eventtable ". $object->$pkey(). "\n";
1791 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
1795 warn " ". scalar(@e_cust_event).
1796 " subtotal possible cust events found for $eventtable\n"
1799 push @cust_event, @e_cust_event;
1803 warn " ". scalar(@cust_event).
1804 " total possible cust events found in initial search\n"
1812 $opt{stage} ||= 'collect';
1814 grep { my $stage = $_->part_event->event_stage;
1815 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
1825 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
1826 'stats_hashref' => \%unsat ),
1829 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
1832 warn " invalid conditions not eliminated with condition_sql:\n".
1833 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
1834 if keys %unsat && $DEBUG; # > 1;
1840 unless( $opt{testonly} ) {
1841 foreach my $cust_event ( @cust_event ) {
1843 my $error = $cust_event->insert();
1845 $dbh->rollback if $oldAutoCommit;
1852 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1858 warn " returning events: ". Dumper(@cust_event). "\n"
1865 =item apply_payments_and_credits [ OPTION => VALUE ... ]
1867 Applies unapplied payments and credits.
1869 In most cases, this new method should be used in place of sequential
1870 apply_payments and apply_credits methods.
1872 A hash of optional arguments may be passed. Currently "manual" is supported.
1873 If true, a payment receipt is sent instead of a statement when
1874 'payment_receipt_email' configuration option is set.
1876 If there is an error, returns the error, otherwise returns false.
1880 sub apply_payments_and_credits {
1881 my( $self, %options ) = @_;
1883 local $SIG{HUP} = 'IGNORE';
1884 local $SIG{INT} = 'IGNORE';
1885 local $SIG{QUIT} = 'IGNORE';
1886 local $SIG{TERM} = 'IGNORE';
1887 local $SIG{TSTP} = 'IGNORE';
1888 local $SIG{PIPE} = 'IGNORE';
1890 my $oldAutoCommit = $FS::UID::AutoCommit;
1891 local $FS::UID::AutoCommit = 0;
1894 $self->select_for_update; #mutex
1896 foreach my $cust_bill ( $self->open_cust_bill ) {
1897 my $error = $cust_bill->apply_payments_and_credits(%options);
1899 $dbh->rollback if $oldAutoCommit;
1900 return "Error applying: $error";
1904 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1909 =item apply_credits OPTION => VALUE ...
1911 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
1912 to outstanding invoice balances in chronological order (or reverse
1913 chronological order if the I<order> option is set to B<newest>) and returns the
1914 value of any remaining unapplied credits available for refund (see
1915 L<FS::cust_refund>).
1917 Dies if there is an error.
1925 local $SIG{HUP} = 'IGNORE';
1926 local $SIG{INT} = 'IGNORE';
1927 local $SIG{QUIT} = 'IGNORE';
1928 local $SIG{TERM} = 'IGNORE';
1929 local $SIG{TSTP} = 'IGNORE';
1930 local $SIG{PIPE} = 'IGNORE';
1932 my $oldAutoCommit = $FS::UID::AutoCommit;
1933 local $FS::UID::AutoCommit = 0;
1936 $self->select_for_update; #mutex
1938 unless ( $self->total_unapplied_credits ) {
1939 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1943 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
1944 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
1946 my @invoices = $self->open_cust_bill;
1947 @invoices = sort { $b->_date <=> $a->_date } @invoices
1948 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
1950 if ( $conf->exists('pkg-balances') ) {
1951 # limit @credits to those w/ a pkgnum grepped from $self
1953 foreach my $i (@invoices) {
1954 foreach my $li ( $i->cust_bill_pkg ) {
1955 $pkgnums{$li->pkgnum} = 1;
1958 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
1963 foreach my $cust_bill ( @invoices ) {
1965 if ( !defined($credit) || $credit->credited == 0) {
1966 $credit = pop @credits or last;
1970 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
1971 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
1973 $owed = $cust_bill->owed;
1975 unless ( $owed > 0 ) {
1976 push @credits, $credit;
1980 my $amount = min( $credit->credited, $owed );
1982 my $cust_credit_bill = new FS::cust_credit_bill ( {
1983 'crednum' => $credit->crednum,
1984 'invnum' => $cust_bill->invnum,
1985 'amount' => $amount,
1987 $cust_credit_bill->pkgnum( $credit->pkgnum )
1988 if $conf->exists('pkg-balances') && $credit->pkgnum;
1989 my $error = $cust_credit_bill->insert;
1991 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
1995 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
1999 my $total_unapplied_credits = $self->total_unapplied_credits;
2001 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2003 return $total_unapplied_credits;
2006 =item apply_payments [ OPTION => VALUE ... ]
2008 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2009 to outstanding invoice balances in chronological order.
2011 #and returns the value of any remaining unapplied payments.
2013 A hash of optional arguments may be passed. Currently "manual" is supported.
2014 If true, a payment receipt is sent instead of a statement when
2015 'payment_receipt_email' configuration option is set.
2017 Dies if there is an error.
2021 sub apply_payments {
2022 my( $self, %options ) = @_;
2024 local $SIG{HUP} = 'IGNORE';
2025 local $SIG{INT} = 'IGNORE';
2026 local $SIG{QUIT} = 'IGNORE';
2027 local $SIG{TERM} = 'IGNORE';
2028 local $SIG{TSTP} = 'IGNORE';
2029 local $SIG{PIPE} = 'IGNORE';
2031 my $oldAutoCommit = $FS::UID::AutoCommit;
2032 local $FS::UID::AutoCommit = 0;
2035 $self->select_for_update; #mutex
2039 my @payments = sort { $b->_date <=> $a->_date }
2040 grep { $_->unapplied > 0 }
2043 my @invoices = sort { $a->_date <=> $b->_date}
2044 grep { $_->owed > 0 }
2047 if ( $conf->exists('pkg-balances') ) {
2048 # limit @payments to those w/ a pkgnum grepped from $self
2050 foreach my $i (@invoices) {
2051 foreach my $li ( $i->cust_bill_pkg ) {
2052 $pkgnums{$li->pkgnum} = 1;
2055 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
2060 foreach my $cust_bill ( @invoices ) {
2062 if ( !defined($payment) || $payment->unapplied == 0 ) {
2063 $payment = pop @payments or last;
2067 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
2068 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
2070 $owed = $cust_bill->owed;
2072 unless ( $owed > 0 ) {
2073 push @payments, $payment;
2077 my $amount = min( $payment->unapplied, $owed );
2079 my $cust_bill_pay = new FS::cust_bill_pay ( {
2080 'paynum' => $payment->paynum,
2081 'invnum' => $cust_bill->invnum,
2082 'amount' => $amount,
2084 $cust_bill_pay->pkgnum( $payment->pkgnum )
2085 if $conf->exists('pkg-balances') && $payment->pkgnum;
2086 my $error = $cust_bill_pay->insert(%options);
2088 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2092 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2096 my $total_unapplied_payments = $self->total_unapplied_payments;
2098 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2100 return $total_unapplied_payments;
2110 suspend_adjourned_pkgs
2113 (do_cust_event pre-bill)
2116 (vendor-only) _gather_taxes
2117 _omit_zero_value_bundles
2120 apply_payments_and_credits
2129 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>