Linha Microsiga Protheus

Árvore de páginas

01. VISÃO GERAL

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

Rede interna

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://sts.itau.com.br/

https://api.itau.com.br/


02. HABILITAR SERVIÇO - ITAÚ

Para a utilização da API do Itaú é necessário a ativação do serviço em sua conta. Esse processo deve ser solicitado diretamente ao seu gerente de conta.

Para estabelecer uma conexão segura com os API Gateways do Itaú é necessário enviar um client certificate. Este certificado é usado para estabelecer o mTLS (OAuth 2.0 Mutual Transport Layer Security).

Mais detalhes do processo de geração do certificado devem ser obtidos no portal do Itaú : https://devportal.itau.com.br/. O acesso ao mesmo deve ser também solicitado ao seu gerente de conta.


Nesse processo será gerado dois arquivos, um com extensão CRT e  outro KEY que serão utilizados no processo de configuração e layout do Novo Gestor Financeiro.


Versões

Caso o ambiente esteja utilizando a primeira versão 1 da API (V1) liberada no NGF, que não utiliza certificado, você pode editar o seu layout e assim atualizar para a nova versão, depois de realizados os pontos acima.

Novas configurações de contas serão realizadas apenas para a nova versão 2 (V2), com certificado.

03. CADASTRO DE BANCO - MATA070

  • Para habilitar a configuração de um layout para o Itaú, deve ser informado no campo Bco Oficial (A6_BCOOFI) o código 341.


Importante

É 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

04. PARÂMETROS DE BANCO - FINA130

  • Código da carteira deve ser informado no campo Cód. Carteira (EE_CODCART).
  • Nosso número deve ser parametrizado nos campos Faixa Inicio (EE_FAXINI) , Faixa Fim (EE_FAXFIM) e Faixa atual (EE_FAXATU).
  • Somente será possível enviar instruções de cobrança a partir do preenchimento dos campos abaixo: 
    1. Banco Oficial (EE_CODOFI) → Não preencher.
    2. Mensagem 1 (EE_FORMEN1) → Instrução de cobrança para o boleto (Formula)
    3. Mensagem 2 (EE_FORMEN2) → Instrução de cobrança para o boleto (Formula)
    4. Mens. Extra 1 (EE_FOREXT1)→ Instrução de cobrança para o boleto (Formula)
    5. Mens. Extra 2 (EE_FOREXT2)→ Não será usado para impressão da instrução. Itaú permite somente 03 mensagens
    6. Dias Protest (EE_DIASPRT) → Quantidade de dias de protesto do boleto
    7. Dias Recebim (EE_DIASREC) → Quantidade de dias para devolução do Boleto 


ATENÇÃO

Para funcionamento da comunicação bancária por API do Itaú o usuário deve configurar os parâmetros de banco

Os campos de fórmula EE_FORXXX devem conter expressões ADVPL válidas para evitar possíveis desconformidades ou interrupções inesperadas no processo.

05. LAYOUT - FINA710 - NOVO GESTOR FINANCEIRO

Ao iniciar a configuração de layout para uma nova conta do Itaú serão apresentados os passos:

01. SELEÇÃO DA CONTA

Selecione a conta que deseja realizar a configuração

02. INSERÇÃO DE CREDENCIAIS

Nesse passo serão inseridas as informações obtidas junto ao banco no processo de habilitar o serviço em sua conta.

Informe nesse passo o ID do cliente e Chave secreta do cliente fornecidos pelo banco.

Informe o nome do Arquivo chave do certificado (KEY) e Arquivo de certificado (CRT).

03. CONFIGURAÇÃO DE LAYOUT

Nesse passo, serão configuradas todas as informações que serão encaminhadas para o banco na transmissão do boleto.

04. AMBIENTE DE HOMOLOGAÇÃO

Quando em ambiente de homologação, o banco não retorna as informações de linha digitável e código de barras.

06. CONFIGURAÇÃO DE LAYOUT

Para utilizar o registro online de boletos para o Itaú Versão 2, deve-se observar a seguinte regra:

  • Porc Juros Mensal: Neste campo, deve ser informado o percentual mensal de juros.

     Como padrão, disponibilizamos o campo E1_PORCJUR já multiplicado por 30, respeitando a seguinte regra: juros diário X 30 dias = juros mensal

                 

  • Número do documento: Neste campo deverá ser informado qual será o número do documento que será transmitido ao banco e posteriormente impresso no boleto.

      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.


Importante

