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