➕ Criar Funcionário

📖 Descrição

Cria um novo funcionário na empresa.

🎯 Exemplo Prático Detalhado

Cenário: Empresa com identify_key: "document" (CPF obrigatório)

✅ ANA SILVA - Será gravada com SUCESSO

{
  "name": "Ana Silva",
  "document": "12345678901",  // CPF válido (11 dígitos)
  "email": "ana@empresa.com",
  "phone": "11987654321",
  "internal_id": "EMP001",
  "fields": [
    {"id": "uuid-filter-departamento", "value": "TI"},
    {"id": "uuid-filter-cargo", "value": "Desenvolvedora"}
  ],
  "include_campaign": true,
  "is_on_leave": false,
   "has_avd": false
}

Resultado: ✅ Status 201 Created

{
  "data": {
    "id": "9c73a4aa-8094-4241-ad05-658436f471fe",  // ⭐ UUID gerado
    "name": "Ana Silva",
    "document": "12345678901",
    "email": "ana@empresa.com",
    "internal_id": "EMP001",
    "has_avd": false,
    "created_at": "2024-01-01T10:00:00+00:00"
  }
}

❌ BEATRIZ SOUZA - Falhará na validação

{
  "name": "Beatriz Souza",
  "document": "123",  // ❌ CPF inválido (apenas 3 dígitos)
  "email": "beatriz@empresa.com",
  "fields": [
    {"id": "uuid-filter-departamento", "value": "RH"}
  ],
  "include_campaign": true,
  "is_on_leave": false
}

Resultado: ❌ Status 422 Validation Error

{
  "id": "validation-error-uuid",
  "status": 422,
  "title": "Validation Error",
  "detail": "The document format is invalid",
  "meta": {
    "errors": {
      "document": ["The document format is invalid."]
    }
  }
}

🔑 Campos Condicionais (Identify Key)

Identify Key	Campo Obrigatório	Validação
`document`	CPF (11 dígitos)	Algoritmo brasileiro + unicidade global
`email`	Email válido	RFC 5322 + unicidade global
`internal_id`	Matrícula	unicidade global

🆔 UUID de Retorno

O POST retorna o UUID do funcionário criado:

Use este UUID para PUT e DELETE

Exemplo: PUT /v1/employees/9c73a4aa-8094-4241-ad05-658436f471fe

Exemplo: DELETE /v1/employees/9c73a4aa-8094-4241-ad05-658436f471fe

👥 Avaliação de Desempenho (AVD)

O envio do campo has_avd é opcional.
Se a sua empresa tiver o módulo de Avaliação de Desempenho (AVD) habilitado, esse campo controla a participação do colaborador no processo de avaliação:

true — o colaborador participará da avaliação de desempenho.
false — o colaborador não participará da avaliação.

Comportamento padrão: quando o campo has_avd não é enviado, ele assume o valor true automaticamente. Portanto, só é necessário incluí-lo na requisição quando você quiser excluir o colaborador do processo de avaliação (ou seja, enviando false).

📋 Fields Obrigatórios

Todos os filtros com is_required=true devem estar presentes.

📖 Dois formatos aceitos: Ver Sistema de Fields

Primeiro: Liste os filtros obrigatórios:

Depois: Inclua todos no array fields (escolha um formato):

Formato ID + Value (Recomendado):

{
  "fields": [
    {"id": "uuid-filter-departamento", "value": "TI"},
    {"id": "uuid-filter-cargo", "value": "Desenvolvedor"}
  ]
}

Formato Key + Value (Alternativo):

{
  "fields": [
    {"key": "departamento", "value": "TI"},
    {"key": "cargo", "value": "Desenvolvedor"}
  ]
}

👤 Criação sem Document

Se identify_key ≠ DOCUMENT: Funcionário pode ser criado sem CPF

Se identify_key = DOCUMENT: CPF obrigatório e deve ser válido (11 dígitos)

// ✅ Válido para identify_key="email"
{
  "name": "Carlos Silva",
  "email": "carlos@empresa.com",  // Email obrigatório
  "document": null,  // CPF opcional
  "fields": [...]
}

🔗 Links Relacionados

Listar Filtros - Para obter IDs dos filtros obrigatórios

Atualizar Funcionário - Para usar o UUID retornado

Listar Empresas - Para verificar identify_key

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

Parâmetros Bodyapplication/json

Examples

Funcionário com todos os camposFuncionário com campos mínimos (identify_key=email)

{
    "name": "Maria Santos Silva",
    "social_name": "Maria Santos",
    "email": "maria@empresa.com",
    "phone": "11987654321",
    "document": "98765432109",
    "internal_id": "FUNC001",
    "birthdate": "15/03/1985",
    "hiring_date": "01/06/2020",
    "exacts_fields": false,
    "fields": [
        {
            "id": "uuid-filter-departamento",
            "value": "Recursos Humanos"
        },
        {
            "id": "uuid-filter-cargo",
            "value": "Analista"
        },
        {
            "id": "uuid-filter-cidade",
            "value": "São Paulo"
        }
    ],
    "include_campaign": true,
    "is_on_leave": false,
    "id_leader_key": "98765432108",
    "has_avd": true
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢201Criado

application/json

✅ Funcionário criado com sucesso

Bodyapplication/json

Examples

Identify key obrigatório ausenteFiltros obrigatórios ausentesCPF já existente

{
    "id": "validation-error-uuid",
    "status": 422,
    "title": "Validation Error",
    "detail": "Os dados fornecidos são inválidos",
    "meta": {
        "errors": {
            "document": [
                "The document field is required."
            ]
        }
    }
}

🟠422Erro de Parâmetro

📖 Descrição#

🎯 Exemplo Prático Detalhado#

✅ ANA SILVA - Será gravada com SUCESSO#

❌ BEATRIZ SOUZA - Falhará na validação#

🔑 Campos Condicionais (Identify Key)#

🆔 UUID de Retorno#

👥 Avaliação de Desempenho (AVD)#

📋 Fields Obrigatórios#

👤 Criação sem Document#

🔗 Links Relacionados#