C4/Accounts.pm

   1 package C4::Accounts;
   2
   3 # Copyright 2000-2002 Katipo Communications
   4 #
   5 # This file is part of Koha.
   6 #
   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.
  11 #
  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.
  16 #
  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>.
  19
  20
  21 use strict;
  22 #use warnings; FIXME - Bug 2505
  23 use C4::Context;
  24 use C4::Stats;
  25 use C4::Members;
  26 use C4::Log qw(logaction);
  27 use Koha::Account;
  28 use Koha::Account::Lines;
  29 use Koha::Account::Offsets;
  30 use Koha::Items;
  31
  32 use Mojo::Util qw(deprecated);
  33 use Data::Dumper qw(Dumper);
  34
  35 use vars qw(@ISA @EXPORT);
  36
  37 BEGIN {
  38     require Exporter;
  39     @ISA    = qw(Exporter);
  40     @EXPORT = qw(
  41       &chargelostitem
  42       &purge_zero_balance_fees
  43     );
  44 }
  45
  46 =head1 NAME
  47
  48 C4::Accounts - Functions for dealing with Koha accounts
  49
  50 =head1 SYNOPSIS
  51
  52 use C4::Accounts;
  53
  54 =head1 DESCRIPTION
  55
  56 The functions in this module deal with the monetary aspect of Koha,
  57 including looking up and modifying the amount of money owed by a
  58 patron.
  59
  60 =head1 FUNCTIONS
  61
  62 =head2 chargelostitem
  63
  64 In a default install of Koha the following lost values are set
  65 1 = Lost
  66 2 = Long overdue
  67 3 = Lost and paid for
  68
  69 FIXME: itemlost should be set to 3 after payment is made, should be a warning to the interface that a charge has been added
  70 FIXME : if no replacement price, borrower just doesn't get charged?
  71
  72 =cut
  73
  74 sub chargelostitem {
  75     my $dbh = C4::Context->dbh();
  76     my ($borrowernumber, $itemnumber, $amount, $description) = @_;
  77     my $itype = Koha::ItemTypes->find({ itemtype => Koha::Items->find($itemnumber)->effective_itemtype() });
  78     my $replacementprice = $amount;
  79     my $defaultreplacecost = $itype->defaultreplacecost;
  80     my $processfee = $itype->processfee;
  81     my $usedefaultreplacementcost = C4::Context->preference("useDefaultReplacementCost");
  82     my $processingfeenote = C4::Context->preference("ProcessingFeeNote");
  83     if ($usedefaultreplacementcost && $amount == 0 && $defaultreplacecost){
  84         $replacementprice = $defaultreplacecost;
  85     }
  86     my $checkout = Koha::Checkouts->find({ itemnumber => $itemnumber });
  87     my $issue_id = $checkout ? $checkout->issue_id : undef;
  88
  89     my $account = Koha::Account->new({ patron_id => $borrowernumber });
  90     # first make sure the borrower hasn't already been charged for this item (for this issuance)
  91     my $existing_charges = $account->lines->search(
  92         {
  93             itemnumber      => $itemnumber,
  94             debit_type_code => 'LOST',
  95             issue_id        => $issue_id
  96         }
  97     )->count();
  98
  99     # OK, they haven't
 100     unless ($existing_charges) {
 101         #add processing fee
 102         if ($processfee && $processfee > 0){
 103             my $accountline = $account->add_debit(
 104                 {
 105                     amount      => $processfee,
 106                     description => $description,
 107                     note        => $processingfeenote,
 108                     user_id     => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
 109                     interface   => C4::Context->interface,
 110                     library_id  => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
 111                     type        => 'PROCESSING',
 112                     item_id     => $itemnumber,
 113                     issue_id    => $issue_id,
 114                 }
 115             );
 116         }
 117         #add replace cost
 118         if ($replacementprice > 0){
 119             my $accountline = $account->add_debit(
 120                 {
 121                     amount      => $replacementprice,
 122                     description => $description,
 123                     note        => undef,
 124                     user_id     => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
 125                     interface   => C4::Context->interface,
 126                     library_id  => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
 127                     type        => 'LOST',
 128                     item_id     => $itemnumber,
 129                     issue_id    => $issue_id,
 130                 }
 131             );
 132         }
 133     }
 134 }
 135
 136 =head2 manualinvoice
 137
 138   &manualinvoice($borrowernumber, $itemnumber, $description, $type,
 139                  $amount, $note);
 140
 141 This function is now deprecated and not used anywhere within koha. It is due for complete removal in 19.11
 142
 143 =cut
 144
 145 sub manualinvoice {
 146     my ( $borrowernumber, $itemnum, $desc, $type, $amount, $note ) = @_;
 147
 148     deprecated "C4::Accounts::manualinvoice is deprecated in favor of Koha::Account->add_debit";
 149
 150     my $manager_id = C4::Context->userenv ? C4::Context->userenv->{'number'} : undef;
 151     my $dbh      = C4::Context->dbh;
 152     my $insert;
 153     my $amountleft = $amount;
 154
 155     my $branchcode = C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
 156
 157     my $issue_id;
 158     if ( $type eq 'LOST' && $itemnum ) {
 159         my $checkouts = Koha::Checkouts->search(
 160             { itemnumber => $itemnum, borrowernumber => $borrowernumber } );
 161         my $checkout =
 162             $checkouts->count
 163           ? $checkouts->next
 164           : Koha::Old::Checkouts->search(
 165             { itemnumber => $itemnum, borrowernumber => $borrowernumber },
 166             { order_by   => { -desc => 'returndate' }, rows => 1 }
 167         )->next;
 168         $issue_id = $checkout ? $checkout->issue_id : undef;
 169     }
 170
 171     my $accountline = Koha::Account::Line->new(
 172         {
 173             borrowernumber    => $borrowernumber,
 174             date              => \'NOW()',
 175             amount            => $amount,
 176             description       => $desc,
 177             debit_type_code   => $type,
 178             amountoutstanding => $amountleft,
 179             itemnumber        => $itemnum || undef,
 180             issue_id          => $issue_id,
 181             note              => $note,
 182             manager_id        => $manager_id,
 183             interface         => C4::Context->interface,
 184             branchcode        => $branchcode,
 185         }
 186     )->store();
 187
 188     my $account_offset = Koha::Account::Offset->new(
 189         {
 190             debit_id => $accountline->id,
 191             type     => 'Manual Debit',
 192             amount   => $amount,
 193         }
 194     )->store();
 195
 196     if ( C4::Context->preference("FinesLog") ) {
 197         logaction("FINES", 'CREATE',$borrowernumber,Dumper({
 198             action            => 'create_fee',
 199             borrowernumber    => $borrowernumber,
 200             amount            => $amount,
 201             description       => $desc,
 202             debit_type_code   => $type,
 203             amountoutstanding => $amountleft,
 204             note              => $note,
 205             itemnumber        => $itemnum,
 206             manager_id        => $manager_id,
 207         }));
 208     }
 209
 210     return 0;
 211 }
 212
 213 =head2 purge_zero_balance_fees
 214
 215   purge_zero_balance_fees( $days );
 216
 217 Delete accountlines entries where amountoutstanding is 0 or NULL which are more than a given number of days old.
 218
 219 B<$days> -- Zero balance fees older than B<$days> days old will be deleted.
 220
 221 B<Warning:> Because fines and payments are not linked in accountlines, it is
 222 possible for a fine to be deleted without the accompanying payment,
 223 or vise versa. This won't affect the account balance, but might be
 224 confusing to staff.
 225
 226 =cut
 227
 228 sub purge_zero_balance_fees {
 229     my $days  = shift;
 230     my $count = 0;
 231
 232     my $dbh = C4::Context->dbh;
 233     my $sth = $dbh->prepare(
 234         q{
 235             DELETE a1 FROM accountlines a1
 236
 237             LEFT JOIN account_offsets credit_offset ON ( a1.accountlines_id = credit_offset.credit_id )
 238             LEFT JOIN accountlines a2 ON ( credit_offset.debit_id = a2.accountlines_id )
 239
 240             LEFT JOIN account_offsets debit_offset ON ( a1.accountlines_id = debit_offset.debit_id )
 241             LEFT JOIN accountlines a3 ON ( debit_offset.credit_id = a3.accountlines_id )
 242
 243             WHERE a1.date < date_sub(curdate(), INTERVAL ? DAY)
 244               AND ( a1.amountoutstanding = 0 OR a1.amountoutstanding IS NULL )
 245               AND ( a2.amountoutstanding = 0 OR a2.amountoutstanding IS NULL )
 246               AND ( a3.amountoutstanding = 0 OR a3.amountoutstanding IS NULL )
 247         }
 248     );
 249     $sth->execute($days) or die $dbh->errstr;
 250 }
 251
 252 END { }    # module clean-up code here (global destructor)
 253
 254 1;
 255 __END__
 256
 257 =head1 SEE ALSO
 258
 259 DBI(3)
 260
 261 =cut
 262