Envia uma admissão

Cabeçalhos e parâmetros

• AuthorizationBearer <chave>cabeçalhoobrigatório

  Authorization: Bearer <chave>. A chave é gerada pelo escritório na ficha da empresa, com um nome, aparece uma vez (o Motor guarda só o resumo SHA-256 dela), e alcança uma empresa e só a admissão. Vale enquanto não for revogada e o escritório que a gerou atender a empresa. A empresa pode ter até duas chaves ativas ao mesmo tempo, para trocar sem parar; o endereço do webhook e o segredo dele são da integração da empresa, não de cada chave — o webhook é opcional, e trocar o endereço gera um segredo novo na hora. Sessão de usuário e token OAuth são recusados nestas rotas.

• Idempotency-Keytextocabeçalhoobrigatório

  Identificador único deste pedido, gerado pelo seu sistema (um UUID serve). Reenvie com a mesma chave quando não souber se o pedido anterior chegou.

  de 8 a 100 caracteres · formato ^[A-Za-z0-9._:-]+$

Corpo

• trabalhadorobjetoobrigatório
  Campos de trabalhador (11)

  • nome_completotextoobrigatório

    Uma linha só, com ao menos um caractere visível (TS_nome do XSD).

    de 2 a 70 caracteres

  • cpftextoobrigatório

    Só dígitos. Os dígitos verificadores são conferidos (CPF_INVALIDO).

    11 dígitos

  • data_nascimentodata (AAAA-MM-DD)obrigatório
  • generotextoobrigatório

    Sexo declarado ao eSocial (o leiaute só aceita M ou F).

    Valor	Significado
    MASCULINO	Masculino (M no eSocial)
    FEMININO	Feminino (F no eSocial)

  • raca_cortextoobrigatório

    Por nome, não por código: a ordem do cadastro do Motor difere da tabela do eSocial, e o nome não deixa margem. "Não informado" não existe aqui — o eSocial o recusa para admissões desde 22/04/2024.

    Valor	Significado
    INDIGENA	Indígena (código 5 no eSocial)
    BRANCA	Branca (código 1 no eSocial)
    PRETA	Preta (código 2 no eSocial)
    AMARELA	Amarela (código 4 no eSocial)
    PARDA	Parda (código 3 no eSocial)

  • grau_instrucaointeiroobrigatório

    Código do grau de instrução do eSocial (01 a 12), sem o zero à esquerda.

    Valor	Significado
    1	Analfabeto, inclusive o que, embora tenha recebido instrução, não se alfabetizou
    2	Até o 5º ano incompleto do ensino fundamental (antiga 4ª série) ou que se tenha alfabetizado sem ter frequentado escola regular
    3	5º ano completo do ensino fundamental
    4	Do 6º ao 9º ano do ensino fundamental incompleto (antiga 5ª a 8ª série)
    5	Ensino fundamental completo
    6	Ensino médio incompleto
    7	Ensino médio completo
    8	Educação superior incompleta
    9	Educação superior completa
    10	Pós-graduação completa
    11	Mestrado completo
    12	Doutorado completo

  • estado_civiltextoopcional

    Gravado no cadastro. Hoje o S-2200 do Motor não o declara.

    Valor	Significado
    SOLTEIRO	Solteiro(a)
    CASADO	Casado(a)
    DIVORCIADO	Divorciado(a)
    VIUVO	Viúvo(a)
    SEPARADO	Separado(a)
    UNIAO_ESTAVEL	União estável

  • nome_maetextoopcional

    de 2 a 70 caracteres

  • nome_paitextoopcional

    de 2 a 70 caracteres

  • emaile-mailopcional

    Fora deste formato é recusado com 422 DADOS_INVALIDOS (EMAIL_INVALIDO) — nunca descartado em silêncio.

    de 6 a 60 caracteres · formato ^[^@\s]+@[^@\s]+\.[^@\s]+$

  • celulartextoopcional

    Com DDD, só dígitos.

    de 10 a 13 dígitos

