C4/Accounts.pm

   1 package C4::Accounts;
   2
   3 # Copyright 2000-2002 Katipo Communications
   4 #
   5 # This file is part of Koha.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it
   8 # under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  19
  20
  21 use strict;
  22 #use warnings; FIXME - Bug 2505
  23 use C4::Context;
  24 use C4::Stats;
  25 use C4::Members;
  26 use C4::Circulation qw(ReturnLostItem);
  27 use C4::Log qw(logaction);
  28
  29 use Data::Dumper qw(Dumper);
  30
  31 use vars qw($VERSION @ISA @EXPORT);
  32
  33 BEGIN {
  34         # set the version for version checking
  35     $VERSION = 3.07.00.049;
  36         require Exporter;
  37         @ISA    = qw(Exporter);
  38         @EXPORT = qw(
  39                 &recordpayment
  40                 &makepayment
  41                 &manualinvoice
  42                 &getnextacctno
  43                 &getcharges
  44                 &ModNote
  45                 &getcredits
  46                 &getrefunds
  47                 &chargelostitem
  48                 &ReversePayment
  49         &makepartialpayment
  50         &recordpayment_selectaccts
  51         &WriteOffFee
  52         &purge_zero_balance_fees
  53         );
  54 }
  55
  56 =head1 NAME
  57
  58 C4::Accounts - Functions for dealing with Koha accounts
  59
  60 =head1 SYNOPSIS
  61
  62 use C4::Accounts;
  63
  64 =head1 DESCRIPTION
  65
  66 The functions in this module deal with the monetary aspect of Koha,
  67 including looking up and modifying the amount of money owed by a
  68 patron.
  69
  70 =head1 FUNCTIONS
  71
  72 =head2 recordpayment
  73
  74   &recordpayment($borrowernumber, $payment, $sip_paytype, $note);
  75
  76 Record payment by a patron. C<$borrowernumber> is the patron's
  77 borrower number. C<$payment> is a floating-point number, giving the
  78 amount that was paid. C<$sip_paytype> is an optional flag to indicate this
  79 payment was made over a SIP2 interface, rather than the staff client. The
  80 value passed is the SIP2 payment type value (message 37, characters 21-22)
  81
  82 Amounts owed are paid off oldest first. That is, if the patron has a
  83 $1 fine from Feb. 1, another $1 fine from Mar. 1, and makes a payment
  84 of $1.50, then the oldest fine will be paid off in full, and $0.50
  85 will be credited to the next one.
  86
  87 =cut
  88
  89 #'
  90 sub recordpayment {
  91
  92     #here we update the account lines
  93     my ( $borrowernumber, $data, $sip_paytype, $payment_note ) = @_;
  94     my $dbh        = C4::Context->dbh;
  95     my $newamtos   = 0;
  96     my $accdata    = "";
  97     my $branch     = C4::Context->userenv->{'branch'};
  98     my $amountleft = $data;
  99     my $manager_id = 0;
 100     $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
 101
 102     $payment_note //= "";
 103
 104     # begin transaction
 105     my $nextaccntno = getnextacctno($borrowernumber);
 106
 107     # get lines with outstanding amounts to offset
 108     my $sth = $dbh->prepare(
 109         "SELECT * FROM accountlines
 110   WHERE (borrowernumber = ?) AND (amountoutstanding<>0)
 111   ORDER BY date"
 112     );
 113     $sth->execute($borrowernumber);
 114
 115     # offset transactions
 116     my @ids;
 117     while ( ( $accdata = $sth->fetchrow_hashref ) and ( $amountleft > 0 ) ) {
 118         if ( $accdata->{'amountoutstanding'} < $amountleft ) {
 119             $newamtos = 0;
 120             $amountleft -= $accdata->{'amountoutstanding'};
 121         }
 122         else {
 123             $newamtos   = $accdata->{'amountoutstanding'} - $amountleft;
 124             $amountleft = 0;
 125         }
 126         my $thisacct = $accdata->{accountlines_id};
 127         my $usth     = $dbh->prepare(
 128             "UPDATE accountlines SET amountoutstanding= ?
 129      WHERE (accountlines_id = ?)"
 130         );
 131         $usth->execute( $newamtos, $thisacct );
 132
 133         if ( C4::Context->preference("FinesLog") ) {
 134             $accdata->{'amountoutstanding_new'} = $newamtos;
 135             logaction("FINES", 'MODIFY', $borrowernumber, Dumper({
 136                 action                => 'fee_payment',
 137                 borrowernumber        => $accdata->{'borrowernumber'},
 138                 old_amountoutstanding => $accdata->{'amountoutstanding'},
 139                 new_amountoutstanding => $newamtos,
 140                 amount_paid           => $accdata->{'amountoutstanding'} - $newamtos,
 141                 accountlines_id       => $accdata->{'accountlines_id'},
 142                 accountno             => $accdata->{'accountno'},
 143                 manager_id            => $manager_id,
 144                 note                  => $payment_note,
 145             }));
 146             push( @ids, $accdata->{'accountlines_id'} );
 147         }
 148     }
 149
 150     # create new line
 151     my $usth = $dbh->prepare(
 152         "INSERT INTO accountlines
 153   (borrowernumber, accountno,date,amount,description,accounttype,amountoutstanding,manager_id, note)
 154   VALUES (?,?,now(),?,'',?,?,?,?)"
 155     );
 156
 157     my $paytype = "Pay";
 158     $paytype .= $sip_paytype if defined $sip_paytype;
 159     $usth->execute( $borrowernumber, $nextaccntno, 0 - $data, $paytype, 0 - $amountleft, $manager_id, $payment_note );
 160     $usth->finish;
 161
 162     UpdateStats({
 163                 branch => $branch,
 164                 type =>'payment',
 165                 amount => $data,
 166                 borrowernumber => $borrowernumber,
 167                 accountno => $nextaccntno }
 168     );
 169
 170     if ( C4::Context->preference("FinesLog") ) {
 171         $accdata->{'amountoutstanding_new'} = $newamtos;
 172         logaction("FINES", 'CREATE',$borrowernumber,Dumper({
 173             action            => 'create_payment',
 174             borrowernumber    => $borrowernumber,
 175             accountno         => $nextaccntno,
 176             amount            => $data * -1,
 177             amountoutstanding => $amountleft * -1,
 178             accounttype       => 'Pay',
 179             accountlines_paid => \@ids,
 180             manager_id        => $manager_id,
 181         }));
 182     }
 183
 184 }
 185
 186 =head2 makepayment
 187
 188   &makepayment($accountlines_id, $borrowernumber, $acctnumber, $amount, $branchcode);
 189
 190 Records the fact that a patron has paid off the entire amount he or
 191 she owes.
 192
 193 C<$borrowernumber> is the patron's borrower number. C<$acctnumber> is
 194 the account that was credited. C<$amount> is the amount paid (this is
 195 only used to record the payment. It is assumed to be equal to the
 196 amount owed). C<$branchcode> is the code of the branch where payment
 197 was made.
 198
 199 =cut
 200
 201 #'
 202 # FIXME - I'm not at all sure about the above, because I don't
 203 # understand what the acct* tables in the Koha database are for.
 204 sub makepayment {
 205
 206     #here we update both the accountoffsets and the account lines
 207     #updated to check, if they are paying off a lost item, we return the item
 208     # from their card, and put a note on the item record
 209     my ( $accountlines_id, $borrowernumber, $accountno, $amount, $user, $branch, $payment_note ) = @_;
 210     my $dbh = C4::Context->dbh;
 211     my $manager_id = 0;
 212     $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
 213
 214     # begin transaction
 215     my $nextaccntno = getnextacctno($borrowernumber);
 216     my $newamtos    = 0;
 217     my $sth         = $dbh->prepare("SELECT * FROM accountlines WHERE accountlines_id=?");
 218     $sth->execute( $accountlines_id );
 219     my $data = $sth->fetchrow_hashref;
 220
 221     my $payment;
 222     if ( $data->{'accounttype'} eq "Pay" ){
 223         my $udp =
 224             $dbh->prepare(
 225                 "UPDATE accountlines
 226                     SET amountoutstanding = 0
 227                     WHERE accountlines_id = ?
 228                 "
 229             );
 230         $udp->execute($accountlines_id);
 231     }else{
 232         my $udp =
 233             $dbh->prepare(
 234                 "UPDATE accountlines
 235                     SET amountoutstanding = 0
 236                     WHERE accountlines_id = ?
 237                 "
 238             );
 239         $udp->execute($accountlines_id);
 240
 241          # create new line
 242         my $payment = 0 - $amount;
 243         $payment_note //= "";
 244
 245         my $ins =
 246             $dbh->prepare(
 247                 "INSERT
 248                     INTO accountlines (borrowernumber, accountno, date, amount, itemnumber, description, accounttype, amountoutstanding, manager_id, note)
 249                     VALUES ( ?, ?, now(), ?, ?, '', 'Pay', 0, ?, ?)"
 250             );
 251         $ins->execute($borrowernumber, $nextaccntno, $payment, $data->{'itemnumber'}, $manager_id, $payment_note);
 252     }
 253
 254     if ( C4::Context->preference("FinesLog") ) {
 255         logaction("FINES", 'MODIFY', $borrowernumber, Dumper({
 256             action                => 'fee_payment',
 257             borrowernumber        => $borrowernumber,
 258             old_amountoutstanding => $data->{'amountoutstanding'},
 259             new_amountoutstanding => 0,
 260             amount_paid           => $data->{'amountoutstanding'},
 261             accountlines_id       => $data->{'accountlines_id'},
 262             accountno             => $data->{'accountno'},
 263             manager_id            => $manager_id,
 264         }));
 265
 266
 267         logaction("FINES", 'CREATE',$borrowernumber,Dumper({
 268             action            => 'create_payment',
 269             borrowernumber    => $borrowernumber,
 270             accountno         => $nextaccntno,
 271             amount            => $payment,
 272             amountoutstanding => 0,,
 273             accounttype       => 'Pay',
 274             accountlines_paid => [$data->{'accountlines_id'}],
 275             manager_id        => $manager_id,
 276         }));
 277     }
 278
 279     UpdateStats({
 280         branch => $branch,
 281         type   => 'payment',
 282         amount => $amount,
 283         borrowernumber => $borrowernumber,
 284         accountno => $accountno
 285     });
 286
 287     #check to see what accounttype
 288     if ( $data->{itemnumber} && ( $data->{'accounttype'} eq 'Rep' || $data->{'accounttype'} eq 'L' ) ) {
 289         C4::Circulation::ReturnLostItem( $borrowernumber, $data->{'itemnumber'} );
 290     }
 291     my $sthr = $dbh->prepare("SELECT max(accountlines_id) AS lastinsertid FROM accountlines");
 292     $sthr->execute();
 293     my $datalastinsertid = $sthr->fetchrow_hashref;
 294     return $datalastinsertid->{'lastinsertid'};
 295 }
 296
 297 =head2 getnextacctno
 298
 299   $nextacct = &getnextacctno($borrowernumber);
 300
 301 Returns the next unused account number for the patron with the given
 302 borrower number.
 303
 304 =cut
 305
 306 #'
 307 # FIXME - Okay, so what does the above actually _mean_?
 308 sub getnextacctno {
 309     my ($borrowernumber) = shift or return;
 310     my $sth = C4::Context->dbh->prepare(
 311         "SELECT accountno+1 FROM accountlines
 312             WHERE    (borrowernumber = ?)
 313             ORDER BY accountno DESC
 314             LIMIT 1"
 315     );
 316     $sth->execute($borrowernumber);
 317     return ($sth->fetchrow || 1);
 318 }
 319
 320 =head2 fixaccounts (removed)
 321
 322   &fixaccounts($accountlines_id, $borrowernumber, $accountnumber, $amount);
 323
 324 #'
 325 # FIXME - I don't understand what this function does.
 326 sub fixaccounts {
 327     my ( $accountlines_id, $borrowernumber, $accountno, $amount ) = @_;
 328     my $dbh = C4::Context->dbh;
 329     my $sth = $dbh->prepare(
 330         "SELECT * FROM accountlines WHERE accountlines_id=?"
 331     );
 332     $sth->execute( $accountlines_id );
 333     my $data = $sth->fetchrow_hashref;
 334
 335     # FIXME - Error-checking
 336     my $diff        = $amount - $data->{'amount'};
 337     my $outstanding = $data->{'amountoutstanding'} + $diff;
 338     $sth->finish;
 339
 340     $dbh->do(<<EOT);
 341         UPDATE  accountlines
 342         SET     amount = '$amount',
 343                 amountoutstanding = '$outstanding'
 344         WHERE   accountlines_id = $accountlines_id
 345 EOT
 346         # FIXME: exceedingly bad form.  Use prepare with placholders ("?") in query and execute args.
 347 }
 348
 349 =cut
 350
 351 sub chargelostitem{
 352 # lost ==1 Lost, lost==2 longoverdue, lost==3 lost and paid for
 353 # FIXME: itemlost should be set to 3 after payment is made, should be a warning to the interface that
 354 # a charge has been added
 355 # FIXME : if no replacement price, borrower just doesn't get charged?
 356     my $dbh = C4::Context->dbh();
 357     my ($borrowernumber, $itemnumber, $amount, $description) = @_;
 358
 359     # first make sure the borrower hasn't already been charged for this item
 360     my $sth1=$dbh->prepare("SELECT * from accountlines
 361     WHERE borrowernumber=? AND itemnumber=? and accounttype='L'");
 362     $sth1->execute($borrowernumber,$itemnumber);
 363     my $existing_charge_hashref=$sth1->fetchrow_hashref();
 364
 365     # OK, they haven't
 366     unless ($existing_charge_hashref) {
 367         my $manager_id = 0;
 368         $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
 369         # This item is on issue ... add replacement cost to the borrower's record and mark it returned
 370         #  Note that we add this to the account even if there's no replacement price, allowing some other
 371         #  process (or person) to update it, since we don't handle any defaults for replacement prices.
 372         my $accountno = getnextacctno($borrowernumber);
 373         my $sth2=$dbh->prepare("INSERT INTO accountlines
 374         (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding,itemnumber,manager_id)
 375         VALUES (?,?,now(),?,?,'L',?,?,?)");
 376         $sth2->execute($borrowernumber,$accountno,$amount,
 377         $description,$amount,$itemnumber,$manager_id);
 378
 379         if ( C4::Context->preference("FinesLog") ) {
 380             logaction("FINES", 'CREATE', $borrowernumber, Dumper({
 381                 action            => 'create_fee',
 382                 borrowernumber    => $borrowernumber,
 383                 accountno         => $accountno,
 384                 amount            => $amount,
 385                 amountoutstanding => $amount,
 386                 description       => $description,
 387                 accounttype       => 'L',
 388                 itemnumber        => $itemnumber,
 389                 manager_id        => $manager_id,
 390             }));
 391         }
 392
 393     }
 394 }
 395
 396 =head2 manualinvoice
 397
 398   &manualinvoice($borrowernumber, $itemnumber, $description, $type,
 399                  $amount, $note);
 400
 401 C<$borrowernumber> is the patron's borrower number.
 402 C<$description> is a description of the transaction.
 403 C<$type> may be one of C<CS>, C<CB>, C<CW>, C<CF>, C<CL>, C<N>, C<L>,
 404 or C<REF>.
 405 C<$itemnumber> is the item involved, if pertinent; otherwise, it
 406 should be the empty string.
 407
 408 =cut
 409
 410 #'
 411 # FIXME: In Koha 3.0 , the only account adjustment 'types' passed to this function
 412 # are :
 413 #               'C' = CREDIT
 414 #               'FOR' = FORGIVEN  (Formerly 'F', but 'F' is taken to mean 'FINE' elsewhere)
 415 #               'N' = New Card fee
 416 #               'F' = Fine
 417 #               'A' = Account Management fee
 418 #               'M' = Sundry
 419 #               'L' = Lost Item
 420 #
 421
 422 sub manualinvoice {
 423     my ( $borrowernumber, $itemnum, $desc, $type, $amount, $note ) = @_;
 424     my $manager_id = 0;
 425     $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
 426     my $dbh      = C4::Context->dbh;
 427     my $notifyid = 0;
 428     my $insert;
 429     my $accountno  = getnextacctno($borrowernumber);
 430     my $amountleft = $amount;
 431
 432     if (   ( $type eq 'L' )
 433         or ( $type eq 'F' )
 434         or ( $type eq 'A' )
 435         or ( $type eq 'N' )
 436         or ( $type eq 'M' ) )
 437     {
 438         $notifyid = 1;
 439     }
 440
 441     if ( $itemnum ) {
 442         $desc .= ' ' . $itemnum;
 443         my $sth = $dbh->prepare(
 444             'INSERT INTO  accountlines
 445                         (borrowernumber, accountno, date, amount, description, accounttype, amountoutstanding, itemnumber,notify_id, note, manager_id)
 446         VALUES (?, ?, now(), ?,?, ?,?,?,?,?,?)');
 447      $sth->execute($borrowernumber, $accountno, $amount, $desc, $type, $amountleft, $itemnum,$notifyid, $note, $manager_id) || return $sth->errstr;
 448   } else {
 449     my $sth=$dbh->prepare("INSERT INTO  accountlines
 450             (borrowernumber, accountno, date, amount, description, accounttype, amountoutstanding,notify_id, note, manager_id)
 451             VALUES (?, ?, now(), ?, ?, ?, ?,?,?,?)"
 452         );
 453         $sth->execute( $borrowernumber, $accountno, $amount, $desc, $type,
 454             $amountleft, $notifyid, $note, $manager_id );
 455     }
 456
 457     if ( C4::Context->preference("FinesLog") ) {
 458         logaction("FINES", 'CREATE',$borrowernumber,Dumper({
 459             action            => 'create_fee',
 460             borrowernumber    => $borrowernumber,
 461             accountno         => $accountno,
 462             amount            => $amount,
 463             description       => $desc,
 464             accounttype       => $type,
 465             amountoutstanding => $amountleft,
 466             notify_id         => $notifyid,
 467             note              => $note,
 468             itemnumber        => $itemnum,
 469             manager_id        => $manager_id,
 470         }));
 471     }
 472
 473     return 0;
 474 }
 475
 476 sub getcharges {
 477         my ( $borrowerno, $timestamp, $accountno ) = @_;
 478         my $dbh        = C4::Context->dbh;
 479         my $timestamp2 = $timestamp - 1;
 480         my $query      = "";
 481         my $sth = $dbh->prepare(
 482                         "SELECT * FROM accountlines WHERE borrowernumber=? AND accountno = ?"
 483           );
 484         $sth->execute( $borrowerno, $accountno );
 485
 486     my @results;
 487     while ( my $data = $sth->fetchrow_hashref ) {
 488                 push @results,$data;
 489         }
 490     return (@results);
 491 }
 492
 493 sub ModNote {
 494     my ( $accountlines_id, $note ) = @_;
 495     my $dbh = C4::Context->dbh;
 496     my $sth = $dbh->prepare('UPDATE accountlines SET note = ? WHERE accountlines_id = ?');
 497     $sth->execute( $note, $accountlines_id );
 498 }
 499
 500 sub getcredits {
 501         my ( $date, $date2 ) = @_;
 502         my $dbh = C4::Context->dbh;
 503         my $sth = $dbh->prepare(
 504                                 "SELECT * FROM accountlines,borrowers
 505       WHERE amount < 0 AND accounttype not like 'Pay%' AND accountlines.borrowernumber = borrowers.borrowernumber
 506           AND timestamp >=TIMESTAMP(?) AND timestamp < TIMESTAMP(?)"
 507       );
 508
 509     $sth->execute( $date, $date2 );
 510     my @results;
 511     while ( my $data = $sth->fetchrow_hashref ) {
 512                 $data->{'date'} = $data->{'timestamp'};
 513                 push @results,$data;
 514         }
 515     return (@results);
 516 }
 517
 518
 519 sub getrefunds {
 520         my ( $date, $date2 ) = @_;
 521         my $dbh = C4::Context->dbh;
 522
 523         my $sth = $dbh->prepare(
 524                                 "SELECT *,timestamp AS datetime
 525                   FROM accountlines,borrowers
 526                   WHERE (accounttype = 'REF'
 527                                           AND accountlines.borrowernumber = borrowers.borrowernumber
 528                                                           AND date  >=?  AND date  <?)"
 529     );
 530
 531     $sth->execute( $date, $date2 );
 532
 533     my @results;
 534     while ( my $data = $sth->fetchrow_hashref ) {
 535                 push @results,$data;
 536
 537         }
 538     return (@results);
 539 }
 540
 541 sub ReversePayment {
 542     my ( $accountlines_id ) = @_;
 543     my $dbh = C4::Context->dbh;
 544
 545     my $sth = $dbh->prepare('SELECT * FROM accountlines WHERE accountlines_id = ?');
 546     $sth->execute( $accountlines_id );
 547     my $row = $sth->fetchrow_hashref();
 548     my $amount_outstanding = $row->{'amountoutstanding'};
 549
 550     if ( $amount_outstanding <= 0 ) {
 551         $sth = $dbh->prepare('UPDATE accountlines SET amountoutstanding = amount * -1, description = CONCAT( description, " Reversed -" ) WHERE accountlines_id = ?');
 552         $sth->execute( $accountlines_id );
 553     } else {
 554         $sth = $dbh->prepare('UPDATE accountlines SET amountoutstanding = 0, description = CONCAT( description, " Reversed -" ) WHERE accountlines_id = ?');
 555         $sth->execute( $accountlines_id );
 556     }
 557
 558     if ( C4::Context->preference("FinesLog") ) {
 559         my $manager_id = 0;
 560         $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
 561
 562         if ( $amount_outstanding <= 0 ) {
 563             $row->{'amountoutstanding'} *= -1;
 564         } else {
 565             $row->{'amountoutstanding'} = '0';
 566         }
 567         $row->{'description'} .= ' Reversed -';
 568         logaction("FINES", 'MODIFY', $row->{'borrowernumber'}, Dumper({
 569             action                => 'reverse_fee_payment',
 570             borrowernumber        => $row->{'borrowernumber'},
 571             old_amountoutstanding => $row->{'amountoutstanding'},
 572             new_amountoutstanding => 0 - $amount_outstanding,,
 573             accountlines_id       => $row->{'accountlines_id'},
 574             accountno             => $row->{'accountno'},
 575             manager_id            => $manager_id,
 576         }));
 577
 578     }
 579
 580 }
 581
 582 =head2 recordpayment_selectaccts
 583
 584   recordpayment_selectaccts($borrowernumber, $payment,$accts);
 585
 586 Record payment by a patron. C<$borrowernumber> is the patron's
 587 borrower number. C<$payment> is a floating-point number, giving the
 588 amount that was paid. C<$accts> is an array ref to a list of
 589 accountnos which the payment can be recorded against
 590
 591 Amounts owed are paid off oldest first. That is, if the patron has a
 592 $1 fine from Feb. 1, another $1 fine from Mar. 1, and makes a payment
 593 of $1.50, then the oldest fine will be paid off in full, and $0.50
 594 will be credited to the next one.
 595
 596 =cut
 597
 598 sub recordpayment_selectaccts {
 599     my ( $borrowernumber, $amount, $accts, $note ) = @_;
 600
 601     my $dbh        = C4::Context->dbh;
 602     my $newamtos   = 0;
 603     my $accdata    = q{};
 604     my $branch     = C4::Context->userenv->{branch};
 605     my $amountleft = $amount;
 606     my $manager_id = 0;
 607     $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
 608     my $sql = 'SELECT * FROM accountlines WHERE (borrowernumber = ?) ' .
 609     'AND (amountoutstanding<>0) ';
 610     if (@{$accts} ) {
 611         $sql .= ' AND accountlines_id IN ( ' .  join ',', @{$accts};
 612         $sql .= ' ) ';
 613     }
 614     $sql .= ' ORDER BY date';
 615     # begin transaction
 616     my $nextaccntno = getnextacctno($borrowernumber);
 617
 618     # get lines with outstanding amounts to offset
 619     my $rows = $dbh->selectall_arrayref($sql, { Slice => {} }, $borrowernumber);
 620
 621     # offset transactions
 622     my $sth     = $dbh->prepare('UPDATE accountlines SET amountoutstanding= ? ' .
 623         'WHERE accountlines_id=?');
 624
 625     my @ids;
 626     for my $accdata ( @{$rows} ) {
 627         if ($amountleft == 0) {
 628             last;
 629         }
 630         if ( $accdata->{amountoutstanding} < $amountleft ) {
 631             $newamtos = 0;
 632             $amountleft -= $accdata->{amountoutstanding};
 633         }
 634         else {
 635             $newamtos   = $accdata->{amountoutstanding} - $amountleft;
 636             $amountleft = 0;
 637         }
 638         my $thisacct = $accdata->{accountlines_id};
 639         $sth->execute( $newamtos, $thisacct );
 640
 641         if ( C4::Context->preference("FinesLog") ) {
 642             logaction("FINES", 'MODIFY', $borrowernumber, Dumper({
 643                 action                => 'fee_payment',
 644                 borrowernumber        => $borrowernumber,
 645                 old_amountoutstanding => $accdata->{'amountoutstanding'},
 646                 new_amountoutstanding => $newamtos,
 647                 amount_paid           => $accdata->{'amountoutstanding'} - $newamtos,
 648                 accountlines_id       => $accdata->{'accountlines_id'},
 649                 accountno             => $accdata->{'accountno'},
 650                 manager_id            => $manager_id,
 651             }));
 652             push( @ids, $accdata->{'accountlines_id'} );
 653         }
 654
 655     }
 656
 657     # create new line
 658     $sql = 'INSERT INTO accountlines ' .
 659     '(borrowernumber, accountno,date,amount,description,accounttype,amountoutstanding,manager_id,note) ' .
 660     q|VALUES (?,?,now(),?,'','Pay',?,?,?)|;
 661     $dbh->do($sql,{},$borrowernumber, $nextaccntno, 0 - $amount, 0 - $amountleft, $manager_id, $note );
 662     UpdateStats({
 663                 branch => $branch,
 664                 type => 'payment',
 665                 amount => $amount,
 666                 borrowernumber => $borrowernumber,
 667                 accountno => $nextaccntno}
 668     );
 669
 670     if ( C4::Context->preference("FinesLog") ) {
 671         logaction("FINES", 'CREATE',$borrowernumber,Dumper({
 672             action            => 'create_payment',
 673             borrowernumber    => $borrowernumber,
 674             accountno         => $nextaccntno,
 675             amount            => 0 - $amount,
 676             amountoutstanding => 0 - $amountleft,
 677             accounttype       => 'Pay',
 678             accountlines_paid => \@ids,
 679             manager_id        => $manager_id,
 680         }));
 681     }
 682
 683     return;
 684 }
 685
 686 # makepayment needs to be fixed to handle partials till then this separate subroutine
 687 # fills in
 688 sub makepartialpayment {
 689     my ( $accountlines_id, $borrowernumber, $accountno, $amount, $user, $branch, $payment_note ) = @_;
 690     my $manager_id = 0;
 691     $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
 692     if (!$amount || $amount < 0) {
 693         return;
 694     }
 695     $payment_note //= "";
 696     my $dbh = C4::Context->dbh;
 697
 698     my $nextaccntno = getnextacctno($borrowernumber);
 699     my $newamtos    = 0;
 700
 701     my $data = $dbh->selectrow_hashref(
 702         'SELECT * FROM accountlines WHERE  accountlines_id=?',undef,$accountlines_id);
 703     my $new_outstanding = $data->{amountoutstanding} - $amount;
 704
 705     my $update = 'UPDATE  accountlines SET amountoutstanding = ?  WHERE   accountlines_id = ? ';
 706     $dbh->do( $update, undef, $new_outstanding, $accountlines_id);
 707
 708     if ( C4::Context->preference("FinesLog") ) {
 709         logaction("FINES", 'MODIFY', $borrowernumber, Dumper({
 710             action                => 'fee_payment',
 711             borrowernumber        => $borrowernumber,
 712             old_amountoutstanding => $data->{'amountoutstanding'},
 713             new_amountoutstanding => $new_outstanding,
 714             amount_paid           => $data->{'amountoutstanding'} - $new_outstanding,
 715             accountlines_id       => $data->{'accountlines_id'},
 716             accountno             => $data->{'accountno'},
 717             manager_id            => $manager_id,
 718         }));
 719     }
 720
 721     # create new line
 722     my $insert = 'INSERT INTO accountlines (borrowernumber, accountno, date, amount, '
 723     .  'description, accounttype, amountoutstanding, itemnumber, manager_id, note) '
 724     . ' VALUES (?, ?, now(), ?, ?, ?, 0, ?, ?, ?)';
 725
 726     $dbh->do(  $insert, undef, $borrowernumber, $nextaccntno, $amount,
 727         '', 'Pay', $data->{'itemnumber'}, $manager_id, $payment_note);
 728
 729     UpdateStats({
 730         branch => $branch,
 731         type   => 'payment',
 732         amount => $amount,
 733         borrowernumber => $borrowernumber,
 734         accountno => $accountno
 735     });
 736
 737     if ( C4::Context->preference("FinesLog") ) {
 738         logaction("FINES", 'CREATE',$borrowernumber,Dumper({
 739             action            => 'create_payment',
 740             borrowernumber    => $user,
 741             accountno         => $nextaccntno,
 742             amount            => 0 - $amount,
 743             accounttype       => 'Pay',
 744             itemnumber        => $data->{'itemnumber'},
 745             accountlines_paid => [ $data->{'accountlines_id'} ],
 746             manager_id        => $manager_id,
 747         }));
 748     }
 749
 750     return;
 751 }
 752
 753 =head2 WriteOffFee
 754
 755   WriteOffFee( $borrowernumber, $accountline_id, $itemnum, $accounttype, $amount, $branch, $payment_note );
 756
 757 Write off a fine for a patron.
 758 C<$borrowernumber> is the patron's borrower number.
 759 C<$accountline_id> is the accountline_id of the fee to write off.
 760 C<$itemnum> is the itemnumber of of item whose fine is being written off.
 761 C<$accounttype> is the account type of the fine being written off.
 762 C<$amount> is a floating-point number, giving the amount that is being written off.
 763 C<$branch> is the branchcode of the library where the writeoff occurred.
 764 C<$payment_note> is the note to attach to this payment
 765
 766 =cut
 767
 768 sub WriteOffFee {
 769     my ( $borrowernumber, $accountlines_id, $itemnum, $accounttype, $amount, $branch, $payment_note ) = @_;
 770     $payment_note //= "";
 771     $branch ||= C4::Context->userenv->{branch};
 772     my $manager_id = 0;
 773     $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
 774
 775     # if no item is attached to fine, make sure to store it as a NULL
 776     $itemnum ||= undef;
 777
 778     my ( $sth, $query );
 779     my $dbh = C4::Context->dbh();
 780
 781     $query = "
 782         UPDATE accountlines SET amountoutstanding = 0
 783         WHERE accountlines_id = ? AND borrowernumber = ?
 784     ";
 785     $sth = $dbh->prepare( $query );
 786     $sth->execute( $accountlines_id, $borrowernumber );
 787
 788     if ( C4::Context->preference("FinesLog") ) {
 789         logaction("FINES", 'MODIFY', $borrowernumber, Dumper({
 790             action                => 'fee_writeoff',
 791             borrowernumber        => $borrowernumber,
 792             accountlines_id       => $accountlines_id,
 793             manager_id            => $manager_id,
 794         }));
 795     }
 796
 797     $query ="
 798         INSERT INTO accountlines
 799         ( borrowernumber, accountno, itemnumber, date, amount, description, accounttype, manager_id, note )
 800         VALUES ( ?, ?, ?, NOW(), ?, 'Writeoff', 'W', ?, ? )
 801     ";
 802     $sth = $dbh->prepare( $query );
 803     my $acct = getnextacctno($borrowernumber);
 804     $sth->execute( $borrowernumber, $acct, $itemnum, $amount, $manager_id, $payment_note );
 805
 806     if ( C4::Context->preference("FinesLog") ) {
 807         logaction("FINES", 'CREATE',$borrowernumber,Dumper({
 808             action            => 'create_writeoff',
 809             borrowernumber    => $borrowernumber,
 810             accountno         => $acct,
 811             amount            => 0 - $amount,
 812             accounttype       => 'W',
 813             itemnumber        => $itemnum,
 814             accountlines_paid => [ $accountlines_id ],
 815             manager_id        => $manager_id,
 816         }));
 817     }
 818
 819     UpdateStats({
 820                 branch => $branch,
 821                 type => 'writeoff',
 822                 amount => $amount,
 823                 borrowernumber => $borrowernumber}
 824     );
 825
 826 }
 827
 828 =head2 purge_zero_balance_fees
 829
 830   purge_zero_balance_fees( $days );
 831
 832 Delete accountlines entries where amountoutstanding is 0 or NULL which are more than a given number of days old.
 833
 834 B<$days> -- Zero balance fees older than B<$days> days old will be deleted.
 835
 836 B<Warning:> Because fines and payments are not linked in accountlines, it is
 837 possible for a fine to be deleted without the accompanying payment,
 838 or vise versa. This won't affect the account balance, but might be
 839 confusing to staff.
 840
 841 =cut
 842
 843 sub purge_zero_balance_fees {
 844     my $days  = shift;
 845     my $count = 0;
 846
 847     my $dbh = C4::Context->dbh;
 848     my $sth = $dbh->prepare(
 849         q{
 850             DELETE FROM accountlines
 851             WHERE date < date_sub(curdate(), INTERVAL ? DAY)
 852               AND ( amountoutstanding = 0 or amountoutstanding IS NULL );
 853         }
 854     );
 855     $sth->execute($days) or die $dbh->errstr;
 856 }
 857
 858 END { }    # module clean-up code here (global destructor)
 859
 860 1;
 861 __END__
 862
 863 =head1 SEE ALSO
 864
 865 DBI(3)
 866
 867 =cut
 868