X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=httemplate%2Fdocs%2Fschema.html;h=2b8b3a1324e9063630007e7a57a8ec26f4842026;hb=ec43c49b63208a39acc00290992dbc47b2d5034b;hp=0da33a5c29078532659b6a2e2be194fe9fad8c57;hpb=0fd508f695b4f19a447eba7663f59dc7fb4033d3;p=freeside.git diff --git a/httemplate/docs/schema.html b/httemplate/docs/schema.html index 0da33a5c2..2b8b3a132 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).
- _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, 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
- _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_main - Customers
- 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,20 +131,39 @@
county
country
tax - % rate +
taxclass +
exempt_amount +

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, 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. +

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

cust_pay_batch - Pending batch

trancode - 77 for charges +
paybatchnum
cardnum
exp - card expiration
amount @@ -136,16 +190,26 @@
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
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 +
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

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 +
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

svcpart - Service definition
quantity - quantity of this service that this package includes

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

portnum - primary key @@ -216,6 +315,7 @@
svcnum - primary key
username
_password +
sec_phrase - security phrase
popnum - Point of Presence
uid
gid @@ -224,7 +324,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

part_pop_local - Local calling areas +

localnum - primary key +
popnum - primary key +
city +
state +
npa - area code +
nxx - exchange +

svc_acct_sm - DEPRECIATED Domain mail aliases

svcnum - primary key @@ -274,5 +386,39 @@
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 +

msgcat - i18n message catalog +

msgnum - primary key +
msgcode - message code +
locale - locale +
msg - Message text +