X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=httemplate%2Fdocs%2Fschema.html;h=2e78f6e9e96809fd9017d52c5165329f6a9fc1d0;hp=07fcb908ef794494af45f00576bca61227b8b96b;hb=48ba2845d0119c56971d5b724661aa37e73b49dd;hpb=9bf26ed4b065b12826fc2980ff277a2f3be25c1d diff --git a/httemplate/docs/schema.html b/httemplate/docs/schema.html index 07fcb908e..2e78f6e9e 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.
- 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 @@ -47,6 +50,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
  - 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.
  - 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 @@ -107,8 +127,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 @@ -130,6 +151,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_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 @@ -175,6 +223,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 @@ -187,7 +236,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' @@ -228,6 +277,13 @@
  - 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 +
- part_referral - Referral listing
  - refnum - primary key @@ -237,7 +293,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'