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. " sum $sum, ".
620 "setup_show_zero ". $cust_bill_pkg->setup_show_zero.
621 "recur_show_zero ". $cust_bill_pkg->recur_show_zero. "\n"
624 if (scalar(@cust_bill_pkg_bundle) && !$cust_bill_pkg->pkgpart_override) {
625 push @cust_bill_pkg, @cust_bill_pkg_bundle
627 || ($sum == 0 && ( $discount_show_always
628 || grep {$_->recur_show_zero || $_->setup_show_zero}
629 @cust_bill_pkg_bundle
632 @cust_bill_pkg_bundle = ();
636 $sum += $cust_bill_pkg->setup + $cust_bill_pkg->recur;
637 push @cust_bill_pkg_bundle, $cust_bill_pkg;
641 push @cust_bill_pkg, @cust_bill_pkg_bundle
643 || ($sum == 0 && ( $discount_show_always
644 || grep {$_->recur_show_zero || $_->setup_show_zero}
645 @cust_bill_pkg_bundle
649 warn " _omit_zero_value_bundles: ". scalar(@in).
650 '->'. scalar(@cust_bill_pkg). "\n" #. Dumper(@cust_bill_pkg). "\n"
657 =item calculate_taxes LINEITEMREF TAXHASHREF INVOICE_TIME
659 This is a weird one. Perhaps it should not even be exposed.
661 Generates tax line items (see L<FS::cust_bill_pkg>) for this customer.
662 Usually used internally by bill method B<bill>.
664 If there is an error, returns the error, otherwise returns reference to a
665 list of line items suitable for insertion.
671 An array ref of the line items being billed.
675 A strange beast. The keys to this hash are internal identifiers consisting
676 of the name of the tax object type, a space, and its unique identifier ( e.g.
677 'cust_main_county 23' ). The values of the hash are listrefs. The first
678 item in the list is the tax object. The remaining items are either line
679 items or floating point values (currency amounts).
681 The taxes are calculated on this entity. Calculated exemption records are
682 transferred to the LINEITEMREF items on the assumption that they are related.
688 This specifies the date appearing on the associated invoice. Some
689 jurisdictions (i.e. Texas) have tax exemptions which are date sensitive.
695 sub calculate_taxes {
696 my ($self, $cust_bill_pkg, $taxlisthash, $invoice_time) = @_;
698 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
700 warn "$me calculate_taxes\n"
701 #.Dumper($self, $cust_bill_pkg, $taxlisthash, $invoice_time). "\n"
704 my @tax_line_items = ();
706 # keys are tax names (as printed on invoices / itemdesc )
707 # values are listrefs of taxlisthash keys (internal identifiers)
710 # keys are taxlisthash keys (internal identifiers)
711 # values are (cumulative) amounts
714 # keys are taxlisthash keys (internal identifiers)
715 # values are listrefs of cust_bill_pkg_tax_location hashrefs
716 my %tax_location = ();
718 # keys are taxlisthash keys (internal identifiers)
719 # values are listrefs of cust_bill_pkg_tax_rate_location hashrefs
720 my %tax_rate_location = ();
722 foreach my $tax ( keys %$taxlisthash ) {
723 my $tax_object = shift @{ $taxlisthash->{$tax} };
724 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
725 warn " ". join('/', @{ $taxlisthash->{$tax} } ). "\n" if $DEBUG > 2;
726 my $hashref_or_error =
727 $tax_object->taxline( $taxlisthash->{$tax},
728 'custnum' => $self->custnum,
729 'invoice_time' => $invoice_time
731 return $hashref_or_error unless ref($hashref_or_error);
733 unshift @{ $taxlisthash->{$tax} }, $tax_object;
735 my $name = $hashref_or_error->{'name'};
736 my $amount = $hashref_or_error->{'amount'};
738 #warn "adding $amount as $name\n";
739 $taxname{ $name } ||= [];
740 push @{ $taxname{ $name } }, $tax;
742 $tax{ $tax } += $amount;
744 $tax_location{ $tax } ||= [];
745 if ( $tax_object->get('pkgnum') || $tax_object->get('locationnum') ) {
746 push @{ $tax_location{ $tax } },
748 'taxnum' => $tax_object->taxnum,
749 'taxtype' => ref($tax_object),
750 'pkgnum' => $tax_object->get('pkgnum'),
751 'locationnum' => $tax_object->get('locationnum'),
752 'amount' => sprintf('%.2f', $amount ),
756 $tax_rate_location{ $tax } ||= [];
757 if ( ref($tax_object) eq 'FS::tax_rate' ) {
758 my $taxratelocationnum =
759 $tax_object->tax_rate_location->taxratelocationnum;
760 push @{ $tax_rate_location{ $tax } },
762 'taxnum' => $tax_object->taxnum,
763 'taxtype' => ref($tax_object),
764 'amount' => sprintf('%.2f', $amount ),
765 'locationtaxid' => $tax_object->location,
766 'taxratelocationnum' => $taxratelocationnum,
772 #move the cust_tax_exempt_pkg records to the cust_bill_pkgs we will commit
773 my %packagemap = map { $_->pkgnum => $_ } @$cust_bill_pkg;
774 foreach my $tax ( keys %$taxlisthash ) {
775 foreach ( @{ $taxlisthash->{$tax} }[1 ... scalar(@{ $taxlisthash->{$tax} })] ) {
776 next unless ref($_) eq 'FS::cust_bill_pkg';
778 my @cust_tax_exempt_pkg = splice( @{ $_->_cust_tax_exempt_pkg } );
780 next unless @cust_tax_exempt_pkg; #just avoiding the prob when irrelevant?
781 die "can't distribute tax exemptions: no line item for ". Dumper($_).
782 " in packagemap ". join(',', sort {$a<=>$b} keys %packagemap). "\n"
783 unless $packagemap{$_->pkgnum};
785 push @{ $packagemap{$_->pkgnum}->_cust_tax_exempt_pkg },
786 @cust_tax_exempt_pkg;
790 #consolidate and create tax line items
791 warn "consolidating and generating...\n" if $DEBUG > 2;
792 foreach my $taxname ( keys %taxname ) {
795 my @cust_bill_pkg_tax_location = ();
796 my @cust_bill_pkg_tax_rate_location = ();
797 warn "adding $taxname\n" if $DEBUG > 1;
798 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
799 next if $seen{$taxitem}++;
800 warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
801 $tax += $tax{$taxitem};
802 push @cust_bill_pkg_tax_location,
803 map { new FS::cust_bill_pkg_tax_location $_ }
804 @{ $tax_location{ $taxitem } };
805 push @cust_bill_pkg_tax_rate_location,
806 map { new FS::cust_bill_pkg_tax_rate_location $_ }
807 @{ $tax_rate_location{ $taxitem } };
811 $tax = sprintf('%.2f', $tax );
813 my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
819 if ( $pkg_category and
820 $conf->config('invoice_latexsummary') ||
821 $conf->config('invoice_htmlsummary')
825 my %hash = ( 'section' => $pkg_category->categoryname );
826 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
830 push @tax_line_items, new FS::cust_bill_pkg {
836 'itemdesc' => $taxname,
837 'display' => \@display,
838 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
839 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
848 my ($self, %params) = @_;
850 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
852 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
853 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
854 my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
855 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
856 my $total_setup = $params{setup} or die "no setup accumulator specified";
857 my $total_recur = $params{recur} or die "no recur accumulator specified";
858 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
859 my $time = $params{'time'} or die "no time specified";
860 my (%options) = %{$params{options}};
863 my $real_pkgpart = $params{real_pkgpart};
864 my %hash = $cust_pkg->hash;
865 my $old_cust_pkg = new FS::cust_pkg \%hash;
871 $cust_pkg->pkgpart($part_pkg->pkgpart);
879 my %setup_param = ();
880 if ( ! $options{recurring_only}
881 and ! $options{cancel}
882 and ( $options{'resetup'}
883 || ( ! $cust_pkg->setup
884 && ( ! $cust_pkg->start_date
885 || $cust_pkg->start_date <= $self->day_end($time)
887 && ( ! $conf->exists('disable_setup_suspended_pkgs')
888 || ( $conf->exists('disable_setup_suspended_pkgs') &&
889 ! $cust_pkg->getfield('susp')
897 warn " bill setup\n" if $DEBUG > 1;
899 unless ( $cust_pkg->waive_setup ) {
902 $setup = eval { $cust_pkg->calc_setup( $time, \@details, \%setup_param ) };
903 return "$@ running calc_setup for $cust_pkg\n"
906 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
909 $cust_pkg->setfield('setup', $time)
910 unless $cust_pkg->setup;
911 #do need it, but it won't get written to the db
912 #|| $cust_pkg->pkgpart != $real_pkgpart;
914 $cust_pkg->setfield('start_date', '')
915 if $cust_pkg->start_date;
923 #XXX unit stuff here too
927 if ( ! $cust_pkg->start_date
928 and ( ! $cust_pkg->susp || $part_pkg->option('suspend_bill', 1) )
930 ( $part_pkg->freq ne '0' && ( $cust_pkg->bill || 0 ) <= $self->day_end($time) )
931 || ( $part_pkg->plan eq 'voip_cdr'
932 && $part_pkg->option('bill_every_call')
937 # XXX should this be a package event? probably. events are called
938 # at collection time at the moment, though...
939 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
940 if $part_pkg->can('reset_usage') && !$options{'no_usage_reset'};
941 #don't want to reset usage just cause we want a line item??
942 #&& $part_pkg->pkgpart == $real_pkgpart;
944 warn " bill recur\n" if $DEBUG > 1;
947 # XXX shared with $recur_prog
948 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
952 #over two params! lets at least switch to a hashref for the rest...
953 my $increment_next_bill = ( $part_pkg->freq ne '0'
954 && ( $cust_pkg->getfield('bill') || 0 ) <= $self->day_end($time)
957 my %param = ( 'precommit_hooks' => $precommit_hooks,
958 'increment_next_bill' => $increment_next_bill,
959 'discounts' => \@discounts,
960 'real_pkgpart' => $real_pkgpart,
961 'freq_override' => $options{freq_override} || '',
966 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
968 # There may be some part_pkg for which this is wrong. Only those
969 # which can_discount are supported.
970 # (the UI should prevent adding discounts to these at the moment)
972 warn "calling $method on cust_pkg ". $cust_pkg->pkgnum.
973 " for pkgpart ". $cust_pkg->pkgpart.
974 " with params ". join(' / ', map "$_=>$param{$_}", keys %param). "\n"
977 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
978 return "$@ running $method for $cust_pkg\n"
981 if ( $increment_next_bill ) {
983 my $next_bill = $part_pkg->add_freq($sdate, $options{freq_override} || 0);
984 return "unparsable frequency: ". $part_pkg->freq
987 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
988 # only for figuring next bill date, nothing else, so, reset $sdate again
990 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
991 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
992 $cust_pkg->last_bill($sdate);
994 $cust_pkg->setfield('bill', $next_bill );
998 if ( $param{'setup_fee'} ) {
999 # Add an additional setup fee at the billing stage.
1000 # Used for prorate_defer_bill.
1001 $setup += $param{'setup_fee'};
1002 $unitsetup += $param{'setup_fee'};
1006 if ( defined $param{'discount_left_setup'} ) {
1007 foreach my $discount_setup ( values %{$param{'discount_left_setup'}} ) {
1008 $setup -= $discount_setup;
1014 warn "\$setup is undefined" unless defined($setup);
1015 warn "\$recur is undefined" unless defined($recur);
1016 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1019 # If there's line items, create em cust_bill_pkg records
1020 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
1025 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
1026 # hmm.. and if just the options are modified in some weird price plan?
1028 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
1031 my $error = $cust_pkg->replace( $old_cust_pkg,
1032 'depend_jobnum'=>$options{depend_jobnum},
1033 'options' => { $cust_pkg->options },
1035 unless $options{no_commit};
1036 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
1037 if $error; #just in case
1040 $setup = sprintf( "%.2f", $setup );
1041 $recur = sprintf( "%.2f", $recur );
1042 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
1043 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1045 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
1046 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
1049 my $discount_show_always = ($recur == 0 && scalar(@discounts)
1050 && $conf->exists('discount-show-always'));
1054 || (!$part_pkg->hidden && $options{has_hidden}) #include some $0 lines
1055 || $discount_show_always
1056 || ($setup == 0 && $cust_pkg->_X_show_zero('setup'))
1057 || ($recur == 0 && $cust_pkg->_X_show_zero('recur'))
1061 warn " charges (setup=$setup, recur=$recur); adding line items\n"
1064 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
1066 warn " adding customer package invoice detail: $_\n"
1067 foreach @cust_pkg_detail;
1069 push @details, @cust_pkg_detail;
1071 my $cust_bill_pkg = new FS::cust_bill_pkg {
1072 'pkgnum' => $cust_pkg->pkgnum,
1074 'unitsetup' => $unitsetup,
1076 'unitrecur' => $unitrecur,
1077 'quantity' => $cust_pkg->quantity,
1078 'details' => \@details,
1079 'discounts' => \@discounts,
1080 'hidden' => $part_pkg->hidden,
1081 'freq' => $part_pkg->freq,
1084 if ( $part_pkg->recur_temporality eq 'preceding' ) {
1085 $cust_bill_pkg->sdate( $hash{last_bill} );
1086 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
1087 $cust_bill_pkg->edate( $time ) if $options{cancel};
1088 } else { #if ( $part_pkg->recur_temporality eq 'upcoming' ) {
1089 $cust_bill_pkg->sdate( $sdate );
1090 $cust_bill_pkg->edate( $cust_pkg->bill );
1091 #$cust_bill_pkg->edate( $time ) if $options{cancel};
1094 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
1095 unless $part_pkg->pkgpart == $real_pkgpart;
1097 $$total_setup += $setup;
1098 $$total_recur += $recur;
1104 unless ( $discount_show_always ) {
1106 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart, \%options);
1107 return $error if $error;
1110 push @$cust_bill_pkgs, $cust_bill_pkg;
1112 } #if $setup != 0 || $recur != 0
1122 my $part_pkg = shift;
1123 my $taxlisthash = shift;
1124 my $cust_bill_pkg = shift;
1125 my $cust_pkg = shift;
1126 my $invoice_time = shift;
1127 my $real_pkgpart = shift;
1128 my $options = shift;
1130 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1132 my %cust_bill_pkg = ();
1136 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
1137 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
1138 push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
1139 push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
1141 if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
1143 if ( $conf->exists('enable_taxproducts')
1144 && ( scalar($part_pkg->part_pkg_taxoverride)
1145 || $part_pkg->has_taxproduct
1150 foreach my $class (@classes) {
1151 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class, $cust_pkg );
1152 return $err_or_ref unless ref($err_or_ref);
1153 $taxes{$class} = $err_or_ref;
1156 unless (exists $taxes{''}) {
1157 my $err_or_ref = $self->_gather_taxes( $part_pkg, '', $cust_pkg );
1158 return $err_or_ref unless ref($err_or_ref);
1159 $taxes{''} = $err_or_ref;
1164 my @loc_keys = qw( city county state country );
1166 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1167 my $cust_location = $cust_pkg->cust_location;
1168 %taxhash = map { $_ => $cust_location->$_() } @loc_keys;
1171 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
1174 %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
1177 $taxhash{'taxclass'} = $part_pkg->taxclass;
1180 my %taxhash_elim = %taxhash;
1181 my @elim = qw( city county state );
1184 #first try a match with taxclass
1185 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1187 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1188 #then try a match without taxclass
1189 my %no_taxclass = %taxhash_elim;
1190 $no_taxclass{ 'taxclass' } = '';
1191 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1194 $taxhash_elim{ shift(@elim) } = '';
1196 } while ( !scalar(@taxes) && scalar(@elim) );
1198 @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
1200 if $self->cust_main_exemption; #just to be safe
1202 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1204 $_->set('pkgnum', $cust_pkg->pkgnum );
1205 $_->set('locationnum', $cust_pkg->locationnum );
1209 $taxes{''} = [ @taxes ];
1210 $taxes{'setup'} = [ @taxes ];
1211 $taxes{'recur'} = [ @taxes ];
1212 $taxes{$_} = [ @taxes ] foreach (@classes);
1214 # # maybe eliminate this entirely, along with all the 0% records
1215 # unless ( @taxes ) {
1217 # "fatal: can't find tax rate for state/county/country/taxclass ".
1218 # join('/', map $taxhash{$_}, qw(state county country taxclass) );
1221 } #if $conf->exists('enable_taxproducts') ...
1226 my $separate = $conf->exists('separate_usage');
1227 my $temp_pkg = new FS::cust_pkg { pkgpart => $real_pkgpart };
1228 my $usage_mandate = $temp_pkg->part_pkg->option('usage_mandate', 'Hush!');
1229 my $section = $temp_pkg->part_pkg->categoryname;
1230 if ( $separate || $section || $usage_mandate ) {
1232 my %hash = ( 'section' => $section );
1234 $section = $temp_pkg->part_pkg->option('usage_section', 'Hush!');
1235 my $summary = $temp_pkg->part_pkg->option('summarize_usage', 'Hush!');
1237 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
1238 push @display, new FS::cust_bill_pkg_display { type => 'R', %hash };
1240 push @display, new FS::cust_bill_pkg_display
1243 ( ( $usage_mandate ) ? ( 'summary' => 'Y' ) : () ),
1247 if ($separate && $section && $summary) {
1248 push @display, new FS::cust_bill_pkg_display { type => 'U',
1253 if ($usage_mandate || $section && $summary) {
1254 $hash{post_total} = 'Y';
1257 if ($separate || $usage_mandate) {
1258 $hash{section} = $section if ($separate || $usage_mandate);
1259 push @display, new FS::cust_bill_pkg_display { type => 'U', %hash };
1263 $cust_bill_pkg->set('display', \@display);
1265 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
1266 foreach my $key (keys %tax_cust_bill_pkg) {
1267 my @taxes = @{ $taxes{$key} || [] };
1268 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
1270 my %localtaxlisthash = ();
1271 foreach my $tax ( @taxes ) {
1273 my $taxname = ref( $tax ). ' '. $tax->taxnum;
1274 # $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
1275 # ' locationnum'. $cust_pkg->locationnum
1276 # if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
1278 $taxlisthash->{ $taxname } ||= [ $tax ];
1279 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
1281 $localtaxlisthash{ $taxname } ||= [ $tax ];
1282 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
1286 warn "finding taxed taxes...\n" if $DEBUG > 2;
1287 foreach my $tax ( keys %localtaxlisthash ) {
1288 my $tax_object = shift @{ $localtaxlisthash{$tax} };
1289 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
1291 next unless $tax_object->can('tax_on_tax');
1293 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
1294 my $totname = ref( $tot ). ' '. $tot->taxnum;
1296 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
1298 next unless exists( $localtaxlisthash{ $totname } ); # only increase
1300 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
1301 my $hashref_or_error =
1302 $tax_object->taxline( $localtaxlisthash{$tax},
1303 'custnum' => $self->custnum,
1304 'invoice_time' => $invoice_time,
1306 return $hashref_or_error
1307 unless ref($hashref_or_error);
1309 $taxlisthash->{ $totname } ||= [ $tot ];
1310 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
1322 my $part_pkg = shift;
1324 my $cust_pkg = shift;
1326 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1329 if ( $cust_pkg->locationnum && $conf->exists('tax-pkg_address') ) {
1330 $geocode = $cust_pkg->cust_location->geocode('cch');
1332 $geocode = $self->geocode('cch');
1337 my @taxclassnums = map { $_->taxclassnum }
1338 $part_pkg->part_pkg_taxoverride($class);
1340 unless (@taxclassnums) {
1341 @taxclassnums = map { $_->taxclassnum }
1342 grep { $_->taxable eq 'Y' }
1343 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
1345 warn "Found taxclassnum values of ". join(',', @taxclassnums)
1350 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
1352 @taxes = qsearch({ 'table' => 'tax_rate',
1353 'hashref' => { 'geocode' => $geocode, },
1354 'extra_sql' => $extra_sql,
1356 if scalar(@taxclassnums);
1358 warn "Found taxes ".
1359 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
1366 =item collect [ HASHREF | OPTION => VALUE ... ]
1368 (Attempt to) collect money for this customer's outstanding invoices (see
1369 L<FS::cust_bill>). Usually used after the bill method.
1371 Actions are now triggered by billing events; see L<FS::part_event> and the
1372 billing events web interface. Old-style invoice events (see
1373 L<FS::part_bill_event>) have been deprecated.
1375 If there is an error, returns the error, otherwise returns false.
1377 Options are passed as name-value pairs.
1379 Currently available options are:
1385 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.
1389 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1393 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1397 set true to surpress email card/ACH decline notices.
1401 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)
1407 # allows for one time override of normal customer billing method
1412 my( $self, %options ) = @_;
1414 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1416 my $invoice_time = $options{'invoice_time'} || time;
1419 local $SIG{HUP} = 'IGNORE';
1420 local $SIG{INT} = 'IGNORE';
1421 local $SIG{QUIT} = 'IGNORE';
1422 local $SIG{TERM} = 'IGNORE';
1423 local $SIG{TSTP} = 'IGNORE';
1424 local $SIG{PIPE} = 'IGNORE';
1426 my $oldAutoCommit = $FS::UID::AutoCommit;
1427 local $FS::UID::AutoCommit = 0;
1430 $self->select_for_update; #mutex
1433 my $balance = $self->balance;
1434 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
1437 if ( exists($options{'retry_card'}) ) {
1438 carp 'retry_card option passed to collect is deprecated; use retry';
1439 $options{'retry'} ||= $options{'retry_card'};
1441 if ( exists($options{'retry'}) && $options{'retry'} ) {
1442 my $error = $self->retry_realtime;
1444 $dbh->rollback if $oldAutoCommit;
1449 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1451 #never want to roll back an event just because it returned an error
1452 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1454 $self->do_cust_event(
1455 'debug' => ( $options{'debug'} || 0 ),
1456 'time' => $invoice_time,
1457 'check_freq' => $options{'check_freq'},
1458 'stage' => 'collect',
1463 =item retry_realtime
1465 Schedules realtime / batch credit card / electronic check / LEC billing
1466 events for for retry. Useful if card information has changed or manual
1467 retry is desired. The 'collect' method must be called to actually retry
1470 Implementation details: For either this customer, or for each of this
1471 customer's open invoices, changes the status of the first "done" (with
1472 statustext error) realtime processing event to "failed".
1476 sub retry_realtime {
1479 local $SIG{HUP} = 'IGNORE';
1480 local $SIG{INT} = 'IGNORE';
1481 local $SIG{QUIT} = 'IGNORE';
1482 local $SIG{TERM} = 'IGNORE';
1483 local $SIG{TSTP} = 'IGNORE';
1484 local $SIG{PIPE} = 'IGNORE';
1486 my $oldAutoCommit = $FS::UID::AutoCommit;
1487 local $FS::UID::AutoCommit = 0;
1490 #a little false laziness w/due_cust_event (not too bad, really)
1492 my $join = FS::part_event_condition->join_conditions_sql;
1493 my $order = FS::part_event_condition->order_conditions_sql;
1496 . join ( ' OR ' , map {
1497 "( part_event.eventtable = " . dbh->quote($_)
1498 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
1499 } FS::part_event->eventtables)
1502 #here is the agent virtualization
1503 my $agent_virt = " ( part_event.agentnum IS NULL
1504 OR part_event.agentnum = ". $self->agentnum. ' )';
1506 #XXX this shouldn't be hardcoded, actions should declare it...
1507 my @realtime_events = qw(
1508 cust_bill_realtime_card
1509 cust_bill_realtime_check
1510 cust_bill_realtime_lec
1514 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
1519 my @cust_event = qsearchs({
1520 'table' => 'cust_event',
1521 'select' => 'cust_event.*',
1522 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
1523 'hashref' => { 'status' => 'done' },
1524 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
1525 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
1528 my %seen_invnum = ();
1529 foreach my $cust_event (@cust_event) {
1531 #max one for the customer, one for each open invoice
1532 my $cust_X = $cust_event->cust_X;
1533 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
1537 or $cust_event->part_event->eventtable eq 'cust_bill'
1540 my $error = $cust_event->retry;
1542 $dbh->rollback if $oldAutoCommit;
1543 return "error scheduling event for retry: $error";
1548 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1553 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
1555 Runs billing events; see L<FS::part_event> and the billing events web
1558 If there is an error, returns the error, otherwise returns false.
1560 Options are passed as name-value pairs.
1562 Currently available options are:
1568 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.
1572 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1576 "collect" (the default) or "pre-bill"
1580 set true to surpress email card/ACH decline notices.
1584 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)
1591 # allows for one time override of normal customer billing method
1595 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1598 my( $self, %options ) = @_;
1600 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1602 my $time = $options{'time'} || time;
1605 local $SIG{HUP} = 'IGNORE';
1606 local $SIG{INT} = 'IGNORE';
1607 local $SIG{QUIT} = 'IGNORE';
1608 local $SIG{TERM} = 'IGNORE';
1609 local $SIG{TSTP} = 'IGNORE';
1610 local $SIG{PIPE} = 'IGNORE';
1612 my $oldAutoCommit = $FS::UID::AutoCommit;
1613 local $FS::UID::AutoCommit = 0;
1616 $self->select_for_update; #mutex
1619 my $balance = $self->balance;
1620 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
1623 # if ( exists($options{'retry_card'}) ) {
1624 # carp 'retry_card option passed to collect is deprecated; use retry';
1625 # $options{'retry'} ||= $options{'retry_card'};
1627 # if ( exists($options{'retry'}) && $options{'retry'} ) {
1628 # my $error = $self->retry_realtime;
1630 # $dbh->rollback if $oldAutoCommit;
1635 # false laziness w/pay_batch::import_results
1637 my $due_cust_event = $self->due_cust_event(
1638 'debug' => ( $options{'debug'} || 0 ),
1640 'check_freq' => $options{'check_freq'},
1641 'stage' => ( $options{'stage'} || 'collect' ),
1643 unless( ref($due_cust_event) ) {
1644 $dbh->rollback if $oldAutoCommit;
1645 return $due_cust_event;
1648 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1649 #never want to roll back an event just because it or a different one
1651 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1653 foreach my $cust_event ( @$due_cust_event ) {
1657 #re-eval event conditions (a previous event could have changed things)
1658 unless ( $cust_event->test_conditions( 'time' => $time ) ) {
1659 #don't leave stray "new/locked" records around
1660 my $error = $cust_event->delete;
1661 return $error if $error;
1666 local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
1667 if $options{'quiet'};
1668 warn " running cust_event ". $cust_event->eventnum. "\n"
1671 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
1672 if ( my $error = $cust_event->do_event( 'time' => $time ) ) {
1673 #XXX wtf is this? figure out a proper dealio with return value
1685 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
1687 Inserts database records for and returns an ordered listref of new events due
1688 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
1689 events are due, an empty listref is returned. If there is an error, returns a
1690 scalar error message.
1692 To actually run the events, call each event's test_condition method, and if
1693 still true, call the event's do_event method.
1695 Options are passed as a hashref or as a list of name-value pairs. Available
1702 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.
1706 "collect" (the default) or "pre-bill"
1710 "Current time" for the events.
1714 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)
1718 Only return events for the specified eventtable (by default, events of all eventtables are returned)
1722 Explicitly pass the objects to be tested (typically used with eventtable).
1726 Set to true to return the objects, but not actually insert them into the
1733 sub due_cust_event {
1735 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
1738 #my $DEBUG = $opt{'debug'}
1739 local($DEBUG) = $opt{'debug'}
1740 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
1741 $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1743 warn "$me due_cust_event called with options ".
1744 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
1747 $opt{'time'} ||= time;
1749 local $SIG{HUP} = 'IGNORE';
1750 local $SIG{INT} = 'IGNORE';
1751 local $SIG{QUIT} = 'IGNORE';
1752 local $SIG{TERM} = 'IGNORE';
1753 local $SIG{TSTP} = 'IGNORE';
1754 local $SIG{PIPE} = 'IGNORE';
1756 my $oldAutoCommit = $FS::UID::AutoCommit;
1757 local $FS::UID::AutoCommit = 0;
1760 $self->select_for_update #mutex
1761 unless $opt{testonly};
1764 # find possible events (initial search)
1767 my @cust_event = ();
1769 my @eventtable = $opt{'eventtable'}
1770 ? ( $opt{'eventtable'} )
1771 : FS::part_event->eventtables_runorder;
1773 my $check_freq = $opt{'check_freq'} || '1d';
1775 foreach my $eventtable ( @eventtable ) {
1778 if ( $opt{'objects'} ) {
1780 @objects = @{ $opt{'objects'} };
1784 #my @objects = $self->$eventtable(); # sub cust_main { @{ [ $self ] }; }
1785 if ( $eventtable eq 'cust_main' ) {
1786 @objects = ( $self );
1790 "LEFT JOIN cust_main USING ( custnum )";
1792 #some false laziness w/Cron::bill bill_where
1794 my $join = FS::part_event_condition->join_conditions_sql( $eventtable);
1795 my $where = FS::part_event_condition->where_conditions_sql($eventtable,
1796 'time'=>$opt{'time'},
1798 $where = $where ? "AND $where" : '';
1800 my $are_part_event =
1801 "EXISTS ( SELECT 1 FROM part_event $join
1802 WHERE check_freq = '$check_freq'
1803 AND eventtable = '$eventtable'
1804 AND ( disabled = '' OR disabled IS NULL )
1810 @objects = $self->$eventtable(
1811 'addl_from' => $cm_join,
1812 'extra_sql' => " AND $are_part_event",
1818 my @e_cust_event = ();
1820 my $cross = "CROSS JOIN $eventtable";
1821 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
1822 unless $eventtable eq 'cust_main';
1824 foreach my $object ( @objects ) {
1826 #this first search uses the condition_sql magic for optimization.
1827 #the more possible events we can eliminate in this step the better
1829 my $cross_where = '';
1830 my $pkey = $object->primary_key;
1831 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
1833 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
1835 FS::part_event_condition->where_conditions_sql( $eventtable,
1836 'time'=>$opt{'time'}
1838 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
1840 $extra_sql = "AND $extra_sql" if $extra_sql;
1842 #here is the agent virtualization
1843 $extra_sql .= " AND ( part_event.agentnum IS NULL
1844 OR part_event.agentnum = ". $self->agentnum. ' )';
1846 $extra_sql .= " $order";
1848 warn "searching for events for $eventtable ". $object->$pkey. "\n"
1849 if $opt{'debug'} > 2;
1850 my @part_event = qsearch( {
1851 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
1852 'select' => 'part_event.*',
1853 'table' => 'part_event',
1854 'addl_from' => "$cross $join",
1855 'hashref' => { 'check_freq' => $check_freq,
1856 'eventtable' => $eventtable,
1859 'extra_sql' => "AND $cross_where $extra_sql",
1863 my $pkey = $object->primary_key;
1864 warn " ". scalar(@part_event).
1865 " possible events found for $eventtable ". $object->$pkey(). "\n";
1868 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
1872 warn " ". scalar(@e_cust_event).
1873 " subtotal possible cust events found for $eventtable\n"
1876 push @cust_event, @e_cust_event;
1880 warn " ". scalar(@cust_event).
1881 " total possible cust events found in initial search\n"
1889 $opt{stage} ||= 'collect';
1891 grep { my $stage = $_->part_event->event_stage;
1892 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
1902 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
1903 'stats_hashref' => \%unsat ),
1906 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
1909 warn " invalid conditions not eliminated with condition_sql:\n".
1910 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
1911 if keys %unsat && $DEBUG; # > 1;
1917 unless( $opt{testonly} ) {
1918 foreach my $cust_event ( @cust_event ) {
1920 my $error = $cust_event->insert();
1922 $dbh->rollback if $oldAutoCommit;
1929 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1935 warn " returning events: ". Dumper(@cust_event). "\n"
1942 =item apply_payments_and_credits [ OPTION => VALUE ... ]
1944 Applies unapplied payments and credits.
1946 In most cases, this new method should be used in place of sequential
1947 apply_payments and apply_credits methods.
1949 A hash of optional arguments may be passed. Currently "manual" is supported.
1950 If true, a payment receipt is sent instead of a statement when
1951 'payment_receipt_email' configuration option is set.
1953 If there is an error, returns the error, otherwise returns false.
1957 sub apply_payments_and_credits {
1958 my( $self, %options ) = @_;
1960 local $SIG{HUP} = 'IGNORE';
1961 local $SIG{INT} = 'IGNORE';
1962 local $SIG{QUIT} = 'IGNORE';
1963 local $SIG{TERM} = 'IGNORE';
1964 local $SIG{TSTP} = 'IGNORE';
1965 local $SIG{PIPE} = 'IGNORE';
1967 my $oldAutoCommit = $FS::UID::AutoCommit;
1968 local $FS::UID::AutoCommit = 0;
1971 $self->select_for_update; #mutex
1973 foreach my $cust_bill ( $self->open_cust_bill ) {
1974 my $error = $cust_bill->apply_payments_and_credits(%options);
1976 $dbh->rollback if $oldAutoCommit;
1977 return "Error applying: $error";
1981 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1986 =item apply_credits OPTION => VALUE ...
1988 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
1989 to outstanding invoice balances in chronological order (or reverse
1990 chronological order if the I<order> option is set to B<newest>) and returns the
1991 value of any remaining unapplied credits available for refund (see
1992 L<FS::cust_refund>).
1994 Dies if there is an error.
2002 local $SIG{HUP} = 'IGNORE';
2003 local $SIG{INT} = 'IGNORE';
2004 local $SIG{QUIT} = 'IGNORE';
2005 local $SIG{TERM} = 'IGNORE';
2006 local $SIG{TSTP} = 'IGNORE';
2007 local $SIG{PIPE} = 'IGNORE';
2009 my $oldAutoCommit = $FS::UID::AutoCommit;
2010 local $FS::UID::AutoCommit = 0;
2013 $self->select_for_update; #mutex
2015 unless ( $self->total_unapplied_credits ) {
2016 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2020 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
2021 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
2023 my @invoices = $self->open_cust_bill;
2024 @invoices = sort { $b->_date <=> $a->_date } @invoices
2025 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
2027 if ( $conf->exists('pkg-balances') ) {
2028 # limit @credits to those w/ a pkgnum grepped from $self
2030 foreach my $i (@invoices) {
2031 foreach my $li ( $i->cust_bill_pkg ) {
2032 $pkgnums{$li->pkgnum} = 1;
2035 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
2040 foreach my $cust_bill ( @invoices ) {
2042 if ( !defined($credit) || $credit->credited == 0) {
2043 $credit = pop @credits or last;
2047 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
2048 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
2050 $owed = $cust_bill->owed;
2052 unless ( $owed > 0 ) {
2053 push @credits, $credit;
2057 my $amount = min( $credit->credited, $owed );
2059 my $cust_credit_bill = new FS::cust_credit_bill ( {
2060 'crednum' => $credit->crednum,
2061 'invnum' => $cust_bill->invnum,
2062 'amount' => $amount,
2064 $cust_credit_bill->pkgnum( $credit->pkgnum )
2065 if $conf->exists('pkg-balances') && $credit->pkgnum;
2066 my $error = $cust_credit_bill->insert;
2068 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2072 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2076 my $total_unapplied_credits = $self->total_unapplied_credits;
2078 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2080 return $total_unapplied_credits;
2083 =item apply_payments [ OPTION => VALUE ... ]
2085 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2086 to outstanding invoice balances in chronological order.
2088 #and returns the value of any remaining unapplied payments.
2090 A hash of optional arguments may be passed. Currently "manual" is supported.
2091 If true, a payment receipt is sent instead of a statement when
2092 'payment_receipt_email' configuration option is set.
2094 Dies if there is an error.
2098 sub apply_payments {
2099 my( $self, %options ) = @_;
2101 local $SIG{HUP} = 'IGNORE';
2102 local $SIG{INT} = 'IGNORE';
2103 local $SIG{QUIT} = 'IGNORE';
2104 local $SIG{TERM} = 'IGNORE';
2105 local $SIG{TSTP} = 'IGNORE';
2106 local $SIG{PIPE} = 'IGNORE';
2108 my $oldAutoCommit = $FS::UID::AutoCommit;
2109 local $FS::UID::AutoCommit = 0;
2112 $self->select_for_update; #mutex
2116 my @payments = sort { $b->_date <=> $a->_date }
2117 grep { $_->unapplied > 0 }
2120 my @invoices = sort { $a->_date <=> $b->_date}
2121 grep { $_->owed > 0 }
2124 if ( $conf->exists('pkg-balances') ) {
2125 # limit @payments to those w/ a pkgnum grepped from $self
2127 foreach my $i (@invoices) {
2128 foreach my $li ( $i->cust_bill_pkg ) {
2129 $pkgnums{$li->pkgnum} = 1;
2132 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
2137 foreach my $cust_bill ( @invoices ) {
2139 if ( !defined($payment) || $payment->unapplied == 0 ) {
2140 $payment = pop @payments or last;
2144 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
2145 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
2147 $owed = $cust_bill->owed;
2149 unless ( $owed > 0 ) {
2150 push @payments, $payment;
2154 my $amount = min( $payment->unapplied, $owed );
2157 'paynum' => $payment->paynum,
2158 'invnum' => $cust_bill->invnum,
2159 'amount' => $amount,
2161 $cbp->{_date} = $payment->_date
2162 if $options{'manual'} && $options{'backdate_application'};
2163 my $cust_bill_pay = new FS::cust_bill_pay($cbp);
2164 $cust_bill_pay->pkgnum( $payment->pkgnum )
2165 if $conf->exists('pkg-balances') && $payment->pkgnum;
2166 my $error = $cust_bill_pay->insert(%options);
2168 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2172 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2176 my $total_unapplied_payments = $self->total_unapplied_payments;
2178 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2180 return $total_unapplied_payments;
2190 suspend_adjourned_pkgs
2193 (do_cust_event pre-bill)
2196 (vendor-only) _gather_taxes
2197 _omit_zero_value_bundles
2200 apply_payments_and_credits
2209 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>