To enable billing, you must create an invoice_template configuration file. An example file is available in the conf/ directory of the distribution. You also need to create an lpr configuration file to enable postal invoices.
-
-
Optional: Invoice template customization
-
-
See the Text::Template documentation for details on the substitution language.
-
You must call the invoice_lines() function at least once - pass it a number of lines, and it returns a list of array references, each of two elements: a service description column, and a price column.
-
In addition, the following variables are available:
-
-
$invnum - invoice number
-
$date - as a UNIX timestamp (see Date::Format for conversion functions).
-
$page - current page
-
$total_pages - total pages
-
@address - A six-element array containing the customer name, company, and address.
-
$overdue - true if this invoice is overdue
-
-
-
+
Add one or more Invoice events implmenting your business rules for re-sending invoices, retrying cards, suspending, etc.
You can bill individual customers by clicking on the Bill now link on the main customer view.
-
The freeside-bill script can be run daily to bill all customers. (link to manpage!) Usage:
freeside-bill [ -c [ -p ] [ -a ] [ -i ] ] [ -d date ] user
+
The freeside-daily script should be run daily to bill customers and run invoice collection events.
+
Real-time credit card processing: Install the Business::OnlinePayment module for your processor. Configure the business-onlinepayment configuration option. Disable the default Batch cardinvoice event and add one for Business::OnlinePayment.
+
Credit card decline alerts: Customize the declinetemplate configuration option and set the emaildecline configuration option.
+
Typeset (LaTeX) invoice templates
+
+
Install teTeX and Ghostscript (included with most distributions).
+
Place your logo in EPS (Encapsulated PostScript) format with size 90pt X 36pt (epsffit -c 0 0 90 33 yourlogo.eps >logo.eps) at /usr/local/etc/freeside/conf.your_datasrc/logo.eps.
+
Edit the invoice_latexreturnaddress, invoice_latexfooter, invoice_latexnotes, and invoice_latexsmallfooter configuration options. If you are adventurous, edit invoice_latex as well.
+
+
Plaintext invoice templates
-
-c: Turn on collecting (you probably want this).
-
-p: Apply unapplied payments and credits before collecting (you probably want this too)
-
-a: Call collect even if there isn't a new invoice (probably a bad idea for daily use)
-
-i: Real-time billing (as opposed to bacth billing). Only relevant for credit cards.
-
See the Text::Template documentation for details on the substitution language.
+
You must call the invoice_lines() function at least once - pass it a number of lines, and it returns a list of array references, each of two elements: a service description column, and a price column. Alternatively, call invoice_lines() with no arguments, and pagination will be disabled - all invoice line items will print on one page, with no padding (recommended for email invoices).
+
In addition, the following variables are available:
+
+
$invnum - invoice number
+
$date - as a UNIX timestamp (see Date::Format for conversion functions).
+
$page - current page
+
$total_pages - total pages
+
@address - A six-element array containing the customer name, company, and address.
+
+
-
Batch credit card processing
+
HTML invoice templates
-
After this script is run, a credit card batch will be in the cust_pay_batch table. Export this table to your credit card batching.
+
Place your logo in PNG format at /usr/local/etc/freeside/conf.your_datasrc/logo.png.
+
The following configuration options can be set to override the default behaviour of using the invoice_latex* data: invoice_htmlreturnaddress, and invoice_htmlfooter, invoice_htmlnotes.
+