getConfParameters

Get account configuration — all the settings from the module Settings > Configuration and also a number of hidden settings that can be enabled by Erply technical support.

This API call returns exactly one result record. This record contains a variable number of attributes and it is not guaranteed that any one of these attributes will be present. The contents of this record should be saved into a dictionary or an associative array, and a default value (0, unless specified otherwise) assumed for all missing ones.

Some of the parameters are supposed to have a decimal/integer value, or a value of 1 or 0 (true/false, enabled/disabled). However API returns almost all fields as strings. If your programming environment requires that, please cast the parameters to the correct type. In the table below, the types are marked with an asterisk.

Most — but not all! — settings can be edited using saveConfParameter. Do NOT edit any undocumented settings or those marked as "Not Editable".

Response

Field name Type Description

General Settings

 
   
country  String (2)  Do not edit. Country where this business resides. An uppercase two-letter country code, see http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.  
default_language  String (3)  Default language of this account. Possible values:
  • eng - English
  • est - Estonian
  • fin - Finnish
  • ger - German
  • gre - Greek
  • lat - Latvian
  • lit - Lithuanian
  • rus - Russian
  • spa - Spanish
  • swe - Swedish
 
timezone  String  Account timezone. Names according to the tz database are used, eg. "America/New_York" or "Europe/Paris". See http://en.wikipedia.org/wiki/Tz_database and http://en.wikipedia.org/wiki/List_of_tz_database_time_zones.  
dateformat  String (15)  Date format to be used. Format descriptor consists of letters Y, m, d and interpunctuation.
  • Y - 4-digit year
  • m - month, with leading zeroes (00 to 12)
  • d - day of month, with leading zeroes (00 to 31)
. Examples: "m/d/Y" - default US date format. "d/m/Y", "d.m.Y" - typical European formats etc.  
numberformat  String (2)  Number format to be used. This format descriptor consists of two letters. The first one is decimal separator and the second one is thousands separator. 3-digit grouping is assumed!

Examples: ".," - default US format (190,000.35), ", " - a sample European format (190 000,35)  
fiscal_year_start_date    fiscal year start date. Format '0000-mm-dd'. By default January 1.  
export_sales_report_to_excel    Sales report export format. If 'csv', export as CSV. If 'xls' or empty, export as Excel file.  
csv_separator  String  Custom CSV field separator defined by the user. Typically, it is not necessary to use this field. If users have NOT overridden the default CSV separator, then this field is missing or empty.

To get the actual CSV separator used in reporting (either the country-specific default, or the user-defined one, whichever is in effect), see the next parameter, "csv_field_separator" instead.  
csv_field_separator  String  The symbol that is used as a field separator in getSalesReport CSV output (or the CSV-formatted reports that can be downloaded from the back office).

By default, ERPLY uses a default region-specific separator which is either a semicolon or a comma. However, it can be overridden in the account settings (Settings → Configuration in the back office).  
show_company_name_in_title_bar    show company name in title bar  
account_links  Array  Account's special URLs for help pages and knowledge bases according to account's reseller and country. Each row (ie. each array element) has the following fields:
Field nameTypeDescription
helpStringDefault help URL
helpPOSStringHelp URL displayed in Berlin POS
terms_of_serviceStringURL to Erply terms of Service
knowledge_baseStringURL to Erply knowledge base
 

Invoices and Sales

 
   
payment_deadline    Default payment deadline  
invoice_rounding  Integer*  There are four possible values:
  • "-1" - invoice totals must not be rounded.
  • "0" - invoice totals to be rounded to closest 0.05 currency units.
  • "10" - invoice totals should be rounded to closest 0.1 currency units.
  • "100" - invoice totals should be rounded to full currency units.

Rounding is a separate operation that takes place at the very end of calculating invoice total. It does not affect invoice net total or tax. Example rounding:

