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 under the
   8 # terms of the GNU General Public License as published by the Free Software
   9 # Foundation; either version 2 of the License, or (at your option) any later
  10 # version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  14 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License along with
  17 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
  18 # Suite 330, Boston, MA  02111-1307 USA
  19
  20
  21 use strict;
  22 use C4::Context;
  23 use C4::Stats;
  24 use C4::Members;
  25 use C4::Items;
  26
  27 #use C4::Circulation;
  28 use vars qw($VERSION @ISA @EXPORT);
  29
  30 BEGIN {
  31         # set the version for version checking
  32         $VERSION = 3.02;
  33         require Exporter;
  34         @ISA    = qw(Exporter);
  35         @EXPORT = qw(
  36                 &recordpayment &fixaccounts &makepayment &manualinvoice
  37                 &getnextacctno &reconcileaccount &getcharges &getcredits
  38                 &getrefunds
  39         );
  40 }
  41
  42 =head1 NAME
  43
  44 C4::Accounts - Functions for dealing with Koha accounts
  45
  46 =head1 SYNOPSIS
  47
  48 use C4::Accounts;
  49
  50 =head1 DESCRIPTION
  51
  52 The functions in this module deal with the monetary aspect of Koha,
  53 including looking up and modifying the amount of money owed by a
  54 patron.
  55
  56 =head1 FUNCTIONS
  57
  58 =head2 recordpayment
  59
  60   &recordpayment($borrowernumber, $payment);
  61
  62 Record payment by a patron. C<$borrowernumber> is the patron's
  63 borrower number. C<$payment> is a floating-point number, giving the
  64 amount that was paid.
  65
  66 Amounts owed are paid off oldest first. That is, if the patron has a
  67 $1 fine from Feb. 1, another $1 fine from Mar. 1, and makes a payment
  68 of $1.50, then the oldest fine will be paid off in full, and $0.50
  69 will be credited to the next one.
  70
  71 =cut
  72
  73 #'
  74 sub recordpayment {
  75
  76     #here we update both the accountoffsets and the account lines
  77     my ( $borrowernumber, $data ) = @_;
  78     my $dbh        = C4::Context->dbh;
  79     my $newamtos   = 0;
  80     my $accdata    = "";
  81     my $branch     = C4::Context->userenv->{'branch'};
  82     my $amountleft = $data;
  83
  84     # begin transaction
  85     my $nextaccntno = getnextacctno($borrowernumber);
  86
  87     # get lines with outstanding amounts to offset
  88     my $sth = $dbh->prepare(
  89         "SELECT * FROM accountlines
  90   WHERE (borrowernumber = ?) AND (amountoutstanding<>0)
  91   ORDER BY date"
  92     );
  93     $sth->execute($borrowernumber);
  94
  95     # offset transactions
  96     while ( ( $accdata = $sth->fetchrow_hashref ) and ( $amountleft > 0 ) ) {
  97         if ( $accdata->{'amountoutstanding'} < $amountleft ) {
  98             $newamtos = 0;
  99             $amountleft -= $accdata->{'amountoutstanding'};
 100         }
 101         else {
 102             $newamtos   = $accdata->{'amountoutstanding'} - $amountleft;
 103             $amountleft = 0;
 104         }
 105         my $thisacct = $accdata->{accountno};
 106         my $usth     = $dbh->prepare(
 107             "UPDATE accountlines SET amountoutstanding= ?
 108      WHERE (borrowernumber = ?) AND (accountno=?)"
 109         );
 110         $usth->execute( $newamtos, $borrowernumber, $thisacct );
 111         $usth->finish;
 112         $usth = $dbh->prepare(
 113             "INSERT INTO accountoffsets
 114      (borrowernumber, accountno, offsetaccount,  offsetamount)
 115      VALUES (?,?,?,?)"
 116         );
 117         $usth->execute( $borrowernumber, $accdata->{'accountno'},
 118             $nextaccntno, $newamtos );
 119         $usth->finish;
 120     }
 121
 122     # create new line
 123     my $usth = $dbh->prepare(
 124         "INSERT INTO accountlines
 125   (borrowernumber, accountno,date,amount,description,accounttype,amountoutstanding)
 126   VALUES (?,?,now(),?,'Payment,thanks','Pay',?)"
 127     );
 128     $usth->execute( $borrowernumber, $nextaccntno, 0 - $data, 0 - $amountleft );
 129     $usth->finish;
 130     UpdateStats( $branch, 'payment', $data, '', '', '', $borrowernumber, $nextaccntno );
 131     $sth->finish;
 132 }
 133
 134 =head2 makepayment
 135
 136   &makepayment($borrowernumber, $acctnumber, $amount, $branchcode);
 137
 138 Records the fact that a patron has paid off the entire amount he or
 139 she owes.
 140
 141 C<$borrowernumber> is the patron's borrower number. C<$acctnumber> is
 142 the account that was credited. C<$amount> is the amount paid (this is
 143 only used to record the payment. It is assumed to be equal to the
 144 amount owed). C<$branchcode> is the code of the branch where payment
 145 was made.
 146
 147 =cut
 148
 149 #'
 150 # FIXME - I'm not at all sure about the above, because I don't
 151 # understand what the acct* tables in the Koha database are for.
 152 sub makepayment {
 153
 154     #here we update both the accountoffsets and the account lines
 155     #updated to check, if they are paying off a lost item, we return the item
 156     # from their card, and put a note on the item record
 157     my ( $borrowernumber, $accountno, $amount, $user, $branch ) = @_;
 158     my $dbh = C4::Context->dbh;
 159
 160     # begin transaction
 161     my $nextaccntno = getnextacctno($borrowernumber);
 162     my $newamtos    = 0;
 163     my $sth =
 164       $dbh->prepare(
 165         "SELECT * FROM accountlines WHERE  borrowernumber=? AND accountno=?");
 166     $sth->execute( $borrowernumber, $accountno );
 167     my $data = $sth->fetchrow_hashref;
 168     $sth->finish;
 169
 170     $dbh->do(
 171         "UPDATE  accountlines
 172         SET     amountoutstanding = 0
 173         WHERE   borrowernumber = $borrowernumber
 174           AND   accountno = $accountno
 175         "
 176     );
 177
 178     #  print $updquery;
 179     $dbh->do( "
 180         INSERT INTO     accountoffsets
 181                         (borrowernumber, accountno, offsetaccount,
 182                          offsetamount)
 183         VALUES          ($borrowernumber, $accountno, $nextaccntno, $newamtos)
 184         " );
 185
 186     # create new line
 187     my $payment = 0 - $amount;
 188     $dbh->do( "
 189         INSERT INTO     accountlines
 190                         (borrowernumber, accountno, date, amount,
 191                          description, accounttype, amountoutstanding)
 192         VALUES          ($borrowernumber, $nextaccntno, now(), $payment,
 193                         'Payment,thanks - $user', 'Pay', 0)
 194         " );
 195
 196     # FIXME - The second argument to &UpdateStats is supposed to be the
 197     # branch code.
 198     # UpdateStats is now being passed $accountno too. MTJ
 199     UpdateStats( $user, 'payment', $amount, '', '', '', $borrowernumber,
 200         $accountno );
 201     $sth->finish;
 202
 203     #check to see what accounttype
 204     if ( $data->{'accounttype'} eq 'Rep' || $data->{'accounttype'} eq 'L' ) {
 205         returnlost( $borrowernumber, $data->{'itemnumber'} );
 206     }
 207 }
 208
 209 =head2 getnextacctno
 210
 211   $nextacct = &getnextacctno($borrowernumber);
 212
 213 Returns the next unused account number for the patron with the given
 214 borrower number.
 215
 216 =cut
 217
 218 #'
 219 # FIXME - Okay, so what does the above actually _mean_?
 220 sub getnextacctno {
 221     my ($borrowernumber) = @_;
 222     my $nextaccntno      = 1;
 223     my $dbh              = C4::Context->dbh;
 224     my $sth              = $dbh->prepare(
 225         "SELECT * FROM accountlines
 226                                 WHERE (borrowernumber = ?)
 227                                 ORDER BY accountno DESC"
 228     );
 229     $sth->execute($borrowernumber);
 230     if ( my $accdata = $sth->fetchrow_hashref ) {
 231         $nextaccntno = $accdata->{'accountno'} + 1;
 232     }
 233     $sth->finish;
 234     return ($nextaccntno);
 235 }
 236
 237 =head2 fixaccounts
 238
 239   &fixaccounts($borrowernumber, $accountnumber, $amount);
 240
 241 =cut
 242
 243 #'
 244 # FIXME - I don't understand what this function does.
 245 sub fixaccounts {
 246     my ( $borrowernumber, $accountno, $amount ) = @_;
 247     my $dbh = C4::Context->dbh;
 248     my $sth = $dbh->prepare(
 249         "SELECT * FROM accountlines WHERE borrowernumber=?
 250      AND accountno=?"
 251     );
 252     $sth->execute( $borrowernumber, $accountno );
 253     my $data = $sth->fetchrow_hashref;
 254
 255     # FIXME - Error-checking
 256     my $diff        = $amount - $data->{'amount'};
 257     my $outstanding = $data->{'amountoutstanding'} + $diff;
 258     $sth->finish;
 259
 260     $dbh->do(<<EOT);
 261         UPDATE  accountlines
 262         SET     amount = '$amount',
 263                 amountoutstanding = '$outstanding'
 264         WHERE   borrowernumber = $borrowernumber
 265           AND   accountno = $accountno
 266 EOT
 267 }
 268
 269 # FIXME - Never used, but not exported, either.
 270 sub returnlost {
 271     my ( $borrowernumber, $itemnum ) = @_;
 272     my $dbh      = C4::Context->dbh;
 273     my $borrower = C4::Members::GetMember( $borrowernumber, 'borrowernumber' );
 274     my $sth      = $dbh->prepare(
 275         "UPDATE issues SET returndate=now() WHERE
 276   borrowernumber=? AND itemnumber=? AND returndate IS NULL"
 277     );
 278     $sth->execute( $borrowernumber, $itemnum );
 279     $sth->finish;
 280     my @datearr = localtime(time);
 281     my $date =
 282       ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
 283     my $bor =
 284 "$borrower->{'firstname'} $borrower->{'surname'} $borrower->{'cardnumber'}";
 285     ModItem({ paidfor =>  "Paid for by $bor $date" }, undef, $itemnum);
 286 }
 287
 288 =head2 manualinvoice
 289
 290   &manualinvoice($borrowernumber, $itemnumber, $description, $type,
 291                  $amount, $user);
 292
 293 C<$borrowernumber> is the patron's borrower number.
 294 C<$description> is a description of the transaction.
 295 C<$type> may be one of C<CS>, C<CB>, C<CW>, C<CF>, C<CL>, C<N>, C<L>,
 296 or C<REF>.
 297 C<$itemnumber> is the item involved, if pertinent; otherwise, it
 298 should be the empty string.
 299
 300 =cut
 301
 302 #'
 303 # FIXME - Okay, so what does this function do, really?
 304 sub manualinvoice {
 305     my ( $borrowernumber, $itemnum, $desc, $type, $amount, $user ) = @_;
 306     my $dbh      = C4::Context->dbh;
 307     my $notifyid = 0;
 308     my $insert;
 309     $itemnum =~ s/ //g;
 310     my $accountno  = getnextacctno($borrowernumber);
 311     my $amountleft = $amount;
 312
 313     if (   $type eq 'CS'
 314         || $type eq 'CB'
 315         || $type eq 'CW'
 316         || $type eq 'CF'
 317         || $type eq 'CL' )
 318     {
 319         my $amount2 = $amount * -1;    # FIXME - $amount2 = -$amount
 320         $amountleft =
 321           fixcredit( $borrowernumber, $amount2, $itemnum, $type, $user );
 322     }
 323     if ( $type eq 'N' ) {
 324         $desc .= "New Card";
 325     }
 326     if ( $type eq 'F' ) {
 327         $desc .= "Fine";
 328     }
 329     if ( $type eq 'A' ) {
 330         $desc .= "Account Management fee";
 331     }
 332     if ( $type eq 'M' ) {
 333         $desc .= "Sundry";
 334     }
 335
 336     if ( $type eq 'L' && $desc eq '' ) {
 337
 338         $desc = "Lost Item";
 339     }
 340     if ( $type eq 'REF' ) {
 341         $desc .= "Cash Refund";
 342         $amountleft = refund( '', $borrowernumber, $amount );
 343     }
 344     if (   ( $type eq 'L' )
 345         or ( $type eq 'F' )
 346         or ( $type eq 'A' )
 347         or ( $type eq 'N' )
 348         or ( $type eq 'M' ) )
 349     {
 350         $notifyid = 1;
 351     }
 352
 353     if ( $itemnum ne '' ) {
 354         $desc .= " " . $itemnum;
 355         my $sth = $dbh->prepare(
 356             "INSERT INTO  accountlines
 357                         (borrowernumber, accountno, date, amount, description, accounttype, amountoutstanding, itemnumber,notify_id)
 358         VALUES (?, ?, now(), ?,?, ?,?,?,?)");
 359      $sth->execute($borrowernumber, $accountno, $amount, $desc, $type, $amountleft, $itemnum,$notifyid) || return $sth->errstr;
 360   } else {
 361     my $sth=$dbh->prepare("INSERT INTO  accountlines
 362             (borrowernumber, accountno, date, amount, description, accounttype, amountoutstanding,notify_id)
 363             VALUES (?, ?, now(), ?, ?, ?, ?,?)"
 364         );
 365         $sth->execute( $borrowernumber, $accountno, $amount, $desc, $type,
 366             $amountleft, $notifyid );
 367     }
 368     return 0;
 369 }
 370
 371 =head2 fixcredit
 372
 373  $amountleft = &fixcredit($borrowernumber, $data, $barcode, $type, $user);
 374
 375  This function is only used internally, not exported.
 376  FIXME - Figure out what this function does, and write it down.
 377
 378 =cut
 379
 380 sub fixcredit {
 381
 382     #here we update both the accountoffsets and the account lines
 383     my ( $borrowernumber, $data, $barcode, $type, $user ) = @_;
 384     my $dbh        = C4::Context->dbh;
 385     my $newamtos   = 0;
 386     my $accdata    = "";
 387     my $amountleft = $data;
 388     if ( $barcode ne '' ) {
 389         my $item        = GetBiblioFromItemNumber( '', $barcode );
 390         my $nextaccntno = getnextacctno($borrowernumber);
 391         my $query       = "SELECT * FROM accountlines WHERE (borrowernumber=?
 392     AND itemnumber=? AND amountoutstanding > 0)";
 393         if ( $type eq 'CL' ) {
 394             $query .= " AND (accounttype = 'L' OR accounttype = 'Rep')";
 395         }
 396         elsif ( $type eq 'CF' ) {
 397             $query .= " AND (accounttype = 'F' OR accounttype = 'FU' OR
 398       accounttype='Res' OR accounttype='Rent')";
 399         }
 400         elsif ( $type eq 'CB' ) {
 401             $query .= " and accounttype='A'";
 402         }
 403
 404         #    print $query;
 405         my $sth = $dbh->prepare($query);
 406         $sth->execute( $borrowernumber, $item->{'itemnumber'} );
 407         $accdata = $sth->fetchrow_hashref;
 408         $sth->finish;
 409         if ( $accdata->{'amountoutstanding'} < $amountleft ) {
 410             $newamtos = 0;
 411             $amountleft -= $accdata->{'amountoutstanding'};
 412         }
 413         else {
 414             $newamtos   = $accdata->{'amountoutstanding'} - $amountleft;
 415             $amountleft = 0;
 416         }
 417         my $thisacct = $accdata->{accountno};
 418         my $usth     = $dbh->prepare(
 419             "UPDATE accountlines SET amountoutstanding= ?
 420      WHERE (borrowernumber = ?) AND (accountno=?)"
 421         );
 422         $usth->execute( $newamtos, $borrowernumber, $thisacct );
 423         $usth->finish;
 424         $usth = $dbh->prepare(
 425             "INSERT INTO accountoffsets
 426      (borrowernumber, accountno, offsetaccount,  offsetamount)
 427      VALUES (?,?,?,?)"
 428         );
 429         $usth->execute( $borrowernumber, $accdata->{'accountno'},
 430             $nextaccntno, $newamtos );
 431         $usth->finish;
 432     }
 433
 434     # begin transaction
 435     my $nextaccntno = getnextacctno($borrowernumber);
 436
 437     # get lines with outstanding amounts to offset
 438     my $sth = $dbh->prepare(
 439         "SELECT * FROM accountlines
 440   WHERE (borrowernumber = ?) AND (amountoutstanding >0)
 441   ORDER BY date"
 442     );
 443     $sth->execute($borrowernumber);
 444
 445     #  print $query;
 446     # offset transactions
 447     while ( ( $accdata = $sth->fetchrow_hashref ) and ( $amountleft > 0 ) ) {
 448         if ( $accdata->{'amountoutstanding'} < $amountleft ) {
 449             $newamtos = 0;
 450             $amountleft -= $accdata->{'amountoutstanding'};
 451         }
 452         else {
 453             $newamtos   = $accdata->{'amountoutstanding'} - $amountleft;
 454             $amountleft = 0;
 455         }
 456         my $thisacct = $accdata->{accountno};
 457         my $usth     = $dbh->prepare(
 458             "UPDATE accountlines SET amountoutstanding= ?
 459      WHERE (borrowernumber = ?) AND (accountno=?)"
 460         );
 461         $usth->execute( $newamtos, $borrowernumber, $thisacct );
 462         $usth->finish;
 463         $usth = $dbh->prepare(
 464             "INSERT INTO accountoffsets
 465      (borrowernumber, accountno, offsetaccount,  offsetamount)
 466      VALUE (?,?,?,?)"
 467         );
 468         $usth->execute( $borrowernumber, $accdata->{'accountno'},
 469             $nextaccntno, $newamtos );
 470         $usth->finish;
 471     }
 472     $sth->finish;
 473     $type = "Credit " . $type;
 474     UpdateStats( $user, $type, $data, $user, '', '', $borrowernumber );
 475     $amountleft *= -1;
 476     return ($amountleft);
 477
 478 }
 479
 480 =head2 refund
 481
 482 # FIXME - Figure out what this function does, and write it down.
 483
 484 =cut
 485
 486 sub refund {
 487
 488     #here we update both the accountoffsets and the account lines
 489     my ( $borrowernumber, $data ) = @_;
 490     my $dbh        = C4::Context->dbh;
 491     my $newamtos   = 0;
 492     my $accdata    = "";
 493     my $amountleft = $data * -1;
 494
 495     # begin transaction
 496     my $nextaccntno = getnextacctno($borrowernumber);
 497
 498     # get lines with outstanding amounts to offset
 499     my $sth = $dbh->prepare(
 500         "SELECT * FROM accountlines
 501   WHERE (borrowernumber = ?) AND (amountoutstanding<0)
 502   ORDER BY date"
 503     );
 504     $sth->execute($borrowernumber);
 505
 506     #  print $amountleft;
 507     # offset transactions
 508     while ( ( $accdata = $sth->fetchrow_hashref ) and ( $amountleft < 0 ) ) {
 509         if ( $accdata->{'amountoutstanding'} > $amountleft ) {
 510             $newamtos = 0;
 511             $amountleft -= $accdata->{'amountoutstanding'};
 512         }
 513         else {
 514             $newamtos   = $accdata->{'amountoutstanding'} - $amountleft;
 515             $amountleft = 0;
 516         }
 517
 518         #     print $amountleft;
 519         my $thisacct = $accdata->{accountno};
 520         my $usth     = $dbh->prepare(
 521             "UPDATE accountlines SET amountoutstanding= ?
 522      WHERE (borrowernumber = ?) AND (accountno=?)"
 523         );
 524         $usth->execute( $newamtos, $borrowernumber, $thisacct );
 525         $usth->finish;
 526         $usth = $dbh->prepare(
 527             "INSERT INTO accountoffsets
 528      (borrowernumber, accountno, offsetaccount,  offsetamount)
 529      VALUES (?,?,?,?)"
 530         );
 531         $usth->execute( $borrowernumber, $accdata->{'accountno'},
 532             $nextaccntno, $newamtos );
 533         $usth->finish;
 534     }
 535     $sth->finish;
 536     return ($amountleft);
 537 }
 538
 539 sub getcharges {
 540         my ( $borrowerno, $timestamp, $accountno ) = @_;
 541         my $dbh        = C4::Context->dbh;
 542         my $timestamp2 = $timestamp - 1;
 543         my $query      = "";
 544         my $sth = $dbh->prepare(
 545                         "SELECT * FROM accountlines WHERE borrowernumber=? AND accountno = ?"
 546           );
 547         $sth->execute( $borrowerno, $accountno );
 548
 549     my @results;
 550     while ( my $data = $sth->fetchrow_hashref ) {
 551                 push @results,$data;
 552         }
 553     return (@results);
 554 }
 555
 556
 557 sub getcredits {
 558         my ( $date, $date2 ) = @_;
 559         my $dbh = C4::Context->dbh;
 560         my $sth = $dbh->prepare(
 561                                 "SELECT * FROM accountlines,borrowers
 562       WHERE amount < 0 AND accounttype <> 'Pay' AND accountlines.borrowernumber = borrowers.borrowernumber
 563           AND timestamp >=TIMESTAMP(?) AND timestamp < TIMESTAMP(?)"
 564       );
 565
 566     $sth->execute( $date, $date2 );
 567     my @results;
 568     while ( my $data = $sth->fetchrow_hashref ) {
 569                 $data->{'date'} = $data->{'timestamp'};
 570                 push @results,$data;
 571         }
 572     return (@results);
 573 }
 574
 575
 576 sub getrefunds {
 577         my ( $date, $date2 ) = @_;
 578         my $dbh = C4::Context->dbh;
 579
 580         my $sth = $dbh->prepare(
 581                                 "SELECT *,timestamp AS datetime
 582                   FROM accountlines,borrowers
 583                   WHERE (accounttype = 'REF'
 584                                           AND accountlines.borrowernumber = borrowers.borrowernumber
 585                                                           AND date  >=?  AND date  <?)"
 586     );
 587
 588     $sth->execute( $date, $date2 );
 589
 590     my @results;
 591     while ( my $data = $sth->fetchrow_hashref ) {
 592                 push @results,$data;
 593
 594         }
 595     return (@results);
 596 }
 597 END { }    # module clean-up code here (global destructor)
 598
 599 1;
 600 __END__
 601
 602 =head1 SEE ALSO
 603
 604 DBI(3)
 605
 606 =cut
 607