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 || $e->requestor->home_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},
287 "cvv2" => $cc_args->{cvv2},
290 if ($U->event_code($response)) { # non-success
292 "Credit card payment for user $user_id failed: " .
293 $response->{"textcode"} . " " .
294 $response->{"payload"}->{"error_message"}
299 # We need to save this for later in case there's a failure on
300 # the EG side to store the processor's result.
301 $cc_payload = $response->{"payload"};
303 $approval_code = $cc_payload->{"authorization"};
304 $cc_type = $cc_payload->{"card_type"};
305 $cc_processor = $cc_payload->{"processor"};
306 $cc_order_number = $cc_payload->{"order_number"};
307 $logger->info("Credit card payment for user $user_id succeeded");
310 return OpenILS::Event->new(
311 'BAD_PARAMS', note => 'Need approval code'
312 ) if not $cc_args->{approval_code};
316 ### RE-OPEN TRANSACTION HERE ###
320 # create payment records
321 my $create_money_method = "create_money_" . $type;
322 for my $payment (@payment_objs) {
323 # update the transaction if it's done
324 my $amount = $payment->amount;
325 my $transid = $payment->xact;
326 my $trans = $xacts{$transid};
327 # making payment with existing patron credit.
328 $credit -= $amount if $type eq 'credit_payment';
329 if( (my $cred = ($trans->balance_owed - $amount)) <= 0 ) {
330 # Any overpay on this transaction goes directly into patron
334 my $circ = $e->retrieve_action_circulation($transid);
336 if(!$circ || $circ->stop_fines) {
337 # If this is a circulation, we can't close the transaction
338 # unless stop_fines is set.
339 $trans = $e->retrieve_money_billable_transaction($transid);
340 $trans->xact_finish("now");
341 if (!$e->update_money_billable_transaction($trans)) {
342 return _recording_failure(
343 $e, "update_money_billable_transaction() failed",
344 $payment, $cc_payload
350 $payment->approval_code($approval_code) if $approval_code;
351 $payment->cc_order_number($cc_order_number) if $cc_order_number;
352 $payment->cc_type($cc_type) if $cc_type;
353 $payment->cc_processor($cc_processor) if $cc_processor;
354 $payment->cc_first_name($cc_args->{'billing_first'}) if $cc_args->{'billing_first'};
355 $payment->cc_last_name($cc_args->{'billing_last'}) if $cc_args->{'billing_last'};
356 if (!$e->$create_money_method($payment)) {
357 return _recording_failure(
358 $e, "$create_money_method failed", $payment, $cc_payload
362 push(@payment_ids, $payment->id);
365 my $evt = _update_patron_credit($e, $patron, $credit);
367 return _recording_failure(
368 $e, "_update_patron_credit() failed", undef, $cc_payload
372 for my $org_id (keys %orgs) {
373 # calculate penalties for each of the affected orgs
374 $evt = OpenILS::Utils::Penalty->calculate_penalties(
375 $e, $user_id, $org_id
378 return _recording_failure(
379 $e, "calculate_penalties() failed", undef, $cc_payload
384 # update the user to create a new last_xact_id
385 $e->update_actor_user($patron) or return $e->die_event;
386 $patron = $e->retrieve_actor_user($patron) or return $e->die_event;
389 # update the cached user object if a user is making a payment toward
390 # his/her own account
391 $U->simplereq('open-ils.auth', 'open-ils.auth.session.reset_timeout', $auth, 1)
392 if $user_id == $e->requestor->id;
394 return {last_xact_id => $patron->last_xact_id, payments => \@payment_ids};
397 sub _recording_failure {
398 my ($e, $msg, $payment, $payload) = @_;
400 if ($payload) { # If the payment processor already accepted a payment:
401 $logger->error($msg);
402 $logger->error("Payment processor payload: " . Dumper($payload));
403 # payment shouldn't contain CC number
404 $logger->error("Payment: " . Dumper($payment)) if $payment;
408 return new OpenILS::Event(
409 "CREDIT_PROCESSOR_SUCCESS_WO_RECORD",
410 "payload" => $payload
412 } else { # Otherwise, the problem is somewhat less severe:
414 $logger->warn("Payment: " . Dumper($payment)) if $payment;
415 return $e->die_event;
419 sub _update_patron_credit {
420 my($e, $patron, $credit) = @_;
421 return undef if $credit == 0;
422 $patron->credit_forward_balance($patron->credit_forward_balance + $credit);
423 return OpenILS::Event->new('NEGATIVE_PATRON_BALANCE') if $patron->credit_forward_balance < 0;
424 $e->update_actor_user($patron) or return $e->die_event;
429 __PACKAGE__->register_method(
430 method => "retrieve_payments",
431 api_name => "open-ils.circ.money.payment.retrieve.all_",
432 notes => "Returns a list of payments attached to a given transaction"
434 sub retrieve_payments {
435 my( $self, $client, $login, $transid ) = @_;
438 $apputils->checksesperm($login, 'VIEW_TRANSACTION');
441 # XXX the logic here is wrong.. we need to check the owner of the transaction
442 # to make sure the requestor has access
444 # XXX grab the view, for each object in the view, grab the real object
446 return $apputils->simplereq(
448 'open-ils.cstore.direct.money.payment.search.atomic', { xact => $transid } );
452 __PACKAGE__->register_method(
453 method => "retrieve_payments2",
455 api_name => "open-ils.circ.money.payment.retrieve.all",
456 notes => "Returns a list of payments attached to a given transaction"
459 sub retrieve_payments2 {
460 my( $self, $client, $login, $transid ) = @_;
462 my $e = new_editor(authtoken=>$login);
463 return $e->event unless $e->checkauth;
464 return $e->event unless $e->allowed('VIEW_TRANSACTION');
467 my $pmnts = $e->search_money_payment({ xact => $transid });
469 my $type = $_->payment_type;
470 my $meth = "retrieve_money_$type";
471 my $p = $e->$meth($_->id) or return $e->event;
472 $p->payment_type($type);
473 $p->cash_drawer($e->retrieve_actor_workstation($p->cash_drawer))
474 if $p->has_field('cash_drawer');
475 push( @payments, $p );
481 __PACKAGE__->register_method(
482 method => "format_payment_receipt",
483 api_name => "open-ils.circ.money.payment_receipt.print",
485 desc => 'Returns a printable receipt for the specified payments',
487 { desc => 'Authentication token', type => 'string'},
488 { desc => 'Payment ID or array of payment IDs', type => 'number' },
491 desc => q/An action_trigger.event object or error event./,
496 __PACKAGE__->register_method(
497 method => "format_payment_receipt",
498 api_name => "open-ils.circ.money.payment_receipt.email",
500 desc => 'Emails a receipt for the specified payments to the user associated with the first payment',
502 { desc => 'Authentication token', type => 'string'},
503 { desc => 'Payment ID or array of payment IDs', type => 'number' },
506 desc => q/Undefined on success, otherwise an error event./,
512 sub format_payment_receipt {
513 my($self, $conn, $auth, $mp_id) = @_;
516 if (ref $mp_id ne 'ARRAY') {
517 $mp_ids = [ $mp_id ];
522 my $for_print = ($self->api_name =~ /print/);
523 my $for_email = ($self->api_name =~ /email/);
525 # manually use xact (i.e. authoritative) so we can kill the cstore
526 # connection before sending the action/trigger request. This prevents our cstore
527 # backend from sitting idle while A/T (which uses its own transactions) runs.
528 my $e = new_editor(xact => 1, authtoken => $auth);
529 return $e->die_event unless $e->checkauth;
532 for my $id (@$mp_ids) {
534 my $payment = $e->retrieve_money_payment([
542 ]) or return $e->die_event;
544 return $e->die_event unless
545 $e->requestor->id == $payment->xact->usr->id or
546 $e->allowed('VIEW_TRANSACTION', $payment->xact->usr->home_ou);
548 push @$payments, $payment;
555 return $U->fire_object_event(undef, 'money.format.payment_receipt.print', $payments, $$payments[0]->xact->usr->home_ou);
557 } elsif ($for_email) {
559 for my $p (@$payments) {
560 $U->create_events_for_hook('money.format.payment_receipt.email', $p, $p->xact->usr->home_ou, undef, undef, 1);
567 __PACKAGE__->register_method(
568 method => "create_grocery_bill",
569 api_name => "open-ils.circ.money.grocery.create",
571 Creates a new grocery transaction using the transaction object provided
572 PARAMS: (login_session, money.grocery (mg) object)
575 sub create_grocery_bill {
576 my( $self, $client, $login, $transaction ) = @_;
578 my( $staff, $evt ) = $apputils->checkses($login);
580 $evt = $apputils->check_perms($staff->id,
581 $transaction->billing_location, 'CREATE_TRANSACTION' );
585 $logger->activity("Creating grocery bill " . Dumper($transaction) );
587 $transaction->clear_id;
588 my $session = $apputils->start_db_session;
589 $apputils->set_audit_info($session, $login, $staff->id, $staff->wsid);
590 my $transid = $session->request(
591 'open-ils.storage.direct.money.grocery.create', $transaction)->gather(1);
593 throw OpenSRF::EX ("Error creating new money.grocery") unless defined $transid;
595 $logger->debug("Created new grocery transaction $transid");
597 $apputils->commit_db_session($session);
599 my $e = new_editor(xact=>1);
600 $evt = _check_open_xact($e, $transid);
608 __PACKAGE__->register_method(
609 method => 'fetch_reservation',
610 api_name => 'open-ils.circ.booking.reservation.retrieve'
612 sub fetch_reservation {
613 my( $self, $conn, $auth, $id ) = @_;
614 my $e = new_editor(authtoken=>$auth);
615 return $e->event unless $e->checkauth;
616 return $e->event unless $e->allowed('VIEW_TRANSACTION'); # eh.. basically the same permission
617 my $g = $e->retrieve_booking_reservation($id)
622 __PACKAGE__->register_method(
623 method => 'fetch_grocery',
624 api_name => 'open-ils.circ.money.grocery.retrieve'
627 my( $self, $conn, $auth, $id ) = @_;
628 my $e = new_editor(authtoken=>$auth);
629 return $e->event unless $e->checkauth;
630 return $e->event unless $e->allowed('VIEW_TRANSACTION'); # eh.. basically the same permission
631 my $g = $e->retrieve_money_grocery($id)
637 __PACKAGE__->register_method(
638 method => "billing_items",
639 api_name => "open-ils.circ.money.billing.retrieve.all",
642 desc => 'Returns a list of billing items for the given transaction ID. ' .
643 'If the operator is not the owner of the transaction, the VIEW_TRANSACTION permission is required.',
645 { desc => 'Authentication token', type => 'string'},
646 { desc => 'Transaction ID', type => 'number'}
649 desc => 'Transaction object, event on error'
655 my( $self, $client, $login, $transid ) = @_;
657 my( $trans, $evt ) = $U->fetch_billable_xact($transid);
661 ($staff, $evt ) = $apputils->checkses($login);
664 if($staff->id ne $trans->usr) {
665 $evt = $U->check_perms($staff->id, $staff->home_ou, 'VIEW_TRANSACTION');
669 return $apputils->simplereq( 'open-ils.cstore',
670 'open-ils.cstore.direct.money.billing.search.atomic', { xact => $transid } )
674 __PACKAGE__->register_method(
675 method => "billing_items_create",
676 api_name => "open-ils.circ.money.billing.create",
678 Creates a new billing line item
679 PARAMS( login, bill_object (mb) )
682 sub billing_items_create {
683 my( $self, $client, $login, $billing ) = @_;
685 my $e = new_editor(authtoken => $login, xact => 1);
686 return $e->die_event unless $e->checkauth;
687 return $e->die_event unless $e->allowed('CREATE_BILL');
689 my $xact = $e->retrieve_money_billable_transaction($billing->xact)
690 or return $e->die_event;
692 # if the transaction was closed, re-open it
693 if($xact->xact_finish) {
694 $xact->clear_xact_finish;
695 $e->update_money_billable_transaction($xact)
696 or return $e->die_event;
699 my $amt = $billing->amount;
701 $billing->amount($amt);
703 $e->create_money_billing($billing) or return $e->die_event;
704 my $evt = OpenILS::Utils::Penalty->calculate_penalties($e, $xact->usr, $U->xact_org($xact->id,$e));
707 $evt = _check_open_xact($e, $xact->id, $xact);
716 __PACKAGE__->register_method(
717 method => 'void_bill',
718 api_name => 'open-ils.circ.money.billing.void',
721 @param authtoken Login session key
722 @param billid Id for the bill to void. This parameter may be repeated to reference other bills.
723 @return 1 on success, Event on error
727 my( $s, $c, $authtoken, @billids ) = @_;
729 my $e = new_editor( authtoken => $authtoken, xact => 1 );
730 return $e->die_event unless $e->checkauth;
731 return $e->die_event unless $e->allowed('VOID_BILLING');
734 for my $billid (@billids) {
736 my $bill = $e->retrieve_money_billing($billid)
737 or return $e->die_event;
739 my $xact = $e->retrieve_money_billable_transaction($bill->xact)
740 or return $e->die_event;
742 if($U->is_true($bill->voided)) {
744 return OpenILS::Event->new('BILL_ALREADY_VOIDED', payload => $bill);
747 my $org = $U->xact_org($bill->xact, $e);
748 $users{$xact->usr} = {} unless $users{$xact->usr};
749 $users{$xact->usr}->{$org} = 1;
752 $bill->voider($e->requestor->id);
753 $bill->void_time('now');
755 $e->update_money_billing($bill) or return $e->die_event;
756 my $evt = _check_open_xact($e, $bill->xact, $xact);
760 # calculate penalties for all user/org combinations
761 for my $user_id (keys %users) {
762 for my $org_id (keys %{$users{$user_id}}) {
763 OpenILS::Utils::Penalty->calculate_penalties($e, $user_id, $org_id);
771 __PACKAGE__->register_method(
772 method => 'edit_bill_note',
773 api_name => 'open-ils.circ.money.billing.note.edit',
775 Edits the note for a bill
776 @param authtoken Login session key
777 @param note The replacement note for the bills we're editing
778 @param billid Id for the bill to edit the note of. This parameter may be repeated to reference other bills.
779 @return 1 on success, Event on error
783 my( $s, $c, $authtoken, $note, @billids ) = @_;
785 my $e = new_editor( authtoken => $authtoken, xact => 1 );
786 return $e->die_event unless $e->checkauth;
787 return $e->die_event unless $e->allowed('UPDATE_BILL_NOTE');
789 for my $billid (@billids) {
791 my $bill = $e->retrieve_money_billing($billid)
792 or return $e->die_event;
795 # 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.
797 $e->update_money_billing($bill) or return $e->die_event;
804 __PACKAGE__->register_method(
805 method => 'edit_payment_note',
806 api_name => 'open-ils.circ.money.payment.note.edit',
808 Edits the note for a payment
809 @param authtoken Login session key
810 @param note The replacement note for the payments we're editing
811 @param paymentid Id for the payment to edit the note of. This parameter may be repeated to reference other payments.
812 @return 1 on success, Event on error
815 sub edit_payment_note {
816 my( $s, $c, $authtoken, $note, @paymentids ) = @_;
818 my $e = new_editor( authtoken => $authtoken, xact => 1 );
819 return $e->die_event unless $e->checkauth;
820 return $e->die_event unless $e->allowed('UPDATE_PAYMENT_NOTE');
822 for my $paymentid (@paymentids) {
824 my $payment = $e->retrieve_money_payment($paymentid)
825 or return $e->die_event;
827 $payment->note($note);
828 # 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.
830 $e->update_money_payment($payment) or return $e->die_event;
837 sub _check_open_xact {
838 my( $editor, $xactid, $xact ) = @_;
840 # Grab the transaction
841 $xact ||= $editor->retrieve_money_billable_transaction($xactid);
842 return $editor->event unless $xact;
843 $xactid ||= $xact->id;
845 # grab the summary and see how much is owed on this transaction
846 my ($summary) = $U->fetch_mbts($xactid, $editor);
848 # grab the circulation if it is a circ;
849 my $circ = $editor->retrieve_action_circulation($xactid);
851 # If nothing is owed on the transaction but it is still open
852 # and this transaction is not an open circulation, close it
854 ( $summary->balance_owed == 0 and ! $xact->xact_finish ) and
855 ( !$circ or $circ->stop_fines )) {
857 $logger->info("closing transaction ".$xact->id. ' becauase balance_owed == 0');
858 $xact->xact_finish('now');
859 $editor->update_money_billable_transaction($xact)
860 or return $editor->event;
864 # If money is owed or a refund is due on the xact and xact_finish
865 # is set, clear it (to reopen the xact) and update
866 if( $summary->balance_owed != 0 and $xact->xact_finish ) {
867 $logger->info("re-opening transaction ".$xact->id. ' becauase balance_owed != 0');
868 $xact->clear_xact_finish;
869 $editor->update_money_billable_transaction($xact)
870 or return $editor->event;
877 __PACKAGE__->register_method (
878 method => 'fetch_mbts',
880 api_name => 'open-ils.circ.money.billable_xact_summary.retrieve'
883 my( $self, $conn, $auth, $id) = @_;
885 my $e = new_editor(xact => 1, authtoken=>$auth);
886 return $e->event unless $e->checkauth;
887 my ($mbts) = $U->fetch_mbts($id, $e);
889 my $user = $e->retrieve_actor_user($mbts->usr)
890 or return $e->die_event;
892 return $e->die_event unless $e->allowed('VIEW_TRANSACTION', $user->home_ou);
898 __PACKAGE__->register_method(
899 method => 'desk_payments',
900 api_name => 'open-ils.circ.money.org_unit.desk_payments'
903 my( $self, $conn, $auth, $org, $start_date, $end_date ) = @_;
904 my $e = new_editor(authtoken=>$auth);
905 return $e->event unless $e->checkauth;
906 return $e->event unless $e->allowed('VIEW_TRANSACTION', $org);
907 my $data = $U->storagereq(
908 'open-ils.storage.money.org_unit.desk_payments.atomic',
909 $org, $start_date, $end_date );
911 $_->workstation( $_->workstation->name ) for(@$data);
916 __PACKAGE__->register_method(
917 method => 'user_payments',
918 api_name => 'open-ils.circ.money.org_unit.user_payments'
922 my( $self, $conn, $auth, $org, $start_date, $end_date ) = @_;
923 my $e = new_editor(authtoken=>$auth);
924 return $e->event unless $e->checkauth;
925 return $e->event unless $e->allowed('VIEW_TRANSACTION', $org);
926 my $data = $U->storagereq(
927 'open-ils.storage.money.org_unit.user_payments.atomic',
928 $org, $start_date, $end_date );
931 $e->retrieve_actor_card($_->usr->card)->barcode);
933 $e->retrieve_actor_org_unit($_->usr->home_ou)->shortname);
939 __PACKAGE__->register_method(
940 method => 'retrieve_credit_payable_balance',
941 api_name => 'open-ils.circ.credit.payable_balance.retrieve',
944 desc => q/Returns the total amount the patron can pay via credit card/,
946 { desc => 'Authentication token', type => 'string' },
947 { desc => 'User id', type => 'number' }
949 return => { desc => 'The ID of the new provider' }
953 sub retrieve_credit_payable_balance {
954 my ( $self, $conn, $auth, $user_id ) = @_;
955 my $e = new_editor(authtoken => $auth);
956 return $e->event unless $e->checkauth;
958 my $user = $e->retrieve_actor_user($user_id)
961 if($e->requestor->id != $user_id) {
962 return $e->event unless $e->allowed('VIEW_USER_TRANSACTIONS', $user->home_ou)
965 my $circ_orgs = $e->json_query({
966 "select" => {circ => ["circ_lib"]},
968 "where" => {usr => $user_id, xact_finish => undef},
972 my $groc_orgs = $e->json_query({
973 "select" => {mg => ["billing_location"]},
975 "where" => {usr => $user_id, xact_finish => undef},
980 for my $org ( @$circ_orgs, @$groc_orgs ) {
981 my $o = $org->{billing_location};
982 $o = $org->{circ_lib} unless $o;
983 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.
984 $hash{$o} = $U->ou_ancestor_setting_value($o, 'credit.payments.allow', $e);
987 my @credit_orgs = map { $hash{$_} ? ($_) : () } keys %hash;
988 $logger->debug("credit: relevant orgs that allow credit payments => @credit_orgs");
991 OpenILS::Application::AppUtils->simplereq('open-ils.actor',
992 'open-ils.actor.user.transactions.have_charge', $auth, $user_id);
996 for my $xact (@$xact_summaries) {
998 # make two lists and grab them in batch XXX
999 if ( $xact->xact_type eq 'circulation' ) {
1000 my $circ = $e->retrieve_action_circulation($xact->id) or return $e->event;
1001 next unless grep { $_ == $circ->circ_lib } @credit_orgs;
1003 } elsif ($xact->xact_type eq 'grocery') {
1004 my $bill = $e->retrieve_money_grocery($xact->id) or return $e->event;
1005 next unless grep { $_ == $bill->billing_location } @credit_orgs;
1006 } elsif ($xact->xact_type eq 'reservation') {
1007 my $bill = $e->retrieve_booking_reservation($xact->id) or return $e->event;
1008 next unless grep { $_ == $bill->pickup_lib } @credit_orgs;
1010 $sum += $xact->balance_owed();