X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;ds=sidebyside;f=htdocs%2Fdocs%2Fbilling.html;h=ecb5e1799b9e830943ae7ccf7a89664dbdf80ceb;hb=e6cf4af2b9d3ffefebe1a3e358f0674f566b56bc;hp=02bfbd783e1c870a4d3d13d917a88a43e90833e4;hpb=ee11db5df023549e5e4a9bf115b274badfb2f449;p=freeside.git diff --git a/htdocs/docs/billing.html b/htdocs/docs/billing.html index 02bfbd783..ecb5e1799 100644 --- a/htdocs/docs/billing.html +++ b/htdocs/docs/billing.html @@ -3,19 +3,37 @@

Billing

- The bin/bill script can be run daily to bill all customers. Usage: bill [ -c [ i ] ] [ -d date ] [ -b ]

-c: Turn on collecting (you probably want this). -
-i: Real-time billing (as opposed to bacth billing). Only relevant for credit cards. Not available without modifying site_perl/Bill.pm -
-d: Pretend it is date (parsed by Date::Parse) -
-b: N/A -

- Printing should be configured on your freeside machine to print invoices. -

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;
+    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
 
@@ -35,6 +53,15 @@ 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.
+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.
+          
+