Pular para o conteúdo principal

Método - Consultando ID de Lotes por período - eSocial

Lucas Santos
Atualizado

ConsultarLotesPorPeriodo(aDtInicial, aDtFinal, aPagina, aLimite)

Para consultar todos os lotes de eventos enviados em um determinado período (a diferença entre os parâmetros "aDtInicial" e "aDtFinal" não pode passar de 30 dias), utilizaremos o método ConsultarLotesPorPeriodo.

 

 

Método

 

ConsultarLotesPorPeriodo(const aDtInicial, aDtFinal: WideString; aPagina, aLimite: SYSINT): IspdSRetConsultarLotesPorPeriodo;

 

 

Parâmetros

 

Argumento Tipo Detalhes
aDtInicial String Data inicial do período de consulta no formato "YYYY-MM-DD"
aDtFinal String Data final do período de consulta no formato "YYYY-MM-DD"
aPagina Integer Página que deseja consultar, é utilizada caso tenha mais de 100 lotes por consulta. Pois o limite de retorno é de até 100 lotes por execução.
aLimite Integer Limite de lotes que deseja retornar por consulta entre 1 e 100

 

 

Retorno

 

Este método retornará um objeto do tipo IspdSRetConsultarLotesPorPeriodo com o seguinte retorno:

  • Mensagem
  • Lotes

Abaixo segue o detalhamento do tipo IspdSRetConsultarLotesPorPeriodo.

 

IspdSRetConsultarLotesPorPeriodo

 

Os campos a seguir são referente ao retorno de lotes por período onde vem a mensagem de retorno e a lista de lotes

 

Campo Função Tipo Exemplo
Mensagem Propriedade que retorna a mensagem de comunicação String Eventos retornados
Lotes Propriedade que retorna os lotes encontrados IspdSRetConsultarLotesPorPeriodoLoteItem _RetConsultarLotesPorPeriodoLoteItem := _RetConsultarLotesPorPeriodo.Lotes[_i]
Count Função que retorno o número de lotes retornado na propriedade Lotes Integer 1

 

 

IspdSRetConsultarLotesPorPeriodoLoteItem

 

Os campos a seguir são referentes ao Lote, onde é indicado suas informações básicas.

 

Campo Função Tipo Exemplo
IdLote Propriedade que retorna o id do lote enviado String c10422eb-c450-41f0-9501-584fa0ead2f1
IdGrupoEventos Propriedade que retorna o id grupo eventos String 1
DataCriacao Propriedade que retorna a data de criação do lote String

2022-07-02
Protocolo* Propriedade que retorna o protocolo de autorização do lote String 1.2.202207.0000000000003273406
StatusConsulta* Propriedade que retorna o status do lote IspdSRetConsultarLotesPorPeriodoStatusConsulta

_RetConsultarLotesPorPeriodoLoteItem.StatusConsulta.Codigo

_RetConsultarLotesPorPeriodoLoteItem.StatusConsulta.Mensagem

 

Atenção! Campos com * eles podem ser vazios de acordo com situação do lote, eles são preenchidos somente em casos de lotes autorizados.

 

IspdSRetConsultarLotesPorPeriodoStatusConsulta

 

Os campos a seguir são referentes ao status consulta do lote

 

Campo Função Tipo Exemplo
Codigo Propriedade que retorna o código da consulta String 201
Mensagem Propriedade que retorna a mensagem do processamento String Lote processado com sucesso.

 

Requisitos

 

Para consultar um evento, é necessário informar um período válido com limite de 30 dias entre as datas.

 

 

Exemplos

 

Delphi

 

var
  _RetConsultarLotesPorPeriodo: IspdSRetConsultarLotesPorPeriodo;
  _RetConsultarLotesPorPeriodoLoteItem: IspdSRetConsultarLotesPorPeriodoLoteItem;
  _i : Integer;
begin
  _RetConsultarLotesPorPeriodo := eSocialS.ConsultarLotesPorPeriodo('2018-07-01', '2018-07-30', 1, 100);

  mmoRetorno.Lines.Clear;
  mmoRetorno.Lines.Add('### CONSULTA DE LOTES POR PERIODO ###');
  mmoRetorno.Lines.Add('Mensagem: ' + _RetConsultarLotesPorPeriodo.Mensagem);

  mmoRetorno.Lines.Add('Lotes:');

  for _i := 0 to _RetConsultarLotesPorPeriodo.Count -1 do
  begin
    _RetConsultarLotesPorPeriodoLoteItem := _RetConsultarLotesPorPeriodo.Lotes[_i];

    mmoRetorno.Lines.Add('Id do Lote: ' + _RetConsultarLotesPorPeriodoLoteItem.IdLote);
    mmoRetorno.Lines.Add('Id Grupo Eventos: ' + _RetConsultarLotesPorPeriodoLoteItem.IdGrupoEventos);
    mmoRetorno.Lines.Add('Data Criacao: ' + _RetConsultarLotesPorPeriodoLoteItem.DataCriacao);
    mmoRetorno.Lines.Add('Protocolo: ' + _RetConsultarLotesPorPeriodoLoteItem.Protocolo);
    mmoRetorno.Lines.Add('Status Consulta:');
    mmoRetorno.Lines.Add(' Codigo: ' + _RetConsultarLotesPorPeriodoLoteItem.StatusConsulta.Codigo);
    mmoRetorno.Lines.Add(' Mensagem: ' +      _RetConsultarLotesPorPeriodoLoteItem.StatusConsulta.Mensagem);
