TOTVS Moda

Páginas filhas
  • DT Processo de integração com API do Banco do Brasil para envio/retorno de boleto


01. DADOS GERAIS

Produto:

TOTVS Moda

Linha de Produto:

Virtual Age

Segmento:

Varejo

Módulo:Financeiro
Função:Processo de integração com API do Banco do Brasil para envio/retorno de boleto
País:Brasil
Ticket:9997067
Requisito/Story/Issue (informe o requisito relacionado) :

DVAARM-2563


02. SITUAÇÃO/REQUISITO

Solicitado a criação de um processo de cobrança bancária, por empresa, para facilitar o operacional do envio e retorno das informações ao banco.

03. SOLUÇÃO

      A necessidade foi entendida e para contemplar o processo foram desenvolvidos os componentes:

  • FCRFP185 - Envio de Título para Cobrança Bancária via API.
  • FCRFP186 - Retorno de Título para Cobrança Bancária via API.

      Foi desenvolvido também o parâmetro por empresa "DS_CONFIG_INT_BB", para que seja realizada a configuração dos parâmetros referente a integração com banco do Brasil. Será demonstrado abaixo as configurações realizadas, entretanto, os valores podem ser configurados conforme a necessidade. Os valores a seguir são apenas fictícios:

  • DS_URLCOB → https://api.hm.bb.com.br/cobrancas/v1/boletos
  • DS_URLTOKEN → https://oauth.hm.bb.com.br/oauth/token
  • DS_PARAMTOKEN → grant_type=client_credentials&scope=cobrancas.boletos-requisicao cobrancas.boletos-info
  • DS_DEV_APP_KEY  → d27b*******************************a5b4
  • DS_CLIENT_ID → eyJpZCI*****************************wic2Y****************************************OjF9
  • DS_CLIENT_SECRET → eyJpZ***********************6Ijk2ZD**********************************************NpYu************************************************************NX0
  • IN_LOG → T

    Abaixo pode ser visto a execução de todo o processo, desde o envio das faturas até o recebimento e impressão das mesmas.



Imagem 01 - Demonstra o novo parâmetro por empresa "DS_CONFIG_INT_BB" onde está sendo selecionado a empresa 001 e acionado o clique duplo (ou tecla F12).


Imagem 02 - Ao acionar o clique duplo (ou tecla F12) mencionado anteriormente, o componente acima é apresentado, onde pode ser observado as configurações necessárias para que a comunicação com a API seja realizada com sucesso.


Imagem 03 - Demonstra o componente FCRFM022, onde pode ser observado as configurações de conta bancária, destacando o tipo de cobrança que aqui no exemplo é "Cobrança Simples", o layout que deve ser o "CNAB 240" e o "Nr. próx. bloqueto" que aqui no exemplo é "6197".

Observações:

-este campo "Nr. próx. bloqueto" segue uma sequencia, sendo assim caso seja enviada uma fatura com esta sequencia, em seguida será apresentado nesse campo a sequencia "6198" e assim sucessivamente.

-o número de convênio tem de ser acima de 1.000.000.

Imagem 01 - Demonstra o componente FCRFM001, onde está sendo criada a fatura "1060" para o cliente "100" onde pode ser observado que o portador "1020".


Imagem 02 - Esta sendo acessado o componente FCRFP185, onde está sendo informado os filtros necessários para que a fatura criada anteriormente seja apresentada, em seguida está sendo acionado o botão "Enviar".


Observação: Caso o botão de impressão (ou a tecla de atalho F6) seja acionado antes da realização do envio da fatura, a mensagem abaixo será apresentada.


Imagem 03 - Demonstra a mensagem que é apresentada quando realizada a tentativa de impressão da fatura antes da realização do envio da mesma.


Imagem 04 - Após realizar o envio da fatura, a mensagem acima é apresentada, informado que o processo foi realizado com sucesso.


Imagem 05 - Após realizar o envio da fatura, está sendo acionado o botão de impressão.


