Boleto Rápido API

 Módulo: Financeiro > Consultas              Versão disponível: A partir da 4.20

O Boleto Rápido API é uma solução da Sankhya Fintech que visa aumentar a eficiência operacional e a produtividade das empresas por meio da automação no processo de emissão e gestão de boletos bancários. Ao eliminar a necessidade de arquivos de remessa e retorno, essa solução simplifica e automatiza as operações financeiras de forma significativa.

Principais Funcionalidades: 

• Registro de boletos: emissão de boletos simples e híbridos (QR Code para pagamento via PIX) de maneira rápida e eficiente, com todos os dados necessários para a cobrança.
• Reprocessamento de registros: a partir da versão 4.29, é possível reenviar todos os boletos para uma nova tentativa de registro junto à instituição bancária. O botão "Reprocessar registro" está disponível na tela Acompanhamento de Boletos - API.
• Cancelamento de boletos: cancelamento de boletos por diversos motivos, como solicitação do cliente ou cancelamento da nota fiscal. O processo de cancelamento é detalhado no tópico Cancelamento de um Boleto.
• Alterações de boletos: permite ajustes nos dados do boleto, como vencimento, desconto e abatimento.
• Baixa e conciliação automática: recebimento automático das informações de pagamento dos boletos, com baixa automática, facilitando o processo de conciliação bancária.

Atualmente, os bancos e modalidades ativas para o Boleto Rápido são:

Para entender como ocorre a Cobrança do serviço Boleto Rápido, acesse o artigo Detalhes de cobrança de serviço do boleto rápido.

Habilitação e configuração do serviço

Na tela Contas, escolha a conta que deverá se tornar API, em seguida, na aba Boleto(s)/Duplicatas habilite a marcação "Boleto Rápido" e selecione o serviço "API do Banco". Clique no botão "Configurar Credencias" e será aberto um pop-up com uma jornada de credenciamento. 

O credenciamento do Boleto Rápido é composto por três etapas:

1. Escolha da modalidade do serviço: selecione entre o boleto simples ou o boleto híbrido, que inclui QR Code para pagamento via PIX.
2. Configuração de cobrança: defina as regras de permanência do boleto após o vencimento, negativação ou protesto e insira as configurações de juros e multa
3. Informações de conta e credenciais: forneça os dados da conta, como convênio, carteira e modalidade, além das credenciais geradas no portal Developers da instituição bancária correspondente.

O passo a passo para obter as credenciais geradas no Portal Developers de cada instituição bancária está disponível nos links abaixo:

• Banco do Brasil: Como obter credenciais - API Banco do Brasil?
• Itaú: Como obter credenciais - Boleto Híbrido (API PIX) Banco Itaú
• Santander: Como obter credenciais API PIX Banco Santander

É muito importante ler os termos e condições de uso, disponíveis no link do pop-up, para ciência dos custos e obrigações legais ao habilitar a funcionalidade. Após a leitura, é obrigatório confirmar que está de acordo com as informações apresentadas. Esta é a assinatura oficial da contratação do serviço Boleto Rápido.

Para obter as orientações sobre como credenciar o Boleto Rápido para os bancos Banco do Brasil, Itaú e Santander, consulte os guias de credenciamento nos links abaixo:

• Como credenciar o Boleto rápido para o Banco do Brasil?
• Como credenciar o Boleto rápido para o Itaú?
• Como credenciar o Boleto rápido para o Santander?

[voltar ao topo]

Acompanhamento do serviço Boleto Rápido

Com todas as configurações executadas, a conta estará apta para emitir boletos de cobrança por meio da API do Banco, eliminando a necessidade de transferência de arquivos de remessa e retorno.

Pode-se acompanhar o histórico e o monitoramento dos boletos através da tela Acompanhamento de Boletos - API.

[voltar ao topo]

Ocorrências de Remessa

Quando uma nova conta bancária for configurada para emissão de boletos com API do Banco, as ocorrências de remessa e a conta bancária configurada serão inseridas automaticamente, além dos campos abaixo que serão monitorados:

• Abatimento;
• Abatimento Cancelado;
• Dt. Vencimento;
• Vlr Desconto.

Nota: apenas os campos acima serão monitorados pela API do Banco.

[voltar ao topo]

Alterações de Dados do Boleto

Todas as alterações permitidas em boletos registrados são enviadas automaticamente ao banco por meio da API, sem necessidade de remessa de arquivos ou renegociação do título:

Os campos monitorados pela API do banco incluem:

• Desconto;
• Abatimento;
• Cancelamento do abatimento;
• Data de vencimento.

Observação: não é possível alterar o valor de desdobramento (na aba Lançamento da tela Movimentação Financeira) quando o boleto é emitido por uma conta bancária integrada via API. Além disso, valores de juros e multa inseridos diretamente no Sankhya (pela Movimentação financeira ou pela tela Cálculo de Juros e Multas) não podem ser transmitidos. Em ambos os casos, será necessário renegociar o título, se preciso.

Nota: no Banco do Brasil, a partir da geração do boleto, há um prazo de 30 minutos para alterar a data de vencimento ou cancelar o boleto. Após esse prazo, as solicitações de cancelamento ou modificação de vencimento serão enviadas ao banco. No Banco Itaú, o prazo é de 24 horas. Após esse período, as mesmas solicitações também serão encaminhadas para o banco. Para o Banco Santander, não há tempo necessário para efetuar a alteração.

