X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=httemplate%2Fdocs%2Fschema.html;h=cdb59a2e992ba92a95cf437f612ee19ad96ed56b;hb=a2b0b3e8500b08a5cf017c85693d9649853f8569;hp=06be8960de0b4a96f4f6670eedc549dfd265cbac;hpb=f63c0e821610c885f9f49d301eeccf804e1ca6d3;p=freeside.git diff --git a/httemplate/docs/schema.html b/httemplate/docs/schema.html index 06be8960d..cdb59a2e9 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 @@ -87,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 @@ -168,6 +177,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 @@ -246,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 +
- codepkgnum - primary key +
- codenum - Registration code +
- pkgpart - Package definition +
part_referral - Referral listing
- refnum - primary key @@ -280,9 +323,11 @@
pkg_svc
- pkgsvcnum - primary key
- pkgpart - Package definition
- svcpart - Service definition
- quantity - quantity of this service that this package includes +
- primary_svc - blank or Y: primary service
export_svc
- 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
- domain_record - Domain zone detail
- type_pkgs
  - typepkgnum - primary key
  - typenum - agent type
  - pkgpart - Package definition
  @@ -422,6 +471,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 @@ -429,5 +506,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 +