1 package FS::cust_main::Billing;
4 use vars qw( $conf $DEBUG $me );
7 use List::Util qw( min );
9 use FS::Record qw( qsearch qsearchs dbdef );
10 use FS::Misc::DateTime qw( day_end );
12 use FS::cust_bill_pkg;
13 use FS::cust_bill_pkg_display;
14 use FS::cust_bill_pay;
15 use FS::cust_credit_bill;
16 use FS::cust_tax_adjustment;
18 use FS::tax_rate_location;
19 use FS::cust_bill_pkg_tax_location;
20 use FS::cust_bill_pkg_tax_rate_location;
22 use FS::part_event_condition;
26 # 1 is mostly method/subroutine entry and options
27 # 2 traces progress of some operations
28 # 3 is even more information including possibly sensitive data
30 $me = '[FS::cust_main::Billing]';
32 install_callback FS::UID sub {
34 #yes, need it for stuff below (prolly should be cached)
39 FS::cust_main::Billing - Billing mixin for cust_main
45 These methods are available on FS::cust_main objects.
51 =item bill_and_collect
53 Cancels and suspends any packages due, generates bills, applies payments and
54 credits, and applies collection events to run cards, send bills and notices,
57 By default, warns on errors and continues with the next operation (but see the
60 Options are passed as name-value pairs. Currently available options are:
66 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:
70 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
74 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.
78 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
82 If set true, re-charges setup fees.
86 If set any errors prevent subsequent operations from continusing. If set
87 specifically to "return", returns the error (or false, if there is no error).
88 Any other true value causes errors to die.
92 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)
96 Optional FS::queue entry to receive status updates.
100 Options are passed to the B<bill> and B<collect> methods verbatim, so all
101 options of those methods are also available.
105 sub bill_and_collect {
106 my( $self, %options ) = @_;
108 my $log = FS::Log->new('bill_and_collect');
109 $log->debug('start', object => $self, agentnum => $self->agentnum);
113 #$options{actual_time} not $options{time} because freeside-daily -d is for
114 #pre-printing invoices
116 $options{'actual_time'} ||= time;
117 my $job = $options{'job'};
119 my $actual_time = ( $conf->exists('next-bill-ignore-time')
120 ? day_end( $options{actual_time} )
121 : $options{actual_time}
124 $job->update_statustext('0,cleaning expired packages') if $job;
125 $error = $self->cancel_expired_pkgs( $actual_time );
127 $error = "Error expiring custnum ". $self->custnum. ": $error";
128 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
129 elsif ( $options{fatal} ) { die $error; }
130 else { warn $error; }
133 $error = $self->suspend_adjourned_pkgs( $actual_time );
135 $error = "Error adjourning 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 $error = $self->unsuspend_resumed_pkgs( $actual_time );
143 $error = "Error resuming custnum ".$self->custnum. ": $error";
144 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
145 elsif ( $options{fatal} ) { die $error; }
146 else { warn $error; }
149 $job->update_statustext('20,billing packages') if $job;
150 $error = $self->bill( %options );
152 $error = "Error billing custnum ". $self->custnum. ": $error";
153 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
154 elsif ( $options{fatal} ) { die $error; }
155 else { warn $error; }
158 $job->update_statustext('50,applying payments and credits') if $job;
159 $error = $self->apply_payments_and_credits;
161 $error = "Error applying custnum ". $self->custnum. ": $error";
162 if ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
163 elsif ( $options{fatal} ) { die $error; }
164 else { warn $error; }
167 $job->update_statustext('70,running collection events') if $job;
168 unless ( $conf->exists('cancelled_cust-noevents')
169 && ! $self->num_ncancelled_pkgs
171 $error = $self->collect( %options );
173 $error = "Error collecting custnum ". $self->custnum. ": $error";
174 if ($options{fatal} && $options{fatal} eq 'return') { return $error; }
175 elsif ($options{fatal} ) { die $error; }
176 else { warn $error; }
179 $job->update_statustext('100,finished') if $job;
180 $log->debug('finish', object => $self, agentnum => $self->agentnum);
186 sub cancel_expired_pkgs {
187 my ( $self, $time, %options ) = @_;
189 my @cancel_pkgs = $self->ncancelled_pkgs( {
190 'extra_sql' => " AND expire IS NOT NULL AND expire > 0 AND expire <= $time "
195 foreach my $cust_pkg ( @cancel_pkgs ) {
196 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
197 my $error = $cust_pkg->cancel($cpr ? ( 'reason' => $cpr->reasonnum,
198 'reason_otaker' => $cpr->otaker,
203 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
206 join(' / ', @errors);
210 sub suspend_adjourned_pkgs {
211 my ( $self, $time, %options ) = @_;
213 my @susp_pkgs = $self->ncancelled_pkgs( {
215 " AND ( susp IS NULL OR susp = 0 )
216 AND ( ( bill IS NOT NULL AND bill != 0 AND bill < $time )
217 OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
222 #only because there's no SQL test for is_prepaid :/
224 grep { ( $_->part_pkg->is_prepaid
229 && $_->adjourn <= $time
237 foreach my $cust_pkg ( @susp_pkgs ) {
238 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
239 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
240 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
241 'reason_otaker' => $cpr->otaker
245 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
248 join(' / ', @errors);
252 sub unsuspend_resumed_pkgs {
253 my ( $self, $time, %options ) = @_;
255 my @unsusp_pkgs = $self->ncancelled_pkgs( {
256 'extra_sql' => " AND resume IS NOT NULL AND resume > 0 AND resume <= $time "
261 foreach my $cust_pkg ( @unsusp_pkgs ) {
262 my $error = $cust_pkg->unsuspend( 'time' => $time );
263 push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
266 join(' / ', @errors);
272 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
273 conjunction with the collect method by calling B<bill_and_collect>.
275 If there is an error, returns the error, otherwise returns false.
277 Options are passed as name-value pairs. Currently available options are:
283 If set true, re-charges setup fees.
287 If set true then only bill recurring charges, not setup, usage, one time
292 If set, then override the normal frequency and look for a part_pkg_discount
293 to take at that frequency. This is appropriate only when the normal
294 frequency for all packages is monthly, and is an error otherwise. Use
295 C<pkg_list> to limit the set of packages included in billing.
299 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:
303 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
307 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
309 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
313 A hashref of pkgparts to exclude from this billing run (can also be specified as a comma-separated scalar).
317 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.
321 This boolean value informs the us that the package is being cancelled. This
322 typically might mean not charging the normal recurring fee but only usage
323 fees since the last billing. Setup charges may be charged. Not all package
324 plans support this feature (they tend to charge 0).
328 Prevent the resetting of usage limits during this call.
332 Do not save the generated bill in the database. Useful with return_bill
336 A list reference on which the generated bill(s) will be returned.
340 Optional terms to be printed on this invoice. Otherwise, customer-specific
341 terms or the default terms are used.
348 my( $self, %options ) = @_;
350 return '' if $self->payby eq 'COMP';
352 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
354 warn "$me bill customer ". $self->custnum. "\n"
357 my $time = $options{'time'} || time;
358 my $invoice_time = $options{'invoice_time'} || $time;
360 $options{'not_pkgpart'} ||= {};
361 $options{'not_pkgpart'} = { map { $_ => 1 }
362 split(/\s*,\s*/, $options{'not_pkgpart'})
364 unless ref($options{'not_pkgpart'});
366 local $SIG{HUP} = 'IGNORE';
367 local $SIG{INT} = 'IGNORE';
368 local $SIG{QUIT} = 'IGNORE';
369 local $SIG{TERM} = 'IGNORE';
370 local $SIG{TSTP} = 'IGNORE';
371 local $SIG{PIPE} = 'IGNORE';
373 my $oldAutoCommit = $FS::UID::AutoCommit;
374 local $FS::UID::AutoCommit = 0;
377 warn "$me acquiring lock on customer ". $self->custnum. "\n"
380 $self->select_for_update; #mutex
382 warn "$me running pre-bill events for customer ". $self->custnum. "\n"
385 my $error = $self->do_cust_event(
386 'debug' => ( $options{'debug'} || 0 ),
387 'time' => $invoice_time,
388 'check_freq' => $options{'check_freq'},
389 'stage' => 'pre-bill',
391 unless $options{no_commit};
393 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
397 warn "$me done running pre-bill events for customer ". $self->custnum. "\n"
400 #keep auto-charge and non-auto-charge line items separate
401 my @passes = ( '', 'no_auto' );
403 my %cust_bill_pkg = map { $_ => [] } @passes;
406 # find the packages which are due for billing, find out how much they are
407 # & generate invoice database.
410 my %total_setup = map { my $z = 0; $_ => \$z; } @passes;
411 my %total_recur = map { my $z = 0; $_ => \$z; } @passes;
413 my %taxlisthash = map { $_ => {} } @passes;
415 my @precommit_hooks = ();
417 $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ]; #param checks?
419 foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
421 next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
423 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG;
425 #? to avoid use of uninitialized value errors... ?
426 $cust_pkg->setfield('bill', '')
427 unless defined($cust_pkg->bill);
429 #my $part_pkg = $cust_pkg->part_pkg;
431 my $real_pkgpart = $cust_pkg->pkgpart;
432 my %hash = $cust_pkg->hash;
434 # we could implement this bit as FS::part_pkg::has_hidden, but we already
435 # suffer from performance issues
436 $options{has_hidden} = 0;
437 my @part_pkg = $cust_pkg->part_pkg->self_and_bill_linked;
438 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
440 foreach my $part_pkg ( @part_pkg ) {
442 $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
444 my $pass = ($cust_pkg->no_auto || $part_pkg->no_auto) ? 'no_auto' : '';
446 my $next_bill = $cust_pkg->getfield('bill') || 0;
448 # let this run once if this is the last bill upon cancellation
449 while ( $next_bill <= $time or $options{cancel} ) {
451 $self->_make_lines( 'part_pkg' => $part_pkg,
452 'cust_pkg' => $cust_pkg,
453 'precommit_hooks' => \@precommit_hooks,
454 'line_items' => $cust_bill_pkg{$pass},
455 'setup' => $total_setup{$pass},
456 'recur' => $total_recur{$pass},
457 'tax_matrix' => $taxlisthash{$pass},
459 'real_pkgpart' => $real_pkgpart,
460 'options' => \%options,
463 # Stop if anything goes wrong
466 # or if we're not incrementing the bill date.
467 last if ($cust_pkg->getfield('bill') || 0) == $next_bill;
469 # or if we're letting it run only once
470 last if $options{cancel};
472 $next_bill = $cust_pkg->getfield('bill') || 0;
474 #stop if -o was passed to freeside-daily
475 last if $options{'one_recur'};
478 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
482 } #foreach my $part_pkg
484 } #foreach my $cust_pkg
486 #if the customer isn't on an automatic payby, everything can go on a single
488 #if ( $cust_main->payby !~ /^(CARD|CHEK)$/ ) {
489 #merge everything into one list
492 foreach my $pass (@passes) { # keys %cust_bill_pkg ) {
494 my @cust_bill_pkg = _omit_zero_value_bundles(@{ $cust_bill_pkg{$pass} });
496 next unless @cust_bill_pkg; #don't create an invoice w/o line items
498 warn "$me billing pass $pass\n"
499 #.Dumper(\@cust_bill_pkg)."\n"
502 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
503 !$conf->exists('postal_invoice-recurring_only')
507 my $postal_pkg = $self->charge_postal_fee();
508 if ( $postal_pkg && !ref( $postal_pkg ) ) {
510 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
511 return "can't charge postal invoice fee for customer ".
512 $self->custnum. ": $postal_pkg";
514 } elsif ( $postal_pkg ) {
516 my $real_pkgpart = $postal_pkg->pkgpart;
517 # we could implement this bit as FS::part_pkg::has_hidden, but we already
518 # suffer from performance issues
519 $options{has_hidden} = 0;
520 my @part_pkg = $postal_pkg->part_pkg->self_and_bill_linked;
521 $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
523 foreach my $part_pkg ( @part_pkg ) {
524 my %postal_options = %options;
525 delete $postal_options{cancel};
527 $self->_make_lines( 'part_pkg' => $part_pkg,
528 'cust_pkg' => $postal_pkg,
529 'precommit_hooks' => \@precommit_hooks,
530 'line_items' => \@cust_bill_pkg,
531 'setup' => $total_setup{$pass},
532 'recur' => $total_recur{$pass},
533 'tax_matrix' => $taxlisthash{$pass},
535 'real_pkgpart' => $real_pkgpart,
536 'options' => \%postal_options,
539 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
544 # it's silly to have a zero value postal_pkg, but....
545 @cust_bill_pkg = _omit_zero_value_bundles(@cust_bill_pkg);
551 my $listref_or_error =
552 $self->calculate_taxes( \@cust_bill_pkg, $taxlisthash{$pass}, $invoice_time);
554 unless ( ref( $listref_or_error ) ) {
555 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
556 return $listref_or_error;
559 foreach my $taxline ( @$listref_or_error ) {
560 ${ $total_setup{$pass} } =
561 sprintf('%.2f', ${ $total_setup{$pass} } + $taxline->setup );
562 push @cust_bill_pkg, $taxline;
566 warn "adding tax adjustments...\n" if $DEBUG > 2;
567 foreach my $cust_tax_adjustment (
568 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
574 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
576 my $itemdesc = $cust_tax_adjustment->taxname;
577 $itemdesc = '' if $itemdesc eq 'Tax';
579 push @cust_bill_pkg, new FS::cust_bill_pkg {
585 'itemdesc' => $itemdesc,
586 'itemcomment' => $cust_tax_adjustment->comment,
587 'cust_tax_adjustment' => $cust_tax_adjustment,
588 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
593 my $charged = sprintf('%.2f', ${ $total_setup{$pass} } + ${ $total_recur{$pass} } );
595 my @cust_bill = $self->cust_bill;
596 my $balance = $self->balance;
597 my $previous_balance = scalar(@cust_bill)
598 ? ( $cust_bill[$#cust_bill]->billing_balance || 0 )
601 $previous_balance += $cust_bill[$#cust_bill]->charged
602 if scalar(@cust_bill);
603 #my $balance_adjustments =
604 # sprintf('%.2f', $balance - $prior_prior_balance - $prior_charged);
606 warn "creating the new invoice\n" if $DEBUG;
607 #create the new invoice
608 my $cust_bill = new FS::cust_bill ( {
609 'custnum' => $self->custnum,
610 '_date' => $invoice_time,
611 'charged' => $charged,
612 'billing_balance' => $balance,
613 'previous_balance' => $previous_balance,
614 'invoice_terms' => $options{'invoice_terms'},
615 'cust_bill_pkg' => \@cust_bill_pkg,
617 $error = $cust_bill->insert unless $options{no_commit};
619 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
620 return "can't create invoice for customer #". $self->custnum. ": $error";
622 push @{$options{return_bill}}, $cust_bill if $options{return_bill};
624 } #foreach my $pass ( keys %cust_bill_pkg )
626 foreach my $hook ( @precommit_hooks ) {
629 } unless $options{no_commit};
631 $dbh->rollback if $oldAutoCommit && !$options{no_commit};
632 return "$@ running precommit hook $hook\n";
636 $dbh->commit or die $dbh->errstr if $oldAutoCommit && !$options{no_commit};
641 #discard bundled packages of 0 value
642 sub _omit_zero_value_bundles {
645 my @cust_bill_pkg = ();
646 my @cust_bill_pkg_bundle = ();
648 my $discount_show_always = 0;
650 foreach my $cust_bill_pkg ( @in ) {
652 $discount_show_always = ($cust_bill_pkg->get('discounts')
653 && scalar(@{$cust_bill_pkg->get('discounts')})
654 && $conf->exists('discount-show-always'));
656 warn " pkgnum ". $cust_bill_pkg->pkgnum. " sum $sum, ".
657 "setup_show_zero ". $cust_bill_pkg->setup_show_zero.
658 "recur_show_zero ". $cust_bill_pkg->recur_show_zero. "\n"
661 if (scalar(@cust_bill_pkg_bundle) && !$cust_bill_pkg->pkgpart_override) {
662 push @cust_bill_pkg, @cust_bill_pkg_bundle
664 || ($sum == 0 && ( $discount_show_always
665 || grep {$_->recur_show_zero || $_->setup_show_zero}
666 @cust_bill_pkg_bundle
669 @cust_bill_pkg_bundle = ();
673 $sum += $cust_bill_pkg->setup + $cust_bill_pkg->recur;
674 push @cust_bill_pkg_bundle, $cust_bill_pkg;
678 push @cust_bill_pkg, @cust_bill_pkg_bundle
680 || ($sum == 0 && ( $discount_show_always
681 || grep {$_->recur_show_zero || $_->setup_show_zero}
682 @cust_bill_pkg_bundle
686 warn " _omit_zero_value_bundles: ". scalar(@in).
687 '->'. scalar(@cust_bill_pkg). "\n" #. Dumper(@cust_bill_pkg). "\n"
694 =item calculate_taxes LINEITEMREF TAXHASHREF INVOICE_TIME
696 Generates tax line items (see L<FS::cust_bill_pkg>) for this customer.
697 Usually used internally by bill method B<bill>.
699 If there is an error, returns the error, otherwise returns reference to a
700 list of line items suitable for insertion.
706 An array ref of the line items being billed.
710 A strange beast. The keys to this hash are internal identifiers consisting
711 of the name of the tax object type, a space, and its unique identifier ( e.g.
712 'cust_main_county 23' ). The values of the hash are listrefs. The first
713 item in the list is the tax object. The remaining items are either line
714 items or floating point values (currency amounts).
716 The taxes are calculated on this entity. Calculated exemption records are
717 transferred to the LINEITEMREF items on the assumption that they are related.
723 This specifies the date appearing on the associated invoice. Some
724 jurisdictions (i.e. Texas) have tax exemptions which are date sensitive.
730 sub calculate_taxes {
731 my ($self, $cust_bill_pkg, $taxlisthash, $invoice_time) = @_;
733 # $taxlisthash is a hashref
734 # keys are identifiers, values are arrayrefs
735 # each arrayref starts with a tax object (cust_main_county or tax_rate)
736 # then any cust_bill_pkg objects the tax applies to
738 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
740 warn "$me calculate_taxes\n"
741 #.Dumper($self, $cust_bill_pkg, $taxlisthash, $invoice_time). "\n"
744 my @tax_line_items = ();
746 # keys are tax names (as printed on invoices / itemdesc )
747 # values are arrayrefs of taxlisthash keys (internal identifiers)
750 # keys are taxlisthash keys (internal identifiers)
751 # values are (cumulative) amounts
754 # keys are taxlisthash keys (internal identifiers)
755 # values are arrayrefs of cust_bill_pkg_tax_location hashrefs
756 my %tax_location = ();
758 # keys are taxlisthash keys (internal identifiers)
759 # values are arrayrefs of cust_bill_pkg_tax_rate_location hashrefs
760 my %tax_rate_location = ();
762 # keys are taxlisthash keys (internal identifiers!)
763 # values are arrayrefs of cust_tax_exempt_pkg objects
766 foreach my $tax ( keys %$taxlisthash ) {
767 # $tax is a tax identifier (intersection of a tax definition record
768 # and a cust_bill_pkg record)
769 my $tax_object = shift @{ $taxlisthash->{$tax} };
770 # $tax_object is a cust_main_county or tax_rate
771 # (with billpkgnum, pkgnum, locationnum set)
772 # the rest of @{ $taxlisthash->{$tax} } is cust_bill_pkg component objects
773 # (setup, recurring, usage classes)
774 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
775 warn " ". join('/', @{ $taxlisthash->{$tax} } ). "\n" if $DEBUG > 2;
776 # taxline calculates the tax on all cust_bill_pkgs in the
777 # first (arrayref) argument, and returns a hashref of 'name'
778 # (the line item description) and 'amount'.
779 # It also calculates exemptions and attaches them to the cust_bill_pkgs
781 my $taxables = $taxlisthash->{$tax};
782 my $exemptions = $tax_exemption{$tax} ||= [];
783 my $taxline = $tax_object->taxline(
785 'custnum' => $self->custnum,
786 'invoice_time' => $invoice_time,
787 'exemptions' => $exemptions,
789 return $taxline unless ref($taxline);
791 unshift @{ $taxlisthash->{$tax} }, $tax_object;
793 if ( $tax_object->isa('FS::cust_main_county') ) {
794 # then $taxline is a real line item
795 push @{ $taxname{ $taxline->itemdesc } }, $taxline;
798 # leave this as is for now
800 my $name = $taxline->{'name'};
801 my $amount = $taxline->{'amount'};
803 #warn "adding $amount as $name\n";
804 $taxname{ $name } ||= [];
805 push @{ $taxname{ $name } }, $tax;
807 $tax_amount{ $tax } += $amount;
809 # link records between cust_main_county/tax_rate and cust_location
810 $tax_rate_location{ $tax } ||= [];
811 my $taxratelocationnum =
812 $tax_object->tax_rate_location->taxratelocationnum;
813 push @{ $tax_rate_location{ $tax } },
815 'taxnum' => $tax_object->taxnum,
816 'taxtype' => ref($tax_object),
817 'amount' => sprintf('%.2f', $amount ),
818 'locationtaxid' => $tax_object->location,
819 'taxratelocationnum' => $taxratelocationnum,
821 } #if ref($tax_object)...
822 } #foreach keys %$taxlisthash
824 #consolidate and create tax line items
825 warn "consolidating and generating...\n" if $DEBUG > 2;
826 foreach my $taxname ( keys %taxname ) {
827 my @cust_bill_pkg_tax_location;
828 my @cust_bill_pkg_tax_rate_location;
829 my $tax_cust_bill_pkg = FS::cust_bill_pkg->new({
834 'itemdesc' => $taxname,
835 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
836 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
841 warn "adding $taxname\n" if $DEBUG > 1;
842 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
843 if ( ref($taxitem) eq 'FS::cust_bill_pkg' ) {
844 # then we need to transfer the amount and the links from the
845 # line item to the new one we're creating.
846 $tax_total += $taxitem->setup;
847 foreach my $link ( @{ $taxitem->get('cust_bill_pkg_tax_location') } ) {
848 $link->set('tax_cust_bill_pkg', $tax_cust_bill_pkg);
849 push @cust_bill_pkg_tax_location, $link;
853 next if $seen{$taxitem}++;
854 warn "adding $tax_amount{$taxitem}\n" if $DEBUG > 1;
855 $tax_total += $tax_amount{$taxitem};
856 push @cust_bill_pkg_tax_rate_location,
857 map { new FS::cust_bill_pkg_tax_rate_location $_ }
858 @{ $tax_rate_location{ $taxitem } };
861 next unless $tax_total;
863 # we should really neverround this up...I guess it's okay if taxline
864 # already returns amounts with 2 decimal places
865 $tax_total = sprintf('%.2f', $tax_total );
866 $tax_cust_bill_pkg->set('setup', $tax_total);
868 my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
874 if ( $pkg_category and
875 $conf->config('invoice_latexsummary') ||
876 $conf->config('invoice_htmlsummary')
880 my %hash = ( 'section' => $pkg_category->categoryname );
881 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
884 $tax_cust_bill_pkg->set('display', \@display);
886 push @tax_line_items, $tax_cust_bill_pkg;
893 my ($self, %params) = @_;
895 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
897 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
898 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
899 my $precommit_hooks = $params{precommit_hooks} or die "no precommit_hooks specified";
900 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
901 my $total_setup = $params{setup} or die "no setup accumulator specified";
902 my $total_recur = $params{recur} or die "no recur accumulator specified";
903 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
904 my $time = $params{'time'} or die "no time specified";
905 my (%options) = %{$params{options}};
907 if ( $part_pkg->freq ne '1' and ($options{'freq_override'} || 0) > 0 ) {
908 # this should never happen
909 die 'freq_override billing attempted on non-monthly package '.
914 my $real_pkgpart = $params{real_pkgpart};
915 my %hash = $cust_pkg->hash;
916 my $old_cust_pkg = new FS::cust_pkg \%hash;
921 $cust_pkg->pkgpart($part_pkg->pkgpart);
923 my $cmp_time = ( $conf->exists('next-bill-ignore-time')
934 my @setup_discounts = ();
935 my %setup_param = ( 'discounts' => \@setup_discounts );
936 if ( ! $options{recurring_only}
937 and ! $options{cancel}
938 and ( $options{'resetup'}
939 || ( ! $cust_pkg->setup
940 && ( ! $cust_pkg->start_date
941 || $cust_pkg->start_date <= $cmp_time
943 && ( ! $conf->exists('disable_setup_suspended_pkgs')
944 || ( $conf->exists('disable_setup_suspended_pkgs') &&
945 ! $cust_pkg->getfield('susp')
953 warn " bill setup\n" if $DEBUG > 1;
955 unless ( $cust_pkg->waive_setup ) {
958 $setup = eval { $cust_pkg->calc_setup( $time, \@details, \%setup_param ) };
959 return "$@ running calc_setup for $cust_pkg\n"
962 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
965 $cust_pkg->setfield('setup', $time)
966 unless $cust_pkg->setup;
967 #do need it, but it won't get written to the db
968 #|| $cust_pkg->pkgpart != $real_pkgpart;
970 $cust_pkg->setfield('start_date', '')
971 if $cust_pkg->start_date;
981 my @recur_discounts = ();
983 if ( ! $cust_pkg->start_date
984 and ( ! $cust_pkg->susp || $cust_pkg->option('suspend_bill',1)
985 || ( $part_pkg->option('suspend_bill', 1) )
986 && ! $cust_pkg->option('no_suspend_bill',1)
989 ( $part_pkg->freq ne '0' && ( $cust_pkg->bill || 0 ) <= $cmp_time )
990 || ( $part_pkg->plan eq 'voip_cdr'
991 && $part_pkg->option('bill_every_call')
996 # XXX should this be a package event? probably. events are called
997 # at collection time at the moment, though...
998 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
999 if $part_pkg->can('reset_usage') && !$options{'no_usage_reset'};
1000 #don't want to reset usage just cause we want a line item??
1001 #&& $part_pkg->pkgpart == $real_pkgpart;
1003 warn " bill recur\n" if $DEBUG > 1;
1006 # XXX shared with $recur_prog
1007 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
1011 #over two params! lets at least switch to a hashref for the rest...
1012 my $increment_next_bill = ( $part_pkg->freq ne '0'
1013 && ( $cust_pkg->getfield('bill') || 0 ) <= $cmp_time
1014 && !$options{cancel}
1016 my %param = ( %setup_param,
1017 'precommit_hooks' => $precommit_hooks,
1018 'increment_next_bill' => $increment_next_bill,
1019 'discounts' => \@recur_discounts,
1020 'real_pkgpart' => $real_pkgpart,
1021 'freq_override' => $options{freq_override} || '',
1025 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
1027 # There may be some part_pkg for which this is wrong. Only those
1028 # which can_discount are supported.
1029 # (the UI should prevent adding discounts to these at the moment)
1031 warn "calling $method on cust_pkg ". $cust_pkg->pkgnum.
1032 " for pkgpart ". $cust_pkg->pkgpart.
1033 " with params ". join(' / ', map "$_=>$param{$_}", keys %param). "\n"
1036 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
1037 return "$@ running $method for $cust_pkg\n"
1041 $unitrecur = $cust_pkg->part_pkg->base_recur || $recur; #XXX uuh
1043 if ( $increment_next_bill ) {
1047 if ( my $main_pkg = $cust_pkg->main_pkg ) {
1048 # supplemental package
1049 # to keep in sync with the main package, simulate billing at
1051 my $main_pkg_freq = $main_pkg->part_pkg->freq;
1052 my $supp_pkg_freq = $part_pkg->freq;
1053 my $ratio = $supp_pkg_freq / $main_pkg_freq;
1054 if ( $ratio != int($ratio) ) {
1055 # the UI should prevent setting up packages like this, but just
1057 return "supplemental package period is not an integer multiple of main package period";
1059 $next_bill = $sdate;
1061 $next_bill = $part_pkg->add_freq( $next_bill, $main_pkg_freq );
1066 $next_bill = $part_pkg->add_freq($sdate, $options{freq_override} || 0);
1067 return "unparsable frequency: ". $part_pkg->freq
1068 if $next_bill == -1;
1071 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
1072 # only for figuring next bill date, nothing else, so, reset $sdate again
1074 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1075 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
1076 $cust_pkg->last_bill($sdate);
1078 $cust_pkg->setfield('bill', $next_bill );
1082 if ( $param{'setup_fee'} ) {
1083 # Add an additional setup fee at the billing stage.
1084 # Used for prorate_defer_bill.
1085 $setup += $param{'setup_fee'};
1086 $unitsetup += $param{'setup_fee'};
1090 if ( defined $param{'discount_left_setup'} ) {
1091 foreach my $discount_setup ( values %{$param{'discount_left_setup'}} ) {
1092 $setup -= $discount_setup;
1098 warn "\$setup is undefined" unless defined($setup);
1099 warn "\$recur is undefined" unless defined($recur);
1100 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1103 # If there's line items, create em cust_bill_pkg records
1104 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
1109 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
1110 # hmm.. and if just the options are modified in some weird price plan?
1112 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
1115 my $error = $cust_pkg->replace( $old_cust_pkg,
1116 'depend_jobnum'=>$options{depend_jobnum},
1117 'options' => { $cust_pkg->options },
1119 unless $options{no_commit};
1120 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
1121 if $error; #just in case
1124 $setup = sprintf( "%.2f", $setup );
1125 $recur = sprintf( "%.2f", $recur );
1126 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
1127 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1129 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
1130 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
1133 my $discount_show_always = $conf->exists('discount-show-always')
1134 && ( ($setup == 0 && scalar(@setup_discounts))
1135 || ($recur == 0 && scalar(@recur_discounts))
1140 || (!$part_pkg->hidden && $options{has_hidden}) #include some $0 lines
1141 || $discount_show_always
1142 || ($setup == 0 && $cust_pkg->_X_show_zero('setup'))
1143 || ($recur == 0 && $cust_pkg->_X_show_zero('recur'))
1147 warn " charges (setup=$setup, recur=$recur); adding line items\n"
1150 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
1152 warn " adding customer package invoice detail: $_\n"
1153 foreach @cust_pkg_detail;
1155 push @details, @cust_pkg_detail;
1157 my $cust_bill_pkg = new FS::cust_bill_pkg {
1158 'pkgnum' => $cust_pkg->pkgnum,
1160 'unitsetup' => $unitsetup,
1162 'unitrecur' => $unitrecur,
1163 'quantity' => $cust_pkg->quantity,
1164 'details' => \@details,
1165 'discounts' => [ @setup_discounts, @recur_discounts ],
1166 'hidden' => $part_pkg->hidden,
1167 'freq' => $part_pkg->freq,
1170 if ( $part_pkg->option('prorate_defer_bill',1)
1171 and !$hash{last_bill} ) {
1172 # both preceding and upcoming, technically
1173 $cust_bill_pkg->sdate( $cust_pkg->setup );
1174 $cust_bill_pkg->edate( $cust_pkg->bill );
1175 } elsif ( $part_pkg->recur_temporality eq 'preceding' ) {
1176 $cust_bill_pkg->sdate( $hash{last_bill} );
1177 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
1178 $cust_bill_pkg->edate( $time ) if $options{cancel};
1179 } else { #if ( $part_pkg->recur_temporality eq 'upcoming' ) {
1180 $cust_bill_pkg->sdate( $sdate );
1181 $cust_bill_pkg->edate( $cust_pkg->bill );
1182 #$cust_bill_pkg->edate( $time ) if $options{cancel};
1185 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
1186 unless $part_pkg->pkgpart == $real_pkgpart;
1188 $$total_setup += $setup;
1189 $$total_recur += $recur;
1195 #unless ( $discount_show_always ) { # oh, for god's sake
1196 my $error = $self->_handle_taxes(
1201 $options{invoice_time},
1203 \%options # I have serious objections to this
1205 return $error if $error;
1208 $cust_bill_pkg->set_display(
1209 part_pkg => $part_pkg,
1210 real_pkgpart => $real_pkgpart,
1213 push @$cust_bill_pkgs, $cust_bill_pkg;
1215 } #if $setup != 0 || $recur != 0
1223 # This is _handle_taxes. It's called once for each cust_bill_pkg generated
1224 # from _make_lines, along with the part_pkg, cust_pkg, invoice time, the
1225 # non-overridden pkgpart, a flag indicating whether the package is being
1226 # canceled, and a partridge in a pear tree.
1228 # The most important argument is 'taxlisthash'. This is shared across the
1229 # entire invoice. It looks like this:
1231 # 'cust_main_county 1001' => [ [FS::cust_main_county], ... ],
1232 # 'cust_main_county 1002' => [ [FS::cust_main_county], ... ],
1235 # 'cust_main_county' can also be 'tax_rate'. The first object in the array
1236 # is always the cust_main_county or tax_rate identified by the key.
1238 # That "..." is a list of FS::cust_bill_pkg objects that will be fed to
1239 # the 'taxline' method to calculate the amount of the tax. This doesn't
1240 # happen until calculate_taxes, though.
1244 my $part_pkg = shift;
1245 my $taxlisthash = shift;
1246 my $cust_bill_pkg = shift;
1247 my $cust_pkg = shift;
1248 my $invoice_time = shift;
1249 my $real_pkgpart = shift;
1250 my $options = shift;
1252 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1254 return if ( $self->payby eq 'COMP' ); #dubious
1256 if ( $conf->exists('enable_taxproducts')
1257 && ( scalar($part_pkg->part_pkg_taxoverride)
1258 || $part_pkg->has_taxproduct
1263 # EXTERNAL TAX RATES (via tax_rate)
1264 my %cust_bill_pkg = ();
1268 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
1269 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
1271 push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
1272 push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
1274 my $exempt = $conf->exists('cust_class-tax_exempt')
1275 ? ( $self->cust_class ? $self->cust_class->tax : '' )
1277 # standardize this just to be sure
1278 $exempt = ($exempt eq 'Y') ? 'Y' : '';
1282 foreach my $class (@classes) {
1283 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class, $cust_pkg );
1284 return $err_or_ref unless ref($err_or_ref);
1285 $taxes{$class} = $err_or_ref;
1288 unless (exists $taxes{''}) {
1289 my $err_or_ref = $self->_gather_taxes( $part_pkg, '', $cust_pkg );
1290 return $err_or_ref unless ref($err_or_ref);
1291 $taxes{''} = $err_or_ref;
1296 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
1297 foreach my $key (keys %tax_cust_bill_pkg) {
1298 # $key is "setup", "recur", or a usage class name. ('' is a usage class.)
1299 # $tax_cust_bill_pkg{$key} is a cust_bill_pkg for that component of
1301 # $taxes{$key} is an arrayref of cust_main_county or tax_rate objects that
1302 # apply to $key-class charges.
1303 my @taxes = @{ $taxes{$key} || [] };
1304 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
1306 my %localtaxlisthash = ();
1307 foreach my $tax ( @taxes ) {
1309 # this is the tax identifier, not the taxname
1310 my $taxname = ref( $tax ). ' '. $tax->taxnum;
1311 $taxname .= ' billpkgnum'. $cust_bill_pkg->billpkgnum;
1312 # We need to create a separate $taxlisthash entry for each billpkgnum
1313 # on the invoice, so that cust_bill_pkg_tax_location records will
1314 # be linked correctly.
1316 # $taxlisthash: keys are "setup", "recur", and usage classes.
1317 # Values are arrayrefs, first the tax object (cust_main_county
1318 # or tax_rate) and then any cust_bill_pkg objects that the
1320 $taxlisthash->{ $taxname } ||= [ $tax ];
1321 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
1323 $localtaxlisthash{ $taxname } ||= [ $tax ];
1324 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
1328 warn "finding taxed taxes...\n" if $DEBUG > 2;
1329 foreach my $tax ( keys %localtaxlisthash ) {
1330 my $tax_object = shift @{ $localtaxlisthash{$tax} };
1331 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
1333 next unless $tax_object->can('tax_on_tax');
1335 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
1336 my $totname = ref( $tot ). ' '. $tot->taxnum;
1338 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
1340 next unless exists( $localtaxlisthash{ $totname } ); # only increase
1342 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
1343 # we're calling taxline() right here? wtf?
1344 my $hashref_or_error =
1345 $tax_object->taxline( $localtaxlisthash{$tax},
1346 'custnum' => $self->custnum,
1347 'invoice_time' => $invoice_time,
1349 return $hashref_or_error
1350 unless ref($hashref_or_error);
1352 $taxlisthash->{ $totname } ||= [ $tot ];
1353 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
1361 # INTERNAL TAX RATES (cust_main_county)
1363 # We fetch taxes even if the customer is completely exempt,
1364 # because we need to record that fact.
1366 my @loc_keys = qw( district city county state country );
1367 my $location = $cust_pkg->tax_location;
1368 my %taxhash = map { $_ => $location->$_ } @loc_keys;
1370 $taxhash{'taxclass'} = $part_pkg->taxclass;
1372 warn "taxhash:\n". Dumper(\%taxhash) if $DEBUG > 2;
1374 my @taxes = (); # entries are cust_main_county objects
1375 my %taxhash_elim = %taxhash;
1376 my @elim = qw( district city county state );
1379 #first try a match with taxclass
1380 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1382 if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1383 #then try a match without taxclass
1384 my %no_taxclass = %taxhash_elim;
1385 $no_taxclass{ 'taxclass' } = '';
1386 @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1389 $taxhash_elim{ shift(@elim) } = '';
1391 } while ( !scalar(@taxes) && scalar(@elim) );
1394 my $tax_id = 'cust_main_county '.$_->taxnum;
1395 $taxlisthash->{$tax_id} ||= [ $_ ];
1396 push @{ $taxlisthash->{$tax_id} }, $cust_bill_pkg;
1405 my $part_pkg = shift;
1407 my $cust_pkg = shift;
1409 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1412 if ( $cust_pkg->locationnum && $conf->exists('tax-pkg_address') ) {
1413 $geocode = $cust_pkg->cust_location->geocode('cch');
1415 $geocode = $self->geocode('cch');
1420 my @taxclassnums = map { $_->taxclassnum }
1421 $part_pkg->part_pkg_taxoverride($class);
1423 unless (@taxclassnums) {
1424 @taxclassnums = map { $_->taxclassnum }
1425 grep { $_->taxable eq 'Y' }
1426 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
1428 warn "Found taxclassnum values of ". join(',', @taxclassnums)
1433 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
1435 @taxes = qsearch({ 'table' => 'tax_rate',
1436 'hashref' => { 'geocode' => $geocode, },
1437 'extra_sql' => $extra_sql,
1439 if scalar(@taxclassnums);
1441 warn "Found taxes ".
1442 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
1449 =item collect [ HASHREF | OPTION => VALUE ... ]
1451 (Attempt to) collect money for this customer's outstanding invoices (see
1452 L<FS::cust_bill>). Usually used after the bill method.
1454 Actions are now triggered by billing events; see L<FS::part_event> and the
1455 billing events web interface. Old-style invoice events (see
1456 L<FS::part_bill_event>) have been deprecated.
1458 If there is an error, returns the error, otherwise returns false.
1460 Options are passed as name-value pairs.
1462 Currently available options are:
1468 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.
1472 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1476 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1480 set true to surpress email card/ACH decline notices.
1484 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)
1490 # allows for one time override of normal customer billing method
1495 my( $self, %options ) = @_;
1497 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1499 my $invoice_time = $options{'invoice_time'} || time;
1502 local $SIG{HUP} = 'IGNORE';
1503 local $SIG{INT} = 'IGNORE';
1504 local $SIG{QUIT} = 'IGNORE';
1505 local $SIG{TERM} = 'IGNORE';
1506 local $SIG{TSTP} = 'IGNORE';
1507 local $SIG{PIPE} = 'IGNORE';
1509 my $oldAutoCommit = $FS::UID::AutoCommit;
1510 local $FS::UID::AutoCommit = 0;
1513 $self->select_for_update; #mutex
1516 my $balance = $self->balance;
1517 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
1520 if ( exists($options{'retry_card'}) ) {
1521 carp 'retry_card option passed to collect is deprecated; use retry';
1522 $options{'retry'} ||= $options{'retry_card'};
1524 if ( exists($options{'retry'}) && $options{'retry'} ) {
1525 my $error = $self->retry_realtime;
1527 $dbh->rollback if $oldAutoCommit;
1532 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1534 #never want to roll back an event just because it returned an error
1535 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1537 $self->do_cust_event(
1538 'debug' => ( $options{'debug'} || 0 ),
1539 'time' => $invoice_time,
1540 'check_freq' => $options{'check_freq'},
1541 'stage' => 'collect',
1546 =item retry_realtime
1548 Schedules realtime / batch credit card / electronic check / LEC billing
1549 events for for retry. Useful if card information has changed or manual
1550 retry is desired. The 'collect' method must be called to actually retry
1553 Implementation details: For either this customer, or for each of this
1554 customer's open invoices, changes the status of the first "done" (with
1555 statustext error) realtime processing event to "failed".
1559 sub retry_realtime {
1562 local $SIG{HUP} = 'IGNORE';
1563 local $SIG{INT} = 'IGNORE';
1564 local $SIG{QUIT} = 'IGNORE';
1565 local $SIG{TERM} = 'IGNORE';
1566 local $SIG{TSTP} = 'IGNORE';
1567 local $SIG{PIPE} = 'IGNORE';
1569 my $oldAutoCommit = $FS::UID::AutoCommit;
1570 local $FS::UID::AutoCommit = 0;
1573 #a little false laziness w/due_cust_event (not too bad, really)
1575 my $join = FS::part_event_condition->join_conditions_sql;
1576 my $order = FS::part_event_condition->order_conditions_sql;
1579 . join ( ' OR ' , map {
1580 my $cust_join = FS::part_event->eventtables_cust_join->{$_} || '';
1581 my $custnum = FS::part_event->eventtables_custnum->{$_};
1582 "( part_event.eventtable = " . dbh->quote($_)
1583 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key
1584 . " from $_ $cust_join"
1585 . " where $custnum = " . dbh->quote( $self->custnum ) . "))" ;
1586 } FS::part_event->eventtables)
1589 #here is the agent virtualization
1590 my $agent_virt = " ( part_event.agentnum IS NULL
1591 OR part_event.agentnum = ". $self->agentnum. ' )';
1593 #XXX this shouldn't be hardcoded, actions should declare it...
1594 my @realtime_events = qw(
1595 cust_bill_realtime_card
1596 cust_bill_realtime_check
1597 cust_bill_realtime_lec
1601 my $is_realtime_event =
1602 ' part_event.action IN ( '.
1603 join(',', map "'$_'", @realtime_events ).
1606 my $batch_or_statustext =
1607 "( part_event.action = 'cust_bill_batch'
1608 OR ( statustext IS NOT NULL AND statustext != '' )
1612 my @cust_event = qsearch({
1613 'table' => 'cust_event',
1614 'select' => 'cust_event.*',
1615 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
1616 'hashref' => { 'status' => 'done' },
1617 'extra_sql' => " AND $batch_or_statustext ".
1618 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
1621 my %seen_invnum = ();
1622 foreach my $cust_event (@cust_event) {
1624 #max one for the customer, one for each open invoice
1625 my $cust_X = $cust_event->cust_X;
1626 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
1630 or $cust_event->part_event->eventtable eq 'cust_bill'
1633 my $error = $cust_event->retry;
1635 $dbh->rollback if $oldAutoCommit;
1636 return "error scheduling event for retry: $error";
1641 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1646 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
1648 Runs billing events; see L<FS::part_event> and the billing events web
1651 If there is an error, returns the error, otherwise returns false.
1653 Options are passed as name-value pairs.
1655 Currently available options are:
1661 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.
1665 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1669 "collect" (the default) or "pre-bill"
1673 set true to surpress email card/ACH decline notices.
1677 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)
1684 # allows for one time override of normal customer billing method
1688 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1691 my( $self, %options ) = @_;
1693 local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1695 my $time = $options{'time'} || time;
1698 local $SIG{HUP} = 'IGNORE';
1699 local $SIG{INT} = 'IGNORE';
1700 local $SIG{QUIT} = 'IGNORE';
1701 local $SIG{TERM} = 'IGNORE';
1702 local $SIG{TSTP} = 'IGNORE';
1703 local $SIG{PIPE} = 'IGNORE';
1705 my $oldAutoCommit = $FS::UID::AutoCommit;
1706 local $FS::UID::AutoCommit = 0;
1709 $self->select_for_update; #mutex
1712 my $balance = $self->balance;
1713 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
1716 # if ( exists($options{'retry_card'}) ) {
1717 # carp 'retry_card option passed to collect is deprecated; use retry';
1718 # $options{'retry'} ||= $options{'retry_card'};
1720 # if ( exists($options{'retry'}) && $options{'retry'} ) {
1721 # my $error = $self->retry_realtime;
1723 # $dbh->rollback if $oldAutoCommit;
1728 # false laziness w/pay_batch::import_results
1730 my $due_cust_event = $self->due_cust_event(
1731 'debug' => ( $options{'debug'} || 0 ),
1733 'check_freq' => $options{'check_freq'},
1734 'stage' => ( $options{'stage'} || 'collect' ),
1736 unless( ref($due_cust_event) ) {
1737 $dbh->rollback if $oldAutoCommit;
1738 return $due_cust_event;
1741 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1742 #never want to roll back an event just because it or a different one
1744 local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1746 foreach my $cust_event ( @$due_cust_event ) {
1750 #re-eval event conditions (a previous event could have changed things)
1751 unless ( $cust_event->test_conditions ) {
1752 #don't leave stray "new/locked" records around
1753 my $error = $cust_event->delete;
1754 return $error if $error;
1759 local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
1760 if $options{'quiet'};
1761 warn " running cust_event ". $cust_event->eventnum. "\n"
1764 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
1765 if ( my $error = $cust_event->do_event( 'time' => $time ) ) {
1766 #XXX wtf is this? figure out a proper dealio with return value
1778 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
1780 Inserts database records for and returns an ordered listref of new events due
1781 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
1782 events are due, an empty listref is returned. If there is an error, returns a
1783 scalar error message.
1785 To actually run the events, call each event's test_condition method, and if
1786 still true, call the event's do_event method.
1788 Options are passed as a hashref or as a list of name-value pairs. Available
1795 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.
1799 "collect" (the default) or "pre-bill"
1803 "Current time" for the events.
1807 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)
1811 Only return events for the specified eventtable (by default, events of all eventtables are returned)
1815 Explicitly pass the objects to be tested (typically used with eventtable).
1819 Set to true to return the objects, but not actually insert them into the
1826 sub due_cust_event {
1828 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
1831 #my $DEBUG = $opt{'debug'}
1832 $opt{'debug'} ||= 0; # silence some warnings
1833 local($DEBUG) = $opt{'debug'}
1834 if $opt{'debug'} > $DEBUG;
1835 $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1837 warn "$me due_cust_event called with options ".
1838 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
1841 $opt{'time'} ||= time;
1843 local $SIG{HUP} = 'IGNORE';
1844 local $SIG{INT} = 'IGNORE';
1845 local $SIG{QUIT} = 'IGNORE';
1846 local $SIG{TERM} = 'IGNORE';
1847 local $SIG{TSTP} = 'IGNORE';
1848 local $SIG{PIPE} = 'IGNORE';
1850 my $oldAutoCommit = $FS::UID::AutoCommit;
1851 local $FS::UID::AutoCommit = 0;
1854 $self->select_for_update #mutex
1855 unless $opt{testonly};
1858 # find possible events (initial search)
1861 my @cust_event = ();
1863 my @eventtable = $opt{'eventtable'}
1864 ? ( $opt{'eventtable'} )
1865 : FS::part_event->eventtables_runorder;
1867 my $check_freq = $opt{'check_freq'} || '1d';
1869 foreach my $eventtable ( @eventtable ) {
1872 if ( $opt{'objects'} ) {
1874 @objects = @{ $opt{'objects'} };
1876 } elsif ( $eventtable eq 'cust_main' ) {
1878 @objects = ( $self );
1882 my $cm_join = " LEFT JOIN cust_main USING ( custnum )";
1883 # linkage not needed here because FS::cust_main->$eventtable will
1886 #some false laziness w/Cron::bill bill_where
1888 my $join = FS::part_event_condition->join_conditions_sql( $eventtable);
1889 my $where = FS::part_event_condition->where_conditions_sql($eventtable,
1890 'time'=>$opt{'time'},
1892 $where = $where ? "AND $where" : '';
1894 my $are_part_event =
1895 "EXISTS ( SELECT 1 FROM part_event $join
1896 WHERE check_freq = '$check_freq'
1897 AND eventtable = '$eventtable'
1898 AND ( disabled = '' OR disabled IS NULL )
1904 @objects = $self->$eventtable(
1905 'addl_from' => $cm_join,
1906 'extra_sql' => " AND $are_part_event",
1908 } # if ( !$opt{objects} and $eventtable ne 'cust_main' )
1910 my @e_cust_event = ();
1912 my $linkage = FS::part_event->eventtables_cust_join->{$eventtable} || '';
1914 my $cross = "CROSS JOIN $eventtable $linkage";
1915 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
1916 unless $eventtable eq 'cust_main';
1918 foreach my $object ( @objects ) {
1920 #this first search uses the condition_sql magic for optimization.
1921 #the more possible events we can eliminate in this step the better
1923 my $cross_where = '';
1924 my $pkey = $object->primary_key;
1925 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
1927 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
1929 FS::part_event_condition->where_conditions_sql( $eventtable,
1930 'time'=>$opt{'time'}
1932 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
1934 $extra_sql = "AND $extra_sql" if $extra_sql;
1936 #here is the agent virtualization
1937 $extra_sql .= " AND ( part_event.agentnum IS NULL
1938 OR part_event.agentnum = ". $self->agentnum. ' )';
1940 $extra_sql .= " $order";
1942 warn "searching for events for $eventtable ". $object->$pkey. "\n"
1943 if $opt{'debug'} > 2;
1944 my @part_event = qsearch( {
1945 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
1946 'select' => 'part_event.*',
1947 'table' => 'part_event',
1948 'addl_from' => "$cross $join",
1949 'hashref' => { 'check_freq' => $check_freq,
1950 'eventtable' => $eventtable,
1953 'extra_sql' => "AND $cross_where $extra_sql",
1957 my $pkey = $object->primary_key;
1958 warn " ". scalar(@part_event).
1959 " possible events found for $eventtable ". $object->$pkey(). "\n";
1962 push @e_cust_event, map {
1963 $_->new_cust_event($object, 'time' => $opt{'time'})
1968 warn " ". scalar(@e_cust_event).
1969 " subtotal possible cust events found for $eventtable\n"
1972 push @cust_event, @e_cust_event;
1976 warn " ". scalar(@cust_event).
1977 " total possible cust events found in initial search\n"
1985 $opt{stage} ||= 'collect';
1987 grep { my $stage = $_->part_event->event_stage;
1988 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
1998 @cust_event = grep $_->test_conditions( 'stats_hashref' => \%unsat ),
2001 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
2004 warn " invalid conditions not eliminated with condition_sql:\n".
2005 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
2006 if keys %unsat && $DEBUG; # > 1;
2012 unless( $opt{testonly} ) {
2013 foreach my $cust_event ( @cust_event ) {
2015 my $error = $cust_event->insert();
2017 $dbh->rollback if $oldAutoCommit;
2024 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2030 warn " returning events: ". Dumper(@cust_event). "\n"
2037 =item apply_payments_and_credits [ OPTION => VALUE ... ]
2039 Applies unapplied payments and credits.
2041 In most cases, this new method should be used in place of sequential
2042 apply_payments and apply_credits methods.
2044 A hash of optional arguments may be passed. Currently "manual" is supported.
2045 If true, a payment receipt is sent instead of a statement when
2046 'payment_receipt_email' configuration option is set.
2048 If there is an error, returns the error, otherwise returns false.
2052 sub apply_payments_and_credits {
2053 my( $self, %options ) = @_;
2055 local $SIG{HUP} = 'IGNORE';
2056 local $SIG{INT} = 'IGNORE';
2057 local $SIG{QUIT} = 'IGNORE';
2058 local $SIG{TERM} = 'IGNORE';
2059 local $SIG{TSTP} = 'IGNORE';
2060 local $SIG{PIPE} = 'IGNORE';
2062 my $oldAutoCommit = $FS::UID::AutoCommit;
2063 local $FS::UID::AutoCommit = 0;
2066 $self->select_for_update; #mutex
2068 foreach my $cust_bill ( $self->open_cust_bill ) {
2069 my $error = $cust_bill->apply_payments_and_credits(%options);
2071 $dbh->rollback if $oldAutoCommit;
2072 return "Error applying: $error";
2076 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2081 =item apply_credits OPTION => VALUE ...
2083 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
2084 to outstanding invoice balances in chronological order (or reverse
2085 chronological order if the I<order> option is set to B<newest>) and returns the
2086 value of any remaining unapplied credits available for refund (see
2087 L<FS::cust_refund>).
2089 Dies if there is an error.
2097 local $SIG{HUP} = 'IGNORE';
2098 local $SIG{INT} = 'IGNORE';
2099 local $SIG{QUIT} = 'IGNORE';
2100 local $SIG{TERM} = 'IGNORE';
2101 local $SIG{TSTP} = 'IGNORE';
2102 local $SIG{PIPE} = 'IGNORE';
2104 my $oldAutoCommit = $FS::UID::AutoCommit;
2105 local $FS::UID::AutoCommit = 0;
2108 $self->select_for_update; #mutex
2110 unless ( $self->total_unapplied_credits ) {
2111 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2115 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
2116 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
2118 my @invoices = $self->open_cust_bill;
2119 @invoices = sort { $b->_date <=> $a->_date } @invoices
2120 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
2122 if ( $conf->exists('pkg-balances') ) {
2123 # limit @credits to those w/ a pkgnum grepped from $self
2125 foreach my $i (@invoices) {
2126 foreach my $li ( $i->cust_bill_pkg ) {
2127 $pkgnums{$li->pkgnum} = 1;
2130 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
2135 foreach my $cust_bill ( @invoices ) {
2137 if ( !defined($credit) || $credit->credited == 0) {
2138 $credit = pop @credits or last;
2142 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
2143 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
2145 $owed = $cust_bill->owed;
2147 unless ( $owed > 0 ) {
2148 push @credits, $credit;
2152 my $amount = min( $credit->credited, $owed );
2154 my $cust_credit_bill = new FS::cust_credit_bill ( {
2155 'crednum' => $credit->crednum,
2156 'invnum' => $cust_bill->invnum,
2157 'amount' => $amount,
2159 $cust_credit_bill->pkgnum( $credit->pkgnum )
2160 if $conf->exists('pkg-balances') && $credit->pkgnum;
2161 my $error = $cust_credit_bill->insert;
2163 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2167 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2171 my $total_unapplied_credits = $self->total_unapplied_credits;
2173 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2175 return $total_unapplied_credits;
2178 =item apply_payments [ OPTION => VALUE ... ]
2180 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2181 to outstanding invoice balances in chronological order.
2183 #and returns the value of any remaining unapplied payments.
2185 A hash of optional arguments may be passed. Currently "manual" is supported.
2186 If true, a payment receipt is sent instead of a statement when
2187 'payment_receipt_email' configuration option is set.
2189 Dies if there is an error.
2193 sub apply_payments {
2194 my( $self, %options ) = @_;
2196 local $SIG{HUP} = 'IGNORE';
2197 local $SIG{INT} = 'IGNORE';
2198 local $SIG{QUIT} = 'IGNORE';
2199 local $SIG{TERM} = 'IGNORE';
2200 local $SIG{TSTP} = 'IGNORE';
2201 local $SIG{PIPE} = 'IGNORE';
2203 my $oldAutoCommit = $FS::UID::AutoCommit;
2204 local $FS::UID::AutoCommit = 0;
2207 $self->select_for_update; #mutex
2211 my @payments = sort { $b->_date <=> $a->_date }
2212 grep { $_->unapplied > 0 }
2215 my @invoices = sort { $a->_date <=> $b->_date}
2216 grep { $_->owed > 0 }
2219 if ( $conf->exists('pkg-balances') ) {
2220 # limit @payments to those w/ a pkgnum grepped from $self
2222 foreach my $i (@invoices) {
2223 foreach my $li ( $i->cust_bill_pkg ) {
2224 $pkgnums{$li->pkgnum} = 1;
2227 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
2232 foreach my $cust_bill ( @invoices ) {
2234 if ( !defined($payment) || $payment->unapplied == 0 ) {
2235 $payment = pop @payments or last;
2239 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
2240 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
2242 $owed = $cust_bill->owed;
2244 unless ( $owed > 0 ) {
2245 push @payments, $payment;
2249 my $amount = min( $payment->unapplied, $owed );
2252 'paynum' => $payment->paynum,
2253 'invnum' => $cust_bill->invnum,
2254 'amount' => $amount,
2256 $cbp->{_date} = $payment->_date
2257 if $options{'manual'} && $options{'backdate_application'};
2258 my $cust_bill_pay = new FS::cust_bill_pay($cbp);
2259 $cust_bill_pay->pkgnum( $payment->pkgnum )
2260 if $conf->exists('pkg-balances') && $payment->pkgnum;
2261 my $error = $cust_bill_pay->insert(%options);
2263 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2267 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2271 my $total_unapplied_payments = $self->total_unapplied_payments;
2273 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2275 return $total_unapplied_payments;
2285 suspend_adjourned_pkgs
2286 unsuspend_resumed_pkgs
2289 (do_cust_event pre-bill)
2292 (vendor-only) _gather_taxes
2293 _omit_zero_value_bundles
2296 apply_payments_and_credits
2305 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>