Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


KeyDefault ValueNotesInheritableSince Version
admin_view_dirdefaultThe view directory for the admin interface

Status
colourGreen
titleYes

4.9
apply_inv_late_fees7The number of days after an invoice has gone unpaid before adding a late fee.

Status
colourGreen
titleYes

4.10
auto_apply_creditstrueEnables available client credits to be applied to open invoices automatically
Status
colourGreen
titleYes

auto_paid_pending_servicestrueEnables available paid pending services to be provisioned automatically
Status
colourGreen
titleYes

autodebittrueEnables autodebiting of a client when payment is due
Status
colourGreen
titleYes

autodebit_attempts3The number of attempts and failures to process a payment account before that payment account is disabled from being automatically debited.
Status
colourGreen
titleYes

autodebit_days_before_due1The number of days before a payment is due when an attempt will be made to autodebit the account for said payment
Status
colourGreen
titleYes

autosuspendtrueEnables auto suspension of a client for non-payment
Status
colourGreen
titleYes

calendar_beginssundayThe first day of the week for the calendar
Status
colourGreen
titleYes

cancel_service_changes_days7The 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
Status
colourGreen
titleYes
3.5
cancelation_fee_taxfalseEnables cancelation fees to be taxable
Status
colourGreen
titleYes

cascade_taxfalseEnables tax on tax
Status
colourGreen
titleYes

client_change_service_packagefalseOffers clients the choice to change their service to a different package belonging to the same package group and module
Status
colourGreen
titleYes
3.3
client_change_service_termfalseOffers clients the choice to change the pricing term of their services
Status
colourGreen
titleYes
3.3
client_create_addonstrueOffers clients the ability to create addons for existing services
Status
colourGreen
titleYes
3.2
client_prorate_creditsfalseEnables prorated credits for services, or service configurable options, that are downgraded
Status
colourGreen
titleYes
3.5
client_set_currencyfalseOffers clients the choice to set their own default currency
Status
colourGreen
titleYes

client_set_invoicetrueOffers clients the choice to set their preferred invoice method
Status
colourGreen
titleYes

client_set_langtrueOffers clients the choice to set their preferred language
Status
colourGreen
titleYes

client_view_dirbootstrapThe view directory for the client interface
Status
colourGreen
titleYes

clients_cancel_servicesfalseOffers clients the choice to cancel their services
Status
colourGreen
titleYes

clients_format{num}The format of client IDs
Status
colourGreen
titleYes

clients_increment1
 

Status
colourGreen
titleYes

clients_pad_size0

Status
colourGreen
titleYes
 

clients_pad_str0

Status
colourGreen
titleYes
 

clients_start1500The first client ID number to begin with
Status
colourGreen
titleYes

countryUSThe 2-character country code
Status
colourGreen
titleYes

date_formatM d, YThe format for dates
Status
colourGreen
titleYes

datetime_formatM d, Y g:i:s AThe format for date and time
Status
colourGreen
titleYes

default_currencyUSDThe 3-character currency code to use as default
Status
colourGreen
titleYes

delivery_methods
 

The delivery methods enabled for this company
Status
colourGreen
titleYes

email_verificationfalseWhether 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.

Status
colourGreen
titleYes

4.12
enable_taxfalseEnables tax to be calculated in the system
Status
colourGreen
titleYes

exchange_rates_auto_updatefalseEnables currency exchange rates to automatically update periodically
Status
colourGreen
titleYes

exchange_rates_padding3The percentage value to pad exchange rate calculations with
Status
colourGreen
titleYes

exchange_rates_processor
 

The exchange rate processor to use to retrieve exchange rates
Status
colourGreen
titleYes

exchange_rates_processor_key
The exchange rate processor API key to use when retrieving exchange rates
Status
colourGreen
titleYes
4.2
html_emailtrueEnables email to be delivered in HTML
Status
colourGreen
titleYes

interfax_password
 

The password for the Interfax account
Status
colourGreen
titleYes

interfax_username
 

The username for the Interfax account
Status
colourGreen
titleYes

inv_background
 