Invoice total: 32.89
Tax: 2.63
Subtotal: 35.52
Rounding: -0.02
Invoice total: 35.50  
make_sales_reports_by_revenue    If 1, dashboard graphs and widgets show sales revenue. If 0, dashboard graphs and widgets show the sales value of goods shipped from warehouse.  
billing_invoice_use_todays_date    On invoices made from billing statements, use today's date  
final_price_input_on_invoice    Allow to enter final prices (with VAT included) on sales invoices  
always_show_eek_prices_on_invoice_form    Display prices both in selected currency and main currency  
allowCreateInvForContactPerson    Allow to create invoices for contact persons  
do_not_create_automatic_credit_refund    Do not create credit refund automatically  
use_matrix_price_in_pricelist    Select a method for setting price list prices for matrix products. If 1 - Only matrix products are added to price lists. The same price will apply to all colors and sizes. If 0 - Each variation (color and size) is added to the price list as a separate item  
reward_points_per_currency_unit    For all purchases, customer collects X reward points per one unit of currency  
reward_points_duration    Reward points are valid for X months. If 0, points will not expire.  
commission_method    Select a method for calculating employee sales commission. 'percentage' - employees have commission percentage rates, 'amount' - each product has a specific sales commission amount.  
commission_percentage    Default employee commission rate on net sales (%)  
accounts_receivable_listed    Show accounts receivable and calculate customer balance: 'by_payer' - according to invoice payers. 'by_receiver' or empty - according to customers (receivers of goods)  
order_is_completed_when  String  An order is considered completed when: 'packing_list_sent' - A waybill (invoice-waybill) has been made and a packing list sent to the warehouse. 'waybill_made' or empty - A waybill (invoice-waybill) has been made  
partial_fulfilment_splits_order  0 or 1*  Partial fulfilment splits sales order  
use_attendants_in_pos  0 or 1*  in POS and on invoices, every line can be associated with an attendant  
show_credit_in_unpaid_invoices_report  0 or 1*  "Unpaid invoices" report also shows credit invoices  
remake_billing_invoice_if_credited  0 or 1*  After crediting a billing statement invoice you can make a new invoice for the same period  

Sales Document Printouts

 
   
ref_no    Print reference numbers on invoices. 'orgper', 'orgper_manual' or 'invoice'  
code_on_invoice    Products can have several codes. On inventory and purchase documents, show: 'code' / 'code2'  
code_on_salesdocument    Company's own code is printed on invoices and waybills  
code2_on_salesdocument    EAN/UPC code is printed on invoices and waybills  
code3_on_salesdocument    Code 3 is printed on invoices and waybills  
code4_on_salesdocument    Manufacturer code is printed on invoices and waybills  
code5_on_salesdocument    Code 5 is printed on invoices and waybills. "Extra product codes" module must be enabled  
code6_on_salesdocument    Code 6 is printed on invoices and waybills. "Extra product codes" module must be enabled  
code7_on_salesdocument    Code 7 is printed on invoices and waybills. "Extra product codes" module must be enabled  
code8_on_salesdocument    Code 8 is printed on invoices and waybills. "Extra product codes" module must be enabled  
showCodeXOnPackListDoc    On packing lists, show: 'code0' - same code as on invoices. 'code1' - company's own code. 'code2', 'code3' or 'code4'  
sort_packinglist_by    Sort packing list and delivery act by: 'name', 'code', code2', 'code3', 'code4'  
barcode_on_invwaybilldocument    Print a barcode on each invoice line: Enable for Invoice-waybills  
barcode_on_waybilldocument    Print a barcode on each invoice line: Enable for Waybills  
barcode_configuration    Generate barcode from: 'code', code2', 'code3', 'code4'  
discount_printed_on_invoices    Discount rate is printed on invoices by default  
invoiceannouncement{LANG}    Announcement/message printed on invoices. {LANG} signifies language code.  
receipt_footer    Message in the footer of cash receipt  
no_barcode_on_receipt_footer    Do not print receipt # as a barcode on receipts.  
receiver_signature_on_invoice    Invoice printouts include blanks for recipient's name and signature  
display_customer_balance_on_invoice    Print customer balance on invoices and invoice-waybills  
print_giftcard_balance_on_receipt  0 or 1*  If set to 1, and if customers pays with a gift card, receipt should display the remaining balance of the gift card.  
invoice_group_rows_by_waybill    Invoice printout shows lines grouped by waybill number  
factoring    Factoring notice on the invoice  
invoiceExtraFooterLine    Additional text in the footer of invoice  

