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.
Sobre a requisição (
...
REQUEST):
Método: POST
Endereço: URL Base + /api/maestro/esocial/searche-social
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 |
startDate | string | Sim | Data inicial da pesquisa, no formato d/m/Y. |
endDate | string | Sim | 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. |
...
| Code Block |
|---|
• cpfCnpj: Validação obrigatória conforme o perfil de acesso (perfilAcesso). Se o perfil for Procurador Pessoa Física, deve ser um CPF válido. Se o perfil for Procurador Pessoa Jurídica ou Representante Legal Pessoa Jurídica, deve ser um CNPJ válido. • perfilAcesso: Deve ser um dos valores válidos na enumeração ESocialProfilecomo titular, procurador_pf, procurador_pj, repons_legal_pj. • certificate: Deve ser fornecido e ser uma string válida. • startDate: Data inicial, deve estar no formato d/m/Y. • endDate: Deve estar no formato d/m/Y, ser posterior à startDate, e não pode ser superior a 1 ano após a startDate nem superior ao dia anterior à data atual. |
Estrutura da resposta
Status | Significado | Descrição | Informações retornadas |
|---|---|---|---|
201 | Created | Solicitação criada | Campo requestId, com o ID da requisição criada. |
422 | Unprocessable Entity | A solicitação contém erro | Em quais campos houve erro. |
Exemplos de retornos quando você faz a requisição:
Status 201
| Include Page | ||||
|---|---|---|---|---|
|
...
| Include Page | ||||
|---|---|---|---|---|
|
Resultados da pesquisa ( retornados no callback ou fazendo requisição à API de respostas )
Valores possíveis do campo “status“
...
| Code Block | ||
|---|---|---|
| ||
{
"status": "erro",
"mensagem": "Mensagem de erro"
} |
Sobre a requisição (
...
SEARCH):
Método: POST
Endereço: URL Base + /api/maestro/esocialresult/request{requestId}
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 | Número da solicitação a ser processada |
...