Mudanças entre as edições de "UniDANFE/Integrando o UniDANFE ao ERP/Gerar documento auxiliar"

De unimake
Ir para: navegação, pesquisa
 
(66 revisões intermediárias pelo mesmo usuário não estão sendo mostradas)
Linha 1: Linha 1:
===Gerar, Imprimir e Distribuir os Documentos Auxiliares===
+
__NOTITLE__
 +
==Gerar, Imprimir e Distribuir os Documentos Auxiliares==
  
Essa é a forma normal que os sistemas ERP usarão para gerar o Documento Auxiliar (DANFE, o DACTE, etc). O UniDANFE deve ser executado com a passagem de alguns parâmetros que o orientarão como se comportar.
+
Essa é a forma normal que os sistemas ERP usarão para gerar o [[Manuais:UniDANFE/Termos|Documento Auxiliar]]. O UniDANFE deve ser executado com a passagem de alguns parâmetros que o orientarão como se comportar.
  
Cada parâmetro é descrito a seguir, e devem ser utilizados no formato parametro=conteúdo, sem qualquer espaço entre o parâmetro, o sinal de igualdade e o conteúdo do mesmo. Os parâmetros cujo conteúdo possa conter espaços (ex: nome de pastas e/ou arquivos) devem estar entre aspas, no formato parametro=“conteúdo completo com espaços”.  
+
Cada parâmetro é descrito a seguir, e devem ser utilizados no formato parametro=conteúdo, sem qualquer espaço entre o parâmetro, o sinal de igualdade e o conteúdo do mesmo. Os parâmetros cujo conteúdo possa conter espaços (ex: nome de pastas e/ou arquivos) devem estar entre aspas, no formato parametro=“conteúdo completo com espaços”. Apenas os parâmetros com asterisco (*) são obrigatórios.
  
 
{| class="wikitable"
 
{| class="wikitable"
Linha 14: Linha 15:
 
|Arquivo*
 
|Arquivo*
 
|a
 
|a
|Nome completo do arquivo XML do Documento Fiscal Eletrônico, CC-e ou Cancelamento, gerado pelo ERP, incluindo todo o caminho para encontrá-lo. Esse arquivo deve ser o XML de distribuição já autorizado pela SEFAZ (procNFe, procCTe, procMDFe, procEventoNFe, etc).  
+
|Nome completo do arquivo XML do [[Manuais:UniDANFE/Termos|Documento Fiscal Eletrônico]], CC-e ou Cancelamento, gerado pelo ERP, incluindo todo o caminho para encontrá-lo. Esse arquivo deve ser o XML de distribuição já autorizado pela SEFAZ (procNFe, procCTe, procMDFe, procEventoNFe, etc).  
|..\unidanfe.exe a="c:\minha pasta\0101010101010-procNFe.xml"
 
  
|- style="vertical-align:top;"
+
No caso de integração via DLL unidanfe_dfe.dll, pode-se opcionalmente passar por esse parâmetro o conteúdo do XML ao invés do nome do arquivo.
|Tipo
 
|t
 
|Indica ao UniDANFE qual o tipo do XML passado pelo parâmetro “arquivo”. As opções válidas são:
 
:* “danfe”, “nfe” ou “nf-e”
 
:* “ds” ou “danfesimplificado”
 
:* “nfce” ou “nfc-e”
 
:* “dacte”, “ct-e” ou “cte”
 
:* “dacteos”, “ct-e os” ou “cteos”
 
:* “damdfe”, “mdf-e” ou “mdfe”
 
:* “cce” (para CC-e de NF-e)
 
:* “ccdse” ou “ccds-e” (para CC-e de NF-e - Simplificada)
 
:* “ccte” (para CC-e de CT-e).  
 
:* “sat” ou “cfe” ou “cf-e”
 
  
Se omitido esse parâmetro, o UniDANFE abrirá o arquivo XML para saber do que se trata, ocasionando um pequeno atraso no processamento. Além disso, no caso de CC-e de NF-e, não há como identificar pelo XML se o mesmo se refere a DANFE simplificado ou não.
+
|..\unidanfe.exe a="c:\minha pasta\0101010101010-procNFe.xml"
|...\unidanfe.exe a="c:\minhapasta\01010101010-procNFe.xml" t=nfe
 
 
 
...\unidanfe.exe a="c:\minhapasta\01010101010-procNFe.xml" t=ds
 
 
 
...\unidanfe.exe a="c:\minhapasta\01010101010-procNFe.xml" t=nfce
 
 
 
...\unidanfe.exe a="c:\minhapasta\01010101010-procCTe.xml" t=cte
 
 
 
...\unidanfe.exe a="c:\minhapasta\01010101010-procMDFe.xml" t=mdfe
 
 
 
...\unidanfe.exe a="c:\minhapasta\CFe01010101010.xml" t=sat
 
  
 
|- style="vertical-align:top;"
 
|- style="vertical-align:top;"
|Arquivo
+
|ArquivoAuxiliar
 
 
Auxiliar
 
 
|au
 
|au
 
|Nome completo do arquivo [[Manuais:UniDANFE/Integrando o UniDANFE ao ERP/XML auxiliar|XML auxiliar]], incluindo todo o caminho para encontrá-lo. No [[Manuais:UniDANFE/Integrando o UniDANFE ao ERP/XML auxiliar|XML auxiliar]] existem TAGS complementares para o UniDANFE, com algumas personalizações. Se esse parâmetro não for passado, o UniDANFE procurará, na mesma pasta do XML principal, um outro arquivo XML com o mesmo nome, precedido do texto “aux-”. Se encontrar tal arquivo, o usará como auxiliar, sem a necessidade de passar seu nome na linha de comando.
 
|Nome completo do arquivo [[Manuais:UniDANFE/Integrando o UniDANFE ao ERP/XML auxiliar|XML auxiliar]], incluindo todo o caminho para encontrá-lo. No [[Manuais:UniDANFE/Integrando o UniDANFE ao ERP/XML auxiliar|XML auxiliar]] existem TAGS complementares para o UniDANFE, com algumas personalizações. Se esse parâmetro não for passado, o UniDANFE procurará, na mesma pasta do XML principal, um outro arquivo XML com o mesmo nome, precedido do texto “aux-”. Se encontrar tal arquivo, o usará como auxiliar, sem a necessidade de passar seu nome na linha de comando.
Linha 54: Linha 28:
  
 
|- style="vertical-align:top;"
 
|- style="vertical-align:top;"
|Arquivo
+
|ArquivoEPEC
 
 
EPEC
 
 
|ad
 
|ad
 
|Nome completo, incluindo todo caminho, do arquivo XML que contém as informações do registro do EPEC. A informação desse arquivo é obrigatória quando necessitar imprimir DANFE de NF-e ou DACTE de CT-e emitido em contingência EPEC antes de sua autorização. O UniDANFE não gerará o Documento Auxiliar em contingência EPEC sem conferir as informações desse arquivo XML. Após a normalização do serviço, quando o XML da NF-e ou do CT-e já contiver o protocolo de autorização de uso, esse parâmetro deixa de ser necessário.
 
|Nome completo, incluindo todo caminho, do arquivo XML que contém as informações do registro do EPEC. A informação desse arquivo é obrigatória quando necessitar imprimir DANFE de NF-e ou DACTE de CT-e emitido em contingência EPEC antes de sua autorização. O UniDANFE não gerará o Documento Auxiliar em contingência EPEC sem conferir as informações desse arquivo XML. Após a normalização do serviço, quando o XML da NF-e ou do CT-e já contiver o protocolo de autorização de uso, esse parâmetro deixa de ser necessário.
Linha 62: Linha 34:
  
 
|- style="vertical-align:top;"
 
|- style="vertical-align:top;"
|NFe
+
|DFe
 
|n
 
|n
|Parâmetro utilizado apenas para impressão da Carta de Correção Eletrônica. Indica ao UniDANFE o nome completo, incluindo todo o caminho, do arquivo XML da NF-e, NFC-e, CT-e ou MDF-e que está sofrendo correção. Quando esse parâmetro é informado, o UniDANFE vai buscar informações relativas ao emitente, destinatário, remetente, expedidor, recebedor, etc., nesse arquivo XML. Quando esse parâmetro é omitido, o UniDANFE busca primeiramente em sua base de dados essas informações e, em não as localizando, procura pelo XML da NF-e/CT-e na mesma pasta do XML do evento da CC-e, nos padrões “chavedeacesso-procXXX.xml” e “chavedeacesso-XXX.xml”, onde XXX=NFe ou CTe, conforme o caso.
+
|Parâmetro utilizado apenas para impressão da eventos (CC-e, cancelamento). Indica ao UniDANFE o nome completo, incluindo todo o caminho, do arquivo XML da NF-e, NFC-e, CT-e ou MDF-e que está sofrendo correção. Quando esse parâmetro é informado, o UniDANFE vai buscar informações relativas ao emitente, destinatário, remetente, expedidor, recebedor, etc., nesse arquivo XML. Quando esse parâmetro é omitido, o UniDANFE busca primeiramente em sua base de dados essas informações e, em não as localizando, procura pelo XML da NF-e/CT-e na mesma pasta do XML do evento da CC-e, nos padrões “chavedeacesso-procXXX.xml” e “chavedeacesso-XXX.xml”, onde XXX=NFe ou CTe, conforme o caso.
 
|...\unidanfe.exe a="c:\x\0101-1-procEventoNFe.xml" n="c:\x\0101-procNFe.xml"
 
|...\unidanfe.exe a="c:\x\0101-1-procEventoNFe.xml" n="c:\x\0101-procNFe.xml"
 +
 +
|- style="vertical-align:top;"
 +
|AnexarDFe
 +
|an
 +
|Parâmetro utilizado apenas para impressão da Carta de Correção Eletrônica. Deve ser utilizado em conjunto com o parâmetro "DFe". Indica ao UniDANFE se o Documento Auxiliar (DANFE, DACTE, etc) deve ser anexado ao impresso da CC-e. 0=Não 1=Sim (antes da CC-e) 2=Sim (depois da CC-e). Se informado, esse parâmetro se sobrepõe às configurações efetuadas no painel de controle do UniDANFE.
 +
|...\unidanfe.exe a="c:\x\0101-1-procEventoNFe.xml" n="c:\x\0101-procNFe.xml" an=1
 +
  
 
|- style="vertical-align:top;"
 
|- style="vertical-align:top;"
 
|Configuracao
 
|Configuracao
 
|c
 
|c
|Nome da configuração que será utilizada para gerar o Documento Auxiliar. Se esse parâmetro não for passado, o UniDANFE tentará localizar a configuração ideal automaticamente. Clique aqui para conhecer os critérios de escolha automática da configuração.  
+
|Nome da configuração que será utilizada para gerar o Documento Auxiliar. Se esse parâmetro não for passado, o UniDANFE tentará localizar a configuração ideal automaticamente. [[Manuais:UniDANFE/FAQ/Impressão/EscolherConfiguracao|Clique aqui para conhecer os critérios de escolha automática da configuração.]]
  
 
Atenção: Para esse parâmetro funcionar é necessário que a configuração passada tenha sido previamente cadastrada no UniDANFE.
 
Atenção: Para esse parâmetro funcionar é necessário que a configuração passada tenha sido previamente cadastrada no UniDANFE.
Linha 114: Linha 93:
  
 
|- style="vertical-align:top;"
 
|- style="vertical-align:top;"
|Pasta
+
|PastaConfiguracao
 +
|pc
 +
|Define a pasta local ou da rede onde o UniDANFE deve ler/gravar suas configurações. Deve ser informado o nome da pasta principal que irá abrigar as subpastas (dados, email, lic, etc) utilizadas pelo UniDANFE.
  
Configuracao
+
Informar apenas nos casos em que a pasta das configurações seja diferente da pasta onde o UniDANFE está instalado. Por exemplo, instala-se o UniDANFE em ''C:\UniDANFE'' mas a base de dados está em um servidor de rede, compartilhada entre todos os usuários, como ''S:\Sistemas\UniDANFE''.
|pc
 
|Define a pasta local ou da rede onde o UniDANFE deve ler/gravar suas configurações. Deve ser informado o nome da pasta principal que irá abrigar as subpastas (dados, email, lic, etc) utilizadas pelo UniDANFE, geralmente a mesma pasta onde o arquivo executável do UniDANFE foi instalado.
 
 
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” pc=“Y:\unimake\uninfe”
 
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” pc=“Y:\unimake\uninfe”
  
Linha 126: Linha 105:
 
|Logotipo
 
|Logotipo
 
|L
 
|L
|Nome da imagem, incluindo seu caminho completo, que será usada na geração do Documento Auxiliar. Há um campo específico da interface de configuração do UniDANFE para informar esse arquivo de imagem. No entanto, em alguns casos, deseja-se utilizar uma mesma configuração para mais de uma empresa/filial. Para esses casos, pode-se passar a imagem através da linha de comando, ou informá-la no [[Manuais:UniDANFE/Integrando o UniDANFE ao ERP/XML auxiliar|XML auxiliar]].
+
|Nome da imagem, incluindo seu caminho completo, que será usada na geração do [[Manuais:UniDANFE/Termos|Documento Auxiliar]]. Há um campo específico da interface de configuração do UniDANFE para informar esse arquivo de imagem. No entanto, em alguns casos, deseja-se utilizar uma mesma configuração para mais de uma empresa/filial. Para esses casos, pode-se passar a imagem através da linha de comando, ou informá-la no [[Manuais:UniDANFE/Integrando o UniDANFE ao ERP/XML auxiliar|XML auxiliar]]. Uma outra forma é salvar o logotipo na pasta imagens\logotipos dentro da pasta de instalação do UniDANFE, com o nome do arquivo igual ao CNPJ do emitente, sem pontos e traços. Nesse caso, o UniDANFE fará a impressão do logotipo para todos os impressos sempre que emitir um documento desse emitente (ex: C:\UniDANFE\imagens\logotipos\06117473000150.jpg).
 
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” L=“c:\imagens\img01.jpg”
 
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” L=“c:\imagens\img01.jpg”
  
Linha 132: Linha 111:
 
|Visualizar
 
|Visualizar
 
|v
 
|v
| Informa ao UniDANFE se o Documento Auxiliar gerado deverá ser visualizado na tela do computador antes da impressão/envio por e-mail. 1=Sim 0=Não. Se informado, esse parâmetro se sobrepõe às configurações efetuadas no painel de controle do UniDANFE.
+
| Informa ao UniDANFE se o [[Manuais:UniDANFE/Termos|Documento Auxiliar]] gerado deverá ser visualizado na tela do computador antes da impressão/envio por e-mail. 1=Sim 0=Não. Se informado, esse parâmetro se sobrepõe às configurações efetuadas no painel de controle do UniDANFE.
 
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” v=0
 
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” v=0
  
Linha 140: Linha 119:
 
|Imprimir
 
|Imprimir
 
|m
 
|m
| Informa ao UniDANFE se o Documento Auxiliar deve ser impresso automaticamente ou não. 1=Sim 0=Não. Se informado, esse parâmetro se sobrepõe às configurações efetuadas no painel de controle do UniDANFE.
+
| Informa ao UniDANFE se o [[Manuais:UniDANFE/Termos|Documento Auxiliar]] deve ser impresso automaticamente ou não. 1=Sim 0=Não. Se informado, esse parâmetro se sobrepõe às configurações efetuadas no painel de controle do UniDANFE.
 
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” v=0 m=1  // imprimir sem visualizar
 
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” v=0 m=1  // imprimir sem visualizar
  
Linha 150: Linha 129:
 
|Impressora
 
|Impressora
 
|i
 
|i
|Informa em qual impressora o Documento deve ser impresso. Aceita os valores “padrao", “selecionar” ou “<nome completo da impressora>”; se informado o valor “padrao", o impresso será enviado para a impressora padrão do computador; se informado “selecionar”, uma tela será exibida ao usuário antes da impressão, para que este selecione a impressora correta; se informado o nome de uma impressora instalada, o UniDANFE imprimirá o Documento nessa impressora.
+
|Informa em qual impressora o Documento deve ser impresso. Aceita os valores “padrao", “selecionar” ou “<nome completo da impressora>”; se informado o valor “padrao", o impresso será enviado para a impressora padrão do computador; se informado “selecionar”, uma tela será exibida ao usuário antes da impressão, para que este selecione a impressora correta; se informado o nome de uma impressora instalada, o UniDANFE imprimirá o [[Manuais:UniDANFE/Termos|Documento]] nessa impressora. No caso de utilizar impressora de rede, é recomendável passar o nome da impressora tal qual aparece na tela de configuração "Impressora e Scanners" do Windows e não utilizar o formato "\\SERVER\IMPRESSORA".
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” i=“\\SERVER\HPLASERJET1001”
+
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” i=“SAMSUNG M4020ND”
  
 
|- style="vertical-align:top;"
 
|- style="vertical-align:top;"
|Copias
+
|NomeImpressao
|p
+
|ni
|Informa ao UniDANFE quantas cópias devem ser impressas do documento gerado.  
+
|Define o texto que vai aparecer no gerenciador de impressão do Windows. Se não informado o texto padrão é gerado pelo UniDANFE.
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” v=0 i=1 p=3    // imprimir 3 cópias, sem visualizar
+
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” ni=“NF=00123 CAIXA=001 OP=JUNIOR”
 +
 
  
 
|- style="vertical-align:top;"
 
|- style="vertical-align:top;"
|PastaPDF
+
|LarguraBobina
 
+
|lb
(Plus)
+
|Informa ao UniDANFE a largura do papel em milímetros quando se tratar de impressão em bobina.  
|pp
+
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” lb=80    // imprimir em papel bobina de 80mm de largura
|Informa ao UniDANFE a pasta onde devem ser gravados os arquivos PDF com a imagem do Documento Auxiliar gerado pelo sistema, quando para isso configurado. Esse parâmetro sobrepõe a pasta definida na configuração do UniDANFE. A pasta informada nesse parâmetro deve existir previamente. O nome do PDF será criado respeitando-se as regras definidas na configuração do UniDANFE.
 
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” pp=“c:\meus_pdfs”
 
  
 
|- style="vertical-align:top;"
 
|- style="vertical-align:top;"
|NomePDF
+
|Copias
 +
|p
 +
|Informa ao UniDANFE quantas cópias devem ser impressas do [[Manuais:UniDANFE/Termos|Documento]] gerado.
 +
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” v=0 i=1 p=3    // imprimir 3 cópias, sem visualizar
  
(Plus)
 
|np
 
|Instrui o UniDANFE como deve ser o nome do arquivo PDF com a imagem do Documento Auxiliar gerado pelo sistema, quando para isso configurado. Esse parâmetro sobrepõe a regra de construção do nome definida na configuração do UniDANFE. Pode ser passado apenas o nome ou o nome incluindo o caminho completo (pastas). Nesse caso, o caminho (pasta) já deve existir previamente.
 
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” np=“c:\meus_pdfs\01010101010.pdf”
 
  
 
|- style="vertical-align:top;"
 
|- style="vertical-align:top;"
|Imagem
+
|ImagemAdicional
 
 
Adicional
 
 
|ia
 
|ia
 
|Nome completo, incluindo o caminho, de uma imagem para ser impressa no rodapé da seção “DADOS ADICIONAIS”, dentro do quadro “Informações Complementares”. Válido apenas para impressão do DANFE de NF-e em orientação RETRATO.  
 
|Nome completo, incluindo o caminho, de uma imagem para ser impressa no rodapé da seção “DADOS ADICIONAIS”, dentro do quadro “Informações Complementares”. Válido apenas para impressão do DANFE de NF-e em orientação RETRATO.  
Linha 184: Linha 159:
  
 
|- style="vertical-align:top;"
 
|- style="vertical-align:top;"
|Altura
+
|AlturaImagemAdicional
 
 
Imagem
 
 
 
Adicional
 
 
|iaa
 
|iaa
 
|Altura, em milésimos de polegadas, com que a imagem adicional vai ser impressa. Essa altura será adicionada ao quadro “Dados Adicionais”. Se omitido, o valor padrão 1000 (aproximadamente 25mm) é assumido. Válido apenas para impressão do DANFE em orientação RETRATO.
 
|Altura, em milésimos de polegadas, com que a imagem adicional vai ser impressa. Essa altura será adicionada ao quadro “Dados Adicionais”. Se omitido, o valor padrão 1000 (aproximadamente 25mm) é assumido. Válido apenas para impressão do DANFE em orientação RETRATO.
Linha 194: Linha 165:
  
 
|- style="vertical-align:top;"
 
|- style="vertical-align:top;"
|Saida
+
|Saida_Erros
 
 
Erros
 
 
|s
 
|s
| Define onde devem ser geradas as possíveis mensagens de erro do sistema. V=vídeo A=rquivo. Útil para os casos em que a impressão e envio por e-mail do Documento Auxiliar seja configurada para ser executada automaticamente sem a intervenção de usuários. Se SaidaErros=A e o parâmetro ArquivoErros for omitido, ArquivoErros será o mesmo nome do XML acrescido da extensão “.err”.
+
| Define onde devem ser geradas as possíveis mensagens de erro do sistema. V=vídeo A=Arquivo N=não gerar. Útil para os casos em que a impressão e envio por e-mail do [[Manuais:UniDANFE/Termos|Documento Auxiliar]] seja configurada para ser executada automaticamente sem a intervenção de usuários. Se Saida_Erros=A e o parâmetro ArquivoErros for omitido, ArquivoErros será o mesmo nome do XML acrescido da extensão “.err”. Saida_erros=N será útil quando estiver utilizando o UniDANFE como DLL e o erro será retornado pelo método DFEGETERRO().
 
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” s=V
 
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” s=V
  
 
...\unidanfe.exe a=“c:\x\0101-procNFe.xml” s=A
 
...\unidanfe.exe a=“c:\x\0101-procNFe.xml” s=A
 +
 +
DFESetParametro('saida_erros', 'N')
  
 
|- style="vertical-align:top;"
 
|- style="vertical-align:top;"
|Arquivo
+
|ArquivoErros
 
 
Erros
 
 
|ae
 
|ae
|Define o nome do arquivo que vai receber os erros ocorridos durante a geração do Documento Auxiliar, se houver.
+
|Define o nome do arquivo que vai receber os erros ocorridos durante a geração do [[Manuais:UniDANFE/Termos|Documento Auxiliar]], se houver.
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” s=A ae=“c:\erros\meus_erros.txt”
+
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” s=A ae=“c:\erros\meus_erros.xml”
  
 
|- style="vertical-align:top;"
 
|- style="vertical-align:top;"
 
|Remetente
 
|Remetente
 
|r
 
|r
|E-mail ou apelido do remetente de e-mail que deve ser utilizado para o envio do Documento por e-mail. O remetente deve estar previamente cadastrado no sistema mesmo quando este parâmetro contiver um endereço eletrônico (e-mail) pois outras informações são necessárias para o envio do e-mail, como servidor SMTP, porta, senha, etc. É possível cadastrar remetentes informando o CNPJ do emitente no campo “Apelido” para que o mesmo seja selecionado automaticamente. Consulte a seção “Configurando as Contas de Remetentes” para maiores detalhes. É possível informar o remetente também no[[Manuais:UniDANFE/Integrando o UniDANFE ao ERP/XML auxiliar|XML auxiliar]] ou nas TAG´s de uso livre.   
+
|E-mail ou apelido do remetente de e-mail que deve ser utilizado para o envio do [[Manuais:UniDANFE/Termos|Documento]] por e-mail. O remetente deve estar previamente cadastrado no sistema mesmo quando este parâmetro contiver um endereço eletrônico (e-mail) pois outras informações são necessárias para o envio do e-mail, como servidor SMTP, porta, senha, etc. É possível cadastrar remetentes informando o CNPJ do emitente no campo “Apelido” para que o mesmo seja selecionado automaticamente. Consulte a seção “Configurando as Contas de Remetentes” para maiores detalhes. É possível informar o remetente também no[[Manuais:UniDANFE/Integrando o UniDANFE ao ERP/XML auxiliar|XML auxiliar]] ou nas TAG´s de uso livre.   
 
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” r=FATURAMENTO
 
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” r=FATURAMENTO
  
Linha 220: Linha 189:
  
 
|- style="vertical-align:top;"
 
|- style="vertical-align:top;"
|Ignorar
+
|IgnorarEmailXML
 
 
Email XML
 
 
|iex
 
|iex
|Instrui o UniDANFE a ignorar endereços de e-mail dos destinatários presentes nos arquivos XML principal e auxiliar. Os valores aceitos são:
+
|Instrui o UniDANFE a ignorar endereços de e-mail dos destinatários presentes nos arquivos XML do [[Manuais:UniDANFE/Termos|Documento]] e no XML auxiliar. Os valores aceitos são:
 
:* "0” = não ignora nenhum dos e-mails presentes nos XMLs;
 
:* "0” = não ignora nenhum dos e-mails presentes nos XMLs;
 
:* “1” – ignora a TAG <email> presente no XML do Documento Fiscal;
 
:* “1” – ignora a TAG <email> presente no XML do Documento Fiscal;
Linha 245: Linha 212:
 
|Delete
 
|Delete
 
|DL
 
|DL
|Instrui o UniDANFE se este deve deletar (excluir) os arquivos XML envolvidos na geração do documento auxiliar após o término do processo. 1=Sim 0=Não. Se passado o valor “1”, os XML´s serão deletados no final. Qualquer outro valor instrui o UniDANFE a não deletar qualquer arquivo XML.
+
|Instrui o UniDANFE se este deve deletar (excluir) os arquivos XML envolvidos na geração do [[Manuais:UniDANFE/Termos|Documento Auxiliar]] após o término do processo. 1=Sim 0=Não. Se passado o valor “1”, os XML´s serão excluídos no final. Qualquer outro valor instrui o UniDANFE a não remover qualquer arquivo XML.
 
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” DL=1
 
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” DL=1
  
 
|- style="vertical-align:top;"
 
|- style="vertical-align:top;"
|Imprimir
+
|ImprimirProdutos
 
 
Produtos
 
 
|iqp
 
|iqp
 
|Informa ao UniDANFE se o impresso gerado deverá conter a seção/divisão “Detalhe” dos produtos. Específico para DANFE de NFC-e e extrato SAT. 1=Sim 0=Não.
 
|Informa ao UniDANFE se o impresso gerado deverá conter a seção/divisão “Detalhe” dos produtos. Específico para DANFE de NFC-e e extrato SAT. 1=Sim 0=Não.
Linha 261: Linha 226:
 
|ITT
 
|ITT
 
|itt
 
|itt
|Indica ao sistema se deve imprimir ou não o Valor Aproximado de Tributos (Lei da Transparência Fiscal). 1=Sim 0=Não.
+
|Indica ao sistema se deve imprimir ou não o Valor Aproximado de Tributos (Lei da Transparência Fiscal) no quadro de totais do [[Manuais:UniDANFE/Termos|Documento Auxiliar]]. 1=Sim 0=Não.
 
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” itt=0
 
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” itt=0
  
Linha 269: Linha 234:
 
|ITTP
 
|ITTP
 
|ittp
 
|ittp
|Indica ao sistema se deve imprimir ou não o Valor Aproximado de Tributos do Produto (Lei da Transparência Fiscal). 1=Sim 0=Não.
+
|Indica ao sistema se deve imprimir ou não o Valor Aproximado de Tributos (Lei da Transparência Fiscal) no quadro de produtos/servidos do [[Manuais:UniDANFE/Termos|Documento Auxiliar]]. 1=Sim 0=Não.
 
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” ittp=0
 
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” ittp=0
  
Linha 275: Linha 240:
  
 
|- style="vertical-align:top;"
 
|- style="vertical-align:top;"
|Texto
+
|TextoMarcaDagua
 
 
Marca
 
 
 
Dagua
 
 
|tmd
 
|tmd
 
|Texto a ser impresso como marca d´água do documento.
 
|Texto a ser impresso como marca d´água do documento.
Linha 285: Linha 246:
  
 
|- style="vertical-align:top;"
 
|- style="vertical-align:top;"
|Cor
+
|TextoAdicionalEmail
 +
|tae
 +
|Texto a ser inserido no assuntou ou no corpo do e-mail. Pode conter um texto ou um nome de arquivo ".txt", ".htm" ou ".html". Na personalização do e-mail deve ser incluído o campo #texto_adicional_email" no ponto onde o texto adicional deve ser inserido.
 +
|...\unidanfe.exe a="001.xml" tae="Texto para o corpo do e-mail"
 +
...\unidanfe.exe a="001.xml" tae="c:\minhapasta\Meu arquivo com texto para o corpo do e-mail.txt"
  
Marca
 
  
Dagua
+
|- style="vertical-align:top;"
 +
|CorMarcaDagua
 
|cmd
 
|cmd
 
|Cor do texto a ser impresso como marca d´água do documento.
 
|Cor do texto a ser impresso como marca d´água do documento.
Linha 295: Linha 260:
  
 
|- style="vertical-align:top;"
 
|- style="vertical-align:top;"
|PosY
+
|PosYMarcaDagua
 
 
Marca
 
 
 
Dagua
 
 
|ymd
 
|ymd
 
|Posição inicial (vertical) da impressão do texto de marca d´água.
 
|Posição inicial (vertical) da impressão do texto de marca d´água.
Linha 307: Linha 268:
 
|Cancelada
 
|Cancelada
 
|cc
 
|cc
|Esse parâmetro indica ao UniDANFE se este deve imprimir a palavra “CANCELADA” no corpo do documento auxiliar, na diagonal. 1=Sim 0=Não
+
|Esse parâmetro indica ao UniDANFE se este deve imprimir a palavra “CANCELADA” no corpo do [[Manuais:UniDANFE/Termos|Documento Auxiliar]], na diagonal. 1=Sim 0=Não
 
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” CC=1
 
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” CC=1
  
 
|- style="vertical-align:top;"
 
|- style="vertical-align:top;"
|Texto
+
|TextoDiagonal
 
 
Diagonal
 
 
|td
 
|td
|Texto a ser impresso na diagonal, no corpo do documento. Aceita qualquer texto e quando informado, sobrepõe qualquer outro texto definido pelo sistema.
+
|Texto a ser impresso na diagonal, no corpo do Documento. Aceita qualquer texto e quando informado, sobrepõe qualquer outro texto definido pelo sistema.
 
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” TD=”Texto para ser impresso”
 
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” TD=”Texto para ser impresso”
  
 
|- style="vertical-align:top;"
 
|- style="vertical-align:top;"
|Pasta Local
+
|ComprovanteTEF<n>
QRCode (Plus)
 
|plq
 
|Pasta local ou da rede para onde a imagem do QR Code gerada deve ser copiada.
 
|...\unidanfe.exe t=nfce a=“c:\x\0101-procNFe.xml” plq=”c:\meu_erp\imagens\qrcode”
 
 
 
|- style="vertical-align:top;"
 
|Comprovante
 
 
 
TEF<n>
 
 
|ct<n>
 
|ct<n>
 
|Nome do arquivo, incluindo o caminho completo, dos arquivos de texto cujo conteúdo deverão ser impressos no final do DANFE de NFC-e e Extrato SAT, onde <n> é um número de 1 a 9. Pode-se utilizar arquivos textos normais, cujo conteúdo será integralmente impresso, ou os próprios arquivos de resposta de venda gerados pelos sistemas de transmissão de TEF.  
 
|Nome do arquivo, incluindo o caminho completo, dos arquivos de texto cujo conteúdo deverão ser impressos no final do DANFE de NFC-e e Extrato SAT, onde <n> é um número de 1 a 9. Pode-se utilizar arquivos textos normais, cujo conteúdo será integralmente impresso, ou os próprios arquivos de resposta de venda gerados pelos sistemas de transmissão de TEF.  
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” t=NFC-e ct1=tef001.res ct2=tef002.res
+
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” ct1=tef001.res ct2=tef002.res
  
 
|- style="vertical-align:top;"
 
|- style="vertical-align:top;"
|Imprimir
+
|ImprimirApenasComprovanteTEF
 +
|iact
 +
|Indica ao sistema que deverão ser impressos apenas os comprovantes TEF passados na lista anterior (ct1  a ct9), não sendo impresso o DANFE/Extrato. 1=Sim 0=Não
 +
 
 +
NOTA 1: quando esse parâmetro é informado com o valor “1”, apenas a visualização e/ou impressão é realizada, não sendo executadas outras operações como enviar e-mail, gerar pdf, salvar xml, etc. Nesse caso pode-se omitir o parâmetro “arquivo”.
  
Apenas
+
NOTA 2: para usar essa funcionalidade é obrigatório passar o parâmetro "tipo" (t) para o sistema saber qual é o tipo do documento (NFC-e ou CF-e/SAT).
  
Comprovante
+
NOTA 3: você pode imprimir apenas o comprovante TEF ou outros textos semelhantes sem passar o XML do documento, passando um XML específico para isso. [[Manuais:UniDANFE/XMLCoprovanteTEF|Veja aqui como deve ser o XML]].
  
TEF
+
|...\unidanfe.exe a=  ct1=tef001.res ct2=tef002.res iact=1
|iact
 
|Indica ao sistema que deverão ser impressos apenas os comprovantes TEF passados na lista anterior (ct1 a ct9), não sendo impresso o DANFE/Extrato. 1=Sim 0=Não
 
  
NOTA 1: quando esse parâmetro é informado com o valor “1”, apenas a visualização e/ou impressão é realizada, não sendo executadas outras operações como enviar e-mail, gerar pdf, salvar xml, etc. Nesse caso pode-se omitir o parâmetro “arquivo”.
+
|- style="vertical-align:top;"
 +
|Tipo
 +
|t
 +
|
 +
Usado em conjunto com o parâmetro "ImprimirApenasComprovanteTEF", indica ao UniDANFE qual o tipo do impresso para o qual o UniDANFE deve buscar a configuração. As opções válidas são:
 +
:* “nfce” ou “nfc-e”
 +
:* “sat” ou “cfe” ou “cf-e”
  
|...\unidanfe.exe a= t=NFC-e ct1=tef001.res ct2=tef002.res iact=1
+
Qualquer outro valor passado nesse parâmetro será ignorado pelo UniDANFE.
 +
|...\unidanfe.exe a="c:\minhapasta\01010101010-procNFe.xml" t=nfce
  
 
|- style="vertical-align:top;"
 
|- style="vertical-align:top;"
|D
+
|Edicao
 
|d
 
|d
|Força o UniDANFE a executar em uma edição específica (Free ou Plus).
+
|Força o UniDANFE a executar em uma edição específica (Free ou Plus). Se esse parâmetro for omitido, o UniDANFE vai funcionar como:
 +
 
 +
:* Plus = se encontrar a licença ou se o XML estiver em ambiente de homologação (tpAmb=2);
 +
:* Free = se não encontrar a licença e o XML estiver em ambiente de produção (tpAmb=1).
 +
 
 +
NOTA 1: ao usar o parâmetro edicao=Plus, é necessário ter a licença correspondente para que a geração funcione como desejado.
  
NOTA 1: ao usar o parâmetro edição=Plus, é necessário ter a licença correspondente para que a geração funcione como desejado.
 
 
|...\UniDANFE.exe arquivo=0100202020202.xml d=Free
 
|...\UniDANFE.exe arquivo=0100202020202.xml d=Free
  
  
 
|- style="vertical-align:top;"
 
|- style="vertical-align:top;"
|Anexo
+
|Anexo<n>
|Anexo
+
|a<n>
|Passa arquivos externos para serem anexados ao mesmo e-mail enviado ao destinatário do Documento Fiscal (ex: PDF com boletos).
+
|Passa arquivos externos para serem anexados ao mesmo e-mail enviado ao destinatário do [[Manuais:UniDANFE/Termos|Documento Fiscal]] (ex: PDF com boletos).
  
NOTA 1: são permitidos no máximo cinco arquivos anexos externos em um mesmo e-mail.
+
NOTA 1: são permitidos no máximo nove arquivos anexos externos em um mesmo e-mail.
|...\UniDANFE.exe arquivo="12313123213.xml" anexo1="c:\pasta\arquivo1.ext" anexo2="y:\xyxyxy.txt" ...
+
|...\UniDANFE.exe arquivo="12313123213.xml" a1="c:\pasta\arquivo1.ext" a2="y:\xyxyxy.txt" ...
 +
 
 +
|-
 +
!colspan="4"|Parâmetros exclusivos da edição Plus
 +
|-
 +
 
 +
|- style="vertical-align:top;"
 +
|PastaPDF
 +
|pp
 +
|Informa ao UniDANFE a pasta onde devem ser gravados os arquivos [[Manuais:UniDANFE/Termos|PDF]] com a imagem do [[Manuais:UniDANFE/Termos|Documento Auxiliar]] gerado pelo sistema, quando para isso configurado. Esse parâmetro sobrepõe a pasta definida na configuração do UniDANFE. A pasta informada nesse parâmetro deve existir previamente. O nome do [[Manuais:UniDANFE/Termos|PDF]] será criado respeitando-se as regras definidas na configuração do UniDANFE.
 +
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” pp=“c:\meus_pdfs”
 +
 
 +
|- style="vertical-align:top;"
 +
|NomePDF
 +
|np
 +
|Instrui o UniDANFE como deve ser o nome do arquivo [[Manuais:UniDANFE/Termos|PDF]] com a imagem do [[Manuais:UniDANFE/Termos|Documento Auxiliar]] gerado pelo sistema, quando para isso configurado. Esse parâmetro sobrepõe a regra de construção do nome definida na configuração do UniDANFE. Pode ser passado apenas o nome ou o nome incluindo o caminho completo (pastas). Nesse caso, o caminho (pasta) já deve existir previamente.
 +
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” np=“c:\meus_pdfs\01010101010.pdf”
 +
 
 +
|- style="vertical-align:top;"
 +
|CombinarPDF
 +
|cp
 +
|Define se o UniDANFE deve combinar vários arquivos PDF em único PDF.
 +
Geralmente usado em conjunto com os parâmetros "Anexo1", "Anexo2", etc, quando outros PDFs externos podem ser anexados ao e-mail. Os valores aceitos são:
 +
 
 +
:* 0 = não combinar os PDFs;
 +
:* 1 = Combinar todos os PDFs externos junto com o PDF do documento, enviando apenas um único PDF como anexo;
 +
:* 2 = Combinar apenas os PDFs externos, enviando dois PDFs como anexo: o PDF do documento e um PDF combinando todos os PDFs externos.
 +
 
 +
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” cp=1
 +
 
 +
|- style="vertical-align:top;"
 +
|SenhaPDF
 +
|sp
 +
|Define uma senha para o PDF combinado.
 +
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” cp=1 sp="123456"
 +
 
 +
|- style="vertical-align:top;"
 +
|PastaLocalQRCode
 +
|plq
 +
|Pasta local ou da rede para onde a imagem do QRCode da chave de acesso gerada deve ser copiada, no formato "qrcode-" + chaveacesso + ".jpg".
 +
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” plq=”c:\meu_erp\imagens\qrcode”
 +
 
 +
|- style="vertical-align:top;"
 +
|ImprimirQRCodePix
 +
|iqrp
 +
|Informa ao UniDANFE se o QRCode do PIX deve ser impresso no documento auxiliar.
 +
1=Sim 0=Não. Se informado, esse parâmetro se sobrepõe às configurações efetuadas no painel de controle do UniDANFE.
 +
|...\unidanfe.exe iqrp=1 qrp="minha-chave-pix"
 +
...\unidanfe.exe iqrp=1 qrp="http://meu-servidor/minhapasta/meucodigodepagamento.php"
 +
 
 +
|- style="vertical-align:top;"
 +
|QRCodePix
 +
|qrp
 +
|Conteúdo da chave do pix ou link que deve ser codificado no QRCode.
 +
|...\unidanfe.exe iqrp=1 qrp="minha-chave-pix"
 +
 
 +
|- style="vertical-align:top;"
 +
|PastaLocalQRCodePix
 +
|plqrp
 +
|Pasta local ou da rede para onde a imagem do QRCode do Pix gerada deve ser copiada, no formato "qrcodepix-" + chaveacesso + ".jpg".
 +
|...\unidanfe.exe a=“c:\x\0101-procNFe.xml” iqrp=1 plqrp=”c:\meu_erp\imagens\qrcode\pix”
  
 
|-  
 
|-  
 
!colspan="4"|Exemplos
 
!colspan="4"|Exemplos
 
|-
 
|-
|colspan="4"|...\UniDANFE.exe t=nfe a=“c:\unimake\uninfe\nfe000100-nfe.xml” au=“c:\unimake\uninfe\nfe000100danfe.xml” configuracao=PAISAGEM [email protected] L=“c:\img\filial001.jpg”  
+
|colspan="4"|...\UniDANFE.exe a=“c:\unimake\uninfe\nfe000100-nfe.xml” au=“c:\unimake\uninfe\nfe000100danfe.xml” configuracao=PAISAGEM [email protected] L=“c:\img\filial001.jpg”  
 
|-
 
|-
|colspan="4"|...\UniDANFE.exe T=nfe a=“\\meuservidor\c\pasta_xml\0102012.xml” pc=“x:\unimake\uninfe” L=”c:\imagens\logotipo_filial_001.jpg” v=0 i=1 p=2 [email protected]
+
|colspan="4"|...\UniDANFE.exe a=“\\meuservidor\c\pasta_xml\0102012.xml” pc=“x:\unimake\uninfe” L=”c:\imagens\logotipo_filial_001.jpg” v=0 i=1 p=2 [email protected]
 
|-
 
|-
|colspan="4"|...\UniDANFE.exe T=cce A=“c:\minhapasta\010101010101-01-procEventoNFe.xml” N=“c:\minhapasta\010101010101-procNFe.xml”  
+
|colspan="4"|...\UniDANFE.exe A=“c:\minhapasta\010101010101-01-procEventoNFe.xml” N=“c:\minhapasta\010101010101-procNFe.xml”  
 
|-
 
|-
|colspan="4"|...\UniDANFE.exe T=cte A=“c:\minhapasta\010101010101-procCTe.xml”
+
|colspan="4"|...\UniDANFE.exe A=“c:\minhapasta\010101010101-procCTe.xml”
 
|-
 
|-
|colspan="4"|...\UniDANFE.exe T=nfe a=“c:\unimake\uninfe\nfe000100-nfe.xml” c=RETRATO
+
|colspan="4"|...\UniDANFE.exe a=“c:\unimake\uninfe\nfe000100-nfe.xml” c=RETRATO
 
|-
 
|-
|colspan="4"|...\UniDANFE.exe t=nfe a=“c:\unimake\uninfe\nfe000100-nfe.xml” c=SEM_IPI
+
|colspan="4"|...\UniDANFE.exe a=“c:\unimake\uninfe\nfe000100-nfe.xml” c=SEM_IPI
 
|-
 
|-
|colspan="4"|...\UniDANFE.exe t=nfe a=“c:\unimake\uninfe\nfe000100-nfe.xml” [email protected] [email protected]
+
|colspan="4"|...\UniDANFE.exe a=“c:\unimake\uninfe\nfe000100-nfe.xml” [email protected] [email protected]
 
|-
 
|-
|colspan="4"|...\UniDANFE.exe t=nfe a=“c:\unimake\uninfe\nfe000100-nfe.xml” cc=1 delete=1
+
|colspan="4"|...\UniDANFE.exe a=“c:\unimake\uninfe\nfe000100-nfe.xml” cc=1 delete=1
 
|}
 
|}
 
''(*) Parâmetros obrigatórios''
 
''(*) Parâmetros obrigatórios''
  
==NOTAS==
+
==Nota==
# Apesar de ser possível usar os parâmetros com seus nomes longos sem espaços (ex: ArquivoAuxiliar), para economizar o buffer da linha de comando o integrador deve optar por utilizar os parâmetros em sua forma abreviada (ex: au). Exemplos da mesma chamada ao UniDANFE, com parâmetros escritos em sua forma longa e abreviada:
+
Apesar de ser possível usar os parâmetros com seus nomes longos sem espaços (ex: ArquivoAuxiliar), para economizar o buffer da linha de comando o integrador deve optar por utilizar os parâmetros em sua forma abreviada (ex: au). Exemplos da mesma chamada ao UniDANFE, com parâmetros escritos em sua forma longa e abreviada:
#::* ...\UniDANFE.exe arquivo=“1232378213276.xml” arquivoauxiliar=“746647467474.xml” email=“[email protected]
+
::* ...\UniDANFE.exe arquivo=“1232378213276.xml” arquivoauxiliar=“746647467474.xml” email=“[email protected]
#::* ...\UniDANFE.exe a=“1232378213276.xml” au=“746647467474.xml” e=“[email protected]
+
::* ...\UniDANFE.exe a=“1232378213276.xml” au=“746647467474.xml” e=“[email protected]
# "Documento Fiscal Eletrônico" (ou DFE) refere-se à todos os documentos fiscais que podem ser emitidos em sua forma eletrônica, em arquivos XML, como NF-e, NFC-e, CT-e, MDF-e, CF-e SAT, etc.
+
 
