Koha/misc/cronjobs/reconcile_balances.pl
Tomas Cohen Arazi 3853014017 Bug 21915: Add a cli script to reconcile balances
This patch adds a CLI script, reconcile_balances.pl that takes care
of calling the reconcile operation for all patrons that have outstanding
credits.

A weird situation has been spotted in the wild, in which a debit ends up
actually being a credit, because amount outstanding is tweaked in
dropbox-mode returns. Until we figure what to do about that (probably a
new account type, etc), we catch any exceptions and warn about the
situation.

To test:
- Have patrons with outstanding credits and debits
- Run the script:
  $ kshell
 k$ perl misc/cronjobs/reconcile_balances.pl --verbose
=> SUCCESS: Notice patrons got their balances reconciled, and useful
            information is output.
- Add new outstanding credits and debits to patrons you con easily
identify
- Run:
 k$ perl misc/cronjobs/reconcile_balances.pl
=> SUCCESS: Notice balances are reconciled, but no output
- Run:
 k$ perl misc/cronjobs/reconcile_balances.pl --help
=> SUCCESS: Usage information is printed.
- Sign off :-D

Sponsored-by: ByWater Solutions
Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>

Signed-off-by: Nick Clemens <nick@bywatersolutions.com>
2019-01-04 03:13:41 +00:00

122 lines
2.8 KiB
Perl
Executable file

#!/usr/bin/perl
# Copyright 2018 Theke Solutions
#
# This file is part of Koha.
#
# Koha is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# Koha is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Koha; if not, see <http://www.gnu.org/licenses>.
=head1 NAME
reconcile_balances.pl - cron script to reconcile patron's balances
=head1 SYNOPSIS
./reconcile_balances.pl
or, in crontab:
0 1 * * * reconcile_balances.pl
=head1 DESCRIPTION
This script loops through patrons with outstanding credits and proceeds
to reconcile their balances.
=head1 OPTIONS
=over 8
=item B<--help>
Prints a brief help message and exits.
=item B<--verbose>
Makes the process print information about the taken actions.
=back
=cut
use Modern::Perl;
use Getopt::Long;
use Pod::Usage;
use Try::Tiny;
BEGIN {
# find Koha's Perl modules
# test carefully before changing this
use FindBin;
eval { require "$FindBin::Bin/../kohalib.pl" };
}
use C4::Log;
use Koha::Account::Lines;
use Koha::Patrons;
my $help = 0;
my $verbose = 0;
GetOptions(
'help' => \$help,
'verbose' => \$verbose
) or pod2usage(2);
pod2usage(1) if $help;
cronlogaction();
my @patron_ids = map { $_->borrowernumber } Koha::Account::Lines->search(
{
amountoutstanding => { '<' => 0 }
},
{
columns => [ qw/borrowernumber/ ],
distinct => 1,
}
);
my $patrons = Koha::Patrons->search({ borrowernumber => { -in => \@patron_ids } });
while (my $patron = $patrons->next) {
my $account = $patron->account;
my $total_outstanding_credit = $account->outstanding_credits->total_outstanding;
my $total_outstanding_debit = $account->outstanding_debits->total_outstanding;
if ( $total_outstanding_credit < 0
and $total_outstanding_debit > 0) {
try {
$account->reconcile_balance;
print $patron->id . ": credit: $total_outstanding_credit " .
"debit: $total_outstanding_debit " .
"=> outstanding " .
"credit: " . $account->outstanding_credits->total_outstanding .
" debit: " . $account->outstanding_debits->total_outstanding . "\n"
if $verbose;
}
catch {
print "Problem with patron " . $patron->borrowernumber . ": $_";
};
}
}
1;
__END__