FS/FS/cust_main/Billing.pm

   1 package FS::cust_main::Billing;
   2
   3 use strict;
   4 use vars qw( $conf $DEBUG $me );
   5 use Carp;
   6 use Data::Dumper;
   7 use List::Util qw( min );
   8 use FS::UID qw( dbh );
   9 use FS::Record qw( qsearch qsearchs dbdef );
  10 use FS::Misc::DateTime qw( day_end );
  11 use FS::cust_bill;
  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;
  17 use FS::tax_rate;
  18 use FS::tax_rate_location;
  19 use FS::cust_bill_pkg_tax_location;
  20 use FS::cust_bill_pkg_tax_rate_location;
  21 use FS::part_event;
  22 use FS::part_event_condition;
  23 use FS::pkg_category;
  24
  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
  28 $DEBUG = 0;
  29 $me = '[FS::cust_main::Billing]';
  30
  31 install_callback FS::UID sub {
  32   $conf = new FS::Conf;
  33   #yes, need it for stuff below (prolly should be cached)
  34 };
  35
  36 =head1 NAME
  37
  38 FS::cust_main::Billing - Billing mixin for cust_main
  39
  40 =head1 SYNOPSIS
  41
  42 =head1 DESCRIPTION
  43
  44 These methods are available on FS::cust_main objects.
  45
  46 =head1 METHODS
  47
  48 =over 4
  49
  50 =item bill_and_collect
  51
  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,
  54 etc.
  55
  56 By default, warns on errors and continues with the next operation (but see the
  57 "fatal" flag below).
  58
  59 Options are passed as name-value pairs.  Currently available options are:
  60
  61 =over 4
  62
  63 =item time
  64
  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:
  66
  67  use Date::Parse;
  68  ...
  69  $cust_main->bill( 'time' => str2time('April 20th, 2001') );
  70
  71 =item invoice_time
  72
  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.
  74
  75 =item check_freq
  76
  77 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
  78
  79 =item resetup
  80
  81 If set true, re-charges setup fees.
  82
  83 =item fatal
  84
  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.
  88
  89 =item debug
  90
  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)
  92
  93 =item job
  94
  95 Optional FS::queue entry to receive status updates.
  96
  97 =back
  98
  99 Options are passed to the B<bill> and B<collect> methods verbatim, so all
 100 options of those methods are also available.
 101
 102 =cut
 103
 104 sub bill_and_collect {
 105   my( $self, %options ) = @_;
 106
 107   my $error;
 108
 109   #$options{actual_time} not $options{time} because freeside-daily -d is for
 110   #pre-printing invoices
 111
 112   $options{'actual_time'} ||= time;
 113   my $job = $options{'job'};
 114
 115   $job->update_statustext('0,cleaning expired packages') if $job;
 116   $error = $self->cancel_expired_pkgs( day_end( $options{actual_time} ) );
 117   if ( $error ) {
 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; }
 122   }
 123
 124   $error = $self->suspend_adjourned_pkgs( day_end( $options{actual_time} ) );
 125   if ( $error ) {
 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; }
 130   }
 131
 132   $error = $self->unsuspend_resumed_pkgs( day_end( $options{actual_time} ) );
 133   if ( $error ) {
 134     $error = "Error resuming custnum ".$self->custnum. ": $error";
 135     if    ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
 136     elsif ( $options{fatal}                                ) { die    $error; }
 137     else                                                     { warn   $error; }
 138   }
 139
 140   $job->update_statustext('20,billing packages') if $job;
 141   $error = $self->bill( %options );
 142   if ( $error ) {
 143     $error = "Error billing custnum ". $self->custnum. ": $error";
 144     if    ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
 145     elsif ( $options{fatal}                                ) { die    $error; }
 146     else                                                     { warn   $error; }
 147   }
 148
 149   $job->update_statustext('50,applying payments and credits') if $job;
 150   $error = $self->apply_payments_and_credits;
 151   if ( $error ) {
 152     $error = "Error applying custnum ". $self->custnum. ": $error";
 153     if    ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
 154     elsif ( $options{fatal}                                ) { die    $error; }
 155     else                                                     { warn   $error; }
 156   }
 157
 158   $job->update_statustext('70,running collection events') if $job;
 159   unless ( $conf->exists('cancelled_cust-noevents')
 160            && ! $self->num_ncancelled_pkgs
 161   ) {
 162     $error = $self->collect( %options );
 163     if ( $error ) {
 164       $error = "Error collecting custnum ". $self->custnum. ": $error";
 165       if    ($options{fatal} && $options{fatal} eq 'return') { return $error; }
 166       elsif ($options{fatal}                               ) { die    $error; }
 167       else                                                   { warn   $error; }
 168     }
 169   }
 170   $job->update_statustext('100,finished') if $job;
 171
 172   '';
 173
 174 }
 175
 176 sub cancel_expired_pkgs {
 177   my ( $self, $time, %options ) = @_;
 178
 179   my @cancel_pkgs = $self->ncancelled_pkgs( {
 180     'extra_sql' => " AND expire IS NOT NULL AND expire > 0 AND expire <= $time "
 181   } );
 182
 183   my @errors = ();
 184
 185   foreach my $cust_pkg ( @cancel_pkgs ) {
 186     my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
 187     my $error = $cust_pkg->cancel($cpr ? ( 'reason'        => $cpr->reasonnum,
 188                                            'reason_otaker' => $cpr->otaker,
 189                                            'time'          => $time,
 190                                          )
 191                                        : ()
 192                                  );
 193     push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
 194   }
 195
 196   join(' / ', @errors);
 197
 198 }
 199
 200 sub suspend_adjourned_pkgs {
 201   my ( $self, $time, %options ) = @_;
 202
 203   my @susp_pkgs = $self->ncancelled_pkgs( {
 204     'extra_sql' =>
 205       " AND ( susp IS NULL OR susp = 0 )
 206         AND (    ( bill    IS NOT NULL AND bill    != 0 AND bill    <  $time )
 207               OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
 208             )
 209       ",
 210   } );
 211
 212   #only because there's no SQL test for is_prepaid :/
 213   @susp_pkgs =
 214     grep {     (    $_->part_pkg->is_prepaid
 215                  && $_->bill
 216                  && $_->bill < $time
 217                )
 218             || (    $_->adjourn
 219                  && $_->adjourn <= $time
 220                )
 221
 222          }
 223          @susp_pkgs;
 224
 225   my @errors = ();
 226
 227   foreach my $cust_pkg ( @susp_pkgs ) {
 228     my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
 229       if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
 230     my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
 231                                             'reason_otaker' => $cpr->otaker
 232                                           )
 233                                         : ()
 234                                   );
 235     push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
 236   }
 237
 238   join(' / ', @errors);
 239
 240 }
 241
 242 sub unsuspend_resumed_pkgs {
 243   my ( $self, $time, %options ) = @_;
 244
 245   my @unsusp_pkgs = $self->ncancelled_pkgs( {
 246     'extra_sql' => " AND resume IS NOT NULL AND resume > 0 AND resume <= $time "
 247   } );
 248
 249   my @errors = ();
 250
 251   foreach my $cust_pkg ( @unsusp_pkgs ) {
 252     my $error = $cust_pkg->unsuspend( 'time' => $time );
 253     push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
 254   }
 255
 256   join(' / ', @errors);
 257
 258 }
 259
 260 =item bill OPTIONS
 261
 262 Generates invoices (see L<FS::cust_bill>) for this customer.  Usually used in
 263 conjunction with the collect method by calling B<bill_and_collect>.
 264
 265 If there is an error, returns the error, otherwise returns false.
 266
 267 Options are passed as name-value pairs.  Currently available options are:
 268
 269 =over 4
 270
 271 =item resetup
 272
 273 If set true, re-charges setup fees.
 274
 275 =item recurring_only
 276
 277 If set true then only bill recurring charges, not setup, usage, one time
 278 charges, etc.
 279
 280 =item freq_override
 281
 282 If set, then override the normal frequency and look for a part_pkg_discount
 283 to take at that frequency.  This is appropriate only when the normal
 284 frequency for all packages is monthly, and is an error otherwise.  Use
 285 C<pkg_list> to limit the set of packages included in billing.
 286
 287 =item time
 288
 289 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:
 290
 291  use Date::Parse;
 292  ...
 293  $cust_main->bill( 'time' => str2time('April 20th, 2001') );
 294
 295 =item pkg_list
 296
 297 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
 298
 299  $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
 300
 301 =item not_pkgpart
 302
 303 A hashref of pkgparts to exclude from this billing run (can also be specified as a comma-separated scalar).
 304
 305 =item invoice_time
 306
 307 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.
 308
 309 =item cancel
 310
 311 This boolean value informs the us that the package is being cancelled.  This
 312 typically might mean not charging the normal recurring fee but only usage
 313 fees since the last billing. Setup charges may be charged.  Not all package
 314 plans support this feature (they tend to charge 0).
 315
 316 =item no_usage_reset
 317
 318 Prevent the resetting of usage limits during this call.
 319
 320 =item no_commit
 321
 322 Do not save the generated bill in the database.  Useful with return_bill
 323
 324 =item return_bill
 325
 326 A list reference on which the generated bill(s) will be returned.
 327
 328 =item invoice_terms
 329
 330 Optional terms to be printed on this invoice.  Otherwise, customer-specific
 331 terms or the default terms are used.
 332
 333 =back
 334
 335 =cut
 336
 337 sub bill {
 338   my( $self, %options ) = @_;
 339
 340   return '' if $self->payby eq 'COMP';
 341
 342   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
 343
 344   warn "$me bill customer ". $self->custnum. "\n"
 345     if $DEBUG;
 346
 347   my $time = $options{'time'} || time;
 348   my $invoice_time = $options{'invoice_time'} || $time;
 349
 350   $options{'not_pkgpart'} ||= {};
 351   $options{'not_pkgpart'} = { map { $_ => 1 }
 352                                   split(/\s*,\s*/, $options{'not_pkgpart'})
 353                             }
 354     unless ref($options{'not_pkgpart'});
 355
 356   local $SIG{HUP} = 'IGNORE';
 357   local $SIG{INT} = 'IGNORE';
 358   local $SIG{QUIT} = 'IGNORE';
 359   local $SIG{TERM} = 'IGNORE';
 360   local $SIG{TSTP} = 'IGNORE';
 361   local $SIG{PIPE} = 'IGNORE';
 362
 363   my $oldAutoCommit = $FS::UID::AutoCommit;
 364   local $FS::UID::AutoCommit = 0;
 365   my $dbh = dbh;
 366
 367   warn "$me acquiring lock on customer ". $self->custnum. "\n"
 368     if $DEBUG;
 369
 370   $self->select_for_update; #mutex
 371
 372   warn "$me running pre-bill events for customer ". $self->custnum. "\n"
 373     if $DEBUG;
 374
 375   my $error = $self->do_cust_event(
 376     'debug'      => ( $options{'debug'} || 0 ),
 377     'time'       => $invoice_time,
 378     'check_freq' => $options{'check_freq'},
 379     'stage'      => 'pre-bill',
 380   )
 381     unless $options{no_commit};
 382   if ( $error ) {
 383     $dbh->rollback if $oldAutoCommit && !$options{no_commit};
 384     return $error;
 385   }
 386
 387   warn "$me done running pre-bill events for customer ". $self->custnum. "\n"
 388     if $DEBUG;
 389
 390   #keep auto-charge and non-auto-charge line items separate
 391   my @passes = ( '', 'no_auto' );
 392
 393   my %cust_bill_pkg = map { $_ => [] } @passes;
 394
 395   ###
 396   # find the packages which are due for billing, find out how much they are
 397   # & generate invoice database.
 398   ###
 399
 400   my %total_setup   = map { my $z = 0; $_ => \$z; } @passes;
 401   my %total_recur   = map { my $z = 0; $_ => \$z; } @passes;
 402
 403   my %taxlisthash = map { $_ => {} } @passes;
 404
 405   my @precommit_hooks = ();
 406
 407   $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ];  #param checks?
 408   foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
 409
 410     next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
 411
 412     warn "  bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG;
 413
 414     #? to avoid use of uninitialized value errors... ?
 415     $cust_pkg->setfield('bill', '')
 416       unless defined($cust_pkg->bill);
 417
 418     #my $part_pkg = $cust_pkg->part_pkg;
 419
 420     my $real_pkgpart = $cust_pkg->pkgpart;
 421     my %hash = $cust_pkg->hash;
 422
 423     # we could implement this bit as FS::part_pkg::has_hidden, but we already
 424     # suffer from performance issues
 425     $options{has_hidden} = 0;
 426     my @part_pkg = $cust_pkg->part_pkg->self_and_bill_linked;
 427     $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
 428
 429     foreach my $part_pkg ( @part_pkg ) {
 430
 431       $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
 432
 433       my $pass = ($cust_pkg->no_auto || $part_pkg->no_auto) ? 'no_auto' : '';
 434
 435       my $next_bill = $cust_pkg->getfield('bill') || 0;
 436       my $error;
 437       # let this run once if this is the last bill upon cancellation
 438       while ( $next_bill <= $time or $options{cancel} ) {
 439         $error =
 440           $self->_make_lines( 'part_pkg'            => $part_pkg,
 441                               'cust_pkg'            => $cust_pkg,
 442                               'precommit_hooks'     => \@precommit_hooks,
 443                               'line_items'          => $cust_bill_pkg{$pass},
 444                               'setup'               => $total_setup{$pass},
 445                               'recur'               => $total_recur{$pass},
 446                               'tax_matrix'          => $taxlisthash{$pass},
 447                               'time'                => $time,
 448                               'real_pkgpart'        => $real_pkgpart,
 449                               'options'             => \%options,
 450                             );
 451
 452         # Stop if anything goes wrong
 453         last if $error;
 454
 455         # or if we're not incrementing the bill date.
 456         last if ($cust_pkg->getfield('bill') || 0) == $next_bill;
 457
 458         # or if we're letting it run only once
 459         last if $options{cancel};
 460
 461         $next_bill = $cust_pkg->getfield('bill') || 0;
 462
 463         #stop if -o was passed to freeside-daily
 464         last if $options{'one_recur'};
 465       }
 466       if ($error) {
 467         $dbh->rollback if $oldAutoCommit && !$options{no_commit};
 468         return $error;
 469       }
 470
 471     } #foreach my $part_pkg
 472
 473   } #foreach my $cust_pkg
 474
 475   #if the customer isn't on an automatic payby, everything can go on a single
 476   #invoice anyway?
 477   #if ( $cust_main->payby !~ /^(CARD|CHEK)$/ ) {
 478     #merge everything into one list
 479   #}
 480
 481   foreach my $pass (@passes) { # keys %cust_bill_pkg ) {
 482
 483     my @cust_bill_pkg = _omit_zero_value_bundles(@{ $cust_bill_pkg{$pass} });
 484
 485     next unless @cust_bill_pkg; #don't create an invoice w/o line items
 486
 487     warn "$me billing pass $pass\n"
 488            #.Dumper(\@cust_bill_pkg)."\n"
 489       if $DEBUG > 2;
 490
 491     if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
 492            !$conf->exists('postal_invoice-recurring_only')
 493        )
 494     {
 495
 496       my $postal_pkg = $self->charge_postal_fee();
 497       if ( $postal_pkg && !ref( $postal_pkg ) ) {
 498
 499         $dbh->rollback if $oldAutoCommit && !$options{no_commit};
 500         return "can't charge postal invoice fee for customer ".
 501           $self->custnum. ": $postal_pkg";
 502
 503       } elsif ( $postal_pkg ) {
 504
 505         my $real_pkgpart = $postal_pkg->pkgpart;
 506         # we could implement this bit as FS::part_pkg::has_hidden, but we already
 507         # suffer from performance issues
 508         $options{has_hidden} = 0;
 509         my @part_pkg = $postal_pkg->part_pkg->self_and_bill_linked;
 510         $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
 511
 512         foreach my $part_pkg ( @part_pkg ) {
 513           my %postal_options = %options;
 514           delete $postal_options{cancel};
 515           my $error =
 516             $self->_make_lines( 'part_pkg'            => $part_pkg,
 517                                 'cust_pkg'            => $postal_pkg,
 518                                 'precommit_hooks'     => \@precommit_hooks,
 519                                 'line_items'          => \@cust_bill_pkg,
 520                                 'setup'               => $total_setup{$pass},
 521                                 'recur'               => $total_recur{$pass},
 522                                 'tax_matrix'          => $taxlisthash{$pass},
 523                                 'time'                => $time,
 524                                 'real_pkgpart'        => $real_pkgpart,
 525                                 'options'             => \%postal_options,
 526                               );
 527           if ($error) {
 528             $dbh->rollback if $oldAutoCommit && !$options{no_commit};
 529             return $error;
 530           }
 531         }
 532
 533         # it's silly to have a zero value postal_pkg, but....
 534         @cust_bill_pkg = _omit_zero_value_bundles(@cust_bill_pkg);
 535
 536       }
 537
 538     }
 539
 540     my $listref_or_error =
 541       $self->calculate_taxes( \@cust_bill_pkg, $taxlisthash{$pass}, $invoice_time);
 542
 543     unless ( ref( $listref_or_error ) ) {
 544       $dbh->rollback if $oldAutoCommit && !$options{no_commit};
 545       return $listref_or_error;
 546     }
 547
 548     foreach my $taxline ( @$listref_or_error ) {
 549       ${ $total_setup{$pass} } =
 550         sprintf('%.2f', ${ $total_setup{$pass} } + $taxline->setup );
 551       push @cust_bill_pkg, $taxline;
 552     }
 553
 554     #add tax adjustments
 555     warn "adding tax adjustments...\n" if $DEBUG > 2;
 556     foreach my $cust_tax_adjustment (
 557       qsearch('cust_tax_adjustment', { 'custnum'    => $self->custnum,
 558                                        'billpkgnum' => '',
 559                                      }
 560              )
 561     ) {
 562
 563       my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
 564
 565       my $itemdesc = $cust_tax_adjustment->taxname;
 566       $itemdesc = '' if $itemdesc eq 'Tax';
 567
 568       push @cust_bill_pkg, new FS::cust_bill_pkg {
 569         'pkgnum'      => 0,
 570         'setup'       => $tax,
 571         'recur'       => 0,
 572         'sdate'       => '',
 573         'edate'       => '',
 574         'itemdesc'    => $itemdesc,
 575         'itemcomment' => $cust_tax_adjustment->comment,
 576         'cust_tax_adjustment' => $cust_tax_adjustment,
 577         #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
 578       };
 579
 580     }
 581
 582     my $charged = sprintf('%.2f', ${ $total_setup{$pass} } + ${ $total_recur{$pass} } );
 583
 584     my @cust_bill = $self->cust_bill;
 585     my $balance = $self->balance;
 586     my $previous_balance = scalar(@cust_bill)
 587                              ? ( $cust_bill[$#cust_bill]->billing_balance || 0 )
 588                              : 0;
 589
 590     $previous_balance += $cust_bill[$#cust_bill]->charged
 591       if scalar(@cust_bill);
 592     #my $balance_adjustments =
 593     #  sprintf('%.2f', $balance - $prior_prior_balance - $prior_charged);
 594
 595     warn "creating the new invoice\n" if $DEBUG;
 596     #create the new invoice
 597     my $cust_bill = new FS::cust_bill ( {
 598       'custnum'             => $self->custnum,
 599       '_date'               => $invoice_time,
 600       'charged'             => $charged,
 601       'billing_balance'     => $balance,
 602       'previous_balance'    => $previous_balance,
 603       'invoice_terms'       => $options{'invoice_terms'},
 604       'cust_bill_pkg'       => \@cust_bill_pkg,
 605     } );
 606     $error = $cust_bill->insert unless $options{no_commit};
 607     if ( $error ) {
 608       $dbh->rollback if $oldAutoCommit && !$options{no_commit};
 609       return "can't create invoice for customer #". $self->custnum. ": $error";
 610     }
 611     push @{$options{return_bill}}, $cust_bill if $options{return_bill};
 612
 613   } #foreach my $pass ( keys %cust_bill_pkg )
 614
 615   foreach my $hook ( @precommit_hooks ) {
 616     eval {
 617       &{$hook}; #($self) ?
 618     } unless $options{no_commit};
 619     if ( $@ ) {
 620       $dbh->rollback if $oldAutoCommit && !$options{no_commit};
 621       return "$@ running precommit hook $hook\n";
 622     }
 623   }
 624
 625   $dbh->commit or die $dbh->errstr if $oldAutoCommit && !$options{no_commit};
 626
 627   ''; #no error
 628 }
 629
 630 #discard bundled packages of 0 value
 631 sub _omit_zero_value_bundles {
 632   my @in = @_;
 633
 634   my @cust_bill_pkg = ();
 635   my @cust_bill_pkg_bundle = ();
 636   my $sum = 0;
 637   my $discount_show_always = 0;
 638
 639   foreach my $cust_bill_pkg ( @in ) {
 640
 641     $discount_show_always = ($cust_bill_pkg->get('discounts')
 642                                 && scalar(@{$cust_bill_pkg->get('discounts')})
 643                                 && $conf->exists('discount-show-always'));
 644
 645     warn "  pkgnum ". $cust_bill_pkg->pkgnum. " sum $sum, ".
 646          "setup_show_zero ". $cust_bill_pkg->setup_show_zero.
 647          "recur_show_zero ". $cust_bill_pkg->recur_show_zero. "\n"
 648       if $DEBUG > 0;
 649
 650     if (scalar(@cust_bill_pkg_bundle) && !$cust_bill_pkg->pkgpart_override) {
 651       push @cust_bill_pkg, @cust_bill_pkg_bundle
 652         if $sum > 0
 653         || ($sum == 0 && (    $discount_show_always
 654                            || grep {$_->recur_show_zero || $_->setup_show_zero}
 655                                    @cust_bill_pkg_bundle
 656                          )
 657            );
 658       @cust_bill_pkg_bundle = ();
 659       $sum = 0;
 660     }
 661
 662     $sum += $cust_bill_pkg->setup + $cust_bill_pkg->recur;
 663     push @cust_bill_pkg_bundle, $cust_bill_pkg;
 664
 665   }
 666
 667   push @cust_bill_pkg, @cust_bill_pkg_bundle
 668     if $sum > 0
 669     || ($sum == 0 && (    $discount_show_always
 670                        || grep {$_->recur_show_zero || $_->setup_show_zero}
 671                                @cust_bill_pkg_bundle
 672                      )
 673        );
 674
 675   warn "  _omit_zero_value_bundles: ". scalar(@in).
 676        '->'. scalar(@cust_bill_pkg). "\n" #. Dumper(@cust_bill_pkg). "\n"
 677     if $DEBUG > 2;
 678
 679   (@cust_bill_pkg);
 680
 681 }
 682
 683 =item calculate_taxes LINEITEMREF TAXHASHREF INVOICE_TIME
 684
 685 This is a weird one.  Perhaps it should not even be exposed.
 686
 687 Generates tax line items (see L<FS::cust_bill_pkg>) for this customer.
 688 Usually used internally by bill method B<bill>.
 689
 690 If there is an error, returns the error, otherwise returns reference to a
 691 list of line items suitable for insertion.
 692
 693 =over 4
 694
 695 =item LINEITEMREF
 696
 697 An array ref of the line items being billed.
 698
 699 =item TAXHASHREF
 700
 701 A strange beast.  The keys to this hash are internal identifiers consisting
 702 of the name of the tax object type, a space, and its unique identifier ( e.g.
 703  'cust_main_county 23' ).  The values of the hash are listrefs.  The first
 704 item in the list is the tax object.  The remaining items are either line
 705 items or floating point values (currency amounts).
 706
 707 The taxes are calculated on this entity.  Calculated exemption records are
 708 transferred to the LINEITEMREF items on the assumption that they are related.
 709
 710 Read the source.
 711
 712 =item INVOICE_TIME
 713
 714 This specifies the date appearing on the associated invoice.  Some
 715 jurisdictions (i.e. Texas) have tax exemptions which are date sensitive.
 716
 717 =back
 718
 719 =cut
 720
 721 sub calculate_taxes {
 722   my ($self, $cust_bill_pkg, $taxlisthash, $invoice_time) = @_;
 723
 724   # $taxlisthash is a hashref
 725   # keys are identifiers, values are arrayrefs
 726   # each arrayref starts with a tax object (cust_main_county or tax_rate)
 727   # then any cust_bill_pkg objects the tax applies to
 728
 729   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
 730
 731   warn "$me calculate_taxes\n"
 732        #.Dumper($self, $cust_bill_pkg, $taxlisthash, $invoice_time). "\n"
 733     if $DEBUG > 2;
 734
 735   my @tax_line_items = ();
 736
 737   # keys are tax names (as printed on invoices / itemdesc )
 738   # values are listrefs of taxlisthash keys (internal identifiers)
 739   my %taxname = ();
 740
 741   # keys are taxlisthash keys (internal identifiers)
 742   # values are (cumulative) amounts
 743   my %tax = ();
 744
 745   # keys are taxlisthash keys (internal identifiers)
 746   # values are listrefs of cust_bill_pkg_tax_location hashrefs
 747   my %tax_location = ();
 748
 749   # keys are taxlisthash keys (internal identifiers)
 750   # values are listrefs of cust_bill_pkg_tax_rate_location hashrefs
 751   my %tax_rate_location = ();
 752
 753   foreach my $tax ( keys %$taxlisthash ) {
 754     # $tax is a tax identifier
 755     my $tax_object = shift @{ $taxlisthash->{$tax} };
 756     # $tax_object is a cust_main_county or tax_rate
 757     # (with pkgnum and locationnum set)
 758     # the rest of @{ $taxlisthash->{$tax} } is cust_bill_pkg objects
 759     warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
 760     warn " ". join('/', @{ $taxlisthash->{$tax} } ). "\n" if $DEBUG > 2;
 761     # taxline calculates the tax on all cust_bill_pkgs in the
 762     # first (arrayref) argument
 763     my $hashref_or_error =
 764       $tax_object->taxline( $taxlisthash->{$tax},
 765                             'custnum'      => $self->custnum,
 766                             'invoice_time' => $invoice_time
 767                           );
 768     return $hashref_or_error unless ref($hashref_or_error);
 769
 770     unshift @{ $taxlisthash->{$tax} }, $tax_object;
 771
 772     my $name   = $hashref_or_error->{'name'};
 773     my $amount = $hashref_or_error->{'amount'};
 774
 775     #warn "adding $amount as $name\n";
 776     $taxname{ $name } ||= [];
 777     push @{ $taxname{ $name } }, $tax;
 778
 779     $tax{ $tax } += $amount;
 780
 781     # link records between cust_main_county/tax_rate and cust_location
 782     $tax_location{ $tax } ||= [];
 783     $tax_rate_location{ $tax } ||= [];
 784     if ( ref($tax_object) eq 'FS::cust_main_county' ) {
 785       push @{ $tax_location{ $tax }  },
 786         {
 787           'taxnum'      => $tax_object->taxnum,
 788           'taxtype'     => ref($tax_object),
 789           'pkgnum'      => $tax_object->get('pkgnum'),
 790           'locationnum' => $tax_object->get('locationnum'),
 791           'amount'      => sprintf('%.2f', $amount ),
 792         };
 793     }
 794     elsif ( ref($tax_object) eq 'FS::tax_rate' ) {
 795       my $taxratelocationnum =
 796         $tax_object->tax_rate_location->taxratelocationnum;
 797       push @{ $tax_rate_location{ $tax }  },
 798         {
 799           'taxnum'             => $tax_object->taxnum,
 800           'taxtype'            => ref($tax_object),
 801           'amount'             => sprintf('%.2f', $amount ),
 802           'locationtaxid'      => $tax_object->location,
 803           'taxratelocationnum' => $taxratelocationnum,
 804         };
 805     }
 806
 807   }
 808
 809   #move the cust_tax_exempt_pkg records to the cust_bill_pkgs we will commit
 810   my %packagemap = map { $_->pkgnum => $_ } @$cust_bill_pkg;
 811   foreach my $tax ( keys %$taxlisthash ) {
 812     foreach ( @{ $taxlisthash->{$tax} }[1 ... scalar(@{ $taxlisthash->{$tax} })] ) {
 813       next unless ref($_) eq 'FS::cust_bill_pkg';
 814
 815       my @cust_tax_exempt_pkg = splice( @{ $_->_cust_tax_exempt_pkg } );
 816
 817       next unless @cust_tax_exempt_pkg; #just avoiding the prob when irrelevant?
 818       die "can't distribute tax exemptions: no line item for ".  Dumper($_).
 819           " in packagemap ". join(',', sort {$a<=>$b} keys %packagemap). "\n"
 820         unless $packagemap{$_->pkgnum};
 821
 822       push @{ $packagemap{$_->pkgnum}->_cust_tax_exempt_pkg },
 823            @cust_tax_exempt_pkg;
 824     }
 825   }
 826
 827   #consolidate and create tax line items
 828   warn "consolidating and generating...\n" if $DEBUG > 2;
 829   foreach my $taxname ( keys %taxname ) {
 830     my $tax = 0;
 831     my %seen = ();
 832     my @cust_bill_pkg_tax_location = ();
 833     my @cust_bill_pkg_tax_rate_location = ();
 834     warn "adding $taxname\n" if $DEBUG > 1;
 835     foreach my $taxitem ( @{ $taxname{$taxname} } ) {
 836       next if $seen{$taxitem}++;
 837       warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
 838       $tax += $tax{$taxitem};
 839       push @cust_bill_pkg_tax_location,
 840         map { new FS::cust_bill_pkg_tax_location $_ }
 841             @{ $tax_location{ $taxitem } };
 842       push @cust_bill_pkg_tax_rate_location,
 843         map { new FS::cust_bill_pkg_tax_rate_location $_ }
 844             @{ $tax_rate_location{ $taxitem } };
 845     }
 846     next unless $tax;
 847
 848     $tax = sprintf('%.2f', $tax );
 849
 850     my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
 851                                                    'disabled'     => '',
 852                                                  },
 853                                );
 854
 855     my @display = ();
 856     if ( $pkg_category and
 857          $conf->config('invoice_latexsummary') ||
 858          $conf->config('invoice_htmlsummary')
 859        )
 860     {
 861
 862       my %hash = (  'section' => $pkg_category->categoryname );
 863       push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
 864
 865     }
 866
 867     push @tax_line_items, new FS::cust_bill_pkg {
 868       'pkgnum'   => 0,
 869       'setup'    => $tax,
 870       'recur'    => 0,
 871       'sdate'    => '',
 872       'edate'    => '',
 873       'itemdesc' => $taxname,
 874       'display'  => \@display,
 875       'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
 876       'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
 877     };
 878
 879   }
 880
 881   \@tax_line_items;
 882 }
 883
 884 sub _make_lines {
 885   my ($self, %params) = @_;
 886
 887   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
 888
 889   my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
 890   my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
 891   my $precommit_hooks = $params{precommit_hooks} or die "no precommit_hooks specified";
 892   my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
 893   my $total_setup = $params{setup} or die "no setup accumulator specified";
 894   my $total_recur = $params{recur} or die "no recur accumulator specified";
 895   my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
 896   my $time = $params{'time'} or die "no time specified";
 897   my (%options) = %{$params{options}};
 898
 899   if ( $part_pkg->freq ne '1' and ($options{'freq_override'} || 0) > 0 ) {
 900     # this should never happen
 901     die 'freq_override billing attempted on non-monthly package '.
 902       $cust_pkg->pkgnum;
 903   }
 904
 905   my $dbh = dbh;
 906   my $real_pkgpart = $params{real_pkgpart};
 907   my %hash = $cust_pkg->hash;
 908   my $old_cust_pkg = new FS::cust_pkg \%hash;
 909
 910   my @details = ();
 911   my $lineitems = 0;
 912
 913   $cust_pkg->pkgpart($part_pkg->pkgpart);
 914
 915   ###
 916   # bill setup
 917   ###
 918
 919   my $setup = 0;
 920   my $unitsetup = 0;
 921   my @setup_discounts = ();
 922   my %setup_param = ( 'discounts' => \@setup_discounts );
 923   if (     ! $options{recurring_only}
 924        and ! $options{cancel}
 925        and ( $options{'resetup'}
 926              || ( ! $cust_pkg->setup
 927                   && ( ! $cust_pkg->start_date
 928                        || $cust_pkg->start_date <= day_end($time)
 929                      )
 930                   && ( ! $conf->exists('disable_setup_suspended_pkgs')
 931                        || ( $conf->exists('disable_setup_suspended_pkgs') &&
 932                             ! $cust_pkg->getfield('susp')
 933                           )
 934                      )
 935                 )
 936            )
 937      )
 938   {
 939
 940     warn "    bill setup\n" if $DEBUG > 1;
 941
 942     unless ( $cust_pkg->waive_setup ) {
 943         $lineitems++;
 944
 945         $setup = eval { $cust_pkg->calc_setup( $time, \@details, \%setup_param ) };
 946         return "$@ running calc_setup for $cust_pkg\n"
 947           if $@;
 948
 949         $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
 950     }
 951
 952     $cust_pkg->setfield('setup', $time)
 953       unless $cust_pkg->setup;
 954           #do need it, but it won't get written to the db
 955           #|| $cust_pkg->pkgpart != $real_pkgpart;
 956
 957     $cust_pkg->setfield('start_date', '')
 958       if $cust_pkg->start_date;
 959
 960   }
 961
 962   ###
 963   # bill recurring fee
 964   ###
 965
 966   my $recur = 0;
 967   my $unitrecur = 0;
 968   my @recur_discounts = ();
 969   my $sdate;
 970   if (     ! $cust_pkg->start_date
 971        and ( ! $cust_pkg->susp || $cust_pkg->option('suspend_bill',1)
 972                                || ( $part_pkg->option('suspend_bill', 1) )
 973                                      && ! $cust_pkg->option('no_suspend_bill',1)
 974                                   )
 975        and
 976             ( $part_pkg->freq ne '0' && ( $cust_pkg->bill || 0 ) <= day_end($time) )
 977          || ( $part_pkg->plan eq 'voip_cdr'
 978                && $part_pkg->option('bill_every_call')
 979             )
 980          || $options{cancel}
 981   ) {
 982
 983     # XXX should this be a package event?  probably.  events are called
 984     # at collection time at the moment, though...
 985     $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
 986       if $part_pkg->can('reset_usage') && !$options{'no_usage_reset'};
 987       #don't want to reset usage just cause we want a line item??
 988       #&& $part_pkg->pkgpart == $real_pkgpart;
 989
 990     warn "    bill recur\n" if $DEBUG > 1;
 991     $lineitems++;
 992
 993     # XXX shared with $recur_prog
 994     $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
 995              || $cust_pkg->setup
 996              || $time;
 997
 998     #over two params!  lets at least switch to a hashref for the rest...
 999     my $increment_next_bill = ( $part_pkg->freq ne '0'
1000                                 && ( $cust_pkg->getfield('bill') || 0 ) <= day_end($time)
1001                                 && !$options{cancel}
1002                               );
1003     my %param = ( %setup_param,
1004                   'precommit_hooks'     => $precommit_hooks,
1005                   'increment_next_bill' => $increment_next_bill,
1006                   'discounts'           => \@recur_discounts,
1007                   'real_pkgpart'        => $real_pkgpart,
1008                   'freq_override'       => $options{freq_override} || '',
1009                   'setup_fee'           => 0,
1010                 );
1011
1012     my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
1013
1014     # There may be some part_pkg for which this is wrong.  Only those
1015     # which can_discount are supported.
1016     # (the UI should prevent adding discounts to these at the moment)
1017
1018     warn "calling $method on cust_pkg ". $cust_pkg->pkgnum.
1019          " for pkgpart ". $cust_pkg->pkgpart.
1020          " with params ". join(' / ', map "$_=>$param{$_}", keys %param). "\n"
1021       if $DEBUG > 2;
1022
1023     $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
1024     return "$@ running $method for $cust_pkg\n"
1025       if ( $@ );
1026
1027     #base_cancel???
1028     $unitrecur = $cust_pkg->part_pkg->base_recur || $recur; #XXX uuh
1029
1030     if ( $increment_next_bill ) {
1031
1032       my $next_bill = $part_pkg->add_freq($sdate, $options{freq_override} || 0);
1033       return "unparsable frequency: ". $part_pkg->freq
1034         if $next_bill == -1;
1035
1036       #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
1037       # only for figuring next bill date, nothing else, so, reset $sdate again
1038       # here
1039       $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1040       #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
1041       $cust_pkg->last_bill($sdate);
1042
1043       $cust_pkg->setfield('bill', $next_bill );
1044
1045     }
1046
1047     if ( $param{'setup_fee'} ) {
1048       # Add an additional setup fee at the billing stage.
1049       # Used for prorate_defer_bill.
1050       $setup += $param{'setup_fee'};
1051       $unitsetup += $param{'setup_fee'};
1052       $lineitems++;
1053     }
1054
1055     if ( defined $param{'discount_left_setup'} ) {
1056         foreach my $discount_setup ( values %{$param{'discount_left_setup'}} ) {
1057             $setup -= $discount_setup;
1058         }
1059     }
1060
1061   }
1062
1063   warn "\$setup is undefined" unless defined($setup);
1064   warn "\$recur is undefined" unless defined($recur);
1065   warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1066
1067   ###
1068   # If there's line items, create em cust_bill_pkg records
1069   # If $cust_pkg has been modified, update it (if we're a real pkgpart)
1070   ###
1071
1072   if ( $lineitems ) {
1073
1074     if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
1075       # hmm.. and if just the options are modified in some weird price plan?
1076
1077       warn "  package ". $cust_pkg->pkgnum. " modified; updating\n"
1078         if $DEBUG >1;
1079
1080       my $error = $cust_pkg->replace( $old_cust_pkg,
1081                                       'depend_jobnum'=>$options{depend_jobnum},
1082                                       'options' => { $cust_pkg->options },
1083                                     )
1084         unless $options{no_commit};
1085       return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
1086         if $error; #just in case
1087     }
1088
1089     $setup = sprintf( "%.2f", $setup );
1090     $recur = sprintf( "%.2f", $recur );
1091     if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
1092       return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1093     }
1094     if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
1095       return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
1096     }
1097
1098     my $discount_show_always = $conf->exists('discount-show-always')
1099                                && (    ($setup == 0 && scalar(@setup_discounts))
1100                                     || ($recur == 0 && scalar(@recur_discounts))
1101                                   );
1102
1103     if (    $setup != 0
1104          || $recur != 0
1105          || (!$part_pkg->hidden && $options{has_hidden}) #include some $0 lines
1106          || $discount_show_always
1107          || ($setup == 0 && $cust_pkg->_X_show_zero('setup'))
1108          || ($recur == 0 && $cust_pkg->_X_show_zero('recur'))
1109        )
1110     {
1111
1112       warn "    charges (setup=$setup, recur=$recur); adding line items\n"
1113         if $DEBUG > 1;
1114
1115       my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
1116       if ( $DEBUG > 1 ) {
1117         warn "      adding customer package invoice detail: $_\n"
1118           foreach @cust_pkg_detail;
1119       }
1120       push @details, @cust_pkg_detail;
1121
1122       my $cust_bill_pkg = new FS::cust_bill_pkg {
1123         'pkgnum'    => $cust_pkg->pkgnum,
1124         'setup'     => $setup,
1125         'unitsetup' => $unitsetup,
1126         'recur'     => $recur,
1127         'unitrecur' => $unitrecur,
1128         'quantity'  => $cust_pkg->quantity,
1129         'details'   => \@details,
1130         'discounts' => [ @setup_discounts, @recur_discounts ],
1131         'hidden'    => $part_pkg->hidden,
1132         'freq'      => $part_pkg->freq,
1133       };
1134
1135       if ( $part_pkg->option('prorate_defer_bill',1)
1136            and !$hash{last_bill} ) {
1137         # both preceding and upcoming, technically
1138         $cust_bill_pkg->sdate( $cust_pkg->setup );
1139         $cust_bill_pkg->edate( $cust_pkg->bill );
1140       } elsif ( $part_pkg->recur_temporality eq 'preceding' ) {
1141         $cust_bill_pkg->sdate( $hash{last_bill} );
1142         $cust_bill_pkg->edate( $sdate - 86399   ); #60s*60m*24h-1
1143         $cust_bill_pkg->edate( $time ) if $options{cancel};
1144       } else { #if ( $part_pkg->recur_temporality eq 'upcoming' ) {
1145         $cust_bill_pkg->sdate( $sdate );
1146         $cust_bill_pkg->edate( $cust_pkg->bill );
1147         #$cust_bill_pkg->edate( $time ) if $options{cancel};
1148       }
1149
1150       $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
1151         unless $part_pkg->pkgpart == $real_pkgpart;
1152
1153       $$total_setup += $setup;
1154       $$total_recur += $recur;
1155
1156       ###
1157       # handle taxes
1158       ###
1159
1160       unless ( $discount_show_always ) {
1161           my $error =
1162             $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart, \%options);
1163           return $error if $error;
1164       }
1165
1166       push @$cust_bill_pkgs, $cust_bill_pkg;
1167
1168     } #if $setup != 0 || $recur != 0
1169
1170   } #if $line_items
1171
1172   '';
1173
1174 }
1175
1176 sub _handle_taxes {
1177   my $self = shift;
1178   my $part_pkg = shift;
1179   my $taxlisthash = shift;
1180   my $cust_bill_pkg = shift;
1181   my $cust_pkg = shift;
1182   my $invoice_time = shift;
1183   my $real_pkgpart = shift;
1184   my $options = shift;
1185
1186   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1187
1188   my %cust_bill_pkg = ();
1189   my %taxes = ();
1190
1191   my @classes;
1192   #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
1193   push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
1194   push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
1195   push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
1196
1197   my $exempt = $conf->exists('cust_class-tax_exempt')
1198                  ? ( $self->cust_class ? $self->cust_class->tax : '' )
1199                  : $self->tax;
1200
1201   if ( $exempt !~ /Y/i && $self->payby ne 'COMP' ) {
1202
1203     if ( $conf->exists('enable_taxproducts')
1204          && ( scalar($part_pkg->part_pkg_taxoverride)
1205               || $part_pkg->has_taxproduct
1206             )
1207        )
1208     {
1209
1210       foreach my $class (@classes) {
1211         my $err_or_ref = $self->_gather_taxes( $part_pkg, $class, $cust_pkg );
1212         return $err_or_ref unless ref($err_or_ref);
1213         $taxes{$class} = $err_or_ref;
1214       }
1215
1216       unless (exists $taxes{''}) {
1217         my $err_or_ref = $self->_gather_taxes( $part_pkg, '', $cust_pkg );
1218         return $err_or_ref unless ref($err_or_ref);
1219         $taxes{''} = $err_or_ref;
1220       }
1221
1222     } else {
1223
1224       my @loc_keys = qw( district city county state country );
1225       my $location = $cust_pkg->tax_location;
1226       my %taxhash = map { $_ => $location->$_ } @loc_keys;
1227
1228       $taxhash{'taxclass'} = $part_pkg->taxclass;
1229
1230       my @taxes = (); # entries are cust_main_county objects
1231       my %taxhash_elim = %taxhash;
1232       my @elim = qw( district city county state );
1233       do {
1234
1235         #first try a match with taxclass
1236         @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1237
1238         if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1239           #then try a match without taxclass
1240           my %no_taxclass = %taxhash_elim;
1241           $no_taxclass{ 'taxclass' } = '';
1242           @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1243         }
1244
1245         $taxhash_elim{ shift(@elim) } = '';
1246
1247       } while ( !scalar(@taxes) && scalar(@elim) );
1248
1249       @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
1250                     @taxes
1251         if $self->cust_main_exemption; #just to be safe
1252
1253       # all packages now have a locationnum and should get a
1254       # cust_bill_pkg_tax_location record.  The tax_locationnum
1255       # may be the package's locationnum, or the customer's bill
1256       # or service location.
1257       foreach (@taxes) {
1258         $_->set('pkgnum',      $cust_pkg->pkgnum);
1259         $_->set('locationnum', $cust_pkg->tax_locationnum);
1260       }
1261
1262       $taxes{''} = [ @taxes ];
1263       $taxes{'setup'} = [ @taxes ];
1264       $taxes{'recur'} = [ @taxes ];
1265       $taxes{$_} = [ @taxes ] foreach (@classes);
1266
1267       # # maybe eliminate this entirely, along with all the 0% records
1268       # unless ( @taxes ) {
1269       #   return
1270       #     "fatal: can't find tax rate for state/county/country/taxclass ".
1271       #     join('/', map $taxhash{$_}, qw(state county country taxclass) );
1272       # }
1273
1274     } #if $conf->exists('enable_taxproducts') ...
1275
1276   }
1277
1278   #what's this doing in the middle of _handle_taxes?  probably should split
1279   #this into three parts above in _make_lines
1280   $cust_bill_pkg->set_display(   part_pkg     => $part_pkg,
1281                                  real_pkgpart => $real_pkgpart,
1282                              );
1283
1284   my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
1285   foreach my $key (keys %tax_cust_bill_pkg) {
1286     # $key is "setup", "recur", or a usage class name. ('' is a usage class.)
1287     # $tax_cust_bill_pkg{$key} is a cust_bill_pkg for that component of
1288     # the line item.
1289     # $taxes{$key} is an arrayref of cust_main_county or tax_rate objects that
1290     # apply to $key-class charges.
1291     my @taxes = @{ $taxes{$key} || [] };
1292     my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
1293
1294     my %localtaxlisthash = ();
1295     foreach my $tax ( @taxes ) {
1296
1297       # this is the tax identifier, not the taxname
1298       my $taxname = ref( $tax ). ' '. $tax->taxnum;
1299 #      $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
1300 #                  ' locationnum'. $cust_pkg->locationnum
1301 #        if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
1302
1303       # $taxlisthash: keys are "setup", "recur", and usage classes
1304       # values are arrayrefs, first the tax object (cust_main_county
1305       # or tax_rate) and then any cust_bill_pkg objects that the
1306       # tax applies to
1307       $taxlisthash->{ $taxname } ||= [ $tax ];
1308       push @{ $taxlisthash->{ $taxname  } }, $tax_cust_bill_pkg;
1309
1310       $localtaxlisthash{ $taxname } ||= [ $tax ];
1311       push @{ $localtaxlisthash{ $taxname  } }, $tax_cust_bill_pkg;
1312
1313     }
1314
1315     warn "finding taxed taxes...\n" if $DEBUG > 2;
1316     foreach my $tax ( keys %localtaxlisthash ) {
1317       my $tax_object = shift @{ $localtaxlisthash{$tax} };
1318       warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
1319         if $DEBUG > 2;
1320       next unless $tax_object->can('tax_on_tax');
1321
1322       foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
1323         my $totname = ref( $tot ). ' '. $tot->taxnum;
1324
1325         warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
1326           if $DEBUG > 2;
1327         next unless exists( $localtaxlisthash{ $totname } ); # only increase
1328                                                              # existing taxes
1329         warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
1330         my $hashref_or_error =
1331           $tax_object->taxline( $localtaxlisthash{$tax},
1332                                 'custnum'      => $self->custnum,
1333                                 'invoice_time' => $invoice_time,
1334                               );
1335         return $hashref_or_error
1336           unless ref($hashref_or_error);
1337
1338         $taxlisthash->{ $totname } ||= [ $tot ];
1339         push @{ $taxlisthash->{ $totname  } }, $hashref_or_error->{amount};
1340
1341       }
1342     }
1343
1344   }
1345
1346   '';
1347 }
1348
1349 sub _gather_taxes {
1350   my $self = shift;
1351   my $part_pkg = shift;
1352   my $class = shift;
1353   my $cust_pkg = shift;
1354
1355   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1356
1357   my $geocode;
1358   if ( $cust_pkg->locationnum && $conf->exists('tax-pkg_address') ) {
1359     $geocode = $cust_pkg->cust_location->geocode('cch');
1360   } else {
1361     $geocode = $self->geocode('cch');
1362   }
1363
1364   my @taxes = ();
1365
1366   my @taxclassnums = map { $_->taxclassnum }
1367                      $part_pkg->part_pkg_taxoverride($class);
1368
1369   unless (@taxclassnums) {
1370     @taxclassnums = map { $_->taxclassnum }
1371                     grep { $_->taxable eq 'Y' }
1372                     $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
1373   }
1374   warn "Found taxclassnum values of ". join(',', @taxclassnums)
1375     if $DEBUG;
1376
1377   my $extra_sql =
1378     "AND (".
1379     join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
1380
1381   @taxes = qsearch({ 'table' => 'tax_rate',
1382                      'hashref' => { 'geocode' => $geocode, },
1383                      'extra_sql' => $extra_sql,
1384                   })
1385     if scalar(@taxclassnums);
1386
1387   warn "Found taxes ".
1388        join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
1389    if $DEBUG;
1390
1391   [ @taxes ];
1392
1393 }
1394
1395 =item collect [ HASHREF | OPTION => VALUE ... ]
1396
1397 (Attempt to) collect money for this customer's outstanding invoices (see
1398 L<FS::cust_bill>).  Usually used after the bill method.
1399
1400 Actions are now triggered by billing events; see L<FS::part_event> and the
1401 billing events web interface.  Old-style invoice events (see
1402 L<FS::part_bill_event>) have been deprecated.
1403
1404 If there is an error, returns the error, otherwise returns false.
1405
1406 Options are passed as name-value pairs.
1407
1408 Currently available options are:
1409
1410 =over 4
1411
1412 =item invoice_time
1413
1414 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.
1415
1416 =item retry
1417
1418 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1419
1420 =item check_freq
1421
1422 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1423
1424 =item quiet
1425
1426 set true to surpress email card/ACH decline notices.
1427
1428 =item debug
1429
1430 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)
1431
1432 =back
1433
1434 # =item payby
1435 #
1436 # allows for one time override of normal customer billing method
1437
1438 =cut
1439
1440 sub collect {
1441   my( $self, %options ) = @_;
1442
1443   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1444
1445   my $invoice_time = $options{'invoice_time'} || time;
1446
1447   #put below somehow?
1448   local $SIG{HUP} = 'IGNORE';
1449   local $SIG{INT} = 'IGNORE';
1450   local $SIG{QUIT} = 'IGNORE';
1451   local $SIG{TERM} = 'IGNORE';
1452   local $SIG{TSTP} = 'IGNORE';
1453   local $SIG{PIPE} = 'IGNORE';
1454
1455   my $oldAutoCommit = $FS::UID::AutoCommit;
1456   local $FS::UID::AutoCommit = 0;
1457   my $dbh = dbh;
1458
1459   $self->select_for_update; #mutex
1460
1461   if ( $DEBUG ) {
1462     my $balance = $self->balance;
1463     warn "$me collect customer ". $self->custnum. ": balance $balance\n"
1464   }
1465
1466   if ( exists($options{'retry_card'}) ) {
1467     carp 'retry_card option passed to collect is deprecated; use retry';
1468     $options{'retry'} ||= $options{'retry_card'};
1469   }
1470   if ( exists($options{'retry'}) && $options{'retry'} ) {
1471     my $error = $self->retry_realtime;
1472     if ( $error ) {
1473       $dbh->rollback if $oldAutoCommit;
1474       return $error;
1475     }
1476   }
1477
1478   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1479
1480   #never want to roll back an event just because it returned an error
1481   local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1482
1483   $self->do_cust_event(
1484     'debug'      => ( $options{'debug'} || 0 ),
1485     'time'       => $invoice_time,
1486     'check_freq' => $options{'check_freq'},
1487     'stage'      => 'collect',
1488   );
1489
1490 }
1491
1492 =item retry_realtime
1493
1494 Schedules realtime / batch  credit card / electronic check / LEC billing
1495 events for for retry.  Useful if card information has changed or manual
1496 retry is desired.  The 'collect' method must be called to actually retry
1497 the transaction.
1498
1499 Implementation details: For either this customer, or for each of this
1500 customer's open invoices, changes the status of the first "done" (with
1501 statustext error) realtime processing event to "failed".
1502
1503 =cut
1504
1505 sub retry_realtime {
1506   my $self = shift;
1507
1508   local $SIG{HUP} = 'IGNORE';
1509   local $SIG{INT} = 'IGNORE';
1510   local $SIG{QUIT} = 'IGNORE';
1511   local $SIG{TERM} = 'IGNORE';
1512   local $SIG{TSTP} = 'IGNORE';
1513   local $SIG{PIPE} = 'IGNORE';
1514
1515   my $oldAutoCommit = $FS::UID::AutoCommit;
1516   local $FS::UID::AutoCommit = 0;
1517   my $dbh = dbh;
1518
1519   #a little false laziness w/due_cust_event (not too bad, really)
1520
1521   my $join = FS::part_event_condition->join_conditions_sql;
1522   my $order = FS::part_event_condition->order_conditions_sql;
1523   my $mine =
1524   '( '
1525    . join ( ' OR ' , map {
1526     my $cust_join = FS::part_event->eventtables_cust_join->{$_} || '';
1527     my $custnum = FS::part_event->eventtables_custnum->{$_};
1528     "( part_event.eventtable = " . dbh->quote($_)
1529     . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key
1530     . " from $_ $cust_join"
1531     . " where $custnum = " . dbh->quote( $self->custnum ) . "))" ;
1532    } FS::part_event->eventtables)
1533    . ') ';
1534
1535   #here is the agent virtualization
1536   my $agent_virt = " (    part_event.agentnum IS NULL
1537                        OR part_event.agentnum = ". $self->agentnum. ' )';
1538
1539   #XXX this shouldn't be hardcoded, actions should declare it...
1540   my @realtime_events = qw(
1541     cust_bill_realtime_card
1542     cust_bill_realtime_check
1543     cust_bill_realtime_lec
1544     cust_bill_batch
1545   );
1546
1547   my $is_realtime_event =
1548     ' part_event.action IN ( '.
1549         join(',', map "'$_'", @realtime_events ).
1550     ' ) ';
1551
1552   my $batch_or_statustext =
1553     "( part_event.action = 'cust_bill_batch'
1554        OR ( statustext IS NOT NULL AND statustext != '' )
1555      )";
1556
1557
1558   my @cust_event = qsearch({
1559     'table'     => 'cust_event',
1560     'select'    => 'cust_event.*',
1561     'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
1562     'hashref'   => { 'status' => 'done' },
1563     'extra_sql' => " AND $batch_or_statustext ".
1564                    " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
1565   });
1566
1567   my %seen_invnum = ();
1568   foreach my $cust_event (@cust_event) {
1569
1570     #max one for the customer, one for each open invoice
1571     my $cust_X = $cust_event->cust_X;
1572     next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
1573                           ? $cust_X->invnum
1574                           : 0
1575                         }++
1576          or $cust_event->part_event->eventtable eq 'cust_bill'
1577             && ! $cust_X->owed;
1578
1579     my $error = $cust_event->retry;
1580     if ( $error ) {
1581       $dbh->rollback if $oldAutoCommit;
1582       return "error scheduling event for retry: $error";
1583     }
1584
1585   }
1586
1587   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1588   '';
1589
1590 }
1591
1592 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
1593
1594 Runs billing events; see L<FS::part_event> and the billing events web
1595 interface.
1596
1597 If there is an error, returns the error, otherwise returns false.
1598
1599 Options are passed as name-value pairs.
1600
1601 Currently available options are:
1602
1603 =over 4
1604
1605 =item time
1606
1607 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.
1608
1609 =item check_freq
1610
1611 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1612
1613 =item stage
1614
1615 "collect" (the default) or "pre-bill"
1616
1617 =item quiet
1618
1619 set true to surpress email card/ACH decline notices.
1620
1621 =item debug
1622
1623 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)
1624
1625 =back
1626 =cut
1627
1628 # =item payby
1629 #
1630 # allows for one time override of normal customer billing method
1631
1632 # =item retry
1633 #
1634 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1635
1636 sub do_cust_event {
1637   my( $self, %options ) = @_;
1638
1639   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1640
1641   my $time = $options{'time'} || time;
1642
1643   #put below somehow?
1644   local $SIG{HUP} = 'IGNORE';
1645   local $SIG{INT} = 'IGNORE';
1646   local $SIG{QUIT} = 'IGNORE';
1647   local $SIG{TERM} = 'IGNORE';
1648   local $SIG{TSTP} = 'IGNORE';
1649   local $SIG{PIPE} = 'IGNORE';
1650
1651   my $oldAutoCommit = $FS::UID::AutoCommit;
1652   local $FS::UID::AutoCommit = 0;
1653   my $dbh = dbh;
1654
1655   $self->select_for_update; #mutex
1656
1657   if ( $DEBUG ) {
1658     my $balance = $self->balance;
1659     warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
1660   }
1661
1662 #  if ( exists($options{'retry_card'}) ) {
1663 #    carp 'retry_card option passed to collect is deprecated; use retry';
1664 #    $options{'retry'} ||= $options{'retry_card'};
1665 #  }
1666 #  if ( exists($options{'retry'}) && $options{'retry'} ) {
1667 #    my $error = $self->retry_realtime;
1668 #    if ( $error ) {
1669 #      $dbh->rollback if $oldAutoCommit;
1670 #      return $error;
1671 #    }
1672 #  }
1673
1674   # false laziness w/pay_batch::import_results
1675
1676   my $due_cust_event = $self->due_cust_event(
1677     'debug'      => ( $options{'debug'} || 0 ),
1678     'time'       => $time,
1679     'check_freq' => $options{'check_freq'},
1680     'stage'      => ( $options{'stage'} || 'collect' ),
1681   );
1682   unless( ref($due_cust_event) ) {
1683     $dbh->rollback if $oldAutoCommit;
1684     return $due_cust_event;
1685   }
1686
1687   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1688   #never want to roll back an event just because it or a different one
1689   # returned an error
1690   local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1691
1692   foreach my $cust_event ( @$due_cust_event ) {
1693
1694     #XXX lock event
1695
1696     #re-eval event conditions (a previous event could have changed things)
1697     unless ( $cust_event->test_conditions ) {
1698       #don't leave stray "new/locked" records around
1699       my $error = $cust_event->delete;
1700       return $error if $error;
1701       next;
1702     }
1703
1704     {
1705       local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
1706         if $options{'quiet'};
1707       warn "  running cust_event ". $cust_event->eventnum. "\n"
1708         if $DEBUG > 1;
1709
1710       #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
1711       if ( my $error = $cust_event->do_event( 'time' => $time ) ) {
1712         #XXX wtf is this?  figure out a proper dealio with return value
1713         #from do_event
1714         return $error;
1715       }
1716     }
1717
1718   }
1719
1720   '';
1721
1722 }
1723
1724 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
1725
1726 Inserts database records for and returns an ordered listref of new events due
1727 for this customer, as FS::cust_event objects (see L<FS::cust_event>).  If no
1728 events are due, an empty listref is returned.  If there is an error, returns a
1729 scalar error message.
1730
1731 To actually run the events, call each event's test_condition method, and if
1732 still true, call the event's do_event method.
1733
1734 Options are passed as a hashref or as a list of name-value pairs.  Available
1735 options are:
1736
1737 =over 4
1738
1739 =item check_freq
1740
1741 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.
1742
1743 =item stage
1744
1745 "collect" (the default) or "pre-bill"
1746
1747 =item time
1748
1749 "Current time" for the events.
1750
1751 =item debug
1752
1753 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)
1754
1755 =item eventtable
1756
1757 Only return events for the specified eventtable (by default, events of all eventtables are returned)
1758
1759 =item objects
1760
1761 Explicitly pass the objects to be tested (typically used with eventtable).
1762
1763 =item testonly
1764
1765 Set to true to return the objects, but not actually insert them into the
1766 database.
1767
1768 =back
1769
1770 =cut
1771
1772 sub due_cust_event {
1773   my $self = shift;
1774   my %opt = ref($_[0]) ? %{ $_[0] } : @_;
1775
1776   #???
1777   #my $DEBUG = $opt{'debug'}
1778   local($DEBUG) = $opt{'debug'}
1779     if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
1780   $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1781
1782   warn "$me due_cust_event called with options ".
1783        join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
1784     if $DEBUG;
1785
1786   $opt{'time'} ||= time;
1787
1788   local $SIG{HUP} = 'IGNORE';
1789   local $SIG{INT} = 'IGNORE';
1790   local $SIG{QUIT} = 'IGNORE';
1791   local $SIG{TERM} = 'IGNORE';
1792   local $SIG{TSTP} = 'IGNORE';
1793   local $SIG{PIPE} = 'IGNORE';
1794
1795   my $oldAutoCommit = $FS::UID::AutoCommit;
1796   local $FS::UID::AutoCommit = 0;
1797   my $dbh = dbh;
1798
1799   $self->select_for_update #mutex
1800     unless $opt{testonly};
1801
1802   ###
1803   # find possible events (initial search)
1804   ###
1805
1806   my @cust_event = ();
1807
1808   my @eventtable = $opt{'eventtable'}
1809                      ? ( $opt{'eventtable'} )
1810                      : FS::part_event->eventtables_runorder;
1811
1812   my $check_freq = $opt{'check_freq'} || '1d';
1813
1814   foreach my $eventtable ( @eventtable ) {
1815
1816     my @objects;
1817     if ( $opt{'objects'} ) {
1818
1819       @objects = @{ $opt{'objects'} };
1820
1821     } elsif ( $eventtable eq 'cust_main' ) {
1822
1823       @objects = ( $self );
1824
1825     } else {
1826
1827       my $cm_join = " LEFT JOIN cust_main USING ( custnum )";
1828       # linkage not needed here because FS::cust_main->$eventtable will
1829       # already supply it
1830
1831       #some false laziness w/Cron::bill bill_where
1832
1833       my $join  = FS::part_event_condition->join_conditions_sql( $eventtable);
1834       my $where = FS::part_event_condition->where_conditions_sql($eventtable,
1835         'time'=>$opt{'time'},
1836       );
1837       $where = $where ? "AND $where" : '';
1838
1839       my $are_part_event =
1840       "EXISTS ( SELECT 1 FROM part_event $join
1841         WHERE check_freq = '$check_freq'
1842         AND eventtable = '$eventtable'
1843         AND ( disabled = '' OR disabled IS NULL )
1844         $where
1845         )
1846       ";
1847       #eofalse
1848
1849       @objects = $self->$eventtable(
1850         'addl_from' => $cm_join,
1851         'extra_sql' => " AND $are_part_event",
1852       );
1853     } # if ( !$opt{objects} and $eventtable ne 'cust_main' )
1854
1855     my @e_cust_event = ();
1856
1857     my $linkage = FS::part_event->eventtables_cust_join->{$eventtable} || '';
1858
1859     my $cross = "CROSS JOIN $eventtable $linkage";
1860     $cross .= ' LEFT JOIN cust_main USING ( custnum )'
1861       unless $eventtable eq 'cust_main';
1862
1863     foreach my $object ( @objects ) {
1864
1865       #this first search uses the condition_sql magic for optimization.
1866       #the more possible events we can eliminate in this step the better
1867
1868       my $cross_where = '';
1869       my $pkey = $object->primary_key;
1870       $cross_where = "$eventtable.$pkey = ". $object->$pkey();
1871
1872       my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
1873       my $extra_sql =
1874         FS::part_event_condition->where_conditions_sql( $eventtable,
1875                                                         'time'=>$opt{'time'}
1876                                                       );
1877       my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
1878
1879       $extra_sql = "AND $extra_sql" if $extra_sql;
1880
1881       #here is the agent virtualization
1882       $extra_sql .= " AND (    part_event.agentnum IS NULL
1883                             OR part_event.agentnum = ". $self->agentnum. ' )';
1884
1885       $extra_sql .= " $order";
1886
1887       warn "searching for events for $eventtable ". $object->$pkey. "\n"
1888         if $opt{'debug'} > 2;
1889       my @part_event = qsearch( {
1890         'debug'     => ( $opt{'debug'} > 3 ? 1 : 0 ),
1891         'select'    => 'part_event.*',
1892         'table'     => 'part_event',
1893         'addl_from' => "$cross $join",
1894         'hashref'   => { 'check_freq' => $check_freq,
1895                          'eventtable' => $eventtable,
1896                          'disabled'   => '',
1897                        },
1898         'extra_sql' => "AND $cross_where $extra_sql",
1899       } );
1900
1901       if ( $DEBUG > 2 ) {
1902         my $pkey = $object->primary_key;
1903         warn "      ". scalar(@part_event).
1904              " possible events found for $eventtable ". $object->$pkey(). "\n";
1905       }
1906
1907       push @e_cust_event, map {
1908         $_->new_cust_event($object, 'time' => $opt{'time'})
1909       } @part_event;
1910
1911     }
1912
1913     warn "    ". scalar(@e_cust_event).
1914          " subtotal possible cust events found for $eventtable\n"
1915       if $DEBUG > 1;
1916
1917     push @cust_event, @e_cust_event;
1918
1919   }
1920
1921   warn "  ". scalar(@cust_event).
1922        " total possible cust events found in initial search\n"
1923     if $DEBUG; # > 1;
1924
1925
1926   ##
1927   # test stage
1928   ##
1929
1930   $opt{stage} ||= 'collect';
1931   @cust_event =
1932     grep { my $stage = $_->part_event->event_stage;
1933            $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
1934          }
1935          @cust_event;
1936
1937   ##
1938   # test conditions
1939   ##
1940
1941   my %unsat = ();
1942
1943   @cust_event = grep $_->test_conditions( 'stats_hashref' => \%unsat ),
1944                      @cust_event;
1945
1946   warn "  ". scalar(@cust_event). " cust events left satisfying conditions\n"
1947     if $DEBUG; # > 1;
1948
1949   warn "    invalid conditions not eliminated with condition_sql:\n".
1950        join('', map "      $_: ".$unsat{$_}."\n", keys %unsat )
1951     if keys %unsat && $DEBUG; # > 1;
1952
1953   ##
1954   # insert
1955   ##
1956
1957   unless( $opt{testonly} ) {
1958     foreach my $cust_event ( @cust_event ) {
1959
1960       my $error = $cust_event->insert();
1961       if ( $error ) {
1962         $dbh->rollback if $oldAutoCommit;
1963         return $error;
1964       }
1965
1966     }
1967   }
1968
1969   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1970
1971   ##
1972   # return
1973   ##
1974
1975   warn "  returning events: ". Dumper(@cust_event). "\n"
1976     if $DEBUG > 2;
1977
1978   \@cust_event;
1979
1980 }
1981
1982 =item apply_payments_and_credits [ OPTION => VALUE ... ]
1983
1984 Applies unapplied payments and credits.
1985
1986 In most cases, this new method should be used in place of sequential
1987 apply_payments and apply_credits methods.
1988
1989 A hash of optional arguments may be passed.  Currently "manual" is supported.
1990 If true, a payment receipt is sent instead of a statement when
1991 'payment_receipt_email' configuration option is set.
1992
1993 If there is an error, returns the error, otherwise returns false.
1994
1995 =cut
1996
1997 sub apply_payments_and_credits {
1998   my( $self, %options ) = @_;
1999
2000   local $SIG{HUP} = 'IGNORE';
2001   local $SIG{INT} = 'IGNORE';
2002   local $SIG{QUIT} = 'IGNORE';
2003   local $SIG{TERM} = 'IGNORE';
2004   local $SIG{TSTP} = 'IGNORE';
2005   local $SIG{PIPE} = 'IGNORE';
2006
2007   my $oldAutoCommit = $FS::UID::AutoCommit;
2008   local $FS::UID::AutoCommit = 0;
2009   my $dbh = dbh;
2010
2011   $self->select_for_update; #mutex
2012
2013   foreach my $cust_bill ( $self->open_cust_bill ) {
2014     my $error = $cust_bill->apply_payments_and_credits(%options);
2015     if ( $error ) {
2016       $dbh->rollback if $oldAutoCommit;
2017       return "Error applying: $error";
2018     }
2019   }
2020
2021   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2022   ''; #no error
2023
2024 }
2025
2026 =item apply_credits OPTION => VALUE ...
2027
2028 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
2029 to outstanding invoice balances in chronological order (or reverse
2030 chronological order if the I<order> option is set to B<newest>) and returns the
2031 value of any remaining unapplied credits available for refund (see
2032 L<FS::cust_refund>).
2033
2034 Dies if there is an error.
2035
2036 =cut
2037
2038 sub apply_credits {
2039   my $self = shift;
2040   my %opt = @_;
2041
2042   local $SIG{HUP} = 'IGNORE';
2043   local $SIG{INT} = 'IGNORE';
2044   local $SIG{QUIT} = 'IGNORE';
2045   local $SIG{TERM} = 'IGNORE';
2046   local $SIG{TSTP} = 'IGNORE';
2047   local $SIG{PIPE} = 'IGNORE';
2048
2049   my $oldAutoCommit = $FS::UID::AutoCommit;
2050   local $FS::UID::AutoCommit = 0;
2051   my $dbh = dbh;
2052
2053   $self->select_for_update; #mutex
2054
2055   unless ( $self->total_unapplied_credits ) {
2056     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2057     return 0;
2058   }
2059
2060   my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
2061       qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
2062
2063   my @invoices = $self->open_cust_bill;
2064   @invoices = sort { $b->_date <=> $a->_date } @invoices
2065     if defined($opt{'order'}) && $opt{'order'} eq 'newest';
2066
2067   if ( $conf->exists('pkg-balances') ) {
2068     # limit @credits to those w/ a pkgnum grepped from $self
2069     my %pkgnums = ();
2070     foreach my $i (@invoices) {
2071       foreach my $li ( $i->cust_bill_pkg ) {
2072         $pkgnums{$li->pkgnum} = 1;
2073       }
2074     }
2075     @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
2076   }
2077
2078   my $credit;
2079
2080   foreach my $cust_bill ( @invoices ) {
2081
2082     if ( !defined($credit) || $credit->credited == 0) {
2083       $credit = pop @credits or last;
2084     }
2085
2086     my $owed;
2087     if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
2088       $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
2089     } else {
2090       $owed = $cust_bill->owed;
2091     }
2092     unless ( $owed > 0 ) {
2093       push @credits, $credit;
2094       next;
2095     }
2096
2097     my $amount = min( $credit->credited, $owed );
2098
2099     my $cust_credit_bill = new FS::cust_credit_bill ( {
2100       'crednum' => $credit->crednum,
2101       'invnum'  => $cust_bill->invnum,
2102       'amount'  => $amount,
2103     } );
2104     $cust_credit_bill->pkgnum( $credit->pkgnum )
2105       if $conf->exists('pkg-balances') && $credit->pkgnum;
2106     my $error = $cust_credit_bill->insert;
2107     if ( $error ) {
2108       $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2109       die $error;
2110     }
2111
2112     redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2113
2114   }
2115
2116   my $total_unapplied_credits = $self->total_unapplied_credits;
2117
2118   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2119
2120   return $total_unapplied_credits;
2121 }
2122
2123 =item apply_payments  [ OPTION => VALUE ... ]
2124
2125 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2126 to outstanding invoice balances in chronological order.
2127
2128  #and returns the value of any remaining unapplied payments.
2129
2130 A hash of optional arguments may be passed.  Currently "manual" is supported.
2131 If true, a payment receipt is sent instead of a statement when
2132 'payment_receipt_email' configuration option is set.
2133
2134 Dies if there is an error.
2135
2136 =cut
2137
2138 sub apply_payments {
2139   my( $self, %options ) = @_;
2140
2141   local $SIG{HUP} = 'IGNORE';
2142   local $SIG{INT} = 'IGNORE';
2143   local $SIG{QUIT} = 'IGNORE';
2144   local $SIG{TERM} = 'IGNORE';
2145   local $SIG{TSTP} = 'IGNORE';
2146   local $SIG{PIPE} = 'IGNORE';
2147
2148   my $oldAutoCommit = $FS::UID::AutoCommit;
2149   local $FS::UID::AutoCommit = 0;
2150   my $dbh = dbh;
2151
2152   $self->select_for_update; #mutex
2153
2154   #return 0 unless
2155
2156   my @payments = sort { $b->_date <=> $a->_date }
2157                  grep { $_->unapplied > 0 }
2158                  $self->cust_pay;
2159
2160   my @invoices = sort { $a->_date <=> $b->_date}
2161                  grep { $_->owed > 0 }
2162                  $self->cust_bill;
2163
2164   if ( $conf->exists('pkg-balances') ) {
2165     # limit @payments to those w/ a pkgnum grepped from $self
2166     my %pkgnums = ();
2167     foreach my $i (@invoices) {
2168       foreach my $li ( $i->cust_bill_pkg ) {
2169         $pkgnums{$li->pkgnum} = 1;
2170       }
2171     }
2172     @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
2173   }
2174
2175   my $payment;
2176
2177   foreach my $cust_bill ( @invoices ) {
2178
2179     if ( !defined($payment) || $payment->unapplied == 0 ) {
2180       $payment = pop @payments or last;
2181     }
2182
2183     my $owed;
2184     if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
2185       $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
2186     } else {
2187       $owed = $cust_bill->owed;
2188     }
2189     unless ( $owed > 0 ) {
2190       push @payments, $payment;
2191       next;
2192     }
2193
2194     my $amount = min( $payment->unapplied, $owed );
2195
2196     my $cbp = {
2197       'paynum' => $payment->paynum,
2198       'invnum' => $cust_bill->invnum,
2199       'amount' => $amount,
2200     };
2201     $cbp->{_date} = $payment->_date
2202         if $options{'manual'} && $options{'backdate_application'};
2203     my $cust_bill_pay = new FS::cust_bill_pay($cbp);
2204     $cust_bill_pay->pkgnum( $payment->pkgnum )
2205       if $conf->exists('pkg-balances') && $payment->pkgnum;
2206     my $error = $cust_bill_pay->insert(%options);
2207     if ( $error ) {
2208       $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2209       die $error;
2210     }
2211
2212     redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2213
2214   }
2215
2216   my $total_unapplied_payments = $self->total_unapplied_payments;
2217
2218   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2219
2220   return $total_unapplied_payments;
2221 }
2222
2223 =back
2224
2225 =head1 FLOW
2226
2227   bill_and_collect
2228
2229     cancel_expired_pkgs
2230     suspend_adjourned_pkgs
2231     unsuspend_resumed_pkgs
2232
2233     bill
2234       (do_cust_event pre-bill)
2235       _make_lines
2236         _handle_taxes
2237           (vendor-only) _gather_taxes
2238       _omit_zero_value_bundles
2239       calculate_taxes
2240
2241     apply_payments_and_credits
2242     collect
2243       do_cust_event
2244         due_cust_event
2245
2246 =head1 BUGS
2247
2248 =head1 SEE ALSO
2249
2250 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>
2251
2252 =cut
2253
2254 1;