RADIUS groups on the way!
[freeside.git] / httemplate / docs / schema.html
index c3cb514..192f56b 100644 (file)
         <li>_date
         <li>charged - amount of this invoice
         <li>printed - how many times this invoice has been printed automatically
+        <li>closed - books closed flag, empty or `Y'
+      </ul>
+    <li><a name="cust_bill_event" href="man/FS/cust_bill_event.html">cust_bill_event</a> - Invoice event history
+      <ul>
+        <li>eventnum - primary key
+        <li>invnum - <a href="#cust_bill">invoice</a>
+        <li>eventpart - <a href="#part_bill_event">event definition</a>
+        <li>_date
+        <li>status
+        <li>statustext
+      </ul>
+    <li><a name="part_bill_event" href="man/FS/part_bill_event.html">part_bill_event</a> - Invoice event definitions
+      <ul>
+        <li>eventpart - primary key
+        <li>payby - CARD, BILL, or COMP
+        <li>event - event name
+        <li>eventcode - event action
+        <li>seconds - how long after the invoice date (<a href="#cust_bill">cust_bill</a>._date) events of this type are triggered
+        <li>weight - ordering for events with identical seconds
+        <li>plan - eventcode plan
+        <li>plandata - additional plan data
+        <li>disabled - Disabled flag, empty or `Y'
       </ul>
     <li><a name="cust_bill_pkg" href="man/FS/cust_bill_pkg.html">cust_bill_pkg</a> - Invoice line items
       <ul>
@@ -42,6 +64,7 @@
         <li>_date
         <li>otaker - order taker
         <li>reason
+        <li>closed - books closed flag, empty or `Y'
       </ul>
     <li><a name="cust_credit_bill" href="man/FS/cust_credit_bill.html">cust_credit_bill</a> - Credit invoice application.  Links a credit to an invoice.
       <ul>
         <li>payby - CARD, 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'
       </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>
       </ul>
     <li><a name="cust_pay_batch" href="man/FS/cust_pay_batch.html">cust_pay_batch</a> - Pending batch
       <ul>
-        <li>trancode - 77 for charges
+        <li>paybatchnum
         <li>cardnum
         <li>exp - card expiration
         <li>amount
         <li>expire - (future) cancellation date
         <li>cancel - (past) cancellation date
         <li>otaker - order taker
+        <li>manual_flag - If this field is set to 1, disables the automatic unsuspensiond of this package when using the <a href="config.html#unsuspendauto">unsuspendauto</a> config file.
       </ul>
     <li><a name="cust_refund" href="man/FS/cust_refund.html">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>payby - CARD, BILL or COMP
         <li>payinfo - card number, P.O.#, or comp issuer
         <li>otaker - order taker
+        <li>closed - books closed flag, empty or `Y'
       </ul>
     <li><a name="cust_credit_refund" href="man/FS/cust_credit_refund.html">cust_credit_refund</a> - Applicaton of a refund to a specific credit.
       <ul>
         <li>pkgpart - primary key
         <li>pkg - package name
         <li>comment - non-customer visable package comment
-        <li>setup - setup fee
+        <li>setup - setup fee expression
         <li>freq - recurring frequency (months)
-        <li>recur - recurring fee
+        <li>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>disabled - Disabled flag, empty or `Y'
       </ul>
     <li><a name="part_referral" href="man/FS/part_referral.html">part_referral</a> - Referral listing
       <ul>
         <li>svcpart - primary key
         <li>svc - name of this service
         <li>svcdb - table used for this service: svc_acct, svc_acct_sm, svc_forward, svc_domain, svc_charge or svc_wo
+        <li>disabled - Disabled flag, empty or `Y'
 <!--        <li><i>table</i>__<i>field</i> - Default or fixed value for <i>field</i> in <i>table</i>
         <li><i>table</i>__<i>field</i>_flag - null, D or F
 -->
         <li>svcpart - <a href="#part_svc">Service definition</a>
         <li>quantity - quantity of this service that this package includes
       </ul>
+    <li><a name="part_export" href="man/FS/part_export.html">part_export</a> - Export to external provisioning
+      <ul>
+        <li>exportnum - primary key
+        <li>svcpart - <a href="#part_svc">Service definition</a>
+        <li>machine - Machine name 
+        <li>exporttype - Export type
+        <li>nodomain - blank or Y: usernames are exported to this service with no domain
+      </ul>
+    <li><a name="part_export_option" href="man/FS/part_export_option.html">part_export_option</a> - provisioning options
+      <ul>
+        <li>optionnum - primary key
+        <li>exportnum - <a href="#part_export">Export</a>
+        <li>optionname - option name
+        <li>optionvalue - option value
+      </ul>
     <li><a name="port" href="man/FS/port.html">port</a> - individual port on a <a href="#nas">nas</a>
       <ul>
         <li>portnum - primary key
         <li>job
         <li>_date
         <li>status
+        <li>statustext
+        <li>svcnum
       </ul>
     <li><a name="queue_arg" href="man/FS/queue_arg.html">queue_arg</a> - job arguments
       <ul>
         <li>jobnum - <a href="#queue">job</a>
         <li>arg - argument
       </ul>
+    <li><a name="radius_usergroup" href="man/FS/radius_usergroup.html">radius_usergroup</a> - Link users to RADIUS groups.
+      <ul>
+        <li>usergroupnum - primary key
+        <li>svcnum - <a href="#svc_acct">account</a>
+        <li>groupname
+      </ul>
   </ul>
 </body>