X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;ds=sidebyside;f=httemplate%2Fdocs%2Fschema.html;h=cd4914a6c6396823ef831a9b437713cdb2be4c9a;hb=cf4ffd334502af562e924c24376333200073ccb8;hp=e3fe98096ef10b2dec77b3e15560ef88c5708b7e;hpb=f5266a4d07d116efd732f433d0f4f3a47b143a7d;p=freeside.git
diff --git a/httemplate/docs/schema.html b/httemplate/docs/schema.html
index e3fe98096..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).
@@ -11,6 +12,9 @@
- 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
+
+
- 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
@@ -33,6 +61,14 @@
- 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.
@@ -42,6 +78,7 @@
- _date
- otaker - order taker
- reason
+
- closed - books closed flag, empty or `Y'
- cust_credit_bill - Credit invoice application. Links a credit to an invoice.
@@ -51,6 +88,14 @@
- 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
@@ -83,8 +128,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
@@ -106,6 +152,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.
@@ -113,9 +172,24 @@
- 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.
@@ -125,10 +199,19 @@
- 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
@@ -142,6 +225,7 @@
- state
- zip
- country
+
- status
- cust_pkg - Customer billing items
@@ -150,10 +234,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.
@@ -161,9 +247,10 @@
- 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.
@@ -192,9 +279,34 @@
- 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
+
- part_referral - Referral listing
@@ -205,7 +317,8 @@
- 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'
@@ -220,9 +333,31 @@
- 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
+
+
- 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
@@ -231,11 +366,13 @@
- 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
@@ -251,6 +388,7 @@
- svcnum - primary key
- username
- _password
+
- sec_phrase - security phrase
- popnum - Point of Presence
- uid
- gid
@@ -273,12 +411,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
@@ -289,8 +429,9 @@
- domain_record - Domain zone detail
- type_pkgs
@@ -318,6 +460,8 @@
- job
- _date
- status
+
- statustext
+
- svcnum
- queue_arg - job arguments
@@ -325,5 +469,65 @@
- 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
+