> For the complete documentation index, see [llms.txt](https://ajuda.consistem.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ajuda.consistem.com.br/consistem-integracoes/areas-de-negocio/financeiro/banco-do-brasil-cobranca-escritural-api.md).

# Banco do Brasil (Cobrança Escritural API)

### Visão geral <a href="#cobrancaescrituralcomapibancodobrasil-visaogeral" id="cobrancaescrituralcomapibancodobrasil-visaogeral"></a>

A integração da Cobrança Escritural com a API do Banco do Brasil visa modernizar, otimizar e automatizar o processo de gestão de recebíveis. Ela substitui a tradicional geração e troca manual de arquivos de remessa e retorno (padrão CNAB) por uma comunicação direta, estruturada e segura via API.

Essa tecnologia elimina gargalos operacionais, proporcionando maior agilidade, robustez contra fraudes e erros de digitação, além de permitir o processamento e o acompanhamento dos títulos em tempo real.

### Requisitos

<table data-full-width="true"><thead><tr><th width="466">Consistem ERP</th><th>Banco do Brasil</th></tr></thead><tbody><tr><td><p><strong>Compatibilidade:</strong> 7.5 ou superior do Consistem ERP.</p><p><strong>Módulo:</strong> Financeiro - Contas a Receber e Cobrança Escritural.</p><p><strong>Licença:</strong> <a href="https://movidesk.consistem.com.br/form/5801/">Aquisição de licença</a> <strong>IBB</strong> ativo junto à Consistem.</p><p><strong>Infraestrutura:</strong> <a href="/spaces/XnBGMr6q45nMdBQT1ioR">Consistem API</a> ativa.</p><p>Orientamos o acompanhamento da nossa equipe de consultores.</p></td><td>Aquisição de licença e implantação deve ser verificada com a empresa fornecedora.<br><a href="https://www.bb.com.br/site/developers/">Saiba mais</a></td></tr><tr><td></td><td><strong>Convênio de Cobrança:</strong> Possuir um convênio ativo junto ao Banco do Brasil que contenha exatamente 7 dígitos.</td></tr><tr><td></td><td><strong>Tipos de Convênio para Registro:</strong> São aceitos apenas os tipos 3 (Banco Numera e Cliente Emite e Expede) ou 4 (Cliente Numera, Emite e Expede) para a funcionalidade de registro automático.</td></tr><tr><td></td><td><strong>Modalidades Suportadas:</strong> Suporte exclusivo para as modalidades 1 (Simples) ou 4 (Vinculada).</td></tr><tr><td></td><td><strong>Carteira:</strong> Utilização estrita da Carteira 17.</td></tr></tbody></table>

### Configuração da Integração

**No Consistem ERP**

1. Acesse o programa [Configuração de Credenciais API Banco (CCSBIA000)](/modulos/financeiro/manuais-de-telas/financeiro-contas-a-receber/configuracao-de-comunicacao-bancaria/configuracao-de-credenciais-api-banco.md) e insira as chaves fornecidas pelo banco, que funcionam com o mesmo rigor e cuidado de uma senha de conta bancária:
   1. **Developer Application Key:** Credencial responsável por acionar e autorizar as chamadas das APIs.
   2. **Client ID:** Identificador público e único da empresa junto ao Banco do Brasil.
   3. **Client Secret:** Credencial privada de autenticação exclusiva para a aplicação junto ao servidor de autorização.<br>

      <figure><img src="/files/4Hi9OTMlwZgEoEQ6K1x7" alt=""><figcaption></figcaption></figure>
2. Clique em **Salvar** para registrar as credenciais por empresa.
3. Acesse o [Cadastro de Dados do Banco da Cobrança Escritural (CCCE030)](/modulos/financeiro/manuais-de-telas/financeiro-contas-a-receber/tabelas-da-cobranca-escritural/cadastro-de-dados-do-banco-da-cobranca-escritural.md) e, no campo **Leiaute CNAB**, selecione a opção *API*. Isso sinaliza internamente ao Consistem ERP que aquela conta corrente específica não processará mais arquivos CNAB físicos e passará a realizar chamadas diretas via Web Services.<br>

   <figure><img src="/files/KtNwNlDsaIOyJBeVqozk" alt=""><figcaption></figcaption></figure>

**Na Cobrança Escritural com API Banco do Brasil**

1. **Solicitação de Acesso:** A empresa deve entrar em contato com a sua agência bancária do Banco do Brasil e solicitar formalmente a autorização para produção e emissão de cobranças através de API.
2. **Liberação das Credenciais:** Após a aprovação da instituição, o banco disponibilizará o pacote de credenciais (*Developer Application Key, Client ID e Client Secret*) que deverão ser copiadas e coladas diretamente no programa [Configuração de Credenciais API Banco (CCSBIA000)](/modulos/financeiro/manuais-de-telas/financeiro-contas-a-receber/configuracao-de-comunicacao-bancaria/configuracao-de-credenciais-api-banco.md) do Consistem ERP.

### Como a Integração Funciona

A comunicação ocorre por meio de requisições HTTPS encriptadas entre o Consistem ERP e os servidores do Banco do Brasil utilizando APIs no padrão REST. Os dados trafegam de forma estruturada e segura, garantindo a integridade das informações de ponta a ponta.

A grande inovação funcional da cobrança via API reside na comunicação síncrona de registro e no modelo síncrono/assíncrono inteligente de retorno:

* **Registro de Títulos:** No método tradicional, as informações do borderô precisavam ser agrupadas e salvas em um arquivo texto (CNAB) para envio posterior. Na API, quando o gatilho de envio é acionado, o ERP transmite os dados estruturados diretamente para o barramento do banco. O Banco do Brasil processa, valida e devolve a resposta na mesma transação (síncrona), informando imediatamente se o título foi registrado com sucesso ou rejeitado.
* **Tratamento do Retorno:** O sistema dispensa a varredura e importação diária de arquivos de retorno bancários. Para os casos de registros e confirmações de entradas, os dados retroalimentam o ERP no ato da transmissão. Para conciliações de pagamento e liquidações ocorridas na rede bancária, o sistema utiliza uma tarefa automatizada em *background* que consulta periodicamente a API do banco e atualiza os status dos títulos diretamente no banco de dados.

### Fluxo do Processo

O fluxo de trabalho ponta a ponta da cobrança escritural via API segue o seguinte passo a passo:

1. **Origem dos Dados (Faturamento):** Os títulos são originados normalmente através do módulo de faturamento da empresa com base nas vendas e emissões de notas fiscais realizadas.
2. **Geração do Borderô:** O operador executa o programa [Geração do Arquivo de Remessa de Borderô (CCCE100)](/modulos/financeiro/manuais-de-telas/financeiro-contas-a-receber/cobranca-escritural/geracao-do-arquivo-de-remessa-de-bordero.md). O sistema analisa o padrão de dados, agrupa-os e prepara o borderô, gerando o resumo de todos os documentos a serem cobrados.
3. **Transmissão Direta (O que a Consistem Envia):** No programa de geração de remessa, em vez de criar um arquivo em disco, o operador clica em **Gerar**. O Consistem ERP converte instantaneamente os dados mapeados no leiaute do borderô para a estrutura de payload da API e envia automaticamente as informações essenciais ao Banco do Brasil, incluindo: dados do sacado (CNPJ/CPF, Nome, Endereço), valor da cobrança, data de vencimento, juros/multas, instruções de cobrança e código do banco.
4. **Processamento Bancário e Resposta (O que a Consistem Recebe):** O Banco do Brasil recebe a requisição em seu barramento, valida os dados contra as regras contratuais da instituição e devolve uma resposta imediata. O Consistem ERP recebe esse retorno na mesma operação, contendo o status do registro (*Confirmado* ou *Rejeitado*) e o Número Bancário gerado. O sistema grava instantaneamente uma sequência de retorno associada àquele lote.
5. **Atualização Interna Automatizada:** O sistema direciona os dados para o programa [Atualização do Movimento de Retorno (CCCE170)](/modulos/financeiro/manuais-de-telas/financeiro-contas-a-receber/cobranca-escritural/atualizacao-do-movimento-de-retorno.md). Se a ocorrência recebida indicar **Entrada Confirmada**, o ERP atualiza o título com o número bancário definitivo. Se for identificada alguma rejeição, o título retorna automaticamente para a carteira disponível para correção, reaproveitando os códigos de motivo de rejeição vigentes.
6. **Conciliação de Pagamentos (Resultado Final):** Para capturar as liquidações diárias, uma tarefa agendada no gerenciador de tarefas do Consistem ERP executa uma busca automática na API do banco (rotina de *background*). Ela localiza os títulos pagos na rede bancária, gera a sequência de retorno de pagamento de forma invisível para o usuário e efetua a baixa do título de forma automatizada no Contas a Receber, concluindo o ciclo com total rastreabilidade e sem necessidade de intervenção manual.

<p align="center">Esse conteúdo foi útil?</p>

<p align="center"><a href="https://movidesk.consistem.com.br/form/10395/" class="button primary" data-icon="thumbs-up">Sim</a> <a href="https://movidesk.consistem.com.br/form/10395/" class="button primary" data-icon="thumbs-down">Não</a></p>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://ajuda.consistem.com.br/consistem-integracoes/areas-de-negocio/financeiro/banco-do-brasil-cobranca-escritural-api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.