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. " with params ".
920 join(' / ', map "$_=>$params{$_}", keys %param). "\n"
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 ( $param{'setup_fee'} ) {
945 # Add an additional setup fee at the billing stage.
946 # Used for prorate_defer_bill.
947 $setup += $param{'setup_fee'};
948 $unitsetup += $param{'setup_fee'};
954 warn "\$setup is undefined" unless defined($setup);
955 warn "\$recur is undefined" unless defined($recur);
956 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
959 # If there's line items, create em cust_bill_pkg records
960 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
965 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
966 # hmm.. and if just the options are modified in some weird price plan?
968 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
971 my $error = $cust_pkg->replace( $old_cust_pkg,
972 'depend_jobnum'=>$options{depend_jobnum},
973 'options' => { $cust_pkg->options },
975 unless $options{no_commit};
976 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
977 if $error; #just in case
980 $setup = sprintf( "%.2f", $setup );
981 $recur = sprintf( "%.2f", $recur );
982 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
983 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
985 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
986 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
989 my $discount_show_always = ($recur == 0 && scalar(@discounts)
990 && $conf->exists('discount-show-always'));
994 (!$part_pkg->hidden && $options{has_hidden}) || #include some $0 lines
995 $discount_show_always )
998 warn " charges (setup=$setup, recur=$recur); adding line items\n"
1001 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
1003 warn " adding customer package invoice detail: $_\n"
1004 foreach @cust_pkg_detail;
1006 push @details, @cust_pkg_detail;
1008 my $cust_bill_pkg = new FS::cust_bill_pkg {
1009 'pkgnum' => $cust_pkg->pkgnum,
1011 'unitsetup' => $unitsetup,
1013 'unitrecur' => $unitrecur,
1014 'quantity' => $cust_pkg->quantity,
1015 'details' => \@details,
1016 'discounts' => \@discounts,
1017 'hidden' => $part_pkg->hidden,
1018 'freq' => $part_pkg->freq,
1021 if ( $part_pkg->option('recur_temporality', 1) eq 'preceding' ) {
1022 $cust_bill_pkg->sdate( $hash{last_bill} );
1023 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
1024 $cust_bill_pkg->edate( $time ) if $options{cancel};
1025 } else { #if ( $part_pkg->option('recur_temporality', 1) eq 'upcoming' ) {
1026 $cust_bill_pkg->sdate( $sdate );
1027 $cust_bill_pkg->edate( $cust_pkg->bill );
1028 #$cust_bill_pkg->edate( $time ) if $options{cancel};
1031 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
1032 unless $part_pkg->pkgpart == $real_pkgpart;
1034 $$total_setup += $setup;
1035 $$total_recur += $recur;
1041 unless ( $discount_show_always ) {
1043 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart, \%options);
1044 return $error if $error;
1047 push @$cust_bill_pkgs, $cust_bill_pkg;
1049 } #if $setup != 0 || $recur != 0
1059 my $part_pkg = shift;
1060 my $taxlisthash = shift;
1061 my $cust_bill_pkg = shift;
1062 my $cust_pkg = shift;
1063 my $invoice_time = shift;
1064 my $real_pkgpart = shift;
1065 my $options = shift;
1067 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1069 my %cust_bill_pkg = ();
1073 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
1074 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
1075 push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
1076 push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
1078 if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
1080 if ( $conf->exists('enable_taxproducts')
1081 && ( scalar($part_pkg->part_pkg_taxoverride)
1082 || $part_pkg->has_taxproduct
1087 foreach my $class (@classes) {
1088 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class, $cust_pkg );
1089 return $err_or_ref unless ref($err_or_ref);
1090 $taxes{$class} = $err_or_ref;
1093 unless (exists $taxes{''}) {
1094 my $err_or_ref = $self->_gather_taxes( $part_pkg, '', $cust_pkg );
1095 return $err_or_ref unless ref($err_or_ref);
1096 $taxes{''} = $err_or_ref;
1101 my @loc_keys = qw( city county state country );
1103 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1104 my $cust_location = $cust_pkg->cust_location;
1105 %taxhash = map { $_ => $cust_location->$_() } @loc_keys;
1108 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
1111 %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
1114 $taxhash{'taxclass'} = $part_pkg->taxclass;
1117 my %taxhash_elim = %taxhash;
1118 my @elim = qw( city county state );
1121 #first try a match with taxclass
1122 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1124 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1125 #then try a match without taxclass
1126 my %no_taxclass = %taxhash_elim;
1127 $no_taxclass{ 'taxclass' } = '';
1128 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1131 $taxhash_elim{ shift(@elim) } = '';
1133 } while ( !scalar(@taxes) && scalar(@elim) );
1135 @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
1137 if $self->cust_main_exemption; #just to be safe
1139 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1141 $_->set('pkgnum', $cust_pkg->pkgnum );
1142 $_->set('locationnum', $cust_pkg->locationnum );
1146 $taxes{''} = [ @taxes ];
1147 $taxes{'setup'} = [ @taxes ];
1148 $taxes{'recur'} = [ @taxes ];
1149 $taxes{$_} = [ @taxes ] foreach (@classes);
1151 # # maybe eliminate this entirely, along with all the 0% records
1152 # unless ( @taxes ) {
1154 # "fatal: can't find tax rate for state/county/country/taxclass ".
1155 # join('/', map $taxhash{$_}, qw(state county country taxclass) );
1158 } #if $conf->exists('enable_taxproducts') ...
1163 my $separate = $conf->exists('separate_usage');
1164 my $temp_pkg = new FS::cust_pkg { pkgpart => $real_pkgpart };
1165 my $usage_mandate = $temp_pkg->part_pkg->option('usage_mandate', 'Hush!');
1166 my $section = $temp_pkg->part_pkg->categoryname;
1167 if ( $separate || $section || $usage_mandate ) {
1169 my %hash = ( 'section' => $section );
1171 $section = $temp_pkg->part_pkg->option('usage_section', 'Hush!');
1172 my $summary = $temp_pkg->part_pkg->option('summarize_usage', 'Hush!');
1174 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
1175 push @display, new FS::cust_bill_pkg_display { type => 'R', %hash };
1177 push @display, new FS::cust_bill_pkg_display
1180 ( ( $usage_mandate ) ? ( 'summary' => 'Y' ) : () ),
1184 if ($separate && $section && $summary) {
1185 push @display, new FS::cust_bill_pkg_display { type => 'U',
1190 if ($usage_mandate || $section && $summary) {
1191 $hash{post_total} = 'Y';
1194 if ($separate || $usage_mandate) {
1195 $hash{section} = $section if ($separate || $usage_mandate);
1196 push @display, new FS::cust_bill_pkg_display { type => 'U', %hash };
1200 $cust_bill_pkg->set('display', \@display);
1202 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
1203 foreach my $key (keys %tax_cust_bill_pkg) {
1204 my @taxes = @{ $taxes{$key} || [] };
1205 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
1207 my %localtaxlisthash = ();
1208 foreach my $tax ( @taxes ) {
1210 my $taxname = ref( $tax ). ' '. $tax->taxnum;
1211 # $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
1212 # ' locationnum'. $cust_pkg->locationnum
1213 # if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
1215 $taxlisthash->{ $taxname } ||= [ $tax ];
1216 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
1218 $localtaxlisthash{ $taxname } ||= [ $tax ];
1219 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
1223 warn "finding taxed taxes...\n" if $DEBUG > 2;
1224 foreach my $tax ( keys %localtaxlisthash ) {
1225 my $tax_object = shift @{ $localtaxlisthash{$tax} };
1226 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
1228 next unless $tax_object->can('tax_on_tax');
1230 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
1231 my $totname = ref( $tot ). ' '. $tot->taxnum;
1233 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
1235 next unless exists( $localtaxlisthash{ $totname } ); # only increase
1237 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
1238 my $hashref_or_error =
1239 $tax_object->taxline( $localtaxlisthash{$tax},
1240 'custnum' => $self->custnum,
1241 'invoice_time' => $invoice_time,
1243 return $hashref_or_error
1244 unless ref($hashref_or_error);
1246 $taxlisthash->{ $totname } ||= [ $tot ];
1247 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
1259 my $part_pkg = shift;
1261 my $cust_pkg = shift;
1263 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1266 if ( $cust_pkg->locationnum && $conf->exists('tax-pkg_address') ) {
1267 $geocode = $cust_pkg->cust_location->geocode('cch');
1269 $geocode = $self->geocode('cch');
1274 my @taxclassnums = map { $_->taxclassnum }
1275 $part_pkg->part_pkg_taxoverride($class);
1277 unless (@taxclassnums) {
1278 @taxclassnums = map { $_->taxclassnum }
1279 grep { $_->taxable eq 'Y' }
1280 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
1282 warn "Found taxclassnum values of ". join(',', @taxclassnums)
1287 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
1289 @taxes = qsearch({ 'table' => 'tax_rate',
1290 'hashref' => { 'geocode' => $geocode, },
1291 'extra_sql' => $extra_sql,
1293 if scalar(@taxclassnums);
1295 warn "Found taxes ".
1296 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
1303 =item collect [ HASHREF | OPTION => VALUE ... ]
1305 (Attempt to) collect money for this customer's outstanding invoices (see
1306 L<FS::cust_bill>). Usually used after the bill method.
1308 Actions are now triggered by billing events; see L<FS::part_event> and the
1309 billing events web interface. Old-style invoice events (see
1310 L<FS::part_bill_event>) have been deprecated.
1312 If there is an error, returns the error, otherwise returns false.
1314 Options are passed as name-value pairs.
1316 Currently available options are:
1322 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.
1326 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1330 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1334 set true to surpress email card/ACH decline notices.
1338 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)
1344 # allows for one time override of normal customer billing method
1349 my( $self, %options ) = @_;
1351 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1353 my $invoice_time = $options{'invoice_time'} || time;
1356 local $SIG{HUP} = 'IGNORE';
1357 local $SIG{INT} = 'IGNORE';
1358 local $SIG{QUIT} = 'IGNORE';
1359 local $SIG{TERM} = 'IGNORE';
1360 local $SIG{TSTP} = 'IGNORE';
1361 local $SIG{PIPE} = 'IGNORE';
1363 my $oldAutoCommit = $FS::UID::AutoCommit;
1364 local $FS::UID::AutoCommit = 0;
1367 $self->select_for_update; #mutex
1370 my $balance = $self->balance;
1371 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
1374 if ( exists($options{'retry_card'}) ) {
1375 carp 'retry_card option passed to collect is deprecated; use retry';
1376 $options{'retry'} ||= $options{'retry_card'};
1378 if ( exists($options{'retry'}) && $options{'retry'} ) {
1379 my $error = $self->retry_realtime;
1381 $dbh->rollback if $oldAutoCommit;
1386 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1388 #never want to roll back an event just because it returned an error
1389 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1391 $self->do_cust_event(
1392 'debug' => ( $options{'debug'} || 0 ),
1393 'time' => $invoice_time,
1394 'check_freq' => $options{'check_freq'},
1395 'stage' => 'collect',
1400 =item retry_realtime
1402 Schedules realtime / batch credit card / electronic check / LEC billing
1403 events for for retry. Useful if card information has changed or manual
1404 retry is desired. The 'collect' method must be called to actually retry
1407 Implementation details: For either this customer, or for each of this
1408 customer's open invoices, changes the status of the first "done" (with
1409 statustext error) realtime processing event to "failed".
1413 sub retry_realtime {
1416 local $SIG{HUP} = 'IGNORE';
1417 local $SIG{INT} = 'IGNORE';
1418 local $SIG{QUIT} = 'IGNORE';
1419 local $SIG{TERM} = 'IGNORE';
1420 local $SIG{TSTP} = 'IGNORE';
1421 local $SIG{PIPE} = 'IGNORE';
1423 my $oldAutoCommit = $FS::UID::AutoCommit;
1424 local $FS::UID::AutoCommit = 0;
1427 #a little false laziness w/due_cust_event (not too bad, really)
1429 my $join = FS::part_event_condition->join_conditions_sql;
1430 my $order = FS::part_event_condition->order_conditions_sql;
1433 . join ( ' OR ' , map {
1434 "( part_event.eventtable = " . dbh->quote($_)
1435 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
1436 } FS::part_event->eventtables)
1439 #here is the agent virtualization
1440 my $agent_virt = " ( part_event.agentnum IS NULL
1441 OR part_event.agentnum = ". $self->agentnum. ' )';
1443 #XXX this shouldn't be hardcoded, actions should declare it...
1444 my @realtime_events = qw(
1445 cust_bill_realtime_card
1446 cust_bill_realtime_check
1447 cust_bill_realtime_lec
1451 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
1456 my @cust_event = qsearchs({
1457 'table' => 'cust_event',
1458 'select' => 'cust_event.*',
1459 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
1460 'hashref' => { 'status' => 'done' },
1461 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
1462 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
1465 my %seen_invnum = ();
1466 foreach my $cust_event (@cust_event) {
1468 #max one for the customer, one for each open invoice
1469 my $cust_X = $cust_event->cust_X;
1470 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
1474 or $cust_event->part_event->eventtable eq 'cust_bill'
1477 my $error = $cust_event->retry;
1479 $dbh->rollback if $oldAutoCommit;
1480 return "error scheduling event for retry: $error";
1485 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1490 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
1492 Runs billing events; see L<FS::part_event> and the billing events web
1495 If there is an error, returns the error, otherwise returns false.
1497 Options are passed as name-value pairs.
1499 Currently available options are:
1505 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.
1509 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1513 "collect" (the default) or "pre-bill"
1517 set true to surpress email card/ACH decline notices.
1521 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)
1528 # allows for one time override of normal customer billing method
1532 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1535 my( $self, %options ) = @_;
1537 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1539 my $time = $options{'time'} || time;
1542 local $SIG{HUP} = 'IGNORE';
1543 local $SIG{INT} = 'IGNORE';
1544 local $SIG{QUIT} = 'IGNORE';
1545 local $SIG{TERM} = 'IGNORE';
1546 local $SIG{TSTP} = 'IGNORE';
1547 local $SIG{PIPE} = 'IGNORE';
1549 my $oldAutoCommit = $FS::UID::AutoCommit;
1550 local $FS::UID::AutoCommit = 0;
1553 $self->select_for_update; #mutex
1556 my $balance = $self->balance;
1557 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
1560 # if ( exists($options{'retry_card'}) ) {
1561 # carp 'retry_card option passed to collect is deprecated; use retry';
1562 # $options{'retry'} ||= $options{'retry_card'};
1564 # if ( exists($options{'retry'}) && $options{'retry'} ) {
1565 # my $error = $self->retry_realtime;
1567 # $dbh->rollback if $oldAutoCommit;
1572 # false laziness w/pay_batch::import_results
1574 my $due_cust_event = $self->due_cust_event(
1575 'debug' => ( $options{'debug'} || 0 ),
1577 'check_freq' => $options{'check_freq'},
1578 'stage' => ( $options{'stage'} || 'collect' ),
1580 unless( ref($due_cust_event) ) {
1581 $dbh->rollback if $oldAutoCommit;
1582 return $due_cust_event;
1585 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1586 #never want to roll back an event just because it or a different one
1588 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1590 foreach my $cust_event ( @$due_cust_event ) {
1594 #re-eval event conditions (a previous event could have changed things)
1595 unless ( $cust_event->test_conditions( 'time' => $time ) ) {
1596 #don't leave stray "new/locked" records around
1597 my $error = $cust_event->delete;
1598 return $error if $error;
1603 local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
1604 if $options{'quiet'};
1605 warn " running cust_event ". $cust_event->eventnum. "\n"
1608 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
1609 if ( my $error = $cust_event->do_event() ) {
1610 #XXX wtf is this? figure out a proper dealio with return value
1622 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
1624 Inserts database records for and returns an ordered listref of new events due
1625 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
1626 events are due, an empty listref is returned. If there is an error, returns a
1627 scalar error message.
1629 To actually run the events, call each event's test_condition method, and if
1630 still true, call the event's do_event method.
1632 Options are passed as a hashref or as a list of name-value pairs. Available
1639 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.
1643 "collect" (the default) or "pre-bill"
1647 "Current time" for the events.
1651 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)
1655 Only return events for the specified eventtable (by default, events of all eventtables are returned)
1659 Explicitly pass the objects to be tested (typically used with eventtable).
1663 Set to true to return the objects, but not actually insert them into the
1670 sub due_cust_event {
1672 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
1675 #my $DEBUG = $opt{'debug'}
1676 local($DEBUG) = $opt{'debug'}
1677 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
1678 $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1680 warn "$me due_cust_event called with options ".
1681 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
1684 $opt{'time'} ||= time;
1686 local $SIG{HUP} = 'IGNORE';
1687 local $SIG{INT} = 'IGNORE';
1688 local $SIG{QUIT} = 'IGNORE';
1689 local $SIG{TERM} = 'IGNORE';
1690 local $SIG{TSTP} = 'IGNORE';
1691 local $SIG{PIPE} = 'IGNORE';
1693 my $oldAutoCommit = $FS::UID::AutoCommit;
1694 local $FS::UID::AutoCommit = 0;
1697 $self->select_for_update #mutex
1698 unless $opt{testonly};
1701 # find possible events (initial search)
1704 my @cust_event = ();
1706 my @eventtable = $opt{'eventtable'}
1707 ? ( $opt{'eventtable'} )
1708 : FS::part_event->eventtables_runorder;
1710 my $check_freq = $opt{'check_freq'} || '1d';
1712 foreach my $eventtable ( @eventtable ) {
1715 if ( $opt{'objects'} ) {
1717 @objects = @{ $opt{'objects'} };
1721 #my @objects = $self->$eventtable(); # sub cust_main { @{ [ $self ] }; }
1722 if ( $eventtable eq 'cust_main' ) {
1723 @objects = ( $self );
1727 "LEFT JOIN cust_main USING ( custnum )";
1729 #some false laziness w/Cron::bill bill_where
1731 my $join = FS::part_event_condition->join_conditions_sql( $eventtable);
1732 my $where = FS::part_event_condition->where_conditions_sql($eventtable,
1733 'time'=>$opt{'time'},
1735 $where = $where ? "AND $where" : '';
1737 my $are_part_event =
1738 "EXISTS ( SELECT 1 FROM part_event $join
1739 WHERE check_freq = '$check_freq'
1740 AND eventtable = '$eventtable'
1741 AND ( disabled = '' OR disabled IS NULL )
1747 @objects = $self->$eventtable(
1748 'addl_from' => $cm_join,
1749 'extra_sql' => " AND $are_part_event",
1755 my @e_cust_event = ();
1757 my $cross = "CROSS JOIN $eventtable";
1758 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
1759 unless $eventtable eq 'cust_main';
1761 foreach my $object ( @objects ) {
1763 #this first search uses the condition_sql magic for optimization.
1764 #the more possible events we can eliminate in this step the better
1766 my $cross_where = '';
1767 my $pkey = $object->primary_key;
1768 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
1770 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
1772 FS::part_event_condition->where_conditions_sql( $eventtable,
1773 'time'=>$opt{'time'}
1775 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
1777 $extra_sql = "AND $extra_sql" if $extra_sql;
1779 #here is the agent virtualization
1780 $extra_sql .= " AND ( part_event.agentnum IS NULL
1781 OR part_event.agentnum = ". $self->agentnum. ' )';
1783 $extra_sql .= " $order";
1785 warn "searching for events for $eventtable ". $object->$pkey. "\n"
1786 if $opt{'debug'} > 2;
1787 my @part_event = qsearch( {
1788 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
1789 'select' => 'part_event.*',
1790 'table' => 'part_event',
1791 'addl_from' => "$cross $join",
1792 'hashref' => { 'check_freq' => $check_freq,
1793 'eventtable' => $eventtable,
1796 'extra_sql' => "AND $cross_where $extra_sql",
1800 my $pkey = $object->primary_key;
1801 warn " ". scalar(@part_event).
1802 " possible events found for $eventtable ". $object->$pkey(). "\n";
1805 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
1809 warn " ". scalar(@e_cust_event).
1810 " subtotal possible cust events found for $eventtable\n"
1813 push @cust_event, @e_cust_event;
1817 warn " ". scalar(@cust_event).
1818 " total possible cust events found in initial search\n"
1826 $opt{stage} ||= 'collect';
1828 grep { my $stage = $_->part_event->event_stage;
1829 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
1839 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
1840 'stats_hashref' => \%unsat ),
1843 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
1846 warn " invalid conditions not eliminated with condition_sql:\n".
1847 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
1848 if keys %unsat && $DEBUG; # > 1;
1854 unless( $opt{testonly} ) {
1855 foreach my $cust_event ( @cust_event ) {
1857 my $error = $cust_event->insert();
1859 $dbh->rollback if $oldAutoCommit;
1866 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1872 warn " returning events: ". Dumper(@cust_event). "\n"
1879 =item apply_payments_and_credits [ OPTION => VALUE ... ]
1881 Applies unapplied payments and credits.
1883 In most cases, this new method should be used in place of sequential
1884 apply_payments and apply_credits methods.
1886 A hash of optional arguments may be passed. Currently "manual" is supported.
1887 If true, a payment receipt is sent instead of a statement when
1888 'payment_receipt_email' configuration option is set.
1890 If there is an error, returns the error, otherwise returns false.
1894 sub apply_payments_and_credits {
1895 my( $self, %options ) = @_;
1897 local $SIG{HUP} = 'IGNORE';
1898 local $SIG{INT} = 'IGNORE';
1899 local $SIG{QUIT} = 'IGNORE';
1900 local $SIG{TERM} = 'IGNORE';
1901 local $SIG{TSTP} = 'IGNORE';
1902 local $SIG{PIPE} = 'IGNORE';
1904 my $oldAutoCommit = $FS::UID::AutoCommit;
1905 local $FS::UID::AutoCommit = 0;
1908 $self->select_for_update; #mutex
1910 foreach my $cust_bill ( $self->open_cust_bill ) {
1911 my $error = $cust_bill->apply_payments_and_credits(%options);
1913 $dbh->rollback if $oldAutoCommit;
1914 return "Error applying: $error";
1918 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1923 =item apply_credits OPTION => VALUE ...
1925 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
1926 to outstanding invoice balances in chronological order (or reverse
1927 chronological order if the I<order> option is set to B<newest>) and returns the
1928 value of any remaining unapplied credits available for refund (see
1929 L<FS::cust_refund>).
1931 Dies if there is an error.
1939 local $SIG{HUP} = 'IGNORE';
1940 local $SIG{INT} = 'IGNORE';
1941 local $SIG{QUIT} = 'IGNORE';
1942 local $SIG{TERM} = 'IGNORE';
1943 local $SIG{TSTP} = 'IGNORE';
1944 local $SIG{PIPE} = 'IGNORE';
1946 my $oldAutoCommit = $FS::UID::AutoCommit;
1947 local $FS::UID::AutoCommit = 0;
1950 $self->select_for_update; #mutex
1952 unless ( $self->total_unapplied_credits ) {
1953 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1957 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
1958 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
1960 my @invoices = $self->open_cust_bill;
1961 @invoices = sort { $b->_date <=> $a->_date } @invoices
1962 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
1964 if ( $conf->exists('pkg-balances') ) {
1965 # limit @credits to those w/ a pkgnum grepped from $self
1967 foreach my $i (@invoices) {
1968 foreach my $li ( $i->cust_bill_pkg ) {
1969 $pkgnums{$li->pkgnum} = 1;
1972 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
1977 foreach my $cust_bill ( @invoices ) {
1979 if ( !defined($credit) || $credit->credited == 0) {
1980 $credit = pop @credits or last;
1984 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
1985 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
1987 $owed = $cust_bill->owed;
1989 unless ( $owed > 0 ) {
1990 push @credits, $credit;
1994 my $amount = min( $credit->credited, $owed );
1996 my $cust_credit_bill = new FS::cust_credit_bill ( {
1997 'crednum' => $credit->crednum,
1998 'invnum' => $cust_bill->invnum,
1999 'amount' => $amount,
2001 $cust_credit_bill->pkgnum( $credit->pkgnum )
2002 if $conf->exists('pkg-balances') && $credit->pkgnum;
2003 my $error = $cust_credit_bill->insert;
2005 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2009 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2013 my $total_unapplied_credits = $self->total_unapplied_credits;
2015 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2017 return $total_unapplied_credits;
2020 =item apply_payments [ OPTION => VALUE ... ]
2022 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2023 to outstanding invoice balances in chronological order.
2025 #and returns the value of any remaining unapplied payments.
2027 A hash of optional arguments may be passed. Currently "manual" is supported.
2028 If true, a payment receipt is sent instead of a statement when
2029 'payment_receipt_email' configuration option is set.
2031 Dies if there is an error.
2035 sub apply_payments {
2036 my( $self, %options ) = @_;
2038 local $SIG{HUP} = 'IGNORE';
2039 local $SIG{INT} = 'IGNORE';
2040 local $SIG{QUIT} = 'IGNORE';
2041 local $SIG{TERM} = 'IGNORE';
2042 local $SIG{TSTP} = 'IGNORE';
2043 local $SIG{PIPE} = 'IGNORE';
2045 my $oldAutoCommit = $FS::UID::AutoCommit;
2046 local $FS::UID::AutoCommit = 0;
2049 $self->select_for_update; #mutex
2053 my @payments = sort { $b->_date <=> $a->_date }
2054 grep { $_->unapplied > 0 }
2057 my @invoices = sort { $a->_date <=> $b->_date}
2058 grep { $_->owed > 0 }
2061 if ( $conf->exists('pkg-balances') ) {
2062 # limit @payments to those w/ a pkgnum grepped from $self
2064 foreach my $i (@invoices) {
2065 foreach my $li ( $i->cust_bill_pkg ) {
2066 $pkgnums{$li->pkgnum} = 1;
2069 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
2074 foreach my $cust_bill ( @invoices ) {
2076 if ( !defined($payment) || $payment->unapplied == 0 ) {
2077 $payment = pop @payments or last;
2081 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
2082 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
2084 $owed = $cust_bill->owed;
2086 unless ( $owed > 0 ) {
2087 push @payments, $payment;
2091 my $amount = min( $payment->unapplied, $owed );
2093 my $cust_bill_pay = new FS::cust_bill_pay ( {
2094 'paynum' => $payment->paynum,
2095 'invnum' => $cust_bill->invnum,
2096 'amount' => $amount,
2098 $cust_bill_pay->pkgnum( $payment->pkgnum )
2099 if $conf->exists('pkg-balances') && $payment->pkgnum;
2100 my $error = $cust_bill_pay->insert(%options);
2102 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2106 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2110 my $total_unapplied_payments = $self->total_unapplied_payments;
2112 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2114 return $total_unapplied_payments;
2124 suspend_adjourned_pkgs
2127 (do_cust_event pre-bill)
2130 (vendor-only) _gather_taxes
2131 _omit_zero_value_bundles
2134 apply_payments_and_credits
2143 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>