Pular para conteúdo

Métodos

Os métodos são as funções que o InvoiCy Framework disponibiliza ao Aplicativo Comercial (AC) para configurar a biblioteca, emitir documentos fiscais, enviar eventos, realizar consultas, imprimir, controlar a numeração e gerenciar os documentos emitidos em contingência. Nesta seção, eles estão organizados em três grupos: Configuração e Inicialização, Emissão e Impressão de Documentos e Status, Utilitários e Pendências.

Métodos Disponíveis

A tabela a seguir lista todos os métodos, indicando em quais plataformas cada um está disponível. Clique no nome do método para acessar sua descrição completa.

MÉTODO WINDOWS/LINUX ANDROID FINALIDADE
Initialize / Terminate ✓ — Inicializar / finalizar a biblioteca
ConfiguraDiretorio ✓ ✓ Pasta de trabalho
ConfiguraInvoicyEx ✓ ✓ Ambiente + empresa (recomendado)
AmbienteEmissao / ConfiguraInvoicy ✓ ✓ Ambiente / empresa, em chamadas separadas
Configura ✓ ✓ Parâmetros gerais
EmiteDocumento ✓ ✓ Emissão, evento ou consulta (XML)
EmiteDocumentoJSON ✓ ✓ Emissão, evento ou consulta (JSON)
ImprimeDocumento ✓ ✓ Impressão/reimpressão do DANFE
ImprimeDocumentoEx ✓ ✓ Idem, com parâmetros de impressão
ImprimeTexto ✓ ✓ Impressão genérica (Framework-HTML)
AbrirGaveta ✓ — Abertura da gaveta
ObtemParametro ✓ ✓ Certificado e impressora
ObtemUltimoSequencialDFe / DefineSequencialDFe ✓ ✓ Ler / definir numeração (NFC-e e NF-e)
ObtemUltimoSequencialNFCe ✓ ✓ Ler numeração NFC-e (legado)
RelatorioPendentes ✓ ✓ Lista de pendentes de sincronização
QuantidadeDocumentosPendentes — ✓ Quantidade de pendentes
EnviaDocumentosPendentes ✓ ✓ Força o envio dos pendentes
EnviaDocumentosPendentesQuantidade ✓ ✓ Força o envio de n pendentes
Versao ✓ ✓ Versão da biblioteca
GetModuleIdentity ✓ — Informações sobre o módulo que está atendendo

Especificidades

Antes de utilizar os métodos, considere as particularidades a seguir:

  • Prefixo dos nomes: na versão Windows/Linux, os nomes dos métodos têm o prefixo InvoiCyFramework_ (ex.: InvoiCyFramework_EmiteDocumento). No Android, os métodos têm os mesmos nomes, sem o prefixo (ex.: EmiteDocumento).
  • Retornos do tipo int: utilizam 1 = sucesso e 0 = erro, exceto onde indicado. As exceções são:
    • InvoiCyFramework_Configura: retorna sempre 1; nomes de parâmetros desconhecidos são gravados e ignorados, portanto confira a grafia.
    • InvoiCyFramework_DefineSequencialDFe: retorna 0 em sucesso e 1 em erro (convenção inversa à dos demais métodos).
    • InvoiCyFramework_ObtemUltimoSequencialDFe e InvoiCyFramework_ObtemUltimoSequencialNFCe: retornam o último número emitido.
    • InvoiCyFramework_ImprimeDocumento e InvoiCyFramework_ImprimeDocumentoEx: retornam a quantidade de documentos impressos (0 = nada impresso).
    • InvoiCyFramework_EnviaDocumentosPendentes: retorna a quantidade de documentos que continuam pendentes (0 = todos enviados).
    • InvoiCyFramework_Versao: retorna a versão como número inteiro (ex.: 15004 = 01.50.04).
  • Retornos do tipo char*: pertencem à biblioteca. Não libere a memória e copie o retorno assim que o receber. Mais detalhes em Formas de Integração.