FS/FS/cust_pay.pm

   1 package FS::cust_pay;
   2
   3 use strict;
   4 use vars qw( @ISA $DEBUG $me $conf @encrypted_fields
   5              $unsuspendauto $ignore_noapply
   6            );
   7 use Date::Format;
   8 use Business::CreditCard;
   9 use Text::Template;
  10 use FS::UID qw( getotaker );
  11 use FS::Misc qw( send_email );
  12 use FS::Record qw( dbh qsearch qsearchs );
  13 use FS::payby;
  14 use FS::cust_main_Mixin;
  15 use FS::payinfo_transaction_Mixin;
  16 use FS::cust_bill;
  17 use FS::cust_bill_pay;
  18 use FS::cust_pay_refund;
  19 use FS::cust_main;
  20 use FS::cust_pkg;
  21 use FS::cust_pay_void;
  22
  23 @ISA = qw( FS::payinfo_transaction_Mixin FS::cust_main_Mixin FS::Record );
  24
  25 $DEBUG = 1;
  26
  27 $me = '[FS::cust_pay]';
  28
  29 $ignore_noapply = 0;
  30
  31 #ask FS::UID to run this stuff for us later
  32 FS::UID->install_callback( sub {
  33   $conf = new FS::Conf;
  34   $unsuspendauto = $conf->exists('unsuspendauto');
  35 } );
  36
  37 @encrypted_fields = ('payinfo');
  38
  39 =head1 NAME
  40
  41 FS::cust_pay - Object methods for cust_pay objects
  42
  43 =head1 SYNOPSIS
  44
  45   use FS::cust_pay;
  46
  47   $record = new FS::cust_pay \%hash;
  48   $record = new FS::cust_pay { 'column' => 'value' };
  49
  50   $error = $record->insert;
  51
  52   $error = $new_record->replace($old_record);
  53
  54   $error = $record->delete;
  55
  56   $error = $record->check;
  57
  58 =head1 DESCRIPTION
  59
  60 An FS::cust_pay object represents a payment; the transfer of money from a
  61 customer.  FS::cust_pay inherits from FS::Record.  The following fields are
  62 currently supported:
  63
  64 =over 4
  65
  66 =item paynum
  67
  68 primary key (assigned automatically for new payments)
  69
  70 =item custnum
  71
  72 customer (see L<FS::cust_main>)
  73
  74 =item _date
  75
  76 specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
  77 L<Time::Local> and L<Date::Parse> for conversion functions.
  78
  79 =item paid
  80
  81 Amount of this payment
  82
  83 =item otaker
  84
  85 order taker (assigned automatically, see L<FS::UID>)
  86
  87 =item payby
  88
  89 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
  90
  91 =item payinfo
  92
  93 Payment Information (See L<FS::payinfo_Mixin> for data format)
  94
  95 =item paymask
  96
  97 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
  98
  99 =item paybatch
 100
 101 text field for tracking card processing or other batch grouping
 102
 103 =item payunique
 104
 105 Optional unique identifer to prevent duplicate transactions.
 106
 107 =item closed
 108
 109 books closed flag, empty or `Y'
 110
 111 =item pkgnum
 112
 113 Desired pkgnum when using experimental package balances.
 114
 115 =back
 116
 117 =head1 METHODS
 118
 119 =over 4
 120
 121 =item new HASHREF
 122
 123 Creates a new payment.  To add the payment to the databse, see L<"insert">.
 124
 125 =cut
 126
 127 sub table { 'cust_pay'; }
 128 sub cust_linked { $_[0]->cust_main_custnum; }
 129 sub cust_unlinked_msg {
 130   my $self = shift;
 131   "WARNING: can't find cust_main.custnum ". $self->custnum.
 132   ' (cust_pay.paynum '. $self->paynum. ')';
 133 }
 134
 135 =item insert [ OPTION => VALUE ... ]
 136
 137 Adds this payment to the database.
 138
 139 For backwards-compatibility and convenience, if the additional field invnum
 140 is defined, an FS::cust_bill_pay record for the full amount of the payment
 141 will be created.  In this case, custnum is optional.
 142
 143 A hash of optional arguments may be passed.  Currently "manual" is supported.
 144 If true, a payment receipt is sent instead of a statement when
 145 'payment_receipt_email' configuration option is set.
 146
 147 =cut
 148
 149 sub insert {
 150   my($self, %options) = @_;
 151
 152   local $SIG{HUP} = 'IGNORE';
 153   local $SIG{INT} = 'IGNORE';
 154   local $SIG{QUIT} = 'IGNORE';
 155   local $SIG{TERM} = 'IGNORE';
 156   local $SIG{TSTP} = 'IGNORE';
 157   local $SIG{PIPE} = 'IGNORE';
 158
 159   my $oldAutoCommit = $FS::UID::AutoCommit;
 160   local $FS::UID::AutoCommit = 0;
 161   my $dbh = dbh;
 162
 163   my $cust_bill;
 164   if ( $self->invnum ) {
 165     $cust_bill = qsearchs('cust_bill', { 'invnum' => $self->invnum } )
 166       or do {
 167         $dbh->rollback if $oldAutoCommit;
 168         return "Unknown cust_bill.invnum: ". $self->invnum;
 169       };
 170     $self->custnum($cust_bill->custnum );
 171   }
 172
 173   my $error = $self->check;
 174   return $error if $error;
 175
 176   my $cust_main = $self->cust_main;
 177   my $old_balance = $cust_main->balance;
 178
 179   $error = $self->SUPER::insert;
 180   if ( $error ) {
 181     $dbh->rollback if $oldAutoCommit;
 182     return "error inserting $self: $error";
 183   }
 184
 185   if ( $self->invnum ) {
 186     my $cust_bill_pay = new FS::cust_bill_pay {
 187       'invnum' => $self->invnum,
 188       'paynum' => $self->paynum,
 189       'amount' => $self->paid,
 190       '_date'  => $self->_date,
 191     };
 192     $error = $cust_bill_pay->insert(%options);
 193     if ( $error ) {
 194       if ( $ignore_noapply ) {
 195         warn "warning: error inserting $cust_bill_pay: $error ".
 196              "(ignore_noapply flag set; inserting cust_pay record anyway)\n";
 197       } else {
 198         $dbh->rollback if $oldAutoCommit;
 199         return "error inserting $cust_bill_pay: $error";
 200       }
 201     }
 202   }
 203
 204   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 205
 206   #false laziness w/ cust_credit::insert
 207   if ( $unsuspendauto && $old_balance && $cust_main->balance <= 0 ) {
 208     my @errors = $cust_main->unsuspend;
 209     #return
 210     # side-fx with nested transactions?  upstack rolls back?
 211     warn "WARNING:Errors unsuspending customer ". $cust_main->custnum. ": ".
 212          join(' / ', @errors)
 213       if @errors;
 214   }
 215   #eslaf
 216
 217   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 218
 219   #payment receipt
 220   my $trigger = $conf->config('payment_receipt-trigger') || 'cust_pay';
 221   if ( $trigger eq 'cust_pay' ) {
 222     my $error = $self->send_receipt(
 223       'manual'    => $options{'manual'},
 224       'cust_bill' => $cust_bill,
 225       'cust_main' => $cust_main,
 226     );
 227     warn "can't send payment receipt/statement: $error" if $error;
 228   }
 229
 230   '';
 231
 232 }
 233
 234 =item void [ REASON ]
 235
 236 Voids this payment: deletes the payment and all associated applications and
 237 adds a record of the voided payment to the FS::cust_pay_void table.
 238
 239 =cut
 240
 241 sub void {
 242   my $self = shift;
 243
 244   local $SIG{HUP} = 'IGNORE';
 245   local $SIG{INT} = 'IGNORE';
 246   local $SIG{QUIT} = 'IGNORE';
 247   local $SIG{TERM} = 'IGNORE';
 248   local $SIG{TSTP} = 'IGNORE';
 249   local $SIG{PIPE} = 'IGNORE';
 250
 251   my $oldAutoCommit = $FS::UID::AutoCommit;
 252   local $FS::UID::AutoCommit = 0;
 253   my $dbh = dbh;
 254
 255   my $cust_pay_void = new FS::cust_pay_void ( {
 256     map { $_ => $self->get($_) } $self->fields
 257   } );
 258   $cust_pay_void->reason(shift) if scalar(@_);
 259   my $error = $cust_pay_void->insert;
 260   if ( $error ) {
 261     $dbh->rollback if $oldAutoCommit;
 262     return $error;
 263   }
 264
 265   $error = $self->delete;
 266   if ( $error ) {
 267     $dbh->rollback if $oldAutoCommit;
 268     return $error;
 269   }
 270
 271   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 272
 273   '';
 274
 275 }
 276
 277 =item delete
 278
 279 Unless the closed flag is set, deletes this payment and all associated
 280 applications (see L<FS::cust_bill_pay> and L<FS::cust_pay_refund>).  In most
 281 cases, you want to use the void method instead to leave a record of the
 282 deleted payment.
 283
 284 =cut
 285
 286 # very similar to FS::cust_credit::delete
 287 sub delete {
 288   my $self = shift;
 289   return "Can't delete closed payment" if $self->closed =~ /^Y/i;
 290
 291   local $SIG{HUP} = 'IGNORE';
 292   local $SIG{INT} = 'IGNORE';
 293   local $SIG{QUIT} = 'IGNORE';
 294   local $SIG{TERM} = 'IGNORE';
 295   local $SIG{TSTP} = 'IGNORE';
 296   local $SIG{PIPE} = 'IGNORE';
 297
 298   my $oldAutoCommit = $FS::UID::AutoCommit;
 299   local $FS::UID::AutoCommit = 0;
 300   my $dbh = dbh;
 301
 302   foreach my $app ( $self->cust_bill_pay, $self->cust_pay_refund ) {
 303     my $error = $app->delete;
 304     if ( $error ) {
 305       $dbh->rollback if $oldAutoCommit;
 306       return $error;
 307     }
 308   }
 309
 310   my $error = $self->SUPER::delete(@_);
 311   if ( $error ) {
 312     $dbh->rollback if $oldAutoCommit;
 313     return $error;
 314   }
 315
 316   if (    $conf->exists('deletepayments')
 317        && $conf->config('deletepayments') ne '' ) {
 318
 319     my $cust_main = $self->cust_main;
 320
 321     my $error = send_email(
 322       'from'    => $conf->config('invoice_from', $self->cust_main->agentnum),
 323                                  #invoice_from??? well as good as any
 324       'to'      => $conf->config('deletepayments'),
 325       'subject' => 'FREESIDE NOTIFICATION: Payment deleted',
 326       'body'    => [
 327         "This is an automatic message from your Freeside installation\n",
 328         "informing you that the following payment has been deleted:\n",
 329         "\n",
 330         'paynum: '. $self->paynum. "\n",
 331         'custnum: '. $self->custnum.
 332           " (". $cust_main->last. ", ". $cust_main->first. ")\n",
 333         'paid: $'. sprintf("%.2f", $self->paid). "\n",
 334         'date: '. time2str("%a %b %e %T %Y", $self->_date). "\n",
 335         'payby: '. $self->payby. "\n",
 336         'payinfo: '. $self->paymask. "\n",
 337         'paybatch: '. $self->paybatch. "\n",
 338       ],
 339     );
 340
 341     if ( $error ) {
 342       $dbh->rollback if $oldAutoCommit;
 343       return "can't send payment deletion notification: $error";
 344     }
 345
 346   }
 347
 348   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 349
 350   '';
 351
 352 }
 353
 354 =item replace OLD_RECORD
 355
 356 You can, but probably shouldn't modify payments...
 357
 358 =cut
 359
 360 sub replace {
 361   #return "Can't modify payment!"
 362   my $self = shift;
 363   return "Can't modify closed payment" if $self->closed =~ /^Y/i;
 364   $self->SUPER::replace(@_);
 365 }
 366
 367 =item check
 368
 369 Checks all fields to make sure this is a valid payment.  If there is an error,
 370 returns the error, otherwise returns false.  Called by the insert method.
 371
 372 =cut
 373
 374 sub check {
 375   my $self = shift;
 376
 377   $self->otaker(getotaker) unless ($self->otaker);
 378
 379   my $error =
 380     $self->ut_numbern('paynum')
 381     || $self->ut_numbern('custnum')
 382     || $self->ut_numbern('_date')
 383     || $self->ut_money('paid')
 384     || $self->ut_alpha('otaker')
 385     || $self->ut_textn('paybatch')
 386     || $self->ut_textn('payunique')
 387     || $self->ut_enum('closed', [ '', 'Y' ])
 388     || $self->ut_foreign_keyn('pkgnum', 'cust_pkg', 'pkgnum')
 389     || $self->payinfo_check()
 390   ;
 391   return $error if $error;
 392
 393   return "paid must be > 0 " if $self->paid <= 0;
 394
 395   return "unknown cust_main.custnum: ". $self->custnum
 396     unless $self->invnum
 397            || qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
 398
 399   $self->_date(time) unless $self->_date;
 400
 401 #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it
 402 #  # UNIQUE index should catch this too, without race conditions, but this
 403 #  # should give a better error message the other 99.9% of the time...
 404 #  if ( length($self->payunique)
 405 #       && qsearchs('cust_pay', { 'payunique' => $self->payunique } ) ) {
 406 #    #well, it *could* be a better error message
 407 #    return "duplicate transaction".
 408 #           " - a payment with unique identifer ". $self->payunique.
 409 #           " already exists";
 410 #  }
 411
 412   $self->SUPER::check;
 413 }
 414
 415 =item send_receipt HASHREF | OPTION => VALUE ...
 416
 417 Sends a payment receipt for this payment..
 418
 419 Available options:
 420
 421 =over 4
 422
 423 =item manual
 424
 425 Flag indicating the payment is being made manually.
 426
 427 =item cust_bill
 428
 429 Invoice (FS::cust_bill) object.  If not specified, the most recent invoice
 430 will be assumed.
 431
 432 =item cust_main
 433
 434 Customer (FS::cust_main) object (for efficiency).
 435
 436 =back
 437
 438 =cut
 439
 440 sub send_receipt {
 441   my $self = shift;
 442   my $opt = ref($_[0]) ? shift : { @_ };
 443
 444   my $cust_bill = $opt->{'cust_bill'};
 445   my $cust_main = $opt->{'cust_main'} || $self->cust_main;
 446
 447   my $conf = new FS::Conf;
 448
 449   return ''
 450     unless $conf->exists('payment_receipt_email')
 451         && grep { $_ !~ /^(POST|FAX)$/ } $cust_main->invoicing_list;
 452
 453   $cust_bill ||= ($cust_main->cust_bill)[-1]; #rather inefficient though?
 454
 455   if (    ( exists($opt->{'manual'}) && $opt->{'manual'} )
 456        || ! $conf->exists('invoice_html_statement')
 457        || ! $cust_bill
 458      ) {
 459
 460     my $receipt_template = new Text::Template (
 461       TYPE   => 'ARRAY',
 462       SOURCE => [ map "$_\n", $conf->config('payment_receipt_email') ],
 463     ) or do {
 464       warn "can't create payment receipt template: $Text::Template::ERROR";
 465       return '';
 466     };
 467
 468     my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ }
 469                            $cust_main->invoicing_list;
 470
 471     my $payby = $self->payby;
 472     my $payinfo = $self->payinfo;
 473     $payby =~ s/^BILL$/Check/ if $payinfo;
 474     if ( $payby eq 'CARD' || $payby eq 'CHEK' ) {
 475       $payinfo = $self->paymask
 476     } else {
 477       $payinfo = $self->decrypt($payinfo);
 478     }
 479     $payby =~ s/^CHEK$/Electronic check/;
 480
 481     my %fill_in = (
 482       'date'         => time2str("%a %B %o, %Y", $self->_date),
 483       'name'         => $cust_main->name,
 484       'paynum'       => $self->paynum,
 485       'paid'         => sprintf("%.2f", $self->paid),
 486       'payby'        => ucfirst(lc($payby)),
 487       'payinfo'      => $payinfo,
 488       'balance'      => $cust_main->balance,
 489       'company_name' => $conf->config('company_name', $cust_main->agentnum),
 490     );
 491
 492     if ( $opt->{'cust_pkg'} ) {
 493       $fill_in{'pkg'} = $opt->{'cust_pkg'}->part_pkg->pkg;
 494       #setup date, other things?
 495     }
 496
 497     send_email(
 498       'from'    => $conf->config('invoice_from', $cust_main->agentnum),
 499                                  #invoice_from??? well as good as any
 500       'to'      => \@invoicing_list,
 501       'subject' => 'Payment receipt',
 502       'body'    => [ $receipt_template->fill_in( HASH => \%fill_in ) ],
 503     );
 504
 505   } else {
 506
 507     my $queue = new FS::queue {
 508        'paynum' => $self->paynum,
 509        'job'    => 'FS::cust_bill::queueable_email',
 510     };
 511
 512     $queue->insert(
 513       'invnum'   => $cust_bill->invnum,
 514       'template' => 'statement',
 515     );
 516
 517   }
 518
 519 }
 520
 521 =item cust_bill_pay
 522
 523 Returns all applications to invoices (see L<FS::cust_bill_pay>) for this
 524 payment.
 525
 526 =cut
 527
 528 sub cust_bill_pay {
 529   my $self = shift;
 530   sort {    $a->_date  <=> $b->_date
 531          || $a->invnum <=> $b->invnum }
 532     qsearch( 'cust_bill_pay', { 'paynum' => $self->paynum } )
 533   ;
 534 }
 535
 536 =item cust_pay_refund
 537
 538 Returns all applications of refunds (see L<FS::cust_pay_refund>) to this
 539 payment.
 540
 541 =cut
 542
 543 sub cust_pay_refund {
 544   my $self = shift;
 545   sort { $a->_date <=> $b->_date }
 546     qsearch( 'cust_pay_refund', { 'paynum' => $self->paynum } )
 547   ;
 548 }
 549
 550
 551 =item unapplied
 552
 553 Returns the amount of this payment that is still unapplied; which is
 554 paid minus all payment applications (see L<FS::cust_bill_pay>) and refund
 555 applications (see L<FS::cust_pay_refund>).
 556
 557 =cut
 558
 559 sub unapplied {
 560   my $self = shift;
 561   my $amount = $self->paid;
 562   $amount -= $_->amount foreach ( $self->cust_bill_pay );
 563   $amount -= $_->amount foreach ( $self->cust_pay_refund );
 564   sprintf("%.2f", $amount );
 565 }
 566
 567 =item unrefunded
 568
 569 Returns the amount of this payment that has not been refuned; which is
 570 paid minus all  refund applications (see L<FS::cust_pay_refund>).
 571
 572 =cut
 573
 574 sub unrefunded {
 575   my $self = shift;
 576   my $amount = $self->paid;
 577   $amount -= $_->amount foreach ( $self->cust_pay_refund );
 578   sprintf("%.2f", $amount );
 579 }
 580
 581 =item amount
 582
 583 Returns the "paid" field.
 584
 585 =cut
 586
 587 sub amount {
 588   my $self = shift;
 589   $self->paid();
 590 }
 591
 592 =back
 593
 594 =head1 CLASS METHODS
 595
 596 =over 4
 597
 598 =item batch_insert CUST_PAY_OBJECT, ...
 599
 600 Class method which inserts multiple payments.  Takes a list of FS::cust_pay
 601 objects.  Returns a list, each element representing the status of inserting the
 602 corresponding payment - empty.  If there is an error inserting any payment, the
 603 entire transaction is rolled back, i.e. all payments are inserted or none are.
 604
 605 For example:
 606
 607   my @errors = FS::cust_pay->batch_insert(@cust_pay);
 608   my $num_errors = scalar(grep $_, @errors);
 609   if ( $num_errors == 0 ) {
 610     #success; all payments were inserted
 611   } else {
 612     #failure; no payments were inserted.
 613   }
 614
 615 =cut
 616
 617 sub batch_insert {
 618   my $self = shift; #class method
 619
 620   local $SIG{HUP} = 'IGNORE';
 621   local $SIG{INT} = 'IGNORE';
 622   local $SIG{QUIT} = 'IGNORE';
 623   local $SIG{TERM} = 'IGNORE';
 624   local $SIG{TSTP} = 'IGNORE';
 625   local $SIG{PIPE} = 'IGNORE';
 626
 627   my $oldAutoCommit = $FS::UID::AutoCommit;
 628   local $FS::UID::AutoCommit = 0;
 629   my $dbh = dbh;
 630
 631   my $errors = 0;
 632
 633   my @errors = map {
 634     my $error = $_->insert( 'manual' => 1 );
 635     if ( $error ) {
 636       $errors++;
 637     } else {
 638       $_->cust_main->apply_payments;
 639     }
 640     $error;
 641   } @_;
 642
 643   if ( $errors ) {
 644     $dbh->rollback if $oldAutoCommit;
 645   } else {
 646     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 647   }
 648
 649   @errors;
 650
 651 }
 652
 653 =item unapplied_sql
 654
 655 Returns an SQL fragment to retreive the unapplied amount.
 656
 657 =cut
 658
 659 sub unapplied_sql {
 660   #my $class = shift;
 661
 662   "paid
 663         - COALESCE(
 664                     ( SELECT SUM(amount) FROM cust_bill_pay
 665                         WHERE cust_pay.paynum = cust_bill_pay.paynum )
 666                     ,0
 667                   )
 668         - COALESCE(
 669                     ( SELECT SUM(amount) FROM cust_pay_refund
 670                         WHERE cust_pay.paynum = cust_pay_refund.paynum )
 671                     ,0
 672                   )
 673   ";
 674
 675 }
 676
 677 # _upgrade_data
 678 #
 679 # Used by FS::Upgrade to migrate to a new database.
 680
 681 use FS::h_cust_pay;
 682
 683 sub _upgrade_data {  #class method
 684   my ($class, %opts) = @_;
 685
 686   warn "$me upgrading $class\n" if $DEBUG;
 687
 688   #not the most efficient, but hey, it only has to run once
 689
 690   my $where = "WHERE ( otaker IS NULL OR otaker = '' OR otaker = 'ivan' ) ".
 691               "  AND 0 < ( SELECT COUNT(*) FROM cust_main                 ".
 692               "              WHERE cust_main.custnum = cust_pay.custnum ) ";
 693
 694   my $count_sql = "SELECT COUNT(*) FROM cust_pay $where";
 695
 696   my $sth = dbh->prepare($count_sql) or die dbh->errstr;
 697   $sth->execute or die $sth->errstr;
 698   my $total = $sth->fetchrow_arrayref->[0];
 699   #warn "$total cust_pay records to update\n"
 700   #  if $DEBUG;
 701   local($DEBUG) = 2 if $total > 1000; #could be a while, force progress info
 702
 703   my $count = 0;
 704   my $lastprog = 0;
 705
 706   my @cust_pay = qsearch( {
 707       'table'     => 'cust_pay',
 708       'hashref'   => {},
 709       'extra_sql' => $where,
 710       'order_by'  => 'ORDER BY paynum',
 711   } );
 712
 713   foreach my $cust_pay (@cust_pay) {
 714
 715     my $h_cust_pay = $cust_pay->h_search('insert');
 716     if ( $h_cust_pay ) {
 717       next if $cust_pay->otaker eq $h_cust_pay->history_user;
 718       $cust_pay->otaker($h_cust_pay->history_user);
 719     } else {
 720       $cust_pay->otaker('legacy');
 721     }
 722
 723     delete $FS::payby::hash{'COMP'}->{cust_pay}; #quelle kludge
 724     my $error = $cust_pay->replace;
 725
 726     if ( $error ) {
 727       warn " *** WARNING: Error updating order taker for payment paynum ".
 728            $cust_pay->paynun. ": $error\n";
 729       next;
 730     }
 731
 732     $FS::payby::hash{'COMP'}->{cust_pay} = ''; #restore it
 733
 734     $count++;
 735     if ( $DEBUG > 1 && $lastprog + 30 < time ) {
 736       warn "$me $count/$total (". sprintf('%.2f',100*$count/$total). '%)'. "\n";
 737       $lastprog = time;
 738     }
 739
 740   }
 741
 742 }
 743
 744 =back
 745
 746 =head1 SUBROUTINES
 747
 748 =over 4
 749
 750 =item batch_import HASHREF
 751
 752 Inserts new payments.
 753
 754 =cut
 755
 756 sub batch_import {
 757   my $param = shift;
 758
 759   my $fh = $param->{filehandle};
 760   my $agentnum = $param->{agentnum};
 761   my $format = $param->{'format'};
 762   my $paybatch = $param->{'paybatch'};
 763
 764   # here is the agent virtualization
 765   my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
 766
 767   my @fields;
 768   my $payby;
 769   if ( $format eq 'simple' ) {
 770     @fields = qw( custnum agent_custid paid payinfo );
 771     $payby = 'BILL';
 772   } elsif ( $format eq 'extended' ) {
 773     die "unimplemented\n";
 774     @fields = qw( );
 775     $payby = 'BILL';
 776   } else {
 777     die "unknown format $format";
 778   }
 779
 780   eval "use Text::CSV_XS;";
 781   die $@ if $@;
 782
 783   my $csv = new Text::CSV_XS;
 784
 785   my $imported = 0;
 786
 787   local $SIG{HUP} = 'IGNORE';
 788   local $SIG{INT} = 'IGNORE';
 789   local $SIG{QUIT} = 'IGNORE';
 790   local $SIG{TERM} = 'IGNORE';
 791   local $SIG{TSTP} = 'IGNORE';
 792   local $SIG{PIPE} = 'IGNORE';
 793
 794   my $oldAutoCommit = $FS::UID::AutoCommit;
 795   local $FS::UID::AutoCommit = 0;
 796   my $dbh = dbh;
 797
 798   my $line;
 799   while ( defined($line=<$fh>) ) {
 800
 801     $csv->parse($line) or do {
 802       $dbh->rollback if $oldAutoCommit;
 803       return "can't parse: ". $csv->error_input();
 804     };
 805
 806     my @columns = $csv->fields();
 807
 808     my %cust_pay = (
 809       payby    => $payby,
 810       paybatch => $paybatch,
 811     );
 812
 813     my $cust_main;
 814     foreach my $field ( @fields ) {
 815
 816       if ( $field eq 'agent_custid'
 817         && $agentnum
 818         && $columns[0] =~ /\S+/ )
 819       {
 820
 821         my $agent_custid = $columns[0];
 822         my %hash = ( 'agent_custid' => $agent_custid,
 823                      'agentnum'     => $agentnum,
 824                    );
 825
 826         if ( $cust_pay{'custnum'} !~ /^\s*$/ ) {
 827           $dbh->rollback if $oldAutoCommit;
 828           return "can't specify custnum with agent_custid $agent_custid";
 829         }
 830
 831         $cust_main = qsearchs({
 832                                 'table'     => 'cust_main',
 833                                 'hashref'   => \%hash,
 834                                 'extra_sql' => $extra_sql,
 835                              });
 836
 837         unless ( $cust_main ) {
 838           $dbh->rollback if $oldAutoCommit;
 839           return "can't find customer with agent_custid $agent_custid";
 840         }
 841
 842         $field = 'custnum';
 843         $columns[0] = $cust_main->custnum;
 844       }
 845
 846       $cust_pay{$field} = shift @columns;
 847     }
 848
 849     my $cust_pay = new FS::cust_pay( \%cust_pay );
 850     my $error = $cust_pay->insert;
 851
 852     if ( $error ) {
 853       $dbh->rollback if $oldAutoCommit;
 854       return "can't insert payment for $line: $error";
 855     }
 856
 857     if ( $format eq 'simple' ) {
 858       # include agentnum for less surprise?
 859       $cust_main = qsearchs({
 860                              'table'     => 'cust_main',
 861                              'hashref'   => { 'custnum' => $cust_pay->custnum },
 862                              'extra_sql' => $extra_sql,
 863                            })
 864         unless $cust_main;
 865
 866       unless ( $cust_main ) {
 867         $dbh->rollback if $oldAutoCommit;
 868         return "can't find customer to which payments apply at line: $line";
 869       }
 870
 871       $error = $cust_main->apply_payments_and_credits;
 872       if ( $error ) {
 873         $dbh->rollback if $oldAutoCommit;
 874         return "can't apply payments to customer for $line: $error";
 875       }
 876
 877     }
 878
 879     $imported++;
 880   }
 881
 882   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 883
 884   return "Empty file!" unless $imported;
 885
 886   ''; #no error
 887
 888 }
 889
 890 =back
 891
 892 =head1 BUGS
 893
 894 Delete and replace methods.
 895
 896 =head1 SEE ALSO
 897
 898 L<FS::cust_pay_pending>, L<FS::cust_bill_pay>, L<FS::cust_bill>, L<FS::Record>,
 899 schema.html from the base documentation.
 900
 901 =cut
 902
 903 1;
 904