# "Documento Auxiliar" refere-se à imagem gráfica do Documento Fiscal Eletrônico que é gerada pelo UniDANFE para facilitar a visualização das informações contidas no XML. São eles:
+
==Veja também==
#::* DANFE - Documento Auxiliar da Nota Fiscal Eletrônica
+
* [[Manuais:UniDANFE/Integrando o UniDANFE ao ERP/Formato da chamada ao UniDANFE|Formato da chamada ao UniDANFE]]
#::* DACTE - Documento Auxiliar do Conhecimento de Transporte Eletrônico
+
* [[Manuais:UniDANFE/Integrando o UniDANFE ao ERP/Exemplos de chamada ao UniDANFE em diversas linguagens|Exemplos de chamada ao UniDANFE em diversas linguagens]]
#::* DAMDFE - Documento Auxiliar do Manifesto de Documentos Fiscais Eletrônicos
+
* [[Manuais:UniDANFE/Integrando o UniDANFE ao ERP/Lista completa dos comandos de integração|Lista completa dos comandos de integração]]
#::* Extrato SAT - Documento Auxiliar do Cupom Fiscal Eletrônico
+
* [[Manuais:UniDANFE/Integrando o UniDANFE ao ERP/XML auxiliar|O XML Auxiliar]]
+
* [[Manuais:UniDANFE/Integrando o UniDANFE ao ERP/TAGS de uso livre|TAGS de uso livre no próprio XML do Documento Fiscal Eletrônico]]

