documentation updates from jason

diff --git a/CREDITS b/CREDITS
index cdfaedc..163e4f1 100644 (file)
--- a/CREDITS
+++ b/CREDITS
@@ -63,11 +63,15 @@ other stuff I can't recall (sorry).
 Stephen Amadei <amadei@dandy.net> contribued portability cleanups for the
 low-level DBI stuff.
 
 Stephen Amadei <amadei@dandy.net> contribued portability cleanups for the
 low-level DBI stuff.
 

-Jason Spence <thalakan@frys.com> contributed admin.html, autocapnames
-javascript, bugfixes & other neat stuff I can't remember.
+Jason Spence <thalakan@frys.com> contributed admin.html and other
+documentation, autocapnames javascript, bugfixes & other neat stuff I can't
+remember.

 
 Brad Dameron <bdameron@tscnet.com> contributed code to do configurable state
 and referral defaults.
 
 
 Brad Dameron <bdameron@tscnet.com> contributed code to do configurable state
 and referral defaults.
 

+Surf and Sip, Inc., <http://www.surfandsip.com> generously sponsored a
+long-requested feature - the session monitor and time-based prepaid cards.
+

 Everything else is my (Ivan Kohler <ivan@420.am>) fault.
 
 Everything else is my (Ivan Kohler <ivan@420.am>) fault.
 

diff --git a/FS/FS/cust_bill.pm b/FS/FS/cust_bill.pm
index 568f272..454a60a 100644 (file)
--- a/FS/FS/cust_bill.pm
+++ b/FS/FS/cust_bill.pm
@@ -65,8 +65,10 @@ FS::cust_bill - Object methods for cust_bill records
 
 =head1 DESCRIPTION
 
 
 =head1 DESCRIPTION
 

-An FS::cust_bill object represents an invoice.  FS::cust_bill inherits from
-FS::Record.  The following fields are currently supported:
+An FS::cust_bill object represents an invoice; a declaration that a customer
+owes you money.  The specific charges are itemized as B<cust_bill_pkg> records
+(see L<FS::cust_bill_pkg>).  FS::cust_bill inherits from FS::Record.  The
+following fields are currently supported:

 
 =over 4
 
 
 =over 4
 


