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 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: In Koha 3.0 , the only account adjustment 'types' passed to this function
293 # 'FOR' = FORGIVEN (Formerly 'F', but 'F' is taken to mean 'FINE' elsewhere)
296 # 'A' = Account Management fee
302 my ( $borrowernumber, $itemnum, $desc, $type, $amount, $user ) = @_;
303 my $dbh = C4::Context->dbh;
307 my $accountno = getnextacctno($borrowernumber);
308 my $amountleft = $amount;
316 # my $amount2 = $amount * -1; # FIXME - $amount2 = -$amount
318 # fixcredit( $borrowernumber, $amount2, $itemnum, $type, $user );
320 if ( $type eq 'N' ) {
321 $desc .= " New Card";
323 if ( $type eq 'F' ) {
326 if ( $type eq 'A' ) {
327 $desc .= " Account Management fee";
329 if ( $type eq 'M' ) {
333 if ( $type eq 'L' && $desc eq '' ) {
335 $desc = " Lost Item";
337 # if ( $type eq 'REF' ) {
338 # $desc .= " Cash Refund";
339 # $amountleft = refund( '', $borrowernumber, $amount );
341 if ( ( $type eq 'L' )
345 or ( $type eq 'M' ) )
350 if ( $itemnum ne '' ) {
351 $desc .= " " . $itemnum;
352 my $sth = $dbh->prepare(
353 "INSERT INTO accountlines
354 (borrowernumber, accountno, date, amount, description, accounttype, amountoutstanding, itemnumber,notify_id)
355 VALUES (?, ?, now(), ?,?, ?,?,?,?)");
356 $sth->execute($borrowernumber, $accountno, $amount, $desc, $type, $amountleft, $itemnum,$notifyid) || return $sth->errstr;
358 my $sth=$dbh->prepare("INSERT INTO accountlines
359 (borrowernumber, accountno, date, amount, description, accounttype, amountoutstanding,notify_id)
360 VALUES (?, ?, now(), ?, ?, ?, ?,?)"
362 $sth->execute( $borrowernumber, $accountno, $amount, $desc, $type,
363 $amountleft, $notifyid );
368 =head2 fixcredit #### DEPRECATED
370 $amountleft = &fixcredit($borrowernumber, $data, $barcode, $type, $user);
372 This function is only used internally, not exported.
376 # This function is deprecated in 3.0
380 #here we update both the accountoffsets and the account lines
381 my ( $borrowernumber, $data, $barcode, $type, $user ) = @_;
382 my $dbh = C4::Context->dbh;
385 my $amountleft = $data;
386 if ( $barcode ne '' ) {
387 my $item = GetBiblioFromItemNumber( '', $barcode );
388 my $nextaccntno = getnextacctno($borrowernumber);
389 my $query = "SELECT * FROM accountlines WHERE (borrowernumber=?
390 AND itemnumber=? AND amountoutstanding > 0)";
391 if ( $type eq 'CL' ) {
392 $query .= " AND (accounttype = 'L' OR accounttype = 'Rep')";
394 elsif ( $type eq 'CF' ) {
395 $query .= " AND (accounttype = 'F' OR accounttype = 'FU' OR
396 accounttype='Res' OR accounttype='Rent')";
398 elsif ( $type eq 'CB' ) {
399 $query .= " and accounttype='A'";
403 my $sth = $dbh->prepare($query);
404 $sth->execute( $borrowernumber, $item->{'itemnumber'} );
405 $accdata = $sth->fetchrow_hashref;
407 if ( $accdata->{'amountoutstanding'} < $amountleft ) {
409 $amountleft -= $accdata->{'amountoutstanding'};
412 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
415 my $thisacct = $accdata->{accountno};
416 my $usth = $dbh->prepare(
417 "UPDATE accountlines SET amountoutstanding= ?
418 WHERE (borrowernumber = ?) AND (accountno=?)"
420 $usth->execute( $newamtos, $borrowernumber, $thisacct );
422 $usth = $dbh->prepare(
423 "INSERT INTO accountoffsets
424 (borrowernumber, accountno, offsetaccount, offsetamount)
427 $usth->execute( $borrowernumber, $accdata->{'accountno'},
428 $nextaccntno, $newamtos );
433 my $nextaccntno = getnextacctno($borrowernumber);
435 # get lines with outstanding amounts to offset
436 my $sth = $dbh->prepare(
437 "SELECT * FROM accountlines
438 WHERE (borrowernumber = ?) AND (amountoutstanding >0)
441 $sth->execute($borrowernumber);
444 # offset transactions
445 while ( ( $accdata = $sth->fetchrow_hashref ) and ( $amountleft > 0 ) ) {
446 if ( $accdata->{'amountoutstanding'} < $amountleft ) {
448 $amountleft -= $accdata->{'amountoutstanding'};
451 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
454 my $thisacct = $accdata->{accountno};
455 my $usth = $dbh->prepare(
456 "UPDATE accountlines SET amountoutstanding= ?
457 WHERE (borrowernumber = ?) AND (accountno=?)"
459 $usth->execute( $newamtos, $borrowernumber, $thisacct );
461 $usth = $dbh->prepare(
462 "INSERT INTO accountoffsets
463 (borrowernumber, accountno, offsetaccount, offsetamount)
466 $usth->execute( $borrowernumber, $accdata->{'accountno'},
467 $nextaccntno, $newamtos );
471 $type = "Credit " . $type;
472 UpdateStats( $user, $type, $data, $user, '', '', $borrowernumber );
474 return ($amountleft);
480 #FIXME : DEPRECATED SUB
481 This subroutine tracks payments and/or credits against fines/charges
482 using the accountoffsets table, which is not used consistently in
483 Koha's fines management, and so is not used in 3.0
489 #here we update both the accountoffsets and the account lines
490 my ( $borrowernumber, $data ) = @_;
491 my $dbh = C4::Context->dbh;
494 my $amountleft = $data * -1;
497 my $nextaccntno = getnextacctno($borrowernumber);
499 # get lines with outstanding amounts to offset
500 my $sth = $dbh->prepare(
501 "SELECT * FROM accountlines
502 WHERE (borrowernumber = ?) AND (amountoutstanding<0)
505 $sth->execute($borrowernumber);
508 # offset transactions
509 while ( ( $accdata = $sth->fetchrow_hashref ) and ( $amountleft < 0 ) ) {
510 if ( $accdata->{'amountoutstanding'} > $amountleft ) {
512 $amountleft -= $accdata->{'amountoutstanding'};
515 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
520 my $thisacct = $accdata->{accountno};
521 my $usth = $dbh->prepare(
522 "UPDATE accountlines SET amountoutstanding= ?
523 WHERE (borrowernumber = ?) AND (accountno=?)"
525 $usth->execute( $newamtos, $borrowernumber, $thisacct );
527 $usth = $dbh->prepare(
528 "INSERT INTO accountoffsets
529 (borrowernumber, accountno, offsetaccount, offsetamount)
532 $usth->execute( $borrowernumber, $accdata->{'accountno'},
533 $nextaccntno, $newamtos );
537 return ($amountleft);
541 my ( $borrowerno, $timestamp, $accountno ) = @_;
542 my $dbh = C4::Context->dbh;
543 my $timestamp2 = $timestamp - 1;
545 my $sth = $dbh->prepare(
546 "SELECT * FROM accountlines WHERE borrowernumber=? AND accountno = ?"
548 $sth->execute( $borrowerno, $accountno );
551 while ( my $data = $sth->fetchrow_hashref ) {
559 my ( $date, $date2 ) = @_;
560 my $dbh = C4::Context->dbh;
561 my $sth = $dbh->prepare(
562 "SELECT * FROM accountlines,borrowers
563 WHERE amount < 0 AND accounttype <> 'Pay' AND accountlines.borrowernumber = borrowers.borrowernumber
564 AND timestamp >=TIMESTAMP(?) AND timestamp < TIMESTAMP(?)"
567 $sth->execute( $date, $date2 );
569 while ( my $data = $sth->fetchrow_hashref ) {
570 $data->{'date'} = $data->{'timestamp'};
578 my ( $date, $date2 ) = @_;
579 my $dbh = C4::Context->dbh;
581 my $sth = $dbh->prepare(
582 "SELECT *,timestamp AS datetime
583 FROM accountlines,borrowers
584 WHERE (accounttype = 'REF'
585 AND accountlines.borrowernumber = borrowers.borrowernumber
586 AND date >=? AND date <?)"
589 $sth->execute( $date, $date2 );
592 while ( my $data = $sth->fetchrow_hashref ) {
598 END { } # module clean-up code here (global destructor)