1 package Koha
::REST
::V1
::Patrons
::Account
;
3 # This file is part of Koha.
5 # Koha is free software; you can redistribute it and/or modify it
6 # under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 3 of the License, or
8 # (at your option) any later version.
10 # Koha is distributed in the hope that it will be useful, but
11 # WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with Koha; if not, see <http://www.gnu.org/licenses>.
20 use Mojo
::Base
'Mojolicious::Controller';
24 use Scalar
::Util
qw(blessed);
29 Koha::REST::V1::Patrons::Account
37 Controller function that handles retrieving a patron's account balance
42 my $c = shift->openapi->valid_input or return;
44 my $patron_id = $c->validation->param('patron_id');
45 my $patron = Koha
::Patrons
->find($patron_id);
48 return $c->render( status
=> 404, openapi
=> { error
=> "Patron not found." } );
51 my $account = $patron->account;
53 # get outstanding debits and credits
54 my $debits = $account->outstanding_debits;
55 my $credits = $account->outstanding_credits;
60 balance
=> $account->balance,
61 outstanding_debits
=> {
62 total
=> $debits->total_outstanding,
63 lines
=> $debits->to_api
65 outstanding_credits
=> {
66 total
=> $credits->total_outstanding,
67 lines
=> $credits->to_api
75 Controller function that handles adding a credit to a patron's account
80 my $c = shift->openapi->valid_input or return;
82 my $patron_id = $c->validation->param('patron_id');
83 my $patron = Koha
::Patrons
->find($patron_id);
84 my $user = $c->stash('koha.user');
88 return $c->render( status
=> 404, openapi
=> { error
=> "Patron not found." } );
91 my $account = $patron->account;
92 my $body = $c->validation->param('body');
95 my $credit_type = $body->{credit_type
} || 'PAYMENT'; # default to 'PAYMENT'
96 my $amount = $body->{amount
}; # mandatory, validated by openapi
98 unless ( $amount > 0 ) { # until we support newer JSON::Validator and thus minimumExclusive
99 Koha
::Exceptions
::BadParameter
->throw( { parameter
=> 'amount' } );
102 # read the rest of the params
103 my $payment_type = $body->{payment_type
};
104 my $description = $body->{description
};
105 my $note = $body->{note
};
106 my $library_id = $body->{library_id
};
108 my $credit = $account->add_credit(
110 type
=> $credit_type,
111 payment_type
=> $payment_type,
112 description
=> $description,
114 user_id
=> $user->id,
116 library_id
=> $library_id
119 $credit->discard_changes;
121 my $date = $body->{date
};
122 $credit->date( $date )->store
125 my $debits_ids = $body->{account_lines_ids
};
127 $debits = Koha
::Account
::Lines
->search({ accountlines_id
=> { -in => $debits_ids } })
130 my $outstanding_credit = $credit->amountoutstanding;
133 $outstanding_credit = $credit->apply({ debits
=> [ $debits->as_list ], offset_type
=> 'payment' })->{outstanding_amount
};
136 if ($outstanding_credit) {
137 my $outstanding_debits = $account->outstanding_debits;
138 $credit->apply({ debits
=> [ $outstanding_debits->as_list ], offset_type
=> 'payment' });
141 return $c->render( status
=> 200, openapi
=> { account_line_id
=> $credit->id } );
144 if ( blessed
$_ && $_->can('rethrow') ) {
147 openapi
=> { error
=> "$_" }
151 # Exception, rely on the stringified exception
154 openapi
=> { error
=> "Something went wrong, check the logs" }