Mudanças entre as edições de "Manuais:UniNFe/EnviandoXMLBoleto"

De unimake
Ir para: navegação, pesquisa
(→‎XML de retorno do envio do registro: O que fazer?)
 
(6 revisões intermediárias por um outro usuário não estão sendo mostradas)
Linha 5: Linha 5:
  
 
* <span style="color: red">'''Observação:'''</span>
 
* <span style="color: red">'''Observação:'''</span>
−
** Por enquanto, está implementado apenas o registro de boletos. Nas próximas semanas, serão integrados os serviços de cancelamento, prorrogação, instruções, etc e de acordo com o que o banco fornece de operações.
+
** Por enquanto, está implementado apenas o registro, consulta, cancelamento e 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>==
 
==<font color=#1E90FF>Registrando o boleto pelo UniNFe</font>==
  
−
Para conseguir fazer o registro de boleto, você 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:
+
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
 
0000000000000-BoletoRegistrar.xml
Linha 33: Linha 32:
 
----
 
----
  
−
===<font color=#1E90FF>Estrutura do XML de envio</font>===
+
===<font color=#1E90FF>Estrutura do XML de envio do registro</font>===
  
 
Para ficar mais fácil o entendimento da estrutura, vamos separar por tópicos.
 
Para ficar mais fácil o entendimento da estrutura, vamos separar por tópicos.
Linha 181: Linha 180:
  
 
* <font color=#1E90FF>'''Legenda das tags:'''</font>
 
* <font color=#1E90FF>'''Legenda das tags:'''</font>
−
** O grupo '''<FichaAceitaConfig>''' indica as configurações da ficha de aceite. Veja mais em [[Manuais:E-Bank/FichaAceite|configurando a ficha de aceite]];
+
** O grupo '''<FichaAceiteConfig>''' indica as configurações da ficha de aceite. Veja mais em [[Manuais:E-Bank/FichaAceite|configurando a ficha de aceite]];
 
** A tag '''<IdentificacaoDistribuicao>''' indica quem está distribuindo o boleto se é o cliente igual a 0 ou banco igual a 1;
 
** A tag '''<IdentificacaoDistribuicao>''' indica quem está distribuindo o boleto se é o cliente igual a 0 ou banco igual a 1;
 
** A tag '''<IdentificacaoEmissao>''' indica quem está emitindo o boleto se é o cliente igual a 0 ou banco igual a 1;
 
** A tag '''<IdentificacaoEmissao>''' indica quem está emitindo o boleto se é o cliente igual a 0 ou banco igual a 1;
Linha 191: Linha 190:
 
<div style="text-align: center;">Valores do tipo de juros</div>
 
<div style="text-align: center;">Valores do tipo de juros</div>
  
−
** A tag '''<Valor>''' é o valor dos juros. Você pode informar como porcentagem ou valor de acordo com o tipo configurado anteriormente;
+
** A tag '''<Valor>''' é o valor dos juros. ERP pode informar como porcentagem ou valor de acordo com o tipo configurado anteriormente;
 
** A tag '''<LinhaDigitavel>''' informa qual é a linha digitável do boleto em questão;
 
** A tag '''<LinhaDigitavel>''' informa qual é a linha digitável do boleto em questão;
 
** O grupo '''<Mensagens>''' auxilia na demonstração da mensagem de instrução para o pagador ou caixa sobre os juros, mora, entre outras informações importantes do boleto;
 
** O grupo '''<Mensagens>''' auxilia na demonstração da mensagem de instrução para o pagador ou caixa sobre os juros, mora, entre outras informações importantes do boleto;
Linha 202: Linha 201:
 
<div style="text-align: center;">Valores do tipo de multa</div>
 
<div style="text-align: center;">Valores do tipo de multa</div>
  
−
** A tag '''<Valor>''' é o valor da multa. Você pode informar como porcentagem ou valor de acordo com o tipo configurado anteriormente;
+
** A tag '''<Valor>''' é o valor da multa. ERP pode informar como porcentagem ou valor de acordo com o tipo configurado anteriormente;
 
** A tag '''<NumeroDiasLimiteRecebimento>''' indica o limite de dias que o boleto pode ser recebido;
 
** A tag '''<NumeroDiasLimiteRecebimento>''' indica o limite de dias que o boleto pode ser recebido;
 
** A tag '''<NumeroNaEmpresa>''' é a identificação do título na empresa (seu número);
 
** A tag '''<NumeroNaEmpresa>''' é a identificação do título na empresa (seu número);
Linha 337: Linha 336:
 
----
 
----
  
−
===<font color=#1E90FF>XML de retorno do envio: O que fazer?</font>===
+
===<font color=#1E90FF>XML de retorno do envio do registro: O que fazer?</font>===
  
 
Para verificar se o boleto foi registrado, 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:
 
Para verificar se o boleto foi registrado, 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:
Linha 357: Linha 356:
 
<PdfContentBase64>BASE_64_DO_PDF_BOLETO</PdfContentBase64>
 
<PdfContentBase64>BASE_64_DO_PDF_BOLETO</PdfContentBase64>
 
<PdfPath>d:\testenfe\Retorno\0000000000000-ret-BoletoRegistrar.pdf</PdfPath>
 
<PdfPath>d:\testenfe\Retorno\0000000000000-ret-BoletoRegistrar.pdf</PdfPath>
 +
<QRCodeContent>
 +
<Image/>
 +
<Success>False</Success>
 +
<Text/>
 +
</QRCodeContent>
 
<UniNFeVersao>5.1.0.136 | 25-03-2025 - 10:41:11</UniNFeVersao>
 
<UniNFeVersao>5.1.0.136 | 25-03-2025 - 10:41:11</UniNFeVersao>
 
</BoletoRegistrarResponse>
 
</BoletoRegistrarResponse>
Linha 370: Linha 374:
 
** A tag '''<PdfContentBase64>''' é o campo em base64 do boleto registrado;
 
** A tag '''<PdfContentBase64>''' é o campo em base64 do boleto registrado;
 
** A tag '''<PdfPath>''' é o caminho onde está o PDF do boleto;
 
** A tag '''<PdfPath>''' é o caminho onde está o PDF do boleto;
 +
** A tag '''<QRCodeContent><Image>''' é o campo em base64 da imagem do QRCode
 +
** A tag '''<QRCodeContent><Success>''' se o QRCode foi ou não gerado com sucesso
 +
** A tag '''<QRCodeContent><Text>''' é o campo com o PixCopiaECola
 +
** A tag '''<UniNFeVersao>''' indica a versão do UniNFe que foi utilizada.
 +
 +
----
 +
 +
==<font color=#1E90FF>Consultando o boleto pelo UniNFe</font>==
 +
 +
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
 +
 +
{| class="wikitable"
 +
|-
 +
||0000000000000
 +
||Conteúdo livre
 +
|-
 +
| style="width: 120px;"|-BoletoConsultar.xml
 +
||Conteúdo fixo. Sempre será "-BoletoConsultar.xml"
 +
|}
 +
 +
O nome do arquivo de retorno é o mesmo do envio, mudando somente a extensão (final) do mesmo, conforme abaixo:
 +
 +
0000000000000-ret-BoletoConsultar.xml (''se tudo ocorreu bem'')
 +
 +
ou
 +
 +
0000000000000-ret-BoletoConsultar.err (''se houve algum erro'')
 +
 +
----
 +
 +
===<font color=#1E90FF>Estrutura do XML de envio da consulta</font>===
 +
 +
O XML é bem pequeno comparado ao XML de registro, vamos conferir!
 +
 +
<pre>
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<BoletoConsultar versao="1.00">
 +
<ConfigurationId>ZCKWGQ55LTDXKYYC</ConfigurationId>
 +
<DataEmissaoInicial>2025-03-25</DataEmissaoInicial>
 +
<DataEmissaoFinal>2025-03-25</DataEmissaoFinal>
 +
<NumerosNoBanco>
 +
        <!--Pode repetir até 50 vezes-->
 +
<NumeroNoBanco>-2147483641</NumeroNoBanco>
 +
<NumeroNoBanco>-2147483642</NumeroNoBanco>
 +
<NumeroNoBanco>-2147483643</NumeroNoBanco>
 +
<NumeroNoBanco>-2147483644</NumeroNoBanco>
 +
</NumerosNoBanco>
 +
<PageNumber>0</PageNumber>
 +
<PageSize>0</PageSize>
 +
<Testing>true</Testing>
 +
<UseHomologServer>true</UseHomologServer>
 +
</BoletoConsultar>
 +
</pre>
 +
 +
