Manuais:UniDANFE/Integrando o UniDANFE ao ERP/XML auxiliar/Estrutura
Estrutura do XML auxiliar
O XML Auxiliar deve ter a estrutura abaixo. Observe que todas as TAGS são opcionais.
<?xml version="1.0" encoding="UTF-8"?> <outrasInf> <emailDest>EMAIL DO DESTINATÁRIO</emailDest> <emailCC>EMAIL PARA ENVIAR CÓPIA</emailCC> <emailCCO>EMAIL PARA ENVIAR CÓPIA OCULTA</emailCCO> <remetente>email ou apelido do remetente previamente cadastrado no UniDANFE</remetente> <textoAdicionalEmail>Texto ou nome de arquivo para ser inserido no corpo do e-mail</textoAdicionalEmail> <logotipo>c:\teste\imagem001.jpg</logotipo> <copias>2</copias> <configuracao>RETRATO</configuracao> <poweredBy>Unimake Softwares</poweredBy> <poweredSite>www.unimake.com.br</poweredSite> <codigoDest>01982</codigoDest> <textoCanhoto>Recebemos de MINHA EMPRESA LTDA a Nota Fiscal 0101010 indicada ao lado</textoCanhoto> <imagemAdicional>c:\teste\nota_abnt_nbr_3758.jpg</imagemAdicional> <alturaImagemAdicional>1000</alturaImagemAdicional> <imprimirProdutos>1</imprimirProdutos> <imprimirTotalTributos>1</imprimirTotalTributos> <imprimirTotalTributosProduto>1</imprimirTotalTributosProduto> <imprimirValorUnitarioLiquido>0</imprimirValorUnitarioLiquido> <imprimirValorTotalLiquido>9</imprimirValorTotalLiquido> <pastaLocalQRCode>c:\Meu_Erp\MinhasImagens\QRCode</pastaLocalQRCode> <imprimirQRCodePix>1</imprimirQRCodePix> <qrCodePix>minha-chave-pix-aqui</qrCodePix> <pastaLocalQRCodePix>c:\Meu_Erp\MinhasImagens\QRCodePix</pastaLocalQRCodePix> <textoMarcaDagua>Texto para imprimir como marca dágua. A cor deve ser em html e a PosY deve ser em milímetros</textoMarcaDagua> <corMarcaDagua>#cc0000</corMarcaDagua> <posYMarcaDagua>180</posYMarcaDagua> <textoDiagonal>texto para ser impresso na diagonal</textoDiagonal> <nomeImpressao>NF=00123 CAIXA=001 OP=JUNIOR</nomeImpressao> <anexo1>c:\pasta\meu_arquivo_externo.pdf</anexo1> <combinarPDF>1</combinarPDF> <senhaPDF>123456</senhaPDF> <descricaoAnexo1>Arquivo PDF com os boletos das parcelas da compra ref. pedido 99999</descricaoAnexo1> <produtos> <produto1> <colunaLivre>300 KG</colunaLivre> <infAdVeic>Nota Fiscal de Entrada: 01010101 Data: 01/01/2001 BLA BLA BLA</infAdVeic> </produto1> <produto2> <colunaLivre>221 KG</colunaLivre> <aux_cor>Verde</aux_cor> <aux_tamanho>P</aux_tamanho> <aux_outra_tag>Conteúdo de qualquer campo do cadastro do produto, ou da venda, etc</aux_outra_tag> <infAdVeic>Nota Fiscal de Entrada: 02020202 Data: 02/02/2002 BLA BLA BLA</infAdVeic> </produto2> </produtos> <fatura> <parcela1> <nValor>100.01</nValor> <dVencto>2024-01-10</dVencto> </parcela1> <parcela2> <nValor>100.02</nValor> <dVencto>2024-02-10</dVencto> </parcela2> </fatura> </outrasInf>
TAGS do XML auxiliar
As TAGS seguintes serão tratadas pelo UniDANFE se existirem no XML auxiliar. Qualquer outra TAG, não listada aqui, será ignorada se existir nesse XML.
TAGS comuns a todos tipos de documentos | |
---|---|
Encoding | Conjunto de caracteres do XML. Válidos: "UTF-8" e "ISO-8859-1". |
<outrasInf> | Grupo de TAGS principal. Essa TAG é a única obrigatória no XML auxiliar.
|
<emailDest> | Endereço eletrônico do destinatário. Esse endereço será usado pelo UniDANFE para enviar e-mail ao destinatário contendo o documento (DANFE, DACTE ou CC-e) e/ou o XML principal, como anexo(s). |
<emailCC> | Endereço eletrônico do destinatário para onde o e-mail deve ser enviado como cópia. |
<emailCCO> | Endereço eletrônico do destinatário para onde o e-mail deve ser enviado como cópia oculta. |
<textoAdicionalEmail> | 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. |
<remetente> | Endereço eletrônico ou apelido do remetente de e-mails. O conteúdo dessa TAG será utilizado pelo UniDANFE para localizar o registro correspondente ao remetente desejado na tabela de remetentes cadastrados no sistema. O remetente deve estar previamente cadastrado no sistema. Consulte a seção "Configurando as Contas de Remetentes" para maiores detalhes. |
<logotipo> | Imagem que contém o logotipo do emitente, para ser impresso no quadro correspondente; |
<copias> | Número de cópias (vias) em que o documento (DANFE, DACTE ou CC-e) deve ser gerado/impresso; |
<configuracao> | Configuração do UniDANFE que será usada para a geração/impressão do documento (DANFE, DACTE ou CC-e); |
<poweredBy> | Publicidade que é impressa no rodapé do impresso. Nome da empresa desenvolvedora do sistema; |
<poweredSite> | Site da empresa desenvolvedora do sistema, impresso junto com o conteúdo da tag <poweredBy>; |
<nomeImpressao> | Texto que vai aparecer no gerenciador de impressão do Windows. Se não informado o texto padrão é gerado pelo UniDANFE; |
<imprimirTotalTributos> | Indica ao sistema se deve imprimir o total aproximado de tributos (Lei da Transparência Fiscal); |
<anexo1> | Outros arquivos que devem ser anexados ao e-mail. Aceita desde <anexo1> até <anexo9>; |
<descricaoAnexo1> | Descrição do arquivo informado em <Anexo1>. Aceita desde <descricaoAnexo1> até <descricaoAnexo9>; |
<combinarPDF> | Define se o UniDANFE deve combinar vários arquivos PDF em único PDF.
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. |
<senhaPDF> | Define uma senha para o PDF combinado. |
<pastaLocalQRCode>(Plus) | Indica uma pasta local ou da rede para onde a imagem do QRCode da chave de acesso gerada deve ser copiada para posterior utilização pelo sistema ERP do cliente. |
<imprimirQRCodePix>(Plus) | Indica ao sistema se deve imprimir o QRCode do PIX no documento auxiliar. Aceita os valores "1" (sim) ou "0" (não). |
<qrCodePix>(Plus) | Chave do pix que deve ser codificada no QRCode. |
<pastaLocalQRCodePix>(Plus) | Indica uma pasta local ou da rede para onde a imagem do QRCode do Pix gerada deve ser copiada para posterior utilização pelo sistema ERP do cliente.
|
Fatura: | |
<fatura> | Grupo de TAGS onde é possível informar parcelamento para os tipos de impresso que não tem esse conjunto de TAGs no XML, como é o caso da NFS-e.
|
Outras TAGS utilizadas no DANFE de NF-e: | |
<textoCanhoto> | Redefinição do texto padrão impresso no canhoto do DANFE. O texto que for definido nessa TAG será impresso integralmente, sobrepondo-se ao padrão atual do sistema. |
<imagemAdicional> | Nome completo, incluindo o caminho, de uma imagem para ser impressa no rodapé da seção "DADOS ADICIONAIS", dentro do quadro "Informações Complementares". sistema. Válido apenas para impressão do DANFE em orientação RETRATO. |
<alturaImagemAdicional> | 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. |
<produtos> | TAGS utilizadas para informações complementares aos produtos. É um recurso especial do UniDANFE para suprir necessidades que o XML auxiliar não contempla. Através dessas TAGS, é possível incluir uma coluna livre (Free) no DANFE, ou definir colunas específicas (Plus) iniciadas com o prefixo "Aux_" para utilização através das configurações de colunas, presentes no UniDANFE Plus. |
<produto?> | Abre um grupo de TAGS de produtos. Deve ser aberta uma TAG de grupo de produtos para cada produto constante no XML auxiliar. O símbolo "?" presente nessa TAG deve ser substituído pelo mesmo número de sequência presente na TAG de grupo <det nItem="?"> do XML principal. |
<colunaLivre>(Free) | O conteúdo dessa TAG será impresso na coluna correspondente do DANFE, desde que previamente configurado na interface amigável do UniDANFE. É utilizada para imprimir conteúdos do cadastro de produtos ou dos itens das vendas que não estejam presentes na estrutura do XML principal. Para maiores detalhes a respeito dessa configuração, consulte a seção "Coluna Livre".
Atenção: se você estiver imprimindo DANFE´s em ambiente de homologação, o UniDANFE se comporta como edição Plus e não imprime os dados da coluna livre. Para contornar isso, ao carregar o UniDANFE passe o parâmetro indicando que quer utilizar especificamente a edição free. Ex: UniDANFE.exe a=01010101.xml d=free |
<aux_nnnnnn>(Plus) | No UniDANFE Plus é possível configurar cada coluna que será impressa no DANFE, bem como mudar sua posição, e inclusive remover colunas não utilizadas, como valor e alíquota de IPI para empresas que não utilizem esse imposto, por exemplo. Também é possível adicionar novas colunas do DANFE. Nesse caso, podem ser adicionadas qualquer TAG do grupo <det> do XML principal, ou mesmo outras que não existam nesse XML principal. Por exemplo, para adicionar no DANFE, logo após a descrição do produto uma coluna contendo a cor do mesmo, basta incluir a coluna <aux_Cor> na configuração do UniDANFE, e gerar no XML auxiliar a mesma TAG com seu respectivo conteúdo, como pode ser visto no exemplo dado logo acima na estrutura do XML auxiliar, onde foram definidas as TAGS <aux_Cor> e <aux_Tamanho>. |
<infAdVeic>(Plus) | Ao emitir DANFE de venda de veículos novos, é possível configurar o UniDANFE v.3 Plus para emitir a descrição complementar dos veículos logo abaixo da linha do produto com as informações presentes nas TAG´s específicas (grupo <veicProd>). No entanto, em havendo necessidade de destacar ali outras informações adicionais não contempladas no conjunto de TAG´s específicas, pode-se gerar o complemento da descrição nessa TAG <infAdVeic> no arquivo auxiliar, que a mesma será adicionada à descrição complementar, no ponto onde a mesma for inserida na interface de configuração do UniDANFE. |
<imprimirTotalTributosProduto> | Indica ao sistema se deve imprimir o total aproximado de tributos do produto (Lei da Transparência Fiscal); |
<imprimirValorUnitarioLiquido> (Plus) | Indica ao sistema se deve imprimir a coluna "Valor Unitário Líquido" do produto. Aceita os valores "1" (sim, sempre), "0" (não) ou "9" (automático - imprime apenas se o valor líquido for diferente do valor bruto); |
<imprimirValorTotalLiquido> (Plus) | Indica ao sistema se deve imprimir a coluna "Valor Total Líquido" do produto. Aceita os valores "1" (sim, sempre), "0" (não) ou "9" (automático - imprime apenas se o valor líquido for diferente do valor bruto); |
Outras TAGS utilizadas no DANFE de NFC-e | |
<imprimirProdutos> | Indica se deve ou não imprimir os produtos. Aceita os valores "1" (sim) ou "0" (não). |
<imprimirTotalTributosProduto> | Indica ao sistema se deve imprimir o total aproximado de tributos do produto (Lei da Transparência Fiscal); |
Outras TAGS utilizadas na CC-e | |
<anexarDFe> | Indica se o Arquivo Auxiliar (DANFE, DACTE, etc) deve ser anexado à impressão da CC-e. Válidos: 0=Não 1=Sim (antes da CC-e) 2=Sim (após a CC-e). |