1 # ---------------------------------------------------------------
2 # Copyright (C) 2005 Georgia Public Library Service
3 # Bill Erickson <billserickson@gmail.com>
5 # This program is free software; you can redistribute it and/or
6 # modify it under the terms of the GNU General Public License
7 # as published by the Free Software Foundation; either version 2
8 # of the License, or (at your option) any later version.
10 # This program is distributed in the hope that it will be useful,
11 # but 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.
14 # ---------------------------------------------------------------
17 package OpenILS::Application::Circ::Money;
18 use base qw/OpenSRF::Application/;
19 use strict; use warnings;
20 use OpenILS::Application::AppUtils;
21 my $apputils = "OpenILS::Application::AppUtils";
22 my $U = "OpenILS::Application::AppUtils";
24 use OpenSRF::EX qw(:try);
28 use OpenSRF::Utils::Logger qw/:logger/;
29 use OpenILS::Utils::Editor qw/:funcs/;
31 __PACKAGE__->register_method(
32 method => "make_payments",
33 api_name => "open-ils.circ.money.payment",
35 Pass in a structure like so:
37 cash_drawer: <string>,
38 payment_type : <string>,
45 patron_credit : <credit amt>
47 login must have CREATE_PAYMENT priveleges.
48 If any payments fail, all are reverted back.
53 my( $self, $client, $login, $payments ) = @_;
55 my( $user, $trans, $evt );
57 ( $user, $evt ) = $apputils->checkses($login);
59 $evt = $apputils->check_perms($user->id, $user->ws_ou, 'CREATE_PAYMENT');
62 $logger->info("Creating payment objects: " . Dumper($payments) );
64 my $session = $apputils->start_db_session;
65 my $type = $payments->{payment_type};
66 my $credit = $payments->{patron_credit} || 0;
67 my $drawer = $user->wsid;
68 my $userid = $payments->{userid};
69 my $note = $payments->{note};
70 my $cc_type = $payments->{cc_type} || 'n/a';
71 my $cc_number = $payments->{cc_number} || 'n/a';
72 my $expire_month = $payments->{expire_month};
73 my $expire_year = $payments->{expire_year};
74 my $approval_code = $payments->{approval_code} || 'n/a';
75 my $check_number = $payments->{check_number} || 'n/a';
77 for my $pay (@{$payments->{payments}}) {
79 my $transid = $pay->[0];
80 my $amount = $pay->[1];
81 ($trans, $evt) = $apputils->fetch_open_billable_transaction($transid);
84 if($trans->usr != $userid) { # Do we need to restrict this in some way ??
85 $logger->info( " * User $userid is making a payment for " .
86 "a different user: " . $trans->usr . ' for transaction ' . $trans->id );
89 if($type eq 'credit_payment') {
91 $logger->activity("user ".$user->id." reducing patron credit by ".
92 "$credit for making a credit_payment on transaction ".$trans->id);
96 # A negative payment is a refund. If the refund causes the transaction
97 # balance to exceed 0 dollars, we are in effect loaning the patron
98 # money. This is not allowed.
99 if( $amount < 0 and ($trans->balance_owed - $amount > 0) ) {
100 return OpenILS::Event->new('REFUND_EXCEEDS_BALANCE');
103 my $payobj = "Fieldmapper::money::$type";
104 $payobj = $payobj->new;
106 $payobj->amount($amount);
107 $payobj->amount_collected($amount);
108 $payobj->accepting_usr($user->id);
109 $payobj->xact($transid);
110 $payobj->note($note);
112 if ($payobj->has_field('cash_drawer')) { $payobj->cash_drawer($drawer); }
113 if ($payobj->has_field('cc_type')) { $payobj->cc_type($cc_type); }
114 if ($payobj->has_field('cc_number')) { $payobj->cc_number($cc_number); }
115 if ($payobj->has_field('expire_month')) { $payobj->expire_month($expire_month); }
116 if ($payobj->has_field('expire_year')) { $payobj->expire_year($expire_year); }
117 if ($payobj->has_field('approval_code')) { $payobj->approval_code($approval_code); }
118 if ($payobj->has_field('check_number')) { $payobj->check_number($check_number); }
120 # update the transaction if it's done
121 if( (my $cred = ($trans->balance_owed - $amount)) <= 0 ) {
123 # Any overpay on this transaction goes directly into patron credit
126 $logger->activity("user ".$user->id." applying credit ".
127 "of $cred on transaction ".$trans->id. " because of overpayment");
129 $logger->debug("Transactin " . $trans->id . ' is complete');
130 $trans = $session->request(
131 "open-ils.storage.direct.money.billable_transaction.retrieve", $transid )->gather(1);
133 # If this is a circulation, we can't close the transaction unless stop_fines is set
134 my $circ = $session->request(
135 'open-ils.storage.direct.action.circulation.retrieve', $transid )->gather(1);
137 if( !$circ || $circ->stop_fines ) {
139 $trans->xact_finish("now");
144 warn "calling open-ils.storage.direct.money.billable_transaction.update\n";
146 my $s = $session->request(
147 "open-ils.storage.direct.money.billable_transaction.update", $trans )->gather(1);
149 if(!$s) { throw OpenSRF::EX::ERROR
150 ("Error updating billable_xact in circ.money.payment"); }
155 $logger->debug("Creating new $payobj for \$$amount\n");
157 my $s = $session->request(
158 "open-ils.storage.direct.money.$type.create", $payobj )->gather(1);
159 if(!$s) { throw OpenSRF::EX::ERROR ("Error creating new $type"); }
164 $logger->activity("user ".$user->id." applying total ".
165 "credit of $credit to user $userid") if $credit != 0;
167 $evt = _update_patron_credit( $session, $userid, $credit );
170 $apputils->commit_db_session($session);
172 $client->respond_complete(1);
174 # ------------------------------------------------------------------------------
175 # Update the patron penalty info in the DB
176 # ------------------------------------------------------------------------------
177 $U->update_patron_penalties(
186 sub _update_patron_credit {
187 my( $session, $userid, $credit ) = @_;
188 #return if $credit <= 0;
190 my $patron = $session->request(
191 'open-ils.storage.direct.actor.user.retrieve', $userid )->gather(1);
193 $patron->credit_forward_balance(
194 $patron->credit_forward_balance + $credit);
196 if( $patron->credit_forward_balance < 0 ) {
197 return OpenILS::Event->new('NEGATIVE_PATRON_BALANCE');
200 $logger->info("Total patron credit for $userid is now " . $patron->credit_forward_balance );
203 'open-ils.storage.direct.actor.user.update', $patron )->gather(1);
209 __PACKAGE__->register_method(
210 method => "retrieve_payments",
211 api_name => "open-ils.circ.money.payment.retrieve.all",
212 notes => "Returns a list of payments attached to a given transaction"
215 sub retrieve_payments {
216 my( $self, $client, $login, $transid ) = @_;
219 $apputils->checksesperm($login, 'VIEW_TRANSACTION');
222 # XXX the logic here is wrong.. we need to check the owner of the transaction
223 # to make sure the requestor has access
225 return $apputils->simplereq(
227 'open-ils.cstore.direct.money.payment.search.atomic', { xact => $transid } );
232 __PACKAGE__->register_method(
233 method => "create_grocery_bill",
234 api_name => "open-ils.circ.money.grocery.create",
236 Creates a new grocery transaction using the transaction object provided
237 PARAMS: (login_session, money.grocery (mg) object)
240 sub create_grocery_bill {
241 my( $self, $client, $login, $transaction ) = @_;
243 my( $staff, $evt ) = $apputils->checkses($login);
245 $evt = $apputils->check_perms($staff->id,
246 $transaction->billing_location, 'CREATE_TRANSACTION' );
250 $logger->activity("Creating grocery bill " . Dumper($transaction) );
252 $transaction->clear_id;
253 my $session = $apputils->start_db_session;
254 my $transid = $session->request(
255 'open-ils.storage.direct.money.grocery.create', $transaction)->gather(1);
257 throw OpenSRF::EX ("Error creating new money.grocery") unless defined $transid;
259 $logger->debug("Created new grocery transaction $transid");
261 $apputils->commit_db_session($session);
266 __PACKAGE__->register_method(
267 method => "billing_items",
268 api_name => "open-ils.circ.money.billing.retrieve.all",
270 Returns a list of billing items for the given transaction.
271 PARAMS( login, transaction_id )
275 my( $self, $client, $login, $transid ) = @_;
277 my( $trans, $evt ) = $U->fetch_billable_xact($transid);
281 ($staff, $evt ) = $apputils->checkses($login);
284 if($staff->id ne $trans->usr) {
285 $evt = $U->check_perms($staff->id, $staff->home_ou, 'VIEW_TRANSACTION');
289 return $apputils->simplereq( 'open-ils.cstore',
290 'open-ils.cstore.direct.money.billing.search.atomic', { xact => $transid } )
294 __PACKAGE__->register_method(
295 method => "billing_items_create",
296 api_name => "open-ils.circ.money.billing.create",
298 Creates a new billing line item
299 PARAMS( login, bill_object (mb) )
302 sub billing_items_create {
303 my( $self, $client, $login, $billing ) = @_;
305 my $e = new_editor(authtoken => $login, xact => 1);
306 return $e->event unless $e->checkauth;
307 return $e->event unless $e->allowed('CREATE_BILL');
309 my $xact = $e->retrieve_money_billable_transaction($billing->xact)
312 # if the transaction was closed, re-open it
313 if($xact->xact_finish) {
314 $xact->clear_xact_finish;
315 $e->update_money_billable_transaction($xact)
319 $e->create_money_billing($billing) or return $e->event;
325 __PACKAGE__->register_method(
326 method => 'void_bill',
327 api_name => 'open-ils.circ.money.billing.void',
330 @param authtoken Login session key
331 @param billid The id of the bill to void
332 @return 1 on success, Event on error
337 my( $s, $c, $authtoken, $billid ) = @_;
339 my $e = OpenILS::Utils::Editor->new( authtoken => $authtoken );
340 return $e->event unless $e->checkauth;
341 return $e->event unless $e->allowed('VOID_BILLING');
343 my $bill = $e->retrieve_money_billing($billid)
346 return OpenILS::Event->new('BILL_ALREADY_VOIDED', payload => $bill)
347 if $bill->voided and $bill->voided =~ /t/io;
350 $bill->voider($e->requestor->id);
351 $bill->void_time('now');
353 $e->update_money_billing($bill) or return $e->event;
354 my $evt = _check_open_xact($e, $bill->xact);
361 # refactored below XXX
362 sub ___check_open_xact {
363 my( $editor, $xactid ) = @_;
365 # Grab the transaction
366 my $xact = $editor->retrieve_money_billable_transaction($xactid)
367 or return $editor->event;
369 # if it's still open, good.
370 return undef unless $xact->xact_finish;
372 $logger->info("re-opening transaction ".$xact->id);
373 my $finish = $xact->xact_finish;
375 # clear the transaction finish time
376 $xact->clear_xact_finish;
377 $editor->update_money_billable_transaction($xact);
379 # grab the summary and see how much is owed on this transaction
380 my $summary = $editor->retrieve_money_open_billable_transaction_summary($xactid)
381 or return $editor->event;
383 if( $summary->balance_owed == 0 ) {
384 # if nothing is owed, re-close the transaction
385 $xact->xact_finish($finish);
386 $editor->update_money_billable_transaction($xact);
394 sub _check_open_xact {
395 my( $editor, $xactid ) = @_;
397 # Grab the transaction
398 my $xact = $editor->retrieve_money_billable_transaction($xactid)
399 or return $editor->event;
401 # grab the summary and see how much is owed on this transaction
402 my $summary = $editor->retrieve_money_open_billable_transaction_summary($xactid)
403 or return $editor->event;
405 # If nothing is owed on the transaction but xact_finish has
406 # not been set, set it and update
407 if( $summary->balance_owed == 0 and ! $xact->xact_finish ) {
408 $logger->info("closing transaction ".$xact->id. ' becauase balance_owed == 0');
409 $xact->xact_finish('now');
410 $editor->update_money_billable_transaction($xact)
411 or return $editor->event;
415 # If money is owed or a refund is due on the xact and xact_finish
416 # is set, clear it (to reopen the xact) and update
417 if( $summary->balance_owed != 0 and $xact->xact_finish ) {
418 $logger->info("re-opening transaction ".$xact->id. ' becauase balance_owed != 0');
419 $xact->clear_xact_finish;
420 $editor->update_money_billable_transaction($xact)
421 or return $editor->event;
430 __PACKAGE__->register_method (
431 method => 'fetch_mbts',
432 api_name => 'open-ils.circ.money.billable_xact_summary.retrieve'
435 my($s, $c, $authtoken, $id) = @_;
437 my $sum = $U->cstorereq(
438 'open-ils.cstore.direct.money.billable_transaction_summary.retrieve', $id );
439 return OpenILS::Event->new('MONEY_BILLABLE_TRANSACTION_SUMMARY_NOT_FOUND', id => $id) unless $sum;
441 my ($reqr, $evt) = $U->checkses($authtoken);
445 ($usr, $evt) = $U->fetch_user($sum->usr);
448 $evt = $U->check_perms($reqr->id, $usr->home_ou, 'VIEW_TRANSACTION');