3 # Copyright 2016 ByWater Solutions
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>.
24 use List::MoreUtils qw(uniq);
26 use C4::Circulation qw( ReturnLostItem );
27 use C4::Log qw( logaction );
28 use C4::Stats qw( UpdateStats );
30 use Koha::Account::Lines;
31 use Koha::Account::Offsets;
32 use Koha::DateUtils qw( dt_from_string );
36 Koha::Accounts - Module for managing payments and fees for patrons
41 my ( $class, $params ) = @_;
43 Carp::croak("No patron id passed in!") unless $params->{patron_id};
45 return bless( $params, $class );
50 This method allows payments to be made against fees/fines
52 Koha::Account->new( { patron_id => $borrowernumber } )->pay(
57 description => $description,
58 library_id => $branchcode,
59 lines => $lines, # Arrayref of Koha::Account::Line objects to pay
60 account_type => $type, # accounttype code
61 offset_type => $offset_type, # offset type code
68 my ( $self, $params ) = @_;
70 my $amount = $params->{amount};
71 my $sip = $params->{sip};
72 my $description = $params->{description};
73 my $note = $params->{note} || q{};
74 my $library_id = $params->{library_id};
75 my $lines = $params->{lines};
76 my $type = $params->{type} || 'payment';
77 my $account_type = $params->{account_type};
78 my $offset_type = $params->{offset_type} || $type eq 'writeoff' ? 'Writeoff' : 'Payment';
80 my $userenv = C4::Context->userenv;
82 # We should remove accountno, it is no longer needed
83 my $last = Koha::Account::Lines->search(
85 borrowernumber => $self->{patron_id}
88 order_by => 'accountno'
91 my $accountno = $last ? $last->accountno + 1 : 1;
93 my $manager_id = $userenv ? $userenv->{number} : 0;
95 my @fines_paid; # List of account lines paid on with this payment
97 my $balance_remaining = $amount; # Set it now so we can adjust the amount if necessary
98 $balance_remaining ||= 0;
102 # We were passed a specific line to pay
103 foreach my $fine ( @$lines ) {
105 $fine->amountoutstanding > $balance_remaining
107 : $fine->amountoutstanding;
109 my $old_amountoutstanding = $fine->amountoutstanding;
110 my $new_amountoutstanding = $old_amountoutstanding - $amount_to_pay;
111 $fine->amountoutstanding($new_amountoutstanding)->store();
112 $balance_remaining = $balance_remaining - $amount_to_pay;
114 if ( $fine->itemnumber && $fine->accounttype && ( $fine->accounttype eq 'Rep' || $fine->accounttype eq 'L' ) )
116 C4::Circulation::ReturnLostItem( $self->{patron_id}, $fine->itemnumber );
119 my $account_offset = Koha::Account::Offset->new(
121 debit_id => $fine->id,
122 type => $offset_type,
123 amount => $amount_to_pay * -1,
126 push( @account_offsets, $account_offset );
128 if ( C4::Context->preference("FinesLog") ) {
134 action => 'fee_payment',
135 borrowernumber => $fine->borrowernumber,
136 old_amountoutstanding => $old_amountoutstanding,
137 new_amountoutstanding => 0,
138 amount_paid => $old_amountoutstanding,
139 accountlines_id => $fine->id,
140 accountno => $fine->accountno,
141 manager_id => $manager_id,
146 push( @fines_paid, $fine->id );
150 # Were not passed a specific line to pay, or the payment was for more
151 # than the what was owed on the given line. In that case pay down other
152 # lines with remaining balance.
153 my @outstanding_fines;
154 @outstanding_fines = Koha::Account::Lines->search(
156 borrowernumber => $self->{patron_id},
157 amountoutstanding => { '>' => 0 },
159 ) if $balance_remaining > 0;
161 foreach my $fine (@outstanding_fines) {
163 $fine->amountoutstanding > $balance_remaining
165 : $fine->amountoutstanding;
167 my $old_amountoutstanding = $fine->amountoutstanding;
168 $fine->amountoutstanding( $old_amountoutstanding - $amount_to_pay );
171 my $account_offset = Koha::Account::Offset->new(
173 debit_id => $fine->id,
174 type => $offset_type,
175 amount => $amount_to_pay * -1,
178 push( @account_offsets, $account_offset );
180 if ( C4::Context->preference("FinesLog") ) {
186 action => "fee_$type",
187 borrowernumber => $fine->borrowernumber,
188 old_amountoutstanding => $old_amountoutstanding,
189 new_amountoutstanding => $fine->amountoutstanding,
190 amount_paid => $amount_to_pay,
191 accountlines_id => $fine->id,
192 accountno => $fine->accountno,
193 manager_id => $manager_id,
198 push( @fines_paid, $fine->id );
201 $balance_remaining = $balance_remaining - $amount_to_pay;
202 last unless $balance_remaining > 0;
206 $type eq 'writeoff' ? 'W'
207 : defined($sip) ? "Pay$sip"
210 $description ||= $type eq 'writeoff' ? 'Writeoff' : q{};
212 my $payment = Koha::Account::Line->new(
214 borrowernumber => $self->{patron_id},
215 accountno => $accountno,
216 date => dt_from_string(),
217 amount => 0 - $amount,
218 description => $description,
219 accounttype => $account_type,
220 amountoutstanding => 0 - $balance_remaining,
221 manager_id => $manager_id,
226 foreach my $o ( @account_offsets ) {
227 $o->credit_id( $payment->id() );
231 $library_id ||= $userenv ? $userenv->{'branch'} : undef;
235 branch => $library_id,
238 borrowernumber => $self->{patron_id},
239 accountno => $accountno,
243 if ( C4::Context->preference("FinesLog") ) {
249 action => "create_$type",
250 borrowernumber => $self->{patron_id},
251 accountno => $accountno,
252 amount => 0 - $amount,
253 amountoutstanding => 0 - $balance_remaining,
254 accounttype => $account_type,
255 accountlines_paid => \@fines_paid,
256 manager_id => $manager_id,
267 my $balance = $self->balance
269 Return the balance (sum of amountoutstanding columns)
275 my $fines = Koha::Account::Lines->search(
277 borrowernumber => $self->{patron_id},
280 select => [ { sum => 'amountoutstanding' } ],
281 as => ['total_amountoutstanding'],
285 ? $fines->next->get_column('total_amountoutstanding')
289 sub non_issues_charges {
292 # FIXME REMOVE And add a warning in the about page + update DB if length(MANUAL_INV) > 5
293 my $ACCOUNT_TYPE_LENGTH = 5; # this is plain ridiculous...
296 push @not_fines, 'Res'
297 unless C4::Context->preference('HoldsInNoissuesCharge');
298 push @not_fines, 'Rent'
299 unless C4::Context->preference('RentalsInNoissuesCharge');
300 unless ( C4::Context->preference('ManInvInNoissuesCharge') ) {
301 my $dbh = C4::Context->dbh;
304 $dbh->selectcol_arrayref(q|
305 SELECT authorised_value FROM authorised_values WHERE category = 'MANUAL_INV'
309 @not_fines = map { substr( $_, 0, $ACCOUNT_TYPE_LENGTH ) } uniq(@not_fines);
311 my $non_issues_charges = Koha::Account::Lines->search(
313 borrowernumber => $self->{patron_id},
314 accounttype => { -not_in => \@not_fines }
317 select => [ { sum => 'amountoutstanding' } ],
318 as => ['non_issues_charges'],
321 return $non_issues_charges->count
322 ? $non_issues_charges->next->get_column('non_issues_charges') + 0
330 Kyle M Hall <kyle.m.hall@gmail.com>