From 51984ac3d3da3006809c6866fdecd4ad83610731 Mon Sep 17 00:00:00 2001 From: ivan Date: Mon, 30 Jul 2001 07:36:04 +0000 Subject: templates!!! --- httemplate/docs/billing.html | 67 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) create mode 100644 httemplate/docs/billing.html (limited to 'httemplate/docs/billing.html') diff --git a/httemplate/docs/billing.html b/httemplate/docs/billing.html new file mode 100644 index 000000000..7841bf776 --- /dev/null +++ b/httemplate/docs/billing.html @@ -0,0 +1,67 @@ + + 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:
```
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. +
  +
+

+ -- cgit v1.2.1 From 18ed1ed986d3a6d1b7529afa3d448b0e76618fee Mon Sep 17 00:00:00 2001 From: ivan Date: Fri, 16 Nov 2001 10:22:03 +0000 Subject: update link to Text::Template docs --- httemplate/docs/billing.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'httemplate/docs/billing.html') diff --git a/httemplate/docs/billing.html b/httemplate/docs/billing.html index 7841bf776..7dc9aef2d 100644 --- a/httemplate/docs/billing.html +++ b/httemplate/docs/billing.html @@ -8,7 +8,7 @@

Optional: Invoice template customization
- See the Text::Template documentation for details on the substitution language. +
- 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:
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
```
+
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
```
- -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) -
- -b: N/A +
- user: as setup with freeside-adduser
Batch credit card processing
- -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!). -- cgit v1.2.1 From 7e3eb82f87c371785544b706b7347c7edde2b593 Mon Sep 17 00:00:00 2001 From: ivan Date: Sun, 10 Feb 2002 19:58:43 +0000 Subject: update billing documentation for the new world of invoice events added freeside-daily replacing freeside-bill for the new world of invoice events --- httemplate/docs/billing.html | 56 +++++++++++++++----------------------------- 1 file changed, 19 insertions(+), 37 deletions(-) (limited to 'httemplate/docs/billing.html') diff --git a/httemplate/docs/billing.html b/httemplate/docs/billing.html index dcb90208a..de59fc60a 100644 --- a/httemplate/docs/billing.html +++ b/httemplate/docs/billing.html @@ -4,36 +4,26 @@

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: 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. +
- 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 +
-

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 +45,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. +

The freeside-print-batch script can print or email pending credit card batches for manual entry. -- cgit v1.2.1 From 38616a70ddf2b60925af53b605a4ea40a1c51e09 Mon Sep 17 00:00:00 2001 From: ivan Date: Sun, 14 Apr 2002 01:36:35 +0000 Subject: docu for invoice_lines(0) with no arguments --- httemplate/docs/billing.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'httemplate/docs/billing.html') diff --git a/httemplate/docs/billing.html b/httemplate/docs/billing.html index de59fc60a..4a5642af9 100644 --- a/httemplate/docs/billing.html +++ b/httemplate/docs/billing.html @@ -10,7 +10,7 @@

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. +
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 -- cgit v1.2.1 From 9bf26ed4b065b12826fc2980ff277a2f3be25c1d Mon Sep 17 00:00:00 2001 From: ivan Date: Sun, 14 Apr 2002 09:11:22 +0000 Subject: - move cyrus, shellcommands, CP exports exports to new-style - skeleton files for vpopmail exports - documentation updates - add big schema diagram to docs --- httemplate/docs/billing.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'httemplate/docs/billing.html') diff --git a/httemplate/docs/billing.html b/httemplate/docs/billing.html index 4a5642af9..c6ef7a869 100644 --- a/httemplate/docs/billing.html +++ b/httemplate/docs/billing.html @@ -18,7 +18,7 @@
- $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 +

Batch credit card processing @@ -47,6 +47,6 @@ if ( $error ) { 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. + -- cgit v1.2.1 From 17ddcceb66e4c5c45abe890403d2ca98b128d375 Mon Sep 17 00:00:00 2001 From: ivan Date: Tue, 16 Apr 2002 09:38:20 +0000 Subject: - send a notice to the customer when their card is declined - closes: Bug#351 - freeside-expiration-alerter works fine, closes: Bug#7 --- httemplate/docs/billing.html | 2 ++ 1 file changed, 2 insertions(+) (limited to 'httemplate/docs/billing.html') diff --git a/httemplate/docs/billing.html b/httemplate/docs/billing.html index c6ef7a869..c78a87f04 100644 --- a/httemplate/docs/billing.html +++ b/httemplate/docs/billing.html @@ -7,6 +7,8 @@

You can bill individual customers by clicking on the Bill now link on the main customer view.

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

See the Text::Template documentation for details on the substitution language. -- cgit v1.2.1 From 03ea266c86cbaa01900755f754db791a866bf951 Mon Sep 17 00:00:00 2001 From: ivan Date: Thu, 16 Oct 2003 13:48:31 +0000 Subject: fix Text::Template link --- httemplate/docs/billing.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'httemplate/docs/billing.html') diff --git a/httemplate/docs/billing.html b/httemplate/docs/billing.html index c78a87f04..1d6f8c4fc 100644 --- a/httemplate/docs/billing.html +++ b/httemplate/docs/billing.html @@ -11,7 +11,7 @@
Credit card decline alerts: Customize the declinetemplate configuration option and set the emaildecline configuration option.
Optional: Invoice template customization
- See the Text::Template documentation for details on the substitution language. +
- 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: