Pular para conteúdo

Parâmetros de Configuração

Os parâmetros são configurados com o método InvoiCyFramework_Configura(nome, valor). Os valores são sempre texto. Os indicadores aceitam 0 ou 1, e o valor padrão aparece em negrito.

Contingência e Comunicação

PARÂMETRO VALORES DESCRIÇÃO
TIPO_CONTINGENCIA 0, 1 0 = não emite em contingência; 1 = contingência offline (exige AUTO_INCREMENTA=1).
EMITIR_EM_CONTINGENCIA 0, 1 1 = força todas as emissões em contingência e suspende a sincronização dos documentos pendentes.
CONTINGENCIA_ATRASO segundos (30, mín. 30) Tempo adicional em contingência após a comunicação ser restabelecida.
TEMPO_VERIFICACAO segundos (300, mín. 60) Intervalo entre tentativas de sincronização dos pendentes.
REJEICAO_nnn_INICIA_CONTINGENCIA 0, 1 1 = ao receber a rejeição nnn, emite em contingência e permanece em contingência.
REJEICAO_nnn_EMITIR_CONTINGENCIA 0, 1 1 = ao receber a rejeição nnn, emite somente este documento em contingência.
WS_TIMEOUT_CONEXAO segundos (4) Timeout da fase de conexão com o InvoiCy.
WS_TIMEOUT_ENVIO segundos (3) Timeout de envio.
WS_TIMEOUT_RECEBIMENTO segundos (3) Timeout de recebimento.

Rejeições aceitas em nnn: 204, 296, 374, 382–384, 386, 446, 471, 518–527, 529, 530, 611, 612, 656, 660, 722, 770, 778, 806, 880, 882–896, 928, 930, 931.

Timeouts: valores abaixo do padrão são ignorados. O timeout de conexão vale isoladamente; o tempo total da comunicação é a soma dos três, mais um acréscimo adaptativo do FW (1 s a cada 30 kB transmitidos e até +10 s após timeouts, reduzido à medida que as comunicações voltam a ser rápidas). Emissões e eventos são enviados uma única vez; consultas têm até 3 tentativas.

Numeração e Preenchimento

PARÂMETRO VALORES DESCRIÇÃO
AUTO_INCREMENTA 0, 1 1 = o FW controla série e sequencial (nNF). Recomendado. Requisito da contingência offline.
AUTO_PREENCHE 0, 1 1 = o FW completa automaticamente informações do XML com os dados obtidos do InvoiCy. Manter 1.
SERIE_INICIAL_NFCE / SEQUENCIAL_INICIAL_NFCE número Série e próximo sequencial da NFC-e. Prefira o método DefineSequencialDFe.
SERIE_INICIAL_NFE / SEQUENCIAL_INICIAL_NFE número Idem para NF-e.
VALIDAR_REJEICAO_212 0, 1 Valida dhEmi contra o relógio (tolerância de 5 min).
RETORNO_FORMATO 0, 3 0 = conteúdo de Documento com caracteres escapados; 3 = sem escape.

Impressão

PARÂMETRO VALORES DESCRIÇÃO
IMPRESSORA_CANAL ver abaixo Impressora do DANFE. Sem este parâmetro o FW não imprime.
LAYOUT_IMPRESSAO_DANFENFCE 0, 1 0 = completo; 1 = resumido.
LAYOUT_IMPRESSAO_POS_QRCODE 0, 1 0 = QR Code centralizado; 1 = à esquerda.
IMPRIME_ACRESC_DESC_ITENS 0, 1 Imprime acréscimo/desconto por item.
IMPRIME_CPF_DEST_MASCARADO 0, 1 Imprime o CPF do destinatário mascarado. Prevalece sobre a configuração do InvoiCy.
NAO_IMPRIME_ENDERECO_DEST 0, 1 Omite o endereço do destinatário.
IMPRIME_CHAVE_ACESSO_BARCODE 0, 1 Imprime a chave de acesso também em código de barras.
IMPRIME_CODIGO_PRODUTO_EAN 0, 1 Imprime cEAN em vez de cProd quando diferente de SEM GTIN.
CONTROLE_GAVETA 0, 1 Abre a gaveta ao final do DANFE (na 2ª via, em contingência).
LIMITE_ESPACAMENTO_IMPRESSAO_DA pixels (12) Máximo de linhas em branco consecutivas no DANFE.
LIMITE_ESPACAMENTO_IMPRESSAO_TEXTO pixels (999) Idem para ImprimeTexto.

