This call is deprecated. We recommend to use Account Administration API instead.
The corresponding new call is: POST /v1/employee.
Create or update an employee.
To retrieve employees, see API call getEmployees.
To record that employee agrees to follow the data protection requirements of General Data Protection Regulation, see API call recordGDPRConfirmation.
Parameter name | Description | Possible value | Required |
---|---|---|---|
employeeID | integer | ||
lang | Retrieve item names in a specific language. If omitted, API will return item names in the default language of your Erply account. Possible values:
|
string | |
firstName | Employee's given name | string | |
lastName | Employee's surname | string | yes |
phone | string | ||
mobile | string | ||
string | |||
skype | string | ||
jobTitle | string | ||
notes | Text | ||
drawerID | Drawer id for the employee. Used only when drawer counting is enabled on the account. | string | |
productGroupIDs | Salon-specific attribute. Available only if Salon / Spa module is enabled on your account. A comma-separated list of product groups that employee provides. | string | |
***** | Additional attributes associated with this item. Attributes must be supplied as a flat list, each attribute defined by the following set of three parameters. Replace # with set number (1, 2, 3, ...). When updating an existing entry, API will only update the attributes specified in input data and leave all other existing attributes unchanged. To delete an attribute, set its value to 'null' or 'undefined'. |
***** | |
attributeName# | Attribute name. Name can only contain the following symbols: A-Z, a-z, 0-9, dash and underscore. | string | |
attributeType# | Attribute type, possible types are 'text', 'int' and 'double'. By default 'text'. | string | |
attributeValue# | Value of the attribute. Set value to 'null' or 'undefined' to delete an attribute. 'text' attribute can be any string, maximum 255 characters. 'int' must be a signed 32-bit integer. 'double' must be a decimal number. |
string |
Field name | Type | Description |
---|---|---|
employeeID | integer | ID of the newly-created or updated item |