Lista com todos os métodos do componente NFSe.
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 |
|---|---|---|---|
| Assinar | aXML, aParams | Gera assinatura digital para um lote XML. | Lote XML assinado pela rotina. |
| CancelarNota | aChave, aParams | Cancela uma NFSe por seu número | XML de confirmação de cancelamento, em caso de sucesso, ou XML da resposta do servidor. |
| LoadConfig | aConfigFile | Utilizado para carregar as configurações do componente, através de um arquivo .ini. | Não há |
| Comando | aNome | Este comando de obter o link da impressão da NFSe é utilizado para os padrões homologados conosco que não tem um XML de retorno da prefeitura imprimível para a geração de uma DANFSe | A função possui um retorno do tipo TspdCollectionItem, porém você pode utilizar ela apenas para setar os parâmetros do comando ObterLinkImpressaoNFSe que irá utilizar. Notas |
| 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á Notas |
| Configurar | aNomeConfig, aValorConfig | Utilizado para configurar o datasets de impressão, onde conseguimos incluir/alterar informações na impressão da NFS-e ou RPS. | Esse método não possui retorno, ele é utilizado apenas para configurar o datasets de impressão. Notas |
| ConfigurarCampos CustomizadosImpressao | aCamposCustomizados | Utilizado para configurar os campos customizados da impressão, após os datasets de impressão serem iniciados. | Esse método não possui retorno, ele é utilizado apenas para configurar os campos customizados da impressão, veja nos exemplos abaixo como vamos utilizá-lo. |
| ConsultarNFSePorRPS | aNumeroRPS, aSerieRPS, aTipoRPS, aParams | Consulta uma NFSe através dos dados do RPS. | XML da nota consultada, caso seja encontrada, ou XML da resposta do servidor. |
| ConsultarNotasTomadas | aNomeCidade, aDocumentoTomador, aIMTomador, aDocumentoPrestadorConsulente, aIMPrestadorConsulente, aDataInicial, aDataFinal, aPagina, aParams | Consulta todas as notas tomadas / Recebidas contra o tomador do serviço em um determinado período para uma cidade especifica. | XML das NFSe'S tomadas no período informado. Notas |
| ConsultarLote | aProtocolo, aParams | Consulta um lote de XML a partir de seu protocolo. | XML do lote de notas geradas pelo servidor NFSe ou lista de erros. |
| ConsultarNota | aNumeroNota, aParams | Consulta uma NFSe por seu número. | XML da NFS-e consultada, caso seja encontrada ou XML da resposta do servidor |
| ConverterEnvioNFSe | aTX2Envio, aParams | Gera um XML de envio de lote de RPS a partir de um arquivo TX2 no padrão de uma cidade específica ou no padrão TecnoNFSe. | Retorna o XML gerado ou o arquivo de remessa, dependendo da forma de integração do padrão da prefeitura. |
| ConverterRetConsultarLoteNFSeTipo | aXmlRetorno | Converte o XML de retorno do envio em um objeto. | Retorna um objeto da classe spdRetConsultaLoteNFSe, com ele serão feitos os tratamentos do retorno. |
| ConverterRetConsultarLote NFSeTomadasTipo | aXmlRetorno | Converte o XML de retorno do envio em um objeto. | Retorna um objeto da classe spdRetConsultaLoteNFSeTomadas, com ele serão feitos os tratamentos do retorno. |
| ConverterRetConsultarNFSeTipo | aXmlRetorno | Converte o XML de retorno do envio em um objeto. | Retorna um objeto da classe spdRetConsultaNFSe, com ele serão feitos os tratamentos do retorno. |
| ConverterRetConsultarNFSePorRpsTipo | aXmlRetorno | Converte o XML de retorno do envio em um objeto. | Retorna um objeto da classe spdRetConsultaNFSe, com ele serão feitos os tratamentos do retorno. |
| ConverterRetCancelarNFSeTipo | aXmlRetorno | Converte o XML de retorno do envio em um objeto. | Retorna um objeto da classe spdRetCancelaNFSe, com ele serão feitos os tratamentos do retorno. |
| ConverterRetEnvioNFSeTipo | aXmlRetorno | Converte o XML de retorno do envio em um objeto. | Retorna um objeto da classe spdRetEnvioNFSe, com ele serão feitos os tratamentos do retorno. |
| ConverterRetEnvioSincronoNFSeTipo | aXmlRetorno | Converte o XML de retorno do envio em um objeto. | Retorna um objeto da classe spdRetEnvioSincronoNFSe, com ele serão feitos os tratamentos do retorno. |
| CriarDatasets | aXml, aLogEnvioRps | Utilizado para iniciar o datasets de impressão, antes de atribuirmos os valores para os campos customizados. | Esse método não possui retorno, ele é utilizado apenas para iniciar o datasets de impressão, veja nos exemplos abaixo como vamos utilizá-lo. |
| EditarDocumento | aXml, aArquivoRtm | 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, veja nos exemplos abaixo como vamos utilizá-lo. |
| Enviar | aXML, aParams | Envia um lote XML para o servidor de forma assíncrona. | Número do protocolo em caso de sucesso, já em caso de falha: caminho_para_o_arquivo_de_log.xml |
| EnviarSincrono | aXML, aParams | Envia um lote XML para o servidor, através do modo síncrono. Notas | Lote XML em caso de sucesso, já em caso de falha: caminho_para_o_arquivo_de_log.xml |
| Comando | aNome | Utilizado para executar comandos avançados para um determinado município. | A função possui um retorno do tipo TspdCollectionItem, porém você pode utilizar ela apenas para setar os parâmetros do comando X que irá utilizar, veja os exemplos abaixo. |
| ExportarDocumentoParaPDF | aXml, aArquivoRtm, aPdfFileName, aFormatExportacao | Através desse método é possível exportar um xml de NFS-e ou RPS para PDF. | Esse método não possui retorno, ele é utilizado apenas para realizar a exportação. |
| GerarXMLPorTX2 | aArquivoTX2, aParams | Realiza a conversão do TX2 em XML. Este método funciona apenas para o TX2 padrão do município, utilize a conversão do TX2 pelo componente Converter para o padrão único e do município. | Lote XML gerado pela rotina a partir do arquivo .tx2 Notas |
| ImprimirDocumento | aXml, aArquivoRtm, aNomeImpressora | Através desse método é possível imprimir uma NFS-e ou RPS. | Esse método não possui retorno, ele é utilizado apenas para realizar a impressão. Notas |
| ListarParametros | Utilizado para listar todos os parâmetros aceitos pelo comando na cidade. | Todos os parâmetros que o comando utiliza | |
| SaveConfig | aConfigFile | Utilizado para criar um arquivo .ini com os valores das propriedades do componente. | não há. |
| aXml, aArquivoRtm | 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, veja nos exemplos abaixo como vamos utilizá-lo. |
Exemplos
Aqui, podemos verificar exemplos de utilização do método ConsultarNotasTomadas em 4 linguagens diferentes. Apesar do exemplo ser específico, o formato pode ser utilizado em qualquer um dos métodos propostos.
Delphi
retorno :=
ProxyNFSe.ConsultarNotasTomadas('NomeDaCidade',
'Documento do tomador', 'Inscrição Municipal do Tomador',
'Documento do prestador ou Consulente', 'Inscrição municipal do Prestador ou Consulente',
'Data inicial das emissão das notas', 'Data final da emissão das notas',
'Número da pagina para trazer os registros',
'Parâmetros extras, exemplo: Login=xxxxxx,Senha=xxxxxxx');
C#
retorno =
ProxyNFSe.ConsultarNotasTomadas("NomeDaCidade", "Documento do tomador",
"Inscrição Municipal do Tomador", "Documento do prestador ou Consulente",
"Inscrição municipal do Prestador ou Consulente", "Data inicial das emissão das notas",
"Data final da emissão das notas", "Número da pagina para trazer os registros",
"Parâmetros extras, exemplo: Login=xxxxxx,Senha=xxxxxxx");
Visual Basic 6
retorno =
ProxyNFSe.ConsultarNotasTomadas "NomeDaCidade", "Documento do tomador",
"Inscrição Municipal do Tomador", "Documento do prestador ou Consulente",
"Inscrição municipal do Prestador ou Consulente", "Data inicial das emissão das notas",
"Data final da emissão das notas", "Número da pagina para trazer os registros",
"Parâmetros extras, exemplo: Login=xxxxxx,Senha=xxxxxxx"
PHP
$retorno = $ProxyNFSe->ConsultarNotasTomadas("NomeDaCidade", "Documento do tomador",
"Inscrição Municipal do Tomador", "Documento do prestador ou Consulente",
"Inscrição municipal do Prestador ou Consulente", "Data inicial das emissão das notas",
"Data final da emissão das notas", "Número da pagina para trazer os registros",
"Parâmetros extras, exemplo: Login=xxxxxx,Senha=xxxxxxx");
Comentários
0 comentário
Por favor, entre para comentar.