for now
[freeside.git] / httemplate / docs / schema.html
index c518d4a..b380317 100644 (file)
@@ -12,6 +12,9 @@
         <li>typenum - <a href="#agent_type">agent type</a>
         <li>prog - (unimplemented)
         <li>freq - (unimplemented)
+        <li>disabled - Disabled flag, empty or 'Y'
+        <li>username - Username for the Agent interface
+        <li>_password - Password for the Agent interface
       </ul>
     <li><a name="agent_type" href="man/FS/agent_type.html">agent_type</a> - Agent types define groups of packages that you can then assign to particular agents.
       <ul>
@@ -39,7 +42,7 @@
     <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>payby - CARD, DCRD, CHEK, DCHK, LECB, 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>edate - ending date
         <li>itemdesc - Line item description (currently used only when pkgnum is 0)
       </ul>
+    <li><a name="cust_bill_pkg_detail" href="man/FS/cust_bill_pkg_detail.html">cust_bill_pkg_detail</a> - Invoice line items detail
+      <ul>
+        <li>detailnum - primary key
+        <li>pkgnum -
+        <li>invnum - 
+        <li>detail - Detail description
+      </ul>
     <li><a name="cust_credit" href="man/FS/cust_credit.html">cust_credit</a> - Credits.  The equivalent of a negative <a href="#cust_bill">cust_bill</a> record.
       <ul>
         <li>crednum - primary key
         <li><i>ship_daytime</i>
         <li><i>ship_night</i>
         <li><i>ship_fax</i>
-        <li>payby - CARD, BILL, or COMP
+        <li>payby - CARD, DCHK, CHEK, DCHK, LECB, BILL, or COMP
         <li>payinfo - card number, P.O.#, or comp issuer
+        <li>paycvv - Card Verification Value, "CVV2" (also known as CVC2 or CID), the 3 or 4 digit number on the back (or front, for American Express) of the credit card
         <li>paydate - expiration date
         <li>payname - billing name (name on card)
         <li>tax - tax exempt, Y or null
         <li>taxclass
         <li>exempt_amount
         <li>taxname - if defined, printed on invoices instead of "Tax"
+        <li>setuptax - if 'Y', this tax does not apply to setup fees
+        <li>recurtax - if 'Y', this tax does not apply to recurring fees
       </ul>
     <li><a name="cust_tax_exempt" href="man/FS/cust_tax_exempt.html">cust_tax_exempt</a> - Tax exemption record
       <ul>
         <li>custnum - <a href="#cust_main">customer</a>
         <li>paid - amount
         <li>_date
-        <li>payby - CARD, BILL, or COMP
+        <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>pkgpart - <a href="#part_pkg">Package definition</a>
         <li>setup - date
         <li>bill - next bill date
+        <li>last_bill - last bill date
         <li>susp - (past) suspension date
         <li>expire - (future) cancellation date
         <li>cancel - (past) cancellation date
         <li>custnum - <a href="#cust_main">customer</a>
         <li>refund - amount
         <li>_date
-        <li>payby - CARD, BILL or COMP
+        <li>payby - CARD, CHEK, LECB, BILL or COMP
         <li>payinfo - card number, P.O.#, or comp issuer
         <li>otaker - order taker
         <li>closed - books closed flag, empty or `Y'
         <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>primary_svc - blank or Y: primary service
       </ul>
     <li><a name="export_svc" href="man/FS/export_svc.html">export_svc</a>
       <ul>
       <ul>
         <li>svcnum - <a href="#cust_svc">primary key</a>
         <li>srcsvc - <a href="#svc_acct">svcnum of the source of this forward</a>
+        <li>src - literal source (username or full email address)
         <li>dstsvc - <a href="#svc_acct">svcnum of the destination of this forward</a>
-        <li>dst - foreign destination (email address) - forward not local to freeside
+        <li>dst - literal destination (username or full email address)
       </ul>
     <li><a name="domain_record" href="man/FS/domain_record.html">domain_record</a> - Domain zone detail
       <ul>