Imagem 06 - Demonstra o relatório FCRR191, onde pode ser observado as informações referente a fatura "1060", como a data de emissão, vencimento, portador e valor da fatura.


Imagem 07 - Após realizar o envio, ao consultar a mesma fatura no componente FCRFM001, pode ser observado que o portador foi alterado para "1 - BANCO DO BRASIL S/A." e no campo "Nosso número" pode ser observado que os quatro últimos dígitos são "6197", número esse que corresponde ao campo "Número próx. bloqueto" do componente FCRFM022.


Observação: Abaixo será demonstrado o processo de envio utilizando o agrupamento de faturas, e a impressão/envio do boleto gerado. O campo "Permitir rec. parcial" tem a função apenas de envio de boleto de recebimento parcial, caso necessário.


Imagem 08 - Demonstra o componente FCRFP185, onde está sendo selecionada as faturas "1061" e "1062" referente ao cliente 100, marcadas as opções "Agrupar fatura" e "Imprimir boleto", em seguida está sendo acionado o botão "Enviar".


Imagem 09 - Ao acionar o botão mencionado anteriormente, o boleto acima é apresentado, onde pode ser observado que os valores referentes as faturas foram somados sendo assim temos apenas uma única fatura de 500,00 R$, pode ser observado também que os quatro últimos números do campo "Nosso número" é  "6198", demonstrando assim que a sequencia mencionada anteriormente está sendo seguida corretamente. 


Imagem 10 - Após fechar o boleto apresentado anteriormente, o componente FCRFL146 é apresentado para realizar o envio da fatura por e-mail, em seguida está sendo acionado o botão "Enviar".

Observação: Pode ser observado que a fatura apresentada é a "78781". O código da fatura é diferente pois, a fatura é gerada agrupando as duas selecionadas anteriormente.


Imagem 11 - Mensagem que é apresentada após acionar o botão mencionado anteriormente, informando que o e-mail foi enviado com sucesso.


Imagem 12 - E-mail enviado, com o boleto apresentado anteriormente anexado.


Imagem 13 - Ao acessar o componente FCRFM001, pode ser observado que as informações como "Valor" e "Nosso número" são as mesmas apresentadas no boleto anteriormente. Observa-se também que o tipo de faturamento ficou "Agrupamento de fatura". A seguir, está sendo acionado o botão "Movimentação...".


Imagem 14 - Ao acionar o botão mencionado anteriormente, pode ser visto que a origem da fatura "78781" é o agrupamento das faturas "1061" e "1062".

Imagem 01 - Demonstra o componente FCRFM001, onde está sendo consultada a fatura "1" referente ao cliente "26848".


Imagem 02 - Está sendo acessado o novo componente FCRFP186, onde está sendo informado os filtros necessários para apresentar a fatura 1 referente ao cliente "26848", em seguida está sendo acionado o botão "Processar". 


Imagem 03 - Ao acionar o botão mencionado anteriormente, a pergunta acima é apresentada, onde está sendo selecionada a opção "Sim".


Imagem 04 - Ao selecionar a opção "Sim" o relatório FCRR190 é aberto, apresentado as informações referente a fatura selecionada para a realização do processamento.


Imagem 05 - Mensagem que é apresentada informando que o processo foi realizado com sucesso.


Imagem 06 - Ao consultar novamente a fatura "1" referente ao cliente "26848" pode observado que o campo "Vl. pago" foi preenchido com o valor de "91,00 R$", valor esse que corresponde campo "Vl pago banco" demonstrado anteriormente no componente FCRFP186. Pode ser observado também que o campo "Oper./Pagamento" está preenchido demonstrando assim que o pagamento foi realizado com sucesso, em sequencia está sendo acionado o botão "Movimentação...".

Imagem 07 - Pode ser observado que a liquidação "250422" foi gerada para a fatura "1" pertencente ao cliente "26848" demonstrando assim que o processo realizado através do componente FCRFP186 foi realizado corretamente.