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
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.
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.
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>.
22 #use warnings; FIXME - Bug 2505
26 use C4::Log qw(logaction);
28 use Koha::Account::Lines;
29 use Koha::Account::Offsets;
32 use Mojo::Util qw(deprecated);
33 use Data::Dumper qw(Dumper);
35 use vars qw(@ISA @EXPORT);
42 &purge_zero_balance_fees
48 C4::Accounts - Functions for dealing with Koha accounts
56 The functions in this module deal with the monetary aspect of Koha,
57 including looking up and modifying the amount of money owed by a
64 In a default install of Koha the following lost values are set
69 FIXME: itemlost should be set to 3 after payment is made, should be a warning to the interface that a charge has been added
70 FIXME : if no replacement price, borrower just doesn't get charged?
75 my $dbh = C4::Context->dbh();
76 my ($borrowernumber, $itemnumber, $amount, $description) = @_;
77 my $itype = Koha::ItemTypes->find({ itemtype => Koha::Items->find($itemnumber)->effective_itemtype() });
78 my $replacementprice = $amount;
79 my $defaultreplacecost = $itype->defaultreplacecost;
80 my $processfee = $itype->processfee;
81 my $usedefaultreplacementcost = C4::Context->preference("useDefaultReplacementCost");
82 my $processingfeenote = C4::Context->preference("ProcessingFeeNote");
83 if ($usedefaultreplacementcost && $amount == 0 && $defaultreplacecost){
84 $replacementprice = $defaultreplacecost;
87 my $account = Koha::Account->new({ patron_id => $borrowernumber });
88 # first make sure the borrower hasn't already been charged for this item
89 # FIXME this should be more exact
90 # there is no reason a user can't lose an item, find and return it, and lost it again
91 my $existing_charges = $account->lines->search(
93 itemnumber => $itemnumber,
99 unless ($existing_charges) {
100 my $checkout = Koha::Checkouts->find({ itemnumber => $itemnumber });
101 my $issue_id = $checkout ? $checkout->issue_id : undef;
103 if ($processfee && $processfee > 0){
104 my $accountline = $account->add_debit(
106 amount => $processfee,
107 description => $description,
108 note => $processingfeenote,
109 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
110 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
111 type => 'processing',
112 item_id => $itemnumber,
113 issue_id => $issue_id,
118 if ($replacementprice > 0){
119 my $accountline = $account->add_debit(
121 amount => $replacementprice,
122 description => $description,
124 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
125 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
127 item_id => $itemnumber,
128 issue_id => $issue_id,
137 &manualinvoice($borrowernumber, $itemnumber, $description, $type,
140 This function is now deprecated and not used anywhere within koha. It is due for complete removal in 19.11
145 my ( $borrowernumber, $itemnum, $desc, $type, $amount, $note ) = @_;
147 deprecated "C4::Accounts::manualinvoice is deprecated in favor of Koha::Account->add_debit";
149 my $manager_id = C4::Context->userenv ? C4::Context->userenv->{'number'} : undef;
150 my $dbh = C4::Context->dbh;
152 my $amountleft = $amount;
154 my $branchcode = C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
156 my $accountline = Koha::Account::Line->new(
158 borrowernumber => $borrowernumber,
161 description => $desc,
162 accounttype => $type,
163 amountoutstanding => $amountleft,
164 itemnumber => $itemnum || undef,
166 manager_id => $manager_id,
167 branchcode => $branchcode,
171 my $account_offset = Koha::Account::Offset->new(
173 debit_id => $accountline->id,
174 type => 'Manual Debit',
179 if ( C4::Context->preference("FinesLog") ) {
180 logaction("FINES", 'CREATE',$borrowernumber,Dumper({
181 action => 'create_fee',
182 borrowernumber => $borrowernumber,
184 description => $desc,
185 accounttype => $type,
186 amountoutstanding => $amountleft,
188 itemnumber => $itemnum,
189 manager_id => $manager_id,
196 =head2 purge_zero_balance_fees
198 purge_zero_balance_fees( $days );
200 Delete accountlines entries where amountoutstanding is 0 or NULL which are more than a given number of days old.
202 B<$days> -- Zero balance fees older than B<$days> days old will be deleted.
204 B<Warning:> Because fines and payments are not linked in accountlines, it is
205 possible for a fine to be deleted without the accompanying payment,
206 or vise versa. This won't affect the account balance, but might be
211 sub purge_zero_balance_fees {
215 my $dbh = C4::Context->dbh;
216 my $sth = $dbh->prepare(
218 DELETE a1 FROM accountlines a1
220 LEFT JOIN account_offsets credit_offset ON ( a1.accountlines_id = credit_offset.credit_id )
221 LEFT JOIN accountlines a2 ON ( credit_offset.debit_id = a2.accountlines_id )
223 LEFT JOIN account_offsets debit_offset ON ( a1.accountlines_id = debit_offset.debit_id )
224 LEFT JOIN accountlines a3 ON ( debit_offset.credit_id = a3.accountlines_id )
226 WHERE a1.date < date_sub(curdate(), INTERVAL ? DAY)
227 AND ( a1.amountoutstanding = 0 OR a1.amountoutstanding IS NULL )
228 AND ( a2.amountoutstanding = 0 OR a2.amountoutstanding IS NULL )
229 AND ( a3.amountoutstanding = 0 OR a3.amountoutstanding IS NULL )
232 $sth->execute($days) or die $dbh->errstr;
235 END { } # module clean-up code here (global destructor)