Lista com todos os métodos do componente NFe.
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 |
|---|---|---|---|
| EnviarDadosVenda | aNumeroSessao, aDadosVenda | Este método é utilizado para realizar o envio do XML diretamente para a dll do aparelho MFe. | O retorno terá o seguinte formato: numeroSessao\EEEEE\CCCC\mensagem\cod\ mensagemSEFAZ\arquivoCFeBase64\ timeStamp\chaveConsulta\ valorTotalCFe\CPFCNPJValue\assinaturaQRCODE |
| AssociarAssinatura | aNumeroSessao | Para associar a assinatura do aplicativo comercial ao equipamento SAT, com geração automática de SignAC, utilize o método AssociarAssinatura. | Número de sessão\código de retorno previsto no manual do SAT\Código de rejeição\Mensagem de retorno\Código de referência\Mensagem da Sefaz ao usuário. Notas |
| AssociarAssinaturaSignAC | aNumeroSessao, aCNPJContribuinte, aCNPJSoftwareHouse, aSignAC | Para associar a assinatura do aplicativo comercial ao equipamento SAT, utilize o método AssociarAssinaturaSignAC. | Número de sessão\código de retorno previsto no manual do SAT\Código de rejeição\Mensagem de retorno\Código de referência\Mensagem da Sefaz ao usuário. Notas |
| AtivarSAT | aNumeroSessao, aCertificadoAtivacao | Este método ativa o equipamento SAT para iniciar as configurações. | O retorno terá o seguinte formato: numeroSessao\EEEEE\CCCC\mensagem\cod\ mensagemSEFAZ\ |
| AtualizarSoftwareSAT | aNumeroSessao | O Contribuinte utilizará a função AtualizarSoftwareSAT para a atualização imediata do software básico do Equipamento SAT. | O retorno terá o seguinte formato: numeroSessao\EEEEE\CCCC\mensagem\cod\ mensagemSEFAZ\ |
| BloquearSAT | aNumeroSessao | Este método realiza o bloqueio operacional do equipamento SAT. | O retorno terá o seguinte formato: numeroSessao\EEEEE\CCCC\mensagem\cod\ mensagemSEFAZ\ |
| CancelarUltimaVenda | aNumeroSessao, aChave, aCNPJSoftwareHouse, aCNPJCPFDestinatario, aNumeroCaixa, aSignAC | Função que cancela o ultimo cupom fiscal eletrônico. | O retorno terá o seguinte formato: numeroSessao\EEEEE\CCCC\mensagem\cod\ mensagemSEFAZ\arquivoCFeBase64\ timeStamp\chaveConsulta\ valorTotalCFe\CPFCNPJValue\assinaturaQRCODE |
| LoadConfig | aConfigFile | Carrega configurações do componente a partir de um arquivo .ini presente na pasta do .exe De preferência quando iniciar seu projeto, de modo que as configurações do componente já sejam feitas. | O método ConfigurarSoftwareHouse não possui retorno. |
| ComunicarCertificadoICPBRASIL | aNumeroSessao, aCertificado | Função responsável por comunicar o certificado utilizado para o equipamento SAT. |
O retorno terá o seguinte formato: numeroSessao\EEEEE\CCCC\mensagem\cod\ |
| ConfigurarSoftwareHouse | 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. Notas |
| ConfigurarInterfaceDeRede | aNumeroSessao, aDadosConfiguracao | Permite ao usuário configurar a interface de comunicação do Equipamento SAT com a rede local do estabelecimento comercial através do envio de um arquivo de configuração no padrão XML. | O retorno terá o seguinte formato: numeroSessao\EEEEE\CCCC\mensagem\cod\ mensagemSEFAZ\ Configuração dos campos |
| ConsultarStatusOperacional | aNumeroSessao | Consulta o status de comunicação do equipamento SAT com a SEFAZ. | numeroSessao\EEEEE\ mensagem\cod\mensagemSEFAZ\ConteudoRetorno |
| ConsultarSAT | aNumeroSessao | Consulta o status de comunicação do equipamento SAT com a o software (AC). | numeroSessao\EEEEE\ mensagem\cod\mensagemSEFAZ\ConteudoRetorno |
| ConsultarNumeroSessao | aNumeroSessao, aNumeroSessaoConsultada | Consulta de número de sessão processada pelo Equipamento SAT. | O retorno terá o seguinte formato: numeroSessao\EEEEE\CCCC\mensagem\cod\ mensagemSEFAZ\ |
| 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 "TspdCFeSatDataSets", populado com os dados do XML. |
| ConverterLoteParaXml | ArquivoTx2, aVersaoEsquema | Função que converte um Lote de CFe's formato TX2 para XML. | Será retornado o XML de envio. |
| DesbloquearSAT | aNumeroSessao | Este método realiza o desbloqueio operacional do equioamento SAT | O retorno terá o seguinte formato: numeroSessao\EEEEE\CCCC\mensagem\cod\ mensagemSEFAZ\ |
| EditarCFeSAT | aLoteNotas, ArquivoRtm | Método utilizado para editar e configurar o leiaute do documento CFe Sat (arquivo .rtm). | |
| EditarCFeSATCancelada | aADNota, aADCNota, aArquivoModelo | Método utilizado para editar e configurar o leiaute do documento CFe Sat (arquivo .rtm). | |
| EnviarDadosVenda | aNumeroSessao, aDadosVenda | Este método é utilizado para realizar o envio do XML do CF-e para o SAT. | O retorno terá o seguinte formato: numeroSessao\EEEEE\CCCC\mensagem\cod\ mensagemSEFAZ\arquivoCFeBase64\ timeStamp\chaveConsulta\ valorTotalCFe\CPFCNPJValue\assinaturaQRCODE |
| EnviarCFeSATDestinatario | aXmlADDestinatario | Método para envio do xml destinatário por e-mail. | |
| EnviarPagamento | aChaveAcessoValidador; aChaveRequisicao; aEstabelecimento; aSerialPOS; aCNPJ; aIcmsBase; aValorTotalVenda; aHabilitarMultiplosPagamentos; aHabilitarControleAntiFraude; aCodigoMoeda; aEmitirCupomNFCE; aOrigemPagamento | O método de Enviar Pagamento sé um dos métodos que somente a SEFAZ do Ceará utiliza ele deve ser executado quando a venda for POS (Point of Sale) ou TEF (Transferência Eletrônica de Fundos) para antecipar alguns dados antes que o pagamento seja realizado. | |
| EnviarStatusPagamento | aNumeroSessao; aChaveAcessoValidador; aCodigoAutorizacao, aBin, aDonoCartao, aDataExpiracao, aInstituicaoFinanceira, aParcelas, aCodigoPagamento, aValorPagamento, aIdFila, aTipo, aUltimosQuatroDigitos | O método de Enviar Status Pagamento sé um dos métodos que somente a SEFAZ do Ceará utiliza ele deve ser executado TEF (Transferência Eletrônica de Fundos) para enviar os dados do pagamento para o integrador. | |
| ExportarCFeSATCancelada | aADNota; aADCNota, aArquivoModelo, aFormato, aSalvarComo | Método utilizado para exportação da impressão em um arquivo no formato PDF | |
| ExportarCFeSAT | aLoteNotas, aArquivoModelo, aFormato, aSalvarComo | Este método é utilizado para exportação da impressão em um arquivo no formato PDF. | |
| ExtrairLogs | aNumeroSessao | Função que extrair os logs do equipamento SAT. | O retorno terá o seguinte formato: numeroSessao\EEEEE\mensagem\cod\msgSefaz\ arquivo log em base 64 |
| GerarSignAC | aCNPJContribuinte, aCNPJSoftwareHouse | Função que faz a geração da assinatura do aplicativo comercial que deve ser associada ao SAT através dos métodos AssociarAssinatura ou AssociarAssinaturaSignAC. | O retorno do método é a string resultante da assinatura da string CNPJ Contribuinte + CNPJ Software House. |
| ImprimirCFeSAT | aLoteNotas, XML, ArquivoRtm, aImpressora | Método utilizado para imprimir um documento CF-e. | |
| ImprimirCFeSATCancelada | aADNota, aADCNota, ArquivoRtm, aImpressora | Método utilizado para imprimir um documento CFe Cancelado | |
| ListarCertificados | aList | Lista os certificados instalados na máquina. O componente lista os certificados instalados. | Este método retornará todos os certificados instalados no repositório pessoal do Windows. |
| GetVencimentoCertificado | Captura o vencimento do certificado digital. | Este método retornará o vencimento do certificado digital. | |
| aNumeroSessao; aChaveAcessoValidador; idFila, aChaveAcesso, aNsu, aNumerodeAprovacao, aBandeira, aAdquirente, aCNPJ, aImpressaoFiscal, aNumeroDocumento | O método de Resposta Fiscal é um dos métodos que somente a SEFAZ do Ceará utiliza ele deve ser executado quando ocorrem vendas com cartões (POS/TEF) para encerrar o processo de venda. | ||
| SaveConfig | 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. | |
| TesteFimAFim | aNumeroSessao, aDadosVenda | Consiste em um teste de comunicação entre o AC, o Equipamento SAT e a SEFAZ. | O retorno terá o seguinte formato: numeroSessao\EEEEE\mensagem\cod\ mensagemSEFAZ\arquivoCFebase64 timeStamp\numDocFiscal\chaveConsulta. Detalhes Exemplo CFeBase64 |
| TrocarCodigoDeAtivacao | aNumeroSessao, aOpcao, aNovoCodigo, aConfirmacaoNovoCodigo | Permite o usuário trocar o código de ativação configurado no SAT. | O retorno terá o seguinte formato: numeroSessao\EEEEE\mensagem\cod\ mensagemSEFAZ |
| VerificarStatusValidador | aNumeroSessao; aChaveAcessoValidador; aIdFila; aCNPJ | O método de Enviar Status Pagamento sé um dos métodos que somente a SEFAZ do Ceará utiliza ele deve ser executado POS para poder retornar os dados do pagamento para a aplicação. | |
| VisualizarCFeSAT | aLoteNotas, ArquivoRtm | Método utilizado para visualizar um documento CFe. | |
| VisualizarCFeSAT | aADNota, aADCNota, ArquivoRtm | Método utilizado para visualizar um documento CFe cancelado. |
Exemplo
Aqui, podemos verificar exemplos de utilização do método EnviarDadosVenda 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
mmRetorno := spdCFeSat.EnviarDadosVenda(getNumeroSessao,mmReturn.Text);
C#
tbRetorno.Text = spdCFeSat.EnviarDadosVenda(getNumeroSessao(), tbRetorno.Text);
Visual Basic 6
mmRetorno.Text = spdCFeSat.EnviarDadosVenda(NumeroSessao, mmRetorno.Text)
Comentários
0 comentário
Artigo fechado para comentários.