Lista com todos os métodos do componente eSocial.
Abaixo da tabela é possível verificar exemplos de utilização dos métodos.
Obs: Posicionando o cursor em cima de cada um dos parâmetros, é possível visualizar detalhes de cada um deles
| Método | Parâmetros | Descrição | Retorno |
|---|---|---|---|
| BaixarXmlEventoLote | aIdLote, aIdEvento | Para obter o XML de um determinado Evento de um lote, utilizaremos o método BaixarXmlEventoLote e informaremos o número de protocolo de um lote válido e o ID de um evento autorizado que pertence ao lote. Atenção! Somente Eventos AUTORIZADOS terão seu XML disponibilizado pelo método. Requisitos | Retornará um objeto tipo IspdRetBaixarXmlEventoLote com o seguinte retorno: XmlEvento / Mensagem Exemplo XML Evento |
| ConsultarIdsEventoLote | aIdLote | Para consultar os ID´s dos eventos de um determinado lote do eSocial que enviamos, utilizaremos o método ConsultarIdsEventoLote e informaremos o número de protocolo de um envio de lote válido. Requisitos | retornará um objeto do tipo IspdRetConsultarIdsEventosLote com retorno: idLote; NumeroProtocolo; Mensagem; Eventos |
| GerarXMLporTX2 | aTX2Content | O primeiro passo para enviar um TX2 de um evento do eSocial é converter este TX2 em XML. Para fazer isso, utilizaremos o método GerarXMLporTX2. Regras de TX2 Requisitos | Este método retornará o conteúdo de um XML com as mesmas informações dos eventos que foram informadas no TX2. |
| AssinarEvento | aXML | Antes de enviarmos um XML do eSocial à SEFAZ, devemos assiná-lo digitalmente. Para isso, utilizamos o método AssinarEvento. Requisitos | Este método retornará o mesmo XML informado como parâmetro, porém, ele terá as tags de assinatura em seu conteúdo. |
| EnviarLoteEventos | aTX2Content, aIdGrupoEventos | Para enviar o lote de eventos à SEFAZ, utilizaremos o método EnviarLoteEventos. | Este método retornará um objeto do tipo IspdRetEnviarLoteEventos com os seguintes atributos: idLote / Mensagem Notas |
| ConsultarLoteEventos | aIdLoteEventos | Para consultar um evento do eSocial que enviamos, utilizaremos o método ConsultarLoteEventos Requisitos | Este método retornará um objeto do tipo IspdRetConsultarLote com quatro níveis de retorno:
IspdRetConsultarLote; IspdRetConsultarLoteOcorrenciaEnvio; IspdRetConsultarLoteItem; IspdRetConsultarLoteOcorrencia |
| ConsultarIdEvento | idEvento | É utilizado para realizar a consulta de um evento especifico através do Id do evento | Este método retornará um objeto do tipo IspdRetConsultarLote com quatro níveis de retorno e será tratado da mesma forma como o retorno do método ConsultarLoteEventos. |
| ConsultarEventoPorRecibo | numeroDoRecibo | É utilizado para realizar a consulta de um evento especifico através do recibo de autorização do mesmo | Este método retornará um objeto do tipo IspdRetConsultarLote com quatro níveis de retorno e será tratado da mesma forma como o retorno do método ConsultarLoteEventos. |
| ReconsultarLoteSefaz | idLoteEventos | Esse método realiza uma reconsulta na receita, através do ID de lote do evento, ele pode ser utilizando quando foi enviado um lote de evento, mas não foi obtido nenhum retorno por parte da receita. Após a realização da reconsulta, basta consultar novamente com o método ConsultarLoteEventos. | O método ReconsultarLoteSefaz não possui retorno. Esse método pode ser utilizado quando não houve um retorno da receita. |
| ListarCertificados | aDelimitador | Para listar todos os certificados instalados na maquina, utilizamos o método ListarCertificados. | Este método retornará uma lista com o nome de todos os certificados instalados na maquina. |
| ListarVersaoManual | aDelimitador | Para listar todas as versão utilizadas, utilizamos o método ListarVersaoManual, o valor retornado deve ser usado na propriedade VersaoManual. | Este método retornará uma lista com todas a versões disponíveis. |
| GetVencimentoCertificado | Utilizado para retornar a data de vencimento do certificado configurado na propriedade NomeCertificado. | Este método retorna uma string com a data de vencimento do certificado. Requisitos | |
| ConfigurarSoftwareHouse | aCNPJSoftwareHouse, aKey | Para que possa utilizar nosso componente, é necessário que configure o CNPJ da software house, através do método ConfigurarSoftwareHouse. | O método ConfigurarSoftwareHouse não possui retorno e deve ser utilizado após a criação da instância do componente. |
| ConsultarLotesPorPeriodo | aDtInicial, aDtFinal, aPagina, aLimite |
Este método realiza uma consulta em nosso banco, para listar os ID de lotes de um determinado período. |
Este método retornará um objeto do tipo IspdSRetConsultarLotesPorPeriodo. |
| SaveConfig | aConfigFile |
Este método salva a configurações do componente em um arquivo .ini. |
Este método retornará um arquivo .ini no diretorio informado. |
Exemplo
Aqui, podemos verificar exemplos de utilização do método EnviarLoteEventos em linguagens diferentes. Apesar do exemplo ser específico do envio de lote, o formato pode ser utilizado em qualquer um dos métodos.
Delphi
var
Retorno: IspdRetEnviarLoteEventos;
begin
Retorno := eSocial.EnviarLoteEventos(mmRetorno.Text, 1);
mmRetorno.Lines.Add(' Retorno:');
mmRetorno.Lines.Add(' ID Lote: ' + Retorno.IdLote);
mmRetorno.Lines.Add(' Mensagem: ' + Retorno.Mensagem);
C#
ESocialClientX.IspdRetEnviarLoteEventos Retorno;
Retorno = eSocial.EnviarLoteEventos(mmRetorno.Text, 1);
mmRetorno.Text = "Retorno:" + Environment.NewLine;
mmRetorno.Text += " ID do lote: " + Retorno.IdLote + Environment.NewLine;
mmRetorno.Text += " Mensagem: " + Retorno.Mensagem + Environment.NewLine;
Visual Basic 6
Dim Retorno As spdRetEnviarLoteEventos
Set Retorno = eSocial.EnviarLoteEventos(mmRetorno.Text, 1)
mmRetorno.Text = " Retorno:" & vbNewLine
mmRetorno.Text = mmRetorno.Text & " ID do lote: " & Retorno.IdLote & vbNewLine
mmRetorno.Text = mmRetorno.Text & " Mensagem: " & Retorno.Mensagem
Comentários
0 comentário
Por favor, entre para comentar.