A funcionalidade do boleto híbrido (BoleCode) esta em processo de piloto, sendo assim, ainda NÃO esta liberada para uso!

  • BoleCode (Boleto + Pix): Este campo indica se o boleto terá opção de pagamento via QR Code (Pix). O QR Code é impresso no boleto e é possível o cliente efetuar o pagamento pelo QRCode ou pelo Código de Barras.
    • Sim - O boleto será registrado com o PIX, na impressão irá aparecer o QR Code PIX para recebimento do valor.
    • Não - O Boleto será registrado sem o PIX, na impressão não irá aparecer o QR Code PIX.
      • Para ativar esta funcionalidade é necessário entrar em contato com o banco Itaú. O banco Itaú irá disponibilizar um novo certificado e novas credenciais que deverão ser informados em 'Configurar BoleCode' 
      • No momento da transmissão de Boleto com QR Code Pix o Itaú exige informar uma chave pix. É preciso informar uma chave pix como principal no cadastro de Banco(MATA070) → Outras Ações → Chaves PIX.

                                                                                                                                                                                                            


  • Aceite: Este campo indica o reconhecimento formal da divida (assinatura no documento) pelo pagador, deverá ser informado os valores:
    • Sim - Quando existe a necessidade do pagador reconhecer/aceitar a cobrança.
    • Não - Quando não existe a necessidade de reconhecimento da cobrança.

  • Beneficiário Filial: Neste campo deverá ser informado qual filial que será utilizada para a transmissão e impressão do boleto. 

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


Atençã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.


  • Abatimento: Neste campo poderá ou não ser informado um valor de abatimento para o 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:

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

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.


07. PAGAMENTO COM VALORES DIVERGENTES

O Protheus não envia a informação se o boleto poderá ou não ser pago com valores divergentes pois essa configuração é efetuada na própria conta no Banco Itaú. Ou seja, o cliente que recebe o boleto poderá ou não pagar com valores divergentes de acordo com a configuração da conta que emitiu o boleto, não havendo nenhuma configuração para isso no Protheus. Portanto pedimos que entre em contato com seu gerente de contas e verifique se a sua conta está configurada de acordo com a necessidade.


08. CONFIGURAÇÃO DE BOLETO

Permite que o usuário configure como será a impressão do boleto.

  • Imprime abatimento
    • Como mensagem - O valor do abatimento será impresso nas mensagens do boleto
    • Campo desconto/abatimento - O valor do abatimento no titulo será impresso no (-) Desconto/Abatimento do boleto

Importante

  • Não é possível utilizar as opções "Como mensagem" e "Campo desconto/abatimento" em conjunto. 
  • Após a transmissão do boleto as alterações realizadas no campo Imprime abatimento não serão aplicadas aos boletos já transmitidos. As alterações serão aplicadas somente aos boletos transmitidos após a alteração.


09. WEBHOOK - BAIXA TÍTULOS RETORNO

Importante

Importante

  • Webhook para o banco Itaú esta em processo de piloto, sendo assim, ainda NÃO esta liberado para uso!

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

A comunicação do Itaú para o Protheus acontece via autenticação de certificados mTLS. Para mais detalhes acessar a documentação Portal Dev Itaú de cada Webhook mais abaixo.

É necessário um serviço REST habilitado no Protheus. O REST deve estar habilitado com SSL utilizando um certificado A1 (Exemplo de configuração).

O banco Itaú disponibiliza dois serviços de Webhook:

  • Webhook Boleto
  • Webhook Pix
    • Notificação de boletos pagos via QR Code.
    • URL → exemplo: https://seuip:suaporta/api/fin/v1/itau/pix/receivables/pix
    • Cadastro da URL deve ser feito na Configuração de contas desejado no NGF, opção Configurar Bolecode.
    • Pré-condições:
      • Chave Pix principal cadastrada em: Banco(MATA070) → Outras Ações → Chaves PIX
      • Habilitar o campo BoleCode (Boleto + Pix)= Sim no Layout da configuração de contas.
      • Solicitar ao banco Itaú ativação da funcionalidade Bolecode/Pix. O Itaú deverá disponibilizar um novo certificado com novo Id Cliente e chave que deverão ser informados na opção Configurar Bolecode.
      • Solicitar ao banco Itaú acesso a API Webhook Pix.
    • Para mais detalhes acesse a documentação que está disponível no Portal Dev Itaú - Pix.

O cadastro da URL junto ao banco Itaú é realizado pelo Protheus. Ao informar as URLs de Webhook na configuração da conta, ao acionar o botão de salvar as alterações o Protheus se comunica com a API do banco Itaú para cadastro da URL informada junto ao Itaú. Caso algum erro ocorra será mostrado em tela e não irá salvar as alterações. Certifique-se que todas as pré-condições foram atendidas e acesso disponibilizado pelo banco Itaú para utilizar as APIs de Webhook. Ao deixar o campo da URL em branco o Protheus retira o cadastro da URL junto ao banco Itaú.