* <font color=#1E90FF>'''Legenda das tags:'''</font>
 +
** A tag '''<ConfigurationID>''' é uma informação fornecida pela [unimake.com.br Unimake Software];
 +
** A tag '''<DataEmissaoInicial>''' é a data de emissão inicial do boleto para realizar a consulta. Não é obrigatória se informado a tag <NumerosNoBanco>;
 +
** A tag '''<DataEmissaoFinal>''' é a data de emissão final do boleto para realizar a consulta. Não é obrigatória se informado a tag <NumerosNoBanco>;
 +
** O grupo '''<NumerosNoBanco>''' são números dos boletos no banco. Não é obrigatória se informado a data de emissão final/inicial;
 +
** A tag '''<PageNumber>''' é o número da página que seja consultar;
 +
** A tag '''<PageSize>''' é o tamanho da página, ou seja, quantidade de registro por página que deseja ter como retorno;
 +
** A tag '''<Testing>''' define o tipo de ambiente para emissão do boleto. Se true, será usado o ambiente de teste;
 +
** 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 consulta: O que fazer?</font>===
 +
 +
Para saber se o boleto foi pago, cancelado, entre outros status, 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-BoletoConsultar.xml
 +
 +
E sua estrutura é a seguinte:
 +
 +
<pre>
 +
<?xml version="1.0" encoding="utf-8"?>
 +
<BoletoConsultarResponse>
 +
<Status>0</Status>
 +
<Motivo>Boletos encontrados</Motivo>
 +
<BoletoResponse>
 +
<CodigoBarras/>
 +
<DataEmissao>20-09-2018</DataEmissao>
 +
<DataLiquidacao/>
 +
<DataVencimento>20-09-2018</DataVencimento>
 +
<NumeroNaEmpresa>1235512</NumeroNaEmpresa>
 +
<NumeroNoBanco>-2147483648</NumeroNoBanco>
 +
<Pagador>
 +
<Codigo/>
 +
<Nome/>
 +
<Inscricao/>
 +
<Telefone/>
 +
<Email>[email protected]</Email>
 +
<TipoInscricao>0</TipoInscricao>
 +
<Endereco>
 +
<Logradouro>Rua 87 Quadra 1 Lote 1 casa 1</Logradouro>
 +
<Numero/>
 +
<Complemento/>
 +
<Bairro>Santa Rosa</Bairro>
 +
<Cidade>Luziânia</Cidade>
 +
<UF>DF</UF>
 +
<CEP>72320000</CEP>
 +
</Endereco>
 +
</Pagador>
 +
<PdfContent>
 +
<Content/>
 +
<Success>False</Success>
 +
<Message/>
 +
</PdfContent>
 +
<QrCodeContent>
 +
<Text>00020101021226950014br.gov.bcb.pix2573pix.sicoob.com.br/qr/payload/v2/cobv/e736df1b-1389-4b96-a070-c8dddac768de5204000053039865802BR5924JULIO PEREIRA DE OLIVEIRA6008Brasilia62070503***630435A3</Text>
 +
<Image/>
 +
<Success>False</Success>
 +
</QrCodeContent>
 +
<Situacao>9</Situacao>
 +
<TipoLiquidacao>0</TipoLiquidacao>
 +
<Valor>156.23</Valor>
 +
<ValorAbatimento>0.00</ValorAbatimento>
 +
<ValorDesconto>0.00</ValorDesconto>
 +
<ValorJuros>0.00</ValorJuros>
 +
<ValorLiquidado>156.23</ValorLiquidado>
 +
<ValorMulta>0.00</ValorMulta>
 +
</BoletoResponse>
 +
<BoletoResponse>
 +
<CodigoBarras/>
 +
<DataEmissao>20-09-2018</DataEmissao>
 +
<DataLiquidacao/>
 +
<DataVencimento>20-09-2018</DataVencimento>
 +
<NumeroNaEmpresa>1235512</NumeroNaEmpresa>
 +
<NumeroNoBanco>-2147483648</NumeroNoBanco>
 +
<Pagador>
 +
<Codigo/>
 +
<Nome/>
 +
<Inscricao/>
 +
<Telefone/>
 +
<Email>[email protected]</Email>
 +
<TipoInscricao>0</TipoInscricao>
 +
<Endereco>
 +
<Logradouro>Rua 87 Quadra 1 Lote 1 casa 1</Logradouro>
 +
<Numero/>
 +
<Complemento/>
 +
<Bairro>Santa Rosa</Bairro>
 +
<Cidade>Luziânia</Cidade>
 +
<UF>DF</UF>
 +
<CEP>72320000</CEP>
 +
</Endereco>
 +
</Pagador>
 +
<PdfContent>
 +
<Content/>
 +
<Success>False</Success>
 +
<Message/>
 +
</PdfContent>
 +
<QrCodeContent>
 +
<Text>00020101021226950014br.gov.bcb.pix2573pix.sicoob.com.br/qr/payload/v2/cobv/e736df1b-1389-4b96-a070-c8dddac768de5204000053039865802BR5924JULIO PEREIRA DE OLIVEIRA6008Brasilia62070503***630435A3</Text>
 +
<Image/>
 +
<Success>False</Success>
 +
</QrCodeContent>
 +
<Situacao>9</Situacao>
 +
<TipoLiquidacao>0</TipoLiquidacao>
 +
<Valor>156.23</Valor>
 +
<ValorAbatimento>0.00</ValorAbatimento>
 +
<ValorDesconto>0.00</ValorDesconto>
 +
<ValorJuros>0.00</ValorJuros>
 +
<ValorLiquidado>156.23</ValorLiquidado>
 +
<ValorMulta>0.00</ValorMulta>
 +
</BoletoResponse>
 +
<UniNFeVersao>5.1.0.136 | 25-03-2025 - 15:40:45</UniNFeVersao>
 +
</BoletoConsultarResponse>
 +
</pre>
 +
 +
* <font color=#1E90FF>'''Legenda das tags:'''</font>
 +
** A tag '''<Status>''' indicando o status da requisição;
 +
** A tag '''<Motivo>''' com a descrição do status da requisição;
 +
** O grupo '''<BoletoResponse>''' com as informações do boleto encontrado:
 +
*** A tag '''<CodigoBarras>''' indica o código de barras do boleto retornado;
 +
*** A tag '''<DataEmissao>''' é a data de emissão do boleto;
 +
*** A tag '''<DataLiquidacao>''' é a data em que o boleto foi liquidado;
 +
*** A tag '''<DataVencimento>''' é a data de vencimento do boleto;
 +
*** A tag '''<NumeroNaEmpresa>''' é o identificador do título na empresa (seu número);
 +
*** A tag '''<NumeroNoBanco>''' é o número do documento no banco (nosso número);
 +
*** O grupo '''<Pagador>''' identifica o pagador do boleto como nome, telefone, email, endereço, entre outros;
 +
*** O grupo '''<PdfContent>''' reúne informações do PDF do boleto:
 +
**** A tag '''<Content>''' terá o base64 do PDF do boleto;
 +
**** A tag '''<Success>''' é um campo booleano em que caso seja verdadeiro o PDF foi gerado com sucesso. Se falso, verifique a tag '''<Message>''';
 +
**** A tag '''<Message>''' é a mensagem de erro caso '''<Success>''' for falso;
 +
*** O grupo '''<QrCodeContent>''' reúne informações do QrCode do boleto:
 +
**** A tag '''<Text>''' é o texto devolvido pelo banco ou mensagem de erro caso o QrCode não seja gerado corretamente;
 +
**** A tag '''<Image>''' é a imagem PNG 512x512 em base64;
 +
**** A tag '''<Success>''' é um campo booleano em que caso seja verdadeiro o QrCode foi gerado com sucesso. Se falso, verifique a tag '''<Message>''';
 +