Sending invoices by e-mail

 
   
import_link_in_invoice_mail    Add an import link to purchase and sales documents sent out by e-mail  
mailtemplatedefault{LANG}    Default text used when sending invoice by e-mail. {LANG} signifies language code.  
mailtemplateinv{1}{2}    Document type-specific text used when sending invoice by e-mail. {1} signifies sales document type ID and {2} signifies language code.  

Sales Quotes

 
   
display_pictures_on_quotes    display product pictures on sales quotes  

Export to Hansa Financials

 
   
hansa_receivables_account    Accounts receivable  
hansa_goods_revenue_account    Revenue from goods  
hansa_services_revenue_account    Revenue from services (if unset, goods revenue account will be used)  
hansa_rounding_account    Invoice rounding (if unset, rounding will not be sent as a separate invoice row)  
hansa_cash_code    Payment condition "Cash"  
hansa_card_code    Payment condition "Card"  
hansa_credit_code    Payment condition "Credited"  
hansa_include_product_codes    Export product codes  
hansa_payables_account    Accounts payable  
hansa_warehouse_account    Warehouse  

Google Apps Integration

 
   
googleapps_default_usergroup    Default user group ID for new users arriving through Google Apps  

Balance statements and Payment reminders

 
   
balance_statement_text1    balance statement letter, header text  
balance_statement_text2    balance statement letter, footer text  
payment_reminder_text1    payment reminder letter, header text  
payment_reminder_text2    payment reminder letter, footer text  
default_period_for_balance_statements    default period for balance statement letters. If 'last_month' or empty, then send end-of-month statement. 'last_year' = end-of-year statement  

Spa and Salon Settings

 
   
salon_booking_email_required    email required when customer books an appointment  
salon_booking_phone_required    phone required when customer books an appointment  
salon_booking_email_or_phone_required    email or phone required when customer books an appointment  
salon_booking_charge1_service  Integer*  Extra charge or service 1. This is a product ID.  
salon_booking_charge2_service  Integer*  Extra charge or service 2. This is a product ID.  
salon_booking_charge3_service  Integer*  Extra charge or service 3. This is a product ID.  
salon_booking_charge1_channel  String  Extra charge 1 is applied when booking: 'walk-in', 'online' or 'phone'  
salon_booking_charge2_channel  String  Extra charge 2 is applied when booking: 'walk-in', 'online' or 'phone'  
salon_booking_charge3_channel  String  Extra charge 3 is applied when booking: 'walk-in', 'online' or 'phone'  
salon_require_credit_card_for_online_booking  0 or 1*  Require credit card information when appointment is booked: online  
salon_require_credit_card_for_phone_booking  0 or 1*  Require credit card information when appointment is booked: over phone  
salon_booking_in_advance_min  Integer*  Customers must book appointments at least X hours in advance.  
salon_booking_in_advance_max  String  Customers can book appointments at most "1w", "2w", "3w" (n weeks) or "1m", "2m", "3m" "6m" (n months) in advance  
salon_cancellation_fee  Decimal*  cancellation fee  
salon_cancellation_service  Integer*  cancellation service. This is a product ID.  
salon_cancellation_deadline  Integer*  Cancellation fee is charged when appointment is canceled less than X hours before the appointment start time  

POS Settings

 
   
default_client_idDat  Integer*  ID of default POS customer (the one that is selected in POS by default, typically "POS Customer", "Walk-in Customer" or similar). NB! It is possible to override this in POS settings, each register may have its own default customer. See getPointsOfSale.  
touchscreen_pos  0 or 1*  Use POS with touchscreen interface  
pos_opening_required  0 or 1*  In POS, days must be opened and closed  
pos_add_rows_automatically  0 or 1*  POS: products identified by barcode will be instantly added to invoice  
quickpos  0 or 1*  Enable automatic printing in POS (Firefox plugin "JS Print Setup" required)  
do_not_use_numpad  0 or 1*  Remove numeric keypad and display more quick select buttons  
show_total_discount_on_receipt  0 or 1*  If customer gets a discount, print a line with total discount on sales receipt.  
total_discount_label  String  Title of that line (eg. "Loyal customer rewards"). By default the line is titled "Total Discount".  
pos_group_items_together  0 or 1*  When ringing up the same product several times, quantity of the last line is incremented  
pos_use_giftcards_with_serial_numbers  0 or 1*  Use gift cards with serial numbers  
pos_timeout  Integer*  Log cashier automatically out after an idle period of X seconds.  

