Create a new Erply account.
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 | ||
string | yes | ||
countryCode | Two-letter ISO-3166 country code: country where the business is located. For a few countries, signups have been disabled; for those country codes, the API call returns error code 1177. |
string | yes |
region | State identifier (for US, CA and AU) | string | |
defaultLanguage | Default language of this account. Possible values:
|
String (3) | |
addressLine1 | string | ||
addressLine2 | string | ||
addressPostCode | string | ||
addressCountry | string | ||
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, if password is defined call will return 1100 error if does not contain at least 8 characters or 1102 error if does not contain at least one small letter, one capital letter and one digit | 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 | |
notes | string |
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!. |
username | string | |
password | string |