Mudanças

Ir para: navegação, pesquisa

Manuais:UniNFe/EnviandoXMLBoleto

3 356 bytes adicionados, 4 abril
sem sumário de edição
* <span style="color: red">'''Observação:'''</span>
** Por enquanto, está implementado apenas o registro, consulta , cancelamento e cancelamento alteração de vencimento de boletos. Nas próximas semanas, serão integrados os serviços de prorrogação, instruções, etc e de acordo com o que o banco fornece de operações.
==<font color=#1E90FF>Registrando o boleto pelo UniNFe</font>==
Para conseguir fazer o registro de boleto, ERP deve gerar o XML conforme [https://www.unimake.com.br/uninfe/modelos.php?p=eBoleto exemplo em nosso site] na [[Manuais:UniNFe/Configurando o UniNFe/Configuracoes Empresas/ConfigAbaPastas/Pasta de envio|pasta de envio]] com o nome e formato a seguir:
 
0000000000000-BoletoRegistrar.xml
Após o registro do boleto, ERP deve consultar ele para saber se foi pago ou não. Para isso, ERP deve usar o XML conforme [https://www.unimake.com.br/uninfe/modelos.php?p=eBoleto exemplo em nosso site] na [[Manuais:UniNFe/Configurando o UniNFe/Configuracoes Empresas/ConfigAbaPastas/Pasta de envio|pasta de envio]] com o nome e formato a seguir:
 
0000000000000-BoletoConsultar.xml
<DataEmissaoFinal>2025-03-25</DataEmissaoFinal>
<NumerosNoBanco>
<!--Pode repetir até 50 vezes-->
<NumeroNoBanco>-2147483641</NumeroNoBanco>
<NumeroNoBanco>-2147483642</NumeroNoBanco>
Após o registro do boleto, ERP pode fazer o cancelamento do boleto. Para isso, ERP deve usar o XML conforme [https://www.unimake.com.br/uninfe/modelos.php?p=eBoleto exemplo em nosso site] na [[Manuais:UniNFe/Configurando o UniNFe/Configuracoes Empresas/ConfigAbaPastas/Pasta de envio|pasta de envio]] com o nome e formato a seguir:
 
0000000000000-BoletoCancelar.xml
** A tag '''<Status>''' indica o status da requisição;
** A tag '''<Motivo>''' é a descrição do status da requisição;
** A tag '''<UniNFeVersao>''' indica a versão do UniNFe que foi utilizada.
 
----
 
==<font color=#1E90FF>Alterando o vencimento do boleto pelo UniNFe</font>==
 
Após o registro do boleto, identificou que precisava alterar o vencimento? Então, temos o serviço certo para você. Para isso, ERP deve usar o XML conforme [https://www.unimake.com.br/uninfe/modelos.php?p=eBoleto exemplo em nosso site] na [[Manuais:UniNFe/Configurando o UniNFe/Configuracoes Empresas/ConfigAbaPastas/Pasta de envio|pasta de envio]] com o nome e formato a seguir:
 
0000000000000-BoletoAlterarVencto.xml
 
{| class="wikitable"
|-
||0000000000000
||Conteúdo livre
|-
| style="width: 120px;"|-BoletoAlterarVencto.xml
||Conteúdo fixo. Sempre será "-BoletoAlterarVencto.xml"
|}
 
O nome do arquivo de retorno é o mesmo do envio, mudando somente a extensão (final) do mesmo, conforme abaixo:
 
0000000000000-ret-BoletoAlterarVencto.xml (''se tudo ocorreu bem'')
 
ou
 
0000000000000-ret-BoletoAlterarVencto.err (''se houve algum erro'')
 
----
 
===<font color=#1E90FF>Estrutura do XML de envio do cancelamento</font>===
 
O XML é bem simples, vamos conferir como é sua estrutura!
 
* <span style="color: red">'''Observação:'''</span>
** As tags escritas em <span style="color: red">vermelho</span> na legenda, indica que são tags obrigatórias.
 
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<BoletoAlterarVencto versao="1.00">
<ConfigurationId>ZCKWGQ55LTDXKYYC</ConfigurationId>
<DataVencimento>2025-04-03</DataVencimento>
<NumeroNoBanco>-2147483641</NumeroNoBanco>
<Testing>true</Testing>
<UseHomologServer>true</UseHomologServer>
</BoletoAlterarVencto>
</pre>
 
* <font color=#1E90FF>'''Legenda das tags:'''</font>
** A tag '''<span style="color: red"><ConfigurationId></span>''' é uma informação fornecida pela [https://unimake.com.br Unimake Software];
** A tag '''<span style="color: red"><DataVencimento></span>''' é a nova data de vencimento do boleto;
** A tag '''<span style="color: red"><NumeroNoBanco></span>''' é o número do boleto no banco;
** A tag '''<Testing>''' é um campo booleano que indica se está em ambiente de teste (true) ou não (false);
** A tag '''<UseHomologServer>''' não é obrigatória, o valor dela por padrão é false. Só utilize quando é necessário fazer testes para possibilitar DEBUG do lado do eBank, naturalmente isso só pode ocorrer se um desenvolvedor do eBank solicitar esta tag no XML para facilitar depuração de código.
 
----
 
===<font color=#1E90FF>XML de retorno do envio da alteração de vencimento: O que fazer?</font>===
 
Para saber se a instrução foi enviada com sucesso, ERP deve analisar o XML de retorno que será gerado na [[Manuais:UniNFe/Configurando o UniNFe/Configuracoes Empresas/ConfigAbaPastas/Pasta de retorno|pasta de retorno]] com o nome a seguir:
 
0000000000000-ret-BoletoAlterarVencto.xml
 
E sua estrutura é a seguinte:
 
<pre>
<?xml version="1.0" encoding="utf-8"?>
<BoletoAlterarVenctoResponse>
<Status>999</Status>
<Motivo>Not Found | No resources match requested URI</Motivo>
<UniNFeVersao>5.1.0.138 | 03-04-2025 - 17:16:05</UniNFeVersao>
</BoletoAlterarVenctoResponse>
</pre>
 
* <font color=#1E90FF>'''Legenda das tags:'''</font>
** A tag '''<Status>''' indica o status da requisição;
** A tag '''<Motivo>''' é a descrição do status do boleto;
** A tag '''<UniNFeVersao>''' indica a versão do UniNFe que foi utilizada.
1 353
edições

Menu de navegação