Offline POS Settings

 
   
allow_pay_with_check    enable check payments  
pos_require_email    Cashier must ask for customer's: Email address  
pos_require_facebook    Cashier must ask for customer's: Facebook name  
pos_require_twitter    Cashier must ask for customer's: Twitter ID  
pos_ask_customer_data    Cashier is reminded to ask for customer's information. 'beginning' - at the beginning of transaction, 'end' - at the end of transaction.  
show_debit_button_on_pos    Debit/credit card payments. If 0, customer inserts card and selects whether to pay by debit or credit. If 1, salesperson must ask customer's preferred payment type and select the correct option in POS  
cash_out_warning_treshold    POS will prompt cashier to deposit cash when amount in drawer exceeds $X  
cash_out_warning_interval    Prompting interval in minutes  

Offline POS - weighed items

 
   
barcode_type  String  Barcode type - 'weight' or 'price'. If empty, then the feature has not been set up.  
barcode_price_prefix  String  Barcode prefix. This parameter is set only when price barcodes are enabled.  
barcode_weight_prefix  String  Barcode prefix. This parameter is set only when weight barcodes are enabled.  
barcode_code_length  Integer*  Length of product code (number of digits)  
barcode_measurement_length  Integer*  Length of price or weight (number of digits)  
barcode_weight_decimals  Integer*  Weight precision (in kg or lbs, number of decimal places) - only for barcodes with weight  

Inventory and Purchase

 
   
positive_stock_required    Stock products  
main_warehouse    Main warehouse ID (Stock Replenishment Report will also show stock amounts in main warehouse, in addition to the warehouse you selected.)  
product_code_unique  0 or 1*  If set to 1, all products must have a unique code. (Code may also be empty.)  
product_code2_unique  0 or 1*  If set to 1, all products must have a unique EAN/UPC code. (EAN / UPC code may also be empty.)  
product_code2_automatic    Generate EAN codes automatically  
product_search_returns_matrix_and_variations    product search always returns both matrix products and variations  
use_transport_costs    Enable adding delivery expenses to purchase invoices  
weights_on_invoices    Print weights on purchase and sales invoices  
transport_info_on_invoices    Use foreign transaction statistics  
use_m2_calculator    Use m² → pcs. calculator on invoices  
prcinvoice_with_salesprice    Include sales prices on purchase invoice printout  
prodmove_with_salesprice    Include sales prices on inventory transfer printout  
prcinvoice_send_price_variance_notice_to    If purchase invoice is confirmed and there are price variances, send a notification e-mail to (separated e-mail addresses with commas)  
use_purchase_waybills    Enable purchase waybills and purchase invoices as separate document types  
warehouse_transfer_reserves_goods    Inventory Transfer Order puts items on hold  
warehouse_transfer_order_removes_items    Inventory Transfer Order removes items from inventory  

Purchase orders

 
   
code_on_prcorder    Which product code to print on purchase orders  
prcorder_without_warehouse_location    Print purchase order without warehouse locations  
prcorder_without_weight    Print purchase order without weights  
prcorder_without_regcode    Print purchase order without company number and VAT number  
prcorder_send_price_variance_notice_to    If purchase order is confirmed and there are price variances, send a notification e-mail to (separated e-mail addresses with commas)  

Assignments

 
   
workorderText    additional text on assignment printout  

Expected Transfer Report

 
   
processing_fee_debit    Payment processing fee for: Debit cards  
processing_fee_amex    Payment processing fee for: American Express  
processing_fee_visa    Payment processing fee for: Visa  
processing_fee_mc    Payment processing fee for: MasterCard  
processing_fee_discover    Payment processing fee for: Discover  
expected_transfer_add_visa_mc_together    In "Expected Transfer" report, Visa and MasterCard are added together  