• enderecoobjetoobrigatório
  Campos de endereco (7)

  • ceptextoobrigatório

    8 dígitos

  • logradourotextoobrigatório

    O primeiro caractere não pode ser espaço (TS_texto_100 do XSD).

    de 1 a 100 caracteres

  • numerotextoopcional

    Uma linha, com ao menos um caractere visível (TS_nrLograd). Ausente, o Motor declara "S/N".

    de 1 a 10 caracteres

  • complementotextoopcional

    Uma linha, com ao menos um caractere visível (TS_complemento).

    de 1 a 30 caracteres

  • bairrotextoobrigatório

    Uma linha, com ao menos um caractere visível (TS_bairro).

    de 1 a 90 caracteres

  • cod_municipio_ibgetextoobrigatório

    Código IBGE do município (7 dígitos). Precisa existir (MUNICIPIO_INVALIDO) e ser da uf informada (MUNICIPIO_DIVERGE_DA_UF).

    7 dígitos

  • uftextoobrigatório

    Valor	Significado
    AC	Acre
    AL	Alagoas
    AM	Amazonas
    AP	Amapá
    BA	Bahia
    CE	Ceará
    DF	Distrito Federal
    ES	Espírito Santo
    GO	Goiás
    MA	Maranhão
    MG	Minas Gerais
    MS	Mato Grosso do Sul
    MT	Mato Grosso
    PA	Pará
    PB	Paraíba
    PE	Pernambuco
    PI	Piauí
    PR	Paraná
    RJ	Rio de Janeiro
    RN	Rio Grande do Norte
    RO	Rondônia
    RR	Roraima
    RS	Rio Grande do Sul
    SC	Santa Catarina
    SE	Sergipe
    SP	São Paulo
    TO	Tocantins

• vinculoobjetoobrigatório
  Campos de vinculo (8)

  • data_admissaodata (AAAA-MM-DD)obrigatório

    O prazo do S-2200 é a véspera. Data de hoje ou passada é aceita e enviada; a resposta diz fora_do_prazo: true.

  • categoriainteiroobrigatório

    Categoria do trabalhador (Tabela 01 do eSocial).

    Valor	Significado
    101	Empregado - Geral, inclusive o empregado público da administração direta ou indireta contratado pela CLT
    103	Empregado - Aprendiz

  • salario_basenúmeroobrigatório

    Salário mensal, em reais, com no máximo duas casas decimais. Mais que isso é recusado pelo servidor com 422 DADOS_INVALIDOS (SALARIO_INVALIDO). A regra não está no schema porque multipleOf: 0.01 reprova valores válidos por arredondamento binário (1234.56).

    maior que 0

  • horas_mensaisinteiroopcional

    Divisor do salário-hora na folha (220 = 44 h semanais). Não é a jornada: o que o S-2200 declara sai da jornada do catálogo. Ausente, o Motor o deriva da jornada escolhida (horas semanais × 5, até 220); sem jornada (tp_reg_jor 2, 3 ou 4), 220. Fora de 1 a 220: HORAS_MENSAIS_INVALIDAS.

    de 1 a 220

  • tp_reg_jorinteiroobrigatório

    Regime de jornada do eSocial. O 1 exige jornada_id.

    Valor	Significado
    1	Submetido a horário de trabalho (Capítulo II do Título II da CLT)
    2	Atividade externa especificada no inciso I do art. 62 da CLT
    3	Função especificada no inciso II do art. 62 da CLT
    4	Teletrabalho, previsto no inciso III do art. 62 da CLT

  • cargoobjetoobrigatório

    Descrito, não referenciado. O Motor procura um cargo com o mesmo nome (sem diferenciar maiúsculas) no cadastro da empresa e o cria, com o CBO informado, se não houver.

    Se o cargo já existir, vale o CBO do cadastro e o informado é ignorado — cargo é cadastro da empresa, e trocar o CBO dele mudaria o de todos os colaboradores daquele cargo. O aviso CBO_DO_CADASTRO sai só quando o CBO informado difere do cadastro. Se o cargo existente estiver sem CBO, a admissão é recusada com CARGO_SEM_CBO, e quem corrige é o escritório, no cadastro do cargo — o CBO informado não o preenche.

    Campos de cargo (2)

    • nometextoobrigatório

      de 1 a 100 caracteres

    • cbotextoobrigatório

      Código da CBO. Precisa existir na classificação (CBO_FORA_DO_CATALOGO).

      6 dígitos

  • jornada_iduuidopcional

    Id de GET /v1/catalogos/jornadas. Obrigatório quando tp_reg_jor = 1.

  • sindicato_iduuidobrigatório

    Id de GET /v1/catalogos/sindicatos.

