X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=httemplate%2Fdocs%2Fschema.html;h=8dee8ad9e9db52ca90b76ccfb090a04fa207b9ae;hb=470c3559d5077d2db4779610bbd798d58eaec27f;hp=21da3ecf66b3181077c0fc6c0c1b0ca34477bc53;hpb=1aa750eba2b9b73b4f09f28b9acd748ee3669bd4;p=freeside.git
diff --git a/httemplate/docs/schema.html b/httemplate/docs/schema.html
index 21da3ecf6..8dee8ad9e 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.
- part_bill_event - Invoice event definitions
- eventpart - primary key
-
- payby - CARD, BILL, or COMP
+
- 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
@@ -50,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.
@@ -69,6 +87,14 @@
- amount - amount applied
- _date
+ - cust_credit_bill - Refund payment application. Links a refund to a payment.
+
+ - payrefundnum - primary key
+
- paynum - payment
+
- refundnum - refund
+
- amount - amount applied
+
- _date
+
- cust_main - Customers
- custnum - primary key
@@ -101,8 +127,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
@@ -124,6 +151,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.
@@ -131,10 +171,24 @@
- 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_pay_void - Voided payments.
+
+ - paynum - primary key
+
- custnum - customer
+
- paid - amount
+
- _date
+
- 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'
+
- void_date
+
- reason
+
- otaker - order taker
- cust_bill_pay - Applicaton of a payment to a specific invoice.
@@ -169,6 +223,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
@@ -181,7 +236,7 @@
- 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'
@@ -231,7 +286,7 @@
- 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'
