Área do desenvolvedorComunidadeMarketplaceUniversidade
Documentação API

Criar uma nova requisição de admissão

post
https://api.sankhya.com.br/v2/funcionarios/admissao

Este endpoint permite o registro de uma nova requisição de admissão, incluindo informações detalhadas sobre o trabalhador, seu cargo, categoria, dados contratuais e cadastrais.

Versão mínima do módulo pessoal: 5.115.0

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Schema v2. Suporta apenas arrays de anexos, removendo os campos de anexo individuais presentes na versão v1. Por padrão, os anexos de documentos (CPF, admissão, etc.) são processados de forma assíncrona: a URL informada é enfileirada e o download do arquivo, bem como sua disponibilização no cadastro do funcionário, ocorrem em um processo em segundo plano (execução periódica, a cada poucos minutos), não durante a chamada síncrona desta API. A foto de perfil (urlFotoPerfil) é a única exceção e é processada de forma síncrona, dentro da própria chamada.

string
required

Nome do Funcionário

string
required

CPF do Funcionário

integer
enum
required

Estado Civil. Os Valores aceitos são:

  • 1 - Solteiro(a)
  • 2 - Casado(a)
  • 3 - Viúvo(a)
  • 4 - Separado(a) Judicialmente
  • 5 - Desquitado(a)
  • 6 - Divorciado(a)
  • 7 - União Estável
Allowed:
boolean

Para indicar se possui filhos

string
enum
required

Identidade de Gênero. Seguem os valores aceitos:

  • C - Cisgênero
  • N - Não-binário
  • T - Transgênero
  • U - Não informado
Allowed:
integer
enum
required

Escolaridade. Seguem os valores aceitos:

  • 1 - Analfabeto
  • 2 - Até 5º Ano Incompleto
  • 3 - 5º Ano Completo
  • 4 - 6º Ao 9º Ano Incompleto
  • 5 - Fundamental Completo
  • 6 - Ensino Médio Incompleto
  • 7 - Ensino Médio Completo
  • 8 - Superior Incompleto
  • 9 - Superior Completo
  • 10 - Mestrado Completo
  • 11 - Doutorado Completo
  • 12 - Pós-Graduação Completa
string

Nome Social do candidato. Opcional. Quando preenchido, o sistema registra automaticamente o candidato como travesti ou transexual. Quando não informado ou vazio, essa marcação não é realizada.

string
enum
required

Orientação Sexual. Seguem os valores aceitos:

  • A - Assexual
  • B - Bissexual
  • E - Heterossexual
  • H - Homossexual
  • N - Não informado
  • P - Panssexual
Allowed:
string
enum
required

Sexo. Seguem os valores aceitos:

  • M - Masculino
  • F - Feminino
Allowed:
integer
enum
required

Raça/Etnia do Funcionário. Seguem os valores aceitos:

  • 0 - Indígena
  • 2 - Branca
  • 4 - Preta
  • 6 - Amarela
  • 8 - Parda
Allowed:
string

Observação sobre Deficiência.

string

URL da foto de perfil (PNG/JPEG).

anexosCpf
array of objects

Lista de anexos do CPF. Processados de forma assíncrona: o download não ocorre na mesma chamada, e sim em um processo em segundo plano executado periodicamente. O vínculo automático ao cadastro do funcionário depende de statusRequisicao (ver descrição do campo).

anexosCpf
anexosAdmissao
array of objects

Lista de anexos do documento admissional. Processados de forma assíncrona: o download não ocorre na mesma chamada, e sim em um processo em segundo plano executado periodicamente. O vínculo automático ao cadastro do funcionário depende de statusRequisicao (ver descrição do campo).

anexosAdmissao
nascimento
object
required

Informações do Nascimento do Funcionário

contato
object
required

Informações de Contato do Funcionário

endereco
object
required

Informações de Endereço do Funcionário

contrato
object
required

Informações de Contrato do Funcionário

documentos
object

Informações dos Documentos do Funcionário

trabalhadorEstrangeiro
object

Informações do Funcionário Estrangeiro

informacoesBancarias
object

Informações Bancárias do Funcionário

convenios
object

Informações de Convênios do Funcionário

string

Observação da requisição de admissão: Essa informação será apresentada ao usuário do departamento pessoal da empresa, na visualização da requisição para aprovação.

deficiencias
array of objects
deficiencias
dependentes
array of objects
dependentes
camposAdicionais
array of objects

Lista de campos adicionais (personalizados) a serem preenchidos na Requisição de Admissão. Propriedade opcional: se não enviada, ou enviada como lista vazia, a requisição é processada normalmente, sem qualquer alteração de comportamento.

O campo adicional informado em nomeCampo deve estar previamente criado na entidade Funcionário (o mesmo campo adicional utilizado no cadastro de Funcionários). Não é possível criar um campo adicional através desta API — ele precisa já existir antes do envio da requisição. Para saber como criar um campo adicional na entidade Funcionário, consulte:

Caso um campo adicional configurado como obrigatório não seja informado (ou seja enviado vazio), a requisição não é bloqueada: ela é criada normalmente, e o usuário do departamento pessoal recebe uma notificação para completar o campo antes de aprovar a requisição.

camposAdicionais
string
enum
Defaults to Pendente

Controla se a requisição já deve nascer aprovada (aprovação automática) ou seguir o fluxo normal de aprovação manual pelo Departamento Pessoal.

  • Pendente (padrão): comportamento atual, a requisição é criada e aguarda aprovação manual.
  • Aprovado: a requisição é criada e aprovada em uma única operação atômica (tudo ou nada) - se qualquer validação falhar, nenhum dado é gravado.

Esse campo também determina o destino final dos anexos assíncronos (anexosCpf/anexosAdmissao):

  • Aprovado: quando o processo em segundo plano terminar de baixar cada anexo, ele é automaticamente disponibilizado nos anexos do cadastro do funcionário já criado - sem necessidade de nenhuma ação manual.
  • Pendente: o anexo baixado fica associado apenas à requisição. Mesmo que a requisição seja aprovada manualmente depois pela tela, o anexo não é vinculado automaticamente ao funcionário - é necessário incluí-lo manualmente pela aba de anexos do funcionário, ou marcar a opção correspondente na aprovação manual.
Allowed:
aprovacaoRequisicao
object

Parâmetros que controlam a aprovação automática da requisição. Só são considerados quando statusRequisicao="Aprovado".

Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?