X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=httemplate%2Fdocs%2Fschema.html;h=cdb59a2e992ba92a95cf437f612ee19ad96ed56b;hb=ab7e1f9f9f86bc39c3e2a35f34b6f3ab54efb66b;hp=6ed96d229a1ef4aa1c0db5e2697eeab07c673e60;hpb=a7c1b602f88c177db34477ed4cdc1f72603f8995;p=freeside.git
diff --git a/httemplate/docs/schema.html b/httemplate/docs/schema.html
index 6ed96d229..cdb59a2e9 100644
--- a/httemplate/docs/schema.html
+++ b/httemplate/docs/schema.html
@@ -1,8 +1,9 @@
-
+
Schema reference
Schema reference
+ Schema diagram (1.4.1): 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.
- cust_bill - Invoices. Declarations that a customer owes you money. The specific charges are itemized in cust_bill_pkg.
+ - billpkgnum - primary_key
- invnum - primary key
- custnum - customer
- _date
@@ -38,7 +43,7 @@
- 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
@@ -46,6 +51,7 @@
- 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
@@ -55,6 +61,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.
@@ -74,6 +88,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
@@ -106,8 +128,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
@@ -129,6 +152,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.
@@ -136,11 +172,25 @@
- 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.
- billpaynum
@@ -174,6 +224,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
@@ -186,7 +237,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'
@@ -218,15 +269,35 @@
- pkgpart - primary key
- pkg - package name
- comment - non-customer visable package comment
-
- setup - setup fee expression
+
- promo_code - promotional code
+
- deprecated setup - setup fee expression
- freq - recurring frequency (months)
-
- recur - recurring fee expression
+
- deprecated recur - recurring fee expression
- setuptax - Setup fee tax exempt flag, empty or `Y'
- recurtax - Recurring fee tax exempt flag, empty or `Y'
- plan - price plan
-
- plandata - additional price plan data
+
- deprecated plandata - additional price plan data
- disabled - Disabled flag, empty or `Y'
+ - part_pkg_option - Package definition options
+
+ - optionnum - primary key
+
- pkgpart - Package definition
+
- optionname - option name
+
- optionvalue - option value
+
+ - reg_code - One-time registration codes
+
+ - codenum - primary key
+
- code
+
- agentnum - Agent
+
+ - reg_code_pkg - Registration code link to package definitions
+
- part_referral - Referral listing
- refnum - primary key
@@ -236,7 +307,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'
