From ec9e52e13c2fa488e190db6ce2cacfcf3f978676 Mon Sep 17 00:00:00 2001 From: ivan Date: Wed, 9 Aug 2000 11:30:41 +0000 Subject: templatable invoices --- htdocs/docs/billing.html | 57 ++++++++++++++++++++++++++++++++---------------- htdocs/docs/config.html | 3 ++- 2 files changed, 40 insertions(+), 20 deletions(-) (limited to 'htdocs/docs') diff --git a/htdocs/docs/billing.html b/htdocs/docs/billing.html index 46ae1fdad..7841bf776 100644 --- a/htdocs/docs/billing.html +++ b/htdocs/docs/billing.html @@ -3,19 +3,37 @@

Billing

- The freeside-bill script can be run daily to bill all customers. Usage: 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 -

- 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: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
 
@@ -36,13 +54,14 @@ 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-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.
+          
       
   
 
diff --git a/htdocs/docs/config.html b/htdocs/docs/config.html
index c500a3336..e42cfd8e1 100644
--- a/htdocs/docs/config.html
+++ b/htdocs/docs/config.html
@@ -21,7 +21,7 @@ All further configuration files and directories are located in
 `/usr/local/etc/freeside/conf.datasource', for example, 
 `/usr/local/etc/freeside/conf.DBI:Pg:dbname=freeside'
 
-  address - Your company name and address, four lines.
+  
address - This configuration file is no longer used.  See invoice_template instead.
   
apacheroot - The directory containing Apache virtual hosts
   
apachemachine - A machine with the apacheroot directory and user home directories.  The existance of this file enables setup of virtual host directories, and, in conjunction with the `home' configuration file, symlinks into user home directories.
   
apachemachines - Your Apache machines, one per line.  This enables export of `/etc/apache/vhosts.conf', which can be included in your Apache configuration via the Include directive.
@@ -42,6 +42,7 @@ All further configuration files and directories are located in
   
icradius_mysqldest - Destination directory for the MySQL databases, on the ICRADIUS machines.  Defaults to "/usr/local/var/".
   
icradius_mysqlsource - Source directory for for the MySQL radcheck table files, on the Freeside machine.  Defaults to "/usr/local/var/freeside".
   
invoice_from - Return address on email invoices.
+  
invoice_template - Required template file for invoices.  See the section on billing for details.
   
lpr - Print command for paper invoices, for example `lpr -h'.
   
maildisablecatchall - The existance of this file will disable the requirement that each virtual domain have a catch-all mailbox.
   
mxmachines - MX entries for new domains, weight and machine, one per line, with trailing `.'
-- 
cgit v1.2.1