registration codes
[freeside.git] / httemplate / docs / schema.html
index b380317..8af8aa9 100644 (file)
@@ -1,9 +1,9 @@
-<head>
+
   <title>Schema reference</title>
 </head>
 <body>
   <h1>Schema reference</h1>
-  Schema diagram: <a href="schema.png">as a giant .png</a> or <a href="schema.dia">dia source</a> (<a href="http://www.lysator.liu.se/~alla/dia/">dia homepage</a>).
+  Schema diagram (1.4.1): <a href="schema.png">as a giant .png</a> or <a href="schema.dia">dia source</a> (<a href="http://www.lysator.liu.se/~alla/dia/">dia homepage</a>).
   <ul>
     <li><a name="agent" href="man/FS/agent.html">agent</a> - Agents are resellers of your service.  Agents may be limited to a subset of your full offerings (via their agent type).
       <ul>
         <li>amount - amount applied
         <li>_date
       </ul>
+    <li><a name="cust_pay_refund" href="man/FS/cust_pay_refund.html">cust_credit_bill</a> - Refund payment application.  Links a refund to a payment.
+      <ul>
+        <li>payrefundnum - primary key
+        <li>paynum - <a href="#cust_pay">payment</a>
+        <li>refundnum - <a href="#cust_refund">refund</a>
+        <li>amount - amount applied
+        <li>_date
+      </ul>
     <li><a name="cust_main" href="man/FS/cust_main.html">cust_main</a> - Customers
       <ul>
         <li>custnum - primary key
         <li>paybatch - text field for tracking card processor batches
         <li>closed - books closed flag, empty or `Y'
       </ul>
+    <li><a name="cust_pay-void" href="man/FS/cust_pay_void.html">cust_pay_void</a> - Voided payments.
+      <ul>
+        <li>paynum - primary key
+        <li>custnum - <a href="#cust_main">customer</a>
+        <li>paid - amount
+        <li>_date
+        <li>payby - CARD, CHEK, LECB, BILL, or COMP
+        <li>payinfo - card number, P.O.#, or comp issuer
+        <li>paybatch - text field for tracking card processor batches
+        <li>closed - books closed flag, empty or `Y'
+        <li>void_date
+        <li>reason
+        <li>otaker - order taker
+      </ul>
     <li><a name="cust_bill_pay" href="man/FS/cust_bill_pay.html">cust_bill_pay</a> - Applicaton of a payment to a specific invoice.
       <ul>
         <li>billpaynum
         <li>pkgpart - primary key
         <li>pkg - package name
         <li>comment - non-customer visable package comment
-        <li>setup - setup fee expression
+        <li>promo_code - promotional code
+        <li><i>deprecated</i> setup - setup fee expression
         <li>freq - recurring frequency (months)
-        <li>recur - recurring fee expression
+        <li><i>deprecated</i> recur - recurring fee expression
         <li>setuptax - Setup fee tax exempt flag, empty or `Y'
         <li>recurtax - Recurring fee tax exempt flag, empty or `Y'
         <li>plan - price plan
-        <li>plandata - additional price plan data
+        <li><i>deprecated</i> plandata - additional price plan data
         <li>disabled - Disabled flag, empty or `Y'
       </ul>
+    <li><a name="part_pkg_option" href="man/FS/part_pkg_option.html">part_pkg_option</a> - Package definition options
+      <ul>
+        <li>optionnum - primary key
+        <li>pkgpart - <a href="#part_pkg">Package definition</a>
+        <li>optionname - option name
+        <li>optionvalue - option value
+      </ul>
+    <li><a name="reg_code" href="man/FS/reg_code.html">reg_code</A> - One-time registration codes
+      <ul>
+        <li>codenum - primary key
+        <li>code
+        <li>agentnum - <a href="#agent">Agent</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>codenum - <a href="#reg_code">Registration code</a>
+        <li>pkgpart - <a href="#part_pkg">Package definition</a>
+      </ul>
     <li><a name="part_referral" href="man/FS/part_referral.html">part_referral</a> - Referral listing
       <ul>
         <li>refnum - primary key
         <li>svcnum - <a href="#svc_acct">account</a>
         <li>groupname
       </ul>
+    <li><a name="rate" href="man/FS/rate.html">rate</a> - Call rate plans
+      <ul>
+        <li>ratenum - primary key
+        <li>ratename
+      </ul>
+    <li><a name="rate_detail" href="man/FS/rate_detail.html">rate_detail</a> - Call rate detail
+      <ul>
+        <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>
+        <li>min_included - included minutes
+        <li>min_charge - charge per minute
+        <li>sec_granularity - granularity in seconds, i.e. 6 or 60
+      </ul>
+    <li><a name="rate_region" href="man/FS/rate_region.html">rate_region</a> - Call rate region
+      <ul>
+        <li>regionnum - primary key
+        <li>regionname
+      </ul>
+    <li><a name="rate_prefix" href="man/FS/rate_prefix.html">rate_prefix</a> - Call rate prefix
+      <ul>
+        <li>prefixnum - primary key
+        <li>regionnum <a href="#rate_region">rate region</a>
+        <li>countrycode
+        <li>npa
+        <li>nxx
+      </ul>
     <li><a name="msgcat" href="man/FS/msgcat.html">msgcat</a> - i18n message catalog
       <ul>
         <li>msgnum - primary key