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;
31 __PACKAGE__->register_method(
32 method => "make_payments",
33 api_name => "open-ils.circ.money.payment",
35 desc => q/Create payments for a given user and set of transactions,
36 login must have CREATE_PAYMENT privileges.
37 If any payments fail, all are reverted back./,
39 {desc => 'Authtoken', type => 'string'},
40 {desc => q/Arguments Hash, supporting the following params:
47 where_process 1 to use processor, !1 for out-of-band
48 approval_code (for out-of-band payment)
49 type (for out-of-band payment)
50 number (for call to payment processor)
51 expire_month (for call to payment processor)
52 expire_year (for call to payment processor)
53 billing_first (for call to payment processor)
54 billing_last (for call to payment processor)
55 billing_address (for call to payment processor)
56 billing_city (for call to payment processor)
57 billing_state (for call to payment processor)
58 billing_zip (for call to payment processor)
59 note (if payments->{note} is blank, use this)
71 q{1 on success, event on failure. Event possibilities include:
73 (Bad parameters were given to this API method itself.
75 CREDIT_PROCESSOR_NOT_SPECIFIED
76 (Evergreen has not been set up to process CC payments)
77 CREDIT_PROCESSOR_NOT_ALLOWED
78 (Evergreen has been incorrectly setup for CC payments)
79 CREDIT_PROCESSOR_NOT_ENABLED
80 (Evergreen has been set up for CC payments, but an admin
81 has not explicitly enabled them)
82 CREDIT_PROCESSOR_BAD_PARAMS
83 (Evergreen has been incorrectly setup for CC payments;
84 specifically, the login and/or password for the CC
85 processor weren't provided)
86 CREDIT_PROCESSOR_DECLINED_TRANSACTION
87 (We contacted the CC processor to attempt the charge, but
88 they declined it. See the statusText field for their
90 CREDIT_PROCESSOR_SUCCESS_WO_RECORD
91 (A payment was processed successfully, but couldn't be
92 recorded in Evergreen. This is bad bad bad, as it means
93 somebody made a payment but isn't getting credit for it.
94 See note field for more info.)
101 my($self, $client, $auth, $payments) = @_;
103 my $e = new_editor(authtoken => $auth, xact => 1);
104 return $e->die_event unless $e->checkauth;
106 my $type = $payments->{payment_type};
107 my $user_id = $payments->{userid};
108 my $credit = $payments->{patron_credit} || 0;
109 my $drawer = $e->requestor->wsid;
110 my $note = $payments->{note};
111 my $cc_args = $payments->{cc_args};
112 my $check_number = $payments->{check_number};
114 my $this_ou = $e->requestor->ws_ou;
117 # unless/until determined by payment processor API
118 my ($approval_code, $cc_processor, $cc_type) = (undef,undef,undef);
120 my $patron = $e->retrieve_actor_user($user_id) or return $e->die_event;
122 # A user is allowed to make credit card payments on his/her own behalf
123 # All other scenarious require permission
124 unless($type eq 'credit_card_payment' and $user_id == $e->requestor->id) {
125 return $e->die_event unless $e->allowed('CREATE_PAYMENT', $patron->home_ou);
128 # first collect the transactions and make sure the transaction
129 # user matches the requested user
131 for my $pay (@{$payments->{payments}}) {
132 my $xact_id = $pay->[0];
133 my $xact = $e->retrieve_money_billable_transaction_summary($xact_id)
134 or return $e->die_event;
136 if($xact->usr != $user_id) {
138 return OpenILS::Event->new('BAD_PARAMS', note => q/user does not match transaction/);
141 $xacts{$xact_id} = $xact;
146 for my $pay (@{$payments->{payments}}) {
147 my $transid = $pay->[0];
148 my $amount = $pay->[1];
149 $amount =~ s/\$//og; # just to be safe
150 my $trans = $xacts{$transid};
152 $total_paid += $amount;
154 $orgs{$U->xact_org($transid, $e)} = 1;
156 # A negative payment is a refund.
159 # Negative credit card payments are not allowed
160 if($type eq 'credit_card_payment') {
162 return OpenILS::Event->new(
164 note => q/Negative credit card payments not allowed/
168 # If the refund causes the transaction balance to exceed 0 dollars,
169 # we are in effect loaning the patron money. This is not allowed.
170 if( ($trans->balance_owed - $amount) > 0 ) {
172 return OpenILS::Event->new('REFUND_EXCEEDS_BALANCE');
175 # Otherwise, make sure the refund does not exceed desk payments
176 # This is also not allowed
178 my $desk_payments = $e->search_money_desk_payment({xact => $transid, voided => 'f'});
179 $desk_total += $_->amount for @$desk_payments;
181 if( (-$amount) > $desk_total ) {
183 return OpenILS::Event->new(
184 'REFUND_EXCEEDS_DESK_PAYMENTS',
185 payload => { allowed_refund => $desk_total, submitted_refund => -$amount } );
189 my $payobj = "Fieldmapper::money::$type";
190 $payobj = $payobj->new;
192 $payobj->amount($amount);
193 $payobj->amount_collected($amount);
194 $payobj->xact($transid);
195 $payobj->note($note);
196 if ((not $payobj->note) and ($type eq 'credit_card_payment')) {
197 $payobj->note($cc_args->{note});
200 if ($payobj->has_field('accepting_usr')) { $payobj->accepting_usr($e->requestor->id); }
201 if ($payobj->has_field('cash_drawer')) { $payobj->cash_drawer($drawer); }
202 if ($payobj->has_field('cc_type')) { $payobj->cc_type($cc_args->{type}); }
203 if ($payobj->has_field('check_number')) { $payobj->check_number($check_number); }
205 # Store the last 4 digits of the CC number
206 if ($payobj->has_field('cc_number')) {
207 $payobj->cc_number(substr($cc_args->{number}, -4));
209 if ($payobj->has_field('expire_month')) { $payobj->expire_month($cc_args->{expire_month}); }
210 if ($payobj->has_field('expire_year')) { $payobj->expire_year($cc_args->{expire_year}); }
212 # Note: It is important not to set approval_code
213 # on the fieldmapper object yet.
215 push(@payment_objs, $payobj);
217 } # all payment objects have been created and inserted.
219 #### NO WRITES TO THE DB ABOVE THIS LINE -- THEY'LL ONLY BE DISCARDED ###
222 # After we try to externally process a credit card (if desired), we'll
223 # open a new transaction. We cannot leave one open while credit card
224 # processing might be happening, as it can easily time out the database
226 if($type eq 'credit_card_payment') {
227 $approval_code = $cc_args->{approval_code};
228 # If an approval code was not given, we'll need
229 # to call to the payment processor ourselves.
230 if ($cc_args->{where_process} == 1) {
231 return OpenILS::Event->new('BAD_PARAMS', note => 'Need CC number')
232 if not $cc_args->{number};
234 OpenILS::Application::Circ::CreditCard::process_payment({
235 "desc" => $cc_args->{note},
236 "amount" => $total_paid,
237 "patron_id" => $user_id,
238 "cc" => $cc_args->{number},
239 "expiration" => sprintf(
241 $cc_args->{expire_month},
242 $cc_args->{expire_year}
245 "first_name" => $cc_args->{billing_first},
246 "last_name" => $cc_args->{billing_last},
247 "address" => $cc_args->{billing_address},
248 "city" => $cc_args->{billing_city},
249 "state" => $cc_args->{billing_state},
250 "zip" => $cc_args->{billing_zip},
253 if (exists $response->{ilsevent}) {
255 "event response from process_payment(): " .
256 $response->{"textcode"}
260 if ($response->{statusCode} != 200) {
261 $logger->info("Credit card payment for user $user_id " .
262 "failed with message: " . $response->{statusText});
263 return OpenILS::Event->new(
264 'CREDIT_PROCESSOR_DECLINED_TRANSACTION',
265 note => $response->{statusText}
268 $approval_code = $response->{approvalCode};
269 $cc_type = $response->{cardType};
270 $cc_processor = $response->{processor};
271 $logger->info("Credit card payment processing for " .
272 "user $user_id succeeded");
275 return OpenILS::Event->new(
276 'BAD_PARAMS', note => 'Need approval code'
277 ) if not $cc_args->{approval_code};
281 ### RE-OPEN TRANSACTION HERE ###
284 # create payment records
285 my $create_money_method = "create_money_" . $type;
286 for my $payment (@payment_objs) {
287 # update the transaction if it's done
288 my $amount = $payment->amount;
289 my $transid = $payment->xact;
290 my $trans = $xacts{$transid};
291 if( (my $cred = ($trans->balance_owed - $amount)) <= 0 ) {
292 # Any overpay on this transaction goes directly into patron
293 # credit making payment with existing patron credit.
294 $credit -= $amount if $type eq 'credit_payment';
298 my $circ = $e->retrieve_action_circulation($transid);
300 if(!$circ || $circ->stop_fines) {
301 # If this is a circulation, we can't close the transaction
302 # unless stop_fines is set.
303 $trans = $e->retrieve_money_billable_transaction($transid);
304 $trans->xact_finish("now");
305 if (!$e->update_money_billable_transaction($trans)) {
306 $logger->warn("update_money_billable_transaction() " .
309 return OpenILS::Event->new(
310 'CREDIT_PROCESSOR_SUCCESS_WO_RECORD',
311 note => 'update_money_billable_transaction() failed'
317 $payment->approval_code($approval_code) if $approval_code;
318 $payment->cc_type($cc_type) if $cc_type;
319 $payment->cc_processor($cc_processor) if $cc_processor;
320 if (!$e->$create_money_method($payment)) {
321 $logger->warn("$create_money_method failed: " .
322 Dumper($payment)); # won't contain CC number.
324 return OpenILS::Event->new(
325 'CREDIT_PROCESSOR_SUCCESS_WO_RECORD',
326 note => "$create_money_method failed"
331 my $evt = _update_patron_credit($e, $patron, $credit);
333 $logger->warn("_update_patron_credit() failed");
335 return OpenILS::Event->new(
336 'CREDIT_PROCESSOR_SUCCESS_WO_RECORD',
337 note => "_update_patron_credit() failed"
341 for my $org_id (keys %orgs) {
342 # calculate penalties for each of the affected orgs
343 $evt = OpenILS::Utils::Penalty->calculate_penalties(
344 $e, $user_id, $org_id
348 "OpenILS::Utils::Penalty::calculate_penalties() failed"
351 return OpenILS::Event->new(
352 'CREDIT_PROCESSOR_SUCCESS_WO_RECORD',
353 note => "OpenILS::Utils::Penalty::calculate_penalties() failed"
362 sub _update_patron_credit {
363 my($e, $patron, $credit) = @_;
364 return undef if $credit == 0;
365 $patron->credit_forward_balance($patron->credit_forward_balance + $credit);
366 return OpenILS::Event->new('NEGATIVE_PATRON_BALANCE') if $patron->credit_forward_balance < 0;
367 $e->update_actor_user($patron) or return $e->die_event;
372 __PACKAGE__->register_method(
373 method => "retrieve_payments",
374 api_name => "open-ils.circ.money.payment.retrieve.all_",
375 notes => "Returns a list of payments attached to a given transaction"
377 sub retrieve_payments {
378 my( $self, $client, $login, $transid ) = @_;
381 $apputils->checksesperm($login, 'VIEW_TRANSACTION');
384 # XXX the logic here is wrong.. we need to check the owner of the transaction
385 # to make sure the requestor has access
387 # XXX grab the view, for each object in the view, grab the real object
389 return $apputils->simplereq(
391 'open-ils.cstore.direct.money.payment.search.atomic', { xact => $transid } );
395 __PACKAGE__->register_method(
396 method => "retrieve_payments2",
398 api_name => "open-ils.circ.money.payment.retrieve.all",
399 notes => "Returns a list of payments attached to a given transaction"
402 sub retrieve_payments2 {
403 my( $self, $client, $login, $transid ) = @_;
405 my $e = new_editor(authtoken=>$login);
406 return $e->event unless $e->checkauth;
407 return $e->event unless $e->allowed('VIEW_TRANSACTION');
410 my $pmnts = $e->search_money_payment({ xact => $transid });
412 my $type = $_->payment_type;
413 my $meth = "retrieve_money_$type";
414 my $p = $e->$meth($_->id) or return $e->event;
415 $p->payment_type($type);
416 $p->cash_drawer($e->retrieve_actor_workstation($p->cash_drawer))
417 if $p->has_field('cash_drawer');
418 push( @payments, $p );
424 __PACKAGE__->register_method(
425 method => "format_payment_receipt",
426 api_name => "open-ils.circ.money.payment_receipt.print",
428 desc => 'Returns a printable receipt for the specified payments',
430 { desc => 'Authentication token', type => 'string'},
431 { desc => 'Payment ID or array of payment IDs', type => 'number' },
434 desc => q/An action_trigger.event object or error event./,
439 __PACKAGE__->register_method(
440 method => "format_payment_receipt",
441 api_name => "open-ils.circ.money.payment_receipt.email",
443 desc => 'Emails a receipt for the specified payments to the user associated with the first payment',
445 { desc => 'Authentication token', type => 'string'},
446 { desc => 'Payment ID or array of payment IDs', type => 'number' },
449 desc => q/Undefined on success, otherwise an error event./,
455 sub format_payment_receipt {
456 my($self, $conn, $auth, $mp_id) = @_;
459 if (ref $mp_id ne 'ARRAY') {
460 $mp_ids = [ $mp_id ];
465 my $for_print = ($self->api_name =~ /print/);
466 my $for_email = ($self->api_name =~ /email/);
467 my $e = new_editor(authtoken => $auth);
468 return $e->event unless $e->checkauth;
471 for my $id (@$mp_ids) {
473 my $payment = $e->retrieve_money_payment([
481 ]) or return OpenILS::Event->new('MP_NOT_FOUND');
483 return $e->event unless $e->allowed('VIEW_TRANSACTION', $payment->xact->usr->home_ou);
485 push @$payments, $payment;
490 return $U->fire_object_event(undef, 'money.format.payment_receipt.print', $payments, $$payments[0]->xact->usr->home_ou);
492 } elsif ($for_email) {
494 for my $p (@$payments) {
495 $U->create_events_for_hook('money.format.payment_receipt.email', $p, $p->xact->usr->home_ou, 1);
502 __PACKAGE__->register_method(
503 method => "create_grocery_bill",
504 api_name => "open-ils.circ.money.grocery.create",
506 Creates a new grocery transaction using the transaction object provided
507 PARAMS: (login_session, money.grocery (mg) object)
510 sub create_grocery_bill {
511 my( $self, $client, $login, $transaction ) = @_;
513 my( $staff, $evt ) = $apputils->checkses($login);
515 $evt = $apputils->check_perms($staff->id,
516 $transaction->billing_location, 'CREATE_TRANSACTION' );
520 $logger->activity("Creating grocery bill " . Dumper($transaction) );
522 $transaction->clear_id;
523 my $session = $apputils->start_db_session;
524 my $transid = $session->request(
525 'open-ils.storage.direct.money.grocery.create', $transaction)->gather(1);
527 throw OpenSRF::EX ("Error creating new money.grocery") unless defined $transid;
529 $logger->debug("Created new grocery transaction $transid");
531 $apputils->commit_db_session($session);
533 my $e = new_editor(xact=>1);
534 $evt = _check_open_xact($e, $transid);
542 __PACKAGE__->register_method(
543 method => 'fetch_reservation',
544 api_name => 'open-ils.circ.booking.reservation.retrieve'
546 sub fetch_reservation {
547 my( $self, $conn, $auth, $id ) = @_;
548 my $e = new_editor(authtoken=>$auth);
549 return $e->event unless $e->checkauth;
550 return $e->event unless $e->allowed('VIEW_TRANSACTION'); # eh.. basically the same permission
551 my $g = $e->retrieve_booking_reservation($id)
556 __PACKAGE__->register_method(
557 method => 'fetch_grocery',
558 api_name => 'open-ils.circ.money.grocery.retrieve'
561 my( $self, $conn, $auth, $id ) = @_;
562 my $e = new_editor(authtoken=>$auth);
563 return $e->event unless $e->checkauth;
564 return $e->event unless $e->allowed('VIEW_TRANSACTION'); # eh.. basically the same permission
565 my $g = $e->retrieve_money_grocery($id)
571 __PACKAGE__->register_method(
572 method => "billing_items",
573 api_name => "open-ils.circ.money.billing.retrieve.all",
576 desc => 'Returns a list of billing items for the given transaction ID. ' .
577 'If the operator is not the owner of the transaction, the VIEW_TRANSACTION permission is required.',
579 { desc => 'Authentication token', type => 'string'},
580 { desc => 'Transaction ID', type => 'number'}
583 desc => 'Transaction object, event on error'
589 my( $self, $client, $login, $transid ) = @_;
591 my( $trans, $evt ) = $U->fetch_billable_xact($transid);
595 ($staff, $evt ) = $apputils->checkses($login);
598 if($staff->id ne $trans->usr) {
599 $evt = $U->check_perms($staff->id, $staff->home_ou, 'VIEW_TRANSACTION');
603 return $apputils->simplereq( 'open-ils.cstore',
604 'open-ils.cstore.direct.money.billing.search.atomic', { xact => $transid } )
608 __PACKAGE__->register_method(
609 method => "billing_items_create",
610 api_name => "open-ils.circ.money.billing.create",
612 Creates a new billing line item
613 PARAMS( login, bill_object (mb) )
616 sub billing_items_create {
617 my( $self, $client, $login, $billing ) = @_;
619 my $e = new_editor(authtoken => $login, xact => 1);
620 return $e->die_event unless $e->checkauth;
621 return $e->die_event unless $e->allowed('CREATE_BILL');
623 my $xact = $e->retrieve_money_billable_transaction($billing->xact)
624 or return $e->die_event;
626 # if the transaction was closed, re-open it
627 if($xact->xact_finish) {
628 $xact->clear_xact_finish;
629 $e->update_money_billable_transaction($xact)
630 or return $e->die_event;
633 my $amt = $billing->amount;
635 $billing->amount($amt);
637 $e->create_money_billing($billing) or return $e->die_event;
638 my $evt = OpenILS::Utils::Penalty->calculate_penalties($e, $xact->usr, $U->xact_org($xact->id));
646 __PACKAGE__->register_method(
647 method => 'void_bill',
648 api_name => 'open-ils.circ.money.billing.void',
651 @param authtoken Login session key
652 @param billid Id for the bill to void. This parameter may be repeated to reference other bills.
653 @return 1 on success, Event on error
657 my( $s, $c, $authtoken, @billids ) = @_;
659 my $e = new_editor( authtoken => $authtoken, xact => 1 );
660 return $e->die_event unless $e->checkauth;
661 return $e->die_event unless $e->allowed('VOID_BILLING');
664 for my $billid (@billids) {
666 my $bill = $e->retrieve_money_billing($billid)
667 or return $e->die_event;
669 my $xact = $e->retrieve_money_billable_transaction($bill->xact)
670 or return $e->die_event;
672 if($U->is_true($bill->voided)) {
674 return OpenILS::Event->new('BILL_ALREADY_VOIDED', payload => $bill);
677 my $org = $U->xact_org($bill->xact, $e);
678 $users{$xact->usr} = {} unless $users{$xact->usr};
679 $users{$xact->usr}->{$org} = 1;
682 $bill->voider($e->requestor->id);
683 $bill->void_time('now');
685 $e->update_money_billing($bill) or return $e->die_event;
686 my $evt = _check_open_xact($e, $bill->xact, $xact);
690 # calculate penalties for all user/org combinations
691 for my $user_id (keys %users) {
692 for my $org_id (keys %{$users{$user_id}}) {
693 OpenILS::Utils::Penalty->calculate_penalties($e, $user_id, $org_id);
701 __PACKAGE__->register_method(
702 method => 'edit_bill_note',
703 api_name => 'open-ils.circ.money.billing.note.edit',
705 Edits the note for a bill
706 @param authtoken Login session key
707 @param note The replacement note for the bills we're editing
708 @param billid Id for the bill to edit the note of. This parameter may be repeated to reference other bills.
709 @return 1 on success, Event on error
713 my( $s, $c, $authtoken, $note, @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('UPDATE_BILL_NOTE');
719 for my $billid (@billids) {
721 my $bill = $e->retrieve_money_billing($billid)
722 or return $e->die_event;
725 # 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.
727 $e->update_money_billing($bill) or return $e->die_event;
734 __PACKAGE__->register_method(
735 method => 'edit_payment_note',
736 api_name => 'open-ils.circ.money.payment.note.edit',
738 Edits the note for a payment
739 @param authtoken Login session key
740 @param note The replacement note for the payments we're editing
741 @param paymentid Id for the payment to edit the note of. This parameter may be repeated to reference other payments.
742 @return 1 on success, Event on error
745 sub edit_payment_note {
746 my( $s, $c, $authtoken, $note, @paymentids ) = @_;
748 my $e = new_editor( authtoken => $authtoken, xact => 1 );
749 return $e->die_event unless $e->checkauth;
750 return $e->die_event unless $e->allowed('UPDATE_PAYMENT_NOTE');
752 for my $paymentid (@paymentids) {
754 my $payment = $e->retrieve_money_payment($paymentid)
755 or return $e->die_event;
757 $payment->note($note);
758 # 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.
760 $e->update_money_payment($payment) or return $e->die_event;
767 sub _check_open_xact {
768 my( $editor, $xactid, $xact ) = @_;
770 # Grab the transaction
771 $xact ||= $editor->retrieve_money_billable_transaction($xactid);
772 return $editor->event unless $xact;
773 $xactid ||= $xact->id;
775 # grab the summary and see how much is owed on this transaction
776 my ($summary) = $U->fetch_mbts($xactid, $editor);
778 # grab the circulation if it is a circ;
779 my $circ = $editor->retrieve_action_circulation($xactid);
781 # If nothing is owed on the transaction but it is still open
782 # and this transaction is not an open circulation, close it
784 ( $summary->balance_owed == 0 and ! $xact->xact_finish ) and
785 ( !$circ or $circ->stop_fines )) {
787 $logger->info("closing transaction ".$xact->id. ' becauase balance_owed == 0');
788 $xact->xact_finish('now');
789 $editor->update_money_billable_transaction($xact)
790 or return $editor->event;
794 # If money is owed or a refund is due on the xact and xact_finish
795 # is set, clear it (to reopen the xact) and update
796 if( $summary->balance_owed != 0 and $xact->xact_finish ) {
797 $logger->info("re-opening transaction ".$xact->id. ' becauase balance_owed != 0');
798 $xact->clear_xact_finish;
799 $editor->update_money_billable_transaction($xact)
800 or return $editor->event;
807 __PACKAGE__->register_method (
808 method => 'fetch_mbts',
810 api_name => 'open-ils.circ.money.billable_xact_summary.retrieve'
813 my( $self, $conn, $auth, $id) = @_;
815 my $e = new_editor(xact => 1, authtoken=>$auth);
816 return $e->event unless $e->checkauth;
817 my ($mbts) = $U->fetch_mbts($id, $e);
819 my $user = $e->retrieve_actor_user($mbts->usr)
820 or return $e->die_event;
822 return $e->die_event unless $e->allowed('VIEW_TRANSACTION', $user->home_ou);
828 __PACKAGE__->register_method(
829 method => 'desk_payments',
830 api_name => 'open-ils.circ.money.org_unit.desk_payments'
833 my( $self, $conn, $auth, $org, $start_date, $end_date ) = @_;
834 my $e = new_editor(authtoken=>$auth);
835 return $e->event unless $e->checkauth;
836 return $e->event unless $e->allowed('VIEW_TRANSACTION', $org);
837 my $data = $U->storagereq(
838 'open-ils.storage.money.org_unit.desk_payments.atomic',
839 $org, $start_date, $end_date );
841 $_->workstation( $_->workstation->name ) for(@$data);
846 __PACKAGE__->register_method(
847 method => 'user_payments',
848 api_name => 'open-ils.circ.money.org_unit.user_payments'
852 my( $self, $conn, $auth, $org, $start_date, $end_date ) = @_;
853 my $e = new_editor(authtoken=>$auth);
854 return $e->event unless $e->checkauth;
855 return $e->event unless $e->allowed('VIEW_TRANSACTION', $org);
856 my $data = $U->storagereq(
857 'open-ils.storage.money.org_unit.user_payments.atomic',
858 $org, $start_date, $end_date );
861 $e->retrieve_actor_card($_->usr->card)->barcode);
863 $e->retrieve_actor_org_unit($_->usr->home_ou)->shortname);
869 __PACKAGE__->register_method(
870 method => 'retrieve_credit_payable_balance',
871 api_name => 'open-ils.circ.credit.payable_balance.retrieve',
874 desc => q/Returns the total amount the patron can pay via credit card/,
876 { desc => 'Authentication token', type => 'string' },
877 { desc => 'User id', type => 'number' }
879 return => { desc => 'The ID of the new provider' }
883 sub retrieve_credit_payable_balance {
884 my ( $self, $conn, $auth, $user_id ) = @_;
885 my $e = new_editor(authtoken => $auth);
886 return $e->event unless $e->checkauth;
888 my $user = $e->retrieve_actor_user($user_id)
891 if($e->requestor->id != $user_id) {
892 return $e->event unless $e->allowed('VIEW_USER_TRANSACTIONS', $user->home_ou)
895 my $circ_orgs = $e->json_query({
896 "select" => {circ => ["circ_lib"]},
898 "where" => {usr => $user_id, xact_finish => undef},
902 my $groc_orgs = $e->json_query({
903 "select" => {mg => ["billing_location"]},
905 "where" => {usr => $user_id, xact_finish => undef},
910 for my $org ( @$circ_orgs, @$groc_orgs ) {
911 my $o = $org->{billing_location};
912 $o = $org->{circ_lib} unless $o;
913 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.
914 $hash{$o} = $U->ou_ancestor_setting_value($o, 'credit.payments.allow', $e);
917 my @credit_orgs = map { $hash{$_} ? ($_) : () } keys %hash;
918 $logger->debug("credit: relevant orgs that allow credit payments => @credit_orgs");
921 OpenILS::Application::AppUtils->simplereq('open-ils.actor',
922 'open-ils.actor.user.transactions.have_charge', $auth, $user_id);
926 for my $xact (@$xact_summaries) {
928 # make two lists and grab them in batch XXX
929 if ( $xact->xact_type eq 'circulation' ) {
930 my $circ = $e->retrieve_action_circulation($xact->id) or return $e->event;
931 next unless grep { $_ == $circ->circ_lib } @credit_orgs;
933 } elsif ($xact->xact_type eq 'grocery') {
934 my $bill = $e->retrieve_money_grocery($xact->id) or return $e->event;
935 next unless grep { $_ == $bill->billing_location } @credit_orgs;
936 } elsif ($xact->xact_type eq 'reservation') {
937 my $bill = $e->retrieve_booking_reservation($xact->id) or return $e->event;
938 next unless grep { $_ == $bill->pickup_lib } @credit_orgs;
940 $sum += $xact->balance_owed();