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';
730 my @cust_tax_exempt_pkg = splice( @{ $_->_cust_tax_exempt_pkg } );
732 next unless @cust_tax_exempt_pkg; #just avoiding the prob when irrelevant?
733 die "can't distribute tax exemptions: no line item for ". Dumper($_).
734 " in packagemap ". join(',', sort {$a<=>$b} keys %packagemap). "\n"
735 unless $packagemap{$_->pkgnum};
737 push @{ $packagemap{$_->pkgnum}->_cust_tax_exempt_pkg },
738 @cust_tax_exempt_pkg;
742 #consolidate and create tax line items
743 warn "consolidating and generating...\n" if $DEBUG > 2;
744 foreach my $taxname ( keys %taxname ) {
747 my @cust_bill_pkg_tax_location = ();
748 my @cust_bill_pkg_tax_rate_location = ();
749 warn "adding $taxname\n" if $DEBUG > 1;
750 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
751 next if $seen{$taxitem}++;
752 warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
753 $tax += $tax{$taxitem};
754 push @cust_bill_pkg_tax_location,
755 map { new FS::cust_bill_pkg_tax_location $_ }
756 @{ $tax_location{ $taxitem } };
757 push @cust_bill_pkg_tax_rate_location,
758 map { new FS::cust_bill_pkg_tax_rate_location $_ }
759 @{ $tax_rate_location{ $taxitem } };
763 $tax = sprintf('%.2f', $tax );
765 my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
771 if ( $pkg_category and
772 $conf->config('invoice_latexsummary') ||
773 $conf->config('invoice_htmlsummary')
777 my %hash = ( 'section' => $pkg_category->categoryname );
778 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
782 push @tax_line_items, new FS::cust_bill_pkg {
788 'itemdesc' => $taxname,
789 'display' => \@display,
790 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
791 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
800 my ($self, %params) = @_;
802 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
804 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
805 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
806 my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
807 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
808 my $total_setup = $params{setup} or die "no setup accumulator specified";
809 my $total_recur = $params{recur} or die "no recur accumulator specified";
810 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
811 my $time = $params{'time'} or die "no time specified";
812 my (%options) = %{$params{options}};
815 my $real_pkgpart = $params{real_pkgpart};
816 my %hash = $cust_pkg->hash;
817 my $old_cust_pkg = new FS::cust_pkg \%hash;
823 $cust_pkg->pkgpart($part_pkg->pkgpart);
831 if ( ! $options{recurring_only}
832 and ! $options{cancel}
833 and ( $options{'resetup'}
834 || ( ! $cust_pkg->setup
835 && ( ! $cust_pkg->start_date
836 || $cust_pkg->start_date <= $time
838 && ( ! $conf->exists('disable_setup_suspended_pkgs')
839 || ( $conf->exists('disable_setup_suspended_pkgs') &&
840 ! $cust_pkg->getfield('susp')
848 warn " bill setup\n" if $DEBUG > 1;
851 $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
852 return "$@ running calc_setup for $cust_pkg\n"
855 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
857 $cust_pkg->setfield('setup', $time)
858 unless $cust_pkg->setup;
859 #do need it, but it won't get written to the db
860 #|| $cust_pkg->pkgpart != $real_pkgpart;
862 $cust_pkg->setfield('start_date', '')
863 if $cust_pkg->start_date;
871 #XXX unit stuff here too
875 if ( ! $cust_pkg->start_date
876 and ( ! $cust_pkg->susp || $part_pkg->option('suspend_bill', 1) )
878 ( $part_pkg->freq ne '0' && ( $cust_pkg->bill || 0 ) <= $time )
879 || ( $part_pkg->plan eq 'voip_cdr'
880 && $part_pkg->option('bill_every_call')
885 # XXX should this be a package event? probably. events are called
886 # at collection time at the moment, though...
887 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
888 if $part_pkg->can('reset_usage') && !$options{'no_usage_reset'};
889 #don't want to reset usage just cause we want a line item??
890 #&& $part_pkg->pkgpart == $real_pkgpart;
892 warn " bill recur\n" if $DEBUG > 1;
895 # XXX shared with $recur_prog
896 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
900 #over two params! lets at least switch to a hashref for the rest...
901 my $increment_next_bill = ( $part_pkg->freq ne '0'
902 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
905 my %param = ( 'precommit_hooks' => $precommit_hooks,
906 'increment_next_bill' => $increment_next_bill,
907 'discounts' => \@discounts,
908 'real_pkgpart' => $real_pkgpart,
909 'freq_override' => $options{freq_override} || '',
913 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
915 # There may be some part_pkg for which this is wrong. Only those
916 # which can_discount are supported.
917 # (the UI should prevent adding discounts to these at the moment)
919 warn "calling $method on cust_pkg ". $cust_pkg->pkgnum.
920 " for pkgpart ". $cust_pkg->pkgpart.
921 " with params ". join(' / ', map "$_=>$param{$_}", keys %param). "\n"
924 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
925 return "$@ running $method for $cust_pkg\n"
928 if ( $increment_next_bill ) {
930 my $next_bill = $part_pkg->add_freq($sdate, $options{freq_override} || 0);
931 return "unparsable frequency: ". $part_pkg->freq
934 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
935 # only for figuring next bill date, nothing else, so, reset $sdate again
937 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
938 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
939 $cust_pkg->last_bill($sdate);
941 $cust_pkg->setfield('bill', $next_bill );
945 if ( $param{'setup_fee'} ) {
946 # Add an additional setup fee at the billing stage.
947 # Used for prorate_defer_bill.
948 $setup += $param{'setup_fee'};
949 $unitsetup += $param{'setup_fee'};
955 warn "\$setup is undefined" unless defined($setup);
956 warn "\$recur is undefined" unless defined($recur);
957 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
960 # If there's line items, create em cust_bill_pkg records
961 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
966 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
967 # hmm.. and if just the options are modified in some weird price plan?
969 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
972 my $error = $cust_pkg->replace( $old_cust_pkg,
973 'depend_jobnum'=>$options{depend_jobnum},
974 'options' => { $cust_pkg->options },
976 unless $options{no_commit};
977 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
978 if $error; #just in case
981 $setup = sprintf( "%.2f", $setup );
982 $recur = sprintf( "%.2f", $recur );
983 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
984 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
986 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
987 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
990 my $discount_show_always = ($recur == 0 && scalar(@discounts)
991 && $conf->exists('discount-show-always'));
995 (!$part_pkg->hidden && $options{has_hidden}) || #include some $0 lines
996 $discount_show_always )
999 warn " charges (setup=$setup, recur=$recur); adding line items\n"
1002 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
1004 warn " adding customer package invoice detail: $_\n"
1005 foreach @cust_pkg_detail;
1007 push @details, @cust_pkg_detail;
1009 my $cust_bill_pkg = new FS::cust_bill_pkg {
1010 'pkgnum' => $cust_pkg->pkgnum,
1012 'unitsetup' => $unitsetup,
1014 'unitrecur' => $unitrecur,
1015 'quantity' => $cust_pkg->quantity,
1016 'details' => \@details,
1017 'discounts' => \@discounts,
1018 'hidden' => $part_pkg->hidden,
1019 'freq' => $part_pkg->freq,
1022 if ( $part_pkg->option('recur_temporality', 1) eq 'preceding' ) {
1023 $cust_bill_pkg->sdate( $hash{last_bill} );
1024 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
1025 $cust_bill_pkg->edate( $time ) if $options{cancel};
1026 } else { #if ( $part_pkg->option('recur_temporality', 1) eq 'upcoming' ) {
1027 $cust_bill_pkg->sdate( $sdate );
1028 $cust_bill_pkg->edate( $cust_pkg->bill );
1029 #$cust_bill_pkg->edate( $time ) if $options{cancel};
1032 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
1033 unless $part_pkg->pkgpart == $real_pkgpart;
1035 $$total_setup += $setup;
1036 $$total_recur += $recur;
1042 unless ( $discount_show_always ) {
1044 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart, \%options);
1045 return $error if $error;
1048 push @$cust_bill_pkgs, $cust_bill_pkg;
1050 } #if $setup != 0 || $recur != 0
1060 my $part_pkg = shift;
1061 my $taxlisthash = shift;
1062 my $cust_bill_pkg = shift;
1063 my $cust_pkg = shift;
1064 my $invoice_time = shift;
1065 my $real_pkgpart = shift;
1066 my $options = shift;
1068 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1070 my %cust_bill_pkg = ();
1074 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
1075 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
1076 push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
1077 push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
1079 if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
1081 if ( $conf->exists('enable_taxproducts')
1082 && ( scalar($part_pkg->part_pkg_taxoverride)
1083 || $part_pkg->has_taxproduct
1088 foreach my $class (@classes) {
1089 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class, $cust_pkg );
1090 return $err_or_ref unless ref($err_or_ref);
1091 $taxes{$class} = $err_or_ref;
1094 unless (exists $taxes{''}) {
1095 my $err_or_ref = $self->_gather_taxes( $part_pkg, '', $cust_pkg );
1096 return $err_or_ref unless ref($err_or_ref);
1097 $taxes{''} = $err_or_ref;
1102 my @loc_keys = qw( city county state country );
1104 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1105 my $cust_location = $cust_pkg->cust_location;
1106 %taxhash = map { $_ => $cust_location->$_() } @loc_keys;
1109 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
1112 %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
1115 $taxhash{'taxclass'} = $part_pkg->taxclass;
1118 my %taxhash_elim = %taxhash;
1119 my @elim = qw( city county state );
1122 #first try a match with taxclass
1123 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1125 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1126 #then try a match without taxclass
1127 my %no_taxclass = %taxhash_elim;
1128 $no_taxclass{ 'taxclass' } = '';
1129 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1132 $taxhash_elim{ shift(@elim) } = '';
1134 } while ( !scalar(@taxes) && scalar(@elim) );
1136 @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
1138 if $self->cust_main_exemption; #just to be safe
1140 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1142 $_->set('pkgnum', $cust_pkg->pkgnum );
1143 $_->set('locationnum', $cust_pkg->locationnum );
1147 $taxes{''} = [ @taxes ];
1148 $taxes{'setup'} = [ @taxes ];
1149 $taxes{'recur'} = [ @taxes ];
1150 $taxes{$_} = [ @taxes ] foreach (@classes);
1152 # # maybe eliminate this entirely, along with all the 0% records
1153 # unless ( @taxes ) {
1155 # "fatal: can't find tax rate for state/county/country/taxclass ".
1156 # join('/', map $taxhash{$_}, qw(state county country taxclass) );
1159 } #if $conf->exists('enable_taxproducts') ...
1164 my $separate = $conf->exists('separate_usage');
1165 my $temp_pkg = new FS::cust_pkg { pkgpart => $real_pkgpart };
1166 my $usage_mandate = $temp_pkg->part_pkg->option('usage_mandate', 'Hush!');
1167 my $section = $temp_pkg->part_pkg->categoryname;
1168 if ( $separate || $section || $usage_mandate ) {
1170 my %hash = ( 'section' => $section );
1172 $section = $temp_pkg->part_pkg->option('usage_section', 'Hush!');
1173 my $summary = $temp_pkg->part_pkg->option('summarize_usage', 'Hush!');
1175 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
1176 push @display, new FS::cust_bill_pkg_display { type => 'R', %hash };
1178 push @display, new FS::cust_bill_pkg_display
1181 ( ( $usage_mandate ) ? ( 'summary' => 'Y' ) : () ),
1185 if ($separate && $section && $summary) {
1186 push @display, new FS::cust_bill_pkg_display { type => 'U',
1191 if ($usage_mandate || $section && $summary) {
1192 $hash{post_total} = 'Y';
1195 if ($separate || $usage_mandate) {
1196 $hash{section} = $section if ($separate || $usage_mandate);
1197 push @display, new FS::cust_bill_pkg_display { type => 'U', %hash };
1201 $cust_bill_pkg->set('display', \@display);
1203 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
1204 foreach my $key (keys %tax_cust_bill_pkg) {
1205 my @taxes = @{ $taxes{$key} || [] };
1206 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
1208 my %localtaxlisthash = ();
1209 foreach my $tax ( @taxes ) {
1211 my $taxname = ref( $tax ). ' '. $tax->taxnum;
1212 # $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
1213 # ' locationnum'. $cust_pkg->locationnum
1214 # if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
1216 $taxlisthash->{ $taxname } ||= [ $tax ];
1217 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
1219 $localtaxlisthash{ $taxname } ||= [ $tax ];
1220 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
1224 warn "finding taxed taxes...\n" if $DEBUG > 2;
1225 foreach my $tax ( keys %localtaxlisthash ) {
1226 my $tax_object = shift @{ $localtaxlisthash{$tax} };
1227 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
1229 next unless $tax_object->can('tax_on_tax');
1231 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
1232 my $totname = ref( $tot ). ' '. $tot->taxnum;
1234 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
1236 next unless exists( $localtaxlisthash{ $totname } ); # only increase
1238 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
1239 my $hashref_or_error =
1240 $tax_object->taxline( $localtaxlisthash{$tax},
1241 'custnum' => $self->custnum,
1242 'invoice_time' => $invoice_time,
1244 return $hashref_or_error
1245 unless ref($hashref_or_error);
1247 $taxlisthash->{ $totname } ||= [ $tot ];
1248 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
1260 my $part_pkg = shift;
1262 my $cust_pkg = shift;
1264 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1267 if ( $cust_pkg->locationnum && $conf->exists('tax-pkg_address') ) {
1268 $geocode = $cust_pkg->cust_location->geocode('cch');
1270 $geocode = $self->geocode('cch');
1275 my @taxclassnums = map { $_->taxclassnum }
1276 $part_pkg->part_pkg_taxoverride($class);
1278 unless (@taxclassnums) {
1279 @taxclassnums = map { $_->taxclassnum }
1280 grep { $_->taxable eq 'Y' }
1281 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
1283 warn "Found taxclassnum values of ". join(',', @taxclassnums)
1288 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
1290 @taxes = qsearch({ 'table' => 'tax_rate',
1291 'hashref' => { 'geocode' => $geocode, },
1292 'extra_sql' => $extra_sql,
1294 if scalar(@taxclassnums);
1296 warn "Found taxes ".
1297 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
1304 =item collect [ HASHREF | OPTION => VALUE ... ]
1306 (Attempt to) collect money for this customer's outstanding invoices (see
1307 L<FS::cust_bill>). Usually used after the bill method.
1309 Actions are now triggered by billing events; see L<FS::part_event> and the
1310 billing events web interface. Old-style invoice events (see
1311 L<FS::part_bill_event>) have been deprecated.
1313 If there is an error, returns the error, otherwise returns false.
1315 Options are passed as name-value pairs.
1317 Currently available options are:
1323 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.
1327 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1331 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1335 set true to surpress email card/ACH decline notices.
1339 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)
1345 # allows for one time override of normal customer billing method
1350 my( $self, %options ) = @_;
1352 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1354 my $invoice_time = $options{'invoice_time'} || time;
1357 local $SIG{HUP} = 'IGNORE';
1358 local $SIG{INT} = 'IGNORE';
1359 local $SIG{QUIT} = 'IGNORE';
1360 local $SIG{TERM} = 'IGNORE';
1361 local $SIG{TSTP} = 'IGNORE';
1362 local $SIG{PIPE} = 'IGNORE';
1364 my $oldAutoCommit = $FS::UID::AutoCommit;
1365 local $FS::UID::AutoCommit = 0;
1368 $self->select_for_update; #mutex
1371 my $balance = $self->balance;
1372 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
1375 if ( exists($options{'retry_card'}) ) {
1376 carp 'retry_card option passed to collect is deprecated; use retry';
1377 $options{'retry'} ||= $options{'retry_card'};
1379 if ( exists($options{'retry'}) && $options{'retry'} ) {
1380 my $error = $self->retry_realtime;
1382 $dbh->rollback if $oldAutoCommit;
1387 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1389 #never want to roll back an event just because it returned an error
1390 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1392 $self->do_cust_event(
1393 'debug' => ( $options{'debug'} || 0 ),
1394 'time' => $invoice_time,
1395 'check_freq' => $options{'check_freq'},
1396 'stage' => 'collect',
1401 =item retry_realtime
1403 Schedules realtime / batch credit card / electronic check / LEC billing
1404 events for for retry. Useful if card information has changed or manual
1405 retry is desired. The 'collect' method must be called to actually retry
1408 Implementation details: For either this customer, or for each of this
1409 customer's open invoices, changes the status of the first "done" (with
1410 statustext error) realtime processing event to "failed".
1414 sub retry_realtime {
1417 local $SIG{HUP} = 'IGNORE';
1418 local $SIG{INT} = 'IGNORE';
1419 local $SIG{QUIT} = 'IGNORE';
1420 local $SIG{TERM} = 'IGNORE';
1421 local $SIG{TSTP} = 'IGNORE';
1422 local $SIG{PIPE} = 'IGNORE';
1424 my $oldAutoCommit = $FS::UID::AutoCommit;
1425 local $FS::UID::AutoCommit = 0;
1428 #a little false laziness w/due_cust_event (not too bad, really)
1430 my $join = FS::part_event_condition->join_conditions_sql;
1431 my $order = FS::part_event_condition->order_conditions_sql;
1434 . join ( ' OR ' , map {
1435 "( part_event.eventtable = " . dbh->quote($_)
1436 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
1437 } FS::part_event->eventtables)
1440 #here is the agent virtualization
1441 my $agent_virt = " ( part_event.agentnum IS NULL
1442 OR part_event.agentnum = ". $self->agentnum. ' )';
1444 #XXX this shouldn't be hardcoded, actions should declare it...
1445 my @realtime_events = qw(
1446 cust_bill_realtime_card
1447 cust_bill_realtime_check
1448 cust_bill_realtime_lec
1452 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
1457 my @cust_event = qsearchs({
1458 'table' => 'cust_event',
1459 'select' => 'cust_event.*',
1460 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
1461 'hashref' => { 'status' => 'done' },
1462 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
1463 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
1466 my %seen_invnum = ();
1467 foreach my $cust_event (@cust_event) {
1469 #max one for the customer, one for each open invoice
1470 my $cust_X = $cust_event->cust_X;
1471 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
1475 or $cust_event->part_event->eventtable eq 'cust_bill'
1478 my $error = $cust_event->retry;
1480 $dbh->rollback if $oldAutoCommit;
1481 return "error scheduling event for retry: $error";
1486 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1491 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
1493 Runs billing events; see L<FS::part_event> and the billing events web
1496 If there is an error, returns the error, otherwise returns false.
1498 Options are passed as name-value pairs.
1500 Currently available options are:
1506 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.
1510 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1514 "collect" (the default) or "pre-bill"
1518 set true to surpress email card/ACH decline notices.
1522 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)
1529 # allows for one time override of normal customer billing method
1533 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1536 my( $self, %options ) = @_;
1538 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1540 my $time = $options{'time'} || time;
1543 local $SIG{HUP} = 'IGNORE';
1544 local $SIG{INT} = 'IGNORE';
1545 local $SIG{QUIT} = 'IGNORE';
1546 local $SIG{TERM} = 'IGNORE';
1547 local $SIG{TSTP} = 'IGNORE';
1548 local $SIG{PIPE} = 'IGNORE';
1550 my $oldAutoCommit = $FS::UID::AutoCommit;
1551 local $FS::UID::AutoCommit = 0;
1554 $self->select_for_update; #mutex
1557 my $balance = $self->balance;
1558 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
1561 # if ( exists($options{'retry_card'}) ) {
1562 # carp 'retry_card option passed to collect is deprecated; use retry';
1563 # $options{'retry'} ||= $options{'retry_card'};
1565 # if ( exists($options{'retry'}) && $options{'retry'} ) {
1566 # my $error = $self->retry_realtime;
1568 # $dbh->rollback if $oldAutoCommit;
1573 # false laziness w/pay_batch::import_results
1575 my $due_cust_event = $self->due_cust_event(
1576 'debug' => ( $options{'debug'} || 0 ),
1578 'check_freq' => $options{'check_freq'},
1579 'stage' => ( $options{'stage'} || 'collect' ),
1581 unless( ref($due_cust_event) ) {
1582 $dbh->rollback if $oldAutoCommit;
1583 return $due_cust_event;
1586 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1587 #never want to roll back an event just because it or a different one
1589 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1591 foreach my $cust_event ( @$due_cust_event ) {
1595 #re-eval event conditions (a previous event could have changed things)
1596 unless ( $cust_event->test_conditions( 'time' => $time ) ) {
1597 #don't leave stray "new/locked" records around
1598 my $error = $cust_event->delete;
1599 return $error if $error;
1604 local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
1605 if $options{'quiet'};
1606 warn " running cust_event ". $cust_event->eventnum. "\n"
1609 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
1610 if ( my $error = $cust_event->do_event() ) {
1611 #XXX wtf is this? figure out a proper dealio with return value
1623 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
1625 Inserts database records for and returns an ordered listref of new events due
1626 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
1627 events are due, an empty listref is returned. If there is an error, returns a
1628 scalar error message.
1630 To actually run the events, call each event's test_condition method, and if
1631 still true, call the event's do_event method.
1633 Options are passed as a hashref or as a list of name-value pairs. Available
1640 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.
1644 "collect" (the default) or "pre-bill"
1648 "Current time" for the events.
1652 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)
1656 Only return events for the specified eventtable (by default, events of all eventtables are returned)
1660 Explicitly pass the objects to be tested (typically used with eventtable).
1664 Set to true to return the objects, but not actually insert them into the
1671 sub due_cust_event {
1673 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
1676 #my $DEBUG = $opt{'debug'}
1677 local($DEBUG) = $opt{'debug'}
1678 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
1679 $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1681 warn "$me due_cust_event called with options ".
1682 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
1685 $opt{'time'} ||= time;
1687 local $SIG{HUP} = 'IGNORE';
1688 local $SIG{INT} = 'IGNORE';
1689 local $SIG{QUIT} = 'IGNORE';
1690 local $SIG{TERM} = 'IGNORE';
1691 local $SIG{TSTP} = 'IGNORE';
1692 local $SIG{PIPE} = 'IGNORE';
1694 my $oldAutoCommit = $FS::UID::AutoCommit;
1695 local $FS::UID::AutoCommit = 0;
1698 $self->select_for_update #mutex
1699 unless $opt{testonly};
1702 # find possible events (initial search)
1705 my @cust_event = ();
1707 my @eventtable = $opt{'eventtable'}
1708 ? ( $opt{'eventtable'} )
1709 : FS::part_event->eventtables_runorder;
1711 my $check_freq = $opt{'check_freq'} || '1d';
1713 foreach my $eventtable ( @eventtable ) {
1716 if ( $opt{'objects'} ) {
1718 @objects = @{ $opt{'objects'} };
1722 #my @objects = $self->$eventtable(); # sub cust_main { @{ [ $self ] }; }
1723 if ( $eventtable eq 'cust_main' ) {
1724 @objects = ( $self );
1728 "LEFT JOIN cust_main USING ( custnum )";
1730 #some false laziness w/Cron::bill bill_where
1732 my $join = FS::part_event_condition->join_conditions_sql( $eventtable);
1733 my $where = FS::part_event_condition->where_conditions_sql($eventtable,
1734 'time'=>$opt{'time'},
1736 $where = $where ? "AND $where" : '';
1738 my $are_part_event =
1739 "EXISTS ( SELECT 1 FROM part_event $join
1740 WHERE check_freq = '$check_freq'
1741 AND eventtable = '$eventtable'
1742 AND ( disabled = '' OR disabled IS NULL )
1748 @objects = $self->$eventtable(
1749 'addl_from' => $cm_join,
1750 'extra_sql' => " AND $are_part_event",
1756 my @e_cust_event = ();
1758 my $cross = "CROSS JOIN $eventtable";
1759 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
1760 unless $eventtable eq 'cust_main';
1762 foreach my $object ( @objects ) {
1764 #this first search uses the condition_sql magic for optimization.
1765 #the more possible events we can eliminate in this step the better
1767 my $cross_where = '';
1768 my $pkey = $object->primary_key;
1769 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
1771 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
1773 FS::part_event_condition->where_conditions_sql( $eventtable,
1774 'time'=>$opt{'time'}
1776 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
1778 $extra_sql = "AND $extra_sql" if $extra_sql;
1780 #here is the agent virtualization
1781 $extra_sql .= " AND ( part_event.agentnum IS NULL
1782 OR part_event.agentnum = ". $self->agentnum. ' )';
1784 $extra_sql .= " $order";
1786 warn "searching for events for $eventtable ". $object->$pkey. "\n"
1787 if $opt{'debug'} > 2;
1788 my @part_event = qsearch( {
1789 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
1790 'select' => 'part_event.*',
1791 'table' => 'part_event',
1792 'addl_from' => "$cross $join",
1793 'hashref' => { 'check_freq' => $check_freq,
1794 'eventtable' => $eventtable,
1797 'extra_sql' => "AND $cross_where $extra_sql",
1801 my $pkey = $object->primary_key;
1802 warn " ". scalar(@part_event).
1803 " possible events found for $eventtable ". $object->$pkey(). "\n";
1806 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
1810 warn " ". scalar(@e_cust_event).
1811 " subtotal possible cust events found for $eventtable\n"
1814 push @cust_event, @e_cust_event;
1818 warn " ". scalar(@cust_event).
1819 " total possible cust events found in initial search\n"
1827 $opt{stage} ||= 'collect';
1829 grep { my $stage = $_->part_event->event_stage;
1830 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
1840 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
1841 'stats_hashref' => \%unsat ),
1844 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
1847 warn " invalid conditions not eliminated with condition_sql:\n".
1848 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
1849 if keys %unsat && $DEBUG; # > 1;
1855 unless( $opt{testonly} ) {
1856 foreach my $cust_event ( @cust_event ) {
1858 my $error = $cust_event->insert();
1860 $dbh->rollback if $oldAutoCommit;
1867 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1873 warn " returning events: ". Dumper(@cust_event). "\n"
1880 =item apply_payments_and_credits [ OPTION => VALUE ... ]
1882 Applies unapplied payments and credits.
1884 In most cases, this new method should be used in place of sequential
1885 apply_payments and apply_credits methods.
1887 A hash of optional arguments may be passed. Currently "manual" is supported.
1888 If true, a payment receipt is sent instead of a statement when
1889 'payment_receipt_email' configuration option is set.
1891 If there is an error, returns the error, otherwise returns false.
1895 sub apply_payments_and_credits {
1896 my( $self, %options ) = @_;
1898 local $SIG{HUP} = 'IGNORE';
1899 local $SIG{INT} = 'IGNORE';
1900 local $SIG{QUIT} = 'IGNORE';
1901 local $SIG{TERM} = 'IGNORE';
1902 local $SIG{TSTP} = 'IGNORE';
1903 local $SIG{PIPE} = 'IGNORE';
1905 my $oldAutoCommit = $FS::UID::AutoCommit;
1906 local $FS::UID::AutoCommit = 0;
1909 $self->select_for_update; #mutex
1911 foreach my $cust_bill ( $self->open_cust_bill ) {
1912 my $error = $cust_bill->apply_payments_and_credits(%options);
1914 $dbh->rollback if $oldAutoCommit;
1915 return "Error applying: $error";
1919 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1924 =item apply_credits OPTION => VALUE ...
1926 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
1927 to outstanding invoice balances in chronological order (or reverse
1928 chronological order if the I<order> option is set to B<newest>) and returns the
1929 value of any remaining unapplied credits available for refund (see
1930 L<FS::cust_refund>).
1932 Dies if there is an error.
1940 local $SIG{HUP} = 'IGNORE';
1941 local $SIG{INT} = 'IGNORE';
1942 local $SIG{QUIT} = 'IGNORE';
1943 local $SIG{TERM} = 'IGNORE';
1944 local $SIG{TSTP} = 'IGNORE';
1945 local $SIG{PIPE} = 'IGNORE';
1947 my $oldAutoCommit = $FS::UID::AutoCommit;
1948 local $FS::UID::AutoCommit = 0;
1951 $self->select_for_update; #mutex
1953 unless ( $self->total_unapplied_credits ) {
1954 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1958 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
1959 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
1961 my @invoices = $self->open_cust_bill;
1962 @invoices = sort { $b->_date <=> $a->_date } @invoices
1963 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
1965 if ( $conf->exists('pkg-balances') ) {
1966 # limit @credits to those w/ a pkgnum grepped from $self
1968 foreach my $i (@invoices) {
1969 foreach my $li ( $i->cust_bill_pkg ) {
1970 $pkgnums{$li->pkgnum} = 1;
1973 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
1978 foreach my $cust_bill ( @invoices ) {
1980 if ( !defined($credit) || $credit->credited == 0) {
1981 $credit = pop @credits or last;
1985 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
1986 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
1988 $owed = $cust_bill->owed;
1990 unless ( $owed > 0 ) {
1991 push @credits, $credit;
1995 my $amount = min( $credit->credited, $owed );
1997 my $cust_credit_bill = new FS::cust_credit_bill ( {
1998 'crednum' => $credit->crednum,
1999 'invnum' => $cust_bill->invnum,
2000 'amount' => $amount,
2002 $cust_credit_bill->pkgnum( $credit->pkgnum )
2003 if $conf->exists('pkg-balances') && $credit->pkgnum;
2004 my $error = $cust_credit_bill->insert;
2006 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2010 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2014 my $total_unapplied_credits = $self->total_unapplied_credits;
2016 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2018 return $total_unapplied_credits;
2021 =item apply_payments [ OPTION => VALUE ... ]
2023 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2024 to outstanding invoice balances in chronological order.
2026 #and returns the value of any remaining unapplied payments.
2028 A hash of optional arguments may be passed. Currently "manual" is supported.
2029 If true, a payment receipt is sent instead of a statement when
2030 'payment_receipt_email' configuration option is set.
2032 Dies if there is an error.
2036 sub apply_payments {
2037 my( $self, %options ) = @_;
2039 local $SIG{HUP} = 'IGNORE';
2040 local $SIG{INT} = 'IGNORE';
2041 local $SIG{QUIT} = 'IGNORE';
2042 local $SIG{TERM} = 'IGNORE';
2043 local $SIG{TSTP} = 'IGNORE';
2044 local $SIG{PIPE} = 'IGNORE';
2046 my $oldAutoCommit = $FS::UID::AutoCommit;
2047 local $FS::UID::AutoCommit = 0;
2050 $self->select_for_update; #mutex
2054 my @payments = sort { $b->_date <=> $a->_date }
2055 grep { $_->unapplied > 0 }
2058 my @invoices = sort { $a->_date <=> $b->_date}
2059 grep { $_->owed > 0 }
2062 if ( $conf->exists('pkg-balances') ) {
2063 # limit @payments to those w/ a pkgnum grepped from $self
2065 foreach my $i (@invoices) {
2066 foreach my $li ( $i->cust_bill_pkg ) {
2067 $pkgnums{$li->pkgnum} = 1;
2070 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
2075 foreach my $cust_bill ( @invoices ) {
2077 if ( !defined($payment) || $payment->unapplied == 0 ) {
2078 $payment = pop @payments or last;
2082 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
2083 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
2085 $owed = $cust_bill->owed;
2087 unless ( $owed > 0 ) {
2088 push @payments, $payment;
2092 my $amount = min( $payment->unapplied, $owed );
2094 my $cust_bill_pay = new FS::cust_bill_pay ( {
2095 'paynum' => $payment->paynum,
2096 'invnum' => $cust_bill->invnum,
2097 'amount' => $amount,
2099 $cust_bill_pay->pkgnum( $payment->pkgnum )
2100 if $conf->exists('pkg-balances') && $payment->pkgnum;
2101 my $error = $cust_bill_pay->insert(%options);
2103 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2107 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2111 my $total_unapplied_payments = $self->total_unapplied_payments;
2113 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2115 return $total_unapplied_payments;
2125 suspend_adjourned_pkgs
2128 (do_cust_event pre-bill)
2131 (vendor-only) _gather_taxes
2132 _omit_zero_value_bundles
2135 apply_payments_and_credits
2144 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>