My Invoice Template/Invoice Designs/Invoice Design Settings

From Emersion
Revision as of 09:55, 19 October 2017 by Dcowan (talk) (added see also)
Jump to: navigation, search


Overview

Whilst most invoice design settings are self-explanatory and do have a small description attached to assist you with how to use a particular design, some design settings may need a little bit extra documentation where the implementation rules are not able to be adequately described in a small description text field.

Days Offset

This design setting only accepts a positive number. This design setting can be referenced in other design settings. (eg. Automated Payment Text)
This value will be used in the (Invoice Due Date less Days Offset) calculation to determine the value of the :p_auto_payment_date output.

Automated Payment Text

If the payment method is Direct Debit or Credit Card, the text contained in this setting, along with a small solid border will be included directly below the "Account Details" section of a standard invoice layout (this position may vary if you have a custom invoice layout). The following variables can be placed inside the automated payment text field and will be expanded out to real values when an invoice is rendered.

 :p_surcharge Where a customer has either either % or $ based additional finance charges (surcharges), the system will print the value of those here. See Admin/Payment Details
 :p_payment_method This will either print 'credit card' or 'direct debit' - depending on the customer (Automated) Payment Method setting. See Account Management/Customer Screen/Payment Methods
 :p_days_offset This field only accepts a positive number. This value will be used in the (Invoice Due Date less Days Offset) calculation to determine the value of the :p_auto_payment_date.

Note: It is not mandatory to reference this particular variable in the Automated Payment Text design setting. If it is referenced, only the stored value will print in its place.
(eg. If the value is '2', then only the literal number '2' will print out on an invoice)

 :p_auto_payment_date Used in conjunction with :p_days_offset. Can only be reference in the Automated Payment Text design setting text field.

This is not an invoice design setting of its own, rather it is a simple variable to indicate you wish the system to perform a calculation (Invoice Due Date less Days Offset) and print the resulting date in the format 'DD Mon YYYY' - (eg. 18 Oct 2017).
Special Note: If :p_days_offset has never been set, then this variable will print out as the literal characters they are. See last example below.

An example usage of this design setting is to indicate to customers when an automated payment will be attempted. Customers typically match the Automated Payment Terms (Days) to the :p_days_offset design setting.

  • The following Automated Payment Text design setting value represents a typical scenario
A payment via :p_payment_method will be attempted :p_days_offset days prior to the due date on :p_auto_payment_date. This payment will incur a surcharge of :p_surcharge

Invoice-design-setting-auto-payment-001.png

  • The value of :p_days_offset will change the way this output looks. Using an Invoice Due Date of 20/OCT/2017, the following examples indicate the calculation difference.
  • It is important to note, that a missing :p_days_offset value (ie. you have never entered a value before) will mean :p_auto_payment_date will print out literally - rather than substituting with a calculated date.

Invoice-design-setting-auto-payment-002.png Invoice-design-setting-auto-payment-003.png Invoice-design-setting-auto-payment-004.png

See Also