X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=httemplate%2Fdocs%2Fschema.html;h=bb18612920d992c73224582bd7ec03d37653fbbd;hb=67b05564568d10ee3833a87f09b752d0319934ba;hp=8a27e0118764302c822693ee60d21d5ba24dc2ff;hpb=958445892a327299ecf08de85b15c0f9545b5e0b;p=freeside.git
diff --git a/httemplate/docs/schema.html b/httemplate/docs/schema.html
index 8a27e0118..bb1861292 100644
--- a/httemplate/docs/schema.html
+++ b/httemplate/docs/schema.html
@@ -1,9 +1,9 @@
-
+
Schema reference
Schema reference
- Schema diagram: as a giant .png or dia source (dia homepage).
+ 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).
- 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
@@ -136,6 +137,7 @@
- otaker - order taker
- referral_custnum
- comments
+
- invoice_ship_address - Y or null, does ship address appear on invoice
(columns in italics are optional)
- cust_main_invoice - Invoice destinations for email invoices. Note that a customer can have many email destinations for their invoice (either literal or via svcnum), but only one postal destination.
@@ -176,6 +178,20 @@
- 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
@@ -184,10 +200,19 @@
- amount
- _date
- cust_pay_batch - Pending batch
+ pay_batch - Pending batch
+
+ - batchnum
+
- status
+
- download
+
- upload
+
+ cust_pay_batch - Pending batch members
- paybatchnum
-
- cardnum
+
- batchnum
+
- payby - CARD, CHEK, LECB, BILL, or COMP
+
- payinfo - account number
- exp - card expiration
- amount
- invnum - invoice
@@ -201,6 +226,7 @@
- state
- zip
- country
+
- status
cust_pkg - Customer billing items
@@ -254,15 +280,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
@@ -288,6 +334,7 @@
pkg_svc
+ - pkgsvcnum - primary key
- pkgpart - Package definition
- svcpart - Service definition
- quantity - quantity of this service that this package includes
@@ -320,11 +367,13 @@
- nasport - port number on the NAS
- nasnum - NAS
- prepay_credit
+ prepay_credit - prepaid cards
- prepaynum - primary key
-
- identifier - text or numeric string used to receive this credit
-
- amount - amount of credit
+
- identifier - text or numeric string of prepaid card
+
- amount - amount of prepayment
+
- seconds - prepaid time instead of (or in addition to) monetary value
+
- agentnum - optional agent assignment for prepaid cards
session
type_pkgs
@@ -432,6 +482,34 @@
svcnum - account
groupname
+ rate - Call rate plans
+
+ - ratenum - primary key
+
- ratename
+
+ rate_detail - Call rate detail
+
+ - ratedetailnum - primary key
+
- ratenum - rate plan
+
- orig_regionnum - call origination region
+
- dest_regionnum - call destination region
+
- min_included - included minutes
+
- min_charge - charge per minute
+
- sec_granularity - granularity in seconds, i.e. 6 or 60
+
+ rate_region - Call rate region
+
+ - regionnum - primary key
+
- regionname
+
+ rate_prefix - Call rate prefix
+
+ - prefixnum - primary key
+
- regionnum - rate region
+
- countrycode
+
- npa
+
- nxx
+
msgcat - i18n message catalog
- msgnum - primary key
@@ -439,5 +517,18 @@
- locale - locale
- msg - Message text
+ clientapi_session - ClientAPI session store
+
+ - sessionnum - primary key
+
- sessionid - session ID
+
- namespace - session namespace
+
+ clientapi_session_field - Client API session store data
+
+ - fieldnum - primary key
+
- sessionnum - session
+
- fieldname
+
- fieldvalue
+
