X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=httemplate%2Fdocs%2Fbilling.html;h=c78a87f0467c1ac09d7434173664f9c5d2f1f394;hb=0b8f79a88503618bca0e18d02aeebdbb1e3b47ba;hp=dcb90208a1bfe79b8f882faa3b4e999058db5e60;hpb=b6b291e9894efecc061aaef6d4af3c510bb32fad;p=freeside.git diff --git a/httemplate/docs/billing.html b/httemplate/docs/billing.html index dcb90208a..c78a87f04 100644 --- a/httemplate/docs/billing.html +++ b/httemplate/docs/billing.html @@ -4,36 +4,28 @@

Billing

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 -
    -
  -
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 card invoice event and add one for Business::OnlinePayment. +
Optional: Credit card expiration alerts: Customize alerter_template configuration option and run freeside-expiration-alerter daily. +
Credit card decline alerts: Customize the declinetemplate configuration option and set the emaildecline configuration option. +
Optional: Invoice template customization
- -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. -
- -d: Pretend it is date (parsed by Date::Parse) -
- user: as setup with freeside-adduser +
- 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 +
Batch credit card processing
- 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. +
- After freeside-daily is run, a credit card batch will be in the cust_pay_batch table. Export this table to your credit card batching.
- When your batch completes, erase the cust_pay_batch records in that batch and add any necessary paymants to the cust_pay table. Example code to add payments is:
```
use FS::cust_pay;
 
@@ -55,16 +47,8 @@ if ( $error ) {
 
 # end loop
 
```
  -All fields except paybatch are contained in the cust_pay_batch table. You can use paybatch field to track particular batches and/or particular transactions within a batch.
  
  -
- The freeside-print-batch script can print or email pending credit card batches for manual entry. Usage: freeside-print-batch [-v] [-p] [-e] [-a] [-d] user -
  - -v: Verbose - Prints records to STDOUT. -
  - -p: Print to printer lpr as found in the conf directory. -
  - -e: Email output to user found in the Conf email file. -
  - -a: Automatically pays all records in cust_pay_batch. Use -d with this option usually. -
  - -d: Delete - Pays account and deletes record from cust_pay_batch. -
  -
-
The freeside-overdue script can list, add postal invoicing, suspend or cancel overdue and/or expired accounts (link to manpage!). +All fields except paybatch are contained in the cust_pay_batch table. You can use paybatch field to track particular batches and/or particular transactions within a batch. +