first stab at BoM download
[freeside.git] / httemplate / docs / schema.html
index 63c7953..d9e35ef 100644 (file)
@@ -23,6 +23,7 @@
       </ul>
     <li><a name="cust_bill" href="man/FS/cust_bill.html">cust_bill</a> - Invoices.  Declarations that a customer owes you money.  The specific charges are itemized in <a href="#cust_bill_pkg">cust_bill_pkg</a>.
       <ul>
+        <li>billpkgnum - primary_key
         <li>invnum - primary key
         <li>custnum - <a href="#cust_main">customer</a>
         <li>_date
         <li>amount
         <li>_date
       </ul>
-    <li><a name="cust_pay_batch" href="man/FS/cust_pay_batch.html">cust_pay_batch</a> - Pending batch
+    <li><a name="pay_batch" href="man/FS/pay_batch.html">pay_batch</a> - Pending batch
+      <ul>
+        <li>batchnum
+        <li>status
+      </ul>
+    <li><a name="cust_pay_batch" href="man/FS/cust_pay_batch.html">cust_pay_batch</a> - Pending batch members
       <ul>
         <li>paybatchnum
-        <li>cardnum
+        <li>batchnum
+        <li>payinfo - account number
         <li>exp - card expiration
         <li>amount
         <li>invnum - <a href="#cust_bill">invoice</a>
       </ul>
     <li><a name="reg_code_pkg" href="man/FS/reg_code_pkg.html">reg_code_pkg</A> - Registration code link to package definitions
       <ul>
+        <li>codepkgnum - primary key
         <li>codenum - <a href="#reg_code">Registration code</a>
         <li>pkgpart - <a href="#part_pkg">Package definition</a>
       </ul>
       </ul>
     <li><a name="pkg_svc" href="man/FS/pkg_svc.html">pkg_svc</a>
       <ul>
+        <li>pkgsvcnum - primary key
         <li>pkgpart - <a href="#part_pkg">Package definition</a>
         <li>svcpart - <a href="#part_svc">Service definition</a>
         <li>quantity - quantity of this service that this package includes
         <li>nasport - port number on the NAS
         <li>nasnum - <a href="#nas">NAS</a>
       </ul>
-    <li><a name="prepay_credit" href="man/FS/prepay_credit.html">prepay_credit</a>
+    <li><a name="prepay_credit" href="man/FS/prepay_credit.html">prepay_credit</a> - prepaid cards
       <ul>
         <li>prepaynum - primary key
-        <li>identifier - text or numeric string used to receive this credit
-        <li>amount - amount of credit
+        <li>identifier - text or numeric string of prepaid card
+        <li>amount - amount of prepayment
+        <li>seconds - prepaid time instead of (or in addition to) monetary value
+        <li>agentnum - optional agent assignment for prepaid cards
       </ul>
     <li><a name="session" href="man/FS/session.html">session</a>
       <ul>
       </ul>
     <li><a name="type_pkgs" href="man/FS/type_pkgs.html">type_pkgs</a>
       <ul>
+        <li>typepkgnum - primary key
         <li>typenum - <a href="#agent_type">agent type</a>
         <li>pkgpart - <a href="#part_pkg">Package definition</a>
       </ul>
       </ul>
     <li><a name="rate_detail" href="man/FS/rate_detail.html">rate_detail</a> - Call rate detail
       <ul>
+        <li>ratedetailnum - primary key
         <li>ratenum - <a href="#rate">rate plan</a>
         <li>orig_regionnum - call origination <a href="#rate_region">region</a>
         <li>dest_regionnum - call destination <a href="#rate_region">region</a>