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   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
 725
 726   warn "$me calculate_taxes\n"
 727        #.Dumper($self, $cust_bill_pkg, $taxlisthash, $invoice_time). "\n"
 728     if $DEBUG > 2;
 729
 730   my @tax_line_items = ();
 731
 732   # keys are tax names (as printed on invoices / itemdesc )
 733   # values are listrefs of taxlisthash keys (internal identifiers)
 734   my %taxname = ();
 735
 736   # keys are taxlisthash keys (internal identifiers)
 737   # values are (cumulative) amounts
 738   my %tax = ();
 739
 740   # keys are taxlisthash keys (internal identifiers)
 741   # values are listrefs of cust_bill_pkg_tax_location hashrefs
 742   my %tax_location = ();
 743
 744   # keys are taxlisthash keys (internal identifiers)
 745   # values are listrefs of cust_bill_pkg_tax_rate_location hashrefs
 746   my %tax_rate_location = ();
 747
 748   foreach my $tax ( keys %$taxlisthash ) {
 749     my $tax_object = shift @{ $taxlisthash->{$tax} };
 750     warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
 751     warn " ". join('/', @{ $taxlisthash->{$tax} } ). "\n" if $DEBUG > 2;
 752     my $hashref_or_error =
 753       $tax_object->taxline( $taxlisthash->{$tax},
 754                             'custnum'      => $self->custnum,
 755                             'invoice_time' => $invoice_time
 756                           );
 757     return $hashref_or_error unless ref($hashref_or_error);
 758
 759     unshift @{ $taxlisthash->{$tax} }, $tax_object;
 760
 761     my $name   = $hashref_or_error->{'name'};
 762     my $amount = $hashref_or_error->{'amount'};
 763
 764     #warn "adding $amount as $name\n";
 765     $taxname{ $name } ||= [];
 766     push @{ $taxname{ $name } }, $tax;
 767
 768     $tax{ $tax } += $amount;
 769
 770     $tax_location{ $tax } ||= [];
 771     if ( $tax_object->get('pkgnum') || $tax_object->get('locationnum') ) {
 772       push @{ $tax_location{ $tax }  },
 773         {
 774           'taxnum'      => $tax_object->taxnum,
 775           'taxtype'     => ref($tax_object),
 776           'pkgnum'      => $tax_object->get('pkgnum'),
 777           'locationnum' => $tax_object->get('locationnum'),
 778           'amount'      => sprintf('%.2f', $amount ),
 779         };
 780     }
 781
 782     $tax_rate_location{ $tax } ||= [];
 783     if ( ref($tax_object) eq 'FS::tax_rate' ) {
 784       my $taxratelocationnum =
 785         $tax_object->tax_rate_location->taxratelocationnum;
 786       push @{ $tax_rate_location{ $tax }  },
 787         {
 788           'taxnum'             => $tax_object->taxnum,
 789           'taxtype'            => ref($tax_object),
 790           'amount'             => sprintf('%.2f', $amount ),
 791           'locationtaxid'      => $tax_object->location,
 792           'taxratelocationnum' => $taxratelocationnum,
 793         };
 794     }
 795
 796   }
 797
 798   #move the cust_tax_exempt_pkg records to the cust_bill_pkgs we will commit
 799   my %packagemap = map { $_->pkgnum => $_ } @$cust_bill_pkg;
 800   foreach my $tax ( keys %$taxlisthash ) {
 801     foreach ( @{ $taxlisthash->{$tax} }[1 ... scalar(@{ $taxlisthash->{$tax} })] ) {
 802       next unless ref($_) eq 'FS::cust_bill_pkg';
 803
 804       my @cust_tax_exempt_pkg = splice( @{ $_->_cust_tax_exempt_pkg } );
 805
 806       next unless @cust_tax_exempt_pkg; #just avoiding the prob when irrelevant?
 807       die "can't distribute tax exemptions: no line item for ".  Dumper($_).
 808           " in packagemap ". join(',', sort {$a<=>$b} keys %packagemap). "\n"
 809         unless $packagemap{$_->pkgnum};
 810
 811       push @{ $packagemap{$_->pkgnum}->_cust_tax_exempt_pkg },
 812            @cust_tax_exempt_pkg;
 813     }
 814   }
 815
 816   #consolidate and create tax line items
 817   warn "consolidating and generating...\n" if $DEBUG > 2;
 818   foreach my $taxname ( keys %taxname ) {
 819     my $tax = 0;
 820     my %seen = ();
 821     my @cust_bill_pkg_tax_location = ();
 822     my @cust_bill_pkg_tax_rate_location = ();
 823     warn "adding $taxname\n" if $DEBUG > 1;
 824     foreach my $taxitem ( @{ $taxname{$taxname} } ) {
 825       next if $seen{$taxitem}++;
 826       warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
 827       $tax += $tax{$taxitem};
 828       push @cust_bill_pkg_tax_location,
 829         map { new FS::cust_bill_pkg_tax_location $_ }
 830             @{ $tax_location{ $taxitem } };
 831       push @cust_bill_pkg_tax_rate_location,
 832         map { new FS::cust_bill_pkg_tax_rate_location $_ }
 833             @{ $tax_rate_location{ $taxitem } };
 834     }
 835     next unless $tax;
 836
 837     $tax = sprintf('%.2f', $tax );
 838
 839     my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
 840                                                    'disabled'     => '',
 841                                                  },
 842                                );
 843
 844     my @display = ();
 845     if ( $pkg_category and
 846          $conf->config('invoice_latexsummary') ||
 847          $conf->config('invoice_htmlsummary')
 848        )
 849     {
 850
 851       my %hash = (  'section' => $pkg_category->categoryname );
 852       push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
 853
 854     }
 855
 856     push @tax_line_items, new FS::cust_bill_pkg {
 857       'pkgnum'   => 0,
 858       'setup'    => $tax,
 859       'recur'    => 0,
 860       'sdate'    => '',
 861       'edate'    => '',
 862       'itemdesc' => $taxname,
 863       'display'  => \@display,
 864       'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
 865       'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
 866     };
 867
 868   }
 869
 870   \@tax_line_items;
 871 }
 872
 873 sub _make_lines {
 874   my ($self, %params) = @_;
 875
 876   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
 877
 878   my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
 879   my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
 880   my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
 881   my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
 882   my $total_setup = $params{setup} or die "no setup accumulator specified";
 883   my $total_recur = $params{recur} or die "no recur accumulator specified";
 884   my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
 885   my $time = $params{'time'} or die "no time specified";
 886   my (%options) = %{$params{options}};
 887
 888   if ( $part_pkg->freq ne '1' and ($options{'freq_override'} || 0) > 0 ) {
 889     # this should never happen
 890     die 'freq_override billing attempted on non-monthly package '.
 891       $cust_pkg->pkgnum;
 892   }
 893
 894   my $dbh = dbh;
 895   my $real_pkgpart = $params{real_pkgpart};
 896   my %hash = $cust_pkg->hash;
 897   my $old_cust_pkg = new FS::cust_pkg \%hash;
 898
 899   my @details = ();
 900   my $lineitems = 0;
 901
 902   $cust_pkg->pkgpart($part_pkg->pkgpart);
 903
 904   ###
 905   # bill setup
 906   ###
 907
 908   my $setup = 0;
 909   my $unitsetup = 0;
 910   my @setup_discounts = ();
 911   my %setup_param = ( 'discounts' => \@setup_discounts );
 912   if (     ! $options{recurring_only}
 913        and ! $options{cancel}
 914        and ( $options{'resetup'}
 915              || ( ! $cust_pkg->setup
 916                   && ( ! $cust_pkg->start_date
 917                        || $cust_pkg->start_date <= day_end($time)
 918                      )
 919                   && ( ! $conf->exists('disable_setup_suspended_pkgs')
 920                        || ( $conf->exists('disable_setup_suspended_pkgs') &&
 921                             ! $cust_pkg->getfield('susp')
 922                           )
 923                      )
 924                 )
 925            )
 926      )
 927   {
 928
 929     warn "    bill setup\n" if $DEBUG > 1;
 930
 931     unless ( $cust_pkg->waive_setup ) {
 932         $lineitems++;
 933
 934         $setup = eval { $cust_pkg->calc_setup( $time, \@details, \%setup_param ) };
 935         return "$@ running calc_setup for $cust_pkg\n"
 936           if $@;
 937
 938         $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
 939     }
 940
 941     $cust_pkg->setfield('setup', $time)
 942       unless $cust_pkg->setup;
 943           #do need it, but it won't get written to the db
 944           #|| $cust_pkg->pkgpart != $real_pkgpart;
 945
 946     $cust_pkg->setfield('start_date', '')
 947       if $cust_pkg->start_date;
 948
 949   }
 950
 951   ###
 952   # bill recurring fee
 953   ###
 954
 955   #XXX unit stuff here too
 956   my $recur = 0;
 957   my $unitrecur = 0;
 958   my @recur_discounts = ();
 959   my $sdate;
 960   if (     ! $cust_pkg->start_date
 961        and ( ! $cust_pkg->susp || $cust_pkg->option('suspend_bill',1)
 962                                || ( $part_pkg->option('suspend_bill', 1) )
 963                                      && ! $cust_pkg->option('no_suspend_bill',1)
 964                                   )
 965        and
 966             ( $part_pkg->freq ne '0' && ( $cust_pkg->bill || 0 ) <= day_end($time) )
 967          || ( $part_pkg->plan eq 'voip_cdr'
 968                && $part_pkg->option('bill_every_call')
 969             )
 970          || $options{cancel}
 971   ) {
 972
 973     # XXX should this be a package event?  probably.  events are called
 974     # at collection time at the moment, though...
 975     $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
 976       if $part_pkg->can('reset_usage') && !$options{'no_usage_reset'};
 977       #don't want to reset usage just cause we want a line item??
 978       #&& $part_pkg->pkgpart == $real_pkgpart;
 979
 980     warn "    bill recur\n" if $DEBUG > 1;
 981     $lineitems++;
 982
 983     # XXX shared with $recur_prog
 984     $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
 985              || $cust_pkg->setup
 986              || $time;
 987
 988     #over two params!  lets at least switch to a hashref for the rest...
 989     my $increment_next_bill = ( $part_pkg->freq ne '0'
 990                                 && ( $cust_pkg->getfield('bill') || 0 ) <= day_end($time)
 991                                 && !$options{cancel}
 992                               );
 993     my %param = ( %setup_param,
 994                   'precommit_hooks'     => $precommit_hooks,
 995                   'increment_next_bill' => $increment_next_bill,
 996                   'discounts'           => \@recur_discounts,
 997                   'real_pkgpart'        => $real_pkgpart,
 998                   'freq_override'       => $options{freq_override} || '',
 999                   'setup_fee'           => 0,
1000                 );
1001
1002     my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
1003
1004     # There may be some part_pkg for which this is wrong.  Only those
1005     # which can_discount are supported.
1006     # (the UI should prevent adding discounts to these at the moment)
1007
1008     warn "calling $method on cust_pkg ". $cust_pkg->pkgnum.
1009          " for pkgpart ". $cust_pkg->pkgpart.
1010          " with params ". join(' / ', map "$_=>$param{$_}", keys %param). "\n"
1011       if $DEBUG > 2;
1012
1013     $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
1014     return "$@ running $method for $cust_pkg\n"
1015       if ( $@ );
1016
1017     if ( $increment_next_bill ) {
1018
1019       my $next_bill = $part_pkg->add_freq($sdate, $options{freq_override} || 0);
1020       return "unparsable frequency: ". $part_pkg->freq
1021         if $next_bill == -1;
1022
1023       #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
1024       # only for figuring next bill date, nothing else, so, reset $sdate again
1025       # here
1026       $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1027       #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
1028       $cust_pkg->last_bill($sdate);
1029
1030       $cust_pkg->setfield('bill', $next_bill );
1031
1032     }
1033
1034     if ( $param{'setup_fee'} ) {
1035       # Add an additional setup fee at the billing stage.
1036       # Used for prorate_defer_bill.
1037       $setup += $param{'setup_fee'};
1038       $unitsetup += $param{'setup_fee'};
1039       $lineitems++;
1040     }
1041
1042     if ( defined $param{'discount_left_setup'} ) {
1043         foreach my $discount_setup ( values %{$param{'discount_left_setup'}} ) {
1044             $setup -= $discount_setup;
1045         }
1046     }
1047
1048   }
1049
1050   warn "\$setup is undefined" unless defined($setup);
1051   warn "\$recur is undefined" unless defined($recur);
1052   warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1053
1054   ###
1055   # If there's line items, create em cust_bill_pkg records
1056   # If $cust_pkg has been modified, update it (if we're a real pkgpart)
1057   ###
1058
1059   if ( $lineitems ) {
1060
1061     if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
1062       # hmm.. and if just the options are modified in some weird price plan?
1063
1064       warn "  package ". $cust_pkg->pkgnum. " modified; updating\n"
1065         if $DEBUG >1;
1066
1067       my $error = $cust_pkg->replace( $old_cust_pkg,
1068                                       'depend_jobnum'=>$options{depend_jobnum},
1069                                       'options' => { $cust_pkg->options },
1070                                     )
1071         unless $options{no_commit};
1072       return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
1073         if $error; #just in case
1074     }
1075
1076     $setup = sprintf( "%.2f", $setup );
1077     $recur = sprintf( "%.2f", $recur );
1078     if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
1079       return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1080     }
1081     if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
1082       return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
1083     }
1084
1085     my $discount_show_always = $conf->exists('discount-show-always')
1086                                && (    ($setup == 0 && scalar(@setup_discounts))
1087                                     || ($recur == 0 && scalar(@recur_discounts))
1088                                   );
1089
1090     if (    $setup != 0
1091          || $recur != 0
1092          || (!$part_pkg->hidden && $options{has_hidden}) #include some $0 lines
1093          || $discount_show_always
1094          || ($setup == 0 && $cust_pkg->_X_show_zero('setup'))
1095          || ($recur == 0 && $cust_pkg->_X_show_zero('recur'))
1096        )
1097     {
1098
1099       warn "    charges (setup=$setup, recur=$recur); adding line items\n"
1100         if $DEBUG > 1;
1101
1102       my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
1103       if ( $DEBUG > 1 ) {
1104         warn "      adding customer package invoice detail: $_\n"
1105           foreach @cust_pkg_detail;
1106       }
1107       push @details, @cust_pkg_detail;
1108
1109       my $cust_bill_pkg = new FS::cust_bill_pkg {
1110         'pkgnum'    => $cust_pkg->pkgnum,
1111         'setup'     => $setup,
1112         'unitsetup' => $unitsetup,
1113         'recur'     => $recur,
1114         'unitrecur' => $unitrecur,
1115         'quantity'  => $cust_pkg->quantity,
1116         'details'   => \@details,
1117         'discounts' => [ @setup_discounts, @recur_discounts ],
1118         'hidden'    => $part_pkg->hidden,
1119         'freq'      => $part_pkg->freq,
1120       };
1121
1122       if ( $part_pkg->option('prorate_defer_bill',1)
1123            and !$hash{last_bill} ) {
1124         # both preceding and upcoming, technically
1125         $cust_bill_pkg->sdate( $cust_pkg->setup );
1126         $cust_bill_pkg->edate( $cust_pkg->bill );
1127       } elsif ( $part_pkg->recur_temporality eq 'preceding' ) {
1128         $cust_bill_pkg->sdate( $hash{last_bill} );
1129         $cust_bill_pkg->edate( $sdate - 86399   ); #60s*60m*24h-1
1130         $cust_bill_pkg->edate( $time ) if $options{cancel};
1131       } else { #if ( $part_pkg->recur_temporality eq 'upcoming' ) {
1132         $cust_bill_pkg->sdate( $sdate );
1133         $cust_bill_pkg->edate( $cust_pkg->bill );
1134         #$cust_bill_pkg->edate( $time ) if $options{cancel};
1135       }
1136
1137       $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
1138         unless $part_pkg->pkgpart == $real_pkgpart;
1139
1140       $$total_setup += $setup;
1141       $$total_recur += $recur;
1142
1143       ###
1144       # handle taxes
1145       ###
1146
1147       unless ( $discount_show_always ) {
1148           my $error =
1149             $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart, \%options);
1150           return $error if $error;
1151       }
1152
1153       push @$cust_bill_pkgs, $cust_bill_pkg;
1154
1155     } #if $setup != 0 || $recur != 0
1156
1157   } #if $line_items
1158
1159   '';
1160
1161 }
1162
1163 sub _handle_taxes {
1164   my $self = shift;
1165   my $part_pkg = shift;
1166   my $taxlisthash = shift;
1167   my $cust_bill_pkg = shift;
1168   my $cust_pkg = shift;
1169   my $invoice_time = shift;
1170   my $real_pkgpart = shift;
1171   my $options = shift;
1172
1173   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1174
1175   my %cust_bill_pkg = ();
1176   my %taxes = ();
1177
1178   my @classes;
1179   #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
1180   push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
1181   push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
1182   push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
1183
1184   if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
1185
1186     if ( $conf->exists('enable_taxproducts')
1187          && ( scalar($part_pkg->part_pkg_taxoverride)
1188               || $part_pkg->has_taxproduct
1189             )
1190        )
1191     {
1192
1193       foreach my $class (@classes) {
1194         my $err_or_ref = $self->_gather_taxes( $part_pkg, $class, $cust_pkg );
1195         return $err_or_ref unless ref($err_or_ref);
1196         $taxes{$class} = $err_or_ref;
1197       }
1198
1199       unless (exists $taxes{''}) {
1200         my $err_or_ref = $self->_gather_taxes( $part_pkg, '', $cust_pkg );
1201         return $err_or_ref unless ref($err_or_ref);
1202         $taxes{''} = $err_or_ref;
1203       }
1204
1205     } else {
1206
1207       my @loc_keys = qw( district city county state country );
1208       my %taxhash;
1209       if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1210         my $cust_location = $cust_pkg->cust_location;
1211         %taxhash = map { $_ => $cust_location->$_()    } @loc_keys;
1212       } else {
1213         my $prefix =
1214           ( $conf->exists('tax-ship_address') && length($self->ship_last) )
1215           ? 'ship_'
1216           : '';
1217         %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
1218       }
1219
1220       $taxhash{'taxclass'} = $part_pkg->taxclass;
1221
1222       my @taxes = ();
1223       my %taxhash_elim = %taxhash;
1224       my @elim = qw( district city county state );
1225       do {
1226
1227         #first try a match with taxclass
1228         @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1229
1230         if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1231           #then try a match without taxclass
1232           my %no_taxclass = %taxhash_elim;
1233           $no_taxclass{ 'taxclass' } = '';
1234           @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1235         }
1236
1237         $taxhash_elim{ shift(@elim) } = '';
1238
1239       } while ( !scalar(@taxes) && scalar(@elim) );
1240
1241       @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
1242                     @taxes
1243         if $self->cust_main_exemption; #just to be safe
1244
1245       if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1246         foreach (@taxes) {
1247           $_->set('pkgnum',      $cust_pkg->pkgnum );
1248           $_->set('locationnum', $cust_pkg->locationnum );
1249         }
1250       }
1251
1252       $taxes{''} = [ @taxes ];
1253       $taxes{'setup'} = [ @taxes ];
1254       $taxes{'recur'} = [ @taxes ];
1255       $taxes{$_} = [ @taxes ] foreach (@classes);
1256
1257       # # maybe eliminate this entirely, along with all the 0% records
1258       # unless ( @taxes ) {
1259       #   return
1260       #     "fatal: can't find tax rate for state/county/country/taxclass ".
1261       #     join('/', map $taxhash{$_}, qw(state county country taxclass) );
1262       # }
1263
1264     } #if $conf->exists('enable_taxproducts') ...
1265
1266   }
1267
1268   #what's this doing in the middle of _handle_taxes?  probably should split
1269   #this into three parts above in _make_lines
1270   $cust_bill_pkg->set_display(   part_pkg     => $part_pkg,
1271                                  real_pkgpart => $real_pkgpart,
1272                              );
1273
1274   my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
1275   foreach my $key (keys %tax_cust_bill_pkg) {
1276     my @taxes = @{ $taxes{$key} || [] };
1277     my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
1278
1279     my %localtaxlisthash = ();
1280     foreach my $tax ( @taxes ) {
1281
1282       my $taxname = ref( $tax ). ' '. $tax->taxnum;
1283 #      $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
1284 #                  ' locationnum'. $cust_pkg->locationnum
1285 #        if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
1286
1287       $taxlisthash->{ $taxname } ||= [ $tax ];
1288       push @{ $taxlisthash->{ $taxname  } }, $tax_cust_bill_pkg;
1289
1290       $localtaxlisthash{ $taxname } ||= [ $tax ];
1291       push @{ $localtaxlisthash{ $taxname  } }, $tax_cust_bill_pkg;
1292
1293     }
1294
1295     warn "finding taxed taxes...\n" if $DEBUG > 2;
1296     foreach my $tax ( keys %localtaxlisthash ) {
1297       my $tax_object = shift @{ $localtaxlisthash{$tax} };
1298       warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
1299         if $DEBUG > 2;
1300       next unless $tax_object->can('tax_on_tax');
1301
1302       foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
1303         my $totname = ref( $tot ). ' '. $tot->taxnum;
1304
1305         warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
1306           if $DEBUG > 2;
1307         next unless exists( $localtaxlisthash{ $totname } ); # only increase
1308                                                              # existing taxes
1309         warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
1310         my $hashref_or_error =
1311           $tax_object->taxline( $localtaxlisthash{$tax},
1312                                 'custnum'      => $self->custnum,
1313                                 'invoice_time' => $invoice_time,
1314                               );
1315         return $hashref_or_error
1316           unless ref($hashref_or_error);
1317
1318         $taxlisthash->{ $totname } ||= [ $tot ];
1319         push @{ $taxlisthash->{ $totname  } }, $hashref_or_error->{amount};
1320
1321       }
1322     }
1323
1324   }
1325
1326   '';
1327 }
1328
1329 sub _gather_taxes {
1330   my $self = shift;
1331   my $part_pkg = shift;
1332   my $class = shift;
1333   my $cust_pkg = shift;
1334
1335   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1336
1337   my $geocode;
1338   if ( $cust_pkg->locationnum && $conf->exists('tax-pkg_address') ) {
1339     $geocode = $cust_pkg->cust_location->geocode('cch');
1340   } else {
1341     $geocode = $self->geocode('cch');
1342   }
1343
1344   my @taxes = ();
1345
1346   my @taxclassnums = map { $_->taxclassnum }
1347                      $part_pkg->part_pkg_taxoverride($class);
1348
1349   unless (@taxclassnums) {
1350     @taxclassnums = map { $_->taxclassnum }
1351                     grep { $_->taxable eq 'Y' }
1352                     $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
1353   }
1354   warn "Found taxclassnum values of ". join(',', @taxclassnums)
1355     if $DEBUG;
1356
1357   my $extra_sql =
1358     "AND (".
1359     join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
1360
1361   @taxes = qsearch({ 'table' => 'tax_rate',
1362                      'hashref' => { 'geocode' => $geocode, },
1363                      'extra_sql' => $extra_sql,
1364                   })
1365     if scalar(@taxclassnums);
1366
1367   warn "Found taxes ".
1368        join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
1369    if $DEBUG;
1370
1371   [ @taxes ];
1372
1373 }
1374
1375 =item collect [ HASHREF | OPTION => VALUE ... ]
1376
1377 (Attempt to) collect money for this customer's outstanding invoices (see
1378 L<FS::cust_bill>).  Usually used after the bill method.
1379
1380 Actions are now triggered by billing events; see L<FS::part_event> and the
1381 billing events web interface.  Old-style invoice events (see
1382 L<FS::part_bill_event>) have been deprecated.
1383
1384 If there is an error, returns the error, otherwise returns false.
1385
1386 Options are passed as name-value pairs.
1387
1388 Currently available options are:
1389
1390 =over 4
1391
1392 =item invoice_time
1393
1394 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.
1395
1396 =item retry
1397
1398 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1399
1400 =item check_freq
1401
1402 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1403
1404 =item quiet
1405
1406 set true to surpress email card/ACH decline notices.
1407
1408 =item debug
1409
1410 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)
1411
1412 =back
1413
1414 # =item payby
1415 #
1416 # allows for one time override of normal customer billing method
1417
1418 =cut
1419
1420 sub collect {
1421   my( $self, %options ) = @_;
1422
1423   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1424
1425   my $invoice_time = $options{'invoice_time'} || time;
1426
1427   #put below somehow?
1428   local $SIG{HUP} = 'IGNORE';
1429   local $SIG{INT} = 'IGNORE';
1430   local $SIG{QUIT} = 'IGNORE';
1431   local $SIG{TERM} = 'IGNORE';
1432   local $SIG{TSTP} = 'IGNORE';
1433   local $SIG{PIPE} = 'IGNORE';
1434
1435   my $oldAutoCommit = $FS::UID::AutoCommit;
1436   local $FS::UID::AutoCommit = 0;
1437   my $dbh = dbh;
1438
1439   $self->select_for_update; #mutex
1440
1441   if ( $DEBUG ) {
1442     my $balance = $self->balance;
1443     warn "$me collect customer ". $self->custnum. ": balance $balance\n"
1444   }
1445
1446   if ( exists($options{'retry_card'}) ) {
1447     carp 'retry_card option passed to collect is deprecated; use retry';
1448     $options{'retry'} ||= $options{'retry_card'};
1449   }
1450   if ( exists($options{'retry'}) && $options{'retry'} ) {
1451     my $error = $self->retry_realtime;
1452     if ( $error ) {
1453       $dbh->rollback if $oldAutoCommit;
1454       return $error;
1455     }
1456   }
1457
1458   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1459
1460   #never want to roll back an event just because it returned an error
1461   local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1462
1463   $self->do_cust_event(
1464     'debug'      => ( $options{'debug'} || 0 ),
1465     'time'       => $invoice_time,
1466     'check_freq' => $options{'check_freq'},
1467     'stage'      => 'collect',
1468   );
1469
1470 }
1471
1472 =item retry_realtime
1473
1474 Schedules realtime / batch  credit card / electronic check / LEC billing
1475 events for for retry.  Useful if card information has changed or manual
1476 retry is desired.  The 'collect' method must be called to actually retry
1477 the transaction.
1478
1479 Implementation details: For either this customer, or for each of this
1480 customer's open invoices, changes the status of the first "done" (with
1481 statustext error) realtime processing event to "failed".
1482
1483 =cut
1484
1485 sub retry_realtime {
1486   my $self = shift;
1487
1488   local $SIG{HUP} = 'IGNORE';
1489   local $SIG{INT} = 'IGNORE';
1490   local $SIG{QUIT} = 'IGNORE';
1491   local $SIG{TERM} = 'IGNORE';
1492   local $SIG{TSTP} = 'IGNORE';
1493   local $SIG{PIPE} = 'IGNORE';
1494
1495   my $oldAutoCommit = $FS::UID::AutoCommit;
1496   local $FS::UID::AutoCommit = 0;
1497   my $dbh = dbh;
1498
1499   #a little false laziness w/due_cust_event (not too bad, really)
1500
1501   my $join = FS::part_event_condition->join_conditions_sql;
1502   my $order = FS::part_event_condition->order_conditions_sql;
1503   my $mine =
1504   '( '
1505    . join ( ' OR ' , map {
1506     my $cust_join = FS::part_event->eventtables_cust_join->{$_} || '';
1507     my $custnum = FS::part_event->eventtables_custnum->{$_};
1508     "( part_event.eventtable = " . dbh->quote($_)
1509     . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key
1510     . " from $_ $cust_join"
1511     . " where $custnum = " . dbh->quote( $self->custnum ) . "))" ;
1512    } FS::part_event->eventtables)
1513    . ') ';
1514
1515   #here is the agent virtualization
1516   my $agent_virt = " (    part_event.agentnum IS NULL
1517                        OR part_event.agentnum = ". $self->agentnum. ' )';
1518
1519   #XXX this shouldn't be hardcoded, actions should declare it...
1520   my @realtime_events = qw(
1521     cust_bill_realtime_card
1522     cust_bill_realtime_check
1523     cust_bill_realtime_lec
1524     cust_bill_batch
1525   );
1526
1527   my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
1528                                                   @realtime_events
1529                                      ).
1530                           ' ) ';
1531
1532   my @cust_event = qsearch({
1533     'table'     => 'cust_event',
1534     'select'    => 'cust_event.*',
1535     'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
1536     'hashref'   => { 'status' => 'done' },
1537     'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
1538                    " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
1539   });
1540
1541   my %seen_invnum = ();
1542   foreach my $cust_event (@cust_event) {
1543
1544     #max one for the customer, one for each open invoice
1545     my $cust_X = $cust_event->cust_X;
1546     next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
1547                           ? $cust_X->invnum
1548                           : 0
1549                         }++
1550          or $cust_event->part_event->eventtable eq 'cust_bill'
1551             && ! $cust_X->owed;
1552
1553     my $error = $cust_event->retry;
1554     if ( $error ) {
1555       $dbh->rollback if $oldAutoCommit;
1556       return "error scheduling event for retry: $error";
1557     }
1558
1559   }
1560
1561   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1562   '';
1563
1564 }
1565
1566 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
1567
1568 Runs billing events; see L<FS::part_event> and the billing events web
1569 interface.
1570
1571 If there is an error, returns the error, otherwise returns false.
1572
1573 Options are passed as name-value pairs.
1574
1575 Currently available options are:
1576
1577 =over 4
1578
1579 =item time
1580
1581 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.
1582
1583 =item check_freq
1584
1585 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1586
1587 =item stage
1588
1589 "collect" (the default) or "pre-bill"
1590
1591 =item quiet
1592
1593 set true to surpress email card/ACH decline notices.
1594
1595 =item debug
1596
1597 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)
1598
1599 =back
1600 =cut
1601
1602 # =item payby
1603 #
1604 # allows for one time override of normal customer billing method
1605
1606 # =item retry
1607 #
1608 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1609
1610 sub do_cust_event {
1611   my( $self, %options ) = @_;
1612
1613   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1614
1615   my $time = $options{'time'} || time;
1616
1617   #put below somehow?
1618   local $SIG{HUP} = 'IGNORE';
1619   local $SIG{INT} = 'IGNORE';
1620   local $SIG{QUIT} = 'IGNORE';
1621   local $SIG{TERM} = 'IGNORE';
1622   local $SIG{TSTP} = 'IGNORE';
1623   local $SIG{PIPE} = 'IGNORE';
1624
1625   my $oldAutoCommit = $FS::UID::AutoCommit;
1626   local $FS::UID::AutoCommit = 0;
1627   my $dbh = dbh;
1628
1629   $self->select_for_update; #mutex
1630
1631   if ( $DEBUG ) {
1632     my $balance = $self->balance;
1633     warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
1634   }
1635
1636 #  if ( exists($options{'retry_card'}) ) {
1637 #    carp 'retry_card option passed to collect is deprecated; use retry';
1638 #    $options{'retry'} ||= $options{'retry_card'};
1639 #  }
1640 #  if ( exists($options{'retry'}) && $options{'retry'} ) {
1641 #    my $error = $self->retry_realtime;
1642 #    if ( $error ) {
1643 #      $dbh->rollback if $oldAutoCommit;
1644 #      return $error;
1645 #    }
1646 #  }
1647
1648   # false laziness w/pay_batch::import_results
1649
1650   my $due_cust_event = $self->due_cust_event(
1651     'debug'      => ( $options{'debug'} || 0 ),
1652     'time'       => $time,
1653     'check_freq' => $options{'check_freq'},
1654     'stage'      => ( $options{'stage'} || 'collect' ),
1655   );
1656   unless( ref($due_cust_event) ) {
1657     $dbh->rollback if $oldAutoCommit;
1658     return $due_cust_event;
1659   }
1660
1661   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1662   #never want to roll back an event just because it or a different one
1663   # returned an error
1664   local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1665
1666   foreach my $cust_event ( @$due_cust_event ) {
1667
1668     #XXX lock event
1669
1670     #re-eval event conditions (a previous event could have changed things)
1671     unless ( $cust_event->test_conditions ) {
1672       #don't leave stray "new/locked" records around
1673       my $error = $cust_event->delete;
1674       return $error if $error;
1675       next;
1676     }
1677
1678     {
1679       local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
1680         if $options{'quiet'};
1681       warn "  running cust_event ". $cust_event->eventnum. "\n"
1682         if $DEBUG > 1;
1683
1684       #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
1685       if ( my $error = $cust_event->do_event( 'time' => $time ) ) {
1686         #XXX wtf is this?  figure out a proper dealio with return value
1687         #from do_event
1688         return $error;
1689       }
1690     }
1691
1692   }
1693
1694   '';
1695
1696 }
1697
1698 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
1699
1700 Inserts database records for and returns an ordered listref of new events due
1701 for this customer, as FS::cust_event objects (see L<FS::cust_event>).  If no
1702 events are due, an empty listref is returned.  If there is an error, returns a
1703 scalar error message.
1704
1705 To actually run the events, call each event's test_condition method, and if
1706 still true, call the event's do_event method.
1707
1708 Options are passed as a hashref or as a list of name-value pairs.  Available
1709 options are:
1710
1711 =over 4
1712
1713 =item check_freq
1714
1715 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.
1716
1717 =item stage
1718
1719 "collect" (the default) or "pre-bill"
1720
1721 =item time
1722
1723 "Current time" for the events.
1724
1725 =item debug
1726
1727 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)
1728
1729 =item eventtable
1730
1731 Only return events for the specified eventtable (by default, events of all eventtables are returned)
1732
1733 =item objects
1734
1735 Explicitly pass the objects to be tested (typically used with eventtable).
1736
1737 =item testonly
1738
1739 Set to true to return the objects, but not actually insert them into the
1740 database.
1741
1742 =back
1743
1744 =cut
1745
1746 sub due_cust_event {
1747   my $self = shift;
1748   my %opt = ref($_[0]) ? %{ $_[0] } : @_;
1749
1750   #???
1751   #my $DEBUG = $opt{'debug'}
1752   local($DEBUG) = $opt{'debug'}
1753     if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
1754   $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1755
1756   warn "$me due_cust_event called with options ".
1757        join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
1758     if $DEBUG;
1759
1760   $opt{'time'} ||= time;
1761
1762   local $SIG{HUP} = 'IGNORE';
1763   local $SIG{INT} = 'IGNORE';
1764   local $SIG{QUIT} = 'IGNORE';
1765   local $SIG{TERM} = 'IGNORE';
1766   local $SIG{TSTP} = 'IGNORE';
1767   local $SIG{PIPE} = 'IGNORE';
1768
1769   my $oldAutoCommit = $FS::UID::AutoCommit;
1770   local $FS::UID::AutoCommit = 0;
1771   my $dbh = dbh;
1772
1773   $self->select_for_update #mutex
1774     unless $opt{testonly};
1775
1776   ###
1777   # find possible events (initial search)
1778   ###
1779
1780   my @cust_event = ();
1781
1782   my @eventtable = $opt{'eventtable'}
1783                      ? ( $opt{'eventtable'} )
1784                      : FS::part_event->eventtables_runorder;
1785
1786   my $check_freq = $opt{'check_freq'} || '1d';
1787
1788   foreach my $eventtable ( @eventtable ) {
1789
1790     my @objects;
1791     if ( $opt{'objects'} ) {
1792
1793       @objects = @{ $opt{'objects'} };
1794
1795     } elsif ( $eventtable eq 'cust_main' ) {
1796
1797       @objects = ( $self );
1798
1799     } else {
1800
1801       my $cm_join = " LEFT JOIN cust_main USING ( custnum )";
1802       # linkage not needed here because FS::cust_main->$eventtable will
1803       # already supply it
1804
1805       #some false laziness w/Cron::bill bill_where
1806
1807       my $join  = FS::part_event_condition->join_conditions_sql( $eventtable);
1808       my $where = FS::part_event_condition->where_conditions_sql($eventtable,
1809         'time'=>$opt{'time'},
1810       );
1811       $where = $where ? "AND $where" : '';
1812
1813       my $are_part_event =
1814       "EXISTS ( SELECT 1 FROM part_event $join
1815         WHERE check_freq = '$check_freq'
1816         AND eventtable = '$eventtable'
1817         AND ( disabled = '' OR disabled IS NULL )
1818         $where
1819         )
1820       ";
1821       #eofalse
1822
1823       @objects = $self->$eventtable(
1824         'addl_from' => $cm_join,
1825         'extra_sql' => " AND $are_part_event",
1826       );
1827     } # if ( !$opt{objects} and $eventtable ne 'cust_main' )
1828
1829     my @e_cust_event = ();
1830
1831     my $linkage = FS::part_event->eventtables_cust_join->{$eventtable} || '';
1832
1833     my $cross = "CROSS JOIN $eventtable $linkage";
1834     $cross .= ' LEFT JOIN cust_main USING ( custnum )'
1835       unless $eventtable eq 'cust_main';
1836
1837     foreach my $object ( @objects ) {
1838
1839       #this first search uses the condition_sql magic for optimization.
1840       #the more possible events we can eliminate in this step the better
1841
1842       my $cross_where = '';
1843       my $pkey = $object->primary_key;
1844       $cross_where = "$eventtable.$pkey = ". $object->$pkey();
1845
1846       my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
1847       my $extra_sql =
1848         FS::part_event_condition->where_conditions_sql( $eventtable,
1849                                                         'time'=>$opt{'time'}
1850                                                       );
1851       my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
1852
1853       $extra_sql = "AND $extra_sql" if $extra_sql;
1854
1855       #here is the agent virtualization
1856       $extra_sql .= " AND (    part_event.agentnum IS NULL
1857                             OR part_event.agentnum = ". $self->agentnum. ' )';
1858
1859       $extra_sql .= " $order";
1860
1861       warn "searching for events for $eventtable ". $object->$pkey. "\n"
1862         if $opt{'debug'} > 2;
1863       my @part_event = qsearch( {
1864         'debug'     => ( $opt{'debug'} > 3 ? 1 : 0 ),
1865         'select'    => 'part_event.*',
1866         'table'     => 'part_event',
1867         'addl_from' => "$cross $join",
1868         'hashref'   => { 'check_freq' => $check_freq,
1869                          'eventtable' => $eventtable,
1870                          'disabled'   => '',
1871                        },
1872         'extra_sql' => "AND $cross_where $extra_sql",
1873       } );
1874
1875       if ( $DEBUG > 2 ) {
1876         my $pkey = $object->primary_key;
1877         warn "      ". scalar(@part_event).
1878              " possible events found for $eventtable ". $object->$pkey(). "\n";
1879       }
1880
1881       push @e_cust_event, map {
1882         $_->new_cust_event($object, 'time' => $opt{'time'})
1883       } @part_event;
1884
1885     }
1886
1887     warn "    ". scalar(@e_cust_event).
1888          " subtotal possible cust events found for $eventtable\n"
1889       if $DEBUG > 1;
1890
1891     push @cust_event, @e_cust_event;
1892
1893   }
1894
1895   warn "  ". scalar(@cust_event).
1896        " total possible cust events found in initial search\n"
1897     if $DEBUG; # > 1;
1898
1899
1900   ##
1901   # test stage
1902   ##
1903
1904   $opt{stage} ||= 'collect';
1905   @cust_event =
1906     grep { my $stage = $_->part_event->event_stage;
1907            $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
1908          }
1909          @cust_event;
1910
1911   ##
1912   # test conditions
1913   ##
1914
1915   my %unsat = ();
1916
1917   @cust_event = grep $_->test_conditions( 'stats_hashref' => \%unsat ),
1918                      @cust_event;
1919
1920   warn "  ". scalar(@cust_event). " cust events left satisfying conditions\n"
1921     if $DEBUG; # > 1;
1922
1923   warn "    invalid conditions not eliminated with condition_sql:\n".
1924        join('', map "      $_: ".$unsat{$_}."\n", keys %unsat )
1925     if keys %unsat && $DEBUG; # > 1;
1926
1927   ##
1928   # insert
1929   ##
1930
1931   unless( $opt{testonly} ) {
1932     foreach my $cust_event ( @cust_event ) {
1933
1934       my $error = $cust_event->insert();
1935       if ( $error ) {
1936         $dbh->rollback if $oldAutoCommit;
1937         return $error;
1938       }
1939
1940     }
1941   }
1942
1943   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1944
1945   ##
1946   # return
1947   ##
1948
1949   warn "  returning events: ". Dumper(@cust_event). "\n"
1950     if $DEBUG > 2;
1951
1952   \@cust_event;
1953
1954 }
1955
1956 =item apply_payments_and_credits [ OPTION => VALUE ... ]
1957
1958 Applies unapplied payments and credits.
1959
1960 In most cases, this new method should be used in place of sequential
1961 apply_payments and apply_credits methods.
1962
1963 A hash of optional arguments may be passed.  Currently "manual" is supported.
1964 If true, a payment receipt is sent instead of a statement when
1965 'payment_receipt_email' configuration option is set.
1966
1967 If there is an error, returns the error, otherwise returns false.
1968
1969 =cut
1970
1971 sub apply_payments_and_credits {
1972   my( $self, %options ) = @_;
1973
1974   local $SIG{HUP} = 'IGNORE';
1975   local $SIG{INT} = 'IGNORE';
1976   local $SIG{QUIT} = 'IGNORE';
1977   local $SIG{TERM} = 'IGNORE';
1978   local $SIG{TSTP} = 'IGNORE';
1979   local $SIG{PIPE} = 'IGNORE';
1980
1981   my $oldAutoCommit = $FS::UID::AutoCommit;
1982   local $FS::UID::AutoCommit = 0;
1983   my $dbh = dbh;
1984
1985   $self->select_for_update; #mutex
1986
1987   foreach my $cust_bill ( $self->open_cust_bill ) {
1988     my $error = $cust_bill->apply_payments_and_credits(%options);
1989     if ( $error ) {
1990       $dbh->rollback if $oldAutoCommit;
1991       return "Error applying: $error";
1992     }
1993   }
1994
1995   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1996   ''; #no error
1997
1998 }
1999
2000 =item apply_credits OPTION => VALUE ...
2001
2002 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
2003 to outstanding invoice balances in chronological order (or reverse
2004 chronological order if the I<order> option is set to B<newest>) and returns the
2005 value of any remaining unapplied credits available for refund (see
2006 L<FS::cust_refund>).
2007
2008 Dies if there is an error.
2009
2010 =cut
2011
2012 sub apply_credits {
2013   my $self = shift;
2014   my %opt = @_;
2015
2016   local $SIG{HUP} = 'IGNORE';
2017   local $SIG{INT} = 'IGNORE';
2018   local $SIG{QUIT} = 'IGNORE';
2019   local $SIG{TERM} = 'IGNORE';
2020   local $SIG{TSTP} = 'IGNORE';
2021   local $SIG{PIPE} = 'IGNORE';
2022
2023   my $oldAutoCommit = $FS::UID::AutoCommit;
2024   local $FS::UID::AutoCommit = 0;
2025   my $dbh = dbh;
2026
2027   $self->select_for_update; #mutex
2028
2029   unless ( $self->total_unapplied_credits ) {
2030     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2031     return 0;
2032   }
2033
2034   my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
2035       qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
2036
2037   my @invoices = $self->open_cust_bill;
2038   @invoices = sort { $b->_date <=> $a->_date } @invoices
2039     if defined($opt{'order'}) && $opt{'order'} eq 'newest';
2040
2041   if ( $conf->exists('pkg-balances') ) {
2042     # limit @credits to those w/ a pkgnum grepped from $self
2043     my %pkgnums = ();
2044     foreach my $i (@invoices) {
2045       foreach my $li ( $i->cust_bill_pkg ) {
2046         $pkgnums{$li->pkgnum} = 1;
2047       }
2048     }
2049     @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
2050   }
2051
2052   my $credit;
2053
2054   foreach my $cust_bill ( @invoices ) {
2055
2056     if ( !defined($credit) || $credit->credited == 0) {
2057       $credit = pop @credits or last;
2058     }
2059
2060     my $owed;
2061     if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
2062       $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
2063     } else {
2064       $owed = $cust_bill->owed;
2065     }
2066     unless ( $owed > 0 ) {
2067       push @credits, $credit;
2068       next;
2069     }
2070
2071     my $amount = min( $credit->credited, $owed );
2072
2073     my $cust_credit_bill = new FS::cust_credit_bill ( {
2074       'crednum' => $credit->crednum,
2075       'invnum'  => $cust_bill->invnum,
2076       'amount'  => $amount,
2077     } );
2078     $cust_credit_bill->pkgnum( $credit->pkgnum )
2079       if $conf->exists('pkg-balances') && $credit->pkgnum;
2080     my $error = $cust_credit_bill->insert;
2081     if ( $error ) {
2082       $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2083       die $error;
2084     }
2085
2086     redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2087
2088   }
2089
2090   my $total_unapplied_credits = $self->total_unapplied_credits;
2091
2092   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2093
2094   return $total_unapplied_credits;
2095 }
2096
2097 =item apply_payments  [ OPTION => VALUE ... ]
2098
2099 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2100 to outstanding invoice balances in chronological order.
2101
2102  #and returns the value of any remaining unapplied payments.
2103
2104 A hash of optional arguments may be passed.  Currently "manual" is supported.
2105 If true, a payment receipt is sent instead of a statement when
2106 'payment_receipt_email' configuration option is set.
2107
2108 Dies if there is an error.
2109
2110 =cut
2111
2112 sub apply_payments {
2113   my( $self, %options ) = @_;
2114
2115   local $SIG{HUP} = 'IGNORE';
2116   local $SIG{INT} = 'IGNORE';
2117   local $SIG{QUIT} = 'IGNORE';
2118   local $SIG{TERM} = 'IGNORE';
2119   local $SIG{TSTP} = 'IGNORE';
2120   local $SIG{PIPE} = 'IGNORE';
2121
2122   my $oldAutoCommit = $FS::UID::AutoCommit;
2123   local $FS::UID::AutoCommit = 0;
2124   my $dbh = dbh;
2125
2126   $self->select_for_update; #mutex
2127
2128   #return 0 unless
2129
2130   my @payments = sort { $b->_date <=> $a->_date }
2131                  grep { $_->unapplied > 0 }
2132                  $self->cust_pay;
2133
2134   my @invoices = sort { $a->_date <=> $b->_date}
2135                  grep { $_->owed > 0 }
2136                  $self->cust_bill;
2137
2138   if ( $conf->exists('pkg-balances') ) {
2139     # limit @payments to those w/ a pkgnum grepped from $self
2140     my %pkgnums = ();
2141     foreach my $i (@invoices) {
2142       foreach my $li ( $i->cust_bill_pkg ) {
2143         $pkgnums{$li->pkgnum} = 1;
2144       }
2145     }
2146     @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
2147   }
2148
2149   my $payment;
2150
2151   foreach my $cust_bill ( @invoices ) {
2152
2153     if ( !defined($payment) || $payment->unapplied == 0 ) {
2154       $payment = pop @payments or last;
2155     }
2156
2157     my $owed;
2158     if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
2159       $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
2160     } else {
2161       $owed = $cust_bill->owed;
2162     }
2163     unless ( $owed > 0 ) {
2164       push @payments, $payment;
2165       next;
2166     }
2167
2168     my $amount = min( $payment->unapplied, $owed );
2169
2170     my $cbp = {
2171       'paynum' => $payment->paynum,
2172       'invnum' => $cust_bill->invnum,
2173       'amount' => $amount,
2174     };
2175     $cbp->{_date} = $payment->_date
2176         if $options{'manual'} && $options{'backdate_application'};
2177     my $cust_bill_pay = new FS::cust_bill_pay($cbp);
2178     $cust_bill_pay->pkgnum( $payment->pkgnum )
2179       if $conf->exists('pkg-balances') && $payment->pkgnum;
2180     my $error = $cust_bill_pay->insert(%options);
2181     if ( $error ) {
2182       $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2183       die $error;
2184     }
2185
2186     redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2187
2188   }
2189
2190   my $total_unapplied_payments = $self->total_unapplied_payments;
2191
2192   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2193
2194   return $total_unapplied_payments;
2195 }
2196
2197 =back
2198
2199 =head1 FLOW
2200
2201   bill_and_collect
2202
2203     cancel_expired_pkgs
2204     suspend_adjourned_pkgs
2205     unsuspend_resumed_pkgs
2206
2207     bill
2208       (do_cust_event pre-bill)
2209       _make_lines
2210         _handle_taxes
2211           (vendor-only) _gather_taxes
2212       _omit_zero_value_bundles
2213       calculate_taxes
2214
2215     apply_payments_and_credits
2216     collect
2217       do_cust_event
2218         due_cust_event
2219
2220 =head1 BUGS
2221
2222 =head1 SEE ALSO
2223
2224 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>
2225
2226 =cut
2227
2228 1;