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 = ();
588 foreach my $cust_bill_pkg ( @_ ) {
589 if (scalar(@cust_bill_pkg_bundle) && !$cust_bill_pkg->pkgpart_override) {
590 push @cust_bill_pkg, @cust_bill_pkg_bundle if $sum > 0;
591 @cust_bill_pkg_bundle = ();
594 $sum += $cust_bill_pkg->setup + $cust_bill_pkg->recur;
595 push @cust_bill_pkg_bundle, $cust_bill_pkg;
597 push @cust_bill_pkg, @cust_bill_pkg_bundle if $sum > 0;
603 =item calculate_taxes LINEITEMREF TAXHASHREF INVOICE_TIME
605 This is a weird one. Perhaps it should not even be exposed.
607 Generates tax line items (see L<FS::cust_bill_pkg>) for this customer.
608 Usually used internally by bill method B<bill>.
610 If there is an error, returns the error, otherwise returns reference to a
611 list of line items suitable for insertion.
617 An array ref of the line items being billed.
621 A strange beast. The keys to this hash are internal identifiers consisting
622 of the name of the tax object type, a space, and its unique identifier ( e.g.
623 'cust_main_county 23' ). The values of the hash are listrefs. The first
624 item in the list is the tax object. The remaining items are either line
625 items or floating point values (currency amounts).
627 The taxes are calculated on this entity. Calculated exemption records are
628 transferred to the LINEITEMREF items on the assumption that they are related.
634 This specifies the date appearing on the associated invoice. Some
635 jurisdictions (i.e. Texas) have tax exemptions which are date sensitive.
641 sub calculate_taxes {
642 my ($self, $cust_bill_pkg, $taxlisthash, $invoice_time) = @_;
644 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
646 warn "$me calculate_taxes\n"
647 #.Dumper($self, $cust_bill_pkg, $taxlisthash, $invoice_time). "\n"
650 my @tax_line_items = ();
652 # keys are tax names (as printed on invoices / itemdesc )
653 # values are listrefs of taxlisthash keys (internal identifiers)
656 # keys are taxlisthash keys (internal identifiers)
657 # values are (cumulative) amounts
660 # keys are taxlisthash keys (internal identifiers)
661 # values are listrefs of cust_bill_pkg_tax_location hashrefs
662 my %tax_location = ();
664 # keys are taxlisthash keys (internal identifiers)
665 # values are listrefs of cust_bill_pkg_tax_rate_location hashrefs
666 my %tax_rate_location = ();
668 foreach my $tax ( keys %$taxlisthash ) {
669 my $tax_object = shift @{ $taxlisthash->{$tax} };
670 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
671 warn " ". join('/', @{ $taxlisthash->{$tax} } ). "\n" if $DEBUG > 2;
672 my $hashref_or_error =
673 $tax_object->taxline( $taxlisthash->{$tax},
674 'custnum' => $self->custnum,
675 'invoice_time' => $invoice_time
677 return $hashref_or_error unless ref($hashref_or_error);
679 unshift @{ $taxlisthash->{$tax} }, $tax_object;
681 my $name = $hashref_or_error->{'name'};
682 my $amount = $hashref_or_error->{'amount'};
684 #warn "adding $amount as $name\n";
685 $taxname{ $name } ||= [];
686 push @{ $taxname{ $name } }, $tax;
688 $tax{ $tax } += $amount;
690 $tax_location{ $tax } ||= [];
691 if ( $tax_object->get('pkgnum') || $tax_object->get('locationnum') ) {
692 push @{ $tax_location{ $tax } },
694 'taxnum' => $tax_object->taxnum,
695 'taxtype' => ref($tax_object),
696 'pkgnum' => $tax_object->get('pkgnum'),
697 'locationnum' => $tax_object->get('locationnum'),
698 'amount' => sprintf('%.2f', $amount ),
702 $tax_rate_location{ $tax } ||= [];
703 if ( ref($tax_object) eq 'FS::tax_rate' ) {
704 my $taxratelocationnum =
705 $tax_object->tax_rate_location->taxratelocationnum;
706 push @{ $tax_rate_location{ $tax } },
708 'taxnum' => $tax_object->taxnum,
709 'taxtype' => ref($tax_object),
710 'amount' => sprintf('%.2f', $amount ),
711 'locationtaxid' => $tax_object->location,
712 'taxratelocationnum' => $taxratelocationnum,
718 #move the cust_tax_exempt_pkg records to the cust_bill_pkgs we will commit
719 my %packagemap = map { $_->pkgnum => $_ } @$cust_bill_pkg;
720 foreach my $tax ( keys %$taxlisthash ) {
721 foreach ( @{ $taxlisthash->{$tax} }[1 ... scalar(@{ $taxlisthash->{$tax} })] ) {
722 next unless ref($_) eq 'FS::cust_bill_pkg';
723 push @{ $packagemap{$_->pkgnum}->_cust_tax_exempt_pkg },
724 splice( @{ $_->_cust_tax_exempt_pkg } );
728 #consolidate and create tax line items
729 warn "consolidating and generating...\n" if $DEBUG > 2;
730 foreach my $taxname ( keys %taxname ) {
733 my @cust_bill_pkg_tax_location = ();
734 my @cust_bill_pkg_tax_rate_location = ();
735 warn "adding $taxname\n" if $DEBUG > 1;
736 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
737 next if $seen{$taxitem}++;
738 warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
739 $tax += $tax{$taxitem};
740 push @cust_bill_pkg_tax_location,
741 map { new FS::cust_bill_pkg_tax_location $_ }
742 @{ $tax_location{ $taxitem } };
743 push @cust_bill_pkg_tax_rate_location,
744 map { new FS::cust_bill_pkg_tax_rate_location $_ }
745 @{ $tax_rate_location{ $taxitem } };
749 $tax = sprintf('%.2f', $tax );
751 my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
757 if ( $pkg_category and
758 $conf->config('invoice_latexsummary') ||
759 $conf->config('invoice_htmlsummary')
763 my %hash = ( 'section' => $pkg_category->categoryname );
764 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
768 push @tax_line_items, new FS::cust_bill_pkg {
774 'itemdesc' => $taxname,
775 'display' => \@display,
776 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
777 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
786 my ($self, %params) = @_;
788 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
790 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
791 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
792 my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
793 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
794 my $total_setup = $params{setup} or die "no setup accumulator specified";
795 my $total_recur = $params{recur} or die "no recur accumulator specified";
796 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
797 my $time = $params{'time'} or die "no time specified";
798 my (%options) = %{$params{options}};
801 my $real_pkgpart = $params{real_pkgpart};
802 my %hash = $cust_pkg->hash;
803 my $old_cust_pkg = new FS::cust_pkg \%hash;
809 $cust_pkg->pkgpart($part_pkg->pkgpart);
817 if ( $options{'resetup'}
818 || ( ! $cust_pkg->setup
819 && ( ! $cust_pkg->start_date
820 || $cust_pkg->start_date <= $time
822 && ( ! $conf->exists('disable_setup_suspended_pkgs')
823 || ( $conf->exists('disable_setup_suspended_pkgs') &&
824 ! $cust_pkg->getfield('susp')
828 and !$options{recurring_only}
832 warn " bill setup\n" if $DEBUG > 1;
835 $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
836 return "$@ running calc_setup for $cust_pkg\n"
839 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
841 $cust_pkg->setfield('setup', $time)
842 unless $cust_pkg->setup;
843 #do need it, but it won't get written to the db
844 #|| $cust_pkg->pkgpart != $real_pkgpart;
846 $cust_pkg->setfield('start_date', '')
847 if $cust_pkg->start_date;
855 #XXX unit stuff here too
859 if ( ! $cust_pkg->start_date
860 and ( ! $cust_pkg->susp || $part_pkg->option('suspend_bill', 1) )
862 ( $part_pkg->freq ne '0' && ( $cust_pkg->bill || 0 ) <= $time )
863 || ( $part_pkg->plan eq 'voip_cdr'
864 && $part_pkg->option('bill_every_call')
869 # XXX should this be a package event? probably. events are called
870 # at collection time at the moment, though...
871 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
872 if $part_pkg->can('reset_usage') && !$options{'no_usage_reset'};
873 #don't want to reset usage just cause we want a line item??
874 #&& $part_pkg->pkgpart == $real_pkgpart;
876 warn " bill recur\n" if $DEBUG > 1;
879 # XXX shared with $recur_prog
880 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
884 #over two params! lets at least switch to a hashref for the rest...
885 my $increment_next_bill = ( $part_pkg->freq ne '0'
886 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
889 my %param = ( 'precommit_hooks' => $precommit_hooks,
890 'increment_next_bill' => $increment_next_bill,
891 'discounts' => \@discounts,
892 'real_pkgpart' => $real_pkgpart,
893 'freq_override' => $options{freq_override} || '',
896 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
898 # There may be some part_pkg for which this is wrong. Only those
899 # which can_discount are supported.
900 # (the UI should prevent adding discounts to these at the moment)
902 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
903 return "$@ running $method for $cust_pkg\n"
906 if ( $increment_next_bill ) {
908 my $next_bill = $part_pkg->add_freq($sdate, $options{freq_override} || 0);
909 return "unparsable frequency: ". $part_pkg->freq
912 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
913 # only for figuring next bill date, nothing else, so, reset $sdate again
915 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
916 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
917 $cust_pkg->last_bill($sdate);
919 $cust_pkg->setfield('bill', $next_bill );
925 warn "\$setup is undefined" unless defined($setup);
926 warn "\$recur is undefined" unless defined($recur);
927 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
930 # If there's line items, create em cust_bill_pkg records
931 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
936 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
937 # hmm.. and if just the options are modified in some weird price plan?
939 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
942 my $error = $cust_pkg->replace( $old_cust_pkg,
943 'depend_jobnum'=>$options{depend_jobnum},
944 'options' => { $cust_pkg->options },
946 unless $options{no_commit};
947 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
948 if $error; #just in case
951 $setup = sprintf( "%.2f", $setup );
952 $recur = sprintf( "%.2f", $recur );
953 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
954 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
956 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
957 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
962 !$part_pkg->hidden && $options{has_hidden} ) #include some $0 lines
965 warn " charges (setup=$setup, recur=$recur); adding line items\n"
968 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
970 warn " adding customer package invoice detail: $_\n"
971 foreach @cust_pkg_detail;
973 push @details, @cust_pkg_detail;
975 my $cust_bill_pkg = new FS::cust_bill_pkg {
976 'pkgnum' => $cust_pkg->pkgnum,
978 'unitsetup' => $unitsetup,
980 'unitrecur' => $unitrecur,
981 'quantity' => $cust_pkg->quantity,
982 'details' => \@details,
983 'discounts' => \@discounts,
984 'hidden' => $part_pkg->hidden,
985 'freq' => $part_pkg->freq,
988 if ( $part_pkg->option('recur_temporality', 1) eq 'preceding' ) {
989 $cust_bill_pkg->sdate( $hash{last_bill} );
990 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
991 $cust_bill_pkg->edate( $time ) if $options{cancel};
992 } else { #if ( $part_pkg->option('recur_temporality', 1) eq 'upcoming' ) {
993 $cust_bill_pkg->sdate( $sdate );
994 $cust_bill_pkg->edate( $cust_pkg->bill );
995 #$cust_bill_pkg->edate( $time ) if $options{cancel};
998 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
999 unless $part_pkg->pkgpart == $real_pkgpart;
1001 $$total_setup += $setup;
1002 $$total_recur += $recur;
1009 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart, \%options);
1010 return $error if $error;
1012 push @$cust_bill_pkgs, $cust_bill_pkg;
1014 } #if $setup != 0 || $recur != 0
1024 my $part_pkg = shift;
1025 my $taxlisthash = shift;
1026 my $cust_bill_pkg = shift;
1027 my $cust_pkg = shift;
1028 my $invoice_time = shift;
1029 my $real_pkgpart = shift;
1030 my $options = shift;
1032 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1034 my %cust_bill_pkg = ();
1038 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
1039 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
1040 push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
1041 push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
1043 if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
1045 if ( $conf->exists('enable_taxproducts')
1046 && ( scalar($part_pkg->part_pkg_taxoverride)
1047 || $part_pkg->has_taxproduct
1052 foreach my $class (@classes) {
1053 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class, $cust_pkg );
1054 return $err_or_ref unless ref($err_or_ref);
1055 $taxes{$class} = $err_or_ref;
1058 unless (exists $taxes{''}) {
1059 my $err_or_ref = $self->_gather_taxes( $part_pkg, '', $cust_pkg );
1060 return $err_or_ref unless ref($err_or_ref);
1061 $taxes{''} = $err_or_ref;
1066 my @loc_keys = qw( city county state country );
1068 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1069 my $cust_location = $cust_pkg->cust_location;
1070 %taxhash = map { $_ => $cust_location->$_() } @loc_keys;
1073 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
1076 %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
1079 $taxhash{'taxclass'} = $part_pkg->taxclass;
1082 my %taxhash_elim = %taxhash;
1083 my @elim = qw( city county state );
1086 #first try a match with taxclass
1087 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1089 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1090 #then try a match without taxclass
1091 my %no_taxclass = %taxhash_elim;
1092 $no_taxclass{ 'taxclass' } = '';
1093 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1096 $taxhash_elim{ shift(@elim) } = '';
1098 } while ( !scalar(@taxes) && scalar(@elim) );
1100 @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
1102 if $self->cust_main_exemption; #just to be safe
1104 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1106 $_->set('pkgnum', $cust_pkg->pkgnum );
1107 $_->set('locationnum', $cust_pkg->locationnum );
1111 $taxes{''} = [ @taxes ];
1112 $taxes{'setup'} = [ @taxes ];
1113 $taxes{'recur'} = [ @taxes ];
1114 $taxes{$_} = [ @taxes ] foreach (@classes);
1116 # # maybe eliminate this entirely, along with all the 0% records
1117 # unless ( @taxes ) {
1119 # "fatal: can't find tax rate for state/county/country/taxclass ".
1120 # join('/', map $taxhash{$_}, qw(state county country taxclass) );
1123 } #if $conf->exists('enable_taxproducts') ...
1128 my $separate = $conf->exists('separate_usage');
1129 my $temp_pkg = new FS::cust_pkg { pkgpart => $real_pkgpart };
1130 my $usage_mandate = $temp_pkg->part_pkg->option('usage_mandate', 'Hush!');
1131 my $section = $temp_pkg->part_pkg->categoryname;
1132 if ( $separate || $section || $usage_mandate ) {
1134 my %hash = ( 'section' => $section );
1136 $section = $temp_pkg->part_pkg->option('usage_section', 'Hush!');
1137 my $summary = $temp_pkg->part_pkg->option('summarize_usage', 'Hush!');
1139 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
1140 push @display, new FS::cust_bill_pkg_display { type => 'R', %hash };
1142 push @display, new FS::cust_bill_pkg_display
1145 ( ( $usage_mandate ) ? ( 'summary' => 'Y' ) : () ),
1149 if ($separate && $section && $summary) {
1150 push @display, new FS::cust_bill_pkg_display { type => 'U',
1155 if ($usage_mandate || $section && $summary) {
1156 $hash{post_total} = 'Y';
1159 if ($separate || $usage_mandate) {
1160 $hash{section} = $section if ($separate || $usage_mandate);
1161 push @display, new FS::cust_bill_pkg_display { type => 'U', %hash };
1165 $cust_bill_pkg->set('display', \@display);
1167 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
1168 foreach my $key (keys %tax_cust_bill_pkg) {
1169 my @taxes = @{ $taxes{$key} || [] };
1170 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
1172 my %localtaxlisthash = ();
1173 foreach my $tax ( @taxes ) {
1175 my $taxname = ref( $tax ). ' '. $tax->taxnum;
1176 # $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
1177 # ' locationnum'. $cust_pkg->locationnum
1178 # if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
1180 $taxlisthash->{ $taxname } ||= [ $tax ];
1181 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
1183 $localtaxlisthash{ $taxname } ||= [ $tax ];
1184 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
1188 warn "finding taxed taxes...\n" if $DEBUG > 2;
1189 foreach my $tax ( keys %localtaxlisthash ) {
1190 my $tax_object = shift @{ $localtaxlisthash{$tax} };
1191 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
1193 next unless $tax_object->can('tax_on_tax');
1195 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
1196 my $totname = ref( $tot ). ' '. $tot->taxnum;
1198 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
1200 next unless exists( $localtaxlisthash{ $totname } ); # only increase
1202 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
1203 my $hashref_or_error =
1204 $tax_object->taxline( $localtaxlisthash{$tax},
1205 'custnum' => $self->custnum,
1206 'invoice_time' => $invoice_time,
1208 return $hashref_or_error
1209 unless ref($hashref_or_error);
1211 $taxlisthash->{ $totname } ||= [ $tot ];
1212 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
1224 my $part_pkg = shift;
1226 my $cust_pkg = shift;
1228 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1231 if ( $cust_pkg->locationnum && $conf->exists('tax-pkg_address') ) {
1232 $geocode = $cust_pkg->cust_location->geocode('cch');
1234 $geocode = $self->geocode('cch');
1239 my @taxclassnums = map { $_->taxclassnum }
1240 $part_pkg->part_pkg_taxoverride($class);
1242 unless (@taxclassnums) {
1243 @taxclassnums = map { $_->taxclassnum }
1244 grep { $_->taxable eq 'Y' }
1245 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
1247 warn "Found taxclassnum values of ". join(',', @taxclassnums)
1252 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
1254 @taxes = qsearch({ 'table' => 'tax_rate',
1255 'hashref' => { 'geocode' => $geocode, },
1256 'extra_sql' => $extra_sql,
1258 if scalar(@taxclassnums);
1260 warn "Found taxes ".
1261 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
1268 =item collect [ HASHREF | OPTION => VALUE ... ]
1270 (Attempt to) collect money for this customer's outstanding invoices (see
1271 L<FS::cust_bill>). Usually used after the bill method.
1273 Actions are now triggered by billing events; see L<FS::part_event> and the
1274 billing events web interface. Old-style invoice events (see
1275 L<FS::part_bill_event>) have been deprecated.
1277 If there is an error, returns the error, otherwise returns false.
1279 Options are passed as name-value pairs.
1281 Currently available options are:
1287 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.
1291 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1295 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1299 set true to surpress email card/ACH decline notices.
1303 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)
1309 # allows for one time override of normal customer billing method
1314 my( $self, %options ) = @_;
1316 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1318 my $invoice_time = $options{'invoice_time'} || time;
1321 local $SIG{HUP} = 'IGNORE';
1322 local $SIG{INT} = 'IGNORE';
1323 local $SIG{QUIT} = 'IGNORE';
1324 local $SIG{TERM} = 'IGNORE';
1325 local $SIG{TSTP} = 'IGNORE';
1326 local $SIG{PIPE} = 'IGNORE';
1328 my $oldAutoCommit = $FS::UID::AutoCommit;
1329 local $FS::UID::AutoCommit = 0;
1332 $self->select_for_update; #mutex
1335 my $balance = $self->balance;
1336 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
1339 if ( exists($options{'retry_card'}) ) {
1340 carp 'retry_card option passed to collect is deprecated; use retry';
1341 $options{'retry'} ||= $options{'retry_card'};
1343 if ( exists($options{'retry'}) && $options{'retry'} ) {
1344 my $error = $self->retry_realtime;
1346 $dbh->rollback if $oldAutoCommit;
1351 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1353 #never want to roll back an event just because it returned an error
1354 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1356 $self->do_cust_event(
1357 'debug' => ( $options{'debug'} || 0 ),
1358 'time' => $invoice_time,
1359 'check_freq' => $options{'check_freq'},
1360 'stage' => 'collect',
1365 =item retry_realtime
1367 Schedules realtime / batch credit card / electronic check / LEC billing
1368 events for for retry. Useful if card information has changed or manual
1369 retry is desired. The 'collect' method must be called to actually retry
1372 Implementation details: For either this customer, or for each of this
1373 customer's open invoices, changes the status of the first "done" (with
1374 statustext error) realtime processing event to "failed".
1378 sub retry_realtime {
1381 local $SIG{HUP} = 'IGNORE';
1382 local $SIG{INT} = 'IGNORE';
1383 local $SIG{QUIT} = 'IGNORE';
1384 local $SIG{TERM} = 'IGNORE';
1385 local $SIG{TSTP} = 'IGNORE';
1386 local $SIG{PIPE} = 'IGNORE';
1388 my $oldAutoCommit = $FS::UID::AutoCommit;
1389 local $FS::UID::AutoCommit = 0;
1392 #a little false laziness w/due_cust_event (not too bad, really)
1394 my $join = FS::part_event_condition->join_conditions_sql;
1395 my $order = FS::part_event_condition->order_conditions_sql;
1398 . join ( ' OR ' , map {
1399 "( part_event.eventtable = " . dbh->quote($_)
1400 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
1401 } FS::part_event->eventtables)
1404 #here is the agent virtualization
1405 my $agent_virt = " ( part_event.agentnum IS NULL
1406 OR part_event.agentnum = ". $self->agentnum. ' )';
1408 #XXX this shouldn't be hardcoded, actions should declare it...
1409 my @realtime_events = qw(
1410 cust_bill_realtime_card
1411 cust_bill_realtime_check
1412 cust_bill_realtime_lec
1416 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
1421 my @cust_event = qsearchs({
1422 'table' => 'cust_event',
1423 'select' => 'cust_event.*',
1424 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
1425 'hashref' => { 'status' => 'done' },
1426 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
1427 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
1430 my %seen_invnum = ();
1431 foreach my $cust_event (@cust_event) {
1433 #max one for the customer, one for each open invoice
1434 my $cust_X = $cust_event->cust_X;
1435 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
1439 or $cust_event->part_event->eventtable eq 'cust_bill'
1442 my $error = $cust_event->retry;
1444 $dbh->rollback if $oldAutoCommit;
1445 return "error scheduling event for retry: $error";
1450 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1455 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
1457 Runs billing events; see L<FS::part_event> and the billing events web
1460 If there is an error, returns the error, otherwise returns false.
1462 Options are passed as name-value pairs.
1464 Currently available options are:
1470 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.
1474 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1478 "collect" (the default) or "pre-bill"
1482 set true to surpress email card/ACH decline notices.
1486 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)
1493 # allows for one time override of normal customer billing method
1497 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1500 my( $self, %options ) = @_;
1502 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1504 my $time = $options{'time'} || time;
1507 local $SIG{HUP} = 'IGNORE';
1508 local $SIG{INT} = 'IGNORE';
1509 local $SIG{QUIT} = 'IGNORE';
1510 local $SIG{TERM} = 'IGNORE';
1511 local $SIG{TSTP} = 'IGNORE';
1512 local $SIG{PIPE} = 'IGNORE';
1514 my $oldAutoCommit = $FS::UID::AutoCommit;
1515 local $FS::UID::AutoCommit = 0;
1518 $self->select_for_update; #mutex
1521 my $balance = $self->balance;
1522 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
1525 # if ( exists($options{'retry_card'}) ) {
1526 # carp 'retry_card option passed to collect is deprecated; use retry';
1527 # $options{'retry'} ||= $options{'retry_card'};
1529 # if ( exists($options{'retry'}) && $options{'retry'} ) {
1530 # my $error = $self->retry_realtime;
1532 # $dbh->rollback if $oldAutoCommit;
1537 # false laziness w/pay_batch::import_results
1539 my $due_cust_event = $self->due_cust_event(
1540 'debug' => ( $options{'debug'} || 0 ),
1542 'check_freq' => $options{'check_freq'},
1543 'stage' => ( $options{'stage'} || 'collect' ),
1545 unless( ref($due_cust_event) ) {
1546 $dbh->rollback if $oldAutoCommit;
1547 return $due_cust_event;
1550 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1551 #never want to roll back an event just because it or a different one
1553 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1555 foreach my $cust_event ( @$due_cust_event ) {
1559 #re-eval event conditions (a previous event could have changed things)
1560 unless ( $cust_event->test_conditions( 'time' => $time ) ) {
1561 #don't leave stray "new/locked" records around
1562 my $error = $cust_event->delete;
1563 return $error if $error;
1568 local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
1569 if $options{'quiet'};
1570 warn " running cust_event ". $cust_event->eventnum. "\n"
1573 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
1574 if ( my $error = $cust_event->do_event() ) {
1575 #XXX wtf is this? figure out a proper dealio with return value
1587 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
1589 Inserts database records for and returns an ordered listref of new events due
1590 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
1591 events are due, an empty listref is returned. If there is an error, returns a
1592 scalar error message.
1594 To actually run the events, call each event's test_condition method, and if
1595 still true, call the event's do_event method.
1597 Options are passed as a hashref or as a list of name-value pairs. Available
1604 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.
1608 "collect" (the default) or "pre-bill"
1612 "Current time" for the events.
1616 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)
1620 Only return events for the specified eventtable (by default, events of all eventtables are returned)
1624 Explicitly pass the objects to be tested (typically used with eventtable).
1628 Set to true to return the objects, but not actually insert them into the
1635 sub due_cust_event {
1637 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
1640 #my $DEBUG = $opt{'debug'}
1641 local($DEBUG) = $opt{'debug'}
1642 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
1643 $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1645 warn "$me due_cust_event called with options ".
1646 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
1649 $opt{'time'} ||= time;
1651 local $SIG{HUP} = 'IGNORE';
1652 local $SIG{INT} = 'IGNORE';
1653 local $SIG{QUIT} = 'IGNORE';
1654 local $SIG{TERM} = 'IGNORE';
1655 local $SIG{TSTP} = 'IGNORE';
1656 local $SIG{PIPE} = 'IGNORE';
1658 my $oldAutoCommit = $FS::UID::AutoCommit;
1659 local $FS::UID::AutoCommit = 0;
1662 $self->select_for_update #mutex
1663 unless $opt{testonly};
1666 # find possible events (initial search)
1669 my @cust_event = ();
1671 my @eventtable = $opt{'eventtable'}
1672 ? ( $opt{'eventtable'} )
1673 : FS::part_event->eventtables_runorder;
1675 my $check_freq = $opt{'check_freq'} || '1d';
1677 foreach my $eventtable ( @eventtable ) {
1680 if ( $opt{'objects'} ) {
1682 @objects = @{ $opt{'objects'} };
1686 #my @objects = $self->$eventtable(); # sub cust_main { @{ [ $self ] }; }
1687 if ( $eventtable eq 'cust_main' ) {
1688 @objects = ( $self );
1692 "LEFT JOIN cust_main USING ( custnum )";
1694 #some false laziness w/Cron::bill bill_where
1696 my $join = FS::part_event_condition->join_conditions_sql( $eventtable);
1697 my $where = FS::part_event_condition->where_conditions_sql($eventtable,
1698 'time'=>$opt{'time'},
1700 $where = $where ? "AND $where" : '';
1702 my $are_part_event =
1703 "EXISTS ( SELECT 1 FROM part_event $join
1704 WHERE check_freq = '$check_freq'
1705 AND eventtable = '$eventtable'
1706 AND ( disabled = '' OR disabled IS NULL )
1712 @objects = $self->$eventtable(
1713 'addl_from' => $cm_join,
1714 'extra_sql' => " AND $are_part_event",
1720 my @e_cust_event = ();
1722 my $cross = "CROSS JOIN $eventtable";
1723 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
1724 unless $eventtable eq 'cust_main';
1726 foreach my $object ( @objects ) {
1728 #this first search uses the condition_sql magic for optimization.
1729 #the more possible events we can eliminate in this step the better
1731 my $cross_where = '';
1732 my $pkey = $object->primary_key;
1733 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
1735 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
1737 FS::part_event_condition->where_conditions_sql( $eventtable,
1738 'time'=>$opt{'time'}
1740 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
1742 $extra_sql = "AND $extra_sql" if $extra_sql;
1744 #here is the agent virtualization
1745 $extra_sql .= " AND ( part_event.agentnum IS NULL
1746 OR part_event.agentnum = ". $self->agentnum. ' )';
1748 $extra_sql .= " $order";
1750 warn "searching for events for $eventtable ". $object->$pkey. "\n"
1751 if $opt{'debug'} > 2;
1752 my @part_event = qsearch( {
1753 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
1754 'select' => 'part_event.*',
1755 'table' => 'part_event',
1756 'addl_from' => "$cross $join",
1757 'hashref' => { 'check_freq' => $check_freq,
1758 'eventtable' => $eventtable,
1761 'extra_sql' => "AND $cross_where $extra_sql",
1765 my $pkey = $object->primary_key;
1766 warn " ". scalar(@part_event).
1767 " possible events found for $eventtable ". $object->$pkey(). "\n";
1770 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
1774 warn " ". scalar(@e_cust_event).
1775 " subtotal possible cust events found for $eventtable\n"
1778 push @cust_event, @e_cust_event;
1782 warn " ". scalar(@cust_event).
1783 " total possible cust events found in initial search\n"
1791 $opt{stage} ||= 'collect';
1793 grep { my $stage = $_->part_event->event_stage;
1794 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
1804 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
1805 'stats_hashref' => \%unsat ),
1808 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
1811 warn " invalid conditions not eliminated with condition_sql:\n".
1812 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
1813 if keys %unsat && $DEBUG; # > 1;
1819 unless( $opt{testonly} ) {
1820 foreach my $cust_event ( @cust_event ) {
1822 my $error = $cust_event->insert();
1824 $dbh->rollback if $oldAutoCommit;
1831 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1837 warn " returning events: ". Dumper(@cust_event). "\n"
1844 =item apply_payments_and_credits [ OPTION => VALUE ... ]
1846 Applies unapplied payments and credits.
1848 In most cases, this new method should be used in place of sequential
1849 apply_payments and apply_credits methods.
1851 A hash of optional arguments may be passed. Currently "manual" is supported.
1852 If true, a payment receipt is sent instead of a statement when
1853 'payment_receipt_email' configuration option is set.
1855 If there is an error, returns the error, otherwise returns false.
1859 sub apply_payments_and_credits {
1860 my( $self, %options ) = @_;
1862 local $SIG{HUP} = 'IGNORE';
1863 local $SIG{INT} = 'IGNORE';
1864 local $SIG{QUIT} = 'IGNORE';
1865 local $SIG{TERM} = 'IGNORE';
1866 local $SIG{TSTP} = 'IGNORE';
1867 local $SIG{PIPE} = 'IGNORE';
1869 my $oldAutoCommit = $FS::UID::AutoCommit;
1870 local $FS::UID::AutoCommit = 0;
1873 $self->select_for_update; #mutex
1875 foreach my $cust_bill ( $self->open_cust_bill ) {
1876 my $error = $cust_bill->apply_payments_and_credits(%options);
1878 $dbh->rollback if $oldAutoCommit;
1879 return "Error applying: $error";
1883 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1888 =item apply_credits OPTION => VALUE ...
1890 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
1891 to outstanding invoice balances in chronological order (or reverse
1892 chronological order if the I<order> option is set to B<newest>) and returns the
1893 value of any remaining unapplied credits available for refund (see
1894 L<FS::cust_refund>).
1896 Dies if there is an error.
1904 local $SIG{HUP} = 'IGNORE';
1905 local $SIG{INT} = 'IGNORE';
1906 local $SIG{QUIT} = 'IGNORE';
1907 local $SIG{TERM} = 'IGNORE';
1908 local $SIG{TSTP} = 'IGNORE';
1909 local $SIG{PIPE} = 'IGNORE';
1911 my $oldAutoCommit = $FS::UID::AutoCommit;
1912 local $FS::UID::AutoCommit = 0;
1915 $self->select_for_update; #mutex
1917 unless ( $self->total_unapplied_credits ) {
1918 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1922 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
1923 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
1925 my @invoices = $self->open_cust_bill;
1926 @invoices = sort { $b->_date <=> $a->_date } @invoices
1927 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
1929 if ( $conf->exists('pkg-balances') ) {
1930 # limit @credits to those w/ a pkgnum grepped from $self
1932 foreach my $i (@invoices) {
1933 foreach my $li ( $i->cust_bill_pkg ) {
1934 $pkgnums{$li->pkgnum} = 1;
1937 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
1942 foreach my $cust_bill ( @invoices ) {
1944 if ( !defined($credit) || $credit->credited == 0) {
1945 $credit = pop @credits or last;
1949 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
1950 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
1952 $owed = $cust_bill->owed;
1954 unless ( $owed > 0 ) {
1955 push @credits, $credit;
1959 my $amount = min( $credit->credited, $owed );
1961 my $cust_credit_bill = new FS::cust_credit_bill ( {
1962 'crednum' => $credit->crednum,
1963 'invnum' => $cust_bill->invnum,
1964 'amount' => $amount,
1966 $cust_credit_bill->pkgnum( $credit->pkgnum )
1967 if $conf->exists('pkg-balances') && $credit->pkgnum;
1968 my $error = $cust_credit_bill->insert;
1970 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
1974 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
1978 my $total_unapplied_credits = $self->total_unapplied_credits;
1980 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1982 return $total_unapplied_credits;
1985 =item apply_payments [ OPTION => VALUE ... ]
1987 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
1988 to outstanding invoice balances in chronological order.
1990 #and returns the value of any remaining unapplied payments.
1992 A hash of optional arguments may be passed. Currently "manual" is supported.
1993 If true, a payment receipt is sent instead of a statement when
1994 'payment_receipt_email' configuration option is set.
1996 Dies if there is an error.
2000 sub apply_payments {
2001 my( $self, %options ) = @_;
2003 local $SIG{HUP} = 'IGNORE';
2004 local $SIG{INT} = 'IGNORE';
2005 local $SIG{QUIT} = 'IGNORE';
2006 local $SIG{TERM} = 'IGNORE';
2007 local $SIG{TSTP} = 'IGNORE';
2008 local $SIG{PIPE} = 'IGNORE';
2010 my $oldAutoCommit = $FS::UID::AutoCommit;
2011 local $FS::UID::AutoCommit = 0;
2014 $self->select_for_update; #mutex
2018 my @payments = sort { $b->_date <=> $a->_date }
2019 grep { $_->unapplied > 0 }
2022 my @invoices = sort { $a->_date <=> $b->_date}
2023 grep { $_->owed > 0 }
2026 if ( $conf->exists('pkg-balances') ) {
2027 # limit @payments to those w/ a pkgnum grepped from $self
2029 foreach my $i (@invoices) {
2030 foreach my $li ( $i->cust_bill_pkg ) {
2031 $pkgnums{$li->pkgnum} = 1;
2034 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
2039 foreach my $cust_bill ( @invoices ) {
2041 if ( !defined($payment) || $payment->unapplied == 0 ) {
2042 $payment = pop @payments or last;
2046 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
2047 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
2049 $owed = $cust_bill->owed;
2051 unless ( $owed > 0 ) {
2052 push @payments, $payment;
2056 my $amount = min( $payment->unapplied, $owed );
2058 my $cust_bill_pay = new FS::cust_bill_pay ( {
2059 'paynum' => $payment->paynum,
2060 'invnum' => $cust_bill->invnum,
2061 'amount' => $amount,
2063 $cust_bill_pay->pkgnum( $payment->pkgnum )
2064 if $conf->exists('pkg-balances') && $payment->pkgnum;
2065 my $error = $cust_bill_pay->insert(%options);
2067 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2071 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2075 my $total_unapplied_payments = $self->total_unapplied_payments;
2077 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2079 return $total_unapplied_payments;
2088 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>