Lista de Métodos - Componente NFCom – Central de Atendimento

O Componente NFCom da Tecnospeed é uma biblioteca contendo todos os métodos necessários para emitir a Nota Fiscal de Serviço de Comunicação. É a escolha ideal para quem pode consumir OCX e prefere manter todo o processo de mensageria do NFCom dentro do próprio ambiente. Para utilizar o Componente em seu software, basta instanciá-lo em seu projeto, implementar chamadas para cada um dos métodos e configurá-los de acordo com sua necessidade.

Com isso reunido, você poderá seguir este passo a passo detalhado:

Lista com todos os métodos do componente NFCom.

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
Configurar Software House	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.
AtualizarVersao	aVersao, aOpcoes	Esse método serve para realizar o download e a instalação da atualização do componente no ambiente do cliente final, facilitando assim a atualização da Software House.	O método AtualizarVersao retorna true quando é encontrado a versão solicitada e false quando não encontra a versão solicitada.
Prever Impressão	aXML, aArquivoRtm	Método utilizado para previsão do DANFECom antes da autorização do NFCom.	Não possui retorno.
Testar Email	Não possui parâmetros.	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.
GerarXmlDestinatario	aChaveNFCom, aLogEnvio, aLogConsulta, 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 NFCom.
VisualizarNFCom	aXmlNFCom, aArquivoModelo	Método utilizado para Visualizar a impressão da NFCom.	Não possui retorno.
ExportarNFCOM	aXMLDestinatario, aArquivoRtm, aFormato, aExportarParaArquivo	Método utilizado para exportação do DANFCOM em um arquivo no formato PDF.	Não possui retorno.
SalvarConfig	aConfigFile	Salva configurações do componente em um arquivo .ini. Quando precisar salvar as configurações antes de ocorrer um erro, de modo que facilite a verificação das propriedades configuradas no momento do erro.	Não possui retorno.
LoadConfig	aConfigFile	Carrega configurações do componente a partir de um arquivo .ini presente na pasta do executável. De preferência quando iniciar seu projeto, de modo que as configurações do componente já sejam feitas.	Não possui retorno.
ConverterTx2Xml	aTx2	Método responsável pela geração do XML de envio da NFCom, a partir do caminho do Tx2.	O retorno é o XML de envio do NFCom.
ConverterJSONXml	aJsonFile	Método responsável pela geração do XML de envio da nfcom, a partir do caminho do Json.	O retorno é o XML de envio do nfcom.
ConverterJsonTx2	aJsonFile	Método utilizado para converter um arquivo Json para Tx2.	Esse método retorna o recebimento da GUIA.
Assinar	aXmlNFCom	Gera assinatura de cada NFCom dentro do arquivo XML. Usado sempre antes de enviar um nfcom.	O retorno do método é o Xml do NFCom assinado.
EnviarSincrono	aXmlNFCom	Função para Enviar NFCom's assinados ao WebService da SEFAZ de modo síncrono, ou seja, tem o retorno da SEFAZ no próprio envio do manifesto, não sendo necessário fazer uma consulta de chave ou recibo após o envio.	Xml contendo mensagem do resultado da solicitação.
CancelarNFcom	aNotaID, aNumProtocolo, aJustificativa, aDataHoraEvento, aSequenciaEvento, aFusoHorario	Este método retornará o conteúdo de um XML, onde será possível verificar se o cancelamento foi autorizado ou rejeitado.	Este método retornará o conteúdo de um XML, onde será possível verificar se o cancelamento foi autorizado ou rejeitado.
ObterCodigoUF	aUF	Retorna o código da UF.	Código da UF.
EnviarEmailXmlNFCom	aArquivoXML, aOutros, aEmailDestinatario	Envia email com o xml e anexos informados ao destinatário.	Não possui retorno.
EnviarEmailXMLDestinatarioNFCom ou EnviarEmailXmlNFCom	aChave, aTipoOperacao, aLogEnvio, aLogRetorno, aOutros, aEmailDestinatario	Envia email com o xml montado a partir dos logs da operação informada e da chave informada.	Não possui retorno.
GerarXmlEventoDestinatario	aChaveNFCom, aTipoEvento, aLogEnv, aLogRet	Gerar XML de evento destinatario no Padrão da SEFAZ para ser armazenado.	XML Padrão de XML Destinatario.
EditarModeloDanfe	aXML, aArquivoRtm	Permite editar o modelo para impressão do DANFECom.	Não possui retorno.
ListarCertificados	aList	Método que lista os certificados instalados.	Não possui retorno.
ConsultarCadastro	aDocumento, aTpDocumento, aUF	Função para consultar cadastro do Contribuinte ICMS.	Retorna XML contendo mensagem do resultado da solicitação (Dados do Contribuinte).
ValidarLoteParaEnvio	aXmlLote	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.	Não possui retorno.

Artigos relacionados