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

Compare with Current View Page History

« Previous Version 32 Next »

KeyDefault ValueNotesInheritableSince Version
auto_apply_creditstrueEnables available client credits to be applied to open invoices automaticallyYES 
auto_paid_pending_servicestrueEnables available paid pending services to be provisioned automaticallyYES 
autodebittrueEnables autodebiting of a client when payment is dueYES 
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 paymentYES 
autosuspendtrueEnables auto suspension of a client for non-paymentYES 
calendar_beginssundayThe first day of the week for the calendarYES 
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 voidedYES3.5
cancelation_fee_taxfalseEnables cancelation fees to be taxableYES 
cascade_taxfalseEnables tax on taxYES 
client_change_service_packagefalseOffers clients the choice to change their service to a different package belonging to the same package group and moduleYES3.3
client_change_service_termfalseOffers clients the choice to change the pricing term of their servicesYES3.3
client_create_addonstrueOffers clients the ability to create addons for existing servicesYES3.2
client_prorate_creditsfalseEnables prorated credits for services, or service configurable options, that are downgradedYES3.5
client_set_currencyfalseOffers clients the choice to set their own default currencyYES 
client_set_invoicetrueOffers clients the choice to set their preferred invoice methodYES 
client_set_langtrueOffers clients the choice to set their preferred languageYES 
client_view_dirbootstrapThe view directory for the client interfaceYES 
clients_cancel_servicesfalseOffers clients the choice to cancel their servicesYES 
clients_format{num}The format of client IDsYES 
clients_increment1 YES 
clients_pad_size0 YES 
clients_pad_str0 YES 
clients_start1500The first client ID number to begin withYES 
countryUSThe 2-character country codeYES 
date_formatM d, YThe format for datesYES 
datetime_formatM d, Y g:i:s AThe format for date and timeYES 
default_currencyUSDThe 3-character currency code to use as defaultYES 
delivery_methods The delivery methods enabled for this companyYES 
enable_taxfalseEnables tax to be calculated in the systemYES 
exchange_rates_auto_updatefalseEnables currency exchange rates to automatically update periodicallyYES 
exchange_rates_padding3The percentage value to pad exchange rate calculations withYES 
exchange_rates_processor The exchange rate processor to use to retrieve exchange ratesYES 
exchange_rates_processor_key The exchange rate processor API key to use when retrieving exchange ratesYES4.2
html_emailtrueEnables email to be delivered in HTMLYES 
interfax_password The password for the Interfax accountYES 
interfax_username The username for the Interfax accountYES 
inv_background The full path to the invoice background imageYES 
inv_days_before_renewal5The number of days before a service renews when a new invoice is to be generatedYES 
inv_display_companyinfotrueEnables company address info to be displayed on invoicesYES 
inv_display_due_date_drafttrueEnables due dates to be displayed on draft invoicesYES3.5
inv_display_due_date_proformatrueEnables due dates to be displayed on pro forma invoicesYES3.5
inv_display_due_date_invtrueEnables due dates to be displayed on standard invoicesYES3.5
inv_display_logotrueEnables company logo to be displayed on invoicesYES 
inv_display_paid_watermarktrueEnables a paid watermark to be display on invoicesYES 
inv_display_paymentstrueEnables payments and credits to be displayed in a new table on invoicesYES3.4
inv_draft_formatDRAFT-{num}The format of draft invoice IDsYES 
inv_format{num}The format of invoice IDsYES 
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.YES3.6
inv_increment1The increment step for the number set for invoice IDsYES 
inv_logo The full path to the invoice logo imageYES 
inv_methodemailThe primary method to use to deliver invoicesYES 
inv_mimetypeapplication/pdfThe Mime-Type of the file that the invoice is created forYES 
inv_pad_size0The padding character-length to use for invoice ID numbersYES 
inv_pad_str0The string to pad the auto-incrementing invoice ID numbers withYES 
inv_paper_sizeletterThe paper size of the invoiceYES 
inv_proforma_start1The first proforma invoice ID number to begin withYES3.3
inv_proforma_formatPROFORMA-{num}The format of proforma invoice IDsYES3.3
inv_start1The first invoice ID number to begin withYES 
inv_suspended_servicestrueEnables suspendend services to continue to be invoicedYES 
inv_templatedefault_invoiceThe template to use for generating invoicesYES3.3
inv_terms The Terms to display on the invoiceYES 
inv_typestandardThe invoice type (standard or proforma)YES3.3
languageen_usThe default languageYES 
mail_deliveryphpThe method with which to send emailYES 
multi_currency_pricingpackageThe pricing scheme to use when evaluating multi-currency pricesYES 
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 noticeYES 
notice23The number of days after an invoice has gone unpaid before sending the second late noticeYES 
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 valueYES 
packages_pad_size0The packages padding sizeYES 
packages_pad_str0The packages padding characterYES 
packages_start1The package start idYES 
payments_allowed_achtrueEnables ACH payments to be processed through gateways and be added to payment accountsYES 
payments_allowed_cctrueEnables credit card payments to be processed through gateways and be added to payment accountsYES 
postalmethods_apikey The API Key required to make requests with PostalMethodsYES 
postalmethods_replyenvelopefalseWhether or not to include a reply envelope with the mailed letterYES 
postalmethods_testmodetrueEnables test mode for the PostalMethods accountYES 
private_key The private key used for decryptionYES 
private_key_passphrase The private key passphrase to set in order to decryptYES 
process_paid_service_changesfalseWhether or not service changes (e.g. upgrades) should be queued and processed only after the associated invoice has been paidYES3.5
public_key The public key used for encryptionYES 
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 contactsYES4.1
send_payment_noticestrueWhether or not clients can be sent any of the Payment Due NoticesYES3.4
services_format{num}The format of service IDsYES 
services_increment1The increment step for the number set for service IDsYES 
services_pad_size0The padding character-length to use for service ID numbersYES 
services_pad_str0The string to pad the auto-incrementing service ID numbers withYES 
services_start1The first service ID number to begin withYES 
setup_fee_taxfalseEnables setup fees to be taxableYES 
show_client_tax_idtrueWhether or not the Tax ID field is shown in the client interfaceYES3.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 serverYES 
smtp_password The SMTP password to a mail serverYES 
smtp_port465The SMTP port to connect to a mail server onYES 
smtp_securitysslThe SMTP protocol to use.YES 
smtp_user The SMTP username to a mail serverYES 
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-exemptYES 
tax_id The Tax ID/VATIN numberNO 
theme_admin1The ID of the theme to use for the admin interfaceYES 
theme_client12The ID of the theme to use for the client interfaceYES 
timezoneAmerica/Los_AngelesThe timezone to use for the systemYES 
void_invoice_canceled_servicetrueWhether to void invoices for a service when it is cancelledYES4.0
  • No labels