01. VISIÓN GENERAL

Configuraciones necesarias para el registro de boletas por el API del Banco do Brasil.

Para pruebas en entorno de homologación deben utilizarse los datos ficticios para pruebas de acuerdo con la documentación del Portal Developers BB.

Red interna

Para la comunicación del Protheus con el banco, si fuera necesario, debe configurarse la seguridad de red para aceptar la salida del rango de IP referente al 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. CREDENCIALES

Para la configuración del layout es necesario obtener ante el Banco do Brasil la siguiente información:

Application Key - Clave de la aplicación: Clave de acceso de la aplicación

Client ID - ID del cliente: Código de identificación del cliente

Client Secret - Clave secreta del cliente: Clave secreta de validación del cliente.

No considere la clave BASIC si la hubiera recibido.

03. REGISTRO DEL BANCO - MATA070

  • Para habilitar la configuración de un layout para el Banco do Brasil debe informarse en el campo A6_BCOOFI  (Banco oficial) el código 001.


Importante

Es necesario el registro correcto del dígito verificador de la cuenta en el campo Dv Cuenta (A6_DVCTA).

Si el registro estuviera incorrecto en la tabla de bancos (SA6), el ajuste debe realizarse en su subcuenta en el Registro Parámetros de bancos (tabla SEE) en los campos Age. Oficial (EE_AGEOFI), Cta. Oficial (EE_CTAOFI) y DV Cta.Ofic. (EE_DVCTOFI).

Ejemplo de cuenta que debe adecuarse: Cuenta 12345-6

En el registro del banco, campo Nº Cuenta (A6_NUMCOM) = 123456 y DV Cuenta (A6_DVCTA) = vacío, el ajuste en su subcuenta debe ser Cta. Oficial (EE_CTAOFI) = 12345 y DV Cta.Ofic. (EE_DVCTOFI) = 6

Para la impresión de la boleta se considerarán los campos DV Cta.Ofic. (EE_DVCTOFI) e DV Age.Ofic. (EE_DVAGOFI), si estos estuvieran vacíos se considerarán los campos DV Cuenta (EE_DVCTA) y DV Agencia (EE_DVAGE).


04. PARÁMETROS DEL BANCO - FINA130

  • Número de convenio debe informarse en el campo Cód. Empresa(EE_CODEMP).
    • El campo se validará en la inclusión del Borderó.
  • Código de la cartera debe informarse en el campo Cód. Cartera (EE_CODCART).
  • Número de la variación de la cartera debe informarse en el campo Var. Cartera (EE_VARCART).
    • El campo se validará en la inclusión del Borderó.
  • Nuestro número debe parametrizarse en los campos Rango inicial (EE_FAXINI), Rango final (EE_FAXFIM) y Rango actual (EE_FAXATU).
    • El campo (EE_FAXATU) se validará con respecto a su tamaño, donde debe tener como máximo 10 caracteres en la inclusión del Borderó y también en la transmisión de la boleta. Si hubiera divergencia, se comunicará en el NGF el motivo del error.
  • Número días límite cobranza debe informarse en el campo Días Cobranz (EE_DIASREC)
    • Si este campo tiene un valor > 0, internamente el Indicador aceptación título vencido se envía con 'S' 
  • Cantidad días protesto debe informarse en el campo Días Prot (EE_DIASPRT)
  • Mensaje para instrucción de cobranza debe informarse en el campo Mensaje 1 (EE_FORMEN1), cabe resaltar que el banco acepta como máximo 165 caracteres. Se recomienda el uso de letras minúsculas, pues en la impresión de la boleta existe un espacio definido previamente para exhibición del mensaje
  • Cobranza on-line debe informarse por lo menos a un convenio cuando la devolución(FINA715 o Webhook) estuviera configurada (EE_RETAUT). Si no esteviera habilitado, la devolución no se procesará para este convenio. 


05. CONFIGURACIÓN DEL LAYOUT

Para utilizar el registro online de boletas para el Banco do Brasil, debe observarse la siguiente regla:

  • Número del documento: En este campo debe informarse cuál será el número del documento que se transmitirá al banco y posteriormente se imprimirá en la boleta.

      Donde puede ser:

    1. Número del título (E1_NUM)
    2. ID CNAB (E1_IDCNAB)
    3. Expresión definida por el usuario.
      • El resultado de la expresión se atribuirá al campo “Número del documento”. Para las macroejecuciones la expresión que se ejecutará debe ser válida. Para informar una expresión, haga clic en el “Engranaje” que está al lado del campo.



  • Aceptación: Este campo indica el reconocimiento formal de la deuda (firma en el documento) por el pagador y deben informarse los valores:
    • - Cuando existe la necesidad de que el pagador reconozca/acepte la cobranza.
    • No - Cuando no existe la necesidad de reconocimiento de la cobranza.

  • Beneficiario sucursal: En este campo debe informarse la sucursal que se utilizará para la transmisión e impresión de la boleta. 

