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 );
10 use FS::Misc::DateTime qw( day_end );
12 use FS::cust_bill_pkg;
13 use FS::cust_bill_pkg_display;
14 use FS::cust_bill_pay;
15 use FS::cust_credit_bill;
16 use FS::cust_tax_adjustment;
18 use FS::tax_rate_location;
19 use FS::cust_bill_pkg_tax_location;
20 use FS::cust_bill_pkg_tax_rate_location;
22 use FS::part_event_condition;
25 # 1 is mostly method/subroutine entry and options
26 # 2 traces progress of some operations
27 # 3 is even more information including possibly sensitive data
29 $me = '[FS::cust_main::Billing]';
31 install_callback FS::UID sub {
33 #yes, need it for stuff below (prolly should be cached)
38 FS::cust_main::Billing - Billing mixin for cust_main
44 These methods are available on FS::cust_main objects.
50 =item bill_and_collect
52 Cancels and suspends any packages due, generates bills, applies payments and
53 credits, and applies collection events to run cards, send bills and notices,
56 By default, warns on errors and continues with the next operation (but see the
59 Options are passed as name-value pairs. Currently available options are:
65 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:
69 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
73 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.
77 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
81 If set true, re-charges setup fees.
85 If set any errors prevent subsequent operations from continusing. If set
86 specifically to "return", returns the error (or false, if there is no error).
87 Any other true value causes errors to die.
91 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)
95 Optional FS::queue entry to receive status updates.
99 Options are passed to the B<bill> and B<collect> methods verbatim, so all
100 options of those methods are also available.
104 sub bill_and_collect {
105 my( $self, %options ) = @_;
109 #$options{actual_time} not $options{time} because freeside-daily -d is for
110 #pre-printing invoices
112 $options{'actual_time'} ||= time;
113 my $job = $options{'job'};
115 $job->update_statustext('0,cleaning expired packages') if $job;
116 $error = $self->cancel_expired_pkgs( day_end( $options{actual_time} ) );
118 $error = "Error expiring custnum ". $self->custnum. ": $error";
119 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
120 elsif ( $options{fatal} ) { die $error; }
121 else { warn $error; }
124 $error = $self->suspend_adjourned_pkgs( day_end( $options{actual_time} ) );
126 $error = "Error adjourning custnum ". $self->custnum. ": $error";
127 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
128 elsif ( $options{fatal} ) { die $error; }
129 else { warn $error; }
132 $job->update_statustext('20,billing packages') if $job;
133 $error = $self->bill( %options );
135 $error = "Error billing custnum ". $self->custnum. ": $error";
136 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
137 elsif ( $options{fatal} ) { die $error; }
138 else { warn $error; }
141 $job->update_statustext('50,applying payments and credits') if $job;
142 $error = $self->apply_payments_and_credits;
144 $error = "Error applying custnum ". $self->custnum. ": $error";
145 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
146 elsif ( $options{fatal} ) { die $error; }
147 else { warn $error; }
150 $job->update_statustext('70,running collection events') if $job;
151 unless ( $conf->exists('cancelled_cust-noevents')
152 && ! $self->num_ncancelled_pkgs
154 $error = $self->collect( %options );
156 $error = "Error collecting custnum ". $self->custnum. ": $error";
157 if ($options{fatal} && $options{fatal} eq 'return') { return $error; }
158 elsif ($options{fatal} ) { die $error; }
159 else { warn $error; }
162 $job->update_statustext('100,finished') if $job;
168 sub cancel_expired_pkgs {
169 my ( $self, $time, %options ) = @_;
171 my @cancel_pkgs = $self->ncancelled_pkgs( {
172 'extra_sql' => " AND expire IS NOT NULL AND expire > 0 AND expire <= $time "
177 foreach my $cust_pkg ( @cancel_pkgs ) {
178 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
179 my $error = $cust_pkg->cancel($cpr ? ( 'reason' => $cpr->reasonnum,
180 'reason_otaker' => $cpr->otaker
184 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
187 scalar(@errors) ? join(' / ', @errors) : '';
191 sub suspend_adjourned_pkgs {
192 my ( $self, $time, %options ) = @_;
194 my @susp_pkgs = $self->ncancelled_pkgs( {
196 " AND ( susp IS NULL OR susp = 0 )
197 AND ( ( bill IS NOT NULL AND bill != 0 AND bill < $time )
198 OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
203 #only because there's no SQL test for is_prepaid :/
205 grep { ( $_->part_pkg->is_prepaid
210 && $_->adjourn <= $time
218 foreach my $cust_pkg ( @susp_pkgs ) {
219 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
220 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
221 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
222 'reason_otaker' => $cpr->otaker
226 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
229 scalar(@errors) ? join(' / ', @errors) : '';
235 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
236 conjunction with the collect method by calling B<bill_and_collect>.
238 If there is an error, returns the error, otherwise returns false.
240 Options are passed as name-value pairs. Currently available options are:
246 If set true, re-charges setup fees.
250 If set true then only bill recurring charges, not setup, usage, one time
255 If set, then override the normal frequency and look for a part_pkg_discount
256 to take at that frequency. This is appropriate only when the normal
257 frequency for all packages is monthly, and is an error otherwise. Use
258 C<pkg_list> to limit the set of packages included in billing.
262 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:
266 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
270 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
272 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
276 A hashref of pkgparts to exclude from this billing run (can also be specified as a comma-separated scalar).
280 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.
284 This boolean value informs the us that the package is being cancelled. This
285 typically might mean not charging the normal recurring fee but only usage
286 fees since the last billing. Setup charges may be charged. Not all package
287 plans support this feature (they tend to charge 0).
291 Prevent the resetting of usage limits during this call.
295 Do not save the generated bill in the database. Useful with return_bill
299 A list reference on which the generated bill(s) will be returned.
303 Optional terms to be printed on this invoice. Otherwise, customer-specific
304 terms or the default terms are used.
311 my( $self, %options ) = @_;
313 return '' if $self->payby eq 'COMP';
315 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
317 warn "$me bill customer ". $self->custnum. "\n"
320 my $time = $options{'time'} || time;
321 my $invoice_time = $options{'invoice_time'} || $time;
323 $options{'not_pkgpart'} ||= {};
324 $options{'not_pkgpart'} = { map { $_ => 1 }
325 split(/\s*,\s*/, $options{'not_pkgpart'})
327 unless ref($options{'not_pkgpart'});
329 local $SIG{HUP} = 'IGNORE';
330 local $SIG{INT} = 'IGNORE';
331 local $SIG{QUIT} = 'IGNORE';
332 local $SIG{TERM} = 'IGNORE';
333 local $SIG{TSTP} = 'IGNORE';
334 local $SIG{PIPE} = 'IGNORE';
336 my $oldAutoCommit = $FS::UID::AutoCommit;
337 local $FS::UID::AutoCommit = 0;
340 warn "$me acquiring lock on customer ". $self->custnum. "\n"
343 $self->select_for_update; #mutex
345 warn "$me running pre-bill events for customer ". $self->custnum. "\n"
348 my $error = $self->do_cust_event(
349 'debug' => ( $options{'debug'} || 0 ),
350 'time' => $invoice_time,
351 'check_freq' => $options{'check_freq'},
352 'stage' => 'pre-bill',
354 unless $options{no_commit};
356 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
360 warn "$me done running pre-bill events for customer ". $self->custnum. "\n"
363 #keep auto-charge and non-auto-charge line items separate
364 my @passes = ( '', 'no_auto' );
366 my %cust_bill_pkg = map { $_ => [] } @passes;
369 # find the packages which are due for billing, find out how much they are
370 # & generate invoice database.
373 my %total_setup = map { my $z = 0; $_ => \$z; } @passes;
374 my %total_recur = map { my $z = 0; $_ => \$z; } @passes;
376 my %taxlisthash = map { $_ => {} } @passes;
378 my @precommit_hooks = ();
380 $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ]; #param checks?
381 foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
383 next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
385 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
387 #? to avoid use of uninitialized value errors... ?
388 $cust_pkg->setfield('bill', '')
389 unless defined($cust_pkg->bill);
391 #my $part_pkg = $cust_pkg->part_pkg;
393 my $real_pkgpart = $cust_pkg->pkgpart;
394 my %hash = $cust_pkg->hash;
396 # we could implement this bit as FS::part_pkg::has_hidden, but we already
397 # suffer from performance issues
398 $options{has_hidden} = 0;
399 my @part_pkg = $cust_pkg->part_pkg->self_and_bill_linked;
400 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
402 foreach my $part_pkg ( @part_pkg ) {
404 $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
406 my $pass = ($cust_pkg->no_auto || $part_pkg->no_auto) ? 'no_auto' : '';
408 my $next_bill = $cust_pkg->getfield('bill') || 0;
410 while ( $next_bill <= $time ) {
412 $self->_make_lines( 'part_pkg' => $part_pkg,
413 'cust_pkg' => $cust_pkg,
414 'precommit_hooks' => \@precommit_hooks,
415 'line_items' => $cust_bill_pkg{$pass},
416 'setup' => $total_setup{$pass},
417 'recur' => $total_recur{$pass},
418 'tax_matrix' => $taxlisthash{$pass},
420 'real_pkgpart' => $real_pkgpart,
421 'options' => \%options,
423 # Stop if anything goes wrong, or if we're not incrementing
426 last if ($cust_pkg->getfield('bill') || 0) == $next_bill;
427 $next_bill = $cust_pkg->getfield('bill') || 0;
430 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
434 } #foreach my $part_pkg
436 } #foreach my $cust_pkg
438 #if the customer isn't on an automatic payby, everything can go on a single
440 #if ( $cust_main->payby !~ /^(CARD|CHEK)$/ ) {
441 #merge everything into one list
444 foreach my $pass (@passes) { # keys %cust_bill_pkg ) {
446 my @cust_bill_pkg = _omit_zero_value_bundles(@{ $cust_bill_pkg{$pass} });
448 next unless @cust_bill_pkg; #don't create an invoice w/o line items
450 warn "$me billing pass $pass\n"
451 #.Dumper(\@cust_bill_pkg)."\n"
454 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
455 !$conf->exists('postal_invoice-recurring_only')
459 my $postal_pkg = $self->charge_postal_fee();
460 if ( $postal_pkg && !ref( $postal_pkg ) ) {
462 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
463 return "can't charge postal invoice fee for customer ".
464 $self->custnum. ": $postal_pkg";
466 } elsif ( $postal_pkg ) {
468 my $real_pkgpart = $postal_pkg->pkgpart;
469 # we could implement this bit as FS::part_pkg::has_hidden, but we already
470 # suffer from performance issues
471 $options{has_hidden} = 0;
472 my @part_pkg = $postal_pkg->part_pkg->self_and_bill_linked;
473 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
475 foreach my $part_pkg ( @part_pkg ) {
476 my %postal_options = %options;
477 delete $postal_options{cancel};
479 $self->_make_lines( 'part_pkg' => $part_pkg,
480 'cust_pkg' => $postal_pkg,
481 'precommit_hooks' => \@precommit_hooks,
482 'line_items' => \@cust_bill_pkg,
483 'setup' => $total_setup{$pass},
484 'recur' => $total_recur{$pass},
485 'tax_matrix' => $taxlisthash{$pass},
487 'real_pkgpart' => $real_pkgpart,
488 'options' => \%postal_options,
491 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
496 # it's silly to have a zero value postal_pkg, but....
497 @cust_bill_pkg = _omit_zero_value_bundles(@cust_bill_pkg);
503 my $listref_or_error =
504 $self->calculate_taxes( \@cust_bill_pkg, $taxlisthash{$pass}, $invoice_time);
506 unless ( ref( $listref_or_error ) ) {
507 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
508 return $listref_or_error;
511 foreach my $taxline ( @$listref_or_error ) {
512 ${ $total_setup{$pass} } =
513 sprintf('%.2f', ${ $total_setup{$pass} } + $taxline->setup );
514 push @cust_bill_pkg, $taxline;
518 warn "adding tax adjustments...\n" if $DEBUG > 2;
519 foreach my $cust_tax_adjustment (
520 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
526 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
528 my $itemdesc = $cust_tax_adjustment->taxname;
529 $itemdesc = '' if $itemdesc eq 'Tax';
531 push @cust_bill_pkg, new FS::cust_bill_pkg {
537 'itemdesc' => $itemdesc,
538 'itemcomment' => $cust_tax_adjustment->comment,
539 'cust_tax_adjustment' => $cust_tax_adjustment,
540 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
545 my $charged = sprintf('%.2f', ${ $total_setup{$pass} } + ${ $total_recur{$pass} } );
547 my @cust_bill = $self->cust_bill;
548 my $balance = $self->balance;
549 my $previous_balance = scalar(@cust_bill)
550 ? ( $cust_bill[$#cust_bill]->billing_balance || 0 )
553 $previous_balance += $cust_bill[$#cust_bill]->charged
554 if scalar(@cust_bill);
555 #my $balance_adjustments =
556 # sprintf('%.2f', $balance - $prior_prior_balance - $prior_charged);
558 warn "creating the new invoice\n" if $DEBUG;
559 #create the new invoice
560 my $cust_bill = new FS::cust_bill ( {
561 'custnum' => $self->custnum,
562 '_date' => $invoice_time,
563 'charged' => $charged,
564 'billing_balance' => $balance,
565 'previous_balance' => $previous_balance,
566 'invoice_terms' => $options{'invoice_terms'},
567 'cust_bill_pkg' => \@cust_bill_pkg,
569 $error = $cust_bill->insert unless $options{no_commit};
571 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
572 return "can't create invoice for customer #". $self->custnum. ": $error";
574 push @{$options{return_bill}}, $cust_bill if $options{return_bill};
576 } #foreach my $pass ( keys %cust_bill_pkg )
578 foreach my $hook ( @precommit_hooks ) {
581 } unless $options{no_commit};
583 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
584 return "$@ running precommit hook $hook\n";
588 $dbh->commit or die $dbh->errstr if $oldAutoCommit && !$options{no_commit};
593 #discard bundled packages of 0 value
594 sub _omit_zero_value_bundles {
597 my @cust_bill_pkg = ();
598 my @cust_bill_pkg_bundle = ();
600 my $discount_show_always = 0;
602 foreach my $cust_bill_pkg ( @in ) {
604 $discount_show_always = ($cust_bill_pkg->get('discounts')
605 && scalar(@{$cust_bill_pkg->get('discounts')})
606 && $conf->exists('discount-show-always'));
608 warn " pkgnum ". $cust_bill_pkg->pkgnum. " sum $sum, ".
609 "setup_show_zero ". $cust_bill_pkg->setup_show_zero.
610 "recur_show_zero ". $cust_bill_pkg->recur_show_zero. "\n"
613 if (scalar(@cust_bill_pkg_bundle) && !$cust_bill_pkg->pkgpart_override) {
614 push @cust_bill_pkg, @cust_bill_pkg_bundle
616 || ($sum == 0 && ( $discount_show_always
617 || grep {$_->recur_show_zero || $_->setup_show_zero}
618 @cust_bill_pkg_bundle
621 @cust_bill_pkg_bundle = ();
625 $sum += $cust_bill_pkg->setup + $cust_bill_pkg->recur;
626 push @cust_bill_pkg_bundle, $cust_bill_pkg;
630 push @cust_bill_pkg, @cust_bill_pkg_bundle
632 || ($sum == 0 && ( $discount_show_always
633 || grep {$_->recur_show_zero || $_->setup_show_zero}
634 @cust_bill_pkg_bundle
638 warn " _omit_zero_value_bundles: ". scalar(@in).
639 '->'. scalar(@cust_bill_pkg). "\n" #. Dumper(@cust_bill_pkg). "\n"
646 =item calculate_taxes LINEITEMREF TAXHASHREF INVOICE_TIME
648 This is a weird one. Perhaps it should not even be exposed.
650 Generates tax line items (see L<FS::cust_bill_pkg>) for this customer.
651 Usually used internally by bill method B<bill>.
653 If there is an error, returns the error, otherwise returns reference to a
654 list of line items suitable for insertion.
660 An array ref of the line items being billed.
664 A strange beast. The keys to this hash are internal identifiers consisting
665 of the name of the tax object type, a space, and its unique identifier ( e.g.
666 'cust_main_county 23' ). The values of the hash are listrefs. The first
667 item in the list is the tax object. The remaining items are either line
668 items or floating point values (currency amounts).
670 The taxes are calculated on this entity. Calculated exemption records are
671 transferred to the LINEITEMREF items on the assumption that they are related.
677 This specifies the date appearing on the associated invoice. Some
678 jurisdictions (i.e. Texas) have tax exemptions which are date sensitive.
684 sub calculate_taxes {
685 my ($self, $cust_bill_pkg, $taxlisthash, $invoice_time) = @_;
687 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
689 warn "$me calculate_taxes\n"
690 #.Dumper($self, $cust_bill_pkg, $taxlisthash, $invoice_time). "\n"
693 my @tax_line_items = ();
695 # keys are tax names (as printed on invoices / itemdesc )
696 # values are listrefs of taxlisthash keys (internal identifiers)
699 # keys are taxlisthash keys (internal identifiers)
700 # values are (cumulative) amounts
703 # keys are taxlisthash keys (internal identifiers)
704 # values are listrefs of cust_bill_pkg_tax_location hashrefs
705 my %tax_location = ();
707 # keys are taxlisthash keys (internal identifiers)
708 # values are listrefs of cust_bill_pkg_tax_rate_location hashrefs
709 my %tax_rate_location = ();
711 foreach my $tax ( keys %$taxlisthash ) {
712 my $tax_object = shift @{ $taxlisthash->{$tax} };
713 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
714 warn " ". join('/', @{ $taxlisthash->{$tax} } ). "\n" if $DEBUG > 2;
715 my $hashref_or_error =
716 $tax_object->taxline( $taxlisthash->{$tax},
717 'custnum' => $self->custnum,
718 'invoice_time' => $invoice_time
720 return $hashref_or_error unless ref($hashref_or_error);
722 unshift @{ $taxlisthash->{$tax} }, $tax_object;
724 my $name = $hashref_or_error->{'name'};
725 my $amount = $hashref_or_error->{'amount'};
727 #warn "adding $amount as $name\n";
728 $taxname{ $name } ||= [];
729 push @{ $taxname{ $name } }, $tax;
731 $tax{ $tax } += $amount;
733 $tax_location{ $tax } ||= [];
734 if ( $tax_object->get('pkgnum') || $tax_object->get('locationnum') ) {
735 push @{ $tax_location{ $tax } },
737 'taxnum' => $tax_object->taxnum,
738 'taxtype' => ref($tax_object),
739 'pkgnum' => $tax_object->get('pkgnum'),
740 'locationnum' => $tax_object->get('locationnum'),
741 'amount' => sprintf('%.2f', $amount ),
745 $tax_rate_location{ $tax } ||= [];
746 if ( ref($tax_object) eq 'FS::tax_rate' ) {
747 my $taxratelocationnum =
748 $tax_object->tax_rate_location->taxratelocationnum;
749 push @{ $tax_rate_location{ $tax } },
751 'taxnum' => $tax_object->taxnum,
752 'taxtype' => ref($tax_object),
753 'amount' => sprintf('%.2f', $amount ),
754 'locationtaxid' => $tax_object->location,
755 'taxratelocationnum' => $taxratelocationnum,
761 #move the cust_tax_exempt_pkg records to the cust_bill_pkgs we will commit
762 my %packagemap = map { $_->pkgnum => $_ } @$cust_bill_pkg;
763 foreach my $tax ( keys %$taxlisthash ) {
764 foreach ( @{ $taxlisthash->{$tax} }[1 ... scalar(@{ $taxlisthash->{$tax} })] ) {
765 next unless ref($_) eq 'FS::cust_bill_pkg';
767 my @cust_tax_exempt_pkg = splice( @{ $_->_cust_tax_exempt_pkg } );
769 next unless @cust_tax_exempt_pkg; #just avoiding the prob when irrelevant?
770 die "can't distribute tax exemptions: no line item for ". Dumper($_).
771 " in packagemap ". join(',', sort {$a<=>$b} keys %packagemap). "\n"
772 unless $packagemap{$_->pkgnum};
774 push @{ $packagemap{$_->pkgnum}->_cust_tax_exempt_pkg },
775 @cust_tax_exempt_pkg;
779 #consolidate and create tax line items
780 warn "consolidating and generating...\n" if $DEBUG > 2;
781 foreach my $taxname ( keys %taxname ) {
784 my @cust_bill_pkg_tax_location = ();
785 my @cust_bill_pkg_tax_rate_location = ();
786 warn "adding $taxname\n" if $DEBUG > 1;
787 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
788 next if $seen{$taxitem}++;
789 warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
790 $tax += $tax{$taxitem};
791 push @cust_bill_pkg_tax_location,
792 map { new FS::cust_bill_pkg_tax_location $_ }
793 @{ $tax_location{ $taxitem } };
794 push @cust_bill_pkg_tax_rate_location,
795 map { new FS::cust_bill_pkg_tax_rate_location $_ }
796 @{ $tax_rate_location{ $taxitem } };
800 $tax = sprintf('%.2f', $tax );
802 my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
808 if ( $pkg_category and
809 $conf->config('invoice_latexsummary') ||
810 $conf->config('invoice_htmlsummary')
814 my %hash = ( 'section' => $pkg_category->categoryname );
815 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
819 push @tax_line_items, new FS::cust_bill_pkg {
825 'itemdesc' => $taxname,
826 'display' => \@display,
827 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
828 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
837 my ($self, %params) = @_;
839 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
841 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
842 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
843 my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
844 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
845 my $total_setup = $params{setup} or die "no setup accumulator specified";
846 my $total_recur = $params{recur} or die "no recur accumulator specified";
847 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
848 my $time = $params{'time'} or die "no time specified";
849 my (%options) = %{$params{options}};
851 if ( $part_pkg->freq ne '1' and ($options{'freq_override'} || 0) > 0 ) {
852 # this should never happen
853 die 'freq_override billing attempted on non-monthly package '.
858 my $real_pkgpart = $params{real_pkgpart};
859 my %hash = $cust_pkg->hash;
860 my $old_cust_pkg = new FS::cust_pkg \%hash;
865 $cust_pkg->pkgpart($part_pkg->pkgpart);
873 my @setup_discounts = ();
874 my %setup_param = ( 'discounts' => \@setup_discounts );
875 if ( ! $options{recurring_only}
876 and ! $options{cancel}
877 and ( $options{'resetup'}
878 || ( ! $cust_pkg->setup
879 && ( ! $cust_pkg->start_date
880 || $cust_pkg->start_date <= day_end($time)
882 && ( ! $conf->exists('disable_setup_suspended_pkgs')
883 || ( $conf->exists('disable_setup_suspended_pkgs') &&
884 ! $cust_pkg->getfield('susp')
892 warn " bill setup\n" if $DEBUG > 1;
894 unless ( $cust_pkg->waive_setup ) {
897 $setup = eval { $cust_pkg->calc_setup( $time, \@details, \%setup_param ) };
898 return "$@ running calc_setup for $cust_pkg\n"
901 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
904 $cust_pkg->setfield('setup', $time)
905 unless $cust_pkg->setup;
906 #do need it, but it won't get written to the db
907 #|| $cust_pkg->pkgpart != $real_pkgpart;
909 $cust_pkg->setfield('start_date', '')
910 if $cust_pkg->start_date;
918 #XXX unit stuff here too
921 my @recur_discounts = ();
923 if ( ! $cust_pkg->start_date
924 and ( ! $cust_pkg->susp || $part_pkg->option('suspend_bill', 1) )
926 ( $part_pkg->freq ne '0' && ( $cust_pkg->bill || 0 ) <= day_end($time) )
927 || ( $part_pkg->plan eq 'voip_cdr'
928 && $part_pkg->option('bill_every_call')
933 # XXX should this be a package event? probably. events are called
934 # at collection time at the moment, though...
935 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
936 if $part_pkg->can('reset_usage') && !$options{'no_usage_reset'};
937 #don't want to reset usage just cause we want a line item??
938 #&& $part_pkg->pkgpart == $real_pkgpart;
940 warn " bill recur\n" if $DEBUG > 1;
943 # XXX shared with $recur_prog
944 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
948 #over two params! lets at least switch to a hashref for the rest...
949 my $increment_next_bill = ( $part_pkg->freq ne '0'
950 && ( $cust_pkg->getfield('bill') || 0 ) <= day_end($time)
953 my %param = ( %setup_param,
954 'precommit_hooks' => $precommit_hooks,
955 'increment_next_bill' => $increment_next_bill,
956 'discounts' => \@recur_discounts,
957 'real_pkgpart' => $real_pkgpart,
958 'freq_override' => $options{freq_override} || '',
962 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
964 # There may be some part_pkg for which this is wrong. Only those
965 # which can_discount are supported.
966 # (the UI should prevent adding discounts to these at the moment)
968 warn "calling $method on cust_pkg ". $cust_pkg->pkgnum.
969 " for pkgpart ". $cust_pkg->pkgpart.
970 " with params ". join(' / ', map "$_=>$param{$_}", keys %param). "\n"
973 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
974 return "$@ running $method for $cust_pkg\n"
977 if ( $increment_next_bill ) {
979 my $next_bill = $part_pkg->add_freq($sdate, $options{freq_override} || 0);
980 return "unparsable frequency: ". $part_pkg->freq
983 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
984 # only for figuring next bill date, nothing else, so, reset $sdate again
986 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
987 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
988 $cust_pkg->last_bill($sdate);
990 $cust_pkg->setfield('bill', $next_bill );
994 if ( $param{'setup_fee'} ) {
995 # Add an additional setup fee at the billing stage.
996 # Used for prorate_defer_bill.
997 $setup += $param{'setup_fee'};
998 $unitsetup += $param{'setup_fee'};
1002 if ( defined $param{'discount_left_setup'} ) {
1003 foreach my $discount_setup ( values %{$param{'discount_left_setup'}} ) {
1004 $setup -= $discount_setup;
1010 warn "\$setup is undefined" unless defined($setup);
1011 warn "\$recur is undefined" unless defined($recur);
1012 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1015 # If there's line items, create em cust_bill_pkg records
1016 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
1021 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
1022 # hmm.. and if just the options are modified in some weird price plan?
1024 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
1027 my $error = $cust_pkg->replace( $old_cust_pkg,
1028 'depend_jobnum'=>$options{depend_jobnum},
1029 'options' => { $cust_pkg->options },
1031 unless $options{no_commit};
1032 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
1033 if $error; #just in case
1036 $setup = sprintf( "%.2f", $setup );
1037 $recur = sprintf( "%.2f", $recur );
1038 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
1039 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1041 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
1042 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
1045 my $discount_show_always = $conf->exists('discount-show-always')
1046 && ( ($setup == 0 && scalar(@setup_discounts))
1047 || ($recur == 0 && scalar(@recur_discounts))
1052 || (!$part_pkg->hidden && $options{has_hidden}) #include some $0 lines
1053 || $discount_show_always
1054 || ($setup == 0 && $cust_pkg->_X_show_zero('setup'))
1055 || ($recur == 0 && $cust_pkg->_X_show_zero('recur'))
1059 warn " charges (setup=$setup, recur=$recur); adding line items\n"
1062 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
1064 warn " adding customer package invoice detail: $_\n"
1065 foreach @cust_pkg_detail;
1067 push @details, @cust_pkg_detail;
1069 my $cust_bill_pkg = new FS::cust_bill_pkg {
1070 'pkgnum' => $cust_pkg->pkgnum,
1072 'unitsetup' => $unitsetup,
1074 'unitrecur' => $unitrecur,
1075 'quantity' => $cust_pkg->quantity,
1076 'details' => \@details,
1077 'discounts' => [ @setup_discounts, @recur_discounts ],
1078 'hidden' => $part_pkg->hidden,
1079 'freq' => $part_pkg->freq,
1082 if ( $part_pkg->recur_temporality eq 'preceding' ) {
1083 $cust_bill_pkg->sdate( $hash{last_bill} );
1084 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
1085 $cust_bill_pkg->edate( $time ) if $options{cancel};
1086 } else { #if ( $part_pkg->recur_temporality eq 'upcoming' ) {
1087 $cust_bill_pkg->sdate( $sdate );
1088 $cust_bill_pkg->edate( $cust_pkg->bill );
1089 #$cust_bill_pkg->edate( $time ) if $options{cancel};
1092 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
1093 unless $part_pkg->pkgpart == $real_pkgpart;
1095 $$total_setup += $setup;
1096 $$total_recur += $recur;
1102 unless ( $discount_show_always ) {
1104 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart, \%options);
1105 return $error if $error;
1108 push @$cust_bill_pkgs, $cust_bill_pkg;
1110 } #if $setup != 0 || $recur != 0
1120 my $part_pkg = shift;
1121 my $taxlisthash = shift;
1122 my $cust_bill_pkg = shift;
1123 my $cust_pkg = shift;
1124 my $invoice_time = shift;
1125 my $real_pkgpart = shift;
1126 my $options = shift;
1128 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1130 my %cust_bill_pkg = ();
1134 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
1135 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
1136 push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
1137 push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
1139 if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
1141 if ( $conf->exists('enable_taxproducts')
1142 && ( scalar($part_pkg->part_pkg_taxoverride)
1143 || $part_pkg->has_taxproduct
1148 foreach my $class (@classes) {
1149 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class, $cust_pkg );
1150 return $err_or_ref unless ref($err_or_ref);
1151 $taxes{$class} = $err_or_ref;
1154 unless (exists $taxes{''}) {
1155 my $err_or_ref = $self->_gather_taxes( $part_pkg, '', $cust_pkg );
1156 return $err_or_ref unless ref($err_or_ref);
1157 $taxes{''} = $err_or_ref;
1162 my @loc_keys = qw( city county state country );
1164 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1165 my $cust_location = $cust_pkg->cust_location;
1166 %taxhash = map { $_ => $cust_location->$_() } @loc_keys;
1169 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
1172 %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
1175 $taxhash{'taxclass'} = $part_pkg->taxclass;
1178 my %taxhash_elim = %taxhash;
1179 my @elim = qw( city county state );
1182 #first try a match with taxclass
1183 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1185 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1186 #then try a match without taxclass
1187 my %no_taxclass = %taxhash_elim;
1188 $no_taxclass{ 'taxclass' } = '';
1189 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1192 $taxhash_elim{ shift(@elim) } = '';
1194 } while ( !scalar(@taxes) && scalar(@elim) );
1196 @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
1198 if $self->cust_main_exemption; #just to be safe
1200 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1202 $_->set('pkgnum', $cust_pkg->pkgnum );
1203 $_->set('locationnum', $cust_pkg->locationnum );
1207 $taxes{''} = [ @taxes ];
1208 $taxes{'setup'} = [ @taxes ];
1209 $taxes{'recur'} = [ @taxes ];
1210 $taxes{$_} = [ @taxes ] foreach (@classes);
1212 # # maybe eliminate this entirely, along with all the 0% records
1213 # unless ( @taxes ) {
1215 # "fatal: can't find tax rate for state/county/country/taxclass ".
1216 # join('/', map $taxhash{$_}, qw(state county country taxclass) );
1219 } #if $conf->exists('enable_taxproducts') ...
1223 #what's this doing in the middle of _handle_taxes? probably should split
1224 #this into three parts above in _make_lines
1225 $cust_bill_pkg->set_display( part_pkg => $part_pkg,
1226 real_pkgpart => $real_pkgpart,
1229 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
1230 foreach my $key (keys %tax_cust_bill_pkg) {
1231 my @taxes = @{ $taxes{$key} || [] };
1232 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
1234 my %localtaxlisthash = ();
1235 foreach my $tax ( @taxes ) {
1237 my $taxname = ref( $tax ). ' '. $tax->taxnum;
1238 # $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
1239 # ' locationnum'. $cust_pkg->locationnum
1240 # if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
1242 $taxlisthash->{ $taxname } ||= [ $tax ];
1243 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
1245 $localtaxlisthash{ $taxname } ||= [ $tax ];
1246 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
1250 warn "finding taxed taxes...\n" if $DEBUG > 2;
1251 foreach my $tax ( keys %localtaxlisthash ) {
1252 my $tax_object = shift @{ $localtaxlisthash{$tax} };
1253 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
1255 next unless $tax_object->can('tax_on_tax');
1257 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
1258 my $totname = ref( $tot ). ' '. $tot->taxnum;
1260 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
1262 next unless exists( $localtaxlisthash{ $totname } ); # only increase
1264 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
1265 my $hashref_or_error =
1266 $tax_object->taxline( $localtaxlisthash{$tax},
1267 'custnum' => $self->custnum,
1268 'invoice_time' => $invoice_time,
1270 return $hashref_or_error
1271 unless ref($hashref_or_error);
1273 $taxlisthash->{ $totname } ||= [ $tot ];
1274 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
1286 my $part_pkg = shift;
1288 my $cust_pkg = shift;
1290 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1293 if ( $cust_pkg->locationnum && $conf->exists('tax-pkg_address') ) {
1294 $geocode = $cust_pkg->cust_location->geocode('cch');
1296 $geocode = $self->geocode('cch');
1301 my @taxclassnums = map { $_->taxclassnum }
1302 $part_pkg->part_pkg_taxoverride($class);
1304 unless (@taxclassnums) {
1305 @taxclassnums = map { $_->taxclassnum }
1306 grep { $_->taxable eq 'Y' }
1307 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
1309 warn "Found taxclassnum values of ". join(',', @taxclassnums)
1314 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
1316 @taxes = qsearch({ 'table' => 'tax_rate',
1317 'hashref' => { 'geocode' => $geocode, },
1318 'extra_sql' => $extra_sql,
1320 if scalar(@taxclassnums);
1322 warn "Found taxes ".
1323 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
1330 =item collect [ HASHREF | OPTION => VALUE ... ]
1332 (Attempt to) collect money for this customer's outstanding invoices (see
1333 L<FS::cust_bill>). Usually used after the bill method.
1335 Actions are now triggered by billing events; see L<FS::part_event> and the
1336 billing events web interface. Old-style invoice events (see
1337 L<FS::part_bill_event>) have been deprecated.
1339 If there is an error, returns the error, otherwise returns false.
1341 Options are passed as name-value pairs.
1343 Currently available options are:
1349 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.
1353 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1357 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1361 set true to surpress email card/ACH decline notices.
1365 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)
1371 # allows for one time override of normal customer billing method
1376 my( $self, %options ) = @_;
1378 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1380 my $invoice_time = $options{'invoice_time'} || time;
1383 local $SIG{HUP} = 'IGNORE';
1384 local $SIG{INT} = 'IGNORE';
1385 local $SIG{QUIT} = 'IGNORE';
1386 local $SIG{TERM} = 'IGNORE';
1387 local $SIG{TSTP} = 'IGNORE';
1388 local $SIG{PIPE} = 'IGNORE';
1390 my $oldAutoCommit = $FS::UID::AutoCommit;
1391 local $FS::UID::AutoCommit = 0;
1394 $self->select_for_update; #mutex
1397 my $balance = $self->balance;
1398 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
1401 if ( exists($options{'retry_card'}) ) {
1402 carp 'retry_card option passed to collect is deprecated; use retry';
1403 $options{'retry'} ||= $options{'retry_card'};
1405 if ( exists($options{'retry'}) && $options{'retry'} ) {
1406 my $error = $self->retry_realtime;
1408 $dbh->rollback if $oldAutoCommit;
1413 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1415 #never want to roll back an event just because it returned an error
1416 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1418 $self->do_cust_event(
1419 'debug' => ( $options{'debug'} || 0 ),
1420 'time' => $invoice_time,
1421 'check_freq' => $options{'check_freq'},
1422 'stage' => 'collect',
1427 =item retry_realtime
1429 Schedules realtime / batch credit card / electronic check / LEC billing
1430 events for for retry. Useful if card information has changed or manual
1431 retry is desired. The 'collect' method must be called to actually retry
1434 Implementation details: For either this customer, or for each of this
1435 customer's open invoices, changes the status of the first "done" (with
1436 statustext error) realtime processing event to "failed".
1440 sub retry_realtime {
1443 local $SIG{HUP} = 'IGNORE';
1444 local $SIG{INT} = 'IGNORE';
1445 local $SIG{QUIT} = 'IGNORE';
1446 local $SIG{TERM} = 'IGNORE';
1447 local $SIG{TSTP} = 'IGNORE';
1448 local $SIG{PIPE} = 'IGNORE';
1450 my $oldAutoCommit = $FS::UID::AutoCommit;
1451 local $FS::UID::AutoCommit = 0;
1454 #a little false laziness w/due_cust_event (not too bad, really)
1456 my $join = FS::part_event_condition->join_conditions_sql;
1457 my $order = FS::part_event_condition->order_conditions_sql;
1460 . join ( ' OR ' , map {
1461 "( part_event.eventtable = " . dbh->quote($_)
1462 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
1463 } FS::part_event->eventtables)
1466 #here is the agent virtualization
1467 my $agent_virt = " ( part_event.agentnum IS NULL
1468 OR part_event.agentnum = ". $self->agentnum. ' )';
1470 #XXX this shouldn't be hardcoded, actions should declare it...
1471 my @realtime_events = qw(
1472 cust_bill_realtime_card
1473 cust_bill_realtime_check
1474 cust_bill_realtime_lec
1478 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
1483 my @cust_event = qsearchs({
1484 'table' => 'cust_event',
1485 'select' => 'cust_event.*',
1486 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
1487 'hashref' => { 'status' => 'done' },
1488 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
1489 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
1492 my %seen_invnum = ();
1493 foreach my $cust_event (@cust_event) {
1495 #max one for the customer, one for each open invoice
1496 my $cust_X = $cust_event->cust_X;
1497 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
1501 or $cust_event->part_event->eventtable eq 'cust_bill'
1504 my $error = $cust_event->retry;
1506 $dbh->rollback if $oldAutoCommit;
1507 return "error scheduling event for retry: $error";
1512 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1517 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
1519 Runs billing events; see L<FS::part_event> and the billing events web
1522 If there is an error, returns the error, otherwise returns false.
1524 Options are passed as name-value pairs.
1526 Currently available options are:
1532 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.
1536 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1540 "collect" (the default) or "pre-bill"
1544 set true to surpress email card/ACH decline notices.
1548 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)
1555 # allows for one time override of normal customer billing method
1559 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1562 my( $self, %options ) = @_;
1564 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1566 my $time = $options{'time'} || time;
1569 local $SIG{HUP} = 'IGNORE';
1570 local $SIG{INT} = 'IGNORE';
1571 local $SIG{QUIT} = 'IGNORE';
1572 local $SIG{TERM} = 'IGNORE';
1573 local $SIG{TSTP} = 'IGNORE';
1574 local $SIG{PIPE} = 'IGNORE';
1576 my $oldAutoCommit = $FS::UID::AutoCommit;
1577 local $FS::UID::AutoCommit = 0;
1580 $self->select_for_update; #mutex
1583 my $balance = $self->balance;
1584 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
1587 # if ( exists($options{'retry_card'}) ) {
1588 # carp 'retry_card option passed to collect is deprecated; use retry';
1589 # $options{'retry'} ||= $options{'retry_card'};
1591 # if ( exists($options{'retry'}) && $options{'retry'} ) {
1592 # my $error = $self->retry_realtime;
1594 # $dbh->rollback if $oldAutoCommit;
1599 # false laziness w/pay_batch::import_results
1601 my $due_cust_event = $self->due_cust_event(
1602 'debug' => ( $options{'debug'} || 0 ),
1604 'check_freq' => $options{'check_freq'},
1605 'stage' => ( $options{'stage'} || 'collect' ),
1607 unless( ref($due_cust_event) ) {
1608 $dbh->rollback if $oldAutoCommit;
1609 return $due_cust_event;
1612 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1613 #never want to roll back an event just because it or a different one
1615 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1617 foreach my $cust_event ( @$due_cust_event ) {
1621 #re-eval event conditions (a previous event could have changed things)
1622 unless ( $cust_event->test_conditions( 'time' => $time ) ) {
1623 #don't leave stray "new/locked" records around
1624 my $error = $cust_event->delete;
1625 return $error if $error;
1630 local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
1631 if $options{'quiet'};
1632 warn " running cust_event ". $cust_event->eventnum. "\n"
1635 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
1636 if ( my $error = $cust_event->do_event( 'time' => $time ) ) {
1637 #XXX wtf is this? figure out a proper dealio with return value
1649 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
1651 Inserts database records for and returns an ordered listref of new events due
1652 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
1653 events are due, an empty listref is returned. If there is an error, returns a
1654 scalar error message.
1656 To actually run the events, call each event's test_condition method, and if
1657 still true, call the event's do_event method.
1659 Options are passed as a hashref or as a list of name-value pairs. Available
1666 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.
1670 "collect" (the default) or "pre-bill"
1674 "Current time" for the events.
1678 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)
1682 Only return events for the specified eventtable (by default, events of all eventtables are returned)
1686 Explicitly pass the objects to be tested (typically used with eventtable).
1690 Set to true to return the objects, but not actually insert them into the
1697 sub due_cust_event {
1699 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
1702 #my $DEBUG = $opt{'debug'}
1703 local($DEBUG) = $opt{'debug'}
1704 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
1705 $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1707 warn "$me due_cust_event called with options ".
1708 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
1711 $opt{'time'} ||= time;
1713 local $SIG{HUP} = 'IGNORE';
1714 local $SIG{INT} = 'IGNORE';
1715 local $SIG{QUIT} = 'IGNORE';
1716 local $SIG{TERM} = 'IGNORE';
1717 local $SIG{TSTP} = 'IGNORE';
1718 local $SIG{PIPE} = 'IGNORE';
1720 my $oldAutoCommit = $FS::UID::AutoCommit;
1721 local $FS::UID::AutoCommit = 0;
1724 $self->select_for_update #mutex
1725 unless $opt{testonly};
1728 # find possible events (initial search)
1731 my @cust_event = ();
1733 my @eventtable = $opt{'eventtable'}
1734 ? ( $opt{'eventtable'} )
1735 : FS::part_event->eventtables_runorder;
1737 my $check_freq = $opt{'check_freq'} || '1d';
1739 foreach my $eventtable ( @eventtable ) {
1742 if ( $opt{'objects'} ) {
1744 @objects = @{ $opt{'objects'} };
1748 #my @objects = $self->$eventtable(); # sub cust_main { @{ [ $self ] }; }
1749 if ( $eventtable eq 'cust_main' ) {
1750 @objects = ( $self );
1754 "LEFT JOIN cust_main USING ( custnum )";
1756 #some false laziness w/Cron::bill bill_where
1758 my $join = FS::part_event_condition->join_conditions_sql( $eventtable);
1759 my $where = FS::part_event_condition->where_conditions_sql($eventtable,
1760 'time'=>$opt{'time'},
1762 $where = $where ? "AND $where" : '';
1764 my $are_part_event =
1765 "EXISTS ( SELECT 1 FROM part_event $join
1766 WHERE check_freq = '$check_freq'
1767 AND eventtable = '$eventtable'
1768 AND ( disabled = '' OR disabled IS NULL )
1774 @objects = $self->$eventtable(
1775 'addl_from' => $cm_join,
1776 'extra_sql' => " AND $are_part_event",
1782 my @e_cust_event = ();
1784 my $cross = "CROSS JOIN $eventtable";
1785 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
1786 unless $eventtable eq 'cust_main';
1788 foreach my $object ( @objects ) {
1790 #this first search uses the condition_sql magic for optimization.
1791 #the more possible events we can eliminate in this step the better
1793 my $cross_where = '';
1794 my $pkey = $object->primary_key;
1795 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
1797 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
1799 FS::part_event_condition->where_conditions_sql( $eventtable,
1800 'time'=>$opt{'time'}
1802 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
1804 $extra_sql = "AND $extra_sql" if $extra_sql;
1806 #here is the agent virtualization
1807 $extra_sql .= " AND ( part_event.agentnum IS NULL
1808 OR part_event.agentnum = ". $self->agentnum. ' )';
1810 $extra_sql .= " $order";
1812 warn "searching for events for $eventtable ". $object->$pkey. "\n"
1813 if $opt{'debug'} > 2;
1814 my @part_event = qsearch( {
1815 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
1816 'select' => 'part_event.*',
1817 'table' => 'part_event',
1818 'addl_from' => "$cross $join",
1819 'hashref' => { 'check_freq' => $check_freq,
1820 'eventtable' => $eventtable,
1823 'extra_sql' => "AND $cross_where $extra_sql",
1827 my $pkey = $object->primary_key;
1828 warn " ". scalar(@part_event).
1829 " possible events found for $eventtable ". $object->$pkey(). "\n";
1832 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
1836 warn " ". scalar(@e_cust_event).
1837 " subtotal possible cust events found for $eventtable\n"
1840 push @cust_event, @e_cust_event;
1844 warn " ". scalar(@cust_event).
1845 " total possible cust events found in initial search\n"
1853 $opt{stage} ||= 'collect';
1855 grep { my $stage = $_->part_event->event_stage;
1856 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
1866 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
1867 'stats_hashref' => \%unsat ),
1870 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
1873 warn " invalid conditions not eliminated with condition_sql:\n".
1874 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
1875 if keys %unsat && $DEBUG; # > 1;
1881 unless( $opt{testonly} ) {
1882 foreach my $cust_event ( @cust_event ) {
1884 my $error = $cust_event->insert();
1886 $dbh->rollback if $oldAutoCommit;
1893 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1899 warn " returning events: ". Dumper(@cust_event). "\n"
1906 =item apply_payments_and_credits [ OPTION => VALUE ... ]
1908 Applies unapplied payments and credits.
1910 In most cases, this new method should be used in place of sequential
1911 apply_payments and apply_credits methods.
1913 A hash of optional arguments may be passed. Currently "manual" is supported.
1914 If true, a payment receipt is sent instead of a statement when
1915 'payment_receipt_email' configuration option is set.
1917 If there is an error, returns the error, otherwise returns false.
1921 sub apply_payments_and_credits {
1922 my( $self, %options ) = @_;
1924 local $SIG{HUP} = 'IGNORE';
1925 local $SIG{INT} = 'IGNORE';
1926 local $SIG{QUIT} = 'IGNORE';
1927 local $SIG{TERM} = 'IGNORE';
1928 local $SIG{TSTP} = 'IGNORE';
1929 local $SIG{PIPE} = 'IGNORE';
1931 my $oldAutoCommit = $FS::UID::AutoCommit;
1932 local $FS::UID::AutoCommit = 0;
1935 $self->select_for_update; #mutex
1937 foreach my $cust_bill ( $self->open_cust_bill ) {
1938 my $error = $cust_bill->apply_payments_and_credits(%options);
1940 $dbh->rollback if $oldAutoCommit;
1941 return "Error applying: $error";
1945 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1950 =item apply_credits OPTION => VALUE ...
1952 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
1953 to outstanding invoice balances in chronological order (or reverse
1954 chronological order if the I<order> option is set to B<newest>) and returns the
1955 value of any remaining unapplied credits available for refund (see
1956 L<FS::cust_refund>).
1958 Dies if there is an error.
1966 local $SIG{HUP} = 'IGNORE';
1967 local $SIG{INT} = 'IGNORE';
1968 local $SIG{QUIT} = 'IGNORE';
1969 local $SIG{TERM} = 'IGNORE';
1970 local $SIG{TSTP} = 'IGNORE';
1971 local $SIG{PIPE} = 'IGNORE';
1973 my $oldAutoCommit = $FS::UID::AutoCommit;
1974 local $FS::UID::AutoCommit = 0;
1977 $self->select_for_update; #mutex
1979 unless ( $self->total_unapplied_credits ) {
1980 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1984 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
1985 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
1987 my @invoices = $self->open_cust_bill;
1988 @invoices = sort { $b->_date <=> $a->_date } @invoices
1989 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
1991 if ( $conf->exists('pkg-balances') ) {
1992 # limit @credits to those w/ a pkgnum grepped from $self
1994 foreach my $i (@invoices) {
1995 foreach my $li ( $i->cust_bill_pkg ) {
1996 $pkgnums{$li->pkgnum} = 1;
1999 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
2004 foreach my $cust_bill ( @invoices ) {
2006 if ( !defined($credit) || $credit->credited == 0) {
2007 $credit = pop @credits or last;
2011 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
2012 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
2014 $owed = $cust_bill->owed;
2016 unless ( $owed > 0 ) {
2017 push @credits, $credit;
2021 my $amount = min( $credit->credited, $owed );
2023 my $cust_credit_bill = new FS::cust_credit_bill ( {
2024 'crednum' => $credit->crednum,
2025 'invnum' => $cust_bill->invnum,
2026 'amount' => $amount,
2028 $cust_credit_bill->pkgnum( $credit->pkgnum )
2029 if $conf->exists('pkg-balances') && $credit->pkgnum;
2030 my $error = $cust_credit_bill->insert;
2032 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2036 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2040 my $total_unapplied_credits = $self->total_unapplied_credits;
2042 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2044 return $total_unapplied_credits;
2047 =item apply_payments [ OPTION => VALUE ... ]
2049 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2050 to outstanding invoice balances in chronological order.
2052 #and returns the value of any remaining unapplied payments.
2054 A hash of optional arguments may be passed. Currently "manual" is supported.
2055 If true, a payment receipt is sent instead of a statement when
2056 'payment_receipt_email' configuration option is set.
2058 Dies if there is an error.
2062 sub apply_payments {
2063 my( $self, %options ) = @_;
2065 local $SIG{HUP} = 'IGNORE';
2066 local $SIG{INT} = 'IGNORE';
2067 local $SIG{QUIT} = 'IGNORE';
2068 local $SIG{TERM} = 'IGNORE';
2069 local $SIG{TSTP} = 'IGNORE';
2070 local $SIG{PIPE} = 'IGNORE';
2072 my $oldAutoCommit = $FS::UID::AutoCommit;
2073 local $FS::UID::AutoCommit = 0;
2076 $self->select_for_update; #mutex
2080 my @payments = sort { $b->_date <=> $a->_date }
2081 grep { $_->unapplied > 0 }
2084 my @invoices = sort { $a->_date <=> $b->_date}
2085 grep { $_->owed > 0 }
2088 if ( $conf->exists('pkg-balances') ) {
2089 # limit @payments to those w/ a pkgnum grepped from $self
2091 foreach my $i (@invoices) {
2092 foreach my $li ( $i->cust_bill_pkg ) {
2093 $pkgnums{$li->pkgnum} = 1;
2096 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
2101 foreach my $cust_bill ( @invoices ) {
2103 if ( !defined($payment) || $payment->unapplied == 0 ) {
2104 $payment = pop @payments or last;
2108 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
2109 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
2111 $owed = $cust_bill->owed;
2113 unless ( $owed > 0 ) {
2114 push @payments, $payment;
2118 my $amount = min( $payment->unapplied, $owed );
2121 'paynum' => $payment->paynum,
2122 'invnum' => $cust_bill->invnum,
2123 'amount' => $amount,
2125 $cbp->{_date} = $payment->_date
2126 if $options{'manual'} && $options{'backdate_application'};
2127 my $cust_bill_pay = new FS::cust_bill_pay($cbp);
2128 $cust_bill_pay->pkgnum( $payment->pkgnum )
2129 if $conf->exists('pkg-balances') && $payment->pkgnum;
2130 my $error = $cust_bill_pay->insert(%options);
2132 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2136 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2140 my $total_unapplied_payments = $self->total_unapplied_payments;
2142 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2144 return $total_unapplied_payments;
2154 suspend_adjourned_pkgs
2157 (do_cust_event pre-bill)
2160 (vendor-only) _gather_taxes
2161 _omit_zero_value_bundles
2164 apply_payments_and_credits
2173 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>