X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=httemplate%2Fdocs%2Fschema.html;h=e9688756be3542d79edf6ef52aff942e438cfc84;hb=6f76f84db8de0e02253dfd551ae254c48855d3f6;hp=a59755e765cca31b3504caa7299af72d3f4738bf;hpb=0ebeec96313dd7edfca340f01f8fbbbac1f4aa1d;p=freeside.git diff --git a/httemplate/docs/schema.html b/httemplate/docs/schema.html index a59755e76..e9688756b 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).
- 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.
- 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 @@ -118,6 +129,7 @@
- ship_fax
- 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 @@ -142,6 +154,8 @@
- 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
- 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 @@ -240,15 +268,34 @@
- 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 +
- codenum - Registration code +
- pkgpart - Package definition +
part_referral - Referral listing
- refnum - primary key @@ -277,6 +324,7 @@
- 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
  - svcnum - account
  - groupname
  +
- rate - Call rate plans +
  - ratenum - primary key +
  - ratename +
  +
- rate_detail - Call rate detail +
  - 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 @@ -423,5 +501,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 +