Os parâmetros de impressão também têm equivalentes em Parâmetros Adicionais de Emissão, que valem apenas para a chamada. Configurados aqui, valem também para a reimpressão.

Valores de IMPRESSORA_CANAL

VALOR USO
PORTA:AUTO Detecta porta serial (COM / /dev/tty*), fabricante e modelo.
PORTA:<porta>|BAUD:<baud>,<par>,<bits>,<stop> Serial em porta fixa. Ex.: PORTA:COM4|BAUD:115200,n,8,1, PORTA:/dev/ttyUSB0|BAUD:115200,n,8,1
MODELO:<fabricante>|PORTA:... Serial com fabricante definido: BEMATECH, EPSON, ELGIN, DARUMA, DIMEP, SWEDA.
USB:AUTO / USB:<vid>:<pid> USB, com detecção automática ou dispositivo fixo.
SERVIDOR:<ip>,<porta> Impressora de rede. Ex.: SERVIDOR:192.168.0.63,9100
IMPRESSORA:<nome> Impressora do spooler do Windows.
BITMAP Não imprime; devolve a imagem do DANFE em Base64 no campo BitmapComprovViaConsBase64 (e BitmapComprovViaEstabBase64, se emissão em contingência com 2 vias) do retorno.
ELGINM10 Android, via InterfaceElginMinipdv.

Acrescente |TEXTO ao final para imprimir com a fonte e os comandos ESC/POS nativos da impressora; sem ele, o DANFE é gerado e impresso como bitmap.

Log

PARÂMETRO VALORES DESCRIÇÃO
LOG_REGISTRO 0, 1 Habilita a gravação de log.
LOG_NIVEL 0, 1, 2 0 = erros; 1 = erros e alertas; 2 = completo.
LOG_DIAS dias (30) Retenção.
LOG_DIRETORIO subpasta Subpasta da pasta de trabalho para os logs.

Tributos

PARÂMETRO VALORES DESCRIÇÃO
LEI_DO_IMPOSTO_CALCULAR_VALORES 0, 1–5 Cálculo do valor aproximado dos tributos (Lei 12.741/2012). Com 0, o cálculo é responsabilidade do AC.
LEI_DO_IMPOSTO_ARQUIVO caminho CSV próprio de produtos × alíquotas (opcional).
URL_API_CALCULADORA URL API da Calculadora de Tributos da RTC.

Atualização Automática (Windows/Linux)

PARÂMETRO PADRÃO DESCRIÇÃO
ATUALIZACAO_AUTOMATICA 0, 1 0 desliga a consulta periódica.
ATUALIZACAO_MINUTOS_ESPERA 10 Intervalo entre consultas, quando o servidor não informa outro.
ATUALIZACAO_ATRASO_INICIAL 120 s Espera antes da primeira consulta (+0–59 s de dispersão automática).
ATUALIZACAO_TROCA_QUENTE 0, 1 1 = ativa a nova versão sem reiniciar o processo; 0 = ativa a nova versão na próxima inicialização.
ATUALIZACAO_MAX_TROCAS 3 Trocas a quente por processo.
ATUALIZACAO_MAX_BLOQUEIO_MS 5000 Espera máxima por chamadas em andamento antes de adiar a troca.
ATUALIZACAO_TLS_VERIFICAR 0, 1 0 desliga a verificação do certificado TLS no download (proxies com inspeção).
ATUALIZACAO_HOST_API por ambiente Host alternativo das APIs de atualização (https://...).