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 );
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 $payment_type = $params->{payment_type} || undef;
78 my $account_type = $params->{account_type};
79 my $offset_type = $params->{offset_type} || $type eq 'writeoff' ? 'Writeoff' : 'Payment';
81 my $userenv = C4::Context->userenv;
83 my $patron = Koha::Patrons->find( $self->{patron_id} );
85 # We should remove accountno, it is no longer needed
86 my $last = Koha::Account::Lines->search(
88 borrowernumber => $self->{patron_id}
91 order_by => 'accountno'
94 my $accountno = $last ? $last->accountno + 1 : 1;
96 my $manager_id = $userenv ? $userenv->{number} : 0;
98 my @fines_paid; # List of account lines paid on with this payment
100 my $balance_remaining = $amount; # Set it now so we can adjust the amount if necessary
101 $balance_remaining ||= 0;
105 # We were passed a specific line to pay
106 foreach my $fine ( @$lines ) {
108 $fine->amountoutstanding > $balance_remaining
110 : $fine->amountoutstanding;
112 my $old_amountoutstanding = $fine->amountoutstanding;
113 my $new_amountoutstanding = $old_amountoutstanding - $amount_to_pay;
114 $fine->amountoutstanding($new_amountoutstanding)->store();
115 $balance_remaining = $balance_remaining - $amount_to_pay;
117 if ( $fine->itemnumber && $fine->accounttype && ( $fine->accounttype eq 'Rep' || $fine->accounttype eq 'L' ) )
119 C4::Circulation::ReturnLostItem( $self->{patron_id}, $fine->itemnumber );
122 my $account_offset = Koha::Account::Offset->new(
124 debit_id => $fine->id,
125 type => $offset_type,
126 amount => $amount_to_pay * -1,
129 push( @account_offsets, $account_offset );
131 if ( C4::Context->preference("FinesLog") ) {
137 action => 'fee_payment',
138 borrowernumber => $fine->borrowernumber,
139 old_amountoutstanding => $old_amountoutstanding,
140 new_amountoutstanding => 0,
141 amount_paid => $old_amountoutstanding,
142 accountlines_id => $fine->id,
143 accountno => $fine->accountno,
144 manager_id => $manager_id,
149 push( @fines_paid, $fine->id );
153 # Were not passed a specific line to pay, or the payment was for more
154 # than the what was owed on the given line. In that case pay down other
155 # lines with remaining balance.
156 my @outstanding_fines;
157 @outstanding_fines = Koha::Account::Lines->search(
159 borrowernumber => $self->{patron_id},
160 amountoutstanding => { '>' => 0 },
162 ) if $balance_remaining > 0;
164 foreach my $fine (@outstanding_fines) {
166 $fine->amountoutstanding > $balance_remaining
168 : $fine->amountoutstanding;
170 my $old_amountoutstanding = $fine->amountoutstanding;
171 $fine->amountoutstanding( $old_amountoutstanding - $amount_to_pay );
174 my $account_offset = Koha::Account::Offset->new(
176 debit_id => $fine->id,
177 type => $offset_type,
178 amount => $amount_to_pay * -1,
181 push( @account_offsets, $account_offset );
183 if ( C4::Context->preference("FinesLog") ) {
189 action => "fee_$type",
190 borrowernumber => $fine->borrowernumber,
191 old_amountoutstanding => $old_amountoutstanding,
192 new_amountoutstanding => $fine->amountoutstanding,
193 amount_paid => $amount_to_pay,
194 accountlines_id => $fine->id,
195 accountno => $fine->accountno,
196 manager_id => $manager_id,
201 push( @fines_paid, $fine->id );
204 $balance_remaining = $balance_remaining - $amount_to_pay;
205 last unless $balance_remaining > 0;
209 $type eq 'writeoff' ? 'W'
210 : defined($sip) ? "Pay$sip"
213 $description ||= $type eq 'writeoff' ? 'Writeoff' : q{};
215 my $payment = Koha::Account::Line->new(
217 borrowernumber => $self->{patron_id},
218 accountno => $accountno,
219 date => dt_from_string(),
220 amount => 0 - $amount,
221 description => $description,
222 accounttype => $account_type,
223 payment_type => $payment_type,
224 amountoutstanding => 0 - $balance_remaining,
225 manager_id => $manager_id,
230 foreach my $o ( @account_offsets ) {
231 $o->credit_id( $payment->id() );
235 $library_id ||= $userenv ? $userenv->{'branch'} : undef;
239 branch => $library_id,
242 borrowernumber => $self->{patron_id},
243 accountno => $accountno,
247 if ( C4::Context->preference("FinesLog") ) {
253 action => "create_$type",
254 borrowernumber => $self->{patron_id},
255 accountno => $accountno,
256 amount => 0 - $amount,
257 amountoutstanding => 0 - $balance_remaining,
258 accounttype => $account_type,
259 accountlines_paid => \@fines_paid,
260 manager_id => $manager_id,
266 if ( C4::Context->preference('UseEmailReceipts') ) {
269 my $letter = C4::Letters::GetPreparedLetter(
270 module => 'circulation',
271 letter_code => uc("ACCOUNT_$type"),
272 message_transport_type => 'email',
273 lang => Koha::Patrons->find( $self->{patron_id} )->lang,
275 borrowers => $self->{patron_id},
276 branches => $self->{library_id},
280 offsets => scalar Koha::Account::Offsets->search( { id => { -in => [ map { $_->id } @account_offsets ] } } ),
285 C4::Letters::EnqueueLetter(
288 borrowernumber => $self->{patron_id},
289 message_transport_type => 'email',
291 ) or warn "can't enqueue letter $letter";
300 This method allows adding credits to a patron's account
302 my $credit_line = Koha::Account->new({ patron_id => $patron_id })->add_credit(
305 description => $description,
308 library_id => $library_id,
310 payment_type => $payment_type,
311 type => $credit_type,
316 $credit_type can be any of:
327 my ( $self, $params ) = @_;
329 # amount is passed as a positive value, but we store credit as negative values
330 my $amount = $params->{amount} * -1;
331 my $description = $params->{description} // q{};
332 my $note = $params->{note} // q{};
333 my $user_id = $params->{user_id};
334 my $library_id = $params->{library_id};
335 my $sip = $params->{sip};
336 my $payment_type = $params->{payment_type};
337 my $type = $params->{type} || 'payment';
338 my $item_id = $params->{item_id};
340 my $schema = Koha::Database->new->schema;
342 my $account_type = $Koha::Account::account_type->{$type};
343 $account_type .= $sip
351 # We should remove accountno, it is no longer needed
352 my $last = Koha::Account::Lines->search( { borrowernumber => $self->{patron_id} },
353 { order_by => 'accountno' } )->next();
354 my $accountno = $last ? $last->accountno + 1 : 1;
356 # Insert the account line
357 $line = Koha::Account::Line->new(
358 { borrowernumber => $self->{patron_id},
361 description => $description,
362 accounttype => $account_type,
363 amountoutstanding => $amount,
364 payment_type => $payment_type,
366 manager_id => $user_id,
367 itemnumber => $item_id
371 # Record the account offset
372 my $account_offset = Koha::Account::Offset->new(
373 { credit_id => $line->id,
374 type => $Koha::Account::offset_type->{$type},
380 { branch => $library_id,
383 borrowernumber => $self->{patron_id},
384 accountno => $accountno,
386 ) if grep { $type eq $_ } ('payment', 'writeoff') ;
388 if ( C4::Context->preference("FinesLog") ) {
393 { action => "create_$type",
394 borrowernumber => $self->{patron_id},
395 accountno => $accountno,
397 description => $description,
398 amountoutstanding => $amount,
399 accounttype => $account_type,
401 itemnumber => $item_id,
402 manager_id => $user_id,
415 my $balance = $self->balance
417 Return the balance (sum of amountoutstanding columns)
423 my $fines = Koha::Account::Lines->search(
425 borrowernumber => $self->{patron_id},
428 select => [ { sum => 'amountoutstanding' } ],
429 as => ['total_amountoutstanding'],
433 return ( $fines->count )
434 ? $fines->next->get_column('total_amountoutstanding') + 0
438 =head3 outstanding_debits
440 my $lines = Koha::Account->new({ patron_id => $patron_id })->outstanding_debits;
444 sub outstanding_debits {
447 my $lines = Koha::Account::Lines->search(
449 borrowernumber => $self->{patron_id},
450 amountoutstanding => { '>' => 0 }
457 =head3 outstanding_credits
459 my $lines = Koha::Account->new({ patron_id => $patron_id })->outstanding_credits;
463 sub outstanding_credits {
466 my $lines = Koha::Account::Lines->search(
468 borrowernumber => $self->{patron_id},
469 amountoutstanding => { '<' => 0 }
476 =head3 non_issues_charges
478 my $non_issues_charges = $self->non_issues_charges
480 Calculates amount immediately owing by the patron - non-issue charges.
482 Charges exempt from non-issue are:
483 * Res (holds) if HoldsInNoissuesCharge syspref is set to false
484 * Rent (rental) if RentalsInNoissuesCharge syspref is set to false
485 * Manual invoices if ManInvInNoissuesCharge syspref is set to false
489 sub non_issues_charges {
492 # FIXME REMOVE And add a warning in the about page + update DB if length(MANUAL_INV) > 5
493 my $ACCOUNT_TYPE_LENGTH = 5; # this is plain ridiculous...
496 push @not_fines, 'Res'
497 unless C4::Context->preference('HoldsInNoissuesCharge');
498 push @not_fines, 'Rent'
499 unless C4::Context->preference('RentalsInNoissuesCharge');
500 unless ( C4::Context->preference('ManInvInNoissuesCharge') ) {
501 my $dbh = C4::Context->dbh;
504 $dbh->selectcol_arrayref(q|
505 SELECT authorised_value FROM authorised_values WHERE category = 'MANUAL_INV'
509 @not_fines = map { substr( $_, 0, $ACCOUNT_TYPE_LENGTH ) } uniq(@not_fines);
511 my $non_issues_charges = Koha::Account::Lines->search(
513 borrowernumber => $self->{patron_id},
514 accounttype => { -not_in => \@not_fines }
517 select => [ { sum => 'amountoutstanding' } ],
518 as => ['non_issues_charges'],
521 return $non_issues_charges->count
522 ? $non_issues_charges->next->get_column('non_issues_charges') + 0
535 'credit' => 'Manual Credit',
536 'forgiven' => 'Writeoff',
537 'lost_item_return' => 'Lost Item Return',
538 'payment' => 'Payment',
539 'writeoff' => 'Writeoff'
546 our $account_type = {
549 'lost_item_return' => 'CR',
556 Kyle M Hall <kyle.m.hall@gmail.com>