*** A tag '''<Situacao>''' indica qual a situação do boleto sendo:
 +
 +
{|class="wikitable" style="margin-left: 70px;"
 +
! scope="row"|'''Literal'''||'''Numérico'''
 +
|-
 +
||Desconhecida||<div style="text-align: center;">0</div>
 +
|-
 +
||EmCarteira||<div style="text-align: center;">1</div>
 +
|-
 +
||Liquidado||<div style="text-align: center;">2</div>
 +
|-
 +
||BaixadoPorSolicitacao||<div style="text-align: center;">3</div>
 +
|-
 +
||BaixadoPorProtesto||<div style="text-align: center;">4</div>
 +
|-
 +
||EmCartorio||<div style="text-align: center;">5</div>
 +
|-
 +
||AguardandoEntradaEmCartorio||<div style="text-align: center;">6</div>
 +
|-
 +
||Rejeitado||<div style="text-align: center;">7</div>
 +
|-
 +
||Cancelado||<div style="text-align: center;">8</div>
 +
|-
 +
||Emitido||<div style="text-align: center;">9</div>
 +
|-
 +
||Confirmado||<div style="text-align: center;">10</div>
 +
|-
 +
||Bloqueado||<div style="text-align: center;">11</div>
 +
|-
 +
||Removido||<div style="text-align: center;">12</div>
 +
|-
 +
||ConfirmadoPeloBeneficiario||<div style="text-align: center;">13</div>
 +
|-
 +
||ProtestadoEAguardandoBaixa||<div style="text-align: center;">14</div>
 +
|-
 +
||AguardandoLiquidacao||<div style="text-align: center;">15</div>
 +
|-
 +
||PagoParcialmente||<div style="text-align: center;">16</div>
 +
|-
 +
||Agendado||<div style="text-align: center;">17</div>
 +
|-
 +
||TituloComPendenciaEmCartorio||<div style="text-align: center;">18</div>
 +
|-
 +
||BaixadoPorDuplicidadeDeRegistro||<div style="text-align: center;">19</div>
 +
|-
 +
||BaixadoPorDecursoDePrazo||<div style="text-align: center;">20</div>
 +
|-
 +
||BaixadoPorMedidaJudicial||<div style="text-align: center;">21</div>
 +
|-
 +
||Devolvido||<div style="text-align: center;">22</div>
 +
|-
 +
||Outros||<div style="text-align: center;">32767</div>
 +
|}
 +
 +
*** A tag '''<TipoLiquidacao>''' indica o tipo da liquidação do boleto, sendo um dos valores abaixo:
 +
{|class="wikitable" style="margin-left: 70px;"
 +
! scope="row"|'''Literal'''||'''Numérico'''
 +
|-
 +
||Desconhecido||<div style="text-align: center;">0</div>
 +
|-
 +
||LiquidadoMasNaoIdentificado||<div style="text-align: center;">1</div>
 +
|-
 +
||LiquidadoViaPIX||<div style="text-align: center;">2</div>
 +
|-
 +
||LiquidadoViaDebitoEmConta||<div style="text-align: center;">3</div>
 +
|-
 +
||LiquidadoViaCheque||<div style="text-align: center;">4</div>
 +
|-
 +
||LiquidadoViaRemessa||<div style="text-align: center;">5</div>
 +
|-
 +
||LiquidadoViaCartorio||<div style="text-align: center;">6</div>
 +
|-
 +
||LiquidadoNoBancoEmissor||<div style="text-align: center;">7</div>
 +
|-
 +
||LiquidadoEmBancoDiferente||<div style="text-align: center;">8</div>
 +
|}
 +
 +
*** A tag '''<Valor>''' é o valor total do boleto;
 +
*** A tag '''<ValorAbatimento>''' é o valor de abatimento do boleto;
 +
*** A tag '''<ValorDesconto>''' é o valor do desconto aplicado no momento do pagamento do boleto;
 +
*** A tag '''<ValorJuros>''' é o valor dos juros aplicados no momento do pagamento do boleto;
 +
*** A tag '''<ValorLiquidado>''' é o valor realmente pago do boleto;
 +
*** A tag '''<ValorMulta>''' é o valor de multa, podendo não existir.
 +
 +
----
 +
 +
==<font color=#1E90FF>Cancelando o boleto pelo UniNFe</font>==
 +
 +
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
 +
 +
{| class="wikitable"
 +
|-
 +
||0000000000000
 +
||Conteúdo livre
 +
|-
 +
| style="width: 120px;"|-BoletoCancelar.xml
 +
||Conteúdo fixo. Sempre será "-BoletoCancelar.xml"
 +
|}
 +
 +
O nome do arquivo de retorno é o mesmo do envio, mudando somente a extensão (final) do mesmo, conforme abaixo:
 +
 +
0000000000000-ret-BoletoCancelar.xml (''se tudo ocorreu bem'')
 +
 +
ou
 +
 +
0000000000000-ret-BoletoCancelar.err (''se houve algum erro'')
 +
 +
----
 +
 +
===<font color=#1E90FF>Estrutura do XML de envio do cancelamento</font>===
 +
 +
O XML de cancelamento do boleto é bem simples, vamos conferir!
 +
 +
<pre>
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<BoletoCancelar versao="1.00">
 +
    <ConfigurationId>ZCKWGQ55LTDXKYYC</ConfigurationId>
 +
<NumeroNoBanco>-2147483648</NumeroNoBanco>
 +
<Testing>true</Testing>
 +
<UseHomologServer>true</UseHomologServer>
 +
</BoletoCancelar>
 +
</pre>
 +
 +
* <font color=#1E90FF>'''Legenda das tags:'''</font>
 +
** A tag '''<ConfigurationId>''' é o ID da configuração da conta corrente no eBank, sendo um número fornecido pela Unimake e <span style="color: red">'''tag obrigatória'''</span>;;
 +
** A tag '''<NumeroNoBanco>''' é o número do documento no banco (nosso número), <span style="color: red">'''sendo uma tag obrigatória'''</span>;
 +
** A tag '''<Testing>''' define o tipo de ambiente para emissão do boleto. Se true, será usado o ambiente de teste;
 +
** 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 do cancelamento: O que fazer?</font>===
 +
 +
Para saber se o boleto foi cancelado, 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-BoletoCancelar.xml
 +
 +
E sua estrutura é a seguinte:
 +
 +
<pre>
 +
<?xml version="1.0" encoding="utf-8"?>
 +
<BoletoCancelarResponse>
 +
<Status>0</Status>
 +
<Motivo>Boleto cancelado com sucesso.</Motivo>
 +
<UniNFeVersao>5.1.0.136 | 25-03-2025 - 11:08:16</UniNFeVersao>
 +
</BoletoCancelarResponse>
 +
</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 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.
 +
 +
----
 +
 +
==<font color=#1E90FF>Enviando instrução para o boleto pelo UniNFe</font>==
 +
 +
Após o registro do boleto, identificou que precisava enviar uma instrução? 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-BoletoEnviarInstrucao.xml
 +
 +
{| class="wikitable"
 +
|-
 +
||0000000000000
 +
||Conteúdo livre
 +
|-
 +
| style="width: 120px;"|-BoletoEnviarInstrucao.xml
 +
||Conteúdo fixo. Sempre será "-BoletoEnviarInstrucao.xml"
 +
|}
 +
 +
O nome do arquivo de retorno é o mesmo do envio, mudando somente a extensão (final) do mesmo, conforme abaixo:
 +
 +
0000000000000-ret-BoletoEnviarInstrucao.xml (''se tudo ocorreu bem'')
 +
 +
ou
 +
 +
0000000000000-ret-BoletoEnviarInstrucao.err (''se houve algum erro'')
 +
 +
----
 +
 +
===<font color=#1E90FF>Estrutura do XML de envio da instrução</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"?>
 +
<BoletoEnviarInstrucao versao="1.00">
 +
<ConfigurationId>ZCKWGQ55LTDXKYYC</ConfigurationId>
 +
<Data>2025-04-03</Data>
 +
<Instrucao>1</Instrucao>
 +
<InstrucaoAdicional>1</InstrucaoAdicional>
 +
<NossoNumero>string</NossoNumero>
 +
<NumeroNoBanco>string</NumeroNoBanco>
 +
<QuantidadeDiasDesconto>0</QuantidadeDiasDesconto>
 +
<SeuNumero>string</SeuNumero>
 +
<TipoDesconto>0</TipoDesconto>
 +
<Valor>0.00</Valor>
 +
<Testing>true</Testing>
 +
<UseHomologServer>true</UseHomologServer>
 +
</BoletoEnviarInstrucao>
 +
</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">Data</span>''' é a data da instrução;
 +
** A tag '''<span style="color: red"><Instrucao></span>''' é a indicação de qual instrução o boleto vai receber, sendo um dos valores abaixo:
 +
{|class="wikitable" style="margin-left: 70px;"
 +
! scope="row"|'''Literal'''||'''Numérico'''
 +
|-
 +
||PedidoDeBaixa||<div style="text-align: center;">0</div>
 +
|-
 +
||ConcessaoDeDesconto||<div style="text-align: center;">1</div>
 +
|-
 +
||CancelamentoDeDescontoConcedido||<div style="text-align: center;">2</div>
 +
|-
 +
||AlteracaoDeVencimento||<div style="text-align: center;">3</div>
 +
|-
 +
||AlteracaoSeuNumero||<div style="text-align: center;">4</div>
 +
|-
 +
||PedidoDeProtesto||<div style="text-align: center;">5</div>
 +
|-
 +
||SustarProtestoEBaixarTitulo||<div style="text-align: center;">6</div>
 +
|-
 +
||SustarProtestoEManterCarteira||<div style="text-align: center;">7</div>
 +
|-
 +
||AlteracaoOutrosDados||<div style="text-align: center;">8</div>
 +
|-
 +
||ConcessaoAbatimento||<div style="text-align: center;">9</div>
 +
|-
 +
||CancelamentoAbatimentoConcedido||<div style="text-align: center;">10</div>
 +
|}
 +