Edição atual tal como às 14h15min de 24 de abril de 2023

Gerar, Imprimir e Distribuir os Documentos Auxiliares

Essa é a forma normal que os sistemas ERP usarão para gerar o Documento Auxiliar. O UniDANFE deve ser executado com a passagem de alguns parâmetros que o orientarão como se comportar.

Cada parâmetro é descrito a seguir, e devem ser utilizados no formato parametro=conteúdo, sem qualquer espaço entre o parâmetro, o sinal de igualdade e o conteúdo do mesmo. Os parâmetros cujo conteúdo possa conter espaços (ex: nome de pastas e/ou arquivos) devem estar entre aspas, no formato parametro=“conteúdo completo com espaços”. Apenas os parâmetros com asterisco (*) são obrigatórios.

Parâmetro Abrev Descrição Exemplos
Arquivo* a Nome completo do arquivo XML do Documento Fiscal Eletrônico, CC-e ou Cancelamento, gerado pelo ERP, incluindo todo o caminho para encontrá-lo. Esse arquivo deve ser o XML de distribuição já autorizado pela SEFAZ (procNFe, procCTe, procMDFe, procEventoNFe, etc).

No caso de integração via DLL unidanfe_dfe.dll, pode-se opcionalmente passar por esse parâmetro o conteúdo do XML ao invés do nome do arquivo.

