You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 34 Next »

KeyDefault ValueNotesInheritableSince Version
auto_apply_creditstrueEnables available client credits to be applied to open invoices automatically
YES
 
auto_paid_pending_servicestrueEnables available paid pending services to be provisioned automatically
YES
 
autodebittrueEnables autodebiting of a client when payment is due
YES
 
autodebit_attempts3The number of attempts and failures to process a payment account before that payment account is disabled from being automatically debited.
YES
 
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
YES
 
autosuspendtrueEnables auto suspension of a client for non-payment
YES
 
calendar_beginssundayThe first day of the week for the calendar
YES
 
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
YES
3.5
cancelation_fee_taxfalseEnables cancelation fees to be taxable
YES
 
cascade_taxfalseEnables tax on tax
YES
 
client_change_service_packagefalseOffers clients the choice to change their service to a different package belonging to the same package group and module
YES
3.3
client_change_service_termfalseOffers clients the choice to change the pricing term of their services
YES
3.3
client_create_addonstrueOffers clients the ability to create addons for existing services
YES
3.2
client_prorate_creditsfalseEnables prorated credits for services, or service configurable options, that are downgraded
YES
3.5
client_set_currencyfalseOffers clients the choice to set their own default currency
YES
 
client_set_invoicetrueOffers clients the choice to set their preferred invoice method
YES
 
client_set_langtrueOffers clients the choice to set their preferred language
YES
 
client_view_dirbootstrapThe view directory for the client interface
YES
 
clients_cancel_servicesfalseOffers clients the choice to cancel their services
YES
 
clients_format{num}The format of client IDs
YES
 
clients_increment1 
YES
 
clients_pad_size0 
YES
 
clients_pad_str0 
YES
 
clients_start1500The first client ID number to begin with
YES
 
countryUSThe 2-character country code
YES
 
date_formatM d, YThe format for dates
YES
 
datetime_formatM d, Y g:i:s AThe format for date and time
YES
 
default_currencyUSDThe 3-character currency code to use as default
YES
 
delivery_methods The delivery methods enabled for this company
YES
 
enable_taxfalseEnables tax to be calculated in the system
YES
 
exchange_rates_auto_updatefalseEnables currency exchange rates to automatically update periodically
YES
 
exchange_rates_padding3The percentage value to pad exchange rate calculations with
YES
 
exchange_rates_processor The exchange rate processor to use to retrieve exchange rates
YES
 
exchange_rates_processor_key The exchange rate processor API key to use when retrieving exchange rates
YES
4.2
html_emailtrueEnables email to be delivered in HTML
YES
 
interfax_password The password for the Interfax account
YES
 
interfax_username The username for the Interfax account
YES
 
inv_background The full path to the invoice background image
YES
 
inv_days_before_renewal5The number of days before a service renews when a new invoice is to be generated
YES
 
inv_display_companyinfotrueEnables company address info to be displayed on invoices
YES
 
inv_display_due_date_drafttrueEnables due dates to be displayed on draft invoices
YES
3.5
inv_display_due_date_proformatrueEnables due dates to be displayed on pro forma invoices
YES
3.5
inv_display_due_date_invtrueEnables due dates to be displayed on standard invoices
YES
3.5
inv_display_logotrueEnables company logo to be displayed on invoices
YES
 
inv_display_paid_watermarktrueEnables a paid watermark to be display on invoices
YES
 
inv_display_paymentstrueEnables payments and credits to be displayed in a new table on invoices
YES
3.4
inv_draft_formatDRAFT-{num}The format of draft invoice IDs
YES
 
inv_format{num}The format of invoice IDs
YES
 
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.
YES
3.6
inv_increment1The increment step for the number set for invoice IDs
YES
 
inv_logo The full path to the invoice logo image
YES
 
inv_methodemailThe primary method to use to deliver invoices
YES
 
inv_mimetypeapplication/pdfThe Mime-Type of the file that the invoice is created for
YES
 
inv_pad_size0The padding character-length to use for invoice ID numbers
YES
 
