X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=httemplate%2Fdocs%2Fschema.html;h=c90f476415ba3504600466c0b7a7cab7489eac30;hp=f68b9d257046de99c4945847bdd286e042ce6257;hb=8c1f9804d9a02c0c054eededeb500c72a640249a;hpb=51984ac3d3da3006809c6866fdecd4ad83610731
diff --git a/httemplate/docs/schema.html b/httemplate/docs/schema.html
index f68b9d257..c90f47641 100644
--- a/httemplate/docs/schema.html
+++ b/httemplate/docs/schema.html
@@ -4,7 +4,7 @@
Schema reference
- - agent - Agents are resellers of your service. Agents may be limited to a subset of your full offerings (via their agent type).
+
- agent - Agents are resellers of your service. Agents may be limited to a subset of your full offerings (via their agent type).
- agentnum - primary key
- agent - name of this agent
@@ -12,12 +12,12 @@
- prog - (unimplemented)
- freq - (unimplemented)
- - agent_type - Agent types define groups of packages that you can then assign to particular agents.
+
- agent_type - Agent types define groups of packages that you can then assign to particular agents.
- typenum - primary key
- atype - name of this agent type
- - cust_bill - Invoices. Declarations that a customer owes you money. The specific charges are itemized in cust_bill_pkg.
+
- cust_bill - Invoices. Declarations that a customer owes you money. The specific charges are itemized in cust_bill_pkg.
- invnum - primary key
- custnum - customer
@@ -25,7 +25,7 @@
- charged - amount of this invoice
- printed - how many times this invoice has been printed automatically
- - cust_bill_pkg - Invoice line items
+
- cust_bill_pkg - Invoice line items
- invnum - (multiple) key
- pkgnum - package or 0 for the special virtual sales tax package
@@ -34,7 +34,7 @@
- sdate - starting date
- edate - ending date
- - cust_credit - Credits. The equivalent of a negative cust_bill record.
+
- cust_credit - Credits. The equivalent of a negative cust_bill record.
- crednum - primary key
- custnum - customer
@@ -43,12 +43,11 @@
- otaker - order taker
- reason
- - cust_main - Customers
+
- cust_main - Customers
- custnum - primary key
- agentnum - agent
- refnum - referral
-
- titlenum - title
- first - name
- last - name
- ss - social security number
@@ -84,13 +83,13 @@
- otaker - order taker
(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.
+
- 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.
- destnum - primary key
- custnum - customer
- dest - Invoice destination. Freeside supports three types of invoice delivery: send directly to a service defined in Freeside, send to an arbitrary email address, or print the invoice to a printer and have someone send it out via snail mail. Freeside determines which method to use based on the contents of the dest field. If the contents are numeric, a svcnum pointing to a valid service is expected in the field. If the contents are a string, a literal email address is expected to be in the field. If the special keyword `POST' is present, the snail mail method is used (which is the default if no cust_main_invoice records exist). Snail mail invoices get their address information from cust_main and are printed with the printer defined in the configuration files.
- - cust_main_county - Tax rates
+
- cust_main_county - Tax rates
- taxnum - primary key
- state
@@ -98,17 +97,25 @@
- country
- tax - % rate
- - cust_pay - Payments. Money being transferred from a customer.
+
- 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
- - cust_pay_batch - Pending batch
+
- cust_bill_pay - Applicaton of a payment to a specific invoice.
+
+
- cust_pay_batch - Pending batch
- trancode - 77 for charges
- cardnum
@@ -126,7 +133,7 @@
- zip
- country
- - cust_pkg - Customer billing items
+
- cust_pkg - Customer billing items
- pkgnum - primary key
- custnum - customer
@@ -138,23 +145,31 @@
- cancel - (past) cancellation date
- otaker - order taker
- - cust_refund - Refunds. The transfer of money to a customer; equivalent to a negative cust_pay record.
+
- 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
- - cust_svc - Customer services
+
- cust_credit_refund - Applicaton of a refund to a specific credit.
+
+ - creditrefundnum - primary key
+
- crednum - credit
+
- refundnum - refund
+
- amount
+
- _date
+
+ - cust_svc - Customer services
-
- nas - Network Access Server (terminal server)
+
- nas - Network Access Server (terminal server)
- nasnum - primary key
- nas - NAS name
@@ -162,7 +177,7 @@
- nasfqdn - NAS fully-qualified domain name
- last - timestamp indicating the last instant the NAS was in a known state (used by the session monitoring).
- - part_pkg - Package definitions
+
- part_pkg - Package definitions
- pkgpart - primary key
- pkg - package name
@@ -171,44 +186,39 @@
- freq - recurring frequency (months)
- recur - recurring fee
- - part_referral - Referral listing
+
- part_referral - Referral listing
- refnum - primary key
- referral - referral
- - part_svc - Service definitions
+
- part_svc - Service definitions
- svcpart - primary key
- svc - name of this service
-
- svcdb - table used for this service: svc_acct, svc_acct_sm, svc_domain, svc_charge or svc_wo
+
- 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
- table__field_flag - null, D or F
- - part_title - Personal titles
-
- - titlenum - primary key
-
- title - personal title (`Dr.' or `Mr.')
-
- - pkg_svc
+
- pkg_svc
-
- port - individual port on a nas
+
- port - individual port on a nas
- portnum - primary key
- ip - IP address of this port
- nasport - port number on the NAS
- nasnum - NAS
- - prepay_credit
+
- prepay_credit
- prepaynum - primary key
- identifier - text or numeric string used to receive this credit
- amount - amount of credit
- - session
+
- session
- sessionnum - primary key
- portnum - Port
@@ -217,7 +227,7 @@
- logout - timestamp indicating the end of this user session. May be null, which indicates a currently open session.
- - svc_acct - Accounts
+
- svc_acct - Accounts
- svcnum - primary key
- username
@@ -232,7 +242,7 @@
- slipip - IP address
- radius_Radius_Attribute - Radius-Attribute
- - svc_acct_pop - Points of Presence
+
- svc_acct_pop - Points of Presence
- popnum - primary key
- city
@@ -241,19 +251,26 @@
- exch - exchange
- loc - rest of number
- - svc_acct_sm - Domain mail aliases
+
- svc_acct_sm - DEPRECIATED Domain mail aliases
-
- svc_domain - Domains
+
- svc_domain - Domains
-
- domain_record - Domain zone detail
+
- svc_forward - Mail forwarding aliases
+
+
- domain_record - Domain zone detail
- recnum - primary key
- svcnum - Domain (by svcnum)
@@ -262,13 +279,13 @@
- rectype - type for this record (A, MX, etc.)
- recdata - data for this record
- - svc_www
+
- svc_www
-
- type_pkgs
+
- type_pkgs