3 # Copyright 2000-2002 Katipo Communications
5 # This file is part of Koha.
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
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.
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
28 use vars qw($VERSION @ISA @EXPORT);
31 # set the version for version checking
36 &recordpayment &makepayment &manualinvoice
37 &getnextacctno &reconcileaccount &getcharges &getcredits
39 ); # removed &fixaccounts
44 C4::Accounts - Functions for dealing with Koha accounts
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
60 &recordpayment($borrowernumber, $payment);
62 Record payment by a patron. C<$borrowernumber> is the patron's
63 borrower number. C<$payment> is a floating-point number, giving the
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.
76 #here we update both the accountoffsets and the account lines
77 my ( $borrowernumber, $data ) = @_;
78 my $dbh = C4::Context->dbh;
81 my $branch = C4::Context->userenv->{'branch'};
82 my $amountleft = $data;
85 my $nextaccntno = getnextacctno($borrowernumber);
87 # get lines with outstanding amounts to offset
88 my $sth = $dbh->prepare(
89 "SELECT * FROM accountlines
90 WHERE (borrowernumber = ?) AND (amountoutstanding<>0)
93 $sth->execute($borrowernumber);
96 while ( ( $accdata = $sth->fetchrow_hashref ) and ( $amountleft > 0 ) ) {
97 if ( $accdata->{'amountoutstanding'} < $amountleft ) {
99 $amountleft -= $accdata->{'amountoutstanding'};
102 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
105 my $thisacct = $accdata->{accountno};
106 my $usth = $dbh->prepare(
107 "UPDATE accountlines SET amountoutstanding= ?
108 WHERE (borrowernumber = ?) AND (accountno=?)"
110 $usth->execute( $newamtos, $borrowernumber, $thisacct );
112 $usth = $dbh->prepare(
113 "INSERT INTO accountoffsets
114 (borrowernumber, accountno, offsetaccount, offsetamount)
117 $usth->execute( $borrowernumber, $accdata->{'accountno'},
118 $nextaccntno, $newamtos );
123 my $usth = $dbh->prepare(
124 "INSERT INTO accountlines
125 (borrowernumber, accountno,date,amount,description,accounttype,amountoutstanding)
126 VALUES (?,?,now(),?,'Payment,thanks','Pay',?)"
128 $usth->execute( $borrowernumber, $nextaccntno, 0 - $data, 0 - $amountleft );
130 UpdateStats( $branch, 'payment', $data, '', '', '', $borrowernumber, $nextaccntno );
136 &makepayment($borrowernumber, $acctnumber, $amount, $branchcode);
138 Records the fact that a patron has paid off the entire amount he or
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
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.
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;
161 my $nextaccntno = getnextacctno($borrowernumber);
165 "SELECT * FROM accountlines WHERE borrowernumber=? AND accountno=?");
166 $sth->execute( $borrowernumber, $accountno );
167 my $data = $sth->fetchrow_hashref;
172 SET amountoutstanding = 0
173 WHERE borrowernumber = $borrowernumber
174 AND accountno = $accountno
180 INSERT INTO accountoffsets
181 (borrowernumber, accountno, offsetaccount,
183 VALUES ($borrowernumber, $accountno, $nextaccntno, $newamtos)
187 my $payment = 0 - $amount;
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)
196 # FIXME - The second argument to &UpdateStats is supposed to be the
198 # UpdateStats is now being passed $accountno too. MTJ
199 UpdateStats( $user, 'payment', $amount, '', '', '', $borrowernumber,
203 #check to see what accounttype
204 if ( $data->{'accounttype'} eq 'Rep' || $data->{'accounttype'} eq 'L' ) {
205 returnlost( $borrowernumber, $data->{'itemnumber'} );
211 $nextacct = &getnextacctno($borrowernumber);
213 Returns the next unused account number for the patron with the given
219 # FIXME - Okay, so what does the above actually _mean_?
220 sub getnextacctno ($) {
221 my ($borrowernumber) = shift or return undef;
222 my $sth = C4::Context->dbh->prepare(
223 "SELECT accountno+1 FROM accountlines
224 WHERE (borrowernumber = ?)
225 ORDER BY accountno DESC
228 $sth->execute($borrowernumber);
229 return ($sth->fetchrow || 1);
232 =head2 fixaccounts (removed)
234 &fixaccounts($borrowernumber, $accountnumber, $amount);
237 # FIXME - I don't understand what this function does.
239 my ( $borrowernumber, $accountno, $amount ) = @_;
240 my $dbh = C4::Context->dbh;
241 my $sth = $dbh->prepare(
242 "SELECT * FROM accountlines WHERE borrowernumber=?
245 $sth->execute( $borrowernumber, $accountno );
246 my $data = $sth->fetchrow_hashref;
248 # FIXME - Error-checking
249 my $diff = $amount - $data->{'amount'};
250 my $outstanding = $data->{'amountoutstanding'} + $diff;
255 SET amount = '$amount',
256 amountoutstanding = '$outstanding'
257 WHERE borrowernumber = $borrowernumber
258 AND accountno = $accountno
260 # FIXME: exceedingly bad form. Use prepare with placholders ("?") in query and execute args.
266 my ( $borrowernumber, $itemnum ) = @_;
267 C4::Circulation::MarkIssueReturned( $borrowernumber, $itemnum );
268 my $borrower = C4::Members::GetMember( $borrowernumber, 'borrowernumber' );
269 my @datearr = localtime(time);
270 my $date = ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
271 my $bor = "$borrower->{'firstname'} $borrower->{'surname'} $borrower->{'cardnumber'}";
272 ModItem({ paidfor => "Paid for by $bor $date" }, undef, $itemnum);
277 &manualinvoice($borrowernumber, $itemnumber, $description, $type,
280 C<$borrowernumber> is the patron's borrower number.
281 C<$description> is a description of the transaction.
282 C<$type> may be one of C<CS>, C<CB>, C<CW>, C<CF>, C<CL>, C<N>, C<L>,
284 C<$itemnumber> is the item involved, if pertinent; otherwise, it
285 should be the empty string.
290 # FIXME - Okay, so what does this function do, really?
292 my ( $borrowernumber, $itemnum, $desc, $type, $amount, $user ) = @_;
293 my $dbh = C4::Context->dbh;
297 my $accountno = getnextacctno($borrowernumber);
298 my $amountleft = $amount;
306 my $amount2 = $amount * -1; # FIXME - $amount2 = -$amount
308 fixcredit( $borrowernumber, $amount2, $itemnum, $type, $user );
310 if ( $type eq 'N' ) {
311 $desc .= " New Card";
313 if ( $type eq 'F' ) {
316 if ( $type eq 'A' ) {
317 $desc .= " Account Management fee";
319 if ( $type eq 'M' ) {
323 if ( $type eq 'L' && $desc eq '' ) {
325 $desc = " Lost Item";
327 if ( $type eq 'REF' ) {
328 $desc .= " Cash Refund";
329 $amountleft = refund( '', $borrowernumber, $amount );
331 if ( ( $type eq 'L' )
335 or ( $type eq 'M' ) )
340 if ( $itemnum ne '' ) {
341 $desc .= " " . $itemnum;
342 my $sth = $dbh->prepare(
343 "INSERT INTO accountlines
344 (borrowernumber, accountno, date, amount, description, accounttype, amountoutstanding, itemnumber,notify_id)
345 VALUES (?, ?, now(), ?,?, ?,?,?,?)");
346 $sth->execute($borrowernumber, $accountno, $amount, $desc, $type, $amountleft, $itemnum,$notifyid) || return $sth->errstr;
348 my $sth=$dbh->prepare("INSERT INTO accountlines
349 (borrowernumber, accountno, date, amount, description, accounttype, amountoutstanding,notify_id)
350 VALUES (?, ?, now(), ?, ?, ?, ?,?)"
352 $sth->execute( $borrowernumber, $accountno, $amount, $desc, $type,
353 $amountleft, $notifyid );
360 $amountleft = &fixcredit($borrowernumber, $data, $barcode, $type, $user);
362 This function is only used internally, not exported.
363 FIXME - Figure out what this function does, and write it down.
369 #here we update both the accountoffsets and the account lines
370 my ( $borrowernumber, $data, $barcode, $type, $user ) = @_;
371 my $dbh = C4::Context->dbh;
374 my $amountleft = $data;
375 if ( $barcode ne '' ) {
376 my $item = GetBiblioFromItemNumber( '', $barcode );
377 my $nextaccntno = getnextacctno($borrowernumber);
378 my $query = "SELECT * FROM accountlines WHERE (borrowernumber=?
379 AND itemnumber=? AND amountoutstanding > 0)";
380 if ( $type eq 'CL' ) {
381 $query .= " AND (accounttype = 'L' OR accounttype = 'Rep')";
383 elsif ( $type eq 'CF' ) {
384 $query .= " AND (accounttype = 'F' OR accounttype = 'FU' OR
385 accounttype='Res' OR accounttype='Rent')";
387 elsif ( $type eq 'CB' ) {
388 $query .= " and accounttype='A'";
392 my $sth = $dbh->prepare($query);
393 $sth->execute( $borrowernumber, $item->{'itemnumber'} );
394 $accdata = $sth->fetchrow_hashref;
396 if ( $accdata->{'amountoutstanding'} < $amountleft ) {
398 $amountleft -= $accdata->{'amountoutstanding'};
401 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
404 my $thisacct = $accdata->{accountno};
405 my $usth = $dbh->prepare(
406 "UPDATE accountlines SET amountoutstanding= ?
407 WHERE (borrowernumber = ?) AND (accountno=?)"
409 $usth->execute( $newamtos, $borrowernumber, $thisacct );
411 $usth = $dbh->prepare(
412 "INSERT INTO accountoffsets
413 (borrowernumber, accountno, offsetaccount, offsetamount)
416 $usth->execute( $borrowernumber, $accdata->{'accountno'},
417 $nextaccntno, $newamtos );
422 my $nextaccntno = getnextacctno($borrowernumber);
424 # get lines with outstanding amounts to offset
425 my $sth = $dbh->prepare(
426 "SELECT * FROM accountlines
427 WHERE (borrowernumber = ?) AND (amountoutstanding >0)
430 $sth->execute($borrowernumber);
433 # offset transactions
434 while ( ( $accdata = $sth->fetchrow_hashref ) and ( $amountleft > 0 ) ) {
435 if ( $accdata->{'amountoutstanding'} < $amountleft ) {
437 $amountleft -= $accdata->{'amountoutstanding'};
440 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
443 my $thisacct = $accdata->{accountno};
444 my $usth = $dbh->prepare(
445 "UPDATE accountlines SET amountoutstanding= ?
446 WHERE (borrowernumber = ?) AND (accountno=?)"
448 $usth->execute( $newamtos, $borrowernumber, $thisacct );
450 $usth = $dbh->prepare(
451 "INSERT INTO accountoffsets
452 (borrowernumber, accountno, offsetaccount, offsetamount)
455 $usth->execute( $borrowernumber, $accdata->{'accountno'},
456 $nextaccntno, $newamtos );
460 $type = "Credit " . $type;
461 UpdateStats( $user, $type, $data, $user, '', '', $borrowernumber );
463 return ($amountleft);
469 # FIXME - Figure out what this function does, and write it down.
475 #here we update both the accountoffsets and the account lines
476 my ( $borrowernumber, $data ) = @_;
477 my $dbh = C4::Context->dbh;
480 my $amountleft = $data * -1;
483 my $nextaccntno = getnextacctno($borrowernumber);
485 # get lines with outstanding amounts to offset
486 my $sth = $dbh->prepare(
487 "SELECT * FROM accountlines
488 WHERE (borrowernumber = ?) AND (amountoutstanding<0)
491 $sth->execute($borrowernumber);
494 # offset transactions
495 while ( ( $accdata = $sth->fetchrow_hashref ) and ( $amountleft < 0 ) ) {
496 if ( $accdata->{'amountoutstanding'} > $amountleft ) {
498 $amountleft -= $accdata->{'amountoutstanding'};
501 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
506 my $thisacct = $accdata->{accountno};
507 my $usth = $dbh->prepare(
508 "UPDATE accountlines SET amountoutstanding= ?
509 WHERE (borrowernumber = ?) AND (accountno=?)"
511 $usth->execute( $newamtos, $borrowernumber, $thisacct );
513 $usth = $dbh->prepare(
514 "INSERT INTO accountoffsets
515 (borrowernumber, accountno, offsetaccount, offsetamount)
518 $usth->execute( $borrowernumber, $accdata->{'accountno'},
519 $nextaccntno, $newamtos );
523 return ($amountleft);
527 my ( $borrowerno, $timestamp, $accountno ) = @_;
528 my $dbh = C4::Context->dbh;
529 my $timestamp2 = $timestamp - 1;
531 my $sth = $dbh->prepare(
532 "SELECT * FROM accountlines WHERE borrowernumber=? AND accountno = ?"
534 $sth->execute( $borrowerno, $accountno );
537 while ( my $data = $sth->fetchrow_hashref ) {
545 my ( $date, $date2 ) = @_;
546 my $dbh = C4::Context->dbh;
547 my $sth = $dbh->prepare(
548 "SELECT * FROM accountlines,borrowers
549 WHERE amount < 0 AND accounttype <> 'Pay' AND accountlines.borrowernumber = borrowers.borrowernumber
550 AND timestamp >=TIMESTAMP(?) AND timestamp < TIMESTAMP(?)"
553 $sth->execute( $date, $date2 );
555 while ( my $data = $sth->fetchrow_hashref ) {
556 $data->{'date'} = $data->{'timestamp'};
564 my ( $date, $date2 ) = @_;
565 my $dbh = C4::Context->dbh;
567 my $sth = $dbh->prepare(
568 "SELECT *,timestamp AS datetime
569 FROM accountlines,borrowers
570 WHERE (accounttype = 'REF'
571 AND accountlines.borrowernumber = borrowers.borrowernumber
572 AND date >=? AND date <?)"
575 $sth->execute( $date, $date2 );
578 while ( my $data = $sth->fetchrow_hashref ) {
584 END { } # module clean-up code here (global destructor)