..\unidanfe.exe a="c:\minha pasta\0101010101010-procNFe.xml"
ArquivoAuxiliar au Nome completo do arquivo XML auxiliar, incluindo todo o caminho para encontrá-lo. No XML auxiliar existem TAGS complementares para o UniDANFE, com algumas personalizações. Se esse parâmetro não for passado, o UniDANFE procurará, na mesma pasta do XML principal, um outro arquivo XML com o mesmo nome, precedido do texto “aux-”. Se encontrar tal arquivo, o usará como auxiliar, sem a necessidade de passar seu nome na linha de comando. ...\unidanfe.exe a="c:\x\0101-procNFe.xml" au="c:\x\aux-0101-procNFe.xml"
ArquivoEPEC ad Nome completo, incluindo todo caminho, do arquivo XML que contém as informações do registro do EPEC. A informação desse arquivo é obrigatória quando necessitar imprimir DANFE de NF-e ou DACTE de CT-e emitido em contingência EPEC antes de sua autorização. O UniDANFE não gerará o Documento Auxiliar em contingência EPEC sem conferir as informações desse arquivo XML. Após a normalização do serviço, quando o XML da NF-e ou do CT-e já contiver o protocolo de autorização de uso, esse parâmetro deixa de ser necessário. ...\unidanfe.exe a="c:\x\0101-procNFe.xml" ad="c:\x\0101-dpec.xml"
DFe n Parâmetro utilizado apenas para impressão da eventos (CC-e, cancelamento). Indica ao UniDANFE o nome completo, incluindo todo o caminho, do arquivo XML da NF-e, NFC-e, CT-e ou MDF-e que está sofrendo correção. Quando esse parâmetro é informado, o UniDANFE vai buscar informações relativas ao emitente, destinatário, remetente, expedidor, recebedor, etc., nesse arquivo XML. Quando esse parâmetro é omitido, o UniDANFE busca primeiramente em sua base de dados essas informações e, em não as localizando, procura pelo XML da NF-e/CT-e na mesma pasta do XML do evento da CC-e, nos padrões “chavedeacesso-procXXX.xml” e “chavedeacesso-XXX.xml”, onde XXX=NFe ou CTe, conforme o caso. ...\unidanfe.exe a="c:\x\0101-1-procEventoNFe.xml" n="c:\x\0101-procNFe.xml"
AnexarDFe an Parâmetro utilizado apenas para impressão da Carta de Correção Eletrônica. Deve ser utilizado em conjunto com o parâmetro "DFe". Indica ao UniDANFE se o Documento Auxiliar (DANFE, DACTE, etc) deve ser anexado ao impresso da CC-e. 0=Não 1=Sim (antes da CC-e) 2=Sim (depois da CC-e). Se informado, esse parâmetro se sobrepõe às configurações efetuadas no painel de controle do UniDANFE. ...\unidanfe.exe a="c:\x\0101-1-procEventoNFe.xml" n="c:\x\0101-procNFe.xml" an=1


