How to create a Employe

📘
Employees are the ones you want to have access to the system. This integration is not mandatory as employees can be setup directly at the system.

Employees can be created through our Entity endpoint, the request should look something like this:

[
  {
    "name": "Jane Doe", // Company's name
    "tradeName": "jane.doe", // Employe's AD usernamer
    "personType": 0, // Person type (0 = Person, 1 = Company)
    "entityTypeId": 3, // Entity type
    "relationalEntityCode": "8504", // Entity's Id on the origin system
    "situationCode": 1, // Entity status (3 = In registration, 01 = Active, 02 = Inactive)
  }
]

These are the mandatory fields to create an Employe.

🚧
Employees always have the entityTypeId property set to 3.

🚧
For Employees to have access to the system, their nickName must be the same as their AD username.

📘
Multiple Employees can be created within the same request.

Optional fields

Name	Description	Default Value
subType	Any subtype you want to add to this Entity
entityNote	Any notes you want to add to an Entity
street	Street address
typeAddressCode	(Ver com Marcelo)
district	Address district
zipCode	Address zipCode
complement	Address complement
city	Address city
initialsState	Address state initials
flag	Flags are used to group entitys
stateRegistration	Company's State Registration Number (Brazil only)

For more information about the required properties please refer to our API Reference here.

Updated 2 months ago