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 my %setup_param = ();
832 if ( ! $options{recurring_only}
833 and ! $options{cancel}
834 and ( $options{'resetup'}
835 || ( ! $cust_pkg->setup
836 && ( ! $cust_pkg->start_date
837 || $cust_pkg->start_date <= $time
839 && ( ! $conf->exists('disable_setup_suspended_pkgs')
840 || ( $conf->exists('disable_setup_suspended_pkgs') &&
841 ! $cust_pkg->getfield('susp')
849 warn " bill setup\n" if $DEBUG > 1;
851 unless ( $cust_pkg->waive_setup ) {
854 $setup = eval { $cust_pkg->calc_setup( $time, \@details, \%setup_param ) };
855 return "$@ running calc_setup for $cust_pkg\n"
858 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
861 $cust_pkg->setfield('setup', $time)
862 unless $cust_pkg->setup;
863 #do need it, but it won't get written to the db
864 #|| $cust_pkg->pkgpart != $real_pkgpart;
866 $cust_pkg->setfield('start_date', '')
867 if $cust_pkg->start_date;
875 #XXX unit stuff here too
879 if ( ! $cust_pkg->start_date
880 and ( ! $cust_pkg->susp || $part_pkg->option('suspend_bill', 1) )
882 ( $part_pkg->freq ne '0' && ( $cust_pkg->bill || 0 ) <= $time )
883 || ( $part_pkg->plan eq 'voip_cdr'
884 && $part_pkg->option('bill_every_call')
889 # XXX should this be a package event? probably. events are called
890 # at collection time at the moment, though...
891 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
892 if $part_pkg->can('reset_usage') && !$options{'no_usage_reset'};
893 #don't want to reset usage just cause we want a line item??
894 #&& $part_pkg->pkgpart == $real_pkgpart;
896 warn " bill recur\n" if $DEBUG > 1;
899 # XXX shared with $recur_prog
900 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
904 #over two params! lets at least switch to a hashref for the rest...
905 my $increment_next_bill = ( $part_pkg->freq ne '0'
906 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
909 my %param = ( 'precommit_hooks' => $precommit_hooks,
910 'increment_next_bill' => $increment_next_bill,
911 'discounts' => \@discounts,
912 'real_pkgpart' => $real_pkgpart,
913 'freq_override' => $options{freq_override} || '',
917 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
919 # There may be some part_pkg for which this is wrong. Only those
920 # which can_discount are supported.
921 # (the UI should prevent adding discounts to these at the moment)
923 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
924 return "$@ running $method for $cust_pkg\n"
927 if ( $increment_next_bill ) {
929 my $next_bill = $part_pkg->add_freq($sdate, $options{freq_override} || 0);
930 return "unparsable frequency: ". $part_pkg->freq
933 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
934 # only for figuring next bill date, nothing else, so, reset $sdate again
936 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
937 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
938 $cust_pkg->last_bill($sdate);
940 $cust_pkg->setfield('bill', $next_bill );
944 if ( defined $param{'discount_left_setup'} ) {
945 foreach my $discount_setup ( values %{$param{'discount_left_setup'}} ) {
946 $setup -= $discount_setup;
952 warn "\$setup is undefined" unless defined($setup);
953 warn "\$recur is undefined" unless defined($recur);
954 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
957 # If there's line items, create em cust_bill_pkg records
958 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
963 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
964 # hmm.. and if just the options are modified in some weird price plan?
966 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
969 my $error = $cust_pkg->replace( $old_cust_pkg,
970 'depend_jobnum'=>$options{depend_jobnum},
971 'options' => { $cust_pkg->options },
973 unless $options{no_commit};
974 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
975 if $error; #just in case
978 $setup = sprintf( "%.2f", $setup );
979 $recur = sprintf( "%.2f", $recur );
980 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
981 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
983 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
984 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
987 my $discount_show_always = ($recur == 0 && scalar(@discounts)
988 && $conf->exists('discount-show-always'));
992 (!$part_pkg->hidden && $options{has_hidden}) || #include some $0 lines
993 $discount_show_always )
996 warn " charges (setup=$setup, recur=$recur); adding line items\n"
999 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
1001 warn " adding customer package invoice detail: $_\n"
1002 foreach @cust_pkg_detail;
1004 push @details, @cust_pkg_detail;
1006 my $cust_bill_pkg = new FS::cust_bill_pkg {
1007 'pkgnum' => $cust_pkg->pkgnum,
1009 'unitsetup' => $unitsetup,
1011 'unitrecur' => $unitrecur,
1012 'quantity' => $cust_pkg->quantity,
1013 'details' => \@details,
1014 'discounts' => \@discounts,
1015 'hidden' => $part_pkg->hidden,
1016 'freq' => $part_pkg->freq,
1019 if ( $part_pkg->option('recur_temporality', 1) eq 'preceding' ) {
1020 $cust_bill_pkg->sdate( $hash{last_bill} );
1021 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
1022 $cust_bill_pkg->edate( $time ) if $options{cancel};
1023 } else { #if ( $part_pkg->option('recur_temporality', 1) eq 'upcoming' ) {
1024 $cust_bill_pkg->sdate( $sdate );
1025 $cust_bill_pkg->edate( $cust_pkg->bill );
1026 #$cust_bill_pkg->edate( $time ) if $options{cancel};
1029 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
1030 unless $part_pkg->pkgpart == $real_pkgpart;
1032 $$total_setup += $setup;
1033 $$total_recur += $recur;
1039 unless ( $discount_show_always ) {
1041 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart, \%options);
1042 return $error if $error;
1045 push @$cust_bill_pkgs, $cust_bill_pkg;
1047 } #if $setup != 0 || $recur != 0
1057 my $part_pkg = shift;
1058 my $taxlisthash = shift;
1059 my $cust_bill_pkg = shift;
1060 my $cust_pkg = shift;
1061 my $invoice_time = shift;
1062 my $real_pkgpart = shift;
1063 my $options = shift;
1065 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1067 my %cust_bill_pkg = ();
1071 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
1072 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
1073 push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
1074 push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
1076 if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
1078 if ( $conf->exists('enable_taxproducts')
1079 && ( scalar($part_pkg->part_pkg_taxoverride)
1080 || $part_pkg->has_taxproduct
1085 foreach my $class (@classes) {
1086 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class, $cust_pkg );
1087 return $err_or_ref unless ref($err_or_ref);
1088 $taxes{$class} = $err_or_ref;
1091 unless (exists $taxes{''}) {
1092 my $err_or_ref = $self->_gather_taxes( $part_pkg, '', $cust_pkg );
1093 return $err_or_ref unless ref($err_or_ref);
1094 $taxes{''} = $err_or_ref;
1099 my @loc_keys = qw( city county state country );
1101 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1102 my $cust_location = $cust_pkg->cust_location;
1103 %taxhash = map { $_ => $cust_location->$_() } @loc_keys;
1106 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
1109 %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
1112 $taxhash{'taxclass'} = $part_pkg->taxclass;
1115 my %taxhash_elim = %taxhash;
1116 my @elim = qw( city county state );
1119 #first try a match with taxclass
1120 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1122 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1123 #then try a match without taxclass
1124 my %no_taxclass = %taxhash_elim;
1125 $no_taxclass{ 'taxclass' } = '';
1126 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1129 $taxhash_elim{ shift(@elim) } = '';
1131 } while ( !scalar(@taxes) && scalar(@elim) );
1133 @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
1135 if $self->cust_main_exemption; #just to be safe
1137 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1139 $_->set('pkgnum', $cust_pkg->pkgnum );
1140 $_->set('locationnum', $cust_pkg->locationnum );
1144 $taxes{''} = [ @taxes ];
1145 $taxes{'setup'} = [ @taxes ];
1146 $taxes{'recur'} = [ @taxes ];
1147 $taxes{$_} = [ @taxes ] foreach (@classes);
1149 # # maybe eliminate this entirely, along with all the 0% records
1150 # unless ( @taxes ) {
1152 # "fatal: can't find tax rate for state/county/country/taxclass ".
1153 # join('/', map $taxhash{$_}, qw(state county country taxclass) );
1156 } #if $conf->exists('enable_taxproducts') ...
1161 my $separate = $conf->exists('separate_usage');
1162 my $temp_pkg = new FS::cust_pkg { pkgpart => $real_pkgpart };
1163 my $usage_mandate = $temp_pkg->part_pkg->option('usage_mandate', 'Hush!');
1164 my $section = $temp_pkg->part_pkg->categoryname;
1165 if ( $separate || $section || $usage_mandate ) {
1167 my %hash = ( 'section' => $section );
1169 $section = $temp_pkg->part_pkg->option('usage_section', 'Hush!');
1170 my $summary = $temp_pkg->part_pkg->option('summarize_usage', 'Hush!');
1172 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
1173 push @display, new FS::cust_bill_pkg_display { type => 'R', %hash };
1175 push @display, new FS::cust_bill_pkg_display
1178 ( ( $usage_mandate ) ? ( 'summary' => 'Y' ) : () ),
1182 if ($separate && $section && $summary) {
1183 push @display, new FS::cust_bill_pkg_display { type => 'U',
1188 if ($usage_mandate || $section && $summary) {
1189 $hash{post_total} = 'Y';
1192 if ($separate || $usage_mandate) {
1193 $hash{section} = $section if ($separate || $usage_mandate);
1194 push @display, new FS::cust_bill_pkg_display { type => 'U', %hash };
1198 $cust_bill_pkg->set('display', \@display);
1200 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
1201 foreach my $key (keys %tax_cust_bill_pkg) {
1202 my @taxes = @{ $taxes{$key} || [] };
1203 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
1205 my %localtaxlisthash = ();
1206 foreach my $tax ( @taxes ) {
1208 my $taxname = ref( $tax ). ' '. $tax->taxnum;
1209 # $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
1210 # ' locationnum'. $cust_pkg->locationnum
1211 # if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
1213 $taxlisthash->{ $taxname } ||= [ $tax ];
1214 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
1216 $localtaxlisthash{ $taxname } ||= [ $tax ];
1217 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
1221 warn "finding taxed taxes...\n" if $DEBUG > 2;
1222 foreach my $tax ( keys %localtaxlisthash ) {
1223 my $tax_object = shift @{ $localtaxlisthash{$tax} };
1224 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
1226 next unless $tax_object->can('tax_on_tax');
1228 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
1229 my $totname = ref( $tot ). ' '. $tot->taxnum;
1231 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
1233 next unless exists( $localtaxlisthash{ $totname } ); # only increase
1235 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
1236 my $hashref_or_error =
1237 $tax_object->taxline( $localtaxlisthash{$tax},
1238 'custnum' => $self->custnum,
1239 'invoice_time' => $invoice_time,
1241 return $hashref_or_error
1242 unless ref($hashref_or_error);
1244 $taxlisthash->{ $totname } ||= [ $tot ];
1245 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
1257 my $part_pkg = shift;
1259 my $cust_pkg = shift;
1261 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1264 if ( $cust_pkg->locationnum && $conf->exists('tax-pkg_address') ) {
1265 $geocode = $cust_pkg->cust_location->geocode('cch');
1267 $geocode = $self->geocode('cch');
1272 my @taxclassnums = map { $_->taxclassnum }
1273 $part_pkg->part_pkg_taxoverride($class);
1275 unless (@taxclassnums) {
1276 @taxclassnums = map { $_->taxclassnum }
1277 grep { $_->taxable eq 'Y' }
1278 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
1280 warn "Found taxclassnum values of ". join(',', @taxclassnums)
1285 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
1287 @taxes = qsearch({ 'table' => 'tax_rate',
1288 'hashref' => { 'geocode' => $geocode, },
1289 'extra_sql' => $extra_sql,
1291 if scalar(@taxclassnums);
1293 warn "Found taxes ".
1294 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
1301 =item collect [ HASHREF | OPTION => VALUE ... ]
1303 (Attempt to) collect money for this customer's outstanding invoices (see
1304 L<FS::cust_bill>). Usually used after the bill method.
1306 Actions are now triggered by billing events; see L<FS::part_event> and the
1307 billing events web interface. Old-style invoice events (see
1308 L<FS::part_bill_event>) have been deprecated.
1310 If there is an error, returns the error, otherwise returns false.
1312 Options are passed as name-value pairs.
1314 Currently available options are:
1320 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.
1324 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1328 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1332 set true to surpress email card/ACH decline notices.
1336 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)
1342 # allows for one time override of normal customer billing method
1347 my( $self, %options ) = @_;
1349 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1351 my $invoice_time = $options{'invoice_time'} || time;
1354 local $SIG{HUP} = 'IGNORE';
1355 local $SIG{INT} = 'IGNORE';
1356 local $SIG{QUIT} = 'IGNORE';
1357 local $SIG{TERM} = 'IGNORE';
1358 local $SIG{TSTP} = 'IGNORE';
1359 local $SIG{PIPE} = 'IGNORE';
1361 my $oldAutoCommit = $FS::UID::AutoCommit;
1362 local $FS::UID::AutoCommit = 0;
1365 $self->select_for_update; #mutex
1368 my $balance = $self->balance;
1369 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
1372 if ( exists($options{'retry_card'}) ) {
1373 carp 'retry_card option passed to collect is deprecated; use retry';
1374 $options{'retry'} ||= $options{'retry_card'};
1376 if ( exists($options{'retry'}) && $options{'retry'} ) {
1377 my $error = $self->retry_realtime;
1379 $dbh->rollback if $oldAutoCommit;
1384 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1386 #never want to roll back an event just because it returned an error
1387 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1389 $self->do_cust_event(
1390 'debug' => ( $options{'debug'} || 0 ),
1391 'time' => $invoice_time,
1392 'check_freq' => $options{'check_freq'},
1393 'stage' => 'collect',
1398 =item retry_realtime
1400 Schedules realtime / batch credit card / electronic check / LEC billing
1401 events for for retry. Useful if card information has changed or manual
1402 retry is desired. The 'collect' method must be called to actually retry
1405 Implementation details: For either this customer, or for each of this
1406 customer's open invoices, changes the status of the first "done" (with
1407 statustext error) realtime processing event to "failed".
1411 sub retry_realtime {
1414 local $SIG{HUP} = 'IGNORE';
1415 local $SIG{INT} = 'IGNORE';
1416 local $SIG{QUIT} = 'IGNORE';
1417 local $SIG{TERM} = 'IGNORE';
1418 local $SIG{TSTP} = 'IGNORE';
1419 local $SIG{PIPE} = 'IGNORE';
1421 my $oldAutoCommit = $FS::UID::AutoCommit;
1422 local $FS::UID::AutoCommit = 0;
1425 #a little false laziness w/due_cust_event (not too bad, really)
1427 my $join = FS::part_event_condition->join_conditions_sql;
1428 my $order = FS::part_event_condition->order_conditions_sql;
1431 . join ( ' OR ' , map {
1432 "( part_event.eventtable = " . dbh->quote($_)
1433 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
1434 } FS::part_event->eventtables)
1437 #here is the agent virtualization
1438 my $agent_virt = " ( part_event.agentnum IS NULL
1439 OR part_event.agentnum = ". $self->agentnum. ' )';
1441 #XXX this shouldn't be hardcoded, actions should declare it...
1442 my @realtime_events = qw(
1443 cust_bill_realtime_card
1444 cust_bill_realtime_check
1445 cust_bill_realtime_lec
1449 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
1454 my @cust_event = qsearchs({
1455 'table' => 'cust_event',
1456 'select' => 'cust_event.*',
1457 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
1458 'hashref' => { 'status' => 'done' },
1459 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
1460 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
1463 my %seen_invnum = ();
1464 foreach my $cust_event (@cust_event) {
1466 #max one for the customer, one for each open invoice
1467 my $cust_X = $cust_event->cust_X;
1468 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
1472 or $cust_event->part_event->eventtable eq 'cust_bill'
1475 my $error = $cust_event->retry;
1477 $dbh->rollback if $oldAutoCommit;
1478 return "error scheduling event for retry: $error";
1483 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1488 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
1490 Runs billing events; see L<FS::part_event> and the billing events web
1493 If there is an error, returns the error, otherwise returns false.
1495 Options are passed as name-value pairs.
1497 Currently available options are:
1503 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.
1507 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1511 "collect" (the default) or "pre-bill"
1515 set true to surpress email card/ACH decline notices.
1519 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)
1526 # allows for one time override of normal customer billing method
1530 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1533 my( $self, %options ) = @_;
1535 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1537 my $time = $options{'time'} || time;
1540 local $SIG{HUP} = 'IGNORE';
1541 local $SIG{INT} = 'IGNORE';
1542 local $SIG{QUIT} = 'IGNORE';
1543 local $SIG{TERM} = 'IGNORE';
1544 local $SIG{TSTP} = 'IGNORE';
1545 local $SIG{PIPE} = 'IGNORE';
1547 my $oldAutoCommit = $FS::UID::AutoCommit;
1548 local $FS::UID::AutoCommit = 0;
1551 $self->select_for_update; #mutex
1554 my $balance = $self->balance;
1555 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
1558 # if ( exists($options{'retry_card'}) ) {
1559 # carp 'retry_card option passed to collect is deprecated; use retry';
1560 # $options{'retry'} ||= $options{'retry_card'};
1562 # if ( exists($options{'retry'}) && $options{'retry'} ) {
1563 # my $error = $self->retry_realtime;
1565 # $dbh->rollback if $oldAutoCommit;
1570 # false laziness w/pay_batch::import_results
1572 my $due_cust_event = $self->due_cust_event(
1573 'debug' => ( $options{'debug'} || 0 ),
1575 'check_freq' => $options{'check_freq'},
1576 'stage' => ( $options{'stage'} || 'collect' ),
1578 unless( ref($due_cust_event) ) {
1579 $dbh->rollback if $oldAutoCommit;
1580 return $due_cust_event;
1583 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1584 #never want to roll back an event just because it or a different one
1586 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1588 foreach my $cust_event ( @$due_cust_event ) {
1592 #re-eval event conditions (a previous event could have changed things)
1593 unless ( $cust_event->test_conditions( 'time' => $time ) ) {
1594 #don't leave stray "new/locked" records around
1595 my $error = $cust_event->delete;
1596 return $error if $error;
1601 local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
1602 if $options{'quiet'};
1603 warn " running cust_event ". $cust_event->eventnum. "\n"
1606 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
1607 if ( my $error = $cust_event->do_event() ) {
1608 #XXX wtf is this? figure out a proper dealio with return value
1620 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
1622 Inserts database records for and returns an ordered listref of new events due
1623 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
1624 events are due, an empty listref is returned. If there is an error, returns a
1625 scalar error message.
1627 To actually run the events, call each event's test_condition method, and if
1628 still true, call the event's do_event method.
1630 Options are passed as a hashref or as a list of name-value pairs. Available
1637 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.
1641 "collect" (the default) or "pre-bill"
1645 "Current time" for the events.
1649 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)
1653 Only return events for the specified eventtable (by default, events of all eventtables are returned)
1657 Explicitly pass the objects to be tested (typically used with eventtable).
1661 Set to true to return the objects, but not actually insert them into the
1668 sub due_cust_event {
1670 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
1673 #my $DEBUG = $opt{'debug'}
1674 local($DEBUG) = $opt{'debug'}
1675 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
1676 $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1678 warn "$me due_cust_event called with options ".
1679 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
1682 $opt{'time'} ||= time;
1684 local $SIG{HUP} = 'IGNORE';
1685 local $SIG{INT} = 'IGNORE';
1686 local $SIG{QUIT} = 'IGNORE';
1687 local $SIG{TERM} = 'IGNORE';
1688 local $SIG{TSTP} = 'IGNORE';
1689 local $SIG{PIPE} = 'IGNORE';
1691 my $oldAutoCommit = $FS::UID::AutoCommit;
1692 local $FS::UID::AutoCommit = 0;
1695 $self->select_for_update #mutex
1696 unless $opt{testonly};
1699 # find possible events (initial search)
1702 my @cust_event = ();
1704 my @eventtable = $opt{'eventtable'}
1705 ? ( $opt{'eventtable'} )
1706 : FS::part_event->eventtables_runorder;
1708 my $check_freq = $opt{'check_freq'} || '1d';
1710 foreach my $eventtable ( @eventtable ) {
1713 if ( $opt{'objects'} ) {
1715 @objects = @{ $opt{'objects'} };
1719 #my @objects = $self->$eventtable(); # sub cust_main { @{ [ $self ] }; }
1720 if ( $eventtable eq 'cust_main' ) {
1721 @objects = ( $self );
1725 "LEFT JOIN cust_main USING ( custnum )";
1727 #some false laziness w/Cron::bill bill_where
1729 my $join = FS::part_event_condition->join_conditions_sql( $eventtable);
1730 my $where = FS::part_event_condition->where_conditions_sql($eventtable,
1731 'time'=>$opt{'time'},
1733 $where = $where ? "AND $where" : '';
1735 my $are_part_event =
1736 "EXISTS ( SELECT 1 FROM part_event $join
1737 WHERE check_freq = '$check_freq'
1738 AND eventtable = '$eventtable'
1739 AND ( disabled = '' OR disabled IS NULL )
1745 @objects = $self->$eventtable(
1746 'addl_from' => $cm_join,
1747 'extra_sql' => " AND $are_part_event",
1753 my @e_cust_event = ();
1755 my $cross = "CROSS JOIN $eventtable";
1756 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
1757 unless $eventtable eq 'cust_main';
1759 foreach my $object ( @objects ) {
1761 #this first search uses the condition_sql magic for optimization.
1762 #the more possible events we can eliminate in this step the better
1764 my $cross_where = '';
1765 my $pkey = $object->primary_key;
1766 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
1768 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
1770 FS::part_event_condition->where_conditions_sql( $eventtable,
1771 'time'=>$opt{'time'}
1773 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
1775 $extra_sql = "AND $extra_sql" if $extra_sql;
1777 #here is the agent virtualization
1778 $extra_sql .= " AND ( part_event.agentnum IS NULL
1779 OR part_event.agentnum = ". $self->agentnum. ' )';
1781 $extra_sql .= " $order";
1783 warn "searching for events for $eventtable ". $object->$pkey. "\n"
1784 if $opt{'debug'} > 2;
1785 my @part_event = qsearch( {
1786 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
1787 'select' => 'part_event.*',
1788 'table' => 'part_event',
1789 'addl_from' => "$cross $join",
1790 'hashref' => { 'check_freq' => $check_freq,
1791 'eventtable' => $eventtable,
1794 'extra_sql' => "AND $cross_where $extra_sql",
1798 my $pkey = $object->primary_key;
1799 warn " ". scalar(@part_event).
1800 " possible events found for $eventtable ". $object->$pkey(). "\n";
1803 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
1807 warn " ". scalar(@e_cust_event).
1808 " subtotal possible cust events found for $eventtable\n"
1811 push @cust_event, @e_cust_event;
1815 warn " ". scalar(@cust_event).
1816 " total possible cust events found in initial search\n"
1824 $opt{stage} ||= 'collect';
1826 grep { my $stage = $_->part_event->event_stage;
1827 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
1837 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
1838 'stats_hashref' => \%unsat ),
1841 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
1844 warn " invalid conditions not eliminated with condition_sql:\n".
1845 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
1846 if keys %unsat && $DEBUG; # > 1;
1852 unless( $opt{testonly} ) {
1853 foreach my $cust_event ( @cust_event ) {
1855 my $error = $cust_event->insert();
1857 $dbh->rollback if $oldAutoCommit;
1864 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1870 warn " returning events: ". Dumper(@cust_event). "\n"
1877 =item apply_payments_and_credits [ OPTION => VALUE ... ]
1879 Applies unapplied payments and credits.
1881 In most cases, this new method should be used in place of sequential
1882 apply_payments and apply_credits methods.
1884 A hash of optional arguments may be passed. Currently "manual" is supported.
1885 If true, a payment receipt is sent instead of a statement when
1886 'payment_receipt_email' configuration option is set.
1888 If there is an error, returns the error, otherwise returns false.
1892 sub apply_payments_and_credits {
1893 my( $self, %options ) = @_;
1895 local $SIG{HUP} = 'IGNORE';
1896 local $SIG{INT} = 'IGNORE';
1897 local $SIG{QUIT} = 'IGNORE';
1898 local $SIG{TERM} = 'IGNORE';
1899 local $SIG{TSTP} = 'IGNORE';
1900 local $SIG{PIPE} = 'IGNORE';
1902 my $oldAutoCommit = $FS::UID::AutoCommit;
1903 local $FS::UID::AutoCommit = 0;
1906 $self->select_for_update; #mutex
1908 foreach my $cust_bill ( $self->open_cust_bill ) {
1909 my $error = $cust_bill->apply_payments_and_credits(%options);
1911 $dbh->rollback if $oldAutoCommit;
1912 return "Error applying: $error";
1916 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1921 =item apply_credits OPTION => VALUE ...
1923 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
1924 to outstanding invoice balances in chronological order (or reverse
1925 chronological order if the I<order> option is set to B<newest>) and returns the
1926 value of any remaining unapplied credits available for refund (see
1927 L<FS::cust_refund>).
1929 Dies if there is an error.
1937 local $SIG{HUP} = 'IGNORE';
1938 local $SIG{INT} = 'IGNORE';
1939 local $SIG{QUIT} = 'IGNORE';
1940 local $SIG{TERM} = 'IGNORE';
1941 local $SIG{TSTP} = 'IGNORE';
1942 local $SIG{PIPE} = 'IGNORE';
1944 my $oldAutoCommit = $FS::UID::AutoCommit;
1945 local $FS::UID::AutoCommit = 0;
1948 $self->select_for_update; #mutex
1950 unless ( $self->total_unapplied_credits ) {
1951 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1955 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
1956 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
1958 my @invoices = $self->open_cust_bill;
1959 @invoices = sort { $b->_date <=> $a->_date } @invoices
1960 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
1962 if ( $conf->exists('pkg-balances') ) {
1963 # limit @credits to those w/ a pkgnum grepped from $self
1965 foreach my $i (@invoices) {
1966 foreach my $li ( $i->cust_bill_pkg ) {
1967 $pkgnums{$li->pkgnum} = 1;
1970 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
1975 foreach my $cust_bill ( @invoices ) {
1977 if ( !defined($credit) || $credit->credited == 0) {
1978 $credit = pop @credits or last;
1982 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
1983 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
1985 $owed = $cust_bill->owed;
1987 unless ( $owed > 0 ) {
1988 push @credits, $credit;
1992 my $amount = min( $credit->credited, $owed );
1994 my $cust_credit_bill = new FS::cust_credit_bill ( {
1995 'crednum' => $credit->crednum,
1996 'invnum' => $cust_bill->invnum,
1997 'amount' => $amount,
1999 $cust_credit_bill->pkgnum( $credit->pkgnum )
2000 if $conf->exists('pkg-balances') && $credit->pkgnum;
2001 my $error = $cust_credit_bill->insert;
2003 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2007 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2011 my $total_unapplied_credits = $self->total_unapplied_credits;
2013 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2015 return $total_unapplied_credits;
2018 =item apply_payments [ OPTION => VALUE ... ]
2020 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2021 to outstanding invoice balances in chronological order.
2023 #and returns the value of any remaining unapplied payments.
2025 A hash of optional arguments may be passed. Currently "manual" is supported.
2026 If true, a payment receipt is sent instead of a statement when
2027 'payment_receipt_email' configuration option is set.
2029 Dies if there is an error.
2033 sub apply_payments {
2034 my( $self, %options ) = @_;
2036 local $SIG{HUP} = 'IGNORE';
2037 local $SIG{INT} = 'IGNORE';
2038 local $SIG{QUIT} = 'IGNORE';
2039 local $SIG{TERM} = 'IGNORE';
2040 local $SIG{TSTP} = 'IGNORE';
2041 local $SIG{PIPE} = 'IGNORE';
2043 my $oldAutoCommit = $FS::UID::AutoCommit;
2044 local $FS::UID::AutoCommit = 0;
2047 $self->select_for_update; #mutex
2051 my @payments = sort { $b->_date <=> $a->_date }
2052 grep { $_->unapplied > 0 }
2055 my @invoices = sort { $a->_date <=> $b->_date}
2056 grep { $_->owed > 0 }
2059 if ( $conf->exists('pkg-balances') ) {
2060 # limit @payments to those w/ a pkgnum grepped from $self
2062 foreach my $i (@invoices) {
2063 foreach my $li ( $i->cust_bill_pkg ) {
2064 $pkgnums{$li->pkgnum} = 1;
2067 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
2072 foreach my $cust_bill ( @invoices ) {
2074 if ( !defined($payment) || $payment->unapplied == 0 ) {
2075 $payment = pop @payments or last;
2079 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
2080 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
2082 $owed = $cust_bill->owed;
2084 unless ( $owed > 0 ) {
2085 push @payments, $payment;
2089 my $amount = min( $payment->unapplied, $owed );
2091 my $cust_bill_pay = new FS::cust_bill_pay ( {
2092 'paynum' => $payment->paynum,
2093 'invnum' => $cust_bill->invnum,
2094 'amount' => $amount,
2096 $cust_bill_pay->pkgnum( $payment->pkgnum )
2097 if $conf->exists('pkg-balances') && $payment->pkgnum;
2098 my $error = $cust_bill_pay->insert(%options);
2100 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2104 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2108 my $total_unapplied_payments = $self->total_unapplied_payments;
2110 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2112 return $total_unapplied_payments;
2121 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>