Nota: de acordo com a regra do Banco do Brasil, não será possível realizar alterações no vencimento de um título vencido. Para todos os bancos, não é possível realizar alterações em um título já pago, liquidado ou baixado.

Observação: no retorno da API, os valores aplicados de juros e multa retornam somente no campo "Vlr Juros", sendo populados automaticamente na Movimentação Financeira.

[voltar ao topo]

Renegociação de Títulos 

Ao realizar a Renegociação de Títulos que possuam boletos registrados com API do Banco e confirmar a renegociação, os títulos originais serão cancelados e novos serão emitidos. Dessa forma, será enviada uma instrução automaticamente para API do Banco cancelar os boletos e uma nova instrução para gerar os novos títulos também será encaminhada para a API do Banco.

Nota: ao gerar um título, o envio automático para o banco ocorrerá exclusivamente no momento da geração do boleto, permitindo que esse processo seja realizado diretamente na tela de Renegociação de Títulos.

Observação: na renegociação será utilizada a "Conta" informada no parâmetro "Conta Padrão para Financeiro - CONTAPADRAOFIN". Se não houver conta informada neste parâmetro, será usada a conta do primeiro financeiro escolhido.

Observação: para renegociação de títulos com contas ativas na API, a marcação "Manter nosso número para 1 título?" não pode estar ativa. 

[voltar ao topo]

Compensação Financeira

Esta rotina é realizada por meio da tela Compensação financeira. Nela, é possível realizar a compensação total da seguinte maneira:

Na compensação total, utilizando o valor total de uma receita com uma despesa, o título original é baixado. Desse modo, quando houver a compensação total que contenha boletos gerados pela API do Banco, será enviada uma instrução baixa/cancelamento do título de cobrança.

Observação: se necessário, o documento de cobrança (boleto) atualizado, deverá ser reimpresso na tela Impressão de Boleto(s).

Em relação ao cancelamento de uma Compensação Financeira, ao desfazer uma Compensação Financeira Total, o sistema cancela a compensação e na Movimentação Financeira o título volta a ficar com o status igual a "Pendente".

Observação: para gerar um novo boleto, deve-se seguir o processo do registro do boleto, pois uma baixa/cancelamento anteriormente já foi enviada.

[voltar ao topo]

Cancelamento de um Boleto

Pode-se realizar o cancelamento de um boleto que tenha sido emitido por uma conta configurada com API do Banco. Observe: 

 Por meio da tela Movimentação Financeira, acione nos Filtros as marcações "Receita", "Real" e "Pendente", em seguida, selecione o registro desejado e acione o botão "Excluir". Desse modo, será apresentado o aviso:

"Você deseja realmente excluir o registro selecionado? Isso não pode ser desfeito."

Clicando em "Sim", será realizada a exclusão do registro e do boleto vinculado a ele.

 Através do Portal de Vendas, deve-se selecionar a nota já confirmada e acionar o botão "Cancelar Nota". Ao confirmar a exclusão será apresentado um pop-up para que seja informada a "Justificativa" do cancelamento. Feito isso, a nota será cancelada. 

 O cancelamento de um boleto também ocorrerá quando houver a alteração de uma conta bancária do título;

 Quando a baixa for realizada;

Em casos que o campo "Nosso número" for limpo;

Em casos que houver a compensação integral dos títulos;

Por fim, quando houver a renegociação dos títulos.

[voltar ao topo]

Desabilitando o serviço Boleto Rápido

Para desabilitar o serviço API do Banco, basta alterar a Conta configurada para outro tipo de emissão, como "Boleto Avançado/Duplicatas" ou "Pix CNAB". Dessa forma, a conta será desabilitada da API e o registro e baixa dos boletos não serão realizados de forma automática.

Nota: se a conta estiver configurada para emitir os boletos via API do Banco e a marcação "Ativa", localizada na aba Cadastros, for desligada, ao salvar o registro a credencial será inativada e o retorno dos boletos não serão feitos de forma automática. 

[voltar ao topo]

Parâmetros que influenciam essa rotina

Consumir API Bancos em modo Debug? - APIBDEBUG: com este parâmetro ligado, os logs do Boleto Rápido serão ligados para serem salvos no ServerLog.

TOP de baixa para recebimentos - RCBTOPBAIXA: se o campo TOP Baixa boleto estiver vazio na tela Conta, a TOP de baixa seguirá a configuração realizada neste parâmetro.

Conta Padrão para Financeiro - CONTAPADRAOFIN: na renegociação será utilizada a "Conta" informada neste parâmetro. Se não houver conta informada neste parâmetro, será usada a conta referente ao primeiro financeiro escolhido.

Calcula valor liquido boleta? - VLRLIQBOL: quando este parâmetro estiver ligado e uma conta for configurada para emitir os boletos via API do Banco será enviado para o campo "Valor Original" o valor apresentado no campo "Vlr. Líquido". Caso o parâmetro esteja desligado, o "Vlr. Desdobramento" será enviado para o campo Valor Original. 

Controla boleto por fila? - FILABOLETA: o serviço API não trabalha com a configuração de "Fila de Boleto".

Realizar compensação de devolução usando acerto - COMPDEVACERTO: este parâmetro deve estar ligado para que a compensação financeira seja efetuada corretamente via API.

[voltar ao topo]