3 # Copyright 2018 Koha Development team
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 Test::More tests => 11;
28 use C4::Circulation qw/AddIssue AddReturn/;
30 use Koha::Account::Lines;
31 use Koha::Account::Offsets;
33 use Koha::DateUtils qw( dt_from_string );
36 use t::lib::TestBuilder;
38 my $schema = Koha::Database->new->schema;
39 my $builder = t::lib::TestBuilder->new;
41 subtest 'patron() tests' => sub {
45 $schema->storage->txn_begin;
47 my $library = $builder->build( { source => 'Branch' } );
48 my $patron = $builder->build( { source => 'Borrower' } );
50 my $line = Koha::Account::Line->new(
52 borrowernumber => $patron->{borrowernumber},
53 debit_type_code => "OVERDUE",
56 interface => 'commandline',
59 my $account_line_patron = $line->patron;
60 is( ref( $account_line_patron ), 'Koha::Patron', 'Koha::Account::Line->patron should return a Koha::Patron' );
61 is( $line->borrowernumber, $account_line_patron->borrowernumber, 'Koha::Account::Line->patron should return the correct borrower' );
63 $line->borrowernumber(undef)->store;
64 is( $line->patron, undef, 'Koha::Account::Line->patron should return undef if no patron linked' );
66 $schema->storage->txn_rollback;
69 subtest 'item() tests' => sub {
73 $schema->storage->txn_begin;
75 my $library = $builder->build( { source => 'Branch' } );
76 my $biblioitem = $builder->build( { source => 'Biblioitem' } );
77 my $patron = $builder->build( { source => 'Borrower' } );
78 my $item = Koha::Item->new(
80 biblionumber => $biblioitem->{biblionumber},
81 biblioitemnumber => $biblioitem->{biblioitemnumber},
82 homebranch => $library->{branchcode},
83 holdingbranch => $library->{branchcode},
84 barcode => 'some_barcode_12',
88 my $line = Koha::Account::Line->new(
90 borrowernumber => $patron->{borrowernumber},
91 itemnumber => $item->itemnumber,
92 debit_type_code => "OVERDUE",
95 interface => 'commandline',
98 my $account_line_item = $line->item;
99 is( ref( $account_line_item ), 'Koha::Item', 'Koha::Account::Line->item should return a Koha::Item' );
100 is( $line->itemnumber, $account_line_item->itemnumber, 'Koha::Account::Line->item should return the correct item' );
102 $line->itemnumber(undef)->store;
103 is( $line->item, undef, 'Koha::Account::Line->item should return undef if no item linked' );
105 $schema->storage->txn_rollback;
108 subtest 'is_credit() and is_debit() tests' => sub {
112 $schema->storage->txn_begin;
114 my $patron = $builder->build_object({ class => 'Koha::Patrons' });
115 my $account = $patron->account;
117 my $credit = $account->add_credit({ amount => 100, user_id => $patron->id, interface => 'commandline' });
119 ok( $credit->is_credit, 'is_credit detects credits' );
120 ok( !$credit->is_debit, 'is_debit detects credits' );
122 my $debit = Koha::Account::Line->new(
124 borrowernumber => $patron->id,
125 debit_type_code => "OVERDUE",
126 status => "RETURNED",
128 interface => 'commandline',
131 ok( !$debit->is_credit, 'is_credit detects debits' );
132 ok( $debit->is_debit, 'is_debit detects debits');
134 $schema->storage->txn_rollback;
137 subtest 'apply() tests' => sub {
141 $schema->storage->txn_begin;
143 my $patron = $builder->build_object( { class => 'Koha::Patrons' } );
144 my $account = $patron->account;
146 my $credit = $account->add_credit( { amount => 100, user_id => $patron->id, interface => 'commandline' } );
148 my $debit_1 = Koha::Account::Line->new(
149 { borrowernumber => $patron->id,
150 debit_type_code => "OVERDUE",
151 status => "RETURNED",
153 amountoutstanding => 10,
154 interface => 'commandline',
158 my $debit_2 = Koha::Account::Line->new(
159 { borrowernumber => $patron->id,
160 debit_type_code => "OVERDUE",
161 status => "RETURNED",
163 amountoutstanding => 100,
164 interface => 'commandline',
168 $credit->discard_changes;
169 $debit_1->discard_changes;
171 my $debits = Koha::Account::Lines->search({ accountlines_id => $debit_1->id });
172 my $remaining_credit = $credit->apply( { debits => [ $debits->as_list ], offset_type => 'Manual Credit' } );
173 is( $remaining_credit * 1, 90, 'Remaining credit is correctly calculated' );
174 $credit->discard_changes;
175 is( $credit->amountoutstanding * -1, $remaining_credit, 'Remaining credit correctly stored' );
178 $debit_1->discard_changes;
179 is( $debit_1->amountoutstanding * 1, 0, 'Debit has been cancelled' );
181 my $offsets = Koha::Account::Offsets->search( { credit_id => $credit->id, debit_id => $debit_1->id } );
182 is( $offsets->count, 1, 'Only one offset is generated' );
183 my $THE_offset = $offsets->next;
184 is( $THE_offset->amount * 1, -10, 'Amount was calculated correctly (less than the available credit)' );
185 is( $THE_offset->type, 'Manual Credit', 'Passed type stored correctly' );
187 $debits = Koha::Account::Lines->search({ accountlines_id => $debit_2->id });
188 $remaining_credit = $credit->apply( { debits => [ $debits->as_list ] } );
189 is( $remaining_credit, 0, 'No remaining credit left' );
190 $credit->discard_changes;
191 is( $credit->amountoutstanding * 1, 0, 'No outstanding credit' );
192 $debit_2->discard_changes;
193 is( $debit_2->amountoutstanding * 1, 10, 'Outstanding amount decremented correctly' );
195 $offsets = Koha::Account::Offsets->search( { credit_id => $credit->id, debit_id => $debit_2->id } );
196 is( $offsets->count, 1, 'Only one offset is generated' );
197 $THE_offset = $offsets->next;
198 is( $THE_offset->amount * 1, -90, 'Amount was calculated correctly (less than the available credit)' );
199 is( $THE_offset->type, 'Credit Applied', 'Defaults to \'Credit Applied\' offset type' );
201 $debits = Koha::Account::Lines->search({ accountlines_id => $debit_1->id });
203 { $credit->apply({ debits => [ $debits->as_list ] }); }
204 'Koha::Exceptions::Account::NoAvailableCredit',
205 '->apply() can only be used with outstanding credits';
207 $debits = Koha::Account::Lines->search({ accountlines_id => $credit->id });
209 { $debit_1->apply({ debits => [ $debits->as_list ] }); }
210 'Koha::Exceptions::Account::IsNotCredit',
211 '->apply() can only be used with credits';
213 $debits = Koha::Account::Lines->search({ accountlines_id => $credit->id });
214 my $credit_3 = $account->add_credit({ amount => 1, interface => 'commandline' });
216 { $credit_3->apply({ debits => [ $debits->as_list ] }); }
217 'Koha::Exceptions::Account::IsNotDebit',
218 '->apply() can only be applied to credits';
220 my $credit_2 = $account->add_credit({ amount => 20, interface => 'commandline' });
221 my $debit_3 = Koha::Account::Line->new(
222 { borrowernumber => $patron->id,
223 debit_type_code => "OVERDUE",
224 status => "RETURNED",
226 amountoutstanding => 100,
227 interface => 'commandline',
231 $debits = Koha::Account::Lines->search({ accountlines_id => { -in => [ $debit_1->id, $debit_2->id, $debit_3->id, $credit->id ] } });
233 $credit_2->apply( { debits => [ $debits->as_list ], offset_type => 'Manual Credit' } ); }
234 'Koha::Exceptions::Account::IsNotDebit',
235 '->apply() rolls back if any of the passed lines is not a debit';
237 is( $debit_1->discard_changes->amountoutstanding * 1, 0, 'No changes to already cancelled debit' );
238 is( $debit_2->discard_changes->amountoutstanding * 1, 10, 'Debit cancelled' );
239 is( $debit_3->discard_changes->amountoutstanding * 1, 100, 'Outstanding amount correctly calculated' );
240 is( $credit_2->discard_changes->amountoutstanding * -1, 20, 'No changes made' );
242 $debits = Koha::Account::Lines->search({ accountlines_id => { -in => [ $debit_1->id, $debit_2->id, $debit_3->id ] } });
243 $remaining_credit = $credit_2->apply( { debits => [ $debits->as_list ], offset_type => 'Manual Credit' } );
245 is( $debit_1->discard_changes->amountoutstanding * 1, 0, 'No changes to already cancelled debit' );
246 is( $debit_2->discard_changes->amountoutstanding * 1, 0, 'Debit cancelled' );
247 is( $debit_3->discard_changes->amountoutstanding * 1, 90, 'Outstanding amount correctly calculated' );
248 is( $credit_2->discard_changes->amountoutstanding * 1, 0, 'No remaining credit' );
250 my $library = $builder->build_object( { class => 'Koha::Libraries' } );
251 my $biblio = $builder->build_sample_biblio();
253 $builder->build_sample_item( { biblionumber => $biblio->biblionumber } );
254 my $now = dt_from_string();
255 my $seven_weeks = DateTime::Duration->new(weeks => 7);
256 my $five_weeks = DateTime::Duration->new(weeks => 5);
257 my $seven_weeks_ago = $now - $seven_weeks;
258 my $five_weeks_ago = $now - $five_weeks;
260 my $checkout = Koha::Checkout->new(
262 borrowernumber => $patron->id,
263 itemnumber => $item->id,
264 date_due => $five_weeks_ago,
265 branchcode => $library->id,
266 issuedate => $seven_weeks_ago
270 my $accountline = Koha::Account::Line->new(
272 issue_id => $checkout->id,
273 borrowernumber => $patron->id,
274 itemnumber => $item->id,
275 branchcode => $library->id,
277 accounttype => 'OVERDUE',
278 status => 'UNRETURNED',
281 amountoutstanding => '1',
285 # Enable renewing upon fine payment
286 t::lib::Mocks::mock_preference( 'RenewAccruingItemWhenPaid', 1 );
288 my $module = new Test::MockModule('C4::Circulation');
289 $module->mock('AddRenewal', sub { $called = 1; });
290 my $credit_renew = $account->add_credit({ amount => 100, user_id => $patron->id, interface => 'commandline' });
291 my $debits_renew = Koha::Account::Lines->search({ accountlines_id => $accountline->id });
292 $credit_renew->apply( { debits => $debits_renew, offset_type => 'Manual Credit' } );
294 is( $called, 1, 'RenewAccruingItemWhenPaid causes C4::Circulation::AddRenew to be called when appropriate' );
296 $schema->storage->txn_rollback;
299 subtest 'Keep account info when related patron, staff, item or cash_register is deleted' => sub {
303 $schema->storage->txn_begin;
305 my $patron = $builder->build_object( { class => 'Koha::Patrons' } );
306 my $staff = $builder->build_object( { class => 'Koha::Patrons' } );
307 my $item = $builder->build_object({ class => 'Koha::Items' });
308 my $issue = $builder->build_object(
310 class => 'Koha::Checkouts',
311 value => { itemnumber => $item->itemnumber }
314 my $register = $builder->build_object({ class => 'Koha::Cash::Registers' });
316 my $line = Koha::Account::Line->new(
318 borrowernumber => $patron->borrowernumber,
319 manager_id => $staff->borrowernumber,
320 itemnumber => $item->itemnumber,
321 debit_type_code => "OVERDUE",
322 status => "RETURNED",
324 interface => 'commandline',
325 register_id => $register->id
330 $line = $line->get_from_storage;
331 is( $line->itemnumber, undef, "The account line should not be deleted when the related item is delete");
334 $line = $line->get_from_storage;
335 is( $line->manager_id, undef, "The account line should not be deleted when the related staff is delete");
338 $line = $line->get_from_storage;
339 is( $line->borro1wernumber, undef, "The account line should not be deleted when the related patron is delete");
342 $line = $line->get_from_storage;
343 is( $line->register_id, undef, "The account line should not be deleted when the related cash register is delete");
345 $schema->storage->txn_rollback;
348 subtest 'adjust() tests' => sub {
352 $schema->storage->txn_begin;
354 # count logs before any actions
355 my $action_logs = $schema->resultset('ActionLog')->search()->count;
358 t::lib::Mocks::mock_preference( 'FinesLog', 0 );
360 my $patron = $builder->build_object( { class => 'Koha::Patrons' } );
361 my $account = $patron->account;
363 my $debit_1 = Koha::Account::Line->new(
364 { borrowernumber => $patron->id,
365 debit_type_code => "OVERDUE",
366 status => "RETURNED",
368 amountoutstanding => 10,
369 interface => 'commandline',
373 my $debit_2 = Koha::Account::Line->new(
374 { borrowernumber => $patron->id,
375 debit_type_code => "OVERDUE",
376 status => "UNRETURNED",
378 amountoutstanding => 100,
379 interface => 'commandline'
383 my $credit = $account->add_credit( { amount => 40, user_id => $patron->id, interface => 'commandline' } );
385 throws_ok { $debit_1->adjust( { amount => 50, type => 'bad', interface => 'commandline' } ) }
386 qr/Update type not recognised/, 'Exception thrown for unrecognised type';
388 throws_ok { $debit_1->adjust( { amount => 50, type => 'overdue_update', interface => 'commandline' } ) }
389 qr/Update type not allowed on this debit_type/,
390 'Exception thrown for type conflict';
392 # Increment an unpaid fine
393 $debit_2->adjust( { amount => 150, type => 'overdue_update', interface => 'commandline' } )->discard_changes;
395 is( $debit_2->amount * 1, 150, 'Fine amount was updated in full' );
396 is( $debit_2->amountoutstanding * 1, 150, 'Fine amountoutstanding was update in full' );
397 isnt( $debit_2->date, undef, 'Date has been set' );
399 my $offsets = Koha::Account::Offsets->search( { debit_id => $debit_2->id } );
400 is( $offsets->count, 1, 'An offset is generated for the increment' );
401 my $THIS_offset = $offsets->next;
402 is( $THIS_offset->amount * 1, 50, 'Amount was calculated correctly (increment by 50)' );
403 is( $THIS_offset->type, 'OVERDUE_INCREASE', 'Adjust type stored correctly' );
405 is( $schema->resultset('ActionLog')->count(), $action_logs + 0, 'No log was added' );
407 # Update fine to partially paid
408 my $debits = Koha::Account::Lines->search({ accountlines_id => $debit_2->id });
409 $credit->apply( { debits => [ $debits->as_list ], offset_type => 'Manual Credit' } );
411 $debit_2->discard_changes;
412 is( $debit_2->amount * 1, 150, 'Fine amount unaffected by partial payment' );
413 is( $debit_2->amountoutstanding * 1, 110, 'Fine amountoutstanding updated by partial payment' );
416 t::lib::Mocks::mock_preference( 'FinesLog', 1 );
418 # Increment the partially paid fine
419 $debit_2->adjust( { amount => 160, type => 'overdue_update', interface => 'commandline' } )->discard_changes;
421 is( $debit_2->amount * 1, 160, 'Fine amount was updated in full' );
422 is( $debit_2->amountoutstanding * 1, 120, 'Fine amountoutstanding was updated by difference' );
424 $offsets = Koha::Account::Offsets->search( { debit_id => $debit_2->id } );
425 is( $offsets->count, 3, 'An offset is generated for the increment' );
426 $THIS_offset = $offsets->last;
427 is( $THIS_offset->amount * 1, 10, 'Amount was calculated correctly (increment by 10)' );
428 is( $THIS_offset->type, 'OVERDUE_INCREASE', 'Adjust type stored correctly' );
430 is( $schema->resultset('ActionLog')->count(), $action_logs + 1, 'Log was added' );
432 # Decrement the partially paid fine, less than what was paid
433 $debit_2->adjust( { amount => 50, type => 'overdue_update', interface => 'commandline' } )->discard_changes;
435 is( $debit_2->amount * 1, 50, 'Fine amount was updated in full' );
436 is( $debit_2->amountoutstanding * 1, 10, 'Fine amountoutstanding was updated by difference' );
438 $offsets = Koha::Account::Offsets->search( { debit_id => $debit_2->id } );
439 is( $offsets->count, 4, 'An offset is generated for the decrement' );
440 $THIS_offset = $offsets->last;
441 is( $THIS_offset->amount * 1, -110, 'Amount was calculated correctly (decrement by 110)' );
442 is( $THIS_offset->type, 'OVERDUE_DECREASE', 'Adjust type stored correctly' );
444 # Decrement the partially paid fine, more than what was paid
445 $debit_2->adjust( { amount => 30, type => 'overdue_update', interface => 'commandline' } )->discard_changes;
446 is( $debit_2->amount * 1, 30, 'Fine amount was updated in full' );
447 is( $debit_2->amountoutstanding * 1, 0, 'Fine amountoutstanding was zeroed (payment was 40)' );
449 $offsets = Koha::Account::Offsets->search( { debit_id => $debit_2->id } );
450 is( $offsets->count, 5, 'An offset is generated for the decrement' );
451 $THIS_offset = $offsets->last;
452 is( $THIS_offset->amount * 1, -20, 'Amount was calculated correctly (decrement by 20)' );
453 is( $THIS_offset->type, 'OVERDUE_DECREASE', 'Adjust type stored correctly' );
455 my $overpayment_refund = $account->lines->last;
456 is( $overpayment_refund->amount * 1, -10, 'A new credit has been added' );
457 is( $overpayment_refund->description, 'Overpayment refund', 'Credit generated with the expected description' );
459 $schema->storage->txn_rollback;
462 subtest 'checkout() tests' => sub {
465 $schema->storage->txn_begin;
467 my $library = $builder->build_object( { class => 'Koha::Libraries' } );
468 my $patron = $builder->build_object( { class => 'Koha::Patrons' } );
469 my $item = $builder->build_sample_item;
470 my $account = $patron->account;
472 t::lib::Mocks::mock_userenv({ branchcode => $library->branchcode });
473 my $checkout = AddIssue( $patron->unblessed, $item->barcode );
475 my $line = $account->add_debit({
477 interface => 'commandline',
478 item_id => $item->itemnumber,
479 issue_id => $checkout->issue_id,
483 my $line_checkout = $line->checkout;
484 is( ref($line_checkout), 'Koha::Checkout', 'Result type is correct' );
485 is( $line_checkout->issue_id, $checkout->issue_id, 'Koha::Account::Line->checkout should return the correct checkout');
487 my ( $returned, undef, $old_checkout) = C4::Circulation::AddReturn( $item->barcode, $library->branchcode );
488 is( $returned, 1, 'The item should have been returned' );
490 $line = $line->get_from_storage;
491 my $old_line_checkout = $line->checkout;
492 is( ref($old_line_checkout), 'Koha::Old::Checkout', 'Result type is correct' );
493 is( $old_line_checkout->issue_id, $old_checkout->issue_id, 'Koha::Account::Line->checkout should return the correct old_checkout' );
495 $line->issue_id(undef)->store;
496 is( $line->checkout, undef, 'Koha::Account::Line->checkout should return undef if no checkout linked' );
498 $schema->storage->txn_rollback;
501 subtest 'credits() and debits() tests' => sub {
504 $schema->storage->txn_begin;
506 my $patron = $builder->build_object( { class => 'Koha::Patrons' } );
507 my $account = $patron->account;
509 my $debit1 = $account->add_debit({
511 interface => 'commandline',
514 my $debit2 = $account->add_debit({
516 interface => 'commandline',
519 my $credit1 = $account->add_credit({
521 interface => 'commandline',
524 my $credit2 = $account->add_credit({
526 interface => 'commandline',
530 $credit1->apply({ debits => [ $debit1 ] });
531 $credit2->apply({ debits => [ $debit1, $debit2 ] });
533 my $credits = $debit1->credits;
534 is($credits->count, 2, '2 Credits applied to debit 1');
535 my $credit = $credits->next;
536 is($credit->amount + 0, -5, 'Correct first credit');
537 $credit = $credits->next;
538 is($credit->amount + 0, -10, 'Correct second credit');
540 $credits = $debit2->credits;
541 is($credits->count, 1, '1 Credits applied to debit 2');
542 $credit = $credits->next;
543 is($credit->amount + 0, -10, 'Correct first credit');
545 my $debits = $credit1->debits;
546 is($debits->count, 1, 'Credit 1 applied to 1 debit');
547 my $debit = $debits->next;
548 is($debit->amount + 0, 8, 'Correct first debit');
550 $debits = $credit2->debits;
551 is($debits->count, 2, 'Credit 2 applied to 2 debits');
552 $debit = $debits->next;
553 is($debit->amount + 0, 8, 'Correct first debit');
554 $debit = $debits->next;
555 is($debit->amount + 0, 12, 'Correct second debit');
557 $schema->storage->txn_rollback;
560 subtest "void() tests" => sub {
564 $schema->storage->txn_begin;
567 my $categorycode = $builder->build({ source => 'Category' })->{ categorycode };
568 my $branchcode = $builder->build({ source => 'Branch' })->{ branchcode };
570 my $borrower = Koha::Patron->new( {
571 cardnumber => 'dariahall',
573 firstname => 'Daria',
575 $borrower->categorycode( $categorycode );
576 $borrower->branchcode( $branchcode );
579 my $account = Koha::Account->new({ patron_id => $borrower->id });
581 my $line1 = Koha::Account::Line->new(
583 borrowernumber => $borrower->borrowernumber,
585 amountoutstanding => 10,
586 interface => 'commandline',
587 debit_type_code => 'OVERDUE'
590 my $line2 = Koha::Account::Line->new(
592 borrowernumber => $borrower->borrowernumber,
594 amountoutstanding => 20,
595 interface => 'commandline',
596 debit_type_code => 'OVERDUE'
600 is( $account->balance(), 30, "Account balance is 30" );
601 is( $line1->amountoutstanding, 10, 'First fee has amount outstanding of 10' );
602 is( $line2->amountoutstanding, 20, 'Second fee has amount outstanding of 20' );
604 my $id = $account->pay(
606 lines => [$line1, $line2],
611 my $account_payment = Koha::Account::Lines->find( $id );
613 is( $account->balance(), 0, "Account balance is 0" );
615 $line1->_result->discard_changes();
616 $line2->_result->discard_changes();
617 is( $line1->amountoutstanding+0, 0, 'First fee has amount outstanding of 0' );
618 is( $line2->amountoutstanding+0, 0, 'Second fee has amount outstanding of 0' );
620 my $ret = $account_payment->void();
622 is( ref($ret), 'Koha::Account::Line', 'Void returns the account line' );
623 is( $account->balance(), 30, "Account balance is again 30" );
625 $account_payment->_result->discard_changes();
626 $line1->_result->discard_changes();
627 $line2->_result->discard_changes();
629 is( $account_payment->credit_type_code, 'PAYMENT', 'Voided payment credit_type_code is still PAYMENT' );
630 is( $account_payment->status, 'VOID', 'Voided payment status is VOID' );
631 is( $account_payment->amount+0, 0, 'Voided payment amount is 0' );
632 is( $account_payment->amountoutstanding+0, 0, 'Voided payment amount outstanding is 0' );
634 is( $line1->amountoutstanding+0, 10, 'First fee again has amount outstanding of 10' );
635 is( $line2->amountoutstanding+0, 20, 'Second fee again has amount outstanding of 20' );
637 # Accountlines that are not credits should be un-voidable
638 my $line1_pre = $line1->unblessed();
639 $ret = $line1->void();
640 $line1->_result->discard_changes();
641 my $line1_post = $line1->unblessed();
642 is( $ret, undef, 'Attempted void on non-credit returns undef' );
643 is_deeply( $line1_pre, $line1_post, 'Non-credit account line cannot be voided' );
645 $schema->storage->txn_rollback;
648 subtest "payout() tests" => sub {
652 $schema->storage->txn_begin;
656 $builder->build( { source => 'Category' } )->{categorycode};
657 my $branchcode = $builder->build( { source => 'Branch' } )->{branchcode};
659 my $borrower = Koha::Patron->new(
661 cardnumber => 'dariahall',
663 firstname => 'Daria',
666 $borrower->categorycode($categorycode);
667 $borrower->branchcode($branchcode);
670 my $staff = Koha::Patron->new(
672 cardnumber => 'bobby',
674 firstname => 'Bobby',
677 $staff->categorycode($categorycode);
678 $staff->branchcode($branchcode);
681 my $account = Koha::Account->new( { patron_id => $borrower->id } );
683 my $debit1 = Koha::Account::Line->new(
685 borrowernumber => $borrower->borrowernumber,
687 amountoutstanding => 10,
688 interface => 'commandline',
689 debit_type_code => 'OVERDUE'
692 my $credit1 = Koha::Account::Line->new(
694 borrowernumber => $borrower->borrowernumber,
696 amountoutstanding => -20,
697 interface => 'commandline',
698 credit_type_code => 'CREDIT'
702 is( $account->balance(), -10, "Account balance is -10" );
703 is( $debit1->amountoutstanding + 0,
704 10, 'Overdue fee has an amount outstanding of 10' );
705 is( $credit1->amountoutstanding + 0,
706 -20, 'Credit has an amount outstanding of -20' );
709 interface => 'intranet',
710 staff_id => $staff->borrowernumber,
711 branch => $branchcode,
712 payout_type => 'CASH',
716 throws_ok { $debit1->payout($pay_params); }
717 'Koha::Exceptions::Account::IsNotCredit',
718 '->payout() can only be used with credits';
721 ( 'interface', 'staff_id', 'branch', 'payout_type', 'amount' );
722 for my $required (@required) {
723 my $params = {%$pay_params};
724 delete( $params->{$required} );
726 $credit1->payout($params);
728 'Koha::Exceptions::MissingParameter',
729 "->payout() requires the `$required` parameter is passed";
735 interface => 'intranet',
736 staff_id => $staff->borrowernumber,
737 branch => $branchcode,
738 payout_type => 'CASH',
743 'Koha::Exceptions::ParameterTooHigh',
744 '->payout() cannot pay out more than the amountoutstanding';
746 t::lib::Mocks::mock_preference( 'UseCashRegisters', 1 );
750 interface => 'intranet',
751 staff_id => $staff->borrowernumber,
752 branch => $branchcode,
753 payout_type => 'CASH',
758 'Koha::Exceptions::Account::RegisterRequired',
759 '->payout() requires a cash_register if payout_type is `CASH`';
761 t::lib::Mocks::mock_preference( 'UseCashRegisters', 0 );
762 my $payout = $credit1->payout(
764 interface => 'intranet',
765 staff_id => $staff->borrowernumber,
766 branch => $branchcode,
767 payout_type => 'CASH',
772 is( ref($payout), 'Koha::Account::Line',
773 '->payout() returns a Koha::Account::Line' );
774 is( $payout->amount() + 0, 10, "Payout amount is 10" );
775 is( $payout->amountoutstanding() + 0, 0, "Payout amountoutstanding is 0" );
776 is( $account->balance() + 0, 0, "Account balance is 0" );
777 is( $debit1->amountoutstanding + 0,
778 10, 'Overdue fee still has an amount outstanding of 10' );
779 is( $credit1->amountoutstanding + 0,
780 -10, 'Credit has an new amount outstanding of -10' );
781 is( $credit1->status(), 'PAID', "Credit has a new status of PAID" );
783 $schema->storage->txn_rollback;
786 subtest "reduce() tests" => sub {
790 $schema->storage->txn_begin;
794 $builder->build( { source => 'Category' } )->{categorycode};
795 my $branchcode = $builder->build( { source => 'Branch' } )->{branchcode};
797 my $borrower = Koha::Patron->new(
799 cardnumber => 'dariahall',
801 firstname => 'Daria',
804 $borrower->categorycode($categorycode);
805 $borrower->branchcode($branchcode);
808 my $staff = Koha::Patron->new(
810 cardnumber => 'bobby',
812 firstname => 'Bobby',
815 $staff->categorycode($categorycode);
816 $staff->branchcode($branchcode);
819 my $account = Koha::Account->new( { patron_id => $borrower->id } );
821 my $debit1 = Koha::Account::Line->new(
823 borrowernumber => $borrower->borrowernumber,
825 amountoutstanding => 20,
826 interface => 'commandline',
827 debit_type_code => 'LOST'
830 my $credit1 = Koha::Account::Line->new(
832 borrowernumber => $borrower->borrowernumber,
834 amountoutstanding => -20,
835 interface => 'commandline',
836 credit_type_code => 'CREDIT'
840 is( $account->balance(), 0, "Account balance is 0" );
841 is( $debit1->amountoutstanding,
842 20, 'Overdue fee has an amount outstanding of 20' );
843 is( $credit1->amountoutstanding,
844 -20, 'Credit has an amount outstanding of -20' );
846 my $reduce_params = {
847 interface => 'commandline',
848 reduction_type => 'REFUND',
850 staff_id => $staff->borrowernumber,
851 branch => $branchcode
854 throws_ok { $credit1->reduce($reduce_params); }
855 'Koha::Exceptions::Account::IsNotDebit',
856 '->reduce() can only be used with debits';
858 my @required = ( 'interface', 'reduction_type', 'amount' );
859 for my $required (@required) {
860 my $params = {%$reduce_params};
861 delete( $params->{$required} );
863 $debit1->reduce($params);
865 'Koha::Exceptions::MissingParameter',
866 "->reduce() requires the `$required` parameter is passed";
869 $reduce_params->{interface} = 'intranet';
870 my @dependant_required = ( 'staff_id', 'branch' );
871 for my $d (@dependant_required) {
872 my $params = {%$reduce_params};
873 delete( $params->{$d} );
875 $debit1->reduce($params);
877 'Koha::Exceptions::MissingParameter',
878 "->reduce() requires the `$d` parameter is passed when interface is intranet";
884 interface => 'intranet',
885 staff_id => $staff->borrowernumber,
886 branch => $branchcode,
887 reduction_type => 'REFUND',
892 'Koha::Exceptions::ParameterTooHigh',
893 '->reduce() cannot reduce more than original amount';
896 # (Refund 5 on debt of 20)
897 my $reduction = $debit1->reduce($reduce_params);
899 is( ref($reduction), 'Koha::Account::Line',
900 '->reduce() returns a Koha::Account::Line' );
901 is( $reduction->amount() * 1, -5, "Reduce amount is -5" );
902 is( $reduction->amountoutstanding() * 1,
903 0, "Reduce amountoutstanding is 0" );
904 is( $debit1->amountoutstanding() * 1,
905 15, "Debit amountoutstanding reduced by 5 to 15" );
906 is( $account->balance() * 1, -5, "Account balance is -5" );
907 is( $reduction->status(), 'APPLIED', "Reduction status is 'APPLIED'" );
909 my $offsets = Koha::Account::Offsets->search(
910 { credit_id => $reduction->id, debit_id => $debit1->id } );
911 is( $offsets->count, 1, 'Only one offset is generated' );
912 my $THE_offset = $offsets->next;
913 is( $THE_offset->amount * 1,
914 -5, 'Correct amount was applied against debit' );
915 is( $THE_offset->type, 'REFUND', "Offset type set to 'REFUND'" );
917 # Zero offset created when zero outstanding
918 # (Refund another 5 on paid debt of 20)
919 $credit1->apply( { debits => [$debit1] } );
920 is( $debit1->amountoutstanding + 0,
921 0, 'Debit1 amountoutstanding reduced to 0' );
922 $reduction = $debit1->reduce($reduce_params);
923 is( $reduction->amount() * 1, -5, "Reduce amount is -5" );
924 is( $reduction->amountoutstanding() * 1,
925 -5, "Reduce amountoutstanding is -5" );
927 $offsets = Koha::Account::Offsets->search(
928 { credit_id => $reduction->id, debit_id => $debit1->id } );
929 is( $offsets->count, 1, 'Only one new offset is generated' );
930 $THE_offset = $offsets->next;
931 is( $THE_offset->amount * 1,
932 0, 'Zero offset created for already paid off debit' );
933 is( $THE_offset->type, 'REFUND', "Offset type set to 'REFUND'" );
935 # Compound reduction should not allow more than original amount
936 # (Reduction of 5 + 5 + 20 > 20)
937 $reduce_params->{amount} = 20;
939 $debit1->reduce($reduce_params);
941 'Koha::Exceptions::ParameterTooHigh',
942 '->reduce cannot reduce more than the original amount (combined reductions test)';
944 # Throw exception if attempting to reduce a payout
945 my $payout = $reduction->payout(
947 interface => 'intranet',
948 staff_id => $staff->borrowernumber,
949 branch => $branchcode,
950 payout_type => 'CASH',
955 $payout->reduce($reduce_params);
957 'Koha::Exceptions::Account::IsNotDebit',
958 '->reduce() cannot be used on a payout debit';
960 $schema->storage->txn_rollback;