X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=httemplate%2Fdocs%2Fschema.html;h=cd4914a6c6396823ef831a9b437713cdb2be4c9a;hb=c8cccb4a92adceb943c635fe62dad0d034462ce0;hp=0da33a5c29078532659b6a2e2be194fe9fad8c57;hpb=0fd508f695b4f19a447eba7663f59dc7fb4033d3;p=freeside.git diff --git a/httemplate/docs/schema.html b/httemplate/docs/schema.html index 0da33a5c2..cd4914a6c 100644 --- a/httemplate/docs/schema.html +++ b/httemplate/docs/schema.html @@ -1,8 +1,9 @@ - + Schema reference

Schema reference

+ 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.
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
- 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. +
- creditbillnum - primary key +
- crednum - credit being applied +
- invnum - invoice to which credit is applied +
- 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
- 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
- otaker - order taker +
- referral_custnum +
- comments
(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. @@ -96,21 +152,66 @@
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.

paynum - primary key -
invnum - invoice +
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' +

cust_pay_void - Voided payments. +

paynum - primary key +
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' +
void_date +
reason +
otaker - order taker +

cust_bill_pay - Applicaton of a payment to a specific invoice. +

billpaynum +
invnum - invoice +
paynum - payment +
amount +
_date

cust_pay_batch - Pending batch +

pay_batch - Pending batch

trancode - 77 for charges -
cardnum +
batchnum +
status +
download +
upload +

cust_pay_batch - Pending batch members +

paybatchnum +
batchnum +
payby - CARD, CHEK, LECB, BILL, or COMP +
payinfo - account number
exp - card expiration
amount
invnum - invoice @@ -124,6 +225,7 @@
state
zip
country +
status

cust_pkg - Customer billing items

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.

refundnum - primary key -
crednum - credit +
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. +

creditrefundnum - primary key +
crednum - credit +
refundnum - refund +
amount +
_date

cust_svc - Customer services

pkgpart - primary key
pkg - package name
comment - non-customer visable package comment -
setup - setup fee +
promo_code - promotional code +
deprecated setup - setup fee expression
freq - recurring frequency (months) -
recur - recurring fee +
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 +
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

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 -
table__field - Default or fixed value for field in table +
svcdb - table used for this service: svc_acct, svc_forward, svc_domain, svc_charge or svc_wo +
disabled - Disabled flag, empty or `Y' + +

part_svc_column +
- columnnum - primary key +
- svcpart - Service definition +
- columnname - column name in part_svc.svcdb table +
- columnvalue - default or fixed value for the column +
- columnflag - null, D or F
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 +
- 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
- 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
- svcnum - primary key
- username
- _password +
- sec_phrase - security phrase
- popnum - Point of Presence
- uid
- gid @@ -224,7 +397,10 @@
- shell
- quota - (unimplementd)
- slipip - IP address -
- radius_Radius_Attribute - Radius-Attribute +
- seconds +
- domsvc +
- radius_Radius_Reply_Attribute - Radius-Reply-Attribute +
- rc_Radius_Check_Attribute - Radius-Check-Attribute
svc_acct_pop - Points of Presence
- 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
- type_pkgs
  - typepkgnum - primary key
  - typenum - agent type
  - pkgpart - Package definition
  +
- queue - job queue +
  - jobnum - primary key +
  - job +
  - _date +
  - status +
  - statustext +
  - svcnum +
  +
- queue_arg - job arguments +
  - argnum - primary key +
  - 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 +
  +
- 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 +
  - msgcode - message code +
  - 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 +