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