createInstallation

Create a new ERPLY account.

Input parameters

Parameter name Description Possible value Required
partnerKey  This request can only be called if you have our partnerKey.  String  yes  
companyName    String  yes  
firstName    String  yes  
lastName    String  yes  
phone    String  yes  
website    String    
email    String  yes  
countryCode  two-letter country code - country where the business is located. By default US.  String    
region  State identifier (for US, CA and AU)  String    
defaultLanguage  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
If omitted, 'eng' will be selected as default. 
String (3)    
addressLine1        
addressLine2        
addressPostCode        
addressCountry        
reseller  Reseller identifier (account will be visible to the specified reseller)  String    
username  If not defined, it is generated automatically  String   
password  If not defined, it is generated automatically  String   
ipAddress  IP address of the user signing up  String    
context  Set to 'inventoryapi' or 'erply'. The wording of the e-mail sent to user is slightly different. Default value is 'erply'.  String    
customerID  If an entry has already been created in ERPLY customer registry, then caller can provide customer ID. Customer name, contact information, country code, default language, reseller ID, username and password can be omitted. If necessary, just set parameter sendEmail.  Integer    
planName  Name of the plan that user signed up to. For informative purposes only.  String    
planPrice  Monthly fee of the plan that user signed up to. For informative purposes only.  String    
sendEmail  Set to 1 to send an e-mail to the user, containing account information and log-in URL  0 or 1    
doNotCreateUser  By default, a new account will be fully set up, with the company card and user account created, so that the user can log in right away. If this parameter is set to 1, user will first see an installation wizard that asks for company name, lets choose a user name etc.

This option can NOT be used if user is signing up through a POS app or some other service!

In that case, the account must be ready right away so that app or the service could communicate with it via API. User will not have the chance to see or fill in any web-based wizard forms. 
0 or 1    
salonModules  Set to 1 to install salon-specific modules.  0 or 1    
notes    String    

Response

Field name Type Description
clientCode  String  Account number (customer code) of the new account.  
clientUrl  String  URL where the end user can log into ERPLY back office. This is not the API endpoint URL! To connect to the account via API, use https://&lt 
username  String    
password  String