Lista com todos os métodos do componente NFCe.
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 | 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 |
| AssinarEPEC | xml | Para realizar a assinatura de um arquivo XML em EPEC | 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 |
| CalculaChaveNFCe | aDtEmissao; aUF; aCNPJ; aModelo; aSerie; aNRNota; aCodSistema; tpEmis | Para recalcular a chave de uma NFCe. Ao passar os parâmetros necessários, ele vai calcular o dígito verificador da chave. | O retorno do método é a chave da nota. |
| CalculaChaveInutilizacao | aAno, aCNPJCPF, aModelo, aSerie, aNFIni, aNFFin | Para gerar uma chave de uma nota/faixa de notas inutilizadas; | Chave de inutilização da nota/faixa de notas inutilizada. |
| CancelarNF | aNotaID, aNumProtocolo, aJustificativa, aDataHoraEvento, aSequenciaEvento, aFusoHorario, aIdLote | Para realizar o cancelamento de uma NFCe que já tenha sido autorizada pela Sefaz, utilize o método CancelarNFCeEvento. | Este método retornará o conteúdo de um XML, onde será possível verificar se o cancelamento foi autorizado ou rejeitado. Notas |
| CancelarNFSubstituicao | aNotaID, aNumProtocolo, aJustificativa, aDataHoraEvento, aSequenciaEvento aFusoHorario, aOrgaoAutor, aVersaoAplicativo, aNotaIDReferenciada; aTipoAutor, aIdLote | Para realizar o cancelamento de uma NFCe emitida em duplicidade | Este método retornará o conteúdo de um XML, onde será possível verificar se o cancelamento foi autorizado ou rejeitado. Nota 1 Nota 2 |
| ConfigurarSoftwareHouse | aCNPJSoftwareHouse, aKey | Para que possa utilizar nosso componente, é necessário que configure o CNPJ da software house | O método ConfigurarSoftwareHouse não possui retorno. Notas |
| ConsultarNF | aNotaID | Para obter a situação de uma nota a partir de sua chave, utilize o método ConsultarNF. | Este método retornará o conteúdo de um XML com a informação se a nota está AUTORIZADA, CANCELADA ou se não consta na Sefaz. Notas |
| ConsultarRecibo | aNumRecibo | Para obter a situação de uma nota a partir de seu recibo, utilize o método ConsultarRecibo. | Este método retornará o conteúdo de um XML com o resultado do processamento da nota. Notas |
| StatusDoServico | Para verificar a situação do WebService da Sefaz | Este método retornará o conteúdo de um XML com a mensagem de serviço em operação, em caso de sucesso. 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 "TspdNFCeDataSets", populado com os dados do XML. |
| EnviarNF | aNumLote, aLoteNotas, aCompactado | Para realizar o envio de uma NFCe de maneira assíncrona. | Este método retornará o conteúdo de um XML contendo o resultado do envio e número do recibo para consulta. Notas |
|
EnviarNotaCancelada Destinatario
|
aIDNFCe, aLogPedCanc, aLogRetCanc, aEmailDestinatario | Para envio do XML destinatário de cancelamento por email | Este método não possui retorno. |
| EnviarNotaDestinatario | aIDNFCe, aLogEnvio, aLogRecibo | Para envio do XML Destinatário por email. | Este método não possui retorno. Notas |
| EnviarNotaDestinatario Anexos |
aArquivoPDF, aArquivoXML, aOutros | Para realizar o envio do XML destinatário, danfce e outros anexos por email. | Este método não possui retorno. |
| EnviarNFSincrono | aNumLote, aXmlNota, aCompactado | Para realizar o envio de uma NFCe em modo síncrono. | Este método retornará o conteúdo de um XML com o resultado do processamento da nota. Notas |
| ExportarDanfce | aNumLote, aLoteNotas, aArquivoModelo, aFormato, aExportarParaArquivo | Para exportação da DANFCe em formato HTML, PDF ou TXT | Este método não possuí retorno, salva o arquivo diretamente no local especificado no parametro aExportarParaArquivo. |
| ExportarEPEC | aLoteNotas, aProtEPEC, aDataHoraEPEC, aArquivoModelo, aFormato, aExportarParaArquivo | Para exportar uma DANFCe emitida em modo EPEC, em formato HTML, PDF ou TXT, utilize o método ExportarDanfce. | Este método não possuí retorno, salva o arquivo diretamente no local especificado no parametro aExportarParaArquivo. |
| ConverterLoteParaXml | ArquivoLoteTxt, aLayoutConv , aVersaoEsquema | Para converter um arquivo TX2 para XML | Este método retornará o conteúdo de um XML com as mesmas informações que foram informadas no TX2. |
| GerarXMLEnvioDestinatario | aIdNFCe, aLogEnvLote, aLogConsReciboOuChave, aSalvarComo | Para geração manual do XML Destinatário de NFCe | Este método retornará uma string, contendo o XML Destinatário da NFCe. Notas |
| GerarXMLCancelamento Destinatario |
aIDNFCe, aContentLogPedCanc, aContentLogRetCanc, aSalvarComo | Para geração manual do XML Destinatário de cancelamento da NFCe | Este método retornará uma string, contendo o XML Destinatário de cancelamento da NFCe. |
| GerarXMLEventoDestinatario | aIDEvento, aLogEvento, aLogRetEvento, aSalvarComo | Para geração manual dos XML's de eventos | Este método retornará uma string, contendo o XML Destinatário do evento. |
| ImprimirDanfce | aNumLote, aLoteNotas, aArquivoModelo, aImpressora | Para realizar a impressão de uma DANFCe diretamente na impressora | Este método não possuí retorno. Realiza a impressão da DANFCE diretamente na impressora. |
| ImprimirEPEC | aLoteNotas, aProtEPEC, aDataHoraEPEC, aArquivoModelo, aImpressora | Para realizar a impressão de uma DANFCe emitida em EPEC, diretamente na impressora | Este método não possuí retorno. Realiza a impressão da DANFCE diretamente na impressora. |
| ImprimirDanfce (Nota cancelada) | aNumLote, aLoteNotas, aArquivoModelo, aImpressora | Para realizar a impressão de uma nota cancelada é necessário passar no parâmetro aLoteNotas, o XML destinatário de autorização e também o XML destinatário de cancelamento. Depois de concatenar os dois, basta passar esse XML concatenado para o método ImprimirDanfce Notas aLoteNotas | |
| InutilizarNF | aNotaID, aAno, aCNPJ, aModelo, aSerie, aNFIni, aNFFin, aJustificativa | Para evitar buracos em sua faixa de numeração | Este método retornará o conteúdo de um XML, com a resposta de inutilização. Notas |
| ListarCertificados | aList OU aDelimiter | Para listar os nomes dos certificados instalados na máquina, em Delphi, utilize o ListarCertificados(aList), para as demais linguagens utilize ListarCertificados(aDelimiter). | Em delphi, retorna em um StringList, o nome de todos os certificados digitais instalados na máquina. Nas demais linguagens, retorna uma String, separada por um delimitador, o nome de todos os certificados digitais instalados na máquina. |
| GetLinkQRCode | aXML | Para geração manual da url do qrcode | Este método retornará uma string com a URL do qrcode. |
| GetVencimentoCertificado | Para obter a data de vencimento do certificado setado na propriedade NomeCertificado | Este método retornará a data de vencimento do certificado. Notas | |
| EditarModeloDanfce | aNumLote; aLoteNotas; aArquivoModelo | Para personalizar o modelo de impressão da DANFCe | Este método não possuí retorno, abre o report builder, para edição do modelo de RTM. Notas |
| PreverDanfce | aLoteNotas, aArquivoModelo | Para pré visualizar uma nota antes de enviar a Sefaz, utilize o método PreverDanfce. | Este método não possuí retorno, apenas é exibida uma tela para visualização da nota. |
| RemoverCertificado | CertificateName | Utilize este método para remover um certificado vencido do repositório do windows. | Retorna se foi removido (True) ou não (False). Notas |
| VisualizarDanfce | aNumLote, aLoteNotas, aArquivoModelo | Para exibir uma janela com a DANFCE, à partir de uma NFCe AUTORIZADA | O método não possuí retorno, apenas abre uma tela para visualização da Danfce. Notas |
| VisualizarEPEC | aLoteNotas, aProtEPEC, aDataHoraEPEC, aArquivoModelo | Para visualizar uma NFCe AUTORIZADA em modo EPEC | O método não possuí retorno, apenas abre uma tela para visualização da Danfce. 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. |
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 := spdNFCe.EnviarNF('1','XML da Nota Assinada', False);
C#
retorno = spdNFCe.EnviarNF("1", "XML da Nota Assinada", false);
Visual Basic 6
retorno = spdNFCe.EnviarNF "1", "XML da Nota Assinada", false
Comentários
0 comentário
Por favor, entre para comentar.