A Linguagem Clarion utiliza das libs de nossos componentes para realizar a chamada dos métodos.
Abaixo a lista de métodos para utilização da LIB em Clarion.

AssinarNota

Para realizar a assinatura de um arquivo XML, utilizando um certificado digital, utilize o método AssinarNota.

AssinarNota(aXML : PWideChar; aConfigFilePath : PChar; tpEmis : Integer)

Parâmetros

Argumento	Tipo	Detalhes
aXML	String	Arquivo XML gerado a partir do método ConverterLoteParaXml
aConfigFilePath	String	Diretório do arquivo .ini
tpEmiss	Integer	1 - Normal / 2 - Scan

 

 

ConverterLoteParaXml

Função que converte um Lote de NFes no formato TX2 ou REC para XML.

ConverterLoteParaXml(ArquivoLoteTxt : PChar;aConfigFilePath : PChar; aTipoConversao : Integer; aVersaoEsquema : PChar) 

Parâmetros

Argumento	Tipo	Detalhes
ArquivoLoteTxt	String	Arquivo TX2
aConfigFilePath	String	Diretório do arquivo .ini
aTipoConversao	Integer	1 - TX2 / 2 - REC

 

 

StatusDoServico

Para verificar se o Webservice está funcionando corretamente, deve-se utilizar o método StatusDoServico.

StatusDoServico(aConfigFilePath : PChar; tpEmis : Integer) :

Parâmetros

Argumento	Tipo	Detalhes
aConfigFilePath	String	Diretório do arquivo .ini
tpEmis	Integer	1 - Normal / 2 - Scan

 

 

CancelarNF

Para enviar uma solicitação de cancelamento de uma NFe, utilize o método CancelaNF.

CancelarNF(aNotaID, aNumProtocolo, aJustificativa : PChar;aConfigFilePath : PChar; tpEmis : Integer)

 

Parâmetros

Argumento	Tipo	Detalhes
aNotaID	String	Chave de Identificação da NF
aNumProtocolo	Integer	Número do Protocolo de registro da NF, que deve conter exatamente 15 dígitos
aJustificativa	String	Texto (mínimo 15 dígitos) para descrição do Motivo de cancelamento da NF
aConfigFilePath	String	Diretório do arquivo .ini
tpEmis	Integer	1 - Normal / 2 - Scan

 

 

ConsultarNF

Para consultar determinada chave no servidor da SEFAZ, deve-se utilizar o método ConsultarNF.

ConsultarNF(aNotaID : PChar;aConfigFilePath : PChar; tpEmis : Integer)

 

Parâmetros

Argumento	Tipo	Detalhes
aNotaID	String	Chave de Identificação da NF
tpEmis	Integer	1 - Normal / 2 - Scan

 

 

InutilizarNF

Função que solicita a Inutilização de Numeração. Utilizado para corrigir uma numeração que foi pulada.

InutilizarNF(aNotaID, aAno, aCNPJ ,aModelo : PChar; aSerie : PChar; aNFIni , aNFFin , aJustificativa ,aConfigFilePath : PChar; tpEmis : Integer)

 

Parâmetros

Argumento	Tipo	Detalhes
aNotaID	String	Chave de Identificação da NF
aAno	Integer	Número do Protocolo de registro da NF, que deve conter exatamente 15 dígitos
aCNPJ	String	CNPJ ou CPF do emitente.
aModelo	String	Modelo da NF-e.
aSerie	Integer	Série da NF-e.
aNFIni	String	Número da NF-e inicial a ser inutilizada.
aNFFin	String	Número da NF-e final a ser inutilizada.
aJustificativa	String	Justificativa para a Inutilização da Faixa de Notas (Mínimo 15 caracteres).
aConfigFilePath	String	Diretório do arquivo .ini
tpEmis	Integer	1 - Normal / 2 - Scan

 

 

EnviarNF

Para realizar o envio de uma NFe de maneira assíncrona, utilize o método EnviarNF.

EnviarNF(aNumLote : PChar; aLoteNotas : PWideChar; aCompactado : Boolean; aConfigFilePath : PChar; tpEmis : Integer)

 

Parâmetros

