FS/FS/cust_bill.pm

   1 package FS::cust_bill;
   2
   3 use strict;
   4 use vars qw( @ISA $DEBUG $me $conf $money_char );
   5 use vars qw( $invoice_lines @buf ); #yuck
   6 use Fcntl qw(:flock); #for spool_csv
   7 use List::Util qw(min max);
   8 use Date::Format;
   9 use Text::Template 1.20;
  10 use File::Temp 0.14;
  11 use String::ShellQuote;
  12 use HTML::Entities;
  13 use Locale::Country;
  14 use FS::UID qw( datasrc );
  15 use FS::Misc qw( send_email send_fax generate_ps do_print );
  16 use FS::Record qw( qsearch qsearchs dbh );
  17 use FS::cust_main_Mixin;
  18 use FS::cust_main;
  19 use FS::cust_bill_pkg;
  20 use FS::cust_credit;
  21 use FS::cust_pay;
  22 use FS::cust_pkg;
  23 use FS::cust_credit_bill;
  24 use FS::pay_batch;
  25 use FS::cust_pay_batch;
  26 use FS::cust_bill_event;
  27 use FS::part_pkg;
  28 use FS::cust_bill_pay;
  29 use FS::cust_bill_pay_batch;
  30 use FS::part_bill_event;
  31 use FS::payby;
  32
  33 @ISA = qw( FS::cust_main_Mixin FS::Record );
  34
  35 $DEBUG = 0;
  36 $me = '[FS::cust_bill]';
  37
  38 #ask FS::UID to run this stuff for us later
  39 FS::UID->install_callback( sub {
  40   $conf = new FS::Conf;
  41   $money_char = $conf->config('money_char') || '$';
  42 } );
  43
  44 =head1 NAME
  45
  46 FS::cust_bill - Object methods for cust_bill records
  47
  48 =head1 SYNOPSIS
  49
  50   use FS::cust_bill;
  51
  52   $record = new FS::cust_bill \%hash;
  53   $record = new FS::cust_bill { 'column' => 'value' };
  54
  55   $error = $record->insert;
  56
  57   $error = $new_record->replace($old_record);
  58
  59   $error = $record->delete;
  60
  61   $error = $record->check;
  62
  63   ( $total_previous_balance, @previous_cust_bill ) = $record->previous;
  64
  65   @cust_bill_pkg_objects = $cust_bill->cust_bill_pkg;
  66
  67   ( $total_previous_credits, @previous_cust_credit ) = $record->cust_credit;
  68
  69   @cust_pay_objects = $cust_bill->cust_pay;
  70
  71   $tax_amount = $record->tax;
  72
  73   @lines = $cust_bill->print_text;
  74   @lines = $cust_bill->print_text $time;
  75
  76 =head1 DESCRIPTION
  77
  78 An FS::cust_bill object represents an invoice; a declaration that a customer
  79 owes you money.  The specific charges are itemized as B<cust_bill_pkg> records
  80 (see L<FS::cust_bill_pkg>).  FS::cust_bill inherits from FS::Record.  The
  81 following fields are currently supported:
  82
  83 =over 4
  84
  85 =item invnum - primary key (assigned automatically for new invoices)
  86
  87 =item custnum - customer (see L<FS::cust_main>)
  88
  89 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
  90 L<Time::Local> and L<Date::Parse> for conversion functions.
  91
  92 =item charged - amount of this invoice
  93
  94 =item printed - deprecated
  95
  96 =item closed - books closed flag, empty or `Y'
  97
  98 =back
  99
 100 =head1 METHODS
 101
 102 =over 4
 103
 104 =item new HASHREF
 105
 106 Creates a new invoice.  To add the invoice to the database, see L<"insert">.
 107 Invoices are normally created by calling the bill method of a customer object
 108 (see L<FS::cust_main>).
 109
 110 =cut
 111
 112 sub table { 'cust_bill'; }
 113
 114 sub cust_linked { $_[0]->cust_main_custnum; }
 115 sub cust_unlinked_msg {
 116   my $self = shift;
 117   "WARNING: can't find cust_main.custnum ". $self->custnum.
 118   ' (cust_bill.invnum '. $self->invnum. ')';
 119 }
 120
 121 =item insert
 122
 123 Adds this invoice to the database ("Posts" the invoice).  If there is an error,
 124 returns the error, otherwise returns false.
 125
 126 =item delete
 127
 128 This method now works but you probably shouldn't use it.  Instead, apply a
 129 credit against the invoice.
 130
 131 Using this method to delete invoices outright is really, really bad.  There
 132 would be no record you ever posted this invoice, and there are no check to
 133 make sure charged = 0 or that there are no associated cust_bill_pkg records.
 134
 135 Really, don't use it.
 136
 137 =cut
 138
 139 sub delete {
 140   my $self = shift;
 141   return "Can't delete closed invoice" if $self->closed =~ /^Y/i;
 142   $self->SUPER::delete(@_);
 143 }
 144
 145 =item replace OLD_RECORD
 146
 147 Replaces the OLD_RECORD with this one in the database.  If there is an error,
 148 returns the error, otherwise returns false.
 149
 150 Only printed may be changed.  printed is normally updated by calling the
 151 collect method of a customer object (see L<FS::cust_main>).
 152
 153 =cut
 154
 155 #replace can be inherited from Record.pm
 156
 157 # replace_check is now the preferred way to #implement replace data checks
 158 # (so $object->replace() works without an argument)
 159
 160 sub replace_check {
 161   my( $new, $old ) = ( shift, shift );
 162   return "Can't change custnum!" unless $old->custnum == $new->custnum;
 163   #return "Can't change _date!" unless $old->_date eq $new->_date;
 164   return "Can't change _date!" unless $old->_date == $new->_date;
 165   return "Can't change charged!" unless $old->charged == $new->charged
 166                                      || $old->charged == 0;
 167
 168   '';
 169 }
 170
 171 =item check
 172
 173 Checks all fields to make sure this is a valid invoice.  If there is an error,
 174 returns the error, otherwise returns false.  Called by the insert and replace
 175 methods.
 176
 177 =cut
 178
 179 sub check {
 180   my $self = shift;
 181
 182   my $error =
 183     $self->ut_numbern('invnum')
 184     || $self->ut_number('custnum')
 185     || $self->ut_numbern('_date')
 186     || $self->ut_money('charged')
 187     || $self->ut_numbern('printed')
 188     || $self->ut_enum('closed', [ '', 'Y' ])
 189   ;
 190   return $error if $error;
 191
 192   return "Unknown customer"
 193     unless qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
 194
 195   $self->_date(time) unless $self->_date;
 196
 197   $self->printed(0) if $self->printed eq '';
 198
 199   $self->SUPER::check;
 200 }
 201
 202 =item previous
 203
 204 Returns a list consisting of the total previous balance for this customer,
 205 followed by the previous outstanding invoices (as FS::cust_bill objects also).
 206
 207 =cut
 208
 209 sub previous {
 210   my $self = shift;
 211   my $total = 0;
 212   my @cust_bill = sort { $a->_date <=> $b->_date }
 213     grep { $_->owed != 0 && $_->_date < $self->_date }
 214       qsearch( 'cust_bill', { 'custnum' => $self->custnum } )
 215   ;
 216   foreach ( @cust_bill ) { $total += $_->owed; }
 217   $total, @cust_bill;
 218 }
 219
 220 =item cust_bill_pkg
 221
 222 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice.
 223
 224 =cut
 225
 226 sub cust_bill_pkg {
 227   my $self = shift;
 228   qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum } );
 229 }
 230
 231 =item cust_pkg
 232
 233 Returns the packages (see L<FS::cust_pkg>) corresponding to the line items for
 234 this invoice.
 235
 236 =cut
 237
 238 sub cust_pkg {
 239   my $self = shift;
 240   my @cust_pkg = map { $_->cust_pkg } $self->cust_bill_pkg;
 241   my %saw = ();
 242   grep { ! $saw{$_->pkgnum}++ } @cust_pkg;
 243 }
 244
 245 =item open_cust_bill_pkg
 246
 247 Returns the open line items for this invoice.
 248
 249 Note that cust_bill_pkg with both setup and recur fees are returned as two
 250 separate line items, each with only one fee.
 251
 252 =cut
 253
 254 # modeled after cust_main::open_cust_bill
 255 sub open_cust_bill_pkg {
 256   my $self = shift;
 257
 258   # grep { $_->owed > 0 } $self->cust_bill_pkg
 259
 260   my %other = ( 'recur' => 'setup',
 261                 'setup' => 'recur', );
 262   my @open = ();
 263   foreach my $field ( qw( recur setup )) {
 264     push @open, map  { $_->set( $other{$field}, 0 ); $_; }
 265                 grep { $_->owed($field) > 0 }
 266                 $self->cust_bill_pkg;
 267   }
 268
 269   @open;
 270 }
 271
 272 =item cust_bill_event
 273
 274 Returns the completed invoice events (see L<FS::cust_bill_event>) for this
 275 invoice.
 276
 277 =cut
 278
 279 sub cust_bill_event {
 280   my $self = shift;
 281   qsearch( 'cust_bill_event', { 'invnum' => $self->invnum } );
 282 }
 283
 284
 285 =item cust_main
 286
 287 Returns the customer (see L<FS::cust_main>) for this invoice.
 288
 289 =cut
 290
 291 sub cust_main {
 292   my $self = shift;
 293   qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
 294 }
 295
 296 =item cust_suspend_if_balance_over AMOUNT
 297
 298 Suspends the customer associated with this invoice if the total amount owed on
 299 this invoice and all older invoices is greater than the specified amount.
 300
 301 Returns a list: an empty list on success or a list of errors.
 302
 303 =cut
 304
 305 sub cust_suspend_if_balance_over {
 306   my( $self, $amount ) = ( shift, shift );
 307   my $cust_main = $self->cust_main;
 308   if ( $cust_main->total_owed_date($self->_date) < $amount ) {
 309     return ();
 310   } else {
 311     $cust_main->suspend(@_);
 312   }
 313 }
 314
 315 =item cust_credit
 316
 317 Depreciated.  See the cust_credited method.
 318
 319  #Returns a list consisting of the total previous credited (see
 320  #L<FS::cust_credit>) and unapplied for this customer, followed by the previous
 321  #outstanding credits (FS::cust_credit objects).
 322
 323 =cut
 324
 325 sub cust_credit {
 326   use Carp;
 327   croak "FS::cust_bill->cust_credit depreciated; see ".
 328         "FS::cust_bill->cust_credit_bill";
 329   #my $self = shift;
 330   #my $total = 0;
 331   #my @cust_credit = sort { $a->_date <=> $b->_date }
 332   #  grep { $_->credited != 0 && $_->_date < $self->_date }
 333   #    qsearch('cust_credit', { 'custnum' => $self->custnum } )
 334   #;
 335   #foreach (@cust_credit) { $total += $_->credited; }
 336   #$total, @cust_credit;
 337 }
 338
 339 =item cust_pay
 340
 341 Depreciated.  See the cust_bill_pay method.
 342
 343 #Returns all payments (see L<FS::cust_pay>) for this invoice.
 344
 345 =cut
 346
 347 sub cust_pay {
 348   use Carp;
 349   croak "FS::cust_bill->cust_pay depreciated; see FS::cust_bill->cust_bill_pay";
 350   #my $self = shift;
 351   #sort { $a->_date <=> $b->_date }
 352   #  qsearch( 'cust_pay', { 'invnum' => $self->invnum } )
 353   #;
 354 }
 355
 356 =item cust_bill_pay
 357
 358 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice.
 359
 360 =cut
 361
 362 sub cust_bill_pay {
 363   my $self = shift;
 364   sort { $a->_date <=> $b->_date }
 365     qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum } );
 366 }
 367
 368 =item cust_credited
 369
 370 Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice.
 371
 372 =cut
 373
 374 sub cust_credited {
 375   my $self = shift;
 376   sort { $a->_date <=> $b->_date }
 377     qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum } )
 378   ;
 379 }
 380
 381 =item tax
 382
 383 Returns the tax amount (see L<FS::cust_bill_pkg>) for this invoice.
 384
 385 =cut
 386
 387 sub tax {
 388   my $self = shift;
 389   my $total = 0;
 390   my @taxlines = qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum ,
 391                                              'pkgnum' => 0 } );
 392   foreach (@taxlines) { $total += $_->setup; }
 393   $total;
 394 }
 395
 396 =item owed
 397
 398 Returns the amount owed (still outstanding) on this invoice, which is charged
 399 minus all payment applications (see L<FS::cust_bill_pay>) and credit
 400 applications (see L<FS::cust_credit_bill>).
 401
 402 =cut
 403
 404 sub owed {
 405   my $self = shift;
 406   my $balance = $self->charged;
 407   $balance -= $_->amount foreach ( $self->cust_bill_pay );
 408   $balance -= $_->amount foreach ( $self->cust_credited );
 409   $balance = sprintf( "%.2f", $balance);
 410   $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
 411   $balance;
 412 }
 413
 414 =item apply_payments_and_credits
 415
 416 =cut
 417
 418 sub apply_payments_and_credits {
 419   my $self = shift;
 420
 421   local $SIG{HUP} = 'IGNORE';
 422   local $SIG{INT} = 'IGNORE';
 423   local $SIG{QUIT} = 'IGNORE';
 424   local $SIG{TERM} = 'IGNORE';
 425   local $SIG{TSTP} = 'IGNORE';
 426   local $SIG{PIPE} = 'IGNORE';
 427
 428   my $oldAutoCommit = $FS::UID::AutoCommit;
 429   local $FS::UID::AutoCommit = 0;
 430   my $dbh = dbh;
 431
 432   $self->select_for_update; #mutex
 433
 434   my @payments = grep { $_->unapplied > 0 } $self->cust_main->cust_pay;
 435   my @credits  = grep { $_->credited > 0 } $self->cust_main->cust_credit;
 436
 437   while ( $self->owed > 0 and ( @payments || @credits ) ) {
 438
 439     my $app = '';
 440     if ( @payments && @credits ) {
 441
 442       #decide which goes first by weight of top (unapplied) line item
 443
 444       my @open_lineitems = $self->open_cust_bill_pkg;
 445
 446       my $max_pay_weight =
 447         max( map  { $_->part_pkg->pay_weight || 0 }
 448              grep { $_ }
 449              map  { $_->cust_pkg }
 450                   @open_lineitems
 451            );
 452       my $max_credit_weight =
 453         max( map  { $_->part_pkg->credit_weight || 0 }
 454              grep { $_ }
 455              map  { $_->cust_pkg }
 456                   @open_lineitems
 457            );
 458
 459       #if both are the same... payments first?  it has to be something
 460       if ( $max_pay_weight >= $max_credit_weight ) {
 461         $app = 'pay';
 462       } else {
 463         $app = 'credit';
 464       }
 465
 466     } elsif ( @payments ) {
 467       $app = 'pay';
 468     } elsif ( @credits ) {
 469       $app = 'credit';
 470     } else {
 471       die "guru meditation #12 and 35";
 472     }
 473
 474     if ( $app eq 'pay' ) {
 475
 476       my $payment = shift @payments;
 477
 478       $app = new FS::cust_bill_pay {
 479         'paynum'  => $payment->paynum,
 480         'amount'  => sprintf('%.2f', min( $payment->unapplied, $self->owed ) ),
 481       };
 482
 483     } elsif ( $app eq 'credit' ) {
 484
 485       my $credit = shift @credits;
 486
 487       $app = new FS::cust_credit_bill {
 488         'crednum' => $credit->crednum,
 489         'amount'  => sprintf('%.2f', min( $credit->credited, $self->owed ) ),
 490       };
 491
 492     } else {
 493       die "guru meditation #12 and 35";
 494     }
 495
 496     $app->invnum( $self->invnum );
 497
 498     my $error = $app->insert;
 499     if ( $error ) {
 500       $dbh->rollback if $oldAutoCommit;
 501       return "Error inserting ". $app->table. " record: $error";
 502     }
 503     die $error if $error;
 504
 505   }
 506
 507   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 508   ''; #no error
 509
 510 }
 511
 512 =item generate_email PARAMHASH
 513
 514 PARAMHASH can contain the following:
 515
 516 =over 4
 517
 518 =item from       => sender address, required
 519
 520 =item tempate    => alternate template name, optional
 521
 522 =item print_text => text attachment arrayref, optional
 523
 524 =item subject    => email subject, optional
 525
 526 =back
 527
 528 Returns an argument list to be passed to L<FS::Misc::send_email>.
 529
 530 =cut
 531
 532 use MIME::Entity;
 533
 534 sub generate_email {
 535
 536   my $self = shift;
 537   my %args = @_;
 538
 539   my $me = '[FS::cust_bill::generate_email]';
 540
 541   my %return = (
 542     'from'      => $args{'from'},
 543     'subject'   => (($args{'subject'}) ? $args{'subject'} : 'Invoice'),
 544   );
 545
 546   if (ref($args{'to'}) eq 'ARRAY') {
 547     $return{'to'} = $args{'to'};
 548   } else {
 549     $return{'to'} = [ grep { $_ !~ /^(POST|FAX)$/ }
 550                            $self->cust_main->invoicing_list
 551                     ];
 552   }
 553
 554   if ( $conf->exists('invoice_html') ) {
 555
 556     warn "$me creating HTML/text multipart message"
 557       if $DEBUG;
 558
 559     $return{'nobody'} = 1;
 560
 561     my $alternative = build MIME::Entity
 562       'Type'        => 'multipart/alternative',
 563       'Encoding'    => '7bit',
 564       'Disposition' => 'inline'
 565     ;
 566
 567     my $data;
 568     if ( $conf->exists('invoice_email_pdf')
 569          and scalar($conf->config('invoice_email_pdf_note')) ) {
 570
 571       warn "$me using 'invoice_email_pdf_note' in multipart message"
 572         if $DEBUG;
 573       $data = [ map { $_ . "\n" }
 574                     $conf->config('invoice_email_pdf_note')
 575               ];
 576
 577     } else {
 578
 579       warn "$me not using 'invoice_email_pdf_note' in multipart message"
 580         if $DEBUG;
 581       if ( ref($args{'print_text'}) eq 'ARRAY' ) {
 582         $data = $args{'print_text'};
 583       } else {
 584         $data = [ $self->print_text('', $args{'template'}) ];
 585       }
 586
 587     }
 588
 589     $alternative->attach(
 590       'Type'        => 'text/plain',
 591       #'Encoding'    => 'quoted-printable',
 592       'Encoding'    => '7bit',
 593       'Data'        => $data,
 594       'Disposition' => 'inline',
 595     );
 596
 597     $args{'from'} =~ /\@([\w\.\-]+)/;
 598     my $from = $1 || 'example.com';
 599     my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
 600
 601     my $path = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
 602     my $file;
 603     if ( defined($args{'template'}) && length($args{'template'})
 604          && -e "$path/logo_". $args{'template'}. ".png"
 605        )
 606     {
 607       $file = "$path/logo_". $args{'template'}. ".png";
 608     } else {
 609       $file = "$path/logo.png";
 610     }
 611
 612     my $image = build MIME::Entity
 613       'Type'       => 'image/png',
 614       'Encoding'   => 'base64',
 615       'Path'       => $file,
 616       'Filename'   => 'logo.png',
 617       'Content-ID' => "<$content_id>",
 618     ;
 619
 620     $alternative->attach(
 621       'Type'        => 'text/html',
 622       'Encoding'    => 'quoted-printable',
 623       'Data'        => [ '<html>',
 624                          '  <head>',
 625                          '    <title>',
 626                          '      '. encode_entities($return{'subject'}),
 627                          '    </title>',
 628                          '  </head>',
 629                          '  <body bgcolor="#e8e8e8">',
 630                          $self->print_html('', $args{'template'}, $content_id),
 631                          '  </body>',
 632                          '</html>',
 633                        ],
 634       'Disposition' => 'inline',
 635       #'Filename'    => 'invoice.pdf',
 636     );
 637
 638     if ( $conf->exists('invoice_email_pdf') ) {
 639
 640       #attaching pdf too:
 641       # multipart/mixed
 642       #   multipart/related
 643       #     multipart/alternative
 644       #       text/plain
 645       #       text/html
 646       #     image/png
 647       #   application/pdf
 648
 649       my $related = build MIME::Entity 'Type'     => 'multipart/related',
 650                                        'Encoding' => '7bit';
 651
 652       #false laziness w/Misc::send_email
 653       $related->head->replace('Content-type',
 654         $related->mime_type.
 655         '; boundary="'. $related->head->multipart_boundary. '"'.
 656         '; type=multipart/alternative'
 657       );
 658
 659       $related->add_part($alternative);
 660
 661       $related->add_part($image);
 662
 663       my $pdf = build MIME::Entity $self->mimebuild_pdf('', $args{'template'});
 664
 665       $return{'mimeparts'} = [ $related, $pdf ];
 666
 667     } else {
 668
 669       #no other attachment:
 670       # multipart/related
 671       #   multipart/alternative
 672       #     text/plain
 673       #     text/html
 674       #   image/png
 675
 676       $return{'content-type'} = 'multipart/related';
 677       $return{'mimeparts'} = [ $alternative, $image ];
 678       $return{'type'} = 'multipart/alternative'; #Content-Type of first part...
 679       #$return{'disposition'} = 'inline';
 680
 681     }
 682
 683   } else {
 684
 685     if ( $conf->exists('invoice_email_pdf') ) {
 686       warn "$me creating PDF attachment"
 687         if $DEBUG;
 688
 689       #mime parts arguments a la MIME::Entity->build().
 690       $return{'mimeparts'} = [
 691         { $self->mimebuild_pdf('', $args{'template'}) }
 692       ];
 693     }
 694
 695     if ( $conf->exists('invoice_email_pdf')
 696          and scalar($conf->config('invoice_email_pdf_note')) ) {
 697
 698       warn "$me using 'invoice_email_pdf_note'"
 699         if $DEBUG;
 700       $return{'body'} = [ map { $_ . "\n" }
 701                               $conf->config('invoice_email_pdf_note')
 702                         ];
 703
 704     } else {
 705
 706       warn "$me not using 'invoice_email_pdf_note'"
 707         if $DEBUG;
 708       if ( ref($args{'print_text'}) eq 'ARRAY' ) {
 709         $return{'body'} = $args{'print_text'};
 710       } else {
 711         $return{'body'} = [ $self->print_text('', $args{'template'}) ];
 712       }
 713
 714     }
 715
 716   }
 717
 718   %return;
 719
 720 }
 721
 722 =item mimebuild_pdf
 723
 724 Returns a list suitable for passing to MIME::Entity->build(), representing
 725 this invoice as PDF attachment.
 726
 727 =cut
 728
 729 sub mimebuild_pdf {
 730   my $self = shift;
 731   (
 732     'Type'        => 'application/pdf',
 733     'Encoding'    => 'base64',
 734     'Data'        => [ $self->print_pdf(@_) ],
 735     'Disposition' => 'attachment',
 736     'Filename'    => 'invoice.pdf',
 737   );
 738 }
 739
 740 =item send [ TEMPLATENAME [ , AGENTNUM [ , INVOICE_FROM ] ] ]
 741
 742 Sends this invoice to the destinations configured for this customer: sends
 743 email, prints and/or faxes.  See L<FS::cust_main_invoice>.
 744
 745 TEMPLATENAME, if specified, is the name of a suffix for alternate invoices.
 746
 747 AGENTNUM, if specified, means that this invoice will only be sent for customers
 748 of the specified agent or agent(s).  AGENTNUM can be a scalar agentnum (for a
 749 single agent) or an arrayref of agentnums.
 750
 751 INVOICE_FROM, if specified, overrides the default email invoice From: address.
 752
 753 =cut
 754
 755 sub queueable_send {
 756   my %opt = @_;
 757
 758   my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
 759     or die "invalid invoice number: " . $opt{invnum};
 760
 761   my @args = ( $opt{template}, $opt{agentnum} );
 762   push @args, $opt{invoice_from}
 763     if exists($opt{invoice_from}) && $opt{invoice_from};
 764
 765   my $error = $self->send( @args );
 766   die $error if $error;
 767
 768 }
 769
 770 sub send {
 771   my $self = shift;
 772   my $template = scalar(@_) ? shift : '';
 773   if ( scalar(@_) && $_[0]  ) {
 774     my $agentnums = ref($_[0]) ? shift : [ shift ];
 775     return 'N/A' unless grep { $_ == $self->cust_main->agentnum } @$agentnums;
 776   }
 777
 778   my $invoice_from =
 779     scalar(@_)
 780       ? shift
 781       : ( $self->_agent_invoice_from || $conf->config('invoice_from') );
 782
 783   my @invoicing_list = $self->cust_main->invoicing_list;
 784
 785   $self->email($template, $invoice_from)
 786     if grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list or !@invoicing_list;
 787
 788   $self->print($template)
 789     if grep { $_ eq 'POST' } @invoicing_list; #postal
 790
 791   $self->fax($template)
 792     if grep { $_ eq 'FAX' } @invoicing_list; #fax
 793
 794   '';
 795
 796 }
 797
 798 =item email [ TEMPLATENAME  [ , INVOICE_FROM ] ]
 799
 800 Emails this invoice.
 801
 802 TEMPLATENAME, if specified, is the name of a suffix for alternate invoices.
 803
 804 INVOICE_FROM, if specified, overrides the default email invoice From: address.
 805
 806 =cut
 807
 808 sub queueable_email {
 809   my %opt = @_;
 810
 811   my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
 812     or die "invalid invoice number: " . $opt{invnum};
 813
 814   my @args = ( $opt{template} );
 815   push @args, $opt{invoice_from}
 816     if exists($opt{invoice_from}) && $opt{invoice_from};
 817
 818   my $error = $self->email( @args );
 819   die $error if $error;
 820
 821 }
 822
 823 sub email {
 824   my $self = shift;
 825   my $template = scalar(@_) ? shift : '';
 826   my $invoice_from =
 827     scalar(@_)
 828       ? shift
 829       : ( $self->_agent_invoice_from || $conf->config('invoice_from') );
 830
 831   my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ }
 832                             $self->cust_main->invoicing_list;
 833
 834   #better to notify this person than silence
 835   @invoicing_list = ($invoice_from) unless @invoicing_list;
 836
 837   my $error = send_email(
 838     $self->generate_email(
 839       'from'       => $invoice_from,
 840       'to'         => [ grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list ],
 841       'template'   => $template,
 842     )
 843   );
 844   die "can't email invoice: $error\n" if $error;
 845   #die "$error\n" if $error;
 846
 847 }
 848
 849 =item lpr_data [ TEMPLATENAME ]
 850
 851 Returns the postscript or plaintext for this invoice as an arrayref.
 852
 853 TEMPLATENAME, if specified, is the name of a suffix for alternate invoices.
 854
 855 =cut
 856
 857 sub lpr_data {
 858   my( $self, $template) = @_;
 859   $conf->exists('invoice_latex')
 860     ? [ $self->print_ps('', $template) ]
 861     : [ $self->print_text('', $template) ];
 862 }
 863
 864 =item print [ TEMPLATENAME ]
 865
 866 Prints this invoice.
 867
 868 TEMPLATENAME, if specified, is the name of a suffix for alternate invoices.
 869
 870 =cut
 871
 872 sub print {
 873   my $self = shift;
 874   my $template = scalar(@_) ? shift : '';
 875
 876   do_print $self->lpr_data($template);
 877 }
 878
 879 =item fax [ TEMPLATENAME ]
 880
 881 Faxes this invoice.
 882
 883 TEMPLATENAME, if specified, is the name of a suffix for alternate invoices.
 884
 885 =cut
 886
 887 sub fax {
 888   my $self = shift;
 889   my $template = scalar(@_) ? shift : '';
 890
 891   die 'FAX invoice destination not (yet?) supported with plain text invoices.'
 892     unless $conf->exists('invoice_latex');
 893
 894   my $dialstring = $self->cust_main->getfield('fax');
 895   #Check $dialstring?
 896
 897   my $error = send_fax( 'docdata'    => $self->lpr_data($template),
 898                         'dialstring' => $dialstring,
 899                       );
 900   die $error if $error;
 901
 902 }
 903
 904 =item send_if_newest [ TEMPLATENAME [ , AGENTNUM [ , INVOICE_FROM ] ] ]
 905
 906 Like B<send>, but only sends the invoice if it is the newest open invoice for
 907 this customer.
 908
 909 =cut
 910
 911 sub send_if_newest {
 912   my $self = shift;
 913
 914   return ''
 915     if scalar(
 916                grep { $_->owed > 0 }
 917                     qsearch('cust_bill', {
 918                       'custnum' => $self->custnum,
 919                       #'_date'   => { op=>'>', value=>$self->_date },
 920                       'invnum'  => { op=>'>', value=>$self->invnum },
 921                     } )
 922              );
 923
 924   $self->send(@_);
 925 }
 926
 927 =item send_csv OPTION => VALUE, ...
 928
 929 Sends invoice as a CSV data-file to a remote host with the specified protocol.
 930
 931 Options are:
 932
 933 protocol - currently only "ftp"
 934 server
 935 username
 936 password
 937 dir
 938
 939 The file will be named "N-YYYYMMDDHHMMSS.csv" where N is the invoice number
 940 and YYMMDDHHMMSS is a timestamp.
 941
 942 See L</print_csv> for a description of the output format.
 943
 944 =cut
 945
 946 sub send_csv {
 947   my($self, %opt) = @_;
 948
 949   #create file(s)
 950
 951   my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
 952   mkdir $spooldir, 0700 unless -d $spooldir;
 953
 954   my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', time);
 955   my $file = "$spooldir/$tracctnum.csv";
 956
 957   my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum );
 958
 959   open(CSV, ">$file") or die "can't open $file: $!";
 960   print CSV $header;
 961
 962   print CSV $detail;
 963
 964   close CSV;
 965
 966   my $net;
 967   if ( $opt{protocol} eq 'ftp' ) {
 968     eval "use Net::FTP;";
 969     die $@ if $@;
 970     $net = Net::FTP->new($opt{server}) or die @$;
 971   } else {
 972     die "unknown protocol: $opt{protocol}";
 973   }
 974
 975   $net->login( $opt{username}, $opt{password} )
 976     or die "can't FTP to $opt{username}\@$opt{server}: login error: $@";
 977
 978   $net->binary or die "can't set binary mode";
 979
 980   $net->cwd($opt{dir}) or die "can't cwd to $opt{dir}";
 981
 982   $net->put($file) or die "can't put $file: $!";
 983
 984   $net->quit;
 985
 986   unlink $file;
 987
 988 }
 989
 990 =item spool_csv
 991
 992 Spools CSV invoice data.
 993
 994 Options are:
 995
 996 =over 4
 997
 998 =item format - 'default' or 'billco'
 999
1000 =item dest - if set (to POST, EMAIL or FAX), only sends spools invoices if the customer has the corresponding invoice destinations set (see L<FS::cust_main_invoice>).
1001
1002 =item agent_spools - if set to a true value, will spool to per-agent files rather than a single global file
1003
1004 =item balanceover - if set, only spools the invoice if the total amount owed on this invoice and all older invoices is greater than the specified amount.
1005
1006 =back
1007
1008 =cut
1009
1010 sub spool_csv {
1011   my($self, %opt) = @_;
1012
1013   my $cust_main = $self->cust_main;
1014
1015   if ( $opt{'dest'} ) {
1016     my %invoicing_list = map { /^(POST|FAX)$/ or 'EMAIL' =~ /^(.*)$/; $1 => 1 }
1017                              $cust_main->invoicing_list;
1018     return 'N/A' unless $invoicing_list{$opt{'dest'}}
1019                      || ! keys %invoicing_list;
1020   }
1021
1022   if ( $opt{'balanceover'} ) {
1023     return 'N/A'
1024       if $cust_main->total_owed_date($self->_date) < $opt{'balanceover'};
1025   }
1026
1027   my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1028   mkdir $spooldir, 0700 unless -d $spooldir;
1029
1030   my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', time);
1031
1032   my $file =
1033     "$spooldir/".
1034     ( $opt{'agent_spools'} ? 'agentnum'.$cust_main->agentnum : 'spool' ).
1035     ( lc($opt{'format'}) eq 'billco' ? '-header' : '' ) .
1036     '.csv';
1037
1038   my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum );
1039
1040   open(CSV, ">>$file") or die "can't open $file: $!";
1041   flock(CSV, LOCK_EX);
1042   seek(CSV, 0, 2);
1043
1044   print CSV $header;
1045
1046   if ( lc($opt{'format'}) eq 'billco' ) {
1047
1048     flock(CSV, LOCK_UN);
1049     close CSV;
1050
1051     $file =
1052       "$spooldir/".
1053       ( $opt{'agent_spools'} ? 'agentnum'.$cust_main->agentnum : 'spool' ).
1054       '-detail.csv';
1055
1056     open(CSV,">>$file") or die "can't open $file: $!";
1057     flock(CSV, LOCK_EX);
1058     seek(CSV, 0, 2);
1059   }
1060
1061   print CSV $detail;
1062
1063   flock(CSV, LOCK_UN);
1064   close CSV;
1065
1066   return '';
1067
1068 }
1069
1070 =item print_csv OPTION => VALUE, ...
1071
1072 Returns CSV data for this invoice.
1073
1074 Options are:
1075
1076 format - 'default' or 'billco'
1077
1078 Returns a list consisting of two scalars.  The first is a single line of CSV
1079 header information for this invoice.  The second is one or more lines of CSV
1080 detail information for this invoice.
1081
1082 If I<format> is not specified or "default", the fields of the CSV file are as
1083 follows:
1084
1085 record_type, invnum, custnum, _date, charged, first, last, company, address1, address2, city, state, zip, country, pkg, setup, recur, sdate, edate
1086
1087 =over 4
1088
1089 =item record type - B<record_type> is either C<cust_bill> or C<cust_bill_pkg>
1090
1091 B<record_type> is C<cust_bill> for the initial header line only.  The
1092 last five fields (B<pkg> through B<edate>) are irrelevant, and all other
1093 fields are filled in.
1094
1095 B<record_type> is C<cust_bill_pkg> for detail lines.  Only the first two fields
1096 (B<record_type> and B<invnum>) and the last five fields (B<pkg> through B<edate>)
1097 are filled in.
1098
1099 =item invnum - invoice number
1100
1101 =item custnum - customer number
1102
1103 =item _date - invoice date
1104
1105 =item charged - total invoice amount
1106
1107 =item first - customer first name
1108
1109 =item last - customer first name
1110
1111 =item company - company name
1112
1113 =item address1 - address line 1
1114
1115 =item address2 - address line 1
1116
1117 =item city
1118
1119 =item state
1120
1121 =item zip
1122
1123 =item country
1124
1125 =item pkg - line item description
1126
1127 =item setup - line item setup fee (one or both of B<setup> and B<recur> will be defined)
1128
1129 =item recur - line item recurring fee (one or both of B<setup> and B<recur> will be defined)
1130
1131 =item sdate - start date for recurring fee
1132
1133 =item edate - end date for recurring fee
1134
1135 =back
1136
1137 If I<format> is "billco", the fields of the header CSV file are as follows:
1138
1139   +-------------------------------------------------------------------+
1140   |                        FORMAT HEADER FILE                         |
1141   |-------------------------------------------------------------------|
1142   | Field | Description                   | Name       | Type | Width |
1143   | 1     | N/A-Leave Empty               | RC         | CHAR |     2 |
1144   | 2     | N/A-Leave Empty               | CUSTID     | CHAR |    15 |
1145   | 3     | Transaction Account No        | TRACCTNUM  | CHAR |    15 |
1146   | 4     | Transaction Invoice No        | TRINVOICE  | CHAR |    15 |
1147   | 5     | Transaction Zip Code          | TRZIP      | CHAR |     5 |
1148   | 6     | Transaction Company Bill To   | TRCOMPANY  | CHAR |    30 |
1149   | 7     | Transaction Contact Bill To   | TRNAME     | CHAR |    30 |
1150   | 8     | Additional Address Unit Info  | TRADDR1    | CHAR |    30 |
1151   | 9     | Bill To Street Address        | TRADDR2    | CHAR |    30 |
1152   | 10    | Ancillary Billing Information | TRADDR3    | CHAR |    30 |
1153   | 11    | Transaction City Bill To      | TRCITY     | CHAR |    20 |
1154   | 12    | Transaction State Bill To     | TRSTATE    | CHAR |     2 |
1155   | 13    | Bill Cycle Close Date         | CLOSEDATE  | CHAR |    10 |
1156   | 14    | Bill Due Date                 | DUEDATE    | CHAR |    10 |
1157   | 15    | Previous Balance              | BALFWD     | NUM* |     9 |
1158   | 16    | Pmt/CR Applied                | CREDAPPLY  | NUM* |     9 |
1159   | 17    | Total Current Charges         | CURRENTCHG | NUM* |     9 |
1160   | 18    | Total Amt Due                 | TOTALDUE   | NUM* |     9 |
1161   | 19    | Total Amt Due                 | AMTDUE     | NUM* |     9 |
1162   | 20    | 30 Day Aging                  | AMT30      | NUM* |     9 |
1163   | 21    | 60 Day Aging                  | AMT60      | NUM* |     9 |
1164   | 22    | 90 Day Aging                  | AMT90      | NUM* |     9 |
1165   | 23    | Y/N                           | AGESWITCH  | CHAR |     1 |
1166   | 24    | Remittance automation         | SCANLINE   | CHAR |   100 |
1167   | 25    | Total Taxes & Fees            | TAXTOT     | NUM* |     9 |
1168   | 26    | Customer Reference Number     | CUSTREF    | CHAR |    15 |
1169   | 27    | Federal Tax***                | FEDTAX     | NUM* |     9 |
1170   | 28    | State Tax***                  | STATETAX   | NUM* |     9 |
1171   | 29    | Other Taxes & Fees***         | OTHERTAX   | NUM* |     9 |
1172   +-------+-------------------------------+------------+------+-------+
1173
1174 If I<format> is "billco", the fields of the detail CSV file are as follows:
1175
1176                                   FORMAT FOR DETAIL FILE
1177         |                            |           |      |
1178   Field | Description                | Name      | Type | Width
1179   1     | N/A-Leave Empty            | RC        | CHAR |     2
1180   2     | N/A-Leave Empty            | CUSTID    | CHAR |    15
1181   3     | Account Number             | TRACCTNUM | CHAR |    15
1182   4     | Invoice Number             | TRINVOICE | CHAR |    15
1183   5     | Line Sequence (sort order) | LINESEQ   | NUM  |     6
1184   6     | Transaction Detail         | DETAILS   | CHAR |   100
1185   7     | Amount                     | AMT       | NUM* |     9
1186   8     | Line Format Control**      | LNCTRL    | CHAR |     2
1187   9     | Grouping Code              | GROUP     | CHAR |     2
1188   10    | User Defined               | ACCT CODE | CHAR |    15
1189
1190 =cut
1191
1192 sub print_csv {
1193   my($self, %opt) = @_;
1194
1195   eval "use Text::CSV_XS";
1196   die $@ if $@;
1197
1198   my $cust_main = $self->cust_main;
1199
1200   my $csv = Text::CSV_XS->new({'always_quote'=>1});
1201
1202   if ( lc($opt{'format'}) eq 'billco' ) {
1203
1204     my $taxtotal = 0;
1205     $taxtotal += $_->{'amount'} foreach $self->_items_tax;
1206
1207     my $duedate = '';
1208     if (    $conf->exists('invoice_default_terms')
1209          && $conf->config('invoice_default_terms')=~ /^\s*Net\s*(\d+)\s*$/ ) {
1210       $duedate = time2str("%m/%d/%Y", $self->_date + ($1*86400) );
1211     }
1212
1213     my( $previous_balance, @unused ) = $self->previous; #previous balance
1214
1215     my $pmt_cr_applied = 0;
1216     $pmt_cr_applied += $_->{'amount'}
1217       foreach ( $self->_items_payments, $self->_items_credits ) ;
1218
1219     my $totaldue = sprintf('%.2f', $self->owed + $previous_balance);
1220
1221     $csv->combine(
1222       '',                         #  1 | N/A-Leave Empty               CHAR   2
1223       '',                         #  2 | N/A-Leave Empty               CHAR  15
1224       $opt{'tracctnum'},          #  3 | Transaction Account No        CHAR  15
1225       $self->invnum,              #  4 | Transaction Invoice No        CHAR  15
1226       $cust_main->zip,            #  5 | Transaction Zip Code          CHAR   5
1227       $cust_main->company,        #  6 | Transaction Company Bill To   CHAR  30
1228       #$cust_main->payname,        #  7 | Transaction Contact Bill To   CHAR  30
1229       $cust_main->contact,        #  7 | Transaction Contact Bill To   CHAR  30
1230       $cust_main->address2,       #  8 | Additional Address Unit Info  CHAR  30
1231       $cust_main->address1,       #  9 | Bill To Street Address        CHAR  30
1232       '',                         # 10 | Ancillary Billing Information CHAR  30
1233       $cust_main->city,           # 11 | Transaction City Bill To      CHAR  20
1234       $cust_main->state,          # 12 | Transaction State Bill To     CHAR   2
1235
1236       # XXX ?
1237       time2str("%m/%d/%Y", $self->_date), # 13 | Bill Cycle Close Date CHAR  10
1238
1239       # XXX ?
1240       $duedate,                   # 14 | Bill Due Date                 CHAR  10
1241
1242       $previous_balance,          # 15 | Previous Balance              NUM*   9
1243       $pmt_cr_applied,            # 16 | Pmt/CR Applied                NUM*   9
1244       sprintf("%.2f", $self->charged), # 17 | Total Current Charges    NUM*   9
1245       $totaldue,                  # 18 | Total Amt Due                 NUM*   9
1246       $totaldue,                  # 19 | Total Amt Due                 NUM*   9
1247       '',                         # 20 | 30 Day Aging                  NUM*   9
1248       '',                         # 21 | 60 Day Aging                  NUM*   9
1249       '',                         # 22 | 90 Day Aging                  NUM*   9
1250       'N',                        # 23 | Y/N                           CHAR   1
1251       '',                         # 24 | Remittance automation         CHAR 100
1252       $taxtotal,                  # 25 | Total Taxes & Fees            NUM*   9
1253       $self->custnum,             # 26 | Customer Reference Number     CHAR  15
1254       '0',                        # 27 | Federal Tax***                NUM*   9
1255       sprintf("%.2f", $taxtotal), # 28 | State Tax***                  NUM*   9
1256       '0',                        # 29 | Other Taxes & Fees***         NUM*   9
1257     );
1258
1259   } else {
1260
1261     $csv->combine(
1262       'cust_bill',
1263       $self->invnum,
1264       $self->custnum,
1265       time2str("%x", $self->_date),
1266       sprintf("%.2f", $self->charged),
1267       ( map { $cust_main->getfield($_) }
1268           qw( first last company address1 address2 city state zip country ) ),
1269       map { '' } (1..5),
1270     ) or die "can't create csv";
1271   }
1272
1273   my $header = $csv->string. "\n";
1274
1275   my $detail = '';
1276   if ( lc($opt{'format'}) eq 'billco' ) {
1277
1278     my $lineseq = 0;
1279     foreach my $item ( $self->_items_pkg ) {
1280
1281       $csv->combine(
1282         '',                     #  1 | N/A-Leave Empty            CHAR   2
1283         '',                     #  2 | N/A-Leave Empty            CHAR  15
1284         $opt{'tracctnum'},      #  3 | Account Number             CHAR  15
1285         $self->invnum,          #  4 | Invoice Number             CHAR  15
1286         $lineseq++,             #  5 | Line Sequence (sort order) NUM    6
1287         $item->{'description'}, #  6 | Transaction Detail         CHAR 100
1288         $item->{'amount'},      #  7 | Amount                     NUM*   9
1289         '',                     #  8 | Line Format Control**      CHAR   2
1290         '',                     #  9 | Grouping Code              CHAR   2
1291         '',                     # 10 | User Defined               CHAR  15
1292       );
1293
1294       $detail .= $csv->string. "\n";
1295
1296     }
1297
1298   } else {
1299
1300     foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
1301
1302       my($pkg, $setup, $recur, $sdate, $edate);
1303       if ( $cust_bill_pkg->pkgnum ) {
1304
1305         ($pkg, $setup, $recur, $sdate, $edate) = (
1306           $cust_bill_pkg->cust_pkg->part_pkg->pkg,
1307           ( $cust_bill_pkg->setup != 0
1308             ? sprintf("%.2f", $cust_bill_pkg->setup )
1309             : '' ),
1310           ( $cust_bill_pkg->recur != 0
1311             ? sprintf("%.2f", $cust_bill_pkg->recur )
1312             : '' ),
1313           ( $cust_bill_pkg->sdate
1314             ? time2str("%x", $cust_bill_pkg->sdate)
1315             : '' ),
1316           ($cust_bill_pkg->edate
1317             ?time2str("%x", $cust_bill_pkg->edate)
1318             : '' ),
1319         );
1320
1321       } else { #pkgnum tax
1322         next unless $cust_bill_pkg->setup != 0;
1323         my $itemdesc = defined $cust_bill_pkg->dbdef_table->column('itemdesc')
1324                          ? ( $cust_bill_pkg->itemdesc || 'Tax' )
1325                          : 'Tax';
1326         ($pkg, $setup, $recur, $sdate, $edate) =
1327           ( $itemdesc, sprintf("%10.2f",$cust_bill_pkg->setup), '', '', '' );
1328       }
1329
1330       $csv->combine(
1331         'cust_bill_pkg',
1332         $self->invnum,
1333         ( map { '' } (1..11) ),
1334         ($pkg, $setup, $recur, $sdate, $edate)
1335       ) or die "can't create csv";
1336
1337       $detail .= $csv->string. "\n";
1338
1339     }
1340
1341   }
1342
1343   ( $header, $detail );
1344
1345 }
1346
1347 =item comp
1348
1349 Pays this invoice with a compliemntary payment.  If there is an error,
1350 returns the error, otherwise returns false.
1351
1352 =cut
1353
1354 sub comp {
1355   my $self = shift;
1356   my $cust_pay = new FS::cust_pay ( {
1357     'invnum'   => $self->invnum,
1358     'paid'     => $self->owed,
1359     '_date'    => '',
1360     'payby'    => 'COMP',
1361     'payinfo'  => $self->cust_main->payinfo,
1362     'paybatch' => '',
1363   } );
1364   $cust_pay->insert;
1365 }
1366
1367 =item realtime_card
1368
1369 Attempts to pay this invoice with a credit card payment via a
1370 Business::OnlinePayment realtime gateway.  See
1371 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
1372 for supported processors.
1373
1374 =cut
1375
1376 sub realtime_card {
1377   my $self = shift;
1378   $self->realtime_bop( 'CC', @_ );
1379 }
1380
1381 =item realtime_ach
1382
1383 Attempts to pay this invoice with an electronic check (ACH) payment via a
1384 Business::OnlinePayment realtime gateway.  See
1385 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
1386 for supported processors.
1387
1388 =cut
1389
1390 sub realtime_ach {
1391   my $self = shift;
1392   $self->realtime_bop( 'ECHECK', @_ );
1393 }
1394
1395 =item realtime_lec
1396
1397 Attempts to pay this invoice with phone bill (LEC) payment via a
1398 Business::OnlinePayment realtime gateway.  See
1399 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
1400 for supported processors.
1401
1402 =cut
1403
1404 sub realtime_lec {
1405   my $self = shift;
1406   $self->realtime_bop( 'LEC', @_ );
1407 }
1408
1409 sub realtime_bop {
1410   my( $self, $method ) = @_;
1411
1412   my $cust_main = $self->cust_main;
1413   my $balance = $cust_main->balance;
1414   my $amount = ( $balance < $self->owed ) ? $balance : $self->owed;
1415   $amount = sprintf("%.2f", $amount);
1416   return "not run (balance $balance)" unless $amount > 0;
1417
1418   my $description = 'Internet Services';
1419   if ( $conf->exists('business-onlinepayment-description') ) {
1420     my $dtempl = $conf->config('business-onlinepayment-description');
1421
1422     my $agent_obj = $cust_main->agent
1423       or die "can't retreive agent for $cust_main (agentnum ".
1424              $cust_main->agentnum. ")";
1425     my $agent = $agent_obj->agent;
1426     my $pkgs = join(', ',
1427       map { $_->cust_pkg->part_pkg->pkg }
1428         grep { $_->pkgnum } $self->cust_bill_pkg
1429     );
1430     $description = eval qq("$dtempl");
1431   }
1432
1433   $cust_main->realtime_bop($method, $amount,
1434     'description' => $description,
1435     'invnum'      => $self->invnum,
1436   );
1437
1438 }
1439
1440 =item batch_card OPTION => VALUE...
1441
1442 Adds a payment for this invoice to the pending credit card batch (see
1443 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
1444 runs the payment using a realtime gateway.
1445
1446 =cut
1447
1448 sub batch_card {
1449   my ($self, %options) = @_;
1450   my $cust_main = $self->cust_main;
1451
1452   $options{invnum} = $self->invnum;
1453
1454   $cust_main->batch_card(%options);
1455 }
1456
1457 sub _agent_template {
1458   my $self = shift;
1459   $self->cust_main->agent_template;
1460 }
1461
1462 sub _agent_invoice_from {
1463   my $self = shift;
1464   $self->cust_main->agent_invoice_from;
1465 }
1466
1467 =item print_text [ TIME [ , TEMPLATE ] ]
1468
1469 Returns an text invoice, as a list of lines.
1470
1471 TIME an optional value used to control the printing of overdue messages.  The
1472 default is now.  It isn't the date of the invoice; that's the `_date' field.
1473 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
1474 L<Time::Local> and L<Date::Parse> for conversion functions.
1475
1476 =cut
1477
1478 #still some false laziness w/_items stuff (and send_csv)
1479 sub print_text {
1480
1481   my( $self, $today, $template ) = @_;
1482   $today ||= time;
1483
1484 #  my $invnum = $self->invnum;
1485   my $cust_main = $self->cust_main;
1486   $cust_main->payname( $cust_main->first. ' '. $cust_main->getfield('last') )
1487     unless $cust_main->payname && $cust_main->payby !~ /^(CHEK|DCHK)$/;
1488
1489   my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
1490 #  my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
1491   #my $balance_due = $self->owed + $pr_total - $cr_total;
1492   my $balance_due = $self->owed + $pr_total;
1493
1494   #my @collect = ();
1495   #my($description,$amount);
1496   @buf = ();
1497
1498   #previous balance
1499   foreach ( @pr_cust_bill ) {
1500     push @buf, [
1501       "Previous Balance, Invoice #". $_->invnum.
1502                  " (". time2str("%x",$_->_date). ")",
1503       $money_char. sprintf("%10.2f",$_->owed)
1504     ];
1505   }
1506   if (@pr_cust_bill) {
1507     push @buf,['','-----------'];
1508     push @buf,[ 'Total Previous Balance',
1509                 $money_char. sprintf("%10.2f",$pr_total ) ];
1510     push @buf,['',''];
1511   }
1512
1513   #new charges
1514   foreach my $cust_bill_pkg (
1515     ( grep {   $_->pkgnum } $self->cust_bill_pkg ),  #packages first
1516     ( grep { ! $_->pkgnum } $self->cust_bill_pkg ),  #then taxes
1517   ) {
1518
1519     my $desc = $cust_bill_pkg->desc;
1520
1521     if ( $cust_bill_pkg->pkgnum > 0 ) {
1522
1523       if ( $cust_bill_pkg->setup != 0 ) {
1524         my $description = $desc;
1525         $description .= ' Setup' if $cust_bill_pkg->recur != 0;
1526         push @buf, [ $description,
1527                      $money_char. sprintf("%10.2f", $cust_bill_pkg->setup) ];
1528         push @buf,
1529           map { [ "  ". $_->[0]. ": ". $_->[1], '' ] }
1530               $cust_bill_pkg->cust_pkg->h_labels($self->_date);
1531       }
1532
1533       if ( $cust_bill_pkg->recur != 0 ) {
1534         push @buf, [
1535           $desc .
1536             ( $conf->exists('disable_line_item_date_ranges')
1537               ? ''
1538               : " (" . time2str("%x", $cust_bill_pkg->sdate) . " - " .
1539                        time2str("%x", $cust_bill_pkg->edate) . ")"
1540             ),
1541           $money_char. sprintf("%10.2f", $cust_bill_pkg->recur)
1542         ];
1543         push @buf,
1544           map { [ "  ". $_->[0]. ": ". $_->[1], '' ] }
1545               $cust_bill_pkg->cust_pkg->h_labels( $cust_bill_pkg->edate,
1546                                                   $cust_bill_pkg->sdate );
1547       }
1548
1549       push @buf, map { [ "  $_", '' ] } $cust_bill_pkg->details;
1550
1551     } else { #pkgnum tax or one-shot line item
1552
1553       if ( $cust_bill_pkg->setup != 0 ) {
1554         push @buf, [ $desc,
1555                      $money_char. sprintf("%10.2f", $cust_bill_pkg->setup) ];
1556       }
1557       if ( $cust_bill_pkg->recur != 0 ) {
1558         push @buf, [ "$desc (". time2str("%x", $cust_bill_pkg->sdate). " - "
1559                               . time2str("%x", $cust_bill_pkg->edate). ")",
1560                      $money_char. sprintf("%10.2f", $cust_bill_pkg->recur)
1561                    ];
1562       }
1563
1564     }
1565
1566   }
1567
1568   push @buf,['','-----------'];
1569   push @buf,['Total New Charges',
1570              $money_char. sprintf("%10.2f",$self->charged) ];
1571   push @buf,['',''];
1572
1573   push @buf,['','-----------'];
1574   push @buf,['Total Charges',
1575              $money_char. sprintf("%10.2f",$self->charged + $pr_total) ];
1576   push @buf,['',''];
1577
1578   #credits
1579   foreach ( $self->cust_credited ) {
1580
1581     #something more elaborate if $_->amount ne $_->cust_credit->credited ?
1582
1583     my $reason = substr($_->cust_credit->reason,0,32);
1584     $reason .= '...' if length($reason) < length($_->cust_credit->reason);
1585     $reason = " ($reason) " if $reason;
1586     push @buf,[
1587       "Credit #". $_->crednum. " (". time2str("%x",$_->cust_credit->_date) .")".
1588         $reason,
1589       $money_char. sprintf("%10.2f",$_->amount)
1590     ];
1591   }
1592   #foreach ( @cr_cust_credit ) {
1593   #  push @buf,[
1594   #    "Credit #". $_->crednum. " (" . time2str("%x",$_->_date) .")",
1595   #    $money_char. sprintf("%10.2f",$_->credited)
1596   #  ];
1597   #}
1598
1599   #get & print payments
1600   foreach ( $self->cust_bill_pay ) {
1601
1602     #something more elaborate if $_->amount ne ->cust_pay->paid ?
1603
1604     push @buf,[
1605       "Payment received ". time2str("%x",$_->cust_pay->_date ),
1606       $money_char. sprintf("%10.2f",$_->amount )
1607     ];
1608   }
1609
1610   #balance due
1611   my $balance_due_msg = $self->balance_due_msg;
1612
1613   push @buf,['','-----------'];
1614   push @buf,[$balance_due_msg, $money_char.
1615     sprintf("%10.2f", $balance_due ) ];
1616
1617   #create the template
1618   $template ||= $self->_agent_template;
1619   my $templatefile = 'invoice_template';
1620   $templatefile .= "_$template" if length($template);
1621   my @invoice_template = $conf->config($templatefile)
1622     or die "cannot load config file $templatefile";
1623   $invoice_lines = 0;
1624   my $wasfunc = 0;
1625   foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
1626     /invoice_lines\((\d*)\)/;
1627     $invoice_lines += $1 || scalar(@buf);
1628     $wasfunc=1;
1629   }
1630   die "no invoice_lines() functions in template?" unless $wasfunc;
1631   my $invoice_template = new Text::Template (
1632     TYPE   => 'ARRAY',
1633     SOURCE => [ map "$_\n", @invoice_template ],
1634   ) or die "can't create new Text::Template object: $Text::Template::ERROR";
1635   $invoice_template->compile()
1636     or die "can't compile template: $Text::Template::ERROR";
1637
1638   #setup template variables
1639   package FS::cust_bill::_template; #!
1640   use vars qw( $custnum $invnum $date $agent @address $overdue
1641                $page $total_pages @buf );
1642
1643   $custnum = $self->custnum;
1644   $invnum = $self->invnum;
1645   $date = $self->_date;
1646   $agent = $self->cust_main->agent->agent;
1647   $page = 1;
1648
1649   if ( $FS::cust_bill::invoice_lines ) {
1650     $total_pages =
1651       int( scalar(@FS::cust_bill::buf) / $FS::cust_bill::invoice_lines );
1652     $total_pages++
1653       if scalar(@FS::cust_bill::buf) % $FS::cust_bill::invoice_lines;
1654   } else {
1655     $total_pages = 1;
1656   }
1657
1658   #format address (variable for the template)
1659   my $l = 0;
1660   @address = ( '', '', '', '', '', '' );
1661   package FS::cust_bill; #!
1662   $FS::cust_bill::_template::address[$l++] =
1663     $cust_main->payname.
1664       ( ( $cust_main->payby eq 'BILL' ) && $cust_main->payinfo
1665         ? " (P.O. #". $cust_main->payinfo. ")"
1666         : ''
1667       )
1668   ;
1669   $FS::cust_bill::_template::address[$l++] = $cust_main->company
1670     if $cust_main->company;
1671   $FS::cust_bill::_template::address[$l++] = $cust_main->address1;
1672   $FS::cust_bill::_template::address[$l++] = $cust_main->address2
1673     if $cust_main->address2;
1674   $FS::cust_bill::_template::address[$l++] =
1675     $cust_main->city. ", ". $cust_main->state. "  ".  $cust_main->zip;
1676
1677   my $countrydefault = $conf->config('countrydefault') || 'US';
1678   $FS::cust_bill::_template::address[$l++] = code2country($cust_main->country)
1679     unless $cust_main->country eq $countrydefault;
1680
1681         #  #overdue? (variable for the template)
1682         #  $FS::cust_bill::_template::overdue = (
1683         #    $balance_due > 0
1684         #    && $today > $self->_date
1685         ##    && $self->printed > 1
1686         #    && $self->printed > 0
1687         #  );
1688
1689   #and subroutine for the template
1690   sub FS::cust_bill::_template::invoice_lines {
1691     my $lines = shift || scalar(@buf);
1692     map {
1693       scalar(@buf) ? shift @buf : [ '', '' ];
1694     }
1695     ( 1 .. $lines );
1696   }
1697
1698   #and fill it in
1699   $FS::cust_bill::_template::page = 1;
1700   my $lines;
1701   my @collect;
1702   while (@buf) {
1703     push @collect, split("\n",
1704       $invoice_template->fill_in( PACKAGE => 'FS::cust_bill::_template' )
1705     );
1706     $FS::cust_bill::_template::page++;
1707   }
1708
1709   map "$_\n", @collect;
1710
1711 }
1712
1713 =item print_latex [ TIME [ , TEMPLATE ] ]
1714
1715 Internal method - returns a filename of a filled-in LaTeX template for this
1716 invoice (Note: add ".tex" to get the actual filename).
1717
1718 See print_ps and print_pdf for methods that return PostScript and PDF output.
1719
1720 TIME an optional value used to control the printing of overdue messages.  The
1721 default is now.  It isn't the date of the invoice; that's the `_date' field.
1722 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
1723 L<Time::Local> and L<Date::Parse> for conversion functions.
1724
1725 =cut
1726
1727 #still some false laziness w/print_text and print_html (and send_csv) (mostly print_text should use _items stuff though)
1728 sub print_latex {
1729
1730   my( $self, $today, $template ) = @_;
1731   $today ||= time;
1732   warn "FS::cust_bill::print_latex called on $self with suffix $template\n"
1733     if $DEBUG;
1734
1735   my $cust_main = $self->cust_main;
1736   $cust_main->payname( $cust_main->first. ' '. $cust_main->getfield('last') )
1737     unless $cust_main->payname && $cust_main->payby !~ /^(CHEK|DCHK)$/;
1738
1739   my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
1740 #  my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
1741   #my $balance_due = $self->owed + $pr_total - $cr_total;
1742   my $balance_due = $self->owed + $pr_total;
1743
1744   #create the template
1745   $template ||= $self->_agent_template;
1746   my $templatefile = 'invoice_latex';
1747   my $suffix = length($template) ? "_$template" : '';
1748   $templatefile .= $suffix;
1749   my @invoice_template = map "$_\n", $conf->config($templatefile)
1750     or die "cannot load config file $templatefile";
1751
1752   my($format, $text_template);
1753   if ( grep { /^%%Detail/ } @invoice_template ) {
1754     #change this to a die when the old code is removed
1755     warn "old-style invoice template $templatefile; ".
1756          "patch with conf/invoice_latex.diff or use new conf/invoice_latex*\n";
1757     $format = 'old';
1758   } else {
1759     $format = 'Text::Template';
1760     $text_template = new Text::Template(
1761       TYPE => 'ARRAY',
1762       SOURCE => \@invoice_template,
1763       DELIMITERS => [ '[@--', '--@]' ],
1764     );
1765
1766     $text_template->compile()
1767       or die 'While compiling ' . $templatefile . ': ' . $Text::Template::ERROR;
1768   }
1769
1770   my $returnaddress;
1771   if ( length($conf->config_orbase('invoice_latexreturnaddress', $template)) ) {
1772     $returnaddress = join("\n",
1773       $conf->config_orbase('invoice_latexreturnaddress', $template)
1774     );
1775   } else {
1776     $returnaddress = '~';
1777   }
1778
1779   my %invoice_data = (
1780     'custnum'      => $self->custnum,
1781     'invnum'       => $self->invnum,
1782     'date'         => time2str('%b %o, %Y', $self->_date),
1783     'today'        => time2str('%b %o, %Y', $today),
1784     'agent'        => _latex_escape($cust_main->agent->agent),
1785     'payname'      => _latex_escape($cust_main->payname),
1786     'company'      => _latex_escape($cust_main->company),
1787     'address1'     => _latex_escape($cust_main->address1),
1788     'address2'     => _latex_escape($cust_main->address2),
1789     'city'         => _latex_escape($cust_main->city),
1790     'state'        => _latex_escape($cust_main->state),
1791     'zip'          => _latex_escape($cust_main->zip),
1792     'footer'       => join("\n", $conf->config_orbase('invoice_latexfooter', $template) ),
1793     'smallfooter'  => join("\n", $conf->config_orbase('invoice_latexsmallfooter', $template) ),
1794     'returnaddress' => $returnaddress,
1795     'quantity'     => 1,
1796     'terms'        => $conf->config('invoice_default_terms') || 'Payable upon receipt',
1797     #'notes'        => join("\n", $conf->config('invoice_latexnotes') ),
1798     'conf_dir'     => "$FS::UID::conf_dir/conf.$FS::UID::datasrc",
1799   );
1800
1801   my $countrydefault = $conf->config('countrydefault') || 'US';
1802   if ( $cust_main->country eq $countrydefault ) {
1803     $invoice_data{'country'} = '';
1804   } else {
1805     $invoice_data{'country'} = _latex_escape(code2country($cust_main->country));
1806   }
1807
1808   $invoice_data{'notes'} =
1809     join("\n",
1810 #  #do variable substitutions in notes
1811 #      map { my $b=$_; $b =~ s/\$(\w+)/$invoice_data{$1}/eg; $b }
1812         $conf->config_orbase('invoice_latexnotes', $template)
1813     );
1814   warn "invoice notes: ". $invoice_data{'notes'}. "\n"
1815     if $DEBUG;
1816
1817   $invoice_data{'footer'} =~ s/\n+$//;
1818   $invoice_data{'smallfooter'} =~ s/\n+$//;
1819   $invoice_data{'notes'} =~ s/\n+$//;
1820
1821   $invoice_data{'po_line'} =
1822     (  $cust_main->payby eq 'BILL' && $cust_main->payinfo )
1823       ? _latex_escape("Purchase Order #". $cust_main->payinfo)
1824       : '~';
1825
1826   my @filled_in = ();
1827   if ( $format eq 'old' ) {
1828
1829     my @line_item = ();
1830     my @total_item = ();
1831     while ( @invoice_template ) {
1832       my $line = shift @invoice_template;
1833
1834       if ( $line =~ /^%%Detail\s*$/ ) {
1835
1836         while ( ( my $line_item_line = shift @invoice_template )
1837                 !~ /^%%EndDetail\s*$/                            ) {
1838           push @line_item, $line_item_line;
1839         }
1840         foreach my $line_item ( $self->_items ) {
1841         #foreach my $line_item ( $self->_items_pkg ) {
1842           $invoice_data{'ref'} = $line_item->{'pkgnum'};
1843           $invoice_data{'description'} =
1844             _latex_escape($line_item->{'description'});
1845           if ( exists $line_item->{'ext_description'} ) {
1846             $invoice_data{'description'} .=
1847               "\\tabularnewline\n~~".
1848               join( "\\tabularnewline\n~~",
1849                     map _latex_escape($_), @{$line_item->{'ext_description'}}
1850                   );
1851           }
1852           $invoice_data{'amount'} = $line_item->{'amount'};
1853           $invoice_data{'product_code'} = $line_item->{'pkgpart'} || 'N/A';
1854           push @filled_in,
1855             map { my $b=$_; $b =~ s/\$(\w+)/$invoice_data{$1}/eg; $b } @line_item;
1856         }
1857
1858       } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
1859
1860         while ( ( my $total_item_line = shift @invoice_template )
1861                 !~ /^%%EndTotalDetails\s*$/                      ) {
1862           push @total_item, $total_item_line;
1863         }
1864
1865         my @total_fill = ();
1866
1867         my $taxtotal = 0;
1868         foreach my $tax ( $self->_items_tax ) {
1869           $invoice_data{'total_item'} = _latex_escape($tax->{'description'});
1870           $taxtotal += $tax->{'amount'};
1871           $invoice_data{'total_amount'} = '\dollar '. $tax->{'amount'};
1872           push @total_fill,
1873             map { my $b=$_; $b =~ s/\$(\w+)/$invoice_data{$1}/eg; $b }
1874                 @total_item;
1875         }
1876
1877         if ( $taxtotal ) {
1878           $invoice_data{'total_item'} = 'Sub-total';
1879           $invoice_data{'total_amount'} =
1880             '\dollar '. sprintf('%.2f', $self->charged - $taxtotal );
1881           unshift @total_fill,
1882             map { my $b=$_; $b =~ s/\$(\w+)/$invoice_data{$1}/eg; $b }
1883                 @total_item;
1884         }
1885
1886         $invoice_data{'total_item'} = '\textbf{Total}';
1887         $invoice_data{'total_amount'} =
1888           '\textbf{\dollar '. sprintf('%.2f', $self->charged + $pr_total ). '}';
1889         push @total_fill,
1890           map { my $b=$_; $b =~ s/\$(\w+)/$invoice_data{$1}/eg; $b }
1891               @total_item;
1892
1893         #foreach my $thing ( sort { $a->_date <=> $b->_date } $self->_items_credits, $self->_items_payments
1894
1895         # credits
1896         foreach my $credit ( $self->_items_credits ) {
1897           $invoice_data{'total_item'} = _latex_escape($credit->{'description'});
1898           #$credittotal
1899           $invoice_data{'total_amount'} = '-\dollar '. $credit->{'amount'};
1900           push @total_fill,
1901             map { my $b=$_; $b =~ s/\$(\w+)/$invoice_data{$1}/eg; $b }
1902                 @total_item;
1903         }
1904
1905         # payments
1906         foreach my $payment ( $self->_items_payments ) {
1907           $invoice_data{'total_item'} = _latex_escape($payment->{'description'});
1908           #$paymenttotal
1909           $invoice_data{'total_amount'} = '-\dollar '. $payment->{'amount'};
1910           push @total_fill,
1911             map { my $b=$_; $b =~ s/\$(\w+)/$invoice_data{$1}/eg; $b }
1912                 @total_item;
1913         }
1914
1915         $invoice_data{'total_item'} = '\textbf{'. $self->balance_due_msg. '}';
1916         $invoice_data{'total_amount'} =
1917           '\textbf{\dollar '. sprintf('%.2f', $self->owed + $pr_total ). '}';
1918         push @total_fill,
1919           map { my $b=$_; $b =~ s/\$(\w+)/$invoice_data{$1}/eg; $b }
1920               @total_item;
1921
1922         push @filled_in, @total_fill;
1923
1924       } else {
1925         #$line =~ s/\$(\w+)/$invoice_data{$1}/eg;
1926         $line =~ s/\$(\w+)/exists($invoice_data{$1}) ? $invoice_data{$1} : nounder($1)/eg;
1927         push @filled_in, $line;
1928       }
1929
1930     }
1931
1932     sub nounder {
1933       my $var = $1;
1934       $var =~ s/_/\-/g;
1935       $var;
1936     }
1937
1938   } elsif ( $format eq 'Text::Template' ) {
1939
1940     my @detail_items = ();
1941     my @total_items = ();
1942
1943     $invoice_data{'detail_items'} = \@detail_items;
1944     $invoice_data{'total_items'} = \@total_items;
1945
1946     foreach my $line_item ( $self->_items ) {
1947       my $detail = {
1948         ext_description => [],
1949       };
1950       $detail->{'ref'} = $line_item->{'pkgnum'};
1951       $detail->{'quantity'} = 1;
1952       $detail->{'description'} = _latex_escape($line_item->{'description'});
1953       if ( exists $line_item->{'ext_description'} ) {
1954         @{$detail->{'ext_description'}} = map {
1955           _latex_escape($_);
1956         } @{$line_item->{'ext_description'}};
1957       }
1958       $detail->{'amount'} = $line_item->{'amount'};
1959       $detail->{'product_code'} = $line_item->{'pkgpart'} || 'N/A';
1960
1961       push @detail_items, $detail;
1962     }
1963
1964
1965     my $taxtotal = 0;
1966     foreach my $tax ( $self->_items_tax ) {
1967       my $total = {};
1968       $total->{'total_item'} = _latex_escape($tax->{'description'});
1969       $taxtotal += $tax->{'amount'};
1970       $total->{'total_amount'} = '\dollar '. $tax->{'amount'};
1971       push @total_items, $total;
1972     }
1973
1974     if ( $taxtotal ) {
1975       my $total = {};
1976       $total->{'total_item'} = 'Sub-total';
1977       $total->{'total_amount'} =
1978         '\dollar '. sprintf('%.2f', $self->charged - $taxtotal );
1979       unshift @total_items, $total;
1980     }
1981
1982     {
1983       my $total = {};
1984       $total->{'total_item'} = '\textbf{Total}';
1985       $total->{'total_amount'} =
1986         '\textbf{\dollar '. sprintf('%.2f', $self->charged + $pr_total ). '}';
1987       push @total_items, $total;
1988     }
1989
1990     #foreach my $thing ( sort { $a->_date <=> $b->_date } $self->_items_credits, $self->_items_payments
1991
1992     # credits
1993     foreach my $credit ( $self->_items_credits ) {
1994       my $total;
1995       $total->{'total_item'} = _latex_escape($credit->{'description'});
1996       #$credittotal
1997       $total->{'total_amount'} = '-\dollar '. $credit->{'amount'};
1998       push @total_items, $total;
1999     }
2000
2001     # payments
2002     foreach my $payment ( $self->_items_payments ) {
2003       my $total = {};
2004       $total->{'total_item'} = _latex_escape($payment->{'description'});
2005       #$paymenttotal
2006       $total->{'total_amount'} = '-\dollar '. $payment->{'amount'};
2007       push @total_items, $total;
2008     }
2009
2010     {
2011       my $total;
2012       $total->{'total_item'} = '\textbf{'. $self->balance_due_msg. '}';
2013       $total->{'total_amount'} =
2014         '\textbf{\dollar '. sprintf('%.2f', $self->owed + $pr_total ). '}';
2015       push @total_items, $total;
2016     }
2017
2018   } else {
2019     die "guru meditation #54";
2020   }
2021
2022   my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
2023   my $fh = new File::Temp( TEMPLATE => 'invoice.'. $self->invnum. '.XXXXXXXX',
2024                            DIR      => $dir,
2025                            SUFFIX   => '.tex',
2026                            UNLINK   => 0,
2027                          ) or die "can't open temp file: $!\n";
2028   if ( $format eq 'old' ) {
2029     print $fh join('', @filled_in );
2030   } elsif ( $format eq 'Text::Template' ) {
2031     $text_template->fill_in(OUTPUT => $fh, HASH => \%invoice_data);
2032   } else {
2033     die "guru meditation #32";
2034   }
2035   close $fh;
2036
2037   $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
2038   return $1;
2039
2040 }
2041
2042 =item print_ps [ TIME [ , TEMPLATE ] ]
2043
2044 Returns an postscript invoice, as a scalar.
2045
2046 TIME an optional value used to control the printing of overdue messages.  The
2047 default is now.  It isn't the date of the invoice; that's the `_date' field.
2048 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
2049 L<Time::Local> and L<Date::Parse> for conversion functions.
2050
2051 =cut
2052
2053 sub print_ps {
2054   my $self = shift;
2055
2056   my $file = $self->print_latex(@_);
2057   FS::Misc::generate_ps($file);
2058
2059 }
2060
2061 =item print_pdf [ TIME [ , TEMPLATE ] ]
2062
2063 Returns an PDF invoice, as a scalar.
2064
2065 TIME an optional value used to control the printing of overdue messages.  The
2066 default is now.  It isn't the date of the invoice; that's the `_date' field.
2067 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
2068 L<Time::Local> and L<Date::Parse> for conversion functions.
2069
2070 =cut
2071
2072 sub print_pdf {
2073   my $self = shift;
2074
2075   my $file = $self->print_latex(@_);
2076
2077   my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
2078   chdir($dir);
2079
2080   #system('pdflatex', "$file.tex");
2081   #system('pdflatex', "$file.tex");
2082   #! LaTeX Error: Unknown graphics extension: .eps.
2083
2084   my $sfile = shell_quote $file;
2085
2086   system("pslatex $sfile.tex >/dev/null 2>&1") == 0
2087     or die "pslatex $file.tex failed; see $file.log for details?\n";
2088   system("pslatex $sfile.tex >/dev/null 2>&1") == 0
2089     or die "pslatex $file.tex failed; see $file.log for details?\n";
2090
2091   #system('dvipdf', "$file.dvi", "$file.pdf" );
2092   system(
2093     "dvips -q -t letter -f $sfile.dvi ".
2094     "| gs -q -dNOPAUSE -dBATCH -sDEVICE=pdfwrite -sOutputFile=$sfile.pdf ".
2095     "     -c save pop -"
2096   ) == 0
2097     or die "dvips | gs failed: $!";
2098
2099   open(PDF, "<$file.pdf")
2100     or die "can't open $file.pdf: $! (error in LaTeX template?)\n";
2101
2102   unlink("$file.dvi", "$file.log", "$file.aux", "$file.pdf", "$file.tex");
2103
2104   my $pdf = '';
2105   while (<PDF>) {
2106     $pdf .= $_;
2107   }
2108
2109   close PDF;
2110
2111   return $pdf;
2112
2113 }
2114
2115 =item print_html [ TIME [ , TEMPLATE [ , CID ] ] ]
2116
2117 Returns an HTML invoice, as a scalar.
2118
2119 TIME an optional value used to control the printing of overdue messages.  The
2120 default is now.  It isn't the date of the invoice; that's the `_date' field.
2121 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
2122 L<Time::Local> and L<Date::Parse> for conversion functions.
2123
2124 CID is a MIME Content-ID used to create a "cid:" URL for the logo image, used
2125 when emailing the invoice as part of a multipart/related MIME email.
2126
2127 =cut
2128
2129 #some falze laziness w/print_text and print_latex (and send_csv)
2130 sub print_html {
2131   my( $self, $today, $template, $cid ) = @_;
2132   $today ||= time;
2133
2134   my $cust_main = $self->cust_main;
2135   $cust_main->payname( $cust_main->first. ' '. $cust_main->getfield('last') )
2136     unless $cust_main->payname && $cust_main->payby !~ /^(CHEK|DCHK)$/;
2137
2138   $template ||= $self->_agent_template;
2139   my $templatefile = 'invoice_html';
2140   my $suffix = length($template) ? "_$template" : '';
2141   $templatefile .= $suffix;
2142   my @html_template = map "$_\n", $conf->config($templatefile)
2143     or die "cannot load config file $templatefile";
2144
2145   my $html_template = new Text::Template(
2146     TYPE   => 'ARRAY',
2147     SOURCE => \@html_template,
2148     DELIMITERS => [ '<%=', '%>' ],
2149   );
2150
2151   $html_template->compile()
2152     or die 'While compiling ' . $templatefile . ': ' . $Text::Template::ERROR;
2153
2154   my %invoice_data = (
2155     'custnum'      => $self->custnum,
2156     'invnum'       => $self->invnum,
2157     'date'         => time2str('%b&nbsp;%o,&nbsp;%Y', $self->_date),
2158     'today'        => time2str('%b %o, %Y', $today),
2159     'agent'        => encode_entities($cust_main->agent->agent),
2160     'payname'      => encode_entities($cust_main->payname),
2161     'company'      => encode_entities($cust_main->company),
2162     'address1'     => encode_entities($cust_main->address1),
2163     'address2'     => encode_entities($cust_main->address2),
2164     'city'         => encode_entities($cust_main->city),
2165     'state'        => encode_entities($cust_main->state),
2166     'zip'          => encode_entities($cust_main->zip),
2167     'terms'        => $conf->config('invoice_default_terms')
2168                       || 'Payable upon receipt',
2169     'cid'          => $cid,
2170     'template'     => $template,
2171 #    'conf_dir'     => "$FS::UID::conf_dir/conf.$FS::UID::datasrc",
2172   );
2173
2174   if (
2175          defined( $conf->config_orbase('invoice_htmlreturnaddress', $template) )
2176       && length(  $conf->config_orbase('invoice_htmlreturnaddress', $template) )
2177   ) {
2178     $invoice_data{'returnaddress'} =
2179       join("\n", $conf->config_orbase('invoice_htmlreturnaddress', $template) );
2180   } else {
2181     $invoice_data{'returnaddress'} =
2182       join("\n", map {
2183                        s/~/&nbsp;/g;
2184                        s/\\\\\*?\s*$/<BR>/;
2185                        s/\\hyphenation\{[\w\s\-]+\}//;
2186                        $_;
2187                      }
2188                      $conf->config_orbase( 'invoice_latexreturnaddress',
2189                                            $template
2190                                          )
2191           );
2192   }
2193
2194   my $countrydefault = $conf->config('countrydefault') || 'US';
2195   if ( $cust_main->country eq $countrydefault ) {
2196     $invoice_data{'country'} = '';
2197   } else {
2198     $invoice_data{'country'} =
2199       encode_entities(code2country($cust_main->country));
2200   }
2201
2202   if (
2203          defined( $conf->config_orbase('invoice_htmlnotes', $template) )
2204       && length(  $conf->config_orbase('invoice_htmlnotes', $template) )
2205   ) {
2206     $invoice_data{'notes'} =
2207       join("\n", $conf->config_orbase('invoice_htmlnotes', $template) );
2208   } else {
2209     $invoice_data{'notes'} =
2210       join("\n", map {
2211                        s/%%(.*)$/<!-- $1 -->/g;
2212                        s/\\section\*\{\\textsc\{(.)(.*)\}\}/<p><b><font size="+1">$1<\/font>\U$2<\/b>/g;
2213                        s/\\begin\{enumerate\}/<ol>/g;
2214                        s/\\item /  <li>/g;
2215                        s/\\end\{enumerate\}/<\/ol>/g;
2216                        s/\\textbf\{(.*)\}/<b>$1<\/b>/g;
2217                        s/\\\\\*/ /;
2218                        s/\\dollar ?/\$/g;
2219                        $_;
2220                      }
2221                      $conf->config_orbase('invoice_latexnotes', $template)
2222           );
2223   }
2224
2225 #  #do variable substitutions in notes
2226 #  $invoice_data{'notes'} =
2227 #    join("\n",
2228 #      map { my $b=$_; $b =~ s/\$(\w+)/$invoice_data{$1}/eg; $b }
2229 #        $conf->config_orbase('invoice_latexnotes', $suffix)
2230 #    );
2231
2232   if (
2233          defined( $conf->config_orbase('invoice_htmlfooter', $template) )
2234       && length(  $conf->config_orbase('invoice_htmlfooter', $template) )
2235   ) {
2236    $invoice_data{'footer'} =
2237      join("\n", $conf->config_orbase('invoice_htmlfooter', $template) );
2238   } else {
2239    $invoice_data{'footer'} =
2240        join("\n", map { s/~/&nbsp;/g; s/\\\\\*?\s*$/<BR>/; $_; }
2241                       $conf->config_orbase('invoice_latexfooter', $template)
2242            );
2243   }
2244
2245   $invoice_data{'po_line'} =
2246     (  $cust_main->payby eq 'BILL' && $cust_main->payinfo )
2247       ? encode_entities("Purchase Order #". $cust_main->payinfo)
2248       : '';
2249
2250   my $money_char = $conf->config('money_char') || '$';
2251
2252   foreach my $line_item ( $self->_items ) {
2253     my $detail = {
2254       ext_description => [],
2255     };
2256     $detail->{'ref'} = $line_item->{'pkgnum'};
2257     $detail->{'description'} = encode_entities($line_item->{'description'});
2258     if ( exists $line_item->{'ext_description'} ) {
2259       @{$detail->{'ext_description'}} = map {
2260         encode_entities($_);
2261       } @{$line_item->{'ext_description'}};
2262     }
2263     $detail->{'amount'} = $money_char. $line_item->{'amount'};
2264     $detail->{'product_code'} = $line_item->{'pkgpart'} || 'N/A';
2265
2266     push @{$invoice_data{'detail_items'}}, $detail;
2267   }
2268
2269
2270   my $taxtotal = 0;
2271   foreach my $tax ( $self->_items_tax ) {
2272     my $total = {};
2273     $total->{'total_item'} = encode_entities($tax->{'description'});
2274     $taxtotal += $tax->{'amount'};
2275     $total->{'total_amount'} = $money_char. $tax->{'amount'};
2276     push @{$invoice_data{'total_items'}}, $total;
2277   }
2278
2279   if ( $taxtotal ) {
2280     my $total = {};
2281     $total->{'total_item'} = 'Sub-total';
2282     $total->{'total_amount'} =
2283       $money_char. sprintf('%.2f', $self->charged - $taxtotal );
2284     unshift @{$invoice_data{'total_items'}}, $total;
2285   }
2286
2287   my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
2288   {
2289     my $total = {};
2290     $total->{'total_item'} = '<b>Total</b>';
2291     $total->{'total_amount'} =
2292       "<b>$money_char".  sprintf('%.2f', $self->charged + $pr_total ). '</b>';
2293     push @{$invoice_data{'total_items'}}, $total;
2294   }
2295
2296   #foreach my $thing ( sort { $a->_date <=> $b->_date } $self->_items_credits, $self->_items_payments
2297
2298   # credits
2299   foreach my $credit ( $self->_items_credits ) {
2300     my $total;
2301     $total->{'total_item'} = encode_entities($credit->{'description'});
2302     #$credittotal
2303     $total->{'total_amount'} = "-$money_char". $credit->{'amount'};
2304     push @{$invoice_data{'total_items'}}, $total;
2305   }
2306
2307   # payments
2308   foreach my $payment ( $self->_items_payments ) {
2309     my $total = {};
2310     $total->{'total_item'} = encode_entities($payment->{'description'});
2311     #$paymenttotal
2312     $total->{'total_amount'} = "-$money_char". $payment->{'amount'};
2313     push @{$invoice_data{'total_items'}}, $total;
2314   }
2315
2316   {
2317     my $total;
2318     $total->{'total_item'} = '<b>'. $self->balance_due_msg. '</b>';
2319     $total->{'total_amount'} =
2320       "<b>$money_char".  sprintf('%.2f', $self->owed + $pr_total ). '</b>';
2321     push @{$invoice_data{'total_items'}}, $total;
2322   }
2323
2324   $html_template->fill_in( HASH => \%invoice_data);
2325 }
2326
2327 # quick subroutine for print_latex
2328 #
2329 # There are ten characters that LaTeX treats as special characters, which
2330 # means that they do not simply typeset themselves:
2331 #      # $ % & ~ _ ^ \ { }
2332 #
2333 # TeX ignores blanks following an escaped character; if you want a blank (as
2334 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
2335
2336 sub _latex_escape {
2337   my $value = shift;
2338   $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
2339   $value =~ s/([<>])/\$$1\$/g;
2340   $value;
2341 }
2342
2343 #utility methods for print_*
2344
2345 sub balance_due_msg {
2346   my $self = shift;
2347   my $msg = 'Balance Due';
2348   return $msg unless $conf->exists('invoice_default_terms');
2349   if ( $conf->config('invoice_default_terms') =~ /^\s*Net\s*(\d+)\s*$/ ) {
2350     $msg .= ' - Please pay by '. time2str("%x", $self->_date + ($1*86400) );
2351   } elsif ( $conf->config('invoice_default_terms') ) {
2352     $msg .= ' - '. $conf->config('invoice_default_terms');
2353   }
2354   $msg;
2355 }
2356
2357 sub _items {
2358   my $self = shift;
2359   my @display = scalar(@_)
2360                 ? @_
2361                 : qw( _items_previous _items_pkg );
2362                 #: qw( _items_pkg );
2363                 #: qw( _items_previous _items_pkg _items_tax _items_credits _items_payments );
2364   my @b = ();
2365   foreach my $display ( @display ) {
2366     push @b, $self->$display(@_);
2367   }
2368   @b;
2369 }
2370
2371 sub _items_previous {
2372   my $self = shift;
2373   my $cust_main = $self->cust_main;
2374   my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
2375   my @b = ();
2376   foreach ( @pr_cust_bill ) {
2377     push @b, {
2378       'description' => 'Previous Balance, Invoice #'. $_->invnum.
2379                        ' ('. time2str('%x',$_->_date). ')',
2380       #'pkgpart'     => 'N/A',
2381       'pkgnum'      => 'N/A',
2382       'amount'      => sprintf("%.2f", $_->owed),
2383     };
2384   }
2385   @b;
2386
2387   #{
2388   #    'description'     => 'Previous Balance',
2389   #    #'pkgpart'         => 'N/A',
2390   #    'pkgnum'          => 'N/A',
2391   #    'amount'          => sprintf("%10.2f", $pr_total ),
2392   #    'ext_description' => [ map {
2393   #                                 "Invoice ". $_->invnum.
2394   #                                 " (". time2str("%x",$_->_date). ") ".
2395   #                                 sprintf("%10.2f", $_->owed)
2396   #                         } @pr_cust_bill ],
2397
2398   #};
2399 }
2400
2401 sub _items_pkg {
2402   my $self = shift;
2403   my @cust_bill_pkg = grep { $_->pkgnum } $self->cust_bill_pkg;
2404   $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
2405 }
2406
2407 sub _items_tax {
2408   my $self = shift;
2409   my @cust_bill_pkg = grep { ! $_->pkgnum } $self->cust_bill_pkg;
2410   $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
2411 }
2412
2413 sub _items_cust_bill_pkg {
2414   my $self = shift;
2415   my $cust_bill_pkg = shift;
2416
2417   my @b = ();
2418   foreach my $cust_bill_pkg ( @$cust_bill_pkg ) {
2419
2420     my $desc = $cust_bill_pkg->desc;
2421
2422     if ( $cust_bill_pkg->pkgnum > 0 ) {
2423
2424       if ( $cust_bill_pkg->setup != 0 ) {
2425         my $description = $desc;
2426         $description .= ' Setup' if $cust_bill_pkg->recur != 0;
2427         my @d = $cust_bill_pkg->cust_pkg->h_labels_short($self->_date);
2428         push @d, $cust_bill_pkg->details if $cust_bill_pkg->recur == 0;
2429         push @b, {
2430           description     => $description,
2431           #pkgpart         => $part_pkg->pkgpart,
2432           pkgnum          => $cust_bill_pkg->pkgnum,
2433           amount          => sprintf("%.2f", $cust_bill_pkg->setup),
2434           ext_description => \@d,
2435         };
2436       }
2437
2438       if ( $cust_bill_pkg->recur != 0 ) {
2439         push @b, {
2440           description     => $desc .
2441                              ( $conf->exists('disable_line_item_date_ranges')
2442                                ? ''
2443                                : " (" .time2str("%x", $cust_bill_pkg->sdate).
2444                                  " - ".time2str("%x", $cust_bill_pkg->edate).")"
2445                              ),
2446           #pkgpart         => $part_pkg->pkgpart,
2447           pkgnum          => $cust_bill_pkg->pkgnum,
2448           amount          => sprintf("%.2f", $cust_bill_pkg->recur),
2449           ext_description =>
2450             [ $cust_bill_pkg->cust_pkg->h_labels_short( $cust_bill_pkg->edate,
2451                                                         $cust_bill_pkg->sdate),
2452               $cust_bill_pkg->details,
2453             ],
2454         };
2455       }
2456
2457     } else { #pkgnum tax or one-shot line item (??)
2458
2459       if ( $cust_bill_pkg->setup != 0 ) {
2460         push @b, {
2461           'description' => $desc,
2462           'amount'      => sprintf("%.2f", $cust_bill_pkg->setup),
2463         };
2464       }
2465       if ( $cust_bill_pkg->recur != 0 ) {
2466         push @b, {
2467           'description' => "$desc (".
2468                            time2str("%x", $cust_bill_pkg->sdate). ' - '.
2469                            time2str("%x", $cust_bill_pkg->edate). ')',
2470           'amount'      => sprintf("%.2f", $cust_bill_pkg->recur),
2471         };
2472       }
2473
2474     }
2475
2476   }
2477
2478   @b;
2479
2480 }
2481
2482 sub _items_credits {
2483   my $self = shift;
2484
2485   my @b;
2486   #credits
2487   foreach ( $self->cust_credited ) {
2488
2489     #something more elaborate if $_->amount ne $_->cust_credit->credited ?
2490
2491     my $reason = $_->cust_credit->reason;
2492     #my $reason = substr($_->cust_credit->reason,0,32);
2493     #$reason .= '...' if length($reason) < length($_->cust_credit->reason);
2494     $reason = " ($reason) " if $reason;
2495     push @b, {
2496       #'description' => 'Credit ref\#'. $_->crednum.
2497       #                 " (". time2str("%x",$_->cust_credit->_date) .")".
2498       #                 $reason,
2499       'description' => 'Credit applied '.
2500                        time2str("%x",$_->cust_credit->_date). $reason,
2501       'amount'      => sprintf("%.2f",$_->amount),
2502     };
2503   }
2504   #foreach ( @cr_cust_credit ) {
2505   #  push @buf,[
2506   #    "Credit #". $_->crednum. " (" . time2str("%x",$_->_date) .")",
2507   #    $money_char. sprintf("%10.2f",$_->credited)
2508   #  ];
2509   #}
2510
2511   @b;
2512
2513 }
2514
2515 sub _items_payments {
2516   my $self = shift;
2517
2518   my @b;
2519   #get & print payments
2520   foreach ( $self->cust_bill_pay ) {
2521
2522     #something more elaborate if $_->amount ne ->cust_pay->paid ?
2523
2524     push @b, {
2525       'description' => "Payment received ".
2526                        time2str("%x",$_->cust_pay->_date ),
2527       'amount'      => sprintf("%.2f", $_->amount )
2528     };
2529   }
2530
2531   @b;
2532
2533 }
2534
2535
2536 =back
2537
2538 =head1 SUBROUTINES
2539
2540 =over 4
2541
2542 =item reprint
2543
2544 =cut
2545
2546 sub process_reprint {
2547   process_re_X('print', @_);
2548 }
2549
2550 =item reemail
2551
2552 =cut
2553
2554 sub process_reemail {
2555   process_re_X('email', @_);
2556 }
2557
2558 =item refax
2559
2560 =cut
2561
2562 sub process_refax {
2563   process_re_X('fax', @_);
2564 }
2565
2566 use Storable qw(thaw);
2567 use Data::Dumper;
2568 use MIME::Base64;
2569 sub process_re_X {
2570   my( $method, $job ) = ( shift, shift );
2571   warn "process_re_X $method for job $job\n" if $DEBUG;
2572
2573   my $param = thaw(decode_base64(shift));
2574   warn Dumper($param) if $DEBUG;
2575
2576   re_X(
2577     $method,
2578     $job,
2579     %$param,
2580   );
2581
2582 }
2583
2584 sub re_X {
2585   my($method, $job, %param ) = @_;
2586   if ( $DEBUG ) {
2587     warn "re_X $method for job $job with param:\n".
2588          join( '', map { "  $_ => ". $param{$_}. "\n" } keys %param );
2589   }
2590
2591   #some false laziness w/search/cust_bill.html
2592   my $distinct = '';
2593   my $orderby = 'ORDER BY cust_bill._date';
2594
2595   my $extra_sql = ' WHERE '. FS::cust_bill->search_sql(\%param);
2596
2597   my $addl_from = 'left join cust_main using ( custnum )';
2598
2599   my @cust_bill = qsearch( 'cust_bill',
2600                            {},
2601                            #"$distinct cust_bill.*",
2602                            "cust_bill.*",
2603                            $extra_sql,
2604                            '',
2605                            $addl_from
2606                          );
2607
2608   my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
2609   foreach my $cust_bill ( @cust_bill ) {
2610     $cust_bill->$method();
2611
2612     if ( $job ) { #progressbar foo
2613       $num++;
2614       if ( time - $min_sec > $last ) {
2615         my $error = $job->update_statustext(
2616           int( 100 * $num / scalar(@cust_bill) )
2617         );
2618         die $error if $error;
2619         $last = time;
2620       }
2621     }
2622
2623   }
2624
2625 }
2626
2627 =back
2628
2629 =head1 CLASS METHODS
2630
2631 =over 4
2632
2633 =item owed_sql
2634
2635 Returns an SQL fragment to retreive the amount owed (charged minus credited and paid).
2636
2637 =cut
2638
2639 sub owed_sql {
2640   my $class = shift;
2641   'charged - '. $class->paid_sql. ' - '. $class->credited_sql;
2642 }
2643
2644 =item net_sql
2645
2646 Returns an SQL fragment to retreive the net amount (charged minus credited).
2647
2648 =cut
2649
2650 sub net_sql {
2651   my $class = shift;
2652   'charged - '. $class->credited_sql;
2653 }
2654
2655 =item paid_sql
2656
2657 Returns an SQL fragment to retreive the amount paid against this invoice.
2658
2659 =cut
2660
2661 sub paid_sql {
2662   #my $class = shift;
2663   "( SELECT COALESCE(SUM(amount),0) FROM cust_bill_pay
2664        WHERE cust_bill.invnum = cust_bill_pay.invnum   )";
2665 }
2666
2667 =item credited_sql
2668
2669 Returns an SQL fragment to retreive the amount credited against this invoice.
2670
2671 =cut
2672
2673 sub credited_sql {
2674   #my $class = shift;
2675   "( SELECT COALESCE(SUM(amount),0) FROM cust_credit_bill
2676        WHERE cust_bill.invnum = cust_credit_bill.invnum   )";
2677 }
2678
2679 =item search_sql HASHREF
2680
2681 Class method which returns an SQL WHERE fragment to search for parameters
2682 specified in HASHREF.  Valid parameters are
2683
2684 =over 4
2685
2686 =item begin - epoch date (UNIX timestamp) setting a lower bound for _date values
2687
2688 =item end - epoch date (UNIX timestamp) setting an upper bound for _date values
2689
2690 =item invnum_min
2691
2692 =item invnum_max
2693
2694 =item agentnum
2695
2696 =item owed
2697
2698 =item net
2699
2700 =item days
2701
2702 =item newest_percust
2703
2704 =back
2705
2706 Note: validates all passed-in data; i.e. safe to use with unchecked CGI params.
2707
2708 =cut
2709
2710 sub search_sql {
2711   my($class, $param) = @_;
2712   my @search = ();
2713
2714   if ( $param->{'begin'} =~ /^(\d+)$/ ) {
2715     push @search, "cust_bill._date >= $1";
2716   }
2717   if ( $param->{'end'} =~ /^(\d+)$/ ) {
2718     push @search, "cust_bill._date < $1";
2719   }
2720   if ( $param->{'invnum_min'} =~ /^(\d+)$/ ) {
2721     push @search, "cust_bill.invnum >= $1";
2722   }
2723   if ( $param->{'invnum_max'} =~ /^(\d+)$/ ) {
2724     push @search, "cust_bill.invnum <= $1";
2725   }
2726   if ( $param->{'agentnum'} =~ /^(\d+)$/ ) {
2727     push @search, "cust_main.agentnum = $1";
2728   }
2729
2730   push @search, '0 != '. FS::cust_bill->owed_sql
2731     if $param->{'open'};
2732
2733   push @search, '0 != '. FS::cust_bill->net_sql
2734     if $param->{'net'};
2735
2736   push @search, "cust_bill._date < ". (time-86400*$param->{'days'})
2737     if $param->{'days'};
2738
2739   if ( $param->{'newest_percust'} ) {
2740
2741     #$distinct = 'DISTINCT ON ( cust_bill.custnum )';
2742     #$orderby = 'ORDER BY cust_bill.custnum ASC, cust_bill._date DESC';
2743
2744     my @newest_where = map { my $x = $_;
2745                              $x =~ s/\bcust_bill\./newest_cust_bill./g;
2746                              $x;
2747                            }
2748                            grep ! /^cust_main./, @search;
2749     my $newest_where = scalar(@newest_where)
2750                          ? ' AND '. join(' AND ', @newest_where)
2751                          : '';
2752
2753
2754     push @search, "cust_bill._date = (
2755       SELECT(MAX(newest_cust_bill._date)) FROM cust_bill AS newest_cust_bill
2756         WHERE newest_cust_bill.custnum = cust_bill.custnum
2757           $newest_where
2758     )";
2759
2760   }
2761
2762   push @search, $FS::CurrentUser::CurrentUser->agentnums_sql;
2763
2764   join(' AND ', @search );
2765
2766 }
2767
2768 =back
2769
2770 =head1 BUGS
2771
2772 The delete method.
2773
2774 =head1 SEE ALSO
2775
2776 L<FS::Record>, L<FS::cust_main>, L<FS::cust_bill_pay>, L<FS::cust_pay>,
2777 L<FS::cust_bill_pkg>, L<FS::cust_bill_credit>, schema.html from the base
2778 documentation.
2779
2780 =cut
2781
2782 1;
2783