Martin Renvoize
55d18aeca6
This patch updates C4::Accounts::chargelostitem to use the newly available add_debit method from Koha::Account. Known Side Effects: If the FinesLog is enabled then the 'action' recorded will change from the generic `create_fee` (for both the lost charge and any associated processing charge) to the more descriptive terms `create_processing` and `create_lost_item`. Sponsored-by: PTFS Europe Signed-off-by: Josef Moravec <josef.moravec@gmail.com> Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io> Signed-off-by: Nick Clemens <nick@bywatersolutions.com>
287 lines
8.8 KiB
Perl
287 lines
8.8 KiB
Perl
package C4::Accounts;
|
|
|
|
# Copyright 2000-2002 Katipo Communications
|
|
#
|
|
# This file is part of Koha.
|
|
#
|
|
# Koha is free software; you can redistribute it and/or modify it
|
|
# under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation; either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Koha is distributed in the hope that it will be useful, but
|
|
# WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Koha; if not, see <http://www.gnu.org/licenses>.
|
|
|
|
|
|
use strict;
|
|
#use warnings; FIXME - Bug 2505
|
|
use C4::Context;
|
|
use C4::Stats;
|
|
use C4::Members;
|
|
use C4::Log qw(logaction);
|
|
use Koha::Account;
|
|
use Koha::Account::Lines;
|
|
use Koha::Account::Offsets;
|
|
use Koha::Items;
|
|
|
|
use Data::Dumper qw(Dumper);
|
|
|
|
use vars qw(@ISA @EXPORT);
|
|
|
|
BEGIN {
|
|
require Exporter;
|
|
@ISA = qw(Exporter);
|
|
@EXPORT = qw(
|
|
&manualinvoice
|
|
&getnextacctno
|
|
&chargelostitem
|
|
&purge_zero_balance_fees
|
|
);
|
|
}
|
|
|
|
=head1 NAME
|
|
|
|
C4::Accounts - Functions for dealing with Koha accounts
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
use C4::Accounts;
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
The functions in this module deal with the monetary aspect of Koha,
|
|
including looking up and modifying the amount of money owed by a
|
|
patron.
|
|
|
|
=head1 FUNCTIONS
|
|
|
|
=head2 getnextacctno
|
|
|
|
$nextacct = &getnextacctno($borrowernumber);
|
|
|
|
Returns the next unused account number for the patron with the given
|
|
borrower number.
|
|
|
|
=cut
|
|
|
|
#'
|
|
# FIXME - Okay, so what does the above actually _mean_?
|
|
sub getnextacctno {
|
|
my ($borrowernumber) = shift or return;
|
|
my $sth = C4::Context->dbh->prepare(
|
|
"SELECT accountno+1 FROM accountlines
|
|
WHERE (borrowernumber = ?)
|
|
ORDER BY accountno DESC
|
|
LIMIT 1"
|
|
);
|
|
$sth->execute($borrowernumber);
|
|
return ($sth->fetchrow || 1);
|
|
}
|
|
|
|
=head2 chargelostitem
|
|
|
|
In a default install of Koha the following lost values are set
|
|
1 = Lost
|
|
2 = Long overdue
|
|
3 = Lost and paid for
|
|
|
|
FIXME: itemlost should be set to 3 after payment is made, should be a warning to the interface that a charge has been added
|
|
FIXME : if no replacement price, borrower just doesn't get charged?
|
|
|
|
=cut
|
|
|
|
sub chargelostitem{
|
|
my $dbh = C4::Context->dbh();
|
|
my ($borrowernumber, $itemnumber, $amount, $description) = @_;
|
|
my $itype = Koha::ItemTypes->find({ itemtype => Koha::Items->find($itemnumber)->effective_itemtype() });
|
|
my $replacementprice = $amount;
|
|
my $defaultreplacecost = $itype->defaultreplacecost;
|
|
my $processfee = $itype->processfee;
|
|
my $usedefaultreplacementcost = C4::Context->preference("useDefaultReplacementCost");
|
|
my $processingfeenote = C4::Context->preference("ProcessingFeeNote");
|
|
if ($usedefaultreplacementcost && $amount == 0 && $defaultreplacecost){
|
|
$replacementprice = $defaultreplacecost;
|
|
}
|
|
|
|
my $account = Koha::Account->new({ patron_id => $borrowernumber });
|
|
# first make sure the borrower hasn't already been charged for this item
|
|
# FIXME this should be more exact
|
|
# there is no reason a user can't lose an item, find and return it, and lost it again
|
|
my $existing_charges = $account->lines->search(
|
|
{
|
|
itemnumber => $itemnumber,
|
|
accounttype => 'L',
|
|
}
|
|
)->count();
|
|
|
|
# OK, they haven't
|
|
unless ($existing_charges) {
|
|
my $checkout = Koha::Checkouts->find({ itemnumber => $itemnumber });
|
|
my $issue_id = $checkout ? $checkout->issue_id : undef;
|
|
#add processing fee
|
|
if ($processfee && $processfee > 0){
|
|
my $accountline = $account->add_debit(
|
|
{
|
|
amount => $processfee,
|
|
description => $description,
|
|
note => $processingfeenote,
|
|
user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : 0,
|
|
library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
|
|
type => 'processing',
|
|
item_id => $itemnumber,
|
|
issue_id => $issue_id,
|
|
}
|
|
);
|
|
}
|
|
#add replace cost
|
|
if ($replacementprice > 0){
|
|
my $accountline = $account->add_debit(
|
|
{
|
|
amount => $replacementprice,
|
|
description => $description,
|
|
note => undef,
|
|
user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : 0,
|
|
library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
|
|
type => 'lost_item',
|
|
item_id => $itemnumber,
|
|
issue_id => $issue_id,
|
|
}
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
=head2 manualinvoice
|
|
|
|
&manualinvoice($borrowernumber, $itemnumber, $description, $type,
|
|
$amount, $note);
|
|
|
|
C<$borrowernumber> is the patron's borrower number.
|
|
C<$description> is a description of the transaction.
|
|
C<$type> may be one of C<CS>, C<CB>, C<CW>, C<CF>, C<CL>, C<N>, C<L>,
|
|
or C<REF>.
|
|
C<$itemnumber> is the item involved, if pertinent; otherwise, it
|
|
should be the empty string.
|
|
|
|
=cut
|
|
|
|
#'
|
|
# FIXME: In Koha 3.0 , the only account adjustment 'types' passed to this function
|
|
# are:
|
|
# 'C' = CREDIT
|
|
# 'FOR' = FORGIVEN (Formerly 'F', but 'F' is taken to mean 'FINE' elsewhere)
|
|
# 'N' = New Card fee
|
|
# 'F' = Fine
|
|
# 'A' = Account Management fee
|
|
# 'M' = Sundry
|
|
# 'L' = Lost Item
|
|
#
|
|
|
|
sub manualinvoice {
|
|
my ( $borrowernumber, $itemnum, $desc, $type, $amount, $note ) = @_;
|
|
my $manager_id = 0;
|
|
$manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
|
|
my $dbh = C4::Context->dbh;
|
|
my $insert;
|
|
my $accountno = getnextacctno($borrowernumber);
|
|
my $amountleft = $amount;
|
|
|
|
my $branchcode = C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
|
|
|
|
my $accountline = Koha::Account::Line->new(
|
|
{
|
|
borrowernumber => $borrowernumber,
|
|
accountno => $accountno,
|
|
date => \'NOW()',
|
|
amount => $amount,
|
|
description => $desc,
|
|
accounttype => $type,
|
|
amountoutstanding => $amountleft,
|
|
itemnumber => $itemnum || undef,
|
|
note => $note,
|
|
manager_id => $manager_id,
|
|
branchcode => $branchcode,
|
|
}
|
|
)->store();
|
|
|
|
my $account_offset = Koha::Account::Offset->new(
|
|
{
|
|
debit_id => $accountline->id,
|
|
type => 'Manual Debit',
|
|
amount => $amount,
|
|
}
|
|
)->store();
|
|
|
|
if ( C4::Context->preference("FinesLog") ) {
|
|
logaction("FINES", 'CREATE',$borrowernumber,Dumper({
|
|
action => 'create_fee',
|
|
borrowernumber => $borrowernumber,
|
|
accountno => $accountno,
|
|
amount => $amount,
|
|
description => $desc,
|
|
accounttype => $type,
|
|
amountoutstanding => $amountleft,
|
|
note => $note,
|
|
itemnumber => $itemnum,
|
|
manager_id => $manager_id,
|
|
}));
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
=head2 purge_zero_balance_fees
|
|
|
|
purge_zero_balance_fees( $days );
|
|
|
|
Delete accountlines entries where amountoutstanding is 0 or NULL which are more than a given number of days old.
|
|
|
|
B<$days> -- Zero balance fees older than B<$days> days old will be deleted.
|
|
|
|
B<Warning:> Because fines and payments are not linked in accountlines, it is
|
|
possible for a fine to be deleted without the accompanying payment,
|
|
or vise versa. This won't affect the account balance, but might be
|
|
confusing to staff.
|
|
|
|
=cut
|
|
|
|
sub purge_zero_balance_fees {
|
|
my $days = shift;
|
|
my $count = 0;
|
|
|
|
my $dbh = C4::Context->dbh;
|
|
my $sth = $dbh->prepare(
|
|
q{
|
|
DELETE a1 FROM accountlines a1
|
|
|
|
LEFT JOIN account_offsets credit_offset ON ( a1.accountlines_id = credit_offset.credit_id )
|
|
LEFT JOIN accountlines a2 ON ( credit_offset.debit_id = a2.accountlines_id )
|
|
|
|
LEFT JOIN account_offsets debit_offset ON ( a1.accountlines_id = debit_offset.debit_id )
|
|
LEFT JOIN accountlines a3 ON ( debit_offset.credit_id = a3.accountlines_id )
|
|
|
|
WHERE a1.date < date_sub(curdate(), INTERVAL ? DAY)
|
|
AND ( a1.amountoutstanding = 0 OR a1.amountoutstanding IS NULL )
|
|
AND ( a2.amountoutstanding = 0 OR a2.amountoutstanding IS NULL )
|
|
AND ( a3.amountoutstanding = 0 OR a3.amountoutstanding IS NULL )
|
|
}
|
|
);
|
|
$sth->execute($days) or die $dbh->errstr;
|
|
}
|
|
|
|
END { } # module clean-up code here (global destructor)
|
|
|
|
1;
|
|
__END__
|
|
|
|
=head1 SEE ALSO
|
|
|
|
DBI(3)
|
|
|
|
=cut
|
|
|