inv_pad_str0The string to pad the auto-incrementing invoice ID numbers with
YES
 
inv_paper_sizeletterThe paper size of the invoice
YES
 
inv_proforma_start1The first proforma invoice ID number to begin with
YES
3.3
inv_proforma_formatPROFORMA-{num}The format of proforma invoice IDs
YES
3.3
inv_start1The first invoice ID number to begin with
YES
 
inv_suspended_servicestrueEnables suspendend services to continue to be invoiced
YES
 
inv_templatedefault_invoiceThe template to use for generating invoices
YES
3.3
inv_terms_* 

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

YES
 
inv_typestandardThe invoice type (standard or proforma)
YES
3.3
languageen_usThe default language
YES
 
mail_deliveryphpThe method with which to send email
YES
 
multi_currency_pricingpackageThe pricing scheme to use when evaluating multi-currency prices
YES
 
notice_pending_autodebit1The number of days before an invoice is scheduled to be autodebited that the Auto-Debit Pending notice should be sent.
YES
 
notice1-1The number of days after an invoice has gone unpaid before sending the first late notice
YES
 
notice23The number of days after an invoice has gone unpaid before sending the second late notice
YES
 
notice37

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

YES
 
packages_format
{num}
The package number format.
YES
 
packages_increment1The package id increment value
YES
 
packages_pad_size0The packages padding size
YES
 
packages_pad_str0The packages padding character
YES
 
packages_start1The package start id
YES
 
payments_allowed_achtrueEnables ACH payments to be processed through gateways and be added to payment accounts
YES
 
payments_allowed_cctrueEnables credit card payments to be processed through gateways and be added to payment accounts
YES
 
postalmethods_apikey The API Key required to make requests with PostalMethods
YES
 
postalmethods_replyenvelopefalseWhether or not to include a reply envelope with the mailed letter
YES
 
postalmethods_testmodetrueEnables test mode for the PostalMethods account
YES
 
private_key The private key used for decryption
YES
 
private_key_passphrase The private key passphrase to set in order to decrypt
YES
 
process_paid_service_changesfalseWhether or not service changes (e.g. upgrades) should be queued and processed only after the associated invoice has been paid
YES
3.5
public_key The public key used for encryption
YES
 
receive_email_marketingfalseWhether or not clients may receive marketing emails

YES

4.3
required_contact_fields The optional contact fields that are required for creating/updating contacts
YES
4.1
send_payment_noticestrueWhether or not clients can be sent any of the Payment Due Notices
YES
3.4
services_format{num}The format of service IDs
YES
 
services_increment1The increment step for the number set for service IDs
YES
 
services_pad_size0The padding character-length to use for service ID numbers
YES
 
services_pad_str0The string to pad the auto-incrementing service ID numbers with
YES
 
services_start1The first service ID number to begin with
YES
 
setup_fee_taxfalseEnables setup fees to be taxable
YES
 
show_client_tax_idtrueWhether or not the Tax ID field is shown in the client interface
YES
3.4
show_currency_codefalseEnables currency codes to be shown next to currency values

YES

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

YES

4.3
smtp_host The SMTP hostname to a mail server
YES
 
smtp_password The SMTP password to a mail server
YES
 
smtp_port465The SMTP port to connect to a mail server on
YES
 
smtp_securitysslThe SMTP protocol to use.
YES
 
smtp_user The SMTP username to a mail server
YES
 
suspend_services_days_after_due7The number of days after a service is overdue and unpaid when it will be suspended.
YES
 
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.

YES

4.3
tax_exemptfalseEnables a client to be tax-exempt
YES
 
tax_id The Tax ID/VATIN number
NO
 
theme_admin1The ID of the theme to use for the admin interface
YES
 
theme_client12The ID of the theme to use for the client interface
YES
 
timezoneAmerica/Los_AngelesThe timezone to use for the system
YES
 
void_invoice_canceled_servicetrueWhether to void invoices for a service when it is cancelled
YES
4.0
  • No labels