Freeside - User contributions [en]

Freeside:1.9:Documentation:User

2010-09-24T01:18:20Z

Rluser: /* Additional notes */

= Introduction =

== About ==

http://www.freeside.biz/~ivan/freeside-slides/html/slide_1.html ?

AGPL now, and MySQL is also supported

== Navigation and Preferences ==

http://www.freeside.biz/~ivan/freeside-slides/html/slide_2.html

== Customers, Packages and Services ==

http://www.freeside.biz/~ivan/freeside-slides/html/slide_3.html

http://www.freeside.biz/~ivan/freeside-slides/html/slide_4.html (simple case: single package and service)

= Customers =

== Adding customers ==

http://www.freeside.biz/~ivan/freeside-slides/html/slide_5.html

== Searching for customers ==

== Customer view ==

http://www.freeside.biz/~ivan/freeside-slides/html/slide_6.html

=== Actions ===

==== Edit customer ====
==== Cancel customer ====
==== Refer customer ====
==== View customer's referrals ====
==== Bill now ====

=== Comments / Notes ===

==== Comments ====

==== Notes ====

=== Tickets ===

http://www.freeside.biz/~ivan/freeside-slides/html/slide_7.html

=== Packages ===

http://www.freeside.biz/~ivan/freeside-slides/html/slide_11.html

==== Services ====

===== Accounts =====

http://www.freeside.biz/~ivan/freeside-slides/html/slide_12.html

===== Domains =====
===== Mail Forwards =====
===== Virtual hosting =====
===== Broadband =====
===== Phone numbers =====
===== External =====

=== Payment history and actions ===

http://www.freeside.biz/~ivan/freeside-slides/html/slide_13.html

==== Invoices ====

Invoices are generated by the system. The charges on each invoice reflect the setup/one-time, recurring and usage charges of that customer's packages. Invoices increase the customer's balance.

To add new packages or charges to a customer, use the "Order new package" or "One-time charge" links in the Packages section of the Customer View page.

To generate a pending invoice for a customer, use the "Bill now" link at the top of the Customer View page.

==== Payments ====

Payments are money the customer pays. Payments decrease the customer's balance.

===== Check and Cash payments =====

* To post a check or cash payment, use the "Enter check payment" or "Enter cash payment" links at the top of the Payment History section of the customer view page.
** Enter the amount of the payment.
** For check payments, enter the check number.
** Leave "Auto-apply to invoices" set to "yes" if you would like the system to apply the payment to any open invoices (oldest first). Or change "Auto-apply to invoices" to "no" if you would like to apply the payment to invoice(s) (or refund(s)) manually.

* Multiple check payments can also be entered in a batch under Tools -> Quick Payment Entry.

===== Credit card and electronic check (ACH) payments =====

* Credit card or electronic check payments will be initiated by the system for customers with Billing Type "Credit card (automatic)" or "Electronic Check (automatic)".

