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