The full path to the invoice background image
Status
colourGreen
titleYes

inv_days_before_renewal5The number of days before a service renews when a new invoice is to be generated
Status
colourGreen
titleYes

inv_display_companyinfotrueEnables company address info to be displayed on invoices
Status
colourGreen
titleYes

inv_display_due_date_drafttrueEnables due dates to be displayed on draft invoices
Status
colourGreen
titleYes
3.5
inv_display_due_date_proformatrueEnables due dates to be displayed on pro forma invoices
Status
colourGreen
titleYes
3.5
inv_display_due_date_invtrueEnables due dates to be displayed on standard invoices
Status
colourGreen
titleYes
3.5
inv_display_logotrueEnables company logo to be displayed on invoices
Status
colourGreen
titleYes

inv_display_paid_watermarktrueEnables a paid watermark to be display on invoices
Status
colourGreen
titleYes

inv_display_paymentstrueEnables payments and credits to be displayed in a new table on invoices
Status
colourGreen
titleYes
3.4
inv_draft_formatDRAFT-{num}The format of draft invoice IDs
Status
colourGreen
titleYes

inv_format{num}The format of invoice IDs
Status
colourGreen
titleYes

inv_group_servicestrueCreates a single invoice for services that renew on the same day for a client, or (if false) a separate invoice for each service.
Status
colourGreen
titleYes
3.6
inv_increment1The increment step for the number set for invoice IDs
Status
colourGreen
titleYes

inv_logo
 

The full path to the invoice logo image
Status
colourGreen
titleYes

inv_methodemailThe primary method to use to deliver invoices
Status
colourGreen
titleYes

inv_mimetypeapplication/pdfThe Mime-Type of the file that the invoice is created for
Status
colourGreen
titleYes

inv_pad_size0The padding character-length to use for invoice ID numbers
Status
colourGreen
titleYes

inv_pad_str0The string to pad the auto-incrementing invoice ID numbers with
Status
colourGreen
titleYes

inv_paper_sizeletterThe paper size of the invoice
Status
colourGreen
titleYes

inv_proforma_start1The first proforma invoice ID number to begin with
Status
colourGreen
titleYes
3.3
inv_proforma_formatPROFORMA-{num}The format of proforma invoice IDs
Status
colourGreen
titleYes
3.3
inv_start1The first invoice ID number to begin with
Status
colourGreen
titleYes

inv_suspended_servicestrueEnables suspendend services to continue to be invoiced
Status
colourGreen
titleYes

inv_templatedefault_invoiceThe template to use for generating invoices
Status
colourGreen
titleYes
3.3
inv_terms
 
_*


Info
titleinv_terms has changed

In v4.5.0, the inv_terms key no longer exists. It is replaced by inv_terms_ followed by the language code, e.g. inv_terms_en_us

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.

Status
colourGreen
titleYes

inv_typestandardThe invoice type (standard or proforma)
Status
colourGreen
titleYes
3.3
languageen_usThe default language
Status
colourGreen
titleYes

late_fee_total_amount

trueWhether or not if the late fee is applied to the total amount of the invoice or only to the unpaid balance.

Status
colourGreen
titleYes

4.10

late_fees


The late fees enabled for this company.

Status
colourGreen
titleYes

4.10
mail_deliveryphpThe method with which to send email
Status
colourGreen
titleYes

multi_currency_pricingpackageThe pricing scheme to use when evaluating multi-currency prices
Status
colourGreen
titleYes

notice_pending_autodebit1The number of days before an invoice is scheduled to be autodebited that the Auto-Debit Pending notice should be sent.
Status
colourGreen
titleYes

notice1-1The number of days after an invoice has gone unpaid before sending the first late notice
Status
colourGreen
titleYes

notice23The number of days after an invoice has gone unpaid before sending the second late notice
Status
colourGreen
titleYes

notice37

The number of days after an invoice has gone unpaid before sending the third late notice

Status
colourGreen
titleYes

packages_format
{num}
The package number format.
Status
colourGreen
titleYes

packages_increment1The package id increment value
Status
colourGreen
titleYes