* Payments can be initiated manually by using the "Process credit card payment" or "Process electronic check (ACH) payment" links, in the Payment History section of the customer view page.
** Enter the amount to process (defaults to the customer's current outstanding balance).
** For credit card payments, enter the card number, expiration date, name on card and billing address. If the customer has a card on-file, the masked card number ("4111xxxxxxxx1111") and other information can be left as-is to charge the on-file card.
** For electronic check payments, enter the account number, account type, ABA or routing number, and bank name (other information such as bank state, social security number, or driver's license number may also be required by some payment gateways). If the customer has electronic checking information on-file, the masked account number and other information can be left as-is to charge the on-file bank account.
** Check "Remember this information" to save the payment information on-file.
** Also check "Charge future payments to this credit card/electronic check automatically" to charge the customer automatically in the future.

* Customers may use the self-service interface to pay by credit card or electronic check themselves.

===== Payment application =====

* Payments are applied to a specific invoice (or split between multiple invoices).
* The "(apply)" and "(unapply)" links next to specific payment (in the Payment History section of the customer view page) can be used to change the application of payments to specific invoice(s) and/or refunds(s).

==== Credits ====

Credits are adjustments to the amount the customer owes. Credits decrease the customer's balance.

* To post a credit, use the "Enter credit" link at the top of the Payment History section of the customer view page.
** Enter the amount to credit.
** Select the reason for the credit or enter a new reason.
** Leave "Auto-apply to invoices" set to "yes" if you would like the system to apply the credit to any open invoices (oldest first). Or change "Auto-apply to invoices" to "no" if you would like to apply the credit to invoice(s) (or refund(s)) manually.

* Like payments, credits can be applied to an invoice (or split between multiple invoices). For example, a credit to reverse an incorrect invoice or write off an invoice as bad debt could be applied to that specific invoice.
* Credits can also be applied to refunds to indicate that the credit was refunded to the customer instead.
* The "(apply)" and "(unapply)" links next to specific credits (in the Payment History section of the customer view page) can be used to change the application of credits to specific invoice(s) and/or refunds(s).

==== Refunds ====

Refunds are money paid to the customer. Refunds increase the customer's balance.

===== Check and Cash refunds =====

* Posting refunds
* Applying and unapplying refunds.

===== Credit card and electronic check (ACH) refunds =====

* To refund a specific credit card or electronic check (ACH) payment back to the customer, use the "(refund)" link next to that specific payment (in the Payment History section of the customer view page). This will process a refund for the amount of the payment with the payment gateway.

= Ticketing =

Link to RT documentation

== New ticket ==

http://www.freeside.biz/~ivan/freeside-slides/html/slide_8.html

== Ticketing Main ==

http://www.freeside.biz/~ivan/freeside-slides/html/slide_9.html

== Ticket View ==

http://www.freeside.biz/~ivan/freeside-slides/html/slide_10.html

= Searching and Reporting =

http://www.freeside.biz/~ivan/freeside-slides/html/slide_14.html

== Customers ==

* To search for a customer, enter the customer number, name, company name or contact phone number into the "Search customers" box at the top of each page. Name and company are "fuzzy" searches that will attempt to find a close match if no exact match is found.
* Other customer browsing and reporting is available from Reports -> Customers
* For advanced reporting with specific criteria, use the "Advanced" link next to the "Search customers" box at the top of each page, or go to Reports -> Customers -> Advanced customer reports

* To search for a customer by invoice number or service information (such as username, email address, domain or service phone number), use the invoice or service search, then click on the customer or "View this customer" link.

== Invoices ==

* To search for an invoice, enter the invoice number into the "Search customers" box at the top of each page.
* Other invoice browsing and reporting is available from Reports -> Invoices
* For advanced reporting with specific criteria, use the "Advanced" link next to the "Search invoice" box at the top of each page, or go to Reports -> Invoices -> Advanced invoice reports

== Packages ==

* Package browsing and reporting is available from Reports -> Packages
* For advanced reporting with specific criteria, go to Reports -> Packages -> Advanced package reports

=== FCC Form 477 ===

==== Prerequisites ====

* visit Configuration->Settings and set cust_main-require_censustract to Yes
* visit Configuration->Packages->Package report classes and add classes to match the FCCs reporting requirements
* edit your package definitions (Configuration->Packages->Package definitions) to include some report classes

==== Usage ====

* visit Reports->Customers->Advanced customer reports to find customers lacking census tract information
* edit customers who lack census information - you should either see a popup asking for census information or it will be automatically filled when you save the customer
* visit Reports->Packages->Advanced package reports to generate reports which may filter by ALL selected "report classes" (logically ANDed)
* visit Reports->Packages->FCC Form 477 packages to generate reports collated by census tract

==== Additional notes ====

Once logged into the fcc system, one can offer it one or more files for upload via its html forms. For 'small' systems (fewer than 5000 broadband subscriptions) we support a single file upload. The size restriction is an FCC restriction on the number of lines in the XML file.

To prepare the report for upload, one must first tag package definitions with appropriate report classes. 'Appropriate' depends on context. For example, if a reporting entity must submit FCC Part IIA then the reporting entity must designate which packages contain 'unswitched UNE loops' and must tag the definitions with a report option which means this. If Part IIA is to be submitted, then each package definition must have the 'voice grade equivalency' for each package (defalt is 0). The global config cust_pkg-show_fcc_voice_grade_equivalent must be enabled to edit this.

Once the packages are tagged, useful reports may be generated. By visiting Reports->Packages->FCC Form 477 you may choose which 'parts' of the FCC form to generate (since not all parts are meaningful to all companies). In Part IA all download speeds and all upload speeds must be set meaningfully and at least one technology must be set. Part IB is not presently supported. Parts IIA and IIB depend on the ds0 equivalency number. They make use of the report options to calculate the percentage of the whole number of ds0s. All of parts I and II rely on the existance of a company name in the customer record for determining if the package is residential or not. Part III is not supported at this time. Part IV offers free form comments. Parts V and VI depend on parts II and I respectively. Only selection of their generation may be selected (and is ignored if the antecedents are missing).

After pressing the submit button, the top 'XML file' link represents a file suitable for uploading to the FCC as an XML file as long as fewer than 5000 broadband connections are being reported. Parts V and VI may also be downloaded as CSV files from links adjacent to the section. This (particularly VI) should be useful for larger entities who must perform the upload in parts.

== Services ==

* To search for a service such as username, email address, IP address, MAC address, domain or service phone number, enter the search data into the "Search servcies" box at the top of each page.
* Other service browsing and reporting is available from Reports -> Services

=== Accounts ===
=== Domains ===
=== Mail Forwards ===
=== Virtual hosting ===
=== Broadband ===
=== Phone numbers ===
=== External ===

== Usage ==

== Tickets ==

* To search for a ticket, enter the ticket number, subject, or email address into the "Search tickets" box at the top of each page.
* A fulltext ticket search can also be performed by entering "fulltext:searchstring" where searchstring is the string to search for.
* For advanced reporting with specific criteria, use the "Advanced" link next to the "Search tickets" box at the top of each page.

== Financial Reports ==

=== Sales, Credits and Receipts ===

=== Sales Report ===

=== Credit Report ===

=== Payment Report ===

=== Payment Batch Report ===

=== A/R Aging ===

Go to Reports -> Financial -> A/R aging to pull up an aging report

* Select "All customers" to pull up a report including all customers.
* Select "Customers with a balance" (the default) to pull up a report only including customers with a balance. Optionally enter a number of days to pull up a report only including customers with balances over the specified number of days old.

=== Prepaid income ===

=== Sales tax liability ===

Go to Reports -> Financial -> Sales tax liability to pull up a report of total sales and taxes, for example, to pull up numbers to add to Quickbooks or another accounting package.

* Enter start and end dates to restrict the search to a specific time period.
* Check "Show tax classes" to break down sales and taxes by tax class.
* Check "Show package classes" to break down sales and taxes by package class.

* In the resulting sales tax report, all clickable links take you to a detail report of the specific items making up the number reported.

= Tools =

== Quick Payment Entry ==

= Auditing Legacy Data =

http://www.freeside.biz/~ivan/freeside-slides/html/slide_15.html

Freeside:Documentation:Developer:Schema changes

2010-09-08T21:27:54Z

Rluser: /* Skeleton class autogeneration */

=== Schema.pm ===

* Required
* Edit the big data structure in FS/FS/Schema.pm and add your tables and columns

=== Essential documentation ===

* The upgrade script will automatically handle new tables as well as new columns, removed columns and changes to columns and indices. Column changes (other than NULLability) require DBIx::DBSchema version 0.37 or later.
* If other schema changes are required (such as renamed or removed tables, etc.), add a quick note to the upgrade instructions at [[Freeside:1.9:Documentation:Upgrading-HEAD]]

=== Skeleton class autogeneration ===

* For new tables. Optional but recommended. We're trying to save you work!
* Make sure the tables have been added to FS/FS/Schema.pm and run <code>make install-perl-modules</code>
* From the root freeside directory, run <code>bin/generate-table-module tablename</code> for each table. Use the <code>-n</code> option if you prefer not to have Mason load the table module.
* Edit the resulting FS/FS/table.pm
* FS/MANIFEST is updated and FS/t/table.t is added. Don't forget to cvs add FS/FS/table.pm and FS/t/table.t and check them in.

=== Required Documentation ===
* For new tables: add to FS/FS.pm

=== Optional: Documentation looking for adopters or innovative autogeneration ===

* somehwat neglected: httemplate/docs/schema.html
* really neglected: httemplate/docs/schema.dia

Freeside:1.9:Documentation:Administration:VOIP plan invoice layout variables

2010-08-05T20:56:28Z

Rluser: /* Common VOIP plan options for invoice appearance */

==== Common VOIP plan options for invoice appearance ====

Certain configuration options on telephony plan packages can have significant impact on the appearances of invoices by '''changing the data calculated and stored''' at the time of invoice generation.

;CDR invoice display format [output_format]
:controls the data stored for the usage detail on the invoice. Current choices are
default - date, time, destination, regionname, duration, price
default with source - source, date, time, destination, regionname, duration, price
default with account code - date, time, account code, destination, regionname, duration, price
simple - date, time, user, destination, duration, price
simple with source - date, time, source, destination, duration, price

;Section in which to place usage charges (whether separated or not) [usage_section]
:names an [[Freeside:Configuration:invoice_sections|invoice section]] which is to contain the usage portion of the invoiced package. If the section is to be included in a [[Freeside:Configuration:invoice_usesummary|summary page]] then you will need to ensure the spelling exactly matches a [[Freeside:1.9:Documentation:Administration:pkg_category|package category]]

;Include usage summary with recurring charges when usage is in separate section [summarize_usage]
:creates an additional (2nd) line on the invoice showing the total usage associated with the package. Typically appears below a 'setup' and 'recurring' line (if they exist).

;Always put usage details in separate section [usage_mandate]
:causes freeside to generate an extra section for the usage details even when freeside is not using [[Freeside:Configuration:invoice_sections|invoice sections]].

[[Category:Invoice_Layout]]
[[Category:Price_Plan_Options]]

Freeside:Configuration:invoice latexextracouponspace

2010-08-05T20:49:48Z

Rluser:

[[Category:Freeside_Configuration_Settings]]
[[Category:Invoice_Layout]]
;invoice_latexextracouponspace
:Optional LaTeX [[Freeside:Configuration:invoice_latextextheight|invoice textheight]] space to reserve for a tear off [[coupon]]. Include units.

Freeside:Configuration:invoice latexcouponaddcompanytoaddress

2010-08-05T20:47:42Z

Rluser:

[[Category:Freeside_Configuration_Settings]]
[[Category:Invoice_Layout]]
;invoice_latexcouponaddcompanytoaddress
:Add the company name to the 'To' address on the remittance [[coupon]] because the return address does not contain it.

Freeside:Configuration:invoice latexcoupontoaddresssep

2010-08-05T20:45:09Z

Rluser:

[[Category:Freeside_Configuration_Settings]]
[[Category:Invoice_Layout]]
;invoice_latexcoupontoaddresssep
:Optional LaTeX invoice separation between invoice data and the 'to' address (usually [[Freeside:1.9:Documentation:Administration#Invoice_Templates|invoice_latexreturnaddress]]). Include units.

Freeside:Configuration:invoice latexaddresssep

2010-08-05T20:44:15Z

Rluser:

[[Category:Freeside_Configuration_Settings]]
[[Category:Invoice_Layout]]
;invoice_latexaddresssep
:Optional LaTeX invoice separation between invoice data and the 'to' address (usually [[Freeside:1.9:Documentation:Administration#Invoice_Templates|invoice_latexreturnaddress]]). Include units.

Freeside:1.9:Documentation:Administration:invoice layout

2010-08-05T20:37:19Z

Rluser: /* Other Rendering Variables */

[[Category:Invoice_Layout]]

===Invoice Layout and Content===
====Basic Invoice Styles====
Several variables make significant changes to the appearance of invoices.

{{Freeside:Configuration:invoice_sections}}
{{Freeside:Configuration:invoice_usesummary}}
{{Freeside:Configuration:usage_class_as_a_section}}
{{Freeside:Configuration:svc_phone_sections}}

====Invoice Templates====
{{Freeside:1.9:Documentation:Administration:invoice_templates|format=latex}}

{{Freeside:1.9:Documentation:Administration:VOIP plan invoice layout variables}}

==== Other Variables Changing Invoice Layout at Billing Time====
{{Freeside:Configuration:separate_usage}}

==== Variables Neither Perfectly Rendering nor Perfectly Generational====
{{Freeside:Configuration:date_format}}
{{Freeside:Configuration:money_char}}
{{Freeside:Configuration:invoice_default_terms}}

====Boolean Rendering Variables====
{{Freeside:Configuration:invoice_show_prior_due_date}}
{{Freeside:Configuration:invoice_include_aging}}
{{Freeside:Configuration:invoice_smallernotes}}
{{Freeside:Configuration:invoice_smallerfooter}}
{{Freeside:Configuration:invoice-ship_address}}
{{Freeside:Configuration:disable_line_item_date_ranges}}
{{Freeside:Configuration:disable_previous_balance}}
{{Freeside:Configuration:previous_balance-summary_only}}
{{Freeside:Configuration:balance_due_below_line}}
{{Freeside:Configuration:invoice-unitprice}}

====Other Rendering Variables====
{{Freeside:Configuration:invoice_latextopmargin}}
{{Freeside:Configuration:invoice_latexheadsep}}
{{Freeside:Configuration:invoice_latexaddresssep}}
{{Freeside:Configuration:invoice_latextextheight}}
{{Freeside:Configuration:invoice_latexextracouponspace}}
{{Freeside:Configuration:invoice_latexcouponfootsep}}
{{Freeside:Configuration:invoice_latexcouponamountenclosedsep}}
{{Freeside:Configuration:invoice_latexcoupontoaddresssep}}
{{Freeside:Configuration:invoice_latexverticalreturnaddress}}
{{Freeside:Configuration:invoice_latexcouponaddcompanytoaddress}}
{{Freeside:Configuration:previous_balance-exclude_from_total}}
{{Freeside:Configuration:company_name}}
{{Freeside:Configuration:company_address}}
{{Freeside:Configuration:finance_pkgclass}}
{{Freeside:Configuration:cust_bill-max_same_services}}
{{Freeside:Configuration:cust_bill-consolidate_services}}

====Miscellaneous Variables Impacting Customer Perception of Invoices====

These variables do not change the invoice per se, but do change what is emailed to a customer as an invoice.
{{Freeside:Configuration:invoice_email_pdf}}
{{Freeside:Configuration:invoice_email_pdf_note}}
{{Freeside:Configuration:voip-cust_email_csv_cdr}}

Freeside:Configuration:invoice latexcouponfootsep

2010-08-05T20:36:19Z

Rluser:

[[Category:Freeside_Configuration_Settings]]
[[Category:Invoice_Layout]]
;invoice_latexcouponfootsep
:Optional LaTeX invoice separation between tear off [[coupon]] and [[Freeside:1.9:Documentation:Administration#Invoice_Templates|footer]]. Include units.

Freeside:1.9:Documentation:Administration:pkg category

2010-08-05T20:25:40Z

Rluser: /* Package Category */

==Package Category==

Package categories define groups of [[Freeside:1.9:Documentation:Administration:pkg_class|package classes]].

;Category name
:defines an [[Freeside:Configuration:invoice_sections|invoice section]] if that feature is enabled.
;Weight
:determines the order in which [[Freeside:Configuration:invoice_sections|invoice_sections]] appear.
;Collapse identical items into one
:causes identical packages to appear folded into a single line item with a quantity when checked rather than the default once line item per package.

Freeside:1.9:Documentation:Administration:invoice templates

2010-08-05T20:23:51Z

Rluser:

* {{#ifeq: {{{format}}} | latex | LaTeX | HTML }} invoices use Text::Template with {{#ifeq: {{{format}}} | latex | [@-- and --@] | <%= and %> }} delimiters.
* {{#ifeq: {{{format}}} | latex | Edit the invoice_{{{format}}}coupon, | The following can be set to override the default behaviour of using the invoice_latex* data transformed to HTML: }} invoice_{{{format}}}returnaddress, invoice_{{{format}}}footer, invoice_{{{format}}}notes, and invoice_{{{format}}}smallfooter configuration options. {{#ifeq: {{{format}}} | latex | If you are adventurous, | You may }} edit invoice_{{{format}}} as well.

Freeside:1.9:Documentation:Administration

2010-08-05T20:22:35Z

Rluser: /* HTML invoice templates */

= Exports (provisioning) =

'''Exports''' allow you to provision services to remote machines, databases and APIs. Some exports, such as ''sqlradius'' and ''sqlradius_withdomain'', enable a feed for retrieving rating/usage data.

Exports can be added and edited under
: Configuration -> Provisioning, services and packages -> View/edit exports

Most exports place jobs in the job queue for new, modified or deleted services. Jobs are run by [[Freeside:1.9:Documentation:Developer/bin/freeside-queued|freeside-queued]]. This daemon needs to be running before exports are acted upon.

Some exports use SSH, SCP or SFTP to communicate with external machines. See the documentation on [[Freeside:1.9:Documentation:Administration:SSH_Keys|SSH keys]].

Click on ''Add a new export'' to create a new export. Select exports from the dropdown to show more information on each export, including available options, setup and usage.

Exports are activated by associating them with one or more '''service definitions'''.

Following is a list of which exports can be associated with each type of service.

==svc_acct==
* [[Freeside:1.9:Documentation:Administration:acct_plesk.pm|acct_plesk.pm]]: Real-time export to Plesk managed mail service
* acct_sql.pm: Real-time export of accounts to SQL databases .
* artera_turbo.pm:
* bsdshell.pm:
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]: Real-time export to a CommuniGate Pro mail server
* communigate_pro_singledomain.pm:
* cpanel.pm: Real-time export to Cpanel control panel.
* cp.pm: Real-time export to Critical Path Account Provisioning Protocol
* cyrus.pm: Real-time export to Cyrus IMAP server
* everyone_net.pm: Real-time export to Everyone.net outsourced mail service
* infostreet.pm: Real-time export to InfoStreet streetSmartAPI
* ldap.pm: Real-time export to LDAP
* passwdfile.pm:
* radiator.pm: Real-time export to RADIATOR
* shellcommands.pm:
* shellcommands_withdomain.pm: Real-time export via remote SSH (vpopmail, ISPMan)
* sqlmail.pm: Real-time export to SQL-backed mail server
* sqlradius.pm: Real-time export to SQL-backed RADIUS (FreeRADIUS, ICRADIUS)
* sqlradius_withdomain.pm: Real-time export to SQL-backed RADIUS (FreeRADIUS, ICRADIUS) with realms
* sysvshell.pm:
* textradius.pm:
* vpopmail.pm: Real-time export to vpopmail text files

==svc_domain==
* bind.pm: Batch export to BIND named
* bind_slave.pm: Batch export to slave BIND named
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]: Real-time export to a CommuniGate Pro mail server
* domain_shellcommands.pm: Run remote commands via SSH, for domains (qmail, ISPMan).
* domain_sql.pm: Real time export of domains to SQL databases .
* http.pm: Send an HTTP or HTTPS GET or POST request
* [[Freeside:1.9:Documentation:Administration:opensrs.pm|opensrs.pm]]: OpenSRS integration
* sqlmail.pm: Real-time export to SQL-backed mail server

==svc_forward==
* artera_turbo.pm:
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]: Real-time export to a CommuniGate Pro mail server
* forward_shellcommands.pm: Run remote commands via SSH, for forwards
* postfix.pm: Postfix text files
* sqlmail.pm: Real-time export to SQL-backed mail server

==svc_www==
* apache.pm: Export an Apache httpd.conf file snippet.
* [[Freeside:1.9:Documentation:Administration:www_plesk.pm|www_plesk.pm]]: Real-time export to Plesk managed hosting service
* www_shellcommands.pm: Run remote commands via SSH, for virtual web sites (directory maintenance, FrontPage, ISPMan)

==svc_broadband==
* nas_wrapper.pm: A meta-export that triggers other svc_broadband exports.
* [[Freeside:1.9:Documentation:Administration:prizm.pm|prizm.pm]]: Real-time export to Northbound Interface
* router.pm: Send a command to a router.
* snmp.pm: Sends SNMP SETs to an SNMP agent.
* trango.pm: Sends SNMP SETs to a Trango AP.

==svc_phone==
* globalpops_voip.pm:
* grandstream.pm: Grandstream phone and ATA provisioning. This [http://www.freeside.biz/blog/?p=11 blog article] is a start at documentation.
* indosoft.pm:
* internal_diddb.pm:
* netsapiens.pm:
* phone_shellcommands.pm:
* phone_sqlradius.pm:
* thirdlane.pm:
* vitelity.pm:

==svc_external==
* artera_turbo.pm:

= Services =

== Accounts (svc_acct) ==

* [[Freeside:1.9:Documentation:Administration:svc_acct:_password_encoding|Password encoding in 1.9]]

== Domains (svc_domain) ==

== Forwards (svc_forward) ==

== Hosting (svc_www) ==

== Broadband (svc_broadband) ==

== Phone (svc_phone) ==

== External (svc_external) ==

= Packages =

{{Freeside:1.9:Documentation:Administration:pkg_category}}

== Price Plans ==

=== Common price plans ===

* flat
* subscription
* prorate
* sqlradacct_hour
* voip_cdr
* prepaid

=== Wholesale price plans ===

* bulk

* [[Freeside:1.9:Documentation:Administration:Packages:Price_Plans:agent | agent]]
* [[Freeside:1.9:Documentation:Administration:Packages:Price_Plans:cdr_termination |
cdr_termination ]]

=== Other price plans ===

* flat_delayed
* flat_introrate
* prorate_delayed

* base_delayed
* base_rate

* sql_external
* sql_generic

=== Price plans of questionable functionality ===

* flat_comission_cust
* flat_comission_pkg
* flat_comission

* voip_sqlradacct

* sesmon_hour
* sesmon_minute

== Misc ==

* Some notes on [[Freeside:1.9:Documentation:Administration:Upselling | Upselling]]

= Resellers =

= Employees =

== Employees ==

Go to Configuration -> Employees -> Employees to view the existing employees and add new ones. It is highly recommended to add a separate account for each person rather than using role accounts.

* To add a new employee, click on "Add an employee"
* Or to edit an existing group, click on the employee number or name in the list of employees.
* Enter or edit the username, password and name. If editing an existing employee and no password change is desired, the password fields can be left blank.
* Check the "Disable employee" box to disable this employee.
* In the "Employee groups" section, mark or unmark checkboxes to indicate the access groups for this employee.

== Employee groups and access control ==

To setup employee access control or agent/reseller virtualization, you need to setup employee groups. Go to Configuration -> Employees -> Employee groups to view the existing groups and add new ones. The system starts with a "Superuser" group which has access to all functionality for the first agent.

* To add a new group, click on "Add an employee group"
* Or to edit an existing group, click on the group number or name in the list of groups.
* Enter or edit the group name.
* In the "Group limited to these agent(s)" section, mark checkboxes next to the agents this employee group should be able to see. Employees in this group will only see customers of the selected agents in the system and reports.
* In the "Group access rights" section, mark or unmark checkboxes to indicate the access rights this employee group should have. Rights marked with an "*" are global rights which provide access to global data which is shared among all agents. Their use is not recommended for groups which are limited to a subset of agents.
* After adding a new group, don't forget to go back and add or edit employees to place them into the new group.

= Billing =

== Billing events ==
Billing events are the primary mechanism to implement your business rules. Rules such as resend invoices, retry cards, suspend or cancel accounts for non-payment, etc. are all handled by billing events.

At a high level, follow the following steps to create billing events:
* Add a new Billing Event (Configuration > Billing > Billing events)
* Name the event
* Choose the type of event:
** Package - Packages and associated dates (Including Commissions)
** Invoice - Invoice status and dates
** Customer - Customer Balances and Information
** Batch Payment - Batch payment results
** Statement - Send statement
* Choose whether to apply to one or all agents
* Choose the frequency for the system to check and see if the event should run.
* Choose appropriate filters.
* Choose appropriate actions.

The form is dynamic so changing the type of event will change the available filters and actions.

== Daily and Monthly Scripts ==
* The freeside-daily script should be run daily to bill customers and run invoice collection events.
** Typically, this is accomplished with an entry in the freeside user's crontab such as: <pre>0 0 * * * /usr/local/bin/freeside-daily</pre>
** If running freeside-daily manually, ensure the <code>TZ</code> variable is set to your timezone with a command such as: <pre>TZ="US/Pacific" freeside-daily fs_daily</pre>
* If any monthly events are enabled, the freeside-monthly script should be run monthly.
* Invoice events can also be used to implement agent-virtualized invoices. (add more info)

== Invoices ==

=== Typeset (LaTeX) invoice templates ===

==== Prerequisites ====

* Almost all distributions include the necessary prerequisites listed here, manual installation is practically never necessary.
* Install [http://www.ghostscript.com/ Ghostscript] (gs)
* Install [http://www.tug.org/tetex/ teTeX] or [http://www.tug.org/texlive/ TeX Live]
* Ensure that the <code>pslatex</code>, <code>dvips</code>, and <code>pdflatex</code> command line utilities were installed

==== Logo setup ====

The EPS logo is for PDF and printed invoices.

* For best results, save a '''vector format''' logo in EPS (Encapsulated PostScript) format.
** Your graphic artist can create vector image from a bitmap (tracing etc).
** Converting a bitmap such as a JPG can work (the bigger the better), but it may render in lower quality, blurry or with the "jaggies" (especially when actually printed, not just viewed as a PDF)
* Resize the logo to 90pt X 36pt: <code>epsffit -c 0 0 90 36 yourlogo.eps >logo.eps</code>
* Upload the resized logo as the <code>logo.eps</code> configuration option.
* Problems? Try <code>bin/strip-eps <oldlogo.eps >trynewlogo.eps</code>

The PNG logo is for emailed and online invoices.

Freeside ships with a logo of 92 x 62. Any logo close to this size should work with the default HTML template.

{{Freeside:1.9:Documentation:Administration:invoice_layout}}

=== HTML invoice templates ===

* Convert your logo to PNG format and upload it as the <code>logo.png</code> configuration option.
{{Freeside:1.9:Documentation:Administration:invoice_templates|format=html}}

=== Plaintext invoice templates ===

* See the Text::Template documentation for details on the substitution language.
* You must call the invoice_lines() function at least once - pass it a number of lines, and it returns a list of array references, each of two elements: a service description column, and a price column. Alternatively, call invoice_lines() with no arguments, and pagination will be disabled - all invoice line items will print on one page, with no padding (recommended for email invoices).
* Descriptions of variables are available in [[Freeside:1.9:Documentation:Template:invoice_html|invoice_html]]

=== Misc ===

==== Manually setting next invoice number sequence ====

* With PostgreSQL, to number invoices starting at 5000: <pre>SELECT SETVAL(cust_bill_invnum_seq, 4999);</pre>
* With MySQL:

== Payment Receipts ==

The [[Freeside:1.9:Documentation:Template:payment_receipt_email|payment_receipt_email]] template is used for manually applied payments.

== Credit cards and Electronic checks ==
* [[Freeside:1.9:Documentation:Administration:Real-time_Processing | Real-time credit card and electronic check processing]]
* [[Freeside:1.9:Documentation:Administration:Batch_Processing | Batch credit card and electronic check processing]]
* Credit card expiration alerts: Customize the ''alerter_template'' configuration option and run <code>freeside-expiration-alerter</code> daily.
* Credit card decline alerts: Customize the ''declinetemplate'' configuration option and set the ''emaildecline'' configuration option.

= Misc =

* Setting up [[Freeside:1.9:Documentation:Administration:Encrypted Credit Cards | Encrypted Credit Cards]]
* Setting up [[Freeside:1.9:Documentation:Administration:Texas Tax | Texas Tax]]
* Setting up [[Freeside:1.9:Documentation:Administration:VoIP | VoIP]]

* Setting up [[Freeside:1.9:Documentation:Administration:Commission|Commissions and Referrals]]
* Need to print to Windows printers? Follow steps 1-4 of [http://iharder.sourceforge.net/current/macosx/winmacprinter/ Share Your Windows Printer].
* Setting up [[Freeside:1.9:Documentation:Administration:Slony | Slony replication and failover]]
* Using a non-standard [[Freeside:1.9:Documentation:Administration:PostgreSQL_Schema | PostgreSQL Schema]]

{{ContextSensitiveHelp}}

Freeside:1.9:Documentation:Administration:invoice templates

2010-08-05T20:20:31Z

Rluser:

* {{#ifeq: {{{format}}} | latex | LaTeX | HTML }} invoices use Text::Template with {{#ifeq: {{{format}}} | latex | [@-- and --@] | <%= and %> }} delimiters.
* {{#ifeq: {{{format}}} | latex | Edit the invoice_{{{format}}}coupon, | The following configuration options can be set to override the default behaviour of using the invoice_latex* data transformed to HTML: }} invoice_{{{format}}}returnaddress, invoice_{{{format}}}footer, invoice_{{{format}}}notes, and invoice_{{{format}}}smallfooter configuration options. {{#ifeq: {{{format}}} | latex | If you are adventurous, | You may }} edit invoice_{{{format}}} as well.

Freeside:1.9:Documentation:Administration:invoice templates

2010-08-05T20:15:16Z

Rluser:

* {{#ifeq: {{{format}}} | latex | Edit the invoice_{{{format}}}coupon, | The following configuration options can be set to override the default behaviour of using the invoice_latex* data transformed to HTML: }} invoice_{{{format}}}returnaddress, invoice_{{{format}}}footer, invoice_{{{format}}}notes, and invoice_{{{format}}}smallfooter configuration options. {{#ifeq: {{{format}}} | latex | If you are adventurous, | You may }} edit invoice_{{{format}}} as well.

Sandbox

2010-08-05T20:10:14Z

Rluser: Removing all content from page

Freeside:1.9:Documentation:Administration

2010-08-05T19:03:20Z

Rluser: /* HTML invoice templates */

= Exports (provisioning) =

'''Exports''' allow you to provision services to remote machines, databases and APIs. Some exports, such as ''sqlradius'' and ''sqlradius_withdomain'', enable a feed for retrieving rating/usage data.

Exports can be added and edited under
: Configuration -> Provisioning, services and packages -> View/edit exports

Most exports place jobs in the job queue for new, modified or deleted services. Jobs are run by [[Freeside:1.9:Documentation:Developer/bin/freeside-queued|freeside-queued]]. This daemon needs to be running before exports are acted upon.

Some exports use SSH, SCP or SFTP to communicate with external machines. See the documentation on [[Freeside:1.9:Documentation:Administration:SSH_Keys|SSH keys]].

Click on ''Add a new export'' to create a new export. Select exports from the dropdown to show more information on each export, including available options, setup and usage.

Exports are activated by associating them with one or more '''service definitions'''.

Following is a list of which exports can be associated with each type of service.

==svc_acct==
* [[Freeside:1.9:Documentation:Administration:acct_plesk.pm|acct_plesk.pm]]: Real-time export to Plesk managed mail service
* acct_sql.pm: Real-time export of accounts to SQL databases .
* artera_turbo.pm:
* bsdshell.pm:
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]: Real-time export to a CommuniGate Pro mail server
* communigate_pro_singledomain.pm:
* cpanel.pm: Real-time export to Cpanel control panel.
* cp.pm: Real-time export to Critical Path Account Provisioning Protocol
* cyrus.pm: Real-time export to Cyrus IMAP server
* everyone_net.pm: Real-time export to Everyone.net outsourced mail service
* infostreet.pm: Real-time export to InfoStreet streetSmartAPI
* ldap.pm: Real-time export to LDAP
* passwdfile.pm:
* radiator.pm: Real-time export to RADIATOR
* shellcommands.pm:
* shellcommands_withdomain.pm: Real-time export via remote SSH (vpopmail, ISPMan)
* sqlmail.pm: Real-time export to SQL-backed mail server
* sqlradius.pm: Real-time export to SQL-backed RADIUS (FreeRADIUS, ICRADIUS)
* sqlradius_withdomain.pm: Real-time export to SQL-backed RADIUS (FreeRADIUS, ICRADIUS) with realms
* sysvshell.pm:
* textradius.pm:
* vpopmail.pm: Real-time export to vpopmail text files

==svc_domain==
* bind.pm: Batch export to BIND named
* bind_slave.pm: Batch export to slave BIND named
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]: Real-time export to a CommuniGate Pro mail server
* domain_shellcommands.pm: Run remote commands via SSH, for domains (qmail, ISPMan).
* domain_sql.pm: Real time export of domains to SQL databases .
* http.pm: Send an HTTP or HTTPS GET or POST request
* [[Freeside:1.9:Documentation:Administration:opensrs.pm|opensrs.pm]]: OpenSRS integration
* sqlmail.pm: Real-time export to SQL-backed mail server

==svc_forward==
* artera_turbo.pm:
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]: Real-time export to a CommuniGate Pro mail server
* forward_shellcommands.pm: Run remote commands via SSH, for forwards
* postfix.pm: Postfix text files
* sqlmail.pm: Real-time export to SQL-backed mail server

==svc_www==
* apache.pm: Export an Apache httpd.conf file snippet.
* [[Freeside:1.9:Documentation:Administration:www_plesk.pm|www_plesk.pm]]: Real-time export to Plesk managed hosting service
* www_shellcommands.pm: Run remote commands via SSH, for virtual web sites (directory maintenance, FrontPage, ISPMan)

==svc_broadband==
* nas_wrapper.pm: A meta-export that triggers other svc_broadband exports.
* [[Freeside:1.9:Documentation:Administration:prizm.pm|prizm.pm]]: Real-time export to Northbound Interface
* router.pm: Send a command to a router.
* snmp.pm: Sends SNMP SETs to an SNMP agent.
* trango.pm: Sends SNMP SETs to a Trango AP.

==svc_phone==
* globalpops_voip.pm:
* grandstream.pm: Grandstream phone and ATA provisioning. This [http://www.freeside.biz/blog/?p=11 blog article] is a start at documentation.
* indosoft.pm:
* internal_diddb.pm:
* netsapiens.pm:
* phone_shellcommands.pm:
* phone_sqlradius.pm:
* thirdlane.pm:
* vitelity.pm:

==svc_external==
* artera_turbo.pm:

= Services =

== Accounts (svc_acct) ==

* [[Freeside:1.9:Documentation:Administration:svc_acct:_password_encoding|Password encoding in 1.9]]

== Domains (svc_domain) ==

== Forwards (svc_forward) ==

== Hosting (svc_www) ==

== Broadband (svc_broadband) ==

== Phone (svc_phone) ==

== External (svc_external) ==

= Packages =

{{Freeside:1.9:Documentation:Administration:pkg_category}}

== Price Plans ==

=== Common price plans ===

* flat
* subscription
* prorate
* sqlradacct_hour
* voip_cdr
* prepaid

=== Wholesale price plans ===

* bulk

* [[Freeside:1.9:Documentation:Administration:Packages:Price_Plans:agent | agent]]
* [[Freeside:1.9:Documentation:Administration:Packages:Price_Plans:cdr_termination |
cdr_termination ]]

=== Other price plans ===

* flat_delayed
* flat_introrate
* prorate_delayed

* base_delayed
* base_rate

* sql_external
* sql_generic

=== Price plans of questionable functionality ===

* flat_comission_cust
* flat_comission_pkg
* flat_comission

* voip_sqlradacct

* sesmon_hour
* sesmon_minute

== Misc ==

* Some notes on [[Freeside:1.9:Documentation:Administration:Upselling | Upselling]]

= Resellers =

= Employees =

== Employees ==

Go to Configuration -> Employees -> Employees to view the existing employees and add new ones. It is highly recommended to add a separate account for each person rather than using role accounts.

* To add a new employee, click on "Add an employee"
* Or to edit an existing group, click on the employee number or name in the list of employees.
* Enter or edit the username, password and name. If editing an existing employee and no password change is desired, the password fields can be left blank.
* Check the "Disable employee" box to disable this employee.
* In the "Employee groups" section, mark or unmark checkboxes to indicate the access groups for this employee.

== Employee groups and access control ==

To setup employee access control or agent/reseller virtualization, you need to setup employee groups. Go to Configuration -> Employees -> Employee groups to view the existing groups and add new ones. The system starts with a "Superuser" group which has access to all functionality for the first agent.

* To add a new group, click on "Add an employee group"
* Or to edit an existing group, click on the group number or name in the list of groups.
* Enter or edit the group name.
* In the "Group limited to these agent(s)" section, mark checkboxes next to the agents this employee group should be able to see. Employees in this group will only see customers of the selected agents in the system and reports.
* In the "Group access rights" section, mark or unmark checkboxes to indicate the access rights this employee group should have. Rights marked with an "*" are global rights which provide access to global data which is shared among all agents. Their use is not recommended for groups which are limited to a subset of agents.
* After adding a new group, don't forget to go back and add or edit employees to place them into the new group.

= Billing =

== Billing events ==
Billing events are the primary mechanism to implement your business rules. Rules such as resend invoices, retry cards, suspend or cancel accounts for non-payment, etc. are all handled by billing events.

At a high level, follow the following steps to create billing events:
* Add a new Billing Event (Configuration > Billing > Billing events)
* Name the event
* Choose the type of event:
** Package - Packages and associated dates (Including Commissions)
** Invoice - Invoice status and dates
** Customer - Customer Balances and Information
** Batch Payment - Batch payment results
** Statement - Send statement
* Choose whether to apply to one or all agents
* Choose the frequency for the system to check and see if the event should run.
* Choose appropriate filters.
* Choose appropriate actions.

The form is dynamic so changing the type of event will change the available filters and actions.

== Daily and Monthly Scripts ==
* The freeside-daily script should be run daily to bill customers and run invoice collection events.
** Typically, this is accomplished with an entry in the freeside user's crontab such as: <pre>0 0 * * * /usr/local/bin/freeside-daily</pre>
** If running freeside-daily manually, ensure the <code>TZ</code> variable is set to your timezone with a command such as: <pre>TZ="US/Pacific" freeside-daily fs_daily</pre>
* If any monthly events are enabled, the freeside-monthly script should be run monthly.
* Invoice events can also be used to implement agent-virtualized invoices. (add more info)

== Invoices ==

=== Typeset (LaTeX) invoice templates ===

==== Prerequisites ====

* Almost all distributions include the necessary prerequisites listed here, manual installation is practically never necessary.
* Install [http://www.ghostscript.com/ Ghostscript] (gs)
* Install [http://www.tug.org/tetex/ teTeX] or [http://www.tug.org/texlive/ TeX Live]
* Ensure that the <code>pslatex</code>, <code>dvips</code>, and <code>pdflatex</code> command line utilities were installed

==== Logo setup ====

The EPS logo is for PDF and printed invoices.

* For best results, save a '''vector format''' logo in EPS (Encapsulated PostScript) format.
** Your graphic artist can create vector image from a bitmap (tracing etc).
** Converting a bitmap such as a JPG can work (the bigger the better), but it may render in lower quality, blurry or with the "jaggies" (especially when actually printed, not just viewed as a PDF)
* Resize the logo to 90pt X 36pt: <code>epsffit -c 0 0 90 36 yourlogo.eps >logo.eps</code>
* Upload the resized logo as the <code>logo.eps</code> configuration option.
* Problems? Try <code>bin/strip-eps <oldlogo.eps >trynewlogo.eps</code>

The PNG logo is for emailed and online invoices.

Freeside ships with a logo of 92 x 62. Any logo close to this size should work with the default HTML template.

{{Freeside:1.9:Documentation:Administration:invoice_layout}}

=== HTML invoice templates ===

* Convert your logo to PNG format and upload it as the <code>logo.png</code> configuration option.
* Edit the invoice_html configuration option. HTML invoices use Text::Template with <%= and %> delimiters.
* The following configuration options can be set to override the default behaviour of using the invoice_latex* data transformed to HTML: invoice_htmlreturnaddress, and invoice_htmlfooter, invoice_htmlsmallfooter invoice_htmlnotes.

=== Plaintext invoice templates ===

* See the Text::Template documentation for details on the substitution language.
* You must call the invoice_lines() function at least once - pass it a number of lines, and it returns a list of array references, each of two elements: a service description column, and a price column. Alternatively, call invoice_lines() with no arguments, and pagination will be disabled - all invoice line items will print on one page, with no padding (recommended for email invoices).
* Descriptions of variables are available in [[Freeside:1.9:Documentation:Template:invoice_html|invoice_html]]

=== Misc ===

==== Manually setting next invoice number sequence ====

* With PostgreSQL, to number invoices starting at 5000: <pre>SELECT SETVAL(cust_bill_invnum_seq, 4999);</pre>
* With MySQL:

== Payment Receipts ==

The [[Freeside:1.9:Documentation:Template:payment_receipt_email|payment_receipt_email]] template is used for manually applied payments.

== Credit cards and Electronic checks ==
* [[Freeside:1.9:Documentation:Administration:Real-time_Processing | Real-time credit card and electronic check processing]]
* [[Freeside:1.9:Documentation:Administration:Batch_Processing | Batch credit card and electronic check processing]]
* Credit card expiration alerts: Customize the ''alerter_template'' configuration option and run <code>freeside-expiration-alerter</code> daily.
* Credit card decline alerts: Customize the ''declinetemplate'' configuration option and set the ''emaildecline'' configuration option.

= Misc =

* Setting up [[Freeside:1.9:Documentation:Administration:Encrypted Credit Cards | Encrypted Credit Cards]]
* Setting up [[Freeside:1.9:Documentation:Administration:Texas Tax | Texas Tax]]
* Setting up [[Freeside:1.9:Documentation:Administration:VoIP | VoIP]]

* Setting up [[Freeside:1.9:Documentation:Administration:Commission|Commissions and Referrals]]
* Need to print to Windows printers? Follow steps 1-4 of [http://iharder.sourceforge.net/current/macosx/winmacprinter/ Share Your Windows Printer].
* Setting up [[Freeside:1.9:Documentation:Administration:Slony | Slony replication and failover]]
* Using a non-standard [[Freeside:1.9:Documentation:Administration:PostgreSQL_Schema | PostgreSQL Schema]]

{{ContextSensitiveHelp}}

Freeside:1.9:Documentation:Administration:invoice templates

2010-08-05T18:58:50Z

Rluser:

* Edit the {{#ifeq: {{{format}}} | latex | invoice_{{{format}}}coupon, | }} invoice_{{{format}}}returnaddress, invoice_{{{format}}}footer, invoice_{{{format}}}notes, and invoice_{{{format}}}smallfooter configuration options. If you are adventurous, edit invoice_{{{format}}} as well.

Freeside:1.9:Documentation:Administration:invoice templates

2010-08-05T18:56:21Z

Rluser:

* Edit the {{#ifeq: {{{format}}} | latex | invoice_{{{format}}}coupon, | } invoice_{{{format}}}returnaddress, invoice_{{{format}}}, invoice_{{{format}}}notes, and invoice_{{{format}}}smallfooter configuration options. If you are adventurous, edit invoice_{{{format}}} as well.

Freeside:1.9:Documentation:Administration:invoice layout

2010-08-05T18:53:43Z

Rluser: /* Invoice Templates */

[[Category:Invoice_Layout]]

===Invoice Layout and Content===
====Basic Invoice Styles====
Several variables make significant changes to the appearance of invoices.

{{Freeside:Configuration:invoice_sections}}
{{Freeside:Configuration:invoice_usesummary}}
{{Freeside:Configuration:usage_class_as_a_section}}
{{Freeside:Configuration:svc_phone_sections}}

====Invoice Templates====
{{Freeside:1.9:Documentation:Administration:invoice_templates|format=latex}}

{{Freeside:1.9:Documentation:Administration:VOIP plan invoice layout variables}}

==== Other Variables Changing Invoice Layout at Billing Time====
{{Freeside:Configuration:separate_usage}}

==== Variables Neither Perfectly Rendering nor Perfectly Generational====
{{Freeside:Configuration:date_format}}
{{Freeside:Configuration:money_char}}
{{Freeside:Configuration:invoice_default_terms}}

====Boolean Rendering Variables====
{{Freeside:Configuration:invoice_show_prior_due_date}}
{{Freeside:Configuration:invoice_include_aging}}
{{Freeside:Configuration:invoice_smallernotes}}
{{Freeside:Configuration:invoice_smallerfooter}}
{{Freeside:Configuration:invoice-ship_address}}
{{Freeside:Configuration:disable_line_item_date_ranges}}
{{Freeside:Configuration:disable_previous_balance}}
{{Freeside:Configuration:previous_balance-summary_only}}
{{Freeside:Configuration:balance_due_below_line}}
{{Freeside:Configuration:invoice-unitprice}}

====Other Rendering Variables====
{{Freeside:Configuration:invoice_latextopmargin}}
{{Freeside:Configuration:invoice_latexheadsep}}
{{Freeside:Configuration:invoice_latexaddresssep}}
{{Freeside:Configuration:invoice_latextextheight}}
{{Freeside:Configuration:invoice_latexextracouponspace}}
{{Freeside:Configuration:invoice_latexcouponfootsep}}
{{Freeside:Configuration:invoice_latexcouponamountencosedsep}}
{{Freeside:Configuration:invoice_latexcoupontoaddresssep}}
{{Freeside:Configuration:invoice_latexverticalreturnaddress}}
{{Freeside:Configuration:invoice_latexcouponaddcompanytoaddress}}
{{Freeside:Configuration:previous_balance-exclude_from_total}}
{{Freeside:Configuration:company_name}}
{{Freeside:Configuration:company_address}}
{{Freeside:Configuration:finance_pkgclass}}
{{Freeside:Configuration:cust_bill-max_same_services}}
{{Freeside:Configuration:cust_bill-consolidate_services}}

====Miscellaneous Variables Impacting Customer Perception of Invoices====

These variables do not change the invoice per se, but do change what is emailed to a customer as an invoice.
{{Freeside:Configuration:invoice_email_pdf}}
{{Freeside:Configuration:invoice_email_pdf_note}}
{{Freeside:Configuration:voip-cust_email_csv_cdr}}

Freeside:1.9:Documentation:Administration:invoice templates

2010-08-05T18:52:32Z

Rluser:

* Edit the {{#ifeq: {{format}} | latex | invoice_{{format}}coupon, | } invoice_{{format}}returnaddress, invoice_{{format}}, invoice_{{format}}notes, and invoice_{{format}}smallfooter configuration options. If you are adventurous, edit invoice_{{format}} as well.

Freeside:Configuration:svc phone sections

2010-08-05T18:26:39Z

Rluser:

[[Category:Freeside_Configuration_Settings]]
[[Category:Invoice_Layout]]
;svc_phone_sections
:enables the creation of a section for each [[Freeside:1.9:Documentation:Administration#Phone_.28svc_phone.29|svc_phone]]

[[Image:Invoice_with_usage_and_svc_phone.pdf|svc_phone sections]]

Freeside:1.9:Documentation:Administration:pkg category

2010-08-05T17:57:30Z

Rluser: /* Package Category */

==Package Category==

Package categories define groups of [[Freeside:1.9:Documentation:Administration:pkg_class|package classes]].

;Category name
:defines an [[Freeside:Configuration:invoice_sections|invoice section]] if that feature is enabled.
;Weight
:determines the order in which [[Freeside:Configuration:invoice_sections]] appear.
;Collapse identical items into one
:causes identical packages to appear folded into a single line item with a quantity when checked rather than the default once line item per package.

Freeside:Configuration:invoice sections

2010-08-05T17:57:23Z

Rluser:

[[Category:Freeside_Configuration_Settings]]
[[Category:Invoice_Layout]]
;invoice_sections
:enables the division of invoices into sections defined by [[Freeside:1.9:Documentation:Administration:pkg_category|package categories]]

[[Image:Invoice_with_sections.pdf|With sections]][[Image:Invoice_without_sections.pdf|Without sections]]

Freeside:1.9:Documentation:Administration:pkg category

2010-08-05T17:51:49Z

Rluser: /* Package Category */

==Package Category==

Package categories define groups of [[Freeside:1.9:Documentation:Adminsitration:pkg_class|package classes]].

;Category name
:defines an [[Freeside:Configuration:invoice_sections|invoice section]] if that feature is enabled.
;Weight
:determines the order in which [[Freeside:Configuration:invoice_sections]] appear.
;Collapse identical items into one
:causes identical packages to appear folded into a single line item with a quantity when checked rather than the default once line item per package.

Freeside:Configuration:svc phone sections

2010-08-05T08:41:17Z

Rluser:

[[Category:Freeside_Configuration_Settings]]
[[Category:Invoice_Layout]]
;svc_phone_sections
:enables the creation of a section for each [[svc_phone]]

[[Image:Invoice_with_usage_and_svc_phone.pdf|svc_phone sections]]

Freeside:Configuration:usage class as a section

2010-08-05T08:39:14Z

Rluser:

[[Category:Freeside_Configuration_Settings]]
[[Category:Invoice_Layout]]
;usage_class_as_a_section
:enables the construction of a section per [[usage_class]] on invoices

[[Image:Invoice_with_usage_class_as_section.pdf|Usage class as a section]]

Freeside:Configuration:invoice usesummary

2010-08-05T08:36:00Z

Rluser:

[[Category:Freeside_Configuration_Settings]]
[[Category:Invoice_Layout]]
;invoice_usesummary
:Indicates that html and latex invoices should be in summary style and make use of invoice_latexsummary or invoice_htmlsummary.

[[Image:Invoice_with_summary.pdf|With summary]][[Image:Invoice_with_sections.pdf|Without summary]]

Freeside:Configuration:invoice sections

2010-08-05T08:31:34Z

Rluser:

[[Category:Freeside_Configuration_Settings]]
[[Category:Invoice_Layout]]
;invoice_sections
:enables the division of invoices into sections defined by [[package categories]]

[[Image:Invoice_with_sections.pdf|With sections]][[Image:Invoice_without_sections.pdf|Without sections]]

Freeside:Configuration:invoice sections

2010-08-05T08:24:25Z

Rluser:

File:Invoice with usage class as section.pdf

2010-08-05T08:15:55Z

Rluser:

File:Invoice with usage and svc phone.pdf

2010-08-05T08:15:15Z

Rluser:

File:Invoice with summary.pdf

2010-08-05T08:14:56Z

Rluser:

File:Invoice without sections.pdf

2010-08-05T08:14:35Z

Rluser:

File:Invoice with sections.pdf

2010-08-05T08:13:32Z

Rluser:

Sandbox

2010-08-05T05:07:43Z

Rluser:

[[File:Invoice_with_sections.png]]

Freeside:Configuration:invoice usesummary

2010-07-12T04:46:42Z

Rluser:

Freeside:1.9:Documentation:Administration

2010-07-12T04:44:19Z

Rluser: /* Invoices */

= Exports (provisioning) =

'''Exports''' allow you to provision services to remote machines, databases and APIs. Some exports, such as ''sqlradius'' and ''sqlradius_withdomain'', enable a feed for retrieving rating/usage data.

Exports can be added and edited under
: Configuration -> Provisioning, services and packages -> View/edit exports

Most exports place jobs in the job queue for new, modified or deleted services. Jobs are run by [[Freeside:1.9:Documentation:Developer/bin/freeside-queued|freeside-queued]]. This daemon needs to be running before exports are acted upon.

Some exports use SSH, SCP or SFTP to communicate with external machines. See the documentation on [[Freeside:1.9:Documentation:Administration:SSH_Keys|SSH keys]].

Click on ''Add a new export'' to create a new export. Select exports from the dropdown to show more information on each export, including available options, setup and usage.

Exports are activated by associating them with one or more '''service definitions'''.

Following is a list of which exports can be associated with each type of service.

==svc_acct==
* [[Freeside:1.9:Documentation:Administration:acct_plesk.pm|acct_plesk.pm]]: Real-time export to Plesk managed mail service
* acct_sql.pm: Real-time export of accounts to SQL databases .
* artera_turbo.pm:
* bsdshell.pm:
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]: Real-time export to a CommuniGate Pro mail server
* communigate_pro_singledomain.pm:
* cpanel.pm: Real-time export to Cpanel control panel.
* cp.pm: Real-time export to Critical Path Account Provisioning Protocol
* cyrus.pm: Real-time export to Cyrus IMAP server
* everyone_net.pm: Real-time export to Everyone.net outsourced mail service
* infostreet.pm: Real-time export to InfoStreet streetSmartAPI
* ldap.pm: Real-time export to LDAP
* passwdfile.pm:
* radiator.pm: Real-time export to RADIATOR
* shellcommands.pm:
* shellcommands_withdomain.pm: Real-time export via remote SSH (vpopmail, ISPMan)
* sqlmail.pm: Real-time export to SQL-backed mail server
* sqlradius.pm: Real-time export to SQL-backed RADIUS (FreeRADIUS, ICRADIUS)
* sqlradius_withdomain.pm: Real-time export to SQL-backed RADIUS (FreeRADIUS, ICRADIUS) with realms
* sysvshell.pm:
* textradius.pm:
* vpopmail.pm: Real-time export to vpopmail text files

==svc_domain==
* bind.pm: Batch export to BIND named
* bind_slave.pm: Batch export to slave BIND named
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]: Real-time export to a CommuniGate Pro mail server
* domain_shellcommands.pm: Run remote commands via SSH, for domains (qmail, ISPMan).
* domain_sql.pm: Real time export of domains to SQL databases .
* http.pm: Send an HTTP or HTTPS GET or POST request
* [[Freeside:1.9:Documentation:Administration:opensrs.pm|opensrs.pm]]: OpenSRS integration
* sqlmail.pm: Real-time export to SQL-backed mail server

==svc_forward==
* artera_turbo.pm:
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]: Real-time export to a CommuniGate Pro mail server
* forward_shellcommands.pm: Run remote commands via SSH, for forwards
* postfix.pm: Postfix text files
* sqlmail.pm: Real-time export to SQL-backed mail server

==svc_www==
* apache.pm: Export an Apache httpd.conf file snippet.
* [[Freeside:1.9:Documentation:Administration:www_plesk.pm|www_plesk.pm]]: Real-time export to Plesk managed hosting service
* www_shellcommands.pm: Run remote commands via SSH, for virtual web sites (directory maintenance, FrontPage, ISPMan)

==svc_broadband==
* nas_wrapper.pm: A meta-export that triggers other svc_broadband exports.
* [[Freeside:1.9:Documentation:Administration:prizm.pm|prizm.pm]]: Real-time export to Northbound Interface
* router.pm: Send a command to a router.
* snmp.pm: Sends SNMP SETs to an SNMP agent.
* trango.pm: Sends SNMP SETs to a Trango AP.

==svc_phone==
* globalpops_voip.pm:
* grandstream.pm: Grandstream phone and ATA provisioning. This [http://www.freeside.biz/blog/?p=11 blog article] is a start at documentation.
* indosoft.pm:
* internal_diddb.pm:
* netsapiens.pm:
* phone_shellcommands.pm:
* phone_sqlradius.pm:
* thirdlane.pm:
* vitelity.pm:

==svc_external==
* artera_turbo.pm:

= Services =

== Accounts (svc_acct) ==

* [[Freeside:1.9:Documentation:Administration:svc_acct:_password_encoding|Password encoding in 1.9]]

== Domains (svc_domain) ==

== Forwards (svc_forward) ==

== Hosting (svc_www) ==

== Broadband (svc_broadband) ==

== Phone (svc_phone) ==

== External (svc_external) ==

= Packages =

{{Freeside:1.9:Documentation:Administration:pkg_category}}

== Price Plans ==

=== Common price plans ===

* flat
* subscription
* prorate
* sqlradacct_hour
* voip_cdr
* prepaid

=== Wholesale price plans ===

* bulk

* [[Freeside:1.9:Documentation:Administration:Packages:Price_Plans:agent | agent]]
* [[Freeside:1.9:Documentation:Administration:Packages:Price_Plans:cdr_termination |
cdr_termination ]]

=== Other price plans ===

* flat_delayed
* flat_introrate
* prorate_delayed

* base_delayed
* base_rate

* sql_external
* sql_generic

=== Price plans of questionable functionality ===

* flat_comission_cust
* flat_comission_pkg
* flat_comission

* voip_sqlradacct

* sesmon_hour
* sesmon_minute

== Misc ==

* Some notes on [[Freeside:1.9:Documentation:Administration:Upselling | Upselling]]

= Resellers =

= Employees =

== Employees ==

Go to Configuration -> Employees -> Employees to view the existing employees and add new ones. It is highly recommended to add a separate account for each person rather than using role accounts.

* To add a new employee, click on "Add an employee"
* Or to edit an existing group, click on the employee number or name in the list of employees.
* Enter or edit the username, password and name. If editing an existing employee and no password change is desired, the password fields can be left blank.
* Check the "Disable employee" box to disable this employee.
* In the "Employee groups" section, mark or unmark checkboxes to indicate the access groups for this employee.

== Employee groups and access control ==

To setup employee access control or agent/reseller virtualization, you need to setup employee groups. Go to Configuration -> Employees -> Employee groups to view the existing groups and add new ones. The system starts with a "Superuser" group which has access to all functionality for the first agent.

* To add a new group, click on "Add an employee group"
* Or to edit an existing group, click on the group number or name in the list of groups.
* Enter or edit the group name.
* In the "Group limited to these agent(s)" section, mark checkboxes next to the agents this employee group should be able to see. Employees in this group will only see customers of the selected agents in the system and reports.
* In the "Group access rights" section, mark or unmark checkboxes to indicate the access rights this employee group should have. Rights marked with an "*" are global rights which provide access to global data which is shared among all agents. Their use is not recommended for groups which are limited to a subset of agents.
* After adding a new group, don't forget to go back and add or edit employees to place them into the new group.

= Billing =

== Billing events ==
Billing events are the primary mechanism to implement your business rules. Rules such as resend invoices, retry cards, suspend or cancel accounts for non-payment, etc. are all handled by billing events.

At a high level, follow the following steps to create billing events:
* Add a new Billing Event (Configuration > Billing > Billing events)
* Name the event
* Choose the type of event:
** Package - Packages and associated dates (Including Commissions)
** Invoice - Invoice status and dates
** Customer - Customer Balances and Information
** Batch Payment - Batch payment results
** Statement - Send statement
* Choose whether to apply to one or all agents
* Choose the frequency for the system to check and see if the event should run.
* Choose appropriate filters.
* Choose appropriate actions.

The form is dynamic so changing the type of event will change the available filters and actions.

== Daily and Monthly Scripts ==
* The freeside-daily script should be run daily to bill customers and run invoice collection events.
** Typically, this is accomplished with an entry in the freeside user's crontab such as: <pre>0 0 * * * /usr/local/bin/freeside-daily</pre>
** If running freeside-daily manually, ensure the <code>TZ</code> variable is set to your timezone with a command such as: <pre>TZ="US/Pacific" freeside-daily fs_daily</pre>
* If any monthly events are enabled, the freeside-monthly script should be run monthly.
* Invoice events can also be used to implement agent-virtualized invoices. (add more info)

== Invoices ==

=== Typeset (LaTeX) invoice templates ===

==== Prerequisites ====

* Almost all distributions include the necessary prerequisites listed here, manual installation is practically never necessary.
* Install [http://www.ghostscript.com/ Ghostscript] (gs)
* Install [http://www.tug.org/tetex/ teTeX] or [http://www.tug.org/texlive/ TeX Live]
* Ensure that the <code>pslatex</code>, <code>dvips</code>, and <code>pdflatex</code> command line utilities were installed

==== Logo setup ====

The EPS logo is for PDF and printed invoices.

* For best results, save a '''vector format''' logo in EPS (Encapsulated PostScript) format.
** Your graphic artist can create vector image from a bitmap (tracing etc).
** Converting a bitmap such as a JPG can work (the bigger the better), but it may render in lower quality, blurry or with the "jaggies" (especially when actually printed, not just viewed as a PDF)
* Resize the logo to 90pt X 36pt: <code>epsffit -c 0 0 90 36 yourlogo.eps >logo.eps</code>
* Upload the resized logo as the <code>logo.eps</code> configuration option.
* Problems? Try <code>bin/strip-eps <oldlogo.eps >trynewlogo.eps</code>

The PNG logo is for emailed and online invoices.

Freeside ships with a logo of 92 x 62. Any logo close to this size should work with the default HTML template.

{{Freeside:1.9:Documentation:Administration:invoice_layout}}

=== HTML invoice templates ===

* Convert your logo to PNG format and upload it as the <code>logo.png</code> configuration option.
* Edit the invoice_html configuration option. HTML invoices use Text::Template with <%= and %> delimiters.
* The following configuration options can be set to override the default behaviour of using the invoice_latex* data transformed to HTML: invoice_htmlreturnaddress, and invoice_htmlfooter, invoice_htmlnotes.

=== Plaintext invoice templates ===

* See the Text::Template documentation for details on the substitution language.
* You must call the invoice_lines() function at least once - pass it a number of lines, and it returns a list of array references, each of two elements: a service description column, and a price column. Alternatively, call invoice_lines() with no arguments, and pagination will be disabled - all invoice line items will print on one page, with no padding (recommended for email invoices).
* Descriptions of variables are available in [[Freeside:1.9:Documentation:Template:invoice_html|invoice_html]]

=== Misc ===

==== Manually setting next invoice number sequence ====

* With PostgreSQL, to number invoices starting at 5000: <pre>SELECT SETVAL(cust_bill_invnum_seq, 4999);</pre>
* With MySQL:

== Payment Receipts ==

The [[Freeside:1.9:Documentation:Template:payment_receipt_email|payment_receipt_email]] template is used for manually applied payments.

== Credit cards and Electronic checks ==
* [[Freeside:1.9:Documentation:Administration:Real-time_Processing | Real-time credit card and electronic check processing]]
* [[Freeside:1.9:Documentation:Administration:Batch_Processing | Batch credit card and electronic check processing]]
* Credit card expiration alerts: Customize the ''alerter_template'' configuration option and run <code>freeside-expiration-alerter</code> daily.
* Credit card decline alerts: Customize the ''declinetemplate'' configuration option and set the ''emaildecline'' configuration option.

= Misc =

* Setting up [[Freeside:1.9:Documentation:Administration:Encrypted Credit Cards | Encrypted Credit Cards]]
* Setting up [[Freeside:1.9:Documentation:Administration:Texas Tax | Texas Tax]]
* Setting up [[Freeside:1.9:Documentation:Administration:VoIP | VoIP]]

* Setting up [[Freeside:1.9:Documentation:Administration:Commission|Commissions and Referrals]]
* Need to print to Windows printers? Follow steps 1-4 of [http://iharder.sourceforge.net/current/macosx/winmacprinter/ Share Your Windows Printer].
* Setting up [[Freeside:1.9:Documentation:Administration:Slony | Slony replication and failover]]
* Using a non-standard [[Freeside:1.9:Documentation:Administration:PostgreSQL_Schema | PostgreSQL Schema]]

{{ContextSensitiveHelp}}

Freeside:1.9:Documentation:Administration

2010-07-12T04:39:48Z

Rluser: /* Typeset (LaTeX) invoice templates */

= Exports (provisioning) =

'''Exports''' allow you to provision services to remote machines, databases and APIs. Some exports, such as ''sqlradius'' and ''sqlradius_withdomain'', enable a feed for retrieving rating/usage data.

Exports can be added and edited under
: Configuration -> Provisioning, services and packages -> View/edit exports

Most exports place jobs in the job queue for new, modified or deleted services. Jobs are run by [[Freeside:1.9:Documentation:Developer/bin/freeside-queued|freeside-queued]]. This daemon needs to be running before exports are acted upon.

Some exports use SSH, SCP or SFTP to communicate with external machines. See the documentation on [[Freeside:1.9:Documentation:Administration:SSH_Keys|SSH keys]].

Click on ''Add a new export'' to create a new export. Select exports from the dropdown to show more information on each export, including available options, setup and usage.

Exports are activated by associating them with one or more '''service definitions'''.

Following is a list of which exports can be associated with each type of service.

==svc_acct==
* [[Freeside:1.9:Documentation:Administration:acct_plesk.pm|acct_plesk.pm]]: Real-time export to Plesk managed mail service
* acct_sql.pm: Real-time export of accounts to SQL databases .
* artera_turbo.pm:
* bsdshell.pm:
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]: Real-time export to a CommuniGate Pro mail server
* communigate_pro_singledomain.pm:
* cpanel.pm: Real-time export to Cpanel control panel.
* cp.pm: Real-time export to Critical Path Account Provisioning Protocol
* cyrus.pm: Real-time export to Cyrus IMAP server
* everyone_net.pm: Real-time export to Everyone.net outsourced mail service
* infostreet.pm: Real-time export to InfoStreet streetSmartAPI
* ldap.pm: Real-time export to LDAP
* passwdfile.pm:
* radiator.pm: Real-time export to RADIATOR
* shellcommands.pm:
* shellcommands_withdomain.pm: Real-time export via remote SSH (vpopmail, ISPMan)
* sqlmail.pm: Real-time export to SQL-backed mail server
* sqlradius.pm: Real-time export to SQL-backed RADIUS (FreeRADIUS, ICRADIUS)
* sqlradius_withdomain.pm: Real-time export to SQL-backed RADIUS (FreeRADIUS, ICRADIUS) with realms
* sysvshell.pm:
* textradius.pm:
* vpopmail.pm: Real-time export to vpopmail text files

==svc_domain==
* bind.pm: Batch export to BIND named
* bind_slave.pm: Batch export to slave BIND named
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]: Real-time export to a CommuniGate Pro mail server
* domain_shellcommands.pm: Run remote commands via SSH, for domains (qmail, ISPMan).
* domain_sql.pm: Real time export of domains to SQL databases .
* http.pm: Send an HTTP or HTTPS GET or POST request
* [[Freeside:1.9:Documentation:Administration:opensrs.pm|opensrs.pm]]: OpenSRS integration
* sqlmail.pm: Real-time export to SQL-backed mail server

==svc_forward==
* artera_turbo.pm:
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]: Real-time export to a CommuniGate Pro mail server
* forward_shellcommands.pm: Run remote commands via SSH, for forwards
* postfix.pm: Postfix text files
* sqlmail.pm: Real-time export to SQL-backed mail server

==svc_www==
* apache.pm: Export an Apache httpd.conf file snippet.
* [[Freeside:1.9:Documentation:Administration:www_plesk.pm|www_plesk.pm]]: Real-time export to Plesk managed hosting service
* www_shellcommands.pm: Run remote commands via SSH, for virtual web sites (directory maintenance, FrontPage, ISPMan)

==svc_broadband==
* nas_wrapper.pm: A meta-export that triggers other svc_broadband exports.
* [[Freeside:1.9:Documentation:Administration:prizm.pm|prizm.pm]]: Real-time export to Northbound Interface
* router.pm: Send a command to a router.
* snmp.pm: Sends SNMP SETs to an SNMP agent.
* trango.pm: Sends SNMP SETs to a Trango AP.

==svc_phone==
* globalpops_voip.pm:
* grandstream.pm: Grandstream phone and ATA provisioning. This [http://www.freeside.biz/blog/?p=11 blog article] is a start at documentation.
* indosoft.pm:
* internal_diddb.pm:
* netsapiens.pm:
* phone_shellcommands.pm:
* phone_sqlradius.pm:
* thirdlane.pm:
* vitelity.pm:

==svc_external==
* artera_turbo.pm:

= Services =

== Accounts (svc_acct) ==

* [[Freeside:1.9:Documentation:Administration:svc_acct:_password_encoding|Password encoding in 1.9]]

== Domains (svc_domain) ==

== Forwards (svc_forward) ==

== Hosting (svc_www) ==

== Broadband (svc_broadband) ==

== Phone (svc_phone) ==

== External (svc_external) ==

= Packages =

{{Freeside:1.9:Documentation:Administration:pkg_category}}

== Price Plans ==

=== Common price plans ===

* flat
* subscription
* prorate
* sqlradacct_hour
* voip_cdr
* prepaid

=== Wholesale price plans ===

* bulk

* [[Freeside:1.9:Documentation:Administration:Packages:Price_Plans:agent | agent]]
* [[Freeside:1.9:Documentation:Administration:Packages:Price_Plans:cdr_termination |
cdr_termination ]]

=== Other price plans ===

* flat_delayed
* flat_introrate
* prorate_delayed

* base_delayed
* base_rate

* sql_external
* sql_generic

=== Price plans of questionable functionality ===

* flat_comission_cust
* flat_comission_pkg
* flat_comission

* voip_sqlradacct

* sesmon_hour
* sesmon_minute

== Misc ==

* Some notes on [[Freeside:1.9:Documentation:Administration:Upselling | Upselling]]

= Resellers =

= Employees =

== Employees ==

Go to Configuration -> Employees -> Employees to view the existing employees and add new ones. It is highly recommended to add a separate account for each person rather than using role accounts.

* To add a new employee, click on "Add an employee"
* Or to edit an existing group, click on the employee number or name in the list of employees.
* Enter or edit the username, password and name. If editing an existing employee and no password change is desired, the password fields can be left blank.
* Check the "Disable employee" box to disable this employee.
* In the "Employee groups" section, mark or unmark checkboxes to indicate the access groups for this employee.

== Employee groups and access control ==

To setup employee access control or agent/reseller virtualization, you need to setup employee groups. Go to Configuration -> Employees -> Employee groups to view the existing groups and add new ones. The system starts with a "Superuser" group which has access to all functionality for the first agent.

* To add a new group, click on "Add an employee group"
* Or to edit an existing group, click on the group number or name in the list of groups.
* Enter or edit the group name.
* In the "Group limited to these agent(s)" section, mark checkboxes next to the agents this employee group should be able to see. Employees in this group will only see customers of the selected agents in the system and reports.
* In the "Group access rights" section, mark or unmark checkboxes to indicate the access rights this employee group should have. Rights marked with an "*" are global rights which provide access to global data which is shared among all agents. Their use is not recommended for groups which are limited to a subset of agents.
* After adding a new group, don't forget to go back and add or edit employees to place them into the new group.

= Billing =

== Billing events ==
Billing events are the primary mechanism to implement your business rules. Rules such as resend invoices, retry cards, suspend or cancel accounts for non-payment, etc. are all handled by billing events.

At a high level, follow the following steps to create billing events:
* Add a new Billing Event (Configuration > Billing > Billing events)
* Name the event
* Choose the type of event:
** Package - Packages and associated dates (Including Commissions)
** Invoice - Invoice status and dates
** Customer - Customer Balances and Information
** Batch Payment - Batch payment results
** Statement - Send statement
* Choose whether to apply to one or all agents
* Choose the frequency for the system to check and see if the event should run.
* Choose appropriate filters.
* Choose appropriate actions.

The form is dynamic so changing the type of event will change the available filters and actions.

== Daily and Monthly Scripts ==
* The freeside-daily script should be run daily to bill customers and run invoice collection events.
** Typically, this is accomplished with an entry in the freeside user's crontab such as: <pre>0 0 * * * /usr/local/bin/freeside-daily</pre>
** If running freeside-daily manually, ensure the <code>TZ</code> variable is set to your timezone with a command such as: <pre>TZ="US/Pacific" freeside-daily fs_daily</pre>
* If any monthly events are enabled, the freeside-monthly script should be run monthly.
* Invoice events can also be used to implement agent-virtualized invoices. (add more info)

== Invoices ==

=== Templates ===

==== Typeset (LaTeX) invoice templates ====

===== Prerequisites =====

* Almost all distributions include the necessary prerequisites listed here, manual installation is practically never necessary.
* Install [http://www.ghostscript.com/ Ghostscript] (gs)
* Install [http://www.tug.org/tetex/ teTeX] or [http://www.tug.org/texlive/ TeX Live]
* Ensure that the <code>pslatex</code>, <code>dvips</code>, and <code>pdflatex</code> command line utilities were installed

===== Logo setup =====

The EPS logo is for PDF and printed invoices.

* For best results, save a '''vector format''' logo in EPS (Encapsulated PostScript) format.
** Your graphic artist can create vector image from a bitmap (tracing etc).
** Converting a bitmap such as a JPG can work (the bigger the better), but it may render in lower quality, blurry or with the "jaggies" (especially when actually printed, not just viewed as a PDF)
* Resize the logo to 90pt X 36pt: <code>epsffit -c 0 0 90 36 yourlogo.eps >logo.eps</code>
* Upload the resized logo as the <code>logo.eps</code> configuration option.
* Problems? Try <code>bin/strip-eps <oldlogo.eps >trynewlogo.eps</code>

The PNG logo is for emailed and online invoices.

Freeside ships with a logo of 92 x 62. Any logo close to this size should work with the default HTML template.

{{Freeside:1.9:Documentation:Administration:invoice_layout}}

==== HTML invoice templates ====

* Convert your logo to PNG format and upload it as the <code>logo.png</code> configuration option.
* Edit the invoice_html configuration option. HTML invoices use Text::Template with <%= and %> delimiters.
* The following configuration options can be set to override the default behaviour of using the invoice_latex* data transformed to HTML: invoice_htmlreturnaddress, and invoice_htmlfooter, invoice_htmlnotes.

==== Plaintext invoice templates ====

* See the Text::Template documentation for details on the substitution language.
* You must call the invoice_lines() function at least once - pass it a number of lines, and it returns a list of array references, each of two elements: a service description column, and a price column. Alternatively, call invoice_lines() with no arguments, and pagination will be disabled - all invoice line items will print on one page, with no padding (recommended for email invoices).
* Descriptions of variables are available in [[Freeside:1.9:Documentation:Template:invoice_html|invoice_html]]

=== Misc ===

==== Manually setting next invoice number sequence ====

* With PostgreSQL, to number invoices starting at 5000: <pre>SELECT SETVAL(cust_bill_invnum_seq, 4999);</pre>
* With MySQL:

== Payment Receipts ==

The [[Freeside:1.9:Documentation:Template:payment_receipt_email|payment_receipt_email]] template is used for manually applied payments.

== Credit cards and Electronic checks ==
* [[Freeside:1.9:Documentation:Administration:Real-time_Processing | Real-time credit card and electronic check processing]]
* [[Freeside:1.9:Documentation:Administration:Batch_Processing | Batch credit card and electronic check processing]]
* Credit card expiration alerts: Customize the ''alerter_template'' configuration option and run <code>freeside-expiration-alerter</code> daily.
* Credit card decline alerts: Customize the ''declinetemplate'' configuration option and set the ''emaildecline'' configuration option.

= Misc =

* Setting up [[Freeside:1.9:Documentation:Administration:Encrypted Credit Cards | Encrypted Credit Cards]]
* Setting up [[Freeside:1.9:Documentation:Administration:Texas Tax | Texas Tax]]
* Setting up [[Freeside:1.9:Documentation:Administration:VoIP | VoIP]]

* Setting up [[Freeside:1.9:Documentation:Administration:Commission|Commissions and Referrals]]
* Need to print to Windows printers? Follow steps 1-4 of [http://iharder.sourceforge.net/current/macosx/winmacprinter/ Share Your Windows Printer].
* Setting up [[Freeside:1.9:Documentation:Administration:Slony | Slony replication and failover]]
* Using a non-standard [[Freeside:1.9:Documentation:Administration:PostgreSQL_Schema | PostgreSQL Schema]]

{{ContextSensitiveHelp}}

Freeside:1.9:Documentation:Administration:invoice layout

2010-07-12T04:36:47Z

Rluser: New page: Category:Invoice_Layout ===Invoice Layout and Content=== ====Basic Invoice Styles==== Several variables make significant changes to the appearance of invoices. {{Freeside:Configurati...

[[Category:Invoice_Layout]]

===Invoice Layout and Content===
====Basic Invoice Styles====
Several variables make significant changes to the appearance of invoices.

{{Freeside:Configuration:invoice_sections}}
{{Freeside:Configuration:invoice_usesummary}}
{{Freeside:Configuration:usage_class_as_a_section}}
{{Freeside:Configuration:svc_phone_sections}}

====Invoice Templates====
{{Freeside:1.9:Documentation:Administration:invoice_templates}}

{{Freeside:1.9:Documentation:Administration:VOIP plan invoice layout variables}}

==== Other Variables Changing Invoice Layout at Billing Time====
{{Freeside:Configuration:separate_usage}}

==== Variables Neither Perfectly Rendering nor Perfectly Generational====
{{Freeside:Configuration:date_format}}
{{Freeside:Configuration:money_char}}
{{Freeside:Configuration:invoice_default_terms}}

====Boolean Rendering Variables====
{{Freeside:Configuration:invoice_show_prior_due_date}}
{{Freeside:Configuration:invoice_include_aging}}
{{Freeside:Configuration:invoice_smallernotes}}
{{Freeside:Configuration:invoice_smallerfooter}}
{{Freeside:Configuration:invoice-ship_address}}
{{Freeside:Configuration:disable_line_item_date_ranges}}
{{Freeside:Configuration:disable_previous_balance}}
{{Freeside:Configuration:previous_balance-summary_only}}
{{Freeside:Configuration:balance_due_below_line}}
{{Freeside:Configuration:invoice-unitprice}}

====Other Rendering Variables====
{{Freeside:Configuration:invoice_latextopmargin}}
{{Freeside:Configuration:invoice_latexheadsep}}
{{Freeside:Configuration:invoice_latexaddresssep}}
{{Freeside:Configuration:invoice_latextextheight}}
{{Freeside:Configuration:invoice_latexextracouponspace}}
{{Freeside:Configuration:invoice_latexcouponfootsep}}
{{Freeside:Configuration:invoice_latexcouponamountencosedsep}}
{{Freeside:Configuration:invoice_latexcoupontoaddresssep}}
{{Freeside:Configuration:invoice_latexverticalreturnaddress}}
{{Freeside:Configuration:invoice_latexcouponaddcompanytoaddress}}
{{Freeside:Configuration:previous_balance-exclude_from_total}}
{{Freeside:Configuration:company_name}}
{{Freeside:Configuration:company_address}}
{{Freeside:Configuration:finance_pkgclass}}
{{Freeside:Configuration:cust_bill-max_same_services}}
{{Freeside:Configuration:cust_bill-consolidate_services}}

====Miscellaneous Variables Impacting Customer Perception of Invoices====

These variables do not change the invoice per se, but do change what is emailed to a customer as an invoice.
{{Freeside:Configuration:invoice_email_pdf}}
{{Freeside:Configuration:invoice_email_pdf_note}}
{{Freeside:Configuration:voip-cust_email_csv_cdr}}

Freeside:1.9:Documentation:Administration:invoice templates

2010-07-12T04:34:24Z

Rluser: New page: * Edit the invoice_latexreturnaddress, invoice_latexfooter, invoice_latexnotes, and invoice_latexsmallfooter configuration options. If you are adventurous, edit invoice_latex as well.

* Edit the invoice_latexreturnaddress, invoice_latexfooter, invoice_latexnotes, and invoice_latexsmallfooter configuration options. If you are adventurous, edit invoice_latex as well.

Freeside:1.9:Documentation:Administration:VOIP plan invoice layout variables

2010-07-12T04:03:20Z

Rluser:

==== Common VOIP plan options for invoice appearance ====

Certain configuration options on telephony plan packages can have significant impact on the appearances of invoices by changing the data calculated and stored at the time of invoice generation.

;CDR invoice display format [output_format]
:controls the data stored for the usage detail on the invoice. Current choices are
default - date, time, destination, regionname, duration, price
default with source - source, date, time, destination, regionname, duration, price
default with account code - date, time, account code, destination, regionname, duration, price
simple - date, time, user, destination, duration, price
simple with source - date, time, source, destination, duration, price

;Section in which to place usage charges (whether separated or not) [usage_section]
:names an [[Freeside:Configuration:invoice_sections|invoice section]] which is to contain the usage portion of the invoiced package. If the section is to be included in a [[Freeside:Configuration:invoice_usesummary|summary page]] then you will need to ensure the spelling exactly matches a [[Freeside:1.9:Documentation:Administration:pkg_category|package category]]

;Include usage summary with recurring charges when usage is in separate section [summarize_usage]
:creates an additional (2nd) line on the invoice showing the total usage associated with the package. Typically appears below a 'setup' and 'recurring' line (if they exist).

;Always put usage details in separate section [usage_mandate]
:causes freeside to generate an extra section for the usage details even when freeside is not using [[Freeside:Configuration:invoice_sections|invoice sections]].

[[Category:Invoice_Layout]]
[[Category:Price_Plan_Options]]

Freeside:1.9:Documentation:Administration:VOIP plan invoice layout variables

2010-07-12T03:46:57Z

Rluser:

== Common VOIP plan options for invoice appearance ==

Certain configuration options on telephony plan packages can have significant impact on the appearances of invoices by changing the data calculated and stored at the time of invoice generation.

;CDR invoice display format [output_format]
:controls the data stored for the usage detail on the invoice. Current choices are
default - date, time, destination, regionname, duration, price
default with source - source, date, time, destination, regionname, duration, price
default with account code - date, time, account code, destination, regionname, duration, price
simple - date, time, user, destination, duration, price
simple with source - date, time, source, destination, duration, price

;Section in which to place usage charges (whether separated or not) [usage_section]
:names an [[Freeside:Configuration:invoice_sections|invoice section]] which is to contain the usage portion of the invoiced package. If the section is to be included in a [[Freeside:Configuration:invoice_usesummary|summary page]] then you will need to ensure the spelling exactly matches a [[Freeside:1.9:Documentation:Administration:pkg_category|package category]]

;Include usage summary with recurring charges when usage is in separate section [summarize_usage]
:creates an additional (2nd) line on the invoice showing the total usage associated with the package. Typically appears below a 'setup' and 'recurring' line (if they exist).

;Always put usage details in separate section [usage_mandate]
:causes freeside to generate an extra section for the usage details even when freeside is not using [[Freeside:Configuration:invoice_sections|invoice sections]].

[[Category:Invoice_Layout]]
[[Category:Price_Plan_Options]]

Freeside:1.9:Documentation:Administration

2010-07-12T03:38:29Z

Rluser: /* Packages */

= Exports (provisioning) =

'''Exports''' allow you to provision services to remote machines, databases and APIs. Some exports, such as ''sqlradius'' and ''sqlradius_withdomain'', enable a feed for retrieving rating/usage data.

Exports can be added and edited under
: Configuration -> Provisioning, services and packages -> View/edit exports

Most exports place jobs in the job queue for new, modified or deleted services. Jobs are run by [[Freeside:1.9:Documentation:Developer/bin/freeside-queued|freeside-queued]]. This daemon needs to be running before exports are acted upon.

Some exports use SSH, SCP or SFTP to communicate with external machines. See the documentation on [[Freeside:1.9:Documentation:Administration:SSH_Keys|SSH keys]].

Click on ''Add a new export'' to create a new export. Select exports from the dropdown to show more information on each export, including available options, setup and usage.

Exports are activated by associating them with one or more '''service definitions'''.

Following is a list of which exports can be associated with each type of service.

==svc_acct==
* [[Freeside:1.9:Documentation:Administration:acct_plesk.pm|acct_plesk.pm]]: Real-time export to Plesk managed mail service
* acct_sql.pm: Real-time export of accounts to SQL databases .
* artera_turbo.pm:
* bsdshell.pm:
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]: Real-time export to a CommuniGate Pro mail server
* communigate_pro_singledomain.pm:
* cpanel.pm: Real-time export to Cpanel control panel.
* cp.pm: Real-time export to Critical Path Account Provisioning Protocol
* cyrus.pm: Real-time export to Cyrus IMAP server
* everyone_net.pm: Real-time export to Everyone.net outsourced mail service
* infostreet.pm: Real-time export to InfoStreet streetSmartAPI
* ldap.pm: Real-time export to LDAP
* passwdfile.pm:
* radiator.pm: Real-time export to RADIATOR
* shellcommands.pm:
* shellcommands_withdomain.pm: Real-time export via remote SSH (vpopmail, ISPMan)
* sqlmail.pm: Real-time export to SQL-backed mail server
* sqlradius.pm: Real-time export to SQL-backed RADIUS (FreeRADIUS, ICRADIUS)
* sqlradius_withdomain.pm: Real-time export to SQL-backed RADIUS (FreeRADIUS, ICRADIUS) with realms
* sysvshell.pm:
* textradius.pm:
* vpopmail.pm: Real-time export to vpopmail text files

==svc_domain==
* bind.pm: Batch export to BIND named
* bind_slave.pm: Batch export to slave BIND named
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]: Real-time export to a CommuniGate Pro mail server
* domain_shellcommands.pm: Run remote commands via SSH, for domains (qmail, ISPMan).
* domain_sql.pm: Real time export of domains to SQL databases .
* http.pm: Send an HTTP or HTTPS GET or POST request
* [[Freeside:1.9:Documentation:Administration:opensrs.pm|opensrs.pm]]: OpenSRS integration
* sqlmail.pm: Real-time export to SQL-backed mail server

==svc_forward==
* artera_turbo.pm:
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]: Real-time export to a CommuniGate Pro mail server
* forward_shellcommands.pm: Run remote commands via SSH, for forwards
* postfix.pm: Postfix text files
* sqlmail.pm: Real-time export to SQL-backed mail server

==svc_www==
* apache.pm: Export an Apache httpd.conf file snippet.
* [[Freeside:1.9:Documentation:Administration:www_plesk.pm|www_plesk.pm]]: Real-time export to Plesk managed hosting service
* www_shellcommands.pm: Run remote commands via SSH, for virtual web sites (directory maintenance, FrontPage, ISPMan)

==svc_broadband==
* nas_wrapper.pm: A meta-export that triggers other svc_broadband exports.
* [[Freeside:1.9:Documentation:Administration:prizm.pm|prizm.pm]]: Real-time export to Northbound Interface
* router.pm: Send a command to a router.
* snmp.pm: Sends SNMP SETs to an SNMP agent.
* trango.pm: Sends SNMP SETs to a Trango AP.

==svc_phone==
* globalpops_voip.pm:
* grandstream.pm: Grandstream phone and ATA provisioning. This [http://www.freeside.biz/blog/?p=11 blog article] is a start at documentation.
* indosoft.pm:
* internal_diddb.pm:
* netsapiens.pm:
* phone_shellcommands.pm:
* phone_sqlradius.pm:
* thirdlane.pm:
* vitelity.pm:

==svc_external==
* artera_turbo.pm:

= Services =

== Accounts (svc_acct) ==

* [[Freeside:1.9:Documentation:Administration:svc_acct:_password_encoding|Password encoding in 1.9]]

== Domains (svc_domain) ==

== Forwards (svc_forward) ==

== Hosting (svc_www) ==

== Broadband (svc_broadband) ==

== Phone (svc_phone) ==

== External (svc_external) ==

= Packages =

{{Freeside:1.9:Documentation:Administration:pkg_category}}

== Price Plans ==

=== Common price plans ===

* flat
* subscription
* prorate
* sqlradacct_hour
* voip_cdr
* prepaid

=== Wholesale price plans ===

* bulk

* [[Freeside:1.9:Documentation:Administration:Packages:Price_Plans:agent | agent]]
* [[Freeside:1.9:Documentation:Administration:Packages:Price_Plans:cdr_termination |
cdr_termination ]]

=== Other price plans ===

* flat_delayed
* flat_introrate
* prorate_delayed

* base_delayed
* base_rate

* sql_external
* sql_generic

=== Price plans of questionable functionality ===

* flat_comission_cust
* flat_comission_pkg
* flat_comission

* voip_sqlradacct

* sesmon_hour
* sesmon_minute

== Misc ==

* Some notes on [[Freeside:1.9:Documentation:Administration:Upselling | Upselling]]

= Resellers =

= Employees =

== Employees ==

Go to Configuration -> Employees -> Employees to view the existing employees and add new ones. It is highly recommended to add a separate account for each person rather than using role accounts.

* To add a new employee, click on "Add an employee"
* Or to edit an existing group, click on the employee number or name in the list of employees.
* Enter or edit the username, password and name. If editing an existing employee and no password change is desired, the password fields can be left blank.
* Check the "Disable employee" box to disable this employee.
* In the "Employee groups" section, mark or unmark checkboxes to indicate the access groups for this employee.

== Employee groups and access control ==

To setup employee access control or agent/reseller virtualization, you need to setup employee groups. Go to Configuration -> Employees -> Employee groups to view the existing groups and add new ones. The system starts with a "Superuser" group which has access to all functionality for the first agent.

* To add a new group, click on "Add an employee group"
* Or to edit an existing group, click on the group number or name in the list of groups.
* Enter or edit the group name.
* In the "Group limited to these agent(s)" section, mark checkboxes next to the agents this employee group should be able to see. Employees in this group will only see customers of the selected agents in the system and reports.
* In the "Group access rights" section, mark or unmark checkboxes to indicate the access rights this employee group should have. Rights marked with an "*" are global rights which provide access to global data which is shared among all agents. Their use is not recommended for groups which are limited to a subset of agents.
* After adding a new group, don't forget to go back and add or edit employees to place them into the new group.

= Billing =

== Billing events ==
Billing events are the primary mechanism to implement your business rules. Rules such as resend invoices, retry cards, suspend or cancel accounts for non-payment, etc. are all handled by billing events.

At a high level, follow the following steps to create billing events:
* Add a new Billing Event (Configuration > Billing > Billing events)
* Name the event
* Choose the type of event:
** Package - Packages and associated dates (Including Commissions)
** Invoice - Invoice status and dates
** Customer - Customer Balances and Information
** Batch Payment - Batch payment results
** Statement - Send statement
* Choose whether to apply to one or all agents
* Choose the frequency for the system to check and see if the event should run.
* Choose appropriate filters.
* Choose appropriate actions.

The form is dynamic so changing the type of event will change the available filters and actions.

== Daily and Monthly Scripts ==
* The freeside-daily script should be run daily to bill customers and run invoice collection events.
** Typically, this is accomplished with an entry in the freeside user's crontab such as: <pre>0 0 * * * /usr/local/bin/freeside-daily</pre>
** If running freeside-daily manually, ensure the <code>TZ</code> variable is set to your timezone with a command such as: <pre>TZ="US/Pacific" freeside-daily fs_daily</pre>
* If any monthly events are enabled, the freeside-monthly script should be run monthly.
* Invoice events can also be used to implement agent-virtualized invoices. (add more info)

== Invoices ==

=== Templates ===

==== Typeset (LaTeX) invoice templates ====

===== Prerequisites =====

* Almost all distributions include the necessary prerequisites listed here, manual installation is practically never necessary.
* Install [http://www.ghostscript.com/ Ghostscript] (gs)
* Install [http://www.tug.org/tetex/ teTeX] or [http://www.tug.org/texlive/ TeX Live]
* Ensure that the <code>pslatex</code>, <code>dvips</code>, and <code>pdflatex</code> command line utilities were installed

===== Content setup =====

* Edit the invoice_latexreturnaddress, invoice_latexfooter, invoice_latexnotes, and invoice_latexsmallfooter configuration options. If you are adventurous, edit invoice_latex as well.

===== Logo setup =====

The EPS logo is for PDF and printed invoices.

* For best results, save a '''vector format''' logo in EPS (Encapsulated PostScript) format.
** Your graphic artist can create vector image from a bitmap (tracing etc).
** Converting a bitmap such as a JPG can work (the bigger the better), but it may render in lower quality, blurry or with the "jaggies" (especially when actually printed, not just viewed as a PDF)
* Resize the logo to 90pt X 36pt: <code>epsffit -c 0 0 90 36 yourlogo.eps >logo.eps</code>
* Upload the resized logo as the <code>logo.eps</code> configuration option.
* Problems? Try <code>bin/strip-eps <oldlogo.eps >trynewlogo.eps</code>

The PNG logo is for emailed and online invoices.

Freeside ships with a logo of 92 x 62. Any logo close to this size should work with the default HTML template.

==== HTML invoice templates ====

* Convert your logo to PNG format and upload it as the <code>logo.png</code> configuration option.
* Edit the invoice_html configuration option. HTML invoices use Text::Template with <%= and %> delimiters.
* The following configuration options can be set to override the default behaviour of using the invoice_latex* data transformed to HTML: invoice_htmlreturnaddress, and invoice_htmlfooter, invoice_htmlnotes.

==== Plaintext invoice templates ====

* See the Text::Template documentation for details on the substitution language.
* You must call the invoice_lines() function at least once - pass it a number of lines, and it returns a list of array references, each of two elements: a service description column, and a price column. Alternatively, call invoice_lines() with no arguments, and pagination will be disabled - all invoice line items will print on one page, with no padding (recommended for email invoices).
* Descriptions of variables are available in [[Freeside:1.9:Documentation:Template:invoice_html|invoice_html]]

=== Misc ===

==== Manually setting next invoice number sequence ====

* With PostgreSQL, to number invoices starting at 5000: <pre>SELECT SETVAL(cust_bill_invnum_seq, 4999);</pre>
* With MySQL:

== Payment Receipts ==

The [[Freeside:1.9:Documentation:Template:payment_receipt_email|payment_receipt_email]] template is used for manually applied payments.

== Credit cards and Electronic checks ==
* [[Freeside:1.9:Documentation:Administration:Real-time_Processing | Real-time credit card and electronic check processing]]
* [[Freeside:1.9:Documentation:Administration:Batch_Processing | Batch credit card and electronic check processing]]
* Credit card expiration alerts: Customize the ''alerter_template'' configuration option and run <code>freeside-expiration-alerter</code> daily.
* Credit card decline alerts: Customize the ''declinetemplate'' configuration option and set the ''emaildecline'' configuration option.

= Misc =

* Setting up [[Freeside:1.9:Documentation:Administration:Encrypted Credit Cards | Encrypted Credit Cards]]
* Setting up [[Freeside:1.9:Documentation:Administration:Texas Tax | Texas Tax]]
* Setting up [[Freeside:1.9:Documentation:Administration:VoIP | VoIP]]

* Setting up [[Freeside:1.9:Documentation:Administration:Commission|Commissions and Referrals]]
* Need to print to Windows printers? Follow steps 1-4 of [http://iharder.sourceforge.net/current/macosx/winmacprinter/ Share Your Windows Printer].
* Setting up [[Freeside:1.9:Documentation:Administration:Slony | Slony replication and failover]]
* Using a non-standard [[Freeside:1.9:Documentation:Administration:PostgreSQL_Schema | PostgreSQL Schema]]

{{ContextSensitiveHelp}}

Freeside:1.9:Documentation:Administration:pkg category

2010-07-12T03:36:58Z

Rluser: New page: ==Package Category== Package categories define groups of package classes. ;Category name :defines an invoice_section if that f...

==Package Category==

Package categories define groups of [[Freeside:1.9:Documentation:Adminsitration:pkg_class|package classes]].

;Category name
:defines an [[invoice_section]] if that feature is enabled.
;Weight
:determines the order in which [[invoice_section]]s appear.
;Collapse identical items into one
:causes identical packages to appear folded into a single line item with a quantity when checked rather than the default once line item per package.

Freeside:1.9:Documentation:Administration:VOIP plan invoice layout variables

2010-07-12T02:05:02Z

Rluser:

== Common VOIP plan options for invoice appearance ==

Certain configuration options on telephony plan packages can have significant impact on the appearances of invoices by changing the data calculated and stored at the time of invoice generation.

;CDR invoice display format [output_format]
:controls the data stored for the usage detail on the invoice. Current choices are
default - date, time, destination, regionname, duration, price
default with source - source, date, time, destination, regionname, duration, price
default with account code - date, time, account code, destination, regionname, duration, price
simple - date, time, user, destination, duration, price
simple with source - date, time, source, destination, duration, price

;Section in which to place usage charges (whether separated or not) [usage_section]
:names an [[Freeside:Configuration:invoice_sections|invoice section]] which is to contain the usage portion of the invoiced package. If the section is to be included in a [[Freeside:1.9:Documentation:Administration:summary_page|summary page]] then you will need to ensure the spelling exactly matches a [[Freeside:1.9:Documentation:Administration:pkg_category|package category]]

;Include usage summary with recurring charges when usage is in separate section [summarize_usage]
:creates an additional (2nd) line on the invoice showing the total usage associated with the package. Typically appears below a 'setup' and 'recurring' line (if they exist).

;Always put usage details in separate section [usage_mandate]
:causes freeside to generate an extra section for the usage details even when freeside is not using [[Freeside:1.9:Documentation:Administration:invoice_section|invoice sections]].

[[Category:Invoice_Layout]]
[[Category:Price_Plan_Options]]

Freeside:1.9:Documentation:Administration:VOIP plan invoice layout variables

2010-07-12T01:48:55Z

Rluser:

== Common VOIP plan options for invoice appearance ==

Certain configuration options on telephony plan packages can have significant impact on the appearances of invoices by changing the data calculated and stored at the time of invoice generation.

;CDR invoice display format [output_format]
:controls the data stored for the usage detail on the invoice. Current choices are
default - date, time, destination, regionname, duration, price
default with source - source, date, time, destination, regionname, duration, price
default with account code - date, time, account code, destination, regionname, duration, price
simple - date, time, user, destination, duration, price
simple with source - date, time, source, destination, duration, price

;Section in which to place usage charges (whether separated or not) [usage_section]
:names an [[Freeside:Configuration:invoice_sections|invoice section]] which is to contain the usage portion of the invoiced package. If the section is to be included in a [[Freeside:1.9:Documentation:Administration:summary_page|summary page]] then you will need to ensure the spelling exactly matches a [[Freeside:1.9:Documentation:Administration:package_category|package category]]

;Include usage summary with recurring charges when usage is in separate section [summarize_usage]
:creates an additional (2nd) line on the invoice showing the total usage associated with the package. Typically appears below a 'setup' and 'recurring' line (if they exist).

;Always put usage details in separate section [usage_mandate]
:causes freeside to generate an extra section for the usage details even when freeside is not using [[Freeside:1.9:Documentation:Administration:invoice_section|invoice sections]].

[[Category:Invoice_Layout]]
[[Category:Price_Plan_Options]]

Freeside:Configuration:voip-cust email csv cdr

2010-07-11T21:23:23Z

Rluser:

[[Category:Freeside_Configuration_Settings]]
[[Category:Invoice_Layout]]
;voip-cust_email_csv_cdr
:Enable the per-customer option for including CDR information as a CSV attachment on emailed invoices.

Freeside:Configuration:invoice email pdf note

2010-07-11T21:20:07Z

Rluser: New page: Category:Freeside_Configuration_Settings Category:Invoice_Layout ;invoice_email_pdf_note :If defined, this text will replace the default plain text invoice as the body of emailed P...

[[Category:Freeside_Configuration_Settings]]
[[Category:Invoice_Layout]]
;invoice_email_pdf_note
:If defined, this text will replace the default plain text invoice as the body of emailed PDF invoices.

Freeside:Configuration:invoice email pdf

2010-07-11T21:19:03Z

Rluser: New page: Category:Freeside_Configuration_Settings Category:Invoice_Layout ;invoice_email_pdf :Send PDF invoice as an attachment to emailed invoices. By default, includes the plain text inv...

[[Category:Freeside_Configuration_Settings]]
[[Category:Invoice_Layout]]
;invoice_email_pdf
:Send PDF invoice as an attachment to emailed invoices. By default, includes the plain text invoice as the email body, unless [[Freeside:Configuration:invoice_email_pdf_note|invoice_email_pdf_note]] is set.

Freeside:Configuration:disable previous balance

2010-07-11T21:14:56Z

Rluser:

[[Category:Freeside_Configuration_Settings]]
[[Category:Invoice_Layout]]
;disable_previous_balance
:Disable inclusion of previous balance, payment, and credit lines on invoices.