• contratouma das formas abaixoobrigatório
  Quando tipo = "INDETERMINADO"

  • tipo"INDETERMINADO"obrigatório
  Quando tipo = "EXPERIENCIA"

  Contrato de experiência é prazo determinado para o eSocial: o S-2200 declara o término do 1º período (o dia da admissão conta como dia 1). A prorrogação para o 2º período é ato do escritório no Motor (S-2206) e não passa por esta API. A soma dos dois períodos não passa de 90 dias (EXPERIENCIA_ACIMA_DE_90_DIAS).

  • tipo"EXPERIENCIA"obrigatório
  • dias_primeiro_periodointeiroobrigatório

    de 1 a 90

  • dias_segundo_periodointeiro ou nullopcional

    Planejado, não declarado. Nulo ou ausente = ainda não decidido.

    de 1 a 89

  • clausula_assecuratoriatrue / falseobrigatório

    Cláusula assecuratória do direito recíproco de rescisão antecipada (art. 481 da CLT).

  Quando tipo = "PRAZO_DETERMINADO"

  Contrato por prazo determinado, para a categoria 101 ou 103, com a data de término obrigatória. Obrigatório para o aprendiz (categoria 103) — sem ele, APRENDIZ_DADOS_OBRIGATORIOS.

  • tipo"PRAZO_DETERMINADO"obrigatório
  • data_terminodata (AAAA-MM-DD)obrigatório

    Igual ou posterior à data_admissao (DATA_TERMINO_INVALIDA).

  • clausula_assecuratoriatrue / falseobrigatório
• deficienciaobjetoopcional

  Envie só para pessoa com deficiência ou reabilitada: pelo menos um dos seis indicadores tem de ser true (PCD_TIPO_OBRIGATORIO). Ausente, o grupo não é declarado. Os indicadores são só true, false ou ausentes (texto como "sim" é recusado, nunca convertido).

  Recusas, em campos[]: PCD_TIPO_OBRIGATORIO (nenhum indicador verdadeiro); PCD_COTA_INCOERENTE (conta_na_cota sem deficiência nem reabilitação, ou faltando com elas); PCD_COTA_APRENDIZ (aprendiz — categoria 103 — com conta_na_cota: true: o aprendiz com deficiência não conta na cota, MOS §23.6); PCD_TIPO_SEM_DEFICIENCIA (tipo de deficiência ou observação sem a deficiência).

  Campos de deficiencia (8)

  • fisicatrue / falseopcional

    padrão false

  • visualtrue / falseopcional

    padrão false

  • auditivatrue / falseopcional

    padrão false

  • mentaltrue / falseopcional

    padrão false

  • intelectualtrue / falseopcional

    padrão false

  • reabilitadotrue / falseopcional

    Beneficiário reabilitado ou readaptado.

    padrão false

  • conta_na_cotatrue / falseobrigatório

    Conta na cota de pessoas com deficiência (Lei 8.213/1991)? Pode ser false com deficiência — a pessoa pode recusar a ação afirmativa. Tem de ser false para o aprendiz (PCD_COTA_APRENDIZ).

  • observacaotextoopcional

    O primeiro caractere não pode ser espaço (TS_texto_255 do XSD).

    de 1 a 255 caracteres

• aprendizobjetoopcional

  Obrigatório, e só aceito, quando vinculo.categoria = 103: fora dela, APRENDIZ_FORA_DA_CATEGORIA; na 103 sem a modalidade, ou sem contrato PRAZO_DETERMINADO, APRENDIZ_DADOS_OBRIGATORIOS (o grupo do aprendiz é obrigatório no S-2200 desde 22/01/2024).

  Recusas, em campos[], com o código do servidor: APRENDIZ_MODALIDADE_AUSENTE · APRENDIZ_INVALIDO (forma) · APRENDIZ_ENTIDADE_AUSENTE (DIRETA sem a entidade qualificadora) · APRENDIZ_ESTABELECIMENTO_AUSENTE (INDIRETA sem o estabelecimento) · APRENDIZ_INCOERENTE (campo da outra modalidade) · APRENDIZ_CNPJ_INVALIDO (entidade qualificadora ou prática) · APRENDIZ_INSCRICAO_INVALIDA (estabelecimento da cota) · APRENDIZ_INSCRICAO_DA_PROPRIA_EMPRESA · APRENDIZ_CPF_NAO_SUPORTADO.

  Campos de aprendiz (4)

  • modalidadetextoobrigatório

    Como o aprendiz é contratado.

    Valor	Significado
    DIRETA	A própria empresa da chave cumpre a cota e contrata o aprendiz (exige cnpj_entidade_qualificadora).
    INDIRETA	A empresa da chave é a entidade sem fins lucrativos ou de prática desportiva que contrata o aprendiz para outro estabelecimento cumprir a cota (exige estabelecimento_da_cota).

  • cnpj_entidade_qualificadoratextoopcional

    CNPJ da entidade qualificadora, na contratação direta. Os dígitos verificadores são conferidos pelo servidor (APRENDIZ_CNPJ_INVALIDO).

    14 dígitos

  • estabelecimento_da_cotaobjetoopcional

    Só na contratação INDIRETA: o estabelecimento para o qual a contratação foi efetivada — quem cumpre a cota com este aprendiz. Não é a empresa da chave: a raiz do CNPJ (8 primeiros dígitos) tem de ser diferente da do empregador (APRENDIZ_INSCRICAO_DA_PROPRIA_EMPRESA). Os dígitos verificadores são conferidos pelo servidor (APRENDIZ_INSCRICAO_INVALIDA).

    Só CNPJ. O leiaute admite CPF, mas a biblioteca do eSocial não o aceita nas alterações contratuais (S-2206) deste aprendiz: com CPF, todo reajuste futuro ficaria travado. CPF é recusado com APRENDIZ_CPF_NAO_SUPORTADO até a biblioteca aceitá-lo.

    Campos de estabelecimento_da_cota (2)

    • tipo_inscricao"CNPJ"obrigatório
    • numerotextoobrigatório

      14 dígitos

  • cnpj_praticatextoopcional

    Estabelecimento onde acontecem as atividades práticas, quando for outro. Os dígitos verificadores são conferidos pelo servidor (APRENDIZ_CNPJ_INVALIDO).

    14 dígitos

