Histórico da Página
Índice | ||
---|---|---|
|
01.
...
VISÃO GERAL
Configurações necessárias para o registro de boletos por API do banco SICOOB.
Informações | ||
---|---|---|
| ||
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:
|
Aviso | ||
---|---|---|
| ||
Essa funcionalidade está em fase de desenvolvimento e em breve entrará em testes com clientes piloto, portanto ainda não está liberada em nenhum release do Protheus! Será liberado através de pacote de expedição acumulado do módulo financeiro em data ainda a ser informada. Essa página poderá sofrer alterações até a data de liberação da funcionalidade! |
02. HABILITAR SERVIÇO - SICOOB
Para a utilização da API do banco SICOOB é 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 SICCOB é necessário enviar um client certificatepossuir um certificado do tipo A1. 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 banco SICCOB : no tópico Certificado SICOOB. O acesso ao mesmo deve ser também solicitado ao seu gerente de conta.digital.
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.
03. CADASTRO DE BANCO - MATA070
- Para habilitar a configuração de um layout para o Itaúbanco SICOOB, deve ser informado no campo Bco Oficial (A6_BCOOFI) o código 756.
...
Informações | ||
---|---|---|
| ||
É 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
- Número de contrato: deve ser informado no campo Cod. Empresa(EE_CODEMP).
- Nosso número: deve ser parametrizado nos campos Faixa Inicio (EE_FAXINI) , Faixa Fim (EE_FAXFIM) e Faixa atual (EE_FAXATU).
- Número Dias Limite Recebimento: deve ser informado no campo Dias Recebim (EE_DIASREC).
- Quantidade Dias Protesto: deve ser informado no campo Dias Prot (EE_DIASPRT)
- Mensagem para instrução de cobrança: deve ser informada no campo Mensagem (1 e 2) e Mens. Extra (1 e 2) (EE_FORMEN1, EE_FORMEN2), vale ressaltar que o banco aceita no máximo 165 caracteres. Recomendamos o uso de letras minúsculas, pois na impressão do boleto existe um espaço pré-definido para exibição da mensagem. , EE_FOREXT1, EE_FOREXT2) com tamanho máximo de 40 caracteres (limite aceito pelo banco) .
Aviso | ||
---|---|---|
| ||
Para funcionamento da comunicação bancária por API do banco SICOOB 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 SICOOB 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 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. BAIXA TÍTULOS (RETORNO)
Nesse passo, serão configuradas todas as informações necessárias para o retorno das movimentações via API, operação que posteriormente efetuar a baixa dos títulos no financeiro.
06. CONFIGURAÇÃO DE LAYOUT
Para utilizar o registro online de boletos para o banco SICOOB deve 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
as seguintes regras:
- 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.
...
- Número do Título (E1_NUM)
- ID CNAB (E1_IDCNAB)
- 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.
- Boleto com PIX Híbrido(Boleto com QRCode+ 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 SICCOB. 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.
...
- .
- Nosso Número: Número sequencial de 7 posições usado para identificação do título no banco.
- Gerar pelo sistema - Será gerado um sequencial de 7 posições (6 dígitos correspondentes ao campo EE_FAXATU seguido do digito verificador). O valor do campo EE_FAXATU deve ser correspondente a um sequencial de 6 caracteres, caso o tamanho do campo seja maior, utilizar zeros a esquerda.
- Gerar pelo banco - O sequencial será gerado pelo banco.
- 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:
Aviso | ||
---|---|---|
| ||
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. |
...
- Vazio - Caso o valor original já esteja calculado com a dedução dos valores de abatimento ou não exista abatimento para o boleto.
- 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)" .
- 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:
...
- "SE1->E1_SALDO - SomaAbat(SE1->E1_PREFIXO,SE1->E1_NUM,SE1->E1_PARCELA,"R",SE1->E1_MOEDA,dDataBase,SE1->E1_CLIENTE,SE1->E1_LOJA)"
Aviso | ||
---|---|---|
| ||
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
...
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.
...
.
...
BAIXA TÍTULOS RETORNO
Aviso | ||
---|---|---|
| ||
Importante
|
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
- Notificação de boletos pagos via código de barras.
- URL → exemplo: https://seuip:suaporta/api/fin/v1/itau/bol/receivables/
- Cadastro da URL deve ser feito na Configuração de contas desejado no NGF, opção Baixa Títulos (Retorno).
- Pré-condições:
- Solicitar ao banco Itaú acesso a API Webhook Boleto.
- Para mais detalhes acesse a documentação que está disponível no Portal Dev Itaú - 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 processo de baixa de títulos (retorno) é realizado através da execução do Job FINA715.
O Protheus inicia a comunicação com o banco solicitando informações de eventos de baixa de boletos. O Job irá requisitar ao banco boletos liquidados (realizado pagamento) e baixados (não foi realizado pagamento e o banco deu baixa automaticamente) no período determinado do parâmetro MV_FNGDTBX até o dia atual, ou do dia anterior até o dia atual caso não informado o parâmetro.
Após o processamento das informações retornadas pelo banco os títulos são baixados no sistema ou transferidos de carteira, conforme o status retornado pelo banco.
É possível acompanhar o logs das execuções através do Novo Gestor Financeiro acessando o menu: Comunicação online→ Contas a Receber → Log Retorno (Baixas).
Clique no link para mais informações sobre o processo de Baixas Títulos (Retorno) - FINA710O 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ú.