Export to QuickBooks

 
   
qb_bank_deposit    Bank Deposit  
qb_accounts_receivable_trade    Accounts Receivable - Trade  
qb_sales_and_use_tax_payable    Sales and Use Tax Payable  
qb_cash_over_and_short    Cash Over and Short  
qb_counted_over_short_amounts  0 or 1  Report cash counted in POS and day over/short amounts  
qb_inventory    Inventory  
qb_undeposited_funds    Undeposited Funds  
qb_credit_default    Sales Income (default account, you may override it for specific product groups)  
qb_debit_default    COGS (default account, you may override it for specific product groups)  

Matrix settings

 
   
matrix_update_variations_automatically    when you edit a matrix product, its variations are updated with the same changes  
matrix_select_fields    The following variation fields are not updated by default. Select the ones that you want to be updated:  
matrix_update_code    code  
matrix_update_name    name  
matrix_update_price    net sales price  
matrix_update_isactive    active  
matrix_update_show_in_webshop    show in webshop  
matrix_update_commission_amount    commission amount  
matrix_update_warehouse_location    location in warehouse  
matrix_update_costprice    product cost  

Settings not found in Erply Settings » Configuration

 
   
price_decimals  Integer  The degree of precision for net prices. Eg. if price_decimals = 4, all net prices should be stored with 4 digits precision. Typically, price_decimals = 2 for US, 3 or 4 for European accounts. Prices with VAT/tax and invoice totals should be always calculated and displayed with a precision of 2 decimals, regardless of any settings.

NB! Invoice total calculation method in Erply is a separate, complicated topic. Ask us for further information.  
default_currency  String (3)  Not editable. Currency code (EUR, USD, JPY) of the account's default currency. See getCurrencies.  
date_installed  Date (yyyy-mm-dd)  Account's set-up date.  
invoice_algorithm_version  Integer  Not editable. Version number of the algorithm to be used for calculation invoice totals. The version numbers and corresponding algorithms are internally defined. This setting may change day-by-day, so it is advised to check this value at the beginning of each day. If account is not aware of algorithm versions yet, parameter will be set to 0  
locale_uses_price_with_tax  0 or 1  Not editable. If 0, prices in this locale are commonly shown without sales tax (US, CA). If 1, prices are commonly shown with VAT included (the rest of the world).  
invoice_waybills_show_price_with_tax  0 or 1  Not editable. If 1, invoice-waybill totals are calculated according to the same method as POS receipts. This is an optional feature that Erply technical support can enable.  
languages  String  Comma-separated list of all languages that are installed in this account.  
*****  *****  The product card in ERPLY by default has only one field for product description, and one field for long (HTML) product description. Fields for other languages are not enabled by default. Check these parameters to see if the extra fields for multi-language descriptions have been enabled on your account.  
product_description_eng_enabled  0 or 1  The value of this parameter is 1 if your account has English as a non-default language, and if product card has a field for English-language product description. Otherwise (if no field, or that language is not in use) the value is 0.  
product_description_rus_enabled  0 or 1  The value of this parameter is 1 if your account has Russian as a non-default language, and if product card has a field for Russian-language product description. Otherwise (if no field, or that language is not in use) the value is 0.  
product_description_fin_enabled  0 or 1  The value of this parameter is 1 if your account has Finnish as a non-default language, and if product card has a field for Finnish-language product description. Otherwise (if no field, or that language is not in use) the value is 0.  
product_longdescription_eng_enabled  0 or 1  The value of this parameter is 1 if your account has English as a non-default language, and if product card has a field for English-language long (HTML) product description. Otherwise (if no field, or that language is not in use) the value is 0.  
product_longdescription_rus_enabled  0 or 1  The value of this parameter is 1 if your account has Russian as a non-default language, and if product card has a field for Russian-language long (HTML) product description. Otherwise (if no field, or that language is not in use) the value is 0.  
product_longdescription_fin_enabled  0 or 1  The value of this parameter is 1 if your account has Finnish as a non-default language, and if product card has a field for Finnish-language long (HTML) product description. Otherwise (if no field, or that language is not in use) the value is 0.