• dependenteslista de objetoopcional

  Até 99 (DEPENDENTE_LIMITE). Não pode haver dois com o mesmo CPF (DEPENDENTE_CPF_REPETIDO), nem dois com o mesmo tipo + nome + data_nascimento (DEPENDENTE_REPETIDO). Os dependentes marcados dependente_irrf são a contagem que o Motor usa na dedução do IRRF — não há campo de "número de dependentes".

  até 99 itens

  Campos de dependentes (8)

  • tipotextoobrigatório

    Código da Tabela 07 do eSocial (tipo de dependente), obrigatório para todo dependente — a biblioteca do eSocial o exige sempre, embora o XSD só o peça com IRRF (DEPENDENTE_TIPO_OBRIGATORIO). Só os vigentes: 04 e 07 foram encerrados em 25/04/2023, e 05 e 08 não existem (DEPENDENTE_TIPO_INVALIDO).

    Valor	Significado
    01	Cônjuge
    02	Companheiro(a) com o(a) qual tenha filho ou viva há mais de 5 (cinco) anos ou possua declaração de união estável
    03	Filho(a) ou enteado(a)
    06	Irmão(ã), neto(a) ou bisneto(a) sem arrimo dos pais, do(a) qual detenha a guarda judicial
    09	Pais, avós e bisavós
    10	Menor pobre do qual detenha a guarda judicial
    11	A pessoa absolutamente incapaz, da qual seja tutor ou curador
    12	Ex-cônjuge
    99	Agregado/Outros (exige descricao)

  • nometextoobrigatório

    Uma linha só, de 2 a 70 caracteres (TS_nmDep).

    de 2 a 70 caracteres

  • data_nascimentodata (AAAA-MM-DD)obrigatório

    Não pode ser futura nem anterior a 1890 (DEPENDENTE_NASCIMENTO_INVALIDO).

  • cpftextoopcional

    Obrigatório quando dependente_irrf = true (DEPENDENTE_CPF_OBRIGATORIO). Dígitos conferidos (DEPENDENTE_CPF_INVALIDO); não pode ser o do próprio trabalhador (DEPENDENTE_CPF_DO_TRABALHADOR) nem repetir o de outro dependente (DEPENDENTE_CPF_REPETIDO).

    11 dígitos

  • dependente_irrftrue / falseopcional

    Dependente para dedução do Imposto de Renda. Os marcados são a contagem que a folha usa.

    padrão false

  • dependente_salario_familiatrue / falseopcional

    padrão false

  • incapaz_para_trabalhotrue / falseopcional

    Tem incapacidade física ou mental para o trabalho.

    padrão false

  • descricaotextoopcional

    Obrigatória quando tipo = "99" (DEPENDENTE_DESCRICAO_OBRIGATORIA), e só aceita nesse caso (DEPENDENTE_DESCRICAO_INDEVIDA). O primeiro caractere não pode ser espaço (TS_descrDep = TS_texto_100).

    de 1 a 100 caracteres

Respostas