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 do 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

O processo de credenciamento ao Boleto Rápido agora é condicionado à contratação prévia do serviço.

1. Pré-requisito: Contratação

Antes de iniciar a configuração técnica, o sistema verificará se o serviço está ativo. Caso você visualize a mensagem "Você ainda não contratou o PIX Imediato/Boleto Rápido":

• Clique no botão "Quero conhecer" para ser direcionado ao Marketplace.

• Para detalhes sobre planos e valores, acesse o guia de Contratação e cobrança dos serviços Fintech.

2. Fluxo de Credenciamento (Assistente de Melhores Práticas)

Com o serviço devidamente contratado, acesse a tela Assistente de Melhores Práticas, navegue até o menu Configurações serviços Fintech, selecione a opção Boleto Rápido e clique em Iniciar.

O processo é dividido em 6 etapas:

1. Seleção da Conta e Modalidade: Selecione a conta bancária e defina o tipo de serviço: Boleto Simples ou Boleto Híbrido (que inclui QR Code para pagamento via PIX).

   

    

   

2. Dados da Conta Bancária: Preencha as informações solicitadas.

   ⚠️ Importante: Os dados variam conforme o banco. É crucial confirmar todas as informações com seu gerente bancário antes de preencher para evitar falhas na emissão.

3. Configuração de Cobrança: Defina as regras de permanência do boleto após o vencimento, condições para negativação ou protesto, além de taxas de juros e multas.

4. Ações Automáticas: Configure os parâmetros para que os processos de baixa e conciliação ocorram de forma automática no ERP.

5. Credenciais: Insira o Client ID e o Client Secret gerados no portal de desenvolvedores do seu banco.

   • Consulte os links ao final deste artigo para guias específicos de cada banco.

6. Resumo de Configuração: Revise todos os dados. Se estiverem corretos, clique em "Instalar".

   • Ao concluir com êxito, a conta exibirá o status CREDENCIADA.

Informações Importantes

1. Credenciamento via tela ‘Contas’: Para clientes em versões que ainda não contemplam a implementação da nova jornada (PLG), recomendamos como alternativa o processo de credenciamento antigo: Na tela Contas, escolha a conta que será configurada como API. Em seguida, na aba Boleto(s)/Duplicatas, ative a marcação Boleto Rápido e selecione o serviço API do Banco. Clique no botão Configurar Credenciais para abrir o processo de credenciamento.

2. Versões anteriores à 4.28: Não será possível realizar atualizações de credenciamento ou novos credenciamentos em versões anteriores à 4.28.

Links para obtenção de Credenciais

• Como obter as credenciais do Banco do Brasil

• Como obter as credenciais do Banco Itaú

• Como obter as credenciais do Banco Santander

• Como obter as credenciais do Banco Sicoob

• Como obter as credenciais do Banco Sicredi

• Como obter as credenciais do Banco Bradesco

• Como obter as credenciais da Caixa Econômica

• Como obter as credenciais do Banco Safra

