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 # ---------------------------------------------------------------
16 package OpenILS::Application::Circ::Money;
17 use base qw/OpenILS::Application/;
18 use strict; use warnings;
19 use OpenILS::Application::AppUtils;
20 my $apputils = "OpenILS::Application::AppUtils";
21 my $U = "OpenILS::Application::AppUtils";
23 use OpenSRF::EX qw(:try);
27 use OpenSRF::Utils::Logger qw/:logger/;
28 use OpenILS::Utils::CStoreEditor qw/:funcs/;
29 use OpenILS::Utils::Penalty;
30 $Data::Dumper::Indent = 0;
32 __PACKAGE__->register_method(
33 method => "make_payments",
34 api_name => "open-ils.circ.money.payment",
36 desc => q/Create payments for a given user and set of transactions,
37 login must have CREATE_PAYMENT privileges.
38 If any payments fail, all are reverted back./,
40 {desc => 'Authtoken', type => 'string'},
41 {desc => q/Arguments Hash, supporting the following params:
48 where_process 1 to use processor, !1 for out-of-band
49 approval_code (for out-of-band payment)
50 type (for out-of-band payment)
51 number (for call to payment processor)
52 expire_month (for call to payment processor)
53 expire_year (for call to payment processor)
54 billing_first (for out-of-band payments and for call to payment processor)
55 billing_last (for out-of-band payments and for call to payment processor)
56 billing_address (for call to payment processor)
57 billing_city (for call to payment processor)
58 billing_state (for call to payment processor)
59 billing_zip (for call to payment processor)
60 note (if payments->{note} is blank, use this)
70 desc => q/Last user transaction ID. This is the actor.usr.last_xact_id value/,
76 q{Array of payment IDs on success, event on failure. Event possibilities include:
78 Bad parameters were given to this API method itself.
81 The last user transaction ID does not match the ID in the database. This means
82 the user object has been updated since the last retrieval. The client should
83 be instructed to reload the user object and related transactions before attempting
85 REFUND_EXCEEDS_BALANCE
86 REFUND_EXCEEDS_DESK_PAYMENTS
87 CREDIT_PROCESSOR_NOT_SPECIFIED
88 Evergreen has not been set up to process CC payments.
89 CREDIT_PROCESSOR_NOT_ALLOWED
90 Evergreen has been incorrectly setup for CC payments.
91 CREDIT_PROCESSOR_NOT_ENABLED
92 Evergreen has been set up for CC payments, but an admin
93 has not explicitly enabled them.
94 CREDIT_PROCESSOR_BAD_PARAMS
95 Evergreen has been incorrectly setup for CC payments;
96 specifically, the login and/or password for the CC
97 processor weren't provided.
98 CREDIT_PROCESSOR_INVALID_CC_NUMBER
99 You have supplied a credit card number that Evergreen
100 has judged to be invalid even before attempting to contact
101 the payment processor.
102 CREDIT_PROCESSOR_DECLINED_TRANSACTION
103 We contacted the CC processor to attempt the charge, but
105 The error_message field of the event payload will
106 contain the payment processor's response. This
107 typically includes a message in plain English intended
108 for human consumption. In PayPal's case, the message
109 is preceded by an integer, a colon, and a space, so
110 a caller might take the 2nd match from /^(\d+: )?(.+)$/
111 to present to the user.
112 The payload also contains other fields from the payment
113 processor, but these are generally not user-friendly
115 CREDIT_PROCESSOR_SUCCESS_WO_RECORD
116 A payment was processed successfully, but couldn't be
117 recorded in Evergreen. This is _bad bad bad_, as it means
118 somebody made a payment but isn't getting credit for it.
119 See errors in the system log if this happens. Info from
120 the credit card transaction will also be available in the
121 event payload, although this probably won't be suitable for
122 staff client/OPAC display.
129 my($self, $client, $auth, $payments, $last_xact_id) = @_;
131 my $e = new_editor(authtoken => $auth, xact => 1);
132 return $e->die_event unless $e->checkauth;
134 my $type = $payments->{payment_type};
135 my $user_id = $payments->{userid};
136 my $credit = $payments->{patron_credit} || 0;
137 my $drawer = $e->requestor->wsid;
138 my $note = $payments->{note};
139 my $cc_args = $payments->{cc_args};
140 my $check_number = $payments->{check_number};
142 my $this_ou = $e->requestor->ws_ou;
145 # unless/until determined by payment processor API
146 my ($approval_code, $cc_processor, $cc_type, $cc_order_number) = (undef,undef,undef, undef);
148 my $patron = $e->retrieve_actor_user($user_id) or return $e->die_event;
150 if($patron->last_xact_id ne $last_xact_id) {
152 return OpenILS::Event->new('INVALID_USER_XACT_ID');
155 # A user is allowed to make credit card payments on his/her own behalf
156 # All other scenarious require permission
157 unless($type eq 'credit_card_payment' and $user_id == $e->requestor->id) {
158 return $e->die_event unless $e->allowed('CREATE_PAYMENT', $patron->home_ou);
161 # first collect the transactions and make sure the transaction
162 # user matches the requested user
164 for my $pay (@{$payments->{payments}}) {
165 my $xact_id = $pay->[0];
166 my $xact = $e->retrieve_money_billable_transaction_summary($xact_id)
167 or return $e->die_event;
169 if($xact->usr != $user_id) {
171 return OpenILS::Event->new('BAD_PARAMS', note => q/user does not match transaction/);
174 $xacts{$xact_id} = $xact;
179 for my $pay (@{$payments->{payments}}) {
180 my $transid = $pay->[0];
181 my $amount = $pay->[1];
182 $amount =~ s/\$//og; # just to be safe
183 my $trans = $xacts{$transid};
185 $total_paid += $amount;
187 $orgs{$U->xact_org($transid, $e)} = 1;
189 # A negative payment is a refund.
192 # Negative credit card payments are not allowed
193 if($type eq 'credit_card_payment') {
195 return OpenILS::Event->new(
197 note => q/Negative credit card payments not allowed/
201 # If the refund causes the transaction balance to exceed 0 dollars,
202 # we are in effect loaning the patron money. This is not allowed.
203 if( ($trans->balance_owed - $amount) > 0 ) {
205 return OpenILS::Event->new('REFUND_EXCEEDS_BALANCE');
208 # Otherwise, make sure the refund does not exceed desk payments
209 # This is also not allowed
211 my $desk_payments = $e->search_money_desk_payment({xact => $transid, voided => 'f'});
212 $desk_total += $_->amount for @$desk_payments;
214 if( (-$amount) > $desk_total ) {
216 return OpenILS::Event->new(
217 'REFUND_EXCEEDS_DESK_PAYMENTS',
218 payload => { allowed_refund => $desk_total, submitted_refund => -$amount } );
222 my $payobj = "Fieldmapper::money::$type";
223 $payobj = $payobj->new;
225 $payobj->amount($amount);
226 $payobj->amount_collected($amount);
227 $payobj->xact($transid);
228 $payobj->note($note);
229 if ((not $payobj->note) and ($type eq 'credit_card_payment')) {
230 $payobj->note($cc_args->{note});
233 if ($payobj->has_field('accepting_usr')) { $payobj->accepting_usr($e->requestor->id); }
234 if ($payobj->has_field('cash_drawer')) { $payobj->cash_drawer($drawer); }
235 if ($payobj->has_field('cc_type')) { $payobj->cc_type($cc_args->{type}); }
236 if ($payobj->has_field('check_number')) { $payobj->check_number($check_number); }
238 # Store the last 4 digits of the CC number
239 if ($payobj->has_field('cc_number')) {
240 $payobj->cc_number(substr($cc_args->{number}, -4));
242 if ($payobj->has_field('expire_month')) { $payobj->expire_month($cc_args->{expire_month}); }
243 if ($payobj->has_field('expire_year')) { $payobj->expire_year($cc_args->{expire_year}); }
245 # Note: It is important not to set approval_code
246 # on the fieldmapper object yet.
248 push(@payment_objs, $payobj);
250 } # all payment objects have been created and inserted.
252 #### NO WRITES TO THE DB ABOVE THIS LINE -- THEY'LL ONLY BE DISCARDED ###
255 # After we try to externally process a credit card (if desired), we'll
256 # open a new transaction. We cannot leave one open while credit card
257 # processing might be happening, as it can easily time out the database
262 if($type eq 'credit_card_payment') {
263 $approval_code = $cc_args->{approval_code};
264 # If an approval code was not given, we'll need
265 # to call to the payment processor ourselves.
266 if ($cc_args->{where_process} == 1) {
267 return OpenILS::Event->new('BAD_PARAMS', note => 'Need CC number')
268 if not $cc_args->{number};
270 OpenILS::Application::Circ::CreditCard::process_payment({
271 "desc" => $cc_args->{note},
272 "amount" => $total_paid,
273 "patron_id" => $user_id,
274 "cc" => $cc_args->{number},
275 "expiration" => sprintf(
277 $cc_args->{expire_month},
278 $cc_args->{expire_year}
281 "first_name" => $cc_args->{billing_first},
282 "last_name" => $cc_args->{billing_last},
283 "address" => $cc_args->{billing_address},
284 "city" => $cc_args->{billing_city},
285 "state" => $cc_args->{billing_state},
286 "zip" => $cc_args->{billing_zip},
289 if ($U->event_code($response)) { # non-success
291 "Credit card payment for user $user_id failed: " .
292 $response->{"textcode"} . " " .
293 $response->{"payload"}->{"error_message"}
298 # We need to save this for later in case there's a failure on
299 # the EG side to store the processor's result.
300 $cc_payload = $response->{"payload"};
302 $approval_code = $cc_payload->{"authorization"};
303 $cc_type = $cc_payload->{"card_type"};
304 $cc_processor = $cc_payload->{"processor"};
305 $cc_order_number = $cc_payload->{"order_number"};
306 $logger->info("Credit card payment for user $user_id succeeded");
309 return OpenILS::Event->new(
310 'BAD_PARAMS', note => 'Need approval code'
311 ) if not $cc_args->{approval_code};
315 ### RE-OPEN TRANSACTION HERE ###
319 # create payment records
320 my $create_money_method = "create_money_" . $type;
321 for my $payment (@payment_objs) {
322 # update the transaction if it's done
323 my $amount = $payment->amount;
324 my $transid = $payment->xact;
325 my $trans = $xacts{$transid};
326 if( (my $cred = ($trans->balance_owed - $amount)) <= 0 ) {
327 # Any overpay on this transaction goes directly into patron
328 # credit making payment with existing patron credit.
329 $credit -= $amount if $type eq 'credit_payment';
333 my $circ = $e->retrieve_action_circulation($transid);
335 if(!$circ || $circ->stop_fines) {
336 # If this is a circulation, we can't close the transaction
337 # unless stop_fines is set.
338 $trans = $e->retrieve_money_billable_transaction($transid);
339 $trans->xact_finish("now");
340 if (!$e->update_money_billable_transaction($trans)) {
341 return _recording_failure(
342 $e, "update_money_billable_transaction() failed",
343 $payment, $cc_payload
349 $payment->approval_code($approval_code) if $approval_code;
350 $payment->cc_order_number($cc_order_number) if $cc_order_number;
351 $payment->cc_type($cc_type) if $cc_type;
352 $payment->cc_processor($cc_processor) if $cc_processor;
353 $payment->cc_first_name($cc_args->{'billing_first'}) if $cc_args->{'billing_first'};
354 $payment->cc_last_name($cc_args->{'billing_last'}) if $cc_args->{'billing_last'};
355 if (!$e->$create_money_method($payment)) {
356 return _recording_failure(
357 $e, "$create_money_method failed", $payment, $cc_payload
361 push(@payment_ids, $payment->id);
364 my $evt = _update_patron_credit($e, $patron, $credit);
366 return _recording_failure(
367 $e, "_update_patron_credit() failed", undef, $cc_payload
371 for my $org_id (keys %orgs) {
372 # calculate penalties for each of the affected orgs
373 $evt = OpenILS::Utils::Penalty->calculate_penalties(
374 $e, $user_id, $org_id
377 return _recording_failure(
378 $e, "calculate_penalties() failed", undef, $cc_payload
383 # update the user to create a new last_xact_id
384 $e->update_actor_user($patron) or return $e->die_event;
385 $patron = $e->retrieve_actor_user($patron) or return $e->die_event;
388 # update the cached user object if a user is making a payment toward
389 # his/her own account
390 $U->simplereq('open-ils.auth', 'open-ils.auth.session.reset_timeout', $auth, 1)
391 if $user_id == $e->requestor->id;
393 return {last_xact_id => $patron->last_xact_id, payments => \@payment_ids};
396 sub _recording_failure {
397 my ($e, $msg, $payment, $payload) = @_;
399 if ($payload) { # If the payment processor already accepted a payment:
400 $logger->error($msg);
401 $logger->error("Payment processor payload: " . Dumper($payload));
402 # payment shouldn't contain CC number
403 $logger->error("Payment: " . Dumper($payment)) if $payment;
407 return new OpenILS::Event(
408 "CREDIT_PROCESSOR_SUCCESS_WO_RECORD",
409 "payload" => $payload
411 } else { # Otherwise, the problem is somewhat less severe:
413 $logger->warn("Payment: " . Dumper($payment)) if $payment;
414 return $e->die_event;
418 sub _update_patron_credit {
419 my($e, $patron, $credit) = @_;
420 return undef if $credit == 0;
421 $patron->credit_forward_balance($patron->credit_forward_balance + $credit);
422 return OpenILS::Event->new('NEGATIVE_PATRON_BALANCE') if $patron->credit_forward_balance < 0;
423 $e->update_actor_user($patron) or return $e->die_event;
428 __PACKAGE__->register_method(
429 method => "retrieve_payments",
430 api_name => "open-ils.circ.money.payment.retrieve.all_",
431 notes => "Returns a list of payments attached to a given transaction"
433 sub retrieve_payments {
434 my( $self, $client, $login, $transid ) = @_;
437 $apputils->checksesperm($login, 'VIEW_TRANSACTION');
440 # XXX the logic here is wrong.. we need to check the owner of the transaction
441 # to make sure the requestor has access
443 # XXX grab the view, for each object in the view, grab the real object
445 return $apputils->simplereq(
447 'open-ils.cstore.direct.money.payment.search.atomic', { xact => $transid } );
451 __PACKAGE__->register_method(
452 method => "retrieve_payments2",
454 api_name => "open-ils.circ.money.payment.retrieve.all",
455 notes => "Returns a list of payments attached to a given transaction"
458 sub retrieve_payments2 {
459 my( $self, $client, $login, $transid ) = @_;
461 my $e = new_editor(authtoken=>$login);
462 return $e->event unless $e->checkauth;
463 return $e->event unless $e->allowed('VIEW_TRANSACTION');
466 my $pmnts = $e->search_money_payment({ xact => $transid });
468 my $type = $_->payment_type;
469 my $meth = "retrieve_money_$type";
470 my $p = $e->$meth($_->id) or return $e->event;
471 $p->payment_type($type);
472 $p->cash_drawer($e->retrieve_actor_workstation($p->cash_drawer))
473 if $p->has_field('cash_drawer');
474 push( @payments, $p );
480 __PACKAGE__->register_method(
481 method => "format_payment_receipt",
482 api_name => "open-ils.circ.money.payment_receipt.print",
484 desc => 'Returns a printable receipt for the specified payments',
486 { desc => 'Authentication token', type => 'string'},
487 { desc => 'Payment ID or array of payment IDs', type => 'number' },
490 desc => q/An action_trigger.event object or error event./,
495 __PACKAGE__->register_method(
496 method => "format_payment_receipt",
497 api_name => "open-ils.circ.money.payment_receipt.email",
499 desc => 'Emails a receipt for the specified payments to the user associated with the first payment',
501 { desc => 'Authentication token', type => 'string'},
502 { desc => 'Payment ID or array of payment IDs', type => 'number' },
505 desc => q/Undefined on success, otherwise an error event./,
511 sub format_payment_receipt {
512 my($self, $conn, $auth, $mp_id) = @_;
515 if (ref $mp_id ne 'ARRAY') {
516 $mp_ids = [ $mp_id ];
521 my $for_print = ($self->api_name =~ /print/);
522 my $for_email = ($self->api_name =~ /email/);
523 my $e = new_editor(authtoken => $auth);
524 return $e->event unless $e->checkauth;
527 for my $id (@$mp_ids) {
529 my $payment = $e->retrieve_money_payment([
537 ]) or return OpenILS::Event->new('MP_NOT_FOUND');
539 return $e->event unless $e->allowed('VIEW_TRANSACTION', $payment->xact->usr->home_ou);
541 push @$payments, $payment;
546 return $U->fire_object_event(undef, 'money.format.payment_receipt.print', $payments, $$payments[0]->xact->usr->home_ou);
548 } elsif ($for_email) {
550 for my $p (@$payments) {
551 $U->create_events_for_hook('money.format.payment_receipt.email', $p, $p->xact->usr->home_ou, undef, undef, 1);
558 __PACKAGE__->register_method(
559 method => "create_grocery_bill",
560 api_name => "open-ils.circ.money.grocery.create",
562 Creates a new grocery transaction using the transaction object provided
563 PARAMS: (login_session, money.grocery (mg) object)
566 sub create_grocery_bill {
567 my( $self, $client, $login, $transaction ) = @_;
569 my( $staff, $evt ) = $apputils->checkses($login);
571 $evt = $apputils->check_perms($staff->id,
572 $transaction->billing_location, 'CREATE_TRANSACTION' );
576 $logger->activity("Creating grocery bill " . Dumper($transaction) );
578 $transaction->clear_id;
579 my $session = $apputils->start_db_session;
580 my $transid = $session->request(
581 'open-ils.storage.direct.money.grocery.create', $transaction)->gather(1);
583 throw OpenSRF::EX ("Error creating new money.grocery") unless defined $transid;
585 $logger->debug("Created new grocery transaction $transid");
587 $apputils->commit_db_session($session);
589 my $e = new_editor(xact=>1);
590 $evt = _check_open_xact($e, $transid);
598 __PACKAGE__->register_method(
599 method => 'fetch_reservation',
600 api_name => 'open-ils.circ.booking.reservation.retrieve'
602 sub fetch_reservation {
603 my( $self, $conn, $auth, $id ) = @_;
604 my $e = new_editor(authtoken=>$auth);
605 return $e->event unless $e->checkauth;
606 return $e->event unless $e->allowed('VIEW_TRANSACTION'); # eh.. basically the same permission
607 my $g = $e->retrieve_booking_reservation($id)
612 __PACKAGE__->register_method(
613 method => 'fetch_grocery',
614 api_name => 'open-ils.circ.money.grocery.retrieve'
617 my( $self, $conn, $auth, $id ) = @_;
618 my $e = new_editor(authtoken=>$auth);
619 return $e->event unless $e->checkauth;
620 return $e->event unless $e->allowed('VIEW_TRANSACTION'); # eh.. basically the same permission
621 my $g = $e->retrieve_money_grocery($id)
627 __PACKAGE__->register_method(
628 method => "billing_items",
629 api_name => "open-ils.circ.money.billing.retrieve.all",
632 desc => 'Returns a list of billing items for the given transaction ID. ' .
633 'If the operator is not the owner of the transaction, the VIEW_TRANSACTION permission is required.',
635 { desc => 'Authentication token', type => 'string'},
636 { desc => 'Transaction ID', type => 'number'}
639 desc => 'Transaction object, event on error'
645 my( $self, $client, $login, $transid ) = @_;
647 my( $trans, $evt ) = $U->fetch_billable_xact($transid);
651 ($staff, $evt ) = $apputils->checkses($login);
654 if($staff->id ne $trans->usr) {
655 $evt = $U->check_perms($staff->id, $staff->home_ou, 'VIEW_TRANSACTION');
659 return $apputils->simplereq( 'open-ils.cstore',
660 'open-ils.cstore.direct.money.billing.search.atomic', { xact => $transid } )
664 __PACKAGE__->register_method(
665 method => "billing_items_create",
666 api_name => "open-ils.circ.money.billing.create",
668 Creates a new billing line item
669 PARAMS( login, bill_object (mb) )
672 sub billing_items_create {
673 my( $self, $client, $login, $billing ) = @_;
675 my $e = new_editor(authtoken => $login, xact => 1);
676 return $e->die_event unless $e->checkauth;
677 return $e->die_event unless $e->allowed('CREATE_BILL');
679 my $xact = $e->retrieve_money_billable_transaction($billing->xact)
680 or return $e->die_event;
682 # if the transaction was closed, re-open it
683 if($xact->xact_finish) {
684 $xact->clear_xact_finish;
685 $e->update_money_billable_transaction($xact)
686 or return $e->die_event;
689 my $amt = $billing->amount;
691 $billing->amount($amt);
693 $e->create_money_billing($billing) or return $e->die_event;
694 my $evt = OpenILS::Utils::Penalty->calculate_penalties($e, $xact->usr, $U->xact_org($xact->id));
702 __PACKAGE__->register_method(
703 method => 'void_bill',
704 api_name => 'open-ils.circ.money.billing.void',
707 @param authtoken Login session key
708 @param billid Id for the bill to void. This parameter may be repeated to reference other bills.
709 @return 1 on success, Event on error
713 my( $s, $c, $authtoken, @billids ) = @_;
715 my $e = new_editor( authtoken => $authtoken, xact => 1 );
716 return $e->die_event unless $e->checkauth;
717 return $e->die_event unless $e->allowed('VOID_BILLING');
720 for my $billid (@billids) {
722 my $bill = $e->retrieve_money_billing($billid)
723 or return $e->die_event;
725 my $xact = $e->retrieve_money_billable_transaction($bill->xact)
726 or return $e->die_event;
728 if($U->is_true($bill->voided)) {
730 return OpenILS::Event->new('BILL_ALREADY_VOIDED', payload => $bill);
733 my $org = $U->xact_org($bill->xact, $e);
734 $users{$xact->usr} = {} unless $users{$xact->usr};
735 $users{$xact->usr}->{$org} = 1;
738 $bill->voider($e->requestor->id);
739 $bill->void_time('now');
741 $e->update_money_billing($bill) or return $e->die_event;
742 my $evt = _check_open_xact($e, $bill->xact, $xact);
746 # calculate penalties for all user/org combinations
747 for my $user_id (keys %users) {
748 for my $org_id (keys %{$users{$user_id}}) {
749 OpenILS::Utils::Penalty->calculate_penalties($e, $user_id, $org_id);
757 __PACKAGE__->register_method(
758 method => 'edit_bill_note',
759 api_name => 'open-ils.circ.money.billing.note.edit',
761 Edits the note for a bill
762 @param authtoken Login session key
763 @param note The replacement note for the bills we're editing
764 @param billid Id for the bill to edit the note of. This parameter may be repeated to reference other bills.
765 @return 1 on success, Event on error
769 my( $s, $c, $authtoken, $note, @billids ) = @_;
771 my $e = new_editor( authtoken => $authtoken, xact => 1 );
772 return $e->die_event unless $e->checkauth;
773 return $e->die_event unless $e->allowed('UPDATE_BILL_NOTE');
775 for my $billid (@billids) {
777 my $bill = $e->retrieve_money_billing($billid)
778 or return $e->die_event;
781 # FIXME: Does this get audited? Need some way so that the original creator of the bill does not get credit/blame for the new note.
783 $e->update_money_billing($bill) or return $e->die_event;
790 __PACKAGE__->register_method(
791 method => 'edit_payment_note',
792 api_name => 'open-ils.circ.money.payment.note.edit',
794 Edits the note for a payment
795 @param authtoken Login session key
796 @param note The replacement note for the payments we're editing
797 @param paymentid Id for the payment to edit the note of. This parameter may be repeated to reference other payments.
798 @return 1 on success, Event on error
801 sub edit_payment_note {
802 my( $s, $c, $authtoken, $note, @paymentids ) = @_;
804 my $e = new_editor( authtoken => $authtoken, xact => 1 );
805 return $e->die_event unless $e->checkauth;
806 return $e->die_event unless $e->allowed('UPDATE_PAYMENT_NOTE');
808 for my $paymentid (@paymentids) {
810 my $payment = $e->retrieve_money_payment($paymentid)
811 or return $e->die_event;
813 $payment->note($note);
814 # FIXME: Does this get audited? Need some way so that the original taker of the payment does not get credit/blame for the new note.
816 $e->update_money_payment($payment) or return $e->die_event;
823 sub _check_open_xact {
824 my( $editor, $xactid, $xact ) = @_;
826 # Grab the transaction
827 $xact ||= $editor->retrieve_money_billable_transaction($xactid);
828 return $editor->event unless $xact;
829 $xactid ||= $xact->id;
831 # grab the summary and see how much is owed on this transaction
832 my ($summary) = $U->fetch_mbts($xactid, $editor);
834 # grab the circulation if it is a circ;
835 my $circ = $editor->retrieve_action_circulation($xactid);
837 # If nothing is owed on the transaction but it is still open
838 # and this transaction is not an open circulation, close it
840 ( $summary->balance_owed == 0 and ! $xact->xact_finish ) and
841 ( !$circ or $circ->stop_fines )) {
843 $logger->info("closing transaction ".$xact->id. ' becauase balance_owed == 0');
844 $xact->xact_finish('now');
845 $editor->update_money_billable_transaction($xact)
846 or return $editor->event;
850 # If money is owed or a refund is due on the xact and xact_finish
851 # is set, clear it (to reopen the xact) and update
852 if( $summary->balance_owed != 0 and $xact->xact_finish ) {
853 $logger->info("re-opening transaction ".$xact->id. ' becauase balance_owed != 0');
854 $xact->clear_xact_finish;
855 $editor->update_money_billable_transaction($xact)
856 or return $editor->event;
863 __PACKAGE__->register_method (
864 method => 'fetch_mbts',
866 api_name => 'open-ils.circ.money.billable_xact_summary.retrieve'
869 my( $self, $conn, $auth, $id) = @_;
871 my $e = new_editor(xact => 1, authtoken=>$auth);
872 return $e->event unless $e->checkauth;
873 my ($mbts) = $U->fetch_mbts($id, $e);
875 my $user = $e->retrieve_actor_user($mbts->usr)
876 or return $e->die_event;
878 return $e->die_event unless $e->allowed('VIEW_TRANSACTION', $user->home_ou);
884 __PACKAGE__->register_method(
885 method => 'desk_payments',
886 api_name => 'open-ils.circ.money.org_unit.desk_payments'
889 my( $self, $conn, $auth, $org, $start_date, $end_date ) = @_;
890 my $e = new_editor(authtoken=>$auth);
891 return $e->event unless $e->checkauth;
892 return $e->event unless $e->allowed('VIEW_TRANSACTION', $org);
893 my $data = $U->storagereq(
894 'open-ils.storage.money.org_unit.desk_payments.atomic',
895 $org, $start_date, $end_date );
897 $_->workstation( $_->workstation->name ) for(@$data);
902 __PACKAGE__->register_method(
903 method => 'user_payments',
904 api_name => 'open-ils.circ.money.org_unit.user_payments'
908 my( $self, $conn, $auth, $org, $start_date, $end_date ) = @_;
909 my $e = new_editor(authtoken=>$auth);
910 return $e->event unless $e->checkauth;
911 return $e->event unless $e->allowed('VIEW_TRANSACTION', $org);
912 my $data = $U->storagereq(
913 'open-ils.storage.money.org_unit.user_payments.atomic',
914 $org, $start_date, $end_date );
917 $e->retrieve_actor_card($_->usr->card)->barcode);
919 $e->retrieve_actor_org_unit($_->usr->home_ou)->shortname);
925 __PACKAGE__->register_method(
926 method => 'retrieve_credit_payable_balance',
927 api_name => 'open-ils.circ.credit.payable_balance.retrieve',
930 desc => q/Returns the total amount the patron can pay via credit card/,
932 { desc => 'Authentication token', type => 'string' },
933 { desc => 'User id', type => 'number' }
935 return => { desc => 'The ID of the new provider' }
939 sub retrieve_credit_payable_balance {
940 my ( $self, $conn, $auth, $user_id ) = @_;
941 my $e = new_editor(authtoken => $auth);
942 return $e->event unless $e->checkauth;
944 my $user = $e->retrieve_actor_user($user_id)
947 if($e->requestor->id != $user_id) {
948 return $e->event unless $e->allowed('VIEW_USER_TRANSACTIONS', $user->home_ou)
951 my $circ_orgs = $e->json_query({
952 "select" => {circ => ["circ_lib"]},
954 "where" => {usr => $user_id, xact_finish => undef},
958 my $groc_orgs = $e->json_query({
959 "select" => {mg => ["billing_location"]},
961 "where" => {usr => $user_id, xact_finish => undef},
966 for my $org ( @$circ_orgs, @$groc_orgs ) {
967 my $o = $org->{billing_location};
968 $o = $org->{circ_lib} unless $o;
969 next if $hash{$o}; # was $hash{$org}, but that doesn't make sense. $org is a hashref and $o gets added in the next line.
970 $hash{$o} = $U->ou_ancestor_setting_value($o, 'credit.payments.allow', $e);
973 my @credit_orgs = map { $hash{$_} ? ($_) : () } keys %hash;
974 $logger->debug("credit: relevant orgs that allow credit payments => @credit_orgs");
977 OpenILS::Application::AppUtils->simplereq('open-ils.actor',
978 'open-ils.actor.user.transactions.have_charge', $auth, $user_id);
982 for my $xact (@$xact_summaries) {
984 # make two lists and grab them in batch XXX
985 if ( $xact->xact_type eq 'circulation' ) {
986 my $circ = $e->retrieve_action_circulation($xact->id) or return $e->event;
987 next unless grep { $_ == $circ->circ_lib } @credit_orgs;
989 } elsif ($xact->xact_type eq 'grocery') {
990 my $bill = $e->retrieve_money_grocery($xact->id) or return $e->event;
991 next unless grep { $_ == $bill->billing_location } @credit_orgs;
992 } elsif ($xact->xact_type eq 'reservation') {
993 my $bill = $e->retrieve_booking_reservation($xact->id) or return $e->event;
994 next unless grep { $_ == $bill->pickup_lib } @credit_orgs;
996 $sum += $xact->balance_owed();