Schema updates

[Jason Spence]

Hi -
 
Here's a patch to the schema docs with some of what Ivan was telling
me about cust_refund, cust_bill, etc.  I also stuck a note in there
about the special pkgnum (0) for sales tax cust_bill_pkg items.  That
particular one had took me a few hours to figure out, and I hope that
pointing it out in the docs will save others some time.
 
 - Jason 

-------------- next part --------------
diff -urN freeside/htdocs/docs/CVS/Entries my-freeside/htdocs/docs/CVS/Entries
--- freeside/htdocs/docs/CVS/Entries	Sat Feb 10 22:44:51 2001
+++ my-freeside/htdocs/docs/CVS/Entries	Wed Feb  7 15:04:36 2001
@@ -9,6 +9,7 @@
 /overview.png/1.1/Mon Dec 11 21:57:46 2000//
 /passwd.html/1.1.3.1/Mon Aug 24 03:28:01 1998//
 /postgresql.html/1.1/Tue Apr  6 08:55:12 1999//
+/schema.html/1.10/Tue Nov  7 15:00:37 2000//
 /trouble.html/1.5/Thu Aug  5 07:19:54 1999//
 /upgrade.html/1.1.3.1/Thu Aug 13 04:15:02 1998//
 /upgrade2.html/1.2/Wed Oct 14 06:52:43 1998//
@@ -19,4 +20,3 @@
 /session.html/1.4/Wed Feb  7 23:04:36 2001//
 /signup.html/1.6/Wed Feb  7 23:04:36 2001//
 /upgrade6.html/1.5/Wed Feb  7 23:04:36 2001//
-/schema.html/1.10/Sun Feb 11 06:44:50 2001//
diff -urN freeside/htdocs/docs/schema.html my-freeside/htdocs/docs/schema.html
--- freeside/htdocs/docs/schema.html	Sat Feb 10 22:44:50 2001
+++ my-freeside/htdocs/docs/schema.html	Sat Feb 10 22:53:54 2001
@@ -17,7 +17,9 @@
         <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
+customers owe you money.  The specific charges are itemized in
+cust_bill_pkg.
       <ul>
         <li>invnum - primary key
         <li>custnum - <a href="#cust_main">customer</a>
@@ -29,13 +31,15 @@
     <li><a name="cust_bill_pkg">cust_bill_pkg</a> - Invoice line items
       <ul>
         <li>invnum - (multiple) key
-        <li>pkgnum - <a href="#cust_pkg">package</a>
+        <li>pkgnum - A <a href="#cust_pkg">package</a>.  
+            Set to 0 for the special sales tax package.
         <li>setup - setup fee 
         <li>recur - recurring fee
         <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 cust_bill record.
       <ul>
         <li>crednum - primary key
         <li>custnum - <a href="#cust_main">customer</a>
@@ -87,7 +91,8 @@
         <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 the customer to you.
       <ul>
         <li>paynum - primary key
         <li>invnum - <a href="#cust_bill">invoice</a>
@@ -127,7 +132,8 @@
         <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
+funds from you to the customer.  Equivalent to a negative cust_pay record.
       <ul>
         <li>refundnum - primary key
         <li>crednum - <a href="#cust_credit">credit</a>