Lista com todos os métodos do componente NFe.
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 |
|---|---|---|---|
| AssinarNota |
XML |
Para realizar a assinatura de um arquivo XML, utilizando um certificado digital, utilize o método AssinarNota. | Este método retornará o mesmo XML que você passou como parâmetro na função, porém ele terá as tags de assinatura em seu conteúdo. Notas |
| AssinarCCe | aXmlCCe | Realiza a assinatura digital da CC-e. | Retorna o XML da CC-e assinado. Notas |
| AssinarEPEC | aXMLEpec | Realiza a assinatura digital de um Xml do EPEC antes de realizar o envio do mesmo. | Será retornado um Xml assinado do EPEC. Notas |
| CalculaChaveInutilizacao | aAno, aCNPJCPF, aModelo, aSerie, aNFIni, aNFFin | Função que calcula a Chave da Inutilização, quando desejar confirmar se a chave da inutilização está correta. | O retorno será uma chave de 41 dígitos, calculada com base nos parâmetros fornecidos. Notas |
| CalculaChaveNFe | aDtEmissao, aUF, aCNPJCPF, aModelo, aSerie, aNRNota, aCodSistema, aTpEmis | Para calcular a chave da nota manualmente, utilize o método CalculaChaveNFe. | O método CalculaChaveNFe retorna a chave. Notas |
| CancelarNFeEvento | aNotaID, aNumProtocolo, aJustificativa, aDataHoraEvento; aSequenciaEvento; aFusoHorario; aIdLote | Para enviar uma solicitação de cancelamento de uma NFe, utilize o método CancelaNFeEvento. | O retorno do método CancelarNFeEvento será um XML dizendo a situação da nota: se o cancelamento foi aprovado ou rejeitado. Notas |
| CancelarComprovanteEntrega | aIdLote, aChaveNFe, aNumProtocoloEvento, aOrgao, aOrgaoAutor, aVersaoAplicativo, aDataHoraEvento, aFusoHorario, aSequenciaEvento, aTpAutor | Método responsável por cancelar o comprovante de entrega da NF-e. | XML contendo mensagem do resultado da solicitação. |
| CancelarComprovanteEntrega | aIdLote, aXmlCancelamentoComprovanteEntrega | Método responsável por cancelar o comprovante de entrega da NF-e. | XML contendo mensagem do resultado da solicitação. |
| LoadConfig | aCaminhoArquivoIni | Carrega configurações do componente a partir do conteúdo de um arquivo .ini Deverá ser utilizado apenas uma vez, de preferência quando seu sistema iniciar, antes de utilizar qualquer função do componente. Notas | Não possui retorno. |
| 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. Notas |
| ConsultarNF | aNotaID | Para consultar determinada chave no servidor da SEFAZ, deve-se utilizar o método ConsultarNF. | O método ConsultarNF retorna um XML com o resultado da operação solicitada. O retorno só será possível caso a situação da nota seja: Autorizada ou Cancelada. Para qualquer situação diferente destas, a SEFAZ retornará que não encontrou esta nota em sua base de dados. |
| ConsultarRecibo | num_recibo | Para obter a situação de uma nota a partir de seu recibo, utilize o método ConsultarRecibo. | Um conteúdo do XML de resposta da consulta será retornado pela função ConsultarRecibo, esse XML terá o campo xMotivo, dizendo se a nota foi Autorizada ou Rejeitada, além do campo cStat que trás o código da situação dessa nota. |
| ConsultarDistribuicaoDFe | aCodigoUF, aCNPJCPF; aNSU; aTipoNSU | Função de "Consulta da Relação de Documentos a serem distribuídos para determinado CPF ou CNPJ de acordo com a NF-e" para quando for realizar a consulta das notas emitidas contra o seu CNPJ. | O método ConsultarDistribuicaoDFe retorna os XMLs Destinados pela busca do NSU. Notas |
| ConsultarCadastro | aDocumento; aTpDocumento; aUF | Para consultar o cadastro do Contribuinte ICMS, utilize o método ConsultarCadastro. | O método ConsultarCadastro(xml) retorna XML contendo mensagem do resultado da solicitação (Dados do Contribuinte). Estados disponíveis: AC, BA, CE, ES, GO, MG, MS, MT, PB, PE, PR, RN RS, SC, SP Notas |
| Consultar GTIN | aGTIN | Função para consultar GTIN no WebService da SEFAZ através do código GTIN. | Este método retornará o XML de resposta da consulta. |
| StatusDoServico | n/a | Para verificar se o Webservice está funcionando corretamente, deve-se utilizar o método StatusDoServico. | O método StatusDoServico irá retornar um XML, onde descreve o status do serviço. Normalmente é 107Servico em Operacao |
| ConsultarDistribuicaoDFeChave | aCodigoUF, aCNPJCPF, aChave | Para consultar uma chave específica emitida contra seu CNPJ, deve-se utilizar o método ConsultarDistribuicaoDFeChave. | O método ConsultarDistribuicaoDFeChave retorna os XMLs Destinados pela busca da chave. Notas |
| ConverteXmlparaDataSet | aXml; aVersaoEsquema | Para realizar a conversão de um XML destinatário para dataset, utilize o método ConverteXmlparaDataSet, isso facilitará a importação e manipulação de dados de um XML. | Este método retornará um objeto do tipo "TspdNFeDataSets", populado com os dados do XML. |
| ConverterLoteParaXml | ArquivoLoteTx2; aVersaoEsquema | Função que converte um Lote de NFes no formato TX2 ou REC para XML. | Será retornado o XML de envio. |
| DescompactarXMLZip | aXML | Para descompactar um XML zipado, utilize o método DescompactarXMLZip. | O método DescompactarXMLZip retorna o XML descompactado. Notas |
| EnviarCCe | aNotaID, aTextoCorrecao, aDataHoraEvento, aOrgao, aIdLote, aSequenciaEvento | Para enviar uma Carta de Correção Eletrônica (CCe) deve-se utilizar o método EnviarCCe. Este método é utilizado para realizar correções em uma NF-e autorizada. | O método EnviarCCe retorna um XML contendo a mensagem do resultado da solicitação. |
| EnviarManifestacaoDestinatario | aTpEvento, aNotaID, aCNPJCPF, aJustificativa, aDataHoraEvento, aSequenciaEvento, aFusoHorario, aCOrgao | Para informar a Sefaz do conhecimento ou desconhecimento de uma operação, utilize o método EnviarManifestacaoDestinatario. | Retorna XML contendo mensagem do resultado da solicitação. |
| EnviarNF | aNumLote, aLoteNotas, aCompactado | Para realizar o envio de uma NFe de maneira assíncrona, utilize o método EnviarNF. | XML contendo mensagem do resultado da solicitação. Notas |
| EnviarEPEC | aXmlNota | Para realizar o envio de uma NFe em modo EPEC, utilize o método EnviarEPEC. | Este método retornará o conteúdo de um XML com o resultado do processamento da nota. Notas |
| EmailDanfe | aNumLote, aLoteNotas, aArquivoModelo | Para enviar uma DANFE por e-mail, deve-se utilizar o método EmailDanfe. | O método EmailDanfe não possui retorno. Documentação completa de configuração. |
| EnviarAtorInteressado | aIdLote, aXmlAtorInteressado | Método responsável por enviar o evento do Ator Interessado na NF-e - Transportador. Utilizado para informar um novo ator envolvido no transporte da NF-e após a sua emissão, quando se tem o XML do Ator Interessado assinado. | XML contendo mensagem do resultado da solicitação. |
| EnviarAtorInteressado | aChaveNFe, aOrgao, aDataHoraEvento, aIdLote, aOrgaoAutor, aCnpjCpfAutorizado, aVersaoAplicativo, aTpEvento, aSequenciaEvento, aTpAutor, aTpAutorizacao, aFusoHorario | Método responsável por enviar o evento do Ator Interessado na NF-e - Transportador. Utilizado para informar um novo ator envolvido no transporte da NF-e após a sua emissão, quando não se tem o XML do Ator Interessado assinado. Assim o próprio componente fica responsável pela geração do mesmo. | XML contendo mensagem do resultado da solicitação. |
| EnviarComprovanteEntrega | aChaveNFe, aOrgao, aDataHoraEvento, aIdLote, aOrgaoAutor, aDataHoraEntrega, aVersaoAplicativo, aFusoHorario, aNumDocIdent, aNomeAssinanteComp, aLatitude, aLongitude, aPathImagemEntrega, aSequenciaEvento, aTpAutor | Método responsável por enviar o comprovante de entrega da NF-e. Utilizado para informar a comprovação de entrega/recebimento de mercadorias, a partir da captura de imagens e registros de eventos nos documentos fiscais eletrônicos utilizados pelas empresas emitentes de NF-e. | XML contendo mensagem do resultado da solicitação. |
| EnviarComprovanteEntrega (com xml de envio) | aIdLote, aXmlComprovanteEntrega | Método responsável por enviar o comprovante de entrega da NF-e. Utilizado para informar a comprovação de entrega/recebimento de mercadorias, a partir da captura de imagens e registros de eventos nos documentos fiscais eletrônicos utilizados pelas empresas emitentes de NF-e. | XML contendo mensagem do resultado da solicitação. Notas |
| EnviarNFSincrono | aNumLote, aLoteNota, aCompactado | Função para enviar o lote das NF's assinadas de modo síncrono. O Lote de notas para o modo síncrono deve conter somente uma nota. | Xml contendo mensagem do resultado da solicitação. |
| EnviarNotaCanceladaDestinatario | aIDNFe, aLogPedCanc, aLogRetCanc, aEmailDestinatario | Método que baseado em Logs de Cancelamento monta o XML padronizado pela Sefaz e o envia por email ao destinatário. É utilizado em casos onde o destinatário exige um e-mail com o Xml do cancelamento. | Não possui retorno. |
| CancelarPedidoProrrogacao | aIdLote, aChaveNFe, aNumProtocolo, aDataHoraEvento, aTpEvento, aSequenciaEvento, aFusoHorario | Este método permite realizar o envio do Cancelamento do Pedido de Prorrogação. Utilizado apenas em pedidos que foram autorizados. | XML contendo mensagem do resultado da solicitação. |
| CancelarInsucessoEntrega | aIdLote, aChaveNFe, aNumProtocoloEvento, aOrgao, aOrgaoAutor, aVersaoAplicativo, aDataHoraEvento, aFusoHorario, aSequenciaEvento |
Utilizado para informar o cancelamento do evento de insucesso na entrega feito para uma determinada NF-e. | XML contendo mensagem do resultado da solicitação. |
| EnviarNotaDestinatarioAnexos | aArquivoPDF, aArquivoXML, aOutros | Para realizar o envio do XML destinatário, danfce e outros anexos por email, utilize o método EnviarNotaDestinatarioAnexos. | Este método não possuí retorno. |
| EnviarNotaDestinatario | aIDNFe, aLogEnvio, aLogRecibo | Para envio do XML Destinatário por email, utilize o método EnviarNotaDestinatario. Notas | Este método não possuí retorno. |
| EnviarPedidoProrrogacao | aIdLote, aXmlPedProrrogacao | Método responsável pelo envio do Pedido de Prorrogação. Utilizado para realizar o pedido de prorrogação quando já se tem o XML do Pedido assinado. | XML contendo mensagem do resultado da solicitação. |
| EnviarPedidoProrrogacao(com xml de envio) | aIdLote, aChaveNFe, aNumProtocolo, aDataHoraEvento, aOrgao, aTpEvento, aSequenciaEvento, aFusoHorario | Método responsável pelo envio do Pedido de Prorrogação. Utilizado para realizar o pedido de prorrogação quando não se tem o XML do Pedido assinado. Assim o próprio componente fica responsável pela geração do mesmo. | XML contendo mensagem do resultado da solicitação. |
| EnviarCCeDestinatario |
aCCe |
Método utilizado para quando precisar enviar um e-mail para o destinatário da nota dizendo que a mesma foi corrigida. Notas | Não possui retorno. |
| aChaveNFe, aOrgao, aDataHoraEvento, aIdLote, aOrgaoAutor, aDataHoraTentativaEntrega, aVersaoAplicativo, aFusoHorario, aNumTentativa, aLatitude, aLongitude, aPathImagemTentativaEntrega, aJustMotivo, aSequenciaEvento, aTpMotivo | Utilizado para informar o insucesso na entrega de mercadorias, a partir da captura de imagens e registros de eventos nos documentos fiscais eletrônicos utilizados pelas empresas emitentes de NF-e. | XML contendo mensagem do resultado da solicitação. | |
| ExportarCCe | aXMLCCe, aSalvarComo | Para gerar um PDF da Carta de Correção, em um diretório especifico, utilize o método ExportarCCe. | Não possui retorno. Notas |
| ExportarEPEC | aLoteNotas, aProtEPEC, aDataHoraEPEC, aArquivoModelo, aFormato, aExportarParaArquivo | Método utilizado para gerar um PDF da DANFE em contingência EPEC quando for necessário emitir uma NF-e em EPEC e precisar realizar a impressão dela. | Não possui retorno. |
| ExportarDanfe | aNumLote, aLoteNotas, aArquivoModelo, aFormato, aExportarParaArquivo | Este método permite exportar um DANFE autorizado para os formatos PDF e HTML. | Este método não possuí retorno. Notas |
| ExportarPreverDanfe | aLoteNotas, aArquivoModelo, aLocalNomeArquivo | Para exportar a pré visualização de uma nota antes de enviar a Sefaz, utilize o método PreverDanfe. | Este método não possuí retorno, apenas é exibida uma tela para visualização da nota. Notas |
| GerarXmlCancelamentoDestinatario | aIDNFe, aContentLogPedCanc, aContentLogRetCanc, aSalvarComo | Função responsável por gerar XML de Cancelamento que deve ser distribuído ao Destinatário. | XML do cancelamento. |
| ConverterLoteParaXml | ArquivoLoteTxt, aLayoutConv, aVersaoEsquema, aExportacao | Para converter um lote de notas fiscais em formato TX2 para XML, utilize o método ConverterLoteParaXml. | O método ConverterLoteParaXml retorna o XML convertido. Notas |
| GerarXMLManifestoDestinatario | aIDEvento, aLogEvento, aLogRetEvento, aSalvarComo | Este método permite regerar o XML Destinatário de uma nota manifestada perante a Sefaz. Utilizado em casos onde é necessário gerar novamente o XML do manifesto de forma manual. | XML do manifesto. |
| GerarXMLEnvioDestinatario | aIdnfe, aLogEnvLote, aLogConsReciboOuChave, aSalvarComo | Gerar XML no Padrão da SEFAZ a ser Enviado ao Destinatário. Utilizado quando for necessário gerar um XML autorizado de forma manual. | Este método retornará uma string, contendo o XML Destinatário da NF-e. Notas |
| GerarXMLCCeDestinatario | aIDEvento, aLogEvento, aLogRetEvento, aSalvarComo | Função responsável por gerar XML da CCe que deve ser enviado ao Destinatário quando for necessário gerar manualmente um XML de uma CC-e. | XML da CC-e. |
| ImprimirDanfe | aNumLote, aLoteNotas, aArquivoModelo, aImpressora | Para imprimir a nota diretamente na impressora, utilize o método ImprimirDanfe. | Não possui retorno. Notas |
| Imprimir | aXmlCCe | Método de impressão da Danfe da Carta de Correção NFe. | Não possui retorno. Notas |
| ImprimirEPEC | aLoteNotas, aProtEPEC, aDataHoraEPEC, aArquivoModelo, aImpressora | Método utilizado para Imprimir a DANFE em contingência EPEC. Quando emitir uma NF-e em EPEC e precisar realizar a impressão dela. | Não possui retorno. Notas |
| ImprimirDanfeXmlDiretorio | aDiretorioXml, aArquivoModelo aExportarArquivoPara aImpressora | Este método permite realizar a impressão do DANFE de XML's autorizados, que estão em um determinado diretório. | Não possui retorno. |
| InutilizarNF | aNotaID, aAno, aCNPJCPF, aModelo, aSerie, aNFIni, aNFFin, aJustificativa | Função que solicita a Inutilização de Numeração. Utilizado para corrigir uma numeração que foi pulada. | XML contendo a mensagem do resultado da solicitação Notas |
| ListarCertificados | aList | Lista os certificados digitais instalados na máquina quando é necessário selecionar um certificado digital para a configuração do componente. | Nome dos certificado digitais instalados na máquina. |
| ListarCertificados | aDelimitador | Lista os certificados digitais instalados na máquina quando é necessário selecionar um certificado digital para a configuração do componente. | Nome dos certificado digitais instalados na máquina. |
| ListarLogs | aList, aFilter, aCustomFilter | Lista todos os logs ou filtra de acordo com o filtro passado em aFilter. Utilizado para listar os logs do Componente. | Retorna os logs. |
| MontarEPEC | aIdLote, aXmlEnvio, aDHEvento aFusoHorario | Para montar o XML de envio do evento EPEC, utilize o método MontarEPEC. | O retorno será o XML de envio do evento EPEC, sem assinatura. Notas |
| MontarXmlCCe | aChaveNFe, aTextoCorrecao, aDataHoraEvento, aOrgao, aSequenciaEvento, aFusoHorario | Permite montar o XML de envio da CC-e. | Retorna o XML montado. Notas |
| GetVencimentoCertificadoDataHora | n/a | Captura o vencimento do certificado digital incluindo Data e Hora. | Este método retornará o vencimento do certificado digital contendo a Data e Hora. |
| ObterCodigoUF | aUF | Obter o código da UF | Código da UF. Notas |
| EditarModeloCCe | aXmlCCe | Personalizar a impressão da carta de correção - CCE | O método não possui retorno. |
| EditarModeloDanfe | aNumLote, aLoteNotas, aArquivoModelo | Para personalizar a impressão da DANFE, deve-se utilizar o método EditarModeloDanfe. Para utilizar o modelo alterado, é necessário salvar o arquivo com extensão .rtm e utilizá-lo no 3º parâmetro (aArquivoModelo) da chamada dos métodos de visualização e impressão. | O método não possui retorno. |
| PreverDanfe | aLoteNotas, aArquivoModelo | Pré visualizar a nota - DANFE | Este método não possuí retorno, apenas é exibida uma tela para visualização da nota. Notas |
| SaveConfig | aCaminhoArquivoIni | Salva as configurações do componente de acordo com o caminho informado no parâmetro aCaminhoArquivoIni. Útil para quando quiser verificar as propriedades do componente em determinado ponto do sistema. | Não possui retorno. |
| TestarEmailConfig | Para fazer um teste dos valores informados nas configurações de e-mail, deve-se utilizar o método TestarEmailConfig. | O método TestarEmailConfig possui como retorno uma String. Caso o retorno for vazio, significa que o envio do e-mail de teste foi realizado com sucesso, validando que as configurações informadas são válidas. Qualquer outro retorno textual, trata-se do erro ocorrido na tentativa de envio, seja configuração de e-mail faltante ou erros do próprio servidor de e-mail, erros de conexão de rede, entre outros. | |
| TratarXMLRetornoDFe | aXML, aDiretorio | Esse método recebe o XML de retorno da Consulta Distribuição DFe, faz o tratamento de cada XML compactado e os salva no diretório desejado. | O método retornará os XML's tratados no diretório passado ao método. |
| ValidarArquivoXmlDestinatario | aXml, aXML, aErrorList | Função utilizada para checar a integridade do XML Destinatário. Geralmente utilizada após a geração do XML Destinatário. | True para XML válido, False para XML com erros. Caso tenha erros, eles serão salvos no segundo argumento da assinatura do método: aErrorList |
| ValidarLoteParaEnvio | aNumLote, aLoteNotas | Valida Lote de Notas, realizando vários procedimentos, desde verificação de assinatura, até validação do xml de acordo com o esquema requerido para envio das notas. Pode ser utilizada antes de enviar uma nota. | Retorna os erros de validação. Notas |
| AuditarXml | aXml, aDelimitador, Servidor, aExibirRegra, aExibirHtml, | Validar o XML através do auditor fiscal | Retorna um tipo de validação dependendo das propriedades setadas. |
| ValidarTamanhoArquivoEnvio | aLoteNotas | Valida o Tamanho máximo do XML de Envio baseado na configuração da propriedade MaxSizeLoteEnvio. Utilizando antes de realizar o envio de uma nota. | Não possui retorno. |
| VisualizarDanfe | aNumLote, aLoteNotas, aArquivoModelo | Para exibir uma janela com a DANFE, à partir de uma NFe AUTORIZADA | O método não possuí retorno, apenas abre uma tela para visualização da Danfe. Notas |
| VisualizarCCe | aXmlCCe | Permite Prever como será impresso um DANFE. Quando autorizar uma CC-e e quiser verificar como ficará a impressão dela. | Não possui retorno. |
| VisualizarEPEC | aLoteNotas, aProtEPEC, aDataHoraEPEC, aArquivoModelo, aSerie | Método utilizado para gerar um PDF da DANFE em contingência EPEC Quando emitir uma NF-e em EPEC e precisar realizar a impressão dela. |
Não possui retorno. |
Exemplo
Aqui, podemos verificar exemplos de utilização do método EnviarNF em 3 linguagens diferentes. Apesar do exemplo ser específico do envio de nota, o formato pode ser utilizado em qualquer um dos métodos.
Delphi
retorno := spdNFe.EnviarNF('1','XML da Nota Assinada', False);
C#
retorno = spdNFe.EnviarNF("1", "XML da Nota Assinada", false);
Visual Basic 6
retorno = spdNFe.EnviarNF "1", "XML da Nota Assinada", false
Comentários
0 comentário
Por favor, entre para comentar.