Esta rota é utilizada para consultar todos os lotes de eventos enviados em um determinado período (a diferença entre os parâmetros "datainicial" e "datafinal" não pode passar de 30 dias).
A consulta é paginada e é possível escolher a quantidade de eventos retornados por página (limite de 300 por página), também é possível definir qual a pagina que será retornada através do parâmetro "pagina".
Rota da API
GET https://api.tecnospeed.com.br/esocial/v1/evento/consultar/empregador/<cnpjEmpregador>
Parâmetros
Query params
| Nome | Descrição | Exemplo | Valores |
| ambiente | Ambiente de envio do Evento | 2 | 1 - Produção ou 2 - Homologação |
| datainicial | Data de inicio da consulta | 2018-07-01 | |
| datafinal | Data do fim da consulta | 2018-07-30 | |
| pagina | Página retornada na consulta | 0 | |
| limite | Limite de eventos por página | 5 |
Route params
| Nome | Descrição | Exemplo | Valores |
| empregador | CNPJ do empregador | 29062609000177 | CNPJ do empregador que esta fazendo o envio |
Headers
| Nome | Descrição | Exemplo | Valores |
| cnpj_sh | CNPJ da Software House | 29062609000177 | CNPJ do contrato com a Tecnospeed |
| token_sh | Token da Software House | gerar o token em https://conta.tecnospeed.com.br/ | O acesso é diferente do portal do cliente, então mesmo que já acesse o portal do cliente é necessário criar um novo acesso |
| empregador | CNPJ ou CPF do empregador | 29062609000177 | CNPJ do empregador que esta fazendo o envio |
Exemplo
GET https://api.tecnospeed.com.br/esocial/v1/evento/consultar/empregador/21188853000179
Retorno
O retorno será um JSON com as principais informações do lote.
Exemplo de retorno:
{
"message": "Eventos retornados",
"data": [
{
"_id": "d10433eb-b460-41f0-9501-584fa0ead2f2",
"idgrupoeventos": "1",
"data_criacao": "2022-03-01",
"protocolo": "1.2.201807.0000000000003178307",
"status_consulta": {
"codigo": "201",
"mensagem": "Lote processado com sucesso."
}
},
{
"_id": "38e19988-b0c0-4d74-9eb5-ef2c27535d5e",
"idgrupoeventos": "1",
"data_criacao": "2022-03-01",
"protocolo": "1.2.201807.0000000000003179381",
"status_consulta": {
"codigo": "201",
"mensagem": "Lote processado com sucesso."
}
},
{
"_id": "87115992-ea8c-4368-815f-b40a7533be23",
"idgrupoeventos": "1",
"data_criacao": "2022-03-02",
"protocolo": "1.2.201807.0000000000003425633",
"status_consulta": {
"codigo": "201",
"mensagem": "Lote processado com sucesso."
}
},
{
"_id": "a62bf734-abba-44e7-9a90-8ea37677a44e",
"idgrupoeventos": "1",
"data_criacao": "2022-03-03",
"protocolo": "1.2.201807.0000000000003426724",
"status_consulta": {
"codigo": "201",
"mensagem": "Lote processado com sucesso."
}
},
{
"_id": "0b654687-e726-42b7-9fcb-86d967afe36f",
"idgrupoeventos": "1",
"data_criacao": "2022-03-04",
"protocolo": "1.2.201807.0000000000003448693",
"status_consulta": {
"codigo": "201",
"mensagem": "Lote processado com sucesso."
}
}
]
}
Exemplo de retorno com erro:
{
"error": {
"message": "É permitido apenas consultar eventos no período de um mês."
}
}
Comentários
0 comentário
Por favor, entre para comentar.