** A tag '''<InstrucaoAdicional>''' é para alguma instrução a mais, sendo um dos valores abaixo:
 +
{|class="wikitable" style="margin-left: 70px;"
 +
! scope="row"|'''Literal'''||'''Numérico'''
 +
|-
 +
||Desconto||<div style="text-align: center;">0</div>
 +
|-
 +
||JurosDia||<div style="text-align: center;">1</div>
 +
|-
 +
||DescontoDiaAntecipacao||<div style="text-align: center;">2</div>
 +
|-
 +
||CancelamentoProtestoAutomatico||<div style="text-align: center;">3</div>
 +
|-
 +
||DataLimiteConcessaoDesconto||<div style="text-align: center;">4</div>
 +
|}
 +
** A tag '''<NossoNumero>''' é o número do boleto bancário que deverá ser aplicada a instrução;
 +
** A tag '''<NumeroNoBanco>''' é o número do boleto bancário no banco;
 +
** A tag '''<QuantidadeDiasDesconto>''' é a quantidade de dias antes da data de vencimento que deve ser aplicado o desconto;
 +
** A tag '''<SeuNumero>''' é o número do boleto na empresa que deverá ser aplicada a instrução;
 +
** A tag '''<TipoDesconto>''' pode ser preenchida com uma das informações abaixo:
 +
 +
[[Arquivo:E-Bank_TipoDesconto.png|border|center|400px]]
 +
<div style="text-align: center;">Valores do tipo de desconto</div>
 +
 +
** A tag '''<Valor>''' é o campo para informar o valor que deverá ser aplicado de acordo com cada instrução, pois, em alguns momentos, a instrução executada depende de um valor que será aplicado;
 +
** A tag '''<Testing>''' define o tipo de ambiente para emissão do boleto. Se true, será usado o ambiente de teste;
 +
** 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 instrução: 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-BoletoEnviarInstrucao.xml
 +
 +
E sua estrutura é a seguinte:
 +
 +
<pre>
 +
<?xml version="1.0" encoding="utf-8"?>
 +
<BoletoEnviarInstrucaoResponse>
 +
<!--0=Instruções do boleto enviado com sucesso, 1 ou 999=Erro-->
 +
<Status>0</Status>
 +
<Motivo>Instruções do boleto enviado com sucesso</Motivo>
 +
<UniNFeVersao>5.1.0.138 | 16-04-2025 - 14:02:12</UniNFeVersao>
 +
</BoletoEnviarInstrucaoResponse>
 +
</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.
 +
 +
----
 +
 +
==<font color=#1E90FF>Enviando informação de pagamento do boleto pelo UniNFe</font>==
 +
 +
Após o pagamento do boleto, o ERP pode enviar a instrução informando o pagamento. 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-BoletoInformarPagto.xml
 +
 +
{| class="wikitable"
 +
|-
 +
||0000000000000
 +
||Conteúdo livre
 +
|-
 +
| style="width: 120px;"|-BoletoInformarPagto.xml
 +
||Conteúdo fixo. Sempre será "-BoletoInformarPagto.xml"
 +
|}
 +
 +
O nome do arquivo de retorno é o mesmo do envio, mudando somente a extensão (final) do mesmo, conforme abaixo:
 +
 +
0000000000000-ret-BoletoInformarPagto.xml (''se tudo ocorreu bem'')
 +
 +
ou
 +
 +
0000000000000-ret-BoletoInformarPagto.err (''se houve algum erro'')
 +
 +
----
 +
 +
===<font color=#1E90FF>Estrutura do XML de envio da informação de pagamento</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"?>
 +
<BoletoInformarPagto versao="1.00">
 +
<ConfigurationId>ZCKWGQ55LTDXKYYC</ConfigurationId>
 +
<NumeroNoBanco>string</NumeroNoBanco>
 +
<Testing>true</Testing>
 +
<UseHomologServer>true</UseHomologServer>
 +
</BoletoInformarPagto>
 +
</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 '''<NumeroNoBanco>''' é o número do boleto bancário no banco;
 +
** A tag '''<Testing>''' define o tipo de ambiente para emissão do boleto. Se true, será usado o ambiente de teste;
 +
** 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 informação de pagamento: O que fazer?</font>===
 +
 +
Para saber se a informaçã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-BoletoInformarPagto.xml
 +
 +
E sua estrutura é a seguinte:
 +
 +
<pre>
 +
<?xml version="1.0" encoding="utf-8"?>
 +
<BoletoInformarPagtoResponse>
 +
        <!--0=Boleto foi marcado como pago com sucesso, 1 ou 999=Erro-->
 +
<Status>1</Status>
 +
<Motivo>Não foi possível marcar o boleto como pago. Tente novamente mais tarde. (Status Code: 202)</Motivo>
 +
<UniNFeVersao>5.1.0.138 | 23-04-2025 - 11:14:22</UniNFeVersao>
 +
</BoletoInformarPagtoResponse>
 +
</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.
 
** A tag '''<UniNFeVersao>''' indica a versão do UniNFe que foi utilizada.
  

Edição atual tal como às 18h23min de 22 de julho de 2025

Como utilizar o serviço do e-Bank Boleto?

Após realizar a configuração do e-Bank no UniNFe, vamos consumir o serviço do e-Bank Boleto. Bora conferir?

  • Observação:
    • Por enquanto, está implementado apenas o registro, consulta, cancelamento e 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.

Registrando o boleto pelo UniNFe

Para conseguir fazer o registro de boleto, ERP deve gerar o XML conforme exemplo em nosso site na pasta de envio com o nome e formato a seguir:

0000000000000-BoletoRegistrar.xml

0000000000000 Conteúdo livre
-BoletoRegistrar.xml Conteúdo fixo. Sempre será "-BoletoRegistrar.xml"

O nome do arquivo de retorno é o mesmo do envio, mudando somente a extensão (final) do mesmo, conforme abaixo:

0000000000000-ret-BoletoRegistrar.xml (se tudo ocorreu bem)

ou

0000000000000-ret-BoletoRegistrar.err (se houve algum erro)

Estrutura do XML de envio do registro

Para ficar mais fácil o entendimento da estrutura, vamos separar por tópicos.

  • Observação:
    • As tags escritas em vermelho na legenda, indica que são tags obrigatórias.

Informações iniciais

<?xml version="1.0" encoding="utf-8"?>
<BoletoRegistrar versao="1.00">
    <ConfigurationId>ZCKWGQ55LTDXKYYC</ConfigurationId>
    <Aceite>true</Aceite>
    <AgenciaColetora>N</AgenciaColetora>
    <Avalista>
        <Nome>string</Nome>
	<TipoInscricao>0</TipoInscricao>
	<Inscricao>string</Inscricao>
	<Endereco>
	    <Logradouro>Rua</Logradouro>
	    <Numero>11</Numero>
	    <Complemento>string</Complemento>
	    <Bairro>Bairro</Bairro>
	    <Cidade>Brasília</Cidade>
	    <UF>DF</UF>
	    <CEP>11111-111</CEP>
	</Endereco>
    </Avalista>
    <Carteira>string</Carteira>
    <CodigoBarraNumerico>string</CodigoBarraNumerico>
    <Desconto>
        <Data>2025-03-12</Data>
	<Tipo>0</Tipo>
	<Valor>0</Valor>
    </Desconto>
    <DiasParaBaixaOuDevolucao>0</DiasParaBaixaOuDevolucao>
    <DigitoVerificadorNumeroNoBanco>string</DigitoVerificadorNumeroNoBanco>
    <Emissao>2025-03-12</Emissao>
    <Especie>0</Especie>
    ....
    ....
    ....
  • Legenda das tags:
    • A tag <ConfigurationId> é uma informação fornecida pela Unimake Software;
    • A tag <Aceite> é um campo true ou false para o aceite do boleto;
    • A tag <AgenciaColetora> indica se a agência é encarregada da cobrança.
    • O grupo <Avalista> indica as informações da pessoa que garante o pagamento da dívida;
    • A tag <Carteira> é o código da carteira do boleto;
    • A tag <CodigoBarraNumerico> indica o código de barras do boleto;
    • O grupo <Desconto> indica os descontos do boleto caso houver:
      • A tag <Tipo> pode ser preenchida com uma das informações abaixo:
