Add Employee Information

Description

Adds employees to the system.

🔑 Query Params

Field	Type	Required	Description
`idBranch`	int32	No	Filter by branch number (applicable in multi-location environments; ignored otherwise).

📨 Request Body

Field	Type	Required	Description
`name`	string	No	Name of the employee.
`lastName`	string	No	Last name of the employee.
`document`	string	No	Identification document (e.g., CPF or RG).
`documentId`	string	No	ID of the identification document.
`cellphone`	string	No	Employee's mobile phone number.
`email`	string	Yes	Employee's email.
`gender`	string	No	Gender of the employee.
`birthday`	datetime	No	Employee's date of birth (ISO 8601 format).
`country`	string	No	Country of residence of the employee.
`address`	string	No	Complete address of the employee.
`state`	string	No	State of residence of the employee.
`city`	string	No	City of residence of the employee.
`passport`	string	No	Passport number (if applicable).
`zipCode`	string	No	Postal code (CEP) of the employee's address.
`complement`	string	No	Address complement.
`neighborhood`	string	No	Neighborhood of residence.
`number`	string	No	Residential address number.
`active`	boolean	No	Indicates if the employee is active (`true`) or inactive (`false`).
`employeeBranchPermissionsList`	array<object>	No	List of permissions for the employee.

🧩 Structure of `employeeBranchPermissionsList`

The identifiers can be obtained directly from EVO.

Field	Type	Description
`idPermission`	int32	Unique permission identifier.
`idBranchPermission`	int32	ID of the branch to which the permission is linked.
`idBranchGroupPermission`	int32	ID of the branch group associated with the permission (if applicable).

Request

Authorization

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Query Params

Body Params application/json-patch+json

Example

{
    "name": "string",
    "lastName": "string",
    "document": "string",
    "documentId": "string",
    "cellphone": "string",
    "email": "string",
    "gender": "string",
    "birthday": "2019-08-24T14:15:22.123Z",
    "country": "string",
    "address": "string",
    "state": "string",
    "city": "string",
    "passport": "string",
    "zipCode": "string",
    "complement": "string",
    "neighborhood": "string",
    "number": "string",
    "active": true,
    "employeeBranchPermissionsList": [
        {
            "idPermission": 0,
            "idBranchPermission": 0,
            "idBranchGroupPermission": 0
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Add employees

Add Employee Information

Description

🔑 Query Params

📨 Request Body

🧩 Structure of `employeeBranchPermissionsList`

Request

Request Code Samples

Responses

Add employees

Add Employee Information#

Description#

🔑 Query Params#

📨 Request Body#

🧩 Structure of employeeBranchPermissionsList#

Request

Request Code Samples

Responses

Add Employee Information

Description

🔑 Query Params

📨 Request Body

🧩 Structure of `employeeBranchPermissionsList`