2 <title>Schema reference</title>
5 <h1>Schema reference</h1>
7 <li><a name="agent" href="man/FS/agent.html">agent</a> - Agents are resellers of your service. Agents may be limited to a subset of your full offerings (via their agent type).
9 <li>agentnum - primary key
10 <li>agent - name of this agent
11 <li>typenum - <a href="#agent_type">agent type</a>
12 <li>prog - (unimplemented)
13 <li>freq - (unimplemented)
15 <li><a name="agent_type" href="man/FS/agent_type.html">agent_type</a> - Agent types define groups of packages that you can then assign to particular agents.
17 <li>typenum - primary key
18 <li>atype - name of this agent type
20 <li><a name="cust_bill" href="man/FS/cust_bill.html">cust_bill</a> - Invoices. Declarations that a customer owes you money. The specific charges are itemized in <a href="#cust_bill_pkg">cust_bill_pkg</a>.
22 <li>invnum - primary key
23 <li>custnum - <a href="#cust_main">customer</a>
25 <li>charged - amount of this invoice
26 <li>printed - how many times this invoice has been printed automatically
27 <li>closed - books closed flag, empty or `Y'
29 <li><a name="cust_bill_event" href="man/FS/cust_bill_event.html">cust_bill_event</a> - Invoice event history
31 <li>eventnum - primary key
32 <li>invnum - <a href="#cust_bill">invoice</a>
33 <li>eventpart - <a href="#part_bill_event">event definition</a>
36 <li><a name="part_bill_event" href="man/FS/part_bill_event.html">part_bill_event</a> - Invoice event definitions
38 <li>eventpart - primary key
39 <li>payby - CARD, BILL, or COMP
40 <li>event - event name
41 <li>eventcode - event action
42 <li>seconds - how long after the invoice date (<a href="#cust_bill">cust_bill</a>._date) events of this type are triggered
43 <li>weight - ordering for events with identical seconds
44 <li>plan - eventcode plan
45 <li>plandata - additional plan data
46 <li>disabled - Disabled flag, empty or `Y'
48 <li><a name="cust_bill_pkg" href="man/FS/cust_bill_pkg.html">cust_bill_pkg</a> - Invoice line items
50 <li>invnum - (multiple) key
51 <li>pkgnum - <a href="#cust_pkg">package</a> or 0 for the special virtual sales tax package
53 <li>recur - recurring fee
54 <li>sdate - starting date
55 <li>edate - ending date
57 <li><a name="cust_credit" href="man/FS/cust_credit.html">cust_credit</a> - Credits. The equivalent of a negative <a href="#cust_bill">cust_bill</a> record.
59 <li>crednum - primary key
60 <li>custnum - <a href="#cust_main">customer</a>
61 <li>amount - amount credited
63 <li>otaker - order taker
65 <li>closed - books closed flag, empty or `Y'
67 <li><a name="cust_credit_bill" href="man/FS/cust_credit_bill.html">cust_credit_bill</a> - Credit invoice application. Links a credit to an invoice.
69 <li>creditbillnum - primary key
70 <li>crednum - <a href="#cust_credit">credit</a> being applied
71 <li>invnum - <a href="#cust_bill">invoice</a> to which credit is applied
72 <li>amount - amount applied
75 <li><a name="cust_main" href="man/FS/cust_main.html">cust_main</a> - Customers
77 <li>custnum - primary key
78 <li>agentnum - <a href="#agent">agent</a>
79 <li>refnum - <a href="#part_referral">referral</a>
82 <li>ss - social security number
96 <li><i>ship_company</i>
97 <li><i>ship_address1</i>
98 <li><i>ship_address2</i>
100 <li><i>ship_county</i>
101 <li><i>ship_state</i>
103 <li><i>ship_country</i>
104 <li><i>ship_daytime</i>
105 <li><i>ship_night</i>
107 <li>payby - CARD, BILL, or COMP
108 <li>payinfo - card number, P.O.#, or comp issuer
109 <li>paydate - expiration date
110 <li>payname - billing name (name on card)
111 <li>tax - tax exempt, Y or null
112 <li>otaker - order taker
116 (columns in <i>italics</i> are optional)
117 <li><a name="cust_main_invoice" href="man/FS/cust_main_invoice.html">cust_main_invoice</a> - 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.
119 <li>destnum - primary key
120 <li>custnum - <a href="#cust_main">customer</a>
121 <li>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 <a href="#svc_acct">svcnum</a> 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 <A name="#cust_main">cust_main</A> and are printed with the printer defined in the configuration files.
123 <li><a name="cust_main_county" href="man/FS/cust_main_county.html">cust_main_county</a> - Tax rates
125 <li>taxnum - primary key
131 <li><a name="cust_pay" href="man/FS/cust_pay.html">cust_pay</a> - Payments. Money being transferred from a customer.
133 <li>paynum - primary key
134 <li>custnum - <a href="#cust_main">customer</a>
137 <li>payby - CARD, BILL, or COMP
138 <li>payinfo - card number, P.O.#, or comp issuer
139 <li>paybatch - text field for tracking card processor batches
140 <li>closed - books closed flag, empty or `Y'
142 <li><a name="cust_bill_pay" href="man/FS/cust_bill_pay.html">cust_bill_pay</a> - Applicaton of a payment to a specific invoice.
145 <li>invnum - <a href="#cust_bill">invoice</a>
146 <li>paynum - <a href="#cust_pay">payment</a>
150 <li><a name="cust_pay_batch" href="man/FS/cust_pay_batch.html">cust_pay_batch</a> - Pending batch
154 <li>exp - card expiration
156 <li>invnum - <a href="#cust_bill">invoice</a>
157 <li>custnum - <a href="#cust_main">customer</a>
158 <li>payname - name on card
168 <li><a name="cust_pkg" href="man/FS/cust_pkg.html">cust_pkg</a> - Customer billing items
170 <li>pkgnum - primary key
171 <li>custnum - <a href="#cust_main">customer</a>
172 <li>pkgpart - <a href="#part_pkg">Package definition</a>
174 <li>bill - next bill date
175 <li>susp - (past) suspension date
176 <li>expire - (future) cancellation date
177 <li>cancel - (past) cancellation date
178 <li>otaker - order taker
179 <li>manual_flag - If this field is set to 1, disables the automatic unsuspensiond of this package when using the <a href="config.html#unsuspendauto">unsuspendauto</a> config file.
181 <li><a name="cust_refund" href="man/FS/cust_refund.html">cust_refund</a> - Refunds. The transfer of money to a customer; equivalent to a negative <a href="#cust_pay">cust_pay</a> record.
183 <li>refundnum - primary key
184 <li>custnum - <a href="#cust_main">customer</a>
187 <li>payby - CARD, BILL or COMP
188 <li>payinfo - card number, P.O.#, or comp issuer
189 <li>otaker - order taker
190 <li>closed - books closed flag, empty or `Y'
192 <li><a name="cust_credit_refund" href="man/FS/cust_credit_refund.html">cust_credit_refund</a> - Applicaton of a refund to a specific credit.
194 <li>creditrefundnum - primary key
195 <li>crednum - <a href="#cust_credit">credit</a>
196 <li>refundnum - <a href="#cust_refund">refund</a>
200 <li><a name="cust_svc" href="man/FS/cust_svc.html">cust_svc</a> - Customer services
202 <li>svcnum - primary key
203 <li>pkgnum - <a href="#cust_pkg">package</a>
204 <li>svcpart - <a href="#part_svc">Service definition</a>
206 <li><a name="nas" href="man/FS/nas.html">nas</a> - Network Access Server (terminal server)
208 <li>nasnum - primary key
210 <li>nasip - NAS ip address
211 <li>nasfqdn - NAS fully-qualified domain name
212 <li>last - timestamp indicating the last instant the NAS was in a known state (used by the session monitoring).
214 <li><a name="part_pkg" href="man/FS/part_pkg.html">part_pkg</a> - Package definitions
216 <li>pkgpart - primary key
217 <li>pkg - package name
218 <li>comment - non-customer visable package comment
219 <li>setup - setup fee expression
220 <li>freq - recurring frequency (months)
221 <li>recur - recurring fee expression
222 <li>setuptax - Setup fee tax exempt flag, empty or `Y'
223 <li>recurtax - Recurring fee tax exempt flag, empty or `Y'
224 <li>plan - price plan
225 <li>plandata - additional price plan data
226 <li>disabled - Disabled flag, empty or `Y'
228 <li><a name="part_referral" href="man/FS/part_referral.html">part_referral</a> - Referral listing
230 <li>refnum - primary key
231 <li>referral - referral
233 <li><a name="part_svc" href="man/FS/part_svc.html">part_svc</a> - Service definitions
235 <li>svcpart - primary key
236 <li>svc - name of this service
237 <li>svcdb - table used for this service: svc_acct, svc_acct_sm, svc_forward, svc_domain, svc_charge or svc_wo
238 <li>disabled - Disabled flag, empty or `Y'
239 <!-- <li><i>table</i>__<i>field</i> - Default or fixed value for <i>field</i> in <i>table</i>
240 <li><i>table</i>__<i>field</i>_flag - null, D or F
243 <li><a name="part_svc_column" href="man/FS/part_svc_column.html">part_svc_column</a>
245 <li>columnnum - primary key
246 <li>svcpart - <a href="#part_svc">Service definition</a>
247 <li>columnname - column name in part_svc.svcdb table
248 <li>columnvalue - default or fixed value for the column
249 <li>columnflag - null, D or F
251 <li><a name="pkg_svc" href="man/FS/pkg_svc.html">pkg_svc</a>
253 <li>pkgpart - <a href="#part_pkg">Package definition</a>
254 <li>svcpart - <a href="#part_svc">Service definition</a>
255 <li>quantity - quantity of this service that this package includes
257 <li><a name="part_export" href="man/FS/part_export.html">part_export</a> - Export to external provisioning
259 <li>exportnum - primary key
260 <li>svcpart - <a href="#part_svc">Service definition</a>
261 <li>machine - Machine name
262 <li>exporttype - Export type
263 <li>nodomain - blank or Y: usernames are exported to this service with no domain
265 <li><a name="part_export_option" href="man/FS/part_export_option.html">part_export_option</a> - provisioning options
267 <li>optionnum - primary key
268 <li>exportnum - <a href="#part_export">Export</a>
269 <li>option - option name
270 <li>optionvalue - option value
272 <li><a name="port" href="man/FS/port.html">port</a> - individual port on a <a href="#nas">nas</a>
274 <li>portnum - primary key
275 <li>ip - IP address of this port
276 <li>nasport - port number on the NAS
277 <li>nasnum - <a href="#nas">NAS</a>
279 <li><a name="prepay_credit" href="man/FS/prepay_credit.html">prepay_credit</a>
281 <li>prepaynum - primary key
282 <li>identifier - text or numeric string used to receive this credit
283 <li>amount - amount of credit
285 <li><a name="session" href="man/FS/session.html">session</a>
287 <li>sessionnum - primary key
288 <li>portnum - <a href="#port">Port</a>
289 <li>svcnum - <a href="#svc_acct">Account</a>
290 <li>login - timestamp indicating the beginning of this user session.
291 <li>logout - timestamp indicating the end of this user session. May be null, which indicates a currently open session.
294 <li><a name="svc_acct" href="man/FS/svc_acct.html">svc_acct</a> - Accounts
296 <li>svcnum - <a href="#cust_svc">primary key</a>
299 <li>popnum - <a href="#svc_acct_pop">Point of Presence</a>
305 <li>quota - (unimplementd)
306 <li>slipip - IP address
309 <li>radius_<i>Radius_Reply_Attribute</i> - Radius-Reply-Attribute
310 <li>rc_<i>Radius_Check_Attribute</i> - Radius-Check-Attribute
312 <li><a name="svc_acct_pop" href="man/FS/svc_acct_pop.html">svc_acct_pop</a> - Points of Presence
314 <li>popnum - primary key
319 <li>loc - rest of number
321 <li><a name="part_pop_local" href="man/FS/part_pop_local.html">part_pop_local</a> - Local calling areas
323 <li>localnum - primary key
324 <li>popnum - primary key
330 <li><a name="svc_acct_sm" href="man/FS/svc_acct_sm.html">svc_acct_sm</a> - <b>DEPRECIATED</b> Domain mail aliases
332 <li>svcnum - <a href="#cust_svc">primary key</a>
333 <li>domsvc - <a href="#svc_domain">Domain</a> (by svcnum)
334 <li>domuid - <a href="#svc_acct">Account</a> (by uid)
335 <li>domuser - domuser @ <a href="#svc_domain">Domain</a> forwards to <a href="#svc_acct">Account</a>
337 <li><a name="svc_domain" href="man/FS/svc_domain.html">svc_domain</a> - Domains
339 <li>svcnum - <a href="#cust_svc">primary key</a>
342 <li><a name="svc_forward" href="man/FS/svc_forward.html">svc_forward</a> - Mail forwarding aliases
344 <li>svcnum - <a href="#cust_svc">primary key</a>
345 <li>srcsvc - <a href="#svc_acct">svcnum of the source of this forward</a>
346 <li>dstsvc - <a href="#svc_acct">svcnum of the destination of this forward</a>
347 <li>dst - foreign destination (email address) - forward not local to freeside
349 <li><a name="domain_record" href="man/FS/domain_record.html">domain_record</a> - Domain zone detail
351 <li>recnum - primary key
352 <li>svcnum - <a href="#svc_domain">Domain</a> (by svcnum)
353 <li>reczone - zone for this line
354 <li>recaf - address family, usually <b>IN</b>
355 <li>rectype - type for this record (<b>A</b>, <b>MX</b>, etc.)
356 <li>recdata - data for this record
358 <li><a name="svc_www" href="man/FS/svc_www.html">svc_www</a>
360 <li>svcnum - <a href="#cust-svc">primary key</a>
361 <li>recnum - <a href="#domain_record">host</a>
362 <li>usersvc - <a href="#svc_acct">account</a>
364 <li><a name="type_pkgs" href="man/FS/type_pkgs.html">type_pkgs</a>
366 <li>typenum - <a href="#agent_type">agent type</a>
367 <li>pkgpart - <a href="#part_pkg">Package definition</a>
369 <li><a name="queue" href="man/FS/queue.html">queue</a> - job queue
371 <li>jobnum - primary key
376 <li><a name="queue_arg" href="man/FS/queue_arg.html">queue_arg</a> - job arguments
378 <li>argnum - primary key
379 <li>jobnum - <a href="#queue">job</a>