From 249f7d6cf45f8df5679ac36fc28dd8376e695496 Mon Sep 17 00:00:00 2001 From: Jonathan Prykop Date: Fri, 23 Oct 2015 20:24:40 -0500 Subject: [PATCH] RT#38432: OFM - Send refund receipt [v3 merge] --- FS/FS/Conf.pm | 7 ++++++ FS/FS/cust_refund.pm | 53 +++++++++++++++++++++++++++++++++++++++ FS/FS/msg_template.pm | 12 +++++++++ httemplate/edit/msg_template.html | 8 ++++++ httemplate/view/cust_pay.html | 15 +++++++---- httemplate/view/cust_refund.html | 36 ++++++++++++++++++++++---- 6 files changed, 121 insertions(+), 10 deletions(-) diff --git a/FS/FS/Conf.pm b/FS/FS/Conf.pm index 884ac9d04..7c220b789 100644 --- a/FS/FS/Conf.pm +++ b/FS/FS/Conf.pm @@ -1802,6 +1802,13 @@ and customer address. Include units.', }, { + 'key' => 'refund_receipt_msgnum', + 'section' => 'notification', + 'description' => 'Template to use for manual refund receipts.', + %msg_template_options, + }, + + { 'key' => 'trigger_export_insert_on_payment', 'section' => 'billing', 'description' => 'Enable exports on payment application.', diff --git a/FS/FS/cust_refund.pm b/FS/FS/cust_refund.pm index a3beb9ba4..d156d22a8 100644 --- a/FS/FS/cust_refund.pm +++ b/FS/FS/cust_refund.pm @@ -342,6 +342,59 @@ sub unapplied { sprintf("%.2f", $amount ); } +=item send_receipt HASHREF | OPTION => VALUE ... + +Sends a payment receipt for this payment. + +refund_receipt_msgnum must be configured. + +Available options: + +=over 4 + +=item cust_main + +Customer (FS::cust_main) object (for efficiency). + +=cut + +=back + +=cut + +sub send_receipt { + my $self = shift; + my $opt = ref($_[0]) ? shift : { @_ }; + + my $cust_main = $opt->{'cust_main'} || $self->cust_main; + + my $conf = new FS::Conf; + + my $msgnum = $conf->config('refund_receipt_msgnum', $cust_main->agentnum); + return "No refund_receipt_msgnum configured" unless $msgnum; + + my $msg_template = qsearchs('msg_template',{ msgnum => $msgnum}); + return "Could not load template" + unless $msg_template; + + my $cust_msg = $msg_template->prepare( + 'cust_main' => $cust_main, + 'object' => $self, + 'msgtype' => 'receipt', + ); + return 'Error preparing message' unless $cust_msg; + my $error = $cust_msg->insert; + return $error if $error; + + my $queue = new FS::queue { + 'job' => 'FS::cust_msg::process_send', + 'custnum' => $cust_main->custnum, + }; + $error = $queue->insert( $cust_msg->custmsgnum ); + + return $error; +} + =back =head1 CLASS METHODS diff --git a/FS/FS/msg_template.pm b/FS/FS/msg_template.pm index cb13696a5..9c2b2844d 100644 --- a/FS/FS/msg_template.pm +++ b/FS/FS/msg_template.pm @@ -660,6 +660,18 @@ sub substitutions { $cust_pay->paymask : $cust_pay->decrypt($cust_pay->payinfo) } ], ], + # for refund receipts + 'cust_refund' => [ + 'refundnum', + [ refund => sub { sprintf("%.2f", shift->refund) } ], + [ payby => sub { FS::payby->shortname(shift->payby) } ], + [ date => sub { time2str("%a %B %o, %Y", shift->_date) } ], + [ payinfo => sub { + my $cust_refund = shift; + ($cust_refund->payby eq 'CARD' || $cust_refund->payby eq 'CHEK') ? + $cust_refund->paymask : $cust_refund->decrypt($cust_refund->payinfo) + } ], + ], # for payment decline messages # try to support all cust_pay fields # 'error' is a special case, it contains the raw error from the gateway diff --git a/httemplate/edit/msg_template.html b/httemplate/edit/msg_template.html index c6b2a7d8d..4bfdd626f 100644 --- a/httemplate/edit/msg_template.html +++ b/httemplate/edit/msg_template.html @@ -296,6 +296,13 @@ my %substitutions = ( '$payinfo' => 'Card/account# (masked)', '$error' => 'Decline reason', ], + 'cust_refund' => [ + '$refundnum' => 'Refund#', + '$refund' => 'Refund Amount', + '$payby' => 'Refund method', + '$date' => 'Refund date', + '$payinfo' => 'Card/account# (masked)', + ], ); tie my %sections, 'Tie::IxHash', ( @@ -303,6 +310,7 @@ tie my %sections, 'Tie::IxHash', ( 'service' => 'Service address', 'cust_main' => 'Customer status and payment info', 'cust_pkg' => 'Package fields', +'cust_refund' => 'Refund fields', 'cust_bill' => 'Invoice fields', 'cust_pay' => 'Payment fields', 'svc_acct' => 'Login service fields', diff --git a/httemplate/view/cust_pay.html b/httemplate/view/cust_pay.html index 76a24884a..b34a90818 100644 --- a/httemplate/view/cust_pay.html +++ b/httemplate/view/cust_pay.html @@ -3,8 +3,10 @@ <& /elements/header-popup.html, mt("$thing Receipt") &>
- <% mt('Print') |h %> | - <% mt('Re-email') |h %> + <% mt('Print') |h %> +% if ( $cust_main->invoicing_list_emailonly ) { + | <% mt('Re-email') |h %> +% }