@@ -424,7 +426,7 @@ sub print_text {
 
 =head1 VERSION
 
 
 =head1 VERSION
 

-$Id: cust_bill.pm,v 1.4 2000-12-03 15:14:00 ivan Exp $
+$Id: cust_bill.pm,v 1.5 2001-02-11 17:17:39 ivan Exp $

 
 =head1 BUGS
 
 
 =head1 BUGS
 

diff --git a/FS/FS/cust_credit.pm b/FS/FS/cust_credit.pm
index de8c39d..e868537 100644 (file)
--- a/FS/FS/cust_credit.pm
+++ b/FS/FS/cust_credit.pm
@@ -29,7 +29,8 @@ FS::cust_credit - Object methods for cust_credit records
 
 =head1 DESCRIPTION
 
 
 =head1 DESCRIPTION
 

-An FS::cust_credit object represents a credit.  FS::cust_credit inherits from
+An FS::cust_credit object represents a credit; the equivalent of a negative
+B<cust_bill> record (see L<FS::cust_bill>).  FS::cust_credit inherits from

 FS::Record.  The following fields are currently supported:
 
 =over 4
 FS::Record.  The following fields are currently supported:
 
 =over 4


@@ -157,7 +158,7 @@ sub check {
 
 =head1 VERSION
 
 
 =head1 VERSION
 

-$Id: cust_credit.pm,v 1.1 1999-08-04 09:03:53 ivan Exp $
+$Id: cust_credit.pm,v 1.2 2001-02-11 17:17:39 ivan Exp $

 
 =head1 BUGS
 
 
 =head1 BUGS
 

diff --git a/FS/FS/cust_pay.pm b/FS/FS/cust_pay.pm
index e2b9298..728981a 100644 (file)
--- a/FS/FS/cust_pay.pm
+++ b/FS/FS/cust_pay.pm
@@ -29,8 +29,9 @@ FS::cust_pay - Object methods for cust_pay objects
 
 =head1 DESCRIPTION
 
 
 =head1 DESCRIPTION
 

-An FS::cust_pay object represents a payment.  FS::cust_pay inherits from
-FS::Record.  The following fields are currently supported:
+An FS::cust_pay object represents a payment; the transfer of money from a
+customer.  FS::cust_pay inherits from FS::Record.  The following fields are
+currently supported:

 
 =over 4
 
 
 =over 4
 


@@ -172,7 +173,7 @@ sub check {
 
 =head1 VERSION
 
 
 =head1 VERSION
 

-$Id: cust_pay.pm,v 1.1 1999-08-04 09:03:53 ivan Exp $
+$Id: cust_pay.pm,v 1.2 2001-02-11 17:17:39 ivan Exp $

 
 =head1 BUGS
 
 
 =head1 BUGS
 

diff --git a/FS/FS/cust_refund.pm b/FS/FS/cust_refund.pm
index 65254ae..742c9bb 100644 (file)
--- a/FS/FS/cust_refund.pm
+++ b/FS/FS/cust_refund.pm
@@ -30,8 +30,9 @@ FS::cust_refund - Object method for cust_refund objects
 
 =head1 DESCRIPTION
 
 
 =head1 DESCRIPTION
 

-An FS::cust_refund represents a refund.  FS::cust_refund inherits from
-FS::Record.  The following fields are currently supported:
+An FS::cust_refund represents a refund: the transfer of money to a customer;
+equivalent to a negative payment (see L<FS::cust_pay>).  FS::cust_refund
+inherits from FS::Record.  The following fields are currently supported:

 
 =over 4
 
 
 =over 4
 


@@ -171,7 +172,7 @@ sub check {
 
 =head1 VERSION
 
 
 =head1 VERSION
 

-$Id: cust_refund.pm,v 1.1 1999-08-04 09:03:53 ivan Exp $
+$Id: cust_refund.pm,v 1.2 2001-02-11 17:17:39 ivan Exp $

 
 =head1 BUGS
 
 
 =head1 BUGS
 

diff --git a/htdocs/docs/schema.html b/htdocs/docs/schema.html
index 474a350..c617817 100644 (file)
--- a/htdocs/docs/schema.html
+++ b/htdocs/docs/schema.html
@@ -17,7 +17,7 @@
         <li>typenum - primary key
         <li>atype - name of this agent type
       </ul>
         <li>typenum - primary key
         <li>atype - name of this agent type
       </ul>

-    <li><a name="cust_bill">cust_bill</a> - Invoices
+    <li><a name="cust_bill">cust_bill</a> - Invoices.  Declarations that a customer owes you money.  The specific charges are itemized in <a href="#cust_billl_pkg">cust_bill_pkg</a>.

       <ul>
         <li>invnum - primary key
         <li>custnum - <a href="#cust_main">customer</a>
       <ul>
         <li>invnum - primary key
         <li>custnum - <a href="#cust_main">customer</a>


@@ -35,7 +35,7 @@
         <li>sdate - starting date
         <li>edate - ending date
       </ul>
         <li>sdate - starting date
         <li>edate - ending date
       </ul>

-    <li><a name="cust_credit">cust_credit</a> - Credits
+    <li><a name="cust_credit">cust_credit</a> - Credits.  The equivalent of a negative <a href="#cust_bill>cust_bill</a> record.

       <ul>
         <li>crednum - primary key
         <li>custnum - <a href="#cust_main">customer</a>
       <ul>
         <li>crednum - primary key
         <li>custnum - <a href="#cust_main">customer</a>


@@ -87,7 +87,7 @@
         <li>country
         <li>tax - % rate
       </ul>
         <li>country
         <li>tax - % rate
       </ul>

-    <li><a name="cust_pay">cust_pay</a> - Payments
+    <li><a name="cust_pay">cust_pay</a> - Payments.  Money being transferred from a customer.

       <ul>
         <li>paynum - primary key
         <li>invnum - <a href="#cust_bill">invoice</a>
       <ul>
         <li>paynum - primary key
         <li>invnum - <a href="#cust_bill">invoice</a>


@@ -127,7 +127,7 @@
         <li>cancel - (past) cancellation date
         <li>otaker - order taker
       </ul>
         <li>cancel - (past) cancellation date
         <li>otaker - order taker
       </ul>

-    <li><a name="cust_refund">cust_refund</a> - Refunds
+    <li><a name="cust_refund">cust_refund</a> - Refunds.  The transfer of money to a customer; equivalent to a negative <a href="#cust_pay">cust_pay</a> record.

       <ul>
         <li>refundnum - primary key
         <li>crednum - <a href="#cust_credit">credit</a>
       <ul>
         <li>refundnum - primary key
         <li>crednum - <a href="#cust_credit">credit</a>