1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
|
<head>
<title>Billing</title>
</head>
<body>
<h1>Billing</h1>
<ul>
<li>To enable billing, you <b>must</b> create an <a href="config.html#invoice_template">invoice_template</a> configuration file. An example file is available in the <i>conf/</i> directory of the distribution. You also need to create an <a href="config.html#lpr">lpr</a> configuration file to enable postal invoices.
<ul>
<li>Optional: Invoice template customization
<ul>
<li>See the <a href="http://search.cpan.org/doc/MJD/Text-Template-1.23/Template.pm">Text::Template</a> documentation for details on the substitution language.
<li>You <b>must</b> 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.
<li>In addition, the following variables are available:
<ul>
<li>$invnum - invoice number
<li>$date - as a UNIX timestamp (see <a href="http://search.cpan.org/doc/GBARR/TimeDate-1.09/lib/Date/Format.pm">Date::Format</a> for conversion functions).
<li>$page - current page
<li>$total_pages - total pages
<li>@address - A six-element array containing the customer name, company, and address.
<li>$overdue - true if this invoice is overdue
</ul>
</ul>
</ul>
<li>You can bill individual customers by clicking on the <i>Bill now</i> link on the main customer view.
<li> The <b>freeside-bill</b> script can be run daily to bill all customers. Usage:<pre>bill [ -c [ i ] ] [ -d <i>date</i> ] [ -b ] <i>user</i></pre>
<ul>
<li>-c: Turn on collecting (you probably want this).
<li>-i: Real-time billing (as opposed to bacth billing). Only relevant for credit cards.
<li>-d: Pretend it is <i>date</i> (parsed by <a href="http://search.cpan.org/doc/GBARR/TimeDate-1.09/lib/Date/Parse.pm">Date::Parse</a>)
<li>-b: N/A
</ul>
<br><br>Batch credit card processing
<ul>
<li>After this script is run, a credit card batch will be in the <a href="schema.html#cust_pay_batch">cust_pay_batch</a> table. Export this table to your credit card batching.
<li>When your batch completes, erase the cust_pay_batch records in that batch and add any necessary paymants to the <a href="schema.html#cust_pay">cust_pay</a> table. Example code to add payments is:
<pre>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
</pre>
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.<br><br>
<li>The <b>freeside-print-batch</b> script can print or email pending credit card batches for manual entry. Usage: freeside-print-batch [-v] [-p] [-e] [-a] [-d] <i>user</i>
<ul>
<li>-v: Verbose - Prints records to STDOUT.
<li>-p: Print to printer lpr as found in the conf directory.
<li>-e: Email output to user found in the Conf email file.
<li>-a: Automatically pays all records in cust_pay_batch. Use -d with this option usually.
<li>-d: Delete - Pays account and deletes record from cust_pay_batch.
</ul>
</ul>
</ul>
</body>
|