% } elsif ( $link eq 'print' ) { @@ -180,11 +182,13 @@ my $cust_pay = qsearchs({ }); die "$thing #$paynum not found!" unless $cust_pay; +my $cust_main = $cust_pay->cust_main; + my $pr_link = "${p}view/cust_pay.html?link=print;paynum=$paynum;void=$void"; my $email_link = "${p}view/cust_pay.html?link=email;paynum=$paynum;void=$void"; my $custnum = $cust_pay->custnum; -my $display_custnum = $cust_pay->cust_main->display_custnum; +my $display_custnum = $cust_main->display_custnum; my $conf = new FS::Conf; @@ -195,8 +199,9 @@ tie my %payby, 'Tie::IxHash', FS::payby->payby2longname; my $email_error; if ( $link eq 'email' ) { - my $email_error = $cust_pay->send_receipt( - 'manual' => 1, + $email_error = $cust_pay->send_receipt( + 'manual' => 1, + 'cust_main' => $cust_main, ); warn "can't send payment receipt/statement: $email_error" if $email_error; diff --git a/httemplate/view/cust_refund.html b/httemplate/view/cust_refund.html index 319761506..d5f5eb232 100644 --- a/httemplate/view/cust_refund.html +++ b/httemplate/view/cust_refund.html @@ -2,7 +2,12 @@ <& /elements/header-popup.html, mt('Refund Receipt') &> -
<% mt('Print') |h %>

+
+ <% mt('Print') |h %> +% if ( $cust_main->invoicing_list_emailonly ) { + | <% mt('Email') |h %> +% } +
% } elsif ( $link eq 'print' ) { @@ -16,6 +21,12 @@ %>

+% } elsif ( $link eq 'email' ) { +% if ( $email_error ) { + <& /elements/header-popup.html, mt("Error re-emailing receipt: [_1]", $email_error) &> +% } else { + <& /elements/header-popup.html, mt("Re-emailed receipt") &> +% } % } else { <& /elements/header.html, mt('Refund Receipt'), menubar( @@ -26,7 +37,7 @@ % } -% unless ($link eq 'popup' ) { +% unless ($link =~ /^(popup|email)$/ ) { <& /elements/small_custview.html, $custnum, scalar($conf->config('countrydefault')), @@ -91,9 +102,14 @@ window.print(); -% } +% } elsif ( $link eq 'email' ) { -% if ( $link =~ /^(popup|print)$/ ) { + + +% } +% if ( $link =~ /^(popup|print|email)$/ ) { % } else { @@ -125,10 +141,13 @@ my $cust_refund = qsearchs({ }); die "Refund #$refundnum not found!" unless $cust_refund; +my $cust_main = $cust_refund->cust_main; + my $pr_link = "${p}view/cust_refund.html?link=print;refundnum=$refundnum"; +my $email_link = "${p}view/cust_refund.html?link=email;refundnum=$refundnum"; my $custnum = $cust_refund->custnum; -my $display_custnum = $cust_refund->cust_main->display_custnum; +my $display_custnum = $cust_main->display_custnum; my $conf = new FS::Conf; @@ -136,4 +155,11 @@ my $money_char = $conf->config('money_char') || '$'; tie my %payby, 'Tie::IxHash', FS::payby->payby2longname; +my $email_error; + +if ( $link eq 'email' ) { + $email_error = $cust_refund->send_receipt( 'cust_main' => $cust_main ); + warn "can't send refund receipt: $email_error" if $email_error; +} + -- 2.11.0