From 7e629641070e04dfb480886dc20582974363c0e8 Mon Sep 17 00:00:00 2001 From: Kyle M Hall Date: Mon, 11 Jul 2016 13:55:50 +0000 Subject: [PATCH] Bug 16895 - Allow writeoffs via SIP2 Many SIP2 services such as those by Comprise Technologies are able to or require that an ILS be able to accept writeoffs via SIP2. The SIP2 protocol specifies that payment type be a two digit number, but does not specify a code for writeoffs. To this end we should allow the write-off code to be specified in the SIP2 config on a per-account basis so that if different vendors use different fixed codes for write-offs we can handle that gracefully. Test Plan: 1) Apply this patch 2) Modify your SIP2 config to include payment_type_writeoff="06" in the login portion of the account you will be using for the test. 3) Restart your SIP2 server 4) Create a fee for a patron 5) Send a SIP2 fee paid message specifying the payment type code we defined earlier, with a payment amount that is *not* equal to the amount outstanding for the fee. 6) Note the fee paid response indicates the payment failed 7) Repeat step 5, but this time send the amount outstanding as the payment amount 8) Note that the fee paid response indicates a successful payment 9) Note in Koha that the fee has been written off! Signed-off-by: Rhonda Kuiper Signed-off-by: Marcel de Rooy --- C4/SIP/ILS.pm | 7 +++---- C4/SIP/ILS/Transaction/FeePayment.pm | 22 +++++++++++++++++++--- C4/SIP/Sip/MsgType.pm | 5 ++++- etc/SIPconfig.xml | 2 +- 4 files changed, 27 insertions(+), 9 deletions(-) diff --git a/C4/SIP/ILS.pm b/C4/SIP/ILS.pm index dba0ccbf86..35879afc79 100644 --- a/C4/SIP/ILS.pm +++ b/C4/SIP/ILS.pm @@ -247,10 +247,9 @@ sub end_patron_session { } sub pay_fee { - my ($self, $patron_id, $patron_pwd, $fee_amt, $fee_type, $pay_type, $fee_id, $trans_id, $currency) = @_; - my $trans; + my ($self, $patron_id, $patron_pwd, $fee_amt, $fee_type, $pay_type, $fee_id, $trans_id, $currency, $is_writeoff) = @_; - $trans = C4::SIP::ILS::Transaction::FeePayment->new(); + my $trans = C4::SIP::ILS::Transaction::FeePayment->new(); $trans->transaction_id($trans_id); my $patron; @@ -259,7 +258,7 @@ sub pay_fee { $trans->screen_msg('Invalid patron barcode.'); return $trans; } - my $ok =$trans->pay($patron->{borrowernumber},$fee_amt, $pay_type, $fee_id); + my $ok = $trans->pay( $patron->{borrowernumber}, $fee_amt, $pay_type, $fee_id, $is_writeoff ); $trans->ok($ok); return $trans; diff --git a/C4/SIP/ILS/Transaction/FeePayment.pm b/C4/SIP/ILS/Transaction/FeePayment.pm index 042f07e22e..9cedce568e 100644 --- a/C4/SIP/ILS/Transaction/FeePayment.pm +++ b/C4/SIP/ILS/Transaction/FeePayment.pm @@ -45,8 +45,11 @@ sub pay { my $self = shift; my $borrowernumber = shift; my $amt = shift; - my $type = shift; + my $sip_type = shift; my $fee_id = shift; + my $is_writeoff = shift; + + my $type = $is_writeoff ? 'writeoff' : undef; warn("RECORD:$borrowernumber::$amt"); @@ -55,7 +58,14 @@ sub pay { if ($fee_id) { my $fee = Koha::Account::Lines->find($fee_id); if ( $fee && $fee->amountoutstanding == $amt ) { - $account->pay( { amount => $amt, sip => $type, lines => [$fee] } ); + $account->pay( + { + amount => $amt, + sip => $sip_type, + type => $type, + lines => [$fee], + } + ); return 1; } else { @@ -63,7 +73,13 @@ sub pay { } } else { - $account->pay( { amount => $amt, sip => $type } ); + $account->pay( + { + amount => $amt, + sip => $sip_type, + type => $type, + } + ); return 1; } } diff --git a/C4/SIP/Sip/MsgType.pm b/C4/SIP/Sip/MsgType.pm index 6dde43e35e..5f66e9b881 100644 --- a/C4/SIP/Sip/MsgType.pm +++ b/C4/SIP/Sip/MsgType.pm @@ -1060,6 +1060,9 @@ sub handle_fee_paid { my $status; my $resp = FEE_PAID_RESP; + my $payment_type_writeoff = $server->{account}->{payment_type_writeoff}; + my $is_writeoff = $pay_type eq $payment_type_writeoff; + $fee_amt = $fields->{ (FID_FEE_AMT) }; $inst_id = $fields->{ (FID_INST_ID) }; $patron_id = $fields->{ (FID_PATRON_ID) }; @@ -1069,7 +1072,7 @@ sub handle_fee_paid { $ils->check_inst_id( $inst_id, "handle_fee_paid" ); - $status = $ils->pay_fee( $patron_id, $patron_pwd, $fee_amt, $fee_type, $pay_type, $fee_id, $trans_id, $currency ); + $status = $ils->pay_fee( $patron_id, $patron_pwd, $fee_amt, $fee_type, $pay_type, $fee_id, $trans_id, $currency, $is_writeoff ); $resp .= ( $status->ok ? 'Y' : 'N' ) . timestamp; $resp .= add_field( FID_INST_ID, $inst_id ); diff --git a/etc/SIPconfig.xml b/etc/SIPconfig.xml index 40e495eebc..db259750f5 100644 --- a/etc/SIPconfig.xml +++ b/etc/SIPconfig.xml @@ -44,7 +44,7 @@ - + -- 2.39.5