Key | Default Value | Notes | Inheritable | Since Version | ||||||
admin_view_dir | default | The view directory for the admin interface |
| 4.9 | ||||||
apply_inv_late_fees | 7 | The number of days after an invoice has gone unpaid before adding a late fee. |
| 4.10 | ||||||
auto_apply_credits | true | Enables |
available client credits to be applied to open invoices automatically |
| |||||||||
auto_paid_pending_services | true | Enables available paid pending services to be provisioned automatically |
| |||||||
autodebit | true |
Enables autodebiting of a client when payment is due |
| ||||||||
autodebit_attempts | 3 | The number of attempts and failures to process a payment account before that payment account is disabled from being automatically debited. |
|
autodebit_days_before_due | 1 |
The number of days before a payment is due when an attempt will be made to autodebit the account for said payment |
|
autosuspend | true |
Enables auto suspension of a client for non-payment |
| |||||||
calendar_begins | sunday |
The first day of the week for the calendar |
| |||||||||
cancel_service_changes_days | 7 | The number of days after a queued service change (e.g. upgrade) has been unpaid at which time it will be canceled and the associated invoice voided |
| 3.5 |
cancelation_fee_tax | false |
Enables cancelation fees to be taxable |
|
cascade_tax | false | Enables tax on tax |
| |||||||
client_change_service_package | false | Offers clients the choice to change their service to a different package belonging to the same package group and module |
| 3.3 | ||||||
client_change_service_term | false |
Offers clients the choice to change the pricing term of their services |
| 3.3 | ||||||||
client_create_addons | true | Offers clients the ability to create addons for existing services |
| 3.2 | ||||||
client_prorate_credits | false | Enables prorated credits for services, or service configurable options, that are downgraded |
| 3.5 |
client_set_currency | false |
Offers clients the choice to set their own default currency |
| |||||||
client_set_invoice |
true | Offers clients the choice to set their preferred invoice method |
|
client_set_lang |
true | Offers clients the choice to set their preferred language |
| ||||||||
client_view_dir | bootstrap | The view directory for the client interface |
|
clients_cancel_services | false |
Offers clients the choice to cancel their services |
|
clients_format |
{num} |
The format of client IDs |
| ||||||||
clients_increment | 1 |
|
clients_pad_size | 0 |
|
clients_pad_str | 0 |
|
clients_start | 1500 |
The first client ID number to begin with |
|
country | US |
The 2-character country code |
| |||||||
date_format | M d, Y |
The format for dates |
| |||||||
datetime_format | M d, Y g:i:s A |
The format for date and time |
|
default_currency | USD |
The 3-character currency code to use as default |
| |||||||
delivery_methods |
The delivery methods enabled for this company |
| |||||||||
email_verification | false | Whether to send an email verification email when a new login is created or a client changes their email address. A notice will appear on the clients profile until they are verified. |
| 4.12 | ||||||
enable_tax | false |
Enables tax to be calculated in the system |
| |||||||
exchange_rates_auto_update | false | Enables currency exchange rates to automatically update |
periodically |
|
exchange_rates_padding | 3 |
The percentage value to pad exchange rate calculations with |
| |||||||||
exchange_rates_processor | The exchange rate processor to use to retrieve exchange rates |
| ||||||||
exchange_rates_processor |
_key | The exchange rate processor API key to use when retrieving exchange rates |
| 4.2 |
html_email | true | Enables email |
to be delivered in HTML |
|
interfax_password |
The password for the Interfax account |
|
interfax_username |
The username for the Interfax account |
|
inv_background |
The full path to the invoice background image |
| ||||||||
inv_days_before_renewal | 5 |
The number of days before a service renews when a new invoice is to be generated |
|
inv_display_companyinfo | true | Enables company address info to be displayed on invoices |
| |||||||
inv_display_due_date_draft | true | Enables due dates to be displayed on draft invoices |
| 3.5 | ||||||
inv_display_due_date_proforma | true | Enables due dates to be displayed on pro forma invoices |
| 3.5 | ||||||
inv_display_due_date_inv | true | Enables due dates to be displayed on standard invoices |
| 3.5 | ||||||
inv_display_logo | true | Enables company logo to be displayed on invoices |
| |||||||
inv_display_paid_watermark | true | Enables a paid watermark to be display on invoices |
| |||||||
inv_display_payments | true | Enables payments and credits to be displayed in a new table on invoices |
| 3.4 | ||||||
inv_draft_format | DRAFT-{num} |
The format of draft invoice IDs |
| ||||||||
inv_format |
{num} |
The format of invoice IDs |
| |||||||||
inv_group_services | true | Creates a single invoice for services that renew on the same day for a client, or (if false) a separate invoice for each service. |
| 3.6 | ||||||
inv_increment | 1 |
The increment step for the number set for invoice IDs |
|
inv_logo |
The full path to the invoice logo image |
| ||||||||
inv_method |
The primary method to use to deliver invoices |
| |||||||||
inv_mimetype | application/pdf | The Mime-Type of the file that the invoice is created for |
| |||||||
inv_pad_size | 0 |
The padding character-length to use for invoice ID numbers |
|
inv_pad_str | 0 |
The string to pad the auto-incrementing invoice ID numbers with |
|
inv_paper_size | letter | The paper size of the invoice |
| |||||||
inv_proforma_start | 1 | The first proforma invoice ID number to begin with |
| 3.3 | ||||||
inv_proforma_format | PROFORMA-{num} | The format of proforma invoice IDs |
| 3.3 | ||||||
inv_start | 1 |
The first invoice ID number to begin with |
|
inv_suspended_services | true |
Enables suspendend services to continue to be invoiced |
|
inv_template | default_invoice | The template to use for generating invoices |
| 3.3 | ||||||
inv_terms_* |
|
The Terms to display on the invoice. The inv_terms key has been replaced by additional keys including the language code, e.g. inv_terms_en_us or inv_terms_de_de for English and German languages, respectively, based on the available installed languages. |
| ||||||||||
inv_type | standard | The invoice type (standard or proforma) |
| 3.3 | |||||||
language | en_us |
The default language |
| |||||||||
late_fee_total_amount | true | Whether or not if the late fee is applied to the total amount of the invoice or only to the unpaid balance. |
| 4.10 | ||||||
late_fees | The late fees enabled for this company. |
| 4.10 | |||||||
mail_delivery | php |
The method with which to send email |
|
multi_currency_pricing | package |
The pricing scheme to use when evaluating multi-currency prices |
| |||||||
notice_pending_autodebit |
1 | The number of days before an invoice is scheduled to be autodebited that the Auto-Debit Pending notice should be sent. |
| ||||||||
notice1 | -1 | The number of days after an invoice has gone unpaid before sending the first late notice |
| |||||||
notice2 | 3 | The number of days after an invoice has gone unpaid before sending the second late notice |
| |||||||
notice3 | 7 | The number of days after an invoice has gone unpaid before sending the third late notice |
| |||||||
packages_format | {num} | The package number format. |
| |||||||
packages_increment | 1 | The package id increment value |
| |||||||
packages_pad_size | 0 | The packages padding size |
| |||||||
packages_pad_str | 0 | The packages padding character |
| |||||||
packages_start | 1 | The package start id |
| |||||||
payments_allowed_ach | true | Enables ACH payments to be processed through gateways and be added to payment accounts |
| |||||||
payments_allowed_cc | true | Enables credit card payments to be processed through gateways and be added to payment accounts |
| |||||||
postalmethods_apikey |
The API Key required to make requests with PostalMethods |
| |||||||||
postalmethods_replyenvelope | false | Whether or not to include a reply envelope with the mailed letter |
| |||||||
postalmethods_testmode |
true | Enables test mode for the PostalMethods account |
| ||||||||
prevent_unverified_payments | false | Whether to allow payments from clients with an unverified email address |
| 4.12 | ||||||
private_key |
The private key used for decryption |
| ||||||||
private_key_passphrase |
The private key passphrase to set in order to decrypt |
| |||||||||
process_paid_service_changes | false | Whether or not service changes (e.g. upgrades) should be queued and processed only after the associated invoice has been paid |
| 3.5 | ||||||
public_key |
The public key used for encryption |
| |||||||||
receive_email_marketing | false | Whether or not clients may receive marketing emails |
| 4.3 | ||||||
required_contact_fields | The optional contact fields that are required for creating/updating contacts |
| 4.1 | |||||||
send_payment_notices | true | Whether or not clients can be sent any of the Payment Due Notices |
| 3.4 | ||||||
services_format |
{num} |
The format of service IDs |
|
services_increment | 1 |
The increment step for the number set for service IDs |
|
services_pad_size | 0 |
The padding character-length to use for service ID numbers |
| |||||||
services_pad_str | 0 |
The string to pad the auto-incrementing service ID numbers with |
|
services_start | 1 |
The first service ID number to begin with |
| |||||||
setup_fee_tax | false |
Enables setup fees to be taxable |
| |||||||||
show_client_tax_id | true | Whether or not the Tax ID field is shown in the client interface |
| 3.4 |
show_currency_code | false |
Enables currency codes to be shown next to currency values |
| |||||||||
show_receive_email_marketing | true | Whether or not the 'receive_email_marketing' setting is shown in the client interface |
| 4.3 |
smtp_host |
The SMTP hostname to a mail server |
|
smtp_password | The SMTP password |
to a mail server |
|
smtp_port | 465 | The SMTP port |
to connect to a mail server on |
|
smtp_security |
ssl | The SMTP protocol to use. |
| ||||||||
smtp_user | The SMTP username to a mail server |
| ||||||||
suspend_services_days_after_due | 7 | The number of days after a service is overdue and unpaid when it will be suspended. |
| |||||||
synchronize_addons | true | Whether or not addon/child services should be set to the same renew date as their parent when they are created. |
In such cases, the price of the addon would be prorated based on the new renew date. |
| 4.3 |
tax_exempt | false |
Enables a client to be tax-exempt |
|
tax_id |
The Tax ID/VATIN number |
| |||||||||
theme_admin | 1 | The ID of the theme to use for the admin interface |
| |||||||
theme_client | 12 | The ID of the theme to use for the client interface |
| |||||||
timezone | America/Los_Angeles | The timezone to use for the system |
| |||||||
unique_contact_emails | Sets a restriction on whether email addresses of contacts must be unique. Values may be primary or all. A value of all will require all contacts have unique email addresses, while a value of primary will require that only primary contacts (i.e. clients) have unique email addresses. No email restriction is imposed otherwise. |
| 4.6 | |||||||
void_invoice_canceled_service | true | Whether to void invoices for a service when it is cancelled |
| 4.0 | ||||||
void_inv_canceled_service_days | any | Select the number of days after the invoice is due that it can be automatically voided. |
| 4.6 |