X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=htdocs%2Fdocs%2Fbilling.html;fp=htdocs%2Fdocs%2Fbilling.html;h=0000000000000000000000000000000000000000;hp=ecb5e1799b9e830943ae7ccf7a89664dbdf80ceb;hb=1d758388ce3b17b8de1ae1d3a8ec39c1026baefc;hpb=e6cf4af2b9d3ffefebe1a3e358f0674f566b56bc diff --git a/htdocs/docs/billing.html b/htdocs/docs/billing.html deleted file mode 100644 index ecb5e1799..000000000 --- a/htdocs/docs/billing.html +++ /dev/null @@ -1,67 +0,0 @@ - - Billing - - -

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. Usage:
```
freeside-bill [ -c [ i ] ] [ -d date ] [ -b ] user
```
-
- -c: Turn on collecting (you probably want this). -
- -i: Real-time billing (as opposed to bacth billing). Only relevant for credit cards. -
- -d: Pretend it is date (parsed by Date::Parse) -
- -b: N/A -
-

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. -
- 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;
-
-# loop over all records in batch
-
-my $payment=create FS::cust_pay (
-  'invnum' => $invnum,
-  'paid' => $paid,
-  '_date' => $_date,
-  'payby' => $payby,
-  'payinfo' => $payinfo,
-  'paybatch' => $paybatch,
-);
-
-my $error=$payment->insert;
-if ( $error ) {
-  #process 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. -
  -
-