Configuracao c Nome da configuração que será utilizada para gerar o Documento Auxiliar. Se esse parâmetro não for passado, o UniDANFE tentará localizar a configuração ideal automaticamente. Clique aqui para conhecer os critérios de escolha automática da configuração.

Atenção: Para esse parâmetro funcionar é necessário que a configuração passada tenha sido previamente cadastrada no UniDANFE.

...\unidanfe.exe a="c:\x\0101-procNFe.xml" c=RETRATO

...\unidanfe.exe a="c:\x\0101-procNFe.xml" c=PAISAGEM

...\unidanfe.exe a="c:\x\0101-procNFe.xml" c=APENAS_GERAR_PDF

...\unidanfe.exe a="c:\x\0101-procNFe.xml" c=APENAS_UPLOAD

...\unidanfe.exe a="c:\x\0101-procNFe.xml" c=APENAS_EMAIL

...\unidanfe.exe a="c:\x\0101-procNFe.xml" c=APENAS_VISUALIZAR

Email e Endereço de e-mail adicional para envio ao destinatário do Documento. Esse e-mail deve ser informado nos casos em que o XML do documento não tenha TAGS específicas para isso - como XML de CC-e e Cancelamento - ou quando deseja-se enviar o Documento para um endereço diferente. O e-mail também pode ser gerado no XML auxiliar, ao invés de passado por parâmetro. ...\unidanfe.exe a=“c:\x\0101-procNFe.xml” [email protected]

...\unidanfe.exe a=“c:\x\0101-procNFe.xml” e=“[email protected],[email protected]

EmailCC ec Endereço para o qual o Documento e/ou o XML serão enviados como cópia (CC). ...\unidanfe.exe a=“c:\x\0101-procNFe.xml” [email protected] [email protected]
EmailCCO eo Endereço para o qual o Documento e/ou o XML serão enviados como cópia oculta (CCO). ...\unidanfe.exe a=“c:\x\0101-procNFe.xml” [email protected] [email protected]
EnviaEmail ee Informa ao UniDANFE se o impresso gerado deverá ser enviado por e-mail ou não. 1=Sim 0=Não. Se informado, esse parâmetro se sobrepõe às configurações efetuadas no painel de controle do UniDANFE. ...\unidanfe.exe a=“c:\x\0101-procNFe.xml” ee=0

...\unidanfe.exe a=“c:\x\0101-procNFe.xml” ee=1

PastaConfiguracao pc Define a pasta local ou da rede onde o UniDANFE deve ler/gravar suas configurações. Deve ser informado o nome da pasta principal que irá abrigar as subpastas (dados, email, lic, etc) utilizadas pelo UniDANFE.

Informar apenas nos casos em que a pasta das configurações seja diferente da pasta onde o UniDANFE está instalado. Por exemplo, instala-se o UniDANFE em C:\UniDANFE mas a base de dados está em um servidor de rede, compartilhada entre todos os usuários, como S:\Sistemas\UniDANFE.

...\unidanfe.exe a=“c:\x\0101-procNFe.xml” pc=“Y:\unimake\uninfe”

...\unidanfe.exe a=“c:\x\0101-procNFe.xml” pc=“\\SERVER01\G\unimake\uninfe”

