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::Log qw( logaction );
27 use C4::Stats qw( UpdateStats );
29 use Koha::Account::Lines;
30 use Koha::Account::Offsets;
31 use Koha::DateUtils qw( dt_from_string );
35 Koha::Accounts - Module for managing payments and fees for patrons
40 my ( $class, $params ) = @_;
42 Carp::croak("No patron id passed in!") unless $params->{patron_id};
44 return bless( $params, $class );
49 This method allows payments to be made against fees/fines
51 Koha::Account->new( { patron_id => $borrowernumber } )->pay(
56 description => $description,
57 library_id => $branchcode,
58 lines => $lines, # Arrayref of Koha::Account::Line objects to pay
59 account_type => $type, # accounttype code
60 offset_type => $offset_type, # offset type code
67 my ( $self, $params ) = @_;
69 my $amount = $params->{amount};
70 my $sip = $params->{sip};
71 my $description = $params->{description};
72 my $note = $params->{note} || q{};
73 my $library_id = $params->{library_id};
74 my $lines = $params->{lines};
75 my $type = $params->{type} || 'payment';
76 my $payment_type = $params->{payment_type} || undef;
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 payment_type => $payment_type,
221 amountoutstanding => 0 - $balance_remaining,
222 manager_id => $manager_id,
227 foreach my $o ( @account_offsets ) {
228 $o->credit_id( $payment->id() );
232 $library_id ||= $userenv ? $userenv->{'branch'} : undef;
236 branch => $library_id,
239 borrowernumber => $self->{patron_id},
240 accountno => $accountno,
244 if ( C4::Context->preference("FinesLog") ) {
250 action => "create_$type",
251 borrowernumber => $self->{patron_id},
252 accountno => $accountno,
253 amount => 0 - $amount,
254 amountoutstanding => 0 - $balance_remaining,
255 accounttype => $account_type,
256 accountlines_paid => \@fines_paid,
257 manager_id => $manager_id,
268 This method allows adding credits to a patron's account
270 my $credit_line = Koha::Account->new({ patron_id => $patron_id })->add_credit(
273 description => $description,
276 library_id => $library_id,
278 payment_type => $payment_type,
279 type => $credit_type,
284 $credit_type can be any of:
295 my ( $self, $params ) = @_;
297 # amount is passed as a positive value, but we store credit as negative values
298 my $amount = $params->{amount} * -1;
299 my $description = $params->{description} // q{};
300 my $note = $params->{note} // q{};
301 my $user_id = $params->{user_id};
302 my $library_id = $params->{library_id};
303 my $sip = $params->{sip};
304 my $payment_type = $params->{payment_type};
305 my $type = $params->{type} || 'payment';
306 my $item_id = $params->{item_id};
308 my $schema = Koha::Database->new->schema;
310 my $account_type = $Koha::Account::account_type->{$type};
311 $account_type .= $sip
319 # We should remove accountno, it is no longer needed
320 my $last = Koha::Account::Lines->search( { borrowernumber => $self->{patron_id} },
321 { order_by => 'accountno' } )->next();
322 my $accountno = $last ? $last->accountno + 1 : 1;
324 # Insert the account line
325 $line = Koha::Account::Line->new(
326 { borrowernumber => $self->{patron_id},
329 description => $description,
330 accounttype => $account_type,
331 amountoutstanding => $amount,
332 payment_type => $payment_type,
334 manager_id => $user_id,
335 itemnumber => $item_id
339 # Record the account offset
340 my $account_offset = Koha::Account::Offset->new(
341 { credit_id => $line->id,
342 type => $Koha::Account::offset_type->{$type},
348 { branch => $library_id,
351 borrowernumber => $self->{patron_id},
352 accountno => $accountno,
354 ) if grep { $type eq $_ } ('payment', 'writeoff') ;
356 if ( C4::Context->preference("FinesLog") ) {
361 { action => "create_$type",
362 borrowernumber => $self->{patron_id},
363 accountno => $accountno,
365 description => $description,
366 amountoutstanding => $amount,
367 accounttype => $account_type,
369 itemnumber => $item_id,
370 manager_id => $user_id,
383 my $balance = $self->balance
385 Return the balance (sum of amountoutstanding columns)
391 my $fines = Koha::Account::Lines->search(
393 borrowernumber => $self->{patron_id},
396 select => [ { sum => 'amountoutstanding' } ],
397 as => ['total_amountoutstanding'],
401 return ( $fines->count )
402 ? $fines->next->get_column('total_amountoutstanding') + 0
406 =head3 outstanding_debits
408 my $lines = Koha::Account->new({ patron_id => $patron_id })->outstanding_debits;
412 sub outstanding_debits {
415 my $lines = Koha::Account::Lines->search(
417 borrowernumber => $self->{patron_id},
418 amountoutstanding => { '>' => 0 }
425 =head3 non_issues_charges
427 my $non_issues_charges = $self->non_issues_charges
429 Calculates amount immediately owing by the patron - non-issue charges.
431 Charges exempt from non-issue are:
432 * Res (holds) if HoldsInNoissuesCharge syspref is set to false
433 * Rent (rental) if RentalsInNoissuesCharge syspref is set to false
434 * Manual invoices if ManInvInNoissuesCharge syspref is set to false
438 sub non_issues_charges {
441 # FIXME REMOVE And add a warning in the about page + update DB if length(MANUAL_INV) > 5
442 my $ACCOUNT_TYPE_LENGTH = 5; # this is plain ridiculous...
445 push @not_fines, 'Res'
446 unless C4::Context->preference('HoldsInNoissuesCharge');
447 push @not_fines, 'Rent'
448 unless C4::Context->preference('RentalsInNoissuesCharge');
449 unless ( C4::Context->preference('ManInvInNoissuesCharge') ) {
450 my $dbh = C4::Context->dbh;
453 $dbh->selectcol_arrayref(q|
454 SELECT authorised_value FROM authorised_values WHERE category = 'MANUAL_INV'
458 @not_fines = map { substr( $_, 0, $ACCOUNT_TYPE_LENGTH ) } uniq(@not_fines);
460 my $non_issues_charges = Koha::Account::Lines->search(
462 borrowernumber => $self->{patron_id},
463 accounttype => { -not_in => \@not_fines }
466 select => [ { sum => 'amountoutstanding' } ],
467 as => ['non_issues_charges'],
470 return $non_issues_charges->count
471 ? $non_issues_charges->next->get_column('non_issues_charges') + 0
479 Kyle M Hall <kyle.m.hall@gmail.com>