Argumento	Tipo	Detalhes
aNumLote	String	Número de Identificação do Lote a ser enviado
aLoteNotas	Integer	XML da NF-e Assinada
aCompactado	Boolean	ara enviar um lote compactado para SEFAZ (Opcional).
aConfigFilePath	String	Diretório do arquivo .ini
tpEmis	Integer	1 - Normal / 2 - Scan

 

 

EnviarNFSincrono

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.

EnviarNFSincrono(aNumLote : PChar; aLoteNotas : PWideChar; aCompactado : Boolean; aConfigFilePath : PChar; tpEmis : Integer)

 

Parâmetros

Argumento	Tipo	Detalhes
aNumLote	String	Número de Identificação do Lote a ser enviado.
aLoteNotas	Integer	XML da NF-e Assinada e encapsulada no Lote.
aCompactado	Boolean	Para enviar um lote compactado para SEFAZ (Opcional).
aConfigFilePath	String	Diretório do arquivo .ini
tpEmis	Integer	1 - Normal / 2 - Scan

 

ConsultarRecibo

Para obter a situação de uma nota a partir de seu recibo, utilize o método ConsultarRecibo.

ConsultarRecibo(aNumRecibo : PChar;aConfigFilePath : PChar; tpEmis : Integer)

 

Parâmetros

Argumento	Tipo	Detalhes
aNumRecibo	String	Um número de 15 dígitos que é retornado pela função EnviarNF
aConfigFilePath	Integer	Diretório do arquivo .ini
tpEmis	Integer	1 - Normal / 2 - Scan

 

 

ConsultarCadastro

Para consultar o cadastro do Contribuinte ICMS, utilize o método ConsultarCadastro.

ConsultarCadastro(aDocumento : PChar; aTpDocumento : PChar; aUF : PChar; aConfigFilePath : PChar; tpEmis : Integer) 

Parâmetros

Argumento	Tipo	Detalhes
aDocumento	String	Número do documento a ser consultado
aTpDocumento	String	Tipo do documento que será consultado (CNPJ, IE, CPF)
aUF	String	UF do documento que está sendo consultado
aConfigFilePath	String	Diretório do arquivo .ini
tpEmis	Integer	1 - Normal / 2 - Scan

 

 

VisualizarDanfe

Para exibir uma janela com a DANFE, à partir de uma NFe AUTORIZADA

VisualizarDanfe(aNumLote : PChar;aLoteNotas : PWideChar; aArquivoModelo : PChar; aConfigFilePath : PChar)

Parâmetros

Argumento	Tipo	Detalhes
aNumLote	String	Número de Identificação do Lote de notas a ser visualizado
aLoteNotas	String	XML válido contendo Notas Fiscais eletrônicas (NFe)
aArquivoModelo	String	Caminho para arquivo de modelo do DANFE (extensão .RTM)
aConfigFilePath	String	Diretório do arquivo .ini

 

 

ImprimirDanfe

Para imprimir a nota diretamente na impressora, utilize o método ImprimirDanfe.

ImprimirDanfe(aNumLote : PChar;aLoteNotas : PWideChar; aArquivoModelo : PChar; aConfigFilePath : PChar; aImpressora : PChar )

Parâmetros

Argumento	Tipo	Detalhes
aNumLote	String	Número de Identificação do Lote de notas a ser visualizado
aLoteNotas	String	XML válido contendo Notas Fiscais eletrônicas (NFe)
aArquivoModelo	String	Caminho para arquivo de modelo do DANFE (extensão .RTM)
aConfigFilePath	String	Diretório do arquivo .ini
aImpressora	String	Nome da impressora que será utilizada para imprimir, caso seja passado vazio, será utilizada a impressora padrão do Windows

 

 

EditarModeloDanfe

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.

EditarModeloDanfe(aNumLote : PChar;aLoteNotas : PWideChar; aArquivoModelo : PChar; aConfigFilePath : PChar)

Parâmetros

Argumento	Tipo	Detalhes
aNumLote	String	Número de Identificação do Lote de Notas a ser impresso
aLoteNotas	String	XML válido contendo Notas Fiscais eletrônicas. Em caso de emissão em FS passar somente o XMLAssinado, caso contrário passar o XML Destinatário, pois contém os dados de Autorização da spdNFe
aArquivoModelo	String	Caminho para arquivo de modelo do DANFE (extensão .rtm). Caso seja deixado em branco, será utilizado o modelo padrão, localizado no diretório de Templates, subdiretório Danfe
aConfigFilePath	String	Diretório do arquivo .ini

 

 

