01. VISÃO GERAL

Configurações necessárias para o registro de boletos por API do Banco do Brasil.

Para testes em ambiente de homologação deve ser utilizados os dados fictícios para testes conforme documentação no Portal Developers BB.

Para a comunicação do Protheus com o banco é necessário configurar a segurança de rede, caso necessário, para aceitar a saída da faixa de IP referente ao DNS: 

https://oauth.bb.com.br

https://oauth.hm.bb.com.br

https://api.bb.com.br

https://api.hm.bb.com.br

https://api-ip.bb.com.br

https://api.hm.bb.com.br


02. CREDENCIAIS

Para a configuração do layout será necessário obter junto ao Banco do Brasil as informações abaixo:

Application Key - Chave da aplicação: Chave de acesso do aplicativo

Client ID - ID do Cliente: Código de identificação do cliente

Client Secret - Chave Secreta do Cliente: Chave secreta de validação do cliente.

Desconsidere a chave BASIC caso seja recebida.

03. CADASTRO DE BANCO - MATA070


É necessário o cadastro correto do dígito verificador da conta no campo Dv Conta (A6_DVCTA).

Caso o cadastro esteja incorreto na tabela de bancos (SA6), o ajuste deve ser realizado em sua subconta no Cadastro Parâmetros de bancos (tabela SEE) nos campos Age. Oficial (EE_AGEOFI), Cta. Oficial (EE_CTAOFI) e DV Cta.Ofic. (EE_DVCTOFI).

Exemplo de conta que precisa ser adequada : Conta 12345-6

No cadastro do banco, campo Nro Conta (A6_NUMCOM) = 123456 e DV Conta (A6_DVCTA) = vazio, o ajuste em sua sub conta deve ser Cta. Oficial (EE_CTAOFI) = 12345 e DV Cta.Ofic. (EE_DVCTOFI) = 6

Para impressão do boleto serão considerados os campos DV Cta.Ofic. (EE_DVCTOFI) e DV Age.Ofic. (EE_DVAGOFI), caso os mesmo estejam vazios serão considerados os campos DV Conta (EE_DVCTA) e DV Agencia (EE_DVAGE).


04. PARÂMETROS DE BANCO - FINA130


05. CONFIGURAÇÃO DE LAYOUT

Para utilizar o registro online de boletos para o Banco do Brasil, deve-se observar a seguinte regra:

      Onde poderá ser:

    1. Número do Título (E1_NUM)
    2. ID CNAB (E1_IDCNAB)
    3. Expressão definida pelo usuário.
      • O resultado da expressão será atribuído ao campo “Número do documento”. Para as macros-execuções a expressão a ser executada deverá ser válida. Para informar uma expressão clique na “Engrenagem” que está ao lado do campo.


Os dados cadastrados nessa filial serão utilizados na transmissão e na impressão:


Caso este campo não esteja preenchido a Filial Atual (Filial Logado ou Filial configurada no agendamento) será utilizada no dados da transmissão e impressão do boleto.


       Onde poderá ser:

    1. Vazio - Caso o valor original já esteja calculado com a dedução dos valores de abatimento ou não exista abatimento para o boleto.
    2. Valor Abatimento (SomaAbat()) - Calculo padrão do sistema conforme a expressão: "SomaAbat(SE1->E1_PREFIXO,SE1->E1_NUM,SE1->E1_PARCELA,"R",SE1->E1_MOEDA,dDataBase,SE1->E1_CLIENTE,SE1->E1_LOJA)" .
    3. Expressão definida pelo usuário.
      • O resultado da expressão será atribuído ao campo “Abatimento”. Para as macros-execuções a expressão a ser executada deverá ser válida. Para informar uma expressão clique na “Engrenagem” que está ao lado do campo.



É possível informar o valor original já deduzindo o valor do abatimento. Basta clicar na engrenagem no campo "Valor Original" e informar uma expressão válida:

Exemplo:


Caso o valor original já esteja calculado com a dedução dos valores de abatimento, o campo "Abatimento" não deve ser preenchido para que não ocorra uma duplicidade no valor de abatimento.

Caso o campo "Abatimento" seja preenchido o campo "Valor Original" deverá conter o valor cheio (Sem a dedução do abatimento). Caso exista abatimento será exibida uma mensagem no corpo do boleto informando o valor do abatimento já calculado.




06. WEBHOOK - BAIXA TÍTULOS (RETORNO)


  • Webhook para o Banco do Brasil disponível a partir da versão 12.1.2310 do Protheus ou Appserver igual ou superior a 20.3.1.4.

Webhook é um serviço onde o banco envia informações de baixas de boletos para o ERP Protheus.

A comunicação entre o Protheus e o Banco do Brasil acontece via autenticação de certificados mTLS.

Para mais detalhes acesse a documentação que está disponível no Portal Developers BB.

É necessário um serviço REST habilitado no Protheus e disponibilizado para o Banco do Brasil ( verificar junto ao Banco do Brasil onde informar essa URL para envio de informações ao Protheus).

Informar a URL do serviço REST disponibilizada ao Banco do Brasil nas configurações de contas no campo Endereço (URL) de call-back do webhook:

https://seuendereco:suaporta/api/fin/v1/bb/bol/receivables/

seuendereco:suaporta → Informar endereço e porta do serviço REST configurado no arquivo appserver.ini.

/api/fin/v1/bb/bol/receivables/ → API disponível no serviço REST padrão do Protheus preparada para receber o payload de cobrança(boletos) do Banco do Brasil.


Obs: Ao informar o campo da url do Webhook, o Job FINA715 não será executado para essa conta, ficando a cargo apenas do Webhook a realização das baixas de boletos.


07. CONFIGURAÇÃO DE BOLETO

Esse passo permite que o usuário configure como será a impressão do valores no boleto