Consulta o andamento de uma admissão
/v1/admissoes/{id}Alcança as admissões da empresa da chave, com qualquer chave ativa dela — inclusive a admissão enviada por uma chave já revogada, para que a troca de chave não deixe nenhuma sem consulta. Admissão de outra empresa e admissão inexistente respondem igual: 404 NAO_ENCONTRADA.
xml_evento é o XML que foi enviado ao eSocial — pode diferir do pedido, porque o escritório pode corrigir o evento antes de aprovar. Trate o XML devolvido como a verdade.
Cabeçalhos e parâmetros
AuthorizationBearer <chave>cabeçalhoobrigatórioAuthorization: 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.iduuidno caminhoobrigatório
Respostas
200
Andamento atual.
Campos do corpo (12)
iduuidobrigatórioestadotextoobrigatórioOnde a admissão está.
Valor Significado RECEBIDAColaborador criado; o evento está sendo montado. AGUARDANDO_ESCRITORIOO evento está na fila do escritório, esperando uma pessoa aprovar. ENVIADATransmitido; aguardando o processamento do eSocial. PROCESSADAAceito pelo eSocial; há nr_recibo.RECUSADARecusado pelo eSocial; veja ocorrencias. Se o escritório corrigir e reenviar, pode voltar a ENVIADA; não a trate como final.DESCARTADAO escritório descartou o evento sem enviá-lo. Pode voltar se ele o restaurar. matriculatextoobrigatórioaté 30 caracteres
ambientetextoobrigatórioAmbiente do eSocial da empresa.
Valor Significado PRODUCAOProdução (com valor legal). RESTRITAProdução Restrita (teste, sem valor legal). prazo_legaldata (AAAA-MM-DD)obrigatóriofora_do_prazotrue / falseobrigatóriorecebida_emdata e hora (ISO 8601)obrigatórioatualizada_emdata e hora (ISO 8601)obrigatórionr_recibotexto ou nullobrigatórioNúmero do recibo do eSocial. Só em PROCESSADA.
formato
^1\.\d\.\d{19}$ocorrenciaslista de objetoobrigatórioCampos de
ocorrencias(4)codigotexto ou nullobrigatóriodescricaotexto ou nullobrigatóriotipotexto ou nullobrigatórioTipo da ocorrência no retorno do eSocial (erro ou advertência).
localizacaotexto ou nullobrigatório
xml_eventotexto ou nullobrigatórioXML do S-2200 assinado, exatamente como foi enviado. Nulo antes de ENVIADA.
xml_retornotexto ou nullobrigatórioXML do retorno do eSocial para ESTE evento (recortado do lote). Só em PROCESSADA ou RECUSADA.
401
CHAVE_INVALIDA — ausente, malformada, desconhecida, credencial que não é chave de integração, ou chave de uma empresa que deixou de ser atendida pelo escritório que a gerou. CHAVE_REVOGADA — a chave foi revogada pelo escritório; vale a partir da chamada seguinte à revogação. Admissão enviada por ela e ainda não transmitida vai para a fila do escritório (aviso admissao.aguardando_escritorio).
Campos do corpo (3)
codigotextoobrigatórioCódigo estável. Conhecidos: IDEMPOTENCY_KEY_INVALIDA, CHAVE_INVALIDA, CHAVE_REVOGADA, CHAVE_SEM_ESCOPO, EMPRESA_NAO_HABILITADA, CERTIFICADO_INDISPONIVEL, NAO_ENCONTRADA, METODO_NAO_PERMITIDO, TRABALHADOR_JA_ADMITIDO, IDEMPOTENCIA_CONFLITO, IDEMPOTENCIA_EM_CURSO, CORPO_GRANDE_DEMAIS, CAMPO_DESCONHECIDO, DADOS_INVALIDOS, DADOS_FALTANDO, LIMITE_EXCEDIDO, INDISPONIVEL (a lista, com o que fazer em cada um, está em
x-motor-codigos.recusas). Trate código desconhecido como erro que exige olhar humano.mensagemtextoobrigatórioTexto em português para pessoas. Não o use para decidir — use
codigo.camposlista de objetoobrigatórioProblemas campo a campo. Vazio quando o erro não é de um campo.
Campos de
campos(3)campotextoobrigatórioCaminho no corpo, com ponto e índice —
trabalhador.cpf,dependentes.0.cpf.(corpo)quando o JSON não pôde ser lido.codigotextoobrigatórioCódigo do campo; a lista completa, com quem corrige cada um, está em
x-motor-codigos.campos. Quem corrige depende do código: os de jornada e sindicato são do cadastro do escritório, não do pedido.mensagemtextoobrigatório
404
NAO_ENCONTRADA — não existe, ou não é da empresa desta chave.
Campos do corpo (3)
codigotextoobrigatórioCódigo estável. Conhecidos: IDEMPOTENCY_KEY_INVALIDA, CHAVE_INVALIDA, CHAVE_REVOGADA, CHAVE_SEM_ESCOPO, EMPRESA_NAO_HABILITADA, CERTIFICADO_INDISPONIVEL, NAO_ENCONTRADA, METODO_NAO_PERMITIDO, TRABALHADOR_JA_ADMITIDO, IDEMPOTENCIA_CONFLITO, IDEMPOTENCIA_EM_CURSO, CORPO_GRANDE_DEMAIS, CAMPO_DESCONHECIDO, DADOS_INVALIDOS, DADOS_FALTANDO, LIMITE_EXCEDIDO, INDISPONIVEL (a lista, com o que fazer em cada um, está em
x-motor-codigos.recusas). Trate código desconhecido como erro que exige olhar humano.mensagemtextoobrigatórioTexto em português para pessoas. Não o use para decidir — use
codigo.camposlista de objetoobrigatórioProblemas campo a campo. Vazio quando o erro não é de um campo.
Campos de
campos(3)campotextoobrigatórioCaminho no corpo, com ponto e índice —
trabalhador.cpf,dependentes.0.cpf.(corpo)quando o JSON não pôde ser lido.codigotextoobrigatórioCódigo do campo; a lista completa, com quem corrige cada um, está em
x-motor-codigos.campos. Quem corrige depende do código: os de jornada e sindicato são do cadastro do escritório, não do pedido.mensagemtextoobrigatório
429
LIMITE_EXCEDIDO — mais de 60 chamadas por minuto com esta chave. Só isso: a admissão pela API não tem limite próprio no plano do escritório (conta como colaborador ativo, como a da tela). Espere o Retry-After (em segundos).
Retry-AftercabeçalhoSegundos a esperar antes de repetir.
Campos do corpo (3)
codigotextoobrigatórioCódigo estável. Conhecidos: IDEMPOTENCY_KEY_INVALIDA, CHAVE_INVALIDA, CHAVE_REVOGADA, CHAVE_SEM_ESCOPO, EMPRESA_NAO_HABILITADA, CERTIFICADO_INDISPONIVEL, NAO_ENCONTRADA, METODO_NAO_PERMITIDO, TRABALHADOR_JA_ADMITIDO, IDEMPOTENCIA_CONFLITO, IDEMPOTENCIA_EM_CURSO, CORPO_GRANDE_DEMAIS, CAMPO_DESCONHECIDO, DADOS_INVALIDOS, DADOS_FALTANDO, LIMITE_EXCEDIDO, INDISPONIVEL (a lista, com o que fazer em cada um, está em
x-motor-codigos.recusas). Trate código desconhecido como erro que exige olhar humano.mensagemtextoobrigatórioTexto em português para pessoas. Não o use para decidir — use
codigo.camposlista de objetoobrigatórioProblemas campo a campo. Vazio quando o erro não é de um campo.
Campos de
campos(3)campotextoobrigatórioCaminho no corpo, com ponto e índice —
trabalhador.cpf,dependentes.0.cpf.(corpo)quando o JSON não pôde ser lido.codigotextoobrigatórioCódigo do campo; a lista completa, com quem corrige cada um, está em
x-motor-codigos.campos. Quem corrige depende do código: os de jornada e sindicato são do cadastro do escritório, não do pedido.mensagemtextoobrigatório
503
INDISPONIVEL — falha nossa, não do pedido nem da chave. No POST, repita com a MESMA Idempotency-Key, respeitando Retry-After quando vier: não haverá duplicata — se a admissão tiver sido criada, a repetição devolve o 202 dela.
Retry-AftercabeçalhoSegundos a esperar antes de repetir, quando vier.
Campos do corpo (3)
codigotextoobrigatórioCódigo estável. Conhecidos: IDEMPOTENCY_KEY_INVALIDA, CHAVE_INVALIDA, CHAVE_REVOGADA, CHAVE_SEM_ESCOPO, EMPRESA_NAO_HABILITADA, CERTIFICADO_INDISPONIVEL, NAO_ENCONTRADA, METODO_NAO_PERMITIDO, TRABALHADOR_JA_ADMITIDO, IDEMPOTENCIA_CONFLITO, IDEMPOTENCIA_EM_CURSO, CORPO_GRANDE_DEMAIS, CAMPO_DESCONHECIDO, DADOS_INVALIDOS, DADOS_FALTANDO, LIMITE_EXCEDIDO, INDISPONIVEL (a lista, com o que fazer em cada um, está em
x-motor-codigos.recusas). Trate código desconhecido como erro que exige olhar humano.mensagemtextoobrigatórioTexto em português para pessoas. Não o use para decidir — use
codigo.camposlista de objetoobrigatórioProblemas campo a campo. Vazio quando o erro não é de um campo.
Campos de
campos(3)campotextoobrigatórioCaminho no corpo, com ponto e índice —
trabalhador.cpf,dependentes.0.cpf.(corpo)quando o JSON não pôde ser lido.codigotextoobrigatórioCódigo do campo; a lista completa, com quem corrige cada um, está em
x-motor-codigos.campos. Quem corrige depende do código: os de jornada e sindicato são do cadastro do escritório, não do pedido.mensagemtextoobrigatório