FS/FS/cust_bill.pm

   1 package FS::cust_bill;
   2 use base qw( FS::Template_Mixin FS::cust_main_Mixin FS::Record );
   3
   4 use strict;
   5 use vars qw( $DEBUG $me $date_format );
   6              # but NOT $conf
   7 use Fcntl qw(:flock); #for spool_csv
   8 use Cwd;
   9 use List::Util qw(min max sum);
  10 use Date::Format;
  11 use File::Temp 0.14;
  12 use HTML::Entities;
  13 use Storable qw( freeze thaw );
  14 use GD::Barcode;
  15 use FS::UID qw( datasrc );
  16 use FS::Misc qw( send_email send_fax do_print );
  17 use FS::Record qw( qsearch qsearchs dbh );
  18 use FS::cust_main;
  19 use FS::cust_statement;
  20 use FS::cust_bill_pkg;
  21 use FS::cust_bill_pkg_display;
  22 use FS::cust_bill_pkg_detail;
  23 use FS::cust_credit;
  24 use FS::cust_pay;
  25 use FS::cust_pkg;
  26 use FS::cust_credit_bill;
  27 use FS::pay_batch;
  28 use FS::cust_pay_batch;
  29 use FS::cust_bill_event;
  30 use FS::cust_event;
  31 use FS::part_pkg;
  32 use FS::cust_bill_pay;
  33 use FS::cust_bill_pay_batch;
  34 use FS::part_bill_event;
  35 use FS::payby;
  36 use FS::bill_batch;
  37 use FS::cust_bill_batch;
  38 use FS::cust_bill_pay_pkg;
  39 use FS::cust_credit_bill_pkg;
  40 use FS::discount_plan;
  41 use FS::cust_bill_void;
  42 use FS::L10N;
  43
  44 $DEBUG = 0;
  45 $me = '[FS::cust_bill]';
  46
  47 #ask FS::UID to run this stuff for us later
  48 FS::UID->install_callback( sub {
  49   my $conf = new FS::Conf; #global
  50   $date_format      = $conf->config('date_format')      || '%x'; #/YY
  51 } );
  52
  53 =head1 NAME
  54
  55 FS::cust_bill - Object methods for cust_bill records
  56
  57 =head1 SYNOPSIS
  58
  59   use FS::cust_bill;
  60
  61   $record = new FS::cust_bill \%hash;
  62   $record = new FS::cust_bill { 'column' => 'value' };
  63
  64   $error = $record->insert;
  65
  66   $error = $new_record->replace($old_record);
  67
  68   $error = $record->delete;
  69
  70   $error = $record->check;
  71
  72   ( $total_previous_balance, @previous_cust_bill ) = $record->previous;
  73
  74   @cust_bill_pkg_objects = $cust_bill->cust_bill_pkg;
  75
  76   ( $total_previous_credits, @previous_cust_credit ) = $record->cust_credit;
  77
  78   @cust_pay_objects = $cust_bill->cust_pay;
  79
  80   $tax_amount = $record->tax;
  81
  82   @lines = $cust_bill->print_text;
  83   @lines = $cust_bill->print_text $time;
  84
  85 =head1 DESCRIPTION
  86
  87 An FS::cust_bill object represents an invoice; a declaration that a customer
  88 owes you money.  The specific charges are itemized as B<cust_bill_pkg> records
  89 (see L<FS::cust_bill_pkg>).  FS::cust_bill inherits from FS::Record.  The
  90 following fields are currently supported:
  91
  92 Regular fields
  93
  94 =over 4
  95
  96 =item invnum - primary key (assigned automatically for new invoices)
  97
  98 =item custnum - customer (see L<FS::cust_main>)
  99
 100 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
 101 L<Time::Local> and L<Date::Parse> for conversion functions.
 102
 103 =item charged - amount of this invoice
 104
 105 =item invoice_terms - optional terms override for this specific invoice
 106
 107 =back
 108
 109 Customer info at invoice generation time
 110
 111 =over 4
 112
 113 =item previous_balance
 114
 115 =item billing_balance
 116
 117 =back
 118
 119 Deprecated
 120
 121 =over 4
 122
 123 =item printed - deprecated
 124
 125 =back
 126
 127 Specific use cases
 128
 129 =over 4
 130
 131 =item closed - books closed flag, empty or `Y'
 132
 133 =item statementnum - invoice aggregation (see L<FS::cust_statement>)
 134
 135 =item agent_invid - legacy invoice number
 136
 137 =item promised_date - customer promised payment date, for collection
 138
 139 =back
 140
 141 =head1 METHODS
 142
 143 =over 4
 144
 145 =item new HASHREF
 146
 147 Creates a new invoice.  To add the invoice to the database, see L<"insert">.
 148 Invoices are normally created by calling the bill method of a customer object
 149 (see L<FS::cust_main>).
 150
 151 =cut
 152
 153 sub table { 'cust_bill'; }
 154 sub notice_name { 'Invoice'; }
 155
 156 sub cust_linked { $_[0]->cust_main_custnum; }
 157 sub cust_unlinked_msg {
 158   my $self = shift;
 159   "WARNING: can't find cust_main.custnum ". $self->custnum.
 160   ' (cust_bill.invnum '. $self->invnum. ')';
 161 }
 162
 163 =item insert
 164
 165 Adds this invoice to the database ("Posts" the invoice).  If there is an error,
 166 returns the error, otherwise returns false.
 167
 168 =cut
 169
 170 sub insert {
 171   my $self = shift;
 172   warn "$me insert called\n" if $DEBUG;
 173
 174   local $SIG{HUP} = 'IGNORE';
 175   local $SIG{INT} = 'IGNORE';
 176   local $SIG{QUIT} = 'IGNORE';
 177   local $SIG{TERM} = 'IGNORE';
 178   local $SIG{TSTP} = 'IGNORE';
 179   local $SIG{PIPE} = 'IGNORE';
 180
 181   my $oldAutoCommit = $FS::UID::AutoCommit;
 182   local $FS::UID::AutoCommit = 0;
 183   my $dbh = dbh;
 184
 185   my $error = $self->SUPER::insert;
 186   if ( $error ) {
 187     $dbh->rollback if $oldAutoCommit;
 188     return $error;
 189   }
 190
 191   if ( $self->get('cust_bill_pkg') ) {
 192     foreach my $cust_bill_pkg ( @{$self->get('cust_bill_pkg')} ) {
 193       $cust_bill_pkg->invnum($self->invnum);
 194       my $error = $cust_bill_pkg->insert;
 195       if ( $error ) {
 196         $dbh->rollback if $oldAutoCommit;
 197         return "can't create invoice line item: $error";
 198       }
 199     }
 200   }
 201
 202   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 203   '';
 204
 205 }
 206
 207 =item void
 208
 209 Voids this invoice: deletes the invoice and adds a record of the voided invoice
 210 to the FS::cust_bill_void table (and related tables starting from
 211 FS::cust_bill_pkg_void).
 212
 213 =cut
 214
 215 sub void {
 216   my $self = shift;
 217   my $reason = scalar(@_) ? shift : '';
 218
 219   local $SIG{HUP} = 'IGNORE';
 220   local $SIG{INT} = 'IGNORE';
 221   local $SIG{QUIT} = 'IGNORE';
 222   local $SIG{TERM} = 'IGNORE';
 223   local $SIG{TSTP} = 'IGNORE';
 224   local $SIG{PIPE} = 'IGNORE';
 225
 226   my $oldAutoCommit = $FS::UID::AutoCommit;
 227   local $FS::UID::AutoCommit = 0;
 228   my $dbh = dbh;
 229
 230   my $cust_bill_void = new FS::cust_bill_void ( {
 231     map { $_ => $self->get($_) } $self->fields
 232   } );
 233   $cust_bill_void->reason($reason);
 234   my $error = $cust_bill_void->insert;
 235   if ( $error ) {
 236     $dbh->rollback if $oldAutoCommit;
 237     return $error;
 238   }
 239
 240   foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
 241     my $error = $cust_bill_pkg->void($reason);
 242     if ( $error ) {
 243       $dbh->rollback if $oldAutoCommit;
 244       return $error;
 245     }
 246   }
 247
 248   $error = $self->delete;
 249   if ( $error ) {
 250     $dbh->rollback if $oldAutoCommit;
 251     return $error;
 252   }
 253
 254   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 255
 256   '';
 257
 258 }
 259
 260 =item delete
 261
 262 This method now works but you probably shouldn't use it.  Instead, apply a
 263 credit against the invoice, or use the new void method.
 264
 265 Using this method to delete invoices outright is really, really bad.  There
 266 would be no record you ever posted this invoice, and there are no check to
 267 make sure charged = 0 or that there are no associated cust_bill_pkg records.
 268
 269 Really, don't use it.
 270
 271 =cut
 272
 273 sub delete {
 274   my $self = shift;
 275   return "Can't delete closed invoice" if $self->closed =~ /^Y/i;
 276
 277   local $SIG{HUP} = 'IGNORE';
 278   local $SIG{INT} = 'IGNORE';
 279   local $SIG{QUIT} = 'IGNORE';
 280   local $SIG{TERM} = 'IGNORE';
 281   local $SIG{TSTP} = 'IGNORE';
 282   local $SIG{PIPE} = 'IGNORE';
 283
 284   my $oldAutoCommit = $FS::UID::AutoCommit;
 285   local $FS::UID::AutoCommit = 0;
 286   my $dbh = dbh;
 287
 288   foreach my $table (qw(
 289     cust_bill_event
 290     cust_event
 291     cust_credit_bill
 292     cust_bill_pay
 293     cust_pay_batch
 294     cust_bill_pay_batch
 295     cust_bill_batch
 296     cust_bill_pkg
 297   )) {
 298
 299     foreach my $linked ( $self->$table() ) {
 300       my $error = $linked->delete;
 301       if ( $error ) {
 302         $dbh->rollback if $oldAutoCommit;
 303         return $error;
 304       }
 305     }
 306
 307   }
 308
 309   my $error = $self->SUPER::delete(@_);
 310   if ( $error ) {
 311     $dbh->rollback if $oldAutoCommit;
 312     return $error;
 313   }
 314
 315   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 316
 317   '';
 318
 319 }
 320
 321 =item replace [ OLD_RECORD ]
 322
 323 You can, but probably shouldn't modify invoices...
 324
 325 Replaces the OLD_RECORD with this one in the database, or, if OLD_RECORD is not
 326 supplied, replaces this record.  If there is an error, returns the error,
 327 otherwise returns false.
 328
 329 =cut
 330
 331 #replace can be inherited from Record.pm
 332
 333 # replace_check is now the preferred way to #implement replace data checks
 334 # (so $object->replace() works without an argument)
 335
 336 sub replace_check {
 337   my( $new, $old ) = ( shift, shift );
 338   return "Can't modify closed invoice" if $old->closed =~ /^Y/i;
 339   #return "Can't change _date!" unless $old->_date eq $new->_date;
 340   return "Can't change _date" unless $old->_date == $new->_date;
 341   return "Can't change charged" unless $old->charged == $new->charged
 342                                     || $old->charged == 0
 343                                     || $new->{'Hash'}{'cc_surcharge_replace_hack'};
 344
 345   '';
 346 }
 347
 348
 349 =item add_cc_surcharge
 350
 351 Giant hack
 352
 353 =cut
 354
 355 sub add_cc_surcharge {
 356     my ($self, $pkgnum, $amount) = (shift, shift, shift);
 357
 358     my $error;
 359     my $cust_bill_pkg = new FS::cust_bill_pkg({
 360                                     'invnum' => $self->invnum,
 361                                     'pkgnum' => $pkgnum,
 362                                     'setup' => $amount,
 363                         });
 364     $error = $cust_bill_pkg->insert;
 365     return $error if $error;
 366
 367     $self->{'Hash'}{'cc_surcharge_replace_hack'} = 1;
 368     $self->charged($self->charged+$amount);
 369     $error = $self->replace;
 370     return $error if $error;
 371
 372     $self->apply_payments_and_credits;
 373 }
 374
 375
 376 =item check
 377
 378 Checks all fields to make sure this is a valid invoice.  If there is an error,
 379 returns the error, otherwise returns false.  Called by the insert and replace
 380 methods.
 381
 382 =cut
 383
 384 sub check {
 385   my $self = shift;
 386
 387   my $error =
 388     $self->ut_numbern('invnum')
 389     || $self->ut_foreign_key('custnum', 'cust_main', 'custnum' )
 390     || $self->ut_numbern('_date')
 391     || $self->ut_money('charged')
 392     || $self->ut_numbern('printed')
 393     || $self->ut_enum('closed', [ '', 'Y' ])
 394     || $self->ut_foreign_keyn('statementnum', 'cust_statement', 'statementnum' )
 395     || $self->ut_numbern('agent_invid') #varchar?
 396   ;
 397   return $error if $error;
 398
 399   $self->_date(time) unless $self->_date;
 400
 401   $self->printed(0) if $self->printed eq '';
 402
 403   $self->SUPER::check;
 404 }
 405
 406 =item display_invnum
 407
 408 Returns the displayed invoice number for this invoice: agent_invid if
 409 cust_bill-default_agent_invid is set and it has a value, invnum otherwise.
 410
 411 =cut
 412
 413 sub display_invnum {
 414   my $self = shift;
 415   my $conf = $self->conf;
 416   if ( $conf->exists('cust_bill-default_agent_invid') && $self->agent_invid ){
 417     return $self->agent_invid;
 418   } else {
 419     return $self->invnum;
 420   }
 421 }
 422
 423 =item previous
 424
 425 Returns a list consisting of the total previous balance for this customer,
 426 followed by the previous outstanding invoices (as FS::cust_bill objects also).
 427
 428 =cut
 429
 430 sub previous {
 431   my $self = shift;
 432   my $total = 0;
 433   my @cust_bill = sort { $a->_date <=> $b->_date }
 434     grep { $_->owed != 0 }
 435       qsearch( 'cust_bill', { 'custnum' => $self->custnum,
 436                               #'_date'   => { op=>'<', value=>$self->_date },
 437                               'invnum'   => { op=>'<', value=>$self->invnum },
 438                             } )
 439   ;
 440   foreach ( @cust_bill ) { $total += $_->owed; }
 441   $total, @cust_bill;
 442 }
 443
 444 =item enable_previous
 445
 446 Whether to show the 'Previous Charges' section when printing this invoice.
 447 The negation of the 'disable_previous_balance' config setting.
 448
 449 =cut
 450
 451 sub enable_previous {
 452   my $self = shift;
 453   my $agentnum = $self->cust_main->agentnum;
 454   !$self->conf->exists('disable_previous_balance', $agentnum);
 455 }
 456
 457 =item cust_bill_pkg
 458
 459 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice.
 460
 461 =cut
 462
 463 sub cust_bill_pkg {
 464   my $self = shift;
 465   qsearch(
 466     { 'table'    => 'cust_bill_pkg',
 467       'hashref'  => { 'invnum' => $self->invnum },
 468       'order_by' => 'ORDER BY billpkgnum',
 469     }
 470   );
 471 }
 472
 473 =item cust_bill_pkg_pkgnum PKGNUM
 474
 475 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice and
 476 specified pkgnum.
 477
 478 =cut
 479
 480 sub cust_bill_pkg_pkgnum {
 481   my( $self, $pkgnum ) = @_;
 482   qsearch(
 483     { 'table'    => 'cust_bill_pkg',
 484       'hashref'  => { 'invnum' => $self->invnum,
 485                       'pkgnum' => $pkgnum,
 486                     },
 487       'order_by' => 'ORDER BY billpkgnum',
 488     }
 489   );
 490 }
 491
 492 =item cust_pkg
 493
 494 Returns the packages (see L<FS::cust_pkg>) corresponding to the line items for
 495 this invoice.
 496
 497 =cut
 498
 499 sub cust_pkg {
 500   my $self = shift;
 501   my @cust_pkg = map { $_->pkgnum > 0 ? $_->cust_pkg : () }
 502                      $self->cust_bill_pkg;
 503   my %saw = ();
 504   grep { ! $saw{$_->pkgnum}++ } @cust_pkg;
 505 }
 506
 507 =item no_auto
 508
 509 Returns true if any of the packages (or their definitions) corresponding to the
 510 line items for this invoice have the no_auto flag set.
 511
 512 =cut
 513
 514 sub no_auto {
 515   my $self = shift;
 516   grep { $_->no_auto || $_->part_pkg->no_auto } $self->cust_pkg;
 517 }
 518
 519 =item open_cust_bill_pkg
 520
 521 Returns the open line items for this invoice.
 522
 523 Note that cust_bill_pkg with both setup and recur fees are returned as two
 524 separate line items, each with only one fee.
 525
 526 =cut
 527
 528 # modeled after cust_main::open_cust_bill
 529 sub open_cust_bill_pkg {
 530   my $self = shift;
 531
 532   # grep { $_->owed > 0 } $self->cust_bill_pkg
 533
 534   my %other = ( 'recur' => 'setup',
 535                 'setup' => 'recur', );
 536   my @open = ();
 537   foreach my $field ( qw( recur setup )) {
 538     push @open, map  { $_->set( $other{$field}, 0 ); $_; }
 539                 grep { $_->owed($field) > 0 }
 540                 $self->cust_bill_pkg;
 541   }
 542
 543   @open;
 544 }
 545
 546 =item cust_bill_event
 547
 548 Returns the completed invoice events (deprecated, old-style events - see L<FS::cust_bill_event>) for this invoice.
 549
 550 =cut
 551
 552 sub cust_bill_event {
 553   my $self = shift;
 554   qsearch( 'cust_bill_event', { 'invnum' => $self->invnum } );
 555 }
 556
 557 =item num_cust_bill_event
 558
 559 Returns the number of completed invoice events (deprecated, old-style events - see L<FS::cust_bill_event>) for this invoice.
 560
 561 =cut
 562
 563 sub num_cust_bill_event {
 564   my $self = shift;
 565   my $sql =
 566     "SELECT COUNT(*) FROM cust_bill_event WHERE invnum = ?";
 567   my $sth = dbh->prepare($sql) or die  dbh->errstr. " preparing $sql";
 568   $sth->execute($self->invnum) or die $sth->errstr. " executing $sql";
 569   $sth->fetchrow_arrayref->[0];
 570 }
 571
 572 =item cust_event
 573
 574 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
 575
 576 =cut
 577
 578 #false laziness w/cust_pkg.pm
 579 sub cust_event {
 580   my $self = shift;
 581   qsearch({
 582     'table'     => 'cust_event',
 583     'addl_from' => 'JOIN part_event USING ( eventpart )',
 584     'hashref'   => { 'tablenum' => $self->invnum },
 585     'extra_sql' => " AND eventtable = 'cust_bill' ",
 586   });
 587 }
 588
 589 =item num_cust_event
 590
 591 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
 592
 593 =cut
 594
 595 #false laziness w/cust_pkg.pm
 596 sub num_cust_event {
 597   my $self = shift;
 598   my $sql =
 599     "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
 600     "  WHERE tablenum = ? AND eventtable = 'cust_bill'";
 601   my $sth = dbh->prepare($sql) or die  dbh->errstr. " preparing $sql";
 602   $sth->execute($self->invnum) or die $sth->errstr. " executing $sql";
 603   $sth->fetchrow_arrayref->[0];
 604 }
 605
 606 =item cust_main
 607
 608 Returns the customer (see L<FS::cust_main>) for this invoice.
 609
 610 =cut
 611
 612 sub cust_main {
 613   my $self = shift;
 614   qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
 615 }
 616
 617 =item cust_suspend_if_balance_over AMOUNT
 618
 619 Suspends the customer associated with this invoice if the total amount owed on
 620 this invoice and all older invoices is greater than the specified amount.
 621
 622 Returns a list: an empty list on success or a list of errors.
 623
 624 =cut
 625
 626 sub cust_suspend_if_balance_over {
 627   my( $self, $amount ) = ( shift, shift );
 628   my $cust_main = $self->cust_main;
 629   if ( $cust_main->total_owed_date($self->_date) < $amount ) {
 630     return ();
 631   } else {
 632     $cust_main->suspend(@_);
 633   }
 634 }
 635
 636 =item cust_credit
 637
 638 Depreciated.  See the cust_credited method.
 639
 640  #Returns a list consisting of the total previous credited (see
 641  #L<FS::cust_credit>) and unapplied for this customer, followed by the previous
 642  #outstanding credits (FS::cust_credit objects).
 643
 644 =cut
 645
 646 sub cust_credit {
 647   use Carp;
 648   croak "FS::cust_bill->cust_credit depreciated; see ".
 649         "FS::cust_bill->cust_credit_bill";
 650   #my $self = shift;
 651   #my $total = 0;
 652   #my @cust_credit = sort { $a->_date <=> $b->_date }
 653   #  grep { $_->credited != 0 && $_->_date < $self->_date }
 654   #    qsearch('cust_credit', { 'custnum' => $self->custnum } )
 655   #;
 656   #foreach (@cust_credit) { $total += $_->credited; }
 657   #$total, @cust_credit;
 658 }
 659
 660 =item cust_pay
 661
 662 Depreciated.  See the cust_bill_pay method.
 663
 664 #Returns all payments (see L<FS::cust_pay>) for this invoice.
 665
 666 =cut
 667
 668 sub cust_pay {
 669   use Carp;
 670   croak "FS::cust_bill->cust_pay depreciated; see FS::cust_bill->cust_bill_pay";
 671   #my $self = shift;
 672   #sort { $a->_date <=> $b->_date }
 673   #  qsearch( 'cust_pay', { 'invnum' => $self->invnum } )
 674   #;
 675 }
 676
 677 sub cust_pay_batch {
 678   my $self = shift;
 679   qsearch('cust_pay_batch', { 'invnum' => $self->invnum } );
 680 }
 681
 682 sub cust_bill_pay_batch {
 683   my $self = shift;
 684   qsearch('cust_bill_pay_batch', { 'invnum' => $self->invnum } );
 685 }
 686
 687 =item cust_bill_pay
 688
 689 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice.
 690
 691 =cut
 692
 693 sub cust_bill_pay {
 694   my $self = shift;
 695   map { $_ } #return $self->num_cust_bill_pay unless wantarray;
 696   sort { $a->_date <=> $b->_date }
 697     qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum } );
 698 }
 699
 700 =item cust_credited
 701
 702 =item cust_credit_bill
 703
 704 Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice.
 705
 706 =cut
 707
 708 sub cust_credited {
 709   my $self = shift;
 710   map { $_ } #return $self->num_cust_credit_bill unless wantarray;
 711   sort { $a->_date <=> $b->_date }
 712     qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum } )
 713   ;
 714 }
 715
 716 sub cust_credit_bill {
 717   shift->cust_credited(@_);
 718 }
 719
 720 #=item cust_bill_pay_pkgnum PKGNUM
 721 #
 722 #Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice
 723 #with matching pkgnum.
 724 #
 725 #=cut
 726 #
 727 #sub cust_bill_pay_pkgnum {
 728 #  my( $self, $pkgnum ) = @_;
 729 #  map { $_ } #return $self->num_cust_bill_pay_pkgnum($pkgnum) unless wantarray;
 730 #  sort { $a->_date <=> $b->_date }
 731 #    qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum,
 732 #                                'pkgnum' => $pkgnum,
 733 #                              }
 734 #           );
 735 #}
 736
 737 =item cust_bill_pay_pkg PKGNUM
 738
 739 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice
 740 applied against the matching pkgnum.
 741
 742 =cut
 743
 744 sub cust_bill_pay_pkg {
 745   my( $self, $pkgnum ) = @_;
 746
 747   qsearch({
 748     'select'    => 'cust_bill_pay_pkg.*',
 749     'table'     => 'cust_bill_pay_pkg',
 750     'addl_from' => ' LEFT JOIN cust_bill_pay USING ( billpaynum ) '.
 751                    ' LEFT JOIN cust_bill_pkg USING ( billpkgnum ) ',
 752     'extra_sql' => ' WHERE cust_bill_pkg.invnum = '. $self->invnum.
 753                    "   AND cust_bill_pkg.pkgnum = $pkgnum",
 754   });
 755
 756 }
 757
 758 #=item cust_credited_pkgnum PKGNUM
 759 #
 760 #=item cust_credit_bill_pkgnum PKGNUM
 761 #
 762 #Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice
 763 #with matching pkgnum.
 764 #
 765 #=cut
 766 #
 767 #sub cust_credited_pkgnum {
 768 #  my( $self, $pkgnum ) = @_;
 769 #  map { $_ } #return $self->num_cust_credit_bill_pkgnum($pkgnum) unless wantarray;
 770 #  sort { $a->_date <=> $b->_date }
 771 #    qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum,
 772 #                                   'pkgnum' => $pkgnum,
 773 #                                 }
 774 #           );
 775 #}
 776 #
 777 #sub cust_credit_bill_pkgnum {
 778 #  shift->cust_credited_pkgnum(@_);
 779 #}
 780
 781 =item cust_credit_bill_pkg PKGNUM
 782
 783 Returns all credit applications (see L<FS::cust_credit_bill>) for this invoice
 784 applied against the matching pkgnum.
 785
 786 =cut
 787
 788 sub cust_credit_bill_pkg {
 789   my( $self, $pkgnum ) = @_;
 790
 791   qsearch({
 792     'select'    => 'cust_credit_bill_pkg.*',
 793     'table'     => 'cust_credit_bill_pkg',
 794     'addl_from' => ' LEFT JOIN cust_credit_bill USING ( creditbillnum ) '.
 795                    ' LEFT JOIN cust_bill_pkg    USING ( billpkgnum    ) ',
 796     'extra_sql' => ' WHERE cust_bill_pkg.invnum = '. $self->invnum.
 797                    "   AND cust_bill_pkg.pkgnum = $pkgnum",
 798   });
 799
 800 }
 801
 802 =item cust_bill_batch
 803
 804 Returns all invoice batch records (L<FS::cust_bill_batch>) for this invoice.
 805
 806 =cut
 807
 808 sub cust_bill_batch {
 809   my $self = shift;
 810   qsearch('cust_bill_batch', { 'invnum' => $self->invnum });
 811 }
 812
 813 =item discount_plans
 814
 815 Returns all discount plans (L<FS::discount_plan>) for this invoice, as a
 816 hash keyed by term length.
 817
 818 =cut
 819
 820 sub discount_plans {
 821   my $self = shift;
 822   FS::discount_plan->all($self);
 823 }
 824
 825 =item tax
 826
 827 Returns the tax amount (see L<FS::cust_bill_pkg>) for this invoice.
 828
 829 =cut
 830
 831 sub tax {
 832   my $self = shift;
 833   my $total = 0;
 834   my @taxlines = qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum ,
 835                                              'pkgnum' => 0 } );
 836   foreach (@taxlines) { $total += $_->setup; }
 837   $total;
 838 }
 839
 840 =item owed
 841
 842 Returns the amount owed (still outstanding) on this invoice, which is charged
 843 minus all payment applications (see L<FS::cust_bill_pay>) and credit
 844 applications (see L<FS::cust_credit_bill>).
 845
 846 =cut
 847
 848 sub owed {
 849   my $self = shift;
 850   my $balance = $self->charged;
 851   $balance -= $_->amount foreach ( $self->cust_bill_pay );
 852   $balance -= $_->amount foreach ( $self->cust_credited );
 853   $balance = sprintf( "%.2f", $balance);
 854   $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
 855   $balance;
 856 }
 857
 858 sub owed_pkgnum {
 859   my( $self, $pkgnum ) = @_;
 860
 861   #my $balance = $self->charged;
 862   my $balance = 0;
 863   $balance += $_->setup + $_->recur for $self->cust_bill_pkg_pkgnum($pkgnum);
 864
 865   $balance -= $_->amount            for $self->cust_bill_pay_pkg($pkgnum);
 866   $balance -= $_->amount            for $self->cust_credit_bill_pkg($pkgnum);
 867
 868   $balance = sprintf( "%.2f", $balance);
 869   $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
 870   $balance;
 871 }
 872
 873 =item hide
 874
 875 Returns true if this invoice should be hidden.  See the
 876 selfservice-hide_invoices-taxclass configuraiton setting.
 877
 878 =cut
 879
 880 sub hide {
 881   my $self = shift;
 882   my $conf = $self->conf;
 883   my $hide_taxclass = $conf->config('selfservice-hide_invoices-taxclass')
 884     or return '';
 885   my @cust_bill_pkg = $self->cust_bill_pkg;
 886   my @part_pkg = grep $_, map $_->part_pkg, @cust_bill_pkg;
 887   ! grep { $_->taxclass ne $hide_taxclass } @part_pkg;
 888 }
 889
 890 =item apply_payments_and_credits [ OPTION => VALUE ... ]
 891
 892 Applies unapplied payments and credits to this invoice.
 893
 894 A hash of optional arguments may be passed.  Currently "manual" is supported.
 895 If true, a payment receipt is sent instead of a statement when
 896 'payment_receipt_email' configuration option is set.
 897
 898 If there is an error, returns the error, otherwise returns false.
 899
 900 =cut
 901
 902 sub apply_payments_and_credits {
 903   my( $self, %options ) = @_;
 904   my $conf = $self->conf;
 905
 906   local $SIG{HUP} = 'IGNORE';
 907   local $SIG{INT} = 'IGNORE';
 908   local $SIG{QUIT} = 'IGNORE';
 909   local $SIG{TERM} = 'IGNORE';
 910   local $SIG{TSTP} = 'IGNORE';
 911   local $SIG{PIPE} = 'IGNORE';
 912
 913   my $oldAutoCommit = $FS::UID::AutoCommit;
 914   local $FS::UID::AutoCommit = 0;
 915   my $dbh = dbh;
 916
 917   $self->select_for_update; #mutex
 918
 919   my @payments = grep { $_->unapplied > 0 } $self->cust_main->cust_pay;
 920   my @credits  = grep { $_->credited > 0 } $self->cust_main->cust_credit;
 921
 922   if ( $conf->exists('pkg-balances') ) {
 923     # limit @payments & @credits to those w/ a pkgnum grepped from $self
 924     my %pkgnums = map { $_ => 1 } map $_->pkgnum, $self->cust_bill_pkg;
 925     @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
 926     @credits  = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
 927   }
 928
 929   while ( $self->owed > 0 and ( @payments || @credits ) ) {
 930
 931     my $app = '';
 932     if ( @payments && @credits ) {
 933
 934       #decide which goes first by weight of top (unapplied) line item
 935
 936       my @open_lineitems = $self->open_cust_bill_pkg;
 937
 938       my $max_pay_weight =
 939         max( map  { $_->part_pkg->pay_weight || 0 }
 940              grep { $_ }
 941              map  { $_->cust_pkg }
 942                   @open_lineitems
 943            );
 944       my $max_credit_weight =
 945         max( map  { $_->part_pkg->credit_weight || 0 }
 946              grep { $_ }
 947              map  { $_->cust_pkg }
 948                   @open_lineitems
 949            );
 950
 951       #if both are the same... payments first?  it has to be something
 952       if ( $max_pay_weight >= $max_credit_weight ) {
 953         $app = 'pay';
 954       } else {
 955         $app = 'credit';
 956       }
 957
 958     } elsif ( @payments ) {
 959       $app = 'pay';
 960     } elsif ( @credits ) {
 961       $app = 'credit';
 962     } else {
 963       die "guru meditation #12 and 35";
 964     }
 965
 966     my $unapp_amount;
 967     if ( $app eq 'pay' ) {
 968
 969       my $payment = shift @payments;
 970       $unapp_amount = $payment->unapplied;
 971       $app = new FS::cust_bill_pay { 'paynum'  => $payment->paynum };
 972       $app->pkgnum( $payment->pkgnum )
 973         if $conf->exists('pkg-balances') && $payment->pkgnum;
 974
 975     } elsif ( $app eq 'credit' ) {
 976
 977       my $credit = shift @credits;
 978       $unapp_amount = $credit->credited;
 979       $app = new FS::cust_credit_bill { 'crednum' => $credit->crednum };
 980       $app->pkgnum( $credit->pkgnum )
 981         if $conf->exists('pkg-balances') && $credit->pkgnum;
 982
 983     } else {
 984       die "guru meditation #12 and 35";
 985     }
 986
 987     my $owed;
 988     if ( $conf->exists('pkg-balances') && $app->pkgnum ) {
 989       warn "owed_pkgnum ". $app->pkgnum;
 990       $owed = $self->owed_pkgnum($app->pkgnum);
 991     } else {
 992       $owed = $self->owed;
 993     }
 994     next unless $owed > 0;
 995
 996     warn "min ( $unapp_amount, $owed )\n" if $DEBUG;
 997     $app->amount( sprintf('%.2f', min( $unapp_amount, $owed ) ) );
 998
 999     $app->invnum( $self->invnum );
1000
1001     my $error = $app->insert(%options);
1002     if ( $error ) {
1003       $dbh->rollback if $oldAutoCommit;
1004       return "Error inserting ". $app->table. " record: $error";
1005     }
1006     die $error if $error;
1007
1008   }
1009
1010   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1011   ''; #no error
1012
1013 }
1014
1015 =item generate_email OPTION => VALUE ...
1016
1017 Options:
1018
1019 =over 4
1020
1021 =item from
1022
1023 sender address, required
1024
1025 =item tempate
1026
1027 alternate template name, optional
1028
1029 =item print_text
1030
1031 text attachment arrayref, optional
1032
1033 =item subject
1034
1035 email subject, optional
1036
1037 =item notice_name
1038
1039 notice name instead of "Invoice", optional
1040
1041 =back
1042
1043 Returns an argument list to be passed to L<FS::Misc::send_email>.
1044
1045 =cut
1046
1047 use MIME::Entity;
1048
1049 sub generate_email {
1050
1051   my $self = shift;
1052   my %args = @_;
1053   my $conf = $self->conf;
1054
1055   my $me = '[FS::cust_bill::generate_email]';
1056
1057   my %return = (
1058     'from'      => $args{'from'},
1059     'subject'   => (($args{'subject'}) ? $args{'subject'} : 'Invoice'),
1060   );
1061
1062   my %opt = (
1063     'unsquelch_cdr' => $conf->exists('voip-cdr_email'),
1064     'template'      => $args{'template'},
1065     'notice_name'   => ( $args{'notice_name'} || 'Invoice' ),
1066     'no_coupon'     => $args{'no_coupon'},
1067   );
1068
1069   my $cust_main = $self->cust_main;
1070
1071   if (ref($args{'to'}) eq 'ARRAY') {
1072     $return{'to'} = $args{'to'};
1073   } else {
1074     $return{'to'} = [ grep { $_ !~ /^(POST|FAX)$/ }
1075                            $cust_main->invoicing_list
1076                     ];
1077   }
1078
1079   if ( $conf->exists('invoice_html') ) {
1080
1081     warn "$me creating HTML/text multipart message"
1082       if $DEBUG;
1083
1084     $return{'nobody'} = 1;
1085
1086     my $alternative = build MIME::Entity
1087       'Type'        => 'multipart/alternative',
1088       #'Encoding'    => '7bit',
1089       'Disposition' => 'inline'
1090     ;
1091
1092     my $data;
1093     if ( $conf->exists('invoice_email_pdf')
1094          and scalar($conf->config('invoice_email_pdf_note')) ) {
1095
1096       warn "$me using 'invoice_email_pdf_note' in multipart message"
1097         if $DEBUG;
1098       $data = [ map { $_ . "\n" }
1099                     $conf->config('invoice_email_pdf_note')
1100               ];
1101
1102     } else {
1103
1104       warn "$me not using 'invoice_email_pdf_note' in multipart message"
1105         if $DEBUG;
1106       if ( ref($args{'print_text'}) eq 'ARRAY' ) {
1107         $data = $args{'print_text'};
1108       } else {
1109         $data = [ $self->print_text(\%opt) ];
1110       }
1111
1112     }
1113
1114     $alternative->attach(
1115       'Type'        => 'text/plain',
1116       'Encoding'    => 'quoted-printable',
1117       #'Encoding'    => '7bit',
1118       'Data'        => $data,
1119       'Disposition' => 'inline',
1120     );
1121
1122
1123     my $htmldata;
1124     my $image = '';
1125     my $barcode = '';
1126     if ( $conf->exists('invoice_email_pdf')
1127          and scalar($conf->config('invoice_email_pdf_note')) ) {
1128
1129       $htmldata = join('<BR>', $conf->config('invoice_email_pdf_note') );
1130
1131     } else {
1132
1133       $args{'from'} =~ /\@([\w\.\-]+)/;
1134       my $from = $1 || 'example.com';
1135       my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
1136
1137       my $logo;
1138       my $agentnum = $cust_main->agentnum;
1139       if ( defined($args{'template'}) && length($args{'template'})
1140            && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
1141          )
1142       {
1143         $logo = 'logo_'. $args{'template'}. '.png';
1144       } else {
1145         $logo = "logo.png";
1146       }
1147       my $image_data = $conf->config_binary( $logo, $agentnum);
1148
1149       $image = build MIME::Entity
1150         'Type'       => 'image/png',
1151         'Encoding'   => 'base64',
1152         'Data'       => $image_data,
1153         'Filename'   => 'logo.png',
1154         'Content-ID' => "<$content_id>",
1155       ;
1156
1157       if ($conf->exists('invoice-barcode')) {
1158         my $barcode_content_id = join('.', rand()*(2**32), $$, time). "\@$from";
1159         $barcode = build MIME::Entity
1160           'Type'       => 'image/png',
1161           'Encoding'   => 'base64',
1162           'Data'       => $self->invoice_barcode(0),
1163           'Filename'   => 'barcode.png',
1164           'Content-ID' => "<$barcode_content_id>",
1165         ;
1166         $opt{'barcode_cid'} = $barcode_content_id;
1167       }
1168
1169       $htmldata = $self->print_html({ 'cid'=>$content_id, %opt });
1170     }
1171
1172     $alternative->attach(
1173       'Type'        => 'text/html',
1174       'Encoding'    => 'quoted-printable',
1175       'Data'        => [ '<html>',
1176                          '  <head>',
1177                          '    <title>',
1178                          '      '. encode_entities($return{'subject'}),
1179                          '    </title>',
1180                          '  </head>',
1181                          '  <body bgcolor="#e8e8e8">',
1182                          $htmldata,
1183                          '  </body>',
1184                          '</html>',
1185                        ],
1186       'Disposition' => 'inline',
1187       #'Filename'    => 'invoice.pdf',
1188     );
1189
1190
1191     my @otherparts = ();
1192     if ( $cust_main->email_csv_cdr ) {
1193
1194       push @otherparts, build MIME::Entity
1195         'Type'        => 'text/csv',
1196         'Encoding'    => '7bit',
1197         'Data'        => [ map { "$_\n" }
1198                              $self->call_details('prepend_billed_number' => 1)
1199                          ],
1200         'Disposition' => 'attachment',
1201         'Filename'    => 'usage-'. $self->invnum. '.csv',
1202       ;
1203
1204     }
1205
1206     if ( $conf->exists('invoice_email_pdf') ) {
1207
1208       #attaching pdf too:
1209       # multipart/mixed
1210       #   multipart/related
1211       #     multipart/alternative
1212       #       text/plain
1213       #       text/html
1214       #     image/png
1215       #   application/pdf
1216
1217       my $related = build MIME::Entity 'Type'     => 'multipart/related',
1218                                        'Encoding' => '7bit';
1219
1220       #false laziness w/Misc::send_email
1221       $related->head->replace('Content-type',
1222         $related->mime_type.
1223         '; boundary="'. $related->head->multipart_boundary. '"'.
1224         '; type=multipart/alternative'
1225       );
1226
1227       $related->add_part($alternative);
1228
1229       $related->add_part($image) if $image;
1230
1231       my $pdf = build MIME::Entity $self->mimebuild_pdf(\%opt);
1232
1233       $return{'mimeparts'} = [ $related, $pdf, @otherparts ];
1234
1235     } else {
1236
1237       #no other attachment:
1238       # multipart/related
1239       #   multipart/alternative
1240       #     text/plain
1241       #     text/html
1242       #   image/png
1243
1244       $return{'content-type'} = 'multipart/related';
1245       if ($conf->exists('invoice-barcode') && $barcode) {
1246         $return{'mimeparts'} = [ $alternative, $image, $barcode, @otherparts ];
1247       } else {
1248         $return{'mimeparts'} = [ $alternative, $image, @otherparts ];
1249       }
1250       $return{'type'} = 'multipart/alternative'; #Content-Type of first part...
1251       #$return{'disposition'} = 'inline';
1252
1253     }
1254
1255   } else {
1256
1257     if ( $conf->exists('invoice_email_pdf') ) {
1258       warn "$me creating PDF attachment"
1259         if $DEBUG;
1260
1261       #mime parts arguments a la MIME::Entity->build().
1262       $return{'mimeparts'} = [
1263         { $self->mimebuild_pdf(\%opt) }
1264       ];
1265     }
1266
1267     if ( $conf->exists('invoice_email_pdf')
1268          and scalar($conf->config('invoice_email_pdf_note')) ) {
1269
1270       warn "$me using 'invoice_email_pdf_note'"
1271         if $DEBUG;
1272       $return{'body'} = [ map { $_ . "\n" }
1273                               $conf->config('invoice_email_pdf_note')
1274                         ];
1275
1276     } else {
1277
1278       warn "$me not using 'invoice_email_pdf_note'"
1279         if $DEBUG;
1280       if ( ref($args{'print_text'}) eq 'ARRAY' ) {
1281         $return{'body'} = $args{'print_text'};
1282       } else {
1283         $return{'body'} = [ $self->print_text(\%opt) ];
1284       }
1285
1286     }
1287
1288   }
1289
1290   %return;
1291
1292 }
1293
1294 =item mimebuild_pdf
1295
1296 Returns a list suitable for passing to MIME::Entity->build(), representing
1297 this invoice as PDF attachment.
1298
1299 =cut
1300
1301 sub mimebuild_pdf {
1302   my $self = shift;
1303   (
1304     'Type'        => 'application/pdf',
1305     'Encoding'    => 'base64',
1306     'Data'        => [ $self->print_pdf(@_) ],
1307     'Disposition' => 'attachment',
1308     'Filename'    => 'invoice-'. $self->invnum. '.pdf',
1309   );
1310 }
1311
1312 =item send HASHREF | [ TEMPLATE [ , AGENTNUM [ , INVOICE_FROM [ , AMOUNT ] ] ] ]
1313
1314 Sends this invoice to the destinations configured for this customer: sends
1315 email, prints and/or faxes.  See L<FS::cust_main_invoice>.
1316
1317 Options can be passed as a hashref (recommended) or as a list of up to
1318 four values for templatename, agentnum, invoice_from and amount.
1319
1320 I<template>, if specified, is the name of a suffix for alternate invoices.
1321
1322 I<agentnum>, if specified, means that this invoice will only be sent for customers
1323 of the specified agent or agent(s).  AGENTNUM can be a scalar agentnum (for a
1324 single agent) or an arrayref of agentnums.
1325
1326 I<invoice_from>, if specified, overrides the default email invoice From: address.
1327
1328 I<amount>, if specified, only sends the invoice if the total amount owed on this
1329 invoice and all older invoices is greater than the specified amount.
1330
1331 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1332
1333 =cut
1334
1335 sub queueable_send {
1336   my %opt = @_;
1337
1338   my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
1339     or die "invalid invoice number: " . $opt{invnum};
1340
1341   my @args = ( $opt{template}, $opt{agentnum} );
1342   push @args, $opt{invoice_from}
1343     if exists($opt{invoice_from}) && $opt{invoice_from};
1344
1345   my $error = $self->send( @args );
1346   die $error if $error;
1347
1348 }
1349
1350 sub send {
1351   my $self = shift;
1352   my $conf = $self->conf;
1353
1354   my( $template, $invoice_from, $notice_name );
1355   my $agentnums = '';
1356   my $balance_over = 0;
1357
1358   if ( ref($_[0]) ) {
1359     my $opt = shift;
1360     $template = $opt->{'template'} || '';
1361     if ( $agentnums = $opt->{'agentnum'} ) {
1362       $agentnums = [ $agentnums ] unless ref($agentnums);
1363     }
1364     $invoice_from = $opt->{'invoice_from'};
1365     $balance_over = $opt->{'balance_over'} if $opt->{'balance_over'};
1366     $notice_name = $opt->{'notice_name'};
1367   } else {
1368     $template = scalar(@_) ? shift : '';
1369     if ( scalar(@_) && $_[0]  ) {
1370       $agentnums = ref($_[0]) ? shift : [ shift ];
1371     }
1372     $invoice_from = shift if scalar(@_);
1373     $balance_over = shift if scalar(@_) && $_[0] !~ /^\s*$/;
1374   }
1375
1376   my $cust_main = $self->cust_main;
1377
1378   return 'N/A' unless ! $agentnums
1379                    or grep { $_ == $cust_main->agentnum } @$agentnums;
1380
1381   return ''
1382     unless $cust_main->total_owed_date($self->_date) > $balance_over;
1383
1384   $invoice_from ||= $self->_agent_invoice_from ||    #XXX should go away
1385                     $conf->config('invoice_from', $cust_main->agentnum );
1386
1387   my %opt = (
1388     'template'     => $template,
1389     'invoice_from' => $invoice_from,
1390     'notice_name'  => ( $notice_name || 'Invoice' ),
1391   );
1392
1393   my @invoicing_list = $cust_main->invoicing_list;
1394
1395   #$self->email_invoice(\%opt)
1396   $self->email(\%opt)
1397     if ( grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list or !@invoicing_list )
1398     && ! $self->invoice_noemail;
1399
1400   #$self->print_invoice(\%opt)
1401   $self->print(\%opt)
1402     if grep { $_ eq 'POST' } @invoicing_list; #postal
1403
1404   $self->fax_invoice(\%opt)
1405     if grep { $_ eq 'FAX' } @invoicing_list; #fax
1406
1407   '';
1408
1409 }
1410
1411 =item email HASHREF | [ TEMPLATE [ , INVOICE_FROM ] ]
1412
1413 Emails this invoice.
1414
1415 Options can be passed as a hashref (recommended) or as a list of up to
1416 two values for templatename and invoice_from.
1417
1418 I<template>, if specified, is the name of a suffix for alternate invoices.
1419
1420 I<invoice_from>, if specified, overrides the default email invoice From: address.
1421
1422 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1423
1424 =cut
1425
1426 sub queueable_email {
1427   my %opt = @_;
1428
1429   my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
1430     or die "invalid invoice number: " . $opt{invnum};
1431
1432   my %args = ( 'template' => $opt{template} );
1433   $args{$_} = $opt{$_}
1434     foreach grep { exists($opt{$_}) && $opt{$_} }
1435               qw( invoice_from notice_name no_coupon );
1436
1437   my $error = $self->email( \%args );
1438   die $error if $error;
1439
1440 }
1441
1442 #sub email_invoice {
1443 sub email {
1444   my $self = shift;
1445   return if $self->hide;
1446   my $conf = $self->conf;
1447
1448   my( $template, $invoice_from, $notice_name, $no_coupon );
1449   if ( ref($_[0]) ) {
1450     my $opt = shift;
1451     $template = $opt->{'template'} || '';
1452     $invoice_from = $opt->{'invoice_from'};
1453     $notice_name = $opt->{'notice_name'} || 'Invoice';
1454     $no_coupon = $opt->{'no_coupon'} || 0;
1455   } else {
1456     $template = scalar(@_) ? shift : '';
1457     $invoice_from = shift if scalar(@_);
1458     $notice_name = 'Invoice';
1459     $no_coupon = 0;
1460   }
1461
1462   $invoice_from ||= $self->_agent_invoice_from ||    #XXX should go away
1463                     $conf->config('invoice_from', $self->cust_main->agentnum );
1464
1465   my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ }
1466                             $self->cust_main->invoicing_list;
1467
1468   if ( ! @invoicing_list ) { #no recipients
1469     if ( $conf->exists('cust_bill-no_recipients-error') ) {
1470       die 'No recipients for customer #'. $self->custnum;
1471     } else {
1472       #default: better to notify this person than silence
1473       @invoicing_list = ($invoice_from);
1474     }
1475   }
1476
1477   my $subject = $self->email_subject($template);
1478
1479   my $error = send_email(
1480     $self->generate_email(
1481       'from'        => $invoice_from,
1482       'to'          => [ grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list ],
1483       'subject'     => $subject,
1484       'template'    => $template,
1485       'notice_name' => $notice_name,
1486       'no_coupon'   => $no_coupon,
1487     )
1488   );
1489   die "can't email invoice: $error\n" if $error;
1490   #die "$error\n" if $error;
1491
1492 }
1493
1494 sub email_subject {
1495   my $self = shift;
1496   my $conf = $self->conf;
1497
1498   #my $template = scalar(@_) ? shift : '';
1499   #per-template?
1500
1501   my $subject = $conf->config('invoice_subject', $self->cust_main->agentnum)
1502                 || 'Invoice';
1503
1504   my $cust_main = $self->cust_main;
1505   my $name = $cust_main->name;
1506   my $name_short = $cust_main->name_short;
1507   my $invoice_number = $self->invnum;
1508   my $invoice_date = $self->_date_pretty;
1509
1510   eval qq("$subject");
1511 }
1512
1513 =item lpr_data HASHREF | [ TEMPLATE ]
1514
1515 Returns the postscript or plaintext for this invoice as an arrayref.
1516
1517 Options can be passed as a hashref (recommended) or as a single optional value
1518 for template.
1519
1520 I<template>, if specified, is the name of a suffix for alternate invoices.
1521
1522 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1523
1524 =cut
1525
1526 sub lpr_data {
1527   my $self = shift;
1528   my $conf = $self->conf;
1529   my( $template, $notice_name );
1530   if ( ref($_[0]) ) {
1531     my $opt = shift;
1532     $template = $opt->{'template'} || '';
1533     $notice_name = $opt->{'notice_name'} || 'Invoice';
1534   } else {
1535     $template = scalar(@_) ? shift : '';
1536     $notice_name = 'Invoice';
1537   }
1538
1539   my %opt = (
1540     'template'    => $template,
1541     'notice_name' => $notice_name,
1542   );
1543
1544   my $method = $conf->exists('invoice_latex') ? 'print_ps' : 'print_text';
1545   [ $self->$method( \%opt ) ];
1546 }
1547
1548 =item print HASHREF | [ TEMPLATE ]
1549
1550 Prints this invoice.
1551
1552 Options can be passed as a hashref (recommended) or as a single optional
1553 value for template.
1554
1555 I<template>, if specified, is the name of a suffix for alternate invoices.
1556
1557 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1558
1559 =cut
1560
1561 #sub print_invoice {
1562 sub print {
1563   my $self = shift;
1564   return if $self->hide;
1565   my $conf = $self->conf;
1566
1567   my( $template, $notice_name );
1568   if ( ref($_[0]) ) {
1569     my $opt = shift;
1570     $template = $opt->{'template'} || '';
1571     $notice_name = $opt->{'notice_name'} || 'Invoice';
1572   } else {
1573     $template = scalar(@_) ? shift : '';
1574     $notice_name = 'Invoice';
1575   }
1576
1577   my %opt = (
1578     'template'    => $template,
1579     'notice_name' => $notice_name,
1580   );
1581
1582   if($conf->exists('invoice_print_pdf')) {
1583     # Add the invoice to the current batch.
1584     $self->batch_invoice(\%opt);
1585   }
1586   else {
1587     do_print $self->lpr_data(\%opt);
1588   }
1589 }
1590
1591 =item fax_invoice HASHREF | [ TEMPLATE ]
1592
1593 Faxes this invoice.
1594
1595 Options can be passed as a hashref (recommended) or as a single optional
1596 value for template.
1597
1598 I<template>, if specified, is the name of a suffix for alternate invoices.
1599
1600 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1601
1602 =cut
1603
1604 sub fax_invoice {
1605   my $self = shift;
1606   return if $self->hide;
1607   my $conf = $self->conf;
1608
1609   my( $template, $notice_name );
1610   if ( ref($_[0]) ) {
1611     my $opt = shift;
1612     $template = $opt->{'template'} || '';
1613     $notice_name = $opt->{'notice_name'} || 'Invoice';
1614   } else {
1615     $template = scalar(@_) ? shift : '';
1616     $notice_name = 'Invoice';
1617   }
1618
1619   die 'FAX invoice destination not (yet?) supported with plain text invoices.'
1620     unless $conf->exists('invoice_latex');
1621
1622   my $dialstring = $self->cust_main->getfield('fax');
1623   #Check $dialstring?
1624
1625   my %opt = (
1626     'template'    => $template,
1627     'notice_name' => $notice_name,
1628   );
1629
1630   my $error = send_fax( 'docdata'    => $self->lpr_data(\%opt),
1631                         'dialstring' => $dialstring,
1632                       );
1633   die $error if $error;
1634
1635 }
1636
1637 =item batch_invoice [ HASHREF ]
1638
1639 Place this invoice into the open batch (see C<FS::bill_batch>).  If there
1640 isn't an open batch, one will be created.
1641
1642 =cut
1643
1644 sub batch_invoice {
1645   my ($self, $opt) = @_;
1646   my $bill_batch = $self->get_open_bill_batch;
1647   my $cust_bill_batch = FS::cust_bill_batch->new({
1648       batchnum => $bill_batch->batchnum,
1649       invnum   => $self->invnum,
1650   });
1651   return $cust_bill_batch->insert($opt);
1652 }
1653
1654 =item get_open_batch
1655
1656 Returns the currently open batch as an FS::bill_batch object, creating a new
1657 one if necessary.  (A per-agent batch if invoice_print_pdf-spoolagent is
1658 enabled)
1659
1660 =cut
1661
1662 sub get_open_bill_batch {
1663   my $self = shift;
1664   my $conf = $self->conf;
1665   my $hashref = { status => 'O' };
1666   $hashref->{'agentnum'} = $conf->exists('invoice_print_pdf-spoolagent')
1667                              ? $self->cust_main->agentnum
1668                              : '';
1669   my $batch = qsearchs('bill_batch', $hashref);
1670   return $batch if $batch;
1671   $batch = FS::bill_batch->new($hashref);
1672   my $error = $batch->insert;
1673   die $error if $error;
1674   return $batch;
1675 }
1676
1677 =item ftp_invoice [ TEMPLATENAME ]
1678
1679 Sends this invoice data via FTP.
1680
1681 TEMPLATENAME is unused?
1682
1683 =cut
1684
1685 sub ftp_invoice {
1686   my $self = shift;
1687   my $conf = $self->conf;
1688   my $template = scalar(@_) ? shift : '';
1689
1690   $self->send_csv(
1691     'protocol'   => 'ftp',
1692     'server'     => $conf->config('cust_bill-ftpserver'),
1693     'username'   => $conf->config('cust_bill-ftpusername'),
1694     'password'   => $conf->config('cust_bill-ftppassword'),
1695     'dir'        => $conf->config('cust_bill-ftpdir'),
1696     'format'     => $conf->config('cust_bill-ftpformat'),
1697   );
1698 }
1699
1700 =item spool_invoice [ TEMPLATENAME ]
1701
1702 Spools this invoice data (see L<FS::spool_csv>)
1703
1704 TEMPLATENAME is unused?
1705
1706 =cut
1707
1708 sub spool_invoice {
1709   my $self = shift;
1710   my $conf = $self->conf;
1711   my $template = scalar(@_) ? shift : '';
1712
1713   $self->spool_csv(
1714     'format'       => $conf->config('cust_bill-spoolformat'),
1715     'agent_spools' => $conf->exists('cust_bill-spoolagent'),
1716   );
1717 }
1718
1719 =item send_if_newest [ TEMPLATENAME [ , AGENTNUM [ , INVOICE_FROM ] ] ]
1720
1721 Like B<send>, but only sends the invoice if it is the newest open invoice for
1722 this customer.
1723
1724 =cut
1725
1726 sub send_if_newest {
1727   my $self = shift;
1728
1729   return ''
1730     if scalar(
1731                grep { $_->owed > 0 }
1732                     qsearch('cust_bill', {
1733                       'custnum' => $self->custnum,
1734                       #'_date'   => { op=>'>', value=>$self->_date },
1735                       'invnum'  => { op=>'>', value=>$self->invnum },
1736                     } )
1737              );
1738
1739   $self->send(@_);
1740 }
1741
1742 =item send_csv OPTION => VALUE, ...
1743
1744 Sends invoice as a CSV data-file to a remote host with the specified protocol.
1745
1746 Options are:
1747
1748 protocol - currently only "ftp"
1749 server
1750 username
1751 password
1752 dir
1753
1754 The file will be named "N-YYYYMMDDHHMMSS.csv" where N is the invoice number
1755 and YYMMDDHHMMSS is a timestamp.
1756
1757 See L</print_csv> for a description of the output format.
1758
1759 =cut
1760
1761 sub send_csv {
1762   my($self, %opt) = @_;
1763
1764   #create file(s)
1765
1766   my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1767   mkdir $spooldir, 0700 unless -d $spooldir;
1768
1769   my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', time);
1770   my $file = "$spooldir/$tracctnum.csv";
1771
1772   my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum );
1773
1774   open(CSV, ">$file") or die "can't open $file: $!";
1775   print CSV $header;
1776
1777   print CSV $detail;
1778
1779   close CSV;
1780
1781   my $net;
1782   if ( $opt{protocol} eq 'ftp' ) {
1783     eval "use Net::FTP;";
1784     die $@ if $@;
1785     $net = Net::FTP->new($opt{server}) or die @$;
1786   } else {
1787     die "unknown protocol: $opt{protocol}";
1788   }
1789
1790   $net->login( $opt{username}, $opt{password} )
1791     or die "can't FTP to $opt{username}\@$opt{server}: login error: $@";
1792
1793   $net->binary or die "can't set binary mode";
1794
1795   $net->cwd($opt{dir}) or die "can't cwd to $opt{dir}";
1796
1797   $net->put($file) or die "can't put $file: $!";
1798
1799   $net->quit;
1800
1801   unlink $file;
1802
1803 }
1804
1805 =item spool_csv
1806
1807 Spools CSV invoice data.
1808
1809 Options are:
1810
1811 =over 4
1812
1813 =item format - any of FS::Misc::::Invoicing::spool_formats
1814
1815 =item dest - if set (to POST, EMAIL or FAX), only sends spools invoices if the
1816 customer has the corresponding invoice destinations set (see
1817 L<FS::cust_main_invoice>).
1818
1819 =item agent_spools - if set to a true value, will spool to per-agent files
1820 rather than a single global file
1821
1822 =item upload_targetnum - if set to a target (see L<FS::upload_target>), will
1823 append to that spool.  L<FS::Cron::upload> will then send the spool file to
1824 that destination.
1825
1826 =item balanceover - if set, only spools the invoice if the total amount owed on
1827 this invoice and all older invoices is greater than the specified amount.
1828
1829 =item time - the "current time".  Controls the printing of past due messages
1830 in the ICS format.
1831
1832 =back
1833
1834 =cut
1835
1836 sub spool_csv {
1837   my($self, %opt) = @_;
1838
1839   my $time = $opt{'time'} || time;
1840   my $cust_main = $self->cust_main;
1841
1842   if ( $opt{'dest'} ) {
1843     my %invoicing_list = map { /^(POST|FAX)$/ or 'EMAIL' =~ /^(.*)$/; $1 => 1 }
1844                              $cust_main->invoicing_list;
1845     return 'N/A' unless $invoicing_list{$opt{'dest'}}
1846                      || ! keys %invoicing_list;
1847   }
1848
1849   if ( $opt{'balanceover'} ) {
1850     return 'N/A'
1851       if $cust_main->total_owed_date($self->_date) < $opt{'balanceover'};
1852   }
1853
1854   my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1855   mkdir $spooldir, 0700 unless -d $spooldir;
1856
1857   my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', $time);
1858
1859   my $file;
1860   if ( $opt{'agent_spools'} ) {
1861     $file = 'agentnum'.$cust_main->agentnum;
1862   } else {
1863     $file = 'spool';
1864   }
1865
1866   if ( $opt{'upload_targetnum'} ) {
1867     $spooldir .= '/target'.$opt{'upload_targetnum'};
1868     mkdir $spooldir, 0700 unless -d $spooldir;
1869   } # otherwise it just goes into export.xxx/cust_bill
1870
1871   if ( lc($opt{'format'}) eq 'billco' ) {
1872     $file .= '-header';
1873   }
1874
1875   $file = "$spooldir/$file.csv";
1876
1877   my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum);
1878
1879   open(CSV, ">>$file") or die "can't open $file: $!";
1880   flock(CSV, LOCK_EX);
1881   seek(CSV, 0, 2);
1882
1883   print CSV $header;
1884
1885   if ( lc($opt{'format'}) eq 'billco' ) {
1886
1887     flock(CSV, LOCK_UN);
1888     close CSV;
1889
1890     $file =~ s/-header.csv$/-detail.csv/;
1891
1892     open(CSV,">>$file") or die "can't open $file: $!";
1893     flock(CSV, LOCK_EX);
1894     seek(CSV, 0, 2);
1895   }
1896
1897   print CSV $detail if defined($detail);
1898
1899   flock(CSV, LOCK_UN);
1900   close CSV;
1901
1902   return '';
1903
1904 }
1905
1906 =item print_csv OPTION => VALUE, ...
1907
1908 Returns CSV data for this invoice.
1909
1910 Options are:
1911
1912 format - 'default', 'billco', 'oneline', 'bridgestone'
1913
1914 Returns a list consisting of two scalars.  The first is a single line of CSV
1915 header information for this invoice.  The second is one or more lines of CSV
1916 detail information for this invoice.
1917
1918 If I<format> is not specified or "default", the fields of the CSV file are as
1919 follows:
1920
1921 record_type, invnum, custnum, _date, charged, first, last, company, address1,
1922 address2, city, state, zip, country, pkg, setup, recur, sdate, edate
1923
1924 =over 4
1925
1926 =item record type - B<record_type> is either C<cust_bill> or C<cust_bill_pkg>
1927
1928 B<record_type> is C<cust_bill> for the initial header line only.  The
1929 last five fields (B<pkg> through B<edate>) are irrelevant, and all other
1930 fields are filled in.
1931
1932 B<record_type> is C<cust_bill_pkg> for detail lines.  Only the first two fields
1933 (B<record_type> and B<invnum>) and the last five fields (B<pkg> through B<edate>)
1934 are filled in.
1935
1936 =item invnum - invoice number
1937
1938 =item custnum - customer number
1939
1940 =item _date - invoice date
1941
1942 =item charged - total invoice amount
1943
1944 =item first - customer first name
1945
1946 =item last - customer first name
1947
1948 =item company - company name
1949
1950 =item address1 - address line 1
1951
1952 =item address2 - address line 1
1953
1954 =item city
1955
1956 =item state
1957
1958 =item zip
1959
1960 =item country
1961
1962 =item pkg - line item description
1963
1964 =item setup - line item setup fee (one or both of B<setup> and B<recur> will be defined)
1965
1966 =item recur - line item recurring fee (one or both of B<setup> and B<recur> will be defined)
1967
1968 =item sdate - start date for recurring fee
1969
1970 =item edate - end date for recurring fee
1971
1972 =back
1973
1974 If I<format> is "billco", the fields of the header CSV file are as follows:
1975
1976   +-------------------------------------------------------------------+
1977   |                        FORMAT HEADER FILE                         |
1978   |-------------------------------------------------------------------|
1979   | Field | Description                   | Name       | Type | Width |
1980   | 1     | N/A-Leave Empty               | RC         | CHAR |     2 |
1981   | 2     | N/A-Leave Empty               | CUSTID     | CHAR |    15 |
1982   | 3     | Transaction Account No        | TRACCTNUM  | CHAR |    15 |
1983   | 4     | Transaction Invoice No        | TRINVOICE  | CHAR |    15 |
1984   | 5     | Transaction Zip Code          | TRZIP      | CHAR |     5 |
1985   | 6     | Transaction Company Bill To   | TRCOMPANY  | CHAR |    30 |
1986   | 7     | Transaction Contact Bill To   | TRNAME     | CHAR |    30 |
1987   | 8     | Additional Address Unit Info  | TRADDR1    | CHAR |    30 |
1988   | 9     | Bill To Street Address        | TRADDR2    | CHAR |    30 |
1989   | 10    | Ancillary Billing Information | TRADDR3    | CHAR |    30 |
1990   | 11    | Transaction City Bill To      | TRCITY     | CHAR |    20 |
1991   | 12    | Transaction State Bill To     | TRSTATE    | CHAR |     2 |
1992   | 13    | Bill Cycle Close Date         | CLOSEDATE  | CHAR |    10 |
1993   | 14    | Bill Due Date                 | DUEDATE    | CHAR |    10 |
1994   | 15    | Previous Balance              | BALFWD     | NUM* |     9 |
1995   | 16    | Pmt/CR Applied                | CREDAPPLY  | NUM* |     9 |
1996   | 17    | Total Current Charges         | CURRENTCHG | NUM* |     9 |
1997   | 18    | Total Amt Due                 | TOTALDUE   | NUM* |     9 |
1998   | 19    | Total Amt Due                 | AMTDUE     | NUM* |     9 |
1999   | 20    | 30 Day Aging                  | AMT30      | NUM* |     9 |
2000   | 21    | 60 Day Aging                  | AMT60      | NUM* |     9 |
2001   | 22    | 90 Day Aging                  | AMT90      | NUM* |     9 |
2002   | 23    | Y/N                           | AGESWITCH  | CHAR |     1 |
2003   | 24    | Remittance automation         | SCANLINE   | CHAR |   100 |
2004   | 25    | Total Taxes & Fees            | TAXTOT     | NUM* |     9 |
2005   | 26    | Customer Reference Number     | CUSTREF    | CHAR |    15 |
2006   | 27    | Federal Tax***                | FEDTAX     | NUM* |     9 |
2007   | 28    | State Tax***                  | STATETAX   | NUM* |     9 |
2008   | 29    | Other Taxes & Fees***         | OTHERTAX   | NUM* |     9 |
2009   +-------+-------------------------------+------------+------+-------+
2010
2011 If I<format> is "billco", the fields of the detail CSV file are as follows:
2012
2013                                   FORMAT FOR DETAIL FILE
2014         |                            |           |      |
2015   Field | Description                | Name      | Type | Width
2016   1     | N/A-Leave Empty            | RC        | CHAR |     2
2017   2     | N/A-Leave Empty            | CUSTID    | CHAR |    15
2018   3     | Account Number             | TRACCTNUM | CHAR |    15
2019   4     | Invoice Number             | TRINVOICE | CHAR |    15
2020   5     | Line Sequence (sort order) | LINESEQ   | NUM  |     6
2021   6     | Transaction Detail         | DETAILS   | CHAR |   100
2022   7     | Amount                     | AMT       | NUM* |     9
2023   8     | Line Format Control**      | LNCTRL    | CHAR |     2
2024   9     | Grouping Code              | GROUP     | CHAR |     2
2025   10    | User Defined               | ACCT CODE | CHAR |    15
2026
2027 If format is 'oneline', there is no detail file.  Each invoice has a
2028 header line only, with the fields:
2029
2030 Agent number, agent name, customer number, first name, last name, address
2031 line 1, address line 2, city, state, zip, invoice date, invoice number,
2032 amount charged, amount due,
2033
2034 and then, for each line item, three columns containing the package number,
2035 description, and amount.
2036
2037 If format is 'bridgestone', there is no detail file.  Each invoice has a
2038 header line with the following fields in a fixed-width format:
2039
2040 Customer number (in display format), date, name (first last), company,
2041 address 1, address 2, city, state, zip.
2042
2043 This is a mailing list format, and has no per-invoice fields.  To avoid
2044 sending redundant notices, the spooling event should have a "once" or
2045 "once_percust_every" condition.
2046
2047 =cut
2048
2049 sub print_csv {
2050   my($self, %opt) = @_;
2051
2052   eval "use Text::CSV_XS";
2053   die $@ if $@;
2054
2055   my $cust_main = $self->cust_main;
2056
2057   my $csv = Text::CSV_XS->new({'always_quote'=>1});
2058   my $format = lc($opt{'format'});
2059
2060   my $time = $opt{'time'} || time;
2061
2062   if ( $format eq 'billco' ) {
2063
2064     my $taxtotal = 0;
2065     $taxtotal += $_->{'amount'} foreach $self->_items_tax;
2066
2067     my $duedate = $self->due_date2str('%m/%d/%Y'); #date_format?
2068
2069     my( $previous_balance, @unused ) = $self->previous; #previous balance
2070
2071     my $pmt_cr_applied = 0;
2072     $pmt_cr_applied += $_->{'amount'}
2073       foreach ( $self->_items_payments, $self->_items_credits ) ;
2074
2075     my $totaldue = sprintf('%.2f', $self->owed + $previous_balance);
2076
2077     $csv->combine(
2078       '',                         #  1 | N/A-Leave Empty               CHAR   2
2079       '',                         #  2 | N/A-Leave Empty               CHAR  15
2080       $opt{'tracctnum'},          #  3 | Transaction Account No        CHAR  15
2081       $self->invnum,              #  4 | Transaction Invoice No        CHAR  15
2082       $cust_main->zip,            #  5 | Transaction Zip Code          CHAR   5
2083       $cust_main->company,        #  6 | Transaction Company Bill To   CHAR  30
2084       #$cust_main->payname,        #  7 | Transaction Contact Bill To   CHAR  30
2085       $cust_main->contact,        #  7 | Transaction Contact Bill To   CHAR  30
2086       $cust_main->address2,       #  8 | Additional Address Unit Info  CHAR  30
2087       $cust_main->address1,       #  9 | Bill To Street Address        CHAR  30
2088       '',                         # 10 | Ancillary Billing Information CHAR  30
2089       $cust_main->city,           # 11 | Transaction City Bill To      CHAR  20
2090       $cust_main->state,          # 12 | Transaction State Bill To     CHAR   2
2091
2092       # XXX ?
2093       time2str("%m/%d/%Y", $self->_date), # 13 | Bill Cycle Close Date CHAR  10
2094
2095       # XXX ?
2096       $duedate,                   # 14 | Bill Due Date                 CHAR  10
2097
2098       $previous_balance,          # 15 | Previous Balance              NUM*   9
2099       $pmt_cr_applied,            # 16 | Pmt/CR Applied                NUM*   9
2100       sprintf("%.2f", $self->charged), # 17 | Total Current Charges    NUM*   9
2101       $totaldue,                  # 18 | Total Amt Due                 NUM*   9
2102       $totaldue,                  # 19 | Total Amt Due                 NUM*   9
2103       '',                         # 20 | 30 Day Aging                  NUM*   9
2104       '',                         # 21 | 60 Day Aging                  NUM*   9
2105       '',                         # 22 | 90 Day Aging                  NUM*   9
2106       'N',                        # 23 | Y/N                           CHAR   1
2107       '',                         # 24 | Remittance automation         CHAR 100
2108       $taxtotal,                  # 25 | Total Taxes & Fees            NUM*   9
2109       $self->custnum,             # 26 | Customer Reference Number     CHAR  15
2110       '0',                        # 27 | Federal Tax***                NUM*   9
2111       sprintf("%.2f", $taxtotal), # 28 | State Tax***                  NUM*   9
2112       '0',                        # 29 | Other Taxes & Fees***         NUM*   9
2113     );
2114
2115   } elsif ( $format eq 'oneline' ) { #name
2116
2117     my ($previous_balance) = $self->previous;
2118     my $totaldue = sprintf('%.2f', $self->owed + $previous_balance);
2119     my @items = map {
2120       ($_->{pkgnum} || ''),
2121       $_->{description},
2122       $_->{amount}
2123     } $self->_items_pkg;
2124
2125     $csv->combine(
2126       $cust_main->agentnum,
2127       $cust_main->agent->agent,
2128       $self->custnum,
2129       $cust_main->first,
2130       $cust_main->last,
2131       $cust_main->address1,
2132       $cust_main->address2,
2133       $cust_main->city,
2134       $cust_main->state,
2135       $cust_main->zip,
2136
2137       # invoice fields
2138       time2str("%x", $self->_date),
2139       $self->invnum,
2140       $self->charged,
2141       $totaldue,
2142
2143       @items,
2144     );
2145
2146   } elsif ( $format eq 'bridgestone' ) {
2147
2148     # bypass the CSV stuff and just return this
2149     my $longdate = time2str('%B %d, %Y', $time); #current time, right?
2150     my $zip = $cust_main->zip;
2151     $zip =~ s/\D//;
2152     my $prefix = $self->conf->config('bridgestone-prefix', $cust_main->agentnum)
2153       || '';
2154     return (
2155       sprintf(
2156         "%-5s%-15s%-20s%-30s%-30s%-30s%-30s%-20s%-2s%-9s\n",
2157         $prefix,
2158         $cust_main->display_custnum,
2159         $longdate,
2160         uc(substr($cust_main->contact_firstlast,0,30)),
2161         uc(substr($cust_main->company          ,0,30)),
2162         uc(substr($cust_main->address1         ,0,30)),
2163         uc(substr($cust_main->address2         ,0,30)),
2164         uc(substr($cust_main->city             ,0,20)),
2165         uc($cust_main->state),
2166         $zip
2167       ),
2168       '' #detail
2169       );
2170
2171   } elsif ( $format eq 'ics' ) {
2172
2173     my $bill = $cust_main->bill_location;
2174     my $zip = $bill->zip;
2175     my $zip4 = '';
2176
2177     $zip =~ s/\D//;
2178     if ( $zip =~ /^(\d{5})(\d{4})$/ ) {
2179       $zip = $1;
2180       $zip4 = $2;
2181     }
2182
2183     # minor false laziness with print_generic
2184     my ($previous_balance) = $self->previous;
2185     my $balance_due = $self->owed + $previous_balance;
2186     my $payment_total = sum(0, map { $_->{'amount'} } $self->_items_payments);
2187     my $credit_total  = sum(0, map { $_->{'amount'} } $self->_items_credits);
2188
2189     my $past_due = '';
2190     if ( $self->due_date and $time >= $self->due_date ) {
2191       $past_due = sprintf('Past due:$%0.2f Due Immediately', $balance_due);
2192     }
2193
2194     # again, bypass CSV
2195     my $header = sprintf(
2196       '%-10s%-30s%-48s%-2s%-50s%-30s%-30s%-25s%-2s%-5s%-4s%-8s%-8s%-10s%-10s%-10s%-10s%-10s%-10s%-480s%-35s',
2197       $cust_main->display_custnum, #BID
2198       uc($cust_main->first), #FNAME
2199       uc($cust_main->last), #LNAME
2200       '00', #BATCH, should this ever be anything else?
2201       uc($cust_main->company), #COMP
2202       uc($bill->address1), #STREET1
2203       uc($bill->address2), #STREET2
2204       uc($bill->city), #CITY
2205       uc($bill->state), #STATE
2206       $zip,
2207       $zip4,
2208       time2str('%Y%m%d', $self->_date), #BILL_DATE
2209       $self->due_date2str('%Y%m%d'), #DUE_DATE,
2210       ( map {sprintf('%0.2f', $_)}
2211         $balance_due, #AMNT_DUE
2212         $previous_balance, #PREV_BAL
2213         $payment_total, #PYMT_RCVD
2214         $credit_total, #CREDITS
2215         $previous_balance, #BEG_BAL--is this correct?
2216         $self->charged, #NEW_CHRG
2217       ),
2218       'img01', #MRKT_MSG?
2219       $past_due, #PAST_MSG
2220     );
2221
2222     my @details;
2223     my %svc_class = ('' => ''); # maybe cache this more persistently?
2224
2225     foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2226
2227       my $show_pkgnum = $cust_bill_pkg->pkgnum || '';
2228       my $cust_pkg = $cust_bill_pkg->cust_pkg if $show_pkgnum;
2229
2230       if ( $cust_pkg ) {
2231
2232         my @dates = ( $self->_date, undef );
2233         if ( my $prev = $cust_bill_pkg->previous_cust_bill_pkg ) {
2234           $dates[1] = $prev->sdate; #questionable
2235         }
2236
2237         # generate an 01 detail for each service
2238         my @svcs = $cust_pkg->h_cust_svc(@dates, 'I');
2239         foreach my $cust_svc ( @svcs ) {
2240           $show_pkgnum = ''; # hide it if we're showing svcnums
2241
2242           my $svcpart = $cust_svc->svcpart;
2243           if (!exists($svc_class{$svcpart})) {
2244             my $classnum = $cust_svc->part_svc->classnum;
2245             my $part_svc_class = FS::part_svc_class->by_key($classnum)
2246               if $classnum;
2247             $svc_class{$svcpart} = $part_svc_class ?
2248                                    $part_svc_class->classname :
2249                                    '';
2250           }
2251
2252           my @h_label = $cust_svc->label(@dates, 'I');
2253           push @details, sprintf('01%-9s%-20s%-47s',
2254             $cust_svc->svcnum,
2255             $svc_class{$svcpart},
2256             $h_label[1],
2257           );
2258         } #foreach $cust_svc
2259       } #if $cust_pkg
2260
2261       my $desc = $cust_bill_pkg->desc; # itemdesc or part_pkg.pkg
2262       if ($cust_bill_pkg->recur > 0) {
2263         $desc .= ' '.time2str('%d-%b-%Y', $cust_bill_pkg->sdate).' to '.
2264                      time2str('%d-%b-%Y', $cust_bill_pkg->edate - 86400);
2265       }
2266       push @details, sprintf('02%-6s%-60s%-10s',
2267         $show_pkgnum,
2268         $desc,
2269         sprintf('%0.2f', $cust_bill_pkg->setup + $cust_bill_pkg->recur),
2270       );
2271     } #foreach $cust_bill_pkg
2272
2273     # Tag this row so that we know whether this is one page (1), two pages
2274     # (2), # or "big" (B).  The tag will be stripped off before uploading.
2275     if ( scalar(@details) < 12 ) {
2276       push @details, '1';
2277     } elsif ( scalar(@details) < 58 ) {
2278       push @details, '2';
2279     } else {
2280       push @details, 'B';
2281     }
2282
2283     return join('', $header, @details, "\n");
2284
2285   } else { # default
2286
2287     $csv->combine(
2288       'cust_bill',
2289       $self->invnum,
2290       $self->custnum,
2291       time2str("%x", $self->_date),
2292       sprintf("%.2f", $self->charged),
2293       ( map { $cust_main->getfield($_) }
2294           qw( first last company address1 address2 city state zip country ) ),
2295       map { '' } (1..5),
2296     ) or die "can't create csv";
2297   }
2298
2299   my $header = $csv->string. "\n";
2300
2301   my $detail = '';
2302   if ( lc($opt{'format'}) eq 'billco' ) {
2303
2304     my $lineseq = 0;
2305     foreach my $item ( $self->_items_pkg ) {
2306
2307       $csv->combine(
2308         '',                     #  1 | N/A-Leave Empty            CHAR   2
2309         '',                     #  2 | N/A-Leave Empty            CHAR  15
2310         $opt{'tracctnum'},      #  3 | Account Number             CHAR  15
2311         $self->invnum,          #  4 | Invoice Number             CHAR  15
2312         $lineseq++,             #  5 | Line Sequence (sort order) NUM    6
2313         $item->{'description'}, #  6 | Transaction Detail         CHAR 100
2314         $item->{'amount'},      #  7 | Amount                     NUM*   9
2315         '',                     #  8 | Line Format Control**      CHAR   2
2316         '',                     #  9 | Grouping Code              CHAR   2
2317         '',                     # 10 | User Defined               CHAR  15
2318       );
2319
2320       $detail .= $csv->string. "\n";
2321
2322     }
2323
2324   } elsif ( lc($opt{'format'}) eq 'oneline' ) {
2325
2326     #do nothing
2327
2328   } else {
2329
2330     foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2331
2332       my($pkg, $setup, $recur, $sdate, $edate);
2333       if ( $cust_bill_pkg->pkgnum ) {
2334
2335         ($pkg, $setup, $recur, $sdate, $edate) = (
2336           $cust_bill_pkg->part_pkg->pkg,
2337           ( $cust_bill_pkg->setup != 0
2338             ? sprintf("%.2f", $cust_bill_pkg->setup )
2339             : '' ),
2340           ( $cust_bill_pkg->recur != 0
2341             ? sprintf("%.2f", $cust_bill_pkg->recur )
2342             : '' ),
2343           ( $cust_bill_pkg->sdate
2344             ? time2str("%x", $cust_bill_pkg->sdate)
2345             : '' ),
2346           ($cust_bill_pkg->edate
2347             ?time2str("%x", $cust_bill_pkg->edate)
2348             : '' ),
2349         );
2350
2351       } else { #pkgnum tax
2352         next unless $cust_bill_pkg->setup != 0;
2353         $pkg = $cust_bill_pkg->desc;
2354         $setup = sprintf('%10.2f', $cust_bill_pkg->setup );
2355         ( $sdate, $edate ) = ( '', '' );
2356       }
2357
2358       $csv->combine(
2359         'cust_bill_pkg',
2360         $self->invnum,
2361         ( map { '' } (1..11) ),
2362         ($pkg, $setup, $recur, $sdate, $edate)
2363       ) or die "can't create csv";
2364
2365       $detail .= $csv->string. "\n";
2366
2367     }
2368
2369   }
2370
2371   ( $header, $detail );
2372
2373 }
2374
2375 =item comp
2376
2377 Pays this invoice with a compliemntary payment.  If there is an error,
2378 returns the error, otherwise returns false.
2379
2380 =cut
2381
2382 sub comp {
2383   my $self = shift;
2384   my $cust_pay = new FS::cust_pay ( {
2385     'invnum'   => $self->invnum,
2386     'paid'     => $self->owed,
2387     '_date'    => '',
2388     'payby'    => 'COMP',
2389     'payinfo'  => $self->cust_main->payinfo,
2390     'paybatch' => '',
2391   } );
2392   $cust_pay->insert;
2393 }
2394
2395 =item realtime_card
2396
2397 Attempts to pay this invoice with a credit card payment via a
2398 Business::OnlinePayment realtime gateway.  See
2399 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2400 for supported processors.
2401
2402 =cut
2403
2404 sub realtime_card {
2405   my $self = shift;
2406   $self->realtime_bop( 'CC', @_ );
2407 }
2408
2409 =item realtime_ach
2410
2411 Attempts to pay this invoice with an electronic check (ACH) payment via a
2412 Business::OnlinePayment realtime gateway.  See
2413 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2414 for supported processors.
2415
2416 =cut
2417
2418 sub realtime_ach {
2419   my $self = shift;
2420   $self->realtime_bop( 'ECHECK', @_ );
2421 }
2422
2423 =item realtime_lec
2424
2425 Attempts to pay this invoice with phone bill (LEC) payment via a
2426 Business::OnlinePayment realtime gateway.  See
2427 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2428 for supported processors.
2429
2430 =cut
2431
2432 sub realtime_lec {
2433   my $self = shift;
2434   $self->realtime_bop( 'LEC', @_ );
2435 }
2436
2437 sub realtime_bop {
2438   my( $self, $method ) = (shift,shift);
2439   my $conf = $self->conf;
2440   my %opt = @_;
2441
2442   my $cust_main = $self->cust_main;
2443   my $balance = $cust_main->balance;
2444   my $amount = ( $balance < $self->owed ) ? $balance : $self->owed;
2445   $amount = sprintf("%.2f", $amount);
2446   return "not run (balance $balance)" unless $amount > 0;
2447
2448   my $description = 'Internet Services';
2449   if ( $conf->exists('business-onlinepayment-description') ) {
2450     my $dtempl = $conf->config('business-onlinepayment-description');
2451
2452     my $agent_obj = $cust_main->agent
2453       or die "can't retreive agent for $cust_main (agentnum ".
2454              $cust_main->agentnum. ")";
2455     my $agent = $agent_obj->agent;
2456     my $pkgs = join(', ',
2457       map { $_->part_pkg->pkg }
2458         grep { $_->pkgnum } $self->cust_bill_pkg
2459     );
2460     $description = eval qq("$dtempl");
2461   }
2462
2463   $cust_main->realtime_bop($method, $amount,
2464     'description' => $description,
2465     'invnum'      => $self->invnum,
2466 #this didn't do what we want, it just calls apply_payments_and_credits
2467 #    'apply'       => 1,
2468     'apply_to_invoice' => 1,
2469     %opt,
2470  #what we want:
2471  #this changes application behavior: auto payments
2472                         #triggered against a specific invoice are now applied
2473                         #to that invoice instead of oldest open.
2474                         #seem okay to me...
2475   );
2476
2477 }
2478
2479 =item batch_card OPTION => VALUE...
2480
2481 Adds a payment for this invoice to the pending credit card batch (see
2482 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2483 runs the payment using a realtime gateway.
2484
2485 =cut
2486
2487 sub batch_card {
2488   my ($self, %options) = @_;
2489   my $cust_main = $self->cust_main;
2490
2491   $options{invnum} = $self->invnum;
2492
2493   $cust_main->batch_card(%options);
2494 }
2495
2496 sub _agent_template {
2497   my $self = shift;
2498   $self->cust_main->agent_template;
2499 }
2500
2501 sub _agent_invoice_from {
2502   my $self = shift;
2503   $self->cust_main->agent_invoice_from;
2504 }
2505
2506 =item invoice_barcode DIR_OR_FALSE
2507
2508 Generates an invoice barcode PNG. If DIR_OR_FALSE is a true value,
2509 it is taken as the temp directory where the PNG file will be generated and the
2510 PNG file name is returned. Otherwise, the PNG image itself is returned.
2511
2512 =cut
2513
2514 sub invoice_barcode {
2515     my ($self, $dir) = (shift,shift);
2516
2517     my $gdbar = new GD::Barcode('Code39',$self->invnum);
2518         die "can't create barcode: " . $GD::Barcode::errStr unless $gdbar;
2519     my $gd = $gdbar->plot(Height => 30);
2520
2521     if($dir) {
2522         my $bh = new File::Temp( TEMPLATE => 'barcode.'. $self->invnum. '.XXXXXXXX',
2523                            DIR      => $dir,
2524                            SUFFIX   => '.png',
2525                            UNLINK   => 0,
2526                          ) or die "can't open temp file: $!\n";
2527         print $bh $gd->png or die "cannot write barcode to file: $!\n";
2528         my $png_file = $bh->filename;
2529         close $bh;
2530         return $png_file;
2531     }
2532     return $gd->png;
2533 }
2534
2535 =item invnum_date_pretty
2536
2537 Returns a string with the invoice number and date, for example:
2538 "Invoice #54 (3/20/2008)"
2539
2540 =cut
2541
2542 sub invnum_date_pretty {
2543   my $self = shift;
2544   $self->mt('Invoice #'). $self->invnum. ' ('. $self->_date_pretty. ')';
2545 }
2546
2547 #sub _items_extra_usage_sections {
2548 #  my $self = shift;
2549 #  my $escape = shift;
2550 #
2551 #  my %sections = ();
2552 #
2553 #  my %usage_class =  map{ $_->classname, $_ } qsearch('usage_class', {});
2554 #  foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
2555 #  {
2556 #    next unless $cust_bill_pkg->pkgnum > 0;
2557 #
2558 #    foreach my $section ( keys %usage_class ) {
2559 #
2560 #      my $usage = $cust_bill_pkg->usage($section);
2561 #
2562 #      next unless $usage && $usage > 0;
2563 #
2564 #      $sections{$section} ||= 0;
2565 #      $sections{$section} += $usage;
2566 #
2567 #    }
2568 #
2569 #  }
2570 #
2571 #  map { { 'description' => &{$escape}($_),
2572 #          'subtotal'    => $sections{$_},
2573 #          'summarized'  => '',
2574 #          'tax_section' => '',
2575 #        }
2576 #      }
2577 #    sort {$usage_class{$a}->weight <=> $usage_class{$b}->weight} keys %sections;
2578 #
2579 #}
2580
2581 sub _items_extra_usage_sections {
2582   my $self = shift;
2583   my $conf = $self->conf;
2584   my $escape = shift;
2585   my $format = shift;
2586
2587   my %sections = ();
2588   my %classnums = ();
2589   my %lines = ();
2590
2591   my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 50;
2592
2593   my %usage_class =  map { $_->classnum => $_ } qsearch( 'usage_class', {} );
2594   foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2595     next unless $cust_bill_pkg->pkgnum > 0;
2596
2597     foreach my $classnum ( keys %usage_class ) {
2598       my $section = $usage_class{$classnum}->classname;
2599       $classnums{$section} = $classnum;
2600
2601       foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail($classnum) ) {
2602         my $amount = $detail->amount;
2603         next unless $amount && $amount > 0;
2604
2605         $sections{$section} ||= { 'subtotal'=>0, 'calls'=>0, 'duration'=>0 };
2606         $sections{$section}{amount} += $amount;  #subtotal
2607         $sections{$section}{calls}++;
2608         $sections{$section}{duration} += $detail->duration;
2609
2610         my $desc = $detail->regionname;
2611         my $description = $desc;
2612         $description = substr($desc, 0, $maxlength). '...'
2613           if $format eq 'latex' && length($desc) > $maxlength;
2614
2615         $lines{$section}{$desc} ||= {
2616           description     => &{$escape}($description),
2617           #pkgpart         => $part_pkg->pkgpart,
2618           pkgnum          => $cust_bill_pkg->pkgnum,
2619           ref             => '',
2620           amount          => 0,
2621           calls           => 0,
2622           duration        => 0,
2623           #unit_amount     => $cust_bill_pkg->unitrecur,
2624           quantity        => $cust_bill_pkg->quantity,
2625           product_code    => 'N/A',
2626           ext_description => [],
2627         };
2628
2629         $lines{$section}{$desc}{amount} += $amount;
2630         $lines{$section}{$desc}{calls}++;
2631         $lines{$section}{$desc}{duration} += $detail->duration;
2632
2633       }
2634     }
2635   }
2636
2637   my %sectionmap = ();
2638   foreach (keys %sections) {
2639     my $usage_class = $usage_class{$classnums{$_}};
2640     $sectionmap{$_} = { 'description' => &{$escape}($_),
2641                         'amount'    => $sections{$_}{amount},    #subtotal
2642                         'calls'       => $sections{$_}{calls},
2643                         'duration'    => $sections{$_}{duration},
2644                         'summarized'  => '',
2645                         'tax_section' => '',
2646                         'sort_weight' => $usage_class->weight,
2647                         ( $usage_class->format
2648                           ? ( map { $_ => $usage_class->$_($format) }
2649                               qw( description_generator header_generator total_generator total_line_generator )
2650                             )
2651                           : ()
2652                         ),
2653                       };
2654   }
2655
2656   my @sections = sort { $a->{sort_weight} <=> $b->{sort_weight} }
2657                  values %sectionmap;
2658
2659   my @lines = ();
2660   foreach my $section ( keys %lines ) {
2661     foreach my $line ( keys %{$lines{$section}} ) {
2662       my $l = $lines{$section}{$line};
2663       $l->{section}     = $sectionmap{$section};
2664       $l->{amount}      = sprintf( "%.2f", $l->{amount} );
2665       #$l->{unit_amount} = sprintf( "%.2f", $l->{unit_amount} );
2666       push @lines, $l;
2667     }
2668   }
2669
2670   return(\@sections, \@lines);
2671
2672 }
2673
2674 sub _did_summary {
2675     my $self = shift;
2676     my $end = $self->_date;
2677
2678     # start at date of previous invoice + 1 second or 0 if no previous invoice
2679     my $start = $self->scalar_sql("SELECT max(_date) FROM cust_bill WHERE custnum = ? and invnum != ?",$self->custnum,$self->invnum);
2680     $start = 0 if !$start;
2681     $start++;
2682
2683     my $cust_main = $self->cust_main;
2684     my @pkgs = $cust_main->all_pkgs;
2685     my($num_activated,$num_deactivated,$num_portedin,$num_portedout,$minutes)
2686         = (0,0,0,0,0);
2687     my @seen = ();
2688     foreach my $pkg ( @pkgs ) {
2689         my @h_cust_svc = $pkg->h_cust_svc($end);
2690         foreach my $h_cust_svc ( @h_cust_svc ) {
2691             next if grep {$_ eq $h_cust_svc->svcnum} @seen;
2692             next unless $h_cust_svc->part_svc->svcdb eq 'svc_phone';
2693
2694             my $inserted = $h_cust_svc->date_inserted;
2695             my $deleted = $h_cust_svc->date_deleted;
2696             my $phone_inserted = $h_cust_svc->h_svc_x($inserted+5);
2697             my $phone_deleted;
2698             $phone_deleted =  $h_cust_svc->h_svc_x($deleted) if $deleted;
2699
2700 # DID either activated or ported in; cannot be both for same DID simultaneously
2701             if ($inserted >= $start && $inserted <= $end && $phone_inserted
2702                 && (!$phone_inserted->lnp_status
2703                     || $phone_inserted->lnp_status eq ''
2704                     || $phone_inserted->lnp_status eq 'native')) {
2705                 $num_activated++;
2706             }
2707             else { # this one not so clean, should probably move to (h_)svc_phone
2708                  my $phone_portedin = qsearchs( 'h_svc_phone',
2709                       { 'svcnum' => $h_cust_svc->svcnum,
2710                         'lnp_status' => 'portedin' },
2711                       FS::h_svc_phone->sql_h_searchs($end),
2712                     );
2713                  $num_portedin++ if $phone_portedin;
2714             }
2715
2716 # DID either deactivated or ported out; cannot be both for same DID simultaneously
2717             if($deleted >= $start && $deleted <= $end && $phone_deleted
2718                 && (!$phone_deleted->lnp_status
2719                     || $phone_deleted->lnp_status ne 'portingout')) {
2720                 $num_deactivated++;
2721             }
2722             elsif($deleted >= $start && $deleted <= $end && $phone_deleted
2723                 && $phone_deleted->lnp_status
2724                 && $phone_deleted->lnp_status eq 'portingout') {
2725                 $num_portedout++;
2726             }
2727
2728             # increment usage minutes
2729         if ( $phone_inserted ) {
2730             my @cdrs = $phone_inserted->get_cdrs('begin'=>$start,'end'=>$end,'billsec_sum'=>1);
2731             $minutes = $cdrs[0]->billsec_sum if scalar(@cdrs) == 1;
2732         }
2733         else {
2734             warn "WARNING: no matching h_svc_phone insert record for insert time $inserted, svcnum " . $h_cust_svc->svcnum;
2735         }
2736
2737             # don't look at this service again
2738             push @seen, $h_cust_svc->svcnum;
2739         }
2740     }
2741
2742     $minutes = sprintf("%d", $minutes);
2743     ("Activated: $num_activated  Ported-In: $num_portedin  Deactivated: "
2744         . "$num_deactivated  Ported-Out: $num_portedout ",
2745             "Total Minutes: $minutes");
2746 }
2747
2748 sub _items_accountcode_cdr {
2749     my $self = shift;
2750     my $escape = shift;
2751     my $format = shift;
2752
2753     my $section = { 'amount'        => 0,
2754                     'calls'         => 0,
2755                     'duration'      => 0,
2756                     'sort_weight'   => '',
2757                     'phonenum'      => '',
2758                     'description'   => 'Usage by Account Code',
2759                     'post_total'    => '',
2760                     'summarized'    => '',
2761                     'header'        => '',
2762                   };
2763     my @lines;
2764     my %accountcodes = ();
2765
2766     foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2767         next unless $cust_bill_pkg->pkgnum > 0;
2768
2769         my @header = $cust_bill_pkg->details_header;
2770         next unless scalar(@header);
2771         $section->{'header'} = join(',',@header);
2772
2773         foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail ) {
2774
2775             $section->{'header'} = $detail->formatted('format' => $format)
2776                 if($detail->detail eq $section->{'header'});
2777
2778             my $accountcode = $detail->accountcode;
2779             next unless $accountcode;
2780
2781             my $amount = $detail->amount;
2782             next unless $amount && $amount > 0;
2783
2784             $accountcodes{$accountcode} ||= {
2785                     description => $accountcode,
2786                     pkgnum      => '',
2787                     ref         => '',
2788                     amount      => 0,
2789                     calls       => 0,
2790                     duration    => 0,
2791                     quantity    => '',
2792                     product_code => 'N/A',
2793                     section     => $section,
2794                     ext_description => [ $section->{'header'} ],
2795                     detail_temp => [],
2796             };
2797
2798             $section->{'amount'} += $amount;
2799             $accountcodes{$accountcode}{'amount'} += $amount;
2800             $accountcodes{$accountcode}{calls}++;
2801             $accountcodes{$accountcode}{duration} += $detail->duration;
2802             push @{$accountcodes{$accountcode}{detail_temp}}, $detail;
2803         }
2804     }
2805
2806     foreach my $l ( values %accountcodes ) {
2807         $l->{amount} = sprintf( "%.2f", $l->{amount} );
2808         my @sorted_detail = sort { $a->startdate <=> $b->startdate } @{$l->{detail_temp}};
2809         foreach my $sorted_detail ( @sorted_detail ) {
2810             push @{$l->{ext_description}}, $sorted_detail->formatted('format'=>$format);
2811         }
2812         delete $l->{detail_temp};
2813         push @lines, $l;
2814     }
2815
2816     my @sorted_lines = sort { $a->{'description'} <=> $b->{'description'} } @lines;
2817
2818     return ($section,\@sorted_lines);
2819 }
2820
2821 sub _items_svc_phone_sections {
2822   my $self = shift;
2823   my $conf = $self->conf;
2824   my $escape = shift;
2825   my $format = shift;
2826
2827   my %sections = ();
2828   my %classnums = ();
2829   my %lines = ();
2830
2831   my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 50;
2832
2833   my %usage_class =  map { $_->classnum => $_ } qsearch( 'usage_class', {} );
2834   $usage_class{''} ||= new FS::usage_class { 'classname' => '', 'weight' => 0 };
2835
2836   foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2837     next unless $cust_bill_pkg->pkgnum > 0;
2838
2839     my @header = $cust_bill_pkg->details_header;
2840     next unless scalar(@header);
2841
2842     foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail ) {
2843
2844       my $phonenum = $detail->phonenum;
2845       next unless $phonenum;
2846
2847       my $amount = $detail->amount;
2848       next unless $amount && $amount > 0;
2849
2850       $sections{$phonenum} ||= { 'amount'      => 0,
2851                                  'calls'       => 0,
2852                                  'duration'    => 0,
2853                                  'sort_weight' => -1,
2854                                  'phonenum'    => $phonenum,
2855                                 };
2856       $sections{$phonenum}{amount} += $amount;  #subtotal
2857       $sections{$phonenum}{calls}++;
2858       $sections{$phonenum}{duration} += $detail->duration;
2859
2860       my $desc = $detail->regionname;
2861       my $description = $desc;
2862       $description = substr($desc, 0, $maxlength). '...'
2863         if $format eq 'latex' && length($desc) > $maxlength;
2864
2865       $lines{$phonenum}{$desc} ||= {
2866         description     => &{$escape}($description),
2867         #pkgpart         => $part_pkg->pkgpart,
2868         pkgnum          => '',
2869         ref             => '',
2870         amount          => 0,
2871         calls           => 0,
2872         duration        => 0,
2873         #unit_amount     => '',
2874         quantity        => '',
2875         product_code    => 'N/A',
2876         ext_description => [],
2877       };
2878
2879       $lines{$phonenum}{$desc}{amount} += $amount;
2880       $lines{$phonenum}{$desc}{calls}++;
2881       $lines{$phonenum}{$desc}{duration} += $detail->duration;
2882
2883       my $line = $usage_class{$detail->classnum}->classname;
2884       $sections{"$phonenum $line"} ||=
2885         { 'amount' => 0,
2886           'calls' => 0,
2887           'duration' => 0,
2888           'sort_weight' => $usage_class{$detail->classnum}->weight,
2889           'phonenum' => $phonenum,
2890           'header'  => [ @header ],
2891         };
2892       $sections{"$phonenum $line"}{amount} += $amount;  #subtotal
2893       $sections{"$phonenum $line"}{calls}++;
2894       $sections{"$phonenum $line"}{duration} += $detail->duration;
2895
2896       $lines{"$phonenum $line"}{$desc} ||= {
2897         description     => &{$escape}($description),
2898         #pkgpart         => $part_pkg->pkgpart,
2899         pkgnum          => '',
2900         ref             => '',
2901         amount          => 0,
2902         calls           => 0,
2903         duration        => 0,
2904         #unit_amount     => '',
2905         quantity        => '',
2906         product_code    => 'N/A',
2907         ext_description => [],
2908       };
2909
2910       $lines{"$phonenum $line"}{$desc}{amount} += $amount;
2911       $lines{"$phonenum $line"}{$desc}{calls}++;
2912       $lines{"$phonenum $line"}{$desc}{duration} += $detail->duration;
2913       push @{$lines{"$phonenum $line"}{$desc}{ext_description}},
2914            $detail->formatted('format' => $format);
2915
2916     }
2917   }
2918
2919   my %sectionmap = ();
2920   my $simple = new FS::usage_class { format => 'simple' }; #bleh
2921   foreach ( keys %sections ) {
2922     my @header = @{ $sections{$_}{header} || [] };
2923     my $usage_simple =
2924       new FS::usage_class { format => 'usage_'. (scalar(@header) || 6). 'col' };
2925     my $summary = $sections{$_}{sort_weight} < 0 ? 1 : 0;
2926     my $usage_class = $summary ? $simple : $usage_simple;
2927     my $ending = $summary ? ' usage charges' : '';
2928     my %gen_opt = ();
2929     unless ($summary) {
2930       $gen_opt{label} = [ map{ &{$escape}($_) } @header ];
2931     }
2932     $sectionmap{$_} = { 'description' => &{$escape}($_. $ending),
2933                         'amount'    => $sections{$_}{amount},    #subtotal
2934                         'calls'       => $sections{$_}{calls},
2935                         'duration'    => $sections{$_}{duration},
2936                         'summarized'  => '',
2937                         'tax_section' => '',
2938                         'phonenum'    => $sections{$_}{phonenum},
2939                         'sort_weight' => $sections{$_}{sort_weight},
2940                         'post_total'  => $summary, #inspire pagebreak
2941                         (
2942                           ( map { $_ => $usage_class->$_($format, %gen_opt) }
2943                             qw( description_generator
2944                                 header_generator
2945                                 total_generator
2946                                 total_line_generator
2947                               )
2948                           )
2949                         ),
2950                       };
2951   }
2952
2953   my @sections = sort { $a->{phonenum} cmp $b->{phonenum} ||
2954                         $a->{sort_weight} <=> $b->{sort_weight}
2955                       }
2956                  values %sectionmap;
2957
2958   my @lines = ();
2959   foreach my $section ( keys %lines ) {
2960     foreach my $line ( keys %{$lines{$section}} ) {
2961       my $l = $lines{$section}{$line};
2962       $l->{section}     = $sectionmap{$section};
2963       $l->{amount}      = sprintf( "%.2f", $l->{amount} );
2964       #$l->{unit_amount} = sprintf( "%.2f", $l->{unit_amount} );
2965       push @lines, $l;
2966     }
2967   }
2968
2969   if($conf->exists('phone_usage_class_summary')) {
2970       # this only works with Latex
2971       my @newlines;
2972       my @newsections;
2973
2974       # after this, we'll have only two sections per DID:
2975       # Calls Summary and Calls Detail
2976       foreach my $section ( @sections ) {
2977         if($section->{'post_total'}) {
2978             $section->{'description'} = 'Calls Summary: '.$section->{'phonenum'};
2979             $section->{'total_line_generator'} = sub { '' };
2980             $section->{'total_generator'} = sub { '' };
2981             $section->{'header_generator'} = sub { '' };
2982             $section->{'description_generator'} = '';
2983             push @newsections, $section;
2984             my %calls_detail = %$section;
2985             $calls_detail{'post_total'} = '';
2986             $calls_detail{'sort_weight'} = '';
2987             $calls_detail{'description_generator'} = sub { '' };
2988             $calls_detail{'header_generator'} = sub {
2989                 return ' & Date/Time & Called Number & Duration & Price'
2990                     if $format eq 'latex';
2991                 '';
2992             };
2993             $calls_detail{'description'} = 'Calls Detail: '
2994                                                     . $section->{'phonenum'};
2995             push @newsections, \%calls_detail;
2996         }
2997       }
2998
2999       # after this, each usage class is collapsed/summarized into a single
3000       # line under the Calls Summary section
3001       foreach my $newsection ( @newsections ) {
3002         if($newsection->{'post_total'}) { # this means Calls Summary
3003             foreach my $section ( @sections ) {
3004                 next unless ($section->{'phonenum'} eq $newsection->{'phonenum'}
3005                                 && !$section->{'post_total'});
3006                 my $newdesc = $section->{'description'};
3007                 my $tn = $section->{'phonenum'};
3008                 $newdesc =~ s/$tn//g;
3009                 my $line = {  ext_description => [],
3010                               pkgnum => '',
3011                               ref => '',
3012                               quantity => '',
3013                               calls => $section->{'calls'},
3014                               section => $newsection,
3015                               duration => $section->{'duration'},
3016                               description => $newdesc,
3017                               amount => sprintf("%.2f",$section->{'amount'}),
3018                               product_code => 'N/A',
3019                             };
3020                 push @newlines, $line;
3021             }
3022         }
3023       }
3024
3025       # after this, Calls Details is populated with all CDRs
3026       foreach my $newsection ( @newsections ) {
3027         if(!$newsection->{'post_total'}) { # this means Calls Details
3028             foreach my $line ( @lines ) {
3029                 next unless (scalar(@{$line->{'ext_description'}}) &&
3030                         $line->{'section'}->{'phonenum'} eq $newsection->{'phonenum'}
3031                             );
3032                 my @extdesc = @{$line->{'ext_description'}};
3033                 my @newextdesc;
3034                 foreach my $extdesc ( @extdesc ) {
3035                     $extdesc =~ s/scriptsize/normalsize/g if $format eq 'latex';
3036                     push @newextdesc, $extdesc;
3037                 }
3038                 $line->{'ext_description'} = \@newextdesc;
3039                 $line->{'section'} = $newsection;
3040                 push @newlines, $line;
3041             }
3042         }
3043       }
3044
3045       return(\@newsections, \@newlines);
3046   }
3047
3048   return(\@sections, \@lines);
3049
3050 }
3051
3052 sub _items_previous {
3053   my $self = shift;
3054   my $conf = $self->conf;
3055   my $cust_main = $self->cust_main;
3056   my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
3057   my @b = ();
3058   foreach ( @pr_cust_bill ) {
3059     my $date = $conf->exists('invoice_show_prior_due_date')
3060                ? 'due '. $_->due_date2str($date_format)
3061                : time2str($date_format, $_->_date);
3062     push @b, {
3063       'description' => $self->mt('Previous Balance, Invoice #'). $_->invnum. " ($date)",
3064       #'pkgpart'     => 'N/A',
3065       'pkgnum'      => 'N/A',
3066       'amount'      => sprintf("%.2f", $_->owed),
3067     };
3068   }
3069   @b;
3070
3071   #{
3072   #    'description'     => 'Previous Balance',
3073   #    #'pkgpart'         => 'N/A',
3074   #    'pkgnum'          => 'N/A',
3075   #    'amount'          => sprintf("%10.2f", $pr_total ),
3076   #    'ext_description' => [ map {
3077   #                                 "Invoice ". $_->invnum.
3078   #                                 " (". time2str("%x",$_->_date). ") ".
3079   #                                 sprintf("%10.2f", $_->owed)
3080   #                         } @pr_cust_bill ],
3081
3082   #};
3083 }
3084
3085 sub _items_credits {
3086   my( $self, %opt ) = @_;
3087   my $trim_len = $opt{'trim_len'} || 60;
3088
3089   my @b;
3090   #credits
3091   foreach ( $self->cust_credited ) {
3092
3093     #something more elaborate if $_->amount ne $_->cust_credit->credited ?
3094
3095     my $reason = substr($_->cust_credit->reason, 0, $trim_len);
3096     $reason .= '...' if length($reason) < length($_->cust_credit->reason);
3097     $reason = " ($reason) " if $reason;
3098
3099     push @b, {
3100       #'description' => 'Credit ref\#'. $_->crednum.
3101       #                 " (". time2str("%x",$_->cust_credit->_date) .")".
3102       #                 $reason,
3103       'description' => $self->mt('Credit applied').' '.
3104                        time2str($date_format,$_->cust_credit->_date). $reason,
3105       'amount'      => sprintf("%.2f",$_->amount),
3106     };
3107   }
3108
3109   @b;
3110
3111 }
3112
3113 sub _items_payments {
3114   my $self = shift;
3115
3116   my @b;
3117   #get & print payments
3118   foreach ( $self->cust_bill_pay ) {
3119
3120     #something more elaborate if $_->amount ne ->cust_pay->paid ?
3121
3122     push @b, {
3123       'description' => $self->mt('Payment received').' '.
3124                        time2str($date_format,$_->cust_pay->_date ),
3125       'amount'      => sprintf("%.2f", $_->amount )
3126     };
3127   }
3128
3129   @b;
3130
3131 }
3132
3133 =item call_details [ OPTION => VALUE ... ]
3134
3135 Returns an array of CSV strings representing the call details for this invoice
3136 The only option available is the boolean prepend_billed_number
3137
3138 =cut
3139
3140 sub call_details {
3141   my ($self, %opt) = @_;
3142
3143   my $format_function = sub { shift };
3144
3145   if ($opt{prepend_billed_number}) {
3146     $format_function = sub {
3147       my $detail = shift;
3148       my $row = shift;
3149
3150       $row->amount ? $row->phonenum. ",". $detail : '"Billed number",'. $detail;
3151
3152     };
3153   }
3154
3155   my @details = map { $_->details( 'format_function' => $format_function,
3156                                    'escape_function' => sub{ return() },
3157                                  )
3158                     }
3159                   grep { $_->pkgnum }
3160                   $self->cust_bill_pkg;
3161   my $header = $details[0];
3162   ( $header, grep { $_ ne $header } @details );
3163 }
3164
3165
3166 =back
3167
3168 =head1 SUBROUTINES
3169
3170 =over 4
3171
3172 =item process_reprint
3173
3174 =cut
3175
3176 sub process_reprint {
3177   process_re_X('print', @_);
3178 }
3179
3180 =item process_reemail
3181
3182 =cut
3183
3184 sub process_reemail {
3185   process_re_X('email', @_);
3186 }
3187
3188 =item process_refax
3189
3190 =cut
3191
3192 sub process_refax {
3193   process_re_X('fax', @_);
3194 }
3195
3196 =item process_reftp
3197
3198 =cut
3199
3200 sub process_reftp {
3201   process_re_X('ftp', @_);
3202 }
3203
3204 =item respool
3205
3206 =cut
3207
3208 sub process_respool {
3209   process_re_X('spool', @_);
3210 }
3211
3212 use Storable qw(thaw);
3213 use Data::Dumper;
3214 use MIME::Base64;
3215 sub process_re_X {
3216   my( $method, $job ) = ( shift, shift );
3217   warn "$me process_re_X $method for job $job\n" if $DEBUG;
3218
3219   my $param = thaw(decode_base64(shift));
3220   warn Dumper($param) if $DEBUG;
3221
3222   re_X(
3223     $method,
3224     $job,
3225     %$param,
3226   );
3227
3228 }
3229
3230 sub re_X {
3231   # spool_invoice ftp_invoice fax_invoice print_invoice
3232   my($method, $job, %param ) = @_;
3233   if ( $DEBUG ) {
3234     warn "re_X $method for job $job with param:\n".
3235          join( '', map { "  $_ => ". $param{$_}. "\n" } keys %param );
3236   }
3237
3238   #some false laziness w/search/cust_bill.html
3239   my $distinct = '';
3240   my $orderby = 'ORDER BY cust_bill._date';
3241
3242   my $extra_sql = ' WHERE '. FS::cust_bill->search_sql_where(\%param);
3243
3244   my $addl_from = 'LEFT JOIN cust_main USING ( custnum )';
3245
3246   my @cust_bill = qsearch( {
3247     #'select'    => "cust_bill.*",
3248     'table'     => 'cust_bill',
3249     'addl_from' => $addl_from,
3250     'hashref'   => {},
3251     'extra_sql' => $extra_sql,
3252     'order_by'  => $orderby,
3253     'debug' => 1,
3254   } );
3255
3256   $method .= '_invoice' unless $method eq 'email' || $method eq 'print';
3257
3258   warn " $me re_X $method: ". scalar(@cust_bill). " invoices found\n"
3259     if $DEBUG;
3260
3261   my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
3262   foreach my $cust_bill ( @cust_bill ) {
3263     $cust_bill->$method();
3264
3265     if ( $job ) { #progressbar foo
3266       $num++;
3267       if ( time - $min_sec > $last ) {
3268         my $error = $job->update_statustext(
3269           int( 100 * $num / scalar(@cust_bill) )
3270         );
3271         die $error if $error;
3272         $last = time;
3273       }
3274     }
3275
3276   }
3277
3278 }
3279
3280 =back
3281
3282 =head1 CLASS METHODS
3283
3284 =over 4
3285
3286 =item owed_sql
3287
3288 Returns an SQL fragment to retreive the amount owed (charged minus credited and paid).
3289
3290 =cut
3291
3292 sub owed_sql {
3293   my ($class, $start, $end) = @_;
3294   'charged - '.
3295     $class->paid_sql($start, $end). ' - '.
3296     $class->credited_sql($start, $end);
3297 }
3298
3299 =item net_sql
3300
3301 Returns an SQL fragment to retreive the net amount (charged minus credited).
3302
3303 =cut
3304
3305 sub net_sql {
3306   my ($class, $start, $end) = @_;
3307   'charged - '. $class->credited_sql($start, $end);
3308 }
3309
3310 =item paid_sql
3311
3312 Returns an SQL fragment to retreive the amount paid against this invoice.
3313
3314 =cut
3315
3316 sub paid_sql {
3317   my ($class, $start, $end) = @_;
3318   $start &&= "AND cust_bill_pay._date <= $start";
3319   $end   &&= "AND cust_bill_pay._date > $end";
3320   $start = '' unless defined($start);
3321   $end   = '' unless defined($end);
3322   "( SELECT COALESCE(SUM(amount),0) FROM cust_bill_pay
3323        WHERE cust_bill.invnum = cust_bill_pay.invnum $start $end  )";
3324 }
3325
3326 =item credited_sql
3327
3328 Returns an SQL fragment to retreive the amount credited against this invoice.
3329
3330 =cut
3331
3332 sub credited_sql {
3333   my ($class, $start, $end) = @_;
3334   $start &&= "AND cust_credit_bill._date <= $start";
3335   $end   &&= "AND cust_credit_bill._date >  $end";
3336   $start = '' unless defined($start);
3337   $end   = '' unless defined($end);
3338   "( SELECT COALESCE(SUM(amount),0) FROM cust_credit_bill
3339        WHERE cust_bill.invnum = cust_credit_bill.invnum $start $end  )";
3340 }
3341
3342 =item due_date_sql
3343
3344 Returns an SQL fragment to retrieve the due date of an invoice.
3345 Currently only supported on PostgreSQL.
3346
3347 =cut
3348
3349 sub due_date_sql {
3350   my $conf = new FS::Conf;
3351 'COALESCE(
3352   SUBSTRING(
3353     COALESCE(
3354       cust_bill.invoice_terms,
3355       cust_main.invoice_terms,
3356       \''.($conf->config('invoice_default_terms') || '').'\'
3357     ), E\'Net (\\\\d+)\'
3358   )::INTEGER, 0
3359 ) * 86400 + cust_bill._date'
3360 }
3361
3362 =item search_sql_where HASHREF
3363
3364 Class method which returns an SQL WHERE fragment to search for parameters
3365 specified in HASHREF.  Valid parameters are
3366
3367 =over 4
3368
3369 =item _date
3370
3371 List reference of start date, end date, as UNIX timestamps.
3372
3373 =item invnum_min
3374
3375 =item invnum_max
3376
3377 =item agentnum
3378
3379 =item charged
3380
3381 List reference of charged limits (exclusive).
3382
3383 =item owed
3384
3385 List reference of charged limits (exclusive).
3386
3387 =item open
3388
3389 flag, return open invoices only
3390
3391 =item net
3392
3393 flag, return net invoices only
3394
3395 =item days
3396
3397 =item newest_percust
3398
3399 =back
3400
3401 Note: validates all passed-in data; i.e. safe to use with unchecked CGI params.
3402
3403 =cut
3404
3405 sub search_sql_where {
3406   my($class, $param) = @_;
3407   if ( $DEBUG ) {
3408     warn "$me search_sql_where called with params: \n".
3409          join("\n", map { "  $_: ". $param->{$_} } keys %$param ). "\n";
3410   }
3411
3412   my @search = ();
3413
3414   #agentnum
3415   if ( $param->{'agentnum'} =~ /^(\d+)$/ ) {
3416     push @search, "cust_main.agentnum = $1";
3417   }
3418
3419   #refnum
3420   if ( $param->{'refnum'} =~ /^(\d+)$/ ) {
3421     push @search, "cust_main.refnum = $1";
3422   }
3423
3424   #custnum
3425   if ( $param->{'custnum'} =~ /^(\d+)$/ ) {
3426     push @search, "cust_bill.custnum = $1";
3427   }
3428
3429   #_date
3430   if ( $param->{_date} ) {
3431     my($beginning, $ending) = @{$param->{_date}};
3432
3433     push @search, "cust_bill._date >= $beginning",
3434                   "cust_bill._date <  $ending";
3435   }
3436
3437   #invnum
3438   if ( $param->{'invnum_min'} =~ /^(\d+)$/ ) {
3439     push @search, "cust_bill.invnum >= $1";
3440   }
3441   if ( $param->{'invnum_max'} =~ /^(\d+)$/ ) {
3442     push @search, "cust_bill.invnum <= $1";
3443   }
3444
3445   #charged
3446   if ( $param->{charged} ) {
3447     my @charged = ref($param->{charged})
3448                     ? @{ $param->{charged} }
3449                     : ($param->{charged});
3450
3451     push @search, map { s/^charged/cust_bill.charged/; $_; }
3452                       @charged;
3453   }
3454
3455   my $owed_sql = FS::cust_bill->owed_sql;
3456
3457   #owed
3458   if ( $param->{owed} ) {
3459     my @owed = ref($param->{owed})
3460                  ? @{ $param->{owed} }
3461                  : ($param->{owed});
3462     push @search, map { s/^owed/$owed_sql/; $_; }
3463                       @owed;
3464   }
3465
3466   #open/net flags
3467   push @search, "0 != $owed_sql"
3468     if $param->{'open'};
3469   push @search, '0 != '. FS::cust_bill->net_sql
3470     if $param->{'net'};
3471
3472   #days
3473   push @search, "cust_bill._date < ". (time-86400*$param->{'days'})
3474     if $param->{'days'};
3475
3476   #newest_percust
3477   if ( $param->{'newest_percust'} ) {
3478
3479     #$distinct = 'DISTINCT ON ( cust_bill.custnum )';
3480     #$orderby = 'ORDER BY cust_bill.custnum ASC, cust_bill._date DESC';
3481
3482     my @newest_where = map { my $x = $_;
3483                              $x =~ s/\bcust_bill\./newest_cust_bill./g;
3484                              $x;
3485                            }
3486                            grep ! /^cust_main./, @search;
3487     my $newest_where = scalar(@newest_where)
3488                          ? ' AND '. join(' AND ', @newest_where)
3489                          : '';
3490
3491
3492     push @search, "cust_bill._date = (
3493       SELECT(MAX(newest_cust_bill._date)) FROM cust_bill AS newest_cust_bill
3494         WHERE newest_cust_bill.custnum = cust_bill.custnum
3495           $newest_where
3496     )";
3497
3498   }
3499
3500   #promised_date - also has an option to accept nulls
3501   if ( $param->{promised_date} ) {
3502     my($beginning, $ending, $null) = @{$param->{promised_date}};
3503
3504     push @search, "(( cust_bill.promised_date >= $beginning AND ".
3505                     "cust_bill.promised_date <  $ending )" .
3506                     ($null ? ' OR cust_bill.promised_date IS NULL ) ' : ')');
3507   }
3508
3509   #agent virtualization
3510   my $curuser = $FS::CurrentUser::CurrentUser;
3511   if ( $curuser->username eq 'fs_queue'
3512        && $param->{'CurrentUser'} =~ /^(\w+)$/ ) {
3513     my $username = $1;
3514     my $newuser = qsearchs('access_user', {
3515       'username' => $username,
3516       'disabled' => '',
3517     } );
3518     if ( $newuser ) {
3519       $curuser = $newuser;
3520     } else {
3521       warn "$me WARNING: (fs_queue) can't find CurrentUser $username\n";
3522     }
3523   }
3524   push @search, $curuser->agentnums_sql;
3525
3526   join(' AND ', @search );
3527
3528 }
3529
3530 =back
3531
3532 =head1 BUGS
3533
3534 The delete method.
3535
3536 =head1 SEE ALSO
3537
3538 L<FS::Record>, L<FS::cust_main>, L<FS::cust_bill_pay>, L<FS::cust_pay>,
3539 L<FS::cust_bill_pkg>, L<FS::cust_bill_credit>, schema.html from the base
3540 documentation.
3541
3542 =cut
3543
3544 1;
3545