[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.

Nota: as operações do Boleto rápido são gerenciadas e gravadas sob o usuário "0 - SUP", pois se tratam de ações automáticas no sistema.

Pode-se acompanhar o histórico e o monitoramento dos boletos por meio da tela Acompanhamento de Boletos - API.

[voltar ao topo]

Boletos anteriores a ativação do serviço

A partir da versão 4.33, ao credenciar a conta, os boletos registrados via arquivo CNAB antes da ativação do serviço e que ainda estiverem abertos no banco serão automaticamente incorporados ao fluxo do Boleto rápido.

Para isso, o sistema identifica automaticamente todos os boletos pendentes com ocorrências de registro via CNAB e consulta a instituição bancária para validar seu status. Se o boleto ainda estiver ativo no banco, ele será atualizado para o status "1 - Em aberto" e seguirá o fluxo normal do serviço, permitindo alterações, cancelamentos e liquidações de forma automática pelo Boleto rápido.

Essa atualização torna o processo mais rápido e eficiente desde o momento da adesão, eliminando a troca manual de arquivos.

[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 pela API do banco:

• abatimento;
• abatimento cancelado;
• dt. vencimento;
• vlr desconto.

[voltar ao topo]

Alterações de dados do boleto

Todas as alterações permitidas em boletos registrados são enviadas automaticamente ao banco pela API, sem necessidade de enviar arquivos de remessa ou renegociar o título.

A API monitora os seguintes campos para alterações:

• desconto;

• abatimento;

• cancelamento do abatimento;

• data de vencimento.

Observações

• Desdobramento e juros/multa: não é possível alterar o valor de desdobramento (na aba Lançamento da tela Movimentação Financeira) para boletos emitidos por contas bancárias integradas via API. Além disso, os valores de juros e multa inseridos diretamente no Sankhya, seja pela Movimentação Financeira ou pela tela Cálculo de Juros e Multas não são transmitidos. Se precisar ajustar esses valores, será necessário renegociar o título.
• Prazos para alteração e cancelamento:
  • banco do Brasil: após gerar o boleto, há um prazo de 30 minutos para alterar a data de vencimento ou cancelar o boleto. Depois disso, as solicitações são enviadas ao banco;
  • banco Itaú: o prazo é de 24 horas para realizar alterações ou cancelar. Após esse período, as solicitações também são enviadas ao banco;
  • banco Santander: não há tempo mínimo necessário para realizar alterações.

• Restrições para alteração:

  • no banco do Brasil, não é possível alterar a data de vencimento de boletos vencidos;
  • para todos os bancos, não é possível alterar títulos já pagos, liquidados ou baixados.

• Informações de juros e multa: os valores de juros e multa retornam no campo "Vlr Juros" da resposta da API e são preenchidos automaticamente na Movimentação Financeira.

[voltar ao topo]

Renegociação de títulos 

Ao realizar a Renegociação de títulos de boletos registrados pela API do banco e confirmar a renegociação, os títulos originais são cancelados e novos são emitidos. Nesse processo, o sistema envia automaticamente duas instruções à API do banco:

1. cancelar os boletos antigos;
2. gerar novos títulos renegociados.

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

Observação: a Conta usada na renegociação é definida pelo 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. Além disso, 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, você pode usar o valor total de uma receita para quitar uma despesa, o que resulta na baixa do título original. 

Quando a compensação total envolve boletos registrados pela API do banco, o sistema envia automaticamente uma instrução para baixar ou cancelar o boleto 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).

Ao desfazer uma compensação total, o sistema cancela a operação e o título retorna ao status Pendente na tela Movimentação Financeira.

Para gerar um novo boleto após o cancelamento, é necessário seguir novamente o processo de registro do boleto, já que a baixa ou cancelamento anterior já foi registrado no banco.

[voltar ao topo]

Cancelamento de um boleto

Você pode cancelar um boleto emitido por uma conta configurada com a API do banco das seguintes formas:

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."

Confirme para realizar a exclusão do registro e do boleto vinculado a ele;

no Portal de Vendas, selecione a nota já confirmada e acione o botão "Cancelar Nota". Ao confirmar a exclusão será apresentado um pop-up para ser informada a "Justificativa" do cancelamento. Feito isso, a nota será cancelada. 

Ainda existem outras situações em que o cancelamento do boleto ocorre automaticamente:

• alteração da conta bancária vinculada ao título;

• baixa do título financeiro;

• quando o campo Nosso Número for limpo;

• compensação integral dos títulos;

• renegociação dos títulos.

[voltar ao topo]

Desabilitando o serviço Boleto rápido

Para descredenciamento de uma ou mais contas credenciadas, basta selecionar a conta desejada na tela 'Assistente de Melhores Práticas' :: Configurações Fintech :: Boleto Rápido e acessar a opção "Descredenciar conta".

Essa ação descredencia a utilização da conta no serviço de Boleto Rápido, porém a cobrança pelo serviço continuará ocorrendo até que o contrato seja efetivamente cancelado. A credencial será inativada e o retorno dos boletos não serão feitos de forma automática.

Já para o cancelamento do contrato, um usuário com perfil gerencial — e diferente do usuário SUP — deve acessar a opção "Cancelar contrato".

Essa ação desativa todas as contas credenciadas e realiza o cancelamento do serviço contratado junto à Sankhya Fintech.

Nota: Para versões que não possuem acesso ao Assistente de Melhores Práticas, basta na tela 'Contas' alterar a Conta configurada para outro tipo de emissão, como "Boleto Avançado/Duplicatas" ou "Pix CNAB".

[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 Contas, 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]