Logotipo L Nome da imagem, incluindo seu caminho completo, que será usada na geração do Documento Auxiliar. Há um campo específico da interface de configuração do UniDANFE para informar esse arquivo de imagem. No entanto, em alguns casos, deseja-se utilizar uma mesma configuração para mais de uma empresa/filial. Para esses casos, pode-se passar a imagem através da linha de comando, ou informá-la no XML auxiliar. Uma outra forma é salvar o logotipo na pasta imagens\logotipos dentro da pasta de instalação do UniDANFE, com o nome do arquivo igual ao CNPJ do emitente, sem pontos e traços. Nesse caso, o UniDANFE fará a impressão do logotipo para todos os impressos sempre que emitir um documento desse emitente (ex: C:\UniDANFE\imagens\logotipos\06117473000150.jpg). ...\unidanfe.exe a=“c:\x\0101-procNFe.xml” L=“c:\imagens\img01.jpg”
Visualizar v Informa ao UniDANFE se o Documento Auxiliar gerado deverá ser visualizado na tela do computador antes da impressão/envio por e-mail. 1=Sim 0=Não. Se informado, esse parâmetro se sobrepõe às configurações efetuadas no painel de controle do UniDANFE. ...\unidanfe.exe a=“c:\x\0101-procNFe.xml” v=0

...\unidanfe.exe a=“c:\x\0101-procNFe.xml” v=1

Imprimir m Informa ao UniDANFE se o Documento Auxiliar deve ser impresso automaticamente ou não. 1=Sim 0=Não. Se informado, esse parâmetro se sobrepõe às configurações efetuadas no painel de controle do UniDANFE. ...\unidanfe.exe a=“c:\x\0101-procNFe.xml” v=0 m=1 // imprimir sem visualizar

...\unidanfe.exe a=“c:\x\0101-procNFe.xml” v=1 m=0 // visualizar sem imprimir

...\unidanfe.exe a=“c:\x\0101-procNFe.xml” v=0 m=0 // envia e-mail sem visualizar ou imprimir

Impressora i Informa em qual impressora o Documento deve ser impresso. Aceita os valores “padrao", “selecionar” ou “<nome completo da impressora>”; se informado o valor “padrao", o impresso será enviado para a impressora padrão do computador; se informado “selecionar”, uma tela será exibida ao usuário antes da impressão, para que este selecione a impressora correta; se informado o nome de uma impressora instalada, o UniDANFE imprimirá o Documento nessa impressora. No caso de utilizar impressora de rede, é recomendável passar o nome da impressora tal qual aparece na tela de configuração "Impressora e Scanners" do Windows e não utilizar o formato "\\SERVER\IMPRESSORA". ...\unidanfe.exe a=“c:\x\0101-procNFe.xml” i=“SAMSUNG M4020ND”
NomeImpressao ni Define o texto que vai aparecer no gerenciador de impressão do Windows. Se não informado o texto padrão é gerado pelo UniDANFE. ...\unidanfe.exe a=“c:\x\0101-procNFe.xml” ni=“NF=00123 CAIXA=001 OP=JUNIOR”


LarguraBobina lb Informa ao UniDANFE a largura do papel em milímetros quando se tratar de impressão em bobina. ...\unidanfe.exe a=“c:\x\0101-procNFe.xml” lb=80 // imprimir em papel bobina de 80mm de largura
Copias p Informa ao UniDANFE quantas cópias devem ser impressas do Documento gerado. ...\unidanfe.exe a=“c:\x\0101-procNFe.xml” v=0 i=1 p=3 // imprimir 3 cópias, sem visualizar


ImagemAdicional ia Nome completo, incluindo o caminho, de uma imagem para ser impressa no rodapé da seção “DADOS ADICIONAIS”, dentro do quadro “Informações Complementares”. Válido apenas para impressão do DANFE de NF-e em orientação RETRATO. ...\unidanfe.exe a=“c:\x\0101-procNFe.xml” ia=“c:\imagens\info.bmp”
AlturaImagemAdicional iaa Altura, em milésimos de polegadas, com que a imagem adicional vai ser impressa. Essa altura será adicionada ao quadro “Dados Adicionais”. Se omitido, o valor padrão 1000 (aproximadamente 25mm) é assumido. Válido apenas para impressão do DANFE em orientação RETRATO. ...\unidanfe.exe a=“c:\x\0101-procNFe.xml” ia=“c:\imagens\info.bmp” iaa=650
Saida_Erros s Define onde devem ser geradas as possíveis mensagens de erro do sistema. V=vídeo A=Arquivo N=não gerar. Útil para os casos em que a impressão e envio por e-mail do Documento Auxiliar seja configurada para ser executada automaticamente sem a intervenção de usuários. Se Saida_Erros=A e o parâmetro ArquivoErros for omitido, ArquivoErros será o mesmo nome do XML acrescido da extensão “.err”. Saida_erros=N será útil quando estiver utilizando o UniDANFE como DLL e o erro será retornado pelo método DFEGETERRO(). ...\unidanfe.exe a=“c:\x\0101-procNFe.xml” s=V

...\unidanfe.exe a=“c:\x\0101-procNFe.xml” s=A

DFESetParametro('saida_erros', 'N')

ArquivoErros ae Define o nome do arquivo que vai receber os erros ocorridos durante a geração do Documento Auxiliar, se houver. ...\unidanfe.exe a=“c:\x\0101-procNFe.xml” s=A ae=“c:\erros\meus_erros.xml”
Remetente r E-mail ou apelido do remetente de e-mail que deve ser utilizado para o envio do Documento por e-mail. O remetente deve estar previamente cadastrado no sistema mesmo quando este parâmetro contiver um endereço eletrônico (e-mail) pois outras informações são necessárias para o envio do e-mail, como servidor SMTP, porta, senha, etc. É possível cadastrar remetentes informando o CNPJ do emitente no campo “Apelido” para que o mesmo seja selecionado automaticamente. Consulte a seção “Configurando as Contas de Remetentes” para maiores detalhes. É possível informar o remetente também noXML auxiliar ou nas TAG´s de uso livre. ...\unidanfe.exe a=“c:\x\0101-procNFe.xml” r=FATURAMENTO

...\unidanfe.exe a=“c:\x\0101-procNFe.xml” [email protected]

IgnorarEmailXML iex Instrui o UniDANFE a ignorar endereços de e-mail dos destinatários presentes nos arquivos XML do Documento e no XML auxiliar. Os valores aceitos são:
  • "0” = não ignora nenhum dos e-mails presentes nos XMLs;
  • “1” – ignora a TAG <email> presente no XML do Documento Fiscal;
  • “2” – ignora os e-mails informado na TAG <obsCont> do XML do Documento Fiscal, atributos Email_Destinatario, Email_CC e Email_CCO;
  • “3” – ignora os e-mails informados no XML auxiliar, nas TAGs <EmailDest>, <EmailCC> e <EmailCCO>

NOTA 1: com exceção do valor “0”, todos os outros podem ser combinados num mesmo parâmetro.

NOTA 2: o valor “2” não se aplica à emissão de CC-e.

...\UniDANFE.exe a=0101010.xml iex=1

...\UniDANFE.exe a=0101010.xml iex=23

...\UniDANFE.exe a=0101010.xml iex=13

...\UniDANFE.exe a=0101010.xml iex=123

Delete DL Instrui o UniDANFE se este deve deletar (excluir) os arquivos XML envolvidos na geração do Documento Auxiliar após o término do processo. 1=Sim 0=Não. Se passado o valor “1”, os XML´s serão excluídos no final. Qualquer outro valor instrui o UniDANFE a não remover qualquer arquivo XML. ...\unidanfe.exe a=“c:\x\0101-procNFe.xml” DL=1
ImprimirProdutos iqp Informa ao UniDANFE se o impresso gerado deverá conter a seção/divisão “Detalhe” dos produtos. Específico para DANFE de NFC-e e extrato SAT. 1=Sim 0=Não. ...\unidanfe.exe a=“c:\x\0101-procNFe.xml” iqp=0

...\unidanfe.exe a=“c:\x\0101-procNFe.xml” iqp=1

ITT itt Indica ao sistema se deve imprimir ou não o Valor Aproximado de Tributos (Lei da Transparência Fiscal) no quadro de totais do Documento Auxiliar. 1=Sim 0=Não. ...\unidanfe.exe a=“c:\x\0101-procNFe.xml” itt=0

...\unidanfe.exe a=“c:\x\0101-procNFe.xml” itt=1

ITTP ittp Indica ao sistema se deve imprimir ou não o Valor Aproximado de Tributos (Lei da Transparência Fiscal) no quadro de produtos/servidos do Documento Auxiliar. 1=Sim 0=Não. ...\unidanfe.exe a=“c:\x\0101-procNFe.xml” ittp=0

...\unidanfe.exe a=“c:\x\0101-procNFe.xml” ittp=1

TextoMarcaDagua tmd Texto a ser impresso como marca d´água do documento.
TextoAdicionalEmail tae Texto a ser inserido no assuntou ou no corpo do e-mail. Pode conter um texto ou um nome de arquivo ".txt", ".htm" ou ".html". Na personalização do e-mail deve ser incluído o campo #texto_adicional_email" no ponto onde o texto adicional deve ser inserido. ...\unidanfe.exe a="001.xml" tae="Texto para o corpo do e-mail"

