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::CStoreEditor 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 my $e = new_editor(); # at this point, just for convenience
64 $logger->info("Creating payment objects: " . Dumper($payments) );
66 my $session = $apputils->start_db_session;
67 my $type = $payments->{payment_type};
68 my $credit = $payments->{patron_credit} || 0;
69 my $drawer = $user->wsid;
70 my $userid = $payments->{userid};
71 my $note = $payments->{note};
72 my $cc_type = $payments->{cc_type} || 'n/a';
73 my $cc_number = $payments->{cc_number} || 'n/a';
74 my $expire_month = $payments->{expire_month};
75 my $expire_year = $payments->{expire_year};
76 my $approval_code = $payments->{approval_code} || 'n/a';
77 my $check_number = $payments->{check_number} || 'n/a';
79 for my $pay (@{$payments->{payments}}) {
81 my $transid = $pay->[0];
82 my $amount = $pay->[1];
83 $amount =~ s/\$//og; # just to be safe
85 #($trans, $evt) = $apputils->fetch_open_billable_transaction($transid);
86 ($trans, $evt) = $apputils->fetch_billable_xact_summary($transid);
89 if($trans->usr != $userid) { # Do we need to restrict this in some way ??
90 $logger->info( " * User $userid is making a payment for " .
91 "a different user: " . $trans->usr . ' for transaction ' . $trans->id );
94 if($type eq 'credit_payment') {
96 $logger->activity("user ".$user->id." reducing patron credit by ".
97 "$credit for making a credit_payment on transaction ".$trans->id);
100 # A negative payment is a refund.
103 # If the refund causes the transaction balance to exceed 0 dollars,
104 # we are in effect loaning the patron money. This is not allowed.
105 if( ($trans->balance_owed - $amount) > 0 ) {
106 return OpenILS::Event->new('REFUND_EXCEEDS_BALANCE');
109 # Otherwise, make sure the refund does not exceed desk payments
110 # This is also not allowed
112 my $desk_payments = $e->search_money_desk_payment(
113 { xact => $transid, voided => 'f' });
114 #$desk_total += $_->amount_collected for @$desk_payments;
115 $desk_total += $_->amount for @$desk_payments;
117 if( (-$amount) > $desk_total ) {
118 return OpenILS::Event->new(
119 'REFUND_EXCEEDS_DESK_PAYMENTS',
120 payload => { allowed_refund => $desk_total, submitted_refund => -$amount } );
124 my $payobj = "Fieldmapper::money::$type";
125 $payobj = $payobj->new;
127 $payobj->amount($amount);
128 $payobj->amount_collected($amount);
129 $payobj->accepting_usr($user->id);
130 $payobj->xact($transid);
131 $payobj->note($note);
133 if ($payobj->has_field('cash_drawer')) { $payobj->cash_drawer($drawer); }
134 if ($payobj->has_field('cc_type')) { $payobj->cc_type($cc_type); }
135 if ($payobj->has_field('cc_number')) { $payobj->cc_number($cc_number); }
136 if ($payobj->has_field('expire_month')) { $payobj->expire_month($expire_month); }
137 if ($payobj->has_field('expire_year')) { $payobj->expire_year($expire_year); }
138 if ($payobj->has_field('approval_code')) { $payobj->approval_code($approval_code); }
139 if ($payobj->has_field('check_number')) { $payobj->check_number($check_number); }
141 # update the transaction if it's done
142 if( (my $cred = ($trans->balance_owed - $amount)) <= 0 ) {
144 # Any overpay on this transaction goes directly into patron credit
147 $logger->activity("user ".$user->id." applying credit ".
148 "of $cred on transaction ".$trans->id. " because of overpayment");
150 $logger->debug("Transactin " . $trans->id . ' is complete');
151 $trans = $session->request(
152 "open-ils.storage.direct.money.billable_transaction.retrieve", $transid )->gather(1);
154 # If this is a circulation, we can't close the transaction unless stop_fines is set
155 my $circ = $session->request(
156 'open-ils.storage.direct.action.circulation.retrieve', $transid )->gather(1);
158 if( !$circ || $circ->stop_fines ) {
160 $trans->xact_finish("now");
161 my $s = $session->request(
162 "open-ils.storage.direct.money.billable_transaction.update", $trans )->gather(1);
164 if(!$s) { throw OpenSRF::EX::ERROR
165 ("Error updating billable_xact in circ.money.payment"); }
170 $logger->debug("Creating new $payobj for \$$amount\n");
172 my $s = $session->request(
173 "open-ils.storage.direct.money.$type.create", $payobj )->gather(1);
174 if(!$s) { throw OpenSRF::EX::ERROR ("Error creating new $type"); }
179 $logger->activity("user ".$user->id." applying total ".
180 "credit of $credit to user $userid") if $credit != 0;
182 $evt = _update_patron_credit( $session, $userid, $credit );
185 $apputils->commit_db_session($session);
187 $client->respond_complete(1);
189 # ------------------------------------------------------------------------------
190 # Update the patron penalty info in the DB
191 # ------------------------------------------------------------------------------
192 $U->update_patron_penalties(
201 sub _update_patron_credit {
202 my( $session, $userid, $credit ) = @_;
203 #return if $credit <= 0;
205 my $patron = $session->request(
206 'open-ils.storage.direct.actor.user.retrieve', $userid )->gather(1);
208 $patron->credit_forward_balance(
209 $patron->credit_forward_balance + $credit);
211 if( $patron->credit_forward_balance < 0 ) {
212 return OpenILS::Event->new('NEGATIVE_PATRON_BALANCE');
215 $logger->info("Total patron credit for $userid is now " . $patron->credit_forward_balance );
218 'open-ils.storage.direct.actor.user.update', $patron )->gather(1);
224 __PACKAGE__->register_method(
225 method => "retrieve_payments",
226 api_name => "open-ils.circ.money.payment.retrieve.all_",
227 notes => "Returns a list of payments attached to a given transaction"
230 sub retrieve_payments {
231 my( $self, $client, $login, $transid ) = @_;
234 $apputils->checksesperm($login, 'VIEW_TRANSACTION');
237 # XXX the logic here is wrong.. we need to check the owner of the transaction
238 # to make sure the requestor has access
240 # XXX grab the view, for each object in the view, grab the real object
242 return $apputils->simplereq(
244 'open-ils.cstore.direct.money.payment.search.atomic', { xact => $transid } );
249 __PACKAGE__->register_method(
250 method => "retrieve_payments2",
251 api_name => "open-ils.circ.money.payment.retrieve.all",
252 notes => "Returns a list of payments attached to a given transaction"
255 sub retrieve_payments2 {
256 my( $self, $client, $login, $transid ) = @_;
258 my $e = new_editor(authtoken=>$login);
259 return $e->event unless $e->checkauth;
260 return $e->event unless $e->allowed('VIEW_TRANSACTION');
263 my $pmnts = $e->search_money_payment({ xact => $transid });
265 my $type = $_->payment_type;
266 my $meth = "retrieve_money_$type";
267 my $p = $e->$meth($_->id) or return $e->event;
268 $p->payment_type($type);
269 $p->cash_drawer($e->retrieve_actor_workstation($p->cash_drawer))
270 if $p->has_field('cash_drawer');
271 push( @payments, $p );
279 __PACKAGE__->register_method(
280 method => "create_grocery_bill",
281 api_name => "open-ils.circ.money.grocery.create",
283 Creates a new grocery transaction using the transaction object provided
284 PARAMS: (login_session, money.grocery (mg) object)
287 sub create_grocery_bill {
288 my( $self, $client, $login, $transaction ) = @_;
290 my( $staff, $evt ) = $apputils->checkses($login);
292 $evt = $apputils->check_perms($staff->id,
293 $transaction->billing_location, 'CREATE_TRANSACTION' );
297 $logger->activity("Creating grocery bill " . Dumper($transaction) );
299 $transaction->clear_id;
300 my $session = $apputils->start_db_session;
301 my $transid = $session->request(
302 'open-ils.storage.direct.money.grocery.create', $transaction)->gather(1);
304 throw OpenSRF::EX ("Error creating new money.grocery") unless defined $transid;
306 $logger->debug("Created new grocery transaction $transid");
308 $apputils->commit_db_session($session);
314 __PACKAGE__->register_method(
315 method => 'fetch_grocery',
316 api_name => 'open-ils.circ.money.grocery.retrieve'
320 my( $self, $conn, $auth, $id ) = @_;
321 my $e = new_editor(authtoken=>$auth);
322 return $e->event unless $e->checkauth;
323 return $e->event unless $e->allowed('VIEW_TRANSACTION'); # eh.. basically the same permission
324 my $g = $e->retrieve_money_grocery($id)
330 __PACKAGE__->register_method(
331 method => "billing_items",
332 api_name => "open-ils.circ.money.billing.retrieve.all",
334 Returns a list of billing items for the given transaction.
335 PARAMS( login, transaction_id )
339 my( $self, $client, $login, $transid ) = @_;
341 my( $trans, $evt ) = $U->fetch_billable_xact($transid);
345 ($staff, $evt ) = $apputils->checkses($login);
348 if($staff->id ne $trans->usr) {
349 $evt = $U->check_perms($staff->id, $staff->home_ou, 'VIEW_TRANSACTION');
353 return $apputils->simplereq( 'open-ils.cstore',
354 'open-ils.cstore.direct.money.billing.search.atomic', { xact => $transid } )
358 __PACKAGE__->register_method(
359 method => "billing_items_create",
360 api_name => "open-ils.circ.money.billing.create",
362 Creates a new billing line item
363 PARAMS( login, bill_object (mb) )
366 sub billing_items_create {
367 my( $self, $client, $login, $billing ) = @_;
369 my $e = new_editor(authtoken => $login, xact => 1);
370 return $e->event unless $e->checkauth;
371 return $e->event unless $e->allowed('CREATE_BILL');
373 my $xact = $e->retrieve_money_billable_transaction($billing->xact)
376 # if the transaction was closed, re-open it
377 if($xact->xact_finish) {
378 $xact->clear_xact_finish;
379 $e->update_money_billable_transaction($xact)
383 my $amt = $billing->amount;
385 $billing->amount($amt);
387 $e->create_money_billing($billing) or return $e->event;
390 # ------------------------------------------------------------------------------
391 # Update the patron penalty info in the DB
392 # ------------------------------------------------------------------------------
393 $U->update_patron_penalties(
395 patronid => $xact->usr,
401 __PACKAGE__->register_method(
402 method => 'void_bill',
403 api_name => 'open-ils.circ.money.billing.void',
406 @param authtoken Login session key
407 @param billid The id of the bill to void
408 @return 1 on success, Event on error
413 my( $s, $c, $authtoken, $billid ) = @_;
415 #my $e = OpenILS::Utils::Editor->new( authtoken => $authtoken );
416 my $e = new_editor( authtoken => $authtoken, xact => 1 );
417 return $e->event unless $e->checkauth;
418 return $e->event unless $e->allowed('VOID_BILLING');
420 my $bill = $e->retrieve_money_billing($billid)
423 return OpenILS::Event->new('BILL_ALREADY_VOIDED', payload => $bill)
424 if $bill->voided and $bill->voided =~ /t/io;
427 $bill->voider($e->requestor->id);
428 $bill->void_time('now');
430 $e->update_money_billing($bill) or return $e->event;
431 my $evt = _check_open_xact($e, $bill->xact);
436 # ------------------------------------------------------------------------------
437 # Update the patron penalty info in the DB
438 # ------------------------------------------------------------------------------
439 my $xact = $e->retrieve_money_billable_transaction($bill->xact)
442 $U->update_patron_penalties(
443 authtoken => $authtoken,
444 patronid => $xact->usr,
450 sub _check_open_xact {
451 my( $editor, $xactid ) = @_;
453 # Grab the transaction
454 my $xact = $editor->retrieve_money_billable_transaction($xactid)
455 or return $editor->event;
457 # grab the summary and see how much is owed on this transaction
458 my $summary = $editor->retrieve_money_billable_transaction_summary($xactid)
459 or return $editor->event;
461 # grab the circulation if it is a circ;
462 my $circ = $editor->retrieve_action_circulation($xactid);
464 # If nothing is owed on the transaction but it is still open
465 # and this transaction is not an open circulation, close it
467 ( $summary->balance_owed == 0 and ! $xact->xact_finish ) and
468 ( !$circ or $circ->stop_fines )) {
470 $logger->info("closing transaction ".$xact->id. ' becauase balance_owed == 0');
471 $xact->xact_finish('now');
472 $editor->update_money_billable_transaction($xact)
473 or return $editor->event;
477 # If money is owed or a refund is due on the xact and xact_finish
478 # is set, clear it (to reopen the xact) and update
479 if( $summary->balance_owed != 0 and $xact->xact_finish ) {
480 $logger->info("re-opening transaction ".$xact->id. ' becauase balance_owed != 0');
481 $xact->clear_xact_finish;
482 $editor->update_money_billable_transaction($xact)
483 or return $editor->event;
496 my $s = new Fieldmapper::money::billable_transaction_summary;
499 $s->xact_start( $x->xact_start );
500 $s->xact_finish( $x->xact_finish );
504 for my $b (@{ $x->billings }) {
505 next if ($U->is_true($b->voided));
507 $lb ||= $b->billing_ts;
508 if ($b->billing_ts ge $lb) {
509 $lb = $b->billing_ts;
510 $s->last_billing_note($b->note);
511 $s->last_billing_ts($b->billing_ts);
512 $s->last_billing_type($b->billing_type);
515 $s->total_owed( $to );
519 for my $p (@{ $x->payments }) {
520 next if ($U->is_true($p->voided));
522 $lp ||= $p->payment_ts;
523 if ($p->payment_ts ge $lp) {
524 $lp = $p->payment_ts;
525 $s->last_payment_note($p->note);
526 $s->last_payment_ts($p->payment_ts);
527 $s->last_payment_type($p->payment_type);
530 $s->total_paid( $tp );
532 $s->balance_owed( $s->total_owed - $s->total_paid );
534 $s->xact_type( 'grocery' ) if ($x->grocery);
535 $s->xact_type( 'circulation' ) if ($x->circulation);
544 __PACKAGE__->register_method (
545 method => 'fetch_mbts',
546 api_name => 'open-ils.circ.money.billable_xact_summary.retrieve'
549 my($s, $c, $authtoken, $id) = @_;
551 $id = $id->id if (ref($id));
553 my @xacts = @{ $U->cstorereq(
554 'open-ils.cstore.direct.money.billable_transaction.search.atomic',
556 { flesh => 1, flesh_fields => { mbt => [ qw/billings payments grocery circulation/ ] } }
559 my ($sum) = _make_mbts(@xacts);
560 return OpenILS::Event->new('MONEY_BILLABLE_TRANSACTION_SUMMARY_NOT_FOUND', id => $id) unless $sum;
562 my ($reqr, $evt) = $U->checkses($authtoken);
566 ($usr, $evt) = $U->fetch_user($sum->usr);
569 $evt = $U->check_perms($reqr->id, $usr->home_ou, 'VIEW_TRANSACTION');
576 __PACKAGE__->register_method(
577 method => 'desk_payments',
578 api_name => 'open-ils.circ.money.org_unit.desk_payments'
582 my( $self, $conn, $auth, $org, $start_date, $end_date ) = @_;
583 my $e = new_editor(authtoken=>$auth);
584 return $e->event unless $e->checkauth;
585 return $e->event unless $e->allowed('VIEW_TRANSACTION', $org);
586 my $data = $U->storagereq(
587 'open-ils.storage.money.org_unit.desk_payments.atomic',
588 $org, $start_date, $end_date );
590 $_->workstation( $_->workstation->name ) for(@$data);
595 __PACKAGE__->register_method(
596 method => 'user_payments',
597 api_name => 'open-ils.circ.money.org_unit.user_payments'
601 my( $self, $conn, $auth, $org, $start_date, $end_date ) = @_;
602 my $e = new_editor(authtoken=>$auth);
603 return $e->event unless $e->checkauth;
604 return $e->event unless $e->allowed('VIEW_TRANSACTION', $org);
605 my $data = $U->storagereq(
606 'open-ils.storage.money.org_unit.user_payments.atomic',
607 $org, $start_date, $end_date );
610 $e->retrieve_actor_card($_->usr->card)->barcode);
612 $e->retrieve_actor_org_unit($_->usr->home_ou)->shortname);