E-Bank TipoDesconto.png
Valores do tipo de desconto
    • A tag <DiasParaBaixaOuDevolucao> indica a quantidade de dias para o boleto ser baixado ou devolvido;
    • A tag <DigitoVerificadorNumeroNoBanco> é o campo para informar o dígito verificar do número do boleto no banco;
    • A tag <Emissao> indica a tag de emissão do boleto;
    • A tag <Especie> pode ser informada conforme abaixo:
   Descrição 1

   Descrição 2

Informações intermediárias

    ....
    ....
    ....
    <FichaAceiteConfig>
	<FichaAceite>true</FichaAceite>
	<Merge>true</Merge>
	<AceiteDetails>
		<Aceite>true</Aceite>
		<AgenciaCodigoBeneficiario>string</AgenciaCodigoBeneficiario>
		<Beneficiario>string</Beneficiario>
		<Carteira>string</Carteira>
		<CodigoBanco>0</CodigoBanco>
		<DataDocumento>2025-03-12</DataDocumento>
		<DataProcessamento>2025-03-12</DataProcessamento>
		<Descontos>0</Descontos>
		<Especie>string</Especie>
		<Instrucoes>
			<Instrucao>string</Instrucao>
		</Instrucoes>
		<LogoBanco>string</LogoBanco>
		<MoraMulta>0</MoraMulta>
		<NossoNumero>string</NossoNumero>
		<NumeroDocumento>string</NumeroDocumento>
		<OutrasDeducoes>0</OutrasDeducoes>
		<OutrosAcrescimos>0</OutrosAcrescimos>
		<Pagador>string</Pagador>
		<RodapeDireito>
			<CodigoBarras>string</CodigoBarras>
			<TextoLivre>string</TextoLivre>
		</RodapeDireito>
		<RodapeEsquerdo>
			<CodigoBarras>string</CodigoBarras>
			<TextoLivre>string</TextoLivre>
		</RodapeEsquerdo>
		<Testing>true</Testing>
		<ValorCobrado>0</ValorCobrado>
		<ValorDocumento>0</ValorDocumento>
		<Vencimento>2025-03-12</Vencimento>
	</AceiteDetails>
    </FichaAceiteConfig>
    <IdentificacaoDistribuicao>0</IdentificacaoDistribuicao>
    <IdentificacaoEmissao>0</IdentificacaoEmissao>
    <Juros>
    	<Data>2025-03-12</Data>
	<Tipo>0</Tipo>
	<Valor>0</Valor>
    </Juros>
    <LinhaDigitavel>string</LinhaDigitavel>
    <Mensagens>
	<Mensagem>string</Mensagem>
	<Mensagem>string</Mensagem>
	<Mensagem>string</Mensagem>
	<Mensagem>string</Mensagem>
    </Mensagens>
    <MensagensRecibo>
	<Mensagem>string</Mensagem>
    </MensagensRecibo>
    <Multa>
	<Data>2025-03-12</Data>
	<Tipo>0</Tipo>
	<Valor>0</Valor>
    </Multa>
    <NumeroDiasLimiteRecebimento>0</NumeroDiasLimiteRecebimento>
    <NumeroNaEmpresa>string</NumeroNaEmpresa>
    <NumeroNoBanco>string</NumeroNoBanco>
    <NumeroParcela>0</NumeroParcela>
    <NumeroVariacaoCarteira>0</NumeroVariacaoCarteira>
    ....
    ....
    ....
  • Legenda das tags:
    • O grupo <FichaAceiteConfig> indica as configurações da ficha de aceite. Veja mais em configurando a ficha de aceite;
    • A tag <IdentificacaoDistribuicao> indica quem está distribuindo o boleto se é o cliente igual a 0 ou banco igual a 1;
    • A tag <IdentificacaoEmissao> indica quem está emitindo o boleto se é o cliente igual a 0 ou banco igual a 1;
    • O grupo <Juros> descreve os juros que serão aplicados ao título caso seja necessário:
      • A tag Data é a data inicial para ser aplicado os juros;
      • A tag <Tipo> deve ser um dos conteúdos abaixo:
E-Bank TipoJuros.png
Valores do tipo de juros
    • A tag <Valor> é o valor dos juros. ERP pode informar como porcentagem ou valor de acordo com o tipo configurado anteriormente;
    • A tag <LinhaDigitavel> informa qual é a linha digitável do boleto em questão;
    • O grupo <Mensagens> auxilia na demonstração da mensagem de instrução para o pagador ou caixa sobre os juros, mora, entre outras informações importantes do boleto;
    • O grupo <MensagensRecibo> auxilia na demonstração da mensagem para o pagador no recibo do boleto;
    • O grupo <Multa> descreve informações sobre a multa que pode ser aplicada no título caso seja necessário:
      • A tag Data é a data inicial para ser aplicado a multa;
      • A tag <Tipo> deve ser um dos conteúdos abaixo:
E-Bank TipoMulta.png
Valores do tipo de multa
    • A tag <Valor> é o valor da multa. ERP pode informar como porcentagem ou valor de acordo com o tipo configurado anteriormente;
    • A tag <NumeroDiasLimiteRecebimento> indica o limite de dias que o boleto pode ser recebido;
    • A tag <NumeroNaEmpresa> é a identificação do título na empresa (seu número);
    • A tag <NumeroNoBanco> é o número do documento no banco (nosso número):
      • Validação:
        • Itaú (314): -- Tamanho: 8 caracteres (sem informar o dígito verificador) -- Obrigatório: Sim
        • Banco do Brasil: -- Tamanho: 10 caracteres (sem informar o dígito verificador) -- Obrigatório: Sim
        • Caixa Econômica Federal: -- Tamanho: 17 caracteres -- Obrigatório: Não
        • Bradesco: -- Tamanho: 11 caracteres -- Obrigatório: Não
        • Santander: -- Tamanho: 12 caracteres (informando o dígito verificador) -- Obrigatório: Não
    • A tag <NumeroParcela> é o campo para informar o número da parcela;
    • A tag <NumeroVariacaoCarteira> indica o número de variação da carteira do boleto.

Informações finais

    ....
    ....
    ....
    <Pagador>
	<Nome>Pagador Fictício</Nome>
	<Inscricao>26994558000123</Inscricao>
	<TipoInscricao>0</TipoInscricao>
	<Codigo>string</Codigo>
	<Email>[email protected]</Email>
	<Telefone>string</Telefone>
	<Endereco>
        	<Logradouro>Rua</Logradouro>
		<Numero>11</Numero>
		<Complemento>string</Complemento>
		<Bairro>Bairro</Bairro>
		<Cidade>Brasília</Cidade>
		<UF>DF</UF>
		<CEP>11111-111</CEP>
	</Endereco>
    </Pagador>
    <PDFConfig>
    	<Password>string</Password>
	<PermitAnnotations>true</PermitAnnotations>
	<PermitAssembleDocument>true</PermitAssembleDocument>
	<PermitExtractContent>true</PermitExtractContent>
	<PermitFormsFill>true</PermitFormsFill>
	<PermitFullQualityPrint>true</PermitFullQualityPrint>
	<PermitModifyDocument>true</PermitModifyDocument>
	<PermitPrint>true</PermitPrint>
	<SignPDF>true</SignPDF>
	<TryGeneratePDF>true</TryGeneratePDF>
    </PDFConfig>
    <PermiteRecebimentoParcial>N</PermiteRecebimentoParcial>
    <PixConfig>
	<Chave>string</Chave>
	<QrCodeConfig>
		<Height>0</Height>
		<ImageFormat>1</ImageFormat>
		<Quality>0</Quality>
		<Width>0</Width>
	</QrCodeConfig>
	<RegistrarPIX>true</RegistrarPIX>
    </PixConfig>
    <Protesto>
	<Tipo>1</Tipo>
	<Valor>0</Valor>
    </Protesto>
    <Testing>true</Testing>
    <TipoBaixaDevolucao>1</TipoBaixaDevolucao>
    <ValorAbatimento>0</ValorAbatimento>
    <ValorIOF>0</ValorIOF>
    <ValorNominal>45.88</ValorNominal>
    <Vencimento>2021-05-13</Vencimento>
    <UseHomologServer>true</UseHomologServer>	