...\unidanfe.exe a="001.xml" tae="c:\minhapasta\Meu arquivo com texto para o corpo do e-mail.txt"


CorMarcaDagua cmd Cor do texto a ser impresso como marca d´água do documento.
PosYMarcaDagua ymd Posição inicial (vertical) da impressão do texto de marca d´água. ...\unidanfe.exe a="001.xml" tmd="Texto para a marca d´água" cmd="#cc0000" ymd=180
Cancelada cc Esse parâmetro indica ao UniDANFE se este deve imprimir a palavra “CANCELADA” no corpo do Documento Auxiliar, na diagonal. 1=Sim 0=Não ...\unidanfe.exe a=“c:\x\0101-procNFe.xml” CC=1
TextoDiagonal td Texto a ser impresso na diagonal, no corpo do Documento. Aceita qualquer texto e quando informado, sobrepõe qualquer outro texto definido pelo sistema. ...\unidanfe.exe a=“c:\x\0101-procNFe.xml” TD=”Texto para ser impresso”
ComprovanteTEF<n> ct<n> Nome do arquivo, incluindo o caminho completo, dos arquivos de texto cujo conteúdo deverão ser impressos no final do DANFE de NFC-e e Extrato SAT, onde <n> é um número de 1 a 9. Pode-se utilizar arquivos textos normais, cujo conteúdo será integralmente impresso, ou os próprios arquivos de resposta de venda gerados pelos sistemas de transmissão de TEF. ...\unidanfe.exe a=“c:\x\0101-procNFe.xml” ct1=tef001.res ct2=tef002.res
ImprimirApenasComprovanteTEF iact Indica ao sistema que deverão ser impressos apenas os comprovantes TEF passados na lista anterior (ct1 a ct9), não sendo impresso o DANFE/Extrato. 1=Sim 0=Não

NOTA 1: quando esse parâmetro é informado com o valor “1”, apenas a visualização e/ou impressão é realizada, não sendo executadas outras operações como enviar e-mail, gerar pdf, salvar xml, etc. Nesse caso pode-se omitir o parâmetro “arquivo”.

NOTA 2: para usar essa funcionalidade é obrigatório passar o parâmetro "tipo" (t) para o sistema saber qual é o tipo do documento (NFC-e ou CF-e/SAT).

NOTA 3: você pode imprimir apenas o comprovante TEF ou outros textos semelhantes sem passar o XML do documento, passando um XML específico para isso. Veja aqui como deve ser o XML.

...\unidanfe.exe a= ct1=tef001.res ct2=tef002.res iact=1
Tipo t

Usado em conjunto com o parâmetro "ImprimirApenasComprovanteTEF", indica ao UniDANFE qual o tipo do impresso para o qual o UniDANFE deve buscar a configuração. As opções válidas são:

  • “nfce” ou “nfc-e”
  • “sat” ou “cfe” ou “cf-e”

Qualquer outro valor passado nesse parâmetro será ignorado pelo UniDANFE.

...\unidanfe.exe a="c:\minhapasta\01010101010-procNFe.xml" t=nfce
Edicao d Força o UniDANFE a executar em uma edição específica (Free ou Plus). Se esse parâmetro for omitido, o UniDANFE vai funcionar como:
  • Plus = se encontrar a licença ou se o XML estiver em ambiente de homologação (tpAmb=2);
  • Free = se não encontrar a licença e o XML estiver em ambiente de produção (tpAmb=1).

NOTA 1: ao usar o parâmetro edicao=Plus, é necessário ter a licença correspondente para que a geração funcione como desejado.

...\UniDANFE.exe arquivo=0100202020202.xml d=Free


Anexo<n> a<n> Passa arquivos externos para serem anexados ao mesmo e-mail enviado ao destinatário do Documento Fiscal (ex: PDF com boletos).

NOTA 1: são permitidos no máximo nove arquivos anexos externos em um mesmo e-mail.

...\UniDANFE.exe arquivo="12313123213.xml" a1="c:\pasta\arquivo1.ext" a2="y:\xyxyxy.txt" ...
Parâmetros exclusivos da edição Plus
PastaPDF pp Informa ao UniDANFE a pasta onde devem ser gravados os arquivos PDF com a imagem do Documento Auxiliar gerado pelo sistema, quando para isso configurado. Esse parâmetro sobrepõe a pasta definida na configuração do UniDANFE. A pasta informada nesse parâmetro deve existir previamente. O nome do PDF será criado respeitando-se as regras definidas na configuração do UniDANFE. ...\unidanfe.exe a=“c:\x\0101-procNFe.xml” pp=“c:\meus_pdfs”
NomePDF np Instrui o UniDANFE como deve ser o nome do arquivo PDF com a imagem do Documento Auxiliar gerado pelo sistema, quando para isso configurado. Esse parâmetro sobrepõe a regra de construção do nome definida na configuração do UniDANFE. Pode ser passado apenas o nome ou o nome incluindo o caminho completo (pastas). Nesse caso, o caminho (pasta) já deve existir previamente. ...\unidanfe.exe a=“c:\x\0101-procNFe.xml” np=“c:\meus_pdfs\01010101010.pdf”
CombinarPDF cp Define se o UniDANFE deve combinar vários arquivos PDF em único PDF.

Geralmente usado em conjunto com os parâmetros "Anexo1", "Anexo2", etc, quando outros PDFs externos podem ser anexados ao e-mail. Os valores aceitos são:

  • 0 = não combinar os PDFs;
  • 1 = Combinar todos os PDFs externos junto com o PDF do documento, enviando apenas um único PDF como anexo;
  • 2 = Combinar apenas os PDFs externos, enviando dois PDFs como anexo: o PDF do documento e um PDF combinando todos os PDFs externos.
...\unidanfe.exe a=“c:\x\0101-procNFe.xml” cp=1
SenhaPDF sp Define uma senha para o PDF combinado. ...\unidanfe.exe a=“c:\x\0101-procNFe.xml” cp=1 sp="123456"
PastaLocalQRCode plq Pasta local ou da rede para onde a imagem do QRCode da chave de acesso gerada deve ser copiada, no formato "qrcode-" + chaveacesso + ".jpg". ...\unidanfe.exe a=“c:\x\0101-procNFe.xml” plq=”c:\meu_erp\imagens\qrcode”
ImprimirQRCodePix iqrp Informa ao UniDANFE se o QRCode do PIX deve ser impresso no documento auxiliar.

1=Sim 0=Não. Se informado, esse parâmetro se sobrepõe às configurações efetuadas no painel de controle do UniDANFE.

...\unidanfe.exe iqrp=1 qrp="minha-chave-pix"

...\unidanfe.exe iqrp=1 qrp="http://meu-servidor/minhapasta/meucodigodepagamento.php"

QRCodePix qrp Conteúdo da chave do pix ou link que deve ser codificado no QRCode. ...\unidanfe.exe iqrp=1 qrp="minha-chave-pix"
PastaLocalQRCodePix plqrp Pasta local ou da rede para onde a imagem do QRCode do Pix gerada deve ser copiada, no formato "qrcodepix-" + chaveacesso + ".jpg". ...\unidanfe.exe a=“c:\x\0101-procNFe.xml” iqrp=1 plqrp=”c:\meu_erp\imagens\qrcode\pix”
Exemplos
...\UniDANFE.exe a=“c:\unimake\uninfe\nfe000100-nfe.xml” au=“c:\unimake\uninfe\nfe000100danfe.xml” configuracao=PAISAGEM [email protected] L=“c:\img\filial001.jpg”
...\UniDANFE.exe a=“\\meuservidor\c\pasta_xml\0102012.xml” pc=“x:\unimake\uninfe” L=”c:\imagens\logotipo_filial_001.jpg” v=0 i=1 p=2 [email protected]
...\UniDANFE.exe A=“c:\minhapasta\010101010101-01-procEventoNFe.xml” N=“c:\minhapasta\010101010101-procNFe.xml”
...\UniDANFE.exe A=“c:\minhapasta\010101010101-procCTe.xml”
...\UniDANFE.exe a=“c:\unimake\uninfe\nfe000100-nfe.xml” c=RETRATO
...\UniDANFE.exe a=“c:\unimake\uninfe\nfe000100-nfe.xml” c=SEM_IPI
...\UniDANFE.exe a=“c:\unimake\uninfe\nfe000100-nfe.xml” [email protected] [email protected]
...\UniDANFE.exe a=“c:\unimake\uninfe\nfe000100-nfe.xml” cc=1 delete=1

(*) Parâmetros obrigatórios

Nota

Apesar de ser possível usar os parâmetros com seus nomes longos sem espaços (ex: ArquivoAuxiliar), para economizar o buffer da linha de comando o integrador deve optar por utilizar os parâmetros em sua forma abreviada (ex: au). Exemplos da mesma chamada ao UniDANFE, com parâmetros escritos em sua forma longa e abreviada:

  • ...\UniDANFE.exe arquivo=“1232378213276.xml” arquivoauxiliar=“746647467474.xml” email=“[email protected]
  • ...\UniDANFE.exe a=“1232378213276.xml” au=“746647467474.xml” e=“[email protected]

Veja também