Los datos registrados en esta sucursal se utilizarán en la transmisión y en la impresión:


Atención

Si este campo no estuviera informado, la Sucursal actual (Sucursal conectada o Sucursal configurada programada en agenda) se utilizará en los datos de la transmisión e impresión de la boleta.


  • Descuento: En este campo se podrá informar o no un valor de descuento para la boleta.  

       Donde:

    1. Vacío - Si el valor original ya está calculado con la deducción de los valores de descuento o no exista descuento para la boleta.
    2. Valor Descuento (SomaAbat()) - Calculo estándar del sistema según la expresión: "SomaAbat(SE1->E1_PREFIXO,SE1->E1_NUM,SE1->E1_PARCELA,"R",SE1->E1_MOEDA,dDataBase,SE1->E1_CLIENTE,SE1->E1_LOJA)" .
    3. Expresión definida por el usuario.
      • El resultado de la expresión se atribuirá al campo “Descuento”. Para las macros ejecuciones la expresión que se ejecutará debe ser válida. Para informar una expresión, haga clic en el “Engranaje” que está al lado del campo.



Se puede informar el valor original ya deduciendo el valor del descuento. Es solo hacer clic en el engranaje en el campo "Valor original" e informar una expresión válida:

Ejemplo:

    • "SE1->E1_SALDO - SomaAbat(SE1->E1_PREFIXO,SE1->E1_NUM,SE1->E1_PARCELA,"R",SE1->E1_MOEDA,dDataBase,SE1->E1_CLIENTE,SE1->E1_LOJA)"


Importante

Si el valor original ya está calculado con la deducción de los valores de descuento, el campo "Descuento" no se debe informar para que no ocurra una duplicación en el valor de descuento.

Si el campo "Descuento" se completa, el campo "Valor original" debe contener el valor informado (Sin la deducción del descuento). Si existe descuento, aparecerá un mensaje en el cuerpo de la boleta informando el valor del descuento ya calculado.


  • Boleta híbrida (Boleta + PIX)
    • Sí - La boleta se registrará con el PIX, en la impresión aparecerá el QR Code PIX para cobrar el valor.
    • No - La boleta se registrará sin el PIX, en la impresión no aparecerá el QR Code PIX.

06. WEBHOOK - BAJA TÍTULOS (DEVOLUCIÓN)


Importante

  • Webhook para el Banco do Brasil disponible a partir de la versión 12.1.2310 del Protheus o Appserver igual o superior a 20.3.1.4.
  • El REST debe estar habilitado con SSL utilizando un certificado A1 (Ejemplo de configuración).

  • La URL de su REST https://seuendereco:suaporta/api/fin/v1/bb/bol/receivables/ ) debe registrarse directamente en el Portal del BB. 


Webhook es un servicio donde el banco envía informações de bajas de boletas al ERP Protheus.

La comunicación entre el Protheus y el Banco do Brasil ocurre mediante la autenticación de certificados mTLS.

Para más detalles acceda a la documentación que está disponible en el Portal Developers BB.

Es necesario un servicio REST habilitado en el Protheus con SSL y puesto a disposición para el Banco do Brasil (verifique en el Banco do Brasil dónde informar esta URL para envío de informaciones al Protheus).

Informe la URL del servicio REST disponibilizada por el Banco do Brasil en las configuraciones de cuentas en el campo Dirección (URL) de call-back del webhook:

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

seuendereco:suaporta → Informe la dirección y puerto del servicio REST configurado en el archivo appserver.ini.

/api/fin/v1/bb/bol/receivables/ → API disponible en el servicio REST estándar del Protheus preparada para recibir el payload de cobro(boletas) del Banco do Brasil.


07. CONFIGURACIÓN DE BOLETA

Permite que el usuario configure cómo se imprimirán los valores en la boleta.

  • Imprime rebaja
    • Como mensaje - El valor de la rebaja se imprimirá en los mensajes de la boleta
    • Campo descuento/rebaja - El valor de la rebaja en el título se imprimirá en el (-) Descuento/Rebaja de la boleta


Importante

  • No se pueden utilizar las opciones "Como mensaje" y "Campo descuento/rebaja" en conjunto.
  • Después de transmitir en la boleta los cambios realizados en el campo Imprime rebaja, no se aplicarán a las boletas transmitidas. Los cambios se aplicarán solamente a las boletas transmitidas después de la modificación.