</BoletoRegistrar>
  • Legenda das tags:
    • O grupo <Pagador> são as informações do pagador do boleto;
    • O grupo <PDFConfig> indica as configurações do PDF. Veja mais em configurando o PDF do boleto;
    • A tag <PermiteRecebimentoParcial> é um campo N (false) ou S (true) que indica se permite recebimento parcial do boleto;
    • O grupo <PixConfig> indica as configurações do PIX quando o banco aceitar boleto híbrido. Veja mais em configurando o PIX do boleto híbrido;
    • O grupo <Protesto> informa o protesto que poderá ser aplicado ao título caso seja necessário:
      • A tag <Tipo> deve ser um dos conteúdos abaixo:
E-Bank TipoProtesto.png
Valores do tipo de protesto
      • A tag <Valor> é o número de dias para protesto ou negativação conforme tipo configurado anteriormente;
    • A tag <Testing> define o tipo de ambiente para emissão do boleto. Se true, será usado o ambiente de teste;
    • A tag <TipoBaixaDevolucao> indica o tipo de baixa ou devolução conforme conteúdo abaixo:
E-Bank TipoBaixaDevolucao.png
Valores do tipo de baixa ou devolução
    • A tag <ValorAbatimento> é o valor do abatimento do boleto;
    • A tag <ValorIOF> é o valor do IOF a ser recolhido;
    • A tag <ValorNominal> é o valor nominal do boleto em questão;
    • A tag <Vencimento> é a data de vencimento do boleto;
    • 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.

Estrutura mínima para utilizar o serviço

<?xml version="1.0" encoding="UTF-8"?>
<BoletoRegistrar versao="1.00">
    <ConfigurationId>ZCKWGQ55LTDXKYYC</ConfigurationId>
	<Aceite>true</Aceite>	
	<Emissao>2025-03-18</Emissao>
	<Especie>2</Especie>
	<NumeroParcela>0</NumeroParcela>
	<Pagador>
		<Nome>Pagador Fictício</Nome>
		<Inscricao>26994558000123</Inscricao>
		<TipoInscricao>0</TipoInscricao>
		<Endereco>
			<Logradouro>Rua</Logradouro>
			<Numero>11</Numero>
			<Complemento>string</Complemento>
			<Bairro>Bairro</Bairro>
			<Cidade>Brasília</Cidade>
			<UF>DF</UF>
			<CEP>11111-111</CEP>
		</Endereco>
	</Pagador>
	<PDFConfig>
		<TryGeneratePDF>true</TryGeneratePDF>
	</PDFConfig>	
	<Testing>true</Testing>
	<ValorNominal>45.88</ValorNominal>
	<Vencimento>2025-03-25</Vencimento>
	<UseHomologServer>true</UseHomologServer>	
</BoletoRegistrar>

XML de retorno do envio do registro: O que fazer?

Para verificar se o boleto foi registrado, deve analisar o XML de retorno que será gerado na pasta de retorno com o nome a seguir:

0000000000000-ret-BoletoRegistrar.xml

E sua estrutura é a seguinte: 

<?xml version="1.0" encoding="utf-8"?>
<BoletoRegistrarResponse>
	<Status>0</Status>
	<Motivo>Boleto registrado</Motivo>
	<CodigoBarraNumerico>73796162838172194122054272866843292534256573</CodigoBarraNumerico>
	<NumeroNoBanco>-2147483648</NumeroNoBanco>
	<LinhaDigitavel>53527298768113385317506126802226533485564252978</LinhaDigitavel>
	<PdfContentSuccess>True</PdfContentSuccess>
	<PdfContentMessage/>
	<PdfContentBase64>BASE_64_DO_PDF_BOLETO</PdfContentBase64>
	<PdfPath>d:\testenfe\Retorno\0000000000000-ret-BoletoRegistrar.pdf</PdfPath>
	<QRCodeContent>
		<Image/>
		<Success>False</Success>
		<Text/>
	</QRCodeContent>
	<UniNFeVersao>5.1.0.136 | 25-03-2025 - 10:41:11</UniNFeVersao>
</BoletoRegistrarResponse>
  • Legenda das tags:
    • A tag <Status> indica o status da requisição;
    • A tag <Motivo> é a descrição do status do boleto;
    • A tag <CodigoBarraNumerico> é o campo com o código de barras do boleto registrado;
    • A tag <NumeroNoBanco> é o campo com o número do boleto no banco;
    • A tag <LinhaDigitavel> é o campo com a linha digitável do boleto;
    • A tag <PdfContentSuccess> indica se o PDF do boleto retornou com sucesso;
    • A tag <PdfContentBase64> é o campo em base64 do boleto registrado;
    • A tag <PdfPath> é o caminho onde está o PDF do boleto;
    • A tag <QRCodeContent><Image> é o campo em base64 da imagem do QRCode
    • A tag <QRCodeContent><Success> se o QRCode foi ou não gerado com sucesso
    • A tag <QRCodeContent><Text> é o campo com o PixCopiaECola
    • A tag <UniNFeVersao> indica a versão do UniNFe que foi utilizada.

Consultando o boleto pelo UniNFe

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 exemplo em nosso site na pasta de envio com o nome e formato a seguir:

0000000000000-BoletoConsultar.xml

0000000000000 Conteúdo livre
-BoletoConsultar.xml Conteúdo fixo. Sempre será "-BoletoConsultar.xml"

O nome do arquivo de retorno é o mesmo do envio, mudando somente a extensão (final) do mesmo, conforme abaixo:

0000000000000-ret-BoletoConsultar.xml (se tudo ocorreu bem)

ou

0000000000000-ret-BoletoConsultar.err (se houve algum erro)

Estrutura do XML de envio da consulta

O XML é bem pequeno comparado ao XML de registro, vamos conferir! 

<?xml version="1.0" encoding="UTF-8"?>
<BoletoConsultar versao="1.00">
	<ConfigurationId>ZCKWGQ55LTDXKYYC</ConfigurationId>
	<DataEmissaoInicial>2025-03-25</DataEmissaoInicial>
	<DataEmissaoFinal>2025-03-25</DataEmissaoFinal>
	<NumerosNoBanco>
	        <!--Pode repetir até 50 vezes-->
		<NumeroNoBanco>-2147483641</NumeroNoBanco>
		<NumeroNoBanco>-2147483642</NumeroNoBanco>
		<NumeroNoBanco>-2147483643</NumeroNoBanco>
		<NumeroNoBanco>-2147483644</NumeroNoBanco>
	</NumerosNoBanco>
	<PageNumber>0</PageNumber>
	<PageSize>0</PageSize>
	<Testing>true</Testing>
	<UseHomologServer>true</UseHomologServer>
</BoletoConsultar>
  • Legenda das tags:
    • A tag <ConfigurationID> é uma informação fornecida pela [unimake.com.br Unimake Software];
    • A tag <DataEmissaoInicial> é a data de emissão inicial do boleto para realizar a consulta. Não é obrigatória se informado a tag <NumerosNoBanco>;
    • A tag <DataEmissaoFinal> é a data de emissão final do boleto para realizar a consulta. Não é obrigatória se informado a tag <NumerosNoBanco>;
    • O grupo <NumerosNoBanco> são números dos boletos no banco. Não é obrigatória se informado a data de emissão final/inicial;
    • A tag <PageNumber> é o número da página que seja consultar;
    • A tag <PageSize> é o tamanho da página, ou seja, quantidade de registro por página que deseja ter como retorno;
    • A tag <Testing> define o tipo de ambiente para emissão do boleto. Se true, será usado o ambiente de teste;
    • 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.

XML de retorno do envio da consulta: O que fazer?

Para saber se o boleto foi pago, cancelado, entre outros status, ERP deve analisar o XML de retorno que será gerado na pasta de retorno com o nome a seguir:

0000000000000-ret-BoletoConsultar.xml

E sua estrutura é a seguinte: 

