Manuais:UniDANFE/Integrando o UniDANFE ao ERP/MetodosDLL
Métodos da DLL dfe.dll
Essa é a forma mais elegante que os sistemas ERP usarão para gerar o Documento Auxiliar. A DLL dfe.dll dO UniDANFE deve ser linkada ao sistema ERP, que fará a integração utilizando o conjunto de métodos disponíveis na biblioteca.
| 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). | ..\unidanfe.exe a="c:\minha pasta\0101010101010-procNFe.xml" |
| Tipo | t | Indica ao UniDANFE qual o tipo do XML passado pelo parâmetro “arquivo”. As opções válidas são:
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:\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 |
| Arquivo
Auxiliar |
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" |
| Arquivo
EPEC |
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" |
| NFe | 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. | ...\unidanfe.exe a="c:\x\0101-1-procEventoNFe.xml" n="c:\x\0101-procNFe.xml" |
| 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 |
| 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 |
| Pasta
Configuracao |
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. | ...\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. | ...\unidanfe.exe a=“c:\x\0101-procNFe.xml” i=“\\SERVER\HPLASERJET1001” |
| 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 |
| PastaPDF
(Plus) |
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
(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” |
| Imagem
Adicional |
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” |
| Altura
Imagem Adicional |
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. Ú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”. | ...\unidanfe.exe a=“c:\x\0101-procNFe.xml” s=V
...\unidanfe.exe a=“c:\x\0101-procNFe.xml” s=A |
| Arquivo
Erros |
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.txt” |
| 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] |
| Ignorar
Email XML |
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:
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 |
| Imprimir
Produtos |
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 |
| Texto
Marca Dagua |
tmd | Texto a ser impresso como marca d´água do documento. | |
| Cor
Marca Dagua |
cmd | Cor do texto a ser impresso como marca d´água do documento. | |
| PosY
Marca Dagua |
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 |
| Texto
Diagonal |
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” |
| Pasta Local
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” |
| Comprovante
TEF<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” t=NFC-e ct1=tef001.res ct2=tef002.res |
| Imprimir
Apenas Comprovante TEF |
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”. |
...\unidanfe.exe a= t=NFC-e ct1=tef001.res ct2=tef002.res iact=1 |
| D | d | Força o UniDANFE a executar em uma edição específica (FREE ou Plus).
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
|
| Anexo | Anexo | 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 cinco arquivos anexos externos em um mesmo e-mail. |
...\UniDANFE.exe arquivo="12313123213.xml" anexo1="c:\pasta\arquivo1.ext" anexo2="y:\xyxyxy.txt" ... |
| Exemplos | |||
| ...\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” | |||
| ...\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] | |||
| ...\UniDANFE.exe T=cce A=“c:\minhapasta\010101010101-01-procEventoNFe.xml” N=“c:\minhapasta\010101010101-procNFe.xml” | |||
| ...\UniDANFE.exe T=cte A=“c:\minhapasta\010101010101-procCTe.xml” | |||
| ...\UniDANFE.exe T=nfe a=“c:\unimake\uninfe\nfe000100-nfe.xml” c=RETRATO | |||
| ...\UniDANFE.exe t=nfe a=“c:\unimake\uninfe\nfe000100-nfe.xml” c=SEM_IPI | |||
| ...\UniDANFE.exe t=nfe a=“c:\unimake\uninfe\nfe000100-nfe.xml” [email protected] [email protected] | |||
| ...\UniDANFE.exe t=nfe 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]”
