X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=httemplate%2Fdocs%2Fschema.html;h=b38031777be97df9eeb76a9a8655297a447e1f2d;hb=7209026857ada1ec716c728ae966f0fc986b180e;hp=e3fe98096ef10b2dec77b3e15560ef88c5708b7e;hpb=f5266a4d07d116efd732f433d0f4f3a47b143a7d;p=freeside.git diff --git a/httemplate/docs/schema.html b/httemplate/docs/schema.html index e3fe98096..b38031777 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).
- 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.
- _date
- charged - amount of this invoice
- printed - how many times this invoice has been printed automatically +
- closed - books closed flag, empty or `Y' +
+
cust_bill_event - Invoice event history +
- eventnum - primary key +
- invnum - invoice +
- eventpart - event definition +
- _date +
- status +
- statustext +
+
part_bill_event - Invoice event definitions +
- eventpart - primary key +
- 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
- 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.
- _date
- otaker - order taker
- reason +
- closed - books closed flag, empty or `Y'
cust_credit_bill - Credit invoice application. Links a credit to an invoice.
- 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 @@ -106,6 +143,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.
- 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_bill_pay - Applicaton of a payment to a specific invoice.
cust_pay_batch - Pending batch
- trancode - 77 for charges +
- paybatchnum
- cardnum
- exp - card expiration
- amount @@ -150,10 +201,12 @@
- 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
- otaker - order taker +
- manual_flag - If this field is set to 1, disables the automatic unsuspensiond of this package when using the unsuspendauto config file.
cust_refund - Refunds. The transfer of money to a customer; equivalent to a negative cust_pay record.
- 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'
cust_credit_refund - Applicaton of a refund to a specific credit.
- pkgpart - primary key
- pkg - package name
- comment - non-customer visable package comment -
- setup - setup fee +
- setup - setup fee expression
- freq - recurring frequency (months) -
- recur - recurring fee +
- 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 +
- disabled - Disabled flag, empty or `Y'
part_referral - Referral listing
- export_svc +
  - exportsvcnum - primary key +
  - svcpart - Service definition +
  - exportnum - Export +
  +
- part_export - Export to external provisioning +
  - exportnum - primary key +
  - machine - Machine name +
  - exporttype - Export type +
  - nodomain - blank or Y: usernames are exported to this service with no domain +
  +
- part_export_option - provisioning options +
  - optionnum - primary key +
  - exportnum - Export +
  - optionname - option name +
  - optionvalue - option value
- port - individual port on a nas
  - svcnum - primary key
  - username
  - _password +
  - sec_phrase - security phrase
  - popnum - Point of Presence
  - uid
  - gid @@ -273,12 +355,14 @@
  - exch - exchange
  - loc - rest of number
  -
- svc_acct_sm - DEPRECIATED Domain mail aliases +
- part_pop_local - Local calling areas
  - svcnum - primary key -
  - domsvc - Domain (by svcnum) -
  - domuid - Account (by uid) -
  - domuser - domuser @ Domain forwards to Account +
  - localnum - primary key +
  - popnum - primary key +
  - city +
  - state +
  - npa - area code +
  - nxx - exchange
- svc_domain - Domains
  - domain_record - Domain zone detail
    - job
    - _date
    - status +
    - statustext +
    - svcnum
  - queue_arg - job arguments
    - jobnum - job
    - arg - argument
    +
  - queue_depend - job dependancies +
    - dependnum - primary key +
    - jobnum - source jobnum +
    - depend_jobnum - dependancy jobnum +
    +
  - radius_usergroup - Link users to RADIUS groups. +
    - usergroupnum - primary key +
    - svcnum - account +
    - groupname +
    +
  - msgcat - i18n message catalog +
    - msgnum - primary key +
    - msgcode - message code +
    - locale - locale +
    - msg - Message text +