ObterCertificados

Para obter os certificados instalados na maquina, utilize o método obterCertificados.

ObterCertificados(aConfigFilePath : PChar)

 

Parâmetros

Argumento	Tipo	Detalhes
aConfigFilePath	String	Diretório do arquivo .ini

 

 

---

RemoverCertificado

Para remover um certificado instalado na máquina, utilize o método removerCertificado.

RemoverCertificado(CertificateName : PCHAR) 

Parâmetros

Argumento	Tipo	Detalhes
CertificateName	String	Certificado a ser removido.

 

 

---

ExportarDanfe

Este método permite exportar um DANFE autorizado para os formatos PDF e JPG.

ExportarDanfe(aNumLote : PChar;aLoteNotas: PWideChar;aArquivoModelo : PChar; aFormato : Integer;aConfigFilePath : PChar)

Parâmetros

Argumento	Tipo	Detalhes
aNumLote	String	Número de Identificação do Lote de notas a ser visualizado
aLoteNotas	String	XML válido contendo Notas Fiscais eletrônicas (NFe)
aArquivoModelo	String	Caminho para arquivo de modelo do DANFE (extensão .RTM)
aFormato	Integer	Valor correspondente ao formato desejado (1=PDF ou 2=JPG). O valor padrão é 1.
aConfigFilePath	String	Diretório do arquivo .ini

 

 

EmailDanfe

Para enviar uma DANFE por e-mail, deve-se utilizar o método EmailDanfe.

EmailDanfe(aNumLote : PChar;aLoteNotas: PWideChar;aArquivoModelo : PChar;aConfigFilePath : PChar)

Parâmetros

Argumento	Tipo	Detalhes
aNumLote	String	Número de Identificação do Lote de Notas a ser impresso
aLoteNotas	String	XML válido contendo Notas Fiscais eletrônicas. Em caso de emissão em FS passar somente o XMLAssinado, caso contrário passar o XML Destinatário, pois contém os dados de Autorização da spdNFe
aArquivoModelo	String	Caminho para arquivo de modelo do DANFE (extensão .rtm). Caso seja deixado em branco, será utilizado o modelo padrão, localizado no diretório de Templates, subdiretório Danfe
aConfigFilePath	String	Diretório do arquivo .ini

 

 

RemoverAcentos

Para remover acentos, utilize o método removerAcentos.

RemoverAcentos(txt: PWideChar):

 

Parâmetros

Argumento	Tipo	Detalhes
txt	String	Arquivo o qual será removido os acentos.

 

 

EnviarNotaDestinatario

Para envio do XML Destinatário por email, utilize o método EnviarNotaDestinatario

EnviarNotaDestinatario (aIDNFe : PChar; aLogEnvio : PChar; aLogRecibo : PChar; aConfigFilePath : PChar)

 

Parâmetros

Argumento	Tipo	Detalhes
aIDNFe	String	Chave da NFe
aLogEnvio	String	Parâmetro opcional, deve ser informado o caminho do log de envio
aLogRecibo	String	Parâmetro opcional, deve ser informado o caminho do log de resposta da consulta ou recibo
aConfigFilePath	String	Diretório do arquivo .ini

 

 

ExportarPreverDanfe

Para exportar a pré visualização de uma nota antes de enviar a Sefaz, utilize o método PreverDanfe.

ExportarPreverDanfe (const aLoteNotas: PWideChar; aArquivoModelo : PWideChar; aLocalNomeArquivo : PWideChar; aConfigFilePath : PChar)

Parâmetros

Argumento	Tipo	Detalhes
aLoteNotas	String	XML de notas assinado
aArquivoModelo	String	Caminho para arquivo de modelo do DANFE (extensão .RTM)
aLocalNomeArquivo	String	Local onde será salvo o arquivo .PDF
aConfigFilePath	String	Diretório do arquivo .ini

 

 

---

ImprimirDanfeXmlDiretorio

Este método permite realizar a impressão do DANFE de XML's autorizados, que estão em um determinado diretório.

ImprimirDanfeXmlDiretorio(const aDiretorioXml: PChar; aArquivoModelo : PChar; const aExportarArquivoPara: PChar; const aImpressora : PChar; aConfigFilePath : PChar)