<?xml version="1.0" encoding="utf-8"?>
<BoletoConsultarResponse>
	<Status>0</Status>
	<Motivo>Boletos encontrados</Motivo>
	<BoletoResponse>
		<CodigoBarras/>
		<DataEmissao>20-09-2018</DataEmissao>
		<DataLiquidacao/>
		<DataVencimento>20-09-2018</DataVencimento>
		<NumeroNaEmpresa>1235512</NumeroNaEmpresa>
		<NumeroNoBanco>-2147483648</NumeroNoBanco>
		<Pagador>
			<Codigo/>
			<Nome/>
			<Inscricao/>
			<Telefone/>
			<Email>[email protected]</Email>
			<TipoInscricao>0</TipoInscricao>
			<Endereco>
				<Logradouro>Rua 87 Quadra 1 Lote 1 casa 1</Logradouro>
				<Numero/>
				<Complemento/>
				<Bairro>Santa Rosa</Bairro>
				<Cidade>Luziânia</Cidade>
				<UF>DF</UF>
				<CEP>72320000</CEP>
			</Endereco>
		</Pagador>
		<PdfContent>
			<Content/>
			<Success>False</Success>
			<Message/>
		</PdfContent>
		<QrCodeContent>
			<Text>00020101021226950014br.gov.bcb.pix2573pix.sicoob.com.br/qr/payload/v2/cobv/e736df1b-1389-4b96-a070-c8dddac768de5204000053039865802BR5924JULIO PEREIRA DE OLIVEIRA6008Brasilia62070503***630435A3</Text>
			<Image/>
			<Success>False</Success>
		</QrCodeContent>
		<Situacao>9</Situacao>
		<TipoLiquidacao>0</TipoLiquidacao>
		<Valor>156.23</Valor>
		<ValorAbatimento>0.00</ValorAbatimento>
		<ValorDesconto>0.00</ValorDesconto>
		<ValorJuros>0.00</ValorJuros>
		<ValorLiquidado>156.23</ValorLiquidado>
		<ValorMulta>0.00</ValorMulta>
	</BoletoResponse>
	<BoletoResponse>
		<CodigoBarras/>
		<DataEmissao>20-09-2018</DataEmissao>
		<DataLiquidacao/>
		<DataVencimento>20-09-2018</DataVencimento>
		<NumeroNaEmpresa>1235512</NumeroNaEmpresa>
		<NumeroNoBanco>-2147483648</NumeroNoBanco>
		<Pagador>
			<Codigo/>
			<Nome/>
			<Inscricao/>
			<Telefone/>
			<Email>[email protected]</Email>
			<TipoInscricao>0</TipoInscricao>
			<Endereco>
				<Logradouro>Rua 87 Quadra 1 Lote 1 casa 1</Logradouro>
				<Numero/>
				<Complemento/>
				<Bairro>Santa Rosa</Bairro>
				<Cidade>Luziânia</Cidade>
				<UF>DF</UF>
				<CEP>72320000</CEP>
			</Endereco>
		</Pagador>
		<PdfContent>
			<Content/>
			<Success>False</Success>
			<Message/>
		</PdfContent>
		<QrCodeContent>
			<Text>00020101021226950014br.gov.bcb.pix2573pix.sicoob.com.br/qr/payload/v2/cobv/e736df1b-1389-4b96-a070-c8dddac768de5204000053039865802BR5924JULIO PEREIRA DE OLIVEIRA6008Brasilia62070503***630435A3</Text>
			<Image/>
			<Success>False</Success>
		</QrCodeContent>
		<Situacao>9</Situacao>
		<TipoLiquidacao>0</TipoLiquidacao>
		<Valor>156.23</Valor>
		<ValorAbatimento>0.00</ValorAbatimento>
		<ValorDesconto>0.00</ValorDesconto>
		<ValorJuros>0.00</ValorJuros>
		<ValorLiquidado>156.23</ValorLiquidado>
		<ValorMulta>0.00</ValorMulta>
	</BoletoResponse>
	<UniNFeVersao>5.1.0.136 | 25-03-2025 - 15:40:45</UniNFeVersao>
</BoletoConsultarResponse>
  • Legenda das tags:
    • A tag <Status> indicando o status da requisição;
    • A tag <Motivo> com a descrição do status da requisição;
    • O grupo <BoletoResponse> com as informações do boleto encontrado:
      • A tag <CodigoBarras> indica o código de barras do boleto retornado;
      • A tag <DataEmissao> é a data de emissão do boleto;
      • A tag <DataLiquidacao> é a data em que o boleto foi liquidado;
      • A tag <DataVencimento> é a data de vencimento do boleto;
      • A tag <NumeroNaEmpresa> é o identificador do título na empresa (seu número);
      • A tag <NumeroNoBanco> é o número do documento no banco (nosso número);
      • O grupo <Pagador> identifica o pagador do boleto como nome, telefone, email, endereço, entre outros;
      • O grupo <PdfContent> reúne informações do PDF do boleto:
        • A tag <Content> terá o base64 do PDF do boleto;
        • A tag <Success> é um campo booleano em que caso seja verdadeiro o PDF foi gerado com sucesso. Se falso, verifique a tag <Message>;
        • A tag <Message> é a mensagem de erro caso <Success> for falso;
      • O grupo <QrCodeContent> reúne informações do QrCode do boleto:
        • A tag <Text> é o texto devolvido pelo banco ou mensagem de erro caso o QrCode não seja gerado corretamente;
        • A tag <Image> é a imagem PNG 512x512 em base64;
        • A tag <Success> é um campo booleano em que caso seja verdadeiro o QrCode foi gerado com sucesso. Se falso, verifique a tag <Message>;
      • A tag <Situacao> indica qual a situação do boleto sendo:
Literal Numérico
Desconhecida
0
EmCarteira
1
Liquidado
2
BaixadoPorSolicitacao
3
BaixadoPorProtesto
4
EmCartorio
5
AguardandoEntradaEmCartorio
6
Rejeitado
7
Cancelado
8
Emitido
9
Confirmado
10
Bloqueado
11
Removido
12
ConfirmadoPeloBeneficiario
13
ProtestadoEAguardandoBaixa
14
AguardandoLiquidacao
15
PagoParcialmente
16
Agendado
17
TituloComPendenciaEmCartorio
18
BaixadoPorDuplicidadeDeRegistro
19
BaixadoPorDecursoDePrazo
20
BaixadoPorMedidaJudicial
21
Devolvido
22
Outros
32767
      • A tag <TipoLiquidacao> indica o tipo da liquidação do boleto, sendo um dos valores abaixo:
Literal Numérico
Desconhecido
0
LiquidadoMasNaoIdentificado
1
LiquidadoViaPIX
2
LiquidadoViaDebitoEmConta
3
LiquidadoViaCheque
4
LiquidadoViaRemessa
5
LiquidadoViaCartorio
6
LiquidadoNoBancoEmissor
7
LiquidadoEmBancoDiferente
8
      • A tag <Valor> é o valor total do boleto;
      • A tag <ValorAbatimento> é o valor de abatimento do boleto;
      • A tag <ValorDesconto> é o valor do desconto aplicado no momento do pagamento do boleto;
      • A tag <ValorJuros> é o valor dos juros aplicados no momento do pagamento do boleto;
      • A tag <ValorLiquidado> é o valor realmente pago do boleto;
      • A tag <ValorMulta> é o valor de multa, podendo não existir.

Cancelando o boleto pelo UniNFe

Após o registro do boleto, ERP pode fazer o cancelamento do boleto. Para isso, ERP deve usar o XML conforme exemplo em nosso site na pasta de envio com o nome e formato a seguir:

0000000000000-BoletoCancelar.xml

0000000000000 Conteúdo livre
-BoletoCancelar.xml Conteúdo fixo. Sempre será "-BoletoCancelar.xml"

O nome do arquivo de retorno é o mesmo do envio, mudando somente a extensão (final) do mesmo, conforme abaixo:

0000000000000-ret-BoletoCancelar.xml (se tudo ocorreu bem)

ou

0000000000000-ret-BoletoCancelar.err (se houve algum erro)

Estrutura do XML de envio do cancelamento

O XML de cancelamento do boleto é bem simples, vamos conferir! 

<?xml version="1.0" encoding="UTF-8"?>
<BoletoCancelar versao="1.00">
    <ConfigurationId>ZCKWGQ55LTDXKYYC</ConfigurationId>
	<NumeroNoBanco>-2147483648</NumeroNoBanco>
	<Testing>true</Testing>
	<UseHomologServer>true</UseHomologServer>	
</BoletoCancelar>
  • Legenda das tags:
    • A tag <ConfigurationId> é o ID da configuração da conta corrente no eBank, sendo um número fornecido pela Unimake e tag obrigatória;;
    • A tag <NumeroNoBanco> é o número do documento no banco (nosso número), sendo uma tag obrigatória;
    • A tag <Testing> define o tipo de ambiente para emissão do boleto. Se true, será usado o ambiente de teste;
    • 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.

XML de retorno do envio do cancelamento: O que fazer?

Para saber se o boleto foi cancelado, ERP deve analisar o XML de retorno que será gerado na pasta de retorno com o nome a seguir:

0000000000000-ret-BoletoCancelar.xml

E sua estrutura é a seguinte: 

