X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=httemplate%2Fdocs%2Fschema.html;h=b38031777be97df9eeb76a9a8655297a447e1f2d;hb=edf90a3eb4219f72c8962ad86caacf409b896e8f;hp=145d55fc238c64c00c7d8cb4351f5314e04612ee;hpb=60c837e0aaf454dfa0b0c0283dc36928782d1b6c;p=freeside.git
diff --git a/httemplate/docs/schema.html b/httemplate/docs/schema.html
index 145d55fc2..b38031777 100644
--- a/httemplate/docs/schema.html
+++ b/httemplate/docs/schema.html
@@ -3,6 +3,7 @@
Schema reference
+ Schema diagram: as a giant .png or dia source (dia homepage).
- agent - Agents are resellers of your service. Agents may be limited to a subset of your full offerings (via their agent type).
@@ -11,6 +12,9 @@
- typenum - agent type
- prog - (unimplemented)
- freq - (unimplemented)
+
- disabled - Disabled flag, empty or 'Y'
+
- username - Username for the Agent interface
+
- _password - Password for the Agent interface
- agent_type - Agent types define groups of packages that you can then assign to particular agents.
@@ -24,6 +28,29 @@
- _date
- charged - amount of this invoice
- printed - how many times this invoice has been printed automatically
+
- closed - books closed flag, empty or `Y'
+
+ - cust_bill_event - Invoice event history
+
+
- part_bill_event - Invoice event definitions
+
+ - eventpart - primary key
+
- payby - CARD, DCRD, CHEK, DCHK, LECB, BILL, or COMP
+
- event - event name
+
- eventcode - event action
+
- seconds - how long after the invoice date (cust_bill._date) events of this type are triggered
+
- weight - ordering for events with identical seconds
+
- plan - eventcode plan
+
- plandata - additional plan data
+
- disabled - Disabled flag, empty or `Y'
+
- taxclass - Texas tax class flag, empty or "none", "access", or "hosting"
- cust_bill_pkg - Invoice line items
@@ -33,6 +60,14 @@
- recur - recurring fee
- sdate - starting date
- edate - ending date
+
- itemdesc - Line item description (currently used only when pkgnum is 0)
+
+ - cust_bill_pkg_detail - Invoice line items detail
+
+ - detailnum - primary key
+
- pkgnum -
+
- invnum -
+
- detail - Detail description
- cust_credit - Credits. The equivalent of a negative cust_bill record.
@@ -42,6 +77,7 @@
- _date
- otaker - order taker
- reason
+
- closed - books closed flag, empty or `Y'
- cust_credit_bill - Credit invoice application. Links a credit to an invoice.
@@ -83,8 +119,9 @@
- ship_daytime
- ship_night
- ship_fax
-
- payby - CARD, BILL, or COMP
+
- payby - CARD, DCHK, CHEK, DCHK, LECB, BILL, or COMP
- payinfo - card number, P.O.#, or comp issuer
+
- 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
- paydate - expiration date
- payname - billing name (name on card)
- tax - tax exempt, Y or null
@@ -106,6 +143,19 @@
- county
- country
- tax - % rate
+
- taxclass
+
- exempt_amount
+
- taxname - if defined, printed on invoices instead of "Tax"
+
- setuptax - if 'Y', this tax does not apply to setup fees
+
- recurtax - if 'Y', this tax does not apply to recurring fees
+
+ - cust_tax_exempt - Tax exemption record
+
+ - exemptnum - primary key
+
- taxnum - tax rate
+
- year
+
- month
+
- amount
- cust_pay - Payments. Money being transferred from a customer.
@@ -113,9 +163,10 @@
- custnum - customer
- paid - amount
- _date
-
- payby - CARD, BILL, or COMP
+
- payby - CARD, CHEK, LECB, BILL, or COMP
- payinfo - card number, P.O.#, or comp issuer
- paybatch - text field for tracking card processor batches
+
- closed - books closed flag, empty or `Y'
- cust_bill_pay - Applicaton of a payment to a specific invoice.
- cust_pay_batch - Pending batch
- - trancode - 77 for charges
+
- paybatchnum
- cardnum
- exp - card expiration
- amount
@@ -150,6 +201,7 @@
- pkgpart - Package definition
- setup - date
- bill - next bill date
+
- last_bill - last bill date
- susp - (past) suspension date
- expire - (future) cancellation date
- cancel - (past) cancellation date
@@ -162,9 +214,10 @@
- custnum - customer
- refund - amount
- _date
-
- payby - CARD, BILL or COMP
+
- payby - CARD, CHEK, LECB, BILL or COMP
- payinfo - card number, P.O.#, or comp issuer
- otaker - order taker
+
- closed - books closed flag, empty or `Y'
- cust_credit_refund - Applicaton of a refund to a specific credit.
@@ -200,6 +253,7 @@
- recurtax - Recurring fee tax exempt flag, empty or `Y'
- plan - price plan
- plandata - additional price plan data
+
- disabled - Disabled flag, empty or `Y'
- part_referral - Referral listing
@@ -210,7 +264,8 @@
- svcpart - primary key
- svc - name of this service
-
- svcdb - table used for this service: svc_acct, svc_acct_sm, svc_forward, svc_domain, svc_charge or svc_wo
+
- svcdb - table used for this service: svc_acct, svc_forward, svc_domain, svc_charge or svc_wo
+
- disabled - Disabled flag, empty or `Y'
@@ -228,6 +283,27 @@
- pkgpart - Package definition
- svcpart - Service definition
- quantity - quantity of this service that this package includes
+
- primary_svc - blank or Y: primary service
+
+ - export_svc
+
+
- part_export - Export to external provisioning
+
+ - exportnum - primary key
+
- machine - Machine name
+
- exporttype - Export type
+
- nodomain - blank or Y: usernames are exported to this service with no domain
+
+ - part_export_option - provisioning options
+
+ - optionnum - primary key
+
- exportnum - Export
+
- optionname - option name
+
- optionvalue - option value
- port - individual port on a nas
@@ -256,6 +332,7 @@
- svcnum - primary key
- username
- _password
+
- sec_phrase - security phrase
- popnum - Point of Presence
- uid
- gid
@@ -287,13 +364,6 @@
- npa - area code
- nxx - exchange
- - svc_acct_sm - DEPRECIATED Domain mail aliases
-
- svc_domain - Domains
- svcnum - primary key
@@ -303,8 +373,9 @@
- domain_record - Domain zone detail
@@ -332,6 +403,8 @@
- job
- _date
- status
+
- statustext
+
- svcnum
- queue_arg - job arguments
@@ -339,5 +412,24 @@
- jobnum - job
- arg - argument
+ - queue_depend - job dependancies
+
+ - dependnum - primary key
+
- jobnum - source jobnum
+
- depend_jobnum - dependancy jobnum
+
+ - radius_usergroup - Link users to RADIUS groups.
+
+ - usergroupnum - primary key
+
- svcnum - account
+
- groupname
+
+ - msgcat - i18n message catalog
+
+ - msgnum - primary key
+
- msgcode - message code
+
- locale - locale
+
- msg - Message text
+