Parâmetros

Argumento	Tipo	Detalhes
aDiretorioXml	String	Caminho do diretório que contém os XML's autorizados que serão impressos.
aArquivoModelo	String	Caminho para o arquivo de modelo do DANFE extensão RTM), se deixar em branco será utilizado o modelo padrão, localizado no diretório de Templates, subdiretório Danfe.
aExportarArquivoPara	String	Exporta os arquivos em formato .pdf para o local indicado neste parâmetro.
aImpressora	String	Nome da impressora, se deixar em branco será utilizada a impressora padrão do Windows.
aConfigFilePath	String	Diretório do arquivo .ini

 

 

ValidarLoteParaEnvio

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.

ValidarLoteParaEnvio(const aNumLote : PWideChar; aLoteNotas : PWideChar; aConfigFilePath: PWideChar )

Parâmetros

Argumento	Tipo	Detalhes
aNumLote	String	Número do lote de notas, para montagem do xml.
aLoteNotas	String	Lote de Notas a ser avaliado.
aConfigFilePath	String	Diretório do arquivo .ini

 

ValidarTamanhoArquivoEnvio

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.

ValidarTamanhoArquivoEnvio (aLoteNotas : PWideChar; aConfigFilePath : PWideChar )

Parâmetros

Argumento	Tipo	Detalhes
aLoteNotas	String	Lote de Notas a ser avaliado.
aConfigFilePath	String	Diretório do arquivo .ini

 

 

ConverteXmlparaDataSet

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.

ConverteXmlparaDataSet(const aXml: PWideChar; aVersaoEsquema : TVersaoEsquema; aConfigFilePath : PChar)

Parâmetros

Argumento	Tipo	Detalhes
aXml	String	Conteúdo de um XML NF-e válido
aVersaoEsquema	TVersaoEsquema	Versão de esquema a ser utilizada para conversão do XML
aConfigFilePath	String	Diretório do arquivo .ini

 

 

GerarXMLManifestoDestinatario

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.

GerarXMLManifestoDestinatario(aIDEvento: PWideChar; const aLogEvento,aLogRetEvento: PWideChar; aSalvarComo: PWideChar; aConfigFilePath : PChar)

Parâmetros

Argumento	Tipo	Detalhes
aIDEvento	String	Chave da Manifestação, cujo arquivo será gerado.
aLogEvento	String	Caminho do Log de Envio da Manifestação.
aLogRetEvento	String	Caminho do Log de Retorno da Manifestação.
aSalvarComo	String	Define o local onde será salvo o XML Destinatário gerado.
aConfigFilePath	String	Diretório do arquivo .ini

 

 

MontarEPEC

Para montar o XML de envio do evento EPEC, utilize o método MontarEPEC.

MontarEPEC(const aIdLote, aXmlEnvio, aDHEvento, aFusoHorario, aConfigFilePath: PWideChar)

Parâmetros

Argumento	Tipo	Detalhes
aIdLote	String	Identificador de controle do lote de envio do evento.
aXmlEnvio	String	XML de envio da nota (tpEmis = 4 e tags xJust, dhCont).
aDHEvento	String	Data e Hora da Emissão do Evento. Ex.: 2010-08-19T13:00:15.
aFusoHorario	String	Fuso horário do local de envio. Ex.: -03:00.
aConfigFilePath	String	Diretório do arquivo .ini

 

 

AssinarEPEC

Realiza a assinatura digital de um Xml do EPEC antes de realizar o envio do mesmo.

AssinarEPEC(const aXMLEpec,aConfigFilePath : PWideChar)

Parâmetros

Argumento	Tipo	Detalhes
aXMLEpec	String	XML do EPEC montado anteriormente, cujo tpemis = 4.
aConfigFilePath	String	Diretório do arquivo .ini

 

 

EnviarEPEC

Para realizar o envio de uma NFe em modo EPEC, utilize o método EnviarEPEC.

EnviarEPEC(const aXMLEpecAssinado,aConfigFilePath : PWideChar)

Parâmetros

Argumento	Tipo	Detalhes
aXMLEpecAssinado	String	XML das NF's assinadas.
aConfigFilePath	String	Diretório do arquivo .ini