<?xml version="1.0" encoding="utf-8"?>
<BoletoCancelarResponse>
	<Status>0</Status>
	<Motivo>Boleto cancelado com sucesso.</Motivo>
	<UniNFeVersao>5.1.0.136 | 25-03-2025 - 11:08:16</UniNFeVersao>
</BoletoCancelarResponse>
  • Legenda das tags:
    • 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.

Alterando o vencimento do boleto pelo UniNFe

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 exemplo em nosso site na pasta de envio com o nome e formato a seguir:

0000000000000-BoletoAlterarVencto.xml

0000000000000 Conteúdo livre
-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)

Estrutura do XML de envio do cancelamento

O XML é bem simples, vamos conferir como é sua estrutura!

  • Observação:
    • As tags escritas em vermelho na legenda, indica que são tags obrigatórias.
<?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>
  • Legenda das tags:
    • A tag <ConfigurationId> é uma informação fornecida pela Unimake Software;
    • A tag <DataVencimento> é a nova data de vencimento do boleto;
    • A tag <NumeroNoBanco> é 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.

XML de retorno do envio da alteração de vencimento: O que fazer?

Para saber se a instrução foi enviada com sucesso, ERP deve analisar o XML de retorno que será gerado na pasta de retorno com o nome a seguir:

0000000000000-ret-BoletoAlterarVencto.xml

E sua estrutura é a seguinte: 

<?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>
  • Legenda das tags:
    • 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.

Enviando instrução para o boleto pelo UniNFe

Após o registro do boleto, identificou que precisava enviar uma instrução? Então, temos o serviço certo para você. Para isso, ERP deve usar o XML conforme exemplo em nosso site na pasta de envio com o nome e formato a seguir:

0000000000000-BoletoEnviarInstrucao.xml

0000000000000 Conteúdo livre
-BoletoEnviarInstrucao.xml Conteúdo fixo. Sempre será "-BoletoEnviarInstrucao.xml"

O nome do arquivo de retorno é o mesmo do envio, mudando somente a extensão (final) do mesmo, conforme abaixo:

0000000000000-ret-BoletoEnviarInstrucao.xml (se tudo ocorreu bem)

ou

0000000000000-ret-BoletoEnviarInstrucao.err (se houve algum erro)

Estrutura do XML de envio da instrução

O XML é bem simples, vamos conferir como é sua estrutura!

  • Observação:
    • As tags escritas em vermelho na legenda, indica que são tags obrigatórias.
<?xml version="1.0" encoding="UTF-8"?>
<BoletoEnviarInstrucao versao="1.00">
	<ConfigurationId>ZCKWGQ55LTDXKYYC</ConfigurationId>
	<Data>2025-04-03</Data>
	<Instrucao>1</Instrucao>
	<InstrucaoAdicional>1</InstrucaoAdicional>
	<NossoNumero>string</NossoNumero>
	<NumeroNoBanco>string</NumeroNoBanco>
	<QuantidadeDiasDesconto>0</QuantidadeDiasDesconto>
	<SeuNumero>string</SeuNumero>
	<TipoDesconto>0</TipoDesconto>
	<Valor>0.00</Valor>
	<Testing>true</Testing>
	<UseHomologServer>true</UseHomologServer>
</BoletoEnviarInstrucao>
  • Legenda das tags:
    • A tag <ConfigurationId> é uma informação fornecida pela Unimake Software;
    • A tag Data é a data da instrução;
    • A tag <Instrucao> é a indicação de qual instrução o boleto vai receber, sendo um dos valores abaixo:
Literal Numérico
PedidoDeBaixa
0
ConcessaoDeDesconto
1
CancelamentoDeDescontoConcedido
2
AlteracaoDeVencimento
3
AlteracaoSeuNumero
4
PedidoDeProtesto
5
SustarProtestoEBaixarTitulo
6
SustarProtestoEManterCarteira
7
AlteracaoOutrosDados
8
ConcessaoAbatimento
9
CancelamentoAbatimentoConcedido
10
    • A tag <InstrucaoAdicional> é para alguma instrução a mais, sendo um dos valores abaixo:
Literal Numérico
Desconto
0
JurosDia
1
DescontoDiaAntecipacao
2
CancelamentoProtestoAutomatico
3
DataLimiteConcessaoDesconto
4
    • A tag <NossoNumero> é o número do boleto bancário que deverá ser aplicada a instrução;
    • A tag <NumeroNoBanco> é o número do boleto bancário no banco;
    • A tag <QuantidadeDiasDesconto> é a quantidade de dias antes da data de vencimento que deve ser aplicado o desconto;
    • A tag <SeuNumero> é o número do boleto na empresa que deverá ser aplicada a instrução;
    • A tag <TipoDesconto> pode ser preenchida com uma das informações abaixo:
E-Bank TipoDesconto.png
Valores do tipo de desconto
    • A tag <Valor> é o campo para informar o valor que deverá ser aplicado de acordo com cada instrução, pois, em alguns momentos, a instrução executada depende de um valor que será aplicado;
    • A tag <Testing> define o tipo de ambiente para emissão do boleto. Se true, será usado o ambiente de teste;
    • 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.

XML de retorno do envio da instrução: O que fazer?

Para saber se a instrução foi enviada com sucesso, ERP deve analisar o XML de retorno que será gerado na pasta de retorno com o nome a seguir:

0000000000000-ret-BoletoEnviarInstrucao.xml

E sua estrutura é a seguinte: 

<?xml version="1.0" encoding="utf-8"?>
<BoletoEnviarInstrucaoResponse>
	<!--0=Instruções do boleto enviado com sucesso, 1 ou 999=Erro-->
	<Status>0</Status>
	<Motivo>Instruções do boleto enviado com sucesso</Motivo>
	<UniNFeVersao>5.1.0.138 | 16-04-2025 - 14:02:12</UniNFeVersao>
</BoletoEnviarInstrucaoResponse>
  • Legenda das tags:
    • 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.

Enviando informação de pagamento do boleto pelo UniNFe

Após o pagamento do boleto, o ERP pode enviar a instrução informando o pagamento. Para isso, ERP deve usar o XML conforme exemplo em nosso site na pasta de envio com o nome e formato a seguir:

0000000000000-BoletoInformarPagto.xml

0000000000000 Conteúdo livre
-BoletoInformarPagto.xml Conteúdo fixo. Sempre será "-BoletoInformarPagto.xml"

O nome do arquivo de retorno é o mesmo do envio, mudando somente a extensão (final) do mesmo, conforme abaixo:

0000000000000-ret-BoletoInformarPagto.xml (se tudo ocorreu bem)

ou

0000000000000-ret-BoletoInformarPagto.err (se houve algum erro)

Estrutura do XML de envio da informação de pagamento

O XML é bem simples, vamos conferir como é sua estrutura!

  • Observação:
    • As tags escritas em vermelho na legenda, indica que são tags obrigatórias.
<?xml version="1.0" encoding="UTF-8"?>
<BoletoInformarPagto versao="1.00">
	<ConfigurationId>ZCKWGQ55LTDXKYYC</ConfigurationId>
	<NumeroNoBanco>string</NumeroNoBanco>
	<Testing>true</Testing>
	<UseHomologServer>true</UseHomologServer>
</BoletoInformarPagto>
  • Legenda das tags:
    • A tag <ConfigurationId> é uma informação fornecida pela Unimake Software;
    • A tag <NumeroNoBanco> é o número do boleto bancário no banco;
    • A tag <Testing> define o tipo de ambiente para emissão do boleto. Se true, será usado o ambiente de teste;
    • 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.

XML de retorno do envio da informação de pagamento: O que fazer?

Para saber se a informação foi enviada com sucesso, ERP deve analisar o XML de retorno que será gerado na pasta de retorno com o nome a seguir:

0000000000000-ret-BoletoInformarPagto.xml

E sua estrutura é a seguinte: 

<?xml version="1.0" encoding="utf-8"?>
<BoletoInformarPagtoResponse>
        <!--0=Boleto foi marcado como pago com sucesso, 1 ou 999=Erro-->
	<Status>1</Status>
	<Motivo>Não foi possível marcar o boleto como pago. Tente novamente mais tarde. (Status Code: 202)</Motivo>
	<UniNFeVersao>5.1.0.138 | 23-04-2025 - 11:14:22</UniNFeVersao>
</BoletoInformarPagtoResponse>
  • Legenda das tags:
    • 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.

Veja também

Disponível em "http://wiki.unimake.com.br/index.php?title=Manuais:UniNFe/EnviandoXMLBoleto&oldid=6516"