Lista de Métodos - Componente NFS-e Nacional – Central de Atendimento

Lista com todos os métodos do componente NFSe Nacional.

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
LoadConfig	aConfigFile	Utilizado para carregar as configurações do componente, através de um arquivo .ini.	Não há
ConfigurarSoftwareHouse	aCNPJSoftwareHouse, aKey	Para que possa utilizar nosso componente, é necessário que configure o CNPJ da software house, através do método ConfigurarSoftwareHouse.	Não há
CancelarNFSe	aChaveAcesso	Cancela uma NFSe pela Chave de Acesso da Nota	XML de confirmação de cancelamento, em caso de sucesso, ou XML da resposta do servidor.
ConsultarNFSe	aChaveAcesso	Consulta uma NFSe pela Chave de Acesso da Nota	XML da NFS-e consultada, caso seja encontrada ou XML da resposta do servidor
ConsultarEventosNFSe	aChaveAcesso	Consulta uma NFSe e seus respectivos eventos vinculados pela Chave de Acesso da Nota	Retorna o XML gerado ou o arquivo de remessa, dependendo da forma de integração do padrão da prefeitura.
ConsultarEventoNFSe	aChaveAcesso, aTipoEvento, aSequenciaEvento	Consulta uma NFSe e seus respectivos eventos filtrados por tipo de evento vinculados pela Chave de Acesso da Nota	Retorna o XML gerado ou o arquivo de remessa, dependendo da forma de integração do padrão da prefeitura.
ConsultarDistribuicaoDFe	aTipoConsultaDFe, aChaveOrNsu	Consulta a Distribuição DFe por Chave, NSU ou Lote NSU	Retorna o XML da Distribuição DFe de acordo com os parâmetros informados.
DescompactarXmlZip	aXmlZip	Transforma um XML zipado em XML normal.	Retorna um XML normal,Usado por exemplo para descompactar o conteudo do campo ArquivoXml retornado na ConsultarDistribuicaoDFe.
EditarDocumento	aXmlNFSe, aArquivoRps, aCamposCustomizados	Através desse método é possível editar o modelo de impressão.	Esse método não possui retorno, ele é utilizado apenas para iniciar o datasets de impressão e abrir o editor de layout.
Enviar	aTx2	Envia um lote XML para o servidor de forma síncrona.	XML Autorizado no WebService ou XML de rejeição com o motivo descrito.
EnviarManifestacao	aTipoManifestacao, aChaveAcesso, aCodigoMotivo, aDescricaoMotivo	Envia um tipo de manifestação para determinada Nota através da Chave Acesso.	XML com retorno de sucesso ou XML com retorno de rejeição na manifestação.
ExportarDocumentoParaPDF	aXml, aXmlRPS, aCamposCustomizados, aDiretorioDestinoPDF	Através desse método é possível exportar um PDF de NFS-e ou DPS.	Esse método não possui retorno, ele é utilizado apenas para realizar a exportação.
ImprimirDocumento	aXml, aXmlRPS, aCamposCustomizados, aNomeImpressora	Através desse método é possível imprimir uma NFS-e ou DPS.	Esse método não possui retorno, ele é utilizado apenas para realizar a impressão de Notas
SaveConfig	aConfigFile	Utilizado para criar um arquivo .ini com os valores das propriedades do componente.	Não há
TratarRetornoConsultaDFe	aRetornoConsultaDFe, aDiretorioDestino	Trata o xml ou json retornado na Distribuição DFe, salvando cada documento com seu respectivo xml na pasta informada.	Esse método não possui retorno, porém preenche as propriedades RetornoCSV, RetornoJson e RetornoWS
VisualizarDocumento	aXml, aXmlRPS, aCamposCustomizados	Através desse método é possível editar o modelo de impressão.	Esse método não possui retorno, ele é utilizado apenas para iniciar o datasets de impressão e visualizar o layout.

Exemplos

Aqui, podemos verificar exemplos de utilização do método ConsultarNFSe em 4 linguagens diferentes. Apesar do exemplo ser específico, o formato pode ser utilizado em qualquer um dos métodos propostos.

Delphi

retorno := NFSe.ConsultarNFSe('ChaveAcessoNFSe');

C#

retorno = NFSe.ConsultarNFSe("ChaveAcessoNFSe");

Visual Basic 6

retorno = NFSe.ConsultarNFSe "ChaveAcessoNFSe"

PHP

$retorno = $NFSe->ConsultarNFSe("ChaveAcessoNFSe");

Exemplos

Delphi

C#

Visual Basic 6

PHP

Artigos relacionados