Freeside - User contributions [en]

Freeside:4:Documentation:Administration:Tax Districts

2019-06-18T22:59:08Z

Jlucas: /* Upgrade from Version 3 to 4 */

== Overview ==
Freeside supports billing taxes by district, instead of city/county/state.

Currently this is only supported in the state of Washington. Public data
sources provided by the Washington Dept. of Revenue are used to automatically
maintain tax rate tables, and classify customer locations into the correct
tax district.

== Setup ==

=== Enable Washington state sales tax districts ===

# Navigate to: Configuration > Settings
# Set option '''tax_district_method''' to '''Washington sales tax'''
# Set option '''tax_district_taxname''', the tax name to dsplay on the invoice, or keep the default as '''Tax'''
# Run '''freeside-daily''' or '''freeside-tax-district-update -l''' to populate tax tables, and classify customers into their districts

=== Download tax tables and classify customer tax districts ===

The WA tax tables will be automatically populated, and customers in WA will
be classified into their tax district he next time '''freeside-daily''' runs.

You don't have to wait for '''freeside-daily'''. The following command
will update the tax tables and classify WA customers into their tax district.

sudo -u freeside /usr/bin/freeside-tax-district-update -l freeside_username

=== Changing Tax Name ===

You can change the display name for this tax by setting the config option '''tax_district_taxname'''. After changing the configuration value, the tax tables must be updated with the new taxname. This will happen automatically on the 1st of each month. Use '''freeside-tax-district-update''' to force this update sooner.

== Administration ==

=== Tax table updates ===

'''freeside-daily''' will refresh the tax tables automatically on the first
of each month.

Tax tables can be forcibly updated at any time using the
'''freeside-tax-district-update''' utility.

If freeside is configured to use tax classes, with the '''enable_taxclasses'''
configuration value, a complete copy of the Washington tax table will be
created in every taxclass. If new tax classes are added later, the
'''freeside-tax-district-update''' utility can be used to force an immediate rebuild
of the tax table into the new tax class.

To view the tax table, navigate to Configuration > Billing > Locales and Tax Rates

=== Customer tax district classification ===

When an address record is created or edited, Freeside will ask the WA Dept.
of Revenue API which tax district to use for the address.

If an invalid address is entereed, the tax district cannot be determined.
The user will be advised to correct the address, or to manually choose a
tax district to use.

Invoices cannot be generated for a WA customer missing a tax district.
When a customer is missing a tax district:
* A notice appears on the customer page with instructions to fix
* Billing will not complete for this customer
* Freeside will retry, daily, to determine the customer tax district
* System log notices are generated about this problem. Subscribe to E-Mail alerts of these notices.

The '''freeside-tax-district-update''' tool can be used to force reclassification
of every WA state address in cust_location. This may be useful if the state
re-draws district lines, and all customers need to be reclassified.

=== Configure system log alerts ===

If a customer location record in the database lacks a tax district,
freeside-daily will attempt to correct this situation. If that fails,
Freeside will report an error to the system log.

Freeside will report another error every time '''freeside-daily''' runs, for
every WA cust_location record without a tax district.

It is recommended to set two e-mail system log alerts:
1. log-level: error, log-context: wa_sales
2. log-level: error, log-context: tax_rate_update

Using log-level: info, somebody can be notified of all tax tables updates,
and every successful tax district classification for a cust_location record.

See [[Freeside:3:Documentation:Administration#System_Log]] for help
configuration system log alerts.

== Upgrade from Version 3 to 4 ==

Beginning with Freeside version 4, duplicate rows for identical tax districts
in the cust_main_county table will block automatic tax table updates.

After upgrade, if an instance needs tax table repair,
'''freeside-wa-tax-table-repair --check''' will display information on
the problem tax rows. The duplicate rows can be merged with
'''freeside-wa-tax-table-repair --merge''' or
'''freeside-wa-tax-table-repair --merge-all'''

If a problem has developed with manually entered tax table rows for
Universal Service Fund, this can be fixed with
'''freeside-wa-tax-table-repair --fix-usf'''

After running these tools, it's recommended to force a tax table update
with '''freeside-wa-tax-table-update -l'''

Freeside:3:Documentation:Administration:Tax Districts

2019-06-06T19:01:52Z

Jlucas: /* Updating tax rates */

See also: [[Freeside:4:Documentation:Administration:Tax_Districts]]

==Overview ==
Freeside currently supports billing taxes by district, instead of city/county/state. Currently this is only supported in the state of Washington. The information is pulled from the Washington Department of Revenue for updating customer records with tax districts while also updating the tax rates in the internal tax editor located at Configuration -> Billing -> Locales and tax rates.

== Setup ==

Configure option: tax_district_method, in Configuration -> Settings. Currently the only option is Washington sales tax.

The command freeside-tax-district-update will need to be ran. User should be replaced with a valid user in Freeside.

<pre>sudo -u freeside freeside-tax-district-update user</pre>

The command will update the 'district' field for all customers and service locations using an online tax information lookup method. Looking up the tax district will create a cust_main_county record with the tax rate for that district. All jobs are queued so their may be some delay before all records are modified.

== Updating tax rates ==

The script wa_tax_rate_update can be used to update taxes in the cust_main_county table.

Example usage:

<pre>sudo -u freeside wa_tax_rate_update -t "State Sales Tax" -c "Sales"</pre>

-t defines the tax name<br>
-c defines the tax class

This will download the new rates and upgrade the tax tables. You will need to do this for each tax class
you have setup in your system.

Freeside:3:Documentation:Administration:Tax Districts

2019-06-06T19:01:38Z

Jlucas: /* Setup */

See also: [[Freeside:4:Documentation:Administration:Tax_Districts]]

==Overview ==
Freeside currently supports billing taxes by district, instead of city/county/state. Currently this is only supported in the state of Washington. The information is pulled from the Washington Department of Revenue for updating customer records with tax districts while also updating the tax rates in the internal tax editor located at Configuration -> Billing -> Locales and tax rates.

== Setup ==

Configure option: tax_district_method, in Configuration -> Settings. Currently the only option is Washington sales tax.

The command freeside-tax-district-update will need to be ran. User should be replaced with a valid user in Freeside.

<pre>sudo -u freeside freeside-tax-district-update user</pre>

The command will update the 'district' field for all customers and service locations using an online tax information lookup method. Looking up the tax district will create a cust_main_county record with the tax rate for that district. All jobs are queued so their may be some delay before all records are modified.

== Updating tax rates ==

The script wa_tax_rate_update can be used to update taxes in the cust_main_county table.

Example usage:

<pre>wa_tax_rate_update -t "State Sales Tax" -c "Sales"</pre>

-t defines the tax name<br>
-c defines the tax class

This will download the new rates and upgrade the tax tables. You will need to do this for each tax class
you have setup in your system.

Freeside:4:Documentation

2019-05-21T21:23:07Z

Jlucas: /* Signup and Self-service installation */

= Note =

Some documentation links point to earlier versions until things are fully moved over. The information should still be applicable.

= Installation and upgrades =

== Backend Installation ==

=== Packages ===

* [[Freeside:4:Documentation:InstallingOnDebian8|Debian 8 "jessie"]]
* [[Freeside:4:Documentation:InstallingOnDebian9|Debian 9 "stretch"]]

=== Source ===

* [[Freeside:4:Documentation:Installation|New Installation]]
* [[Freeside:3:Documentation:RT Installation|Integrated RT Installation]]
* [[Freeside:3:Documentation:Torrus Installation|Integrated Torrus Installation]]

== Signup and Self-service installation ==

* [[Freeside:3:Documentation:Self-Service Installation|Signup/Self-service Installation]]
* [[Freeside:3:Documentation:Self-Service access without service|Self-Service access without package/service]]
* [[Freeside:3:Documentation:NG_Self-Service| Next generation self-service portal]] (Work in progress)

== Upgrading ==

* [[Freeside:4:Documentation:Upgrading|Upgrading from 3.3 or later to 4.x]]
* [[Freeside:3:Documentation:Upgrading|Upgrading between 4.x versions]]

= Users =

* [[Freeside:3:Documentation:User|User's Guide]] (help wanted)
* [http://www.sisd.com/~ivan/freeside-slides Training presentation slides]

== Features in v3 and v4 that somehow got documented here ==

* [[Freeside:4:Documentation:Appointments]]

= Administrator =

== Reference ==

* [[Freeside:3:Documentation:Administration|Administrator's Guide]]
* [[:Category:Freeside:1.9:Documentation:Template|Templates]] used and their fill in variables.

== New features in v4 ==

* [[Freeside:4:Documentation:Administrator:Multi-currency|Multi-currency]]
* Emails triggered by system log events can be set up at Configuration -> Miscellaneous -> System log emails

== Features in v3 and v4 that somehow got documented here ==

* [[Freeside:4:Documentation:Administrator:Fees|Automated fees]]
* [[Freeside:4:Documentation:Cacti|Cacti Integration]]
* [[Freeside:4:Documentation:MagicMail|MagicMail Integration]]

= Developer =

== Reference ==

* [[Freeside:3:Documentation:Developer|Developer's Guide]]
* [[Freeside:3:Documentation:Billing_Internals|Billing Internals]] (walkthrough of the core invoice generation code)

== New features in v4 ==

* [[Freeside:4:Documentation:Developer:Authentication_Plugins|Authentication Plugins]]
* [[Freeside:4:Documentation:TaxEngine|Tax Engines]]

= Accounting Guide =

*[[Freeside:Documentation:Accounting|Accounting Guide]]

= Misc old stuff =

* [[Freeside:Documentation:FAQ|Frequently Asked Questions]]
* [[3rd_party_software|Third-party software]]
* [[Freeside:2.1:Documentation:Administration:VoIP:Timed_Rates|Feature: Timed Rates]]
* [[Freeside:2.1:Documentation:Administration:RT_Workflow|RT workflow features]]
* [[Freeside:2.1:Documentation:Administration:Tips_and_Tricks|Tips and Tricks]]

= Changelog =

* [[Freeside:4.0:Changelog|4.0 Changelog]]
* [[Freeside:4.1:Changelog|4.1 Changelog]]
* [[Freeside:4.2:Changelog|4.2 Changelog]]
* [[Freeside:4.3:Changelog|4.3 Changelog]]

Freeside:4:Documentation:User:Price Adjustment tool

2019-05-17T07:20:29Z

Jlucas: Created page with "==== Price Adjustment Tool ==== Do you need to perform a bulk edit of many packages to adjust the setup or recurring price set? Well now there is a tool to help you make thi..."

==== Price Adjustment Tool ====

Do you need to perform a bulk edit of many packages to adjust the setup or recurring price set?

Well now there is a tool to help you make this adjustment.

Go to '''Configuration''' -> '''Packages''' -> '''Package Definitions'''

Using the check box to the far right edge of each package, check the box for the items that need adjusting.

Once you have those packages checked, scroll to the very bottom of the page. Click "edit packages"

A modal will be displayed and within that you will see two options: first is "'''Edit Report Classes'''", second is "'''Edit pricing fields'''".

Check the box next to "'''Edit pricing fields'''".

You will now see two new rows. One for adjusting the setup fee and second for adjusting the recurring fee. Both of which need to have a percentage value. Enter a value greater than 0 and then click "'''Bulk change packages'''"

* "'''Edit report classes'''" allows you to add one or more Report Classes to all selected packages.
* "'''Edit pricing fields'''" allows you to enter a "real" number percentage value that can be used to adjust the setup or recurring price of the selected packages.

Freeside:3:Documentation:User:Price Adjustment tool

2019-05-17T07:19:42Z

Freeside:3:Documentation:User

2019-05-17T06:59:12Z

Jlucas: /* Tower coverage estimation */

= Introduction =

== About ==

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

AGPL now

== 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)

= Prospects =

== Adding prospcts ==

== Searching for prospects ==

== Prospect view ==

=== Qualifications ===

If you have any qualification-capable services configured, you may perform qualifications using the "New Qualification" link. Previously-performed qualifications may be viewed from "View Qualifications". See [[#Qualifications 2|Package Qualifications]] for details.

= 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

==== Package Dates ====

There are several dates which can be set on a package for a wide range of functionality

* Start date - Delay the package's first billing until a date in the future. Setting this in the past will have no effect and the package will bill immediately.
* Setup date - The first day the package bills. This also controls the billing of setup fees. Once a setup date is established on a package the setup fee will not bill

* Last bill date - The last date the package billed

* Next bill date - The next date the package will bill.

* Contract end date - Notes the end date of the customers current contract. Does not have any billing implications unless you setup billing events to suspend packages which have a lapsed contract end date. This date can also be used in the advanced package reports for auditing purposes.

It is not advised to manually edit last or next bill dates as editing these incorrectly can have undesired results.

'''NOTE: Package date editing will deprecated in 4.x in favor of specific work flow functionality.'''

==== Qualifications ====

If you have any qualification-capable services configured, you may perform qualifications using the "New Qualification" link under Packages, and then choosing the "Qualify using" field appropriately and filling out the form.

Previously-performed qualifications may be viewed from "View Qualifications".

Notes specific to New Qualification for Ikano:
# An address is always required
# Location Type may be only one of the fixed Ikano values - see their documentation
# Location Kind must always be chosen
# Dry loops - always leave "Service Telephone Number" empty
# Line-share (non dry loops) - always fill in "Service Telephone Number"

Notes specific to qualification results / viewing previous qualifications for Ikano:
# The view qualification page will show all possible packages in Freeside which you can order, based on the customer data which was qualified
# Click on the package to order

==== Services ====

===== Accounts =====

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

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

Ikano-specific notes:
* New Orders
# Perform a qualification (see Qualifications above)
# Order one of the qualifying packages shown on the qualification result and set the start date and location on this package appropriately
# For dry loops, leave the Service Telephone Number blank and choose the "Standalone" Loop Type
# For line-share (non dry-loops), always fill in the Service Telephone Number and choose the "Line-share" Loop Type
* Viewing DSL Orders - click on the service to view all order data, including notes placed on the order by Ikano or you via their web portal
* Canceling DSL Orders
** A NEW order in NEW or PENDING statuses may be canceled immediately - do a normal "Cancel now" on the package
** A NEW order in COMPLETED status may be canceled by expiring the package - do a normal "Cancel later" on the package with a cancel date at least 48 hours in future
* Changing PPPoE password - edit the service and change the password
* Suspending and unsuspending - do a normal Suspend Now or Unsuspend on the package
* Processes not supported currently (use the Ikano web interface for now):
** Canceling NEW orders in any status other than NEW, PENDING, or COMPLETED
** Anything involving CHANGE orders - e.g. changing the package/service, canceling a change/move, performing a move
** Aborting cancellations (unexpiring packages) while a CANCEL order is in NEW or PENDING status
** Syncing an order's disconnect or activation date to the package dates
* Due to Ikano's API, it will not be possible to place notes on an order from Freeside, so this cannot be implemented

=== 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 ===

* See [[Freeside:3:Documentation:User:Form_477]].

== 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 ===

* See [[Freeside:3:Documentation:User:Tax_liability_report]].

= Tools =

== Quick Payment Entry ==

== Tower coverage estimation ==

[[Freeside:3:Documentation:User:Tower_coverage_estimation|Enter your tower locations and display their expected coverage area.]]

== Price Adjustment tool ==

[[Freeside:3:Documentation:User:Price_Adjustment_tool|Bulk editor for setup and recurring prices]]

= Services =
== Provisioning exports ==
[[Provisioning_exports|Provisioning exports.]]

= Auditing Legacy Data =

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

Freeside:4:Documentation

2019-05-16T19:45:41Z

Jlucas: /* Signup and Self-service installation */

= Note =

Some documentation links point to earlier versions until things are fully moved over. The information should still be applicable.

= Installation and upgrades =

== Backend Installation ==

=== Packages ===

* [[Freeside:4:Documentation:InstallingOnDebian8|Debian 8 "jessie"]]
* [[Freeside:4:Documentation:InstallingOnDebian9|Debian 9 "stretch"]]

=== Source ===

* [[Freeside:4:Documentation:Installation|New Installation]]
* [[Freeside:3:Documentation:RT Installation|Integrated RT Installation]]
* [[Freeside:3:Documentation:Torrus Installation|Integrated Torrus Installation]]

== Signup and Self-service installation ==

* [[Freeside:3:Documentation:Self-Service Installation|Signup/Self-service Installation]]
* [[Freeside:4:Documentation:Self-Service Signup|Including Signup/Self-service in your WordPress pages]]
* [[Freeside:3:Documentation:Self-Service access without service|Self-Service access without package/service]]
* [[Freeside:3:Documentation:NG_Self-Service| Next generation self-service portal]] (Work in progress)

== Upgrading ==

* [[Freeside:4:Documentation:Upgrading|Upgrading from 3.3 or later to 4.x]]
* [[Freeside:3:Documentation:Upgrading|Upgrading between 4.x versions]]

= Users =

* [[Freeside:3:Documentation:User|User's Guide]] (help wanted)
* [http://www.sisd.com/~ivan/freeside-slides Training presentation slides]

== Features in v3 and v4 that somehow got documented here ==

* [[Freeside:4:Documentation:Appointments]]

= Administrator =

== Reference ==

* [[Freeside:3:Documentation:Administration|Administrator's Guide]]
* [[:Category:Freeside:1.9:Documentation:Template|Templates]] used and their fill in variables.

== New features in v4 ==

* [[Freeside:4:Documentation:Administrator:Multi-currency|Multi-currency]]
* Emails triggered by system log events can be set up at Configuration -> Miscellaneous -> System log emails

== Features in v3 and v4 that somehow got documented here ==

* [[Freeside:4:Documentation:Administrator:Fees|Automated fees]]
* [[Freeside:4:Documentation:Cacti|Cacti Integration]]
* [[Freeside:4:Documentation:MagicMail|MagicMail Integration]]

= Developer =

== Reference ==

* [[Freeside:3:Documentation:Developer|Developer's Guide]]
* [[Freeside:3:Documentation:Billing_Internals|Billing Internals]] (walkthrough of the core invoice generation code)

== New features in v4 ==

* [[Freeside:4:Documentation:Developer:Authentication_Plugins|Authentication Plugins]]
* [[Freeside:4:Documentation:TaxEngine|Tax Engines]]

= Accounting Guide =

*[[Freeside:Documentation:Accounting|Accounting Guide]]

= Misc old stuff =

* [[Freeside:Documentation:FAQ|Frequently Asked Questions]]
* [[3rd_party_software|Third-party software]]
* [[Freeside:2.1:Documentation:Administration:VoIP:Timed_Rates|Feature: Timed Rates]]
* [[Freeside:2.1:Documentation:Administration:RT_Workflow|RT workflow features]]
* [[Freeside:2.1:Documentation:Administration:Tips_and_Tricks|Tips and Tricks]]

= Changelog =

* [[Freeside:4.0:Changelog|4.0 Changelog]]
* [[Freeside:4.1:Changelog|4.1 Changelog]]
* [[Freeside:4.2:Changelog|4.2 Changelog]]
* [[Freeside:4.3:Changelog|4.3 Changelog]]

Freeside:4:Documentation:Administration:Tax Districts

2019-05-07T19:45:00Z

Jlucas: /* Changing Tax Name */

Freeside:4:Documentation:Administration:Tax Districts

2019-05-07T19:44:24Z

Jlucas: /* Tax table updates */

== Overview ==
Freeside supports billing taxes by district, instead of city/county/state.

Currently this is only supported in the state of Washington. Public data
sources provided by the Washington Dept. of Revenue are used to automatically
maintain tax rate tables, and classify customer locations into the correct
tax district.

== Setup ==

=== Enable Washington state sales tax districts ===

# Navigate to: Configuration > Settings
# Set option '''tax_district_method''' to '''Washington sales tax'''
# Set option '''tax_district_taxname''', the tax name to dsplay on the invoice, or keep the default as '''Tax'''
# Run '''freeside-daily''' or '''freeside-tax-district-update -l''' to populate tax tables, and classify customers into their districts

=== Download tax tables and classify customer tax districts ===

The WA tax tables will be automatically populated, and customers in WA will
be classified into their tax district he next time '''freeside-daily''' runs.

You don't have to wait for '''freeside-daily'''. The following command
will update the tax tables and classify WA customers into their tax district.

sudo -u freeside /usr/bin/freeside-tax-district-update -l freeside_username

=== Changing Tax Name ===

You can change the display name for this tax by setting the config
option '''tax_district_taxname'''. After changing the configuration
value, the tax tables must be updated with the new taxname. This
will happen automatically on the 1st of each month. Use
'''wa_tax_rate_update''' to force this update sooner.

== Administration ==

=== Tax table updates ===

'''freeside-daily''' will refresh the tax tables automatically on the first
of each month.

Tax tables can be forcibly updated at any time using the
'''freeside-tax-district-update''' utility.

If freeside is configured to use tax classes, with the '''enable_taxclasses'''
configuration value, a complete copy of the Washington tax table will be
created in every taxclass. If new tax classes are added later, the
'''freeside-tax-district-update''' utility can be used to force an immediate rebuild
of the tax table into the new tax class.

To view the tax table, navigate to Configuration > Billing > Locales and Tax Rates

=== Customer tax district classification ===

When an address record is created or edited, Freeside will ask the WA Dept.
of Revenue API which tax district to use for the address.

If an invalid address is entereed, the tax district cannot be determined.
The user will be advised to correct the address, or to manually choose a
tax district to use.

Invoices cannot be generated for a WA customer missing a tax district.
When a customer is missing a tax district:
* A notice appears on the customer page with instructions to fix
* Billing will not complete for this customer
* Freeside will retry, daily, to determine the customer tax district
* System log notices are generated about this problem. Subscribe to E-Mail alerts of these notices.

The '''freeside-tax-district-update''' tool can be used to force reclassification
of every WA state address in cust_location. This may be useful if the state
re-draws district lines, and all customers need to be reclassified.

=== Configure system log alerts ===

If a customer location record in the database lacks a tax district,
freeside-daily will attempt to correct this situation. If that fails,
Freeside will report an error to the system log.

Freeside will report another error every time '''freeside-daily''' runs, for
every WA cust_location record without a tax district.

It is recommended to set two e-mail system log alerts:
1. log-level: error, log-context: wa_sales
2. log-level: error, log-context: tax_rate_update

Using log-level: info, somebody can be notified of all tax tables updates,
and every successful tax district classification for a cust_location record.

See [[Freeside:3:Documentation:Administration#System_Log]] for help
configuration system log alerts.

Freeside:4:Documentation:Administration:Tax Districts

2019-05-07T19:44:09Z

Jlucas: /* Tax table updates */

== Overview ==
Freeside supports billing taxes by district, instead of city/county/state.

Currently this is only supported in the state of Washington. Public data
sources provided by the Washington Dept. of Revenue are used to automatically
maintain tax rate tables, and classify customer locations into the correct
tax district.

== Setup ==

=== Enable Washington state sales tax districts ===

# Navigate to: Configuration > Settings
# Set option '''tax_district_method''' to '''Washington sales tax'''
# Set option '''tax_district_taxname''', the tax name to dsplay on the invoice, or keep the default as '''Tax'''
# Run '''freeside-daily''' or '''freeside-tax-district-update -l''' to populate tax tables, and classify customers into their districts

=== Download tax tables and classify customer tax districts ===

The WA tax tables will be automatically populated, and customers in WA will
be classified into their tax district he next time '''freeside-daily''' runs.

You don't have to wait for '''freeside-daily'''. The following command
will update the tax tables and classify WA customers into their tax district.

sudo -u freeside /usr/bin/freeside-tax-district-update -l freeside_username

=== Changing Tax Name ===

You can change the display name for this tax by setting the config
option '''tax_district_taxname'''. After changing the configuration
value, the tax tables must be updated with the new taxname. This
will happen automatically on the 1st of each month. Use
'''wa_tax_rate_update''' to force this update sooner.

== Administration ==

=== Tax table updates ===

'''freeside-daily''' will refresh the tax tables automatically on the first
of each month.

Tax tables can be forcibly updated at any time using the
'''wa_tax_rate_update''' utility.

If freeside is configured to use tax classes, with the '''enable_taxclasses'''
configuration value, a complete copy of the Washington tax table will be
created in every taxclass. If new tax classes are added later, the
'''freeside-tax-district-update''' utility can be used to force an immediate rebuild
of the tax table into the new tax class.

To view the tax table, navigate to Configuration > Billing > Locales and Tax Rates

=== Customer tax district classification ===

When an address record is created or edited, Freeside will ask the WA Dept.
of Revenue API which tax district to use for the address.

If an invalid address is entereed, the tax district cannot be determined.
The user will be advised to correct the address, or to manually choose a
tax district to use.

Invoices cannot be generated for a WA customer missing a tax district.
When a customer is missing a tax district:
* A notice appears on the customer page with instructions to fix
* Billing will not complete for this customer
* Freeside will retry, daily, to determine the customer tax district
* System log notices are generated about this problem. Subscribe to E-Mail alerts of these notices.

The '''freeside-tax-district-update''' tool can be used to force reclassification
of every WA state address in cust_location. This may be useful if the state
re-draws district lines, and all customers need to be reclassified.

=== Configure system log alerts ===

If a customer location record in the database lacks a tax district,
freeside-daily will attempt to correct this situation. If that fails,
Freeside will report an error to the system log.

Freeside will report another error every time '''freeside-daily''' runs, for
every WA cust_location record without a tax district.

It is recommended to set two e-mail system log alerts:
1. log-level: error, log-context: wa_sales
2. log-level: error, log-context: tax_rate_update

Using log-level: info, somebody can be notified of all tax tables updates,
and every successful tax district classification for a cust_location record.

See [[Freeside:3:Documentation:Administration#System_Log]] for help
configuration system log alerts.

Freeside:4:Documentation:Administration:Tax Districts

2019-05-07T19:43:22Z

Jlucas: /* Enable Washington state sales tax districts */

== Overview ==
Freeside supports billing taxes by district, instead of city/county/state.

Currently this is only supported in the state of Washington. Public data
sources provided by the Washington Dept. of Revenue are used to automatically
maintain tax rate tables, and classify customer locations into the correct
tax district.

== Setup ==

=== Enable Washington state sales tax districts ===

# Navigate to: Configuration > Settings
# Set option '''tax_district_method''' to '''Washington sales tax'''
# Set option '''tax_district_taxname''', the tax name to dsplay on the invoice, or keep the default as '''Tax'''
# Run '''freeside-daily''' or '''freeside-tax-district-update -l''' to populate tax tables, and classify customers into their districts

=== Download tax tables and classify customer tax districts ===

The WA tax tables will be automatically populated, and customers in WA will
be classified into their tax district he next time '''freeside-daily''' runs.

You don't have to wait for '''freeside-daily'''. The following command
will update the tax tables and classify WA customers into their tax district.

sudo -u freeside /usr/bin/freeside-tax-district-update -l freeside_username

=== Changing Tax Name ===

You can change the display name for this tax by setting the config
option '''tax_district_taxname'''. After changing the configuration
value, the tax tables must be updated with the new taxname. This
will happen automatically on the 1st of each month. Use
'''wa_tax_rate_update''' to force this update sooner.

== Administration ==

=== Tax table updates ===

'''freeside-daily''' will refresh the tax tables automatically on the first
of each month.

Tax tables can be forcibly updated at any time using the
'''wa_tax_rate_update''' utility.

If freeside is configured to use tax classes, with the '''enable_taxclasses'''
configuration value, a complete copy of the Washington tax table will be
created in every taxclass. If new tax classes are added later, the
'''wa_tax_rate_update''' utility can be used to force an immediate rebuild
of the tax table into the new tax class.

To view the tax table, navigate to Configuration > Billing > Locales and Tax Rates

=== Customer tax district classification ===

When an address record is created or edited, Freeside will ask the WA Dept.
of Revenue API which tax district to use for the address.

If an invalid address is entereed, the tax district cannot be determined.
The user will be advised to correct the address, or to manually choose a
tax district to use.

Invoices cannot be generated for a WA customer missing a tax district.
When a customer is missing a tax district:
* A notice appears on the customer page with instructions to fix
* Billing will not complete for this customer
* Freeside will retry, daily, to determine the customer tax district
* System log notices are generated about this problem. Subscribe to E-Mail alerts of these notices.

The '''freeside-tax-district-update''' tool can be used to force reclassification
of every WA state address in cust_location. This may be useful if the state
re-draws district lines, and all customers need to be reclassified.

=== Configure system log alerts ===

If a customer location record in the database lacks a tax district,
freeside-daily will attempt to correct this situation. If that fails,
Freeside will report an error to the system log.

Freeside will report another error every time '''freeside-daily''' runs, for
every WA cust_location record without a tax district.

It is recommended to set two e-mail system log alerts:
1. log-level: error, log-context: wa_sales
2. log-level: error, log-context: tax_rate_update

Using log-level: info, somebody can be notified of all tax tables updates,
and every successful tax district classification for a cust_location record.

See [[Freeside:3:Documentation:Administration#System_Log]] for help
configuration system log alerts.

Freeside:4:Documentation:Administration:Tax Districts

2019-05-07T19:43:10Z

Jlucas: /* Download tax tables and classify customer tax districts */

== Overview ==
Freeside supports billing taxes by district, instead of city/county/state.

Currently this is only supported in the state of Washington. Public data
sources provided by the Washington Dept. of Revenue are used to automatically
maintain tax rate tables, and classify customer locations into the correct
tax district.

== Setup ==

=== Enable Washington state sales tax districts ===

# Navigate to: Configuration > Settings
# Set option '''tax_district_method''' to '''Washington sales tax'''
# Set option '''tax_district_taxname''', the tax name to dsplay on the invoice, or keep the default as '''Tax'''
# Run '''freeside-daily''' or '''wa_tax_rate_update -l''' to populate tax tables, and classify customers into their districts

=== Download tax tables and classify customer tax districts ===

The WA tax tables will be automatically populated, and customers in WA will
be classified into their tax district he next time '''freeside-daily''' runs.

You don't have to wait for '''freeside-daily'''. The following command
will update the tax tables and classify WA customers into their tax district.

sudo -u freeside /usr/bin/freeside-tax-district-update -l freeside_username

=== Changing Tax Name ===

You can change the display name for this tax by setting the config
option '''tax_district_taxname'''. After changing the configuration
value, the tax tables must be updated with the new taxname. This
will happen automatically on the 1st of each month. Use
'''wa_tax_rate_update''' to force this update sooner.

== Administration ==

=== Tax table updates ===

'''freeside-daily''' will refresh the tax tables automatically on the first
of each month.

Tax tables can be forcibly updated at any time using the
'''wa_tax_rate_update''' utility.

If freeside is configured to use tax classes, with the '''enable_taxclasses'''
configuration value, a complete copy of the Washington tax table will be
created in every taxclass. If new tax classes are added later, the
'''wa_tax_rate_update''' utility can be used to force an immediate rebuild
of the tax table into the new tax class.

To view the tax table, navigate to Configuration > Billing > Locales and Tax Rates

=== Customer tax district classification ===

When an address record is created or edited, Freeside will ask the WA Dept.
of Revenue API which tax district to use for the address.

If an invalid address is entereed, the tax district cannot be determined.
The user will be advised to correct the address, or to manually choose a
tax district to use.

Invoices cannot be generated for a WA customer missing a tax district.
When a customer is missing a tax district:
* A notice appears on the customer page with instructions to fix
* Billing will not complete for this customer
* Freeside will retry, daily, to determine the customer tax district
* System log notices are generated about this problem. Subscribe to E-Mail alerts of these notices.

The '''freeside-tax-district-update''' tool can be used to force reclassification
of every WA state address in cust_location. This may be useful if the state
re-draws district lines, and all customers need to be reclassified.

=== Configure system log alerts ===

If a customer location record in the database lacks a tax district,
freeside-daily will attempt to correct this situation. If that fails,
Freeside will report an error to the system log.

Freeside will report another error every time '''freeside-daily''' runs, for
every WA cust_location record without a tax district.

It is recommended to set two e-mail system log alerts:
1. log-level: error, log-context: wa_sales
2. log-level: error, log-context: tax_rate_update

Using log-level: info, somebody can be notified of all tax tables updates,
and every successful tax district classification for a cust_location record.

See [[Freeside:3:Documentation:Administration#System_Log]] for help
configuration system log alerts.

Freeside:4:Documentation:Administration:Tax Districts

2019-05-07T19:36:40Z

Jlucas: /* Download tax tables and classify customer tax districts */

== Overview ==
Freeside supports billing taxes by district, instead of city/county/state.

Currently this is only supported in the state of Washington. Public data
sources provided by the Washington Dept. of Revenue are used to automatically
maintain tax rate tables, and classify customer locations into the correct
tax district.

== Setup ==

=== Enable Washington state sales tax districts ===

# Navigate to: Configuration > Settings
# Set option '''tax_district_method''' to '''Washington sales tax'''
# Set option '''tax_district_taxname''', the tax name to dsplay on the invoice, or keep the default as '''Tax'''
# Run '''freeside-daily''' or '''wa_tax_rate_update -l''' to populate tax tables, and classify customers into their districts

=== Download tax tables and classify customer tax districts ===

The WA tax tables will be automatically populated, and customers in WA will
be classified into their tax district he next time '''freeside-daily''' runs.

You don't have to wait for '''freeside-daily'''. The following command
will update the tax tables and classify WA customers into their tax district.

sudo -u freeside wa_tax_rate_update -l freeside_username

=== Changing Tax Name ===

You can change the display name for this tax by setting the config
option '''tax_district_taxname'''. After changing the configuration
value, the tax tables must be updated with the new taxname. This
will happen automatically on the 1st of each month. Use
'''wa_tax_rate_update''' to force this update sooner.

== Administration ==

=== Tax table updates ===

'''freeside-daily''' will refresh the tax tables automatically on the first
of each month.

Tax tables can be forcibly updated at any time using the
'''wa_tax_rate_update''' utility.

If freeside is configured to use tax classes, with the '''enable_taxclasses'''
configuration value, a complete copy of the Washington tax table will be
created in every taxclass. If new tax classes are added later, the
'''wa_tax_rate_update''' utility can be used to force an immediate rebuild
of the tax table into the new tax class.

To view the tax table, navigate to Configuration > Billing > Locales and Tax Rates

=== Customer tax district classification ===

When an address record is created or edited, Freeside will ask the WA Dept.
of Revenue API which tax district to use for the address.

If an invalid address is entereed, the tax district cannot be determined.
The user will be advised to correct the address, or to manually choose a
tax district to use.

Invoices cannot be generated for a WA customer missing a tax district.
When a customer is missing a tax district:
* A notice appears on the customer page with instructions to fix
* Billing will not complete for this customer
* Freeside will retry, daily, to determine the customer tax district
* System log notices are generated about this problem. Subscribe to E-Mail alerts of these notices.

The '''freeside-tax-district-update''' tool can be used to force reclassification
of every WA state address in cust_location. This may be useful if the state
re-draws district lines, and all customers need to be reclassified.

=== Configure system log alerts ===

If a customer location record in the database lacks a tax district,
freeside-daily will attempt to correct this situation. If that fails,
Freeside will report an error to the system log.

Freeside will report another error every time '''freeside-daily''' runs, for
every WA cust_location record without a tax district.

It is recommended to set two e-mail system log alerts:
1. log-level: error, log-context: wa_sales
2. log-level: error, log-context: tax_rate_update

Using log-level: info, somebody can be notified of all tax tables updates,
and every successful tax district classification for a cust_location record.

See [[Freeside:3:Documentation:Administration#System_Log]] for help
configuration system log alerts.