Cadastra um empregado no estabelecimento
POST/api/time-tracking/employees
- Auth
- Requires a token
- API key:
- No API key accepted
- X-CommunityId
X-CommunityIdSend the X-CommunityId of the community the operation happens in.
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.
Gestão do ponto. A pessoa precisa ser da comunidade e abrir algum espaço de ponto do estabelecimento (422 `personNoAccess`). CPF com dígito conferido (422 `cpfInvalid`), data de admissão e cargo ou função obrigatórios, matrícula eSocial opcional; sem `name`, o nome do perfil (até 52 caracteres, como vai no AFD). Grava o registro tipo 5 "I". A pessoa já cadastrada: 409 `employeeExists`; o CPF em outro cadastro: 409 `cpfInUse`.
Headers
| Name | Type | Description |
|---|---|---|
X-CommunityIdoptional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Request body application/json
| Name | Type | Description |
|---|---|---|
establishmentIdrequired | string (uuid) | |
memberIdrequired | string (uuid) | |
cpfrequired | string | |
nameoptional | string | max 52 |
admissionDaterequired | string (date) | |
jobTitlerequired | string | max 100 |
esocialRegistrationoptional | string | max 30 |
responsibleCpfoptional | string |
Responses
| Status | Description |
|---|---|
201 | Empregado cadastrado. |
401 | Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`). |
403 | Só a gestão do ponto (owner, admin, financeiro): `timeTracking.errors.managementOnly`; quem não tem cadastro de empregado: `notEmployee`; sessão de suporte do SuperAdmin: `supportSession`. |
404 | Recurso não encontrado. |
409 | Conflito com o estado atual do recurso. |
422 | Dado inválido (CPF ou CNPJ com dígito errado, dia, período, campo obrigatório, pessoa sem acesso ao espaço, CPF do responsável ausente). |
curl example
curl -X POST "https://api.memberfy.net/api/time-tracking/employees" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{"establishmentId":"00000000-0000-0000-0000-000000000000","memberId":"00000000-0000-0000-0000-000000000000","cpf":"string","admissionDate":"string","jobTitle":"string"}'