packages_pad_size0The packages padding size
Status
colourGreen
titleYes

packages_pad_str0The packages padding character
Status
colourGreen
titleYes

packages_start1The package start id
Status
colourGreen
titleYes

payments_allowed_achtrueEnables ACH payments to be processed through gateways and be added to payment accounts
Status
colourGreen
titleYes

payments_allowed_cctrueEnables credit card payments to be processed through gateways and be added to payment accounts
Status
colourGreen
titleYes

postalmethods_apikey
 

The API Key required to make requests with PostalMethods
Status
colourGreen
titleYes

postalmethods_replyenvelopefalseWhether or not to include a reply envelope with the mailed letter
Status
colourGreen
titleYes

postalmethods_testmodetrueEnables test mode for the PostalMethods account
Status
colourGreen
titleYes

prevent_unverified_paymentsfalseWhether to allow payments from clients with an unverified email address

Status
colourGreen
titleYes

4.12
private_key
 

The private key used for decryption
Status
colourGreen
titleYes

private_key_passphrase
 

The private key passphrase to set in order to decrypt
Status
colourGreen
titleYes

process_paid_service_changesfalseWhether or not service changes (e.g. upgrades) should be queued and processed only after the associated invoice has been paid
Status
colourGreen
titleYes
3.5
public_key
 

The public key used for encryption
Status
colourGreen
titleYes

receive_email_marketingfalseWhether or not clients may receive marketing emails

Status
colourGreen
titleYes

4.3
required_contact_fields
The optional contact fields that are required for creating/updating contacts
Status
colourGreen
titleYes
4.1
send_payment_noticestrueWhether or not clients can be sent any of the Payment Due Notices
Status
colourGreen
titleYes
3.4
services_format{num}The format of service IDs
Status
colourGreen
titleYes

services_increment1The increment step for the number set for service IDs
Status
colourGreen
titleYes

services_pad_size0The padding character-length to use for service ID numbers
Status
colourGreen
titleYes

services_pad_str0The string to pad the auto-incrementing service ID numbers with
Status
colourGreen
titleYes

services_start1The first service ID number to begin with
Status
colourGreen
titleYes

setup_fee_taxfalseEnables setup fees to be taxable
Status
colourGreen
titleYes

show_client_tax_idtrueWhether or not the Tax ID field is shown in the client interface
Status
colourGreen
titleYes
3.4
show_currency_codefalseEnables currency codes to be shown next to currency values

Status
colourGreen
titleYes


show_receive_email_marketingtrueWhether or not the 'receive_email_marketing' setting is shown in the client interface

Status
colourGreen
titleYes

4.3
smtp_host
 

The SMTP hostname to a mail server
Status
colourGreen
titleYes

smtp_password
 

The SMTP password to a mail server
Status
colourGreen
titleYes

smtp_port465The SMTP port to connect to a mail server on
Status
colourGreen
titleYes

smtp_securitysslThe SMTP protocol to use.
Status
colourGreen
titleYes

smtp_user
 

The SMTP username to a mail server
Status
colourGreen
titleYes

suspend_services_days_after_due7The number of days after a service is overdue and unpaid when it will be suspended.
Status
colourGreen
titleYes

synchronize_addonstrueWhether 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.

Status
colourGreen
titleYes

4.3
tax_exemptfalseEnables a client to be tax-exempt
Status
colourGreen
titleYes

tax_id
 

The Tax ID/VATIN number
Status
colourRed
titleNo

theme_admin1The ID of the theme to use for the admin interface
Status
colourGreen
titleYes

theme_client12The ID of the theme to use for the client interface
Status
colourGreen
titleYes

timezoneAmerica/Los_AngelesThe timezone to use for the system
Status
colourGreen
titleYes

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.

Status
colourGreen
titleYes

4.6
void_invoice_canceled_servicetrueWhether to void invoices for a service when it is cancelled
Status
colourGreen
titleYes
4.0

void_inv_canceled_service_days

anySelect the number of days after the invoice is due that it can be automatically voided.

Status
colourGreen
titleYes

4.6