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 $svc_x = $cust_svc->svc_x or
2253             warn "missing svc_x record for svc#".$cust_svc->svcnum."\n";
2254           push @details, sprintf('01%-9s%-20s%-47s',
2255             $cust_svc->svcnum,
2256             $svc_class{$svcpart},
2257             ($svc_x ? $svc_x->label : ''),
2258           );
2259         } #foreach $cust_svc
2260       } #if $cust_pkg
2261
2262       my $desc = $cust_bill_pkg->desc; # itemdesc or part_pkg.pkg
2263       if ($cust_bill_pkg->recur > 0) {
2264         $desc .= ' '.time2str('%d-%b-%Y', $cust_bill_pkg->sdate).' to '.
2265                      time2str('%d-%b-%Y', $cust_bill_pkg->edate - 86400);
2266       }
2267       push @details, sprintf('02%-6s%-60s%-10s',
2268         $show_pkgnum,
2269         $desc,
2270         sprintf('%0.2f', $cust_bill_pkg->setup + $cust_bill_pkg->recur),
2271       );
2272     } #foreach $cust_bill_pkg
2273
2274     # Tag this row so that we know whether this is one page (1), two pages
2275     # (2), # or "big" (B).  The tag will be stripped off before uploading.
2276     if ( scalar(@details) < 12 ) {
2277       push @details, '1';
2278     } elsif ( scalar(@details) < 58 ) {
2279       push @details, '2';
2280     } else {
2281       push @details, 'B';
2282     }
2283
2284     return join('', $header, @details, "\n");
2285
2286   } else { # default
2287
2288     $csv->combine(
2289       'cust_bill',
2290       $self->invnum,
2291       $self->custnum,
2292       time2str("%x", $self->_date),
2293       sprintf("%.2f", $self->charged),
2294       ( map { $cust_main->getfield($_) }
2295           qw( first last company address1 address2 city state zip country ) ),
2296       map { '' } (1..5),
2297     ) or die "can't create csv";
2298   }
2299
2300   my $header = $csv->string. "\n";
2301
2302   my $detail = '';
2303   if ( lc($opt{'format'}) eq 'billco' ) {
2304
2305     my $lineseq = 0;
2306     foreach my $item ( $self->_items_pkg ) {
2307
2308       $csv->combine(
2309         '',                     #  1 | N/A-Leave Empty            CHAR   2
2310         '',                     #  2 | N/A-Leave Empty            CHAR  15
2311         $opt{'tracctnum'},      #  3 | Account Number             CHAR  15
2312         $self->invnum,          #  4 | Invoice Number             CHAR  15
2313         $lineseq++,             #  5 | Line Sequence (sort order) NUM    6
2314         $item->{'description'}, #  6 | Transaction Detail         CHAR 100
2315         $item->{'amount'},      #  7 | Amount                     NUM*   9
2316         '',                     #  8 | Line Format Control**      CHAR   2
2317         '',                     #  9 | Grouping Code              CHAR   2
2318         '',                     # 10 | User Defined               CHAR  15
2319       );
2320
2321       $detail .= $csv->string. "\n";
2322
2323     }
2324
2325   } elsif ( lc($opt{'format'}) eq 'oneline' ) {
2326
2327     #do nothing
2328
2329   } else {
2330
2331     foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2332
2333       my($pkg, $setup, $recur, $sdate, $edate);
2334       if ( $cust_bill_pkg->pkgnum ) {
2335
2336         ($pkg, $setup, $recur, $sdate, $edate) = (
2337           $cust_bill_pkg->part_pkg->pkg,
2338           ( $cust_bill_pkg->setup != 0
2339             ? sprintf("%.2f", $cust_bill_pkg->setup )
2340             : '' ),
2341           ( $cust_bill_pkg->recur != 0
2342             ? sprintf("%.2f", $cust_bill_pkg->recur )
2343             : '' ),
2344           ( $cust_bill_pkg->sdate
2345             ? time2str("%x", $cust_bill_pkg->sdate)
2346             : '' ),
2347           ($cust_bill_pkg->edate
2348             ?time2str("%x", $cust_bill_pkg->edate)
2349             : '' ),
2350         );
2351
2352       } else { #pkgnum tax
2353         next unless $cust_bill_pkg->setup != 0;
2354         $pkg = $cust_bill_pkg->desc;
2355         $setup = sprintf('%10.2f', $cust_bill_pkg->setup );
2356         ( $sdate, $edate ) = ( '', '' );
2357       }
2358
2359       $csv->combine(
2360         'cust_bill_pkg',
2361         $self->invnum,
2362         ( map { '' } (1..11) ),
2363         ($pkg, $setup, $recur, $sdate, $edate)
2364       ) or die "can't create csv";
2365
2366       $detail .= $csv->string. "\n";
2367
2368     }
2369
2370   }
2371
2372   ( $header, $detail );
2373
2374 }
2375
2376 =item comp
2377
2378 Pays this invoice with a compliemntary payment.  If there is an error,
2379 returns the error, otherwise returns false.
2380
2381 =cut
2382
2383 sub comp {
2384   my $self = shift;
2385   my $cust_pay = new FS::cust_pay ( {
2386     'invnum'   => $self->invnum,
2387     'paid'     => $self->owed,
2388     '_date'    => '',
2389     'payby'    => 'COMP',
2390     'payinfo'  => $self->cust_main->payinfo,
2391     'paybatch' => '',
2392   } );
2393   $cust_pay->insert;
2394 }
2395
2396 =item realtime_card
2397
2398 Attempts to pay this invoice with a credit card payment via a
2399 Business::OnlinePayment realtime gateway.  See
2400 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2401 for supported processors.
2402
2403 =cut
2404
2405 sub realtime_card {
2406   my $self = shift;
2407   $self->realtime_bop( 'CC', @_ );
2408 }
2409
2410 =item realtime_ach
2411
2412 Attempts to pay this invoice with an electronic check (ACH) payment via a
2413 Business::OnlinePayment realtime gateway.  See
2414 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2415 for supported processors.
2416
2417 =cut
2418
2419 sub realtime_ach {
2420   my $self = shift;
2421   $self->realtime_bop( 'ECHECK', @_ );
2422 }
2423
2424 =item realtime_lec
2425
2426 Attempts to pay this invoice with phone bill (LEC) payment via a
2427 Business::OnlinePayment realtime gateway.  See
2428 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2429 for supported processors.
2430
2431 =cut
2432
2433 sub realtime_lec {
2434   my $self = shift;
2435   $self->realtime_bop( 'LEC', @_ );
2436 }
2437
2438 sub realtime_bop {
2439   my( $self, $method ) = (shift,shift);
2440   my $conf = $self->conf;
2441   my %opt = @_;
2442
2443   my $cust_main = $self->cust_main;
2444   my $balance = $cust_main->balance;
2445   my $amount = ( $balance < $self->owed ) ? $balance : $self->owed;
2446   $amount = sprintf("%.2f", $amount);
2447   return "not run (balance $balance)" unless $amount > 0;
2448
2449   my $description = 'Internet Services';
2450   if ( $conf->exists('business-onlinepayment-description') ) {
2451     my $dtempl = $conf->config('business-onlinepayment-description');
2452
2453     my $agent_obj = $cust_main->agent
2454       or die "can't retreive agent for $cust_main (agentnum ".
2455              $cust_main->agentnum. ")";
2456     my $agent = $agent_obj->agent;
2457     my $pkgs = join(', ',
2458       map { $_->part_pkg->pkg }
2459         grep { $_->pkgnum } $self->cust_bill_pkg
2460     );
2461     $description = eval qq("$dtempl");
2462   }
2463
2464   $cust_main->realtime_bop($method, $amount,
2465     'description' => $description,
2466     'invnum'      => $self->invnum,
2467 #this didn't do what we want, it just calls apply_payments_and_credits
2468 #    'apply'       => 1,
2469     'apply_to_invoice' => 1,
2470     %opt,
2471  #what we want:
2472  #this changes application behavior: auto payments
2473                         #triggered against a specific invoice are now applied
2474                         #to that invoice instead of oldest open.
2475                         #seem okay to me...
2476   );
2477
2478 }
2479
2480 =item batch_card OPTION => VALUE...
2481
2482 Adds a payment for this invoice to the pending credit card batch (see
2483 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2484 runs the payment using a realtime gateway.
2485
2486 =cut
2487
2488 sub batch_card {
2489   my ($self, %options) = @_;
2490   my $cust_main = $self->cust_main;
2491
2492   $options{invnum} = $self->invnum;
2493
2494   $cust_main->batch_card(%options);
2495 }
2496
2497 sub _agent_template {
2498   my $self = shift;
2499   $self->cust_main->agent_template;
2500 }
2501
2502 sub _agent_invoice_from {
2503   my $self = shift;
2504   $self->cust_main->agent_invoice_from;
2505 }
2506
2507 =item invoice_barcode DIR_OR_FALSE
2508
2509 Generates an invoice barcode PNG. If DIR_OR_FALSE is a true value,
2510 it is taken as the temp directory where the PNG file will be generated and the
2511 PNG file name is returned. Otherwise, the PNG image itself is returned.
2512
2513 =cut
2514
2515 sub invoice_barcode {
2516     my ($self, $dir) = (shift,shift);
2517
2518     my $gdbar = new GD::Barcode('Code39',$self->invnum);
2519         die "can't create barcode: " . $GD::Barcode::errStr unless $gdbar;
2520     my $gd = $gdbar->plot(Height => 30);
2521
2522     if($dir) {
2523         my $bh = new File::Temp( TEMPLATE => 'barcode.'. $self->invnum. '.XXXXXXXX',
2524                            DIR      => $dir,
2525                            SUFFIX   => '.png',
2526                            UNLINK   => 0,
2527                          ) or die "can't open temp file: $!\n";
2528         print $bh $gd->png or die "cannot write barcode to file: $!\n";
2529         my $png_file = $bh->filename;
2530         close $bh;
2531         return $png_file;
2532     }
2533     return $gd->png;
2534 }
2535
2536 =item invnum_date_pretty
2537
2538 Returns a string with the invoice number and date, for example:
2539 "Invoice #54 (3/20/2008)"
2540
2541 =cut
2542
2543 sub invnum_date_pretty {
2544   my $self = shift;
2545   $self->mt('Invoice #'). $self->invnum. ' ('. $self->_date_pretty. ')';
2546 }
2547
2548 #sub _items_extra_usage_sections {
2549 #  my $self = shift;
2550 #  my $escape = shift;
2551 #
2552 #  my %sections = ();
2553 #
2554 #  my %usage_class =  map{ $_->classname, $_ } qsearch('usage_class', {});
2555 #  foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
2556 #  {
2557 #    next unless $cust_bill_pkg->pkgnum > 0;
2558 #
2559 #    foreach my $section ( keys %usage_class ) {
2560 #
2561 #      my $usage = $cust_bill_pkg->usage($section);
2562 #
2563 #      next unless $usage && $usage > 0;
2564 #
2565 #      $sections{$section} ||= 0;
2566 #      $sections{$section} += $usage;
2567 #
2568 #    }
2569 #
2570 #  }
2571 #
2572 #  map { { 'description' => &{$escape}($_),
2573 #          'subtotal'    => $sections{$_},
2574 #          'summarized'  => '',
2575 #          'tax_section' => '',
2576 #        }
2577 #      }
2578 #    sort {$usage_class{$a}->weight <=> $usage_class{$b}->weight} keys %sections;
2579 #
2580 #}
2581
2582 sub _items_extra_usage_sections {
2583   my $self = shift;
2584   my $conf = $self->conf;
2585   my $escape = shift;
2586   my $format = shift;
2587
2588   my %sections = ();
2589   my %classnums = ();
2590   my %lines = ();
2591
2592   my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 50;
2593
2594   my %usage_class =  map { $_->classnum => $_ } qsearch( 'usage_class', {} );
2595   foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2596     next unless $cust_bill_pkg->pkgnum > 0;
2597
2598     foreach my $classnum ( keys %usage_class ) {
2599       my $section = $usage_class{$classnum}->classname;
2600       $classnums{$section} = $classnum;
2601
2602       foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail($classnum) ) {
2603         my $amount = $detail->amount;
2604         next unless $amount && $amount > 0;
2605
2606         $sections{$section} ||= { 'subtotal'=>0, 'calls'=>0, 'duration'=>0 };
2607         $sections{$section}{amount} += $amount;  #subtotal
2608         $sections{$section}{calls}++;
2609         $sections{$section}{duration} += $detail->duration;
2610
2611         my $desc = $detail->regionname;
2612         my $description = $desc;
2613         $description = substr($desc, 0, $maxlength). '...'
2614           if $format eq 'latex' && length($desc) > $maxlength;
2615
2616         $lines{$section}{$desc} ||= {
2617           description     => &{$escape}($description),
2618           #pkgpart         => $part_pkg->pkgpart,
2619           pkgnum          => $cust_bill_pkg->pkgnum,
2620           ref             => '',
2621           amount          => 0,
2622           calls           => 0,
2623           duration        => 0,
2624           #unit_amount     => $cust_bill_pkg->unitrecur,
2625           quantity        => $cust_bill_pkg->quantity,
2626           product_code    => 'N/A',
2627           ext_description => [],
2628         };
2629
2630         $lines{$section}{$desc}{amount} += $amount;
2631         $lines{$section}{$desc}{calls}++;
2632         $lines{$section}{$desc}{duration} += $detail->duration;
2633
2634       }
2635     }
2636   }
2637
2638   my %sectionmap = ();
2639   foreach (keys %sections) {
2640     my $usage_class = $usage_class{$classnums{$_}};
2641     $sectionmap{$_} = { 'description' => &{$escape}($_),
2642                         'amount'    => $sections{$_}{amount},    #subtotal
2643                         'calls'       => $sections{$_}{calls},
2644                         'duration'    => $sections{$_}{duration},
2645                         'summarized'  => '',
2646                         'tax_section' => '',
2647                         'sort_weight' => $usage_class->weight,
2648                         ( $usage_class->format
2649                           ? ( map { $_ => $usage_class->$_($format) }
2650                               qw( description_generator header_generator total_generator total_line_generator )
2651                             )
2652                           : ()
2653                         ),
2654                       };
2655   }
2656
2657   my @sections = sort { $a->{sort_weight} <=> $b->{sort_weight} }
2658                  values %sectionmap;
2659
2660   my @lines = ();
2661   foreach my $section ( keys %lines ) {
2662     foreach my $line ( keys %{$lines{$section}} ) {
2663       my $l = $lines{$section}{$line};
2664       $l->{section}     = $sectionmap{$section};
2665       $l->{amount}      = sprintf( "%.2f", $l->{amount} );
2666       #$l->{unit_amount} = sprintf( "%.2f", $l->{unit_amount} );
2667       push @lines, $l;
2668     }
2669   }
2670
2671   return(\@sections, \@lines);
2672
2673 }
2674
2675 sub _did_summary {
2676     my $self = shift;
2677     my $end = $self->_date;
2678
2679     # start at date of previous invoice + 1 second or 0 if no previous invoice
2680     my $start = $self->scalar_sql("SELECT max(_date) FROM cust_bill WHERE custnum = ? and invnum != ?",$self->custnum,$self->invnum);
2681     $start = 0 if !$start;
2682     $start++;
2683
2684     my $cust_main = $self->cust_main;
2685     my @pkgs = $cust_main->all_pkgs;
2686     my($num_activated,$num_deactivated,$num_portedin,$num_portedout,$minutes)
2687         = (0,0,0,0,0);
2688     my @seen = ();
2689     foreach my $pkg ( @pkgs ) {
2690         my @h_cust_svc = $pkg->h_cust_svc($end);
2691         foreach my $h_cust_svc ( @h_cust_svc ) {
2692             next if grep {$_ eq $h_cust_svc->svcnum} @seen;
2693             next unless $h_cust_svc->part_svc->svcdb eq 'svc_phone';
2694
2695             my $inserted = $h_cust_svc->date_inserted;
2696             my $deleted = $h_cust_svc->date_deleted;
2697             my $phone_inserted = $h_cust_svc->h_svc_x($inserted+5);
2698             my $phone_deleted;
2699             $phone_deleted =  $h_cust_svc->h_svc_x($deleted) if $deleted;
2700
2701 # DID either activated or ported in; cannot be both for same DID simultaneously
2702             if ($inserted >= $start && $inserted <= $end && $phone_inserted
2703                 && (!$phone_inserted->lnp_status
2704                     || $phone_inserted->lnp_status eq ''
2705                     || $phone_inserted->lnp_status eq 'native')) {
2706                 $num_activated++;
2707             }
2708             else { # this one not so clean, should probably move to (h_)svc_phone
2709                  my $phone_portedin = qsearchs( 'h_svc_phone',
2710                       { 'svcnum' => $h_cust_svc->svcnum,
2711                         'lnp_status' => 'portedin' },
2712                       FS::h_svc_phone->sql_h_searchs($end),
2713                     );
2714                  $num_portedin++ if $phone_portedin;
2715             }
2716
2717 # DID either deactivated or ported out; cannot be both for same DID simultaneously
2718             if($deleted >= $start && $deleted <= $end && $phone_deleted
2719                 && (!$phone_deleted->lnp_status
2720                     || $phone_deleted->lnp_status ne 'portingout')) {
2721                 $num_deactivated++;
2722             }
2723             elsif($deleted >= $start && $deleted <= $end && $phone_deleted
2724                 && $phone_deleted->lnp_status
2725                 && $phone_deleted->lnp_status eq 'portingout') {
2726                 $num_portedout++;
2727             }
2728
2729             # increment usage minutes
2730         if ( $phone_inserted ) {
2731             my @cdrs = $phone_inserted->get_cdrs('begin'=>$start,'end'=>$end,'billsec_sum'=>1);
2732             $minutes = $cdrs[0]->billsec_sum if scalar(@cdrs) == 1;
2733         }
2734         else {
2735             warn "WARNING: no matching h_svc_phone insert record for insert time $inserted, svcnum " . $h_cust_svc->svcnum;
2736         }
2737
2738             # don't look at this service again
2739             push @seen, $h_cust_svc->svcnum;
2740         }
2741     }
2742
2743     $minutes = sprintf("%d", $minutes);
2744     ("Activated: $num_activated  Ported-In: $num_portedin  Deactivated: "
2745         . "$num_deactivated  Ported-Out: $num_portedout ",
2746             "Total Minutes: $minutes");
2747 }
2748
2749 sub _items_accountcode_cdr {
2750     my $self = shift;
2751     my $escape = shift;
2752     my $format = shift;
2753
2754     my $section = { 'amount'        => 0,
2755                     'calls'         => 0,
2756                     'duration'      => 0,
2757                     'sort_weight'   => '',
2758                     'phonenum'      => '',
2759                     'description'   => 'Usage by Account Code',
2760                     'post_total'    => '',
2761                     'summarized'    => '',
2762                     'header'        => '',
2763                   };
2764     my @lines;
2765     my %accountcodes = ();
2766
2767     foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2768         next unless $cust_bill_pkg->pkgnum > 0;
2769
2770         my @header = $cust_bill_pkg->details_header;
2771         next unless scalar(@header);
2772         $section->{'header'} = join(',',@header);
2773
2774         foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail ) {
2775
2776             $section->{'header'} = $detail->formatted('format' => $format)
2777                 if($detail->detail eq $section->{'header'});
2778
2779             my $accountcode = $detail->accountcode;
2780             next unless $accountcode;
2781
2782             my $amount = $detail->amount;
2783             next unless $amount && $amount > 0;
2784
2785             $accountcodes{$accountcode} ||= {
2786                     description => $accountcode,
2787                     pkgnum      => '',
2788                     ref         => '',
2789                     amount      => 0,
2790                     calls       => 0,
2791                     duration    => 0,
2792                     quantity    => '',
2793                     product_code => 'N/A',
2794                     section     => $section,
2795                     ext_description => [ $section->{'header'} ],
2796                     detail_temp => [],
2797             };
2798
2799             $section->{'amount'} += $amount;
2800             $accountcodes{$accountcode}{'amount'} += $amount;
2801             $accountcodes{$accountcode}{calls}++;
2802             $accountcodes{$accountcode}{duration} += $detail->duration;
2803             push @{$accountcodes{$accountcode}{detail_temp}}, $detail;
2804         }
2805     }
2806
2807     foreach my $l ( values %accountcodes ) {
2808         $l->{amount} = sprintf( "%.2f", $l->{amount} );
2809         my @sorted_detail = sort { $a->startdate <=> $b->startdate } @{$l->{detail_temp}};
2810         foreach my $sorted_detail ( @sorted_detail ) {
2811             push @{$l->{ext_description}}, $sorted_detail->formatted('format'=>$format);
2812         }
2813         delete $l->{detail_temp};
2814         push @lines, $l;
2815     }
2816
2817     my @sorted_lines = sort { $a->{'description'} <=> $b->{'description'} } @lines;
2818
2819     return ($section,\@sorted_lines);
2820 }
2821
2822 sub _items_svc_phone_sections {
2823   my $self = shift;
2824   my $conf = $self->conf;
2825   my $escape = shift;
2826   my $format = shift;
2827
2828   my %sections = ();
2829   my %classnums = ();
2830   my %lines = ();
2831
2832   my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 50;
2833
2834   my %usage_class =  map { $_->classnum => $_ } qsearch( 'usage_class', {} );
2835   $usage_class{''} ||= new FS::usage_class { 'classname' => '', 'weight' => 0 };
2836
2837   foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2838     next unless $cust_bill_pkg->pkgnum > 0;
2839
2840     my @header = $cust_bill_pkg->details_header;
2841     next unless scalar(@header);
2842
2843     foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail ) {
2844
2845       my $phonenum = $detail->phonenum;
2846       next unless $phonenum;
2847
2848       my $amount = $detail->amount;
2849       next unless $amount && $amount > 0;
2850
2851       $sections{$phonenum} ||= { 'amount'      => 0,
2852                                  'calls'       => 0,
2853                                  'duration'    => 0,
2854                                  'sort_weight' => -1,
2855                                  'phonenum'    => $phonenum,
2856                                 };
2857       $sections{$phonenum}{amount} += $amount;  #subtotal
2858       $sections{$phonenum}{calls}++;
2859       $sections{$phonenum}{duration} += $detail->duration;
2860
2861       my $desc = $detail->regionname;
2862       my $description = $desc;
2863       $description = substr($desc, 0, $maxlength). '...'
2864         if $format eq 'latex' && length($desc) > $maxlength;
2865
2866       $lines{$phonenum}{$desc} ||= {
2867         description     => &{$escape}($description),
2868         #pkgpart         => $part_pkg->pkgpart,
2869         pkgnum          => '',
2870         ref             => '',
2871         amount          => 0,
2872         calls           => 0,
2873         duration        => 0,
2874         #unit_amount     => '',
2875         quantity        => '',
2876         product_code    => 'N/A',
2877         ext_description => [],
2878       };
2879
2880       $lines{$phonenum}{$desc}{amount} += $amount;
2881       $lines{$phonenum}{$desc}{calls}++;
2882       $lines{$phonenum}{$desc}{duration} += $detail->duration;
2883
2884       my $line = $usage_class{$detail->classnum}->classname;
2885       $sections{"$phonenum $line"} ||=
2886         { 'amount' => 0,
2887           'calls' => 0,
2888           'duration' => 0,
2889           'sort_weight' => $usage_class{$detail->classnum}->weight,
2890           'phonenum' => $phonenum,
2891           'header'  => [ @header ],
2892         };
2893       $sections{"$phonenum $line"}{amount} += $amount;  #subtotal
2894       $sections{"$phonenum $line"}{calls}++;
2895       $sections{"$phonenum $line"}{duration} += $detail->duration;
2896
2897       $lines{"$phonenum $line"}{$desc} ||= {
2898         description     => &{$escape}($description),
2899         #pkgpart         => $part_pkg->pkgpart,
2900         pkgnum          => '',
2901         ref             => '',
2902         amount          => 0,
2903         calls           => 0,
2904         duration        => 0,
2905         #unit_amount     => '',
2906         quantity        => '',
2907         product_code    => 'N/A',
2908         ext_description => [],
2909       };
2910
2911       $lines{"$phonenum $line"}{$desc}{amount} += $amount;
2912       $lines{"$phonenum $line"}{$desc}{calls}++;
2913       $lines{"$phonenum $line"}{$desc}{duration} += $detail->duration;
2914       push @{$lines{"$phonenum $line"}{$desc}{ext_description}},
2915            $detail->formatted('format' => $format);
2916
2917     }
2918   }
2919
2920   my %sectionmap = ();
2921   my $simple = new FS::usage_class { format => 'simple' }; #bleh
2922   foreach ( keys %sections ) {
2923     my @header = @{ $sections{$_}{header} || [] };
2924     my $usage_simple =
2925       new FS::usage_class { format => 'usage_'. (scalar(@header) || 6). 'col' };
2926     my $summary = $sections{$_}{sort_weight} < 0 ? 1 : 0;
2927     my $usage_class = $summary ? $simple : $usage_simple;
2928     my $ending = $summary ? ' usage charges' : '';
2929     my %gen_opt = ();
2930     unless ($summary) {
2931       $gen_opt{label} = [ map{ &{$escape}($_) } @header ];
2932     }
2933     $sectionmap{$_} = { 'description' => &{$escape}($_. $ending),
2934                         'amount'    => $sections{$_}{amount},    #subtotal
2935                         'calls'       => $sections{$_}{calls},
2936                         'duration'    => $sections{$_}{duration},
2937                         'summarized'  => '',
2938                         'tax_section' => '',
2939                         'phonenum'    => $sections{$_}{phonenum},
2940                         'sort_weight' => $sections{$_}{sort_weight},
2941                         'post_total'  => $summary, #inspire pagebreak
2942                         (
2943                           ( map { $_ => $usage_class->$_($format, %gen_opt) }
2944                             qw( description_generator
2945                                 header_generator
2946                                 total_generator
2947                                 total_line_generator
2948                               )
2949                           )
2950                         ),
2951                       };
2952   }
2953
2954   my @sections = sort { $a->{phonenum} cmp $b->{phonenum} ||
2955                         $a->{sort_weight} <=> $b->{sort_weight}
2956                       }
2957                  values %sectionmap;
2958
2959   my @lines = ();
2960   foreach my $section ( keys %lines ) {
2961     foreach my $line ( keys %{$lines{$section}} ) {
2962       my $l = $lines{$section}{$line};
2963       $l->{section}     = $sectionmap{$section};
2964       $l->{amount}      = sprintf( "%.2f", $l->{amount} );
2965       #$l->{unit_amount} = sprintf( "%.2f", $l->{unit_amount} );
2966       push @lines, $l;
2967     }
2968   }
2969
2970   if($conf->exists('phone_usage_class_summary')) {
2971       # this only works with Latex
2972       my @newlines;
2973       my @newsections;
2974
2975       # after this, we'll have only two sections per DID:
2976       # Calls Summary and Calls Detail
2977       foreach my $section ( @sections ) {
2978         if($section->{'post_total'}) {
2979             $section->{'description'} = 'Calls Summary: '.$section->{'phonenum'};
2980             $section->{'total_line_generator'} = sub { '' };
2981             $section->{'total_generator'} = sub { '' };
2982             $section->{'header_generator'} = sub { '' };
2983             $section->{'description_generator'} = '';
2984             push @newsections, $section;
2985             my %calls_detail = %$section;
2986             $calls_detail{'post_total'} = '';
2987             $calls_detail{'sort_weight'} = '';
2988             $calls_detail{'description_generator'} = sub { '' };
2989             $calls_detail{'header_generator'} = sub {
2990                 return ' & Date/Time & Called Number & Duration & Price'
2991                     if $format eq 'latex';
2992                 '';
2993             };
2994             $calls_detail{'description'} = 'Calls Detail: '
2995                                                     . $section->{'phonenum'};
2996             push @newsections, \%calls_detail;
2997         }
2998       }
2999
3000       # after this, each usage class is collapsed/summarized into a single
3001       # line under the Calls Summary section
3002       foreach my $newsection ( @newsections ) {
3003         if($newsection->{'post_total'}) { # this means Calls Summary
3004             foreach my $section ( @sections ) {
3005                 next unless ($section->{'phonenum'} eq $newsection->{'phonenum'}
3006                                 && !$section->{'post_total'});
3007                 my $newdesc = $section->{'description'};
3008                 my $tn = $section->{'phonenum'};
3009                 $newdesc =~ s/$tn//g;
3010                 my $line = {  ext_description => [],
3011                               pkgnum => '',
3012                               ref => '',
3013                               quantity => '',
3014                               calls => $section->{'calls'},
3015                               section => $newsection,
3016                               duration => $section->{'duration'},
3017                               description => $newdesc,
3018                               amount => sprintf("%.2f",$section->{'amount'}),
3019                               product_code => 'N/A',
3020                             };
3021                 push @newlines, $line;
3022             }
3023         }
3024       }
3025
3026       # after this, Calls Details is populated with all CDRs
3027       foreach my $newsection ( @newsections ) {
3028         if(!$newsection->{'post_total'}) { # this means Calls Details
3029             foreach my $line ( @lines ) {
3030                 next unless (scalar(@{$line->{'ext_description'}}) &&
3031                         $line->{'section'}->{'phonenum'} eq $newsection->{'phonenum'}
3032                             );
3033                 my @extdesc = @{$line->{'ext_description'}};
3034                 my @newextdesc;
3035                 foreach my $extdesc ( @extdesc ) {
3036                     $extdesc =~ s/scriptsize/normalsize/g if $format eq 'latex';
3037                     push @newextdesc, $extdesc;
3038                 }
3039                 $line->{'ext_description'} = \@newextdesc;
3040                 $line->{'section'} = $newsection;
3041                 push @newlines, $line;
3042             }
3043         }
3044       }
3045
3046       return(\@newsections, \@newlines);
3047   }
3048
3049   return(\@sections, \@lines);
3050
3051 }
3052
3053 sub _items_previous {
3054   my $self = shift;
3055   my $conf = $self->conf;
3056   my $cust_main = $self->cust_main;
3057   my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
3058   my @b = ();
3059   foreach ( @pr_cust_bill ) {
3060     my $date = $conf->exists('invoice_show_prior_due_date')
3061                ? 'due '. $_->due_date2str($date_format)
3062                : time2str($date_format, $_->_date);
3063     push @b, {
3064       'description' => $self->mt('Previous Balance, Invoice #'). $_->invnum. " ($date)",
3065       #'pkgpart'     => 'N/A',
3066       'pkgnum'      => 'N/A',
3067       'amount'      => sprintf("%.2f", $_->owed),
3068     };
3069   }
3070   @b;
3071
3072   #{
3073   #    'description'     => 'Previous Balance',
3074   #    #'pkgpart'         => 'N/A',
3075   #    'pkgnum'          => 'N/A',
3076   #    'amount'          => sprintf("%10.2f", $pr_total ),
3077   #    'ext_description' => [ map {
3078   #                                 "Invoice ". $_->invnum.
3079   #                                 " (". time2str("%x",$_->_date). ") ".
3080   #                                 sprintf("%10.2f", $_->owed)
3081   #                         } @pr_cust_bill ],
3082
3083   #};
3084 }
3085
3086 sub _items_credits {
3087   my( $self, %opt ) = @_;
3088   my $trim_len = $opt{'trim_len'} || 60;
3089
3090   my @b;
3091   #credits
3092   foreach ( $self->cust_credited ) {
3093
3094     #something more elaborate if $_->amount ne $_->cust_credit->credited ?
3095
3096     my $reason = substr($_->cust_credit->reason, 0, $trim_len);
3097     $reason .= '...' if length($reason) < length($_->cust_credit->reason);
3098     $reason = " ($reason) " if $reason;
3099
3100     push @b, {
3101       #'description' => 'Credit ref\#'. $_->crednum.
3102       #                 " (". time2str("%x",$_->cust_credit->_date) .")".
3103       #                 $reason,
3104       'description' => $self->mt('Credit applied').' '.
3105                        time2str($date_format,$_->cust_credit->_date). $reason,
3106       'amount'      => sprintf("%.2f",$_->amount),
3107     };
3108   }
3109
3110   @b;
3111
3112 }
3113
3114 sub _items_payments {
3115   my $self = shift;
3116
3117   my @b;
3118   #get & print payments
3119   foreach ( $self->cust_bill_pay ) {
3120
3121     #something more elaborate if $_->amount ne ->cust_pay->paid ?
3122
3123     push @b, {
3124       'description' => $self->mt('Payment received').' '.
3125                        time2str($date_format,$_->cust_pay->_date ),
3126       'amount'      => sprintf("%.2f", $_->amount )
3127     };
3128   }
3129
3130   @b;
3131
3132 }
3133
3134 =item call_details [ OPTION => VALUE ... ]
3135
3136 Returns an array of CSV strings representing the call details for this invoice
3137 The only option available is the boolean prepend_billed_number
3138
3139 =cut
3140
3141 sub call_details {
3142   my ($self, %opt) = @_;
3143
3144   my $format_function = sub { shift };
3145
3146   if ($opt{prepend_billed_number}) {
3147     $format_function = sub {
3148       my $detail = shift;
3149       my $row = shift;
3150
3151       $row->amount ? $row->phonenum. ",". $detail : '"Billed number",'. $detail;
3152
3153     };
3154   }
3155
3156   my @details = map { $_->details( 'format_function' => $format_function,
3157                                    'escape_function' => sub{ return() },
3158                                  )
3159                     }
3160                   grep { $_->pkgnum }
3161                   $self->cust_bill_pkg;
3162   my $header = $details[0];
3163   ( $header, grep { $_ ne $header } @details );
3164 }
3165
3166
3167 =back
3168
3169 =head1 SUBROUTINES
3170
3171 =over 4
3172
3173 =item process_reprint
3174
3175 =cut
3176
3177 sub process_reprint {
3178   process_re_X('print', @_);
3179 }
3180
3181 =item process_reemail
3182
3183 =cut
3184
3185 sub process_reemail {
3186   process_re_X('email', @_);
3187 }
3188
3189 =item process_refax
3190
3191 =cut
3192
3193 sub process_refax {
3194   process_re_X('fax', @_);
3195 }
3196
3197 =item process_reftp
3198
3199 =cut
3200
3201 sub process_reftp {
3202   process_re_X('ftp', @_);
3203 }
3204
3205 =item respool
3206
3207 =cut
3208
3209 sub process_respool {
3210   process_re_X('spool', @_);
3211 }
3212
3213 use Storable qw(thaw);
3214 use Data::Dumper;
3215 use MIME::Base64;
3216 sub process_re_X {
3217   my( $method, $job ) = ( shift, shift );
3218   warn "$me process_re_X $method for job $job\n" if $DEBUG;
3219
3220   my $param = thaw(decode_base64(shift));
3221   warn Dumper($param) if $DEBUG;
3222
3223   re_X(
3224     $method,
3225     $job,
3226     %$param,
3227   );
3228
3229 }
3230
3231 sub re_X {
3232   # spool_invoice ftp_invoice fax_invoice print_invoice
3233   my($method, $job, %param ) = @_;
3234   if ( $DEBUG ) {
3235     warn "re_X $method for job $job with param:\n".
3236          join( '', map { "  $_ => ". $param{$_}. "\n" } keys %param );
3237   }
3238
3239   #some false laziness w/search/cust_bill.html
3240   my $distinct = '';
3241   my $orderby = 'ORDER BY cust_bill._date';
3242
3243   my $extra_sql = ' WHERE '. FS::cust_bill->search_sql_where(\%param);
3244
3245   my $addl_from = 'LEFT JOIN cust_main USING ( custnum )';
3246
3247   my @cust_bill = qsearch( {
3248     #'select'    => "cust_bill.*",
3249     'table'     => 'cust_bill',
3250     'addl_from' => $addl_from,
3251     'hashref'   => {},
3252     'extra_sql' => $extra_sql,
3253     'order_by'  => $orderby,
3254     'debug' => 1,
3255   } );
3256
3257   $method .= '_invoice' unless $method eq 'email' || $method eq 'print';
3258
3259   warn " $me re_X $method: ". scalar(@cust_bill). " invoices found\n"
3260     if $DEBUG;
3261
3262   my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
3263   foreach my $cust_bill ( @cust_bill ) {
3264     $cust_bill->$method();
3265
3266     if ( $job ) { #progressbar foo
3267       $num++;
3268       if ( time - $min_sec > $last ) {
3269         my $error = $job->update_statustext(
3270           int( 100 * $num / scalar(@cust_bill) )
3271         );
3272         die $error if $error;
3273         $last = time;
3274       }
3275     }
3276
3277   }
3278
3279 }
3280
3281 =back
3282
3283 =head1 CLASS METHODS
3284
3285 =over 4
3286
3287 =item owed_sql
3288
3289 Returns an SQL fragment to retreive the amount owed (charged minus credited and paid).
3290
3291 =cut
3292
3293 sub owed_sql {
3294   my ($class, $start, $end) = @_;
3295   'charged - '.
3296     $class->paid_sql($start, $end). ' - '.
3297     $class->credited_sql($start, $end);
3298 }
3299
3300 =item net_sql
3301
3302 Returns an SQL fragment to retreive the net amount (charged minus credited).
3303
3304 =cut
3305
3306 sub net_sql {
3307   my ($class, $start, $end) = @_;
3308   'charged - '. $class->credited_sql($start, $end);
3309 }
3310
3311 =item paid_sql
3312
3313 Returns an SQL fragment to retreive the amount paid against this invoice.
3314
3315 =cut
3316
3317 sub paid_sql {
3318   my ($class, $start, $end) = @_;
3319   $start &&= "AND cust_bill_pay._date <= $start";
3320   $end   &&= "AND cust_bill_pay._date > $end";
3321   $start = '' unless defined($start);
3322   $end   = '' unless defined($end);
3323   "( SELECT COALESCE(SUM(amount),0) FROM cust_bill_pay
3324        WHERE cust_bill.invnum = cust_bill_pay.invnum $start $end  )";
3325 }
3326
3327 =item credited_sql
3328
3329 Returns an SQL fragment to retreive the amount credited against this invoice.
3330
3331 =cut
3332
3333 sub credited_sql {
3334   my ($class, $start, $end) = @_;
3335   $start &&= "AND cust_credit_bill._date <= $start";
3336   $end   &&= "AND cust_credit_bill._date >  $end";
3337   $start = '' unless defined($start);
3338   $end   = '' unless defined($end);
3339   "( SELECT COALESCE(SUM(amount),0) FROM cust_credit_bill
3340        WHERE cust_bill.invnum = cust_credit_bill.invnum $start $end  )";
3341 }
3342
3343 =item due_date_sql
3344
3345 Returns an SQL fragment to retrieve the due date of an invoice.
3346 Currently only supported on PostgreSQL.
3347
3348 =cut
3349
3350 sub due_date_sql {
3351   my $conf = new FS::Conf;
3352 'COALESCE(
3353   SUBSTRING(
3354     COALESCE(
3355       cust_bill.invoice_terms,
3356       cust_main.invoice_terms,
3357       \''.($conf->config('invoice_default_terms') || '').'\'
3358     ), E\'Net (\\\\d+)\'
3359   )::INTEGER, 0
3360 ) * 86400 + cust_bill._date'
3361 }
3362
3363 =item search_sql_where HASHREF
3364
3365 Class method which returns an SQL WHERE fragment to search for parameters
3366 specified in HASHREF.  Valid parameters are
3367
3368 =over 4
3369
3370 =item _date
3371
3372 List reference of start date, end date, as UNIX timestamps.
3373
3374 =item invnum_min
3375
3376 =item invnum_max
3377
3378 =item agentnum
3379
3380 =item charged
3381
3382 List reference of charged limits (exclusive).
3383
3384 =item owed
3385
3386 List reference of charged limits (exclusive).
3387
3388 =item open
3389
3390 flag, return open invoices only
3391
3392 =item net
3393
3394 flag, return net invoices only
3395
3396 =item days
3397
3398 =item newest_percust
3399
3400 =back
3401
3402 Note: validates all passed-in data; i.e. safe to use with unchecked CGI params.
3403
3404 =cut
3405
3406 sub search_sql_where {
3407   my($class, $param) = @_;
3408   if ( $DEBUG ) {
3409     warn "$me search_sql_where called with params: \n".
3410          join("\n", map { "  $_: ". $param->{$_} } keys %$param ). "\n";
3411   }
3412
3413   my @search = ();
3414
3415   #agentnum
3416   if ( $param->{'agentnum'} =~ /^(\d+)$/ ) {
3417     push @search, "cust_main.agentnum = $1";
3418   }
3419
3420   #refnum
3421   if ( $param->{'refnum'} =~ /^(\d+)$/ ) {
3422     push @search, "cust_main.refnum = $1";
3423   }
3424
3425   #custnum
3426   if ( $param->{'custnum'} =~ /^(\d+)$/ ) {
3427     push @search, "cust_bill.custnum = $1";
3428   }
3429
3430   #_date
3431   if ( $param->{_date} ) {
3432     my($beginning, $ending) = @{$param->{_date}};
3433
3434     push @search, "cust_bill._date >= $beginning",
3435                   "cust_bill._date <  $ending";
3436   }
3437
3438   #invnum
3439   if ( $param->{'invnum_min'} =~ /^(\d+)$/ ) {
3440     push @search, "cust_bill.invnum >= $1";
3441   }
3442   if ( $param->{'invnum_max'} =~ /^(\d+)$/ ) {
3443     push @search, "cust_bill.invnum <= $1";
3444   }
3445
3446   #charged
3447   if ( $param->{charged} ) {
3448     my @charged = ref($param->{charged})
3449                     ? @{ $param->{charged} }
3450                     : ($param->{charged});
3451
3452     push @search, map { s/^charged/cust_bill.charged/; $_; }
3453                       @charged;
3454   }
3455
3456   my $owed_sql = FS::cust_bill->owed_sql;
3457
3458   #owed
3459   if ( $param->{owed} ) {
3460     my @owed = ref($param->{owed})
3461                  ? @{ $param->{owed} }
3462                  : ($param->{owed});
3463     push @search, map { s/^owed/$owed_sql/; $_; }
3464                       @owed;
3465   }
3466
3467   #open/net flags
3468   push @search, "0 != $owed_sql"
3469     if $param->{'open'};
3470   push @search, '0 != '. FS::cust_bill->net_sql
3471     if $param->{'net'};
3472
3473   #days
3474   push @search, "cust_bill._date < ". (time-86400*$param->{'days'})
3475     if $param->{'days'};
3476
3477   #newest_percust
3478   if ( $param->{'newest_percust'} ) {
3479
3480     #$distinct = 'DISTINCT ON ( cust_bill.custnum )';
3481     #$orderby = 'ORDER BY cust_bill.custnum ASC, cust_bill._date DESC';
3482
3483     my @newest_where = map { my $x = $_;
3484                              $x =~ s/\bcust_bill\./newest_cust_bill./g;
3485                              $x;
3486                            }
3487                            grep ! /^cust_main./, @search;
3488     my $newest_where = scalar(@newest_where)
3489                          ? ' AND '. join(' AND ', @newest_where)
3490                          : '';
3491
3492
3493     push @search, "cust_bill._date = (
3494       SELECT(MAX(newest_cust_bill._date)) FROM cust_bill AS newest_cust_bill
3495         WHERE newest_cust_bill.custnum = cust_bill.custnum
3496           $newest_where
3497     )";
3498
3499   }
3500
3501   #promised_date - also has an option to accept nulls
3502   if ( $param->{promised_date} ) {
3503     my($beginning, $ending, $null) = @{$param->{promised_date}};
3504
3505     push @search, "(( cust_bill.promised_date >= $beginning AND ".
3506                     "cust_bill.promised_date <  $ending )" .
3507                     ($null ? ' OR cust_bill.promised_date IS NULL ) ' : ')');
3508   }
3509
3510   #agent virtualization
3511   my $curuser = $FS::CurrentUser::CurrentUser;
3512   if ( $curuser->username eq 'fs_queue'
3513        && $param->{'CurrentUser'} =~ /^(\w+)$/ ) {
3514     my $username = $1;
3515     my $newuser = qsearchs('access_user', {
3516       'username' => $username,
3517       'disabled' => '',
3518     } );
3519     if ( $newuser ) {
3520       $curuser = $newuser;
3521     } else {
3522       warn "$me WARNING: (fs_queue) can't find CurrentUser $username\n";
3523     }
3524   }
3525   push @search, $curuser->agentnums_sql;
3526
3527   join(' AND ', @search );
3528
3529 }
3530
3531 =back
3532
3533 =head1 BUGS
3534
3535 The delete method.
3536
3537 =head1 SEE ALSO
3538
3539 L<FS::Record>, L<FS::cust_main>, L<FS::cust_bill_pay>, L<FS::cust_pay>,
3540 L<FS::cust_bill_pkg>, L<FS::cust_bill_credit>, schema.html from the base
3541 documentation.
3542
3543 =cut
3544
3545 1;
3546