end;

 

C#

 

IspdSRetConsultarLotesPorPeriodo _RetConsultaPorPeriodo;
IspdSRetConsultarLotesPorPeriodoLoteItem _RetConsultaPorPeriodoLoteItem;

 

_RetConsultaPorPeriodo = eSocial.ConsultarLotesPorPeriodo("2018-07-01", "2018-07-30", 1, 100);

tbRetorno.Clear();
tbRetorno.Text += "### CONSULTA DE LOTES POR PERIODO ###" + Environment.NewLine;
tbRetorno.Text += "Mensagem: " + _RetConsultaPorPeriodo.Mensagem + Environment.NewLine;
tbRetorno.Text += "Lotes: "+ Environment.NewLine;


tbRetorno.Text += Environment.NewLine;

for (var i = 0; i < _RetConsultaPorPeriodo.Count(); i++)
{
  _RetConsultaPorPeriodoLoteItem = _RetConsultaPorPeriodo.Lotes[i];

  tbRetorno.Text += " LOTE: " + (i + 1).ToString() + Environment.NewLine;
  tbRetorno.Text += " Id do Evento: " + _RetConsultaPorPeriodoLoteItem.IdLote + Environment.NewLine;
  tbRetorno.Text += " Id Grupo Evento: " + _RetConsultaPorPeriodoLoteItem.IdGrupoEventos + Environment.NewLine;
  tbRetorno.Text += " Data Criação: " + _RetConsultaPorPeriodoLoteItem.DataCriacao + Environment.NewLine;
  tbRetorno.Text += " Protocolo: " + _RetConsultaPorPeriodoLoteItem.Protocolo + Environment.NewLine;
  tbRetorno.Text += " STATUS CONSULTA: " + Environment.NewLine;
  tbRetorno.Text += " Codigo: " + _RetConsultaPorPeriodoLoteItem.StatusConsulta.Codigo + Environment.NewLine;
  tbRetorno.Text += " Mensagem: " + _RetConsultaPorPeriodoLoteItem.StatusConsulta.Mensagem + Environment.NewLine;
  tbRetorno.Text += Environment.NewLine;
}

 

Visual Basic 6

 

Dim RetConsultaPorPeriodo As spdSRetConsultarLotesPorPeriodo
Dim RetConsultaPorPeriodoLoteItem As spdSRetConsultarLotesPorPeriodoLoteItem

Dim i As Integer

Set RetConsultaPorPeriodo = eSocial.ConsultarLotesPorPeriodo("2018-07-01", "2018-07-30", 1, 100)

tbRetorno.Text = "### CONSULTA DE LOTES POR PERIODO ###" & vbNewLine
tbRetorno.Text = tbRetorno.Text & "Mensagem: " & RetConsultaPorPeriodo.Mensagem & vbNewLine
tbRetorno.Text = tbRetorno.Text & "Lotes: " & vbNewLine

For i = 0 To RetConsultaPorPeriodo.Count - 1
    Set RetConsultaPorPeriodoLoteItem = RetConsultaPorPeriodo.Lotes(i)

    tbRetorno.Text = tbRetorno.Text & "LOTE: " & CStr(i + 1) & vbNewLine

    tbRetorno.Text = tbRetorno.Text & " Id do Evento: " & RetConsultaPorPeriodoLoteItem.IdLote & vbNewLine
    tbRetorno.Text = tbRetorno.Text & " Id Grupo Evento: " &     RetConsultaPorPeriodoLoteItem.IdGrupoEventos & vbNewLine
    tbRetorno.Text = tbRetorno.Text & " Data Criação: " & RetConsultaPorPeriodoLoteItem.DataCriacao & vbNewLine
    tbRetorno.Text = tbRetorno.Text & " Protocolo: " & RetConsultaPorPeriodoLoteItem.Protocolo & vbNewLine

    tbRetorno.Text = tbRetorno.Text & "STATUS CONSULTA: " & vbNewLine
    tbRetorno.Text = tbRetorno.Text & " Codigo: " & RetConsultaPorPeriodoLoteItem.StatusConsulta.Codigo & vbNewLine
    tbRetorno.Text = tbRetorno.Text & " Mensagem: " & RetConsultaPorPeriodoLoteItem.StatusConsulta.Mensagem & vbNewLine
Next

 

Artigos relacionados

Comentários

0 comentário

Por favor, entre para comentar.