Schema reference

• 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
  • typenum - agent type
  • prog - (unimplemented)
  • freq - (unimplemented)
• 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.
  • invnum - primary key
  • custnum - customer
  • _date
  • charged - amount of this invoice
  • printed - how many times this invoice has been printed automatically
• cust_bill_pkg - Invoice line items
  • invnum - (multiple) key
  • pkgnum - package or 0 for the special virtual sales tax package
  • setup - setup fee
  • recur - recurring fee
  • sdate - starting date
  • edate - ending date
• cust_credit - Credits. The equivalent of a negative cust_bill record.
  • crednum - primary key
  • custnum - customer
  • amount - amount credited
  • _date
  • otaker - order taker
  • reason
• cust_main - Customers
  • custnum - primary key
  • agentnum - agent
  • refnum - referral
  • titlenum - title
  • first - name
  • last - name
  • ss - social security number
  • company
  • address1
  • address2
  • city
  • county
  • state
  • zip
  • country
  • daytime - phone
  • night - phone
  • fax - phone
  • ship_first
  • ship_last
  • ship_company
  • ship_address1
  • ship_address2
  • ship_city
  • ship_county
  • ship_state
  • ship_zip
  • ship_country
  • ship_daytime
  • ship_night
  • ship_fax
  • payby - CARD, BILL, or COMP
  • payinfo - card number, P.O.#, or comp issuer
  • paydate - expiration date
  • payname - billing name (name on card)
  • tax - tax exempt, Y or null
  • 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.
  • 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
  • taxnum - primary key
  • state
  • county
  • country
  • tax - % rate
• cust_pay - Payments. Money being transferred from a customer.
  • paynum - primary key
  • invnum - invoice
  • 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
  • trancode - 77 for charges
  • cardnum
  • exp - card expiration
  • amount
  • invnum - invoice
  • custnum - customer
  • payname - name on card
  • first - name
  • last - name
  • address1
  • address2
  • city
  • state
  • zip
  • country
• cust_pkg - Customer billing items
  • pkgnum - primary key
  • custnum - customer
  • pkgpart - Package definition
  • setup - date
  • bill - next bill date
  • susp - (past) suspension date
  • expire - (future) cancellation date
  • cancel - (past) cancellation date
  • otaker - order taker
• cust_refund - Refunds. The transfer of money to a customer; equivalent to a negative cust_pay record.
  • refundnum - primary key
  • crednum - credit
  • refund - amount
  • _date
  • payby - CARD, BILL or COMP
  • payinfo - card number, P.O.#, or comp issuer
  • otaker - order taker
• cust_svc - Customer services
  • svcnum - primary key
  • pkgnum - package
  • svcpart - Service definition
• nas - Network Access Server (terminal server)
  • nasnum - primary key
  • nas - NAS name
  • nasip - NAS ip address
  • 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
  • pkgpart - primary key
  • pkg - package name
  • comment - non-customer visable package comment
  • setup - setup fee
  • freq - recurring frequency (months)
  • recur - recurring fee
• part_referral - Referral listing
  • refnum - primary key
  • referral - referral
• part_svc - Service definitions
  • 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
  • table__field_flag - null, D or F
• part_title - Personal titles
  • titlenum - primary key
  • title - personal title (`Dr.' or `Mr.')
• pkg_svc
  • pkgpart - Package definition
  • svcpart - Service definition
  • quantity - quantity of this service that this package includes
• 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
  • prepaynum - primary key
  • identifier - text or numeric string used to receive this credit
  • amount - amount of credit
• session
  • sessionnum - primary key
  • portnum - Port
  • svcnum - Account
  • login - timestamp indicating the beginning of this user session.
  • logout - timestamp indicating the end of this user session. May be null, which indicates a currently open session.
• svc_acct - Accounts
  • svcnum - primary key
  • username
  • _password
  • popnum - Point of Presence
  • uid
  • gid
  • finger - GECOS
  • dir
  • shell
  • quota - (unimplementd)
  • slipip - IP address
  • radius_Radius_Attribute - Radius-Attribute
• svc_acct_pop - Points of Presence
  • popnum - primary key
  • city
  • state
  • ac - area code
  • exch - exchange
  • loc - rest of number
• svc_acct_sm - DEPRICIATED Domain mail aliases
  • svcnum - primary key
  • domsvc - Domain (by svcnum)
  • domuid - Account (by uid)
  • domuser - domuser @ Domain forwards to Account
• svc_domain - Domains
  • svcnum - primary key
  • domain
• primary key
• srcsvc - svcnum of the source of this forward
• dstsvc - svcnum of the destination of this forward
• dst - foreign destination (email address) - forward not local to freeside