FS/FS/cust_bill.pm

   1 package FS::cust_bill;
   2
   3 use strict;
   4 use vars qw( @ISA $conf $money_char );
   5 use vars qw( $lpr $invoice_from $smtpmachine );
   6 use vars qw( $processor );
   7 use vars qw( $xaction $E_NoErr );
   8 use vars qw( $bop_processor $bop_login $bop_password $bop_action @bop_options );
   9 use vars qw( $invoice_lines @buf ); #yuck
  10 use Date::Format;
  11 use Mail::Internet 1.44;
  12 use Mail::Header;
  13 use Text::Template;
  14 use FS::Record qw( qsearch qsearchs );
  15 use FS::cust_main;
  16 use FS::cust_bill_pkg;
  17 use FS::cust_credit;
  18 use FS::cust_pay;
  19 use FS::cust_pkg;
  20 use FS::cust_credit_bill;
  21 use FS::cust_pay_batch;
  22 use FS::cust_bill_event;
  23
  24 @ISA = qw( FS::Record );
  25
  26 #ask FS::UID to run this stuff for us later
  27 $FS::UID::callback{'FS::cust_bill'} = sub {
  28
  29   $conf = new FS::Conf;
  30
  31   $money_char = $conf->config('money_char') || '$';
  32
  33   $lpr = $conf->config('lpr');
  34   $invoice_from = $conf->config('invoice_from');
  35   $smtpmachine = $conf->config('smtpmachine');
  36
  37   if ( $conf->exists('cybercash3.2') ) {
  38     require CCMckLib3_2;
  39       #qw($MCKversion %Config InitConfig CCError CCDebug CCDebug2);
  40     require CCMckDirectLib3_2;
  41       #qw(SendCC2_1Server);
  42     require CCMckErrno3_2;
  43       #qw(MCKGetErrorMessage $E_NoErr);
  44     import CCMckErrno3_2 qw($E_NoErr);
  45
  46     my $merchant_conf;
  47     ($merchant_conf,$xaction)= $conf->config('cybercash3.2');
  48     my $status = &CCMckLib3_2::InitConfig($merchant_conf);
  49     if ( $status != $E_NoErr ) {
  50       warn "CCMckLib3_2::InitConfig error:\n";
  51       foreach my $key (keys %CCMckLib3_2::Config) {
  52         warn "  $key => $CCMckLib3_2::Config{$key}\n"
  53       }
  54       my($errmsg) = &CCMckErrno3_2::MCKGetErrorMessage($status);
  55       die "CCMckLib3_2::InitConfig fatal error: $errmsg\n";
  56     }
  57     $processor='cybercash3.2';
  58   } elsif ( $conf->exists('business-onlinepayment') ) {
  59     ( $bop_processor,
  60       $bop_login,
  61       $bop_password,
  62       $bop_action,
  63       @bop_options
  64     ) = $conf->config('business-onlinepayment');
  65     $bop_action ||= 'normal authorization';
  66     eval "use Business::OnlinePayment";
  67     $processor="Business::OnlinePayment::$bop_processor";
  68   }
  69
  70 };
  71
  72 =head1 NAME
  73
  74 FS::cust_bill - Object methods for cust_bill records
  75
  76 =head1 SYNOPSIS
  77
  78   use FS::cust_bill;
  79
  80   $record = new FS::cust_bill \%hash;
  81   $record = new FS::cust_bill { 'column' => 'value' };
  82
  83   $error = $record->insert;
  84
  85   $error = $new_record->replace($old_record);
  86
  87   $error = $record->delete;
  88
  89   $error = $record->check;
  90
  91   ( $total_previous_balance, @previous_cust_bill ) = $record->previous;
  92
  93   @cust_bill_pkg_objects = $cust_bill->cust_bill_pkg;
  94
  95   ( $total_previous_credits, @previous_cust_credit ) = $record->cust_credit;
  96
  97   @cust_pay_objects = $cust_bill->cust_pay;
  98
  99   $tax_amount = $record->tax;
 100
 101   @lines = $cust_bill->print_text;
 102   @lines = $cust_bill->print_text $time;
 103
 104 =head1 DESCRIPTION
 105
 106 An FS::cust_bill object represents an invoice; a declaration that a customer
 107 owes you money.  The specific charges are itemized as B<cust_bill_pkg> records
 108 (see L<FS::cust_bill_pkg>).  FS::cust_bill inherits from FS::Record.  The
 109 following fields are currently supported:
 110
 111 =over 4
 112
 113 =item invnum - primary key (assigned automatically for new invoices)
 114
 115 =item custnum - customer (see L<FS::cust_main>)
 116
 117 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
 118 L<Time::Local> and L<Date::Parse> for conversion functions.
 119
 120 =item charged - amount of this invoice
 121
 122 =item printed - deprecated
 123
 124 =item closed - books closed flag, empty or `Y'
 125
 126 =back
 127
 128 =head1 METHODS
 129
 130 =over 4
 131
 132 =item new HASHREF
 133
 134 Creates a new invoice.  To add the invoice to the database, see L<"insert">.
 135 Invoices are normally created by calling the bill method of a customer object
 136 (see L<FS::cust_main>).
 137
 138 =cut
 139
 140 sub table { 'cust_bill'; }
 141
 142 =item insert
 143
 144 Adds this invoice to the database ("Posts" the invoice).  If there is an error,
 145 returns the error, otherwise returns false.
 146
 147 =item delete
 148
 149 Currently unimplemented.  I don't remove invoices because there would then be
 150 no record you ever posted this invoice (which is bad, no?)
 151
 152 =cut
 153
 154 sub delete {
 155   my $self = shift;
 156   return "Can't delete closed invoice" if $self->closed =~ /^Y/i;
 157   $self->SUPER::delete(@_);
 158 }
 159
 160 =item replace OLD_RECORD
 161
 162 Replaces the OLD_RECORD with this one in the database.  If there is an error,
 163 returns the error, otherwise returns false.
 164
 165 Only printed may be changed.  printed is normally updated by calling the
 166 collect method of a customer object (see L<FS::cust_main>).
 167
 168 =cut
 169
 170 sub replace {
 171   my( $new, $old ) = ( shift, shift );
 172   return "Can't change custnum!" unless $old->custnum == $new->custnum;
 173   #return "Can't change _date!" unless $old->_date eq $new->_date;
 174   return "Can't change _date!" unless $old->_date == $new->_date;
 175   return "Can't change charged!" unless $old->charged == $new->charged;
 176
 177   $new->SUPER::replace($old);
 178 }
 179
 180 =item check
 181
 182 Checks all fields to make sure this is a valid invoice.  If there is an error,
 183 returns the error, otherwise returns false.  Called by the insert and replace
 184 methods.
 185
 186 =cut
 187
 188 sub check {
 189   my $self = shift;
 190
 191   my $error =
 192     $self->ut_numbern('invnum')
 193     || $self->ut_number('custnum')
 194     || $self->ut_numbern('_date')
 195     || $self->ut_money('charged')
 196     || $self->ut_numbern('printed')
 197     || $self->ut_enum('closed', [ '', 'Y' ])
 198   ;
 199   return $error if $error;
 200
 201   return "Unknown customer"
 202     unless qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
 203
 204   $self->_date(time) unless $self->_date;
 205
 206   $self->printed(0) if $self->printed eq '';
 207
 208   ''; #no error
 209 }
 210
 211 =item previous
 212
 213 Returns a list consisting of the total previous balance for this customer,
 214 followed by the previous outstanding invoices (as FS::cust_bill objects also).
 215
 216 =cut
 217
 218 sub previous {
 219   my $self = shift;
 220   my $total = 0;
 221   my @cust_bill = sort { $a->_date <=> $b->_date }
 222     grep { $_->owed != 0 && $_->_date < $self->_date }
 223       qsearch( 'cust_bill', { 'custnum' => $self->custnum } )
 224   ;
 225   foreach ( @cust_bill ) { $total += $_->owed; }
 226   $total, @cust_bill;
 227 }
 228
 229 =item cust_bill_pkg
 230
 231 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice.
 232
 233 =cut
 234
 235 sub cust_bill_pkg {
 236   my $self = shift;
 237   qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum } );
 238 }
 239
 240 =item cust_bill_event
 241
 242 Returns the completed invoice events (see L<FS::cust_bill_event>) for this
 243 invoice.
 244
 245 =cut
 246
 247 sub cust_bill_event {
 248   my $self = shift;
 249   qsearch( 'cust_bill_event', { 'invnum' => $self->invnum } );
 250 }
 251
 252
 253 =item cust_main
 254
 255 Returns the customer (see L<FS::cust_main>) for this invoice.
 256
 257 =cut
 258
 259 sub cust_main {
 260   my $self = shift;
 261   qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
 262 }
 263
 264 =item cust_credit
 265
 266 Depreciated.  See the cust_credited method.
 267
 268  #Returns a list consisting of the total previous credited (see
 269  #L<FS::cust_credit>) and unapplied for this customer, followed by the previous
 270  #outstanding credits (FS::cust_credit objects).
 271
 272 =cut
 273
 274 sub cust_credit {
 275   use Carp;
 276   croak "FS::cust_bill->cust_credit depreciated; see ".
 277         "FS::cust_bill->cust_credit_bill";
 278   #my $self = shift;
 279   #my $total = 0;
 280   #my @cust_credit = sort { $a->_date <=> $b->_date }
 281   #  grep { $_->credited != 0 && $_->_date < $self->_date }
 282   #    qsearch('cust_credit', { 'custnum' => $self->custnum } )
 283   #;
 284   #foreach (@cust_credit) { $total += $_->credited; }
 285   #$total, @cust_credit;
 286 }
 287
 288 =item cust_pay
 289
 290 Depreciated.  See the cust_bill_pay method.
 291
 292 #Returns all payments (see L<FS::cust_pay>) for this invoice.
 293
 294 =cut
 295
 296 sub cust_pay {
 297   use Carp;
 298   croak "FS::cust_bill->cust_pay depreciated; see FS::cust_bill->cust_bill_pay";
 299   #my $self = shift;
 300   #sort { $a->_date <=> $b->_date }
 301   #  qsearch( 'cust_pay', { 'invnum' => $self->invnum } )
 302   #;
 303 }
 304
 305 =item cust_bill_pay
 306
 307 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice.
 308
 309 =cut
 310
 311 sub cust_bill_pay {
 312   my $self = shift;
 313   sort { $a->_date <=> $b->_date }
 314     qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum } );
 315 }
 316
 317 =item cust_credited
 318
 319 Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice.
 320
 321 =cut
 322
 323 sub cust_credited {
 324   my $self = shift;
 325   sort { $a->_date <=> $b->_date }
 326     qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum } )
 327   ;
 328 }
 329
 330 =item tax
 331
 332 Returns the tax amount (see L<FS::cust_bill_pkg>) for this invoice.
 333
 334 =cut
 335
 336 sub tax {
 337   my $self = shift;
 338   my $total = 0;
 339   my @taxlines = qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum ,
 340                                              'pkgnum' => 0 } );
 341   foreach (@taxlines) { $total += $_->setup; }
 342   $total;
 343 }
 344
 345 =item owed
 346
 347 Returns the amount owed (still outstanding) on this invoice, which is charged
 348 minus all payment applications (see L<FS::cust_bill_pay>) and credit
 349 applications (see L<FS::cust_credit_bill>).
 350
 351 =cut
 352
 353 sub owed {
 354   my $self = shift;
 355   my $balance = $self->charged;
 356   $balance -= $_->amount foreach ( $self->cust_bill_pay );
 357   $balance -= $_->amount foreach ( $self->cust_credited );
 358   $balance = sprintf( "%.2f", $balance);
 359   $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
 360   $balance;
 361 }
 362
 363 =item send
 364
 365 Sends this invoice to the destinations configured for this customer: send
 366 emails or print.  See L<FS::cust_main_invoice>.
 367
 368 =cut
 369
 370 sub send {
 371   my($self,$template) = @_;
 372
 373   #my @print_text = $cust_bill->print_text; #( date )
 374   my @invoicing_list = $self->cust_main->invoicing_list;
 375   if ( grep { $_ ne 'POST' } @invoicing_list ) { #email invoice
 376     #false laziness w/FS::cust_pay::delete & fs_signup_server && ::realtime_card
 377     #$ENV{SMTPHOSTS} = $smtpmachine;
 378     $ENV{MAILADDRESS} = $invoice_from;
 379     my $header = new Mail::Header ( [
 380       "From: $invoice_from",
 381       "To: ". join(', ', grep { $_ ne 'POST' } @invoicing_list ),
 382       "Sender: $invoice_from",
 383       "Reply-To: $invoice_from",
 384       "Date: ". time2str("%a, %d %b %Y %X %z", time),
 385       "Subject: Invoice",
 386     ] );
 387     my $message = new Mail::Internet (
 388       'Header' => $header,
 389       'Body' => [ $self->print_text('', $template) ], #( date)
 390     );
 391     $!=0;
 392     $message->smtpsend( Host => $smtpmachine )
 393       or $message->smtpsend( Host => $smtpmachine, Debug => 1 )
 394         or return "(customer # ". $self->custnum. ") can't send invoice email".
 395                   " to ". join(', ', grep { $_ ne 'POST' } @invoicing_list ).
 396                   " via server $smtpmachine with SMTP: $!";
 397
 398   #} elsif ( grep { $_ eq 'POST' } @invoicing_list ) {
 399   } elsif ( ! @invoicing_list || grep { $_ eq 'POST' } @invoicing_list ) {
 400     open(LPR, "|$lpr")
 401       or return "Can't open pipe to $lpr: $!";
 402     print LPR $self->print_text; #( date )
 403     close LPR
 404       or return $! ? "Error closing $lpr: $!"
 405                    : "Exit status $? from $lpr";
 406   }
 407
 408   '';
 409
 410 }
 411
 412 =item comp
 413
 414 Pays this invoice with a compliemntary payment.  If there is an error,
 415 returns the error, otherwise returns false.
 416
 417 =cut
 418
 419 sub comp {
 420   my $self = shift;
 421   my $cust_pay = new FS::cust_pay ( {
 422     'invnum'   => $self->invnum,
 423     'paid'     => $self->owed,
 424     '_date'    => '',
 425     'payby'    => 'COMP',
 426     'payinfo'  => $self->cust_main->payinfo,
 427     'paybatch' => '',
 428   } );
 429   $cust_pay->insert;
 430 }
 431
 432 =item realtime_card
 433
 434 Attempts to pay this invoice with a Business::OnlinePayment realtime gateway.
 435 See http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
 436 for supproted processors.
 437
 438 =cut
 439
 440 sub realtime_card {
 441   my $self = shift;
 442   my $cust_main = $self->cust_main;
 443   my $amount = $self->owed;
 444
 445   unless ( $processor =~ /^Business::OnlinePayment::(.*)$/ ) {
 446     return "Real-time card processing not enabled (processor $processor)";
 447   }
 448   my $bop_processor = $1; #hmm?
 449
 450   my $address = $cust_main->address1;
 451   $address .= ", ". $cust_main->address2 if $cust_main->address2;
 452
 453   #fix exp. date
 454   #$cust_main->paydate =~ /^(\d+)\/\d*(\d{2})$/;
 455   $cust_main->paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
 456   my $exp = "$2/$1";
 457
 458   my($payname, $payfirst, $paylast);
 459   if ( $cust_main->payname ) {
 460     $payname = $cust_main->payname;
 461     $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
 462       or do {
 463               #$dbh->rollback if $oldAutoCommit;
 464               return "Illegal payname $payname";
 465             };
 466     ($payfirst, $paylast) = ($1, $2);
 467   } else {
 468     $payfirst = $cust_main->getfield('first');
 469     $paylast = $cust_main->getfield('last');
 470     $payname =  "$payfirst $paylast";
 471   }
 472
 473   my @invoicing_list = grep { $_ ne 'POST' } $cust_main->invoicing_list;
 474   if ( $conf->exists('emailinvoiceauto')
 475        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
 476     push @invoicing_list, $cust_main->default_invoicing_list;
 477   }
 478   my $email = $invoicing_list[0];
 479
 480   my( $action1, $action2 ) = split(/\s*\,\s*/, $bop_action );
 481
 482   my $description = 'Internet Services';
 483   if ( $conf->exists('business-onlinepayment-description') ) {
 484     my $dtempl = $conf->config('business-onlinepayment-description');
 485
 486     my $agent_obj = $cust_main->agent
 487       or die "can't retreive agent for $cust_main (agentnum ".
 488              $cust_main->agentnum. ")";
 489     my $agent = $agent_obj->agent;
 490     my $pkgs = join(', ',
 491       map { $_->cust_pkg->part_pkg->pkg }
 492         grep { $_->pkgnum } $self->cust_bill_pkg
 493     );
 494     $description = eval qq("$dtempl");
 495
 496   }
 497
 498   my $transaction =
 499     new Business::OnlinePayment( $bop_processor, @bop_options );
 500   $transaction->content(
 501     'type'           => 'CC',
 502     'login'          => $bop_login,
 503     'password'       => $bop_password,
 504     'action'         => $action1,
 505     'description'    => $description,
 506     'amount'         => $amount,
 507     'invoice_number' => $self->invnum,
 508     'customer_id'    => $self->custnum,
 509     'last_name'      => $paylast,
 510     'first_name'     => $payfirst,
 511     'name'           => $payname,
 512     'address'        => $address,
 513     'city'           => $cust_main->city,
 514     'state'          => $cust_main->state,
 515     'zip'            => $cust_main->zip,
 516     'country'        => $cust_main->country,
 517     'card_number'    => $cust_main->payinfo,
 518     'expiration'     => $exp,
 519     'referer'        => 'http://cleanwhisker.420.am/',
 520     'email'          => $email,
 521     'phone'          => $cust_main->daytime || $cust_main->night,
 522   );
 523   $transaction->submit();
 524
 525   if ( $transaction->is_success() && $action2 ) {
 526     my $auth = $transaction->authorization;
 527     my $ordernum = $transaction->order_number;
 528     #warn "********* $auth ***********\n";
 529     #warn "********* $ordernum ***********\n";
 530     my $capture =
 531       new Business::OnlinePayment( $bop_processor, @bop_options );
 532
 533     $capture->content(
 534       action         => $action2,
 535       login          => $bop_login,
 536       password       => $bop_password,
 537       order_number   => $ordernum,
 538       amount         => $amount,
 539       authorization  => $auth,
 540       description    => $description,
 541     );
 542
 543     $capture->submit();
 544
 545     unless ( $capture->is_success ) {
 546       my $e = "Authorization sucessful but capture failed, invnum #".
 547               $self->invnum. ': '.  $capture->result_code.
 548               ": ". $capture->error_message;
 549       warn $e;
 550       return $e;
 551     }
 552
 553   }
 554
 555   if ( $transaction->is_success() ) {
 556
 557     my $cust_pay = new FS::cust_pay ( {
 558        'invnum'   => $self->invnum,
 559        'paid'     => $amount,
 560        '_date'     => '',
 561        'payby'    => 'CARD',
 562        'payinfo'  => $cust_main->payinfo,
 563        'paybatch' => "$processor:". $transaction->authorization,
 564     } );
 565     my $error = $cust_pay->insert;
 566     if ( $error ) {
 567       # gah, even with transactions.
 568       my $e = 'WARNING: Card debited but database not updated - '.
 569               'error applying payment, invnum #' . $self->invnum.
 570               " ($processor): $error";
 571       warn $e;
 572       return $e;
 573     } else {
 574       return '';
 575     }
 576   #} elsif ( $options{'report_badcard'} ) {
 577   } else {
 578
 579     my $perror = "$processor error, invnum #". $self->invnum. ': '.
 580                  $transaction->result_code. ": ". $transaction->error_message;
 581
 582     if ( $conf->exists('emaildecline')
 583          && grep { $_ ne 'POST' } $cust_main->invoicing_list
 584     ) {
 585       my @templ = $conf->config('declinetemplate');
 586       my $template = new Text::Template (
 587         TYPE   => 'ARRAY',
 588         SOURCE => [ map "$_\n", @templ ],
 589       ) or return "($perror) can't create template: $Text::Template::ERROR";
 590       $template->compile()
 591         or return "($perror) can't compile template: $Text::Template::ERROR";
 592
 593       my $error = $transaction->error_message;
 594
 595       #false laziness w/FS::cust_pay::delete & fs_signup_server && ::send
 596       $ENV{MAILADDRESS} = $invoice_from;
 597       my $header = new Mail::Header ( [
 598         "From: $invoice_from",
 599         "To: ". join(', ', grep { $_ ne 'POST' } $cust_main->invoicing_list ),
 600         "Sender: $invoice_from",
 601         "Reply-To: $invoice_from",
 602         "Date: ". time2str("%a, %d %b %Y %X %z", time),
 603         "Subject: Your credit card could not be processed",
 604       ] );
 605       my $message = new Mail::Internet (
 606         'Header' => $header,
 607         'Body' => [ $template->fill_in() ],
 608       );
 609       $!=0;
 610       $message->smtpsend( Host => $smtpmachine )
 611         or $message->smtpsend( Host => $smtpmachine, Debug => 1 )
 612           or return "($perror) (customer # ". $self->custnum.
 613             ") can't send card decline email to ".
 614             join(', ', grep { $_ ne 'POST' } $cust_main->invoicing_list ).
 615             " via server $smtpmachine with SMTP: $!";
 616     }
 617
 618     return $perror;
 619   }
 620
 621 }
 622
 623 =item realtime_card_cybercash
 624
 625 Attempts to pay this invoice with the CyberCash CashRegister realtime gateway.
 626
 627 =cut
 628
 629 sub realtime_card_cybercash {
 630   my $self = shift;
 631   my $cust_main = $self->cust_main;
 632   my $amount = $self->owed;
 633
 634   return "CyberCash CashRegister real-time card processing not enabled!"
 635     unless $processor eq 'cybercash3.2';
 636
 637   my $address = $cust_main->address1;
 638   $address .= ", ". $cust_main->address2 if $cust_main->address2;
 639
 640   #fix exp. date
 641   #$cust_main->paydate =~ /^(\d+)\/\d*(\d{2})$/;
 642   $cust_main->paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
 643   my $exp = "$2/$1";
 644
 645   #
 646
 647   my $paybatch = $self->invnum.
 648                   '-' . time2str("%y%m%d%H%M%S", time);
 649
 650   my $payname = $cust_main->payname ||
 651                 $cust_main->getfield('first').' '.$cust_main->getfield('last');
 652
 653   my $country = $cust_main->country eq 'US' ? 'USA' : $cust_main->country;
 654
 655   my @full_xaction = ( $xaction,
 656     'Order-ID'     => $paybatch,
 657     'Amount'       => "usd $amount",
 658     'Card-Number'  => $cust_main->getfield('payinfo'),
 659     'Card-Name'    => $payname,
 660     'Card-Address' => $address,
 661     'Card-City'    => $cust_main->getfield('city'),
 662     'Card-State'   => $cust_main->getfield('state'),
 663     'Card-Zip'     => $cust_main->getfield('zip'),
 664     'Card-Country' => $country,
 665     'Card-Exp'     => $exp,
 666   );
 667
 668   my %result;
 669   %result = &CCMckDirectLib3_2::SendCC2_1Server(@full_xaction);
 670
 671   if ( $result{'MStatus'} eq 'success' ) { #cybercash smps v.2 or 3
 672     my $cust_pay = new FS::cust_pay ( {
 673        'invnum'   => $self->invnum,
 674        'paid'     => $amount,
 675        '_date'     => '',
 676        'payby'    => 'CARD',
 677        'payinfo'  => $cust_main->payinfo,
 678        'paybatch' => "$processor:$paybatch",
 679     } );
 680     my $error = $cust_pay->insert;
 681     if ( $error ) {
 682       # gah, even with transactions.
 683       my $e = 'WARNING: Card debited but database not updated - '.
 684               'error applying payment, invnum #' . $self->invnum.
 685               " (CyberCash Order-ID $paybatch): $error";
 686       warn $e;
 687       return $e;
 688     } else {
 689       return '';
 690     }
 691 #  } elsif ( $result{'Mstatus'} ne 'failure-bad-money'
 692 #            || $options{'report_badcard'}
 693 #          ) {
 694   } else {
 695      return 'Cybercash error, invnum #' .
 696        $self->invnum. ':'. $result{'MErrMsg'};
 697   }
 698
 699 }
 700
 701 =item batch_card
 702
 703 Adds a payment for this invoice to the pending credit card batch (see
 704 L<FS::cust_pay_batch>).
 705
 706 =cut
 707
 708 sub batch_card {
 709   my $self = shift;
 710   my $cust_main = $self->cust_main;
 711
 712   my $cust_pay_batch = new FS::cust_pay_batch ( {
 713     'invnum'   => $self->getfield('invnum'),
 714     'custnum'  => $cust_main->getfield('custnum'),
 715     'last'     => $cust_main->getfield('last'),
 716     'first'    => $cust_main->getfield('first'),
 717     'address1' => $cust_main->getfield('address1'),
 718     'address2' => $cust_main->getfield('address2'),
 719     'city'     => $cust_main->getfield('city'),
 720     'state'    => $cust_main->getfield('state'),
 721     'zip'      => $cust_main->getfield('zip'),
 722     'country'  => $cust_main->getfield('country'),
 723     'trancode' => 77,
 724     'cardnum'  => $cust_main->getfield('payinfo'),
 725     'exp'      => $cust_main->getfield('paydate'),
 726     'payname'  => $cust_main->getfield('payname'),
 727     'amount'   => $self->owed,
 728   } );
 729   $cust_pay_batch->insert;
 730
 731 }
 732
 733 =item print_text [TIME];
 734
 735 Returns an text invoice, as a list of lines.
 736
 737 TIME an optional value used to control the printing of overdue messages.  The
 738 default is now.  It isn't the date of the invoice; that's the `_date' field.
 739 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
 740 L<Time::Local> and L<Date::Parse> for conversion functions.
 741
 742 =cut
 743
 744 sub print_text {
 745
 746   my( $self, $today, $template ) = @_;
 747   $today ||= time;
 748 #  my $invnum = $self->invnum;
 749   my $cust_main = qsearchs('cust_main', { 'custnum', $self->custnum } );
 750   $cust_main->payname( $cust_main->first. ' '. $cust_main->getfield('last') )
 751     unless $cust_main->payname;
 752
 753   my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
 754 #  my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
 755   #my $balance_due = $self->owed + $pr_total - $cr_total;
 756   my $balance_due = $self->owed + $pr_total;
 757
 758   #my @collect = ();
 759   #my($description,$amount);
 760   @buf = ();
 761
 762   #previous balance
 763   foreach ( @pr_cust_bill ) {
 764     push @buf, [
 765       "Previous Balance, Invoice #". $_->invnum.
 766                  " (". time2str("%x",$_->_date). ")",
 767       $money_char. sprintf("%10.2f",$_->owed)
 768     ];
 769   }
 770   if (@pr_cust_bill) {
 771     push @buf,['','-----------'];
 772     push @buf,[ 'Total Previous Balance',
 773                 $money_char. sprintf("%10.2f",$pr_total ) ];
 774     push @buf,['',''];
 775   }
 776
 777   #new charges
 778   foreach ( $self->cust_bill_pkg ) {
 779
 780     if ( $_->pkgnum ) {
 781
 782       my($cust_pkg)=qsearchs('cust_pkg', { 'pkgnum', $_->pkgnum } );
 783       my($part_pkg)=qsearchs('part_pkg',{'pkgpart'=>$cust_pkg->pkgpart});
 784       my($pkg)=$part_pkg->pkg;
 785
 786       if ( $_->setup != 0 ) {
 787         push @buf, [ "$pkg Setup", $money_char. sprintf("%10.2f",$_->setup) ];
 788         push @buf,
 789           map { [ "  ". $_->[0]. ": ". $_->[1], '' ] } $cust_pkg->labels;
 790       }
 791
 792       if ( $_->recur != 0 ) {
 793         push @buf, [
 794           "$pkg (" . time2str("%x",$_->sdate) . " - " .
 795                                 time2str("%x",$_->edate) . ")",
 796           $money_char. sprintf("%10.2f",$_->recur)
 797         ];
 798         push @buf,
 799           map { [ "  ". $_->[0]. ": ". $_->[1], '' ] } $cust_pkg->labels;
 800       }
 801
 802     } else { #pkgnum Tax
 803       push @buf,["Tax", $money_char. sprintf("%10.2f",$_->setup) ]
 804         if $_->setup != 0;
 805     }
 806   }
 807
 808   push @buf,['','-----------'];
 809   push @buf,['Total New Charges',
 810              $money_char. sprintf("%10.2f",$self->charged) ];
 811   push @buf,['',''];
 812
 813   push @buf,['','-----------'];
 814   push @buf,['Total Charges',
 815              $money_char. sprintf("%10.2f",$self->charged + $pr_total) ];
 816   push @buf,['',''];
 817
 818   #credits
 819   foreach ( $self->cust_credited ) {
 820
 821     #something more elaborate if $_->amount ne $_->cust_credit->credited ?
 822
 823     my $reason = substr($_->cust_credit->reason,0,32);
 824     $reason .= '...' if length($reason) < length($_->cust_credit->reason);
 825     $reason = " ($reason) " if $reason;
 826     push @buf,[
 827       "Credit #". $_->crednum. " (". time2str("%x",$_->cust_credit->_date) .")".
 828         $reason,
 829       $money_char. sprintf("%10.2f",$_->amount)
 830     ];
 831   }
 832   #foreach ( @cr_cust_credit ) {
 833   #  push @buf,[
 834   #    "Credit #". $_->crednum. " (" . time2str("%x",$_->_date) .")",
 835   #    $money_char. sprintf("%10.2f",$_->credited)
 836   #  ];
 837   #}
 838
 839   #get & print payments
 840   foreach ( $self->cust_bill_pay ) {
 841
 842     #something more elaborate if $_->amount ne ->cust_pay->paid ?
 843
 844     push @buf,[
 845       "Payment received ". time2str("%x",$_->cust_pay->_date ),
 846       $money_char. sprintf("%10.2f",$_->amount )
 847     ];
 848   }
 849
 850   #balance due
 851   push @buf,['','-----------'];
 852   push @buf,['Balance Due', $money_char.
 853     sprintf("%10.2f", $balance_due ) ];
 854
 855   #create the template
 856   my $templatefile = 'invoice_template';
 857   $templatefile .= "_$template" if $template;
 858   my @invoice_template = $conf->config($templatefile)
 859   or die "cannot load config file $templatefile";
 860   $invoice_lines = 0;
 861   my $wasfunc = 0;
 862   foreach ( grep /invoice_lines\(\d+\)/, @invoice_template ) { #kludgy
 863     /invoice_lines\((\d+)\)/;
 864     $invoice_lines += $1;
 865     $wasfunc=1;
 866   }
 867   die "no invoice_lines() functions in template?" unless $wasfunc;
 868   my $invoice_template = new Text::Template (
 869     TYPE   => 'ARRAY',
 870     SOURCE => [ map "$_\n", @invoice_template ],
 871   ) or die "can't create new Text::Template object: $Text::Template::ERROR";
 872   $invoice_template->compile()
 873     or die "can't compile template: $Text::Template::ERROR";
 874
 875   #setup template variables
 876   package FS::cust_bill::_template; #!
 877   use vars qw( $invnum $date $page $total_pages @address $overdue @buf );
 878
 879   $invnum = $self->invnum;
 880   $date = $self->_date;
 881   $page = 1;
 882
 883   if ( $FS::cust_bill::invoice_lines ) {
 884     $total_pages =
 885       int( scalar(@FS::cust_bill::buf) / $FS::cust_bill::invoice_lines );
 886     $total_pages++
 887       if scalar(@FS::cust_bill::buf) % $FS::cust_bill::invoice_lines;
 888   } else {
 889     $total_pages = 1;
 890   }
 891
 892   #format address (variable for the template)
 893   my $l = 0;
 894   @address = ( '', '', '', '', '', '' );
 895   package FS::cust_bill; #!
 896   $FS::cust_bill::_template::address[$l++] =
 897     $cust_main->payname.
 898       ( ( $cust_main->payby eq 'BILL' ) && $cust_main->payinfo
 899         ? " (P.O. #". $cust_main->payinfo. ")"
 900         : ''
 901       )
 902   ;
 903   $FS::cust_bill::_template::address[$l++] = $cust_main->company
 904     if $cust_main->company;
 905   $FS::cust_bill::_template::address[$l++] = $cust_main->address1;
 906   $FS::cust_bill::_template::address[$l++] = $cust_main->address2
 907     if $cust_main->address2;
 908   $FS::cust_bill::_template::address[$l++] =
 909     $cust_main->city. ", ". $cust_main->state. "  ".  $cust_main->zip;
 910   $FS::cust_bill::_template::address[$l++] = $cust_main->country
 911     unless $cust_main->country eq 'US';
 912
 913         #  #overdue? (variable for the template)
 914         #  $FS::cust_bill::_template::overdue = (
 915         #    $balance_due > 0
 916         #    && $today > $self->_date
 917         ##    && $self->printed > 1
 918         #    && $self->printed > 0
 919         #  );
 920
 921   #and subroutine for the template
 922
 923   sub FS::cust_bill::_template::invoice_lines {
 924     my $lines = shift or return @buf;
 925     map {
 926       scalar(@buf) ? shift @buf : [ '', '' ];
 927     }
 928     ( 1 .. $lines );
 929   }
 930
 931
 932   #and fill it in
 933   $FS::cust_bill::_template::page = 1;
 934   my $lines;
 935   my @collect;
 936   while (@buf) {
 937     push @collect, split("\n",
 938       $invoice_template->fill_in( PACKAGE => 'FS::cust_bill::_template' )
 939     );
 940     $FS::cust_bill::_template::page++;
 941   }
 942
 943   map "$_\n", @collect;
 944
 945 }
 946
 947 =back
 948
 949 =head1 VERSION
 950
 951 $Id: cust_bill.pm,v 1.35 2002-05-18 09:51:30 ivan Exp $
 952
 953 =head1 BUGS
 954
 955 The delete method.
 956
 957 print_text formatting (and some logic :/) is in source, but needs to be
 958 slurped in from a file.  Also number of lines ($=).
 959
 960 missing print_ps for a nice postscript copy (maybe HylaFAX-cover-page-style
 961 or something similar so the look can be completely customized?)
 962
 963 =head1 SEE ALSO
 964
 965 L<FS::Record>, L<FS::cust_main>, L<FS::cust_bill_pay>, L<FS::cust_pay>,
 966 L<FS::cust_bill_pkg>, L<FS::cust_bill_credit>, schema.html from the base
 967 documentation.
 968
 969 =cut
 970
 971 1;
 972