Deletar colaborador

Este endpoint permite deletar um colaborador da empresa com base nos dados fornecidos.

Regras de negócio e validações

Campos obrigatórios

• email ou taxpayerRegistry (query parameter): Ao menos um identificador deve ser informado para localizar o colaborador.
  • email: E-mail do colaborador.
  • taxpayerRegistry: CPF do colaborador. Formato aceito: 12345678909 ou 123.456.789-09.
    

Campos opcionais

• terminationReason: Motivo do desligamento. Valores aceitos:
  • Involuntário
  • Voluntário
  • Não se aplica
  • Término de contrato
• terminationDate: Data de desligamento. Formato: YYYY-MM-DD.

Identificação do colaborador

O colaborador é identificado pelo email ou taxpayerRegistry informado como query parameter. O sistema verifica se a conta encontrada pertence à empresa associada ao token de autenticação.

Restrições

• O colaborador já deve existir na empresa vinculada ao token.
• Não é possível deletar um colaborador que já foi desligado anteriormente.

Exemplo de requisição (cURL)

curl --request DELETE \
  --url 'https://api.gupy.io/user-management/v1/[email protected]' \
  --header 'Authorization: Bearer bearer_token_value_here' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "terminationReason": "Voluntário",
  "terminationDate": "2025-01-15"
}'

Atenção: Forneça o token de autenticação no cabeçalho Authorization.

Possíveis erros

Identificador não informado

Erro lançado quando nem email nem taxpayerRegistry são informados como query parameter.

{
  "statusCode": 400,
  "message": "email or taxpayerRegistry should not be empty.",
  "error": "Bad Request"
}

Identificador inválido

Erro lançado quando o valor do identificador informado é inválido ou de um tipo não suportado.

{
  "statusCode": 400,
  "message": "Invalid identifier value or type.",
  "error": "Bad Request"
}

Colaborador não encontrado

Erro lançado quando o colaborador não foi encontrado através do identificador informado, ou o colaborador não pertence à empresa do token.

{
  "statusCode": 404,
  "message": "Account not found",
  "error": "Not Found"
}

Colaborador já desligado

Erro lançado quando o colaborador informado já foi desligado anteriormente.

{
  "statusCode": 400,
  "message": "Employee already deleted.",
  "error": "Bad Request"
}

Colaborador não pertence à empresa

Erro lançado quando o colaborador encontrado não pertence à empresa vinculada ao token de autenticação.

{
  "statusCode": 400,
  "message": "Employee does not belong to the company",
  "error": "Bad Request"
}

Atributo não encontrado

Erro lançado quando os atributos padrão de desligamento (data de desligamento ou motivo do desligamento) não são encontrados na empresa.

{
  "statusCode": 404,
  "message": "Attribute not found",
  "error": "Not Found"
}

Opção de motivo de desligamento não encontrada

Erro lançado quando o terminationReason informado não corresponde a nenhuma opção válida.

{
  "statusCode": 404,
  "message": "Attribute option not found",
  "error": "Not Found"
}