eSocial Download
- Engenharia
O que é
O eSocial é o instrumento de unificação da prestação das informações referentes à escrituração das obrigações fiscais, previdenciárias e trabalhistas e tem por finalidade padronizar sua transmissão, validação, armazenamento e distribuição, constituindo um ambiente nacional. Esta consulta realiza o download de solicitações cadastradas anteriormente filtrando pelo número da solicitação ou pelas datas iniciais e finais.
Sobre a requisição:
Método: POST
Endereço: URL Base + /api/maestro/e-social/download
URL Base: https://api.plexi.com.br/
Parâmetros do header
Nome | Tipo | Obrigatório? | Descrição |
|---|---|---|---|
Authorization | String | Sim | Chave de API gerada no cadastro no Plexi, prefixada com |
Callback | String | Não | URL para onde o resultado da requisição será enviado via HTTP POST. |
Parâmetros da queryString
Nome | Tipo | Obrigatório? | Descrição |
|---|---|---|---|
certificate | string | Sim, conforme o perfil de acesso | Certificado a ser utilizado para autenticação. |
Parâmetros do body
Nome | Tipo | Obrigatório? | Descrição |
|---|---|---|---|
cpfCnpj | string | Sim, conforme o perfil de acesso | CPF ou CNPJ a ser pesquisado. Validação é obrigatória e deve seguir o tipo de perfil: CPF para perfil de Procurador Pessoa Física e CNPJ para Procurador Pessoa Jurídica ou Representante Legal Pessoa Jurídica. |
perfilAcesso | string | Sim | Perfil de acesso do solicitante. Deve ser um dos valores válidos como titular, procurador_pf, procurador_pj, repons_legal_pj |
numeroSolicitacao | string | Sim, caso não fornecer startDate e endDate | Número da solicitação a ser processada |
startDate | string | Sim, caso não fornecer numeroSolicitacao | Data inicial da pesquisa, no formato d/m/Y. |
endDate | string | Sim, caso não fornecer numeroSolicitacao | Data final da pesquisa, no formato d/m/Y. Deve ser posterior à startDate, não pode ser superior a 1 ano após a startDate e também não pode ser superior ao dia anterior à data atual. |
Regras de Validação:
• A regra para o campo cpfCnpj é definida de acordo com o valor do campo perfilAcesso:
• Procurador Pessoa Física: O campo cpfCnpj deve ser um CPF válido.
• Procurador Pessoa Jurídica e Representante Legal Pessoa Jurídica: O campo cpfCnpj deve ser um CNPJ válido.
• Para outros perfis, o campo cpfCnpj é opcional (não obrigatório).
Resposta com registro encontrado
{
"status": "sucesso",
"numeroSolicitacao": "00000000",
"arquivo": "https://url.com/arquivo",
"dataInicial": "01/10/2024",
"dataFinal": "05/10/2024",
"solicitante": "00000000000",
"empregador": "00000000000000"
}Resposta quando nenhum evento for encontrado
{
"status": "erro",
"mensagem": "Nenhum evento encontrado"
}Resposta quando arquivo indisponível
{
"status": "erro",
"mensagem": "A solicitação não está disponível para download."
}