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;
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( $self->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( $self->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;
169 # XXX: sometimes "incorrect" if crossing DST boundaries?
174 return $time unless $conf->exists('next-bill-ignore-time');
176 my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) =
178 mktime(59,59,23,$mday,$mon,$year,$wday,$yday,$isdst);
181 sub cancel_expired_pkgs {
182 my ( $self, $time, %options ) = @_;
184 my @cancel_pkgs = $self->ncancelled_pkgs( {
185 'extra_sql' => " AND expire IS NOT NULL AND expire > 0 AND expire <= $time "
190 foreach my $cust_pkg ( @cancel_pkgs ) {
191 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
192 my $error = $cust_pkg->cancel($cpr ? ( 'reason' => $cpr->reasonnum,
193 'reason_otaker' => $cpr->otaker
197 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
200 scalar(@errors) ? join(' / ', @errors) : '';
204 sub suspend_adjourned_pkgs {
205 my ( $self, $time, %options ) = @_;
207 my @susp_pkgs = $self->ncancelled_pkgs( {
209 " AND ( susp IS NULL OR susp = 0 )
210 AND ( ( bill IS NOT NULL AND bill != 0 AND bill < $time )
211 OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
216 #only because there's no SQL test for is_prepaid :/
218 grep { ( $_->part_pkg->is_prepaid
223 && $_->adjourn <= $time
231 foreach my $cust_pkg ( @susp_pkgs ) {
232 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
233 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
234 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
235 'reason_otaker' => $cpr->otaker
239 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
242 scalar(@errors) ? join(' / ', @errors) : '';
248 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
249 conjunction with the collect method by calling B<bill_and_collect>.
251 If there is an error, returns the error, otherwise returns false.
253 Options are passed as name-value pairs. Currently available options are:
259 If set true, re-charges setup fees.
263 If set true then only bill recurring charges, not setup, usage, one time
268 If set, then override the normal frequency and look for a part_pkg_discount
269 to take at that frequency.
273 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:
277 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
281 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
283 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
287 A hashref of pkgparts to exclude from this billing run (can also be specified as a comma-separated scalar).
291 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.
295 This boolean value informs the us that the package is being cancelled. This
296 typically might mean not charging the normal recurring fee but only usage
297 fees since the last billing. Setup charges may be charged. Not all package
298 plans support this feature (they tend to charge 0).
302 Prevent the resetting of usage limits during this call.
306 Do not save the generated bill in the database. Useful with return_bill
310 A list reference on which the generated bill(s) will be returned.
314 Optional terms to be printed on this invoice. Otherwise, customer-specific
315 terms or the default terms are used.
322 my( $self, %options ) = @_;
324 return '' if $self->payby eq 'COMP';
326 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
328 warn "$me bill customer ". $self->custnum. "\n"
331 my $time = $options{'time'} || time;
332 my $invoice_time = $options{'invoice_time'} || $time;
334 $options{'not_pkgpart'} ||= {};
335 $options{'not_pkgpart'} = { map { $_ => 1 }
336 split(/\s*,\s*/, $options{'not_pkgpart'})
338 unless ref($options{'not_pkgpart'});
340 local $SIG{HUP} = 'IGNORE';
341 local $SIG{INT} = 'IGNORE';
342 local $SIG{QUIT} = 'IGNORE';
343 local $SIG{TERM} = 'IGNORE';
344 local $SIG{TSTP} = 'IGNORE';
345 local $SIG{PIPE} = 'IGNORE';
347 my $oldAutoCommit = $FS::UID::AutoCommit;
348 local $FS::UID::AutoCommit = 0;
351 warn "$me acquiring lock on customer ". $self->custnum. "\n"
354 $self->select_for_update; #mutex
356 warn "$me running pre-bill events for customer ". $self->custnum. "\n"
359 my $error = $self->do_cust_event(
360 'debug' => ( $options{'debug'} || 0 ),
361 'time' => $invoice_time,
362 'check_freq' => $options{'check_freq'},
363 'stage' => 'pre-bill',
365 unless $options{no_commit};
367 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
371 warn "$me done running pre-bill events for customer ". $self->custnum. "\n"
374 #keep auto-charge and non-auto-charge line items separate
375 my @passes = ( '', 'no_auto' );
377 my %cust_bill_pkg = map { $_ => [] } @passes;
380 # find the packages which are due for billing, find out how much they are
381 # & generate invoice database.
384 my %total_setup = map { my $z = 0; $_ => \$z; } @passes;
385 my %total_recur = map { my $z = 0; $_ => \$z; } @passes;
387 my %taxlisthash = map { $_ => {} } @passes;
389 my @precommit_hooks = ();
391 $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ]; #param checks?
392 foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
394 next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
396 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
398 #? to avoid use of uninitialized value errors... ?
399 $cust_pkg->setfield('bill', '')
400 unless defined($cust_pkg->bill);
402 #my $part_pkg = $cust_pkg->part_pkg;
404 my $real_pkgpart = $cust_pkg->pkgpart;
405 my %hash = $cust_pkg->hash;
407 # we could implement this bit as FS::part_pkg::has_hidden, but we already
408 # suffer from performance issues
409 $options{has_hidden} = 0;
410 my @part_pkg = $cust_pkg->part_pkg->self_and_bill_linked;
411 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
413 foreach my $part_pkg ( @part_pkg ) {
415 $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
417 my $pass = ($cust_pkg->no_auto || $part_pkg->no_auto) ? 'no_auto' : '';
419 my $next_bill = $cust_pkg->getfield('bill') || 0;
421 while ( $next_bill <= $time ) {
423 $self->_make_lines( 'part_pkg' => $part_pkg,
424 'cust_pkg' => $cust_pkg,
425 'precommit_hooks' => \@precommit_hooks,
426 'line_items' => $cust_bill_pkg{$pass},
427 'setup' => $total_setup{$pass},
428 'recur' => $total_recur{$pass},
429 'tax_matrix' => $taxlisthash{$pass},
431 'real_pkgpart' => $real_pkgpart,
432 'options' => \%options,
434 # Stop if anything goes wrong, or if we're not incrementing
437 last if ($cust_pkg->getfield('bill') || 0) == $next_bill;
438 $next_bill = $cust_pkg->getfield('bill') || 0;
441 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
445 } #foreach my $part_pkg
447 } #foreach my $cust_pkg
449 #if the customer isn't on an automatic payby, everything can go on a single
451 #if ( $cust_main->payby !~ /^(CARD|CHEK)$/ ) {
452 #merge everything into one list
455 foreach my $pass (@passes) { # keys %cust_bill_pkg ) {
457 my @cust_bill_pkg = _omit_zero_value_bundles(@{ $cust_bill_pkg{$pass} });
459 next unless @cust_bill_pkg; #don't create an invoice w/o line items
461 warn "$me billing pass $pass\n"
462 #.Dumper(\@cust_bill_pkg)."\n"
465 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
466 !$conf->exists('postal_invoice-recurring_only')
470 my $postal_pkg = $self->charge_postal_fee();
471 if ( $postal_pkg && !ref( $postal_pkg ) ) {
473 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
474 return "can't charge postal invoice fee for customer ".
475 $self->custnum. ": $postal_pkg";
477 } elsif ( $postal_pkg ) {
479 my $real_pkgpart = $postal_pkg->pkgpart;
480 # we could implement this bit as FS::part_pkg::has_hidden, but we already
481 # suffer from performance issues
482 $options{has_hidden} = 0;
483 my @part_pkg = $postal_pkg->part_pkg->self_and_bill_linked;
484 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
486 foreach my $part_pkg ( @part_pkg ) {
487 my %postal_options = %options;
488 delete $postal_options{cancel};
490 $self->_make_lines( 'part_pkg' => $part_pkg,
491 'cust_pkg' => $postal_pkg,
492 'precommit_hooks' => \@precommit_hooks,
493 'line_items' => \@cust_bill_pkg,
494 'setup' => $total_setup{$pass},
495 'recur' => $total_recur{$pass},
496 'tax_matrix' => $taxlisthash{$pass},
498 'real_pkgpart' => $real_pkgpart,
499 'options' => \%postal_options,
502 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
507 # it's silly to have a zero value postal_pkg, but....
508 @cust_bill_pkg = _omit_zero_value_bundles(@cust_bill_pkg);
514 my $listref_or_error =
515 $self->calculate_taxes( \@cust_bill_pkg, $taxlisthash{$pass}, $invoice_time);
517 unless ( ref( $listref_or_error ) ) {
518 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
519 return $listref_or_error;
522 foreach my $taxline ( @$listref_or_error ) {
523 ${ $total_setup{$pass} } =
524 sprintf('%.2f', ${ $total_setup{$pass} } + $taxline->setup );
525 push @cust_bill_pkg, $taxline;
529 warn "adding tax adjustments...\n" if $DEBUG > 2;
530 foreach my $cust_tax_adjustment (
531 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
537 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
539 my $itemdesc = $cust_tax_adjustment->taxname;
540 $itemdesc = '' if $itemdesc eq 'Tax';
542 push @cust_bill_pkg, new FS::cust_bill_pkg {
548 'itemdesc' => $itemdesc,
549 'itemcomment' => $cust_tax_adjustment->comment,
550 'cust_tax_adjustment' => $cust_tax_adjustment,
551 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
556 my $charged = sprintf('%.2f', ${ $total_setup{$pass} } + ${ $total_recur{$pass} } );
558 my @cust_bill = $self->cust_bill;
559 my $balance = $self->balance;
560 my $previous_balance = scalar(@cust_bill)
561 ? ( $cust_bill[$#cust_bill]->billing_balance || 0 )
564 $previous_balance += $cust_bill[$#cust_bill]->charged
565 if scalar(@cust_bill);
566 #my $balance_adjustments =
567 # sprintf('%.2f', $balance - $prior_prior_balance - $prior_charged);
569 warn "creating the new invoice\n" if $DEBUG;
570 #create the new invoice
571 my $cust_bill = new FS::cust_bill ( {
572 'custnum' => $self->custnum,
573 '_date' => $invoice_time,
574 'charged' => $charged,
575 'billing_balance' => $balance,
576 'previous_balance' => $previous_balance,
577 'invoice_terms' => $options{'invoice_terms'},
578 'cust_bill_pkg' => \@cust_bill_pkg,
580 $error = $cust_bill->insert unless $options{no_commit};
582 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
583 return "can't create invoice for customer #". $self->custnum. ": $error";
585 push @{$options{return_bill}}, $cust_bill if $options{return_bill};
587 } #foreach my $pass ( keys %cust_bill_pkg )
589 foreach my $hook ( @precommit_hooks ) {
592 } unless $options{no_commit};
594 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
595 return "$@ running precommit hook $hook\n";
599 $dbh->commit or die $dbh->errstr if $oldAutoCommit && !$options{no_commit};
604 #discard bundled packages of 0 value
605 sub _omit_zero_value_bundles {
608 my @cust_bill_pkg = ();
609 my @cust_bill_pkg_bundle = ();
611 my $discount_show_always = 0;
613 foreach my $cust_bill_pkg ( @in ) {
615 $discount_show_always = ($cust_bill_pkg->get('discounts')
616 && scalar(@{$cust_bill_pkg->get('discounts')})
617 && $conf->exists('discount-show-always'));
619 warn " pkgnum ". $cust_bill_pkg->pkgnum.
620 " sum $sum, recur_show_zero ". $cust_bill_pkg->recur_show_zero. "\n"
623 if (scalar(@cust_bill_pkg_bundle) && !$cust_bill_pkg->pkgpart_override) {
624 push @cust_bill_pkg, @cust_bill_pkg_bundle
626 || ($sum == 0 && ( $discount_show_always
627 || grep $_->recur_show_zero, @cust_bill_pkg_bundle )
629 @cust_bill_pkg_bundle = ();
633 $sum += $cust_bill_pkg->setup + $cust_bill_pkg->recur;
634 push @cust_bill_pkg_bundle, $cust_bill_pkg;
638 push @cust_bill_pkg, @cust_bill_pkg_bundle
640 || ($sum == 0 && ( $discount_show_always
641 || grep $_->recur_show_zero, @cust_bill_pkg_bundle )
644 warn " _omit_zero_value_bundles: ". scalar(@in).
645 '->'. scalar(@cust_bill_pkg). "\n" #. Dumper(@cust_bill_pkg). "\n"
652 =item calculate_taxes LINEITEMREF TAXHASHREF INVOICE_TIME
654 This is a weird one. Perhaps it should not even be exposed.
656 Generates tax line items (see L<FS::cust_bill_pkg>) for this customer.
657 Usually used internally by bill method B<bill>.
659 If there is an error, returns the error, otherwise returns reference to a
660 list of line items suitable for insertion.
666 An array ref of the line items being billed.
670 A strange beast. The keys to this hash are internal identifiers consisting
671 of the name of the tax object type, a space, and its unique identifier ( e.g.
672 'cust_main_county 23' ). The values of the hash are listrefs. The first
673 item in the list is the tax object. The remaining items are either line
674 items or floating point values (currency amounts).
676 The taxes are calculated on this entity. Calculated exemption records are
677 transferred to the LINEITEMREF items on the assumption that they are related.
683 This specifies the date appearing on the associated invoice. Some
684 jurisdictions (i.e. Texas) have tax exemptions which are date sensitive.
690 sub calculate_taxes {
691 my ($self, $cust_bill_pkg, $taxlisthash, $invoice_time) = @_;
693 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
695 warn "$me calculate_taxes\n"
696 #.Dumper($self, $cust_bill_pkg, $taxlisthash, $invoice_time). "\n"
699 my @tax_line_items = ();
701 # keys are tax names (as printed on invoices / itemdesc )
702 # values are listrefs of taxlisthash keys (internal identifiers)
705 # keys are taxlisthash keys (internal identifiers)
706 # values are (cumulative) amounts
709 # keys are taxlisthash keys (internal identifiers)
710 # values are listrefs of cust_bill_pkg_tax_location hashrefs
711 my %tax_location = ();
713 # keys are taxlisthash keys (internal identifiers)
714 # values are listrefs of cust_bill_pkg_tax_rate_location hashrefs
715 my %tax_rate_location = ();
717 foreach my $tax ( keys %$taxlisthash ) {
718 my $tax_object = shift @{ $taxlisthash->{$tax} };
719 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
720 warn " ". join('/', @{ $taxlisthash->{$tax} } ). "\n" if $DEBUG > 2;
721 my $hashref_or_error =
722 $tax_object->taxline( $taxlisthash->{$tax},
723 'custnum' => $self->custnum,
724 'invoice_time' => $invoice_time
726 return $hashref_or_error unless ref($hashref_or_error);
728 unshift @{ $taxlisthash->{$tax} }, $tax_object;
730 my $name = $hashref_or_error->{'name'};
731 my $amount = $hashref_or_error->{'amount'};
733 #warn "adding $amount as $name\n";
734 $taxname{ $name } ||= [];
735 push @{ $taxname{ $name } }, $tax;
737 $tax{ $tax } += $amount;
739 $tax_location{ $tax } ||= [];
740 if ( $tax_object->get('pkgnum') || $tax_object->get('locationnum') ) {
741 push @{ $tax_location{ $tax } },
743 'taxnum' => $tax_object->taxnum,
744 'taxtype' => ref($tax_object),
745 'pkgnum' => $tax_object->get('pkgnum'),
746 'locationnum' => $tax_object->get('locationnum'),
747 'amount' => sprintf('%.2f', $amount ),
751 $tax_rate_location{ $tax } ||= [];
752 if ( ref($tax_object) eq 'FS::tax_rate' ) {
753 my $taxratelocationnum =
754 $tax_object->tax_rate_location->taxratelocationnum;
755 push @{ $tax_rate_location{ $tax } },
757 'taxnum' => $tax_object->taxnum,
758 'taxtype' => ref($tax_object),
759 'amount' => sprintf('%.2f', $amount ),
760 'locationtaxid' => $tax_object->location,
761 'taxratelocationnum' => $taxratelocationnum,
767 #move the cust_tax_exempt_pkg records to the cust_bill_pkgs we will commit
768 my %packagemap = map { $_->pkgnum => $_ } @$cust_bill_pkg;
769 foreach my $tax ( keys %$taxlisthash ) {
770 foreach ( @{ $taxlisthash->{$tax} }[1 ... scalar(@{ $taxlisthash->{$tax} })] ) {
771 next unless ref($_) eq 'FS::cust_bill_pkg';
773 my @cust_tax_exempt_pkg = splice( @{ $_->_cust_tax_exempt_pkg } );
775 next unless @cust_tax_exempt_pkg; #just avoiding the prob when irrelevant?
776 die "can't distribute tax exemptions: no line item for ". Dumper($_).
777 " in packagemap ". join(',', sort {$a<=>$b} keys %packagemap). "\n"
778 unless $packagemap{$_->pkgnum};
780 push @{ $packagemap{$_->pkgnum}->_cust_tax_exempt_pkg },
781 @cust_tax_exempt_pkg;
785 #consolidate and create tax line items
786 warn "consolidating and generating...\n" if $DEBUG > 2;
787 foreach my $taxname ( keys %taxname ) {
790 my @cust_bill_pkg_tax_location = ();
791 my @cust_bill_pkg_tax_rate_location = ();
792 warn "adding $taxname\n" if $DEBUG > 1;
793 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
794 next if $seen{$taxitem}++;
795 warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
796 $tax += $tax{$taxitem};
797 push @cust_bill_pkg_tax_location,
798 map { new FS::cust_bill_pkg_tax_location $_ }
799 @{ $tax_location{ $taxitem } };
800 push @cust_bill_pkg_tax_rate_location,
801 map { new FS::cust_bill_pkg_tax_rate_location $_ }
802 @{ $tax_rate_location{ $taxitem } };
806 $tax = sprintf('%.2f', $tax );
808 my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
814 if ( $pkg_category and
815 $conf->config('invoice_latexsummary') ||
816 $conf->config('invoice_htmlsummary')
820 my %hash = ( 'section' => $pkg_category->categoryname );
821 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
825 push @tax_line_items, new FS::cust_bill_pkg {
831 'itemdesc' => $taxname,
832 'display' => \@display,
833 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
834 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
843 my ($self, %params) = @_;
845 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
847 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
848 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
849 my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
850 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
851 my $total_setup = $params{setup} or die "no setup accumulator specified";
852 my $total_recur = $params{recur} or die "no recur accumulator specified";
853 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
854 my $time = $params{'time'} or die "no time specified";
855 my (%options) = %{$params{options}};
858 my $real_pkgpart = $params{real_pkgpart};
859 my %hash = $cust_pkg->hash;
860 my $old_cust_pkg = new FS::cust_pkg \%hash;
866 $cust_pkg->pkgpart($part_pkg->pkgpart);
874 my %setup_param = ();
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 <= $self->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
922 if ( ! $cust_pkg->start_date
923 and ( ! $cust_pkg->susp || $part_pkg->option('suspend_bill', 1) )
925 ( $part_pkg->freq ne '0' && ( $cust_pkg->bill || 0 ) <= $self->day_end($time) )
926 || ( $part_pkg->plan eq 'voip_cdr'
927 && $part_pkg->option('bill_every_call')
932 # XXX should this be a package event? probably. events are called
933 # at collection time at the moment, though...
934 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
935 if $part_pkg->can('reset_usage') && !$options{'no_usage_reset'};
936 #don't want to reset usage just cause we want a line item??
937 #&& $part_pkg->pkgpart == $real_pkgpart;
939 warn " bill recur\n" if $DEBUG > 1;
942 # XXX shared with $recur_prog
943 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
947 #over two params! lets at least switch to a hashref for the rest...
948 my $increment_next_bill = ( $part_pkg->freq ne '0'
949 && ( $cust_pkg->getfield('bill') || 0 ) <= $self->day_end($time)
952 my %param = ( 'precommit_hooks' => $precommit_hooks,
953 'increment_next_bill' => $increment_next_bill,
954 'discounts' => \@discounts,
955 'real_pkgpart' => $real_pkgpart,
956 'freq_override' => $options{freq_override} || '',
961 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
963 # There may be some part_pkg for which this is wrong. Only those
964 # which can_discount are supported.
965 # (the UI should prevent adding discounts to these at the moment)
967 warn "calling $method on cust_pkg ". $cust_pkg->pkgnum.
968 " for pkgpart ". $cust_pkg->pkgpart.
969 " with params ". join(' / ', map "$_=>$param{$_}", keys %param). "\n"
972 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
973 return "$@ running $method for $cust_pkg\n"
976 if ( $increment_next_bill ) {
978 my $next_bill = $part_pkg->add_freq($sdate, $options{freq_override} || 0);
979 return "unparsable frequency: ". $part_pkg->freq
982 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
983 # only for figuring next bill date, nothing else, so, reset $sdate again
985 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
986 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
987 $cust_pkg->last_bill($sdate);
989 $cust_pkg->setfield('bill', $next_bill );
993 if ( $param{'setup_fee'} ) {
994 # Add an additional setup fee at the billing stage.
995 # Used for prorate_defer_bill.
996 $setup += $param{'setup_fee'};
997 $unitsetup += $param{'setup_fee'};
1001 if ( defined $param{'discount_left_setup'} ) {
1002 foreach my $discount_setup ( values %{$param{'discount_left_setup'}} ) {
1003 $setup -= $discount_setup;
1009 warn "\$setup is undefined" unless defined($setup);
1010 warn "\$recur is undefined" unless defined($recur);
1011 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1014 # If there's line items, create em cust_bill_pkg records
1015 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
1020 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
1021 # hmm.. and if just the options are modified in some weird price plan?
1023 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
1026 my $error = $cust_pkg->replace( $old_cust_pkg,
1027 'depend_jobnum'=>$options{depend_jobnum},
1028 'options' => { $cust_pkg->options },
1030 unless $options{no_commit};
1031 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
1032 if $error; #just in case
1035 $setup = sprintf( "%.2f", $setup );
1036 $recur = sprintf( "%.2f", $recur );
1037 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
1038 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1040 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
1041 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
1044 my $discount_show_always = ($recur == 0 && scalar(@discounts)
1045 && $conf->exists('discount-show-always'));
1049 || (!$part_pkg->hidden && $options{has_hidden}) #include some $0 lines
1050 || $discount_show_always
1051 || ($recur == 0 && $part_pkg->recur_show_zero)
1055 warn " charges (setup=$setup, recur=$recur); adding line items\n"
1058 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
1060 warn " adding customer package invoice detail: $_\n"
1061 foreach @cust_pkg_detail;
1063 push @details, @cust_pkg_detail;
1065 my $cust_bill_pkg = new FS::cust_bill_pkg {
1066 'pkgnum' => $cust_pkg->pkgnum,
1068 'unitsetup' => $unitsetup,
1070 'unitrecur' => $unitrecur,
1071 'quantity' => $cust_pkg->quantity,
1072 'details' => \@details,
1073 'discounts' => \@discounts,
1074 'hidden' => $part_pkg->hidden,
1075 'freq' => $part_pkg->freq,
1078 if ( $part_pkg->recur_temporality eq 'preceding' ) {
1079 $cust_bill_pkg->sdate( $hash{last_bill} );
1080 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
1081 $cust_bill_pkg->edate( $time ) if $options{cancel};
1082 } else { #if ( $part_pkg->recur_temporality eq 'upcoming' ) {
1083 $cust_bill_pkg->sdate( $sdate );
1084 $cust_bill_pkg->edate( $cust_pkg->bill );
1085 #$cust_bill_pkg->edate( $time ) if $options{cancel};
1088 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
1089 unless $part_pkg->pkgpart == $real_pkgpart;
1091 $$total_setup += $setup;
1092 $$total_recur += $recur;
1098 unless ( $discount_show_always ) {
1100 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart, \%options);
1101 return $error if $error;
1104 push @$cust_bill_pkgs, $cust_bill_pkg;
1106 } #if $setup != 0 || $recur != 0
1116 my $part_pkg = shift;
1117 my $taxlisthash = shift;
1118 my $cust_bill_pkg = shift;
1119 my $cust_pkg = shift;
1120 my $invoice_time = shift;
1121 my $real_pkgpart = shift;
1122 my $options = shift;
1124 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1126 my %cust_bill_pkg = ();
1130 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
1131 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
1132 push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
1133 push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
1135 if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
1137 if ( $conf->exists('enable_taxproducts')
1138 && ( scalar($part_pkg->part_pkg_taxoverride)
1139 || $part_pkg->has_taxproduct
1144 foreach my $class (@classes) {
1145 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class, $cust_pkg );
1146 return $err_or_ref unless ref($err_or_ref);
1147 $taxes{$class} = $err_or_ref;
1150 unless (exists $taxes{''}) {
1151 my $err_or_ref = $self->_gather_taxes( $part_pkg, '', $cust_pkg );
1152 return $err_or_ref unless ref($err_or_ref);
1153 $taxes{''} = $err_or_ref;
1158 my @loc_keys = qw( city county state country );
1160 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1161 my $cust_location = $cust_pkg->cust_location;
1162 %taxhash = map { $_ => $cust_location->$_() } @loc_keys;
1165 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
1168 %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
1171 $taxhash{'taxclass'} = $part_pkg->taxclass;
1174 my %taxhash_elim = %taxhash;
1175 my @elim = qw( city county state );
1178 #first try a match with taxclass
1179 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1181 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1182 #then try a match without taxclass
1183 my %no_taxclass = %taxhash_elim;
1184 $no_taxclass{ 'taxclass' } = '';
1185 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1188 $taxhash_elim{ shift(@elim) } = '';
1190 } while ( !scalar(@taxes) && scalar(@elim) );
1192 @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
1194 if $self->cust_main_exemption; #just to be safe
1196 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1198 $_->set('pkgnum', $cust_pkg->pkgnum );
1199 $_->set('locationnum', $cust_pkg->locationnum );
1203 $taxes{''} = [ @taxes ];
1204 $taxes{'setup'} = [ @taxes ];
1205 $taxes{'recur'} = [ @taxes ];
1206 $taxes{$_} = [ @taxes ] foreach (@classes);
1208 # # maybe eliminate this entirely, along with all the 0% records
1209 # unless ( @taxes ) {
1211 # "fatal: can't find tax rate for state/county/country/taxclass ".
1212 # join('/', map $taxhash{$_}, qw(state county country taxclass) );
1215 } #if $conf->exists('enable_taxproducts') ...
1220 my $separate = $conf->exists('separate_usage');
1221 my $temp_pkg = new FS::cust_pkg { pkgpart => $real_pkgpart };
1222 my $usage_mandate = $temp_pkg->part_pkg->option('usage_mandate', 'Hush!');
1223 my $section = $temp_pkg->part_pkg->categoryname;
1224 if ( $separate || $section || $usage_mandate ) {
1226 my %hash = ( 'section' => $section );
1228 $section = $temp_pkg->part_pkg->option('usage_section', 'Hush!');
1229 my $summary = $temp_pkg->part_pkg->option('summarize_usage', 'Hush!');
1231 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
1232 push @display, new FS::cust_bill_pkg_display { type => 'R', %hash };
1234 push @display, new FS::cust_bill_pkg_display
1237 ( ( $usage_mandate ) ? ( 'summary' => 'Y' ) : () ),
1241 if ($separate && $section && $summary) {
1242 push @display, new FS::cust_bill_pkg_display { type => 'U',
1247 if ($usage_mandate || $section && $summary) {
1248 $hash{post_total} = 'Y';
1251 if ($separate || $usage_mandate) {
1252 $hash{section} = $section if ($separate || $usage_mandate);
1253 push @display, new FS::cust_bill_pkg_display { type => 'U', %hash };
1257 $cust_bill_pkg->set('display', \@display);
1259 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
1260 foreach my $key (keys %tax_cust_bill_pkg) {
1261 my @taxes = @{ $taxes{$key} || [] };
1262 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
1264 my %localtaxlisthash = ();
1265 foreach my $tax ( @taxes ) {
1267 my $taxname = ref( $tax ). ' '. $tax->taxnum;
1268 # $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
1269 # ' locationnum'. $cust_pkg->locationnum
1270 # if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
1272 $taxlisthash->{ $taxname } ||= [ $tax ];
1273 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
1275 $localtaxlisthash{ $taxname } ||= [ $tax ];
1276 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
1280 warn "finding taxed taxes...\n" if $DEBUG > 2;
1281 foreach my $tax ( keys %localtaxlisthash ) {
1282 my $tax_object = shift @{ $localtaxlisthash{$tax} };
1283 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
1285 next unless $tax_object->can('tax_on_tax');
1287 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
1288 my $totname = ref( $tot ). ' '. $tot->taxnum;
1290 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
1292 next unless exists( $localtaxlisthash{ $totname } ); # only increase
1294 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
1295 my $hashref_or_error =
1296 $tax_object->taxline( $localtaxlisthash{$tax},
1297 'custnum' => $self->custnum,
1298 'invoice_time' => $invoice_time,
1300 return $hashref_or_error
1301 unless ref($hashref_or_error);
1303 $taxlisthash->{ $totname } ||= [ $tot ];
1304 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
1316 my $part_pkg = shift;
1318 my $cust_pkg = shift;
1320 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1323 if ( $cust_pkg->locationnum && $conf->exists('tax-pkg_address') ) {
1324 $geocode = $cust_pkg->cust_location->geocode('cch');
1326 $geocode = $self->geocode('cch');
1331 my @taxclassnums = map { $_->taxclassnum }
1332 $part_pkg->part_pkg_taxoverride($class);
1334 unless (@taxclassnums) {
1335 @taxclassnums = map { $_->taxclassnum }
1336 grep { $_->taxable eq 'Y' }
1337 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
1339 warn "Found taxclassnum values of ". join(',', @taxclassnums)
1344 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
1346 @taxes = qsearch({ 'table' => 'tax_rate',
1347 'hashref' => { 'geocode' => $geocode, },
1348 'extra_sql' => $extra_sql,
1350 if scalar(@taxclassnums);
1352 warn "Found taxes ".
1353 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
1360 =item collect [ HASHREF | OPTION => VALUE ... ]
1362 (Attempt to) collect money for this customer's outstanding invoices (see
1363 L<FS::cust_bill>). Usually used after the bill method.
1365 Actions are now triggered by billing events; see L<FS::part_event> and the
1366 billing events web interface. Old-style invoice events (see
1367 L<FS::part_bill_event>) have been deprecated.
1369 If there is an error, returns the error, otherwise returns false.
1371 Options are passed as name-value pairs.
1373 Currently available options are:
1379 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.
1383 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1387 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1391 set true to surpress email card/ACH decline notices.
1395 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)
1401 # allows for one time override of normal customer billing method
1406 my( $self, %options ) = @_;
1408 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1410 my $invoice_time = $options{'invoice_time'} || time;
1413 local $SIG{HUP} = 'IGNORE';
1414 local $SIG{INT} = 'IGNORE';
1415 local $SIG{QUIT} = 'IGNORE';
1416 local $SIG{TERM} = 'IGNORE';
1417 local $SIG{TSTP} = 'IGNORE';
1418 local $SIG{PIPE} = 'IGNORE';
1420 my $oldAutoCommit = $FS::UID::AutoCommit;
1421 local $FS::UID::AutoCommit = 0;
1424 $self->select_for_update; #mutex
1427 my $balance = $self->balance;
1428 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
1431 if ( exists($options{'retry_card'}) ) {
1432 carp 'retry_card option passed to collect is deprecated; use retry';
1433 $options{'retry'} ||= $options{'retry_card'};
1435 if ( exists($options{'retry'}) && $options{'retry'} ) {
1436 my $error = $self->retry_realtime;
1438 $dbh->rollback if $oldAutoCommit;
1443 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1445 #never want to roll back an event just because it returned an error
1446 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1448 $self->do_cust_event(
1449 'debug' => ( $options{'debug'} || 0 ),
1450 'time' => $invoice_time,
1451 'check_freq' => $options{'check_freq'},
1452 'stage' => 'collect',
1457 =item retry_realtime
1459 Schedules realtime / batch credit card / electronic check / LEC billing
1460 events for for retry. Useful if card information has changed or manual
1461 retry is desired. The 'collect' method must be called to actually retry
1464 Implementation details: For either this customer, or for each of this
1465 customer's open invoices, changes the status of the first "done" (with
1466 statustext error) realtime processing event to "failed".
1470 sub retry_realtime {
1473 local $SIG{HUP} = 'IGNORE';
1474 local $SIG{INT} = 'IGNORE';
1475 local $SIG{QUIT} = 'IGNORE';
1476 local $SIG{TERM} = 'IGNORE';
1477 local $SIG{TSTP} = 'IGNORE';
1478 local $SIG{PIPE} = 'IGNORE';
1480 my $oldAutoCommit = $FS::UID::AutoCommit;
1481 local $FS::UID::AutoCommit = 0;
1484 #a little false laziness w/due_cust_event (not too bad, really)
1486 my $join = FS::part_event_condition->join_conditions_sql;
1487 my $order = FS::part_event_condition->order_conditions_sql;
1490 . join ( ' OR ' , map {
1491 "( part_event.eventtable = " . dbh->quote($_)
1492 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
1493 } FS::part_event->eventtables)
1496 #here is the agent virtualization
1497 my $agent_virt = " ( part_event.agentnum IS NULL
1498 OR part_event.agentnum = ". $self->agentnum. ' )';
1500 #XXX this shouldn't be hardcoded, actions should declare it...
1501 my @realtime_events = qw(
1502 cust_bill_realtime_card
1503 cust_bill_realtime_check
1504 cust_bill_realtime_lec
1508 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
1513 my @cust_event = qsearchs({
1514 'table' => 'cust_event',
1515 'select' => 'cust_event.*',
1516 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
1517 'hashref' => { 'status' => 'done' },
1518 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
1519 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
1522 my %seen_invnum = ();
1523 foreach my $cust_event (@cust_event) {
1525 #max one for the customer, one for each open invoice
1526 my $cust_X = $cust_event->cust_X;
1527 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
1531 or $cust_event->part_event->eventtable eq 'cust_bill'
1534 my $error = $cust_event->retry;
1536 $dbh->rollback if $oldAutoCommit;
1537 return "error scheduling event for retry: $error";
1542 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1547 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
1549 Runs billing events; see L<FS::part_event> and the billing events web
1552 If there is an error, returns the error, otherwise returns false.
1554 Options are passed as name-value pairs.
1556 Currently available options are:
1562 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.
1566 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1570 "collect" (the default) or "pre-bill"
1574 set true to surpress email card/ACH decline notices.
1578 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)
1585 # allows for one time override of normal customer billing method
1589 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1592 my( $self, %options ) = @_;
1594 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1596 my $time = $options{'time'} || time;
1599 local $SIG{HUP} = 'IGNORE';
1600 local $SIG{INT} = 'IGNORE';
1601 local $SIG{QUIT} = 'IGNORE';
1602 local $SIG{TERM} = 'IGNORE';
1603 local $SIG{TSTP} = 'IGNORE';
1604 local $SIG{PIPE} = 'IGNORE';
1606 my $oldAutoCommit = $FS::UID::AutoCommit;
1607 local $FS::UID::AutoCommit = 0;
1610 $self->select_for_update; #mutex
1613 my $balance = $self->balance;
1614 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
1617 # if ( exists($options{'retry_card'}) ) {
1618 # carp 'retry_card option passed to collect is deprecated; use retry';
1619 # $options{'retry'} ||= $options{'retry_card'};
1621 # if ( exists($options{'retry'}) && $options{'retry'} ) {
1622 # my $error = $self->retry_realtime;
1624 # $dbh->rollback if $oldAutoCommit;
1629 # false laziness w/pay_batch::import_results
1631 my $due_cust_event = $self->due_cust_event(
1632 'debug' => ( $options{'debug'} || 0 ),
1634 'check_freq' => $options{'check_freq'},
1635 'stage' => ( $options{'stage'} || 'collect' ),
1637 unless( ref($due_cust_event) ) {
1638 $dbh->rollback if $oldAutoCommit;
1639 return $due_cust_event;
1642 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1643 #never want to roll back an event just because it or a different one
1645 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1647 foreach my $cust_event ( @$due_cust_event ) {
1651 #re-eval event conditions (a previous event could have changed things)
1652 unless ( $cust_event->test_conditions( 'time' => $time ) ) {
1653 #don't leave stray "new/locked" records around
1654 my $error = $cust_event->delete;
1655 return $error if $error;
1660 local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
1661 if $options{'quiet'};
1662 warn " running cust_event ". $cust_event->eventnum. "\n"
1665 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
1666 if ( my $error = $cust_event->do_event() ) {
1667 #XXX wtf is this? figure out a proper dealio with return value
1679 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
1681 Inserts database records for and returns an ordered listref of new events due
1682 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
1683 events are due, an empty listref is returned. If there is an error, returns a
1684 scalar error message.
1686 To actually run the events, call each event's test_condition method, and if
1687 still true, call the event's do_event method.
1689 Options are passed as a hashref or as a list of name-value pairs. Available
1696 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.
1700 "collect" (the default) or "pre-bill"
1704 "Current time" for the events.
1708 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)
1712 Only return events for the specified eventtable (by default, events of all eventtables are returned)
1716 Explicitly pass the objects to be tested (typically used with eventtable).
1720 Set to true to return the objects, but not actually insert them into the
1727 sub due_cust_event {
1729 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
1732 #my $DEBUG = $opt{'debug'}
1733 local($DEBUG) = $opt{'debug'}
1734 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
1735 $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1737 warn "$me due_cust_event called with options ".
1738 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
1741 $opt{'time'} ||= time;
1743 local $SIG{HUP} = 'IGNORE';
1744 local $SIG{INT} = 'IGNORE';
1745 local $SIG{QUIT} = 'IGNORE';
1746 local $SIG{TERM} = 'IGNORE';
1747 local $SIG{TSTP} = 'IGNORE';
1748 local $SIG{PIPE} = 'IGNORE';
1750 my $oldAutoCommit = $FS::UID::AutoCommit;
1751 local $FS::UID::AutoCommit = 0;
1754 $self->select_for_update #mutex
1755 unless $opt{testonly};
1758 # find possible events (initial search)
1761 my @cust_event = ();
1763 my @eventtable = $opt{'eventtable'}
1764 ? ( $opt{'eventtable'} )
1765 : FS::part_event->eventtables_runorder;
1767 my $check_freq = $opt{'check_freq'} || '1d';
1769 foreach my $eventtable ( @eventtable ) {
1772 if ( $opt{'objects'} ) {
1774 @objects = @{ $opt{'objects'} };
1778 #my @objects = $self->$eventtable(); # sub cust_main { @{ [ $self ] }; }
1779 if ( $eventtable eq 'cust_main' ) {
1780 @objects = ( $self );
1784 "LEFT JOIN cust_main USING ( custnum )";
1786 #some false laziness w/Cron::bill bill_where
1788 my $join = FS::part_event_condition->join_conditions_sql( $eventtable);
1789 my $where = FS::part_event_condition->where_conditions_sql($eventtable,
1790 'time'=>$opt{'time'},
1792 $where = $where ? "AND $where" : '';
1794 my $are_part_event =
1795 "EXISTS ( SELECT 1 FROM part_event $join
1796 WHERE check_freq = '$check_freq'
1797 AND eventtable = '$eventtable'
1798 AND ( disabled = '' OR disabled IS NULL )
1804 @objects = $self->$eventtable(
1805 'addl_from' => $cm_join,
1806 'extra_sql' => " AND $are_part_event",
1812 my @e_cust_event = ();
1814 my $cross = "CROSS JOIN $eventtable";
1815 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
1816 unless $eventtable eq 'cust_main';
1818 foreach my $object ( @objects ) {
1820 #this first search uses the condition_sql magic for optimization.
1821 #the more possible events we can eliminate in this step the better
1823 my $cross_where = '';
1824 my $pkey = $object->primary_key;
1825 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
1827 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
1829 FS::part_event_condition->where_conditions_sql( $eventtable,
1830 'time'=>$opt{'time'}
1832 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
1834 $extra_sql = "AND $extra_sql" if $extra_sql;
1836 #here is the agent virtualization
1837 $extra_sql .= " AND ( part_event.agentnum IS NULL
1838 OR part_event.agentnum = ". $self->agentnum. ' )';
1840 $extra_sql .= " $order";
1842 warn "searching for events for $eventtable ". $object->$pkey. "\n"
1843 if $opt{'debug'} > 2;
1844 my @part_event = qsearch( {
1845 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
1846 'select' => 'part_event.*',
1847 'table' => 'part_event',
1848 'addl_from' => "$cross $join",
1849 'hashref' => { 'check_freq' => $check_freq,
1850 'eventtable' => $eventtable,
1853 'extra_sql' => "AND $cross_where $extra_sql",
1857 my $pkey = $object->primary_key;
1858 warn " ". scalar(@part_event).
1859 " possible events found for $eventtable ". $object->$pkey(). "\n";
1862 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
1866 warn " ". scalar(@e_cust_event).
1867 " subtotal possible cust events found for $eventtable\n"
1870 push @cust_event, @e_cust_event;
1874 warn " ". scalar(@cust_event).
1875 " total possible cust events found in initial search\n"
1883 $opt{stage} ||= 'collect';
1885 grep { my $stage = $_->part_event->event_stage;
1886 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
1896 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
1897 'stats_hashref' => \%unsat ),
1900 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
1903 warn " invalid conditions not eliminated with condition_sql:\n".
1904 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
1905 if keys %unsat && $DEBUG; # > 1;
1911 unless( $opt{testonly} ) {
1912 foreach my $cust_event ( @cust_event ) {
1914 my $error = $cust_event->insert();
1916 $dbh->rollback if $oldAutoCommit;
1923 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1929 warn " returning events: ". Dumper(@cust_event). "\n"
1936 =item apply_payments_and_credits [ OPTION => VALUE ... ]
1938 Applies unapplied payments and credits.
1940 In most cases, this new method should be used in place of sequential
1941 apply_payments and apply_credits methods.
1943 A hash of optional arguments may be passed. Currently "manual" is supported.
1944 If true, a payment receipt is sent instead of a statement when
1945 'payment_receipt_email' configuration option is set.
1947 If there is an error, returns the error, otherwise returns false.
1951 sub apply_payments_and_credits {
1952 my( $self, %options ) = @_;
1954 local $SIG{HUP} = 'IGNORE';
1955 local $SIG{INT} = 'IGNORE';
1956 local $SIG{QUIT} = 'IGNORE';
1957 local $SIG{TERM} = 'IGNORE';
1958 local $SIG{TSTP} = 'IGNORE';
1959 local $SIG{PIPE} = 'IGNORE';
1961 my $oldAutoCommit = $FS::UID::AutoCommit;
1962 local $FS::UID::AutoCommit = 0;
1965 $self->select_for_update; #mutex
1967 foreach my $cust_bill ( $self->open_cust_bill ) {
1968 my $error = $cust_bill->apply_payments_and_credits(%options);
1970 $dbh->rollback if $oldAutoCommit;
1971 return "Error applying: $error";
1975 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1980 =item apply_credits OPTION => VALUE ...
1982 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
1983 to outstanding invoice balances in chronological order (or reverse
1984 chronological order if the I<order> option is set to B<newest>) and returns the
1985 value of any remaining unapplied credits available for refund (see
1986 L<FS::cust_refund>).
1988 Dies if there is an error.
1996 local $SIG{HUP} = 'IGNORE';
1997 local $SIG{INT} = 'IGNORE';
1998 local $SIG{QUIT} = 'IGNORE';
1999 local $SIG{TERM} = 'IGNORE';
2000 local $SIG{TSTP} = 'IGNORE';
2001 local $SIG{PIPE} = 'IGNORE';
2003 my $oldAutoCommit = $FS::UID::AutoCommit;
2004 local $FS::UID::AutoCommit = 0;
2007 $self->select_for_update; #mutex
2009 unless ( $self->total_unapplied_credits ) {
2010 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2014 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
2015 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
2017 my @invoices = $self->open_cust_bill;
2018 @invoices = sort { $b->_date <=> $a->_date } @invoices
2019 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
2021 if ( $conf->exists('pkg-balances') ) {
2022 # limit @credits to those w/ a pkgnum grepped from $self
2024 foreach my $i (@invoices) {
2025 foreach my $li ( $i->cust_bill_pkg ) {
2026 $pkgnums{$li->pkgnum} = 1;
2029 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
2034 foreach my $cust_bill ( @invoices ) {
2036 if ( !defined($credit) || $credit->credited == 0) {
2037 $credit = pop @credits or last;
2041 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
2042 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
2044 $owed = $cust_bill->owed;
2046 unless ( $owed > 0 ) {
2047 push @credits, $credit;
2051 my $amount = min( $credit->credited, $owed );
2053 my $cust_credit_bill = new FS::cust_credit_bill ( {
2054 'crednum' => $credit->crednum,
2055 'invnum' => $cust_bill->invnum,
2056 'amount' => $amount,
2058 $cust_credit_bill->pkgnum( $credit->pkgnum )
2059 if $conf->exists('pkg-balances') && $credit->pkgnum;
2060 my $error = $cust_credit_bill->insert;
2062 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2066 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2070 my $total_unapplied_credits = $self->total_unapplied_credits;
2072 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2074 return $total_unapplied_credits;
2077 =item apply_payments [ OPTION => VALUE ... ]
2079 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2080 to outstanding invoice balances in chronological order.
2082 #and returns the value of any remaining unapplied payments.
2084 A hash of optional arguments may be passed. Currently "manual" is supported.
2085 If true, a payment receipt is sent instead of a statement when
2086 'payment_receipt_email' configuration option is set.
2088 Dies if there is an error.
2092 sub apply_payments {
2093 my( $self, %options ) = @_;
2095 local $SIG{HUP} = 'IGNORE';
2096 local $SIG{INT} = 'IGNORE';
2097 local $SIG{QUIT} = 'IGNORE';
2098 local $SIG{TERM} = 'IGNORE';
2099 local $SIG{TSTP} = 'IGNORE';
2100 local $SIG{PIPE} = 'IGNORE';
2102 my $oldAutoCommit = $FS::UID::AutoCommit;
2103 local $FS::UID::AutoCommit = 0;
2106 $self->select_for_update; #mutex
2110 my @payments = sort { $b->_date <=> $a->_date }
2111 grep { $_->unapplied > 0 }
2114 my @invoices = sort { $a->_date <=> $b->_date}
2115 grep { $_->owed > 0 }
2118 if ( $conf->exists('pkg-balances') ) {
2119 # limit @payments to those w/ a pkgnum grepped from $self
2121 foreach my $i (@invoices) {
2122 foreach my $li ( $i->cust_bill_pkg ) {
2123 $pkgnums{$li->pkgnum} = 1;
2126 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
2131 foreach my $cust_bill ( @invoices ) {
2133 if ( !defined($payment) || $payment->unapplied == 0 ) {
2134 $payment = pop @payments or last;
2138 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
2139 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
2141 $owed = $cust_bill->owed;
2143 unless ( $owed > 0 ) {
2144 push @payments, $payment;
2148 my $amount = min( $payment->unapplied, $owed );
2150 my $cust_bill_pay = new FS::cust_bill_pay ( {
2151 'paynum' => $payment->paynum,
2152 'invnum' => $cust_bill->invnum,
2153 'amount' => $amount,
2155 $cust_bill_pay->pkgnum( $payment->pkgnum )
2156 if $conf->exists('pkg-balances') && $payment->pkgnum;
2157 my $error = $cust_bill_pay->insert(%options);
2159 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2163 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2167 my $total_unapplied_payments = $self->total_unapplied_payments;
2169 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2171 return $total_unapplied_payments;
2181 suspend_adjourned_pkgs
2184 (do_cust_event pre-bill)
2187 (vendor-only) _gather_taxes
2188 _omit_zero_value_bundles
2191 apply_payments_and_credits
2200 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>