Difference between revisions of "Freeside:1.7:Documentation:Template:payment receipt email"

From Freeside
Jump to: navigation, search
 
Line 1: Line 1:
 
[[Category:Freeside:1.7:Documentation:Template]]
 
[[Category:Freeside:1.7:Documentation:Template]]
 +
 +
This template is emailed to customers when a manual payment is applied.  A customer or support rep can initiate this.  This applies to '''Process credit card''' and '''Process electronic check ([[ACH]])''' payment links.  If the value is set to '''NO''', the template is ignored.
 +
 +
You may configure this template from '''Configuration''', then '''Settings''' then '''payment_receipt_email'''. You can use <code>ctrl-f</code> (or <code>cmd-f</code> on macs) to search on the page.
 +
 +
First, apply a payment to the customer http://420.am/~supaplex/screenshots/post-cash-payment.png
 +
, then they'll receive the payment email like http://420.am/~supaplex/screenshots/received-payment_receipt_email.png
 +
 +
== Defaults ==
 +
 +
On a new install, the checkbox is ticked (enabled).
 +
 +
Default template:
 +
 +
<code>
 +
<pre>
 +
{ $date }
 +
 +
Dear { $name },
 +
 +
This message is to inform you that your payment of ${ $paid } has been
 +
received.
 +
 +
Payment ID: { $paynum }
 +
Date:      { $date }
 +
Amount:    { $paid }
 +
Type:      { $payby } # { $payinfo }
 +
 +
{
 +
  if ( $balance > 0 ) {
 +
    $OUT .= "Your current balance is now \$$balance.\n\n";
 +
  } elsif ( $balance < 0 ) {
 +
    $OUT .= 'You have a credit balance of $'. sprintf("%.2f",0-$balance).
 +
              ".\n".
 +
            "Future charges will be deducted from this balance before billing ".
 +
              "you again.\n\n";
 +
           
 +
  }
 +
}
 +
Thank you for your business.
 +
 +
</pre>
 +
</code>
 +
 +
== Variables ==
  
 
;$date
 
;$date
Line 15: Line 60:
 
;$balance
 
;$balance
 
:New balance
 
:New balance
 +
 +
== See Also ==
 +
 +
* [http://search.cpan.org/perldoc/Text::Template Text::Template Documentation] on [[CPAN]]
 +
* [[Freeside:1.7:Documentation:Administration]]

Revision as of 15:09, 3 March 2008


This template is emailed to customers when a manual payment is applied. A customer or support rep can initiate this. This applies to Process credit card and Process electronic check (ACH) payment links. If the value is set to NO, the template is ignored.

You may configure this template from Configuration, then Settings then payment_receipt_email. You can use ctrl-f (or cmd-f on macs) to search on the page.

First, apply a payment to the customer http://420.am/~supaplex/screenshots/post-cash-payment.png , then they'll receive the payment email like http://420.am/~supaplex/screenshots/received-payment_receipt_email.png

Defaults

On a new install, the checkbox is ticked (enabled).

Default template:

{ $date }

Dear { $name },

This message is to inform you that your payment of ${ $paid } has been
received.

Payment ID: { $paynum }
Date:       { $date }
Amount:     { $paid } 
Type:       { $payby } # { $payinfo }

{
  if ( $balance > 0 ) {
    $OUT .= "Your current balance is now \$$balance.\n\n";
  } elsif ( $balance < 0 ) {
    $OUT .= 'You have a credit balance of $'. sprintf("%.2f",0-$balance).
              ".\n".
            "Future charges will be deducted from this balance before billing ".
              "you again.\n\n";
            
  }
}
Thank you for your business.

Variables

$date
The date
$name
Customer name
$paynum
Freeside payment number
$paid
Amount of payment
$payby
Payment type (Card, Check, Electronic check, etc.)
$payinfo
Masked credit card number or check number
$balance
New balance

See Also