FlashBack Express Recorder

Como Fazer Finanças

2022-05-18T19:39:14Z

Alan.campos:

Como Fazer Finanças

2022-05-18T19:38:57Z

Alan.campos:

2022-05-16T19:32:46Z

Alan.campos: /* Tela Inicial Configuração do Assistente Open Banking: */

[[categoria:Como_Fazer_Finanças]]

='''O que significa Open Banking?'''=

Open Banking é um conceito relativamente novo na realidade do mercado financeiro brasileiro. Porém, ele tem ganhado cada vez mais atenção em todo o mundo.
Traduzido, o termo significa “banco aberto”, mas uma tradução mais precisa seria “sistema financeiro aberto”.
O conceito em si trata de algo de simples compreensão. Basicamente, Open Banking é a defesa de que o sistema financeiro adote a tecnologia de forma mais ampla e padronizada, como forma de incentivar e ampliar a oferta e a qualidade dos produtos e serviços financeiros.
A base do Open Banking está na premissa de que os dados pertencem aos consumidores. Logo, caso eles autorizem, esses dados devem ser disponibilizados para que eles possam ter acesso a produtos e serviços que forem mais convenientes.
Na prática, há um pedido para que as instituições abram suas API’s (sigla em inglês para Interface de Programação de Aplicativos) para que terceiros desenvolvam e aprimorem os sistemas e suas funcionalidades.
O objetivo do Open Banking é desenvolver sistemas integrados, que facilitem o controle e transferência de informações de dados, histórico, contas, empréstimos etc. Todo o tipo de produto e serviço oferecido pelos bancos seria integrado de maneira a evitar processos complicados e dispendiosos.
À primeira vista, pode parecer que com o Open Banking as informações dos clientes ficarão soltas e desprotegidas. No entanto, os bancos e instituições financeiras ainda serão responsáveis pela proteção de dados sigilosos.

='''Serviços Disponíveis pela API do Banco nesta Versão?'''=
'''Menu > Utilidades/Diversos > Genéricos > Parâmetros > Configurações'''
 
<center>
{| class="wikitable"
|-
! SERVIÇO !! COBRANÇA
|-
| Registro de Boleto via API || SIM
|-
| Open Banking PIX no Boleto || NÃO
|-
| Retorno de Cobrança via API || NÃO
|-
| Alteração de Juros via API || SIM
|-
| Alteração de Multa via API || SIM
|-
| Alteração de Vencimento via API || SIM
|-
| Alteração de Baixa via API || SIM
|-
| Negativação no Envio do Registro via API || SIM
|-
| Prostesto no Envio do Registro via API || NÃO
|-
|}
</center>
 

='''Como obter as Credenciais para utilizar a Funcionalidade Open Banking?'''=
 
As credenciais do Banco devem ser obtidas através do contato com o seu Gerente de Cash (Gerente da Conta no Banco).
 
O Banco Sicredi, possui uma nomenclatura interna para esse processo, conhecido como Registro de Cobrança OnLine ou Ecommerce, conforme documentação.
 
Então ao entrar em contato com o Gerente de Cash, validar as nomenclaturas para que haja o entendimento da funcionalidade.
 

='''Quais os Módulos necessários para utilizar a Funcionalidade Open Banking”?'''=

• Módulo Gestão Financeira;

='''Quais são as parametrizações necessárias para utilizar a funcionalidade do Open Banking Banco Sicredi?'''=

'''Itens Importantes na Parametrização:'''
 
'''- Processar retornos pelo número do Boleto:''' esta opção deve estar marcada, pois caso contrário ocorrerá problemas na gravação das informações e envio para Banco.
 
Caso tenha sido realizado movimentações com esta opção desmarcada, não será possível realizar a Baixa, pois sistema não consegue localizar devido não possuir o '''Nosso Número''' gravado nas tabelas envolvidas.
 
Para solucionar essa questão será necessário:
 
'''1-''' Identificar o '''Nosso Número''' do registro a ser baixado (Lançamento Financeiro);
 
'''2-''' Gravar o '''Nosso Número''' nas seguintes tabelas:
 
'''GFBOLETOS:''' campo a ser atualizado '''NOSSO_NRO''' com a informação do Nosso Número.
 
'''GFLAUXIL:''' campo a ser atualizado '''CODIGO_BARRAS''' com a informação do Nosso Número.
 
'''- Processar retornos pelo número do Boleto:''' esta opção deve estar marcada, pois caso contrário ocorrerá problemas na gravação das informações e envio para Banco.
 
 
'''Importante preenchimento Telefone''': o não preenchimento do Telefone no Cadastro de Empresa acarretará em Erro no Registro Open Banking. Não é um item obrigatório, porém o Banco Sicredi para registrar necessita o preenchimento deste dado. Não deve ser utilizado espaços ou caracteres especiais.
 
Para utilizar esta funcionalidade é necessário possuir o Cadastro do Portador para o Banco citado.
O cadastro quando preenchido corretamente garante que não ocorrerá inconsistências no momento do registro do Open Banking.
 
Como boa prática de implementação é mais coerente criar um novo Portador para Open Banking evitando assim de alterar o Portador utilizado para CNAB caso necessite realizar algum processo via remessa ou retorno, quando a API do Banco estiver com instabilidade.
 
Essa parametrização deverá validar os últimos Sequenciais da numeração de Boletos do Portador utilizado para as Remessas, pois assim garante que não ocorrerá conflito enviar uma numeração de Título já registrado.
 
 
Itens importantes na parametrização:
 
- '''Nº Banco''';
 
- '''Nº Conta''';
 
- '''Nº Convênio''';
 
- '''Agência/DV''': o DV da Agência é considerado o '''Posto''' da Agência, ou seja, para adquirir essa informação o Banco da Unidade da Agência deve fornecer.
 
Quando se tratar do Portador Open Banking do SICREDI, o campo '''DV''' da Agência deve ser preenchido conforme a Unidade da Agência do Banco.
 
- '''Código Cedente''';
 
Para o correto funcionamento da rotina é necessário que os dados do Portador esteja com todas informações necessárias, inclusive o Convênio.
 
'''Menu > Finanças > Gestão Financeira > Parâmetros > Portadores'''
 
Este cadastro é apenas uma demonstração de parametrização:
 
<center>'''Cadastro de Portador'''
[[Arquivo:Cadastro Portador Principal.png|750x500px|nenhum|Cadastro_Portador_Principal]]
 
<center>'''Guia CNAB'''
[[Arquivo:Cadastro Portador CNAB Sicredi.png|750x500px|nenhum|Cadastro_Portador_CNAB]]
 

Campo "Especie" quando utilizado Open Banking deve ser = A para Duplicata Mercantil.

<center>'''Guia Configurações'''
[[Arquivo:Cadastro Portador Configurações Sicredi.png|750x500px|nenhum|Cadastro_Portador_Configurações_Sicredi]]
 

'''Irá surgir a necessidade de realizar a alteração de Vencimento, Multa ou Juros do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?'''
 
Regra Sistema para Vencimento, Multa ou Juros:
 
Cadastro do Portador deve possuir Comando de Remessa com as novas opções:
 
'''Tipo de Comando =''' Alteração de Vencimento (para alteração de Vencimento).
 
'''Tipo de Comando =''' Alteração de Multa para Multa (para alteração de Multa).
 
'''Tipo de Comando =''' Alteração de Juros para Juros (para alteração de Juros).
 
Caso não seja parametrizado neste primeiro momento as opções de Multa e Juros o sistema cria automaticamente (Somente Juros e Multa).
 
Ao acessar o Lançamento Financeiro em modo Modificar e alterar o campo Multa de ou Juros de, automaticamente após alteração da Multa, o Sistema irá criar essa parametrização do Comando de Remessa com sugestão, sendo passível de alteração, no Cadastro do Portador no botão Remessas e depois no botão Comandos.
 
'''Comando sugestão para Multa:'''
 
'''Código Operação''' = ATM
 
'''Comando''' = ATM
 
'''Descrição''' = ALTERAÇÃO DE MULTA PARA OPEN BANKING
 
'''Tipo de Comando''' = Alteração de Multa
 
'''Comando sugestão para Juros:'''
 
'''Código Operação''' = ATJ
 
'''Comando''' = ATK
 
'''Descrição''' = ALTERAÇÃO DE JUROS PARA OPEN BANKING
 
'''Tipo de Comando''' = Alteração de Juros
 
<center>'''Botão Remessas > Comandos'''
[[Arquivo:Cadastro Portador Comando Remessa.png|750x500px|nenhum|Cadastro_Portador_Comando_Remessa]]
 
<center>'''Botão Retornos > Códigos de Retorno'''
[[Arquivo:Cadastro Portador Codigo Retorno.png|750x500px|nenhum|Cadastro_Portador_Codigo_Retorno]]
 
Para iniciar a configuração através do “Assistente de Parâmetros do Open Banking”, basta selecionar o botão “Open Banking”:
 
'''Menu > Finanças > Gestão Financeira > Parâmetros > Configuração de Bancos'''
 
 
<center>'''Configurações de Banco'''
[[Arquivo:Cadastro Configuraçao Banco.png|750x500px|nenhum|Cadastro_Configuraçao_Banco]]
 
 
Para dar início ao processo de parametrização, basta selecionar o botão “Avançar”:
 
 

='''Tela Inicial Configuração do Assistente Open Banking:'''=
 
Para iniciar a configuração é necessário ter em mãos os seguintes dados: (Código de Acesso).
Sem essas informações não será possível dar continuidade na parametrização do Open Banking para o Banco do Sicredi.
 
<center>'''GIF'''
[[Arquivo:Agora vai|750x500px|nenhum|agora vai]]
 


 
<center>'''Tela Inicial Assistente de Parâmetros Open Banking'''
[[Arquivo:Wizard Bem Vindo.png|750x500px|nenhum|Wizard_Bem_Vindo]]
 


=='''Etapa 1 (Parâmetros: Passo 1 de 4):'''==


Uma das etapas mais importantes e que requer um cuidado maior e sigilo das informações nesta parametrização.
 
Essas informações são disponibilizadas pelo Banco a qual deve ser restrita somente a pessoa responsável pelo setor Financeiro da Empresa.
 
O assistente tem como objetivo proporcionar que o próprio usuário tenha autonomia para executar esse passo a passo sem necessidade de passar essas informações restritas da Empresa para qualquer pessoa que não seja ele mesmo.
 
Reforçando, mesmo que tenha dificuldades para executar esta etapa, não repasse nenhuma informação relacionado aos acessos dos tokens.
 
Dados em mãos para informar os respectivos campos, basta copiar e colar as informações.
 
Código de Acesso.
 
O Campos '''Código de Acesso''' possui uma tecnologia de criptografia, ou seja, após informar os dados nos campos o sistema irá criptografar as informações garantindo e mantendo a segurança das informações.
 
Caso haja necessidade de alterações, basta clicar no ícone do "Cadeado", será aberta a tela de Criptografia e após colar ou digitar as informações em tela e selecionar o botão "Confirmar".
 
Também tenha alguma dúvida no dado informado e necessitar validar o dado seguindo os mesmos passos da alteração será aberta a tela de Criptografia e após colar ou digitar as informações em tela e selecionar o botão "Validar", sistema confirma se os dados são os mesmos.
 
Observamos que esta tela possui duas guias, uma de Homologação e Produção. Preencher conforme a necessidade do processo, caso precise realizar testes, parametrize em homologação e posteriormente parametrize o de Produção ou se preferir, pode preencher os dois se possuir os dados.
 
Lembrando que esses dados são confidenciais de uso e exclusivo de cada usuário.
 
Através dessas informações o sistema irá se comunicar com API do Banco para poder realizar os registros dos Lançamentos.
 
Após informado os dados, basta selecionar o botão "Avançar", para seguir os próximos passos.
 
'''Código de Acesso:''' informar a codificação passada pelo Banco.
 
 
<center>'''Parâmetros: Passo 1 de 4'''
[[Arquivo:Wizard Passo 1 Sicredi.png|750x500px|nenhum|Wizard_Passo_1_Sicredi]]
 

=='''Etapa 2 (Portador de Remessa e Retorno - Pagamento: Passo 2 de 4):'''==

Nesta etapa deve ser selecionado o Portador que será considerado para o envio da Remessa de Pagamento (onde estarão os boletos em aberto) e nesta mesma tela informar o qual Portador será considerado para o Retorno de Pagamento (onde serão liquidados os retornos de Pagamentos).
 
Nesta etapa, é possível pular, caso não utilize ainda o Envio de Pagamentos do Open Banking.
 
'''Pular:''' caso deseja pular essa etapa e prosseguir com o processo de parametrização do Open Banking.
 
'''Avançar:''' dá continuidade ao processo de parametrização, após selecionado uma opção.
 
Para continuar a parametrização selecione o botão "Pular" e siga para os próximos passos.
 
<center>'''Portador de Remessa e Retorno: Passo: 2 de 4'''
[[Arquivo:Wizard Passo 2 Sicredi.png|750x500px|nenhum|Wizard_Passo_2_Sicredi]]
 

=='''Etapa 3 (Convênios de Cobrança: Passo 3 de 4):'''==
 
Nesta etapa o sistema avalia sua base de dados, e localiza os Convênios parametrizados para o Banco Sicredi, onde serão listados.
O sistema possibilita a parametrização de Convênios específicos bem como caso seja optado, selecionando o botão "Pular" o sistema criará automaticamente o Convênio "Geral", ao qual utiliza dados do Portador registrado.
 
'''Pular:''' caso deseja pular essa etapa e prosseguir com o processo de parametrização do Open Banking.
 
'''Avançar:''' dá continuidade ao processo de parametrização, após selecionado uma opção.
 
<center>'''Convênios de Cobrança: Passo 3 de 4'''
[[Arquivo:Wizard Passo 3 Sicredi.png|750x500px|nenhum|Wizard_Passo_3_Sicredi]]
 

=='''Etapa 3 (Portador de Remessa e Retorno - Cobrança: Passo 3 de 4):'''==
 
Nesta etapa deve ser selecionado o Portador que será considerado para o envio da Remessa de Cobrança (onde estarão os boletos em aberto) e nesta mesma tela informar o qual Portador será considerado para o Retorno de Cobrança (onde serão liquidados os retornos de Cobranças).
 
'''Avançar:''' dá continuidade ao processo de parametrização, após selecionado uma opção.
 
<center>'''Portador de Remessa e Retorno - Cobrança: Passo 3 de 4'''
[[Arquivo:Wizard Passo 3-4 Final Sicredi.png|750x500px|nenhum|Wizard_Passo_3-4_Final_Sicredi]]
 
Atualizado Wizard para Versão 2 do Open Banking, disponibilizando duas opções:
 
'''- Direto:''' esta opção tem como finalidade registrar o Boleto no momento da sua geração, ou seja, quando selecionado ativa propriedade ao qual ao gerar o Boleto Bancário o sistema automaticamente envia o registro Open Banking, sem a necessidade de fazer o processo de envio da Remessa Open Banking do título.
 
Também quando selecionada, terá uma particularidade na questão da Emissão de Boletos em lote pela Rotina de Emissão de Boletos Personalizados. A rotina na guia '''Opções''' tem a opção '''Enviar somente Lançamentos não marcados e marca-los''', caso esteja desmarcada o Registro Open Banking ocorrerá da mesma forma que o sistema irá marcar a opção '''Boleto Impresso''' do Lançamento Financeiro, registrando a Operação Open Banking.
Isso ocorre para manter a integridade, já que esta operação é considerada única no registro, sendo então necessário marcar a '''Boleto Impresso''', para poder conseguir realizar alterações como Alteração de Vencimento ou mesmo a Baixa, sendo uma condição de Sistema.
 
'''- PIX''': esta opção tem como finalidade registrar uma operação PIX para os Boletos emitido de forma Direta (opção '''Direto''' marcado).
 
Esta opção é válida '''SOMENTE''' para o Banco do Brasil.
 

=='''Etapa 4 (Relatório: Passo 4 de 4):'''==

 
Nesta etapa o sistema irá buscar automaticamente o Modelo de Relatório Padrão, caso exista no ambiente, facilitando assim todo processo de parametrização e implementação para usuário.
 
A busca é realizado '''(%CIGAM_INSTAL%RF00071_remessas.RTF)''', com isso é importante que o Modelo de Relatório (RF00071_remessas.RTF) esteja devidamente localizado na pasta padrão do Cigam_Instal, como por exemplo:
 
'''%CIGAM_INSTAL%''' = P:\Cigam11\Projects\Controle\MACIEL\Financeiro_Open_Banking
 
"P:\Cigam11\Projects\Controle\MACIEL\Financeiro_Open_Banking\Modelos\Relatorios\Gestao Financeira\RF00071_remessas.RTF"
 
Clicar em "Avançar" para dar seguimento.
 
<center>'''Assistente de Parâmetros Open Banking: Passo 4 de 4'''
[[Arquivo:Wizard Passo 4-4 Relat Sicredi.png|750x500px|nenhum|Wizard_Passo_4-4_Relat_Sicredi]]
 
 

=='''Etapa Conclusão (Parâmetros de Convênio Open Banking - Conclusão):'''==

 
Esta etapa o sistema faz validação da comunicação com o Banco através da API verificando o ambiente se esta tudo ok, listando em tela.
 
Após a consulta estar "OK", basta clicar no botão "Concluir" e seu ambiente estará apto para utilizar a funcionalidade Open Banking.
 
<center>'''Parâmetros de Convênio Open Banking: Passo Final - Conclusão'''
[[Arquivo:Wizard Passo Final Conclusao Conexao Sicredi.png|750x500px|nenhum|Wizard_Passo_Final_Conclusao_Conexao_Sicredi]]
 
'''Homologação:''' Conexão realizada com sucesso.
 
'''Produção:''' Conexão realizada com sucesso.
 
O servidor remoto retornou um erro: (401) Não Autorizado. Isso ocorre quando não houve a parametrização dos dados em Produção como foi realizado no ambiente de Homologação conforme o passo a passo, ou possa ter ocorrido algum erro na comunicação com o Banco.
 
<center>'''Convênio Cadastrado com Sucesso - Cobrança'''
[[Arquivo:Parametros OP Sicredi.png|750x500px|nenhum|Parametros_OP_Sicredi]]
 
'''Ambiente:''' lista qual é o ambiente cadastrado, sendo apenas duas opções: Homologação e Produção.
 
'''Convênios:''' neste grupo serão listados todos os convênios cadastrados, bem como todas informações pertinentes como:
 
- Portador;
 
- Agência;
 
- Número Conta;
 
- Portador de retorno;
 
'''- Direto:''' esta opção tem como finalidade registrar o Boleto no momento da sua geração, ou seja, quando selecionado ativa propriedade ao qual ao gerar o Boleto Bancário o sistema automaticamente envia o registro Open Banking, sem a necessidade de fazer o processo de envio da Remessa Open Banking do título.
 
'''- PIX:''' esta opção fica habilitada somente quando selecionado a opção Direto, ela tem como finalidade registrar uma operação PIX para os Boletos emitido de forma Direta (opção Direto marcado).
 
Esta opção é válida SOMENTE para o Banco do Brasil.
 
Ao emitir o Boleto do Lançamento o sistema marca as 3 opções:
 
- Boleto Impresso;
 
- Remessa Enviada;
 
- Código de Barras Lido;
 
'''U.N Ced.:''' esta opção tem como finalidade possibilitar o envio e registro de Boletos de outras Unidades de Negócio.
 
Basta informar a Unidade desejada no campo e o sistema entenderá quando realizado o processo de registro de um título que não seja da Unidade Matriz, então sistema identifica e realiza o processo de envio e registro.
Se deixar em Branco a Unidade Cedente irá considerar para todas Unidades de Negócio.
 
 
<center>'''Convênio Cadastrado com Sucesso - Pagamento'''
[[Arquivo:Parametros OP Sicredi Pagamento.png|750x500px|nenhum|Parametros_OP_Sicredi_Pagamento]]
 
'''Ambiente:''' lista qual é o ambiente cadastrado, sendo apenas duas opções: Homologação e Produção.
 
'''Convênios:''' neste grupo serão listados todos os convênios cadastrados, bem como todas informações pertinentes como:
 
- Portador;
 
- Agência;
 
- Número Conta;
 
- Portador de retorno;
 
<center>'''Ícone Credenciais'''
[[Arquivo:Parametros OP Sicredi Credenciais.png|750x500px|nenhum|Parametros_OP_Sicredi_Credenciais]]
 
Através deste ícone é possível verificar os Parâmetros API parametrizados, tanto em homologação quanto em produção.
 
 
<center>'''Ícone Endereços'''
[[Arquivo:Parametros OP Sicredi Endereços.png|750x500px|nenhum|Parametros_OP_Sicredi_Endereços]]
 
Através deste ícone é possível verificar todos endereços de URLs parametrizados.

='''O que significa a Categoria Open Banking de acesso?'''=
 
 A Categoria Open Banking é uma Categoria que é habilitada mediante a utilização de um Portador parametrizado com as Configurações de Banco Open Banking. A mesma tem como objetivo proporcionar maior agilidade e gerenciamento das atividades relacionadas a Remessa de Cobrança Online.
 
'''Categoria Open Banking'''
 
 
<center>'''Categoria Open Banking'''
[[Arquivo:Categoria Open Banking.png|750x500px|semmoldura|nenhum|Categoria_Open_Banking]]
 
 

'''Registrar:''' item de categoria tem como funcionalidade registrar o Boleto Bancário Online. Substitui todo o processo de geração do arquivo de Remessa de Cobrança, acessar o site e remeter ao Banco esse arquivo, com apenas um clique na opção.
 
'''Reenviar:''' item de categoria tem como funcionalidade possibilitar o reenvio de registros que estão com alguma pendência ou algum erro de parametrização. Será habilitado somente quando já possuir movimento de "Registro" enviado, cuja Situação estiver com pendência ou erro.
 
'''Baixar:''' item de categoria tem como funcionalidade comunicar o Banco referente a Baixa do movimento em questão do Boleto Bancário. Utilizado para eventuais falhas operacionais, como registrado um movimento por engano, ou negociações diretamente com cliente a parte. Eliminando então também todo processo de geração do arquivo de Remessa Bancária com Comando de Remessa de Baixa e o processo de remeter ao Banco o arquivo, sendo realizado tudo online através desta opção.
 
'''Registrar Alteração:''' item de categoria tem como funcionalidade registrar uma alteração ocorrida referente ao "Vencimento" do Lançamento Financeiro.
Ao realizar alteração da Data de Vencimento do Lançamento Financeiro que está com "Situação Open Banking" igual "Registrado" e ocorrer alteração no Vencimento, o sistema emite uma mensagem possibilitando já o envio da alteração no momento ou mais tarde através desta opção de "Registrar Alteração".
 
'''Histórico:''' item de categoria tem como funcionalidade gravar todas movimentações realizadas relativo ao Open Banking. Registros, Baixas, Erros...

='''Layout e Detalhamento de Campos API'''=
==Registro de Boletos==
<center>

{| class="wikitable"
|-
! Nº !! Campo JSON !! Descriçao do Banco !! Campo CIGAM !! Tabela !! Obrigatório !! Observações
|-
| 1 || token || Chave Transacional gerada pelo recurso /autenticacao || || || Obrigatório ||
|-
| 2 || Content-Type || Estabelece o tipo de conteúdo da requisição || || || Obrigatório ||
|-
| 3 || agencia || Código da Cooperativa do beneficiário || Agência || Portador || Obrigatório ||
|-
| 4 || posto || Código do Posto do beneficiário || Dígito Agência || Portador || Obrigatório ||
|-
| 5 || cedente || Código do Convênio de Cobrança do beneficiário || Código Cedente || Portador || Obrigatório ||
|-
| 6 || nossoNumero* || Nosso Número || Nosso Número || Boletos || Opcional ||
|-
| 7 || codigoPagador || Código Pagador || Não Tratado || Não Tratado || Opcional ||
|-
| 8 || tipoPessoa* || Tipo de pessoa do pagador.
'''Domínio:'''
 
1 - PESSOA FÍSICA
 
2 - PESSOA JURÍDICA
|| Pessoa || Empresa || Obrigatório ||
|-
| 9 || cpfCnpj* || CPF ou CNPJ do pagador || CNPJ/CPF || Empresa || Obrigatório ||
|-
| 10 || nome || Nome do pagador || Nome Completo || Empresa || Obrigatório ||
|-
| 11 || endereco || Endereço do pagador || Endereço || Empresa || Opcional || Será obrigatório se o código do pagador '''não''' for informado.
|-
| 12 || cidade || cidade || Município || Empresa || Opcional || Será obrigatório se o código do pagador '''não''' for informado.
|-
| 13 || uf || Estado do pagador || UF || Empresa || Opcional || Será obrigatório se o código do pagador '''não''' for informado.
|-
| 14 || cep || CEP do pagador || CEP || Empresa || Obrigatório ||
|-
| 15 || telefone || Telefone mais DDD do pagador || Fone || Empresa || Opcional || Será obrigatório se o código do pagador '''não''' for informado.
|-
| 16 || email || Endereço de email do pagador || Email || Contato || Opcional ||
|-
| 17 || especieDocumento || Espécie de documento do título.(*) || Espécie || Portador || Obrigatório ||
|-
| 18 || codigoSacadorAvalista || Código do sacador avalista. || Não Tradado || Não Tradado || Opcional ||
|-
| 19 || seuNumero || Número de controle interno do beneficiário que referencia o pagador. || Lançamento || LANCAM || Obrigatório ||
|-
| 20 || dataVencimento || Data de vencimento do boleto || Vencimento || Boletos || Obrigatório ||
|-
| 21 || valor || Valor do boleto || Saldo || LANCAM || Obrigatório ||
|-
| 22 || tipoDesconto || Tipo de desconto.
'''Domínios:'''
 
A - VALOR
 
B - PERCENTUAL
|| Não Tratado || Não Tratado || Obrigatório ||
|-
| 23 || valorDesconto1 || Valor de desconto 1 || Valor Desconto || LANCAM || Opcional || Será obrigatório se o dataDesconto1 for informado.
|-
| 24 || dataDesconto1 || Data limite para concessão de desconto1 || Vencimento || LANCAM || Opcional || Será obrigatório se o valorDesconto1 for informado. Não pode ser igual a outras dataDescontos e nem maior que vencimento.
|-
| 25 || valorDesconto2 || Valor de desconto 2 || Não Tratado || Não Tratado || Opcional || Será obrigatório se o dataDesconto2 for informado.
|-
| 26 || dataDesconto2 || Data limite para a concessão de desconto 2 || Não Tratado || Não Tratado || Opcional || Será obrigatório se o valorDesconto2 for informado. Não pode ser igual a outras dataDescontos e nem maior que vencimento.
|-
| 27 || valorDesconto3 || Valor de desconto 3 || Não Tratado || Não Tratado || Opcional || Será obrigatório se o dataDesconto3 for informado.
|-
| 28 || dataDesconto3 || Data limite para a concessão de desconto 3 || Não Tratado || Não Tratado || Opcional || Será obrigatório se o valorDesconto3 for informado. Não pode ser igual a outras dataDescontos e nem maior que vencimento.
|-
| 29 || tipoJuros || Tipo de Juros.
'''Domínios:'''
 
A - VALOR
 
B - PERCENTUAL
|| || || Obrigatório ||
|-
| 30 || juros || Valor de juros a cobrar por dia. || Juros Dia || LANCAM || Opcional ||
|-
| 31 || multas || Percentual de multa a cobrar || Valor Multa || LANCAM || Opcional ||
|-
| 32 || desconto Antecipado || Valor de desconto antecipado a cobrar || Não Tratado || Não Tratado || Opcional || Deve ser menor que o valor.
|-
| 33 || informativo || Texto do Informativo || Não Tratado || Não Tratado || Opcional ||
|-
| 34 || mensagem* || Texto da linha da mensagem || Não Tratado || Não Tratado || Opcional ||
|-
| 35 || codigoMensagem || Código da mensagem || Não Tratado || Não Tratado || Opcional ||
|-
| 36 || numDiasNegativacaoAuto || Número de dias para Negativação Automática. 0 (Zero) para não negativar automaticamente. Quando preenchido com 3 ou 4 dias o sistema comandará negativação em dias úteis após o vencimento. Quando preenchido acima de 4 dias, o sistema comandará negativação em dias corridos após o vencimento. || Protesto || Portador || Opcional ||
|-
| 37 || NomeBeneficiarioFinal || NomeBeneficiarioFinal || Não Tratado || Não Tratado || Obrigatório caso informado TipoPessoaBeneficiarioFinal e CpfCnpjBeneficiarioFinal ||
|-
| 38 || TipoPessoaBeneficiarioFinal || Tipo de pessoa.
'''Domínios:'''
 
1 - Física
 
2 - Jurídica
|| Não Tratado || Não Tratado || Obrigatório caso informado NomeBeneficiarioFinal e CpfCnpjBeneficiarioFinal ||
|-
| 39 || CpfCnpjBeneficiarioFinal || CPF/CNPJ do beneficiário final || Não Tratado || Não Tratado || Obrigatório caso informado NomeBeneficiarioFinal e TipoPessoaBeneficiarioFinal ||
|-
| 40 || FoneBeneficiarioFinal || Fone do beneficiário final || Não Tratado || Não Tratado || Opcional ||
|-
| 41 || EnderecoBeneficiarioFinal || Endereço do beneficiário final || Não Tratado || Não Tratado || Opcional ||
|-
| 42 || CepBeneficiarioFinal || CEP do beneficiário final || Não Tratado || Não Tratado || Opcional ||
|-
| 43 || CidadeBeneficiarioFinal || CidadeBeneficiarioFinal || Não Tratado || Não Tratado || Opcional ||
|-
| 44 || UfBeneficiarioFinal || UF do beneficiário final || Não Tratado || Não Tratado || Opcional ||
|-
|}

</center>

'''(*) Domínios:'''
 
A - DUPLICATA MERCANTIL (DM)
 
B - DUPLICATA RURAL (DR)
 
C - NOTA PROMISSORIA (NP)
 
D - NOTA PROMISSORIA RURAL (NR)
 
E - NOTA DE SEGURO (NS)
 
G - RECIBO (RC)
 
H - LETRA DE CAMBIO (LC)
 
I - NOTA DE DEBITO (ND)
 
J - DUPLICATA DE SERVICO (DS)
 
K - OUTROS (OS)
 
O - BOLETO OFERTA (OFE)

==Alteração de Boletos==
<center>

{| class="wikitable"
|-
! Nº !! Campo JSON !! Descriçao do Banco !! Campo CIGAM !! Tabela !! Obrigatório !! Observações
|-
| 1 || agencia || Agência do Beneficiário || Agência || Portador || Obrigatório ||
|-
| 2 || posto || Posto do Beneficiário || Dígito Agência || Portador || Obrigatório ||
|-
| 3 || cedente || Código do Beneficiário || Código Cedente || Portador || Obrigatório ||
|-
| 4 || nossoNumero* || Nosso Número do Título || Nosso Número || Boletos || Obrigatório ||
|-
| 5 || instrucaoComando || Comando que será realizado na alteração do boleto. || || || Obrigatório || Caso seja informado ALTERACAO_OUTROS_DADOS será '''obrigatória''' a inclusão do campo complementoInstrucao.
|-
| 5.1 || PEDIDO_BAIXA || || || || Obrigatório || Consultar o Termo de Adesão com sua Unidade de Atendimento Sicredi p/ ver se está com Baixa Automática de boletos vencidos. Caso esteja, o boleto vencido terá sua baixa efetuada automaticamente.
|-
| 5.2 || CONCESSAO_ABATIMENTO || || || || Obrigatório ||
|-
| 5.3 || CANCELAMENTO_ABATIMENTO_CONCEDIDO || || || || Obrigatório ||
|-
| 5.4 || ALTERACAO_VENCIMENTO || || || || Obrigatório ||
|-
| 5.5 || ALTERACAO_SEU_NUMERO || || || || Obrigatório ||
|-
| 5.6 || PEDIDO_PROTESTO || || || || Obrigatório || Somente em título vencido. Por padrão, todos os boletos emitidos pelo EComm-API, não são protestados.
|-
| 5.7 || SUSTAR_PROTESTO_BAIXAR _TITULO || || || || Obrigatório ||
|-
| 5.8 || SUSTAR_PROTESTO_MANTER_CARTEIRA || || || || Obrigatório ||
|-
| 5.9 || ALTERACAO_OUTROS_DADOS || || || || Obrigatório ||
|-
| 6 || complementoInstrucao || Complemento do comando que será realizado na alteração do boleto || || || Condicional ||
|-
| 6.1 || DESCONTO || || || || Condicional ||
|-
| 6.2 || JUROS_DIA || || || || Condicional ||
|-
| 6.3 || DESCONTO_DIA_ANTECIPACAO || || || || Condicional ||
|-
| 6.4 || DATA_LIMITE_CONCESSAO_DESCONTO || || || || Condicional ||
|-
| 6.5 || CANCELAMENTO_PROTESTO _AUTOMATICO || || || || Condicional ||
|-
| 6.6 || CANCELAMENTO_NEGATIVACAO_AUTOMATICA || || || || Condicional ||
|-
| 7 || ''Campo de Alteração'' || Nome do campo que deseja mudar || || || Obrigatório ||
|-
|}

</center>

='''Como realizar a criação de Lançamentos utilizando a funcionalidade Open Banking?'''=
 
Para a criação de Lançamentos Financeiros acessar o caminho de Menu:
 

'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 

Acessar o botão “Criar” e informar os dados necessários para a criação do Lançamento Financeiro a Receber utilizando o Portador parametrizado para Open Banking.
 
 
'''1- Etapa criação do Lançamento:'''
 
 
<center>'''Criação do Lançamento Financeiro a Receber'''
[[Arquivo:Create Lanc Open Banking.png|750x500px|semmoldura|nenhum|Criação do Lançamento Financeiro]]
 
 

'''2- Etapa Impressão do Boleto Bancário do Lançamento Financeiro:'''
 
Nesta etapa pode ser realizado a impressão do Boleto Bancário diretamente pelo próprio Lançamento Financeiro ou através da rotina de Emissão em lote "Emissão de Boletos Personalizados":
 
 
<center>'''Impressão do Boleto Bancário do Lançamento Financeiro'''
[[Arquivo:Imprimir Boleto Lanc.png|750x500px|semmoldura|nenhum|Impressão Boleto Bancário]]
 
 

'''3- Etapa do Registro do Boleto Open Banking:'''
 
Nesta etapa pode ser realizado o "Registro" do Boleto diretamente pelo próprio Lançamento Financeiro ou através da rotina de Emissão em lote "Emissão de Boletos Personalizados":
Basta acessar a Categoria "Open Banking" e selecionar o Item de Categoria "Registrar".
Sistema irá realizar a comunicação através das parametrizações realizadas das Urls e Tokens de acesso e listará a situação do Registro do Boleto Bancário através do Relatório.
 
 
<center>'''Registrar Boleto Open Banking através Lançamento Financeiro'''
[[Arquivo:Boleto Impresso Registrar OP.png|750x500px|semmoldura|nenhum|Registro Boleto Open Banking]]
 
 
<center>'''Relatório Remessa Bancária OnLine'''
[[Arquivo:Relat Registro Open Banking.png|750x500px|semmoldura|nenhum|Relatório Remessa Bancária Online]]
 
 
Após o registro automaticamente o sistema marca as opções de:
 
- Remessa Enviada
 
- Códigos de Barras Lido
 
 
<center>'''Boleto Bancário Registrado'''
[[Arquivo:Lanc Registrado Validar Historico.png|750x500px|semmoldura|nenhum|Lanc_Registrado_Validar_Historico]]
 
 
Para verificar todas as movimentações realizada sobre Open Banking, elas estão sendo gravadas no Item de Categoria "Histórico" que fica na Categoria "Open Banking".
Ao selecionar o Item de Categoria "Histórico" deve listar o Registro do Boleto Bancário.
 
 
<center>'''Item de Categoria Histórico de Movimentos Open Banking'''
[[Arquivo:Item Categoria Historico.png|750x500px|semmoldura|nenhum|Item_Categoria_Histórico]]
 
 

='''Como realizar o Envio em Lote Open Banking através da rotina Remessa de Cobrança Open Banking?'''=

Assim como é possível realizar o Envio do Registro do Boleto Bancário através do próprio Lançamento Financeiro, existe a possibilidade de realizar esse processo em Lote, quando se tratar de vários registros a serem enviados.
Através do Menu:
 
 
'''Menu: Finanças > Gestão Financeira > Rotinas > EDI> Transmite > Remessa Cobranças Bancárias > Remessa de Cobrança Open Banking'''
 
 
<center>'''Remessa de Cobrança Open Banking'''
[[Arquivo:Remessa_de_Cobranca_Open_Banking_BB3.png|750x500px|semmoldura|nenhum|Remessa_de_Cobranca_Open_Banking]]
 
 
Esta rotina tem um conceito muito simples em relação aos filtros, foram disponibilizados campos essências que permitem ter uma rastreabilidade dos movimentos.

'''Unidade de Negócio:''' informe a Unidade de Negócio desejada para realizar o filtro para busca dos movimentos.
 
'''Data:''' informe a Data desejada para realizar o filtro para busca dos movimentos.
 
'''Vencimento:''' informe o período de Vencimento desejado para realizar o filtro para busca dos movimentos.
 
'''Lançamento:''' informe a faixa de Lançamentos desejada para realizar o filtro para busca dos movimentos.
 
'''Tipo de Pagamento:''' informe o Tipo de Pagamento desejado para realizar o filtro para busca dos movimentos.
 
'''Série:''' informe a Série desejada para realizar o filtro para busca dos movimentos.
 
'''Nota Fiscal:''' informe a faixa de Nota Fiscal desejada para realizar o filtro para busca dos movimentos.
 
'''Conta Financeira:''' informe a Conta Financeira desejada para realizar o filtro para busca dos movimentos.
 
'''Empresa:''' informe a faixa de Empresa desejada para realizar o filtro para busca dos movimentos.
 
'''Cobrança:''' informe a faixa de Empresa de Cobrança desejada para realizar o filtro para busca dos movimentos.
 
 
Após informado os filtros e confirmado a operação da rotina o sistema gera um relatório com a listagem dos movimentos.
Na coluna "Registro", será listado se houve a confirmação ou ocorreu algum erro.
 
 
<center>'''Relatório Remessa de Cobrança Open Banking'''
[[Arquivo:Relat Remessa Bancaria Open Banking.png|750x500px|semmoldura|nenhum|Relat_Remessa_Bancaria_Open_Banking]]
 
 

='''Como realizar a alteração de Vencimento do Lançamento já Registrado Open Banking e reenviá-lo novamente?'''=
 

Irá surgir a necessidade de realizar a alteração do Vencimento do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?
 
'''Dado que''' já temos um Lançamento Financeiro já Registrado Open Banking, basta acessar o Lançamento Financeiro desejado através do caminho do Menu:
 
'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 
Acessar o Lançamento Financeiro em modo Modificar e alterar o campo "Venc.Original", automaticamente após alteração do Vencimento, o sistema insere o Comando "05" no campo "Comando de Remessa" e diante disso já emite uma mensagem:
 
'''Confirma o envio da alteração do título ao banco?'''
 
'''Importante:''' para o envio da alteração do Vencimento o sistema já considera o campo '''Vencimento''', caso seja utilizado a '''Modalidade''' como '''Seguinte''' por exemplo, onde é possível ter um Vencimento Original diferente do Vencimento.
 
<center>'''Lançamento Financeiro a Receber já Registrado'''
[[Arquivo:AlterarVenc Lanc1.png|750x500px|nenhum|AlterarVenc_Lanc1]]
 
 
Vencimento alterado, sistema insere o Comando "05" no campo "Comando de Remessa" e ao salvar o registro é emitido a mensagem: "Confirma o envio da alteração do título ao banco?"
 
<center>'''Vencimento alterado e registro salvo'''
[[Arquivo:Vencimento Alterado Msn.png|750x500px|nenhum|Vencimento_Alterado_Msn]]
 
'''Sim:''' é enviado o registro de alteração do Open Banking e se registrado com sucesso, sistema retira então o Comando de Remessa.
 
<center>'''Processo Concluído com Sucesso'''
[[Arquivo:Processo_Concluido_Sucesso_Lanc.png|750x500px|nenhum|Processo_Concluido_Sucesso_Lanc]]
 
Há possibilidades do tempo de comunicação com API do Banco não retornar imediatamente a confirmação do recebimento da Alteração do Vencimento. Quando ocorrer essa situação, sistema emite uma mensagem, solicitando aguardar, para tentar novamente o envio da alteração do vencimento.
Quando ocorrer essa situação, será necessário aguardar e após realizar o envio novamente ou através do próprio Lançamento ou através da rotina de Remessa de Cobrança - Open Banking, que remeterá as alterações para o Banco.
<center>'''Processo Pendente Alteração - Aguardar'''
[[Arquivo:Alteração Vencimento Processo Pendente Envio Aguardar.png|750x500px|nenhum|Alteração_Vencimento_Processo_Pendente_Envio_Aguardar]]
 
Já quando selecionado a opção '''Não''':
 
'''Não:''' não faz a comunicação do envio da alteração do vencimento via Open Banking. Este registro não foi notificado, logo será necessário realiza-lo através do próprio Lançamento ou através da rotina de Remessa de Cobrança Open Banking.
 
No Lançamento Financeiro é habilitado o botão "Reenviar Registro" no Item de Categoria "Open Banking".
Quando selecionado o botão '''Registrar Alteração''', sistema faz a comunicação via Open Banking e registra alteração de vencimento realizada.
 
<center>'''Lançamento Não Registrado a alteração de Vencimento com o Comando de Remessa'''
[[Arquivo:Botao Registrar Alteracao Habilitado.png|750x500px|nenhum|Botao_Registrar_Alteracao_Habilitado]]
 
Ao selecionar o botão "Registrar Alteração" sistema emite a mensagem para confirmar o envio.
 
<center>'''Botão Registrar Alteração'''
[[Arquivo:Registrar Alteracao Selecionado.png|750x500px|nenhum|Registrar_Alteracao_Selecionado]]
 
Após a confirmação o sistema registra alteração
 
<center>'''Processo Concluído com Sucesso'''
[[Arquivo:Processo_Concluido_Sucesso_Lanc.png|750x500px|nenhum|Processo_Concluido_Sucesso_Lanc]]
 
 
<center>'''Lançamento alterado e registrado'''
[[Arquivo:Lançamento alterado registrado.png|750x500px|nenhum|Lançamento_alterado_registrado]]
 

='''Como realizar a Alteração de Juros do Lançamento já Registrado Open Banking e reenviá-lo novamente?'''=
 

'''Irá surgir a necessidade de realizar a alteração de Juros do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?'''
 
Dado que já temos um Lançamento Financeiro já Registrado Open Banking, basta acessar o Lançamento Financeiro desejado através do caminho do Menu:
 
'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 
'''Regra Sistema para os Juros:'''
 
Se no cadastro do Portador não possuir Comando de Remessa com as novas opções:
 
'''Tipo de Comando =''' Alteração de Juros para Juros
 
'''BANCO SICREDI:''' para este Banco por enquanto atende '''somente''' alteração de Juros para registro Open Banking, não registrando então caso alterado Multas.
 
Ao acessar o Lançamento Financeiro em modo Modificar e alterar o campo '''Juros Dias de''' ou '''Juros Mês de''', automaticamente após alteração dos Juros, o Sistema irá criar essa parametrização do Comando de Remessa com '''sugestão''', sendo passível de alteração, no Cadastro do Portador no botão '''Remessas''' e depois no botão '''Comandos'''.
 
'''Comando sugestão para Juros:'''
 
'''Código Operação =''' ATJ
 
'''Comando =''' ATJ
 
'''Descrição =''' ALTERAÇÃO DE JUROS PARA OPEN BANKING
 
'''Tipo de Comando =''' Alteração de Juros
 
 
<center>'''Cadastro do Portador Comando de Remessa Juros'''
[[Arquivo:Lancto Registrado Alteração Juros Dia 748.png|750x500px|nenhum|Lancto_Registrado_Alteração_Juros_Dia_748]]
 
 

'''Como é identificado a alteração de Juros para Banco?'''
 
Através das tags enviadas para API gravadas no Histórico do Open Banking Dados API:
 
'''instruçãoComando''':'''ALTERACAO_OUTROS_DADOS''' – indica que ocorreu uma alteração de registro no Lançamento.
 
'''complementoInstrucao''': '''JUROS_DIA''' – indica que há Juros no registro.
 
'''valor1''': 0.12, - indica o valor dos Juros.
 
 
<center>'''Lançamento Financeiro a Receber já Registrado alterando os Juros'''
[[Arquivo:Lancto Registrado Alteração Juros Dia.png|750x500px|nenhum|Lancto_Registrado_Alteração_Juros_Dia]]
 
 

Tags enviadas para API Banco:
 
 
<center>'''Dados API Tags referente aos Juros'''
[[Arquivo:Dados API Juros 748.png|750x500px|nenhum|Dados_API_Juros_748]]
 
 

='''Quais são as novidades após atualização para Versão 2 do Open Banking?'''=
 
Disponibilizado a Versão 2 para Open Banking que traz algumas novidades para o processo de Registro no Banco.
 
Nela terá um componente que quando atualizado a Base através do Assistente de Atualização (Atualiza CIGAM) será adicionado nos Parâmetros Open Banking da Configuração de Bancos, especificamente nas Credenciais, o registro '''Versão API''' = v2.
 
'''Finanças > Gestão Financeira > Parâmetros > Configurações de Bancos'''
 
<center>'''Parâmetros Open Banking'''
[[Arquivo:Parametros OP Sicredi Credenciais.png|750x500px|nenhum|Parametros_OP_Sicredi_Credenciais]]
 
A partir desta Versão o Sistema passa a realizar a busca para localizar os títulos da seguinte forma:
 
1- O sistema tenta localizar os títulos pelo Número do Lançamento;
 
2- Caso os títulos tenham sido gerados pelo CIGAM irá localizar pelo '''Nosso Número''', avaliando então a tabela '''GFBOLETOS''' pela coluna '''NOSSO_NRO'''.
 
3- Caso os títulos tenham sido gerados por outro sistema irá localizar pelo '''Nosso Número''', avaliando então a tabela '''GFLAUXIL''' pela coluna '''CODIGO_BARRAS'''.
 
Também nesta versão estão disponíveis as tags para Envio da Série/NF, sendo utilizado a Tag na API '''NumeroTituloBeneficiario'''. A regra é '''Serie''' '''NF''' '''Complemento Duplicata''', bem como descrito com espaços em Branco entre eles. Para verificar esse registro, basta acessar após o Registro no Banco o Histórico Open Banking na guia '''Envio''' e localizar para Tag '''NumeroTituloBeneficiario'''.
 
<center>'''Parâmetros de Convênio Open Banking'''
[[Arquivo:Wizard Passo 3-4 Final Sicredi.png|750x500px|nenhum|Wizard_Passo_3-4_Final_Sicredi]]
 
Atualizado Wizard para Versão 2 do Open Banking, disponibilizando duas opções:
 
'''- Direto''': esta opção tem como finalidade registrar o Boleto no momento da sua geração, ou seja, quando selecionado ativa propriedade ao qual ao gerar o Boleto Bancário o sistema automaticamente envia o registro Open Banking, sem a necessidade de fazer o processo de envio da Remessa Open Banking do título.
 
'''- PIX''': esta opção fica habilitada somente quando selecionado a opção '''Direto''', ela tem como finalidade registrar uma operação PIX para os Boletos emitido de forma Direta (opção '''Direto''' marcado).
 
Esta opção é válida '''SOMENTE''' para o Banco do Brasil.
 
Ao emitir o Boleto do Lançamento o sistema marca as 3 opções:
 
- Boleto Impresso;
 
- Remessa Enviada;
 
- Código de Barras Lido;
 
Outra mudança é no '''Histórico''' Open Banking, ao qual passa criar o registro com '''Status Open Banking''' já '''Registrado'''.
 
Também ao acessar os '''Dados API''' é enviado a tag: "indicadorPix": "S", pois a opção PIX esta selecionada.
 
Disponibilizado o Modelo de Relatório para o Boleto Banco do Brasil já com o QRCode:
 
'''I:\CIGAM\DOC\Modelos_relatorios\Gestão Financeira\Bloquetos Merge\0098_brasil_PIX.rtf'''

='''Como realizar a Baixa de um Lançamento Financeiro Registrado Open Banking e enviar o Registro de Baixa?'''=
 
'''IMPORTANTE:''' O processo de Cancelamento de Notas Fiscais, não atende a baixa automatica dos Boletos, logo deve ser baixado manualmente os registros dos Lançamentos Financeiros.
 
Para realizar o processo de '''Baixa''' de um Lançamento Financeiro que foi registrado via Open Banking, basta acessar o Lançamento Financeiro.
 
'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 
Selecionar a opção de Menu Lateral do Lançamento Financeiro '''Open Banking''' e a opção de '''Baixar'''.
 
<center>'''Lançamento Financeiro Registrado/Baixar'''
[[Arquivo:Opção Baixar Lancto.png|750x500px|nenhum|Opção_Baixar_Lancto]]
 
<center>'''Lançamento Financeiro Confirmando Operação'''
[[Arquivo:Deseja Baixar.png|750x500px|nenhum|Deseja_Baixar]]
 
<center>'''Lançamento Financeiro Baixado com Sucesso'''
[[Arquivo:Baixado Sucesso.png|750x500px|nenhum|Baixado_Sucesso]]
 

='''Como parametrizar para envio Open Banking a Negativação?'''=
 
Basta acessar o Cadastro do Portador e inserir os dias no campo '''Protestar após''' na guia '''Configurações.
 

'''Menu > Finanças > Gestão Financeira > Parâmetros > Portadores'''

 
<center>'''Dias de Protesto Cadastro do Portador'''
[[Arquivo:Cadastro Portador Negativacao Sicredi.png|750x500px|nenhum|Cadastro_Portador_Negativacao_Sicredi]]
 

Banco do Sicredi:
 
Para este Banco a negativação é parametrizada no Cadastro do Portador na guia “Configurações” no campo “Protestar após”, é através deste campo que o sistema reconhece e passa considerar o envio das tags para os dados da API do Banco.
 
'''"numDiasNegativacaoAuto": "07",'''

 

='''Como cadastrar as Mensagens de Retorno API Financeira Sugestão Usuário?'''=
 
As Mensagens de Retorno API Financeira é uma funcionalidade para facilitar a identificar e de orientação para com as mensagens provindas das APIs que o Sistema tem conexão.
 
Elas foram implementadas para Open banking.
 
Para acessar o cadastro basta acessar através do Menu:
 
'''Menu: Finanças > Gestão Financeira > Parâmetros > Mensagens de Retorno API Financeiro'''
 

<center>'''Mensagens de Retorno API Financeiro'''
[[Arquivo:Mensagens Retorno API Financeiro.png|750x500px|nenhum|Mensagens_Retorno_API_Financeiro]]
 

'''Banco:''' código do Banco conforme codificação no orgão que rege os Bancos Febraban.
 
'''Código Erro:''' código do erro conforme layout das APIS dos Bancos.
 
'''Status:''' é o código de Status de erro do Servidor retornado da API dos Bancos. (Código HTTP)
 
'''Descrição do Erro (Banco):''' essa descrição é oriunda do Banco retornada pela API deles.
 
'''Sugestão CIGAM:''' esta mensagem é interna do Sistema, ou seja, quando internamente identificarmos uma situação a qual a Mensagem retornada pelo Banco não é clara, vamos alimentar com Mensagens de sugestão, para orientar as possíveis causas, dando um norte para situação.
 
'''Sugestão Cliente:''' este campo é reservado para o próprio usuário, possibilitando cadastrar Mensagens que ele identificar para facilitar no processo de entendimento das Mensagens de Retorno das APIs.
 
Agora através desta aplicação, quando ocorrer um Erro de Open Banking é possível verificar através dos links dispostos na tela de Lançamento Financeiro no campo Situação Open Banking, terá um link para tabela do erro ocorrido.
 
<center>'''Lançamento Financeiro Mensagens de Retorno API Financeiro'''
[[Arquivo:Mensagens Retorno API Financeiro BB OP.png|750x500px|nenhum|Mensagens_Retorno_API_Financeiro_BB_OP]]
 
Ou também através do Histórico Open Banking:
 
<center>'''Lançamento Financeiro Mensagens de Retorno API Financeiro Histórico Open Banking'''
[[Arquivo:Historico OP Mensagens Retorno API Financeiro BB OP.png|750x500px|nenhum|Historico_OP_Mensagens_Retorno_API_Financeiro_BB_OP]]

Como Fazer Finanças

2022-05-16T18:46:45Z

Alan.campos:

GF - Como Fazer - Open Banking para Banco Sicredi

2022-05-12T18:32:08Z

Alan.campos: /* Como parametrizar para envio Open Banking a Negativação ou Protesto? */

[[categoria:Como_Fazer_Finanças]]

='''O que significa Open Banking?'''=

Open Banking é um conceito relativamente novo na realidade do mercado financeiro brasileiro. Porém, ele tem ganhado cada vez mais atenção em todo o mundo.
Traduzido, o termo significa “banco aberto”, mas uma tradução mais precisa seria “sistema financeiro aberto”.
O conceito em si trata de algo de simples compreensão. Basicamente, Open Banking é a defesa de que o sistema financeiro adote a tecnologia de forma mais ampla e padronizada, como forma de incentivar e ampliar a oferta e a qualidade dos produtos e serviços financeiros.
A base do Open Banking está na premissa de que os dados pertencem aos consumidores. Logo, caso eles autorizem, esses dados devem ser disponibilizados para que eles possam ter acesso a produtos e serviços que forem mais convenientes.
Na prática, há um pedido para que as instituições abram suas API’s (sigla em inglês para Interface de Programação de Aplicativos) para que terceiros desenvolvam e aprimorem os sistemas e suas funcionalidades.
O objetivo do Open Banking é desenvolver sistemas integrados, que facilitem o controle e transferência de informações de dados, histórico, contas, empréstimos etc. Todo o tipo de produto e serviço oferecido pelos bancos seria integrado de maneira a evitar processos complicados e dispendiosos.
À primeira vista, pode parecer que com o Open Banking as informações dos clientes ficarão soltas e desprotegidas. No entanto, os bancos e instituições financeiras ainda serão responsáveis pela proteção de dados sigilosos.

='''Serviços Disponíveis pela API do Banco nesta Versão?'''=
'''Menu > Utilidades/Diversos > Genéricos > Parâmetros > Configurações'''
 
<center>
{| class="wikitable"
|-
! SERVIÇO !! COBRANÇA
|-
| Registro de Boleto via API || SIM
|-
| Open Banking PIX no Boleto || NÃO
|-
| Retorno de Cobrança via API || NÃO
|-
| Alteração de Juros via API || SIM
|-
| Alteração de Multa via API || SIM
|-
| Alteração de Vencimento via API || SIM
|-
| Alteração de Baixa via API || SIM
|-
| Negativação no Envio do Registro via API || SIM
|-
| Prostesto no Envio do Registro via API || NÃO
|-
|}
</center>
 

='''Como obter as Credenciais para utilizar a Funcionalidade Open Banking?'''=
 
As credenciais do Banco devem ser obtidas através do contato com o seu Gerente de Cash (Gerente da Conta no Banco).
 
O Banco Sicredi, possui uma nomenclatura interna para esse processo, conhecido como Registro de Cobrança OnLine ou Ecommerce, conforme documentação.
 
Então ao entrar em contato com o Gerente de Cash, validar as nomenclaturas para que haja o entendimento da funcionalidade.
 

='''Quais os Módulos necessários para utilizar a Funcionalidade Open Banking”?'''=

• Módulo Gestão Financeira;

='''Quais são as parametrizações necessárias para utilizar a funcionalidade do Open Banking Banco Sicredi?'''=

'''Itens Importantes na Parametrização:'''
 
'''- Processar retornos pelo número do Boleto:''' esta opção deve estar marcada, pois caso contrário ocorrerá problemas na gravação das informações e envio para Banco.
 
Caso tenha sido realizado movimentações com esta opção desmarcada, não será possível realizar a Baixa, pois sistema não consegue localizar devido não possuir o '''Nosso Número''' gravado nas tabelas envolvidas.
 
Para solucionar essa questão será necessário:
 
'''1-''' Identificar o '''Nosso Número''' do registro a ser baixado (Lançamento Financeiro);
 
'''2-''' Gravar o '''Nosso Número''' nas seguintes tabelas:
 
'''GFBOLETOS:''' campo a ser atualizado '''NOSSO_NRO''' com a informação do Nosso Número.
 
'''GFLAUXIL:''' campo a ser atualizado '''CODIGO_BARRAS''' com a informação do Nosso Número.
 
'''- Processar retornos pelo número do Boleto:''' esta opção deve estar marcada, pois caso contrário ocorrerá problemas na gravação das informações e envio para Banco.
 
 
'''Importante preenchimento Telefone''': o não preenchimento do Telefone no Cadastro de Empresa acarretará em Erro no Registro Open Banking. Não é um item obrigatório, porém o Banco Sicredi para registrar necessita o preenchimento deste dado. Não deve ser utilizado espaços ou caracteres especiais.
 
Para utilizar esta funcionalidade é necessário possuir o Cadastro do Portador para o Banco citado.
O cadastro quando preenchido corretamente garante que não ocorrerá inconsistências no momento do registro do Open Banking.
 
Como boa prática de implementação é mais coerente criar um novo Portador para Open Banking evitando assim de alterar o Portador utilizado para CNAB caso necessite realizar algum processo via remessa ou retorno, quando a API do Banco estiver com instabilidade.
 
Essa parametrização deverá validar os últimos Sequenciais da numeração de Boletos do Portador utilizado para as Remessas, pois assim garante que não ocorrerá conflito enviar uma numeração de Título já registrado.
 
 
Itens importantes na parametrização:
 
- '''Nº Banco''';
 
- '''Nº Conta''';
 
- '''Nº Convênio''';
 
- '''Agência/DV''': o DV da Agência é considerado o '''Posto''' da Agência, ou seja, para adquirir essa informação o Banco da Unidade da Agência deve fornecer.
 
Quando se tratar do Portador Open Banking do SICREDI, o campo '''DV''' da Agência deve ser preenchido conforme a Unidade da Agência do Banco.
 
- '''Código Cedente''';
 
Para o correto funcionamento da rotina é necessário que os dados do Portador esteja com todas informações necessárias, inclusive o Convênio.
 
'''Menu > Finanças > Gestão Financeira > Parâmetros > Portadores'''
 
Este cadastro é apenas uma demonstração de parametrização:
 
<center>'''Cadastro de Portador'''
[[Arquivo:Cadastro Portador Principal.png|750x500px|nenhum|Cadastro_Portador_Principal]]
 
<center>'''Guia CNAB'''
[[Arquivo:Cadastro Portador CNAB Sicredi.png|750x500px|nenhum|Cadastro_Portador_CNAB]]
 

Campo "Especie" quando utilizado Open Banking deve ser = A para Duplicata Mercantil.

<center>'''Guia Configurações'''
[[Arquivo:Cadastro Portador Configurações Sicredi.png|750x500px|nenhum|Cadastro_Portador_Configurações_Sicredi]]
 

'''Irá surgir a necessidade de realizar a alteração de Vencimento, Multa ou Juros do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?'''
 
Regra Sistema para Vencimento, Multa ou Juros:
 
Cadastro do Portador deve possuir Comando de Remessa com as novas opções:
 
'''Tipo de Comando =''' Alteração de Vencimento (para alteração de Vencimento).
 
'''Tipo de Comando =''' Alteração de Multa para Multa (para alteração de Multa).
 
'''Tipo de Comando =''' Alteração de Juros para Juros (para alteração de Juros).
 
Caso não seja parametrizado neste primeiro momento as opções de Multa e Juros o sistema cria automaticamente (Somente Juros e Multa).
 
Ao acessar o Lançamento Financeiro em modo Modificar e alterar o campo Multa de ou Juros de, automaticamente após alteração da Multa, o Sistema irá criar essa parametrização do Comando de Remessa com sugestão, sendo passível de alteração, no Cadastro do Portador no botão Remessas e depois no botão Comandos.
 
'''Comando sugestão para Multa:'''
 
'''Código Operação''' = ATM
 
'''Comando''' = ATM
 
'''Descrição''' = ALTERAÇÃO DE MULTA PARA OPEN BANKING
 
'''Tipo de Comando''' = Alteração de Multa
 
'''Comando sugestão para Juros:'''
 
'''Código Operação''' = ATJ
 
'''Comando''' = ATK
 
'''Descrição''' = ALTERAÇÃO DE JUROS PARA OPEN BANKING
 
'''Tipo de Comando''' = Alteração de Juros
 
<center>'''Botão Remessas > Comandos'''
[[Arquivo:Cadastro Portador Comando Remessa.png|750x500px|nenhum|Cadastro_Portador_Comando_Remessa]]
 
<center>'''Botão Retornos > Códigos de Retorno'''
[[Arquivo:Cadastro Portador Codigo Retorno.png|750x500px|nenhum|Cadastro_Portador_Codigo_Retorno]]
 
Para iniciar a configuração através do “Assistente de Parâmetros do Open Banking”, basta selecionar o botão “Open Banking”:
 
'''Menu > Finanças > Gestão Financeira > Parâmetros > Configuração de Bancos'''
 
 
<center>'''Configurações de Banco'''
[[Arquivo:Cadastro Configuraçao Banco.png|750x500px|nenhum|Cadastro_Configuraçao_Banco]]
 
 
Para dar início ao processo de parametrização, basta selecionar o botão “Avançar”:
 
 

='''Tela Inicial Configuração do Assistente Open Banking:'''=
 
Para iniciar a configuração é necessário ter em mãos os seguintes dados: (Código de Acesso).
Sem essas informações não será possível dar continuidade na parametrização do Open Banking para o Banco do Sicredi.
 
<center>'''Tela Inicial Assistente de Parâmetros Open Banking'''
[[Arquivo:Wizard Bem Vindo.png|750x500px|nenhum|Wizard_Bem_Vindo]]
 


=='''Etapa 1 (Parâmetros: Passo 1 de 4):'''==


Uma das etapas mais importantes e que requer um cuidado maior e sigilo das informações nesta parametrização.
 
Essas informações são disponibilizadas pelo Banco a qual deve ser restrita somente a pessoa responsável pelo setor Financeiro da Empresa.
 
O assistente tem como objetivo proporcionar que o próprio usuário tenha autonomia para executar esse passo a passo sem necessidade de passar essas informações restritas da Empresa para qualquer pessoa que não seja ele mesmo.
 
Reforçando, mesmo que tenha dificuldades para executar esta etapa, não repasse nenhuma informação relacionado aos acessos dos tokens.
 
Dados em mãos para informar os respectivos campos, basta copiar e colar as informações.
 
Código de Acesso.
 
O Campos '''Código de Acesso''' possui uma tecnologia de criptografia, ou seja, após informar os dados nos campos o sistema irá criptografar as informações garantindo e mantendo a segurança das informações.
 
Caso haja necessidade de alterações, basta clicar no ícone do "Cadeado", será aberta a tela de Criptografia e após colar ou digitar as informações em tela e selecionar o botão "Confirmar".
 
Também tenha alguma dúvida no dado informado e necessitar validar o dado seguindo os mesmos passos da alteração será aberta a tela de Criptografia e após colar ou digitar as informações em tela e selecionar o botão "Validar", sistema confirma se os dados são os mesmos.
 
Observamos que esta tela possui duas guias, uma de Homologação e Produção. Preencher conforme a necessidade do processo, caso precise realizar testes, parametrize em homologação e posteriormente parametrize o de Produção ou se preferir, pode preencher os dois se possuir os dados.
 
Lembrando que esses dados são confidenciais de uso e exclusivo de cada usuário.
 
Através dessas informações o sistema irá se comunicar com API do Banco para poder realizar os registros dos Lançamentos.
 
Após informado os dados, basta selecionar o botão "Avançar", para seguir os próximos passos.
 
'''Código de Acesso:''' informar a codificação passada pelo Banco.
 
 
<center>'''Parâmetros: Passo 1 de 4'''
[[Arquivo:Wizard Passo 1 Sicredi.png|750x500px|nenhum|Wizard_Passo_1_Sicredi]]
 

=='''Etapa 2 (Portador de Remessa e Retorno - Pagamento: Passo 2 de 4):'''==

Nesta etapa deve ser selecionado o Portador que será considerado para o envio da Remessa de Pagamento (onde estarão os boletos em aberto) e nesta mesma tela informar o qual Portador será considerado para o Retorno de Pagamento (onde serão liquidados os retornos de Pagamentos).
 
Nesta etapa, é possível pular, caso não utilize ainda o Envio de Pagamentos do Open Banking.
 
'''Pular:''' caso deseja pular essa etapa e prosseguir com o processo de parametrização do Open Banking.
 
'''Avançar:''' dá continuidade ao processo de parametrização, após selecionado uma opção.
 
Para continuar a parametrização selecione o botão "Pular" e siga para os próximos passos.
 
<center>'''Portador de Remessa e Retorno: Passo: 2 de 4'''
[[Arquivo:Wizard Passo 2 Sicredi.png|750x500px|nenhum|Wizard_Passo_2_Sicredi]]
 

=='''Etapa 3 (Convênios de Cobrança: Passo 3 de 4):'''==
 
Nesta etapa o sistema avalia sua base de dados, e localiza os Convênios parametrizados para o Banco Sicredi, onde serão listados.
O sistema possibilita a parametrização de Convênios específicos bem como caso seja optado, selecionando o botão "Pular" o sistema criará automaticamente o Convênio "Geral", ao qual utiliza dados do Portador registrado.
 
'''Pular:''' caso deseja pular essa etapa e prosseguir com o processo de parametrização do Open Banking.
 
'''Avançar:''' dá continuidade ao processo de parametrização, após selecionado uma opção.
 
<center>'''Convênios de Cobrança: Passo 3 de 4'''
[[Arquivo:Wizard Passo 3 Sicredi.png|750x500px|nenhum|Wizard_Passo_3_Sicredi]]
 

=='''Etapa 3 (Portador de Remessa e Retorno - Cobrança: Passo 3 de 4):'''==
 
Nesta etapa deve ser selecionado o Portador que será considerado para o envio da Remessa de Cobrança (onde estarão os boletos em aberto) e nesta mesma tela informar o qual Portador será considerado para o Retorno de Cobrança (onde serão liquidados os retornos de Cobranças).
 
'''Avançar:''' dá continuidade ao processo de parametrização, após selecionado uma opção.
 
<center>'''Portador de Remessa e Retorno - Cobrança: Passo 3 de 4'''
[[Arquivo:Wizard Passo 3-4 Final Sicredi.png|750x500px|nenhum|Wizard_Passo_3-4_Final_Sicredi]]
 
Atualizado Wizard para Versão 2 do Open Banking, disponibilizando duas opções:
 
'''- Direto:''' esta opção tem como finalidade registrar o Boleto no momento da sua geração, ou seja, quando selecionado ativa propriedade ao qual ao gerar o Boleto Bancário o sistema automaticamente envia o registro Open Banking, sem a necessidade de fazer o processo de envio da Remessa Open Banking do título.
 
Também quando selecionada, terá uma particularidade na questão da Emissão de Boletos em lote pela Rotina de Emissão de Boletos Personalizados. A rotina na guia '''Opções''' tem a opção '''Enviar somente Lançamentos não marcados e marca-los''', caso esteja desmarcada o Registro Open Banking ocorrerá da mesma forma que o sistema irá marcar a opção '''Boleto Impresso''' do Lançamento Financeiro, registrando a Operação Open Banking.
Isso ocorre para manter a integridade, já que esta operação é considerada única no registro, sendo então necessário marcar a '''Boleto Impresso''', para poder conseguir realizar alterações como Alteração de Vencimento ou mesmo a Baixa, sendo uma condição de Sistema.
 
'''- PIX''': esta opção tem como finalidade registrar uma operação PIX para os Boletos emitido de forma Direta (opção '''Direto''' marcado).
 
Esta opção é válida '''SOMENTE''' para o Banco do Brasil.
 

=='''Etapa 4 (Relatório: Passo 4 de 4):'''==

 
Nesta etapa o sistema irá buscar automaticamente o Modelo de Relatório Padrão, caso exista no ambiente, facilitando assim todo processo de parametrização e implementação para usuário.
 
A busca é realizado '''(%CIGAM_INSTAL%RF00071_remessas.RTF)''', com isso é importante que o Modelo de Relatório (RF00071_remessas.RTF) esteja devidamente localizado na pasta padrão do Cigam_Instal, como por exemplo:
 
'''%CIGAM_INSTAL%''' = P:\Cigam11\Projects\Controle\MACIEL\Financeiro_Open_Banking
 
"P:\Cigam11\Projects\Controle\MACIEL\Financeiro_Open_Banking\Modelos\Relatorios\Gestao Financeira\RF00071_remessas.RTF"
 
Clicar em "Avançar" para dar seguimento.
 
<center>'''Assistente de Parâmetros Open Banking: Passo 4 de 4'''
[[Arquivo:Wizard Passo 4-4 Relat Sicredi.png|750x500px|nenhum|Wizard_Passo_4-4_Relat_Sicredi]]
 
 

=='''Etapa Conclusão (Parâmetros de Convênio Open Banking - Conclusão):'''==

 
Esta etapa o sistema faz validação da comunicação com o Banco através da API verificando o ambiente se esta tudo ok, listando em tela.
 
Após a consulta estar "OK", basta clicar no botão "Concluir" e seu ambiente estará apto para utilizar a funcionalidade Open Banking.
 
<center>'''Parâmetros de Convênio Open Banking: Passo Final - Conclusão'''
[[Arquivo:Wizard Passo Final Conclusao Conexao Sicredi.png|750x500px|nenhum|Wizard_Passo_Final_Conclusao_Conexao_Sicredi]]
 
'''Homologação:''' Conexão realizada com sucesso.
 
'''Produção:''' Conexão realizada com sucesso.
 
O servidor remoto retornou um erro: (401) Não Autorizado. Isso ocorre quando não houve a parametrização dos dados em Produção como foi realizado no ambiente de Homologação conforme o passo a passo, ou possa ter ocorrido algum erro na comunicação com o Banco.
 
<center>'''Convênio Cadastrado com Sucesso - Cobrança'''
[[Arquivo:Parametros OP Sicredi.png|750x500px|nenhum|Parametros_OP_Sicredi]]
 
'''Ambiente:''' lista qual é o ambiente cadastrado, sendo apenas duas opções: Homologação e Produção.
 
'''Convênios:''' neste grupo serão listados todos os convênios cadastrados, bem como todas informações pertinentes como:
 
- Portador;
 
- Agência;
 
- Número Conta;
 
- Portador de retorno;
 
'''- Direto:''' esta opção tem como finalidade registrar o Boleto no momento da sua geração, ou seja, quando selecionado ativa propriedade ao qual ao gerar o Boleto Bancário o sistema automaticamente envia o registro Open Banking, sem a necessidade de fazer o processo de envio da Remessa Open Banking do título.
 
'''- PIX:''' esta opção fica habilitada somente quando selecionado a opção Direto, ela tem como finalidade registrar uma operação PIX para os Boletos emitido de forma Direta (opção Direto marcado).
 
Esta opção é válida SOMENTE para o Banco do Brasil.
 
Ao emitir o Boleto do Lançamento o sistema marca as 3 opções:
 
- Boleto Impresso;
 
- Remessa Enviada;
 
- Código de Barras Lido;
 
'''U.N Ced.:''' esta opção tem como finalidade possibilitar o envio e registro de Boletos de outras Unidades de Negócio.
 
Basta informar a Unidade desejada no campo e o sistema entenderá quando realizado o processo de registro de um título que não seja da Unidade Matriz, então sistema identifica e realiza o processo de envio e registro.
Se deixar em Branco a Unidade Cedente irá considerar para todas Unidades de Negócio.
 
 
<center>'''Convênio Cadastrado com Sucesso - Pagamento'''
[[Arquivo:Parametros OP Sicredi Pagamento.png|750x500px|nenhum|Parametros_OP_Sicredi_Pagamento]]
 
'''Ambiente:''' lista qual é o ambiente cadastrado, sendo apenas duas opções: Homologação e Produção.
 
'''Convênios:''' neste grupo serão listados todos os convênios cadastrados, bem como todas informações pertinentes como:
 
- Portador;
 
- Agência;
 
- Número Conta;
 
- Portador de retorno;
 
<center>'''Ícone Credenciais'''
[[Arquivo:Parametros OP Sicredi Credenciais.png|750x500px|nenhum|Parametros_OP_Sicredi_Credenciais]]
 
Através deste ícone é possível verificar os Parâmetros API parametrizados, tanto em homologação quanto em produção.
 
 
<center>'''Ícone Endereços'''
[[Arquivo:Parametros OP Sicredi Endereços.png|750x500px|nenhum|Parametros_OP_Sicredi_Endereços]]
 
Através deste ícone é possível verificar todos endereços de URLs parametrizados.

='''O que significa a Categoria Open Banking de acesso?'''=
 
 A Categoria Open Banking é uma Categoria que é habilitada mediante a utilização de um Portador parametrizado com as Configurações de Banco Open Banking. A mesma tem como objetivo proporcionar maior agilidade e gerenciamento das atividades relacionadas a Remessa de Cobrança Online.
 
'''Categoria Open Banking'''
 
 
<center>'''Categoria Open Banking'''
[[Arquivo:Categoria Open Banking.png|750x500px|semmoldura|nenhum|Categoria_Open_Banking]]
 
 

'''Registrar:''' item de categoria tem como funcionalidade registrar o Boleto Bancário Online. Substitui todo o processo de geração do arquivo de Remessa de Cobrança, acessar o site e remeter ao Banco esse arquivo, com apenas um clique na opção.
 
'''Reenviar:''' item de categoria tem como funcionalidade possibilitar o reenvio de registros que estão com alguma pendência ou algum erro de parametrização. Será habilitado somente quando já possuir movimento de "Registro" enviado, cuja Situação estiver com pendência ou erro.
 
'''Baixar:''' item de categoria tem como funcionalidade comunicar o Banco referente a Baixa do movimento em questão do Boleto Bancário. Utilizado para eventuais falhas operacionais, como registrado um movimento por engano, ou negociações diretamente com cliente a parte. Eliminando então também todo processo de geração do arquivo de Remessa Bancária com Comando de Remessa de Baixa e o processo de remeter ao Banco o arquivo, sendo realizado tudo online através desta opção.
 
'''Registrar Alteração:''' item de categoria tem como funcionalidade registrar uma alteração ocorrida referente ao "Vencimento" do Lançamento Financeiro.
Ao realizar alteração da Data de Vencimento do Lançamento Financeiro que está com "Situação Open Banking" igual "Registrado" e ocorrer alteração no Vencimento, o sistema emite uma mensagem possibilitando já o envio da alteração no momento ou mais tarde através desta opção de "Registrar Alteração".
 
'''Histórico:''' item de categoria tem como funcionalidade gravar todas movimentações realizadas relativo ao Open Banking. Registros, Baixas, Erros...

='''Layout e Detalhamento de Campos API'''=
==Registro de Boletos==
<center>

{| class="wikitable"
|-
! Nº !! Campo JSON !! Descriçao do Banco !! Campo CIGAM !! Tabela !! Obrigatório !! Observações
|-
| 1 || token || Chave Transacional gerada pelo recurso /autenticacao || || || Obrigatório ||
|-
| 2 || Content-Type || Estabelece o tipo de conteúdo da requisição || || || Obrigatório ||
|-
| 3 || agencia || Código da Cooperativa do beneficiário || Agência || Portador || Obrigatório ||
|-
| 4 || posto || Código do Posto do beneficiário || Dígito Agência || Portador || Obrigatório ||
|-
| 5 || cedente || Código do Convênio de Cobrança do beneficiário || Código Cedente || Portador || Obrigatório ||
|-
| 6 || nossoNumero* || Nosso Número || Nosso Número || Boletos || Opcional ||
|-
| 7 || codigoPagador || Código Pagador || Não Tratado || Não Tratado || Opcional ||
|-
| 8 || tipoPessoa* || Tipo de pessoa do pagador.
'''Domínio:'''
 
1 - PESSOA FÍSICA
 
2 - PESSOA JURÍDICA
|| Pessoa || Empresa || Obrigatório ||
|-
| 9 || cpfCnpj* || CPF ou CNPJ do pagador || CNPJ/CPF || Empresa || Obrigatório ||
|-
| 10 || nome || Nome do pagador || Nome Completo || Empresa || Obrigatório ||
|-
| 11 || endereco || Endereço do pagador || Endereço || Empresa || Opcional || Será obrigatório se o código do pagador '''não''' for informado.
|-
| 12 || cidade || cidade || Município || Empresa || Opcional || Será obrigatório se o código do pagador '''não''' for informado.
|-
| 13 || uf || Estado do pagador || UF || Empresa || Opcional || Será obrigatório se o código do pagador '''não''' for informado.
|-
| 14 || cep || CEP do pagador || CEP || Empresa || Obrigatório ||
|-
| 15 || telefone || Telefone mais DDD do pagador || Fone || Empresa || Opcional || Será obrigatório se o código do pagador '''não''' for informado.
|-
| 16 || email || Endereço de email do pagador || Email || Contato || Opcional ||
|-
| 17 || especieDocumento || Espécie de documento do título.(*) || Espécie || Portador || Obrigatório ||
|-
| 18 || codigoSacadorAvalista || Código do sacador avalista. || Não Tradado || Não Tradado || Opcional ||
|-
| 19 || seuNumero || Número de controle interno do beneficiário que referencia o pagador. || Lançamento || LANCAM || Obrigatório ||
|-
| 20 || dataVencimento || Data de vencimento do boleto || Vencimento || Boletos || Obrigatório ||
|-
| 21 || valor || Valor do boleto || Saldo || LANCAM || Obrigatório ||
|-
| 22 || tipoDesconto || Tipo de desconto.
'''Domínios:'''
 
A - VALOR
 
B - PERCENTUAL
|| Não Tratado || Não Tratado || Obrigatório ||
|-
| 23 || valorDesconto1 || Valor de desconto 1 || Valor Desconto || LANCAM || Opcional || Será obrigatório se o dataDesconto1 for informado.
|-
| 24 || dataDesconto1 || Data limite para concessão de desconto1 || Vencimento || LANCAM || Opcional || Será obrigatório se o valorDesconto1 for informado. Não pode ser igual a outras dataDescontos e nem maior que vencimento.
|-
| 25 || valorDesconto2 || Valor de desconto 2 || Não Tratado || Não Tratado || Opcional || Será obrigatório se o dataDesconto2 for informado.
|-
| 26 || dataDesconto2 || Data limite para a concessão de desconto 2 || Não Tratado || Não Tratado || Opcional || Será obrigatório se o valorDesconto2 for informado. Não pode ser igual a outras dataDescontos e nem maior que vencimento.
|-
| 27 || valorDesconto3 || Valor de desconto 3 || Não Tratado || Não Tratado || Opcional || Será obrigatório se o dataDesconto3 for informado.
|-
| 28 || dataDesconto3 || Data limite para a concessão de desconto 3 || Não Tratado || Não Tratado || Opcional || Será obrigatório se o valorDesconto3 for informado. Não pode ser igual a outras dataDescontos e nem maior que vencimento.
|-
| 29 || tipoJuros || Tipo de Juros.
'''Domínios:'''
 
A - VALOR
 
B - PERCENTUAL
|| || || Obrigatório ||
|-
| 30 || juros || Valor de juros a cobrar por dia. || Juros Dia || LANCAM || Opcional ||
|-
| 31 || multas || Percentual de multa a cobrar || Valor Multa || LANCAM || Opcional ||
|-
| 32 || desconto Antecipado || Valor de desconto antecipado a cobrar || Não Tratado || Não Tratado || Opcional || Deve ser menor que o valor.
|-
| 33 || informativo || Texto do Informativo || Não Tratado || Não Tratado || Opcional ||
|-
| 34 || mensagem* || Texto da linha da mensagem || Não Tratado || Não Tratado || Opcional ||
|-
| 35 || codigoMensagem || Código da mensagem || Não Tratado || Não Tratado || Opcional ||
|-
| 36 || numDiasNegativacaoAuto || Número de dias para Negativação Automática. 0 (Zero) para não negativar automaticamente. Quando preenchido com 3 ou 4 dias o sistema comandará negativação em dias úteis após o vencimento. Quando preenchido acima de 4 dias, o sistema comandará negativação em dias corridos após o vencimento. || Protesto || Portador || Opcional ||
|-
| 37 || NomeBeneficiarioFinal || NomeBeneficiarioFinal || Não Tratado || Não Tratado || Obrigatório caso informado TipoPessoaBeneficiarioFinal e CpfCnpjBeneficiarioFinal ||
|-
| 38 || TipoPessoaBeneficiarioFinal || Tipo de pessoa.
'''Domínios:'''
 
1 - Física
 
2 - Jurídica
|| Não Tratado || Não Tratado || Obrigatório caso informado NomeBeneficiarioFinal e CpfCnpjBeneficiarioFinal ||
|-
| 39 || CpfCnpjBeneficiarioFinal || CPF/CNPJ do beneficiário final || Não Tratado || Não Tratado || Obrigatório caso informado NomeBeneficiarioFinal e TipoPessoaBeneficiarioFinal ||
|-
| 40 || FoneBeneficiarioFinal || Fone do beneficiário final || Não Tratado || Não Tratado || Opcional ||
|-
| 41 || EnderecoBeneficiarioFinal || Endereço do beneficiário final || Não Tratado || Não Tratado || Opcional ||
|-
| 42 || CepBeneficiarioFinal || CEP do beneficiário final || Não Tratado || Não Tratado || Opcional ||
|-
| 43 || CidadeBeneficiarioFinal || CidadeBeneficiarioFinal || Não Tratado || Não Tratado || Opcional ||
|-
| 44 || UfBeneficiarioFinal || UF do beneficiário final || Não Tratado || Não Tratado || Opcional ||
|-
|}

</center>

'''(*) Domínios:'''
 
A - DUPLICATA MERCANTIL (DM)
 
B - DUPLICATA RURAL (DR)
 
C - NOTA PROMISSORIA (NP)
 
D - NOTA PROMISSORIA RURAL (NR)
 
E - NOTA DE SEGURO (NS)
 
G - RECIBO (RC)
 
H - LETRA DE CAMBIO (LC)
 
I - NOTA DE DEBITO (ND)
 
J - DUPLICATA DE SERVICO (DS)
 
K - OUTROS (OS)
 
O - BOLETO OFERTA (OFE)

==Alteração de Boletos==
<center>

{| class="wikitable"
|-
! Nº !! Campo JSON !! Descriçao do Banco !! Campo CIGAM !! Tabela !! Obrigatório !! Observações
|-
| 1 || agencia || Agência do Beneficiário || Agência || Portador || Obrigatório ||
|-
| 2 || posto || Posto do Beneficiário || Dígito Agência || Portador || Obrigatório ||
|-
| 3 || cedente || Código do Beneficiário || Código Cedente || Portador || Obrigatório ||
|-
| 4 || nossoNumero* || Nosso Número do Título || Nosso Número || Boletos || Obrigatório ||
|-
| 5 || instrucaoComando || Comando que será realizado na alteração do boleto. || || || Obrigatório || Caso seja informado ALTERACAO_OUTROS_DADOS será '''obrigatória''' a inclusão do campo complementoInstrucao.
|-
| 5.1 || PEDIDO_BAIXA || || || || Obrigatório || Consultar o Termo de Adesão com sua Unidade de Atendimento Sicredi p/ ver se está com Baixa Automática de boletos vencidos. Caso esteja, o boleto vencido terá sua baixa efetuada automaticamente.
|-
| 5.2 || CONCESSAO_ABATIMENTO || || || || Obrigatório ||
|-
| 5.3 || CANCELAMENTO_ABATIMENTO_CONCEDIDO || || || || Obrigatório ||
|-
| 5.4 || ALTERACAO_VENCIMENTO || || || || Obrigatório ||
|-
| 5.5 || ALTERACAO_SEU_NUMERO || || || || Obrigatório ||
|-
| 5.6 || PEDIDO_PROTESTO || || || || Obrigatório || Somente em título vencido. Por padrão, todos os boletos emitidos pelo EComm-API, não são protestados.
|-
| 5.7 || SUSTAR_PROTESTO_BAIXAR _TITULO || || || || Obrigatório ||
|-
| 5.8 || SUSTAR_PROTESTO_MANTER_CARTEIRA || || || || Obrigatório ||
|-
| 5.9 || ALTERACAO_OUTROS_DADOS || || || || Obrigatório ||
|-
| 6 || complementoInstrucao || Complemento do comando que será realizado na alteração do boleto || || || Condicional ||
|-
| 6.1 || DESCONTO || || || || Condicional ||
|-
| 6.2 || JUROS_DIA || || || || Condicional ||
|-
| 6.3 || DESCONTO_DIA_ANTECIPACAO || || || || Condicional ||
|-
| 6.4 || DATA_LIMITE_CONCESSAO_DESCONTO || || || || Condicional ||
|-
| 6.5 || CANCELAMENTO_PROTESTO _AUTOMATICO || || || || Condicional ||
|-
| 6.6 || CANCELAMENTO_NEGATIVACAO_AUTOMATICA || || || || Condicional ||
|-
| 7 || ''Campo de Alteração'' || Nome do campo que deseja mudar || || || Obrigatório ||
|-
|}

</center>

='''Como realizar a criação de Lançamentos utilizando a funcionalidade Open Banking?'''=
 
Para a criação de Lançamentos Financeiros acessar o caminho de Menu:
 

'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 

Acessar o botão “Criar” e informar os dados necessários para a criação do Lançamento Financeiro a Receber utilizando o Portador parametrizado para Open Banking.
 
 
'''1- Etapa criação do Lançamento:'''
 
 
<center>'''Criação do Lançamento Financeiro a Receber'''
[[Arquivo:Create Lanc Open Banking.png|750x500px|semmoldura|nenhum|Criação do Lançamento Financeiro]]
 
 

'''2- Etapa Impressão do Boleto Bancário do Lançamento Financeiro:'''
 
Nesta etapa pode ser realizado a impressão do Boleto Bancário diretamente pelo próprio Lançamento Financeiro ou através da rotina de Emissão em lote "Emissão de Boletos Personalizados":
 
 
<center>'''Impressão do Boleto Bancário do Lançamento Financeiro'''
[[Arquivo:Imprimir Boleto Lanc.png|750x500px|semmoldura|nenhum|Impressão Boleto Bancário]]
 
 

'''3- Etapa do Registro do Boleto Open Banking:'''
 
Nesta etapa pode ser realizado o "Registro" do Boleto diretamente pelo próprio Lançamento Financeiro ou através da rotina de Emissão em lote "Emissão de Boletos Personalizados":
Basta acessar a Categoria "Open Banking" e selecionar o Item de Categoria "Registrar".
Sistema irá realizar a comunicação através das parametrizações realizadas das Urls e Tokens de acesso e listará a situação do Registro do Boleto Bancário através do Relatório.
 
 
<center>'''Registrar Boleto Open Banking através Lançamento Financeiro'''
[[Arquivo:Boleto Impresso Registrar OP.png|750x500px|semmoldura|nenhum|Registro Boleto Open Banking]]
 
 
<center>'''Relatório Remessa Bancária OnLine'''
[[Arquivo:Relat Registro Open Banking.png|750x500px|semmoldura|nenhum|Relatório Remessa Bancária Online]]
 
 
Após o registro automaticamente o sistema marca as opções de:
 
- Remessa Enviada
 
- Códigos de Barras Lido
 
 
<center>'''Boleto Bancário Registrado'''
[[Arquivo:Lanc Registrado Validar Historico.png|750x500px|semmoldura|nenhum|Lanc_Registrado_Validar_Historico]]
 
 
Para verificar todas as movimentações realizada sobre Open Banking, elas estão sendo gravadas no Item de Categoria "Histórico" que fica na Categoria "Open Banking".
Ao selecionar o Item de Categoria "Histórico" deve listar o Registro do Boleto Bancário.
 
 
<center>'''Item de Categoria Histórico de Movimentos Open Banking'''
[[Arquivo:Item Categoria Historico.png|750x500px|semmoldura|nenhum|Item_Categoria_Histórico]]
 
 

='''Como realizar o Envio em Lote Open Banking através da rotina Remessa de Cobrança Open Banking?'''=

Assim como é possível realizar o Envio do Registro do Boleto Bancário através do próprio Lançamento Financeiro, existe a possibilidade de realizar esse processo em Lote, quando se tratar de vários registros a serem enviados.
Através do Menu:
 
 
'''Menu: Finanças > Gestão Financeira > Rotinas > EDI> Transmite > Remessa Cobranças Bancárias > Remessa de Cobrança Open Banking'''
 
 
<center>'''Remessa de Cobrança Open Banking'''
[[Arquivo:Remessa_de_Cobranca_Open_Banking_BB3.png|750x500px|semmoldura|nenhum|Remessa_de_Cobranca_Open_Banking]]
 
 
Esta rotina tem um conceito muito simples em relação aos filtros, foram disponibilizados campos essências que permitem ter uma rastreabilidade dos movimentos.

'''Unidade de Negócio:''' informe a Unidade de Negócio desejada para realizar o filtro para busca dos movimentos.
 
'''Data:''' informe a Data desejada para realizar o filtro para busca dos movimentos.
 
'''Vencimento:''' informe o período de Vencimento desejado para realizar o filtro para busca dos movimentos.
 
'''Lançamento:''' informe a faixa de Lançamentos desejada para realizar o filtro para busca dos movimentos.
 
'''Tipo de Pagamento:''' informe o Tipo de Pagamento desejado para realizar o filtro para busca dos movimentos.
 
'''Série:''' informe a Série desejada para realizar o filtro para busca dos movimentos.
 
'''Nota Fiscal:''' informe a faixa de Nota Fiscal desejada para realizar o filtro para busca dos movimentos.
 
'''Conta Financeira:''' informe a Conta Financeira desejada para realizar o filtro para busca dos movimentos.
 
'''Empresa:''' informe a faixa de Empresa desejada para realizar o filtro para busca dos movimentos.
 
'''Cobrança:''' informe a faixa de Empresa de Cobrança desejada para realizar o filtro para busca dos movimentos.
 
 
Após informado os filtros e confirmado a operação da rotina o sistema gera um relatório com a listagem dos movimentos.
Na coluna "Registro", será listado se houve a confirmação ou ocorreu algum erro.
 
 
<center>'''Relatório Remessa de Cobrança Open Banking'''
[[Arquivo:Relat Remessa Bancaria Open Banking.png|750x500px|semmoldura|nenhum|Relat_Remessa_Bancaria_Open_Banking]]
 
 

='''Como realizar a alteração de Vencimento do Lançamento já Registrado Open Banking e reenviá-lo novamente?'''=
 

Irá surgir a necessidade de realizar a alteração do Vencimento do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?
 
'''Dado que''' já temos um Lançamento Financeiro já Registrado Open Banking, basta acessar o Lançamento Financeiro desejado através do caminho do Menu:
 
'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 
Acessar o Lançamento Financeiro em modo Modificar e alterar o campo "Venc.Original", automaticamente após alteração do Vencimento, o sistema insere o Comando "05" no campo "Comando de Remessa" e diante disso já emite uma mensagem:
 
'''Confirma o envio da alteração do título ao banco?'''
 
'''Importante:''' para o envio da alteração do Vencimento o sistema já considera o campo '''Vencimento''', caso seja utilizado a '''Modalidade''' como '''Seguinte''' por exemplo, onde é possível ter um Vencimento Original diferente do Vencimento.
 
<center>'''Lançamento Financeiro a Receber já Registrado'''
[[Arquivo:AlterarVenc Lanc1.png|750x500px|nenhum|AlterarVenc_Lanc1]]
 
 
Vencimento alterado, sistema insere o Comando "05" no campo "Comando de Remessa" e ao salvar o registro é emitido a mensagem: "Confirma o envio da alteração do título ao banco?"
 
<center>'''Vencimento alterado e registro salvo'''
[[Arquivo:Vencimento Alterado Msn.png|750x500px|nenhum|Vencimento_Alterado_Msn]]
 
'''Sim:''' é enviado o registro de alteração do Open Banking e se registrado com sucesso, sistema retira então o Comando de Remessa.
 
<center>'''Processo Concluído com Sucesso'''
[[Arquivo:Processo_Concluido_Sucesso_Lanc.png|750x500px|nenhum|Processo_Concluido_Sucesso_Lanc]]
 
Há possibilidades do tempo de comunicação com API do Banco não retornar imediatamente a confirmação do recebimento da Alteração do Vencimento. Quando ocorrer essa situação, sistema emite uma mensagem, solicitando aguardar, para tentar novamente o envio da alteração do vencimento.
Quando ocorrer essa situação, será necessário aguardar e após realizar o envio novamente ou através do próprio Lançamento ou através da rotina de Remessa de Cobrança - Open Banking, que remeterá as alterações para o Banco.
<center>'''Processo Pendente Alteração - Aguardar'''
[[Arquivo:Alteração Vencimento Processo Pendente Envio Aguardar.png|750x500px|nenhum|Alteração_Vencimento_Processo_Pendente_Envio_Aguardar]]
 
Já quando selecionado a opção '''Não''':
 
'''Não:''' não faz a comunicação do envio da alteração do vencimento via Open Banking. Este registro não foi notificado, logo será necessário realiza-lo através do próprio Lançamento ou através da rotina de Remessa de Cobrança Open Banking.
 
No Lançamento Financeiro é habilitado o botão "Reenviar Registro" no Item de Categoria "Open Banking".
Quando selecionado o botão '''Registrar Alteração''', sistema faz a comunicação via Open Banking e registra alteração de vencimento realizada.
 
<center>'''Lançamento Não Registrado a alteração de Vencimento com o Comando de Remessa'''
[[Arquivo:Botao Registrar Alteracao Habilitado.png|750x500px|nenhum|Botao_Registrar_Alteracao_Habilitado]]
 
Ao selecionar o botão "Registrar Alteração" sistema emite a mensagem para confirmar o envio.
 
<center>'''Botão Registrar Alteração'''
[[Arquivo:Registrar Alteracao Selecionado.png|750x500px|nenhum|Registrar_Alteracao_Selecionado]]
 
Após a confirmação o sistema registra alteração
 
<center>'''Processo Concluído com Sucesso'''
[[Arquivo:Processo_Concluido_Sucesso_Lanc.png|750x500px|nenhum|Processo_Concluido_Sucesso_Lanc]]
 
 
<center>'''Lançamento alterado e registrado'''
[[Arquivo:Lançamento alterado registrado.png|750x500px|nenhum|Lançamento_alterado_registrado]]
 

='''Como realizar a Alteração de Juros do Lançamento já Registrado Open Banking e reenviá-lo novamente?'''=
 

'''Irá surgir a necessidade de realizar a alteração de Juros do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?'''
 
Dado que já temos um Lançamento Financeiro já Registrado Open Banking, basta acessar o Lançamento Financeiro desejado através do caminho do Menu:
 
'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 
'''Regra Sistema para os Juros:'''
 
Se no cadastro do Portador não possuir Comando de Remessa com as novas opções:
 
'''Tipo de Comando =''' Alteração de Juros para Juros
 
'''BANCO SICREDI:''' para este Banco por enquanto atende '''somente''' alteração de Juros para registro Open Banking, não registrando então caso alterado Multas.
 
Ao acessar o Lançamento Financeiro em modo Modificar e alterar o campo '''Juros Dias de''' ou '''Juros Mês de''', automaticamente após alteração dos Juros, o Sistema irá criar essa parametrização do Comando de Remessa com '''sugestão''', sendo passível de alteração, no Cadastro do Portador no botão '''Remessas''' e depois no botão '''Comandos'''.
 
'''Comando sugestão para Juros:'''
 
'''Código Operação =''' ATJ
 
'''Comando =''' ATJ
 
'''Descrição =''' ALTERAÇÃO DE JUROS PARA OPEN BANKING
 
'''Tipo de Comando =''' Alteração de Juros
 
 
<center>'''Cadastro do Portador Comando de Remessa Juros'''
[[Arquivo:Lancto Registrado Alteração Juros Dia 748.png|750x500px|nenhum|Lancto_Registrado_Alteração_Juros_Dia_748]]
 
 

'''Como é identificado a alteração de Juros para Banco?'''
 
Através das tags enviadas para API gravadas no Histórico do Open Banking Dados API:
 
'''instruçãoComando''':'''ALTERACAO_OUTROS_DADOS''' – indica que ocorreu uma alteração de registro no Lançamento.
 
'''complementoInstrucao''': '''JUROS_DIA''' – indica que há Juros no registro.
 
'''valor1''': 0.12, - indica o valor dos Juros.
 
 
<center>'''Lançamento Financeiro a Receber já Registrado alterando os Juros'''
[[Arquivo:Lancto Registrado Alteração Juros Dia.png|750x500px|nenhum|Lancto_Registrado_Alteração_Juros_Dia]]
 
 

Tags enviadas para API Banco:
 
 
<center>'''Dados API Tags referente aos Juros'''
[[Arquivo:Dados API Juros 748.png|750x500px|nenhum|Dados_API_Juros_748]]
 
 

='''Quais são as novidades após atualização para Versão 2 do Open Banking?'''=
 
Disponibilizado a Versão 2 para Open Banking que traz algumas novidades para o processo de Registro no Banco.
 
Nela terá um componente que quando atualizado a Base através do Assistente de Atualização (Atualiza CIGAM) será adicionado nos Parâmetros Open Banking da Configuração de Bancos, especificamente nas Credenciais, o registro '''Versão API''' = v2.
 
'''Finanças > Gestão Financeira > Parâmetros > Configurações de Bancos'''
 
<center>'''Parâmetros Open Banking'''
[[Arquivo:Parametros OP Sicredi Credenciais.png|750x500px|nenhum|Parametros_OP_Sicredi_Credenciais]]
 
A partir desta Versão o Sistema passa a realizar a busca para localizar os títulos da seguinte forma:
 
1- O sistema tenta localizar os títulos pelo Número do Lançamento;
 
2- Caso os títulos tenham sido gerados pelo CIGAM irá localizar pelo '''Nosso Número''', avaliando então a tabela '''GFBOLETOS''' pela coluna '''NOSSO_NRO'''.
 
3- Caso os títulos tenham sido gerados por outro sistema irá localizar pelo '''Nosso Número''', avaliando então a tabela '''GFLAUXIL''' pela coluna '''CODIGO_BARRAS'''.
 
Também nesta versão estão disponíveis as tags para Envio da Série/NF, sendo utilizado a Tag na API '''NumeroTituloBeneficiario'''. A regra é '''Serie''' '''NF''' '''Complemento Duplicata''', bem como descrito com espaços em Branco entre eles. Para verificar esse registro, basta acessar após o Registro no Banco o Histórico Open Banking na guia '''Envio''' e localizar para Tag '''NumeroTituloBeneficiario'''.
 
<center>'''Parâmetros de Convênio Open Banking'''
[[Arquivo:Wizard Passo 3-4 Final Sicredi.png|750x500px|nenhum|Wizard_Passo_3-4_Final_Sicredi]]
 
Atualizado Wizard para Versão 2 do Open Banking, disponibilizando duas opções:
 
'''- Direto''': esta opção tem como finalidade registrar o Boleto no momento da sua geração, ou seja, quando selecionado ativa propriedade ao qual ao gerar o Boleto Bancário o sistema automaticamente envia o registro Open Banking, sem a necessidade de fazer o processo de envio da Remessa Open Banking do título.
 
'''- PIX''': esta opção fica habilitada somente quando selecionado a opção '''Direto''', ela tem como finalidade registrar uma operação PIX para os Boletos emitido de forma Direta (opção '''Direto''' marcado).
 
Esta opção é válida '''SOMENTE''' para o Banco do Brasil.
 
Ao emitir o Boleto do Lançamento o sistema marca as 3 opções:
 
- Boleto Impresso;
 
- Remessa Enviada;
 
- Código de Barras Lido;
 
Outra mudança é no '''Histórico''' Open Banking, ao qual passa criar o registro com '''Status Open Banking''' já '''Registrado'''.
 
Também ao acessar os '''Dados API''' é enviado a tag: "indicadorPix": "S", pois a opção PIX esta selecionada.
 
Disponibilizado o Modelo de Relatório para o Boleto Banco do Brasil já com o QRCode:
 
'''I:\CIGAM\DOC\Modelos_relatorios\Gestão Financeira\Bloquetos Merge\0098_brasil_PIX.rtf'''

='''Como realizar a Baixa de um Lançamento Financeiro Registrado Open Banking e enviar o Registro de Baixa?'''=
 
'''IMPORTANTE:''' O processo de Cancelamento de Notas Fiscais, não atende a baixa automatica dos Boletos, logo deve ser baixado manualmente os registros dos Lançamentos Financeiros.
 
Para realizar o processo de '''Baixa''' de um Lançamento Financeiro que foi registrado via Open Banking, basta acessar o Lançamento Financeiro.
 
'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 
Selecionar a opção de Menu Lateral do Lançamento Financeiro '''Open Banking''' e a opção de '''Baixar'''.
 
<center>'''Lançamento Financeiro Registrado/Baixar'''
[[Arquivo:Opção Baixar Lancto.png|750x500px|nenhum|Opção_Baixar_Lancto]]
 
<center>'''Lançamento Financeiro Confirmando Operação'''
[[Arquivo:Deseja Baixar.png|750x500px|nenhum|Deseja_Baixar]]
 
<center>'''Lançamento Financeiro Baixado com Sucesso'''
[[Arquivo:Baixado Sucesso.png|750x500px|nenhum|Baixado_Sucesso]]
 

='''Como parametrizar para envio Open Banking a Negativação?'''=
 
Basta acessar o Cadastro do Portador e inserir os dias no campo '''Protestar após''' na guia '''Configurações.
 

'''Menu > Finanças > Gestão Financeira > Parâmetros > Portadores'''

 
<center>'''Dias de Protesto Cadastro do Portador'''
[[Arquivo:Cadastro Portador Negativacao Sicredi.png|750x500px|nenhum|Cadastro_Portador_Negativacao_Sicredi]]
 

Banco do Sicredi:
 
Para este Banco a negativação é parametrizada no Cadastro do Portador na guia “Configurações” no campo “Protestar após”, é através deste campo que o sistema reconhece e passa considerar o envio das tags para os dados da API do Banco.
 
'''"numDiasNegativacaoAuto": "07",'''

 

='''Como cadastrar as Mensagens de Retorno API Financeira Sugestão Usuário?'''=
 
As Mensagens de Retorno API Financeira é uma funcionalidade para facilitar a identificar e de orientação para com as mensagens provindas das APIs que o Sistema tem conexão.
 
Elas foram implementadas para Open banking.
 
Para acessar o cadastro basta acessar através do Menu:
 
'''Menu: Finanças > Gestão Financeira > Parâmetros > Mensagens de Retorno API Financeiro'''
 

<center>'''Mensagens de Retorno API Financeiro'''
[[Arquivo:Mensagens Retorno API Financeiro.png|750x500px|nenhum|Mensagens_Retorno_API_Financeiro]]
 

'''Banco:''' código do Banco conforme codificação no orgão que rege os Bancos Febraban.
 
'''Código Erro:''' código do erro conforme layout das APIS dos Bancos.
 
'''Status:''' é o código de Status de erro do Servidor retornado da API dos Bancos. (Código HTTP)
 
'''Descrição do Erro (Banco):''' essa descrição é oriunda do Banco retornada pela API deles.
 
'''Sugestão CIGAM:''' esta mensagem é interna do Sistema, ou seja, quando internamente identificarmos uma situação a qual a Mensagem retornada pelo Banco não é clara, vamos alimentar com Mensagens de sugestão, para orientar as possíveis causas, dando um norte para situação.
 
'''Sugestão Cliente:''' este campo é reservado para o próprio usuário, possibilitando cadastrar Mensagens que ele identificar para facilitar no processo de entendimento das Mensagens de Retorno das APIs.
 
Agora através desta aplicação, quando ocorrer um Erro de Open Banking é possível verificar através dos links dispostos na tela de Lançamento Financeiro no campo Situação Open Banking, terá um link para tabela do erro ocorrido.
 
<center>'''Lançamento Financeiro Mensagens de Retorno API Financeiro'''
[[Arquivo:Mensagens Retorno API Financeiro BB OP.png|750x500px|nenhum|Mensagens_Retorno_API_Financeiro_BB_OP]]
 
Ou também através do Histórico Open Banking:
 
<center>'''Lançamento Financeiro Mensagens de Retorno API Financeiro Histórico Open Banking'''
[[Arquivo:Historico OP Mensagens Retorno API Financeiro BB OP.png|750x500px|nenhum|Historico_OP_Mensagens_Retorno_API_Financeiro_BB_OP]]

GF - Como Fazer - Open Banking para Banco Sicredi

2022-05-12T18:30:10Z

Alan.campos: /* Serviços Disponíveis pela API do Banco nesta Versão? */

[[categoria:Como_Fazer_Finanças]]

='''O que significa Open Banking?'''=

Open Banking é um conceito relativamente novo na realidade do mercado financeiro brasileiro. Porém, ele tem ganhado cada vez mais atenção em todo o mundo.
Traduzido, o termo significa “banco aberto”, mas uma tradução mais precisa seria “sistema financeiro aberto”.
O conceito em si trata de algo de simples compreensão. Basicamente, Open Banking é a defesa de que o sistema financeiro adote a tecnologia de forma mais ampla e padronizada, como forma de incentivar e ampliar a oferta e a qualidade dos produtos e serviços financeiros.
A base do Open Banking está na premissa de que os dados pertencem aos consumidores. Logo, caso eles autorizem, esses dados devem ser disponibilizados para que eles possam ter acesso a produtos e serviços que forem mais convenientes.
Na prática, há um pedido para que as instituições abram suas API’s (sigla em inglês para Interface de Programação de Aplicativos) para que terceiros desenvolvam e aprimorem os sistemas e suas funcionalidades.
O objetivo do Open Banking é desenvolver sistemas integrados, que facilitem o controle e transferência de informações de dados, histórico, contas, empréstimos etc. Todo o tipo de produto e serviço oferecido pelos bancos seria integrado de maneira a evitar processos complicados e dispendiosos.
À primeira vista, pode parecer que com o Open Banking as informações dos clientes ficarão soltas e desprotegidas. No entanto, os bancos e instituições financeiras ainda serão responsáveis pela proteção de dados sigilosos.

='''Serviços Disponíveis pela API do Banco nesta Versão?'''=
'''Menu > Utilidades/Diversos > Genéricos > Parâmetros > Configurações'''
 
<center>
{| class="wikitable"
|-
! SERVIÇO !! COBRANÇA
|-
| Registro de Boleto via API || SIM
|-
| Open Banking PIX no Boleto || NÃO
|-
| Retorno de Cobrança via API || NÃO
|-
| Alteração de Juros via API || SIM
|-
| Alteração de Multa via API || SIM
|-
| Alteração de Vencimento via API || SIM
|-
| Alteração de Baixa via API || SIM
|-
| Negativação no Envio do Registro via API || SIM
|-
| Prostesto no Envio do Registro via API || NÃO
|-
|}
</center>
 

='''Como obter as Credenciais para utilizar a Funcionalidade Open Banking?'''=
 
As credenciais do Banco devem ser obtidas através do contato com o seu Gerente de Cash (Gerente da Conta no Banco).
 
O Banco Sicredi, possui uma nomenclatura interna para esse processo, conhecido como Registro de Cobrança OnLine ou Ecommerce, conforme documentação.
 
Então ao entrar em contato com o Gerente de Cash, validar as nomenclaturas para que haja o entendimento da funcionalidade.
 

='''Quais os Módulos necessários para utilizar a Funcionalidade Open Banking”?'''=

• Módulo Gestão Financeira;

='''Quais são as parametrizações necessárias para utilizar a funcionalidade do Open Banking Banco Sicredi?'''=

'''Itens Importantes na Parametrização:'''
 
'''- Processar retornos pelo número do Boleto:''' esta opção deve estar marcada, pois caso contrário ocorrerá problemas na gravação das informações e envio para Banco.
 
Caso tenha sido realizado movimentações com esta opção desmarcada, não será possível realizar a Baixa, pois sistema não consegue localizar devido não possuir o '''Nosso Número''' gravado nas tabelas envolvidas.
 
Para solucionar essa questão será necessário:
 
'''1-''' Identificar o '''Nosso Número''' do registro a ser baixado (Lançamento Financeiro);
 
'''2-''' Gravar o '''Nosso Número''' nas seguintes tabelas:
 
'''GFBOLETOS:''' campo a ser atualizado '''NOSSO_NRO''' com a informação do Nosso Número.
 
'''GFLAUXIL:''' campo a ser atualizado '''CODIGO_BARRAS''' com a informação do Nosso Número.
 
'''- Processar retornos pelo número do Boleto:''' esta opção deve estar marcada, pois caso contrário ocorrerá problemas na gravação das informações e envio para Banco.
 
 
'''Importante preenchimento Telefone''': o não preenchimento do Telefone no Cadastro de Empresa acarretará em Erro no Registro Open Banking. Não é um item obrigatório, porém o Banco Sicredi para registrar necessita o preenchimento deste dado. Não deve ser utilizado espaços ou caracteres especiais.
 
Para utilizar esta funcionalidade é necessário possuir o Cadastro do Portador para o Banco citado.
O cadastro quando preenchido corretamente garante que não ocorrerá inconsistências no momento do registro do Open Banking.
 
Como boa prática de implementação é mais coerente criar um novo Portador para Open Banking evitando assim de alterar o Portador utilizado para CNAB caso necessite realizar algum processo via remessa ou retorno, quando a API do Banco estiver com instabilidade.
 
Essa parametrização deverá validar os últimos Sequenciais da numeração de Boletos do Portador utilizado para as Remessas, pois assim garante que não ocorrerá conflito enviar uma numeração de Título já registrado.
 
 
Itens importantes na parametrização:
 
- '''Nº Banco''';
 
- '''Nº Conta''';
 
- '''Nº Convênio''';
 
- '''Agência/DV''': o DV da Agência é considerado o '''Posto''' da Agência, ou seja, para adquirir essa informação o Banco da Unidade da Agência deve fornecer.
 
Quando se tratar do Portador Open Banking do SICREDI, o campo '''DV''' da Agência deve ser preenchido conforme a Unidade da Agência do Banco.
 
- '''Código Cedente''';
 
Para o correto funcionamento da rotina é necessário que os dados do Portador esteja com todas informações necessárias, inclusive o Convênio.
 
'''Menu > Finanças > Gestão Financeira > Parâmetros > Portadores'''
 
Este cadastro é apenas uma demonstração de parametrização:
 
<center>'''Cadastro de Portador'''
[[Arquivo:Cadastro Portador Principal.png|750x500px|nenhum|Cadastro_Portador_Principal]]
 
<center>'''Guia CNAB'''
[[Arquivo:Cadastro Portador CNAB Sicredi.png|750x500px|nenhum|Cadastro_Portador_CNAB]]
 

Campo "Especie" quando utilizado Open Banking deve ser = A para Duplicata Mercantil.

<center>'''Guia Configurações'''
[[Arquivo:Cadastro Portador Configurações Sicredi.png|750x500px|nenhum|Cadastro_Portador_Configurações_Sicredi]]
 

'''Irá surgir a necessidade de realizar a alteração de Vencimento, Multa ou Juros do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?'''
 
Regra Sistema para Vencimento, Multa ou Juros:
 
Cadastro do Portador deve possuir Comando de Remessa com as novas opções:
 
'''Tipo de Comando =''' Alteração de Vencimento (para alteração de Vencimento).
 
'''Tipo de Comando =''' Alteração de Multa para Multa (para alteração de Multa).
 
'''Tipo de Comando =''' Alteração de Juros para Juros (para alteração de Juros).
 
Caso não seja parametrizado neste primeiro momento as opções de Multa e Juros o sistema cria automaticamente (Somente Juros e Multa).
 
Ao acessar o Lançamento Financeiro em modo Modificar e alterar o campo Multa de ou Juros de, automaticamente após alteração da Multa, o Sistema irá criar essa parametrização do Comando de Remessa com sugestão, sendo passível de alteração, no Cadastro do Portador no botão Remessas e depois no botão Comandos.
 
'''Comando sugestão para Multa:'''
 
'''Código Operação''' = ATM
 
'''Comando''' = ATM
 
'''Descrição''' = ALTERAÇÃO DE MULTA PARA OPEN BANKING
 
'''Tipo de Comando''' = Alteração de Multa
 
'''Comando sugestão para Juros:'''
 
'''Código Operação''' = ATJ
 
'''Comando''' = ATK
 
'''Descrição''' = ALTERAÇÃO DE JUROS PARA OPEN BANKING
 
'''Tipo de Comando''' = Alteração de Juros
 
<center>'''Botão Remessas > Comandos'''
[[Arquivo:Cadastro Portador Comando Remessa.png|750x500px|nenhum|Cadastro_Portador_Comando_Remessa]]
 
<center>'''Botão Retornos > Códigos de Retorno'''
[[Arquivo:Cadastro Portador Codigo Retorno.png|750x500px|nenhum|Cadastro_Portador_Codigo_Retorno]]
 
Para iniciar a configuração através do “Assistente de Parâmetros do Open Banking”, basta selecionar o botão “Open Banking”:
 
'''Menu > Finanças > Gestão Financeira > Parâmetros > Configuração de Bancos'''
 
 
<center>'''Configurações de Banco'''
[[Arquivo:Cadastro Configuraçao Banco.png|750x500px|nenhum|Cadastro_Configuraçao_Banco]]
 
 
Para dar início ao processo de parametrização, basta selecionar o botão “Avançar”:
 
 

='''Tela Inicial Configuração do Assistente Open Banking:'''=
 
Para iniciar a configuração é necessário ter em mãos os seguintes dados: (Código de Acesso).
Sem essas informações não será possível dar continuidade na parametrização do Open Banking para o Banco do Sicredi.
 
<center>'''Tela Inicial Assistente de Parâmetros Open Banking'''
[[Arquivo:Wizard Bem Vindo.png|750x500px|nenhum|Wizard_Bem_Vindo]]
 


=='''Etapa 1 (Parâmetros: Passo 1 de 4):'''==


Uma das etapas mais importantes e que requer um cuidado maior e sigilo das informações nesta parametrização.
 
Essas informações são disponibilizadas pelo Banco a qual deve ser restrita somente a pessoa responsável pelo setor Financeiro da Empresa.
 
O assistente tem como objetivo proporcionar que o próprio usuário tenha autonomia para executar esse passo a passo sem necessidade de passar essas informações restritas da Empresa para qualquer pessoa que não seja ele mesmo.
 
Reforçando, mesmo que tenha dificuldades para executar esta etapa, não repasse nenhuma informação relacionado aos acessos dos tokens.
 
Dados em mãos para informar os respectivos campos, basta copiar e colar as informações.
 
Código de Acesso.
 
O Campos '''Código de Acesso''' possui uma tecnologia de criptografia, ou seja, após informar os dados nos campos o sistema irá criptografar as informações garantindo e mantendo a segurança das informações.
 
Caso haja necessidade de alterações, basta clicar no ícone do "Cadeado", será aberta a tela de Criptografia e após colar ou digitar as informações em tela e selecionar o botão "Confirmar".
 
Também tenha alguma dúvida no dado informado e necessitar validar o dado seguindo os mesmos passos da alteração será aberta a tela de Criptografia e após colar ou digitar as informações em tela e selecionar o botão "Validar", sistema confirma se os dados são os mesmos.
 
Observamos que esta tela possui duas guias, uma de Homologação e Produção. Preencher conforme a necessidade do processo, caso precise realizar testes, parametrize em homologação e posteriormente parametrize o de Produção ou se preferir, pode preencher os dois se possuir os dados.
 
Lembrando que esses dados são confidenciais de uso e exclusivo de cada usuário.
 
Através dessas informações o sistema irá se comunicar com API do Banco para poder realizar os registros dos Lançamentos.
 
Após informado os dados, basta selecionar o botão "Avançar", para seguir os próximos passos.
 
'''Código de Acesso:''' informar a codificação passada pelo Banco.
 
 
<center>'''Parâmetros: Passo 1 de 4'''
[[Arquivo:Wizard Passo 1 Sicredi.png|750x500px|nenhum|Wizard_Passo_1_Sicredi]]
 

=='''Etapa 2 (Portador de Remessa e Retorno - Pagamento: Passo 2 de 4):'''==

Nesta etapa deve ser selecionado o Portador que será considerado para o envio da Remessa de Pagamento (onde estarão os boletos em aberto) e nesta mesma tela informar o qual Portador será considerado para o Retorno de Pagamento (onde serão liquidados os retornos de Pagamentos).
 
Nesta etapa, é possível pular, caso não utilize ainda o Envio de Pagamentos do Open Banking.
 
'''Pular:''' caso deseja pular essa etapa e prosseguir com o processo de parametrização do Open Banking.
 
'''Avançar:''' dá continuidade ao processo de parametrização, após selecionado uma opção.
 
Para continuar a parametrização selecione o botão "Pular" e siga para os próximos passos.
 
<center>'''Portador de Remessa e Retorno: Passo: 2 de 4'''
[[Arquivo:Wizard Passo 2 Sicredi.png|750x500px|nenhum|Wizard_Passo_2_Sicredi]]
 

=='''Etapa 3 (Convênios de Cobrança: Passo 3 de 4):'''==
 
Nesta etapa o sistema avalia sua base de dados, e localiza os Convênios parametrizados para o Banco Sicredi, onde serão listados.
O sistema possibilita a parametrização de Convênios específicos bem como caso seja optado, selecionando o botão "Pular" o sistema criará automaticamente o Convênio "Geral", ao qual utiliza dados do Portador registrado.
 
'''Pular:''' caso deseja pular essa etapa e prosseguir com o processo de parametrização do Open Banking.
 
'''Avançar:''' dá continuidade ao processo de parametrização, após selecionado uma opção.
 
<center>'''Convênios de Cobrança: Passo 3 de 4'''
[[Arquivo:Wizard Passo 3 Sicredi.png|750x500px|nenhum|Wizard_Passo_3_Sicredi]]
 

=='''Etapa 3 (Portador de Remessa e Retorno - Cobrança: Passo 3 de 4):'''==
 
Nesta etapa deve ser selecionado o Portador que será considerado para o envio da Remessa de Cobrança (onde estarão os boletos em aberto) e nesta mesma tela informar o qual Portador será considerado para o Retorno de Cobrança (onde serão liquidados os retornos de Cobranças).
 
'''Avançar:''' dá continuidade ao processo de parametrização, após selecionado uma opção.
 
<center>'''Portador de Remessa e Retorno - Cobrança: Passo 3 de 4'''
[[Arquivo:Wizard Passo 3-4 Final Sicredi.png|750x500px|nenhum|Wizard_Passo_3-4_Final_Sicredi]]
 
Atualizado Wizard para Versão 2 do Open Banking, disponibilizando duas opções:
 
'''- Direto:''' esta opção tem como finalidade registrar o Boleto no momento da sua geração, ou seja, quando selecionado ativa propriedade ao qual ao gerar o Boleto Bancário o sistema automaticamente envia o registro Open Banking, sem a necessidade de fazer o processo de envio da Remessa Open Banking do título.
 
Também quando selecionada, terá uma particularidade na questão da Emissão de Boletos em lote pela Rotina de Emissão de Boletos Personalizados. A rotina na guia '''Opções''' tem a opção '''Enviar somente Lançamentos não marcados e marca-los''', caso esteja desmarcada o Registro Open Banking ocorrerá da mesma forma que o sistema irá marcar a opção '''Boleto Impresso''' do Lançamento Financeiro, registrando a Operação Open Banking.
Isso ocorre para manter a integridade, já que esta operação é considerada única no registro, sendo então necessário marcar a '''Boleto Impresso''', para poder conseguir realizar alterações como Alteração de Vencimento ou mesmo a Baixa, sendo uma condição de Sistema.
 
'''- PIX''': esta opção tem como finalidade registrar uma operação PIX para os Boletos emitido de forma Direta (opção '''Direto''' marcado).
 
Esta opção é válida '''SOMENTE''' para o Banco do Brasil.
 

=='''Etapa 4 (Relatório: Passo 4 de 4):'''==

 
Nesta etapa o sistema irá buscar automaticamente o Modelo de Relatório Padrão, caso exista no ambiente, facilitando assim todo processo de parametrização e implementação para usuário.
 
A busca é realizado '''(%CIGAM_INSTAL%RF00071_remessas.RTF)''', com isso é importante que o Modelo de Relatório (RF00071_remessas.RTF) esteja devidamente localizado na pasta padrão do Cigam_Instal, como por exemplo:
 
'''%CIGAM_INSTAL%''' = P:\Cigam11\Projects\Controle\MACIEL\Financeiro_Open_Banking
 
"P:\Cigam11\Projects\Controle\MACIEL\Financeiro_Open_Banking\Modelos\Relatorios\Gestao Financeira\RF00071_remessas.RTF"
 
Clicar em "Avançar" para dar seguimento.
 
<center>'''Assistente de Parâmetros Open Banking: Passo 4 de 4'''
[[Arquivo:Wizard Passo 4-4 Relat Sicredi.png|750x500px|nenhum|Wizard_Passo_4-4_Relat_Sicredi]]
 
 

=='''Etapa Conclusão (Parâmetros de Convênio Open Banking - Conclusão):'''==

 
Esta etapa o sistema faz validação da comunicação com o Banco através da API verificando o ambiente se esta tudo ok, listando em tela.
 
Após a consulta estar "OK", basta clicar no botão "Concluir" e seu ambiente estará apto para utilizar a funcionalidade Open Banking.
 
<center>'''Parâmetros de Convênio Open Banking: Passo Final - Conclusão'''
[[Arquivo:Wizard Passo Final Conclusao Conexao Sicredi.png|750x500px|nenhum|Wizard_Passo_Final_Conclusao_Conexao_Sicredi]]
 
'''Homologação:''' Conexão realizada com sucesso.
 
'''Produção:''' Conexão realizada com sucesso.
 
O servidor remoto retornou um erro: (401) Não Autorizado. Isso ocorre quando não houve a parametrização dos dados em Produção como foi realizado no ambiente de Homologação conforme o passo a passo, ou possa ter ocorrido algum erro na comunicação com o Banco.
 
<center>'''Convênio Cadastrado com Sucesso - Cobrança'''
[[Arquivo:Parametros OP Sicredi.png|750x500px|nenhum|Parametros_OP_Sicredi]]
 
'''Ambiente:''' lista qual é o ambiente cadastrado, sendo apenas duas opções: Homologação e Produção.
 
'''Convênios:''' neste grupo serão listados todos os convênios cadastrados, bem como todas informações pertinentes como:
 
- Portador;
 
- Agência;
 
- Número Conta;
 
- Portador de retorno;
 
'''- Direto:''' esta opção tem como finalidade registrar o Boleto no momento da sua geração, ou seja, quando selecionado ativa propriedade ao qual ao gerar o Boleto Bancário o sistema automaticamente envia o registro Open Banking, sem a necessidade de fazer o processo de envio da Remessa Open Banking do título.
 
'''- PIX:''' esta opção fica habilitada somente quando selecionado a opção Direto, ela tem como finalidade registrar uma operação PIX para os Boletos emitido de forma Direta (opção Direto marcado).
 
Esta opção é válida SOMENTE para o Banco do Brasil.
 
Ao emitir o Boleto do Lançamento o sistema marca as 3 opções:
 
- Boleto Impresso;
 
- Remessa Enviada;
 
- Código de Barras Lido;
 
'''U.N Ced.:''' esta opção tem como finalidade possibilitar o envio e registro de Boletos de outras Unidades de Negócio.
 
Basta informar a Unidade desejada no campo e o sistema entenderá quando realizado o processo de registro de um título que não seja da Unidade Matriz, então sistema identifica e realiza o processo de envio e registro.
Se deixar em Branco a Unidade Cedente irá considerar para todas Unidades de Negócio.
 
 
<center>'''Convênio Cadastrado com Sucesso - Pagamento'''
[[Arquivo:Parametros OP Sicredi Pagamento.png|750x500px|nenhum|Parametros_OP_Sicredi_Pagamento]]
 
'''Ambiente:''' lista qual é o ambiente cadastrado, sendo apenas duas opções: Homologação e Produção.
 
'''Convênios:''' neste grupo serão listados todos os convênios cadastrados, bem como todas informações pertinentes como:
 
- Portador;
 
- Agência;
 
- Número Conta;
 
- Portador de retorno;
 
<center>'''Ícone Credenciais'''
[[Arquivo:Parametros OP Sicredi Credenciais.png|750x500px|nenhum|Parametros_OP_Sicredi_Credenciais]]
 
Através deste ícone é possível verificar os Parâmetros API parametrizados, tanto em homologação quanto em produção.
 
 
<center>'''Ícone Endereços'''
[[Arquivo:Parametros OP Sicredi Endereços.png|750x500px|nenhum|Parametros_OP_Sicredi_Endereços]]
 
Através deste ícone é possível verificar todos endereços de URLs parametrizados.

='''O que significa a Categoria Open Banking de acesso?'''=
 
 A Categoria Open Banking é uma Categoria que é habilitada mediante a utilização de um Portador parametrizado com as Configurações de Banco Open Banking. A mesma tem como objetivo proporcionar maior agilidade e gerenciamento das atividades relacionadas a Remessa de Cobrança Online.
 
'''Categoria Open Banking'''
 
 
<center>'''Categoria Open Banking'''
[[Arquivo:Categoria Open Banking.png|750x500px|semmoldura|nenhum|Categoria_Open_Banking]]
 
 

'''Registrar:''' item de categoria tem como funcionalidade registrar o Boleto Bancário Online. Substitui todo o processo de geração do arquivo de Remessa de Cobrança, acessar o site e remeter ao Banco esse arquivo, com apenas um clique na opção.
 
'''Reenviar:''' item de categoria tem como funcionalidade possibilitar o reenvio de registros que estão com alguma pendência ou algum erro de parametrização. Será habilitado somente quando já possuir movimento de "Registro" enviado, cuja Situação estiver com pendência ou erro.
 
'''Baixar:''' item de categoria tem como funcionalidade comunicar o Banco referente a Baixa do movimento em questão do Boleto Bancário. Utilizado para eventuais falhas operacionais, como registrado um movimento por engano, ou negociações diretamente com cliente a parte. Eliminando então também todo processo de geração do arquivo de Remessa Bancária com Comando de Remessa de Baixa e o processo de remeter ao Banco o arquivo, sendo realizado tudo online através desta opção.
 
'''Registrar Alteração:''' item de categoria tem como funcionalidade registrar uma alteração ocorrida referente ao "Vencimento" do Lançamento Financeiro.
Ao realizar alteração da Data de Vencimento do Lançamento Financeiro que está com "Situação Open Banking" igual "Registrado" e ocorrer alteração no Vencimento, o sistema emite uma mensagem possibilitando já o envio da alteração no momento ou mais tarde através desta opção de "Registrar Alteração".
 
'''Histórico:''' item de categoria tem como funcionalidade gravar todas movimentações realizadas relativo ao Open Banking. Registros, Baixas, Erros...

='''Layout e Detalhamento de Campos API'''=
==Registro de Boletos==
<center>

{| class="wikitable"
|-
! Nº !! Campo JSON !! Descriçao do Banco !! Campo CIGAM !! Tabela !! Obrigatório !! Observações
|-
| 1 || token || Chave Transacional gerada pelo recurso /autenticacao || || || Obrigatório ||
|-
| 2 || Content-Type || Estabelece o tipo de conteúdo da requisição || || || Obrigatório ||
|-
| 3 || agencia || Código da Cooperativa do beneficiário || Agência || Portador || Obrigatório ||
|-
| 4 || posto || Código do Posto do beneficiário || Dígito Agência || Portador || Obrigatório ||
|-
| 5 || cedente || Código do Convênio de Cobrança do beneficiário || Código Cedente || Portador || Obrigatório ||
|-
| 6 || nossoNumero* || Nosso Número || Nosso Número || Boletos || Opcional ||
|-
| 7 || codigoPagador || Código Pagador || Não Tratado || Não Tratado || Opcional ||
|-
| 8 || tipoPessoa* || Tipo de pessoa do pagador.
'''Domínio:'''
 
1 - PESSOA FÍSICA
 
2 - PESSOA JURÍDICA
|| Pessoa || Empresa || Obrigatório ||
|-
| 9 || cpfCnpj* || CPF ou CNPJ do pagador || CNPJ/CPF || Empresa || Obrigatório ||
|-
| 10 || nome || Nome do pagador || Nome Completo || Empresa || Obrigatório ||
|-
| 11 || endereco || Endereço do pagador || Endereço || Empresa || Opcional || Será obrigatório se o código do pagador '''não''' for informado.
|-
| 12 || cidade || cidade || Município || Empresa || Opcional || Será obrigatório se o código do pagador '''não''' for informado.
|-
| 13 || uf || Estado do pagador || UF || Empresa || Opcional || Será obrigatório se o código do pagador '''não''' for informado.
|-
| 14 || cep || CEP do pagador || CEP || Empresa || Obrigatório ||
|-
| 15 || telefone || Telefone mais DDD do pagador || Fone || Empresa || Opcional || Será obrigatório se o código do pagador '''não''' for informado.
|-
| 16 || email || Endereço de email do pagador || Email || Contato || Opcional ||
|-
| 17 || especieDocumento || Espécie de documento do título.(*) || Espécie || Portador || Obrigatório ||
|-
| 18 || codigoSacadorAvalista || Código do sacador avalista. || Não Tradado || Não Tradado || Opcional ||
|-
| 19 || seuNumero || Número de controle interno do beneficiário que referencia o pagador. || Lançamento || LANCAM || Obrigatório ||
|-
| 20 || dataVencimento || Data de vencimento do boleto || Vencimento || Boletos || Obrigatório ||
|-
| 21 || valor || Valor do boleto || Saldo || LANCAM || Obrigatório ||
|-
| 22 || tipoDesconto || Tipo de desconto.
'''Domínios:'''
 
A - VALOR
 
B - PERCENTUAL
|| Não Tratado || Não Tratado || Obrigatório ||
|-
| 23 || valorDesconto1 || Valor de desconto 1 || Valor Desconto || LANCAM || Opcional || Será obrigatório se o dataDesconto1 for informado.
|-
| 24 || dataDesconto1 || Data limite para concessão de desconto1 || Vencimento || LANCAM || Opcional || Será obrigatório se o valorDesconto1 for informado. Não pode ser igual a outras dataDescontos e nem maior que vencimento.
|-
| 25 || valorDesconto2 || Valor de desconto 2 || Não Tratado || Não Tratado || Opcional || Será obrigatório se o dataDesconto2 for informado.
|-
| 26 || dataDesconto2 || Data limite para a concessão de desconto 2 || Não Tratado || Não Tratado || Opcional || Será obrigatório se o valorDesconto2 for informado. Não pode ser igual a outras dataDescontos e nem maior que vencimento.
|-
| 27 || valorDesconto3 || Valor de desconto 3 || Não Tratado || Não Tratado || Opcional || Será obrigatório se o dataDesconto3 for informado.
|-
| 28 || dataDesconto3 || Data limite para a concessão de desconto 3 || Não Tratado || Não Tratado || Opcional || Será obrigatório se o valorDesconto3 for informado. Não pode ser igual a outras dataDescontos e nem maior que vencimento.
|-
| 29 || tipoJuros || Tipo de Juros.
'''Domínios:'''
 
A - VALOR
 
B - PERCENTUAL
|| || || Obrigatório ||
|-
| 30 || juros || Valor de juros a cobrar por dia. || Juros Dia || LANCAM || Opcional ||
|-
| 31 || multas || Percentual de multa a cobrar || Valor Multa || LANCAM || Opcional ||
|-
| 32 || desconto Antecipado || Valor de desconto antecipado a cobrar || Não Tratado || Não Tratado || Opcional || Deve ser menor que o valor.
|-
| 33 || informativo || Texto do Informativo || Não Tratado || Não Tratado || Opcional ||
|-
| 34 || mensagem* || Texto da linha da mensagem || Não Tratado || Não Tratado || Opcional ||
|-
| 35 || codigoMensagem || Código da mensagem || Não Tratado || Não Tratado || Opcional ||
|-
| 36 || numDiasNegativacaoAuto || Número de dias para Negativação Automática. 0 (Zero) para não negativar automaticamente. Quando preenchido com 3 ou 4 dias o sistema comandará negativação em dias úteis após o vencimento. Quando preenchido acima de 4 dias, o sistema comandará negativação em dias corridos após o vencimento. || Protesto || Portador || Opcional ||
|-
| 37 || NomeBeneficiarioFinal || NomeBeneficiarioFinal || Não Tratado || Não Tratado || Obrigatório caso informado TipoPessoaBeneficiarioFinal e CpfCnpjBeneficiarioFinal ||
|-
| 38 || TipoPessoaBeneficiarioFinal || Tipo de pessoa.
'''Domínios:'''
 
1 - Física
 
2 - Jurídica
|| Não Tratado || Não Tratado || Obrigatório caso informado NomeBeneficiarioFinal e CpfCnpjBeneficiarioFinal ||
|-
| 39 || CpfCnpjBeneficiarioFinal || CPF/CNPJ do beneficiário final || Não Tratado || Não Tratado || Obrigatório caso informado NomeBeneficiarioFinal e TipoPessoaBeneficiarioFinal ||
|-
| 40 || FoneBeneficiarioFinal || Fone do beneficiário final || Não Tratado || Não Tratado || Opcional ||
|-
| 41 || EnderecoBeneficiarioFinal || Endereço do beneficiário final || Não Tratado || Não Tratado || Opcional ||
|-
| 42 || CepBeneficiarioFinal || CEP do beneficiário final || Não Tratado || Não Tratado || Opcional ||
|-
| 43 || CidadeBeneficiarioFinal || CidadeBeneficiarioFinal || Não Tratado || Não Tratado || Opcional ||
|-
| 44 || UfBeneficiarioFinal || UF do beneficiário final || Não Tratado || Não Tratado || Opcional ||
|-
|}

</center>

'''(*) Domínios:'''
 
A - DUPLICATA MERCANTIL (DM)
 
B - DUPLICATA RURAL (DR)
 
C - NOTA PROMISSORIA (NP)
 
D - NOTA PROMISSORIA RURAL (NR)
 
E - NOTA DE SEGURO (NS)
 
G - RECIBO (RC)
 
H - LETRA DE CAMBIO (LC)
 
I - NOTA DE DEBITO (ND)
 
J - DUPLICATA DE SERVICO (DS)
 
K - OUTROS (OS)
 
O - BOLETO OFERTA (OFE)

==Alteração de Boletos==
<center>

{| class="wikitable"
|-
! Nº !! Campo JSON !! Descriçao do Banco !! Campo CIGAM !! Tabela !! Obrigatório !! Observações
|-
| 1 || agencia || Agência do Beneficiário || Agência || Portador || Obrigatório ||
|-
| 2 || posto || Posto do Beneficiário || Dígito Agência || Portador || Obrigatório ||
|-
| 3 || cedente || Código do Beneficiário || Código Cedente || Portador || Obrigatório ||
|-
| 4 || nossoNumero* || Nosso Número do Título || Nosso Número || Boletos || Obrigatório ||
|-
| 5 || instrucaoComando || Comando que será realizado na alteração do boleto. || || || Obrigatório || Caso seja informado ALTERACAO_OUTROS_DADOS será '''obrigatória''' a inclusão do campo complementoInstrucao.
|-
| 5.1 || PEDIDO_BAIXA || || || || Obrigatório || Consultar o Termo de Adesão com sua Unidade de Atendimento Sicredi p/ ver se está com Baixa Automática de boletos vencidos. Caso esteja, o boleto vencido terá sua baixa efetuada automaticamente.
|-
| 5.2 || CONCESSAO_ABATIMENTO || || || || Obrigatório ||
|-
| 5.3 || CANCELAMENTO_ABATIMENTO_CONCEDIDO || || || || Obrigatório ||
|-
| 5.4 || ALTERACAO_VENCIMENTO || || || || Obrigatório ||
|-
| 5.5 || ALTERACAO_SEU_NUMERO || || || || Obrigatório ||
|-
| 5.6 || PEDIDO_PROTESTO || || || || Obrigatório || Somente em título vencido. Por padrão, todos os boletos emitidos pelo EComm-API, não são protestados.
|-
| 5.7 || SUSTAR_PROTESTO_BAIXAR _TITULO || || || || Obrigatório ||
|-
| 5.8 || SUSTAR_PROTESTO_MANTER_CARTEIRA || || || || Obrigatório ||
|-
| 5.9 || ALTERACAO_OUTROS_DADOS || || || || Obrigatório ||
|-
| 6 || complementoInstrucao || Complemento do comando que será realizado na alteração do boleto || || || Condicional ||
|-
| 6.1 || DESCONTO || || || || Condicional ||
|-
| 6.2 || JUROS_DIA || || || || Condicional ||
|-
| 6.3 || DESCONTO_DIA_ANTECIPACAO || || || || Condicional ||
|-
| 6.4 || DATA_LIMITE_CONCESSAO_DESCONTO || || || || Condicional ||
|-
| 6.5 || CANCELAMENTO_PROTESTO _AUTOMATICO || || || || Condicional ||
|-
| 6.6 || CANCELAMENTO_NEGATIVACAO_AUTOMATICA || || || || Condicional ||
|-
| 7 || ''Campo de Alteração'' || Nome do campo que deseja mudar || || || Obrigatório ||
|-
|}

</center>

='''Como realizar a criação de Lançamentos utilizando a funcionalidade Open Banking?'''=
 
Para a criação de Lançamentos Financeiros acessar o caminho de Menu:
 

'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 

Acessar o botão “Criar” e informar os dados necessários para a criação do Lançamento Financeiro a Receber utilizando o Portador parametrizado para Open Banking.
 
 
'''1- Etapa criação do Lançamento:'''
 
 
<center>'''Criação do Lançamento Financeiro a Receber'''
[[Arquivo:Create Lanc Open Banking.png|750x500px|semmoldura|nenhum|Criação do Lançamento Financeiro]]
 
 

'''2- Etapa Impressão do Boleto Bancário do Lançamento Financeiro:'''
 
Nesta etapa pode ser realizado a impressão do Boleto Bancário diretamente pelo próprio Lançamento Financeiro ou através da rotina de Emissão em lote "Emissão de Boletos Personalizados":
 
 
<center>'''Impressão do Boleto Bancário do Lançamento Financeiro'''
[[Arquivo:Imprimir Boleto Lanc.png|750x500px|semmoldura|nenhum|Impressão Boleto Bancário]]
 
 

'''3- Etapa do Registro do Boleto Open Banking:'''
 
Nesta etapa pode ser realizado o "Registro" do Boleto diretamente pelo próprio Lançamento Financeiro ou através da rotina de Emissão em lote "Emissão de Boletos Personalizados":
Basta acessar a Categoria "Open Banking" e selecionar o Item de Categoria "Registrar".
Sistema irá realizar a comunicação através das parametrizações realizadas das Urls e Tokens de acesso e listará a situação do Registro do Boleto Bancário através do Relatório.
 
 
<center>'''Registrar Boleto Open Banking através Lançamento Financeiro'''
[[Arquivo:Boleto Impresso Registrar OP.png|750x500px|semmoldura|nenhum|Registro Boleto Open Banking]]
 
 
<center>'''Relatório Remessa Bancária OnLine'''
[[Arquivo:Relat Registro Open Banking.png|750x500px|semmoldura|nenhum|Relatório Remessa Bancária Online]]
 
 
Após o registro automaticamente o sistema marca as opções de:
 
- Remessa Enviada
 
- Códigos de Barras Lido
 
 
<center>'''Boleto Bancário Registrado'''
[[Arquivo:Lanc Registrado Validar Historico.png|750x500px|semmoldura|nenhum|Lanc_Registrado_Validar_Historico]]
 
 
Para verificar todas as movimentações realizada sobre Open Banking, elas estão sendo gravadas no Item de Categoria "Histórico" que fica na Categoria "Open Banking".
Ao selecionar o Item de Categoria "Histórico" deve listar o Registro do Boleto Bancário.
 
 
<center>'''Item de Categoria Histórico de Movimentos Open Banking'''
[[Arquivo:Item Categoria Historico.png|750x500px|semmoldura|nenhum|Item_Categoria_Histórico]]
 
 

='''Como realizar o Envio em Lote Open Banking através da rotina Remessa de Cobrança Open Banking?'''=

Assim como é possível realizar o Envio do Registro do Boleto Bancário através do próprio Lançamento Financeiro, existe a possibilidade de realizar esse processo em Lote, quando se tratar de vários registros a serem enviados.
Através do Menu:
 
 
'''Menu: Finanças > Gestão Financeira > Rotinas > EDI> Transmite > Remessa Cobranças Bancárias > Remessa de Cobrança Open Banking'''
 
 
<center>'''Remessa de Cobrança Open Banking'''
[[Arquivo:Remessa_de_Cobranca_Open_Banking_BB3.png|750x500px|semmoldura|nenhum|Remessa_de_Cobranca_Open_Banking]]
 
 
Esta rotina tem um conceito muito simples em relação aos filtros, foram disponibilizados campos essências que permitem ter uma rastreabilidade dos movimentos.

'''Unidade de Negócio:''' informe a Unidade de Negócio desejada para realizar o filtro para busca dos movimentos.
 
'''Data:''' informe a Data desejada para realizar o filtro para busca dos movimentos.
 
'''Vencimento:''' informe o período de Vencimento desejado para realizar o filtro para busca dos movimentos.
 
'''Lançamento:''' informe a faixa de Lançamentos desejada para realizar o filtro para busca dos movimentos.
 
'''Tipo de Pagamento:''' informe o Tipo de Pagamento desejado para realizar o filtro para busca dos movimentos.
 
'''Série:''' informe a Série desejada para realizar o filtro para busca dos movimentos.
 
'''Nota Fiscal:''' informe a faixa de Nota Fiscal desejada para realizar o filtro para busca dos movimentos.
 
'''Conta Financeira:''' informe a Conta Financeira desejada para realizar o filtro para busca dos movimentos.
 
'''Empresa:''' informe a faixa de Empresa desejada para realizar o filtro para busca dos movimentos.
 
'''Cobrança:''' informe a faixa de Empresa de Cobrança desejada para realizar o filtro para busca dos movimentos.
 
 
Após informado os filtros e confirmado a operação da rotina o sistema gera um relatório com a listagem dos movimentos.
Na coluna "Registro", será listado se houve a confirmação ou ocorreu algum erro.
 
 
<center>'''Relatório Remessa de Cobrança Open Banking'''
[[Arquivo:Relat Remessa Bancaria Open Banking.png|750x500px|semmoldura|nenhum|Relat_Remessa_Bancaria_Open_Banking]]
 
 

='''Como realizar a alteração de Vencimento do Lançamento já Registrado Open Banking e reenviá-lo novamente?'''=
 

Irá surgir a necessidade de realizar a alteração do Vencimento do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?
 
'''Dado que''' já temos um Lançamento Financeiro já Registrado Open Banking, basta acessar o Lançamento Financeiro desejado através do caminho do Menu:
 
'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 
Acessar o Lançamento Financeiro em modo Modificar e alterar o campo "Venc.Original", automaticamente após alteração do Vencimento, o sistema insere o Comando "05" no campo "Comando de Remessa" e diante disso já emite uma mensagem:
 
'''Confirma o envio da alteração do título ao banco?'''
 
'''Importante:''' para o envio da alteração do Vencimento o sistema já considera o campo '''Vencimento''', caso seja utilizado a '''Modalidade''' como '''Seguinte''' por exemplo, onde é possível ter um Vencimento Original diferente do Vencimento.
 
<center>'''Lançamento Financeiro a Receber já Registrado'''
[[Arquivo:AlterarVenc Lanc1.png|750x500px|nenhum|AlterarVenc_Lanc1]]
 
 
Vencimento alterado, sistema insere o Comando "05" no campo "Comando de Remessa" e ao salvar o registro é emitido a mensagem: "Confirma o envio da alteração do título ao banco?"
 
<center>'''Vencimento alterado e registro salvo'''
[[Arquivo:Vencimento Alterado Msn.png|750x500px|nenhum|Vencimento_Alterado_Msn]]
 
'''Sim:''' é enviado o registro de alteração do Open Banking e se registrado com sucesso, sistema retira então o Comando de Remessa.
 
<center>'''Processo Concluído com Sucesso'''
[[Arquivo:Processo_Concluido_Sucesso_Lanc.png|750x500px|nenhum|Processo_Concluido_Sucesso_Lanc]]
 
Há possibilidades do tempo de comunicação com API do Banco não retornar imediatamente a confirmação do recebimento da Alteração do Vencimento. Quando ocorrer essa situação, sistema emite uma mensagem, solicitando aguardar, para tentar novamente o envio da alteração do vencimento.
Quando ocorrer essa situação, será necessário aguardar e após realizar o envio novamente ou através do próprio Lançamento ou através da rotina de Remessa de Cobrança - Open Banking, que remeterá as alterações para o Banco.
<center>'''Processo Pendente Alteração - Aguardar'''
[[Arquivo:Alteração Vencimento Processo Pendente Envio Aguardar.png|750x500px|nenhum|Alteração_Vencimento_Processo_Pendente_Envio_Aguardar]]
 
Já quando selecionado a opção '''Não''':
 
'''Não:''' não faz a comunicação do envio da alteração do vencimento via Open Banking. Este registro não foi notificado, logo será necessário realiza-lo através do próprio Lançamento ou através da rotina de Remessa de Cobrança Open Banking.
 
No Lançamento Financeiro é habilitado o botão "Reenviar Registro" no Item de Categoria "Open Banking".
Quando selecionado o botão '''Registrar Alteração''', sistema faz a comunicação via Open Banking e registra alteração de vencimento realizada.
 
<center>'''Lançamento Não Registrado a alteração de Vencimento com o Comando de Remessa'''
[[Arquivo:Botao Registrar Alteracao Habilitado.png|750x500px|nenhum|Botao_Registrar_Alteracao_Habilitado]]
 
Ao selecionar o botão "Registrar Alteração" sistema emite a mensagem para confirmar o envio.
 
<center>'''Botão Registrar Alteração'''
[[Arquivo:Registrar Alteracao Selecionado.png|750x500px|nenhum|Registrar_Alteracao_Selecionado]]
 
Após a confirmação o sistema registra alteração
 
<center>'''Processo Concluído com Sucesso'''
[[Arquivo:Processo_Concluido_Sucesso_Lanc.png|750x500px|nenhum|Processo_Concluido_Sucesso_Lanc]]
 
 
<center>'''Lançamento alterado e registrado'''
[[Arquivo:Lançamento alterado registrado.png|750x500px|nenhum|Lançamento_alterado_registrado]]
 

='''Como realizar a Alteração de Juros do Lançamento já Registrado Open Banking e reenviá-lo novamente?'''=
 

'''Irá surgir a necessidade de realizar a alteração de Juros do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?'''
 
Dado que já temos um Lançamento Financeiro já Registrado Open Banking, basta acessar o Lançamento Financeiro desejado através do caminho do Menu:
 
'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 
'''Regra Sistema para os Juros:'''
 
Se no cadastro do Portador não possuir Comando de Remessa com as novas opções:
 
'''Tipo de Comando =''' Alteração de Juros para Juros
 
'''BANCO SICREDI:''' para este Banco por enquanto atende '''somente''' alteração de Juros para registro Open Banking, não registrando então caso alterado Multas.
 
Ao acessar o Lançamento Financeiro em modo Modificar e alterar o campo '''Juros Dias de''' ou '''Juros Mês de''', automaticamente após alteração dos Juros, o Sistema irá criar essa parametrização do Comando de Remessa com '''sugestão''', sendo passível de alteração, no Cadastro do Portador no botão '''Remessas''' e depois no botão '''Comandos'''.
 
'''Comando sugestão para Juros:'''
 
'''Código Operação =''' ATJ
 
'''Comando =''' ATJ
 
'''Descrição =''' ALTERAÇÃO DE JUROS PARA OPEN BANKING
 
'''Tipo de Comando =''' Alteração de Juros
 
 
<center>'''Cadastro do Portador Comando de Remessa Juros'''
[[Arquivo:Lancto Registrado Alteração Juros Dia 748.png|750x500px|nenhum|Lancto_Registrado_Alteração_Juros_Dia_748]]
 
 

'''Como é identificado a alteração de Juros para Banco?'''
 
Através das tags enviadas para API gravadas no Histórico do Open Banking Dados API:
 
'''instruçãoComando''':'''ALTERACAO_OUTROS_DADOS''' – indica que ocorreu uma alteração de registro no Lançamento.
 
'''complementoInstrucao''': '''JUROS_DIA''' – indica que há Juros no registro.
 
'''valor1''': 0.12, - indica o valor dos Juros.
 
 
<center>'''Lançamento Financeiro a Receber já Registrado alterando os Juros'''
[[Arquivo:Lancto Registrado Alteração Juros Dia.png|750x500px|nenhum|Lancto_Registrado_Alteração_Juros_Dia]]
 
 

Tags enviadas para API Banco:
 
 
<center>'''Dados API Tags referente aos Juros'''
[[Arquivo:Dados API Juros 748.png|750x500px|nenhum|Dados_API_Juros_748]]
 
 

='''Quais são as novidades após atualização para Versão 2 do Open Banking?'''=
 
Disponibilizado a Versão 2 para Open Banking que traz algumas novidades para o processo de Registro no Banco.
 
Nela terá um componente que quando atualizado a Base através do Assistente de Atualização (Atualiza CIGAM) será adicionado nos Parâmetros Open Banking da Configuração de Bancos, especificamente nas Credenciais, o registro '''Versão API''' = v2.
 
'''Finanças > Gestão Financeira > Parâmetros > Configurações de Bancos'''
 
<center>'''Parâmetros Open Banking'''
[[Arquivo:Parametros OP Sicredi Credenciais.png|750x500px|nenhum|Parametros_OP_Sicredi_Credenciais]]
 
A partir desta Versão o Sistema passa a realizar a busca para localizar os títulos da seguinte forma:
 
1- O sistema tenta localizar os títulos pelo Número do Lançamento;
 
2- Caso os títulos tenham sido gerados pelo CIGAM irá localizar pelo '''Nosso Número''', avaliando então a tabela '''GFBOLETOS''' pela coluna '''NOSSO_NRO'''.
 
3- Caso os títulos tenham sido gerados por outro sistema irá localizar pelo '''Nosso Número''', avaliando então a tabela '''GFLAUXIL''' pela coluna '''CODIGO_BARRAS'''.
 
Também nesta versão estão disponíveis as tags para Envio da Série/NF, sendo utilizado a Tag na API '''NumeroTituloBeneficiario'''. A regra é '''Serie''' '''NF''' '''Complemento Duplicata''', bem como descrito com espaços em Branco entre eles. Para verificar esse registro, basta acessar após o Registro no Banco o Histórico Open Banking na guia '''Envio''' e localizar para Tag '''NumeroTituloBeneficiario'''.
 
<center>'''Parâmetros de Convênio Open Banking'''
[[Arquivo:Wizard Passo 3-4 Final Sicredi.png|750x500px|nenhum|Wizard_Passo_3-4_Final_Sicredi]]
 
Atualizado Wizard para Versão 2 do Open Banking, disponibilizando duas opções:
 
'''- Direto''': esta opção tem como finalidade registrar o Boleto no momento da sua geração, ou seja, quando selecionado ativa propriedade ao qual ao gerar o Boleto Bancário o sistema automaticamente envia o registro Open Banking, sem a necessidade de fazer o processo de envio da Remessa Open Banking do título.
 
'''- PIX''': esta opção fica habilitada somente quando selecionado a opção '''Direto''', ela tem como finalidade registrar uma operação PIX para os Boletos emitido de forma Direta (opção '''Direto''' marcado).
 
Esta opção é válida '''SOMENTE''' para o Banco do Brasil.
 
Ao emitir o Boleto do Lançamento o sistema marca as 3 opções:
 
- Boleto Impresso;
 
- Remessa Enviada;
 
- Código de Barras Lido;
 
Outra mudança é no '''Histórico''' Open Banking, ao qual passa criar o registro com '''Status Open Banking''' já '''Registrado'''.
 
Também ao acessar os '''Dados API''' é enviado a tag: "indicadorPix": "S", pois a opção PIX esta selecionada.
 
Disponibilizado o Modelo de Relatório para o Boleto Banco do Brasil já com o QRCode:
 
'''I:\CIGAM\DOC\Modelos_relatorios\Gestão Financeira\Bloquetos Merge\0098_brasil_PIX.rtf'''

='''Como realizar a Baixa de um Lançamento Financeiro Registrado Open Banking e enviar o Registro de Baixa?'''=
 
'''IMPORTANTE:''' O processo de Cancelamento de Notas Fiscais, não atende a baixa automatica dos Boletos, logo deve ser baixado manualmente os registros dos Lançamentos Financeiros.
 
Para realizar o processo de '''Baixa''' de um Lançamento Financeiro que foi registrado via Open Banking, basta acessar o Lançamento Financeiro.
 
'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 
Selecionar a opção de Menu Lateral do Lançamento Financeiro '''Open Banking''' e a opção de '''Baixar'''.
 
<center>'''Lançamento Financeiro Registrado/Baixar'''
[[Arquivo:Opção Baixar Lancto.png|750x500px|nenhum|Opção_Baixar_Lancto]]
 
<center>'''Lançamento Financeiro Confirmando Operação'''
[[Arquivo:Deseja Baixar.png|750x500px|nenhum|Deseja_Baixar]]
 
<center>'''Lançamento Financeiro Baixado com Sucesso'''
[[Arquivo:Baixado Sucesso.png|750x500px|nenhum|Baixado_Sucesso]]
 

='''Como parametrizar para envio Open Banking a Negativação ou Protesto?'''=
 
Basta acessar o Cadastro do Portador e inserir os dias no campo '''Protestar após''' na guia '''Configurações.
 

'''Menu > Finanças > Gestão Financeira > Parâmetros > Portadores'''

 
<center>'''Dias de Protesto Cadastro do Portador'''
[[Arquivo:Cadastro Portador Negativacao Sicredi.png|750x500px|nenhum|Cadastro_Portador_Negativacao_Sicredi]]
 

Banco do Sicredi:
 
Para este Banco a negativação é parametrizada no Cadastro do Portador na guia “Configurações” no campo “Protestar após”, é através deste campo que o sistema reconhece e passa considerar o envio das tags para os dados da API do Banco.
 
'''"numDiasNegativacaoAuto": "07",'''

 

='''Como cadastrar as Mensagens de Retorno API Financeira Sugestão Usuário?'''=
 
As Mensagens de Retorno API Financeira é uma funcionalidade para facilitar a identificar e de orientação para com as mensagens provindas das APIs que o Sistema tem conexão.
 
Elas foram implementadas para Open banking.
 
Para acessar o cadastro basta acessar através do Menu:
 
'''Menu: Finanças > Gestão Financeira > Parâmetros > Mensagens de Retorno API Financeiro'''
 

<center>'''Mensagens de Retorno API Financeiro'''
[[Arquivo:Mensagens Retorno API Financeiro.png|750x500px|nenhum|Mensagens_Retorno_API_Financeiro]]
 

'''Banco:''' código do Banco conforme codificação no orgão que rege os Bancos Febraban.
 
'''Código Erro:''' código do erro conforme layout das APIS dos Bancos.
 
'''Status:''' é o código de Status de erro do Servidor retornado da API dos Bancos. (Código HTTP)
 
'''Descrição do Erro (Banco):''' essa descrição é oriunda do Banco retornada pela API deles.
 
'''Sugestão CIGAM:''' esta mensagem é interna do Sistema, ou seja, quando internamente identificarmos uma situação a qual a Mensagem retornada pelo Banco não é clara, vamos alimentar com Mensagens de sugestão, para orientar as possíveis causas, dando um norte para situação.
 
'''Sugestão Cliente:''' este campo é reservado para o próprio usuário, possibilitando cadastrar Mensagens que ele identificar para facilitar no processo de entendimento das Mensagens de Retorno das APIs.
 
Agora através desta aplicação, quando ocorrer um Erro de Open Banking é possível verificar através dos links dispostos na tela de Lançamento Financeiro no campo Situação Open Banking, terá um link para tabela do erro ocorrido.
 
<center>'''Lançamento Financeiro Mensagens de Retorno API Financeiro'''
[[Arquivo:Mensagens Retorno API Financeiro BB OP.png|750x500px|nenhum|Mensagens_Retorno_API_Financeiro_BB_OP]]
 
Ou também através do Histórico Open Banking:
 
<center>'''Lançamento Financeiro Mensagens de Retorno API Financeiro Histórico Open Banking'''
[[Arquivo:Historico OP Mensagens Retorno API Financeiro BB OP.png|750x500px|nenhum|Historico_OP_Mensagens_Retorno_API_Financeiro_BB_OP]]

GF - Como Fazer - Open Banking para Banco Sicredi

2022-05-12T18:28:46Z

Alan.campos: /* Serviços Disponíveis pela API do Banco nesta Versão? */

[[categoria:Como_Fazer_Finanças]]

='''O que significa Open Banking?'''=

Open Banking é um conceito relativamente novo na realidade do mercado financeiro brasileiro. Porém, ele tem ganhado cada vez mais atenção em todo o mundo.
Traduzido, o termo significa “banco aberto”, mas uma tradução mais precisa seria “sistema financeiro aberto”.
O conceito em si trata de algo de simples compreensão. Basicamente, Open Banking é a defesa de que o sistema financeiro adote a tecnologia de forma mais ampla e padronizada, como forma de incentivar e ampliar a oferta e a qualidade dos produtos e serviços financeiros.
A base do Open Banking está na premissa de que os dados pertencem aos consumidores. Logo, caso eles autorizem, esses dados devem ser disponibilizados para que eles possam ter acesso a produtos e serviços que forem mais convenientes.
Na prática, há um pedido para que as instituições abram suas API’s (sigla em inglês para Interface de Programação de Aplicativos) para que terceiros desenvolvam e aprimorem os sistemas e suas funcionalidades.
O objetivo do Open Banking é desenvolver sistemas integrados, que facilitem o controle e transferência de informações de dados, histórico, contas, empréstimos etc. Todo o tipo de produto e serviço oferecido pelos bancos seria integrado de maneira a evitar processos complicados e dispendiosos.
À primeira vista, pode parecer que com o Open Banking as informações dos clientes ficarão soltas e desprotegidas. No entanto, os bancos e instituições financeiras ainda serão responsáveis pela proteção de dados sigilosos.

='''Serviços Disponíveis pela API do Banco nesta Versão?'''=
'''Menu > Utilidades/Diversos > Genéricos > Parâmetros > Configurações'''
 
<center>
{| class="wikitable"
|-
! SERVIÇO !! COBRANÇA
|-
| Registro de Boleto via API || SIM
|-
| Open Banking PIX no Boleto || NÃO
|-
| Retorno de Cobrança via API || NÃO
|-
| Alteração de Juros via API || SIM
|-
| Alteração de Multa via API || SIM
|-
| Alteração de Vencimento via API || SIM
|-
| Alteração de Baixa via API || SIM
|-
|}
</center>
 

='''Como obter as Credenciais para utilizar a Funcionalidade Open Banking?'''=
 
As credenciais do Banco devem ser obtidas através do contato com o seu Gerente de Cash (Gerente da Conta no Banco).
 
O Banco Sicredi, possui uma nomenclatura interna para esse processo, conhecido como Registro de Cobrança OnLine ou Ecommerce, conforme documentação.
 
Então ao entrar em contato com o Gerente de Cash, validar as nomenclaturas para que haja o entendimento da funcionalidade.
 

='''Quais os Módulos necessários para utilizar a Funcionalidade Open Banking”?'''=

• Módulo Gestão Financeira;

='''Quais são as parametrizações necessárias para utilizar a funcionalidade do Open Banking Banco Sicredi?'''=

'''Itens Importantes na Parametrização:'''
 
'''- Processar retornos pelo número do Boleto:''' esta opção deve estar marcada, pois caso contrário ocorrerá problemas na gravação das informações e envio para Banco.
 
Caso tenha sido realizado movimentações com esta opção desmarcada, não será possível realizar a Baixa, pois sistema não consegue localizar devido não possuir o '''Nosso Número''' gravado nas tabelas envolvidas.
 
Para solucionar essa questão será necessário:
 
'''1-''' Identificar o '''Nosso Número''' do registro a ser baixado (Lançamento Financeiro);
 
'''2-''' Gravar o '''Nosso Número''' nas seguintes tabelas:
 
'''GFBOLETOS:''' campo a ser atualizado '''NOSSO_NRO''' com a informação do Nosso Número.
 
'''GFLAUXIL:''' campo a ser atualizado '''CODIGO_BARRAS''' com a informação do Nosso Número.
 
'''- Processar retornos pelo número do Boleto:''' esta opção deve estar marcada, pois caso contrário ocorrerá problemas na gravação das informações e envio para Banco.
 
 
'''Importante preenchimento Telefone''': o não preenchimento do Telefone no Cadastro de Empresa acarretará em Erro no Registro Open Banking. Não é um item obrigatório, porém o Banco Sicredi para registrar necessita o preenchimento deste dado. Não deve ser utilizado espaços ou caracteres especiais.
 
Para utilizar esta funcionalidade é necessário possuir o Cadastro do Portador para o Banco citado.
O cadastro quando preenchido corretamente garante que não ocorrerá inconsistências no momento do registro do Open Banking.
 
Como boa prática de implementação é mais coerente criar um novo Portador para Open Banking evitando assim de alterar o Portador utilizado para CNAB caso necessite realizar algum processo via remessa ou retorno, quando a API do Banco estiver com instabilidade.
 
Essa parametrização deverá validar os últimos Sequenciais da numeração de Boletos do Portador utilizado para as Remessas, pois assim garante que não ocorrerá conflito enviar uma numeração de Título já registrado.
 
 
Itens importantes na parametrização:
 
- '''Nº Banco''';
 
- '''Nº Conta''';
 
- '''Nº Convênio''';
 
- '''Agência/DV''': o DV da Agência é considerado o '''Posto''' da Agência, ou seja, para adquirir essa informação o Banco da Unidade da Agência deve fornecer.
 
Quando se tratar do Portador Open Banking do SICREDI, o campo '''DV''' da Agência deve ser preenchido conforme a Unidade da Agência do Banco.
 
- '''Código Cedente''';
 
Para o correto funcionamento da rotina é necessário que os dados do Portador esteja com todas informações necessárias, inclusive o Convênio.
 
'''Menu > Finanças > Gestão Financeira > Parâmetros > Portadores'''
 
Este cadastro é apenas uma demonstração de parametrização:
 
<center>'''Cadastro de Portador'''
[[Arquivo:Cadastro Portador Principal.png|750x500px|nenhum|Cadastro_Portador_Principal]]
 
<center>'''Guia CNAB'''
[[Arquivo:Cadastro Portador CNAB Sicredi.png|750x500px|nenhum|Cadastro_Portador_CNAB]]
 

Campo "Especie" quando utilizado Open Banking deve ser = A para Duplicata Mercantil.

<center>'''Guia Configurações'''
[[Arquivo:Cadastro Portador Configurações Sicredi.png|750x500px|nenhum|Cadastro_Portador_Configurações_Sicredi]]
 

'''Irá surgir a necessidade de realizar a alteração de Vencimento, Multa ou Juros do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?'''
 
Regra Sistema para Vencimento, Multa ou Juros:
 
Cadastro do Portador deve possuir Comando de Remessa com as novas opções:
 
'''Tipo de Comando =''' Alteração de Vencimento (para alteração de Vencimento).
 
'''Tipo de Comando =''' Alteração de Multa para Multa (para alteração de Multa).
 
'''Tipo de Comando =''' Alteração de Juros para Juros (para alteração de Juros).
 
Caso não seja parametrizado neste primeiro momento as opções de Multa e Juros o sistema cria automaticamente (Somente Juros e Multa).
 
Ao acessar o Lançamento Financeiro em modo Modificar e alterar o campo Multa de ou Juros de, automaticamente após alteração da Multa, o Sistema irá criar essa parametrização do Comando de Remessa com sugestão, sendo passível de alteração, no Cadastro do Portador no botão Remessas e depois no botão Comandos.
 
'''Comando sugestão para Multa:'''
 
'''Código Operação''' = ATM
 
'''Comando''' = ATM
 
'''Descrição''' = ALTERAÇÃO DE MULTA PARA OPEN BANKING
 
'''Tipo de Comando''' = Alteração de Multa
 
'''Comando sugestão para Juros:'''
 
'''Código Operação''' = ATJ
 
'''Comando''' = ATK
 
'''Descrição''' = ALTERAÇÃO DE JUROS PARA OPEN BANKING
 
'''Tipo de Comando''' = Alteração de Juros
 
<center>'''Botão Remessas > Comandos'''
[[Arquivo:Cadastro Portador Comando Remessa.png|750x500px|nenhum|Cadastro_Portador_Comando_Remessa]]
 
<center>'''Botão Retornos > Códigos de Retorno'''
[[Arquivo:Cadastro Portador Codigo Retorno.png|750x500px|nenhum|Cadastro_Portador_Codigo_Retorno]]
 
Para iniciar a configuração através do “Assistente de Parâmetros do Open Banking”, basta selecionar o botão “Open Banking”:
 
'''Menu > Finanças > Gestão Financeira > Parâmetros > Configuração de Bancos'''
 
 
<center>'''Configurações de Banco'''
[[Arquivo:Cadastro Configuraçao Banco.png|750x500px|nenhum|Cadastro_Configuraçao_Banco]]
 
 
Para dar início ao processo de parametrização, basta selecionar o botão “Avançar”:
 
 

='''Tela Inicial Configuração do Assistente Open Banking:'''=
 
Para iniciar a configuração é necessário ter em mãos os seguintes dados: (Código de Acesso).
Sem essas informações não será possível dar continuidade na parametrização do Open Banking para o Banco do Sicredi.
 
<center>'''Tela Inicial Assistente de Parâmetros Open Banking'''
[[Arquivo:Wizard Bem Vindo.png|750x500px|nenhum|Wizard_Bem_Vindo]]
 


=='''Etapa 1 (Parâmetros: Passo 1 de 4):'''==


Uma das etapas mais importantes e que requer um cuidado maior e sigilo das informações nesta parametrização.
 
Essas informações são disponibilizadas pelo Banco a qual deve ser restrita somente a pessoa responsável pelo setor Financeiro da Empresa.
 
O assistente tem como objetivo proporcionar que o próprio usuário tenha autonomia para executar esse passo a passo sem necessidade de passar essas informações restritas da Empresa para qualquer pessoa que não seja ele mesmo.
 
Reforçando, mesmo que tenha dificuldades para executar esta etapa, não repasse nenhuma informação relacionado aos acessos dos tokens.
 
Dados em mãos para informar os respectivos campos, basta copiar e colar as informações.
 
Código de Acesso.
 
O Campos '''Código de Acesso''' possui uma tecnologia de criptografia, ou seja, após informar os dados nos campos o sistema irá criptografar as informações garantindo e mantendo a segurança das informações.
 
Caso haja necessidade de alterações, basta clicar no ícone do "Cadeado", será aberta a tela de Criptografia e após colar ou digitar as informações em tela e selecionar o botão "Confirmar".
 
Também tenha alguma dúvida no dado informado e necessitar validar o dado seguindo os mesmos passos da alteração será aberta a tela de Criptografia e após colar ou digitar as informações em tela e selecionar o botão "Validar", sistema confirma se os dados são os mesmos.
 
Observamos que esta tela possui duas guias, uma de Homologação e Produção. Preencher conforme a necessidade do processo, caso precise realizar testes, parametrize em homologação e posteriormente parametrize o de Produção ou se preferir, pode preencher os dois se possuir os dados.
 
Lembrando que esses dados são confidenciais de uso e exclusivo de cada usuário.
 
Através dessas informações o sistema irá se comunicar com API do Banco para poder realizar os registros dos Lançamentos.
 
Após informado os dados, basta selecionar o botão "Avançar", para seguir os próximos passos.
 
'''Código de Acesso:''' informar a codificação passada pelo Banco.
 
 
<center>'''Parâmetros: Passo 1 de 4'''
[[Arquivo:Wizard Passo 1 Sicredi.png|750x500px|nenhum|Wizard_Passo_1_Sicredi]]
 

=='''Etapa 2 (Portador de Remessa e Retorno - Pagamento: Passo 2 de 4):'''==

Nesta etapa deve ser selecionado o Portador que será considerado para o envio da Remessa de Pagamento (onde estarão os boletos em aberto) e nesta mesma tela informar o qual Portador será considerado para o Retorno de Pagamento (onde serão liquidados os retornos de Pagamentos).
 
Nesta etapa, é possível pular, caso não utilize ainda o Envio de Pagamentos do Open Banking.
 
'''Pular:''' caso deseja pular essa etapa e prosseguir com o processo de parametrização do Open Banking.
 
'''Avançar:''' dá continuidade ao processo de parametrização, após selecionado uma opção.
 
Para continuar a parametrização selecione o botão "Pular" e siga para os próximos passos.
 
<center>'''Portador de Remessa e Retorno: Passo: 2 de 4'''
[[Arquivo:Wizard Passo 2 Sicredi.png|750x500px|nenhum|Wizard_Passo_2_Sicredi]]
 

=='''Etapa 3 (Convênios de Cobrança: Passo 3 de 4):'''==
 
Nesta etapa o sistema avalia sua base de dados, e localiza os Convênios parametrizados para o Banco Sicredi, onde serão listados.
O sistema possibilita a parametrização de Convênios específicos bem como caso seja optado, selecionando o botão "Pular" o sistema criará automaticamente o Convênio "Geral", ao qual utiliza dados do Portador registrado.
 
'''Pular:''' caso deseja pular essa etapa e prosseguir com o processo de parametrização do Open Banking.
 
'''Avançar:''' dá continuidade ao processo de parametrização, após selecionado uma opção.
 
<center>'''Convênios de Cobrança: Passo 3 de 4'''
[[Arquivo:Wizard Passo 3 Sicredi.png|750x500px|nenhum|Wizard_Passo_3_Sicredi]]
 

=='''Etapa 3 (Portador de Remessa e Retorno - Cobrança: Passo 3 de 4):'''==
 
Nesta etapa deve ser selecionado o Portador que será considerado para o envio da Remessa de Cobrança (onde estarão os boletos em aberto) e nesta mesma tela informar o qual Portador será considerado para o Retorno de Cobrança (onde serão liquidados os retornos de Cobranças).
 
'''Avançar:''' dá continuidade ao processo de parametrização, após selecionado uma opção.
 
<center>'''Portador de Remessa e Retorno - Cobrança: Passo 3 de 4'''
[[Arquivo:Wizard Passo 3-4 Final Sicredi.png|750x500px|nenhum|Wizard_Passo_3-4_Final_Sicredi]]
 
Atualizado Wizard para Versão 2 do Open Banking, disponibilizando duas opções:
 
'''- Direto:''' esta opção tem como finalidade registrar o Boleto no momento da sua geração, ou seja, quando selecionado ativa propriedade ao qual ao gerar o Boleto Bancário o sistema automaticamente envia o registro Open Banking, sem a necessidade de fazer o processo de envio da Remessa Open Banking do título.
 
Também quando selecionada, terá uma particularidade na questão da Emissão de Boletos em lote pela Rotina de Emissão de Boletos Personalizados. A rotina na guia '''Opções''' tem a opção '''Enviar somente Lançamentos não marcados e marca-los''', caso esteja desmarcada o Registro Open Banking ocorrerá da mesma forma que o sistema irá marcar a opção '''Boleto Impresso''' do Lançamento Financeiro, registrando a Operação Open Banking.
Isso ocorre para manter a integridade, já que esta operação é considerada única no registro, sendo então necessário marcar a '''Boleto Impresso''', para poder conseguir realizar alterações como Alteração de Vencimento ou mesmo a Baixa, sendo uma condição de Sistema.
 
'''- PIX''': esta opção tem como finalidade registrar uma operação PIX para os Boletos emitido de forma Direta (opção '''Direto''' marcado).
 
Esta opção é válida '''SOMENTE''' para o Banco do Brasil.
 

=='''Etapa 4 (Relatório: Passo 4 de 4):'''==

 
Nesta etapa o sistema irá buscar automaticamente o Modelo de Relatório Padrão, caso exista no ambiente, facilitando assim todo processo de parametrização e implementação para usuário.
 
A busca é realizado '''(%CIGAM_INSTAL%RF00071_remessas.RTF)''', com isso é importante que o Modelo de Relatório (RF00071_remessas.RTF) esteja devidamente localizado na pasta padrão do Cigam_Instal, como por exemplo:
 
'''%CIGAM_INSTAL%''' = P:\Cigam11\Projects\Controle\MACIEL\Financeiro_Open_Banking
 
"P:\Cigam11\Projects\Controle\MACIEL\Financeiro_Open_Banking\Modelos\Relatorios\Gestao Financeira\RF00071_remessas.RTF"
 
Clicar em "Avançar" para dar seguimento.
 
<center>'''Assistente de Parâmetros Open Banking: Passo 4 de 4'''
[[Arquivo:Wizard Passo 4-4 Relat Sicredi.png|750x500px|nenhum|Wizard_Passo_4-4_Relat_Sicredi]]
 
 

=='''Etapa Conclusão (Parâmetros de Convênio Open Banking - Conclusão):'''==

 
Esta etapa o sistema faz validação da comunicação com o Banco através da API verificando o ambiente se esta tudo ok, listando em tela.
 
Após a consulta estar "OK", basta clicar no botão "Concluir" e seu ambiente estará apto para utilizar a funcionalidade Open Banking.
 
<center>'''Parâmetros de Convênio Open Banking: Passo Final - Conclusão'''
[[Arquivo:Wizard Passo Final Conclusao Conexao Sicredi.png|750x500px|nenhum|Wizard_Passo_Final_Conclusao_Conexao_Sicredi]]
 
'''Homologação:''' Conexão realizada com sucesso.
 
'''Produção:''' Conexão realizada com sucesso.
 
O servidor remoto retornou um erro: (401) Não Autorizado. Isso ocorre quando não houve a parametrização dos dados em Produção como foi realizado no ambiente de Homologação conforme o passo a passo, ou possa ter ocorrido algum erro na comunicação com o Banco.
 
<center>'''Convênio Cadastrado com Sucesso - Cobrança'''
[[Arquivo:Parametros OP Sicredi.png|750x500px|nenhum|Parametros_OP_Sicredi]]
 
'''Ambiente:''' lista qual é o ambiente cadastrado, sendo apenas duas opções: Homologação e Produção.
 
'''Convênios:''' neste grupo serão listados todos os convênios cadastrados, bem como todas informações pertinentes como:
 
- Portador;
 
- Agência;
 
- Número Conta;
 
- Portador de retorno;
 
'''- Direto:''' esta opção tem como finalidade registrar o Boleto no momento da sua geração, ou seja, quando selecionado ativa propriedade ao qual ao gerar o Boleto Bancário o sistema automaticamente envia o registro Open Banking, sem a necessidade de fazer o processo de envio da Remessa Open Banking do título.
 
'''- PIX:''' esta opção fica habilitada somente quando selecionado a opção Direto, ela tem como finalidade registrar uma operação PIX para os Boletos emitido de forma Direta (opção Direto marcado).
 
Esta opção é válida SOMENTE para o Banco do Brasil.
 
Ao emitir o Boleto do Lançamento o sistema marca as 3 opções:
 
- Boleto Impresso;
 
- Remessa Enviada;
 
- Código de Barras Lido;
 
'''U.N Ced.:''' esta opção tem como finalidade possibilitar o envio e registro de Boletos de outras Unidades de Negócio.
 
Basta informar a Unidade desejada no campo e o sistema entenderá quando realizado o processo de registro de um título que não seja da Unidade Matriz, então sistema identifica e realiza o processo de envio e registro.
Se deixar em Branco a Unidade Cedente irá considerar para todas Unidades de Negócio.
 
 
<center>'''Convênio Cadastrado com Sucesso - Pagamento'''
[[Arquivo:Parametros OP Sicredi Pagamento.png|750x500px|nenhum|Parametros_OP_Sicredi_Pagamento]]
 
'''Ambiente:''' lista qual é o ambiente cadastrado, sendo apenas duas opções: Homologação e Produção.
 
'''Convênios:''' neste grupo serão listados todos os convênios cadastrados, bem como todas informações pertinentes como:
 
- Portador;
 
- Agência;
 
- Número Conta;
 
- Portador de retorno;
 
<center>'''Ícone Credenciais'''
[[Arquivo:Parametros OP Sicredi Credenciais.png|750x500px|nenhum|Parametros_OP_Sicredi_Credenciais]]
 
Através deste ícone é possível verificar os Parâmetros API parametrizados, tanto em homologação quanto em produção.
 
 
<center>'''Ícone Endereços'''
[[Arquivo:Parametros OP Sicredi Endereços.png|750x500px|nenhum|Parametros_OP_Sicredi_Endereços]]
 
Através deste ícone é possível verificar todos endereços de URLs parametrizados.

='''O que significa a Categoria Open Banking de acesso?'''=
 
 A Categoria Open Banking é uma Categoria que é habilitada mediante a utilização de um Portador parametrizado com as Configurações de Banco Open Banking. A mesma tem como objetivo proporcionar maior agilidade e gerenciamento das atividades relacionadas a Remessa de Cobrança Online.
 
'''Categoria Open Banking'''
 
 
<center>'''Categoria Open Banking'''
[[Arquivo:Categoria Open Banking.png|750x500px|semmoldura|nenhum|Categoria_Open_Banking]]
 
 

'''Registrar:''' item de categoria tem como funcionalidade registrar o Boleto Bancário Online. Substitui todo o processo de geração do arquivo de Remessa de Cobrança, acessar o site e remeter ao Banco esse arquivo, com apenas um clique na opção.
 
'''Reenviar:''' item de categoria tem como funcionalidade possibilitar o reenvio de registros que estão com alguma pendência ou algum erro de parametrização. Será habilitado somente quando já possuir movimento de "Registro" enviado, cuja Situação estiver com pendência ou erro.
 
'''Baixar:''' item de categoria tem como funcionalidade comunicar o Banco referente a Baixa do movimento em questão do Boleto Bancário. Utilizado para eventuais falhas operacionais, como registrado um movimento por engano, ou negociações diretamente com cliente a parte. Eliminando então também todo processo de geração do arquivo de Remessa Bancária com Comando de Remessa de Baixa e o processo de remeter ao Banco o arquivo, sendo realizado tudo online através desta opção.
 
'''Registrar Alteração:''' item de categoria tem como funcionalidade registrar uma alteração ocorrida referente ao "Vencimento" do Lançamento Financeiro.
Ao realizar alteração da Data de Vencimento do Lançamento Financeiro que está com "Situação Open Banking" igual "Registrado" e ocorrer alteração no Vencimento, o sistema emite uma mensagem possibilitando já o envio da alteração no momento ou mais tarde através desta opção de "Registrar Alteração".
 
'''Histórico:''' item de categoria tem como funcionalidade gravar todas movimentações realizadas relativo ao Open Banking. Registros, Baixas, Erros...

='''Layout e Detalhamento de Campos API'''=
==Registro de Boletos==
<center>

{| class="wikitable"
|-
! Nº !! Campo JSON !! Descriçao do Banco !! Campo CIGAM !! Tabela !! Obrigatório !! Observações
|-
| 1 || token || Chave Transacional gerada pelo recurso /autenticacao || || || Obrigatório ||
|-
| 2 || Content-Type || Estabelece o tipo de conteúdo da requisição || || || Obrigatório ||
|-
| 3 || agencia || Código da Cooperativa do beneficiário || Agência || Portador || Obrigatório ||
|-
| 4 || posto || Código do Posto do beneficiário || Dígito Agência || Portador || Obrigatório ||
|-
| 5 || cedente || Código do Convênio de Cobrança do beneficiário || Código Cedente || Portador || Obrigatório ||
|-
| 6 || nossoNumero* || Nosso Número || Nosso Número || Boletos || Opcional ||
|-
| 7 || codigoPagador || Código Pagador || Não Tratado || Não Tratado || Opcional ||
|-
| 8 || tipoPessoa* || Tipo de pessoa do pagador.
'''Domínio:'''
 
1 - PESSOA FÍSICA
 
2 - PESSOA JURÍDICA
|| Pessoa || Empresa || Obrigatório ||
|-
| 9 || cpfCnpj* || CPF ou CNPJ do pagador || CNPJ/CPF || Empresa || Obrigatório ||
|-
| 10 || nome || Nome do pagador || Nome Completo || Empresa || Obrigatório ||
|-
| 11 || endereco || Endereço do pagador || Endereço || Empresa || Opcional || Será obrigatório se o código do pagador '''não''' for informado.
|-
| 12 || cidade || cidade || Município || Empresa || Opcional || Será obrigatório se o código do pagador '''não''' for informado.
|-
| 13 || uf || Estado do pagador || UF || Empresa || Opcional || Será obrigatório se o código do pagador '''não''' for informado.
|-
| 14 || cep || CEP do pagador || CEP || Empresa || Obrigatório ||
|-
| 15 || telefone || Telefone mais DDD do pagador || Fone || Empresa || Opcional || Será obrigatório se o código do pagador '''não''' for informado.
|-
| 16 || email || Endereço de email do pagador || Email || Contato || Opcional ||
|-
| 17 || especieDocumento || Espécie de documento do título.(*) || Espécie || Portador || Obrigatório ||
|-
| 18 || codigoSacadorAvalista || Código do sacador avalista. || Não Tradado || Não Tradado || Opcional ||
|-
| 19 || seuNumero || Número de controle interno do beneficiário que referencia o pagador. || Lançamento || LANCAM || Obrigatório ||
|-
| 20 || dataVencimento || Data de vencimento do boleto || Vencimento || Boletos || Obrigatório ||
|-
| 21 || valor || Valor do boleto || Saldo || LANCAM || Obrigatório ||
|-
| 22 || tipoDesconto || Tipo de desconto.
'''Domínios:'''
 
A - VALOR
 
B - PERCENTUAL
|| Não Tratado || Não Tratado || Obrigatório ||
|-
| 23 || valorDesconto1 || Valor de desconto 1 || Valor Desconto || LANCAM || Opcional || Será obrigatório se o dataDesconto1 for informado.
|-
| 24 || dataDesconto1 || Data limite para concessão de desconto1 || Vencimento || LANCAM || Opcional || Será obrigatório se o valorDesconto1 for informado. Não pode ser igual a outras dataDescontos e nem maior que vencimento.
|-
| 25 || valorDesconto2 || Valor de desconto 2 || Não Tratado || Não Tratado || Opcional || Será obrigatório se o dataDesconto2 for informado.
|-
| 26 || dataDesconto2 || Data limite para a concessão de desconto 2 || Não Tratado || Não Tratado || Opcional || Será obrigatório se o valorDesconto2 for informado. Não pode ser igual a outras dataDescontos e nem maior que vencimento.
|-
| 27 || valorDesconto3 || Valor de desconto 3 || Não Tratado || Não Tratado || Opcional || Será obrigatório se o dataDesconto3 for informado.
|-
| 28 || dataDesconto3 || Data limite para a concessão de desconto 3 || Não Tratado || Não Tratado || Opcional || Será obrigatório se o valorDesconto3 for informado. Não pode ser igual a outras dataDescontos e nem maior que vencimento.
|-
| 29 || tipoJuros || Tipo de Juros.
'''Domínios:'''
 
A - VALOR
 
B - PERCENTUAL
|| || || Obrigatório ||
|-
| 30 || juros || Valor de juros a cobrar por dia. || Juros Dia || LANCAM || Opcional ||
|-
| 31 || multas || Percentual de multa a cobrar || Valor Multa || LANCAM || Opcional ||
|-
| 32 || desconto Antecipado || Valor de desconto antecipado a cobrar || Não Tratado || Não Tratado || Opcional || Deve ser menor que o valor.
|-
| 33 || informativo || Texto do Informativo || Não Tratado || Não Tratado || Opcional ||
|-
| 34 || mensagem* || Texto da linha da mensagem || Não Tratado || Não Tratado || Opcional ||
|-
| 35 || codigoMensagem || Código da mensagem || Não Tratado || Não Tratado || Opcional ||
|-
| 36 || numDiasNegativacaoAuto || Número de dias para Negativação Automática. 0 (Zero) para não negativar automaticamente. Quando preenchido com 3 ou 4 dias o sistema comandará negativação em dias úteis após o vencimento. Quando preenchido acima de 4 dias, o sistema comandará negativação em dias corridos após o vencimento. || Protesto || Portador || Opcional ||
|-
| 37 || NomeBeneficiarioFinal || NomeBeneficiarioFinal || Não Tratado || Não Tratado || Obrigatório caso informado TipoPessoaBeneficiarioFinal e CpfCnpjBeneficiarioFinal ||
|-
| 38 || TipoPessoaBeneficiarioFinal || Tipo de pessoa.
'''Domínios:'''
 
1 - Física
 
2 - Jurídica
|| Não Tratado || Não Tratado || Obrigatório caso informado NomeBeneficiarioFinal e CpfCnpjBeneficiarioFinal ||
|-
| 39 || CpfCnpjBeneficiarioFinal || CPF/CNPJ do beneficiário final || Não Tratado || Não Tratado || Obrigatório caso informado NomeBeneficiarioFinal e TipoPessoaBeneficiarioFinal ||
|-
| 40 || FoneBeneficiarioFinal || Fone do beneficiário final || Não Tratado || Não Tratado || Opcional ||
|-
| 41 || EnderecoBeneficiarioFinal || Endereço do beneficiário final || Não Tratado || Não Tratado || Opcional ||
|-
| 42 || CepBeneficiarioFinal || CEP do beneficiário final || Não Tratado || Não Tratado || Opcional ||
|-
| 43 || CidadeBeneficiarioFinal || CidadeBeneficiarioFinal || Não Tratado || Não Tratado || Opcional ||
|-
| 44 || UfBeneficiarioFinal || UF do beneficiário final || Não Tratado || Não Tratado || Opcional ||
|-
|}

</center>

'''(*) Domínios:'''
 
A - DUPLICATA MERCANTIL (DM)
 
B - DUPLICATA RURAL (DR)
 
C - NOTA PROMISSORIA (NP)
 
D - NOTA PROMISSORIA RURAL (NR)
 
E - NOTA DE SEGURO (NS)
 
G - RECIBO (RC)
 
H - LETRA DE CAMBIO (LC)
 
I - NOTA DE DEBITO (ND)
 
J - DUPLICATA DE SERVICO (DS)
 
K - OUTROS (OS)
 
O - BOLETO OFERTA (OFE)

==Alteração de Boletos==
<center>

{| class="wikitable"
|-
! Nº !! Campo JSON !! Descriçao do Banco !! Campo CIGAM !! Tabela !! Obrigatório !! Observações
|-
| 1 || agencia || Agência do Beneficiário || Agência || Portador || Obrigatório ||
|-
| 2 || posto || Posto do Beneficiário || Dígito Agência || Portador || Obrigatório ||
|-
| 3 || cedente || Código do Beneficiário || Código Cedente || Portador || Obrigatório ||
|-
| 4 || nossoNumero* || Nosso Número do Título || Nosso Número || Boletos || Obrigatório ||
|-
| 5 || instrucaoComando || Comando que será realizado na alteração do boleto. || || || Obrigatório || Caso seja informado ALTERACAO_OUTROS_DADOS será '''obrigatória''' a inclusão do campo complementoInstrucao.
|-
| 5.1 || PEDIDO_BAIXA || || || || Obrigatório || Consultar o Termo de Adesão com sua Unidade de Atendimento Sicredi p/ ver se está com Baixa Automática de boletos vencidos. Caso esteja, o boleto vencido terá sua baixa efetuada automaticamente.
|-
| 5.2 || CONCESSAO_ABATIMENTO || || || || Obrigatório ||
|-
| 5.3 || CANCELAMENTO_ABATIMENTO_CONCEDIDO || || || || Obrigatório ||
|-
| 5.4 || ALTERACAO_VENCIMENTO || || || || Obrigatório ||
|-
| 5.5 || ALTERACAO_SEU_NUMERO || || || || Obrigatório ||
|-
| 5.6 || PEDIDO_PROTESTO || || || || Obrigatório || Somente em título vencido. Por padrão, todos os boletos emitidos pelo EComm-API, não são protestados.
|-
| 5.7 || SUSTAR_PROTESTO_BAIXAR _TITULO || || || || Obrigatório ||
|-
| 5.8 || SUSTAR_PROTESTO_MANTER_CARTEIRA || || || || Obrigatório ||
|-
| 5.9 || ALTERACAO_OUTROS_DADOS || || || || Obrigatório ||
|-
| 6 || complementoInstrucao || Complemento do comando que será realizado na alteração do boleto || || || Condicional ||
|-
| 6.1 || DESCONTO || || || || Condicional ||
|-
| 6.2 || JUROS_DIA || || || || Condicional ||
|-
| 6.3 || DESCONTO_DIA_ANTECIPACAO || || || || Condicional ||
|-
| 6.4 || DATA_LIMITE_CONCESSAO_DESCONTO || || || || Condicional ||
|-
| 6.5 || CANCELAMENTO_PROTESTO _AUTOMATICO || || || || Condicional ||
|-
| 6.6 || CANCELAMENTO_NEGATIVACAO_AUTOMATICA || || || || Condicional ||
|-
| 7 || ''Campo de Alteração'' || Nome do campo que deseja mudar || || || Obrigatório ||
|-
|}

</center>

='''Como realizar a criação de Lançamentos utilizando a funcionalidade Open Banking?'''=
 
Para a criação de Lançamentos Financeiros acessar o caminho de Menu:
 

'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 

Acessar o botão “Criar” e informar os dados necessários para a criação do Lançamento Financeiro a Receber utilizando o Portador parametrizado para Open Banking.
 
 
'''1- Etapa criação do Lançamento:'''
 
 
<center>'''Criação do Lançamento Financeiro a Receber'''
[[Arquivo:Create Lanc Open Banking.png|750x500px|semmoldura|nenhum|Criação do Lançamento Financeiro]]
 
 

'''2- Etapa Impressão do Boleto Bancário do Lançamento Financeiro:'''
 
Nesta etapa pode ser realizado a impressão do Boleto Bancário diretamente pelo próprio Lançamento Financeiro ou através da rotina de Emissão em lote "Emissão de Boletos Personalizados":
 
 
<center>'''Impressão do Boleto Bancário do Lançamento Financeiro'''
[[Arquivo:Imprimir Boleto Lanc.png|750x500px|semmoldura|nenhum|Impressão Boleto Bancário]]
 
 

'''3- Etapa do Registro do Boleto Open Banking:'''
 
Nesta etapa pode ser realizado o "Registro" do Boleto diretamente pelo próprio Lançamento Financeiro ou através da rotina de Emissão em lote "Emissão de Boletos Personalizados":
Basta acessar a Categoria "Open Banking" e selecionar o Item de Categoria "Registrar".
Sistema irá realizar a comunicação através das parametrizações realizadas das Urls e Tokens de acesso e listará a situação do Registro do Boleto Bancário através do Relatório.
 
 
<center>'''Registrar Boleto Open Banking através Lançamento Financeiro'''
[[Arquivo:Boleto Impresso Registrar OP.png|750x500px|semmoldura|nenhum|Registro Boleto Open Banking]]
 
 
<center>'''Relatório Remessa Bancária OnLine'''
[[Arquivo:Relat Registro Open Banking.png|750x500px|semmoldura|nenhum|Relatório Remessa Bancária Online]]
 
 
Após o registro automaticamente o sistema marca as opções de:
 
- Remessa Enviada
 
- Códigos de Barras Lido
 
 
<center>'''Boleto Bancário Registrado'''
[[Arquivo:Lanc Registrado Validar Historico.png|750x500px|semmoldura|nenhum|Lanc_Registrado_Validar_Historico]]
 
 
Para verificar todas as movimentações realizada sobre Open Banking, elas estão sendo gravadas no Item de Categoria "Histórico" que fica na Categoria "Open Banking".
Ao selecionar o Item de Categoria "Histórico" deve listar o Registro do Boleto Bancário.
 
 
<center>'''Item de Categoria Histórico de Movimentos Open Banking'''
[[Arquivo:Item Categoria Historico.png|750x500px|semmoldura|nenhum|Item_Categoria_Histórico]]
 
 

='''Como realizar o Envio em Lote Open Banking através da rotina Remessa de Cobrança Open Banking?'''=

Assim como é possível realizar o Envio do Registro do Boleto Bancário através do próprio Lançamento Financeiro, existe a possibilidade de realizar esse processo em Lote, quando se tratar de vários registros a serem enviados.
Através do Menu:
 
 
'''Menu: Finanças > Gestão Financeira > Rotinas > EDI> Transmite > Remessa Cobranças Bancárias > Remessa de Cobrança Open Banking'''
 
 
<center>'''Remessa de Cobrança Open Banking'''
[[Arquivo:Remessa_de_Cobranca_Open_Banking_BB3.png|750x500px|semmoldura|nenhum|Remessa_de_Cobranca_Open_Banking]]
 
 
Esta rotina tem um conceito muito simples em relação aos filtros, foram disponibilizados campos essências que permitem ter uma rastreabilidade dos movimentos.

'''Unidade de Negócio:''' informe a Unidade de Negócio desejada para realizar o filtro para busca dos movimentos.
 
'''Data:''' informe a Data desejada para realizar o filtro para busca dos movimentos.
 
'''Vencimento:''' informe o período de Vencimento desejado para realizar o filtro para busca dos movimentos.
 
'''Lançamento:''' informe a faixa de Lançamentos desejada para realizar o filtro para busca dos movimentos.
 
'''Tipo de Pagamento:''' informe o Tipo de Pagamento desejado para realizar o filtro para busca dos movimentos.
 
'''Série:''' informe a Série desejada para realizar o filtro para busca dos movimentos.
 
'''Nota Fiscal:''' informe a faixa de Nota Fiscal desejada para realizar o filtro para busca dos movimentos.
 
'''Conta Financeira:''' informe a Conta Financeira desejada para realizar o filtro para busca dos movimentos.
 
'''Empresa:''' informe a faixa de Empresa desejada para realizar o filtro para busca dos movimentos.
 
'''Cobrança:''' informe a faixa de Empresa de Cobrança desejada para realizar o filtro para busca dos movimentos.
 
 
Após informado os filtros e confirmado a operação da rotina o sistema gera um relatório com a listagem dos movimentos.
Na coluna "Registro", será listado se houve a confirmação ou ocorreu algum erro.
 
 
<center>'''Relatório Remessa de Cobrança Open Banking'''
[[Arquivo:Relat Remessa Bancaria Open Banking.png|750x500px|semmoldura|nenhum|Relat_Remessa_Bancaria_Open_Banking]]
 
 

='''Como realizar a alteração de Vencimento do Lançamento já Registrado Open Banking e reenviá-lo novamente?'''=
 

Irá surgir a necessidade de realizar a alteração do Vencimento do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?
 
'''Dado que''' já temos um Lançamento Financeiro já Registrado Open Banking, basta acessar o Lançamento Financeiro desejado através do caminho do Menu:
 
'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 
Acessar o Lançamento Financeiro em modo Modificar e alterar o campo "Venc.Original", automaticamente após alteração do Vencimento, o sistema insere o Comando "05" no campo "Comando de Remessa" e diante disso já emite uma mensagem:
 
'''Confirma o envio da alteração do título ao banco?'''
 
'''Importante:''' para o envio da alteração do Vencimento o sistema já considera o campo '''Vencimento''', caso seja utilizado a '''Modalidade''' como '''Seguinte''' por exemplo, onde é possível ter um Vencimento Original diferente do Vencimento.
 
<center>'''Lançamento Financeiro a Receber já Registrado'''
[[Arquivo:AlterarVenc Lanc1.png|750x500px|nenhum|AlterarVenc_Lanc1]]
 
 
Vencimento alterado, sistema insere o Comando "05" no campo "Comando de Remessa" e ao salvar o registro é emitido a mensagem: "Confirma o envio da alteração do título ao banco?"
 
<center>'''Vencimento alterado e registro salvo'''
[[Arquivo:Vencimento Alterado Msn.png|750x500px|nenhum|Vencimento_Alterado_Msn]]
 
'''Sim:''' é enviado o registro de alteração do Open Banking e se registrado com sucesso, sistema retira então o Comando de Remessa.
 
<center>'''Processo Concluído com Sucesso'''
[[Arquivo:Processo_Concluido_Sucesso_Lanc.png|750x500px|nenhum|Processo_Concluido_Sucesso_Lanc]]
 
Há possibilidades do tempo de comunicação com API do Banco não retornar imediatamente a confirmação do recebimento da Alteração do Vencimento. Quando ocorrer essa situação, sistema emite uma mensagem, solicitando aguardar, para tentar novamente o envio da alteração do vencimento.
Quando ocorrer essa situação, será necessário aguardar e após realizar o envio novamente ou através do próprio Lançamento ou através da rotina de Remessa de Cobrança - Open Banking, que remeterá as alterações para o Banco.
<center>'''Processo Pendente Alteração - Aguardar'''
[[Arquivo:Alteração Vencimento Processo Pendente Envio Aguardar.png|750x500px|nenhum|Alteração_Vencimento_Processo_Pendente_Envio_Aguardar]]
 
Já quando selecionado a opção '''Não''':
 
'''Não:''' não faz a comunicação do envio da alteração do vencimento via Open Banking. Este registro não foi notificado, logo será necessário realiza-lo através do próprio Lançamento ou através da rotina de Remessa de Cobrança Open Banking.
 
No Lançamento Financeiro é habilitado o botão "Reenviar Registro" no Item de Categoria "Open Banking".
Quando selecionado o botão '''Registrar Alteração''', sistema faz a comunicação via Open Banking e registra alteração de vencimento realizada.
 
<center>'''Lançamento Não Registrado a alteração de Vencimento com o Comando de Remessa'''
[[Arquivo:Botao Registrar Alteracao Habilitado.png|750x500px|nenhum|Botao_Registrar_Alteracao_Habilitado]]
 
Ao selecionar o botão "Registrar Alteração" sistema emite a mensagem para confirmar o envio.
 
<center>'''Botão Registrar Alteração'''
[[Arquivo:Registrar Alteracao Selecionado.png|750x500px|nenhum|Registrar_Alteracao_Selecionado]]
 
Após a confirmação o sistema registra alteração
 
<center>'''Processo Concluído com Sucesso'''
[[Arquivo:Processo_Concluido_Sucesso_Lanc.png|750x500px|nenhum|Processo_Concluido_Sucesso_Lanc]]
 
 
<center>'''Lançamento alterado e registrado'''
[[Arquivo:Lançamento alterado registrado.png|750x500px|nenhum|Lançamento_alterado_registrado]]
 

='''Como realizar a Alteração de Juros do Lançamento já Registrado Open Banking e reenviá-lo novamente?'''=
 

'''Irá surgir a necessidade de realizar a alteração de Juros do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?'''
 
Dado que já temos um Lançamento Financeiro já Registrado Open Banking, basta acessar o Lançamento Financeiro desejado através do caminho do Menu:
 
'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 
'''Regra Sistema para os Juros:'''
 
Se no cadastro do Portador não possuir Comando de Remessa com as novas opções:
 
'''Tipo de Comando =''' Alteração de Juros para Juros
 
'''BANCO SICREDI:''' para este Banco por enquanto atende '''somente''' alteração de Juros para registro Open Banking, não registrando então caso alterado Multas.
 
Ao acessar o Lançamento Financeiro em modo Modificar e alterar o campo '''Juros Dias de''' ou '''Juros Mês de''', automaticamente após alteração dos Juros, o Sistema irá criar essa parametrização do Comando de Remessa com '''sugestão''', sendo passível de alteração, no Cadastro do Portador no botão '''Remessas''' e depois no botão '''Comandos'''.
 
'''Comando sugestão para Juros:'''
 
'''Código Operação =''' ATJ
 
'''Comando =''' ATJ
 
'''Descrição =''' ALTERAÇÃO DE JUROS PARA OPEN BANKING
 
'''Tipo de Comando =''' Alteração de Juros
 
 
<center>'''Cadastro do Portador Comando de Remessa Juros'''
[[Arquivo:Lancto Registrado Alteração Juros Dia 748.png|750x500px|nenhum|Lancto_Registrado_Alteração_Juros_Dia_748]]
 
 

'''Como é identificado a alteração de Juros para Banco?'''
 
Através das tags enviadas para API gravadas no Histórico do Open Banking Dados API:
 
'''instruçãoComando''':'''ALTERACAO_OUTROS_DADOS''' – indica que ocorreu uma alteração de registro no Lançamento.
 
'''complementoInstrucao''': '''JUROS_DIA''' – indica que há Juros no registro.
 
'''valor1''': 0.12, - indica o valor dos Juros.
 
 
<center>'''Lançamento Financeiro a Receber já Registrado alterando os Juros'''
[[Arquivo:Lancto Registrado Alteração Juros Dia.png|750x500px|nenhum|Lancto_Registrado_Alteração_Juros_Dia]]
 
 

Tags enviadas para API Banco:
 
 
<center>'''Dados API Tags referente aos Juros'''
[[Arquivo:Dados API Juros 748.png|750x500px|nenhum|Dados_API_Juros_748]]
 
 

='''Quais são as novidades após atualização para Versão 2 do Open Banking?'''=
 
Disponibilizado a Versão 2 para Open Banking que traz algumas novidades para o processo de Registro no Banco.
 
Nela terá um componente que quando atualizado a Base através do Assistente de Atualização (Atualiza CIGAM) será adicionado nos Parâmetros Open Banking da Configuração de Bancos, especificamente nas Credenciais, o registro '''Versão API''' = v2.
 
'''Finanças > Gestão Financeira > Parâmetros > Configurações de Bancos'''
 
<center>'''Parâmetros Open Banking'''
[[Arquivo:Parametros OP Sicredi Credenciais.png|750x500px|nenhum|Parametros_OP_Sicredi_Credenciais]]
 
A partir desta Versão o Sistema passa a realizar a busca para localizar os títulos da seguinte forma:
 
1- O sistema tenta localizar os títulos pelo Número do Lançamento;
 
2- Caso os títulos tenham sido gerados pelo CIGAM irá localizar pelo '''Nosso Número''', avaliando então a tabela '''GFBOLETOS''' pela coluna '''NOSSO_NRO'''.
 
3- Caso os títulos tenham sido gerados por outro sistema irá localizar pelo '''Nosso Número''', avaliando então a tabela '''GFLAUXIL''' pela coluna '''CODIGO_BARRAS'''.
 
Também nesta versão estão disponíveis as tags para Envio da Série/NF, sendo utilizado a Tag na API '''NumeroTituloBeneficiario'''. A regra é '''Serie''' '''NF''' '''Complemento Duplicata''', bem como descrito com espaços em Branco entre eles. Para verificar esse registro, basta acessar após o Registro no Banco o Histórico Open Banking na guia '''Envio''' e localizar para Tag '''NumeroTituloBeneficiario'''.
 
<center>'''Parâmetros de Convênio Open Banking'''
[[Arquivo:Wizard Passo 3-4 Final Sicredi.png|750x500px|nenhum|Wizard_Passo_3-4_Final_Sicredi]]
 
Atualizado Wizard para Versão 2 do Open Banking, disponibilizando duas opções:
 
'''- Direto''': esta opção tem como finalidade registrar o Boleto no momento da sua geração, ou seja, quando selecionado ativa propriedade ao qual ao gerar o Boleto Bancário o sistema automaticamente envia o registro Open Banking, sem a necessidade de fazer o processo de envio da Remessa Open Banking do título.
 
'''- PIX''': esta opção fica habilitada somente quando selecionado a opção '''Direto''', ela tem como finalidade registrar uma operação PIX para os Boletos emitido de forma Direta (opção '''Direto''' marcado).
 
Esta opção é válida '''SOMENTE''' para o Banco do Brasil.
 
Ao emitir o Boleto do Lançamento o sistema marca as 3 opções:
 
- Boleto Impresso;
 
- Remessa Enviada;
 
- Código de Barras Lido;
 
Outra mudança é no '''Histórico''' Open Banking, ao qual passa criar o registro com '''Status Open Banking''' já '''Registrado'''.
 
Também ao acessar os '''Dados API''' é enviado a tag: "indicadorPix": "S", pois a opção PIX esta selecionada.
 
Disponibilizado o Modelo de Relatório para o Boleto Banco do Brasil já com o QRCode:
 
'''I:\CIGAM\DOC\Modelos_relatorios\Gestão Financeira\Bloquetos Merge\0098_brasil_PIX.rtf'''

='''Como realizar a Baixa de um Lançamento Financeiro Registrado Open Banking e enviar o Registro de Baixa?'''=
 
'''IMPORTANTE:''' O processo de Cancelamento de Notas Fiscais, não atende a baixa automatica dos Boletos, logo deve ser baixado manualmente os registros dos Lançamentos Financeiros.
 
Para realizar o processo de '''Baixa''' de um Lançamento Financeiro que foi registrado via Open Banking, basta acessar o Lançamento Financeiro.
 
'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 
Selecionar a opção de Menu Lateral do Lançamento Financeiro '''Open Banking''' e a opção de '''Baixar'''.
 
<center>'''Lançamento Financeiro Registrado/Baixar'''
[[Arquivo:Opção Baixar Lancto.png|750x500px|nenhum|Opção_Baixar_Lancto]]
 
<center>'''Lançamento Financeiro Confirmando Operação'''
[[Arquivo:Deseja Baixar.png|750x500px|nenhum|Deseja_Baixar]]
 
<center>'''Lançamento Financeiro Baixado com Sucesso'''
[[Arquivo:Baixado Sucesso.png|750x500px|nenhum|Baixado_Sucesso]]
 

='''Como parametrizar para envio Open Banking a Negativação ou Protesto?'''=
 
Basta acessar o Cadastro do Portador e inserir os dias no campo '''Protestar após''' na guia '''Configurações.
 

'''Menu > Finanças > Gestão Financeira > Parâmetros > Portadores'''

 
<center>'''Dias de Protesto Cadastro do Portador'''
[[Arquivo:Cadastro Portador Negativacao Sicredi.png|750x500px|nenhum|Cadastro_Portador_Negativacao_Sicredi]]
 

Banco do Sicredi:
 
Para este Banco a negativação é parametrizada no Cadastro do Portador na guia “Configurações” no campo “Protestar após”, é através deste campo que o sistema reconhece e passa considerar o envio das tags para os dados da API do Banco.
 
'''"numDiasNegativacaoAuto": "07",'''

 

='''Como cadastrar as Mensagens de Retorno API Financeira Sugestão Usuário?'''=
 
As Mensagens de Retorno API Financeira é uma funcionalidade para facilitar a identificar e de orientação para com as mensagens provindas das APIs que o Sistema tem conexão.
 
Elas foram implementadas para Open banking.
 
Para acessar o cadastro basta acessar através do Menu:
 
'''Menu: Finanças > Gestão Financeira > Parâmetros > Mensagens de Retorno API Financeiro'''
 

<center>'''Mensagens de Retorno API Financeiro'''
[[Arquivo:Mensagens Retorno API Financeiro.png|750x500px|nenhum|Mensagens_Retorno_API_Financeiro]]
 

'''Banco:''' código do Banco conforme codificação no orgão que rege os Bancos Febraban.
 
'''Código Erro:''' código do erro conforme layout das APIS dos Bancos.
 
'''Status:''' é o código de Status de erro do Servidor retornado da API dos Bancos. (Código HTTP)
 
'''Descrição do Erro (Banco):''' essa descrição é oriunda do Banco retornada pela API deles.
 
'''Sugestão CIGAM:''' esta mensagem é interna do Sistema, ou seja, quando internamente identificarmos uma situação a qual a Mensagem retornada pelo Banco não é clara, vamos alimentar com Mensagens de sugestão, para orientar as possíveis causas, dando um norte para situação.
 
'''Sugestão Cliente:''' este campo é reservado para o próprio usuário, possibilitando cadastrar Mensagens que ele identificar para facilitar no processo de entendimento das Mensagens de Retorno das APIs.
 
Agora através desta aplicação, quando ocorrer um Erro de Open Banking é possível verificar através dos links dispostos na tela de Lançamento Financeiro no campo Situação Open Banking, terá um link para tabela do erro ocorrido.
 
<center>'''Lançamento Financeiro Mensagens de Retorno API Financeiro'''
[[Arquivo:Mensagens Retorno API Financeiro BB OP.png|750x500px|nenhum|Mensagens_Retorno_API_Financeiro_BB_OP]]
 
Ou também através do Histórico Open Banking:
 
<center>'''Lançamento Financeiro Mensagens de Retorno API Financeiro Histórico Open Banking'''
[[Arquivo:Historico OP Mensagens Retorno API Financeiro BB OP.png|750x500px|nenhum|Historico_OP_Mensagens_Retorno_API_Financeiro_BB_OP]]

GF - Como Fazer - Open Banking para Banco Sicredi

2022-05-12T18:28:24Z

Alan.campos: /* Serviços Disponíveis pela API do Banco nesta Versão? */

[[categoria:Como_Fazer_Finanças]]

='''O que significa Open Banking?'''=

Open Banking é um conceito relativamente novo na realidade do mercado financeiro brasileiro. Porém, ele tem ganhado cada vez mais atenção em todo o mundo.
Traduzido, o termo significa “banco aberto”, mas uma tradução mais precisa seria “sistema financeiro aberto”.
O conceito em si trata de algo de simples compreensão. Basicamente, Open Banking é a defesa de que o sistema financeiro adote a tecnologia de forma mais ampla e padronizada, como forma de incentivar e ampliar a oferta e a qualidade dos produtos e serviços financeiros.
A base do Open Banking está na premissa de que os dados pertencem aos consumidores. Logo, caso eles autorizem, esses dados devem ser disponibilizados para que eles possam ter acesso a produtos e serviços que forem mais convenientes.
Na prática, há um pedido para que as instituições abram suas API’s (sigla em inglês para Interface de Programação de Aplicativos) para que terceiros desenvolvam e aprimorem os sistemas e suas funcionalidades.
O objetivo do Open Banking é desenvolver sistemas integrados, que facilitem o controle e transferência de informações de dados, histórico, contas, empréstimos etc. Todo o tipo de produto e serviço oferecido pelos bancos seria integrado de maneira a evitar processos complicados e dispendiosos.
À primeira vista, pode parecer que com o Open Banking as informações dos clientes ficarão soltas e desprotegidas. No entanto, os bancos e instituições financeiras ainda serão responsáveis pela proteção de dados sigilosos.

='''Serviços Disponíveis pela API do Banco nesta Versão?'''=
'''Menu > Utilidades/Diversos > Genéricos > Parâmetros > Configurações'''
 
<center>
{| class="wikitable"
|-
! SERVIÇO !! COBRANÇA
|-
| Registro de Boleto via API || SIM
|-
| Open Banking PIX no Boleto || NÃO
|-
| Retorno de Cobrança via API || NÃO
|-
| Alteração de Juros via API || SIM
|-
| Alteração de Multa via API || SIM
|-
| Alteração de Vencimento via API || SIM
|-
| Alteração de Baixa via API || SIM
|-
| Negativação no Envio do Registro || SIM
|-
| Prostesto no Envio do Registro || NÃO
|-
|}
</center>
 

='''Como obter as Credenciais para utilizar a Funcionalidade Open Banking?'''=
 
As credenciais do Banco devem ser obtidas através do contato com o seu Gerente de Cash (Gerente da Conta no Banco).
 
O Banco Sicredi, possui uma nomenclatura interna para esse processo, conhecido como Registro de Cobrança OnLine ou Ecommerce, conforme documentação.
 
Então ao entrar em contato com o Gerente de Cash, validar as nomenclaturas para que haja o entendimento da funcionalidade.
 

='''Quais os Módulos necessários para utilizar a Funcionalidade Open Banking”?'''=

• Módulo Gestão Financeira;

='''Quais são as parametrizações necessárias para utilizar a funcionalidade do Open Banking Banco Sicredi?'''=

'''Itens Importantes na Parametrização:'''
 
'''- Processar retornos pelo número do Boleto:''' esta opção deve estar marcada, pois caso contrário ocorrerá problemas na gravação das informações e envio para Banco.
 
Caso tenha sido realizado movimentações com esta opção desmarcada, não será possível realizar a Baixa, pois sistema não consegue localizar devido não possuir o '''Nosso Número''' gravado nas tabelas envolvidas.
 
Para solucionar essa questão será necessário:
 
'''1-''' Identificar o '''Nosso Número''' do registro a ser baixado (Lançamento Financeiro);
 
'''2-''' Gravar o '''Nosso Número''' nas seguintes tabelas:
 
'''GFBOLETOS:''' campo a ser atualizado '''NOSSO_NRO''' com a informação do Nosso Número.
 
'''GFLAUXIL:''' campo a ser atualizado '''CODIGO_BARRAS''' com a informação do Nosso Número.
 
'''- Processar retornos pelo número do Boleto:''' esta opção deve estar marcada, pois caso contrário ocorrerá problemas na gravação das informações e envio para Banco.
 
 
'''Importante preenchimento Telefone''': o não preenchimento do Telefone no Cadastro de Empresa acarretará em Erro no Registro Open Banking. Não é um item obrigatório, porém o Banco Sicredi para registrar necessita o preenchimento deste dado. Não deve ser utilizado espaços ou caracteres especiais.
 
Para utilizar esta funcionalidade é necessário possuir o Cadastro do Portador para o Banco citado.
O cadastro quando preenchido corretamente garante que não ocorrerá inconsistências no momento do registro do Open Banking.
 
Como boa prática de implementação é mais coerente criar um novo Portador para Open Banking evitando assim de alterar o Portador utilizado para CNAB caso necessite realizar algum processo via remessa ou retorno, quando a API do Banco estiver com instabilidade.
 
Essa parametrização deverá validar os últimos Sequenciais da numeração de Boletos do Portador utilizado para as Remessas, pois assim garante que não ocorrerá conflito enviar uma numeração de Título já registrado.
 
 
Itens importantes na parametrização:
 
- '''Nº Banco''';
 
- '''Nº Conta''';
 
- '''Nº Convênio''';
 
- '''Agência/DV''': o DV da Agência é considerado o '''Posto''' da Agência, ou seja, para adquirir essa informação o Banco da Unidade da Agência deve fornecer.
 
Quando se tratar do Portador Open Banking do SICREDI, o campo '''DV''' da Agência deve ser preenchido conforme a Unidade da Agência do Banco.
 
- '''Código Cedente''';
 
Para o correto funcionamento da rotina é necessário que os dados do Portador esteja com todas informações necessárias, inclusive o Convênio.
 
'''Menu > Finanças > Gestão Financeira > Parâmetros > Portadores'''
 
Este cadastro é apenas uma demonstração de parametrização:
 
<center>'''Cadastro de Portador'''
[[Arquivo:Cadastro Portador Principal.png|750x500px|nenhum|Cadastro_Portador_Principal]]
 
<center>'''Guia CNAB'''
[[Arquivo:Cadastro Portador CNAB Sicredi.png|750x500px|nenhum|Cadastro_Portador_CNAB]]
 

Campo "Especie" quando utilizado Open Banking deve ser = A para Duplicata Mercantil.

<center>'''Guia Configurações'''
[[Arquivo:Cadastro Portador Configurações Sicredi.png|750x500px|nenhum|Cadastro_Portador_Configurações_Sicredi]]
 

'''Irá surgir a necessidade de realizar a alteração de Vencimento, Multa ou Juros do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?'''
 
Regra Sistema para Vencimento, Multa ou Juros:
 
Cadastro do Portador deve possuir Comando de Remessa com as novas opções:
 
'''Tipo de Comando =''' Alteração de Vencimento (para alteração de Vencimento).
 
'''Tipo de Comando =''' Alteração de Multa para Multa (para alteração de Multa).
 
'''Tipo de Comando =''' Alteração de Juros para Juros (para alteração de Juros).
 
Caso não seja parametrizado neste primeiro momento as opções de Multa e Juros o sistema cria automaticamente (Somente Juros e Multa).
 
Ao acessar o Lançamento Financeiro em modo Modificar e alterar o campo Multa de ou Juros de, automaticamente após alteração da Multa, o Sistema irá criar essa parametrização do Comando de Remessa com sugestão, sendo passível de alteração, no Cadastro do Portador no botão Remessas e depois no botão Comandos.
 
'''Comando sugestão para Multa:'''
 
'''Código Operação''' = ATM
 
'''Comando''' = ATM
 
'''Descrição''' = ALTERAÇÃO DE MULTA PARA OPEN BANKING
 
'''Tipo de Comando''' = Alteração de Multa
 
'''Comando sugestão para Juros:'''
 
'''Código Operação''' = ATJ
 
'''Comando''' = ATK
 
'''Descrição''' = ALTERAÇÃO DE JUROS PARA OPEN BANKING
 
'''Tipo de Comando''' = Alteração de Juros
 
<center>'''Botão Remessas > Comandos'''
[[Arquivo:Cadastro Portador Comando Remessa.png|750x500px|nenhum|Cadastro_Portador_Comando_Remessa]]
 
<center>'''Botão Retornos > Códigos de Retorno'''
[[Arquivo:Cadastro Portador Codigo Retorno.png|750x500px|nenhum|Cadastro_Portador_Codigo_Retorno]]
 
Para iniciar a configuração através do “Assistente de Parâmetros do Open Banking”, basta selecionar o botão “Open Banking”:
 
'''Menu > Finanças > Gestão Financeira > Parâmetros > Configuração de Bancos'''
 
 
<center>'''Configurações de Banco'''
[[Arquivo:Cadastro Configuraçao Banco.png|750x500px|nenhum|Cadastro_Configuraçao_Banco]]
 
 
Para dar início ao processo de parametrização, basta selecionar o botão “Avançar”:
 
 

='''Tela Inicial Configuração do Assistente Open Banking:'''=
 
Para iniciar a configuração é necessário ter em mãos os seguintes dados: (Código de Acesso).
Sem essas informações não será possível dar continuidade na parametrização do Open Banking para o Banco do Sicredi.
 
<center>'''Tela Inicial Assistente de Parâmetros Open Banking'''
[[Arquivo:Wizard Bem Vindo.png|750x500px|nenhum|Wizard_Bem_Vindo]]
 


=='''Etapa 1 (Parâmetros: Passo 1 de 4):'''==


Uma das etapas mais importantes e que requer um cuidado maior e sigilo das informações nesta parametrização.
 
Essas informações são disponibilizadas pelo Banco a qual deve ser restrita somente a pessoa responsável pelo setor Financeiro da Empresa.
 
O assistente tem como objetivo proporcionar que o próprio usuário tenha autonomia para executar esse passo a passo sem necessidade de passar essas informações restritas da Empresa para qualquer pessoa que não seja ele mesmo.
 
Reforçando, mesmo que tenha dificuldades para executar esta etapa, não repasse nenhuma informação relacionado aos acessos dos tokens.
 
Dados em mãos para informar os respectivos campos, basta copiar e colar as informações.
 
Código de Acesso.
 
O Campos '''Código de Acesso''' possui uma tecnologia de criptografia, ou seja, após informar os dados nos campos o sistema irá criptografar as informações garantindo e mantendo a segurança das informações.
 
Caso haja necessidade de alterações, basta clicar no ícone do "Cadeado", será aberta a tela de Criptografia e após colar ou digitar as informações em tela e selecionar o botão "Confirmar".
 
Também tenha alguma dúvida no dado informado e necessitar validar o dado seguindo os mesmos passos da alteração será aberta a tela de Criptografia e após colar ou digitar as informações em tela e selecionar o botão "Validar", sistema confirma se os dados são os mesmos.
 
Observamos que esta tela possui duas guias, uma de Homologação e Produção. Preencher conforme a necessidade do processo, caso precise realizar testes, parametrize em homologação e posteriormente parametrize o de Produção ou se preferir, pode preencher os dois se possuir os dados.
 
Lembrando que esses dados são confidenciais de uso e exclusivo de cada usuário.
 
Através dessas informações o sistema irá se comunicar com API do Banco para poder realizar os registros dos Lançamentos.
 
Após informado os dados, basta selecionar o botão "Avançar", para seguir os próximos passos.
 
'''Código de Acesso:''' informar a codificação passada pelo Banco.
 
 
<center>'''Parâmetros: Passo 1 de 4'''
[[Arquivo:Wizard Passo 1 Sicredi.png|750x500px|nenhum|Wizard_Passo_1_Sicredi]]
 

=='''Etapa 2 (Portador de Remessa e Retorno - Pagamento: Passo 2 de 4):'''==

Nesta etapa deve ser selecionado o Portador que será considerado para o envio da Remessa de Pagamento (onde estarão os boletos em aberto) e nesta mesma tela informar o qual Portador será considerado para o Retorno de Pagamento (onde serão liquidados os retornos de Pagamentos).
 
Nesta etapa, é possível pular, caso não utilize ainda o Envio de Pagamentos do Open Banking.
 
'''Pular:''' caso deseja pular essa etapa e prosseguir com o processo de parametrização do Open Banking.
 
'''Avançar:''' dá continuidade ao processo de parametrização, após selecionado uma opção.
 
Para continuar a parametrização selecione o botão "Pular" e siga para os próximos passos.
 
<center>'''Portador de Remessa e Retorno: Passo: 2 de 4'''
[[Arquivo:Wizard Passo 2 Sicredi.png|750x500px|nenhum|Wizard_Passo_2_Sicredi]]
 

=='''Etapa 3 (Convênios de Cobrança: Passo 3 de 4):'''==
 
Nesta etapa o sistema avalia sua base de dados, e localiza os Convênios parametrizados para o Banco Sicredi, onde serão listados.
O sistema possibilita a parametrização de Convênios específicos bem como caso seja optado, selecionando o botão "Pular" o sistema criará automaticamente o Convênio "Geral", ao qual utiliza dados do Portador registrado.
 
'''Pular:''' caso deseja pular essa etapa e prosseguir com o processo de parametrização do Open Banking.
 
'''Avançar:''' dá continuidade ao processo de parametrização, após selecionado uma opção.
 
<center>'''Convênios de Cobrança: Passo 3 de 4'''
[[Arquivo:Wizard Passo 3 Sicredi.png|750x500px|nenhum|Wizard_Passo_3_Sicredi]]
 

=='''Etapa 3 (Portador de Remessa e Retorno - Cobrança: Passo 3 de 4):'''==
 
Nesta etapa deve ser selecionado o Portador que será considerado para o envio da Remessa de Cobrança (onde estarão os boletos em aberto) e nesta mesma tela informar o qual Portador será considerado para o Retorno de Cobrança (onde serão liquidados os retornos de Cobranças).
 
'''Avançar:''' dá continuidade ao processo de parametrização, após selecionado uma opção.
 
<center>'''Portador de Remessa e Retorno - Cobrança: Passo 3 de 4'''
[[Arquivo:Wizard Passo 3-4 Final Sicredi.png|750x500px|nenhum|Wizard_Passo_3-4_Final_Sicredi]]
 
Atualizado Wizard para Versão 2 do Open Banking, disponibilizando duas opções:
 
'''- Direto:''' esta opção tem como finalidade registrar o Boleto no momento da sua geração, ou seja, quando selecionado ativa propriedade ao qual ao gerar o Boleto Bancário o sistema automaticamente envia o registro Open Banking, sem a necessidade de fazer o processo de envio da Remessa Open Banking do título.
 
Também quando selecionada, terá uma particularidade na questão da Emissão de Boletos em lote pela Rotina de Emissão de Boletos Personalizados. A rotina na guia '''Opções''' tem a opção '''Enviar somente Lançamentos não marcados e marca-los''', caso esteja desmarcada o Registro Open Banking ocorrerá da mesma forma que o sistema irá marcar a opção '''Boleto Impresso''' do Lançamento Financeiro, registrando a Operação Open Banking.
Isso ocorre para manter a integridade, já que esta operação é considerada única no registro, sendo então necessário marcar a '''Boleto Impresso''', para poder conseguir realizar alterações como Alteração de Vencimento ou mesmo a Baixa, sendo uma condição de Sistema.
 
'''- PIX''': esta opção tem como finalidade registrar uma operação PIX para os Boletos emitido de forma Direta (opção '''Direto''' marcado).
 
Esta opção é válida '''SOMENTE''' para o Banco do Brasil.
 

=='''Etapa 4 (Relatório: Passo 4 de 4):'''==

 
Nesta etapa o sistema irá buscar automaticamente o Modelo de Relatório Padrão, caso exista no ambiente, facilitando assim todo processo de parametrização e implementação para usuário.
 
A busca é realizado '''(%CIGAM_INSTAL%RF00071_remessas.RTF)''', com isso é importante que o Modelo de Relatório (RF00071_remessas.RTF) esteja devidamente localizado na pasta padrão do Cigam_Instal, como por exemplo:
 
'''%CIGAM_INSTAL%''' = P:\Cigam11\Projects\Controle\MACIEL\Financeiro_Open_Banking
 
"P:\Cigam11\Projects\Controle\MACIEL\Financeiro_Open_Banking\Modelos\Relatorios\Gestao Financeira\RF00071_remessas.RTF"
 
Clicar em "Avançar" para dar seguimento.
 
<center>'''Assistente de Parâmetros Open Banking: Passo 4 de 4'''
[[Arquivo:Wizard Passo 4-4 Relat Sicredi.png|750x500px|nenhum|Wizard_Passo_4-4_Relat_Sicredi]]
 
 

=='''Etapa Conclusão (Parâmetros de Convênio Open Banking - Conclusão):'''==

 
Esta etapa o sistema faz validação da comunicação com o Banco através da API verificando o ambiente se esta tudo ok, listando em tela.
 
Após a consulta estar "OK", basta clicar no botão "Concluir" e seu ambiente estará apto para utilizar a funcionalidade Open Banking.
 
<center>'''Parâmetros de Convênio Open Banking: Passo Final - Conclusão'''
[[Arquivo:Wizard Passo Final Conclusao Conexao Sicredi.png|750x500px|nenhum|Wizard_Passo_Final_Conclusao_Conexao_Sicredi]]
 
'''Homologação:''' Conexão realizada com sucesso.
 
'''Produção:''' Conexão realizada com sucesso.
 
O servidor remoto retornou um erro: (401) Não Autorizado. Isso ocorre quando não houve a parametrização dos dados em Produção como foi realizado no ambiente de Homologação conforme o passo a passo, ou possa ter ocorrido algum erro na comunicação com o Banco.
 
<center>'''Convênio Cadastrado com Sucesso - Cobrança'''
[[Arquivo:Parametros OP Sicredi.png|750x500px|nenhum|Parametros_OP_Sicredi]]
 
'''Ambiente:''' lista qual é o ambiente cadastrado, sendo apenas duas opções: Homologação e Produção.
 
'''Convênios:''' neste grupo serão listados todos os convênios cadastrados, bem como todas informações pertinentes como:
 
- Portador;
 
- Agência;
 
- Número Conta;
 
- Portador de retorno;
 
'''- Direto:''' esta opção tem como finalidade registrar o Boleto no momento da sua geração, ou seja, quando selecionado ativa propriedade ao qual ao gerar o Boleto Bancário o sistema automaticamente envia o registro Open Banking, sem a necessidade de fazer o processo de envio da Remessa Open Banking do título.
 
'''- PIX:''' esta opção fica habilitada somente quando selecionado a opção Direto, ela tem como finalidade registrar uma operação PIX para os Boletos emitido de forma Direta (opção Direto marcado).
 
Esta opção é válida SOMENTE para o Banco do Brasil.
 
Ao emitir o Boleto do Lançamento o sistema marca as 3 opções:
 
- Boleto Impresso;
 
- Remessa Enviada;
 
- Código de Barras Lido;
 
'''U.N Ced.:''' esta opção tem como finalidade possibilitar o envio e registro de Boletos de outras Unidades de Negócio.
 
Basta informar a Unidade desejada no campo e o sistema entenderá quando realizado o processo de registro de um título que não seja da Unidade Matriz, então sistema identifica e realiza o processo de envio e registro.
Se deixar em Branco a Unidade Cedente irá considerar para todas Unidades de Negócio.
 
 
<center>'''Convênio Cadastrado com Sucesso - Pagamento'''
[[Arquivo:Parametros OP Sicredi Pagamento.png|750x500px|nenhum|Parametros_OP_Sicredi_Pagamento]]
 
'''Ambiente:''' lista qual é o ambiente cadastrado, sendo apenas duas opções: Homologação e Produção.
 
'''Convênios:''' neste grupo serão listados todos os convênios cadastrados, bem como todas informações pertinentes como:
 
- Portador;
 
- Agência;
 
- Número Conta;
 
- Portador de retorno;
 
<center>'''Ícone Credenciais'''
[[Arquivo:Parametros OP Sicredi Credenciais.png|750x500px|nenhum|Parametros_OP_Sicredi_Credenciais]]
 
Através deste ícone é possível verificar os Parâmetros API parametrizados, tanto em homologação quanto em produção.
 
 
<center>'''Ícone Endereços'''
[[Arquivo:Parametros OP Sicredi Endereços.png|750x500px|nenhum|Parametros_OP_Sicredi_Endereços]]
 
Através deste ícone é possível verificar todos endereços de URLs parametrizados.

='''O que significa a Categoria Open Banking de acesso?'''=
 
 A Categoria Open Banking é uma Categoria que é habilitada mediante a utilização de um Portador parametrizado com as Configurações de Banco Open Banking. A mesma tem como objetivo proporcionar maior agilidade e gerenciamento das atividades relacionadas a Remessa de Cobrança Online.
 
'''Categoria Open Banking'''
 
 
<center>'''Categoria Open Banking'''
[[Arquivo:Categoria Open Banking.png|750x500px|semmoldura|nenhum|Categoria_Open_Banking]]
 
 

'''Registrar:''' item de categoria tem como funcionalidade registrar o Boleto Bancário Online. Substitui todo o processo de geração do arquivo de Remessa de Cobrança, acessar o site e remeter ao Banco esse arquivo, com apenas um clique na opção.
 
'''Reenviar:''' item de categoria tem como funcionalidade possibilitar o reenvio de registros que estão com alguma pendência ou algum erro de parametrização. Será habilitado somente quando já possuir movimento de "Registro" enviado, cuja Situação estiver com pendência ou erro.
 
'''Baixar:''' item de categoria tem como funcionalidade comunicar o Banco referente a Baixa do movimento em questão do Boleto Bancário. Utilizado para eventuais falhas operacionais, como registrado um movimento por engano, ou negociações diretamente com cliente a parte. Eliminando então também todo processo de geração do arquivo de Remessa Bancária com Comando de Remessa de Baixa e o processo de remeter ao Banco o arquivo, sendo realizado tudo online através desta opção.
 
'''Registrar Alteração:''' item de categoria tem como funcionalidade registrar uma alteração ocorrida referente ao "Vencimento" do Lançamento Financeiro.
Ao realizar alteração da Data de Vencimento do Lançamento Financeiro que está com "Situação Open Banking" igual "Registrado" e ocorrer alteração no Vencimento, o sistema emite uma mensagem possibilitando já o envio da alteração no momento ou mais tarde através desta opção de "Registrar Alteração".
 
'''Histórico:''' item de categoria tem como funcionalidade gravar todas movimentações realizadas relativo ao Open Banking. Registros, Baixas, Erros...

='''Layout e Detalhamento de Campos API'''=
==Registro de Boletos==
<center>

{| class="wikitable"
|-
! Nº !! Campo JSON !! Descriçao do Banco !! Campo CIGAM !! Tabela !! Obrigatório !! Observações
|-
| 1 || token || Chave Transacional gerada pelo recurso /autenticacao || || || Obrigatório ||
|-
| 2 || Content-Type || Estabelece o tipo de conteúdo da requisição || || || Obrigatório ||
|-
| 3 || agencia || Código da Cooperativa do beneficiário || Agência || Portador || Obrigatório ||
|-
| 4 || posto || Código do Posto do beneficiário || Dígito Agência || Portador || Obrigatório ||
|-
| 5 || cedente || Código do Convênio de Cobrança do beneficiário || Código Cedente || Portador || Obrigatório ||
|-
| 6 || nossoNumero* || Nosso Número || Nosso Número || Boletos || Opcional ||
|-
| 7 || codigoPagador || Código Pagador || Não Tratado || Não Tratado || Opcional ||
|-
| 8 || tipoPessoa* || Tipo de pessoa do pagador.
'''Domínio:'''
 
1 - PESSOA FÍSICA
 
2 - PESSOA JURÍDICA
|| Pessoa || Empresa || Obrigatório ||
|-
| 9 || cpfCnpj* || CPF ou CNPJ do pagador || CNPJ/CPF || Empresa || Obrigatório ||
|-
| 10 || nome || Nome do pagador || Nome Completo || Empresa || Obrigatório ||
|-
| 11 || endereco || Endereço do pagador || Endereço || Empresa || Opcional || Será obrigatório se o código do pagador '''não''' for informado.
|-
| 12 || cidade || cidade || Município || Empresa || Opcional || Será obrigatório se o código do pagador '''não''' for informado.
|-
| 13 || uf || Estado do pagador || UF || Empresa || Opcional || Será obrigatório se o código do pagador '''não''' for informado.
|-
| 14 || cep || CEP do pagador || CEP || Empresa || Obrigatório ||
|-
| 15 || telefone || Telefone mais DDD do pagador || Fone || Empresa || Opcional || Será obrigatório se o código do pagador '''não''' for informado.
|-
| 16 || email || Endereço de email do pagador || Email || Contato || Opcional ||
|-
| 17 || especieDocumento || Espécie de documento do título.(*) || Espécie || Portador || Obrigatório ||
|-
| 18 || codigoSacadorAvalista || Código do sacador avalista. || Não Tradado || Não Tradado || Opcional ||
|-
| 19 || seuNumero || Número de controle interno do beneficiário que referencia o pagador. || Lançamento || LANCAM || Obrigatório ||
|-
| 20 || dataVencimento || Data de vencimento do boleto || Vencimento || Boletos || Obrigatório ||
|-
| 21 || valor || Valor do boleto || Saldo || LANCAM || Obrigatório ||
|-
| 22 || tipoDesconto || Tipo de desconto.
'''Domínios:'''
 
A - VALOR
 
B - PERCENTUAL
|| Não Tratado || Não Tratado || Obrigatório ||
|-
| 23 || valorDesconto1 || Valor de desconto 1 || Valor Desconto || LANCAM || Opcional || Será obrigatório se o dataDesconto1 for informado.
|-
| 24 || dataDesconto1 || Data limite para concessão de desconto1 || Vencimento || LANCAM || Opcional || Será obrigatório se o valorDesconto1 for informado. Não pode ser igual a outras dataDescontos e nem maior que vencimento.
|-
| 25 || valorDesconto2 || Valor de desconto 2 || Não Tratado || Não Tratado || Opcional || Será obrigatório se o dataDesconto2 for informado.
|-
| 26 || dataDesconto2 || Data limite para a concessão de desconto 2 || Não Tratado || Não Tratado || Opcional || Será obrigatório se o valorDesconto2 for informado. Não pode ser igual a outras dataDescontos e nem maior que vencimento.
|-
| 27 || valorDesconto3 || Valor de desconto 3 || Não Tratado || Não Tratado || Opcional || Será obrigatório se o dataDesconto3 for informado.
|-
| 28 || dataDesconto3 || Data limite para a concessão de desconto 3 || Não Tratado || Não Tratado || Opcional || Será obrigatório se o valorDesconto3 for informado. Não pode ser igual a outras dataDescontos e nem maior que vencimento.
|-
| 29 || tipoJuros || Tipo de Juros.
'''Domínios:'''
 
A - VALOR
 
B - PERCENTUAL
|| || || Obrigatório ||
|-
| 30 || juros || Valor de juros a cobrar por dia. || Juros Dia || LANCAM || Opcional ||
|-
| 31 || multas || Percentual de multa a cobrar || Valor Multa || LANCAM || Opcional ||
|-
| 32 || desconto Antecipado || Valor de desconto antecipado a cobrar || Não Tratado || Não Tratado || Opcional || Deve ser menor que o valor.
|-
| 33 || informativo || Texto do Informativo || Não Tratado || Não Tratado || Opcional ||
|-
| 34 || mensagem* || Texto da linha da mensagem || Não Tratado || Não Tratado || Opcional ||
|-
| 35 || codigoMensagem || Código da mensagem || Não Tratado || Não Tratado || Opcional ||
|-
| 36 || numDiasNegativacaoAuto || Número de dias para Negativação Automática. 0 (Zero) para não negativar automaticamente. Quando preenchido com 3 ou 4 dias o sistema comandará negativação em dias úteis após o vencimento. Quando preenchido acima de 4 dias, o sistema comandará negativação em dias corridos após o vencimento. || Protesto || Portador || Opcional ||
|-
| 37 || NomeBeneficiarioFinal || NomeBeneficiarioFinal || Não Tratado || Não Tratado || Obrigatório caso informado TipoPessoaBeneficiarioFinal e CpfCnpjBeneficiarioFinal ||
|-
| 38 || TipoPessoaBeneficiarioFinal || Tipo de pessoa.
'''Domínios:'''
 
1 - Física
 
2 - Jurídica
|| Não Tratado || Não Tratado || Obrigatório caso informado NomeBeneficiarioFinal e CpfCnpjBeneficiarioFinal ||
|-
| 39 || CpfCnpjBeneficiarioFinal || CPF/CNPJ do beneficiário final || Não Tratado || Não Tratado || Obrigatório caso informado NomeBeneficiarioFinal e TipoPessoaBeneficiarioFinal ||
|-
| 40 || FoneBeneficiarioFinal || Fone do beneficiário final || Não Tratado || Não Tratado || Opcional ||
|-
| 41 || EnderecoBeneficiarioFinal || Endereço do beneficiário final || Não Tratado || Não Tratado || Opcional ||
|-
| 42 || CepBeneficiarioFinal || CEP do beneficiário final || Não Tratado || Não Tratado || Opcional ||
|-
| 43 || CidadeBeneficiarioFinal || CidadeBeneficiarioFinal || Não Tratado || Não Tratado || Opcional ||
|-
| 44 || UfBeneficiarioFinal || UF do beneficiário final || Não Tratado || Não Tratado || Opcional ||
|-
|}

</center>

'''(*) Domínios:'''
 
A - DUPLICATA MERCANTIL (DM)
 
B - DUPLICATA RURAL (DR)
 
C - NOTA PROMISSORIA (NP)
 
D - NOTA PROMISSORIA RURAL (NR)
 
E - NOTA DE SEGURO (NS)
 
G - RECIBO (RC)
 
H - LETRA DE CAMBIO (LC)
 
I - NOTA DE DEBITO (ND)
 
J - DUPLICATA DE SERVICO (DS)
 
K - OUTROS (OS)
 
O - BOLETO OFERTA (OFE)

==Alteração de Boletos==
<center>

{| class="wikitable"
|-
! Nº !! Campo JSON !! Descriçao do Banco !! Campo CIGAM !! Tabela !! Obrigatório !! Observações
|-
| 1 || agencia || Agência do Beneficiário || Agência || Portador || Obrigatório ||
|-
| 2 || posto || Posto do Beneficiário || Dígito Agência || Portador || Obrigatório ||
|-
| 3 || cedente || Código do Beneficiário || Código Cedente || Portador || Obrigatório ||
|-
| 4 || nossoNumero* || Nosso Número do Título || Nosso Número || Boletos || Obrigatório ||
|-
| 5 || instrucaoComando || Comando que será realizado na alteração do boleto. || || || Obrigatório || Caso seja informado ALTERACAO_OUTROS_DADOS será '''obrigatória''' a inclusão do campo complementoInstrucao.
|-
| 5.1 || PEDIDO_BAIXA || || || || Obrigatório || Consultar o Termo de Adesão com sua Unidade de Atendimento Sicredi p/ ver se está com Baixa Automática de boletos vencidos. Caso esteja, o boleto vencido terá sua baixa efetuada automaticamente.
|-
| 5.2 || CONCESSAO_ABATIMENTO || || || || Obrigatório ||
|-
| 5.3 || CANCELAMENTO_ABATIMENTO_CONCEDIDO || || || || Obrigatório ||
|-
| 5.4 || ALTERACAO_VENCIMENTO || || || || Obrigatório ||
|-
| 5.5 || ALTERACAO_SEU_NUMERO || || || || Obrigatório ||
|-
| 5.6 || PEDIDO_PROTESTO || || || || Obrigatório || Somente em título vencido. Por padrão, todos os boletos emitidos pelo EComm-API, não são protestados.
|-
| 5.7 || SUSTAR_PROTESTO_BAIXAR _TITULO || || || || Obrigatório ||
|-
| 5.8 || SUSTAR_PROTESTO_MANTER_CARTEIRA || || || || Obrigatório ||
|-
| 5.9 || ALTERACAO_OUTROS_DADOS || || || || Obrigatório ||
|-
| 6 || complementoInstrucao || Complemento do comando que será realizado na alteração do boleto || || || Condicional ||
|-
| 6.1 || DESCONTO || || || || Condicional ||
|-
| 6.2 || JUROS_DIA || || || || Condicional ||
|-
| 6.3 || DESCONTO_DIA_ANTECIPACAO || || || || Condicional ||
|-
| 6.4 || DATA_LIMITE_CONCESSAO_DESCONTO || || || || Condicional ||
|-
| 6.5 || CANCELAMENTO_PROTESTO _AUTOMATICO || || || || Condicional ||
|-
| 6.6 || CANCELAMENTO_NEGATIVACAO_AUTOMATICA || || || || Condicional ||
|-
| 7 || ''Campo de Alteração'' || Nome do campo que deseja mudar || || || Obrigatório ||
|-
|}

</center>

='''Como realizar a criação de Lançamentos utilizando a funcionalidade Open Banking?'''=
 
Para a criação de Lançamentos Financeiros acessar o caminho de Menu:
 

'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 

Acessar o botão “Criar” e informar os dados necessários para a criação do Lançamento Financeiro a Receber utilizando o Portador parametrizado para Open Banking.
 
 
'''1- Etapa criação do Lançamento:'''
 
 
<center>'''Criação do Lançamento Financeiro a Receber'''
[[Arquivo:Create Lanc Open Banking.png|750x500px|semmoldura|nenhum|Criação do Lançamento Financeiro]]
 
 

'''2- Etapa Impressão do Boleto Bancário do Lançamento Financeiro:'''
 
Nesta etapa pode ser realizado a impressão do Boleto Bancário diretamente pelo próprio Lançamento Financeiro ou através da rotina de Emissão em lote "Emissão de Boletos Personalizados":
 
 
<center>'''Impressão do Boleto Bancário do Lançamento Financeiro'''
[[Arquivo:Imprimir Boleto Lanc.png|750x500px|semmoldura|nenhum|Impressão Boleto Bancário]]
 
 

'''3- Etapa do Registro do Boleto Open Banking:'''
 
Nesta etapa pode ser realizado o "Registro" do Boleto diretamente pelo próprio Lançamento Financeiro ou através da rotina de Emissão em lote "Emissão de Boletos Personalizados":
Basta acessar a Categoria "Open Banking" e selecionar o Item de Categoria "Registrar".
Sistema irá realizar a comunicação através das parametrizações realizadas das Urls e Tokens de acesso e listará a situação do Registro do Boleto Bancário através do Relatório.
 
 
<center>'''Registrar Boleto Open Banking através Lançamento Financeiro'''
[[Arquivo:Boleto Impresso Registrar OP.png|750x500px|semmoldura|nenhum|Registro Boleto Open Banking]]
 
 
<center>'''Relatório Remessa Bancária OnLine'''
[[Arquivo:Relat Registro Open Banking.png|750x500px|semmoldura|nenhum|Relatório Remessa Bancária Online]]
 
 
Após o registro automaticamente o sistema marca as opções de:
 
- Remessa Enviada
 
- Códigos de Barras Lido
 
 
<center>'''Boleto Bancário Registrado'''
[[Arquivo:Lanc Registrado Validar Historico.png|750x500px|semmoldura|nenhum|Lanc_Registrado_Validar_Historico]]
 
 
Para verificar todas as movimentações realizada sobre Open Banking, elas estão sendo gravadas no Item de Categoria "Histórico" que fica na Categoria "Open Banking".
Ao selecionar o Item de Categoria "Histórico" deve listar o Registro do Boleto Bancário.
 
 
<center>'''Item de Categoria Histórico de Movimentos Open Banking'''
[[Arquivo:Item Categoria Historico.png|750x500px|semmoldura|nenhum|Item_Categoria_Histórico]]
 
 

='''Como realizar o Envio em Lote Open Banking através da rotina Remessa de Cobrança Open Banking?'''=

Assim como é possível realizar o Envio do Registro do Boleto Bancário através do próprio Lançamento Financeiro, existe a possibilidade de realizar esse processo em Lote, quando se tratar de vários registros a serem enviados.
Através do Menu:
 
 
'''Menu: Finanças > Gestão Financeira > Rotinas > EDI> Transmite > Remessa Cobranças Bancárias > Remessa de Cobrança Open Banking'''
 
 
<center>'''Remessa de Cobrança Open Banking'''
[[Arquivo:Remessa_de_Cobranca_Open_Banking_BB3.png|750x500px|semmoldura|nenhum|Remessa_de_Cobranca_Open_Banking]]
 
 
Esta rotina tem um conceito muito simples em relação aos filtros, foram disponibilizados campos essências que permitem ter uma rastreabilidade dos movimentos.

'''Unidade de Negócio:''' informe a Unidade de Negócio desejada para realizar o filtro para busca dos movimentos.
 
'''Data:''' informe a Data desejada para realizar o filtro para busca dos movimentos.
 
'''Vencimento:''' informe o período de Vencimento desejado para realizar o filtro para busca dos movimentos.
 
'''Lançamento:''' informe a faixa de Lançamentos desejada para realizar o filtro para busca dos movimentos.
 
'''Tipo de Pagamento:''' informe o Tipo de Pagamento desejado para realizar o filtro para busca dos movimentos.
 
'''Série:''' informe a Série desejada para realizar o filtro para busca dos movimentos.
 
'''Nota Fiscal:''' informe a faixa de Nota Fiscal desejada para realizar o filtro para busca dos movimentos.
 
'''Conta Financeira:''' informe a Conta Financeira desejada para realizar o filtro para busca dos movimentos.
 
'''Empresa:''' informe a faixa de Empresa desejada para realizar o filtro para busca dos movimentos.
 
'''Cobrança:''' informe a faixa de Empresa de Cobrança desejada para realizar o filtro para busca dos movimentos.
 
 
Após informado os filtros e confirmado a operação da rotina o sistema gera um relatório com a listagem dos movimentos.
Na coluna "Registro", será listado se houve a confirmação ou ocorreu algum erro.
 
 
<center>'''Relatório Remessa de Cobrança Open Banking'''
[[Arquivo:Relat Remessa Bancaria Open Banking.png|750x500px|semmoldura|nenhum|Relat_Remessa_Bancaria_Open_Banking]]
 
 

='''Como realizar a alteração de Vencimento do Lançamento já Registrado Open Banking e reenviá-lo novamente?'''=
 

Irá surgir a necessidade de realizar a alteração do Vencimento do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?
 
'''Dado que''' já temos um Lançamento Financeiro já Registrado Open Banking, basta acessar o Lançamento Financeiro desejado através do caminho do Menu:
 
'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 
Acessar o Lançamento Financeiro em modo Modificar e alterar o campo "Venc.Original", automaticamente após alteração do Vencimento, o sistema insere o Comando "05" no campo "Comando de Remessa" e diante disso já emite uma mensagem:
 
'''Confirma o envio da alteração do título ao banco?'''
 
'''Importante:''' para o envio da alteração do Vencimento o sistema já considera o campo '''Vencimento''', caso seja utilizado a '''Modalidade''' como '''Seguinte''' por exemplo, onde é possível ter um Vencimento Original diferente do Vencimento.
 
<center>'''Lançamento Financeiro a Receber já Registrado'''
[[Arquivo:AlterarVenc Lanc1.png|750x500px|nenhum|AlterarVenc_Lanc1]]
 
 
Vencimento alterado, sistema insere o Comando "05" no campo "Comando de Remessa" e ao salvar o registro é emitido a mensagem: "Confirma o envio da alteração do título ao banco?"
 
<center>'''Vencimento alterado e registro salvo'''
[[Arquivo:Vencimento Alterado Msn.png|750x500px|nenhum|Vencimento_Alterado_Msn]]
 
'''Sim:''' é enviado o registro de alteração do Open Banking e se registrado com sucesso, sistema retira então o Comando de Remessa.
 
<center>'''Processo Concluído com Sucesso'''
[[Arquivo:Processo_Concluido_Sucesso_Lanc.png|750x500px|nenhum|Processo_Concluido_Sucesso_Lanc]]
 
Há possibilidades do tempo de comunicação com API do Banco não retornar imediatamente a confirmação do recebimento da Alteração do Vencimento. Quando ocorrer essa situação, sistema emite uma mensagem, solicitando aguardar, para tentar novamente o envio da alteração do vencimento.
Quando ocorrer essa situação, será necessário aguardar e após realizar o envio novamente ou através do próprio Lançamento ou através da rotina de Remessa de Cobrança - Open Banking, que remeterá as alterações para o Banco.
<center>'''Processo Pendente Alteração - Aguardar'''
[[Arquivo:Alteração Vencimento Processo Pendente Envio Aguardar.png|750x500px|nenhum|Alteração_Vencimento_Processo_Pendente_Envio_Aguardar]]
 
Já quando selecionado a opção '''Não''':
 
'''Não:''' não faz a comunicação do envio da alteração do vencimento via Open Banking. Este registro não foi notificado, logo será necessário realiza-lo através do próprio Lançamento ou através da rotina de Remessa de Cobrança Open Banking.
 
No Lançamento Financeiro é habilitado o botão "Reenviar Registro" no Item de Categoria "Open Banking".
Quando selecionado o botão '''Registrar Alteração''', sistema faz a comunicação via Open Banking e registra alteração de vencimento realizada.
 
<center>'''Lançamento Não Registrado a alteração de Vencimento com o Comando de Remessa'''
[[Arquivo:Botao Registrar Alteracao Habilitado.png|750x500px|nenhum|Botao_Registrar_Alteracao_Habilitado]]
 
Ao selecionar o botão "Registrar Alteração" sistema emite a mensagem para confirmar o envio.
 
<center>'''Botão Registrar Alteração'''
[[Arquivo:Registrar Alteracao Selecionado.png|750x500px|nenhum|Registrar_Alteracao_Selecionado]]
 
Após a confirmação o sistema registra alteração
 
<center>'''Processo Concluído com Sucesso'''
[[Arquivo:Processo_Concluido_Sucesso_Lanc.png|750x500px|nenhum|Processo_Concluido_Sucesso_Lanc]]
 
 
<center>'''Lançamento alterado e registrado'''
[[Arquivo:Lançamento alterado registrado.png|750x500px|nenhum|Lançamento_alterado_registrado]]
 

='''Como realizar a Alteração de Juros do Lançamento já Registrado Open Banking e reenviá-lo novamente?'''=
 

'''Irá surgir a necessidade de realizar a alteração de Juros do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?'''
 
Dado que já temos um Lançamento Financeiro já Registrado Open Banking, basta acessar o Lançamento Financeiro desejado através do caminho do Menu:
 
'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 
'''Regra Sistema para os Juros:'''
 
Se no cadastro do Portador não possuir Comando de Remessa com as novas opções:
 
'''Tipo de Comando =''' Alteração de Juros para Juros
 
'''BANCO SICREDI:''' para este Banco por enquanto atende '''somente''' alteração de Juros para registro Open Banking, não registrando então caso alterado Multas.
 
Ao acessar o Lançamento Financeiro em modo Modificar e alterar o campo '''Juros Dias de''' ou '''Juros Mês de''', automaticamente após alteração dos Juros, o Sistema irá criar essa parametrização do Comando de Remessa com '''sugestão''', sendo passível de alteração, no Cadastro do Portador no botão '''Remessas''' e depois no botão '''Comandos'''.
 
'''Comando sugestão para Juros:'''
 
'''Código Operação =''' ATJ
 
'''Comando =''' ATJ
 
'''Descrição =''' ALTERAÇÃO DE JUROS PARA OPEN BANKING
 
'''Tipo de Comando =''' Alteração de Juros
 
 
<center>'''Cadastro do Portador Comando de Remessa Juros'''
[[Arquivo:Lancto Registrado Alteração Juros Dia 748.png|750x500px|nenhum|Lancto_Registrado_Alteração_Juros_Dia_748]]
 
 

'''Como é identificado a alteração de Juros para Banco?'''
 
Através das tags enviadas para API gravadas no Histórico do Open Banking Dados API:
 
'''instruçãoComando''':'''ALTERACAO_OUTROS_DADOS''' – indica que ocorreu uma alteração de registro no Lançamento.
 
'''complementoInstrucao''': '''JUROS_DIA''' – indica que há Juros no registro.
 
'''valor1''': 0.12, - indica o valor dos Juros.
 
 
<center>'''Lançamento Financeiro a Receber já Registrado alterando os Juros'''
[[Arquivo:Lancto Registrado Alteração Juros Dia.png|750x500px|nenhum|Lancto_Registrado_Alteração_Juros_Dia]]
 
 

Tags enviadas para API Banco:
 
 
<center>'''Dados API Tags referente aos Juros'''
[[Arquivo:Dados API Juros 748.png|750x500px|nenhum|Dados_API_Juros_748]]
 
 

='''Quais são as novidades após atualização para Versão 2 do Open Banking?'''=
 
Disponibilizado a Versão 2 para Open Banking que traz algumas novidades para o processo de Registro no Banco.
 
Nela terá um componente que quando atualizado a Base através do Assistente de Atualização (Atualiza CIGAM) será adicionado nos Parâmetros Open Banking da Configuração de Bancos, especificamente nas Credenciais, o registro '''Versão API''' = v2.
 
'''Finanças > Gestão Financeira > Parâmetros > Configurações de Bancos'''
 
<center>'''Parâmetros Open Banking'''
[[Arquivo:Parametros OP Sicredi Credenciais.png|750x500px|nenhum|Parametros_OP_Sicredi_Credenciais]]
 
A partir desta Versão o Sistema passa a realizar a busca para localizar os títulos da seguinte forma:
 
1- O sistema tenta localizar os títulos pelo Número do Lançamento;
 
2- Caso os títulos tenham sido gerados pelo CIGAM irá localizar pelo '''Nosso Número''', avaliando então a tabela '''GFBOLETOS''' pela coluna '''NOSSO_NRO'''.
 
3- Caso os títulos tenham sido gerados por outro sistema irá localizar pelo '''Nosso Número''', avaliando então a tabela '''GFLAUXIL''' pela coluna '''CODIGO_BARRAS'''.
 
Também nesta versão estão disponíveis as tags para Envio da Série/NF, sendo utilizado a Tag na API '''NumeroTituloBeneficiario'''. A regra é '''Serie''' '''NF''' '''Complemento Duplicata''', bem como descrito com espaços em Branco entre eles. Para verificar esse registro, basta acessar após o Registro no Banco o Histórico Open Banking na guia '''Envio''' e localizar para Tag '''NumeroTituloBeneficiario'''.
 
<center>'''Parâmetros de Convênio Open Banking'''
[[Arquivo:Wizard Passo 3-4 Final Sicredi.png|750x500px|nenhum|Wizard_Passo_3-4_Final_Sicredi]]
 
Atualizado Wizard para Versão 2 do Open Banking, disponibilizando duas opções:
 
'''- Direto''': esta opção tem como finalidade registrar o Boleto no momento da sua geração, ou seja, quando selecionado ativa propriedade ao qual ao gerar o Boleto Bancário o sistema automaticamente envia o registro Open Banking, sem a necessidade de fazer o processo de envio da Remessa Open Banking do título.
 
'''- PIX''': esta opção fica habilitada somente quando selecionado a opção '''Direto''', ela tem como finalidade registrar uma operação PIX para os Boletos emitido de forma Direta (opção '''Direto''' marcado).
 
Esta opção é válida '''SOMENTE''' para o Banco do Brasil.
 
Ao emitir o Boleto do Lançamento o sistema marca as 3 opções:
 
- Boleto Impresso;
 
- Remessa Enviada;
 
- Código de Barras Lido;
 
Outra mudança é no '''Histórico''' Open Banking, ao qual passa criar o registro com '''Status Open Banking''' já '''Registrado'''.
 
Também ao acessar os '''Dados API''' é enviado a tag: "indicadorPix": "S", pois a opção PIX esta selecionada.
 
Disponibilizado o Modelo de Relatório para o Boleto Banco do Brasil já com o QRCode:
 
'''I:\CIGAM\DOC\Modelos_relatorios\Gestão Financeira\Bloquetos Merge\0098_brasil_PIX.rtf'''

='''Como realizar a Baixa de um Lançamento Financeiro Registrado Open Banking e enviar o Registro de Baixa?'''=
 
'''IMPORTANTE:''' O processo de Cancelamento de Notas Fiscais, não atende a baixa automatica dos Boletos, logo deve ser baixado manualmente os registros dos Lançamentos Financeiros.
 
Para realizar o processo de '''Baixa''' de um Lançamento Financeiro que foi registrado via Open Banking, basta acessar o Lançamento Financeiro.
 
'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 
Selecionar a opção de Menu Lateral do Lançamento Financeiro '''Open Banking''' e a opção de '''Baixar'''.
 
<center>'''Lançamento Financeiro Registrado/Baixar'''
[[Arquivo:Opção Baixar Lancto.png|750x500px|nenhum|Opção_Baixar_Lancto]]
 
<center>'''Lançamento Financeiro Confirmando Operação'''
[[Arquivo:Deseja Baixar.png|750x500px|nenhum|Deseja_Baixar]]
 
<center>'''Lançamento Financeiro Baixado com Sucesso'''
[[Arquivo:Baixado Sucesso.png|750x500px|nenhum|Baixado_Sucesso]]
 

='''Como parametrizar para envio Open Banking a Negativação ou Protesto?'''=
 
Basta acessar o Cadastro do Portador e inserir os dias no campo '''Protestar após''' na guia '''Configurações.
 

'''Menu > Finanças > Gestão Financeira > Parâmetros > Portadores'''

 
<center>'''Dias de Protesto Cadastro do Portador'''
[[Arquivo:Cadastro Portador Negativacao Sicredi.png|750x500px|nenhum|Cadastro_Portador_Negativacao_Sicredi]]
 

Banco do Sicredi:
 
Para este Banco a negativação é parametrizada no Cadastro do Portador na guia “Configurações” no campo “Protestar após”, é através deste campo que o sistema reconhece e passa considerar o envio das tags para os dados da API do Banco.
 
'''"numDiasNegativacaoAuto": "07",'''

 

='''Como cadastrar as Mensagens de Retorno API Financeira Sugestão Usuário?'''=
 
As Mensagens de Retorno API Financeira é uma funcionalidade para facilitar a identificar e de orientação para com as mensagens provindas das APIs que o Sistema tem conexão.
 
Elas foram implementadas para Open banking.
 
Para acessar o cadastro basta acessar através do Menu:
 
'''Menu: Finanças > Gestão Financeira > Parâmetros > Mensagens de Retorno API Financeiro'''
 

<center>'''Mensagens de Retorno API Financeiro'''
[[Arquivo:Mensagens Retorno API Financeiro.png|750x500px|nenhum|Mensagens_Retorno_API_Financeiro]]
 

'''Banco:''' código do Banco conforme codificação no orgão que rege os Bancos Febraban.
 
'''Código Erro:''' código do erro conforme layout das APIS dos Bancos.
 
'''Status:''' é o código de Status de erro do Servidor retornado da API dos Bancos. (Código HTTP)
 
'''Descrição do Erro (Banco):''' essa descrição é oriunda do Banco retornada pela API deles.
 
'''Sugestão CIGAM:''' esta mensagem é interna do Sistema, ou seja, quando internamente identificarmos uma situação a qual a Mensagem retornada pelo Banco não é clara, vamos alimentar com Mensagens de sugestão, para orientar as possíveis causas, dando um norte para situação.
 
'''Sugestão Cliente:''' este campo é reservado para o próprio usuário, possibilitando cadastrar Mensagens que ele identificar para facilitar no processo de entendimento das Mensagens de Retorno das APIs.
 
Agora através desta aplicação, quando ocorrer um Erro de Open Banking é possível verificar através dos links dispostos na tela de Lançamento Financeiro no campo Situação Open Banking, terá um link para tabela do erro ocorrido.
 
<center>'''Lançamento Financeiro Mensagens de Retorno API Financeiro'''
[[Arquivo:Mensagens Retorno API Financeiro BB OP.png|750x500px|nenhum|Mensagens_Retorno_API_Financeiro_BB_OP]]
 
Ou também através do Histórico Open Banking:
 
<center>'''Lançamento Financeiro Mensagens de Retorno API Financeiro Histórico Open Banking'''
[[Arquivo:Historico OP Mensagens Retorno API Financeiro BB OP.png|750x500px|nenhum|Historico_OP_Mensagens_Retorno_API_Financeiro_BB_OP]]

GF - Como Fazer - Open Banking para Banco Sicredi

2022-04-25T18:29:18Z

Alan.campos: /* Como realizar a Baixa de um Lançamento Financeiro Registrado Open Banking e enviar o Registro de Baixa? */

[[categoria:Como_Fazer_Finanças]]

='''O que significa Open Banking?'''=

Open Banking é um conceito relativamente novo na realidade do mercado financeiro brasileiro. Porém, ele tem ganhado cada vez mais atenção em todo o mundo.
Traduzido, o termo significa “banco aberto”, mas uma tradução mais precisa seria “sistema financeiro aberto”.
O conceito em si trata de algo de simples compreensão. Basicamente, Open Banking é a defesa de que o sistema financeiro adote a tecnologia de forma mais ampla e padronizada, como forma de incentivar e ampliar a oferta e a qualidade dos produtos e serviços financeiros.
A base do Open Banking está na premissa de que os dados pertencem aos consumidores. Logo, caso eles autorizem, esses dados devem ser disponibilizados para que eles possam ter acesso a produtos e serviços que forem mais convenientes.
Na prática, há um pedido para que as instituições abram suas API’s (sigla em inglês para Interface de Programação de Aplicativos) para que terceiros desenvolvam e aprimorem os sistemas e suas funcionalidades.
O objetivo do Open Banking é desenvolver sistemas integrados, que facilitem o controle e transferência de informações de dados, histórico, contas, empréstimos etc. Todo o tipo de produto e serviço oferecido pelos bancos seria integrado de maneira a evitar processos complicados e dispendiosos.
À primeira vista, pode parecer que com o Open Banking as informações dos clientes ficarão soltas e desprotegidas. No entanto, os bancos e instituições financeiras ainda serão responsáveis pela proteção de dados sigilosos.

='''Serviços Disponíveis pela API do Banco nesta Versão?'''=
'''Menu > Utilidades/Diversos > Genéricos > Parâmetros > Configurações'''
 
<center>
{| class="wikitable"
|-
! SERVIÇO !! COBRANÇA
|-
| Registro de Boleto via API || SIM
|-
| Open Banking PIX no Boleto || NÃO
|-
| Retorno de Cobrança via API || NÃO
|-
| Alteração de Juros via API || SIM
|-
| Alteração de Multa via API || SIM
|-
| Alteração de Vencimento via API || SIM
|-
| Alteração de Baixa via API || SIM
|-
|}
</center>
 

='''Como obter as Credenciais para utilizar a Funcionalidade Open Banking?'''=
 
As credenciais do Banco devem ser obtidas através do contato com o seu Gerente de Cash (Gerente da Conta no Banco).
 
O Banco Sicredi, possui uma nomenclatura interna para esse processo, conhecido como Registro de Cobrança OnLine ou Ecommerce, conforme documentação.
 
Então ao entrar em contato com o Gerente de Cash, validar as nomenclaturas para que haja o entendimento da funcionalidade.
 

='''Quais os Módulos necessários para utilizar a Funcionalidade Open Banking”?'''=

• Módulo Gestão Financeira;

='''Quais são as parametrizações necessárias para utilizar a funcionalidade do Open Banking Banco Sicredi?'''=

'''Itens Importantes na Parametrização:'''
 
'''- Processar retornos pelo número do Boleto:''' esta opção deve estar marcada, pois caso contrário ocorrerá problemas na gravação das informações e envio para Banco.
 
Caso tenha sido realizado movimentações com esta opção desmarcada, não será possível realizar a Baixa, pois sistema não consegue localizar devido não possuir o '''Nosso Número''' gravado nas tabelas envolvidas.
 
Para solucionar essa questão será necessário:
 
'''1-''' Identificar o '''Nosso Número''' do registro a ser baixado (Lançamento Financeiro);
 
'''2-''' Gravar o '''Nosso Número''' nas seguintes tabelas:
 
'''GFBOLETOS:''' campo a ser atualizado '''NOSSO_NRO''' com a informação do Nosso Número.
 
'''GFLAUXIL:''' campo a ser atualizado '''CODIGO_BARRAS''' com a informação do Nosso Número.
 
'''- Processar retornos pelo número do Boleto:''' esta opção deve estar marcada, pois caso contrário ocorrerá problemas na gravação das informações e envio para Banco.
 
 
'''Importante preenchimento Telefone''': o não preenchimento do Telefone no Cadastro de Empresa acarretará em Erro no Registro Open Banking. Não é um item obrigatório, porém o Banco Sicredi para registrar necessita o preenchimento deste dado. Não deve ser utilizado espaços ou caracteres especiais.
 
Para utilizar esta funcionalidade é necessário possuir o Cadastro do Portador para o Banco citado.
O cadastro quando preenchido corretamente garante que não ocorrerá inconsistências no momento do registro do Open Banking.
 
Como boa prática de implementação é mais coerente criar um novo Portador para Open Banking evitando assim de alterar o Portador utilizado para CNAB caso necessite realizar algum processo via remessa ou retorno, quando a API do Banco estiver com instabilidade.
 
Essa parametrização deverá validar os últimos Sequenciais da numeração de Boletos do Portador utilizado para as Remessas, pois assim garante que não ocorrerá conflito enviar uma numeração de Título já registrado.
 
 
Itens importantes na parametrização:
 
- '''Nº Banco''';
 
- '''Nº Conta''';
 
- '''Nº Convênio''';
 
- '''Agência/DV''': o DV da Agência é considerado o '''Posto''' da Agência, ou seja, para adquirir essa informação o Banco da Unidade da Agência deve fornecer.
 
Quando se tratar do Portador Open Banking do SICREDI, o campo '''DV''' da Agência deve ser preenchido conforme a Unidade da Agência do Banco.
 
- '''Código Cedente''';
 
Para o correto funcionamento da rotina é necessário que os dados do Portador esteja com todas informações necessárias, inclusive o Convênio.
 
'''Menu > Finanças > Gestão Financeira > Parâmetros > Portadores'''
 
Este cadastro é apenas uma demonstração de parametrização:
 
<center>'''Cadastro de Portador'''
[[Arquivo:Cadastro Portador Principal.png|750x500px|nenhum|Cadastro_Portador_Principal]]
 
<center>'''Guia CNAB'''
[[Arquivo:Cadastro Portador CNAB Sicredi.png|750x500px|nenhum|Cadastro_Portador_CNAB]]
 

Campo "Especie" quando utilizado Open Banking deve ser = A para Duplicata Mercantil.

<center>'''Guia Configurações'''
[[Arquivo:Cadastro Portador Configurações Sicredi.png|750x500px|nenhum|Cadastro_Portador_Configurações_Sicredi]]
 

'''Irá surgir a necessidade de realizar a alteração de Vencimento, Multa ou Juros do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?'''
 
Regra Sistema para Vencimento, Multa ou Juros:
 
Cadastro do Portador deve possuir Comando de Remessa com as novas opções:
 
'''Tipo de Comando =''' Alteração de Vencimento (para alteração de Vencimento).
 
'''Tipo de Comando =''' Alteração de Multa para Multa (para alteração de Multa).
 
'''Tipo de Comando =''' Alteração de Juros para Juros (para alteração de Juros).
 
Caso não seja parametrizado neste primeiro momento as opções de Multa e Juros o sistema cria automaticamente (Somente Juros e Multa).
 
Ao acessar o Lançamento Financeiro em modo Modificar e alterar o campo Multa de ou Juros de, automaticamente após alteração da Multa, o Sistema irá criar essa parametrização do Comando de Remessa com sugestão, sendo passível de alteração, no Cadastro do Portador no botão Remessas e depois no botão Comandos.
 
'''Comando sugestão para Multa:'''
 
'''Código Operação''' = ATM
 
'''Comando''' = ATM
 
'''Descrição''' = ALTERAÇÃO DE MULTA PARA OPEN BANKING
 
'''Tipo de Comando''' = Alteração de Multa
 
'''Comando sugestão para Juros:'''
 
'''Código Operação''' = ATJ
 
'''Comando''' = ATK
 
'''Descrição''' = ALTERAÇÃO DE JUROS PARA OPEN BANKING
 
'''Tipo de Comando''' = Alteração de Juros
 
<center>'''Botão Remessas > Comandos'''
[[Arquivo:Cadastro Portador Comando Remessa.png|750x500px|nenhum|Cadastro_Portador_Comando_Remessa]]
 
<center>'''Botão Retornos > Códigos de Retorno'''
[[Arquivo:Cadastro Portador Codigo Retorno.png|750x500px|nenhum|Cadastro_Portador_Codigo_Retorno]]
 
Para iniciar a configuração através do “Assistente de Parâmetros do Open Banking”, basta selecionar o botão “Open Banking”:
 
'''Menu > Finanças > Gestão Financeira > Parâmetros > Configuração de Bancos'''
 
 
<center>'''Configurações de Banco'''
[[Arquivo:Cadastro Configuraçao Banco.png|750x500px|nenhum|Cadastro_Configuraçao_Banco]]
 
 
Para dar início ao processo de parametrização, basta selecionar o botão “Avançar”:
 
 

='''Tela Inicial Configuração do Assistente Open Banking:'''=
 
Para iniciar a configuração é necessário ter em mãos os seguintes dados: (Código de Acesso).
Sem essas informações não será possível dar continuidade na parametrização do Open Banking para o Banco do Sicredi.
 
<center>'''Tela Inicial Assistente de Parâmetros Open Banking'''
[[Arquivo:Wizard Bem Vindo.png|750x500px|nenhum|Wizard_Bem_Vindo]]
 


=='''Etapa 1 (Parâmetros: Passo 1 de 4):'''==


Uma das etapas mais importantes e que requer um cuidado maior e sigilo das informações nesta parametrização.
 
Essas informações são disponibilizadas pelo Banco a qual deve ser restrita somente a pessoa responsável pelo setor Financeiro da Empresa.
 
O assistente tem como objetivo proporcionar que o próprio usuário tenha autonomia para executar esse passo a passo sem necessidade de passar essas informações restritas da Empresa para qualquer pessoa que não seja ele mesmo.
 
Reforçando, mesmo que tenha dificuldades para executar esta etapa, não repasse nenhuma informação relacionado aos acessos dos tokens.
 
Dados em mãos para informar os respectivos campos, basta copiar e colar as informações.
 
Código de Acesso.
 
O Campos '''Código de Acesso''' possui uma tecnologia de criptografia, ou seja, após informar os dados nos campos o sistema irá criptografar as informações garantindo e mantendo a segurança das informações.
 
Caso haja necessidade de alterações, basta clicar no ícone do "Cadeado", será aberta a tela de Criptografia e após colar ou digitar as informações em tela e selecionar o botão "Confirmar".
 
Também tenha alguma dúvida no dado informado e necessitar validar o dado seguindo os mesmos passos da alteração será aberta a tela de Criptografia e após colar ou digitar as informações em tela e selecionar o botão "Validar", sistema confirma se os dados são os mesmos.
 
Observamos que esta tela possui duas guias, uma de Homologação e Produção. Preencher conforme a necessidade do processo, caso precise realizar testes, parametrize em homologação e posteriormente parametrize o de Produção ou se preferir, pode preencher os dois se possuir os dados.
 
Lembrando que esses dados são confidenciais de uso e exclusivo de cada usuário.
 
Através dessas informações o sistema irá se comunicar com API do Banco para poder realizar os registros dos Lançamentos.
 
Após informado os dados, basta selecionar o botão "Avançar", para seguir os próximos passos.
 
'''Código de Acesso:''' informar a codificação passada pelo Banco.
 
 
<center>'''Parâmetros: Passo 1 de 4'''
[[Arquivo:Wizard Passo 1 Sicredi.png|750x500px|nenhum|Wizard_Passo_1_Sicredi]]
 

=='''Etapa 2 (Portador de Remessa e Retorno - Pagamento: Passo 2 de 4):'''==

Nesta etapa deve ser selecionado o Portador que será considerado para o envio da Remessa de Pagamento (onde estarão os boletos em aberto) e nesta mesma tela informar o qual Portador será considerado para o Retorno de Pagamento (onde serão liquidados os retornos de Pagamentos).
 
Nesta etapa, é possível pular, caso não utilize ainda o Envio de Pagamentos do Open Banking.
 
'''Pular:''' caso deseja pular essa etapa e prosseguir com o processo de parametrização do Open Banking.
 
'''Avançar:''' dá continuidade ao processo de parametrização, após selecionado uma opção.
 
Para continuar a parametrização selecione o botão "Pular" e siga para os próximos passos.
 
<center>'''Portador de Remessa e Retorno: Passo: 2 de 4'''
[[Arquivo:Wizard Passo 2 Sicredi.png|750x500px|nenhum|Wizard_Passo_2_Sicredi]]
 

=='''Etapa 3 (Convênios de Cobrança: Passo 3 de 4):'''==
 
Nesta etapa o sistema avalia sua base de dados, e localiza os Convênios parametrizados para o Banco Sicredi, onde serão listados.
O sistema possibilita a parametrização de Convênios específicos bem como caso seja optado, selecionando o botão "Pular" o sistema criará automaticamente o Convênio "Geral", ao qual utiliza dados do Portador registrado.
 
'''Pular:''' caso deseja pular essa etapa e prosseguir com o processo de parametrização do Open Banking.
 
'''Avançar:''' dá continuidade ao processo de parametrização, após selecionado uma opção.
 
<center>'''Convênios de Cobrança: Passo 3 de 4'''
[[Arquivo:Wizard Passo 3 Sicredi.png|750x500px|nenhum|Wizard_Passo_3_Sicredi]]
 

=='''Etapa 3 (Portador de Remessa e Retorno - Cobrança: Passo 3 de 4):'''==
 
Nesta etapa deve ser selecionado o Portador que será considerado para o envio da Remessa de Cobrança (onde estarão os boletos em aberto) e nesta mesma tela informar o qual Portador será considerado para o Retorno de Cobrança (onde serão liquidados os retornos de Cobranças).
 
'''Avançar:''' dá continuidade ao processo de parametrização, após selecionado uma opção.
 
<center>'''Portador de Remessa e Retorno - Cobrança: Passo 3 de 4'''
[[Arquivo:Wizard Passo 3-4 Final Sicredi.png|750x500px|nenhum|Wizard_Passo_3-4_Final_Sicredi]]
 
Atualizado Wizard para Versão 2 do Open Banking, disponibilizando duas opções:
 
'''- Direto:''' esta opção tem como finalidade registrar o Boleto no momento da sua geração, ou seja, quando selecionado ativa propriedade ao qual ao gerar o Boleto Bancário o sistema automaticamente envia o registro Open Banking, sem a necessidade de fazer o processo de envio da Remessa Open Banking do título.
 
Também quando selecionada, terá uma particularidade na questão da Emissão de Boletos em lote pela Rotina de Emissão de Boletos Personalizados. A rotina na guia '''Opções''' tem a opção '''Enviar somente Lançamentos não marcados e marca-los''', caso esteja desmarcada o Registro Open Banking ocorrerá da mesma forma que o sistema irá marcar a opção '''Boleto Impresso''' do Lançamento Financeiro, registrando a Operação Open Banking.
Isso ocorre para manter a integridade, já que esta operação é considerada única no registro, sendo então necessário marcar a '''Boleto Impresso''', para poder conseguir realizar alterações como Alteração de Vencimento ou mesmo a Baixa, sendo uma condição de Sistema.
 
'''- PIX''': esta opção tem como finalidade registrar uma operação PIX para os Boletos emitido de forma Direta (opção '''Direto''' marcado).
 
Esta opção é válida '''SOMENTE''' para o Banco do Brasil.
 

=='''Etapa 4 (Relatório: Passo 4 de 4):'''==

 
Nesta etapa o sistema irá buscar automaticamente o Modelo de Relatório Padrão, caso exista no ambiente, facilitando assim todo processo de parametrização e implementação para usuário.
 
A busca é realizado '''(%CIGAM_INSTAL%RF00071_remessas.RTF)''', com isso é importante que o Modelo de Relatório (RF00071_remessas.RTF) esteja devidamente localizado na pasta padrão do Cigam_Instal, como por exemplo:
 
'''%CIGAM_INSTAL%''' = P:\Cigam11\Projects\Controle\MACIEL\Financeiro_Open_Banking
 
"P:\Cigam11\Projects\Controle\MACIEL\Financeiro_Open_Banking\Modelos\Relatorios\Gestao Financeira\RF00071_remessas.RTF"
 
Clicar em "Avançar" para dar seguimento.
 
<center>'''Assistente de Parâmetros Open Banking: Passo 4 de 4'''
[[Arquivo:Wizard Passo 4-4 Relat Sicredi.png|750x500px|nenhum|Wizard_Passo_4-4_Relat_Sicredi]]
 
 

=='''Etapa Conclusão (Parâmetros de Convênio Open Banking - Conclusão):'''==

 
Esta etapa o sistema faz validação da comunicação com o Banco através da API verificando o ambiente se esta tudo ok, listando em tela.
 
Após a consulta estar "OK", basta clicar no botão "Concluir" e seu ambiente estará apto para utilizar a funcionalidade Open Banking.
 
<center>'''Parâmetros de Convênio Open Banking: Passo Final - Conclusão'''
[[Arquivo:Wizard Passo Final Conclusao Conexao Sicredi.png|750x500px|nenhum|Wizard_Passo_Final_Conclusao_Conexao_Sicredi]]
 
'''Homologação:''' Conexão realizada com sucesso.
 
'''Produção:''' Conexão realizada com sucesso.
 
O servidor remoto retornou um erro: (401) Não Autorizado. Isso ocorre quando não houve a parametrização dos dados em Produção como foi realizado no ambiente de Homologação conforme o passo a passo, ou possa ter ocorrido algum erro na comunicação com o Banco.
 
<center>'''Convênio Cadastrado com Sucesso - Cobrança'''
[[Arquivo:Parametros OP Sicredi.png|750x500px|nenhum|Parametros_OP_Sicredi]]
 
'''Ambiente:''' lista qual é o ambiente cadastrado, sendo apenas duas opções: Homologação e Produção.
 
'''Convênios:''' neste grupo serão listados todos os convênios cadastrados, bem como todas informações pertinentes como:
 
- Portador;
 
- Agência;
 
- Número Conta;
 
- Portador de retorno;
 
'''- Direto:''' esta opção tem como finalidade registrar o Boleto no momento da sua geração, ou seja, quando selecionado ativa propriedade ao qual ao gerar o Boleto Bancário o sistema automaticamente envia o registro Open Banking, sem a necessidade de fazer o processo de envio da Remessa Open Banking do título.
 
'''- PIX:''' esta opção fica habilitada somente quando selecionado a opção Direto, ela tem como finalidade registrar uma operação PIX para os Boletos emitido de forma Direta (opção Direto marcado).
 
Esta opção é válida SOMENTE para o Banco do Brasil.
 
Ao emitir o Boleto do Lançamento o sistema marca as 3 opções:
 
- Boleto Impresso;
 
- Remessa Enviada;
 
- Código de Barras Lido;
 
'''U.N Ced.:''' esta opção tem como finalidade possibilitar o envio e registro de Boletos de outras Unidades de Negócio.
 
Basta informar a Unidade desejada no campo e o sistema entenderá quando realizado o processo de registro de um título que não seja da Unidade Matriz, então sistema identifica e realiza o processo de envio e registro.
Se deixar em Branco a Unidade Cedente irá considerar para todas Unidades de Negócio.
 
 
<center>'''Convênio Cadastrado com Sucesso - Pagamento'''
[[Arquivo:Parametros OP Sicredi Pagamento.png|750x500px|nenhum|Parametros_OP_Sicredi_Pagamento]]
 
'''Ambiente:''' lista qual é o ambiente cadastrado, sendo apenas duas opções: Homologação e Produção.
 
'''Convênios:''' neste grupo serão listados todos os convênios cadastrados, bem como todas informações pertinentes como:
 
- Portador;
 
- Agência;
 
- Número Conta;
 
- Portador de retorno;
 
<center>'''Ícone Credenciais'''
[[Arquivo:Parametros OP Sicredi Credenciais.png|750x500px|nenhum|Parametros_OP_Sicredi_Credenciais]]
 
Através deste ícone é possível verificar os Parâmetros API parametrizados, tanto em homologação quanto em produção.
 
 
<center>'''Ícone Endereços'''
[[Arquivo:Parametros OP Sicredi Endereços.png|750x500px|nenhum|Parametros_OP_Sicredi_Endereços]]
 
Através deste ícone é possível verificar todos endereços de URLs parametrizados.

='''O que significa a Categoria Open Banking de acesso?'''=
 
 A Categoria Open Banking é uma Categoria que é habilitada mediante a utilização de um Portador parametrizado com as Configurações de Banco Open Banking. A mesma tem como objetivo proporcionar maior agilidade e gerenciamento das atividades relacionadas a Remessa de Cobrança Online.
 
'''Categoria Open Banking'''
 
 
<center>'''Categoria Open Banking'''
[[Arquivo:Categoria Open Banking.png|750x500px|semmoldura|nenhum|Categoria_Open_Banking]]
 
 

'''Registrar:''' item de categoria tem como funcionalidade registrar o Boleto Bancário Online. Substitui todo o processo de geração do arquivo de Remessa de Cobrança, acessar o site e remeter ao Banco esse arquivo, com apenas um clique na opção.
 
'''Reenviar:''' item de categoria tem como funcionalidade possibilitar o reenvio de registros que estão com alguma pendência ou algum erro de parametrização. Será habilitado somente quando já possuir movimento de "Registro" enviado, cuja Situação estiver com pendência ou erro.
 
'''Baixar:''' item de categoria tem como funcionalidade comunicar o Banco referente a Baixa do movimento em questão do Boleto Bancário. Utilizado para eventuais falhas operacionais, como registrado um movimento por engano, ou negociações diretamente com cliente a parte. Eliminando então também todo processo de geração do arquivo de Remessa Bancária com Comando de Remessa de Baixa e o processo de remeter ao Banco o arquivo, sendo realizado tudo online através desta opção.
 
'''Registrar Alteração:''' item de categoria tem como funcionalidade registrar uma alteração ocorrida referente ao "Vencimento" do Lançamento Financeiro.
Ao realizar alteração da Data de Vencimento do Lançamento Financeiro que está com "Situação Open Banking" igual "Registrado" e ocorrer alteração no Vencimento, o sistema emite uma mensagem possibilitando já o envio da alteração no momento ou mais tarde através desta opção de "Registrar Alteração".
 
'''Histórico:''' item de categoria tem como funcionalidade gravar todas movimentações realizadas relativo ao Open Banking. Registros, Baixas, Erros...

='''Layout e Detalhamento de Campos API'''=
==Registro de Boletos==
<center>

{| class="wikitable"
|-
! Nº !! Campo JSON !! Descriçao do Banco !! Campo CIGAM !! Tabela !! Obrigatório !! Observações
|-
| 1 || token || Chave Transacional gerada pelo recurso /autenticacao || || || Obrigatório ||
|-
| 2 || Content-Type || Estabelece o tipo de conteúdo da requisição || || || Obrigatório ||
|-
| 3 || agencia || Código da Cooperativa do beneficiário || Agência || Portador || Obrigatório ||
|-
| 4 || posto || Código do Posto do beneficiário || Dígito Agência || Portador || Obrigatório ||
|-
| 5 || cedente || Código do Convênio de Cobrança do beneficiário || Código Cedente || Portador || Obrigatório ||
|-
| 6 || nossoNumero* || Nosso Número || Nosso Número || Boletos || Opcional ||
|-
| 7 || codigoPagador || Código Pagador || Não Tratado || Não Tratado || Opcional ||
|-
| 8 || tipoPessoa* || Tipo de pessoa do pagador.
'''Domínio:'''
 
1 - PESSOA FÍSICA
 
2 - PESSOA JURÍDICA
|| Pessoa || Empresa || Obrigatório ||
|-
| 9 || cpfCnpj* || CPF ou CNPJ do pagador || CNPJ/CPF || Empresa || Obrigatório ||
|-
| 10 || nome || Nome do pagador || Nome Completo || Empresa || Obrigatório ||
|-
| 11 || endereco || Endereço do pagador || Endereço || Empresa || Opcional || Será obrigatório se o código do pagador '''não''' for informado.
|-
| 12 || cidade || cidade || Município || Empresa || Opcional || Será obrigatório se o código do pagador '''não''' for informado.
|-
| 13 || uf || Estado do pagador || UF || Empresa || Opcional || Será obrigatório se o código do pagador '''não''' for informado.
|-
| 14 || cep || CEP do pagador || CEP || Empresa || Obrigatório ||
|-
| 15 || telefone || Telefone mais DDD do pagador || Fone || Empresa || Opcional || Será obrigatório se o código do pagador '''não''' for informado.
|-
| 16 || email || Endereço de email do pagador || Email || Contato || Opcional ||
|-
| 17 || especieDocumento || Espécie de documento do título.(*) || Espécie || Portador || Obrigatório ||
|-
| 18 || codigoSacadorAvalista || Código do sacador avalista. || Não Tradado || Não Tradado || Opcional ||
|-
| 19 || seuNumero || Número de controle interno do beneficiário que referencia o pagador. || Lançamento || LANCAM || Obrigatório ||
|-
| 20 || dataVencimento || Data de vencimento do boleto || Vencimento || Boletos || Obrigatório ||
|-
| 21 || valor || Valor do boleto || Saldo || LANCAM || Obrigatório ||
|-
| 22 || tipoDesconto || Tipo de desconto.
'''Domínios:'''
 
A - VALOR
 
B - PERCENTUAL
|| Não Tratado || Não Tratado || Obrigatório ||
|-
| 23 || valorDesconto1 || Valor de desconto 1 || Valor Desconto || LANCAM || Opcional || Será obrigatório se o dataDesconto1 for informado.
|-
| 24 || dataDesconto1 || Data limite para concessão de desconto1 || Vencimento || LANCAM || Opcional || Será obrigatório se o valorDesconto1 for informado. Não pode ser igual a outras dataDescontos e nem maior que vencimento.
|-
| 25 || valorDesconto2 || Valor de desconto 2 || Não Tratado || Não Tratado || Opcional || Será obrigatório se o dataDesconto2 for informado.
|-
| 26 || dataDesconto2 || Data limite para a concessão de desconto 2 || Não Tratado || Não Tratado || Opcional || Será obrigatório se o valorDesconto2 for informado. Não pode ser igual a outras dataDescontos e nem maior que vencimento.
|-
| 27 || valorDesconto3 || Valor de desconto 3 || Não Tratado || Não Tratado || Opcional || Será obrigatório se o dataDesconto3 for informado.
|-
| 28 || dataDesconto3 || Data limite para a concessão de desconto 3 || Não Tratado || Não Tratado || Opcional || Será obrigatório se o valorDesconto3 for informado. Não pode ser igual a outras dataDescontos e nem maior que vencimento.
|-
| 29 || tipoJuros || Tipo de Juros.
'''Domínios:'''
 
A - VALOR
 
B - PERCENTUAL
|| || || Obrigatório ||
|-
| 30 || juros || Valor de juros a cobrar por dia. || Juros Dia || LANCAM || Opcional ||
|-
| 31 || multas || Percentual de multa a cobrar || Valor Multa || LANCAM || Opcional ||
|-
| 32 || desconto Antecipado || Valor de desconto antecipado a cobrar || Não Tratado || Não Tratado || Opcional || Deve ser menor que o valor.
|-
| 33 || informativo || Texto do Informativo || Não Tratado || Não Tratado || Opcional ||
|-
| 34 || mensagem* || Texto da linha da mensagem || Não Tratado || Não Tratado || Opcional ||
|-
| 35 || codigoMensagem || Código da mensagem || Não Tratado || Não Tratado || Opcional ||
|-
| 36 || numDiasNegativacaoAuto || Número de dias para Negativação Automática. 0 (Zero) para não negativar automaticamente. Quando preenchido com 3 ou 4 dias o sistema comandará negativação em dias úteis após o vencimento. Quando preenchido acima de 4 dias, o sistema comandará negativação em dias corridos após o vencimento. || Protesto || Portador || Opcional ||
|-
| 37 || NomeBeneficiarioFinal || NomeBeneficiarioFinal || Não Tratado || Não Tratado || Obrigatório caso informado TipoPessoaBeneficiarioFinal e CpfCnpjBeneficiarioFinal ||
|-
| 38 || TipoPessoaBeneficiarioFinal || Tipo de pessoa.
'''Domínios:'''
 
1 - Física
 
2 - Jurídica
|| Não Tratado || Não Tratado || Obrigatório caso informado NomeBeneficiarioFinal e CpfCnpjBeneficiarioFinal ||
|-
| 39 || CpfCnpjBeneficiarioFinal || CPF/CNPJ do beneficiário final || Não Tratado || Não Tratado || Obrigatório caso informado NomeBeneficiarioFinal e TipoPessoaBeneficiarioFinal ||
|-
| 40 || FoneBeneficiarioFinal || Fone do beneficiário final || Não Tratado || Não Tratado || Opcional ||
|-
| 41 || EnderecoBeneficiarioFinal || Endereço do beneficiário final || Não Tratado || Não Tratado || Opcional ||
|-
| 42 || CepBeneficiarioFinal || CEP do beneficiário final || Não Tratado || Não Tratado || Opcional ||
|-
| 43 || CidadeBeneficiarioFinal || CidadeBeneficiarioFinal || Não Tratado || Não Tratado || Opcional ||
|-
| 44 || UfBeneficiarioFinal || UF do beneficiário final || Não Tratado || Não Tratado || Opcional ||
|-
|}

</center>

'''(*) Domínios:'''
 
A - DUPLICATA MERCANTIL (DM)
 
B - DUPLICATA RURAL (DR)
 
C - NOTA PROMISSORIA (NP)
 
D - NOTA PROMISSORIA RURAL (NR)
 
E - NOTA DE SEGURO (NS)
 
G - RECIBO (RC)
 
H - LETRA DE CAMBIO (LC)
 
I - NOTA DE DEBITO (ND)
 
J - DUPLICATA DE SERVICO (DS)
 
K - OUTROS (OS)
 
O - BOLETO OFERTA (OFE)

==Alteração de Boletos==
<center>

{| class="wikitable"
|-
! Nº !! Campo JSON !! Descriçao do Banco !! Campo CIGAM !! Tabela !! Obrigatório !! Observações
|-
| 1 || agencia || Agência do Beneficiário || Agência || Portador || Obrigatório ||
|-
| 2 || posto || Posto do Beneficiário || Dígito Agência || Portador || Obrigatório ||
|-
| 3 || cedente || Código do Beneficiário || Código Cedente || Portador || Obrigatório ||
|-
| 4 || nossoNumero* || Nosso Número do Título || Nosso Número || Boletos || Obrigatório ||
|-
| 5 || instrucaoComando || Comando que será realizado na alteração do boleto. || || || Obrigatório || Caso seja informado ALTERACAO_OUTROS_DADOS será '''obrigatória''' a inclusão do campo complementoInstrucao.
|-
| 5.1 || PEDIDO_BAIXA || || || || Obrigatório || Consultar o Termo de Adesão com sua Unidade de Atendimento Sicredi p/ ver se está com Baixa Automática de boletos vencidos. Caso esteja, o boleto vencido terá sua baixa efetuada automaticamente.
|-
| 5.2 || CONCESSAO_ABATIMENTO || || || || Obrigatório ||
|-
| 5.3 || CANCELAMENTO_ABATIMENTO_CONCEDIDO || || || || Obrigatório ||
|-
| 5.4 || ALTERACAO_VENCIMENTO || || || || Obrigatório ||
|-
| 5.5 || ALTERACAO_SEU_NUMERO || || || || Obrigatório ||
|-
| 5.6 || PEDIDO_PROTESTO || || || || Obrigatório || Somente em título vencido. Por padrão, todos os boletos emitidos pelo EComm-API, não são protestados.
|-
| 5.7 || SUSTAR_PROTESTO_BAIXAR _TITULO || || || || Obrigatório ||
|-
| 5.8 || SUSTAR_PROTESTO_MANTER_CARTEIRA || || || || Obrigatório ||
|-
| 5.9 || ALTERACAO_OUTROS_DADOS || || || || Obrigatório ||
|-
| 6 || complementoInstrucao || Complemento do comando que será realizado na alteração do boleto || || || Condicional ||
|-
| 6.1 || DESCONTO || || || || Condicional ||
|-
| 6.2 || JUROS_DIA || || || || Condicional ||
|-
| 6.3 || DESCONTO_DIA_ANTECIPACAO || || || || Condicional ||
|-
| 6.4 || DATA_LIMITE_CONCESSAO_DESCONTO || || || || Condicional ||
|-
| 6.5 || CANCELAMENTO_PROTESTO _AUTOMATICO || || || || Condicional ||
|-
| 6.6 || CANCELAMENTO_NEGATIVACAO_AUTOMATICA || || || || Condicional ||
|-
| 7 || ''Campo de Alteração'' || Nome do campo que deseja mudar || || || Obrigatório ||
|-
|}

</center>

='''Como realizar a criação de Lançamentos utilizando a funcionalidade Open Banking?'''=
 
Para a criação de Lançamentos Financeiros acessar o caminho de Menu:
 

'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 

Acessar o botão “Criar” e informar os dados necessários para a criação do Lançamento Financeiro a Receber utilizando o Portador parametrizado para Open Banking.
 
 
'''1- Etapa criação do Lançamento:'''
 
 
<center>'''Criação do Lançamento Financeiro a Receber'''
[[Arquivo:Create Lanc Open Banking.png|750x500px|semmoldura|nenhum|Criação do Lançamento Financeiro]]
 
 

'''2- Etapa Impressão do Boleto Bancário do Lançamento Financeiro:'''
 
Nesta etapa pode ser realizado a impressão do Boleto Bancário diretamente pelo próprio Lançamento Financeiro ou através da rotina de Emissão em lote "Emissão de Boletos Personalizados":
 
 
<center>'''Impressão do Boleto Bancário do Lançamento Financeiro'''
[[Arquivo:Imprimir Boleto Lanc.png|750x500px|semmoldura|nenhum|Impressão Boleto Bancário]]
 
 

'''3- Etapa do Registro do Boleto Open Banking:'''
 
Nesta etapa pode ser realizado o "Registro" do Boleto diretamente pelo próprio Lançamento Financeiro ou através da rotina de Emissão em lote "Emissão de Boletos Personalizados":
Basta acessar a Categoria "Open Banking" e selecionar o Item de Categoria "Registrar".
Sistema irá realizar a comunicação através das parametrizações realizadas das Urls e Tokens de acesso e listará a situação do Registro do Boleto Bancário através do Relatório.
 
 
<center>'''Registrar Boleto Open Banking através Lançamento Financeiro'''
[[Arquivo:Boleto Impresso Registrar OP.png|750x500px|semmoldura|nenhum|Registro Boleto Open Banking]]
 
 
<center>'''Relatório Remessa Bancária OnLine'''
[[Arquivo:Relat Registro Open Banking.png|750x500px|semmoldura|nenhum|Relatório Remessa Bancária Online]]
 
 
Após o registro automaticamente o sistema marca as opções de:
 
- Remessa Enviada
 
- Códigos de Barras Lido
 
 
<center>'''Boleto Bancário Registrado'''
[[Arquivo:Lanc Registrado Validar Historico.png|750x500px|semmoldura|nenhum|Lanc_Registrado_Validar_Historico]]
 
 
Para verificar todas as movimentações realizada sobre Open Banking, elas estão sendo gravadas no Item de Categoria "Histórico" que fica na Categoria "Open Banking".
Ao selecionar o Item de Categoria "Histórico" deve listar o Registro do Boleto Bancário.
 
 
<center>'''Item de Categoria Histórico de Movimentos Open Banking'''
[[Arquivo:Item Categoria Historico.png|750x500px|semmoldura|nenhum|Item_Categoria_Histórico]]
 
 

='''Como realizar o Envio em Lote Open Banking através da rotina Remessa de Cobrança Open Banking?'''=

Assim como é possível realizar o Envio do Registro do Boleto Bancário através do próprio Lançamento Financeiro, existe a possibilidade de realizar esse processo em Lote, quando se tratar de vários registros a serem enviados.
Através do Menu:
 
 
'''Menu: Finanças > Gestão Financeira > Rotinas > EDI> Transmite > Remessa Cobranças Bancárias > Remessa de Cobrança Open Banking'''
 
 
<center>'''Remessa de Cobrança Open Banking'''
[[Arquivo:Remessa_de_Cobranca_Open_Banking_BB3.png|750x500px|semmoldura|nenhum|Remessa_de_Cobranca_Open_Banking]]
 
 
Esta rotina tem um conceito muito simples em relação aos filtros, foram disponibilizados campos essências que permitem ter uma rastreabilidade dos movimentos.

'''Unidade de Negócio:''' informe a Unidade de Negócio desejada para realizar o filtro para busca dos movimentos.
 
'''Data:''' informe a Data desejada para realizar o filtro para busca dos movimentos.
 
'''Vencimento:''' informe o período de Vencimento desejado para realizar o filtro para busca dos movimentos.
 
'''Lançamento:''' informe a faixa de Lançamentos desejada para realizar o filtro para busca dos movimentos.
 
'''Tipo de Pagamento:''' informe o Tipo de Pagamento desejado para realizar o filtro para busca dos movimentos.
 
'''Série:''' informe a Série desejada para realizar o filtro para busca dos movimentos.
 
'''Nota Fiscal:''' informe a faixa de Nota Fiscal desejada para realizar o filtro para busca dos movimentos.
 
'''Conta Financeira:''' informe a Conta Financeira desejada para realizar o filtro para busca dos movimentos.
 
'''Empresa:''' informe a faixa de Empresa desejada para realizar o filtro para busca dos movimentos.
 
'''Cobrança:''' informe a faixa de Empresa de Cobrança desejada para realizar o filtro para busca dos movimentos.
 
 
Após informado os filtros e confirmado a operação da rotina o sistema gera um relatório com a listagem dos movimentos.
Na coluna "Registro", será listado se houve a confirmação ou ocorreu algum erro.
 
 
<center>'''Relatório Remessa de Cobrança Open Banking'''
[[Arquivo:Relat Remessa Bancaria Open Banking.png|750x500px|semmoldura|nenhum|Relat_Remessa_Bancaria_Open_Banking]]
 
 

='''Como realizar a alteração de Vencimento do Lançamento já Registrado Open Banking e reenviá-lo novamente?'''=
 

Irá surgir a necessidade de realizar a alteração do Vencimento do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?
 
'''Dado que''' já temos um Lançamento Financeiro já Registrado Open Banking, basta acessar o Lançamento Financeiro desejado através do caminho do Menu:
 
'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 
Acessar o Lançamento Financeiro em modo Modificar e alterar o campo "Venc.Original", automaticamente após alteração do Vencimento, o sistema insere o Comando "05" no campo "Comando de Remessa" e diante disso já emite uma mensagem:
 
'''Confirma o envio da alteração do título ao banco?'''
 
'''Importante:''' para o envio da alteração do Vencimento o sistema já considera o campo '''Vencimento''', caso seja utilizado a '''Modalidade''' como '''Seguinte''' por exemplo, onde é possível ter um Vencimento Original diferente do Vencimento.
 
<center>'''Lançamento Financeiro a Receber já Registrado'''
[[Arquivo:AlterarVenc Lanc1.png|750x500px|nenhum|AlterarVenc_Lanc1]]
 
 
Vencimento alterado, sistema insere o Comando "05" no campo "Comando de Remessa" e ao salvar o registro é emitido a mensagem: "Confirma o envio da alteração do título ao banco?"
 
<center>'''Vencimento alterado e registro salvo'''
[[Arquivo:Vencimento Alterado Msn.png|750x500px|nenhum|Vencimento_Alterado_Msn]]
 
'''Sim:''' é enviado o registro de alteração do Open Banking e se registrado com sucesso, sistema retira então o Comando de Remessa.
 
<center>'''Processo Concluído com Sucesso'''
[[Arquivo:Processo_Concluido_Sucesso_Lanc.png|750x500px|nenhum|Processo_Concluido_Sucesso_Lanc]]
 
Há possibilidades do tempo de comunicação com API do Banco não retornar imediatamente a confirmação do recebimento da Alteração do Vencimento. Quando ocorrer essa situação, sistema emite uma mensagem, solicitando aguardar, para tentar novamente o envio da alteração do vencimento.
Quando ocorrer essa situação, será necessário aguardar e após realizar o envio novamente ou através do próprio Lançamento ou através da rotina de Remessa de Cobrança - Open Banking, que remeterá as alterações para o Banco.
<center>'''Processo Pendente Alteração - Aguardar'''
[[Arquivo:Alteração Vencimento Processo Pendente Envio Aguardar.png|750x500px|nenhum|Alteração_Vencimento_Processo_Pendente_Envio_Aguardar]]
 
Já quando selecionado a opção '''Não''':
 
'''Não:''' não faz a comunicação do envio da alteração do vencimento via Open Banking. Este registro não foi notificado, logo será necessário realiza-lo através do próprio Lançamento ou através da rotina de Remessa de Cobrança Open Banking.
 
No Lançamento Financeiro é habilitado o botão "Reenviar Registro" no Item de Categoria "Open Banking".
Quando selecionado o botão '''Registrar Alteração''', sistema faz a comunicação via Open Banking e registra alteração de vencimento realizada.
 
<center>'''Lançamento Não Registrado a alteração de Vencimento com o Comando de Remessa'''
[[Arquivo:Botao Registrar Alteracao Habilitado.png|750x500px|nenhum|Botao_Registrar_Alteracao_Habilitado]]
 
Ao selecionar o botão "Registrar Alteração" sistema emite a mensagem para confirmar o envio.
 
<center>'''Botão Registrar Alteração'''
[[Arquivo:Registrar Alteracao Selecionado.png|750x500px|nenhum|Registrar_Alteracao_Selecionado]]
 
Após a confirmação o sistema registra alteração
 
<center>'''Processo Concluído com Sucesso'''
[[Arquivo:Processo_Concluido_Sucesso_Lanc.png|750x500px|nenhum|Processo_Concluido_Sucesso_Lanc]]
 
 
<center>'''Lançamento alterado e registrado'''
[[Arquivo:Lançamento alterado registrado.png|750x500px|nenhum|Lançamento_alterado_registrado]]
 

='''Como realizar a Alteração de Juros do Lançamento já Registrado Open Banking e reenviá-lo novamente?'''=
 

'''Irá surgir a necessidade de realizar a alteração de Juros do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?'''
 
Dado que já temos um Lançamento Financeiro já Registrado Open Banking, basta acessar o Lançamento Financeiro desejado através do caminho do Menu:
 
'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 
'''Regra Sistema para os Juros:'''
 
Se no cadastro do Portador não possuir Comando de Remessa com as novas opções:
 
'''Tipo de Comando =''' Alteração de Juros para Juros
 
'''BANCO SICREDI:''' para este Banco por enquanto atende '''somente''' alteração de Juros para registro Open Banking, não registrando então caso alterado Multas.
 
Ao acessar o Lançamento Financeiro em modo Modificar e alterar o campo '''Juros Dias de''' ou '''Juros Mês de''', automaticamente após alteração dos Juros, o Sistema irá criar essa parametrização do Comando de Remessa com '''sugestão''', sendo passível de alteração, no Cadastro do Portador no botão '''Remessas''' e depois no botão '''Comandos'''.
 
'''Comando sugestão para Juros:'''
 
'''Código Operação =''' ATJ
 
'''Comando =''' ATJ
 
'''Descrição =''' ALTERAÇÃO DE JUROS PARA OPEN BANKING
 
'''Tipo de Comando =''' Alteração de Juros
 
 
<center>'''Cadastro do Portador Comando de Remessa Juros'''
[[Arquivo:Lancto Registrado Alteração Juros Dia 748.png|750x500px|nenhum|Lancto_Registrado_Alteração_Juros_Dia_748]]
 
 

'''Como é identificado a alteração de Juros para Banco?'''
 
Através das tags enviadas para API gravadas no Histórico do Open Banking Dados API:
 
'''instruçãoComando''':'''ALTERACAO_OUTROS_DADOS''' – indica que ocorreu uma alteração de registro no Lançamento.
 
'''complementoInstrucao''': '''JUROS_DIA''' – indica que há Juros no registro.
 
'''valor1''': 0.12, - indica o valor dos Juros.
 
 
<center>'''Lançamento Financeiro a Receber já Registrado alterando os Juros'''
[[Arquivo:Lancto Registrado Alteração Juros Dia.png|750x500px|nenhum|Lancto_Registrado_Alteração_Juros_Dia]]
 
 

Tags enviadas para API Banco:
 
 
<center>'''Dados API Tags referente aos Juros'''
[[Arquivo:Dados API Juros 748.png|750x500px|nenhum|Dados_API_Juros_748]]
 
 

='''Quais são as novidades após atualização para Versão 2 do Open Banking?'''=
 
Disponibilizado a Versão 2 para Open Banking que traz algumas novidades para o processo de Registro no Banco.
 
Nela terá um componente que quando atualizado a Base através do Assistente de Atualização (Atualiza CIGAM) será adicionado nos Parâmetros Open Banking da Configuração de Bancos, especificamente nas Credenciais, o registro '''Versão API''' = v2.
 
'''Finanças > Gestão Financeira > Parâmetros > Configurações de Bancos'''
 
<center>'''Parâmetros Open Banking'''
[[Arquivo:Parametros OP Sicredi Credenciais.png|750x500px|nenhum|Parametros_OP_Sicredi_Credenciais]]
 
A partir desta Versão o Sistema passa a realizar a busca para localizar os títulos da seguinte forma:
 
1- O sistema tenta localizar os títulos pelo Número do Lançamento;
 
2- Caso os títulos tenham sido gerados pelo CIGAM irá localizar pelo '''Nosso Número''', avaliando então a tabela '''GFBOLETOS''' pela coluna '''NOSSO_NRO'''.
 
3- Caso os títulos tenham sido gerados por outro sistema irá localizar pelo '''Nosso Número''', avaliando então a tabela '''GFLAUXIL''' pela coluna '''CODIGO_BARRAS'''.
 
Também nesta versão estão disponíveis as tags para Envio da Série/NF, sendo utilizado a Tag na API '''NumeroTituloBeneficiario'''. A regra é '''Serie''' '''NF''' '''Complemento Duplicata''', bem como descrito com espaços em Branco entre eles. Para verificar esse registro, basta acessar após o Registro no Banco o Histórico Open Banking na guia '''Envio''' e localizar para Tag '''NumeroTituloBeneficiario'''.
 
<center>'''Parâmetros de Convênio Open Banking'''
[[Arquivo:Wizard Passo 3-4 Final Sicredi.png|750x500px|nenhum|Wizard_Passo_3-4_Final_Sicredi]]
 
Atualizado Wizard para Versão 2 do Open Banking, disponibilizando duas opções:
 
'''- Direto''': esta opção tem como finalidade registrar o Boleto no momento da sua geração, ou seja, quando selecionado ativa propriedade ao qual ao gerar o Boleto Bancário o sistema automaticamente envia o registro Open Banking, sem a necessidade de fazer o processo de envio da Remessa Open Banking do título.
 
'''- PIX''': esta opção fica habilitada somente quando selecionado a opção '''Direto''', ela tem como finalidade registrar uma operação PIX para os Boletos emitido de forma Direta (opção '''Direto''' marcado).
 
Esta opção é válida '''SOMENTE''' para o Banco do Brasil.
 
Ao emitir o Boleto do Lançamento o sistema marca as 3 opções:
 
- Boleto Impresso;
 
- Remessa Enviada;
 
- Código de Barras Lido;
 
Outra mudança é no '''Histórico''' Open Banking, ao qual passa criar o registro com '''Status Open Banking''' já '''Registrado'''.
 
Também ao acessar os '''Dados API''' é enviado a tag: "indicadorPix": "S", pois a opção PIX esta selecionada.
 
Disponibilizado o Modelo de Relatório para o Boleto Banco do Brasil já com o QRCode:
 
'''I:\CIGAM\DOC\Modelos_relatorios\Gestão Financeira\Bloquetos Merge\0098_brasil_PIX.rtf'''

='''Como realizar a Baixa de um Lançamento Financeiro Registrado Open Banking e enviar o Registro de Baixa?'''=
 
'''IMPORTANTE:''' O processo de Cancelamento de Notas Fiscais, não atende a baixa automatica dos Boletos, logo deve ser baixado manualmente os registros dos Lançamentos Financeiros.
 
Para realizar o processo de '''Baixa''' de um Lançamento Financeiro que foi registrado via Open Banking, basta acessar o Lançamento Financeiro.
 
'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 
Selecionar a opção de Menu Lateral do Lançamento Financeiro '''Open Banking''' e a opção de '''Baixar'''.
 
<center>'''Lançamento Financeiro Registrado/Baixar'''
[[Arquivo:Opção Baixar Lancto.png|750x500px|nenhum|Opção_Baixar_Lancto]]
 
<center>'''Lançamento Financeiro Confirmando Operação'''
[[Arquivo:Deseja Baixar.png|750x500px|nenhum|Deseja_Baixar]]
 
<center>'''Lançamento Financeiro Baixado com Sucesso'''
[[Arquivo:Baixado Sucesso.png|750x500px|nenhum|Baixado_Sucesso]]
 

='''Como parametrizar para envio Open Banking a Negativação ou Protesto?'''=
 
Basta acessar o Cadastro do Portador e inserir os dias no campo '''Protestar após''' na guia '''Configurações.
 

'''Menu > Finanças > Gestão Financeira > Parâmetros > Portadores'''

 
<center>'''Dias de Protesto Cadastro do Portador'''
[[Arquivo:Cadastro Portador Negativacao Sicredi.png|750x500px|nenhum|Cadastro_Portador_Negativacao_Sicredi]]
 

Banco do Sicredi:
 
Para este Banco a negativação é parametrizada no Cadastro do Portador na guia “Configurações” no campo “Protestar após”, é através deste campo que o sistema reconhece e passa considerar o envio das tags para os dados da API do Banco.
 
'''"numDiasNegativacaoAuto": "07",'''

 

='''Como cadastrar as Mensagens de Retorno API Financeira Sugestão Usuário?'''=
 
As Mensagens de Retorno API Financeira é uma funcionalidade para facilitar a identificar e de orientação para com as mensagens provindas das APIs que o Sistema tem conexão.
 
Elas foram implementadas para Open banking.
 
Para acessar o cadastro basta acessar através do Menu:
 
'''Menu: Finanças > Gestão Financeira > Parâmetros > Mensagens de Retorno API Financeiro'''
 

<center>'''Mensagens de Retorno API Financeiro'''
[[Arquivo:Mensagens Retorno API Financeiro.png|750x500px|nenhum|Mensagens_Retorno_API_Financeiro]]
 

'''Banco:''' código do Banco conforme codificação no orgão que rege os Bancos Febraban.
 
'''Código Erro:''' código do erro conforme layout das APIS dos Bancos.
 
'''Status:''' é o código de Status de erro do Servidor retornado da API dos Bancos. (Código HTTP)
 
'''Descrição do Erro (Banco):''' essa descrição é oriunda do Banco retornada pela API deles.
 
'''Sugestão CIGAM:''' esta mensagem é interna do Sistema, ou seja, quando internamente identificarmos uma situação a qual a Mensagem retornada pelo Banco não é clara, vamos alimentar com Mensagens de sugestão, para orientar as possíveis causas, dando um norte para situação.
 
'''Sugestão Cliente:''' este campo é reservado para o próprio usuário, possibilitando cadastrar Mensagens que ele identificar para facilitar no processo de entendimento das Mensagens de Retorno das APIs.
 
Agora através desta aplicação, quando ocorrer um Erro de Open Banking é possível verificar através dos links dispostos na tela de Lançamento Financeiro no campo Situação Open Banking, terá um link para tabela do erro ocorrido.
 
<center>'''Lançamento Financeiro Mensagens de Retorno API Financeiro'''
[[Arquivo:Mensagens Retorno API Financeiro BB OP.png|750x500px|nenhum|Mensagens_Retorno_API_Financeiro_BB_OP]]
 
Ou também através do Histórico Open Banking:
 
<center>'''Lançamento Financeiro Mensagens de Retorno API Financeiro Histórico Open Banking'''
[[Arquivo:Historico OP Mensagens Retorno API Financeiro BB OP.png|750x500px|nenhum|Historico_OP_Mensagens_Retorno_API_Financeiro_BB_OP]]

GF - Como Fazer - Open Banking para Banco Itaú

2022-04-25T18:22:35Z

Alan.campos: /* Como realizar a alteração de Vencimento do Lançamento já Registrado Open Banking e reenviá-lo novamente? */

[[categoria:Como_Fazer_Finanças]]

=='''O que significa Open Banking?'''==

Open Banking é um conceito relativamente novo na realidade do mercado financeiro brasileiro. Porém, ele tem ganhado cada vez mais atenção em todo o mundo.
Traduzido, o termo significa “banco aberto”, mas uma tradução mais precisa seria “sistema financeiro aberto”.
O conceito em si trata de algo de simples compreensão. Basicamente, Open Banking é a defesa de que o sistema financeiro adote a tecnologia de forma mais ampla e padronizada, como forma de incentivar e ampliar a oferta e a qualidade dos produtos e serviços financeiros.
A base do Open Banking está na premissa de que os dados pertencem aos consumidores. Logo, caso eles autorizem, esses dados devem ser disponibilizados para que eles possam ter acesso a produtos e serviços que forem mais convenientes.
Na prática, há um pedido para que as instituições abram suas API’s (sigla em inglês para Interface de Programação de Aplicativos) para que terceiros desenvolvam e aprimorem os sistemas e suas funcionalidades.
O objetivo do Open Banking é desenvolver sistemas integrados, que facilitem o controle e transferência de informações de dados, histórico, contas, empréstimos etc. Todo o tipo de produto e serviço oferecido pelos bancos seria integrado de maneira a evitar processos complicados e dispendiosos.
À primeira vista, pode parecer que com o Open Banking as informações dos clientes ficarão soltas e desprotegidas. No entanto, os bancos e instituições financeiras ainda serão responsáveis pela proteção de dados sigilosos.

=='''Serviços Disponíveis pela API do Banco Versão 2'''==
Válido para clientes implementados a partir de 01/01/2022.
<center>
{| class="wikitable"
|-
! SERVIÇO !! COBRANÇA
|-
| Registro de Boleto via API || SIM
|-
| Open Banking PIX no Boleto || NÃO
|-
| Retorno de Cobrança via API || NÃO
|-
| Alteração de Juros via API || SIM
|-
| Alteração de Multa via API || SIM
|-
| Alteração de Vencimento via API || SIM
|-
| Alteração de Baixa via API || SIM
|-
|}
</center>

=='''Serviços Disponíveis pela API do Banco Versão 1'''==
Válido somente para clientes implementados até 31/12/2021, data de expiração da versão ainda não definida pelo Banco.
<center>
{| class="wikitable"
|-
! SERVIÇO !! COBRANÇA
|-
| Registro de Boleto via API || SIM
|-
| Open Banking PIX no Boleto || NÃO
|-
| Retorno de Cobrança via API || NÃO
|-
| Alteração de Juros via API || NÃO
|-
| Alteração de Multa via API || NÃO
|-
| Alteração de Vencimento via API || NÃO
|-
| Alteração de Baixa via API || NÃO
|-
|}
</center>

='''Como obter as Credenciais para utilizar a Versão 2 da Funcionalidade Open Banking?'''=

Método utilizado para clientes implementados a partir de 01/01/2022.
 
==Pré-requisitos==

• [https://code.visualstudio.com/ Visual Studio Code]
 
• [https://www.java.com/pt-BR/ Java]
 
• [https://www.openssl.org/ OpenSSL]

==Solicitação de Abertura de Chamado==

Para iniciar o processo de obtenção de credenciais será necessário entrar em contato com o seu gerente de cash (quem gerencia a sua conta corrente que fará os registros de boleto) e solicitar a abertura de um chamado para o uso das APIs, no caso da cobrança será a API de Cash Management.
 
Após a solicitação de abertura do chamado, o cliente receberá as orientações do processo por e-mail.

 
 
==Orientações==
'''1-''' Acessar o [https://developer.itau.com.br/ Portal Developers] com o usuário do responsável da conta corrente e ler a documentação CASH MANAGEMENT voltada para a API - Cobrança;
 
 
<center>'''Todas APIS'''</center>
[[Arquivo:Todas APIS Itau.png|550x300px|centro]]
 
<center>'''API cash_management'''</center>
[[Arquivo:API Cash Management.png|750x500px|centro]]
 
<center>'''Documentações API cash_management'''</center>
[[Arquivo:Documentacoes API Cash Management.png|750x500px|centro]]
 

'''2-''' Utilizar-se do SANDBOX para seus testes estruturais;
 
 
'''3-''' Para geração de Certificado se faz necessário a criação da Chave Pública e envio para o Itaú para serem criados a Credencial e o Token, necessários para o processo.
 
 

==Chave Pública==

Nesta etapa iremos obter o par de chaves gerando a Chave Pública, dando origem à um arquivo ".pem" que deve ser enviado ao gerente de cash para que o mesmo entre em contato com o time de atendimento e dê continuidade ao processo de abertura do chamado. O Par de Chaves sera utilizado para criptografar e decifrar o Token Temporário(access_token_tmp) e o Client ID(CLIENT_ID) quando enviados por e-mail.
 
 
Para visualizar o documento no [https://developer.itau.com.br/ Portal Developers] faça login com a conta do seu Gerente de Cash e siga os próximos passos:
 
 
<center>'''Todas APIS'''</center>
[[Arquivo:Todas APIS Itau.png|550x300px|centro]]
 
<center>'''API cash_management'''</center>
[[Arquivo:API Cash Management.png|750x500px|centro]]
 
<center>'''Documentações API cash_management'''</center>
[[Arquivo:Documentacoes API Cash Management.png|750x500px|centro]]
 
<center>'''Documentação Obtenção do par de chaves'''</center>
[[Arquivo:Obtencao do par de chaves.png|750x500px|centro]]
 


===Orientações para obter o Par de Chaves===


====Verificação OpenSSL====

Execute o seguinte comando em um terminal de seu sistema operacional para verificar se possui o OpenSSL instalado:
 
<ul><pre>
openssl version
OpenSSL 1.1.1c 28 May 2019 #deverá ser apresentado a versão instalada no ambiente
</pre></ul>
 
No exemplo deste manual utilizaremos o Terminal Git Bash no Visual Studio Code para o processo de geração do Par de Chaves.
 
 
<center>'''Terminal Git Bash '''</center>
[[Arquivo:Terminal Git Bash.png|800x550px|centro]]
 
<center>'''Retorno do comando '''</center>
[[Arquivo:Verificacao OpenSSL.png|450x200px|centro]]
 

Caso não obtenha retorno, instale o aplicativo OpenSSL e tente novamente.

====Comando - Par de Chaves RSA====

Para gerar seu par de chaves RSA, execute o seguinte comando. Você necessitará gerar a chave privada (para decifrar) e a pública (para criptografar):
 
<ul><pre>
openssl genpkey -out private.pem -algorithm RSA -pkeyopt rsa_keygen_bits:2048
openssl rsa -in private.pem -pubout -out public.pem
</pre></ul>

Após os passos anteriores, informe ao time de atendimento o conteúdo do arquivo public.pem (gerado no passo anterior)
 
 
Exemplo do arquivo ''public.pem'':
 
<ul>
'''BEGIN PUBLIC KEY'''
 
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwtCm21MHeGMHN8e4uAZi U/pKoIrtLoyOuoLmpogmWdiV2OJz3OjysQf7JLE1o7xmkwHI8JGg41wuUv+CF6Ax 0kk3EwV6AVkLnI2lOAY2LbrgwDtsGQh6gslIUJhiadHqwwnezBanTIgV+Z4sa02O SWZGbWufXJ9PVP91LXy/d4oyHGbKMVUQlyK350+iL8Pw0reTy6MiKKPrdSaKkj87 PhrE/Fd3vIE1ANqhJjIgHNtB4iqo4VF8bBZKohkShu8IA5Y3uV2OkMz3lD/jNtJn 8J7D7uKYCB8Xy9Sy/8O+rwvyly7i7nWLG1zpVz7KD7+3KWrnmuf2o1gefCin1FLv pwIDAQAB
 
'''END PUBLIC KEY'''
</ul>

==Recebimento do Token Temporário==

O primeiro passo para a ativação do certificado é solicitar o token temporário access_token_tmp e o client id CLIENT_ID através dos canais de suporte, combinados com o seu representante comercial Itaú, para possibilitar a geração do arquivo de certificado que será enviado nas chamadas de nossas APIs.
 
Para solicitar essas informações, é necessário, previamente, ter um par de chaves RSA, obtidos no passo anterior ([[#Orientações para obter o Par de Chaves|Orientações para obter o Par de Chaves]]). Você pode enviar um único e-mail contendo sua chave pública, do par RSA que o Itaú irá criptografar seu token temporário ''access_token_tmp'' e client id ''CLIENT_ID'' e encaminha-los para que consiga seguir o fluxo. Em posse do email, será necessário decriptar os dados recebidos ([[#Decifrar credenciais|Decifrar credenciais]]) com sua chave privada, do par RSA.
 
O prazo para a resposta da equipe de atendimento com o envio do token é de até 1 dia útil e o envio também será feito para o e-mail do responsável pelo envio da solicitação.
 
Vale ressaltar que o Token enviado tem validade de 7 dias para o início do fluxo de geração de certificado e caso o token não seja utilizado dentro desse período você precisará enviar novamente a requisição pelo formulário e aguardar o tempo de resposta.
 
Fique muito atento à resposta do e-mail com o envio do token. O SLA médio de resposta é de 1 dia útil e a validade do token temporário é de apenas 7 dias.
 
<ul><pre>
Fique muito atento à resposta do e-mail com o envio do token. O SLA médio de resposta é de 1 dia útil e a validade do token temporário é de apenas 7 dias.
</pre></ul>

==Decifrar credenciais==

Pré-requisito → JDK 8+
 
 
Após o envio das credenciais pelo time de atendimento, chegará em seu endereço de email, uma mensagem parecida com essa:
 
<ul><pre> E-mail de credenciais

Olá parceiro, seja bem vindo ao Itaú_

Você já pode gerar seu certificado dinâmico com as credenciais abaixo:

ClientId: KWMMqDhJ+p/2fejfX2uktyDnAjT8B3u2FZCyPlyA5U5t3IU4VVcS6wY5KG+SZO+a

Token Temporário: +B8tD52L3qrexAjr3vinhj1FGrfr/iGzx/lKhE2mHJPcjOCnLbCcqP52w3YDXNL+Zi2RKmEp0ZwRFzZYJzWNBMiQh65CKTIRMPBA/2GSQmreMz22dVf8YN2TcjMWtRJzPZRtu/WPUER1izEDWJdUFjMUlJQojUyDZZ2TJ6+B6io7k9ng18djcFmhDQYAbkCMl8oQymgXj8EYCMquWIW7DTK6Srw04VjIktc/eidzYRCpF94/U5uVIAXbrjVwBg9vxbGLiTU1NPR2doWdkA8u+HpZDX+SJjAun6BCD43JGudFI93/YreqvvKD1/QtZg57lTxt7NAw5Brqg4NU/flLF/djN8+c/gLuK/PbnNezWZ6dmdeHO7R2B/efcXvdztFGoXftwzz8FnfC8ZR3gPppIEOeDppduVhw3AXCquwMKDFKxlHaCsZcNwhFIOZvmvXzs1RHo8SoZmpXrdm5BjFZp/2NIprUNOXyMVYxa6NEm3Bv4HwTeE75yQ8xLSjzipThyB7i+2wqMjOQg1WvKzswv1azsMd8R8aQ6G6nvOH7YY0MBM6XAUJNBBQwT7tXSck4j9cOXPlQ6x8SBJluY+/nRptLyr+oG4cDAHGmT5CyRKUI+nfCllojFOFbf01AYnfT4HYhIDQ59afzboI2EH1MDItlESQQ+CstS33AKQe0OkdOOSIUwbOBIfceEhA2xQIDdOSwNTOYUjkfuccjE4fJS2hTcAuVle+MtVzHjb6gpeviqg7H7vxNjZcg8cmFM5sRB/LISPZ2nQ2j2N3BzJjp8XhEs0ML9ENV1XL/+zJdkC2EoxLUkyFIgrN1GD8KU4ZKZM090Ap3wOsv5OHG+mJPNQZqyNc8taDnNukXbduWZ5+IQmin2sz9JK28+88lwxeWY8qWuaB3z/2yV68UmLELpNEP0yg9qMkUflvvmfFKbYZGQGGNCQZuY5hYX5AiWUmDiEgb6CP5nMcO4Z0G65bPWQlsa/aH6yO8WWEe498syokszcMlCiM34Cn+hOa56trEBK0sbapFQYxuKBfUD3bpHr7a4MtZinGKZmv3daLg28XNW/NZQo7VsBsFIY4rZt9MMEuK5Cb9rx52mF4yLa1YvooQaqFlmkf86SogsPwUCw2Onw7FvBTccC7rPLa6/Fork7Zje9viAE9G0XGx2E3R4lqgv3DEquSCdfx3iYsE9c2s/bxW04EU9sZkd6jEj5ARkJADdQw8ope61PBGDDp7UcxMZi7SjZdNiqhYcIbyv9OtkdJ0qrlmCwYiB+nPmj5+

Chave Sessão: KT9d4C4mthX9aFWHGwUlvBS3quLagK2NrDDAXxQWiBCcpu7RDdQE+/C0dATzAjMUUiqsuKpFSnakhI7b0uNAF3CzqNgTnGc6xtu3iOqma0W4pERASb4Lyh+X/A1+95575JVzJrnk9GvfSnn+GMfqv7Kx5uxYBHr8BfOn8R6Pl3Jdi5tAwvynJohFaXx45LM6BKp+R+B7Rk59VyWsQZ/Qzv6Ks7KgKUr/RtyoNlthcmSQAJw9NKoepV4p59uBBZuAwZ+96BLpzgarEB/PIa9bn172TW9ruP24nMA5tssGI6mpHu1ZHPrh67gUH6jD/4fqSwY/IiriAUX3tS6/QZsjABoWBs1QFdM7ImSEnneBzzv1kG2C15x7raPRryzWwBLjN88GOa++kdjpOEzugwzgtgR9WDFYTSxq58mJw3A0yI4jBfkp/dxjQfBeUdq0RToVEAjfPpq+lzgS9RDASjACLCyfKIo8tnHp63dKT7HjHieVv0B7f5Kwq2+NJDUxYDuwEeHRPWx5DVBv5lVse4heAGgLc1VvespTifsoaI/Jj1WUMBk2h+s8xG7e2M0TSZIh+RxQ4s0weA3SbalWqRR+E3pQuf3c0xxosdKiEqhkHmrNnqllU/6QFtj9h0tgWkgrDb3suk9pXHieuePwN/LRmKF3ImnBF35HZrapqRQI+ws=
</pre></ul>
Siga o passo a passo abaixo para decifrar o token temporário access_token_tmp e client id CLIENT_ID e dessa forma poder gerar seu certificado dinâmico.
 
 
Crie um arquivo NomeArquivo.java (sugestão Criptografia.java) com o código abaixo:
 
<ul><pre>
import java.io.BufferedReader;
import java.io.FileInputStream;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.security.InvalidAlgorithmParameterException;
import java.security.InvalidKeyException;
import java.security.KeyFactory;
import java.security.NoSuchAlgorithmException;
import java.security.interfaces.RSAPrivateKey;
import java.security.spec.PKCS8EncodedKeySpec;
import java.util.Base64;
import java.util.Scanner;

import javax.crypto.BadPaddingException;
import javax.crypto.Cipher;
import javax.crypto.IllegalBlockSizeException;
import javax.crypto.NoSuchPaddingException;
import javax.crypto.SecretKey;
import javax.crypto.spec.IvParameterSpec;
import javax.crypto.spec.SecretKeySpec;

public class Criptografia {

private static String extrairChaveRsaPem(String tipoChave, String arquivoChavesRsa) {

try {
InputStream is = new FileInputStream(arquivoChavesRsa);
@SuppressWarnings("resource")
BufferedReader br = new BufferedReader(new InputStreamReader(is));
StringBuilder sb = new StringBuilder();
boolean inKey = false;
for (String line = br.readLine(); line != null; line = br.readLine()) {
if (!inKey) {
if (line.startsWith("-----BEGIN ") && line.endsWith(" " + tipoChave + " KEY-----")) {
inKey = true;
}
} else {
if (line.startsWith("-----END ") && line.endsWith(" " + tipoChave + " KEY-----")) {
inKey = false;
break;
}
sb.append(line);
}
}
return sb.toString();
}
catch(Exception e) {
e.printStackTrace();
}

return null;
}

public static String decriptografiaAes(SecretKey key, String cipherText) {

try {
Cipher cipher = Cipher.getInstance("AES/CBC/PKCS5Padding");
IvParameterSpec iv = new IvParameterSpec(new byte[16]);
cipher.init(Cipher.DECRYPT_MODE, key, iv);
byte[] plainText = cipher.doFinal(Base64.getDecoder().decode(cipherText));

return new String(plainText);
}
catch(NoSuchAlgorithmException e) {
e.printStackTrace();
}
catch(BadPaddingException e) {
e.printStackTrace();
}
catch(IllegalBlockSizeException e) {
e.printStackTrace();
}
catch(InvalidKeyException e) {
e.printStackTrace();
}
catch(InvalidAlgorithmParameterException e) {
e.printStackTrace();
}
catch(NoSuchPaddingException e) {
e.printStackTrace();
}

return null;
}

private static byte[] decriptografiaRsa(String caminhoChavePrivada, String dadosCifrados) {

try {
String chavePrivada = extrairChaveRsaPem("PRIVATE", caminhoChavePrivada);

PKCS8EncodedKeySpec spec = new PKCS8EncodedKeySpec(Base64.getDecoder().decode(chavePrivada.toString()));
KeyFactory kf = KeyFactory.getInstance("RSA");
RSAPrivateKey privateKey = (RSAPrivateKey) kf.generatePrivate(spec);

Cipher cipher = Cipher.getInstance("RSA/ECB/PKCS1Padding");
cipher.init(Cipher.DECRYPT_MODE, privateKey);

return cipher.doFinal(Base64.getDecoder().decode(dadosCifrados));

} catch (Exception e) {
e.printStackTrace();
}

return null;
}

public static void main(String[] args)
{
SecretKey chaveSessao = null;
Scanner scanner = new Scanner(System.in);

try {
System.out.println("\n=========================================");
System.out.println("Informe as informações recebidas no e-mail");
System.out.println("=========================================");

System.out.println("\nClientId: ");
System.out.flush();
String clientIdCifrado = scanner.nextLine().trim();

System.out.println("\nToken Temporário: ");
System.out.flush();
String tokenCifrado = scanner.nextLine().trim();

System.out.println("\nChave Sessão: ");
System.out.flush();
String chaveSessaoCifrada = scanner.nextLine().trim();

System.out.println("\nCaminho chave privada: ");
System.out.flush();
String caminhoChavePrivada = scanner.nextLine().trim();

System.out.flush();
scanner.close();

System.out.println("\n=====================================");
System.out.println(" Processo de Decriptografia ");
System.out.println("=====================================");

// Decifra a chave de sessao AES com a chave RSA privada
byte[] chaveSessaoDecifrada = decriptografiaRsa(caminhoChavePrivada, chaveSessaoCifrada);
chaveSessao = new SecretKeySpec(chaveSessaoDecifrada, 0, chaveSessaoDecifrada.length, "AES");
// Decriptografa a credencial atraves da chave de sessao AES
String clientIdDecifrada = decriptografiaAes(chaveSessao, clientIdCifrado);
System.out.println("\nClient id decifrado com a chave de sessao AES:\n[ " + new String(clientIdDecifrada) + " ]");
String tokenDecifrado = decriptografiaAes(chaveSessao, tokenCifrado);
System.out.println("\nToken decifrado com a chave de sessao AES:\n[ " + new String(tokenDecifrado) + " ]");
}
catch(Exception e) {
e.printStackTrace();
}
}
}
</pre></ul>
 
Para decifrar o '''token temporário access_token_tmp''' e '''client id CLIENT_ID''' é necessário compilar e executar o código conforme comandos abaixo (em um cmd no mesmo diretório onde foi salvo o arquivo .java criado):
 
<ul><pre>
javac Criptografia.java
java -cp . Criptografia
</pre></ul>
 
<center>'''Diretório informado e Primeiro Comando'''</center>
[[Arquivo:Primeiro Comando.png|650x400px|centro]]

O primeiro comando (''javac Criptografia.java'') dará origem a um arquivo .class, que é o arquivo Java compilado.
 
 
<center>'''Arquivos no Diretório (Primeiro Comando) 06:58'''</center>
[[Arquivo:Arquivos no Diretorio.png|550x300px|centro]]

 
Após a execução do segundo comando (''java -cp . Criptografia''), preencha os dados que serão pedidos conforme o que foi recebido via email (Client ID, Token Temporário e Chave Sessão) e o caminho em que a chave privada se encontra.
 
<ul>
• '''ClientId:''' <ClientId presente no e-mail>
 
• '''Token temporário:''' <Token temporário presente no e-mail>
 
• '''Chave sessão:''' <Chave sessão presente no e-mail>
 
• '''Caminho absoluto da chave privada:''' <C:/Users/.../.../private.pem> obtida no passo [[#Orientações para obter o Par de Chaves|Orientações para obter o Par de Chaves]].
</ul>
<center>'''Dados Informados'''</center>
[[Arquivo:Segundo Comando.png|650x400px|centro]]

Ao executar a aplicação com os valores informados, o Itaú recebe no terminal as credenciais em texto aberto e geram o Client ID e Token decifrado com o Par de Chaves.
 
 
<ul>
'''Exemplo:''' Retorno Credenciais decifradas
----
Processo de Decriptografia
----
Client id decifrada com a chave de sessao AES:
[ e26f2f89-0ead-4ca6-8bc3-dd44b4ab3cc7 ]

Token decifrado com a chave de sessao AES:
[eyJraWQiOiJhZTYxYWIxZi0yNTRhLTQ5ZWQtODMzNC05ZDJlN2E0MzZiNGQuaG9tLmdlbi4xNTk3NjAwMzM2OTkyLmp3dCIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiJlMjZmMmY4OS0wZWFkLTRjYTYtOGJjMy1kZDQ0YjRhYjNjYzciLCJhdXQiOiJNQVIiLCJ2ZXIiOiJ2MS4wIiwiaXNzIjoiaHR0cHM6XC9cL29wZW5pZC5pdGF1LmNvbS5iclwvYXBpXC9vYXV0aFwvdG9rZW4iLCJBY2Nlc3NfVG9rZW4iOiIyYWEzZmU5NS43OGM2YjhmNS1lZWJjLTQxMzQtYmJlZS1hZDAzMjZmMTRmM2EiLCJzb3VyY2UiOiJFWFQiLCJlbnYiOiJIIiwic2l0ZSI6ImRldiIsInVzciI6Im51bGwiLCJtYmkiOiJ0cnVlIiwidXNlcl9pZCI6ImUyNmYyZjg5LTBlYWQtNGNhNi04YmMzLWRkNDRiNGFiM2NjNyIsInNjb3BlIjoiZXNjb3BvX2RlZmF1bHQiLCJleHAiOjE2MTg5NDIyMTIsImlhdCI6MTYxODUxMDIxMiwiZmxvdyI6IkNDIn0.ZEIGYAUu-8-aCirhuClcp4F4qpL9L0KFh0pQJggXieUSCEasX-3I5QLvp5BkKcE2RhwvRfW2dUuiXJGaDqK_Mri6wZ8gVVdeHaP3ctwm8_4WBdHzxVPsAQKv2MAi8IWvHaFLFLUFcF7Z9-fpTkve_8SBnnJb4L_O7SYzXgxg3zpYSCFwMr4SrBvidq2plajEbytcDXikAXyibAWr2OH5Aijq8yfIc6dbMbH2ueA1V3mft7b_eueBQlihF1PHbytVWah6RleR5He9FLbjygcZ-F-1ygx5yTSl_DMCGn4uCYmH5IfkZa9jC9A2-t4jlIlvFZHeGVl_c2-xaWFBd_9ryQ ]
</ul>

==Geração do arquivo .csr==
Com as credenciais em mãos você partirá para a segunda etapa do processo, a geração do arquivo '''CSR (Certificate Sign Request)''' conforme os padrões e orientações abaixo.
 
<ul>
Nesse processo deverá ser utilizada a ferramenta Openssl e, caso não esteja disponível, você deverá instalar conforme orientações disponíveis em: [https://www.openssl.org/ openssl.org].
</ul>
Para a criação do arquivo, alguns parâmetros serão exigidos e para te ajudar segue abaixo a lista desses parâmetros e uma breve descrição sobre eles.
 
 
<ul>
• '''CLIENT_ID:''' é o client_id solicitado por e-mail e enviado pelo Itaú (etapa 1 da ativação do certificado).
 
• '''Nome do Parceiro e Aplicação:''' é o nome criado pelo Parceiro para identificar facilmente a aplicação consumidora. Uma sugestão é utilizar o nome da Aplicação e do Parceiro. Ex: Site Parceiro A; App Parceiro B, etc.
 
• '''arquivo_request_certificado.csr:''' é o nome do arquivo CSR que será gerado.
 
• '''arquivo_chave_privada.key:''' arquivo contendo a chave privada do certificado. Ele será gerado no mesmo momento da criação do arquivo do certificado. Recomendamos mantê-lo armazenado em segurança já que será utilizado pela aplicação no momento das chamadas às APIs.
</ul>

 
'''Exemplos de geração do arquivo .csr'''
---- '''Windows'''
openssl req -new -subj "//CN=CLIENT_ID\OU=SITE OU APP DO PARCEIRO\L=CIDADE\ST=ESTADO\C=BR" -out ARQUIVO_REQUEST_CERTIFICADO.csr -nodes -sha512 -newkey rsa:2048 -keyout ARQUIVO_CHAVE_PRIVADA.key
 
---- '''Linux'''
openssl req -new -subj "/CN=CLIENT_ID/OU=SITE OU APP DO PARCEIRO/L=CIDADE/ST=ESTADO/C=BR" -out ARQUIVO_REQUEST_CERTIFICADO.csr -nodes -sha512 -newkey rsa:2048 -keyout ARQUIVO_CHAVE_PRIVADA.key
----

Após a criação do ''arquivo_request_certificado.csr'' deverá ser enviado ao Itaú para concluir o processo de geração do certificado. Esse envio ocorrerá através de uma API que solicitará o token temporário para que a transferência seja finalizada.
 
 
'''Exemplo de verificação das informações do arquivo .csr'''
<ul><pre>
openssl req -in ARQUIVO_REQUEST_CERTIFICADO.csr -noout -text
</pre></ul>

==Envio de arquivo .csr==
A terceira etapa do processo é o envio do arquivo CSR e ele deverá ser feito através da API '''/seguranca/v1/certificado/solicitacao''' para o STS do Itaú pela url: '''sts.itau.com.br.'''
 
 
'''Envio de arquivo .csr utilizando o fluxo de autenticacao autenticação client credentials e mTLS'''
 
Como desenhado no fluxo abaixo, o parceiro deverá enviar no header o token temporário access_token_tmp que recebeu por e-mail do Itaú ([[#Recebimento do Token Temporário|Recebimento do Token Temporário]]) e o arquivo .csr gerado no body ([[#Geração do arquivo .csr|Geração do arquivo .csr]]). Por fim, como retorno da chamada o Parceiro receberá o client_secret e o certificado CRT requisitado.
 
 
[[Arquivo:Imagem itau 1.png|750x500px|centro]]
 
 
'''Envio de arquivo .csr utilizando o fluxo de autenticacao autenticação client credentials com private key JWT e mTLS'''
 
Como desenhado no fluxo abaixo, o parceiro deverá enviar no header o token temporário access_token_tmp que recebeu por e-mail do Itaú ([[#Recebimento do Token Temporário|Recebimento do Token Temporário]]) e o arquivo .csr gerado no body ([[#Geração do arquivo .csr|Geração do arquivo .csr]]). Por fim, como retorno da chamada o Parceiro receberá apenas o '''certificado CRT''' requisitado.
 
 
[[Arquivo:Imagem itau 2.png|750x500px|centro]]
 
 
<ul><pre>
Verifique sempre as datas de expiração do certificado, pois o processo de renovação poderá ser feito a partir 60 dias até a data de vencimento.
</pre></ul>
 
 
<center>'''Envio de arquivo .csr - Parâmetros'''
{| class="wikitable"
|-
! Parâmetro !! Tipo de Parâmetro !! Tipo de dado !! Obrigatório !! Descrição
|-
| Content-Type || header || string || sim || O tipo de mensagem enviada
|-
| Authorization || header || string || sim || Token Temporário enviado por e-mail - Bearer access_token_tmp
|-
| Body || Body || string || sim || Certificate request da aplicação
|-
|}
</center>
 

Caso receba o parâmetro x-itau-client-cert-error no header do response, isto identifica que a chamada foi rejeitada por conta do certificado, verificar na seção de [[#Códigos de Erro do Certificado|Códigos de Erro do Certificado]].

==Renovação do Certificado Dinâmico==

A renovação de certificado só é possível após 60 dias antes do término da validade, caso contrário, o certificado ficará inválido para este processo e será necessário a utilização do fluxo de Ativação Certificado Dinâmico.
 
'''Importante: '''Verifique sempre as datas de expiração do certificado para finalizar o processo de renovação do certificado.
 
Assim como na ativação, a renovação também exige a utilização das credenciais da autenticação OAuth que já devem ter sido geradas através do passo a passo detalhado no início desse tutorial. Se você precisar de ajuda para gerar novos códigos ou consultar códigos já recebidos, entre em contato conosco diretamente pelos canais de suporte combinados com o seu representante comercial Itaú. '''No processo de renovação, o certificado antigo continua válido até sua data de vencimento.'''
 
<ul><pre>
O Certificado Dinâmico deve ser renovado anualmente e é de total reponsabilidade do cliente.
</pre></ul>
 

==Códigos de Erro do Certificado==
<center>
{| class="wikitable"
|-
! Código !! Motivo !! Ação
|-
| C100 || Ausência do certificado na chamada || Verifique os parâmetros incluídos para corrigir possíveis erros. Se não encontrar divergências entre em contato com nosso suporte.
|-
| C200 || Certificado inválido || Verifique os parâmetros incluídos para corrigir possíveis erros. Se não encontrar divergências entre em contato com nosso suporte.
|-
| C300 || Certificado inválido || Verifique os parâmetros incluídos para corrigir possíveis erros. Se não encontrar divergências entre em contato com nosso suporte.
|-
| C400 || Cadeia certificadora inválida || Se não encontrar divergências entre em contato com nosso suporte.
|-
| C500 || Certificado expirado || Nesse caso será necessário realizar o processo de reativação do certificado. Procure no tópico ‘reativação’ para encontrar mais informações
|-
| C600 || O CN (Common Name) do certificado é diferente do client_id || Verifique a geração do CSR.
|-
|}
</center>

='''Como obter as Credenciais para utilizar a Versão 1 da Funcionalidade Open Banking?'''=
As credenciais do Banco devem ser obtidas através do contato com o seu Gerente de Cash (Gerente da Conta no Banco).
 
Válido somente até 31/12/2021.

='''Quais os Módulos necessários para utilizar a Funcionalidade Open Banking do Banco Itaú?'''=

• Módulo Gestão Financeira;

='''Quais são as parametrizações necessárias para utilizar a funcionalidade do Open Banking?'''=

Para utilizar esta funcionalidade é necessário possuir o Cadastro do Portador para o Banco Itaú.
 
Como boa prática de implementação é mais coerente criar um novo Portador para Open Banking evitando assim de alterar o Portador utilizado para CNAB caso necessite realizar algum processo via remessa ou retorno, quando a API do Banco estiver com instabilidade.
 
Essa parametrização deverá validar os últimos Sequenciais da numeração de Boletos do Portador utilizado para as Remessas, pois assim garante que não ocorrerá conflito enviar uma numeração de Título já registrado.
 
Para o correto funcionamento da rotina é necessário que os dados do Portador esteja com todas informações necessárias, inclusive o '''Convênio'''.
 
 
'''Itens Importantes na Parametrização:'''
 
'''- Processar retornos pelo número do Boleto:''' esta opção deve estar marcada, pois caso contrário ocorrerá problemas na gravação das informações e envio para Banco.
 
 
'''Itens Importantes na Parametrização:'''
 
'''- Processar retornos pelo número do Boleto:''' esta opção deve estar marcada, pois caso contrário ocorrerá problemas na gravação das informações e envio para Banco.
 
Caso tenha sido realizado movimentações com esta opção desmarcada, não será possível realizar a Baixa, pois sistema não consegue localizar devido não possuir o '''Nosso Número''' gravado nas tabelas envolvidas.
 
Para solucionar essa questão será necessário:
 
'''1-''' Identificar o '''Nosso Número''' do registro a ser baixado (Lançamento Financeiro);
 
'''2-''' Gravar o '''Nosso Número''' nas seguintes tabelas:
 
'''GFBOLETOS:''' campo a ser atualizado '''NOSSO_NRO''' com a informação do Nosso Número.
 
'''GFLAUXIL:''' campo a ser atualizado '''CODIGO_BARRAS''' com a informação do Nosso Número.
 
'''Menu > Finanças > Gestão Financeira > Parâmetros > Portadores'''
 
Este cadastro é apenas uma demonstração de parametrização:
 
<center>'''Cadastro de Portador'''
[[Arquivo:Cadastro Portador OpenBanking Juros.png|750x500px|semmoldura|nenhum|Cadastro_Portador_OpenBanking_Juros]]
<center>'''Guia CNAB'''
[[Arquivo:Cadastro Portador OpenBanking CNAB.png|750x500px|semmoldura|nenhum|Cadastro_Portador_OpenBanking_CNAB]]
<center>'''Guia Configurações'''
[[Arquivo:Cadastro Portador OpenBanking Config.png|750x500px|semmoldura|nenhum|Cadastro_Portador_OpenBanking_Config]]
 </center>
 

Acessando o Botão Remessas:
 
<center>'''Botão Remessas > Comandos'''
[[Arquivo:Cadastro Portador OpenBanking Comando Remessa.png|750x500px|semmoldura|nenhum|Cadastro_Portador_Comando_Remessa]]
 
 

Acessando o Botão Retornos:
<center>'''Botão Retornos > Códigos de Retorno'''
[[Arquivo:Cadastro Portador Codigo Retorno Remessa.png|750x500px|semmoldura|nenhum|Cadastro_Portador_Codigo_Retorno_Remessa]]
 
 
Para iniciar a configuração através do “Assistente de Parâmetros do Open Banking”, basta selecionar o botão “Open Banking”:
 
'''Menu > Finanças > Gestão Financeira > Parâmetros > Configuração de Bancos'''
 
 
<center>'''Configurações de Banco'''
[[Arquivo:Configuracao Banco.png|750x500px|semmoldura|nenhum|Configuracao_Banco]]
 
Para dar início ao processo de parametrização, basta selecionar o botão “Avançar”:
 
'''Tela Inicial Configuração do Assistente Open Banking:'''
 
Para iniciar a configuração é necessário ter em mãos os seguintes dados: (Cliente, Chave de Autorização e Gw-app-Key).
Sem essas informações não será possível dar continuidade na parametrização do Open Banking para o Banco do Brasil.
 

='''Tela Inicial Configuração do Assistente Open Banking:'''=
 
Para iniciar a configuração é necessário ter em mãos os seguintes dados: (Cliente, Chave de Autorização e Gw-app-Key).
Sem essas informações não será possível dar continuidade na parametrização do Open Banking para o Banco.
 
<center>'''Tela Inicial Parâmetros de Convênio Open Banking'''
[[Arquivo:Tela Inicial.png|750x500px|nenhum|Tela_Inicial]]
 


=='''Etapa 1 (Parâmetros: Passo 1 de 4):'''==


Uma das etapas mais importantes e que requer um cuidado maior e sigilo das informações nesta parametrização.
 
Essas informações são disponibilizadas pelo Banco a qual deve ser restrita somente a pessoa responsável pelo setor Financeiro da Empresa.
 
O assistente tem como objetivo proporcionar que o próprio usuário tenha autonomia para executar esse passo a passo sem necessidade de passar essas informações restritas da Empresa para qualquer pessoa que não seja ele mesmo.
 
Reforçando, mesmo que tenha dificuldades para executar esta etapa, não repasse nenhuma informação relacionado aos acessos dos tokens.
 
Dados em mãos para informar os respectivos campos, basta copiar e colar as informações.
 
Client_id, Client_secret, Itau_chave, Identificador e o Scope que passa vir preenchido automaticamente por padrão.
 
Os campos:
 
Client ID e Client Secret possuem uma tecnologia de criptografia, ou seja, após informar os dados nos campos o sistema irá criptografar as informações garantindo e mantendo a segurança das informações.
 
Caso haja necessidade de alterações, basta clicar no ícone do "Cadeado", será aberta a tela de Criptografia e após colar ou digitar as informações em tela e selecionar o botão "Confirmar".
 
Também tenha alguma dúvida no dado informado e necessitar validar o dado seguindo os mesmos passos da alteração será aberta a tela de Criptografia e após colar ou digitar as informações em tela e selecionar o botão "Validar", sistema confirma se os dados são os mesmos.
 
Observamos que para o Banco Itaú não possui duas guias de Homologação e Produção, ou seja, os dados são validos para ambos os ambientes o que diferenciará será no momento de setar os dados para "Produção" na etapa de Conclusão.
 
Lembrando que esses dados são confidenciais de uso e exclusivo de cada usuário.
 
Através dessas informações o sistema irá se comunicar com API do Banco para poder realizar os registros dos Lançamentos.
Após informado os dados, basta selecionar o botão "Avançar", para seguir os próximos passos.
 
'''Client Id:''' Identificação da Aplicação, é necessário informar a codificação passada pelo Banco. Este dado é criptografado.
 
'''Client Secret:''' Credencial do banco, é necessário informar a codificação passada pelo Banco. Este dado é criptografado.
 
'''Chave Itaú:''' Código de Chave do banco, é necessário informar a codificação passada pelo Banco. Este dado é criptografado.
 
'''Identificador (CNPJ/CPF - somente números):''' este dado é referente ao emissor dos registros Open Banking, ou seja, deve ser informado o CNPJ ou CPF da Organização que será responsável pela emissão dos registros.
 
 
<center>'''Parâmetros: Passo 1 de 4'''
[[Arquivo:Parametros 1de4.png|750x500px|nenhum|Parametros_1de4]]
 

=='''Etapa 2 (Portador de Remessa e Retorno - Pagamento: Passo 2 de 4):'''==

Nesta etapa deve ser selecionado o Portador que será considerado para o envio da Remessa de Pagamento (onde estarão os boletos em aberto) e nesta mesma tela informar o qual Portador será considerado para o Retorno de Pagamento (onde serão liquidados os retornos de Pagamentos).
 
Nesta etapa, é possível pular, caso não utilize ainda o Envio de Pagamentos do Open Banking.
 
'''Pular:''' caso deseja pular essa etapa e prosseguir com o processo de parametrização do Open Banking.
 
'''Avançar:''' dá continuidade ao processo de parametrização, após selecionado uma opção.
 
Para continuar a parametrização selecione o botão "Pular" e siga para os próximos passos.
 
<center>'''Portador de Remessa e Retorno: Passo: 2 de 4'''
[[Arquivo:PortadorRemessaRetorno-Pagamento 2de4.png|750x500px|nenhum|PortadorRemessaRetorno-Pagamento_2de4]]
 

=='''Etapa 3 (Convênios de Cobrança: Passo 3 de 4):'''==
 
Nesta etapa o sistema avalia sua base de dados, e localiza os Convênios parametrizados para o Banco Itaú, onde serão listados.
 
'''Pular:''' caso deseja pular essa etapa e prosseguir com o processo de parametrização do Open Banking.
 
'''Avançar:''' dá continuidade ao processo de parametrização, após selecionado uma opção.
 
<center>'''Convênios de Cobrança: Passo 3 de 4'''
[[Arquivo:Convenios Cobranca 3de4.png|750x500px|nenhum|Convenios_Cobranca_3de4]]
 

=='''Etapa 3 (Portador de Remessa e Retorno - Cobrança: Passo 3 de 4):'''==
 
Nesta etapa deve ser selecionado o Portador que será considerado para o envio da Remessa de Cobrança (onde estarão os boletos em aberto) e nesta mesma tela informar o qual Portador será considerado para o Retorno de Cobrança (onde serão liquidados os retornos de Cobranças).
 
'''Avançar:''' dá continuidade ao processo de parametrização, após selecionado uma opção.
 
<center>'''Portador de Remessa e Retorno - Cobrança: Passo 3 de 4'''
[[Arquivo:Wizard passo 3 de 4 Direto PIX Itau.png|750x500px|nenhum|Wizard_passo_3_de_4_Direto_PIX.png]]
 
Atualizado Wizard do Open Banking, disponibilizando duas opções:
 
'''- Direto:''' esta opção tem como finalidade registrar o Boleto no momento da sua geração, ou seja, quando selecionado ativa propriedade ao qual ao gerar o Boleto Bancário o sistema automaticamente envia o registro Open Banking, sem a necessidade de fazer o processo de envio da Remessa Open Banking do título.
 
Também quando selecionada, terá uma particularidade na questão da Emissão de Boletos em lote pela Rotina de Emissão de Boletos Personalizados. A rotina na guia '''Opções''' tem a opção '''Enviar somente Lançamentos não marcados e marca-los''', caso esteja desmarcada o Registro Open Banking ocorrerá da mesma forma que o sistema irá marcar a opção '''Boleto Impresso''' do Lançamento Financeiro, registrando a Operação Open Banking.
Isso ocorre para manter a integridade, já que esta operação é considerada única no registro, sendo então necessário marcar a '''Boleto Impresso''', para poder conseguir realizar alterações como Alteração de Vencimento ou mesmo a Baixa, sendo uma condição de Sistema.
 
'''- PIX''': esta opção fica habilitada somente quando selecionado a opção '''Direto''', ela tem como finalidade registrar uma operação PIX para os Boletos emitido de forma Direta (opção '''Direto''' marcado).
 
Esta opção é válida '''SOMENTE''' para o Banco do Brasil.
 
Ao emitir o Boleto do Lançamento o sistema marca as 3 opções:
 
- Boleto Impresso;
 
- Remessa Enviada;
 
- Código de Barras Lido;
 
Outra mudança é no '''Histórico''' Open Banking, ao qual passa criar o registro com '''Status Open Banking''' já '''Registrado'''.
 
Também ao acessar os '''Dados API''' é enviado a tag: "indicadorPix": "S", pois a opção PIX esta selecionada.

=='''Etapa 4 (Relatório: Passo 4 de 4):'''==

 
Nesta etapa o sistema irá buscar automaticamente o Modelo de Relatório Padrão, caso exista no ambiente, facilitando assim todo processo de parametrização e implementação para usuário.
 
A busca é realizado '''(%CIGAM_INSTAL%RF00071_remessas.RTF)''', com isso é importante que o Modelo de Relatório (RF00071_remessas.RTF) esteja devidamente localizado na pasta padrão do Cigam_Instal, como por exemplo:
 
'''%CIGAM_INSTAL%''' = P:\Cigam11\Projects\Controle\MACIEL\Financeiro_Open_Banking
 
"P:\Cigam11\Projects\Controle\MACIEL\Financeiro_Open_Banking\Modelos\Relatorios\Gestao Financeira\RF00071_remessas.RTF"
 
Clicar em "Avançar" para dar seguimento.
 
<center>'''Assistente de Parâmetros Open Banking: Passo 4 de 4'''
[[Arquivo:Assistente Passo 4.png|750x500px|semmoldura|nenhum|Assistente_Passo_4]]
 
 
=='''Etapa Conclusão (Parâmetros de Convênio Open Banking - Conclusão):'''==
 
Esta etapa o sistema faz validação da comunicação com o Banco através da API verificando o ambiente se esta tudo ok, listando em tela.
 
Após a consulta estar "OK", basta clicar no botão "Concluir" e seu ambiente estará apto para utilizar a funcionalidade Open Banking.
 
<center>'''Parâmetros de Convênio Open Banking: Passo Final - Conclusão'''
[[Arquivo:Conclusão.png|750x500px|nenhum|Conclusão]]
 
'''Credenciais:''' Conexão realizada com sucesso.
 
<center>'''Convênio Cadastrado com Sucesso - Cobrança'''
[[Arquivo:Parametros Open Banking Cobranca.png|750x500px|nenhum|Parametros_Open_Banking_Cobranca]]
 
'''Ambiente:''' lista qual é o ambiente cadastrado, sendo apenas duas opções: Homologação e Produção.
 
'''Convênios:''' neste grupo serão listados todos os convênios cadastrados, bem como todas informações pertinentes como:
 
- Portador;
 
- Agência;
 
- Número Conta;
 
- Portador de retorno;
 
'''- Direto:''' esta opção tem como finalidade registrar o Boleto no momento da sua geração, ou seja, quando selecionado ativa propriedade ao qual ao gerar o Boleto Bancário o sistema automaticamente envia o registro Open Banking, sem a necessidade de fazer o processo de envio da Remessa Open Banking do título.
 
'''- PIX:''' esta opção fica habilitada somente quando selecionado a opção Direto, ela tem como finalidade registrar uma operação PIX para os Boletos emitido de forma Direta (opção Direto marcado).
 
Esta opção é válida SOMENTE para o Banco do Brasil.
 
Ao emitir o Boleto do Lançamento o sistema marca as 3 opções:
 
- Boleto Impresso;
 
- Remessa Enviada;
 
- Código de Barras Lido;
 
'''U.N Ced.:''' esta opção tem como finalidade possibilitar o envio e registro de Boletos de outras Unidades de Negócio.
 
Basta informar a Unidade desejada no campo e o sistema entenderá quando realizado o processo de registro de um título que não seja da Unidade Matriz, então sistema identifica e realiza o processo de envio e registro.
Se deixar em Branco a Unidade Cedente irá considerar para todas Unidades de Negócio.
 
 
<center>'''Convênio Cadastrado com Sucesso - Pagamento'''
[[Arquivo:Parametros Open Banking Pagamentos.png|750x500px|nenhum|Parametros_Open_Banking_Pagamentos]]
 
'''Ambiente:''' lista qual é o ambiente cadastrado, sendo apenas duas opções: Homologação e Produção.
 
'''Convênios:''' neste grupo serão listados todos os convênios cadastrados, bem como todas informações pertinentes como:
 
- Portador;
 
- Agência;
 
- Número Conta;
 
- Portador de retorno;
 
<center>'''Ícone Credenciais'''
[[Arquivo:Icone Credenciais Cobranca.png|750x500px|nenhum|Icone_Credenciais_Cobranca]]
 
Através deste ícone é possível verificar os Parâmetros API parametrizados, tanto em homologação quanto em produção.
 
 
<center>'''Ícone Endereços'''
[[Arquivo:Icone Enderecos.png|750x500px|nenhum|Icone_Enderecos]]
 
Através deste ícone é possível verificar todos endereços de URLs parametrizados.

=='''O que significa a Categoria Open Banking de acesso?'''==
 
 A Categoria Open Banking é uma Categoria que é habilitada mediante a utilização de um Portador parametrizado com as Configurações de Banco Open Banking. A mesma tem como objetivo proporcionar maior agilidade e gerenciamento das atividades relacionadas a Remessa de Cobrança Online.
 
'''Categoria Open Banking'''
 
 
<center>'''Categoria Open Banking'''
[[Arquivo:Categoria Open Banking.png|750x500px|semmoldura|nenhum|Categoria_Open_Banking]]
 
 

'''Registrar:''' item de categoria tem como funcionalidade registrar o Boleto Bancário Online. Substitui todo o processo de geração do arquivo de Remessa de Cobrança, acessar o site e remeter ao Banco esse arquivo, com apenas um clique na opção.
 
'''Reenviar:''' item de categoria tem como funcionalidade possibilitar o reenvio de registros que estão com alguma pendência ou algum erro de parametrização. Será habilitado somente quando já possuir movimento de "Registro" enviado, cuja Situação estiver com pendência ou erro.
 
'''Baixar:''' item de categoria tem como funcionalidade comunicar o Banco referente a Baixa do movimento em questão do Boleto Bancário. Utilizado para eventuais falhas operacionais, como registrado um movimento por engano, ou negociações diretamente com cliente a parte. Eliminando então também todo processo de geração do arquivo de Remessa Bancária com Comando de Remessa de Baixa e o processo de remeter ao Banco o arquivo, sendo realizado tudo online através desta opção.
 
'''Registrar Alteração:''' item de categoria tem como funcionalidade registrar uma alteração ocorrida referente ao "Vencimento" do Lançamento Financeiro.
Ao realizar alteração da Data de Vencimento do Lançamento Financeiro que está com "Situação Open Banking" igual "Registrado" e ocorrer alteração no Vencimento, o sistema emite uma mensagem possibilitando já o envio da alteração no momento ou mais tarde através desta opção de "Registrar Alteração".
 
'''Histórico:''' item de categoria tem como funcionalidade gravar todas movimentações realizadas relativo ao Open Banking. Registros, Baixas, Erros...

='''Layout e Detalhamento de Campos API última versão'''=

==Registro de Boletos==
<center>

{| class="wikitable"
|-
! Nº !! Campo JSON !! Descriçao do Banco !! Campo CIGAM !! Tabela !! Obrigatório !! Observações
|-
| 1 || etapa_processo _boleto || Simulação de Emissão - 'validacao' Emissão - 'efetivacao' || Não Tratado || Não Tratado || obrigatório || CIGAM: fixo = efetivacao.
|-
| 2 || id_beneficiario || Agência (4 dígitos) + Conta (7 dígitos) + DAC (1 dígito). || Agência + Conta Número || Portador || obrigatório || Exemplo: 150000123450
|-
| 3 || '''dado_boleto'''
|-
| 3.1 || descricao_instrumento _cobranca || Tipo de cobrança. Preencher com 'boleto' || Não Tratado || Não Tratado || obrigatório || CIGAM: fixo = boleto.
|-
| 3.2 || tipo_boleto || Deve ser indicado um dos tipos do boleto: 'a vista' 'proposta' || Não Tratado || Não Tratado || obrigatório || CIGAM: fixo = a vista.
|-
| 3.3 || codigo_carteira || Deve ser informado algum dos códigos de carteiras disponíveis: 109 e 112 || Carteira || Portador || obrigatório ||
|-
| 3.4 || valor_total_titulo || Valor total a ser cobrado. Sendo 15 dígitos inteiros e 2 casas decimais. || Saldo || LANCAM || obrigatório || Exemplo: 99999999999999900
|-
| 3.5 || codigo_especie || Espécie do título. Ver "Tabela de Espécies" || Não Tratado || Não Tratado || obrigatório ||
|-
| 3.6 || valor_abatimento || Valor do abatimento do título. Este valor não pode superar o valor da cobrança. || Não Tratado || Não Tratado || opcional || Formato do campo: 15 dígitos inteiros e 2 casas decimais
|-
| 3.7 || data_emissao || Data de emissão do boleto. || Não Tratado || Não Tratado || opcional || Formato: AAAA-MM-DD
|-
| 3.8 || indicador_pagamento _parcial || Indicador de pagamento parcial. Caso não seja enviado, assume-se o padrão 'false'
'''Domínios:'''
 
true - Aceita pagamento parcial
 
false - Não aceita pagamento parcial
|| Não Tratado || Não Tratado || opcional ||
|-
| 3.9 || quantidade_maximo _parcial || Quantidade permitida de pagamentos parciais da cobrança, valor deve ser entre 1 e 99. || Não Tratado || Não Tratado || opcional || Obrigatório caso indicador_pagamento_parcial = true
|-
| 4 || '''pagador'''
|-
| 4.1 || pessoa
|-
| 4.1.1 || nome_pessoa || Nome/Razão social do pagador. || Nome Completo || Emissor || obrigatório || Máximo caracteres: 50
|-
| 4.1.2 || nome_fantasia || Nome Fantasia do pagador - Exemplo: Empresa A || Não Tratado || Não Tratado || opcional || Obrigatório caso tipo_pessoa = J
|-
| 4.2 || tipo_pessoa
|-
| 4.2.1 || codigo_tipo_pessoa || Tipo de pessoa do pagador
'''Domínios:'''
 
F - Pessoa Física
 
J - Pessoa Jurídica
|| || || obrigatório ||
|-
| 4.2.2 || numero_cadastro _pessoa_fisica || CPF do pagador || CPF/CNPJ || Empresa || opcional || Obrigatório caso tipo_pessoa = F Exemplo: 12345678910
|-
| 4.2.3 || numero_cadastro_ nacional_pessoa _juridica || CNPJ do pagador || CPF/CNPJ || Empresa || opcional || Obrigatório caso tipo_pessoa = J Exemplo: 12312312000110
|-
| 5 || '''sacador_avalista'''
|-
| 5.1 || pessoa
|-
| 5.2 || tipo_pessoa
|-
| 5.2.1 || codigo_tipo_pessoa || Tipo de pessoa do sacador avalista.
'''Domínios:'''
 
F - Pessoa Física
J - Pessoa Jurídica
|| Pessoa || Empresa || obrigatório ||
|-
| 5.2.2 || numero_cadastro _pessoa_fisica || CPF do sacador avalista || CPF/CNPJ || Empresa || opcional || Obrigatório caso tipo_pessoa = F Exemplo: 12345678910
|-
| 5.2.3 || numero_cadastro _nacional_pessoa _juridica || CNPJ do sacador avalista || CPF/CNPJ || Empresa || opcional || Obrigatório caso tipo_pessoa = J Exemplo: 12312312000110
|-
| 6 || '''endereco'''
|-
| 6.1 || nome_logradouro || Nome do logradouro, número, complemento. || Endereco + Numero || Emissor || obrigatório || Máximo caracteres: 45
|-
| 6.2 || nome_bairro || Nome do bairro || Bairro || Emissor || obrigatório ||
|-
| 6.3 || nome_cidade || Nome da cidade || Municipio || Emissor || obrigatório ||
|-
| 6.4 || sigla_UF || Sigla da UF || UF || Emissor || obrigatório ||
|-
| 6.5 || numero_CEP || CEP || CEP || Emissor || obrigatório ||
|-
| 7 || '''dados_individuais _boleto'''
|-
| 7.1 || numero_nosso _numero || Número de identificação do título. De livre utilização do usuário seguindo as regras da carteira do produto contratado. Não pode ser repetido se nosso número ainda estiver ativo ou tiver menos de 45 dias de sua baixa/liquidação. || Não Tratado || Não Tratado || opcional || Nosso número é obrigatório para carteira 109 e não deve ser informado para carteira 112
|-
| 7.2 || data_vencimento || Data máxima para pagamento do título sem que haja acréscimo de juros e multa. || Vencimento || LANCAM || obrigatório || Formato: AAAA-MM-DD
|-
| 7.3 || valor_titulo || Valor a ser cobrado. || Saldo || LANCAM || obrigatório || Formato do campo: 15 dígitos inteiros e 2 casas decimais
|-
| 7.4 || data_limite _pagamento || Data limite para pagamento do título. Após esta data, o título não poderá ser pago. || Não Tratado || Não Tratado || opcional || Formato: AAAA-MM-DD
|-
| 7.5 || texto_uso _beneficiario || Campo de 25 caractéres, utilizado na API legado como "identificador_titulo_empresa". || Não Tratado || Não Tratado || opcional ||
|-
| 8 || texto_seu _numero || Seu número é a identificação do boleto que poderá ter letras e números e facilitará a consulta e acompanhamento do status do boleto. Este campo é para controle do cliente || Não Tratado || Não Tratado || opcional ||
|-
| 9 || desconto_expresso || Indicador de desconto. Enviar como "false" || Não Tratado || Não Tratado || opcional ||
|-
| 10 || '''juros'''
|-
| 10.1 || codigo_tipo _juros || Tipo da cobrança dos juros no cálculo da cobrança. Para cada um dos valores informados, será impresso no boleto uma anotação referente. '90' - Percentual mensal (utilizando parâmetros do cadastro de beneficiário para dias úteis ou corridos) '93' - Valor diário (utilizando parâmetros do cadastro de beneficiário para dias úteis ou corridos) || Não Tratado || Não Tratado || obrigatório ||
|-
| 10.2 || valor_juros || Valor dos juros a ser cobrado. Obrigatório para codigo_tipo_juros ‘93’. Formato do campo: 15 dígitos inteiros e 2 casas decimais. Exemplo: 99999999999999900 || Não Tratado || Não Tratado || opcional ||
|-
| 10.3 || percentual_juros || Percentual dos juros a ser cobrado. Obrigatório para tipo_juros ‘90’, ‘91’ e ‘92’. Formato do campo: 7 dígitos inteiros e 5 casas decimais. Exemplo: 999999900000 || Não Tratado || Não Tratado || opcional ||
|-
| 10.4 || data_juros || Data de início de cobrança de juros. Caso o campo esteja vazio, será automaticamente assumido que a cobrança de juros se inicia logo após o vencimento. Formato: AAAA-MM-DD || Não Tratado || Não Tratado || opcional ||
|-
| 11 || '''multa'''
|-
| 11.1 || codigo_tipo _multa || Código da multa '01' - Quando se deseja cobrar um valor fixo de multa após o vencimento. '02' - Quando se deseja cobrar um percentual do valor do título de multa após o vencimento. '03' - Quando não se deseja cobrar multa caso o pagamento seja feito após o vencimento (isento) || Não Tratado || Não Tratado || obrigatório ||
|-
| 11.2 || valor_multa || Valor da multa cobrada. Obrigatório para codigo_tipo_multa 01. Formato do campo: 15 dígitos inteiros e 2 casas decimais || Não Tratado || Não Tratado || opcional ||
|-
| 11.3 || percentual_multa || Percentual da multa cobrada. Obrigatório para tipo_multa 02. Formato do campo: 7 dígitos inteiros e 5 casas decimais || Não Tratado || Não Tratado || opcional ||
|-
| 11.4 || data_multa || Data de início de cobrança de multa. Caso o campo esteja vazio, será automaticamente assumido que a cobrança de multa se inicia logo após o vencimento. Formato: AAAA-MM-DD || Não Tratado || Não Tratado || opcional ||
|-
| 12 || '''desconto'''
|-
| 12.1 || codigo_tipo _desconto || Código do desconto. Caso exista mais de um desconto, todos os tipo_desconto deverão ter o mesmo código. '00' - Quando não houver condição de desconto – sem desconto '01' - Quando o desconto for um valor fixo se o título for pago até a data informada (data_desconto) '02' - Quando o desconto for um percentual do valor do título e for pago até a data informada (data_desconto) '90' - Percentual por antecipação(utilizando parâmetros do cadastro de beneficiário para dias úteis ou corridos)" '91' -Valor por antecipação (utilizando parâmetros do cadastro de beneficiário para dias úteis ou corridos)" || Não Tratado || Não Tratado || obrigatório ||
|-
| 12.2 || data_desconto || Data limite de cobrança de desconto. Caso o campo esteja vazio, será automaticamente assumido que a cobrança de desconto é até a data de vencimento. Formato: AAAA-MM-DD || Não Tratado || Não Tratado || opcional ||
|-
| 12.3 || valor_desconto || Valor do desconto a ser cobrado. Obrigatório para codigo_tipo_desconto 1 ou 91. Formato do campo: 15 dígitos inteiros e 2 casas decimais || Não Tratado || Não Tratado || opcional ||
|-
| 12.4 || percentual_desconto || Percentual do desconto concedido. Obrigatório para codigo_tipo_desconto 2 ou 90. Formato do campo: 7 dígitos inteiros e 5 casas decimais || Não Tratado || Não Tratado || opcional ||
|-
| 13 || '''recebimento_divergente'''
|-
| 13.1 || codigo_tipo _autorizacao || Tipo de autorização de recebimento divergente da cobrança. "01" - Quando o título aceita qualquer valor divergente ao da cobrança. "02" - Quando o título contém uma faixa de valores aceitos para recebimentos divergentes. "03" - Quando o título não deve aceitar pagamentos de valores divergentes ao da cobrança. "04" - Quando o título aceitar pagamentos de valores superiores ao mínimo definido" || Não Tratado || Não Tratado || obrigatório ||
|-
| 13.2 || codigo_tipo _recebimento || Tipo de autorização de recebimento divergente da cobrança. Obrigatório para codigo_tipo_autorizacao diferente de 01 e 03. V - Recebimento divergente for informado por valores P - Recebimento divergente for informado por percentuais || Não Tratado || Não Tratado || opcional ||
|-
| 13.3 || valor_minimo || Valor mínimo permitido para pagamento. Obrigatório para codigo_aceite_pagamento_divergente 2 ou 4. Formato do campo: 15 dígitos inteiros e 2 casas decimais || Não Tratado || Não Tratado || opcional ||
|-
| 13.4 || percentual_minimo || Percentual mínimo permitido para pagamento. Obrigatório para codigo_tipo_autorizacao 2 ou 4. Formato do campo: 7 dígitos inteiros e 5 casas decimais || Não Tratado || Não Tratado || opcional ||
|-
| 13.5 || valor_maximo || Valor máximo permitido para pagamento. Obrigatório para codigo_tipo_autorizacao 2. Formato do campo: 15 dígitos inteiros e 2 casas decimais || Não Tratado || Não Tratado || opcional ||
|-
| 13.6 || percentual_maximo || Percentual máximo permitido. Obrigatório para codigo_tipo_autorizacao 2. Formato do campo: 7 dígitos inteiros e 5 casas decimais || Não Tratado || Não Tratado || opcional ||
|-
| 14 || '''protesto'''
|-
| 14.1 || protesto || Códigos das instruções de protesto. Ver "Tabela de Instruções" || Não Tratado || Não Tratado || obrigatorio ||
|-
| 14.2 || quantidade_dias _protesto || Quantidade de dias requisitado para instrução de protesto || Não Tratado || Não Tratado || opcional ||
|-
| 15 || '''negativacao'''
|-
| 15.1 || negativacao || Códigos das instruções de negativação. Ver "Tabela de Instruções" '''>CLIQUE AQUI<''' || Não Tratado || Não Tratado || obrigatorio ||
|-
| 15.2 || quantidade_dias_negativacao || Quantidade de dias requisitado para instrução de negativação || Não Tratado || Não Tratado || opcional ||
|-
|}

</center>
 
<center> '''Tabela de Instruções'''
{| class="wikitable"
|-
! Código !! Instrução
|-
| 1 || Protestar
|-
| 2 || Negativar
|-
| 4 || Não protestar
|-
| 5 || Não negativar
|-
| 7 || Não receber após o vencimento
|-
| 8 || Baixar após vencimento
|-
|}
 
<center>'''Tabela de Espécies'''
{| class="wikitable"
|-
! Código !! Sigla !! Descrição da espécie
|-
| 1 || DM || Duplicata de Venda Mercantil
|-
| 2 || NP || Nota Promissória
|-
| 3 || NS || Nota de Seguro
|-
| 4 || ME || Mensalidade Escolar
|-
| 5 || RC || Recibo
|-
| 6 || CT || Contrato
|-
| 8 || DS || Duplicata de Prestação de Serviços Original
|-
| 9 || LC || Letra de Câmbio
|-
| 15 || DD || Documento de Dívida
|-
| 16 || EC || Encargos Condominais
|-
| 17 || FS || Fatura de Serviço
|-
| 18 || BDP || Boleto Proposta
|-
| 88 || CBI || Cédula de Crédito Bancário por Indicação
|-
| 89 || CC || Contrato de Câmbio
|-
| 90 || CCB || Cédula de Crédito Bancário
|-
| 91 || CD || Confissão de Dívida
|-
| 92 || CH || Cheque
|-
| 93 || CM || Contrato de Mútuo
|-
| 94 || CPS || Conta de Prestação de Serviços
|-
| 95 || DMI || Duplicata de Venda Mercantil por Indicação
|-
| 96 || DSI || Duplicata de Prestação de Serviços - Original Por Indicação
|-
| 97 || RA || Recibo de Aluguel (PJ)
|-
| 98 || TA || Termo de acordo
|-
| 99 || DV || Diversos
|-
|}

='''Layout e Detalhamento de Campos API'''=

==Registro de Boletos==
<center>

{| class="wikitable"
|-
! Nº !! Campo JSON !! Descriçao do Banco !! Campo CIGAM !! Tabela !! Obrigatório !! Observações
|-
| 1 || tipo_ambiente || '''Domínios:'''
Para Testes: 1
 
Para Produção: 2
|| Não Tratado || Não Tratado || Obrigatório ||
|-
| 2 || tipo_registro || '''Domínios:'''
Para Registro: 1
|| Não Tratado || Não Tratado || Obrigatório ||
|-
| 3 || tipo_cobranca || '''Domínios:'''
Para boletos: 1
|| Não Tratado || Não Tratado || Obrigatório ||
|-
| 4 || tipo_produto || '''Domínios:'''
Cliente: 00006
|| Não Tratado || Não Tratado || Obrigatório ||
|-
| 5 || subproduto || '''Domínios:'''
Cliente: 00008
|| Não Tratado || Não Tratado || Obrigatório ||
|-
| 6 || identificador_titulo_empresa || É um campo de livre utilização pela empresa parceira, cuja informação não é consistida pelo Banco Itaú e não sai no aviso de cobrança, retornando ao beneficiário no arquivo retorno em qualquer movimentação do título (baixa, liquidação, confirmação de protesto, etc.) com o mesmo conteúdo da entrada.|| Lancamento || LANCAM || Opcional || Para instituições financeiras (ab:1248/Bancorp), o conteúdo deste campo também será impresso no rodapé do boleto
|-
| 7 || titulo_aceite || '''Domínios:'''
Se for um boleto de cobrança: S
 
Se for um boleto de proposta: N
|| Aceite || Portador || Obrigatório ||
|-
| 8 || tipo_carteira_titulo || '''Domínios:'''
109, 110, 111, 124, 125, 133, 142, 143, 145, 146, 148, 149, 153, 160, 167, 175, 179, 186, 187, 189, 196, 198, 202, 203, 210.
|| Carteira || Portador || Obrigatório || Deve ser informado algum dos códigos de carteiras disponíveis na Descrição
|-
| 9 || nosso_numero || '''Domínios:'''
'''Carteiras Diretas com registro:'''
 
Carteiras Diretas: Livre utilização pelo beneficiário *
 
'''Carteiras com nosso número adicional:'''
 
Carteira 133: Enviar valor do nosso número no campo uso
da empresa.
 
Carteiras 189, 196 e 198: Enviar os 8 primeiros dígitos no campo nosso número e os dígitos restantes no campo seu número.
|| Nosso Número || Boletos || Obrigatório || *Campo de livre utilização pelo usuário, não podendo ser repetida se o número ainda estiver registrado no Banco Itaú ou se transcorridos menos de 45 dias de sua Baixa/Liquidação
no Banco Itaú. Dependendo da carteira de cobrança utilizada, a faixa de Nosso Número pode ser
definida pelo Banco. A empresa é responsável pelo seu controle e pela geração correta do
número do DAC (Dígito de Auto Conferência).
|-
| 10 || digito_verificador_nosso_numero || Deve ser informado o Dígito Verificador do Nosso Número. || Nosso Número || Boletos || Obrigatório ||
|-
| 11 || codigo_barras || Deve ser informado o número do código de barras. || Não Tratado || Não Tratado || Opcional || Para carteiras com nosso número adicional sempre enviar o código de barras.
|-
| 12 || data_vencimento || Deve ser informada a data de vencimento do título. Inserir em formato YYYY-MM-DD. || Vencimento || LANCAM || Opcional || Pagamentos com Tipo de Pagamento à vista não precisam preencher o parâmetro data_vencimento. Caso contrário, o parâmetro deve ser preenchido.
|-
| 13 || valor_cobrado || Deve ser informado o valor a ser cobrado. || Saldo || LANCAM || Obrigatório || Inserir em formato 99999999999999900. Completar com zeros à esquerda e à direita (9 - Digito inteiro. 0 - Casa decimal).
|-
| 14 || seu_numero || Deve ser informado o valor do Seu Número. || Não Tratado || Não Tratado || Opcional || 10 caracteres numéricos
|-
| 15 || especie || Inserir somente algum dos valores. [[#Domínios: especie|Clique aqui]] para visualizar os domínios. || Espécie || Portador || Obrigatório ||
|-
| 16 || data_emissao || Deve ser informada a data de emissão do boleto. || Data || LANCAM || Obrigatório || Inserir em formato YYYY-MM-DD.
|-
| 17 || data_limite_pagamento || Deve ser informada a data limite de pagamento. || Não Tratado || Não Tratado || Opcional || Inserir em formato YYYY-MM-DD
|-
| 18 || tipo_pagamento || Deve ser informado um dos valores:
'''Domínios:'''
 
Pagamento realizado à vista - 1
 
Pagamento com data de vencimento determinada - 3
|| Não Tratado || Não Tratado || Obrigatório || Pagamentos com Tipo de Pagamento à vista não precisam preencher o parâmetro data_vencimento. Caso contrário, o parâmetro deve ser preenchido.
|-
| 19 || indicador_pagamento_parcial || '''Domínios:'''
Aceita pagamento parcial - true
 
Não aceita pagamento parcial - false
|| Não Tratado || Não Tratado || Obrigatório ||
|-
| 20 || quantidade_pagamento_parcial || Deve ser informada a quantidade de vezes que o mesmo boleto poderá ser pago parcialmente. || Não Tratado || Não Tratado || Opcional || Enviar entre 01 e 99.
|-
| 21 || quantidade_parcelas || Deve ser informado a quantidade de parcelas que o título gerará. || Não Tratado || Não Tratado || Opcional || Enviar entre 001 e 999.
|-
| 22 || instrucao_cobranca_1 || Deve ser informado o código correspondente à instrução de cobrança. [[#Tabela de Instruções de Cobrança|Clique aqui]] para visualizar a tabela. || Não Tratado || Não Tratado || Opcional ||
|-
| 23 || quantidade_dias_1 || Deve ser informada, dependendo da instrução de cobrança (vide tabela de instruções de cobrança), a quantidade de dias referente à instrução. || Não Tratado || Não Tratado || Opcional || Enviar entre 00 e 99
|-
| 24 || data_instrucao_1 || Deve ser informada, dependendo da instrução de cobrança (vide tabela de instruções de cobrança), a data referente à instrução. Inserir em formato YYYY-MM-DD || Não Tratado || Não Tratado || Opcional || Dependendo da instrução de cobrança (vide tabela de instruções de cobrança), o parâmetro quantidade_dias_1 se torna obrigatório.
|-
| 25 || instrucao_cobranca_2 || Deve ser informado o código correspondente à instrução de cobrança. [[#Tabela de Instruções de Cobrança|Clique aqui]] para visualizar a tabela.|| Não Tratado || Não Tratado || Opcional ||
|-
| 26 || quantidade_dias_2 || Deve ser informada, conforme instrução de cobrança (vide tabela de instruções de cobrança), a quantidade de dias referente à instrução. || Não Tratado || Não Tratado || Opcional || Enviar entre 00 e 99
|-
| 27 || data_instrucao_2 || Deve ser informada, dependendo da instrução de cobrança (vide tabela de instruções de cobrança), a data referente à instrução. Inserir em formato YYYY-MM-DD. || Não Tratado || Não Tratado || Opcional || Dependendo da instrução de cobrança (vide tabela de instruções de cobrança), o
parâmetro quantidade_dias_2 se torna obrigatório.
|-
| 28 || instrucao_cobranca_3 || Deve ser informado o código correspondente à instrução de cobrança. Ver tabela de instrução de cobrança. || Não Tratado || Não Tratado || Opcional ||
|-
| 29 || quantidade_dias_3 || Deve ser informada, dependendo da instrução de cobrança (vide tabela de instruções de cobrança), a quantidade de dias referente à instrução. || Não Tratado || Não Tratado || Opcional || Enviar entre 00 e 99.
|-
| 30 || data_instrucao_3 || Deve ser informada, dependendo da instrução de cobrança (vide tabela de instruções de cobrança), a data referente à instrução. Inserir em formato YYYY-MM-DD. || Não Tratado || Não Tratado || Opcional || Dependendo da instrução de cobrança (vide tabela de instruções de cobrança), o parâmetro quantidade_dias_3 se torna obrigatório.
|-
| 31 || valor_abatimento || Deve ser informado o valor de desconto/abatimento. O sistema limita o desconto concedido a 90% do valor de entrada do título. Para um mesmo título podem ser concedidos mais dois descontos, desde que previamente parametrizado no cadastro de cobrança do beneficiário (indicador 19.0).
|| Não Tratado || Não Tratado || Opcional || Inserir em formato 99999999999999900. Completar com zeros à esquerda e à direita (9 - Digito inteiro. 0 - Casa decimal).
|-
| 32 || cpf_cnpj_beneficiario || Deve ser informado o número de inscrição do beneficiário no CNPJ sem traços e barras.|| Não Tratado || Não Tratado || Obrigatório || Inserir em texto corrido o CNPJ. Enviar 14 posições. Formato: 00000000000000.
|-
| 33 || agencia_beneficiario || Inserir no formato 0000. || Agência || Portador || Obrigatório || Inserir no formato 0000.
|-
| 34 || conta_beneficiario || Deve ser informado o número da conta bancária do beneficiário. || Conta Número || Portador || Obrigatório || Inserir no formato 0000000. Não incluir dígito verificador. Inserir 0 à esquerda.
|-
| 35 || digito_verificador_conta_beneficiario || Deve ser informado o dígito verificador da conta do beneficiário. || Conta Número || Portador || Obrigatório || Inserir no formato 0.
|-
| 36 || cpf_cnpj_pagador || Deve ser informado o número de inscrição do pagador no CPF/CNPJ sem traços e barras. || CNPJ/CPF || Empresa || Obrigatório || Inserir em texto corrido o CPF ou CNPJ. Em caso de CPF, enviar 11 posições. Formato: 00000000000000
|-
| 37 || nome_pagador || Deve ser informado o nome do Pagador. || Nome Completo || Empresa || Obrigatório || 30 caracteres alfabéticos.
|-
| 38 || logradouro_pagador || Deve ser informado o logradouro do Pagador. || Endereço || Empresa || Obrigatório || 40 caracteres alfanuméricos.
|-
| 39 || bairro_pagador || Deve ser informado o bairro do Pagador. || Bairro || Empresa || Opcional || 15 caracteres alfanuméricos.
|-
| 40 || cidade_pagador || Deve ser informada a cidade do Pagador. || Município || Empresa || Obrigatório || 20 caracteres alfanuméricos.
|-
| 41 || uf_pagador || Deve ser informada a sigla da União Federativa do pagador (UF). || UF || Empresa || Obrigatório || 2 caracteres alfanuméricos.
|-
| 42 || cep_pagador || Deve ser informado o Código de Endereçamento Postal do pagador (CEP). || CEP || Empresa || Obrigatório || Inserir no formato 00000000.
|-
| 43 || grupo_email_pagador || É uma lista com e-mails do pagador (ocorre até 5 vezes). Para as carteiras de cobrança escriturais, onde o Banco Itaú mantém o registro da cobrança e se encarrega de imprimir e postar os Boletos, tendo sido acertado previamente entre o Beneficiário e o Pagador, o boleto poderá ser remetido ao Pagador por e-mail, destinando-o ao endereço especificado neste campo. Se o endereço de e-mail informado for inválido, o boleto será impresso e enviado pelos meios tradicionais. Neste caso o Beneficiário será informado no arquivo retorno pela ocorrência '25' e o motivo '1826'. Se o pagador não acessar o boleto até 5 dias úteis antes do vencimento, desde que já tenham se passado 2 dias úteis do envio do e-mail, o boleto será impresso e enviado pelos meios tradicionais. Neste caso, o beneficiário será informado no arquivo retorno pela ocorrência '25' e o motivo '1818'. || || || Opcional || Cobrança e-mail não compatível com cobrança mensagem.
|-
| 44 || email_pagador || Subparâmetro de grupo_email_pagador que contém a String do endereço de e-mail. || Email || Contato || Opcional || 100 caracteres alfanuméricos.
|-
| 45 || cpf_cnpj_sacador_avalista || Deve ser informado o número de inscrição do pagador no CPF/CNPJ sem traços e barras. || Não Tratado || Não Tratado || Opcional || Inserir em texto corrido o CPF ou CNPJ. Em caso de CPF, enviar 11 posições. Formato: 00000000000000.
|-
| 46 || nome_sacador_avalista || Deve ser informado o nome do Sacador Avalista. || Não Tratado || Não Tratado || Opcional || 50 caracteres alfabéticos.
|-
| 47 || logradouro_sacador_avalista || Deve ser informado logradouro do Sacador Avalista. || Não Tratado || Não Tratado || Opcional || 40 caracteres alfanuméricos.
|-
| 48 || bairro_sacador_avalista || Deve ser informado o bairro do Sacador Avalista. || Não Tratado || Não Tratado || Opcional || 15 caracteres alfanuméricos.
|-
| 49 || cidade_sacador_avalista || Deve ser informada a cidade do Sacador Avalista. || Não Tratado || Não Tratado || Opcional || 20 caracteres alfanuméricos.
|-
| 50 || uf_sacador_avalista || Deve ser informada a sigla da União Federativa o Sacador Avalista (UF). || Não Tratado || Não Tratado || Opcional || 2 caracteres alfanuméricos.
|-
| 51 || cep_sacador_avalista || Deve ser informado o Código de Endereçamento Postal do Sacador Avalista (UF). || Não Tratado || Não Tratado || Opcional || Inserir no formato 00000000. Todos os parâmetros dos dados do Sacador Avalista são opcionais, porém se um deles for preenchido, todos eles se tornam obrigatórios.
|-
| 52 || codigo_moeda_cnab || Deve ser informado o código CNAB da moeda que expressa o valor do título. Para o Banco Itaú o título é sempre emitido em real. Para moeda real o campo deve ser preenchido com 09. || Não Tratado || Não Tratado || Obrigatório || Inserir no formato 00. Inserir 0 à esquerda.
|-
| 53 || quantidade_moeda || Deve ser informada a quantidade da moeda informada. || Não Tratado || Não Tratado || Opcional || Inserir em formato 99999999999999900. Completar com zeros à esquerda e à direita (9 - Digito inteiro. 0 - Casa decimal)
|-
| 54 || data_juros || Deve ser informada a data que começará a cobrar juros do título. Caso esteja vazio, o valor automaticamente passará a assumir a data de vencimento. || Não Tratado || Não Tratado || Opcional || Inserir em formato YYYY-MM-DD.
|-
| 55 || tipo_juros || Inserir somente algum dos valores da tabela. [[#Tabela de Domínios: tipo_juros|Clique aqui]] para acessar a tabela. || Não Tratado || Não Tratado || Obrigatório || Para cada um dos valores informados, no boleto será impresso a anotação referente. Por exemplo: “APÓS VENCIMENTO, COBRAR JUROS DE (valor/percentual) (dias corridos/dias úteis).
|-
| 55.1 || valor_juros || Deve ser informado o valor de juros (de acordo com o selecionado em tipo_juros). || Não Tratado || Não Tratado || Opcional || Inserir em formato 99999999999999900. Completar com zeros à esquerda e à direita (9 - Digito inteiro. 0 - Casa decimal).
|-
| 55.2 || percentual_juros || Deve ser informado o percentual dos juros (de acordo com o selecionado em (tipo_juros). || Não Tratado || Não Tratado || Opcional || Inserir em formato 999999900000. Completar com zeros à esquerda e à direita (9 - Digito inteiro. 0 - Casa decimal).
|-
| 56 || data_multa || Deve ser informada a data em que será cobrada multa ao ser atingida. Caso esteja vazio, o valor automaticamente passará a assumir a data de vencimento. || Não Tratado || Não Tratado || Opcional || Inserir em formato YYYY-MM-DD.
|-
| 56.1 || tipo_multa || Deve ser informado um dos valores de acordo com a tabela. [[#Tabela de Domínios: tipo_multa|Clique aqui]] para visualizar a tabela. || Não Tratado || Não Tratado || Obrigatório ||
|-
| 56.2 || valor_multa || Deve ser informado o valor da multa (de acordo com o selecionado em tipo_multa).
|| Não Tratado || Não Tratado || Opcional || Inserir em formato 99999999999999900. Completar com zeros à esquerda e à direita (9 - Digito inteiro. 0 - Casa decimal).
|-
| 56.3 || percentual_multa || Deve ser informado o percentual da multa (de acordo com o selecionado em
tipo_multa).
|| Não Tratado || Não Tratado || Opcional || Inserir em formato 999999900000. Completar com zeros à esquerda e à direita (9 - Digito inteiro. 0 - Casa decimal).
|-
| 57 || grupo_desconto || lista (ocorre até 5 vezes) que contém os seguintes parâmetros abaixo. || || || ||
|-
| 57.1 || data_desconto || Deve ser informada uma data de referência para o desconto. || Não Tratado || Não Tratado || Opcional || Inserir em formato YYYY-MM-DD.
|-
| 57.2 || tipo_desconto || Deve ser informado um dos valores de acordo com a tabela. [[#Tabela de Domínios: tipo_desconto|Clique aqui]] para visualizar a tabela. || Não Tratado || Não Tratado || Obrigatório ||
|-
| 57.3 || valor_desconto || Deve ser informado o valor da multa (de acordo com o selecionado em tipo_desconto). || Não Tratado || Não Tratado || Opcional || Inserir em formato 99999999999999900. Completar com zeros à esquerda e à direita (9 - Digito inteiro. 0 - Casa decimal).
|-
| 57.4 || percentual_desconto || Deve ser informado o percentual da multa (de acordo com o selecionado em (tipo_desconto). || Não Tratado || Não Tratado || Opcional || Inserir em formato 999999900000. Completar com zeros à esquerda e à direita (9 - Digito inteiro. 0 - Casa decimal).
|-
| 58 || tipo_autorizacao_recebimento || Deve ser informado um dos valores de acordo com a tabela. [[#Tabela de Domínios: tipo_autorizacao_recebimento|Clique aqui]] para visualizar a tabela. || Não Tratado || Não Tratado || Obrigatório ||
|-
| 59 || tipo_valor_percentual_recebimento || Deve ser informado um dos valores:
'''Domínios:'''
 
Quando o recebimento divergente for informado por valores - V
 
Quando o recebimento divergente for informado por percentuais - P
|| Não Tratado || Não Tratado || Opcional ||
|-
| 60 || valor_minimo_recebimento || Deve ser informado o valor mínimo de recebimento. || Não Tratado || Não Tratado || Opcional || Inserir em formato 99999999999999900. Completar com zeros à esquerda e à direita (9 - Digito inteiro. 0 - Casa decimal).
|-
| 61 || percentual_minimo_recebimento || Deve ser informado o percentual mínimo de recebimento. || Não Tratado || Não Tratado || Opcional || Inserir em formato 999999900000. Completar com zeros à esquerda e à direita (9 - Digito inteiro. 0 - Casa decimal).
|-
| 62 || valor_maximo_recebimento || Deve ser informado o valor máximo de recebimento. || Não Tratado || Não Tratado || Opcional || Inserir em formato 99999999999999900. Completar com zeros à esquerda e à direita (9 - Digito inteiro. 0 - Casa decimal).
|-
| 63 || percentual_recebimento || Deve ser informado o percentual máximo de recebimento. Inserir em formato 999999900000. Completar com zeros à esquerda e à direita (9 - Digito inteiro. 0 - Casa decimal). || Não Tratado || Não Tratado || Opcional || Os campos: "valor_minimo_recebimento" ou "percentual_minimo_recebimento" e ”valor_maximo_recebimento" ou "percentual_maximo_recebimento", se tornam obrigatórios quando o campo "tipo_autorizacao_recebimento" recebe valor "aceita_minimo_maximo". Quando o tipo_autorizacao_recebimento for igual à “4”, apenas os campos valor/percentual mínimo são obrigatórios.
|-
| 64 || agencia_grupo_rateio || Deve ser informada a agência bancária que ocorrerá o rateio. || Não Tratado || Não Tratado || Opcional || Inserir no formato 0000.
|-
| 65 || conta_grupo_rateio || Deve ser informada a conta bancária que ocorrerá o rateio. || Não Tratado || Não Tratado || Opcional || Inserir no formato 0000000. Não incluir dígito verificador. Inserir 0 à esquerda.
|-
| 66 || digito_verificador_conta_grupo_rateio || Deve ser informado o dígito verificador da conta em que ocorrerá o rateio. || Não Tratado || Não Tratado || Opcional || Inserir no formato 0.
|-
| 67 || tipo_rateio || Deve ser informado um dos valores de acordo com a tabela. [[#Tabela de Domínios: tipo_rateio|Clique aqui]] para visualizar a tabela. || Não Tratado || Não Tratado || Opcional ||
|-
| 68 || valor_percentual_rateio || Deve ser informado o valor ou percentual do rateio. Todos os parâmetros no rateio são opcionais, porém se um deles for preenchido, todos eles tornam-se obrigatórios. A conta do beneficiário não deve ser incluída na relação de contas de rateio. || Não Tratado || Não Tratado || Opcional || Inserir em formato 99999999999900000. Completar com zeros à esquerda e à direita (9 - Digito inteiro. 0 - Casa decimal).
|-
|}

</center>

 
===Domínios: especie===

• Duplicata Mercantil - 01
 
• Nota Promissória - 02
 
• Nota de Seguro - 03
 
• Mensalidade Escolar - 04
 
• Recibo - 05
 
• Contrato - 06
 
• Cosseguros - 07
 
• Duplicata de Serviço - 08
 
• Letra de Câmbio - 09
 
• Nota de Débitos - 13
 
• Documento de Dívida - 15
 
• Encargos Condominiais - 16
 
• Prestação de Serviços - 17
 
• Boleto de Proposta - 18
 
• Diversos - 99
 
 

===Tabela de Instruções de Cobrança===
<center>
{| class="wikitable"
|-
! Instrução !! Código
|-
| Devolver após 05 dias do vencimento || 02
|-
| Devolver após 30 dias do vencimento || 03
|-
| Receber conforme instruções no próprio título || 05
|-
| Devolver após 10 dias do vencimento || 06
|-
| Devolver após 15 dias do vencimento || 07
|-
| Devolver após 20 dias do vencimento || 08
|-
| PROTESTAR (envia ao cartório após ''quantidade dias'' dias úteis ou corridos do vencimento de acordo com o cadastro do beneficiário / não imprimi no boleto) || 09
|-
| Não protestar (inibe protesto, quando houver) || 10
|-
| Devolver após 25 dias do vencimento || 11
|-
| Devolver após 35 dias do vencimento || 12
|-
| Devolver após 40 dias do vencimento || 13
|-
| Devolver após 45 dias do vencimento || 14
|-
| Devolver após 50 dias do vencimento || 15
|-
| Devolver após 55 dias do vencimento || 16
|-
| Devolver após 60 dias do vencimento || 17
|-
| Devolver após 90 dias do vencimento || 18
|-
| Não receber após 05 dias do vencimento || 19
|-
| Não receber após 10 dias do vencimento || 20
|-
| Não receber após 15 dias do vencimento || 21
|-
| Não receber após 20 dias do vencimento || 22
|-
| Não receber após 25 dias do vencimento || 23
|-
| Não receber após 30 dias do vencimento || 24
|-
| Não receber após 35 dias do vencimento || 25
|-
| Não receber após 40 dias do vencimento || 26
|-
| Não receber após 45 dias do vencimento || 27
|-
| Não receber após 50 dias do vencimento || 28
|-
| Não receber após 55 dias do vencimento || 29
|-
| Importância de desconto por dia || 30
|-
| Não receber após 60 dias do vencimento || 31
|-
| Não receber após 90 dias do vencimento || 32
|-
| Conceder abatimento ref. À PIS-PASEP/COFIN/CSLL, mesmo após vencimento || 33
|-
| Protesto urgente (Envia ao cartório após quantidade_dias úteis ou corridos do vencimento de acordo com o cadastro do beneficiário / não imprime no boleto) || 36
|-
| Receber até o último dia do mês de vencimento || 37
|-
| Conceder desconto mesmo após vencimento || 38
|-
| Não receber após o vencimento || 39
|-
| Conceder desconto conforme nota de crédito || 40
|-
| Protesto para fins alimentares || 42
|-
| Sujeito a protesto se não for pago no vencimento || 43
|-
| Importância por dia de atraso a partir de YYYY-MM-DD || 44
|-
| Tem dia da graça || 45
|-
| Uso do banco || 46
|-
| Dispensar Juros/Comissão de permanência || 47
|-
| Receber somente com a parcela anterior quitada || 51
|-
| Efetuar o pagamento somente através deste boleto e na rede bancária || 52
|-
| Uso do banco || 53
|-
| Após vencimento, pagável somente na empresa || 54
|-
| Uso do banco || 56
|-
| Somar valor do título ao valor do campo mora/multa caso exista || 57
|-
| Devolver após 365 dias de vencido || 58
|-
| Cobrança negociada. Pagável somente por este boleto na rede bancária || 59
|-
| Título entregue em penhor em favor do beneficiário acima || 61
|-
| Título transferido a favor do beneficiário || 62
|-
| Entrada em negativação expressa (Impresso no boleto: “SUJEITO A NEGATIVAÇÃO APÓS O VENCIMENTO”) ||
66
|-
| Não negativar (Inibe entrada na negativação expressa) || 67
|-
| Uso do banco || 70 a 75
|-
| Valor da ida engloba multa de 10% pro rata || 78
|-
| Cobrar juros após 15 dias da emissão (Para títulos com emissão à vista) || 79
|-
| Pagamento em cheque: Somente receber com cheque de emissão do pagador || 80
|-
| Protesto Urgente – Protestar após quantidade_dias dias corridos do vencimento (imprime no boleto) || 81
|-
| Protesto urgente – Protestar após quantidade_dias dias úteis do vencimento (imprime no boleto) || 82
|-
| Operação referente a vendor || 83
|-
| Após vencimento consultar a agência do beneficiário || 84
|-
| Antes do vencimento ou após 15 dias, pagável somente em nossa rede || 86
|-
| Uso do banco || 87
|-
| Não receber antes do vencimento || 88
|-
| Uso do banco || 89
|-
| No vencimento, pagável em qualquer agência bancária || 90
|-
| Não receber após quantidade_dias dias do vencimento || 91
|-
| Devolver após quantidade_dias dias do vencimento || 92
|-
| Mensagens nos boletos com 30 posições || 93
|-
| Mensagens nos boletos com 40 posições || 94
|-
| Uso do banco || 95 a 97
|-
| Duplicata / Fatura nº|| 98
|-
|}
</center>
 

===Tabela de Domínios: tipo_juros===
<center>
{| class="wikitable"
|-
! Condição !! Valor
|-
| Valor diário para incidência de juros após um dia corrido da Data de Vencimento || 1
|-
| Percentual diário para incidência de juros após um dia corrido da Data de Vencimento || 2
|-
| Percentual mensal para incidência de juros após um dia corrido da Data de Vencimento || 3
|-
| Percentual anual para incidência de juros após um dia corrido da Data de Vencimento || 4
|-
| Isento de Juros: Não se aplica juros caso o título seja pago após a Data de Vencimento || 5
|-
| Valor diário para incidência de juros após um dia útil da Data de Vencimento || 6
|-
| Percentual diário para incidência de juros após um dia útil da Data de Vencimento || 7
|-
| Percentual mensal para incidência de juros após um dia útil da Data de Vencimento || 8
|-
| Percentual anual para incidência de juros após um dia útil da Data de Vencimento || 9
|-
|}
</center>
 

===Tabela de Domínios: tipo_multa===
<center>
{| class="wikitable"
|-
! Condição !! Valor
|-
| Quando se deseja cobrar um valor fixo de multa após o vencimento. || 1
|-
| Quando se deseja cobrar um percentual do valor do título de multa após o vencimento. || 2
|-
| Isento: Quando não se deseja cobrar multa caso o pagamento seja feito após o vencimento || 3
|-
|}
</center>
 

===Tabela de Domínios: tipo_desconto===
<center>
{| class="wikitable"
|-
! Condição !! Valor
|-
| Sem desconto - Quando não houver condição de desconto || 0
|-
| Quando o desconto for um valor fixo se o título for pago até a data informada (data_desconto) || 1
|-
| Quando o desconto for um percentual do valor do título e for pago até a data informada (data_desconto) || 2
|-
| Quando o desconto for um valor dependente da quantidade de dias corridos na antecipação do pagamento referente à Data de Vencimento. || 3
|-
| Quando o desconto for um valor dependente da quantidade de dias úteis na antecipação do pagamento referente à Data de Vencimento. || 4
|-
| Quando o desconto for um percentual do valor do título e dependente da quantidade de dias corridos na antecipação do pagamento referente à Data de Vencimento. || 5
|-
| Quando o desconto for um percentual do valor do título e dependente da quantidade de dias úteis na antecipação do pagamento referente à Data de Vencimento. || 6
|-
|}
</center>

Por exemplo, se houver um título que tem valores dependentes da data de pagamento (R$400,00 se pago até o dia 10/10, R$ 500,00 se pago até o dia 20/10 e 600,00 se pago até dia 25/10), deverão ser inseridos três descontos no grupo, com data_desconto contendo as datas de referência e os valores (em valores fixos ou percentuais de desconto) respectivos dos descontos.
 

===Tabela de Domínios: tipo_autorizacao_recebimento===
<center>
{| class="wikitable"
|-
! Condição !! Valor
|-
| Quando o título aceita qualquer valor divergente ao da cobrança || 1
|-
| Quando o título contém uma faixa de valores aceitos para recebimentos divergentes || 2
|-
| Quando o título não deve aceitar pagamentos de valores divergentes ao da cobrança || 3
|-
| Quando o título aceitar pagamentos de valores superiores ao mínimo definido || 4
|-
|}
<center>
 

===Tabela de Domínios: tipo_rateio===
<center>
{| class="wikitable"
|-
! Condição !! Valor
|-
| Percentual ao valor original do título || 1
|-
| Valor referente ao valor original do título || 2
|-
| Percentual ao valor líquido recebido || 3
|-
| Valor referente ao valor líquido recebido || 4
|-
|}
</center>
 

='''Como realizar a criação de Lançamentos utilizando a funcionalidade Open Banking?'''=
 
Para a criação de Lançamentos Financeiros acessar o caminho de Menu:
 

'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 

Acessar o botão “Criar” e informar os dados necessários para a criação do Lançamento Financeiro a Receber utilizando o Portador parametrizado para Open Banking.
 
 
'''1- Etapa criação do Lançamento:'''
 
 
<center>'''Criação do Lançamento Financeiro a Receber'''
[[Arquivo:Lancamento Itau.png|750x500px|semmoldura|nenhum|Lancamento_Itau]]
 
 

'''2- Etapa Impressão do Boleto Bancário do Lançamento Financeiro:'''
 
Nesta etapa pode ser realizado a impressão do Boleto Bancário diretamente pelo próprio Lançamento Financeiro ou através da rotina de Emissão em lote "Emissão de Boletos Personalizados":
 
 
<center>'''Impressão do Boleto Bancário do Lançamento Financeiro'''
[[Arquivo:Lancamento Imprimir Boleto.png|750x500px|semmoldura|nenhum|Lancamento_Imprimir_Boleto]]
 
 

'''3- Etapa do Registro do Boleto Open Banking:'''
 
Nesta etapa pode ser realizado o "Registro" do Boleto diretamente pelo próprio Lançamento Financeiro ou através da rotina de Emissão em lote "Emissão de Boletos Personalizados":
Basta acessar a Categoria "Open Banking" e selecionar o Item de Categoria "Registrar".
Sistema irá realizar a comunicação através das parametrizações realizadas das Urls e Tokens de acesso e listará a situação do Registro do Boleto Bancário através do Relatório.
 
 
<center>'''Registrar Boleto Open Banking através Lançamento Financeiro'''
[[Arquivo:Lancamento Registrar.png|750x500px|semmoldura|nenhum|Lancamento_Registrar]]
 
 
<center>'''Relatório Remessa Bancária OnLine'''
[[Arquivo:Relat Impressão OP.png|750x500px|semmoldura|nenhum|Relat_Impressão_OP_Online]]
 
 
Após o registro automaticamente o sistema marca as opções de:
 
- Remessa Enviada
 
- Códigos de Barras Lodo
 
 
<center>'''Boleto Bancário Registrado'''
[[Arquivo:Lancamento Confirmado Historico.png|750x500px|semmoldura|nenhum|Lancamento_Confirmado_Historico]]
 
 
Para verificar todas as movimentações realizada sobre Open Banking, elas estão sendo gravadas no Item de Categoria "Histórico" que fica na Categoria "Open Banking".
Ao selecionar o Item de Categoria "Histórico" deve listar o Registro do Boleto Bancário.
 
 
<center>'''Item de Categoria Histórico de Movimentos Open Banking'''
[[Arquivo:Historico Lanc OP.png|750x500px|semmoldura|nenhum|Historico_Lanc_OP]]
 
 

='''Como realizar o Envio em Lote Open Banking através da rotina Remessa de Cobrança Open Banking?'''=

Assim como é possível realizar o Envio do Registro do Boleto Bancário através do próprio Lançamento Financeiro, existe a possibilidade de realizar esse processo em Lote, quando se tratar de vários registros a serem enviados.
Através do Menu:
 
 
'''Menu: Finanças > Gestão Financeira > Rotinas > EDI> Transmite > Remessa Cobranças Bancárias > Remessa de Cobrança Open Banking'''
 
 
<center>'''Remessa de Cobrança Open Banking'''
[[Arquivo:Remessa_de_Cobranca_Open_BankingiTAU.png|750x500px|semmoldura|nenhum|Remessa_de_Cobranca_Open_Banking]]
 
 
Esta rotina tem um conceito muito simples em relação aos filtros, foram disponibilizados campos essências que permitem ter uma rastreabilidade dos movimentos.

'''Unidade de Negócio:''' informe a Unidade de Negócio desejada para realizar o filtro para busca dos movimentos.
 
'''Data:''' informe a Data desejada para realizar o filtro para busca dos movimentos.
 
'''Vencimento:''' informe o período de Vencimento desejado para realizar o filtro para busca dos movimentos.
 
'''Lançamento:''' informe a faixa de Lançamentos desejada para realizar o filtro para busca dos movimentos.
 
'''Tipo de Pagamento:''' informe o Tipo de Pagamento desejado para realizar o filtro para busca dos movimentos.
 
'''Série:''' informe a Série desejada para realizar o filtro para busca dos movimentos.
 
'''Nota Fiscal:''' informe a faixa de Nota Fiscal desejada para realizar o filtro para busca dos movimentos.
 
'''Conta Financeira:''' informe a Conta Financeira desejada para realizar o filtro para busca dos movimentos.
 
'''Empresa:''' informe a faixa de Empresa desejada para realizar o filtro para busca dos movimentos.
 
'''Cobrança:''' informe a faixa de Empresa de Cobrança desejada para realizar o filtro para busca dos movimentos.
 
 
Após informado os filtros e confirmado a operação da rotina o sistema gera um relatório com a listagem dos movimentos.
Na coluna "Registro", será listado se houve a confirmação ou ocorreu algum erro.
 
 
<center>'''Relatório Remessa de Cobrança Open Banking'''
[[Arquivo:Relat Remessa Bancaria Open Banking.png|750x500px|semmoldura|nenhum|Relat_Remessa_Bancaria_Open_Banking]]
 
 

='''Como realizar a alteração de Vencimento do Lançamento já Registrado Open Banking e reenviá-lo novamente?'''=
 

Irá surgir a necessidade de realizar a alteração do Vencimento do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?
 
'''Dado que''' já temos um Lançamento Financeiro já Registrado Open Banking, basta acessar o Lançamento Financeiro desejado através do caminho do Menu:
 
'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 
Acessar o Lançamento Financeiro em modo Modificar e alterar o campo "Venc.Original", automaticamente após alteração do Vencimento, o sistema insere o Comando "05" no campo "Comando de Remessa", porém diferente do Banco do Brasil o envio não é automático, pois por enquanto o Banco não disponibilizou essa funcionalidade.
Logo esse registro de alteração de vencimento terá que ser tratado manualmente através de um envio de remessa bancária de cobrança.
 
'''Importante:''' para o envio da alteração do Vencimento o sistema já considera o campo '''Vencimento''', caso seja utilizado a '''Modalidade''' como '''Seguinte''' por exemplo, onde é possível ter um Vencimento Original diferente do Vencimento.
 
<center>'''Lançamento Financeiro a Receber já Registrado'''
[[Arquivo:Lancamento Sem Alt Venc.png|750x500px|nenhum|Lancamento_Sem_Alt_Venc]]
 
 
Vencimento alterado, sistema insere o Comando "05" no campo "Comando de Remessa".
Lembrando, para que essa alteração seja registrado no Banco, esse processo terá que ser gerado uma Remessa de Cobrança para enviar ao Banco esse registro.
<center>'''Vencimento alterado e registro salvo'''
[[Arquivo:Lancamento Venc Alterado.png|750x500px|nenhum|Lancamento_Venc_Alterado]]
 

='''Como realizar a Alteração de Multa do Lançamento já Registrado Open Banking e reenviá-lo novamente?'''=

Falta Documentar
 
='''Como realizar a Alteração de Juros do Lançamento já Registrado Open Banking e reenviá-lo novamente?'''=
 
Falta Documentar
 
='''Como realizar a Baixa de um Lançamento Financeiro Registrado Open Banking e enviar o Registro de Baixa?'''=

'''IMPORTANTE:''' O processo de Cancelamento de Notas Fiscais, não atende a baixa automatica dos Boletos, logo deve ser baixado manualmente os registros dos Lançamentos Financeiros.
 
 

='''Como parametrizar para envio Open Banking a Negativação ou Protesto?'''=
 
Basta acessar o Cadastro do Portador e inserir as parametrizações nos campos '''Intrução 1''' , '''Intrução 2''' e os dias no campo '''Protestar após''' na guia '''Configurações.
 

'''Menu > Finanças > Gestão Financeira > Parâmetros > Portadores'''

 
<center>'''Instrução 1 e 2 Cadastro do Portador'''
[[Arquivo:Cadastro Portador Negativacao ITAU Instrucoes.png|750x500px|nenhum|Cadastro_Portador_Negativacao_ITAU_Instrucoes]]
 

<center>'''Dias de Protesto Cadastro do Portador'''
[[Arquivo:Cadastro Portador Negativacao ITAU.png|750x500px|nenhum|Cadastro_Portador_Negativacao_ITAU]]
 

Banco ITAÚ:
 
Para este Banco a negativação é parametrizada no Cadastro do Portador na guia “Configurações” no campo “Protestar após” e considera os campos “Instrução 1” e “Instrução 2” sendo através destes campos que o sistema reconhece e passa considerar o envio das tags para os dados da API do Banco.
 
'''"instrucao_cobranca_1": “66”'''
 
'''"instrucao_cobranca_2": “09”'''
 
'''"quantidade_dias_2": “3”'''

 

='''Como cadastrar as Mensagens de Retorno API Financeira Sugestão Usuário?'''=
 
As Mensagens de Retorno API Financeira é uma funcionalidade para facilitar a identificar e de orientação para com as mensagens provindas das APIs que o Sistema tem conexão.
 
Elas foram implementadas para Open banking.
 
Para acessar o cadastro basta acessar através do Menu:
 
'''Menu: Finanças > Gestão Financeira > Parâmetros > Mensagens de Retorno API Financeiro'''
 

<center>'''Mensagens de Retorno API Financeiro'''
[[Arquivo:Mensagens Retorno API Financeiro.png|750x500px|nenhum|Mensagens_Retorno_API_Financeiro]]
 

'''Banco:''' código do Banco conforme codificação no orgão que rege os Bancos Febraban.
 
'''Código Erro:''' código do erro conforme layout das APIS dos Bancos.
 
'''Status:''' é o código de Status de erro do Servidor retornado da API dos Bancos. (Código HTTP)
 
'''Descrição do Erro (Banco):''' essa descrição é oriunda do Banco retornada pela API deles.
 
'''Sugestão CIGAM:''' esta mensagem é interna do Sistema, ou seja, quando internamente identificarmos uma situação a qual a Mensagem retornada pelo Banco não é clara, vamos alimentar com Mensagens de sugestão, para orientar as possíveis causas, dando um norte para situação.
 
'''Sugestão Cliente:''' este campo é reservado para o próprio usuário, possibilitando cadastrar Mensagens que ele identificar para facilitar no processo de entendimento das Mensagens de Retorno das APIs.
 
Agora através desta aplicação, quando ocorrer um Erro de Open Banking é possível verificar através dos links dispostos na tela de Lançamento Financeiro no campo Situação Open Banking, terá um link para tabela do erro ocorrido.
 
<center>'''Lançamento Financeiro Mensagens de Retorno API Financeiro'''
[[Arquivo:Mensagens Retorno API Financeiro BB OP.png|750x500px|nenhum|Mensagens_Retorno_API_Financeiro_BB_OP]]
 
Ou também através do Histórico Open Banking:
 
<center>'''Lançamento Financeiro Mensagens de Retorno API Financeiro Histórico Open Banking'''
[[Arquivo:Historico OP Mensagens Retorno API Financeiro BB OP.png|750x500px|nenhum|Historico_OP_Mensagens_Retorno_API_Financeiro_BB_OP]]

GF - Como Fazer - Open Banking para Banco SICOOB

2022-04-25T18:16:51Z

Alan.campos: /* Como realizar a Baixa de um Lançamento Financeiro Registrado Open Banking e enviar o Registro de Baixa? */

[[categoria:Como_Fazer_Finanças]]

='''O que significa Open Banking?'''=

Open Banking é um conceito relativamente novo na realidade do mercado financeiro brasileiro. Porém, ele tem ganhado cada vez mais atenção em todo o mundo.
 
Traduzido, o termo significa “banco aberto”, mas uma tradução mais precisa seria “sistema financeiro aberto”.
 
O conceito em si trata de algo de simples compreensão. Basicamente, Open Banking é a defesa de que o sistema financeiro adote a tecnologia de forma mais ampla e padronizada, como forma de incentivar e ampliar a oferta e a qualidade dos produtos e serviços financeiros.
 
A base do Open Banking está na premissa de que os dados pertencem aos consumidores. Logo, caso eles autorizem, esses dados devem ser disponibilizados para que eles possam ter acesso a produtos e serviços que forem mais convenientes.
 
Na prática, há um pedido para que as instituições abram suas API’s (sigla em inglês para Interface de Programação de Aplicativos) para que terceiros desenvolvam e aprimorem os sistemas e suas funcionalidades.
O objetivo do Open Banking é desenvolver sistemas integrados, que facilitem o controle e transferência de informações de dados, histórico, contas, empréstimos etc. Todo o tipo de produto e serviço oferecido pelos bancos seria integrado de maneira a evitar processos complicados e dispendiosos.
 
À primeira vista, pode parecer que com o Open Banking as informações dos clientes ficarão soltas e desprotegidas. No entanto, os bancos e instituições financeiras ainda serão responsáveis pela proteção de dados sigilosos.

 

='''Serviços Disponíveis pela API do Banco nesta Versão'''=

'''Menu > Utilidades/Diversos > Genéricos > Parâmetros > Configurações'''
 
<center>
{| class="wikitable"
|-
! SERVIÇO !! COBRANÇA
|-
| Registro de Boleto via API || SIM
|-
| Open Banking PIX no Boleto || NÃO
|-
| Retorno de Cobrança via API || SIM
|-
| Alteração de Juros via API || SIM
|-
| Alteração de Multa via API || SIM
|-
| Alteração de Vencimento via API || SIM
|-
| Alteração de Baixa via API || SIM
|-
| Retorno de Cobrança com Registro em Cartório via API || NÃO
|-
|}
</center>

 
'''Observação:''' Existe Retorno de Cobrança via API para o SICOOB mas ainda está em desenvolvimento. [[#Não Escopo Retorno Open Banking Cartório?|Clique aqui]] para mais informações.

='''Como obter as Credenciais para utilizar a Funcionalidade Open Banking?'''=

As credenciais do Banco SICOOB devem ser obtidas através do contato com o seu Gerente de Cash (responsável pela conta corrente na empresa).

='''Quais os Módulos necessários para utilizar a Funcionalidade Open Banking do Banco SICOOB?'''=

• Módulo Gestão Financeira;

='''Quais são as parametrizações necessárias para utilizar a funcionalidade do Open Banking?'''=

Para utilizar esta funcionalidade é necessário possuir o Cadastro do Portador para o SICOOB.
O cadastro quando preenchido corretamente garante que não ocorrerá inconsistências no momento do registro do Open Banking.
 
Como boa prática de implementação é mais coerente criar um novo Portador para Open Banking, evitando assim, de alterar o Portador utilizado para CNAB caso necessite realizar algum processo via remessa ou retorno quando a API do Banco estiver com instabilidade.
 
Essa parametrização deverá validar os últimos Sequenciais da numeração de Boletos do Portador utilizado para as Remessas, pois assim garante que não ocorrerá conflito enviar uma numeração de Título já registrado.
 
 
'''Itens Importantes na Parametrização:'''
 
'''- Processar retornos pelo número do Boleto:''' esta opção deve estar marcada, pois caso contrário ocorrerá problemas na gravação das informações e envio para Banco.
 
Caso tenha sido realizado movimentações com esta opção desmarcada, não será possível realizar a Baixa, pois sistema não consegue localizar devido não possuir o '''Nosso Número''' gravado nas tabelas envolvidas.
 
Para solucionar essa questão será necessário:
 
'''1-''' Identificar o '''Nosso Número''' do registro a ser baixado (Lançamento Financeiro);
 
'''2-''' Gravar o '''Nosso Número''' nas seguintes tabelas:
 
'''GFBOLETOS:''' campo a ser atualizado '''NOSSO_NRO''' com a informação do Nosso Número.
 
'''GFLAUXIL:''' campo a ser atualizado '''CODIGO_BARRAS''' com a informação do Nosso Número.
 
Para o correto funcionamento da rotina é necessário que os dados do Portador estejam com todas informações necessárias, inclusive o '''Convênio'''.
 
'''Menu > Finanças > Gestão Financeira > Parâmetros > Portadores'''
 
 
<center>'''Exemplo de Parametrização do Cadastro de Portador'''
[[Arquivo:Exemplo Cadastro Portador.png|750x500px|centro]]
 
<center>'''Guia CNAB'''
[[Arquivo:Guia CNAB.png|750x500px|centro]]
 
<center>'''Guia Configurações'''
[[Arquivo:Guia Configuracoes.png|750x500px|centro]]
 
 
'''Irá surgir a necessidade de realizar a alteração de Vencimento, Multa ou Juros do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?'''
 
Regra Sistema para Vencimento, Multa ou Juros:
 
Cadastro do Portador deve possuir Comando de Remessa com as novas opções:
 
'''Tipo de Comando =''' Alteração de Vencimento (para alteração de Vencimento).
 
'''Tipo de Comando =''' Alteração de Multa para Multa (para alteração de Multa).
 
'''Tipo de Comando =''' Alteração de Juros para Juros (para alteração de Juros).
 
Caso não seja parametrizado neste primeiro momento as opções de Multa e Juros o sistema cria automaticamente (Somente Juros e Multa).
 
Ao acessar o Lançamento Financeiro em modo Modificar e alterar o campo Multa de ou Juros de, automaticamente após alteração da Multa, o Sistema irá criar essa parametrização do Comando de Remessa com sugestão, sendo passível de alteração, no Cadastro do Portador no botão Remessas e depois no botão Comandos.
 
'''Comando sugestão para Multa:'''
 
'''Código Operação''' = ATM
 
'''Comando''' = ATM
 
'''Descrição''' = ALTERAÇÃO DE MULTA PARA OPEN BANKING
 
'''Tipo de Comando''' = Alteração de Multa
 
'''Comando sugestão para Juros:'''
 
'''Código Operação''' = ATJ
 
'''Comando''' = ATK
 
'''Descrição''' = ALTERAÇÃO DE JUROS PARA OPEN BANKING
 
'''Tipo de Comando''' = Alteração de Juros
 
<center>'''Botão Remessas > Comandos'''
[[Arquivo:Comandos de Remessas.png|750x500px|centro]]
 
 
Para iniciar a configuração através do “Assistente de Parâmetros do Open Banking”, basta selecionar o botão “Open Banking” e seguir os passos a partir do título [[#Tela Inicial Configuração do Assistente Open Banking|Tela Inicial Configuração do Assistente Open Banking]].
 
'''Menu > Finanças > Gestão Financeira > Parâmetros > Configuração de Bancos'''
 
 
<center>'''Configurações de Banco'''
[[Arquivo:Configuracao de Bancos.png|750x500px|centro]]


='''Tela Inicial Configuração do Assistente Open Banking'''=

Para iniciar a configuração é necessário ter em mãos os seguintes dados:
 
• '''Client ID'''
 
• '''Client Secret'''
 
• '''Token Basic'''
 
Sem essas informações não será possível dar continuidade na parametrização do Open Banking para o SICOOB.
 
[[#Como obter as Credenciais para utilizar a Funcionalidade Open Banking?|Como obter as Credenciais para utilizar a Funcionalidade Open Banking?]]

<center>'''Tela Inicial Assistente de Parâmetros Open Banking'''
[[Arquivo:Tela Inicial Assistente de Parâmetros Open Banking SICOOB.png|750x500px|centro]]
</center>

=='''Etapa 1 (Parâmetros: Passo 1 de 4):'''==


Uma das etapas mais importantes e que requer um maior cuidado e sigilo das informações nesta parametrização. Essas informações são disponibilizadas pelo Banco a qual deve ser restrita somente a pessoa responsável pelo setor Financeiro da Empresa.
 
O assistente tem como objetivo proporcionar que o próprio usuário tenha autonomia para executar esse passo a passo sem necessidade de passar essas informações restritas da Empresa para qualquer pessoa que não seja ele mesmo.
 
Vale reforçar que mesmo que tenha dificuldades para executar esta etapa, não repasse nenhuma informação relacionado aos acessos dos tokens.
 
 
Dados necessários em mãos para informar os respectivos campos (basta copiar e colar as informações):
 
• '''Client ID:''' Identificação da Aplicação, é necessário informar a codificação passada pelo Banco. Este dado é criptografado.
 
• '''Client Secret:''' Credencial do banco, é necessário informar a codificação passada pelo Banco. Este dado é criptografado.
 
• '''Token Basic'''
 
 
<center>'''Parâmetros: Passo 1 de 4'''
[[Arquivo:Parametros de Convenio Open Banking SICOOB 2.png|750x500px|centro]]
</center>
 

'''Sobre os campos'''
 
Client ID, Client Secret e Token Basic possuem uma tecnologia de criptografia, ou seja, após informar os dados nos campos o sistema irá criptografar as informações garantindo e mantendo a segurança dos mesmos. Se houver necessidade de alterações, basta clicar no ícone do "Cadeado" [[Arquivo:Icone Cadeado.png]] que será aberta a tela de Criptografia e colar ou digitar as informações em tela e selecionar o botão "Confirmar".
 
Caso tenha alguma dúvida no dado informado e necessidade de valida-lo, basta seguir os mesmos passos da alteração, clicando no ícone do Cadeado para abrir a tela de Criptografia, colar ou digitar as informações em tela e selecionar o botão "Validar" que o sistema confirmará se os dados são os mesmos.
 
 
<center>'''Botão Validar'''</center>
[[Arquivo:Botao Validar SICOOB.png|650x400px|centro]]
 
 

'''Considerações'''
 
Observamos que esta tela possui duas guias, uma de Homologação e Produção, nas quais preenchemos conforme a necessidade do processo, caso precise realizar testes, parametrize em homologação e posteriormente parametrize o de Produção, ou se preferir, pode preencher os dois se possuir os dados.
 
 
<center>'''Guias Homologação e Produção'''</center>
[[Arquivo:Guias Homologacao e Producao.png|750x500px|centro]]

'''Importante:''' Esses dados são confidenciais de uso e exclusivo de cada usuário. Através dessas informações o sistema irá se comunicar com API do Banco para poder realizar os registros dos Lançamentos.
Após informado os dados, basta selecionar o botão "Avançar" para seguir os próximos passos.


=='''Etapa 2 (Portador de Remessa e Retorno - Pagamento: Passo 2 de 4):'''==

Nesta etapa seleciona-se o Portador que será considerado para o envio da Remessa de Pagamento (onde estarão os boletos em aberto) e informa qual Portador será considerado para o Retorno de Pagamento (onde serão liquidados os retornos de Pagamentos).
 
Caso ainda não utilize o Envio de Pagamentos do Open Banking é possível apenas pular esta parte da parametrização.
 
• '''Pular:''' caso deseja pular essa etapa e prosseguir com o processo de parametrização do Open Banking.
 
• '''Avançar:''' dá continuidade ao processo de parametrização, após selecionado uma opção.
 
Neste exemplo não utilizamos o Envio de Pagamentos do Open Banking, então é selecionado o botão "Pular" para seguir os próximos passos.
 
<center>'''Portador de Remessa e Retorno: Passo: 2 de 4'''</center>
[[Arquivo:Portador de Remessa e Retorno SICOOB.png|750x500px|centro]]
 

=='''Etapa 3 (Convênios de Cobrança: Passo 3 de 4):'''==

Nesta etapa o sistema avalia sua base de dados, e localiza os Convênios parametrizados para o Banco SICOOB, onde serão listados.
O sistema possibilita a parametrização de Convênios específicos bem como caso seja optado, selecionando o botão "Pular" o sistema criará automaticamente o Convênio "Geral", ao qual utiliza dados do Portador registrado.
 
• '''Pular:''' caso deseja pular essa etapa e prosseguir com o processo de parametrização do Open Banking.
 
• '''Avançar:''' dá continuidade ao processo de parametrização, após selecionado uma opção.
 
 
<center>'''Convênios de Cobrança: Passo 3 de 4'''</center>
[[Arquivo:Convenio de Cobranca SICOOB.png|750x500px|centro]]
 

=='''Etapa 3 (Portador de Remessa e Retorno - Cobrança: Passo 3 de 4):'''==

Nesta etapa deve ser selecionado o Portador que será considerado para o envio da Remessa de Cobrança (onde estarão os boletos em aberto) e nesta mesma tela informar o Portador que será considerado para o Retorno de Cobrança (onde serão liquidados os retornos de Cobranças).
 
'''Avançar:''' dá continuidade ao processo de parametrização após selecionado uma opção.
 
 
<center>'''Portador de Remessa e Retorno - Cobrança: Passo 3 de 4'''</center>
[[Arquivo:Portador de Remessa e Retorno SICOOB Passo 3.png|750x500px|centro]]

• '''Direto''': Esta opção tem como finalidade registrar o Boleto no momento da sua geração, ou seja, quando selecionado ativa propriedade ao qual ao gerar o Boleto Bancário o sistema automaticamente envia o registro Open Banking, sem a necessidade de fazer o processo de envio da Remessa Open Banking do título.
 
• '''PIX''': Esta opção é válida '''SOMENTE''' para o Banco do Brasil.


=='''Etapa 4 (Relatório: Passo 4 de 4):'''==

Nesta etapa o sistema irá buscar automaticamente o Modelo de Relatório Padrão, caso exista no ambiente, facilitando assim todo processo de parametrização e implementação para usuário.
 
A busca é realizado '''(%CIGAM_INSTAL%RF00071_remessas.RTF)''', com isso é importante que o Modelo de Relatório (RF00071_remessas.RTF) esteja devidamente localizado na pasta padrão do Cigam_Instal, como por exemplo:
 
'''%CIGAM_INSTAL%''' = P:\Cigam11\Projects\Controle\MACIEL\Financeiro_Open_Banking
 
"P:\Cigam11\Projects\Controle\MACIEL\Financeiro_Open_Banking\Modelos\Relatorios\GestaoFinanceira\RF00071_remessas.RTF"
 
Clicar em "Avançar" para dar seguimento.
 
 
<center>'''Assistente de Parâmetros Open Banking: Passo 4 de 4'''
[[Arquivo:Assistente Passo 4.png|750x500px|semmoldura|nenhum|Assistente_Passo_4]]
 
 

=='''Etapa Conclusão (Parâmetros de Convênio Open Banking - Conclusão):'''==

Nesta etapa o sistema faz a validação e aprovação da comunicação com o Banco através da API. Para isso, devemos seguir os seguintes passos apresentados na tela:
 
 
'''1-''' Copie a URL e cole em seu navegador;
[[Arquivo:Copiar a URL para Aprovacao SICOOB.png|750x500px|centro]]
 

'''2-''' Complete as Informações de Autorização;
[[Arquivo:Dados para Aprovacao Validacao.png|750x500px|centro]]
 

'''3-''' Aprove os Escopos na parte inferior da tela;
[[Arquivo:Aprovar Escopos.png|750x500px|centro]]
 

'''4-''' Na barra de endereço do seu navegador, copie o código informado após o trecho "code=" que compõe a URL e cole no campo "Code" da tela Obter Access Token dentro do prazo de validade de cinco minutos;
 
 
<center>'''Copie o Código após o "code="'''</center>
[[Arquivo:Copiar codigo.png|750x500px|centro]]
 
<center>'''Cole no campo "Code"'''</center>
[[Arquivo:Colar Code.png|750x500px|centro]]
 

'''5-''' Clique em confirmar para que o Access Token seja obtido automaticamente e a validação do ambiente de Homologação ocorra.
 
 
Após a aprovação e validação, basta clicar no botão "Concluir" e seu ambiente estará apto para utilizar a funcionalidade Open Banking.
 
<center>'''Parâmetros de Convênio Open Banking: Passo Final - Conclusão'''</center>
[[Arquivo:Conclusao Open Banking SICOOB.png|750x500px|centro]]
 
<center>'''Convênio Cadastrado com Sucesso - Cobrança'''
[[Arquivo:Convenio Cadastrado com Sucesso SICOOB.png|750x500px|centro]]
 
'''Considerações'''
 
'''Ambiente:''' lista qual é o ambiente cadastrado, sendo apenas duas opções: Homologação e Produção.
 
'''Convênios:''' neste grupo serão listados todos os convênios cadastrados, bem como todas informações pertinentes como:
 
• Portador;
 
• Agência;
 
• Número Conta;
 
• Portador de retorno.
 
 
'''Opções dos Portadores na Tela de Parâmetros Open Banking'''
 
[[Arquivo:Opcoes Portadores.png|750x500px|centro]]

•'''Direto:''' Esta opção tem como finalidade registrar o Boleto no momento da sua geração, ou seja, quando selecionado ativa propriedade ao qual ao gerar o Boleto Bancário o sistema automaticamente envia o registro Open Banking, sem a necessidade de fazer o processo de envio da Remessa Open Banking do título.
 
Também quando selecionada, terá uma particularidade na questão da Emissão de Boletos em lote pela Rotina de Emissão de Boletos Personalizados. A rotina na guia '''Opções''' tem a opção '''Enviar somente Lançamentos não marcados e marca-los''', caso esteja desmarcada o Registro Open Banking ocorrerá da mesma forma que o sistema irá marcar a opção '''Boleto Impresso''' do Lançamento Financeiro, registrando a Operação Open Banking.
 
 
<center>'''Opções da Rotina Emissão de Boletos Personalizados'''</center>
[[Arquivo:Emissao de Boletos SICOOB.png|750x500px|centro]]

Isso ocorre para manter a integridade, já que esta operação é considerada única no registro, sendo então necessário marcar a '''Boleto Impresso''', para poder conseguir realizar alterações como Alteração de Vencimento ou mesmo a Baixa, sendo uma condição de Sistema.
 
 
•'''PIX:''' Esta opção é válida '''SOMENTE''' para o Banco do Brasil.
 
 
'''Emissão de Boleto'''
 
Ao emitir o Boleto do Lançamento o sistema marca as 3 opções:
 
• Boleto Impresso;
 
• Remessa Enviada;
 
• Código de Barras Lido;
 
 
'''U.N Ced.:''' esta opção tem como finalidade possibilitar o envio e registro de Boletos de outras Unidades de Negócio.
 
Basta informar a Unidade desejada no campo e o sistema entenderá quando realizado o processo de registro de um título que não seja da Unidade Matriz, então sistema identifica e realiza o processo de envio e registro.
Se deixar em Branco a Unidade Cedente irá considerar para todas Unidades de Negócio.
 
 
'''Ícones'''
 
<center>'''Ícone Credenciais'''
[[Arquivo:Icone Credenciais.png|750x500px|centro]]
 
Através deste ícone é possível verificar os Parâmetros API parametrizados, tanto em homologação quanto em produção.
 
 
<center>'''Ícone Endereços'''
[[Arquivo:Icone Enderecos 2.png|750x500px|centro]]
 
Através deste ícone é possível verificar todos endereços de URLs parametrizados.

='''O que significa a Categoria Open Banking de acesso?'''=
 A Categoria Open Banking é uma Categoria que é habilitada mediante a utilização de um Portador parametrizado com as Configurações de Banco Open Banking. A mesma tem como objetivo proporcionar maior agilidade e gerenciamento das atividades relacionadas a Remessa de Cobrança Online.
 
 
<center>'''Categoria Open Banking'''
[[Arquivo:Categoria Open Banking SICOOB.png|750x500px|centro]]
 

•'''Registrar:''' item de categoria tem como funcionalidade registrar o Boleto Bancário Online. Substitui todo o processo de geração do arquivo de Remessa de Cobrança, acessar o site e remeter ao Banco esse arquivo, com apenas um clique na opção.
 
•'''Reenviar:''' item de categoria tem como funcionalidade possibilitar o reenvio de registros que estão com alguma pendência ou algum erro de parametrização. Será habilitado somente quando já possuir movimento de "Registro" enviado, cuja Situação estiver com pendência ou erro.
 
•'''Baixar:''' item de categoria tem como funcionalidade comunicar o Banco referente a Baixa do movimento em questão do Boleto Bancário. Utilizado para eventuais falhas operacionais, como registrado um movimento por engano, ou negociações diretamente com cliente a parte. Eliminando então também todo processo de geração do arquivo de Remessa Bancária com Comando de Remessa de Baixa e o processo de remeter ao Banco o arquivo, sendo realizado tudo online através desta opção.
 
•'''Registrar Alteração:''' item de categoria tem como funcionalidade registrar uma alteração ocorrida referente ao "Vencimento" do Lançamento Financeiro.
Ao realizar alteração da Data de Vencimento do Lançamento Financeiro que está com "Situação Open Banking" igual "Registrado" e ocorrer alteração no Vencimento, o sistema emite uma mensagem possibilitando já o envio da alteração no momento ou mais tarde através desta opção de "Registrar Alteração".
 
•'''Histórico:''' item de categoria tem como funcionalidade gravar todas movimentações realizadas relativo ao Open Banking (Registros, Baixas, Erros)


='''Layout e Detalhamento de Campos API'''=
==Registro de Boletos==
<center>

{| class="wikitable"
|-
! Nº !! Campo JSON !! Descriçao do Banco !! Campo CIGAM !! Tabela !! Obrigatório !! Observações
|-
| 1 || numeroContrato || Número que identifica o contrato do beneficiário. || Número Controle || GFPORTAD || Opcional ||
|-
| 2 || modalidade || Número que identifica a modalidade do boleto.
'''Domínios:'''
 
1 SIMPLES COM REGISTRO
 
5 CARNÊ DE PAGAMENTOS
 
6 INDEXADA
 
14 CARTÃO DE CRÉDITO
|| Não Tratado || Não Tratado || Opcional ||
|-
| 3 || numeroContaCorrente || Número da Conta Corrente para crédito do boleto. || Conta Número || GFPORTAD || Opcional ||
|-
| 4 || especieDocumento || Espécie do documento. [[#Domínios: especieDocumento|Clique aqui]] para acessar os domínios || Não Tratado || Não Tratado || Opcional ||
|-
| 5 || dataEmissao || Data de emissão do boleto. || Data || LANCAM || Opcional ||
|-
| 6 || nossoNumero || Número que identifica o boleto. || Número Controle || GFPORTAD || Opcional ||
|-
| 7 || seuNumero || Informar o número que identifica o boleto no sistema do beneficiário. || Lançamento || LANCAM || Opcional || Tamanho máximo 18
|-
| 8 || identificacaoBoletoEmpresa || Destinado para uso da Empresa Cedente para identificação do Boleto || Série || LANCAM || Opcional ||
|-
| 9 || identificacaoEmissaoBoleto || Identificação de Emissão do Boleto.
'''Domínio:'''
 
1 - Banco Emite
 
2 - Cliente Emite
|| Série || LANCAM || Opcional ||
|-
| 10 || identificacaoDistribuicaoBoleto || Identificação de Distribuição do Boleto.
'''Domínios:'''
 
1 - Banco Distribui
 
2 - Cliente Distribui
|| Não Tratado || Não Tratado || Opcional ||
|-
| 11 || valor || Valor nominal do boleto. || Saldo || LANCAM || Opcional ||
|-
| 12 || dataVencimento || Data de vencimento do boleto. || Vencimento || LANCAM || Opcional ||
|-
| 13 || dataLimitePagamento || Data de limite para pagamento do boleto. || Não Tratado || Não Tratado || Opcional ||
|-
| 14 || valorAbatimento || Valor do abatimento. || Não Tratado || Não Tratado || Opcional ||
|-
| 15 || tipoDesconto || Informar o tipo de desconto atribuido ao boleto. [[#Domínios - tipoDesconto|Clique aqui]] para acessar os domínios || Valor Desconto || LANCAM || Opcional ||
|-
| 16 || dataPrimeiroDesconto || Data do primeiro desconto. || Não Tratado || Não Tratado || Opcional ||
|-
| 17 || valorPrimeiroDesconto || Valor do primeiro desconto. || Valor Desconto || LANCAM || Opcional || Deve ser informado caso a data do primeiro desconto seja preenchida.
|-
| 18 || dataSegundoDesconto || Data do segundo desconto. || Não Tratado || Não Tratado || Opcional ||
|-
| 19 || valorSegundoDesconto || Valor do segundo desconto. || Não Tratado || Não Tratado || Opcional || Deve ser informado caso a data do segundo desconto seja preenchida.
|-
| 20 || dataTerceiroDesconto || Data do terceiro desconto. || Não Tratado || Não Tratado || Opcional ||
|-
| 21 || valorTerceiroDesconto || Valor do terceiro desconto. || Não Tratado || Não Tratado || Opcional || Deve ser preenchido caso a data do terceiro desconto seja preenchida.
|-
| 22 || tipoMulta || Tipo de multa a ser aplicado no boleto. Informar os valores listados abaixo.
'''Domínios:'''
 
0 - Isento
 
1 - Valor Fixo
 
2 - Percentual
|| Valor Multa || LANCAM || Opcional ||
|-
| 23 || dataMulta || Deve ser maior que a data de vencimento do boleto e menor ou igual que data limite de pagamento. || Vencimento || LANCAM || Opcional ||
|-
| 24 || valorMulta || Valor da multa. || Valor Multa || LANCAM || Opcional || Deve ser preenchido caso o campo dataMulta seja preenchido.
|-
| 25 || tipoJurosMora || Tipo de juros de mora. Informar os valores listados abaixo.
'''Domínios:'''
 
2 - Taxa Mensal
 
3 - Isento
|| Não Tratado || Não Tratado || Opcional ||
|-
| 26 || dataJurosMora || Deve ser maior que a data de vencimento do boleto e menor ou igual que data limite de pagamento. || Não Tratado || Não Tratado || Opcional ||
|-
| 27 || valorJurosMora || Valor do juros de mora. || Não Tratado || Não Tratado || Opcional || Deve ser preenchido caso o campo dataJurosMora seja preenchido.
|-
| 28 || numeroParcela || Número da parcela do boleto.Valor máximo permitido '99'. || Não Tratado || Não Tratado || Opcional ||
|-
| 29 || aceite || Identificador do aceite do boleto || Não Tratado || Não Tratado || Opcional ||
|-
| 30 || codigoNegativacao || Código de negativação do boleto. Informar os valores abaixo.
'''Domínios:'''
 
2 - Negativar Dias Úteis
 
3 - Não Negativar
|| Não Tratado || Não Tratado || Opcional ||
|-
| 31 || numeroDiasNegativacao || Número de dias para negativação do boleto. || Não Tratado || Não Tratado || Opcional || Deve ser preenchido caso o campo codigoNegativacao seja igual a '2'.
|-
| 32 || codigoProtesto || Código de protesto do boleto. Informar os valores abaixo.
'''Domínios:'''
 
1 - Protestar Dias Corridos
 
2 - Protestar Dias Úteis
 
3 - Não Protestar
|| Não Tratado || Não Tratado || Opcional ||
|-
| 33 || numeroDiasProtesto || Número de dias para protesto do boleto. || Não Tratado || Não Tratado || Opcional || Deve ser preenchido caso o campo codigoProtesto seja '1'.
|-
| 34 || gerarPdf || Identificador para o sistema devolver ou não o PDF do Boleto. O PDF será retornado na Base64. || Não Tratado || Não Tratado || Opcional ||
|-
| 35 || pagador || || || || Opcional ||
|-
| 35.1 || numeroCpfCnpj || CPF ou CNPJ do pagador do boleto de cobrança. || Não Tratado || Não Tratado || Obrigatório || Tamanho máximo 14
|-
| 35.2 || nome || Nome completo do pagador do boleto de cobrança. || Não Tratado || Não Tratado || Obrigatório || Tamanho máximo 50
|-
| 35.3 || endereco || Endereço do pagador do boleto de cobrança. || Não Tratado || Não Tratado || Obrigatório || Tamanho máximo 40
|-
| 35.4 || bairro || Bairro do pagador do boleto de cobrança. || Não Tratado || Não Tratado || Obrigatório || Tamanho máximo 30
|-
| 35.5 || cidade || Cidade do pagador do boleto de cobrança. || Não Tratado || Não Tratado || Obrigatório || Tamanho máximo 40
|-
| 35.6 || cep || CEP do pagador. || Não Tratado || Não Tratado || Obrigatório || Tamanho máximo 8
|-
| 35.7 || uf || UF do pagador. || Não Tratado || Não Tratado || Obrigatório || Tamanho máximo 2
|-
| 35.8 || email || || Não Tratado || Não Tratado || Opcional ||
|-
| 36 || beneficiarioFinal || || Não Tratado || Não Tratado || Opcional ||
|-
| 36.1 || numeroCpfCnpj || || Não Tratado || Não Tratado || ||
|-
| 36.2 || nome || || Não Tratado || Não Tratado || ||
|-
| 37 || mensagensInstrucao || || Não Tratado || Não Tratado || Opcional ||
|-
| 37.1 || tipoInstrucao || Código adotado pela FEBRABAN para identificação do tipo de impressão da mensagem do boleto de cobrança.- 3 - Corpo de Instruções da Ficha de Compensação do Bloqueto. || Não Tratado || Não TratadoNão Tratado || Opcional ||
|-
| 37.2 || mensagens || || Não Tratado || Não Tratado || Opcional ||
|-
| 38 || rateioCreditos || || Não Tratado || Não Tratado || Opcional ||
|-
| 38.1 || numeroBanco || Número do Banco de Destino || Não Tratado || Não Tratado || Obrigatório ||
|-
| 38.2 || numeroAgencia || Número da Agência de Destino || Não Tratado || Não Tratado || Obrigatório ||
|-
| 38.3 || numeroContaCorrente || Número da Conta Corrente Destino. || Conta Numero || GFPORTAD || Obrigatório ||
|-
| 38.4 || contaPrincipal || Identificador de conta principal. || Não Tratado || Não Tratado || Obrigatório ||
|-
| 38.5 || codigoTipoValorRateio || Tipo de valor do Rateio.
'''Domínios:'''
 
1 - Percentual
 
2 - Valor ou Quantidade
|| Não Tratado || Não Tratado || Obrigatório ||
|-
| 38.6 || valorRateio || Valor do rateio. || Não Tratado || Não Tratado || Obrigatório ||
|-
| 38.7 || codigoTipoCalculoRateio || Tipo de cálculo do Rateio.
'''Domínios:'''
1 - Valor Cobrado
2 - Valor Registro
3 - Rateio pelo menor valor
|| Não Tratado || Não Tratado || Obrigatório ||
|-
| 38.8 || numeroCpfCnpjTitular || CPF ou CNPJ do titular da conta. || Não Tratado || Não Tratado || Obrigatório || Tamanho máximo 14
|-
| 38.9 || nomeTitular || Nome completo do titular da conta. || Não Tratado || Não Tratado || Obrigatório || Tamanho máximo 50
|-
| 38.10 || codigoFinalidadeTed || Código da Finalidade TED. [[#Domínios: codigoFinalidadeTed|Clique aqui]] para visualizar os Domínios. || Não Tratado || Não Tratado || Obrigatório ||
|-
| 38.11 || codigoTipoContaDestinoTed || Tipo de conta Finalidade TED.
'''Domínios:'''
 
CC - Conta Corrente
 
CD - Conta de Depósito
 
CG - Conta garantida
|| Não Tratado || Não Tratado || Obrigatório || Tamanho máximo 2
|-
| 38.12 || quantidadeDiasFloat || Quantidade de dias float || Não Tratado || Não Tratado || Obrigatório || Não informar junto com dataFloatCredito
|-
| 38.13 || dataFloatCredito || Data do float || Não Tratado || Não Tratado || Opcional || Não informar junto com quantidadeDiasFloat
|-
|}

</center>
 
==='''Domínios: especieDocumento'''===

• CH - Cheque
 
• DM - Duplicata Mercantil
 
• DMI - Duplicata Mercantil Indicação
 
• DS - Duplicata de Serviço
 
• DSI - Duplicata Serviço Indicação
 
• DR - Duplicata Rural
 
• LC - Letra de Câmbio
 
• NCC - Nota de Crédito Comercial
 
• NCE - Nota de Crédito Exportação
 
• NCI - Nota de Crédito Industrial
 
• NCR - Nota de Crédito Rural
 
• NP - Nota Promissória
 
• NPR - Nota Promissória Rural
 
• TM - Triplicata Mercantil
 
• TS - Triplicata de Serviço
 
• NS - Nota de Seguro
 
• RC - Recibo
 
• FAT - Fatura
 
• ND - Nota de Débito
 
• AP - Apólice de Seguro
 
• ME - Mensalidade Escolar
 
• PC - Pagamento de Consórcio
 
• NF - Nota Fiscal
 
• DD - Documento de Dívida
 
• CC - Cartão de Crédito
 
• BDP - Boleto Proposta
 
• OU - Outros
 

==='''Domínios: tipoDesconto'''===

• 0 - Sem Desconto
 
• 1 - Valor Fixo Até a Data Informada
 
• 2 - Percentual até a data informada
 
• 3 - Valor por antecipação dia corrido
 
• 4 - Valor por antecipação dia útil
 
• 5 - Percentual por antecipação dia corrido
 
• 6 - Percentual por antecipação dia útil

==='''Domínios: codigoFinalidadeTed'''===

• 1 - Pagamento de Impostos, Tributos e Taxas
 
• 2 - Pagamento à Concessionárias de Serviço Público
 
• 3 - Pagamentos de Dividendos
 
• 4 - Pagamento de Salários
 
• 5 - Pagamento de Fornecedores
 
• 6 - Pagamento de Honorários
 
• 7 - Pagamento de Aluguéis e Taxas de Condomínio
 
• 8 - Pagamento de Duplicatas e Títulos
 
• 9 - Pagamento de Mensalidade Escolar
 
• 10 - Crédito em Conta
 
• 99999 - Outros

==Retorno de Boletos==
<center>

{| class="wikitable"
|-
! Nº !! Campo JSON !! Descriçao do Banco !! Campo CIGAM !! Tabela !! Obrigatório !! Observações
|-
| 1 || '''resultado'''
|-
| 2 || numeroContrato || Número que identifica o contrato do beneficiário. || Número Controle || GFPORTAD || Opcional ||
|-
| 3 || modalidade || Número que identifica a modalidade do boleto. [[#Domínios: modalidade|Clique aqui]] para visualizar os Domínios || Não Tratado || Não Tratado || Opcional ||
|-
| 4 || numeroContaCorrente || Número da Conta Corrente para crédito do boleto. || Conta Número || GFPORTAD || Opcional ||
|-
| 5 || especieDocumento || Espécie do documento. [[#Domínios: especieDocumento|Clique aqui]] para visualizar os Domínios. || Não Tratado || Não Tratado || Opcional ||
|-
| 6 || dataEmissao || Data de emissão do boleto || Data || LANCAM || Opcional ||
|-
| 7 || nossoNumero || Número que identifica o boleto. || Número Controle || GFPORTAD || Opcional ||
|-
| 8 || seuNumero || Informar o número que identifica o boleto no sistema do beneficiário. || Lancamento || LANCAM || Opcional || Tamanho máximo 18
|-
| 9 || identificacaoBoletoEmpresa || Destinado para uso da Empresa Cedente para identificação do Boleto. || Serie || LANCAM || Opcional ||
|-
| 10 || codigoBarras || Número de código de barras do boleto com 44 posições. || Não Tratado || Não Tratado || Opcional ||
|-
| 11 || linhaDigitavel || Número da linha digitável do boleto com 47 posições. || Não Tratado || Não Tratado || Opcional ||
|-
| 12 || valor || Valor nominal do boleto. || Saldo || LANCAM || Opcional ||
|-
| 13 || dataVencimento || Data de vencimento do boleto. || Vencimento || LANCAM || Opcional ||
|-
| 14 || valorAbatimento || Valor do abatimento. || Não Tratado || Não Tratado || Opcional ||
|-
| 15 || tipoDesconto || Informar o tipo de desconto a ser aplicado no boleto. || Valor Desconto || LANCAM || Opcional ||
|-
| 16 || dataPrimeiroDesconto || Data do primeiro desconto. || Vencimento || LANCAM || Opcional ||
|-
| 17 || valorPrimeiroDesconto || Valor do primeiro desconto || Valor Desconto || LANCAM || Opcional ||
|-
| 18 || dataSegundoDesconto || Data do segundo desconto || Não Tratado || Não Tratado || Opcional ||
|-
| 19 || valorSegundoDesconto || Valor do segundo desconto. || Não Tratado || Não Tratado || Opcional ||
|-
| 20 || dataTerceiroDesconto || Data do terceiro desconto. || Não Tratado || Não Tratado || Opcional ||
|-
| 21 || valorTerceiroDesconto || Valor do terceiro desconto. || Não Tratado || Não Tratado || Opcional ||
|-
| 22 || tipoMulta || Tipo de Multa.
'''Domínio:'''
 
0 - Isento
 
1 - Valor Fixo
 
2 - Percentual
|| Valor Multa || LANCAM || Opcional ||
|-
| 23 || dataMulta || Deve ser maior que a data de vencimento do boleto e menor ou igual que data limite de pagamento. || Tolerâcia Multa || LANCAM || Opcional ||
|-
| 24 || valorMulta || Valor da multa. || Valor Multa || LANCAM || Opcional ||
|-
| 25 || tipoJurosMora || Tipo de Juros de Mora.
'''Domínios:'''
 
2 - Taxa Mensal
 
3 - Isento
|| Não Tratado || Não Tratado || Opcional ||
|-
| 26 || dataJurosMora || Deve ser maior que a data de vencimento do boleto e menor ou igual que data limite de pagamento. || Não Tratado || Não Tratado || Opcional ||
|-
| 27 || valorJurosMora || Valor do Juros de Mora. || Não Tratado || Não Tratado || Opcional ||
|-
| 28 || numeroParcela || Número da parcela. || Não Tratado || Não Tratado || Opcional ||
|-
| 29 || aceite || Identificador do aceite do boleto. || Não Tratado || Não Tratado || Opcional ||
|-
| 30 || codigoNegativacao || Código de Negativação do Boleto
'''Domínios:'''
 
2 - Negativar Dias Úteis
 
3 - Não Negativar
|| Não Tratado || Não Tratado || Opcional ||
|-
| 31 || codigoProtesto || Código de Protesto do Boleto
'''Domínios:'''
1 - Protestar Dias Corridos
 
2 - Protestar Dias Úteis
 
3 - Não Protestar
|| Não Tratado || Não Tratado || Opcional ||
|-
| 32 || quantidadeDiasFloat || Quantidade de Dias de Float. || Não Tratado || Não Tratado || Opcional ||
|-
| 33 || situacaoBoleto || Descreve a Situação atual do Boleto. || Não Tratado || Não Tratado || Opcional ||
|-
| 34 || pagador || || || || Opcional ||
|-
| 34.1 || numeroCpfCnpj || CPF ou CNPJ do pagador. || Não Tratado || Não Tratado || Opcional || Tamanho máximo 14
|-
| 34.2 || nome || Nome completo do pagador. || Não Tratado || Não Tratado || Opcional || Tamanho máximo 50
|-
| 35 || beneficiarioFinal || || Não Tratado || Não Tratado || Opcional ||
|-
| 35.1 || nome || Nome do Beneficário Final. Antigo Sacador Avalista. || Não Tratado || Não Tratado || Opcional || Tamanho máximo 50
|-
| 36 || mensagensInstrucao || || Não Tratado || Não Tratado || Opcional ||
|-
| 36.1 || mensagens || || Não Tratado || Não Tratado || Opcional ||
|-
|}

</center>
 

==='''Domínios: modalidade'''===

• 1 - SIMPLES COM REGISTRO
 
• 5 - CARNÊ DE PAGAMENTOS
 
• 6 - INDEXADA
 
• 14 - CARTÃO DE CRÉDITO
 

==='''Domínios: especieDocumento'''===

• CH - Cheque
 
• DM - Duplicata Mercantil
 
• DMI - Duplicata Mercantil Indicação
 
• DS - Duplicata de Serviço
 
• DSI - Duplicata Serviço Indicação
 
• DR - Duplicata Rural
 
• LC - Letra de Câmbio
 
• NCC - Nota de Crédito Comercial
 
• NCE - Nota de Crédito Exportação
 
• NCI - Nota de Crédito Industrial
 
• NCR - Nota de Crédito Rural
 
• NP - Nota Promissória
 
• NPR - Nota Promissória Rural
 
• TM - Triplicata Mercantil
 
• TS - Triplicata de Serviço
 
• NS - Nota de Seguro
 
• RC - Recibo
 
• FAT - Fatura
 
• ND - Nota de Débito
 
• AP - Apólice de Seguro
 
• ME - Mensalidade Escolar
 
• PC - Pagamento de Consórcio
 
• NF - Nota Fiscal
 
• DD - Documento de Dívida
 
• CC - Cartão de Crédito
 
• BDP - Boleto Proposta
 
• OU - Outros
 

==Alteração de Boletos==
<center>

{| class="wikitable"
|-
! Nº !! Campo JSON !! Descriçao do Banco !! Campo CIGAM !! Tabela !! Obrigatório !! Observações
|-
| 1 || '''Desconto'''
|-
| 1.1 || numeroContrato || Número que identifica o contrato do beneficiário. || Número Controle || GFPORTAD || Obrigatório ||
|-
| 1.2 || modalidade || Número que identifica a modalidade do boleto. [[#Domínios: modalidade|Clique aqui]] para visualizar os Domínios. || Não Tratado || Não Tratado || Obrigatório ||
|-
| 1.3 || nossoNumero || Número identificador do boleto. || Número Controle || GFPORTAD || Obrigatório ||
|-
| 1.4 || tipoDesconto || Informar o tipo de desconto atribuido ao boleto. [[#Domínios: tipoDesconto|Clique aqui]] para visualizar os Domínios. || Valor Desconto || LANCAM || Opcional ||
|-
| 1.5 || dataPrimeiroDesconto || Data do primeiro desconto. || Valor Desconto || LANCAM || Opcional ||
|-
| 1.6 || valorPrimeiroDesconto || Valor do primeiro desconto. || Valor Desconto || LANCAM || Opcional ||
|-
| 1.7 || dataSegundoDesconto || Data do segundo desconto. || Não Tratado || Não Tratado || Opcional ||
|-
| 1.8 || valorSegundoDesconto || Valor do segundo desconto. || Não Tratado || Não Tratado || Opcional ||
|-
| 1.9 || dataTerceiroDesconto || Data do terceiro desconto. || Não Tratado || Não Tratado || Opcional ||
|-
| 1.10 || valorTerceiroDesconto || Valor do terceiro desconto. || Não Tratado || Não Tratado || Opcional ||
|-
| 2 || '''Abatimento'''
|-
| 2.1 || numeroContrato || Número que identifica o contrato do beneficiáriono Sisbr. || Número Controle || GFPORTAD || Opcional ||
|-
| 2.2 || modalidade || Número que identifica a modalidade do boleto. [[#Domínios: modalidade|Clique aqui]] para visualizar os Domínios. || Não Tratado || Não Tratado || ||
|-
| 2.3 || nossoNumero || Número identificador do boleto no Sisbr. || Número Controle || GFPORTAD || ||
|-
| 2.4 || valorAbatimento || Valor do abatimento. || Não Tratado || Não Tratado || ||
|-
| 3 || '''EncargoMulta'''
|-
| 3.1 || numeroContrato || Número que identifica o contrato do beneficiário. || Número Controle || GFPORTAD || ||
|-
| 3.2 || modalidade || Número que identifica a modalidade do boleto. [[#Domínios: modalidade|Clique aqui]] para visualizar os Domínios. || Não Tratado || Não Tratado || ||
|-
| 3.3 || nossoNumero || Número identificador o boleto. || Número Controle || GFPORTAD || ||
|-
| 3.4 || tipoMulta || Tipo de Multa.
'''Domínios'''
 
0 - Isento
 
1 - Valor Fixo
 
2 - Percentual
|| Valor Multa || LANCAM || ||
|-
| 3.5 || dataMulta || Deve ser maior que a data de vencimento do boleto e menor ou igual que data limite de pagamento. || Tolerância Multa || LANCAM || Opcional ||
|-
| 3.6 || valorMulta || Valor da multa. || Valor Multa || LANCAM || Opcional ||
|-
| 4 || '''EncargoJuros'''
|-
| 4.1 || numeroContrato || Número que identifica o contrato do beneficiário. || Número Controle || GFPORTAD || ||
|-
| 4.2 || modalidade || Número que identifica a modalidade do boleto. [[#Domínios: modalidade|Clique aqui]] para visualizar os Domínios. || Não Tratado || Não Tratado ||
|-
| 4.3 || nossoNumero || Número identificador o boleto. || Número Controle || GFPORTAD || ||
|-
| 4.4 || tipoJurosMora || Tipo de Juros de Mora.
'''Domínios:'''
 
2 - Taxa Mensal
 
3 - Isento
|| Não Tratado || Não Tratado || ||
|-
| 4.5 || dataJurosMora || Deve ser maior que a data de vencimento do boleto e menor ou igual que data limite de pagamento. || Não Tratado || Não Tratado || Opcional ||
|-
| 4.6 || valorJurosMora || Valor do Juros de Mora. || Não Tratado || Não Tratado || Opcional ||
|-
| 5 || '''ValorNominal'''
|-
| 5.1 || numeroContrato || Número que identifica o contrato do beneficiário no Sisbr. || Número Controle || GFPORTAD || ||
|-
| 5.2 || modalidade || Número que identifica a modalidade do boleto. [[#Domínios: modalidade|Clique aqui]] para visualizar os Domínios. || Não Tratado || Não Tratado ||
|-
| 5.3 || nossoNumero || Número identificador o boleto no Sisbr. || Número Controle || GFPORTAD || ||
|-
| 5.4 || valor || Valor do boleto. || Saldo || LANCAM || ||
|-
| 6 || SeuNumero
|-
| 6.1 || numeroContrato || Número que identifica o contrato do beneficiário no Sisbr. || Número Controle || GFPORTAD || ||
|-
| 6.2 || modalidade || Número que identifica a modalidade do boleto. [[#Domínios: modalidade|Clique aqui]] para visualizar os Domínios. || Não Tratado || Não Tratado ||
|-
| 6.3 || nossoNumero || Número que identifica o boleto no Sisbr. || Número Controle || GFPORTAD ||
|-
| 6.4 || seuNumero || Número identificador do boleto determinado pelo beneficiário. || Não Tratado || Não Tratado || Opcional || Tamanho máximo 18
|-
| 6.5 || identificacaoBoletoEmpresa || Número de controle do boleto determinado pelo beneficiário. || Serie || LANCAM || Opcional ||
|-
| 7 || EspecieDocumento
|-
| 7.1 || numeroContrato || Número que identifica o contrato do beneficiário no Sisbr. || Número Controle || GFPORTAD || ||
|-
| 7.2 || modalidade || Número que identifica a modalidade do boleto. [[#Domínios: modalidade|Clique aqui]] para visualizar os Domínios. || Não Tratado || Não Tratado ||
|-
| 7.3 || nossoNumero || Número que identifica o boleto de cobrança no Sisbr. || Número Controle || GFPORTAD || ||
|-
| 7.4 || especieDocumento || Espécie do Documento. [[#Domínios: especieDocumento|Clique aqui]] para visualizar os Domínios || Não Tratado || Não Tratado || ||
|-
|}

</center>

==='''Domínios: modalidade'''===

• 1 - SIMPLES COM REGISTRO
 
• 5 - CARNÊ DE PAGAMENTOS
 
• 6 - INDEXADA
 
• 14 - CARTÃO DE CRÉDITO
 

==='''Domínios: tipoDesconto'''===

• 0 - Sem Desconto
 
• 1 - Valor Fixo Até a Data Informada
 
• 2 - Percentual até a data informada
 
• 3 - Valor por antecipação dia corrido
 
• 4 - Valor por antecipação dia útil
 
• 5 - Percentual por antecipação dia corrido
 
• 6 - Percentual por antecipação dia útil
 

==='''Domínios: especieDocumento'''===

• CH - Cheque
 
• DM - Duplicata Mercantil
 
• DMI - Duplicata Mercantil Indicação
 
• DS - Duplicata de Serviço
 
• DSI - Duplicata Serviço Indicação
 
• DR - Duplicata Rural
 
• LC - Letra de Câmbio
 
• NCC - Nota de Crédito Comercial
 
• NCE - Nota de Crédito Exportação
 
• NCI - Nota de Crédito Industrial
 
• NCR - Nota de Crédito Rural
 
• NP - Nota Promissória
 
• NPR - Nota Promissória Rural
 
• TM - Triplicata Mercantil
 
• TS - Triplicata de Serviço
 
• NS - Nota de Seguro
 
• RC - Recibo
 
• FAT - Fatura
 
• ND - Nota de Débito
 
• AP - Apólice de Seguro
 
• ME - Mensalidade Escolar
 
• PC - Pagamento de Consórcio
 
• NF - Nota Fiscal
 
• DD - Documento de Dívida
 
• CC - Cartão de Crédito
 
• BDP - Boleto Proposta
 
• OU - Outros
 

='''Como realizar a criação de Lançamentos utilizando a funcionalidade Open Banking?'''=
Para a criação de Lançamentos Financeiros acessar o caminho de Menu:
 

'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 

Acessar o botão “Criar” e informar os dados necessários para a criação do Lançamento Financeiro a Receber utilizando o Portador parametrizado para Open Banking.
 
 
'''1- Etapa criação do Lançamento:'''
 
 
<center>'''Criação do Lançamento Financeiro a Receber'''
[[Arquivo:Criacao Lancamento SICOOB.png|750x500px|centro]]
 
 

'''2- Etapa Impressão do Boleto Bancário do Lançamento Financeiro:'''
 
Nesta etapa pode ser realizado a impressão do Boleto Bancário diretamente pelo próprio Lançamento Financeiro ou através da rotina de Emissão em lote "Emissão de Boletos Personalizados":
 
 
<center>'''Impressão do Boleto Bancário do Lançamento Financeiro'''
[[Arquivo:Impressao de Boleto SICOOB.png|750x500px|centro]]
 
 

'''3- Etapa do Registro do Boleto Open Banking:'''
 
Nesta etapa pode ser realizado o "Registro" do Boleto diretamente pelo próprio Lançamento Financeiro ou através da rotina de Emissão em lote "Emissão de Boletos Personalizados", basta acessar a Categoria "Open Banking" e selecionar o Item de Categoria "Registrar".
O sistema irá realizar a comunicação através das parametrizações realizadas das Urls e Tokens de acesso e listará a situação do Registro do Boleto Bancário através do Relatório.
 
 
<center>'''Registrar Boleto Open Banking através Lançamento Financeiro'''
[[Arquivo:Registrar Lancamento SICOOB.png|750x500px|centro]]
 
<center>'''Relatório Remessa Bancária OnLine'''
[[Arquivo:Remessa Bancaria SICOOB.png|750x500px|centro]]
 
 

Após o registro automaticamente o sistema marca as opções de:
 
• Remessa Enviada
 
• Códigos de Barras Lido
 
 
<center>'''Boleto Bancário Registrado'''
[[Arquivo:Remessa Enviada SICOOB.png|750x500px|centro]]
 
 

Todas as movimentações realizadas sobre Open Banking ficam gravadas no Item de Categoria "Histórico" que fica na Categoria "Open Banking". Ao selecionar o Item de Categoria "Histórico" deve listar o Registro do Boleto Bancário.
 
 
<center>'''Item de Categoria Histórico de Movimentos Open Banking'''
[[Arquivo:Historico Open Banking SICOOB.png|750x500px|centro]]

='''Como realizar o Envio em Lote Open Banking através da rotina Remessa de Cobrança Open Banking?'''=
Assim como é possível realizar o Envio do Registro do Boleto Bancário através do próprio Lançamento Financeiro, existe a possibilidade de realizar esse processo em Lote, quando se tratar de vários registros a serem enviados.
Através do Menu:
 
'''Finanças > Gestão Financeira > Rotinas > Operacionais > Open Banking > Remessa de Cobrança Open Banking'''
 
 
<center>'''Remessa de Cobrança Open Banking'''
[[Arquivo:Remessa de Cobranca SICOOB.png|750x500px|centro]]
 
Esta rotina tem um conceito muito simples em relação aos filtros, foram disponibilizados campos essências que permitem ter uma rastreabilidade dos movimentos.

• '''Unidade de Negócio:''' informe a Unidade de Negócio desejada para realizar o filtro para busca dos movimentos.
 
• '''Data:''' informe a Data desejada para realizar o filtro para busca dos movimentos.
 
• '''Vencimento:''' informe o período de Vencimento desejado para realizar o filtro para busca dos movimentos.
 
• '''Lançamento:''' informe a faixa de Lançamentos desejada para realizar o filtro para busca dos movimentos.
 
• '''Tipo de Pagamento:''' informe o Tipo de Pagamento desejado para realizar o filtro para busca dos movimentos.
 
• '''Série:''' informe a Série desejada para realizar o filtro para busca dos movimentos.
 
• '''Nota Fiscal:''' informe a faixa de Nota Fiscal desejada para realizar o filtro para busca dos movimentos.
 
• '''Conta Financeira:''' informe a Conta Financeira desejada para realizar o filtro para busca dos movimentos.
 
• '''Empresa:''' informe a faixa de Empresa desejada para realizar o filtro para busca dos movimentos.
 
• '''Cobrança:''' informe a faixa de Empresa de Cobrança desejada para realizar o filtro para busca dos movimentos.
 
 
Após informado os filtros e confirmado a operação da rotina, o sistema gera um relatório com a listagem dos movimentos.
 
Na coluna "Registro", será listado se houve a confirmação ou ocorreu algum erro.
 
 
<center>'''Relatório Remessa de Cobrança Open Banking'''
[[Arquivo:Coluna Registro SICOOB.png|750x500px|centro]]

='''Como realizar a Alteração de Vencimento do Lançamento já Registrado Open Banking e reenviá-lo novamente?'''=

Irá surgir a necessidade de realizar a alteração do Vencimento do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?
 
'''Dado que''' temos um Lançamento Financeiro já Registrado Open Banking, basta acessar o Lançamento Financeiro desejado através do caminho do Menu:
 
'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 
Acessar o Lançamento Financeiro em modo Modificar e alterar o campo "Venc.Original", automaticamente após alteração do Vencimento, o sistema insere o Comando "05" no campo "Comando de Remessa" e diante disso já emite uma mensagem:
 
'''Confirma o envio da alteração do título ao banco?'''
 
'''Importante:''' para o envio da alteração do Vencimento o sistema já considera o campo '''Vencimento''', caso seja utilizado a '''Modalidade''' como '''Seguinte''' por exemplo, onde é possível ter um Vencimento Original diferente do Vencimento.
 
<center>'''Lançamento Financeiro a Receber já Registrado'''
[[Arquivo:Lancamento ja Registrado SICOOB.png|750x500px|centro]]
 
Vencimento alterado, o sistema insere o Comando "05" no campo "Comando de Remessa" e ao salvar o registro é emitido a mensagem: "Confirma o envio da alteração do título ao banco?"
<center>'''Confirma o envio da alteração do título ao banco?'''
[[Arquivo:Vencimento Alterado.png|750x500px|centro]]
 

•'''Sim:''' é enviado o registro de alteração do Open Banking e se registrado com sucesso o sistema retira o Comando de Remessa.
 
<center>'''Vencimento alterado e registro salvo'''
[[Arquivo:Lancamento Vencimento Alterado.png|750x500px|centro]]
 

•'''Não:''' não faz a comunicação do envio da alteração do vencimento via Open Banking. Este registro não foi notificado, logo será necessário realiza-lo através do próprio Lançamento ou através da rotina de Remessa de Cobrança Open Banking.
 
No Lançamento Financeiro é habilitado o botão "Reenviar Registro" no Item de Categoria "Open Banking".
Quando selecionado o botão '''Registrar Alteração''', o sistema faz a comunicação via Open Banking e registra alteração de vencimento realizada.
 
<center>'''Lançamento Não Registrado a alteração de Vencimento com o Comando de Remessa'''
[[Arquivo:Botao Registrar Alteracao.png|750x500px|centro]]
 
Ao selecionar o botão "Registrar Alteração" o sistema emite a mensagem para confirmar o envio.
 
<center>'''Botão Registrar Alteração'''
[[Arquivo:Lancamento Confirmar Lancamento.png|750x500px|centro]]
 
Após a confirmação o sistema registra alteração
 
<center>'''Lançamento alterado e registrado'''
[[Arquivo:Lancamento Registrado e Salvo.png|750x500px|centro]]


='''Como realizar a Alteração de Multa do Lançamento já Registrado Open Banking e reenviá-lo novamente?'''=

'''Irá surgir a necessidade de realizar a alteração da Multa do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?'''
 
Dado que já temos um Lançamento Financeiro já Registrado Open Banking, basta acessar o Lançamento Financeiro desejado através do caminho do Menu:
 
'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 
'''Regra Sistema para Multa ou Juros:'''
 
Se no cadastro do Portador não possuir Comando de Remessa com as novas opções:
 
'''Tipo de Comando =''' Alteração de Multa para Multa
 
'''Tipo de Comando =''' Alteração de Juros para Juros
 
Ao acessar o Lançamento Financeiro em modo Modificar e alterar o campo '''Multa de''', automaticamente após alteração da Multa, o Sistema irá criar essa parametrização do Comando de Remessa com '''sugestão''', sendo passível de alteração, no Cadastro do Portador no botão '''Remessas''' e depois no botão '''Comandos'''.
 
'''Comando sugestão para Multa:'''
 
'''Código Operação =''' ATM
 
'''Comando =''' ATM
 
'''Descrição =''' ALTERAÇÃO DE MULTA PARA OPEN BANKING
 
'''Tipo de Comando =''' Alteração de Multa
 
 
<center>'''Cadastro do Portador Comando de Remessa Multa'''
[[Arquivo:Comando Multa 2.png|750x500px|centro]]
 

'''Como é identificado a alteração da Multa para Banco?'''
 
Através das tags enviadas para API gravadas no Histórico do Open Banking Dados API:
 
• '''tipoMulta''': 2 - Percentual;
 
• '''tipoMulta''': 0 - Isento;
 
• '''valorMulta''': Indica a porcentagem da multa.
 
 
<center>'''Lançamento Financeiro a Receber já Registrado alterando a Multa'''
[[Arquivo:Alteracao Multa.png|750x500px|centro]]

Tags enviadas para API Banco:
 
<center>'''Dados API Tags referente a Multa'''
[[Arquivo:Tags Multa.png|750x500px|centro]]
 

='''Como realizar a Alteração de Juros do Lançamento já Registrado Open Banking e reenviá-lo novamente?'''=

'''Irá surgir a necessidade de realizar a alteração de Juros do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?'''
 
Dado que já temos um Lançamento Financeiro já Registrado Open Banking, basta acessar o Lançamento Financeiro desejado através do caminho do Menu:
 
'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 
'''Regra do Sistema para Multa ou Juros:'''
 
Se no cadastro do Portador não possuir Comando de Remessa com as novas opções:
 
'''Tipo de Comando =''' Alteração de Multa para Multa
 
'''Tipo de Comando =''' Alteração de Juros para Juros
 
Ao acessar o Lançamento Financeiro em modo Modificar e alterar o campo '''Juros Dias de''' ou '''Juros Mês de''', automaticamente após alteração dos Juros, o Sistema irá criar essa parametrização do Comando de Remessa com '''sugestão''', sendo passível de alteração, no Cadastro do Portador no botão '''Remessas''' e depois no botão '''Comandos'''.
 
'''Comando sugestão para Juros:'''
 
'''Código Operação =''' ATJ
 
'''Comando =''' ATJ
 
'''Descrição =''' ALTERAÇÃO DE JUROS PARA OPEN BANKING
 
'''Tipo de Comando =''' Alteração de Juros
 
 
<center>'''Cadastro do Portador Comando de Remessa Juros'''
[[Arquivo:Comando Juros.png|750x500px|centro]]
 
'''Como é identificado a alteração de Juros para Banco?'''
 
Através das tags enviadas para API gravadas no Histórico do Open Banking Dados API:
 
• '''tipoJurosMora:''' '''2''' – Taxa Mensal; Indica que há Juros no registro.
 
• '''tipoJurosMora:''' '''3''' – Isento.
 
• '''valorJurosMora:''' Valor do Juros de Mora.
 
 
<center>'''Lançamento Financeiro a Receber já Registrado alterando os Juros'''
[[Arquivo:Confirma Alteracao Juros.png|750x500px|centro]]
 

Tags enviadas para API Banco:
 
 
<center>'''Dados API: Tags referente aos Juros'''
[[Arquivo:Tags Juros.png|750x500px|centro]]


='''Como realizar a Baixa de um Lançamento Financeiro Registrado Open Banking e enviar o Registro de Baixa?'''=

'''IMPORTANTE:''' O processo de Cancelamento de Notas Fiscais, não atende a baixa automatica dos Boletos, logo deve ser baixado manualmente os registros dos Lançamentos Financeiros.
 
 
Para realizar o processo de '''Baixa''' de um Lançamento Financeiro que foi registrado via Open Banking, basta acessar o Lançamento Financeiro.
 
'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 
Selecionar a opção de Menu Lateral do Lançamento Financeiro '''Open Banking''' e a opção de '''Baixar'''.
 
<center>'''Lançamento Financeiro Registrado/Baixar'''
[[Arquivo:Baixar.png|750x500px|nenhum|Baixado_Sucesso]]
 
<center>'''Lançamento Financeiro Baixado'''
[[Arquivo:Baixado.png|750x500px|nenhum|Baixado_Sucesso]]
 
Agora basta acessar a rotina de Retorno de Cobrança Open Banking através do Menu:
 
'''Menu > Finanças > Gestão Financeira > Rotinas > Operacionais > Open Banking > Retorno de Cobrança Open Banking '''
 
Modelo de Relatório utilizado:
 
%CIGAM_INSTAL%\Modelos_relatorios\Gestão Financeira\RF00071_remessas.RTF
 
<center>'''Retorno de Cobrança Open Banking'''
[[Arquivo:Filtros Retorno Cobranca.png|750x500px|centro]]
 
<center>'''Retorno de Cobrança Open Banking'''
[[Arquivo:Parametros Retorno Cobranca.png|750x500px|centro]]
 
Após confirmado a rotina emite a Listagem de Retorno com o título baixado registrado.
 
<center>'''Listagem Retorno Bancario Online'''
[[Arquivo:Listagem Retorno Bancario Online.png|750x500px|nenhum|Listagem_Retorno_Bancario_Online]]


='''Como parametrizar para envio Open Banking a Negativação ou Protesto?'''=

Para enviar um '''PROTESTO:'''
 
Acesse o Cadastro do Portador e insira os dias no campo '''Protestar após''' na guia Configurações.
 
'''Menu > Finanças > Gestão Financeira > Parâmetros > Portadores'''
 
<center>'''Dias de Protesto no Cadastro do Portador'''
[[Arquivo:Protestar Apos.png|750x500px|centro]]
 
Quando se tratar de '''Protesto''' o sistema deve enviar as tags para API do Banco da seguinte forma:
 
• '''codigoProtesto:''' 1 - Protestar Dias Corridos;
 
• '''codigoProtesto:''' 3 - Não Protestar;
 
• '''numeroDiasProtesto:''' Número de dias para protesto do boleto.
 
<center>'''Exemplo de envio da API'''</center>
[[Arquivo:Tags Protesto.png|750x500px|centro]]

 
Para enviar uma '''NEGATIVAÇÃO:'''
 
Acesse o Cadastro do Portador e insira os dias no campo '''Negativar após''' na guia '''Configurações.
 
'''Menu > Finanças > Gestão Financeira > Parâmetros > Portadores'''
 
<center>'''Dias de Negativação no Cadastro do Portador'''
[[Arquivo:Dias Negativacao.png|750x500px|centro]]
 
Quando se tratar de '''Negativação''' o sistema deve enviar as tags para API do Banco da seguinte forma:
 
• '''codigoNegativacao:''' 2 - Negativar Dias Úteis;
 
• '''codigoNegativacao:''' 3 - Não Negativar;
 
• '''numeroDiasNegativacao:''' Número de dias para negativação do boleto.
 
<center>'''Exemplo de envio da API'''
[[Arquivo:Tags Negativacao.png|750x500px|centro]]


='''Não Escopo Retorno Open Banking Cartório?'''=

Referente ao retorno para liquidação em Cartório, o Banco tem uma limitação e não foi desenvolvido ainda por parte do Banco na API as custas e tarifas de Cartório, impossibilitando o Sistema de realizar essa liquidação.
 
A sugestão para registros de Cartório é realizar via Remessa de CNAB de Retorno manual, até o Banco SICOOB liberar essa funcionalidade na API.

GF - Como Fazer - Open Banking para Banco do Brasil

2022-04-25T18:12:26Z

Alan.campos: /* Como realizar a Baixa de um Lançamento Financeiro Registrado Open Banking e enviar o Registro de Baixa? */

[[categoria:Como_Fazer_Finanças]]

=='''O que significa Open Banking?'''==

Open Banking é um conceito relativamente novo na realidade do mercado financeiro brasileiro. Porém, ele tem ganhado cada vez mais atenção em todo o mundo.
Traduzido, o termo significa “banco aberto”, mas uma tradução mais precisa seria “sistema financeiro aberto”.
O conceito em si trata de algo de simples compreensão. Basicamente, Open Banking é a defesa de que o sistema financeiro adote a tecnologia de forma mais ampla e padronizada, como forma de incentivar e ampliar a oferta e a qualidade dos produtos e serviços financeiros.
A base do Open Banking está na premissa de que os dados pertencem aos consumidores. Logo, caso eles autorizem, esses dados devem ser disponibilizados para que eles possam ter acesso a produtos e serviços que forem mais convenientes.
Na prática, há um pedido para que as instituições abram suas API’s (sigla em inglês para Interface de Programação de Aplicativos) para que terceiros desenvolvam e aprimorem os sistemas e suas funcionalidades.
O objetivo do Open Banking é desenvolver sistemas integrados, que facilitem o controle e transferência de informações de dados, histórico, contas, empréstimos etc. Todo o tipo de produto e serviço oferecido pelos bancos seria integrado de maneira a evitar processos complicados e dispendiosos.
À primeira vista, pode parecer que com o Open Banking as informações dos clientes ficarão soltas e desprotegidas. No entanto, os bancos e instituições financeiras ainda serão responsáveis pela proteção de dados sigilosos.

 

=='''Serviços Disponíveis pela API do Banco nesta Versão?'''==

'''Menu > Utilidades/Diversos > Genéricos > Parâmetros > Configurações'''
 
<center>
{| class="wikitable"
|-
! SERVIÇO !! COBRANÇA
|-
| Registro de Boleto via API || SIM
|-
| Open Banking PIX no Boleto || SIM
|-
| Retorno de Cobrança via API || SIM
|-
| Alteração de Juros via API || SIM
|-
| Alteração de Multa via API || SIM
|-
| Alteração de Vencimento via API || SIM
|-
| Alteração de Baixa via API || SIM
|-
| Retorno de Cobrança com Registro em Cartório via API || NÃO
|-
|}
</center>
 

=='''Como obter as Credenciais para utilizar a Funcionalidade Open Banking?'''==
 
As credenciais do Banco do Brasil devem ser obtidas através do acesso ao Portal Developers (pdf caminho citado).
 
'''I:\CIGAM\Implementa\Documentos\Apoio a implementação\Open Banking Manual Banco\02 Portal Developers - Credenciais de produção.pdf'''
 
Este acesso deve ser feito pelo '''responsável da conta corrente na empresa'''. No momento da geração das credenciais devem ser incluídos os “Escopos” (Funcionalidades da API) tais como Cobrança, Pagamento e PIX.
 
Qualquer geração de credenciais com um contexto diferente deste, seja porque a pessoa a gerar as credenciais '''não é o responsável da conta''' ou por algum dos serviços tenha ficado de fora do escopo, irá resultar em erro no momento do uso da API.
 
'''Ex: {"statusCode":403,"error":"Forbidden","message":"Application key is not allowed to call this resource method"};”'''
 

=='''Quais os Módulos necessários para utilizar a Funcionalidade Open Banking do Banco do Brasil”?'''==

• Módulo Gestão Financeira;

=='''Quais são as parametrizações necessárias para utilizar a funcionalidade do Open Banking?'''==

Para utilizar esta funcionalidade é necessário possuir o Cadastro do Portador para o Banco do Brasil.
O cadastro quando preenchido corretamente garante que não ocorrerá inconsistências no momento do registro do Open Banking.
 
Como boa prática de implementação é mais coerente criar um novo Portador para Open Banking evitando assim de alterar o Portador utilizado para CNAB caso necessite realizar algum processo via remessa ou retorno, quando a API do Banco estiver com instabilidade.
 
Essa parametrização deverá validar os últimos Sequenciais da numeração de Boletos do Portador utilizado para as Remessas, pois assim garante que não ocorrerá conflito enviar uma numeração de Título já registrado.
 
 
'''Itens Importantes na Parametrização:'''
 
'''- Processar retornos pelo número do Boleto:''' esta opção deve estar marcada, pois caso contrário ocorrerá problemas na gravação das informações e envio para Banco.
 
Caso tenha sido realizado movimentações com esta opção desmarcada, não será possível realizar a Baixa, pois sistema não consegue localizar devido não possuir o '''Nosso Número''' gravado nas tabelas envolvidas.
 
Para solucionar essa questão será necessário:
 
'''1-''' Identificar o '''Nosso Número''' do registro a ser baixado (Lançamento Financeiro);
 
'''2-''' Gravar o '''Nosso Número''' nas seguintes tabelas:
 
'''GFBOLETOS:''' campo a ser atualizado '''NOSSO_NRO''' com a informação do Nosso Número.
 
'''GFLAUXIL:''' campo a ser atualizado '''CODIGO_BARRAS''' com a informação do Nosso Número.
 
- A variação da Carteira do Banco do Brasil;
 
- Quando se tratar do Portador Open Banking do BB, o campo "Identificação do serviço" deve ser em Branco.
 
Para o correto funcionamento da rotina é necessário que os dados do Portador esteja com todas informações necessárias, inclusive o '''Convênio'''.
 
'''Menu > Finanças > Gestão Financeira > Parâmetros > Portadores'''
 
Este cadastro é apenas uma demonstração de parametrização:
 
<center>'''Cadastro de Portador'''
[[Arquivo:Cadastro Portador OpenBanking.png|750x500px|semmoldura|nenhum|Cadastro_Portador_OpenBanking]]
 
Quando se tratar do Portador Open Banking do BB, o campo "Identificação do serviço" deve ser em Branco.
 
'''Conta:''' o preenchimento da Conta deve ser sem caracteres especiais, somente números.
 
 
'''Convênio:'''
 
"Cada Conta Corrente é um Convênio" - (7 posições).
"Uma Conta Corrente pode ter vários Convênios".
"Quando tenho mais de um Convênio, muda o Código do Convênio e a variação da Carteira conforme a tabela abaixo:"
Variação da Carteira (caso tenha mais de um Convênio):
 
'''019 (Código de 2 + DV)'''
 
'''027'''
 
'''035'''
 
'''043...'''
 
'''Carteira (Serviço):'''
 
'''011 -''' (Cobrança simples Boleto por correio)
 
'''031 -''' (Cobrança simples Vinculada)
 
'''017 -''' (Cobrança simples Imprime Boleto - considerado como Única)
 
'''051 -''' (Carteira Descontada), modalidade utilizada é 04.
 
Demais são considerados atributos.
 
'''Modalidades de Serviço do Banco do Brasil consideradas:'''
 
01 - Simples
 
04 - Vinculada (esta Modalidade esta atrelada somente a '''Carteira 051''', logo não deve ser utilizada para outras Carteiras)
 
'''Regra do Sistema para Banco do Brasil Open Banking:'''
 
'''Identificador do Serviço:''' as opções para este campo são:
 
'''01 -''' Simples
 
'''04 -''' Vinculado
 
Valores diferentes destes serão tratados = '''01 -''' Simples
 

 
'''Espécie:''' este campo para Open Banking é considerado para identificar o Tipo de Boleto de Cobrança. Quando este campo estiver em Branco o Sistema irá considerar sempre '''04 -''' DUPLICATA SERVICO.
 
'''01 -''' CHEQUE
 
'''02 -''' DUPLICATA MERCANTIL
 
'''03 -''' DUPLICATA MTIL POR INDICACAO
 
'''04 -''' DUPLICATA SERVICO
 
'''05 -''' DUPLICATA SRVC P/INDICAO
 
'''06 -''' DUPLICATA RURAL
 
'''07 -''' LETRA DE CAMBIO
 
'''08 -''' NOTA DE CRÉDITO COMERCIAL
 
'''9-''' NOTA DE CREDITO A EXPORTACAO
 
'''10-''' NOTA DE CREDITO INDULTRIAL
 
'''11-''' NOTA DE CREDITO RURAL
 
'''12-''' NOTA PROMISSORIA
 
'''13-''' NOTA PROMISSORIA RURAL
 
'''14-''' TRIPLICATA MERCANTIL
 
'''15-''' TRIPLICATA DE SERVICO
 
'''16-''' NOTA DE SEGURO
 
'''17-''' RECIBO
 
'''18-''' FATURA
 
'''19-''' NOTA DE DEBITO
 
'''20-''' APOLICE DE SEGURO
 
'''21-''' MENSALIDADE ESCOLAR
 
'''22-''' PARCELA DE CONSORCIO
 
'''23-''' DIVIDA ATIVA DA UNIAO
 
'''24-''' DIVIDA ATIVA DE ESTADO
 
'''25-''' DIVIDA ATIVA DE MUNICIPIO
 
'''31-''' CARTAO DE CREDITO
 
'''32-''' BOLETO PROPOSTA
 
'''33-''' BOLETO APORTE
 
'''99-''' OUTROS
 
<center>'''Guia CNAB'''
[[Arquivo:Portador_Guia_CNAB3.png|700x500px|semmoldura|nenhum|Portador_Guia_CNAB3]]
 
<center>'''Guia Configurações'''
[[Arquivo:Cadastro Portador Config.png|700x500px|semmoldura|nenhum|Cadastro_Portador_Config]]
 
 
'''Irá surgir a necessidade de realizar a alteração de Vencimento, Multa ou Juros do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?'''
 
Regra Sistema para Vencimento, Multa ou Juros:
 
Cadastro do Portador deve possuir Comando de Remessa com as novas opções:
 
'''Tipo de Comando =''' Alteração de Vencimento (para alteração de Vencimento).
 
'''Tipo de Comando =''' Alteração de Multa para Multa (para alteração de Multa).
 
'''Tipo de Comando =''' Alteração de Juros para Juros (para alteração de Juros).
 
Caso não seja parametrizado neste primeiro momento as opções de Multa e Juros o sistema cria automaticamente (Somente Juros e Multa).
 
Ao acessar o Lançamento Financeiro em modo Modificar e alterar o campo Multa de ou Juros de, automaticamente após alteração da Multa, o Sistema irá criar essa parametrização do Comando de Remessa com sugestão, sendo passível de alteração, no Cadastro do Portador no botão Remessas e depois no botão Comandos.
 
'''Comando sugestão para Multa:'''
 
'''Código Operação''' = ATM
 
'''Comando''' = ATM
 
'''Descrição''' = ALTERAÇÃO DE MULTA PARA OPEN BANKING
 
'''Tipo de Comando''' = Alteração de Multa
 
'''Comando sugestão para Juros:'''
 
'''Código Operação''' = ATJ
 
'''Comando''' = ATK
 
'''Descrição''' = ALTERAÇÃO DE JUROS PARA OPEN BANKING
 
'''Tipo de Comando''' = Alteração de Juros
 
<center>'''Botão Remessas > Comandos'''
[[image:bt_Comando_Remessa_cop.png.png|center|semmoldura|750px|Comando Remessa]]
 
 
<center>'''Botão Retornos > Códigos de Retorno'''
[[image:bt_Codigo_Ret.png|center|semmoldura|750px|Código de Retorno]]
 
 
Para iniciar a configuração através do “Assistente de Parâmetros do Open Banking”, basta selecionar o botão “Open Banking”:
 
'''Menu > Finanças > Gestão Financeira > Parâmetros > Configuração de Bancos'''
 
 
<center>'''Configurações de Banco'''
[[Arquivo:Configuracoes Banco.png|750x550px|semmoldura|nenhum|Configuracoes_Banco]]
 
 
Para dar início ao processo de parametrização, basta selecionar o botão “Avançar”:
 
 

=='''Tela Inicial Configuração do Assistente Open Banking:'''==
 
'''IMPORTANTE:''' Devido a uma especificação do Banco do Brasil, as Credenciais do Banco geradas são válidas para o escopo de serviços (APIs) do Cliente no momento da sua criação.
 
Caso haja adição de novos serviços ao escopo do Cliente, por exemplo, Credenciais para a API de Cobrança e posteriormente adicione a API do '''PIX''' ao seu escopo, será necessário excluir as Credenciais Antigas no Portal Developers e criar novas, contendo as duas APIs.
 
Depois disso, ele deverá inseri-las no Sistema novamente, substituindo as antigas.
 
Para iniciar a configuração é necessário ter em mãos os seguintes dados: (Cliente, Chave de Autorização e Gw-app-Key).
Sem essas informações não será possível dar continuidade na parametrização do Open Banking para o Banco do Brasil.
 
<center>'''Tela Inicial Assistente de Parâmetros Open Banking'''
[[Arquivo:Tela Inicial Wizard2.png|750x500px|nenhum|Tela_Inicial_Wizard2.png]]
 


=='''Etapa 1 (Parâmetros: Passo 1 de 4):'''==


Uma das etapas mais importantes e que requer um cuidado maior e sigilo das informações nesta parametrização.
 
Essas informações são disponibilizadas pelo Banco a qual deve ser restrita somente a pessoa responsável pelo setor Financeiro da Empresa.
 
O assistente tem como objetivo proporcionar que o próprio usuário tenha autonomia para executar esse passo a passo sem necessidade de passar essas informações restritas da Empresa para qualquer pessoa que não seja ele mesmo.
 
Reforçando, mesmo que tenha dificuldades para executar esta etapa, não repasse nenhuma informação relacionado aos acessos dos tokens.
 
Dados em mãos para informar os respectivos campos, basta copiar e colar as informações.
 
Developer Application Key, Client Id, Cliente Secret, e o Scope que passa vir preenchido automaticamente por padrão.
 
Os campos:
 
Client ID e Client Secret possuem uma tecnologia de criptografia, ou seja, após informar os dados nos campos o sistema irá criptografar as informações garantindo e mantendo a segurança das informações.
 
Caso haja necessidade de alterações, basta clicar no ícone do "Cadeado", será aberta a tela de Criptografia e após colar ou digitar as informações em tela e selecionar o botão "Confirmar".
 
Também tenha alguma dúvida no dado informado e necessitar validar o dado seguindo os mesmos passos da alteração será aberta a tela de Criptografia e após colar ou digitar as informações em tela e selecionar o botão "Validar", sistema confirma se os dados são os mesmos.
 
Observamos que esta tela possui duas guias, uma de Homologação e Produção. Preencher conforme a necessidade do processo, caso precise realizar testes, parametrize em homologação e posteriormente parametrize o de Produção ou se preferir, pode preencher os dois se possuir os dados.
 
Lembrando que esses dados são confidenciais de uso e exclusivo de cada usuário.
 
Através dessas informações o sistema irá se comunicar com API do Banco para poder realizar os registros dos Lançamentos.
 
Após informado os dados, basta selecionar o botão "Avançar", para seguir os próximos passos.
 
'''Developer Application Key:''' conforme orientação do Banco esses dados são de cunho da própria Desenvolvedora de Software, ou seja, elas serão fixas do Sistema CIGAM, sendo setadas por padrão.
 
'''Client ID:''' Identificação da Aplicação, é necessário informar a codificação passada pelo Banco. Este dado é criptografado.
 
'''Client Secret:''' Credencial do banco, é necessário informar a codificação passada pelo Banco. Este dado é criptografado.

 
 
<center>'''Parâmetros: Passo 1 de 4'''
[[Arquivo:Parametros Passo 1de4.png|750x500px|nenhum|Parametros_Passo_1de4]]
 
Atualizado o Scope para Versão 2 do Open Banking sendo setado por padrão, para maiores informações acessar o título do Manual:
 
'''Quais são as novidades após atualização para Versão 2 do Open Banking?'''

=='''Etapa 2 (Portador de Remessa e Retorno - Pagamento: Passo 2 de 4):'''==

Nesta etapa deve ser selecionado o Portador que será considerado para o envio da Remessa de Pagamento (onde estarão os boletos em aberto) e nesta mesma tela informar o qual Portador será considerado para o Retorno de Pagamento (onde serão liquidados os retornos de Pagamentos).
 
Nesta etapa, é possível pular, caso não utilize ainda o Envio de Pagamentos do Open Banking.
 
'''Pular:''' caso deseja pular essa etapa e prosseguir com o processo de parametrização do Open Banking.
 
'''Avançar:''' dá continuidade ao processo de parametrização, após selecionado uma opção.
 
Para continuar a parametrização selecione o botão "Pular" e siga para os próximos passos.
 
<center>'''Portador de Remessa e Retorno: Passo: 2 de 4'''
[[Arquivo:Passo 2 Portador Pagamentos 2.png|750x500px|nenhum|Passo_2_Portador_Pagamentos_2]]
 

=='''Etapa 3 (Convênios de Cobrança: Passo 3 de 4):'''==
 
Nesta etapa o sistema avalia sua base de dados, e localiza os Convênios parametrizados para o Banco do Brasil, onde serão listados.
O sistema possibilita a parametrização de Convênios específicos bem como caso seja optado, selecionando o botão "Pular" o sistema criará automaticamente o Convênio "Geral", ao qual utiliza dados do Portador registrado.
 
'''Pular:''' caso deseja pular essa etapa e prosseguir com o processo de parametrização do Open Banking.
 
'''Avançar:''' dá continuidade ao processo de parametrização, após selecionado uma opção.
 
<center>'''Convênios de Cobrança: Passo 3 de 4'''
[[Arquivo:Passo 3 Convenios Cobranca 2.png|750x500px|nenhum|Passo_3_Convenios_Cobranca_2]]
 

=='''Etapa 3 (Portador de Remessa e Retorno - Cobrança: Passo 3 de 4):'''==
 
Nesta etapa deve ser selecionado o Portador que será considerado para o envio da Remessa de Cobrança (onde estarão os boletos em aberto) e nesta mesma tela informar o qual Portador será considerado para o Retorno de Cobrança (onde serão liquidados os retornos de Cobranças).
 
'''Avançar:''' dá continuidade ao processo de parametrização, após selecionado uma opção.
 
<center>'''Portador de Remessa e Retorno - Cobrança: Passo 3 de 4'''
[[Arquivo:Passo 3 Convenios Cobranca Portador.png|750x500px|nenhum|Passo_3_Convenios_Cobranca_Portador]]
 
Atualizado Wizard para Versão 2 do Open Banking, disponibilizando duas opções:
 
'''- Direto''': esta opção tem como finalidade registrar o Boleto no momento da sua geração, ou seja, quando selecionado ativa propriedade ao qual ao gerar o Boleto Bancário o sistema automaticamente envia o registro Open Banking, sem a necessidade de fazer o processo de envio da Remessa Open Banking do título.
 
'''- PIX''': esta opção tem como finalidade registrar uma operação PIX para os Boletos emitido de forma Direta (opção '''Direto''' marcado).
 
Esta opção é válida '''SOMENTE''' para o Banco do Brasil.
 
Para maiores informações acessar o título do Manual:
 
'''Quais são as novidades após atualização para Versão 2 do Open Banking?'''

=='''Etapa 4 (Relatório: Passo 4 de 4):'''==

 
Nesta etapa o sistema irá buscar automaticamente o Modelo de Relatório Padrão, caso exista no ambiente, facilitando assim todo processo de parametrização e implementação para usuário.
 
A busca é realizado '''(%CIGAM_INSTAL%RF00071_remessas.RTF)''', com isso é importante que o Modelo de Relatório (RF00071_remessas.RTF) esteja devidamente localizado na pasta padrão do Cigam_Instal, como por exemplo:
 
'''%CIGAM_INSTAL%''' = P:\Cigam11\Projects\Controle\MACIEL\Financeiro_Open_Banking
 
"P:\Cigam11\Projects\Controle\MACIEL\Financeiro_Open_Banking\Modelos\Relatorios\Gestao Financeira\RF00071_remessas.RTF"
 
Clicar em "Avançar" para dar seguimento.
 
<center>'''Assistente de Parâmetros Open Banking: Passo 4 de 4'''
[[Arquivo:Assistente Passo 4.png|750x500px|semmoldura|nenhum|Assistente_Passo_4]]
 
 

=='''Etapa Conclusão (Parâmetros de Convênio Open Banking - Conclusão):'''==

 
Esta etapa o sistema faz validação da comunicação com o Banco através da API verificando o ambiente se esta tudo ok, listando em tela.
 
Após a consulta estar "OK", basta clicar no botão "Concluir" e seu ambiente estará apto para utilizar a funcionalidade Open Banking.
 
<center>'''Parâmetros de Convênio Open Banking: Passo Final - Conclusão'''
[[Arquivo:Etapa Final Conclusao.png|750x500px|nenhum|Etapa_Final_Conclusao]]
 
'''Homologação:''' Conexão realizada com sucesso.
 
'''Produção:''' O servidor remoto retornou um erro: (401) Não Autorizado. Isso ocorre quando não houve a parametrização dos dados em Produção como foi realizado no ambiente de Homologação conforme o passo a passo, ou possa ter ocorrido algum erro na comunicação com o Banco.
 
<center>'''Convênio Cadastrado com Sucesso - Cobrança'''
[[Arquivo:Convenio Cobranca Homolog.png|750x500px|nenhum|Convenio_Cobranca_Homolog]]
 
'''Ambiente:''' lista qual é o ambiente cadastrado, sendo apenas duas opções: Homologação e Produção.
 
'''Convênios:''' neste grupo serão listados todos os convênios cadastrados, bem como todas informações pertinentes como:
 
- Portador;
 
- Agência;
 
- Número Conta;
 
- Portador de retorno;
 
'''- Direto:''' esta opção tem como finalidade registrar o Boleto no momento da sua geração, ou seja, quando selecionado ativa propriedade ao qual ao gerar o Boleto Bancário o sistema automaticamente envia o registro Open Banking, sem a necessidade de fazer o processo de envio da Remessa Open Banking do título.
 
Também quando selecionada, terá uma particularidade na questão da Emissão de Boletos em lote pela Rotina de Emissão de Boletos Personalizados. A rotina na guia '''Opções''' tem a opção '''Enviar somente Lançamentos não marcados e marca-los''', caso esteja desmarcada o Registro Open Banking ocorrerá da mesma forma que o sistema irá marcar a opção '''Boleto Impresso''' do Lançamento Financeiro, registrando a Operação Open Banking.
Isso ocorre para manter a integridade, já que esta operação é considerada única no registro, sendo então necessário marcar a '''Boleto Impresso''', para poder conseguir realizar alterações como Alteração de Vencimento ou mesmo a Baixa, sendo uma condição de Sistema.
 
'''- PIX:''' esta opção fica habilitada somente quando selecionado a opção Direto, ela tem como finalidade registrar uma operação PIX para os Boletos emitido de forma Direta (opção Direto marcado).
 
Esta opção é válida SOMENTE para o Banco do Brasil.
 
Ao emitir o Boleto do Lançamento o sistema marca as 3 opções:
 
- Boleto Impresso;
 
- Remessa Enviada;
 
- Código de Barras Lido;
 
'''U.N Ced.:''' esta opção tem como finalidade possibilitar o envio e registro de Boletos de outras Unidades de Negócio.
 
Basta informar a Unidade desejada no campo e o sistema entenderá quando realizado o processo de registro de um título que não seja da Unidade Matriz, então sistema identifica e realiza o processo de envio e registro.
Se deixar em Branco a Unidade Cedente irá considerar para todas Unidades de Negócio.
 
 
<center>'''Convênio Cadastrado com Sucesso - Pagamento'''
[[Arquivo:Convenio Pagamento Homolog.png|750x500px|nenhum|Convenio_Pagamento_Homolog]]
 
'''Ambiente:''' lista qual é o ambiente cadastrado, sendo apenas duas opções: Homologação e Produção.
 
'''Convênios:''' neste grupo serão listados todos os convênios cadastrados, bem como todas informações pertinentes como:
 
- Portador;
 
- Agência;
 
- Número Conta;
 
- Portador de retorno;
 
<center>'''Ícone Credenciais'''
[[Arquivo:Icone Credenciais API.png|750x500px|nenhum|Icone_Credenciais_API]]
 
Através deste ícone é possível verificar os Parâmetros API parametrizados, tanto em homologação quanto em produção.
 
 
<center>'''Ícone Endereços'''
[[Arquivo:Icone Endereços.png|750x500px|nenhum|Icone_Endereços]]
 
Através deste ícone é possível verificar todos endereços de URLs parametrizados.

=='''O que significa a Categoria Open Banking de acesso?'''==
 
 A Categoria Open Banking é uma Categoria que é habilitada mediante a utilização de um Portador parametrizado com as Configurações de Banco Open Banking. A mesma tem como objetivo proporcionar maior agilidade e gerenciamento das atividades relacionadas a Remessa de Cobrança Online.
 
'''Categoria Open Banking'''
 
 
<center>'''Categoria Open Banking'''
[[Arquivo:Categoria Open Banking.png|750x500px|semmoldura|nenhum|Categoria_Open_Banking]]
 
 

'''Registrar:''' item de categoria tem como funcionalidade registrar o Boleto Bancário Online. Substitui todo o processo de geração do arquivo de Remessa de Cobrança, acessar o site e remeter ao Banco esse arquivo, com apenas um clique na opção.
 
'''Reenviar:''' item de categoria tem como funcionalidade possibilitar o reenvio de registros que estão com alguma pendência ou algum erro de parametrização. Será habilitado somente quando já possuir movimento de "Registro" enviado, cuja Situação estiver com pendência ou erro.
 
'''Baixar:''' item de categoria tem como funcionalidade comunicar o Banco referente a Baixa do movimento em questão do Boleto Bancário. Utilizado para eventuais falhas operacionais, como registrado um movimento por engano, ou negociações diretamente com cliente a parte. Eliminando então também todo processo de geração do arquivo de Remessa Bancária com Comando de Remessa de Baixa e o processo de remeter ao Banco o arquivo, sendo realizado tudo online através desta opção.
 
'''Registrar Alteração:''' item de categoria tem como funcionalidade registrar uma alteração ocorrida referente ao "Vencimento" do Lançamento Financeiro.
Ao realizar alteração da Data de Vencimento do Lançamento Financeiro que está com "Situação Open Banking" igual "Registrado" e ocorrer alteração no Vencimento, o sistema emite uma mensagem possibilitando já o envio da alteração no momento ou mais tarde através desta opção de "Registrar Alteração".
 
'''Histórico:''' item de categoria tem como funcionalidade gravar todas movimentações realizadas relativo ao Open Banking. Registros, Baixas, Erros...


='''Layout e Detalhamento de Campos API'''=

==Registro de Boletos==
<center>

{| class="wikitable sortable"
|-
! Nº!!Campo JSON!!Descriçao do Banco!!Campo CIGAM!!Tabela!!Obrigatório!!Ex.Homolog!!Observações
|-
| 1 ||numeroConvenio||Número do convênio de Cobrança do Cliente||Número Controle||Portador||Obrigatório|| 3128557 || Em produção, informar o número do convênio de cobrança, com 7 dígitos.
|-
| 2 || numeroCarteira || Características do serviço de boleto bancário e como ele deve ser tratado pelo banco. || Carteira || Portador || Obrigatório || 17 || Em produção, informar o número da carteira de cobrança.
|-
| 3 || numero Variacao Carteira || Número da variação da carteira do convênio de cobrança. || Variação || Portador || Obrigatório || 35 || Em produção, informar o número da variação da carteira de cobrança.
|-
| 4 || codigoModalidade || Identifica a característica dos boletos dentro das modalidades de cobrança existentes no banco.
'''Domínios:'''
 
01 - SIMPLES
 
04 - VINCULADA
|| Tipo Serviço || Portador || Obrigatório || 1 ou 4 ||
|-
| 5 || dataEmissao || Data de emissão do boleto (formato "dd.mm.aaaaa"). || Data Documento || Boletos || Obrigatório || “15.12.2020” || Qualquer data, a partir da data atual, no formato “dd.mm.aaaa”.
|-
| 6 || dataVencimento || Data de vencimento do boleto. || Vencimento || Boletos || Obrigatório || “31.03.2021” || Qualquer data maior ou igual que a data de emissão, no formato “dd.mm.aaaa”.
|-
| 7 || valorOriginal || Valor do boleto no registro. || Saldo || LANCAM || Obrigatório || 123.45 || Valor do boleto no registro, em reais. Deve ser maior que a soma dos campos “valorDesconto” e “valorAbatimento”, se informados. Deve ser maior do que zero. No caso de emissão com valor equivocado, sugerimos cancelar o boleto e emitir um novo.
|-
| 8 || valorAbatimento || Valor do abatimento (reduz valor do boleto) expresso em moeda corrente. || 0 || 0 || Opcional || 12.34 || Valor de dedução do boleto. Se informado, deve ser maior que zero.
|-
| 9 || quantidade DiasProtesto || Quantos dias após a data de vencimento do boleto para iniciar o processo de cobrança através de protesto. (valor inteiro >= 0). || Protesto || Portador || Opcional || 0 ou maior que zero || Quantidade de dias após a data de vencimento do boleto para iniciar o processo de cobrança através de protesto. (3 a 5 dias úteis ou 6 a 29, 35, 40 ou 45 dias corridos)
|-
|10||indicador Aceite Titulo Vencido||Indicador de que o boleto pode ou não ser recebido após o vencimento. Se não informado, será assumida a informação de limite de recebimento parametrizada no convênio.|| X || X || Obrigatório || S ou N || Quando informado “S”, em conjunto com o campo “numeroDias LimiteRecebimento”, será definida a quantidade de dias corridos após o vencimento que este boleto ficará disponível para pagamento. Atenção: neste caso, se o campo “numeroDias LimiteRecebimento” ficar com valor zero, também será assumida a informação de limite de recebimento parametrizada no convênio.

Quando informado “N”, está definindo que o boleto NÃO permite pagamento em atraso.

Quando informado “N”, está definindo que o boleto NÃO permite pagamento em atraso.
|-
| 11 || numeroDias LimiteRecebimento || Número de dias limite para recebimento. Informar valor inteiro > 0. || X || X || Opcional || 0 ou maior que zero ||
|-
| 12 || codigoAceite || Código para identificar se o boleto de cobrança foi aceito (reconhecimento da dívida pelo Pagador).
'''Domínios:'''
 
A - ACEITE
 
N - NAO ACEITE
|| Aceite || Portador || Obrigatório || A ou N ||
|-
| 13 || codigoTipoTitulo || Código para identificar o tipo de boleto de cobrança. [[#Domínios: codigoTipoTitulo|Clique aqui]] para visualizar os Domínios. || Especie || Portador || Obrigatório || 2 ||
|-
| 14 || descricao TipoTitulo || Descrição do tipo de boleto. || 0 || 0 || Opcional || “DM” || Descrição do tipo de boleto. Se houver dúvidas com relação ao tipo, consultar as regras da Febraban.
|-
| 15 ||indicador Permissao RecebimentoParcial|| Código para identificação da autorização de pagamento parcial do boleto.
'''Domínios:'''
 
S - SIM
 
N - NÃO
|| X || X || Obrigatório || S ou N ||
|-
| 16 || numeroTitulo Beneficiario || Número de identificação do boleto (correspondente ao SEU NÚMERO), no formato STRING (Limitado a 15 caracteres - Letras Maiúsculas). || Serie || LANCAM || Opcional || “123456” ||
|-
| 17 || campo Utilizacao Beneficiario || Informações adicionais sobre o beneficiário. || Lançamento || LANCAM || Opcional || “UM TEXTO” || Pode ter até 30 caracteres, em maiúsculas.
|-
| 18 || numero TituloCliente || Número de identificação do boleto (correspondente ao NOSSO NÚMERO). || Nosso Número || Boletos || Obrigatório || “00031285570000030000” || Formato STRING, com 20 dígitos, que deverá ser formatado da seguinte forma: “000” + (número do convênio com 7 dígitos) + (10 algarismos - se necessário, completar com zeros à esquerda).
|-
| 19 || mensagem Bloqueto Ocorrencia || Mensagem definida pelo beneficiário para ser impressa no boleto (Limitado a 30 caracteres) || Texto 4 || Boletos || Opcional || “Outro texto” || Mensagem definida pelo beneficiário para ser impressa no boleto. Pode ter até 165 caracteres, sendo que cada 55 caracteres equivalem a uma linha de mensagem. Atenção: não são permitidos caracteres de escape ( \r ou \n ).
|-
| 20 || desconto || Define a ausência ou a forma como será concedido o desconto para o Título de Cobrança. || X || X || Opcional || ||
|-
| 20.1 || tipo || Define como o desconto será concedido.
'''Domínio:'''
0 - Sem desconto
 
1 - Valor fixo até a data informada
 
2 - percentual até a data informada.
|| Valor Desconto || LANCAM || Opcional || 0 ou 1 ou 2 ||
|-
| 20.2 || dataExpiracao || Define a data de expiração do desconto (somente se tipo > 0), no formato “dd.mm.aaaa”. || Vencimento* || LANCAM || Opcional || “30.01.2021” ||
|-
| 20.3 || porcentagem || Define a porcentagem do desconto (somente se tipo = 2). || X || X || Opcional || 5.00 ||
|-
| 20.4 || valor || Define o valor do desconto (somente se tipo = 1). || Valor Desconto* || LANCAM || Opcional || 12.34 ||
|-
| 21 || segundoDesconto || Define a forma como será concedido um segundo desconto para o boleto. Só pode ser usado se for definido um primeiro desconto. O tipo do segundo desconto será igual ao do primeiro desconto. || X || X || Opcional || ||
|-
| 21.1 || dataExpiracao || Define a data de expiração do desconto, no formato “dd.mm.aaaa”. Deve ser posterior a data de expiração do primeiro desconto. || X || X || Opcional || “10.02.2021” ||
|-
| 21.2 || porcentagem || Define a porcentagem do desconto (somente se o tipo = 2). || X || X || Opcional || 5.00 ||
|-
| 21.3 || valor || Define o valor do desconto (somente se o tipo = 1). || X || X || Opcional || 12.34 ||
|-
| 22 || terceiroDesconto || Define a forma como será concedido um terceiro desconto para o boleto. Só pode ser usado se for definido um segundo desconto. O tipo do terceiro desconto será igual ao do primeiro desconto. || X || X || Opcional || ||
|-
| 22.1 || dataExpiracao || Define a data de expiração do desconto, no formato “dd.mm.aaaa”. Deve ser posterior a data de expiração do segundo desconto. || X || X || Opcional || 20.02.2021” ||
|-
| 22.2 || porcentagem || Define a porcentagem do desconto (somente se o tipo = 2). || X || X || Opcional || 5.00 ||
|-
| 22.3 || valor || Define o valor do desconto (somente se o tipo = 1). || X || X || Opcional || 12.34 ||
|-
| 23 || jurosMora || Código utilizado pela FEBRABAN para identificar o tipo de taxa de juros. [[#Domínios: jurosMora|Clique aqui]] para visualizar os Domínios.
|| X || X || Opcional || || Se informado ‘0’ (zero) ou ‘3’ (três), os campos “PERCENTUAL DE JUROS DO TÍTULO” e “VALOR DO JUROS DO TÍTULO” não devem ser informados ou ser informados igual a ‘0’ (zero).
O valor de juros e multa incidem sobre o valor atual do boleto (valor do boleto - valor de abatimento).
|-
| 23.1 || tipo || Código utilizado pela FEBRABAN para identificar o tipo da taxa de juros. [[#Domínios: tipo (jurosMora)|Clique aqui]] para visualizar os Domínios.
|| Juros Dia || LANCAN || Opcional || 0 ou 1 ou 2 ou 3 ||
|-
| 23.2 || porcentagem || Define a taxa mensal de juros (somente informar se tipo = 2). A taxa incide sobre o valor atual do boleto (valorOriginal - valorAbatimento) || X || X || Opcional || 1.00 ||
|-
| 23.3 || valor || Define o valor fixo por dia de atraso (somente informar se tipo = 1). || Juros Dia || LANCAM || Opcional || 0.33 ||
|-
| 24 || multa || Define a forma que será cobrada (ou não) a multa por atraso no pagamento. || X || X || Opcional || ||
|-
| 24.1 || tipo || Código utilizado pela FEBRABAN para identificar o tipo da multa. [[#Domínios: tipo (multa)|Clique aqui]] para visualizar os Domínios.
|| Valor Multa || LANCAM || Opcional || 0 ou 1 ou 2 ||
|-
| 24.2 || data || Define a data a partir da qual será cobrada a multa (somente informar se tipo = 1 ou 2). Deve ser posterior a data de vencimento do boleto. || Tolerância Multa || LANCAM || Opcional || “01.04.2021” ||
|-
| 24.3 || porcentagem || Define a porcentagem da multa (somente informar se tipo = 2). A porcentagem incide sobre o valor atual do boleto (valorOriginal - valorAbatimento). || Valor || LANCAM || Opcional || 2.00 ||
|-
| 24.4 || valor || Define o valor da multa (somente informar se tipo = 1). || Valor Multa || LANCAM || Opcional || 10.00 ||
|-
| 25 || pagador || Identifica o pagador do boleto. || X || X || Obrigatório || ||
|-
| 25.1 || tipoInscricao || Define o tipo do inscrição do pagador.
'''Domínio:'''
 
1 - Pessoa física
 
2 - Pessoa Jurídica.
|| X || X || Obrigatório || 1 ou 2 ||
|-
| 25.2 || numeroInscricao || Define o número de inscrição do pagador; se pessoa física, CPF; se pessoa jurídica, CNPJ. Numérico, deve ser preenchido sem ponto, hífen, barra, e sem zeros à esquerda. || X || X || Obrigatório || 97965940132 (PF) ou 74910037000193 (PJ) ||
|-
| 25.3 || nome || Identifica o nome do pagador. Pode ter até 30 caracteres. || Pessoa || Empresa || Obrigatório || “Odorico Paraguassu” ||
|-
| 25.4 || endereco || Identifica o endereço do pagador. Pode ter até 30 caracteres. || X || X || Obrigatório || “Avenida Dias Gomes 1970” ||
|-
| 25.5 || cep || Identifica o CEP do pagador. Numérico, deve ser preenchido sem ponto ou hífen, e sem zeros à esquerda. || CEP || Empresa || Obrigatório || 77458000 ||
|-
| 25.6 || cidade || Identifica a cidade do pagador. Pode ter até 30 caracteres. || Municipio || Empresa || Obrigatório || “Sucupira” ||
|-
| 25.7 || bairro || Identifica o bairro do pagador. Pode ter até 30 caracteres. || Bairro || Empresa || Obrigatório || “Centro” ||
|-
| 25.8 || uf || Identifica o estado (UF) do pagador. Deve ter 2 caracteres e ser um estado válido. || UF || Empresa || Obrigatório || “TO” ||
|-
| 25.9 || telefone || Define o número de telefone do pagador. Pode ter até 30 caracteres. || Fone || Empresa || Opcional || “63987654321” ||
|-
| 26 || beneficiarioFinal || Identifica o beneficiário final (antigo avalista) do boleto, se houver. || X || X || Opcional || ||
|-
| 26.1 || tipoInscricao || Define o tipo do inscrição do beneficiário final (antigo avalista).
'''Domínio:'''
 
1 - Pessoa física
 
2 - Pessoa Jurídica.
|| X || X || Opcional || 1 ou 2 ||
|-
| 26.2 || numeroInscricao || Define o número de inscrição do beneficiário final (antigo avalista); se pessoa física, CPF; se pessoa jurídica, CNPJ. Numérico, deve ser preenchido sem ponto, hífen, barra, e sem zeros à esquerda. || X || X || Opcional || 66779051870 (PF) ou 98959112000179 (PJ) ||
|-
| 26.3 || nome || Identifica o nome do beneficiário final (antigo avalista). Pode ter até 30 caracteres. || X || X || Opcional || “Dirceu Borboleta” ||
|-
| 27 || quantidadeDiasNegativacao || Quantidade de dias, após o vencimento do Boleto, que o Boleto será Negativado || Protesto || Portador || Opcional || 0 ou maior que zero ||
|-
| 28 || orgaoNegativador || Código do órgão negativador selecionado.
'''Domínio:'''
 
10 - SERASA
 
11 - QUOD.
|| X || X || Opcional || 10 ou 11 ||
|-
| 29 || indicadorPix || Código para informar se o boleto terá um QRCode Pix atrelado. Se não informado, ou utilizado caractere inválido, o sistema assumirá ‘N’.
'''Domínio:'''
 
S - QRCode dinâmico
 
N - sem Pix.
|| X || X || Opcional || S ou N || Atenção: conforme regulamentação do Bacen, é permitido somente para modalidade de cobrança simples (ver codigoModalidade).
|-
|}

</center>

==='''Domínios: codigoTipoTitulo'''===

• 1 - CHEQUE
 
• 2 - DUPLICATA MERCANTIL
 
• 3- DUPLICATA MTIL POR INDICACAO
 
• 4 - DUPLICATA DE SERVICO
 
• 5 - DUPLICATA DE SRVC P/INDICACAO
 
• 6 - DUPLICATA RURAL
 
• 7 - LETRA DE CAMBIO
 
• 8 - NOTA DE CREDITO COMERCIAL
 
• 9 - NOTA DE CREDITO A EXPORTACAO
 
• 10 - NOTA DE CREDITO INDULTRIAL
 
• 11 - NOTA DE CREDITO RURAL
 
• 12 - NOTA PROMISSORIA
 
• 13 - NOTA PROMISSORIA RURAL
 
• 14 - TRIPLICATA MERCANTIL
 
• 15 - TRIPLICATA DE SERVICO
 
• 16 - NOTA DE SEGURO
 
• 17 - RECIBO
 
• 18 - FATURA
 
• 19 - NOTA DE DEBITO
 
• 20 - APOLICE DE SEGURO
 
• 21- MENSALIDADE ESCOLAR
 
• 22 - PARCELA DE CONSORCIO
 
• 23 - DIVIDA ATIVA DA UNIAO
 
• 24- DIVIDA ATIVA DE ESTADO
 
• 25 - DIVIDA ATIVA DE MUNICIPIO
 
• 31 - CARTAO DE CREDITO
 
• 32 - BOLETO PROPOSTA
 
• 33 - BOLETO APORTE
 
• 99 - OUTROS.
 

==='''Domínios: jurosMora'''===

• 0 - DISPENSAR
 
• 1 - VALOR DIA ATRASO
 
• 2 - TAXA MENSAL
 
• 3 - ISENTO
 

==='''Domínios: tipo (jurosMora)'''===

• 0 - Dispensar
 
• 1 - Valor fixo por dia de atraso
 
• 2 - Taxa mensal
 
• 3 - Isento
 

==='''Domínios: tipo (multa)'''===

• 0 - Dispensar
 
• 1 - Valor fixo (a partir da data estipulada no registro)
 
• 2 - Percentual (a partir da data estipulada no registro).
 

==Retorno de Boletos==

<center>

{| class="wikitable"
|-
! Nº !! Campo JSON !! Descriçao do Banco !! Campo CIGAM !! Tabela !! Obrigatório !! Exemplo para HOMOLOGAÇÃO !! Observações
|-
| 1 || gw-app-key || É a chave de acesso do aplicativo do desenvolvedor utilizada em produção, obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo. || 0 || 0 || Obrigatório || 0021239456d80136 bebf005056891bed || >>REVISAR<<
|-
| 2 || indicadorSituacao || Situação do boleto.
'''Domínios:'''
 
A - Em ser
 
B - Baixados/ Protestados/ Liquidados
|| X || X || Obrigatório || A ou B || Campo obrigatoriamente MAIÚSCULO.
|-
| 3 || agenciaBeneficiario || Indica o número da agência cadastrada como beneficiária do convênio, sem o dígito verificador e sem zeros a esquerda. || Agência || Portador || Obrigatório || 452 ||
|-
| 4 || contaBeneficiario || Indica o número da conta cadastrada como beneficiária do convênio, sem o dígito verificador e sem zeros a esquerda. || Conta Número || Portador || Obrigatório || 123873 ||
|-
| 5 || carteiraConvenio || Indica o número da carteira do convênio de cobrança. || Carteira || Portador || Obrigatório || 17 ||
|-
| 6 || variacaoCarteiraConvenio || Indica o número da variação do convênio de cobrança. || Variação || Portador || Opcional || 35 ||
|-
| 7 || modalidadeCobranca || Indica a modalidade de cobrança na qual o boleto está cadastrado no BB.
'''Domínio''':
 
1 - Simples
 
4 - Vinculada.
|| Tipo Serviço || Portador || Opcional || 1 ou 4 ||
|-
| 8 || cnpjPagador || Indica o CNPJ do pagador a ser pesquisado, sem o dígito e sem zeros a esquerda. || CNPJ/CPF || Cobrança || Opcional || 543483490001 || Informar em conjunto com digitoCnpjPagador.
|-
| 9 || digitoCNPJPagador || Indica o dígito do CNPJ do pagador a ser pesquisado, sem zeros a esquerda.
|| X || X || Opcional || 48 || Informar em conjunto com cnpjPagador.
|-
| 10 || cpfPagador || Indica o CPF do pagador a ser pesquisado, sem o dígito e sem zeros a esquerda.
|| CNPJ/CPF || Cobrança || Opcional || 979659401 || Informar em conjunto com digitoCpfPagador.
|-
| 11 || digitoCPFPagador || Indica o dígito do CPF do pagador a ser pesquisado, sem zeros a esquerda.
|| X || X || Opcional || 32 || Informar em conjunto com cpfPagador.
|-
| 12 || dataInicioVencimento || Data inicial de vencimento que delimita o período da consulta, formato dd.mm.aaaa. Se informada data posterior a atual, o campo dataFimVencimento deve ser preenchido com data posterior ou igual a dataInicioVencimento. Se informada data anterior ou igual a data atual e o campo dataFimVencimento não for informado, o sistema assume a data atual como dataFimVencimento.|| X || X || Opcional || 01.01.2021 ||
|-
| 13 || dataFimVencimento || Data final de vencimento que delimita o período da consulta, formato dd.mm.aaaa. Se informada, deve ser uma data posterior ou igual a dataInicioVencimento. || X || X || Opcional || 30.01.2021 ||
|-
| 14 || dataInicioRegistro || Data inicial de registro que delimita o período da consulta, formato dd.mm.aaaa. Deve ser anterior ou igual a data atual. || X || X || Opcional || 01.11.2020 ||
|-
| 15 || dataFimRegistro || Data fim de registro que delimita o período da consulta, formato dd.mm.aaaa.
|| X || X || Opcional || 30.11.2020 || Se informada, deve ser posterior ou igual a dataInicioRegistro, e igual ou anterior à data atual. Se não informada, o sistema assume a data atual.
|-
| 16 || dataInicioMovimento || Data início de movimento que delimita o período de consulta de boletos baixados, liquidados ou protestados, formato dd.mm.aaaa. || X || X || Opcional || 01.12.2020 || Deve ser anterior ou igual à data atual.
|-
| 17 || dataFimMovimento || Data fim de movimento que delimita o período de consulta de boletos baixados, liquidados ou protestados, formato dd.mm.aaaa. || X || X || Opcional || 15.12.2020 || Se informada, deve ser posterior ou igual a dataInicioMovimento, e igual ou anterior à data atual. Se não informada, o sistema assume a data atual.
|-
| 18 || codigoEstadoTituloCobranca || Código da situação atual do boleto. [[#Domínios: codigoEstadoTituloCobranca|Clique aqui]] para visualizar os Domínios. || X || X || Opcional || entre 1 e 21 ||
|-
| 19 || boletoVencido || Define se a pesquisa trará apenas boletos vencidos ou não. || X || X || Opcional || S ou N || Sempre MAIÚSCULA.
|-
| 20 || indice || Representa o índice da listagem pelo qual sua pesquisa se iniciará, podendo retornar até 300 registros por chamada. O default é 0, o que trará os resultados de 0 a 299 (se houver). || X || X || Opcional || qualquer inteiro || Quando o resultado da pesquisa tiver mais que 300 registros, na resposta, o campo indicadorContinuidade retornará com “S”. Recomendamos utilizar o valor do campo proximoIndice (informado na resposta), no campo indice da próxima chamada, para retornar com os próximos registros.
|-
|}
</center>


==='''Domínios: codigoEstadoTituloCobranca'''===

1 - NORMAL
 
2 - MOVIMENTO CARTORIO
 
3 - EM CARTORIO
 
4 - TITULO COM OCORRENCIA DE CARTORIO
 
5 - PROTESTADO ELETRONICO
 
6 - LIQUIDADO
 
7 - BAIXADO
 
8 - TITULO COM PENDENCIA DE CARTORIO
 
9 - TITULO PROTESTADO MANUAL
 
10 - TITULO BAIXADO/PAGO EM CARTORIO
 
11 - TITULO LIQUIDADO/PROTESTADO
 
12 - TITULO LIQUID/PGCRTO
 
13 - TITULO PROTESTADO AGUARDANDO BAIXA
 
14 - TITULO EM LIQUIDACAO
 
15 - TITULO AGENDADO BB
 
16 - TITULO CREDITADO
 
17 - PAGO EM CHEQUE - AGUARD.LIQUIDACAO
 
18 - PAGO PARCIALMENTE
 
19 - PAGO PARCIALMENTE CREDITADO
 
21 - TITULO AGENDADO OUTROS BANCOS

==Alteração de Boletos==

<center>

{| class="wikitable"
|-
! Nº !! Campo JSON !! Descriçao do Banco !! Campo CIGAM !! Tabela !! Obrigatório !! Exemplo para HOMOLOGAÇÃO !! Observações
|-
| 1 || numeroConvenio || Identifica o número do convênio de cobrança. || Número Controle || Portador || Obrigatório || 3128557 ||
|-
| 2 || indicador Cancelar Abatimento || Indica a intenção (ou não) de cancelar o abatimento concedido a um boleto. || X || X || Obrigatório || S ou N ||
|-
| 3 || alteracaoAbatimento || X || X || X || Parcial || ||
|-
| 3.1 || novoValorAbatimento || Novo valor do abatimento (reduz valor do boleto) expresso em moeda corrente. || X || X || Parcial || 2.00 ||
|-
| 4 || indicador Alterar DataDesconto || Indica a intenção (ou não) de alterar a data de desconto(s) concedido(s) em um boleto. || X || X || Obrigatório || S ou N || Se sim, deve ser usado em conjunto com o campo alteracaoDataDesconto.
|-
| 5 || alteracao DataDesconto || Nova data limite do Primeiro Desconto || X || X || Parcial || || Observar as regras para datas de desconto no campo desconto da Geração de Boletos.
|-
| 5.1 || novaData LimitePrimeiro Desconto || Nova data limite do Primeiro Desconto || X || X || Parcial || “01.01.2021” ||
|-
| 5.2 || novaData Limite SegundoDesconto || Nova data limite do Segundo Desconto || X || X || Parcial || “10.01.2021” ||
|-
| 5.3 || novaData LimiteTerceiro Desconto || Nova data limite do Terceiro Desconto || X || X || Parcial || “20.01.2021” ||
|-
| 6 || indicador Alterar Desconto || Indica a intenção (ou não) de alterar o desconto concedido em um boleto. || X || X || Obrigatório || S ou N || Se sim, deve ser usado em conjunto com o campo alteracaoDesconto.
|-
| 7 || alteracaoDesconto || || X || X || Parcial || || Observar as instruções sobre o campo desconto na Geração de Boletos.
|-
| 8 || indicador Alterar EnderecoPagador || Indica a intenção (ou não) de alterar o endereço do pagador no boleto. Se sim, deve ser usado em conjunto com o campo alteracaoEndereco. || X || X || Obrigatório || S ou N || '''Atenção:''' a alteração do endereço não implica em nova geração ou envio de boleto. Isso é responsabilidade do beneficiário.
|-
| 9 || alteracaoEndereco || || X || X || Parcial || || Observar as instruções sobre o campo pagador na Geração de Boletos.
|-
| 10 || indicador AlterarPrazo BoletoVencido || Indica a intenção (ou não) de alterar o prazo para recebimento de boleto vencido. || X || X || Obrigatório || S ou N || Se sim, deve ser usado em conjunto com o campo alteracaoPrazo.
|-
| 11 || alteracaoPrazo || || X || X || Parcial || ||
|-
| 11.1 || quantidade DiasAceite || Define a quantidade e dias corridos após o vencimento em que o boleto poderá ser recebido. Equivalente ao campo numeroDiasLimiteRecebimento na Geração de Boletos. || X || X || Parcial || 0 ou maior que zero ||
|-
| 12 || indicador AlterarSeuNumero || Indica a intenção (ou não) de alterar o campo numeroTituloBeneficiario (equivalente ao SEU NÚMERO) no boleto. || X || X || Obrigatório || S ou N || Se sim, deve ser usado em conjunto com o campo alteracaoSeuNumero.
|-
| 13 || alteracaoSeuNumero || || X || X || Parcial || || Observar as instruções sobre o campo numeroTituloBeneficiario na Geração de Boletos.
|-
| 14 || indicador AtribuirDesconto || Indica a intenção (ou não) de atribuir desconto ao boleto. || X || X || Obrigatório || S ou N || Se sim, deve ser usado em conjunto com o campo desconto.
|-
| 15 || desconto || || X || X || Parcial || || Observar as instruções sobre o campo desconto na Geração de Boletos. Lembrete: o tipo definido para o primeiro desconto será replicado no segundo e no terceiro desconto (se informados).
|-
| 16 || indicador Cancelar Protesto || Indica a intenção (ou não) de cancelar uma instrução de protesto enviada ao BB na mesma data ou que ainda não tenha sido processada pelo BB.
'''Domínios:'''
 
S - Sim, desejo alterar
 
N - Não, não desejo alterar
|| X || X || Obrigatório || S ou N ||
|-
| 17 || indicadorCobrarJuros || Indica a intenção (ou não) de cobrar juros no boleto.
'''Domínios:'''
 
S - Sim, desejo alterar
 
N - Não, não desejo alterar
|| X || X || Obrigatório || S ou N || Se sim, deve ser usado em conjunto com o campo juros.
|-
| 18 || juros || || || || Parcial || || Observar as instruções sobre o campo juros na Geração de Boletos.
|-
| 19 || indicadorCobrarMulta || Indica a intenção (ou não) de cobrar multa no boleto.
'''Domínios:'''
 
S - Sim, desejo alterar
 
N - Não, não desejo alterar
|| X || X || Obrigatório || S ou N || Se sim, deve ser usado em conjunto com o campo multa.
|-
| 20 || multa || || X || X || Parcial || || Observar as instruções sobre o campo multa na Geração de Boletos.
|-
| 21 || indicador Dispensar Juros || Indica a intenção (ou não) de dispensar os juros sobre o boleto.
'''Domínios:'''
 
S - Sim, desejo alterar
 
N - Não, não desejo alterar
|| X || X || Obrigatório || S ou N ||
|-
| 22 || indicador Dispensar Multa || Indica a intenção (ou não) de dispensar a multa sobre o boleto.
'''Domínios:'''
 
S - Sim, desejo alterar
 
N - Não, não desejo alterar
|| X || X || Obrigatório || S ou N ||
|-
| 23 || indicadorIncluirAbatimento || Indica a intenção (ou não) de incluir abatimento em um boleto.
'''Domínios:'''
 
S - Sim, desejo alterar
 
N - Não, não desejo alterar
|| X || X || Obrigatório || S ou N || Se sim, deve ser usado em conjunto com o campo abatimento.
|-
| 24 || abatimento || || X || X || Parcial || ||
|-
| 24.1 || valorAbatimento || Define o valor a ser concedido como abatimento. || X || X || Parcial || 10.00 ||
|-
| 25 || indicadorNegativar || Indica a intenção (ou não) de negativar ou cancelar a negativação do boleto.
'''Domínios:'''
 
S - Sim, desejo alterar
 
N - Não, não desejo alterar
|| X || X || Obrigatório || S ou N || Se sim, deve ser usado em conjunto com o campo negativacao. Não confundir com protesto.
|-
| 26 || negativacao || || X || X || Parcial || ||
|-
| 26.1 || quantidade DiasNegativacao* || Quantidade de dias, após o vencimento do boleto, em que o boleto será negativado. || Protesto || Portador || Parcial || qualquer inteiro ||
|-
| 26.2 || tipoNegativacao || Código para identificação do tipo de negativação que deverá ser aplicada ao boleto.
'''Domínio:'''
 
1 - incluir
 
2 - alterar prazo
 
3 - cancelar
 
4 - excluir
|| X || X || Parcial || 1 ou 2 ou 3 ou 4 ||
|-
| 26.3 || indicador Nova DataVencimento || Indica a intenção (ou não) de atribuir nova data de vencimento ao boleto. || X || X || Obrigatório || S ou N || Se sim, deve ser usado em conjunto com o campo alteracaoData.
|-
| 27 || alteracaoData || || X || X || Parcial || ||
|-
| 27.1 || novaDataVencimento || Define a nova data de vencimento, formato “dd.mm.aaaa”. || Vencimento || LANCAM || Parcial || “30.04.2021" ||
|-
| 28 || indicadorProtestar || Indica a intenção (ou não) de protestar o boleto. || X || X || Obrigatório || S ou N || Não confundir com negativação.
|-
| 28.1 || indicador SustacaoProtesto || Indica a intenção (ou não) de sustar/cancelar um comando de protesto que já tenha sido processado pelo BB. || X || X || Obrigatório || S ou N ||
|-
| 29 || indicador SustacaoProtesto || Indica a intenção (ou não) de sustar/cancelar um comando de protesto que já tenha sido processado pelo BB. || X || X || Obrigatório || S ou N ||
|}
</center>


='''Como realizar a criação de Lançamentos utilizando a funcionalidade Open Banking?'''=
 
Para a criação de Lançamentos Financeiros acessar o caminho de Menu:
 

'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 

Acessar o botão “Criar” e informar os dados necessários para a criação do Lançamento Financeiro a Receber utilizando o Portador parametrizado para Open Banking.
 
 
'''1- Etapa criação do Lançamento:'''
 
 
<center>'''Criação do Lançamento Financeiro a Receber'''
[[Arquivo:Create Lanc Open Banking.png|750x500px|semmoldura|nenhum|Criação do Lançamento Financeiro]]
 
 

'''2- Etapa Impressão do Boleto Bancário do Lançamento Financeiro:'''
 
Nesta etapa pode ser realizado a impressão do Boleto Bancário diretamente pelo próprio Lançamento Financeiro ou através da rotina de Emissão em lote "Emissão de Boletos Personalizados":
 
 
<center>'''Impressão do Boleto Bancário do Lançamento Financeiro'''
[[Arquivo:Imprimir Boleto Lanc.png|750x500px|semmoldura|nenhum|Impressão Boleto Bancário]]
 
 

'''3- Etapa do Registro do Boleto Open Banking:'''
 
Nesta etapa pode ser realizado o "Registro" do Boleto diretamente pelo próprio Lançamento Financeiro ou através da rotina de Emissão em lote "Emissão de Boletos Personalizados":
Basta acessar a Categoria "Open Banking" e selecionar o Item de Categoria "Registrar".
Sistema irá realizar a comunicação através das parametrizações realizadas das Urls e Tokens de acesso e listará a situação do Registro do Boleto Bancário através do Relatório.
 
 
<center>'''Registrar Boleto Open Banking através Lançamento Financeiro'''
[[Arquivo:Boleto Impresso Registrar OP.png|750x500px|semmoldura|nenhum|Registro Boleto Open Banking]]
 
 
<center>'''Relatório Remessa Bancária OnLine'''
[[Arquivo:Relat Registro Open Banking.png|750x500px|semmoldura|nenhum|Relatório Remessa Bancária Online]]
 
 
Após o registro automaticamente o sistema marca as opções de:
 
- Remessa Enviada
 
- Códigos de Barras Lido
 
 
<center>'''Boleto Bancário Registrado'''
[[Arquivo:Lanc Registrado Validar Historico.png|750x500px|semmoldura|nenhum|Lanc_Registrado_Validar_Historico]]
 
 
Para verificar todas as movimentações realizada sobre Open Banking, elas estão sendo gravadas no Item de Categoria "Histórico" que fica na Categoria "Open Banking".
Ao selecionar o Item de Categoria "Histórico" deve listar o Registro do Boleto Bancário.
 
 
<center>'''Item de Categoria Histórico de Movimentos Open Banking'''
[[Arquivo:Item Categoria Historico.png|750x500px|semmoldura|nenhum|Item_Categoria_Histórico]]
 
 

='''Como realizar o Envio em Lote Open Banking através da rotina Remessa de Cobrança Open Banking?'''=

Assim como é possível realizar o Envio do Registro do Boleto Bancário através do próprio Lançamento Financeiro, existe a possibilidade de realizar esse processo em Lote, quando se tratar de vários registros a serem enviados.
Através do Menu:
 
 
'''Menu: Finanças > Gestão Financeira > Rotinas > EDI> Transmite > Remessa Cobranças Bancárias > Remessa de Cobrança Open Banking'''
 
 
<center>'''Remessa de Cobrança Open Banking'''
[[Arquivo:Remessa_de_Cobranca_Open_Banking_BB3.png|750x500px|semmoldura|nenhum|Remessa_de_Cobranca_Open_Banking]]
 
 
Esta rotina tem um conceito muito simples em relação aos filtros, foram disponibilizados campos essências que permitem ter uma rastreabilidade dos movimentos.

'''Unidade de Negócio:''' informe a Unidade de Negócio desejada para realizar o filtro para busca dos movimentos.
 
'''Data:''' informe a Data desejada para realizar o filtro para busca dos movimentos.
 
'''Vencimento:''' informe o período de Vencimento desejado para realizar o filtro para busca dos movimentos.
 
'''Lançamento:''' informe a faixa de Lançamentos desejada para realizar o filtro para busca dos movimentos.
 
'''Tipo de Pagamento:''' informe o Tipo de Pagamento desejado para realizar o filtro para busca dos movimentos.
 
'''Série:''' informe a Série desejada para realizar o filtro para busca dos movimentos.
 
'''Nota Fiscal:''' informe a faixa de Nota Fiscal desejada para realizar o filtro para busca dos movimentos.
 
'''Conta Financeira:''' informe a Conta Financeira desejada para realizar o filtro para busca dos movimentos.
 
'''Empresa:''' informe a faixa de Empresa desejada para realizar o filtro para busca dos movimentos.
 
'''Cobrança:''' informe a faixa de Empresa de Cobrança desejada para realizar o filtro para busca dos movimentos.
 
 
Após informado os filtros e confirmado a operação da rotina o sistema gera um relatório com a listagem dos movimentos.
Na coluna "Registro", será listado se houve a confirmação ou ocorreu algum erro.
 
 
<center>'''Relatório Remessa de Cobrança Open Banking'''
[[Arquivo:Relat Remessa Bancaria Open Banking.png|750x500px|semmoldura|nenhum|Relat_Remessa_Bancaria_Open_Banking]]
 
 

='''Como realizar o Retorno de Cobrança Open Banking?'''=

Esta rotina tem como funcionalidade realizar a consulta dos registros enviados para o Banco não só através do Open Banking como também títulos enviados pela rotina de Remessa Bancárias e efetuar as liquidações dos registros que já foram pagos ou baixados. Porém as buscas para títulos não gerados pelo CIGAM e o retorno do registro de baixa estão disponíveis apenas para Versão 2 da API do Open Banking.
 
'''IMPORTANTE:''' caso o retorno apresente o erro:(500) Erro Interno do Servidor é possível que o Cadastro do Portador esteja com algum parâmetro incorreto, como por exemplo um caractere especial na Conta ou na Agência.
 
'''Regras de Busca do Sistema para localizar os títulos a partir da Versão API = v2'''
 
1- O sistema tenta localizar os títulos pelo Número do Lançamento;
 
2- Caso os títulos tenham sido gerados pelo CIGAM irá localizar pelo '''Nosso Número''', avaliando então a tabela '''GFBOLETOS''' pela coluna '''NOSSO_NRO'''.
 
3- Caso os títulos tenham sido gerados por outro sistema irá localizar pelo '''Nosso Número''', avaliando então a tabela '''GFLAUXIL''' pela coluna '''CODIGO_BARRAS'''.
 
'''Como faço para atualizar com a nova Versão API = v2?'''
 
Simples acesse a opção do índice do Manual:
 
'''Quais são as novidades após atualização para Versão 2 do Open Banking?'''
 
 
'''Menu: Finanças > Gestão Financeira > Rotinas > EDI> Recebe > Retorno Cobranças Bancárias > Retorno de Cobrança Open Banking'''
 
<center>'''Rotina Retorno de Cobrança Open Banking'''
[[Arquivo:Retorno_Boletos_Open_Banking_V.png|750x500px|semmoldura|nenhum|Retorno_Boletos_Open_Banking]]
 
 

'''Empresa:''' possibilita realizar o filtro por Empresa, consultando todos os registros da Empresa informada.
 
'''Unidade de Negócio:''' possibilita realizar o filtro por Unidade de Negócio.
 
'''Lançamento:''' possibilita realizar filtro por faixa de Lançamento.
 
'''Vencimento:''' possibilita realizar filtro por faixa de Vencimento.
 
'''Movimento/Registro:''' possibilita realizar filtro por faixa do período do Movimento ou do Registro. Data que delimita o período da Consulta de Boletos liquidados, Baixados ou Protestados.
 
'''Situação do Boleto:''' filtro com duas opções:
 
'''A - Em ser (abertos):''' listam os registros que se encontram com Status "Abertos" no Banco.
 
'''B - Baixadas/Protestados/Liquidados:''' listam os registros que se encontram com Status "Baixados/Protestados/Liquidados".
 
'''Cód. Situação Atual Boleto:''' listagem para realizar filtro através do Código da Situação do Boleto no Banco conforme layout.
 
<center>'''Rotina Rotina Retorno de Cobrança Open Banking guia Parâmetros'''
[[Arquivo:Retorno_Boletos_Open_Banking_V3.png|750x500px|semmoldura|nenhum|Retorno_Boletos_Open_Banking_2]]
 
 

'''Tipo de Retorno:''' há 3 opções para o retorno.
 
'''* Listagem:''' quando selecionado essa opção, ao executar a rotina, apenas listará o status do registro do Boleto Bancário junto ao Banco.
 
'''* Retorno:''' quando selecionado essa opção, ao executar a rotina, o sistema irá executar o retorno dos registros confirmados e já irá realizar a liquidação caso haja registros pagos, sem executar a listagem.
 
'''* Ambos:''' quando selecionado essa opção irá executar tanto a opção de "Listagem" quanto a opção de "Retorno".
 
'''Portador para Liquidação:''' este campo tem como finalidade informar qual será o Portador utilizado para os registros que serão liquidados. Caso não seja informado nenhum Portador neste campo, será utilizado o Portador de Retorno parametrizado para Open Banking.
 
'''Portador Carteira de Desconto:''' este campo é para informar o Portador de Carteira de Desconto, para Contratos Bancários, para os registros que possuem Duplicatas negociadas com o Banco.
 
'''Histórico de Liquidação:''' campo para informar o Histórico que será utilizado para os registros que serão liquidados.
 
'''Não contabilizar Juros e Descontos nas liquidações da Carteira Descontada:''' esta opção tem como finalidade não contabilizar os Juros e Descontos para as liquidações de Carteira Descontada, ou seja, caso possua duplicatas com o Banco negociada e o registro possuir Juros, Desconto, possibilita o usuário não contabiliza-los marcando esta opção.
 
'''Não gerar lançamentos de tarifa de cobrança:''' esta opção tem como finalidade quando selecionada não gerar a liquidação do valor da tarifa de cobrança.
 
'''Data para Liquidação:''' quando zerado a Data será habilitado para selecionar as opções. Esta opção tem como finalidade realizar a busca para liquidação de duas formas:
 
- '''Ocorrência:''' os títulos serão liquidados com a Data de Ocorrência do Título (Data Recebimento do Título) ao qual foi processado no Banco.
 
- '''Crédito:''' os títulos serão liquidados com a Data de Crédito (Data de Crédito Liquidação) em que foi processado no Banco.
Ou seja, se o título foi pago por exemplo na Data 31/08/2020 o banco irá processar esse pagamento e o retorno será creditado na conta no dia 01/09/2020, porém o pagamento foi realizado no dia anterior e creditado no dia posterior.
 
A Data para Liquidação é trazida por padrão a Data atual como sugestão, sendo possível altera-lá ou quando zerada habilita para buscar automaticamente a Data de Ocorrência ou Crédito.
 
 
'''Modelo de Relatório:''' o modelo de relatório utilizado pode ser obtido através do caminho padrão.
Nome do Modelo: (RF00071_remessas).
<center>'''Relatório Retorno Bancário Online'''
[[Arquivo:Relat Retorno Bancario Online.png|750x500px|semmoldura|nenhum|Relat_Retorno_Bancario_Online]]
 
 
Ao acessar o Lançamento Financeiro após o Retorno de Cobrança Open Banking, realizando as liquidações o sistema altera o status do Lançamento Financeiro.
 
'''Menu: Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 
<center>'''Lançamento Financeiro Liquidado através da Rotina de Cobrança Open Banking'''
[[Arquivo:Lançamento Liquidado Retorno.png|750x500px|nenhum|Lançamento_Liquidado_Retorno.png]]
 

='''Como realizar a Alteração de Vencimento do Lançamento já Registrado Open Banking e reenviá-lo novamente?'''=

Irá surgir a necessidade de realizar a alteração do Vencimento do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?
 
'''Dado que''' já temos um Lançamento Financeiro já Registrado Open Banking, basta acessar o Lançamento Financeiro desejado através do caminho do Menu:
 
'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 
Acessar o Lançamento Financeiro em modo Modificar e alterar o campo "Venc.Original", automaticamente após alteração do Vencimento, o sistema insere o Comando "05" no campo "Comando de Remessa" e diante disso já emite uma mensagem:
 
'''Confirma o envio da alteração do título ao banco?'''
 
'''Importante:''' para o envio da alteração do Vencimento o sistema já considera o campo '''Vencimento''', caso seja utilizado a '''Modalidade''' como '''Seguinte''' por exemplo, onde é possível ter um Vencimento Original diferente do Vencimento.
 
<center>'''Lançamento Financeiro a Receber já Registrado'''
[[Arquivo:AlterarVenc Lanc1.png|750x500px|nenhum|AlterarVenc_Lanc1]]
 
 
Vencimento alterado, sistema insere o Comando "05" no campo "Comando de Remessa" e ao salvar o registro é emitido a mensagem: "Confirma o envio da alteração do título ao banco?"
 
<center>'''Vencimento alterado e registro salvo'''
[[Arquivo:Vencimento Alterado Msn.png|750x500px|nenhum|Vencimento_Alterado_Msn]]
 
'''Sim:''' é enviado o registro de alteração do Open Banking e se registrado com sucesso, sistema retira então o Comando de Remessa.
 
<center>'''Processo Concluído com Sucesso'''
[[Arquivo:Processo_Concluido_Sucesso_Lanc.png|750x500px|nenhum|Processo_Concluido_Sucesso_Lanc]]
 
Há possibilidades do tempo de comunicação com API do Banco não retornar imediatamente a confirmação do recebimento da Alteração do Vencimento. Quando ocorrer essa situação, sistema emite uma mensagem, solicitando aguardar, para tentar novamente o envio da alteração do vencimento.
Quando ocorrer essa situação, será necessário aguardar e após realizar o envio novamente ou através do próprio Lançamento ou através da rotina de Remessa de Cobrança - Open Banking, que remeterá as alterações para o Banco.
<center>'''Processo Pendente Alteração - Aguardar'''
[[Arquivo:Alteração Vencimento Processo Pendente Envio Aguardar.png|750x500px|nenhum|Alteração_Vencimento_Processo_Pendente_Envio_Aguardar]]
 
Já quando selecionado a opção '''Não''':
 
'''Não:''' não faz a comunicação do envio da alteração do vencimento via Open Banking. Este registro não foi notificado, logo será necessário realiza-lo através do próprio Lançamento ou através da rotina de Remessa de Cobrança Open Banking.
 
No Lançamento Financeiro é habilitado o botão "Reenviar Registro" no Item de Categoria "Open Banking".
Quando selecionado o botão '''Registrar Alteração''', sistema faz a comunicação via Open Banking e registra alteração de vencimento realizada.
 
<center>'''Lançamento Não Registrado a alteração de Vencimento com o Comando de Remessa'''
[[Arquivo:Botao Registrar Alteracao Habilitado.png|750x500px|nenhum|Botao_Registrar_Alteracao_Habilitado]]
 
Ao selecionar o botão "Registrar Alteração" sistema emite a mensagem para confirmar o envio.
 
<center>'''Botão Registrar Alteração'''
[[Arquivo:Registrar Alteracao Selecionado.png|750x500px|nenhum|Registrar_Alteracao_Selecionado]]
 
Após a confirmação o sistema registra alteração
 
<center>'''Processo Concluído com Sucesso'''
[[Arquivo:Processo_Concluido_Sucesso_Lanc.png|750x500px|nenhum|Processo_Concluido_Sucesso_Lanc]]
 
 
<center>'''Lançamento alterado e registrado'''
[[Arquivo:Lançamento alterado registrado.png|750x500px|nenhum|Lançamento_alterado_registrado]]
 

='''Como realizar a Alteração de Multa do Lançamento já Registrado Open Banking e reenviá-lo novamente?'''=

'''Irá surgir a necessidade de realizar a alteração da Multa do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?'''
 
Dado que já temos um Lançamento Financeiro já Registrado Open Banking, basta acessar o Lançamento Financeiro desejado através do caminho do Menu:
 
'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 
'''Regra Sistema para Multa ou Juros:'''
 
Se no cadastro do Portador não possuir Comando de Remessa com as novas opções:
 
'''Tipo de Comando =''' Alteração de Multa para Multa
 
'''Tipo de Comando =''' Alteração de Juros para Juros
 
Ao acessar o Lançamento Financeiro em modo Modificar e alterar o campo '''Multa de''', automaticamente após alteração da Multa, o Sistema irá criar essa parametrização do Comando de Remessa com '''sugestão''', sendo passível de alteração, no Cadastro do Portador no botão '''Remessas''' e depois no botão '''Comandos'''.
 
'''Comando sugestão para Multa:'''
 
'''Código Operação =''' ATM
 
'''Comando =''' ATM
 
'''Descrição =''' ALTERAÇÃO DE MULTA PARA OPEN BANKING
 
'''Tipo de Comando =''' Alteração de Multa
 
 
<center>'''Cadastro do Portador Comando de Remessa Multa'''
[[Arquivo:Cadastro Portador Comando Remessa ATM.png|750x500px|nenhum|Cadastro_Portador_Comando_Remessa_ATM]]
 
 

'''Como é identificado a alteração da Multa para Banco?'''
 
Através das tags enviadas para API gravadas no Histórico do Open Banking Dados API:
 
'''indicadorCobrarMulta''':'''S''' – indica que há multa no registro.
 
'''indicadorDispensarMulta''': '''S''' – indica que a multa foi zerada e não há mais ocorrência de multa para o registro enviado.
 
'''tipoMulta''': 1, - indica que a Multa é maior que 0,01 centavo.
 
'''tipoMulta''': 0, - indica que a Multa é menor que 0,01 centavo não registrando a operação de multa.
 
'''valorMulta''': 0.44, - indica o valor da multa.
 
'''dataInicioMulta''': "23.09.2021", - indica a data do movimento da alteração da multa enviado.
 
 
<center>'''Lançamento Financeiro a Receber já Registrado alterando a Multa'''
[[Arquivo:Alteração Multa Lancto.png|750x500px|nenhum|Alteração_Multa_Lancto]]
 
 

Tags enviadas para API Banco:
 
 
<center>'''Dados API Tags referente a Multa'''
[[Arquivo:Lancto Registrado Alteração Multa Lancto.png|750x500px|nenhum|Lancto_Registrado_Alteração_Multa_Lancto]]
 
 

='''Como realizar a Alteração de Juros do Lançamento já Registrado Open Banking e reenviá-lo novamente?'''=

'''Irá surgir a necessidade de realizar a alteração de Juros do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?'''
 
Dado que já temos um Lançamento Financeiro já Registrado Open Banking, basta acessar o Lançamento Financeiro desejado através do caminho do Menu:
 
'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 
'''Regra Sistema para Multa ou Juros:'''
 
Se no cadastro do Portador não possuir Comando de Remessa com as novas opções:
 
'''Tipo de Comando =''' Alteração de Multa para Multa
 
'''Tipo de Comando =''' Alteração de Juros para Juros
 
Ao acessar o Lançamento Financeiro em modo Modificar e alterar o campo '''Juros Dias de''' ou '''Juros Mês de''', automaticamente após alteração dos Juros, o Sistema irá criar essa parametrização do Comando de Remessa com '''sugestão''', sendo passível de alteração, no Cadastro do Portador no botão '''Remessas''' e depois no botão '''Comandos'''.
 
'''Comando sugestão para Juros:'''
 
'''Código Operação =''' ATJ
 
'''Comando =''' ATJ
 
'''Descrição =''' ALTERAÇÃO DE JUROS PARA OPEN BANKING
 
'''Tipo de Comando =''' Alteração de Juros
 
 
<center>'''Cadastro do Portador Comando de Remessa Juros'''
[[Arquivo:Cadastro Portador Comando Remessa ATJ.png|750x500px|nenhum|Cadastro_Portador_Comando_Remessa_ATJ]]
 
 

'''Como é identificado a alteração de Juros para Banco?'''
 
Através das tags enviadas para API gravadas no Histórico do Open Banking Dados API:
 
'''indicadorCobrarJuros''':'''S''' – indica que há Juros no registro.
 
'''indicadorDispensarJuros''': '''S''' – indica que o Juros foi zerado e não há mais ocorrência de Juros para o registro enviado.
 
'''tipoJuros''': 1, - indica que os Juros é maior que 0,01 centavo.
 
'''tipoMulta''': 0, - indica que os Juros é menor que 0,01 centavo não registrando a operação de Juros.
 
'''valorJuros''': 0.46, - indica o valor dos Juros.
 
 
<center>'''Lançamento Financeiro a Receber já Registrado alterando os Juros'''
[[Arquivo:Lancto Registrado Alteração Juros Dia.png|750x500px|nenhum|Lancto_Registrado_Alteração_Juros_Dia]]
 
 

Tags enviadas para API Banco:
 
 
<center>'''Dados API Tags referente aos Juros''
[[Arquivo:Dados API Juros.png|750x500px|nenhum|Dados_API_Juros]]
 
 

='''Como realizar a Alteração dos 3 juntos (Vencimento/Juros/Multa) do Lançamento já Registrado Open Banking e reenviá-lo novamente?'''=

Irá surgir a necessidade de realizar a alteração do Vencimento do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?
 
'''Dado que''' já temos um Lançamento Financeiro já Registrado Open Banking, basta acessar o Lançamento Financeiro desejado através do caminho do Menu:
 
'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 
Acessar o Lançamento Financeiro em modo Modificar e alterar o campo "Venc.Original", automaticamente após alteração do Vencimento, o sistema insere o Comando "05" no campo "Comando de Remessa" e diante disso já emite uma mensagem:
 
'''Confirma o envio da alteração do título ao banco?'''
 
'''Importante:''' para o envio da alteração do Vencimento o sistema já considera o campo '''Vencimento''', caso seja utilizado a '''Modalidade''' como '''Seguinte''' por exemplo, onde é possível ter um Vencimento Original diferente do Vencimento.
 
<center>'''Lançamento Financeiro a Receber já Registrado'''
[[Arquivo:AlterarVenc Lanc1.png|750x500px|nenhum|AlterarVenc_Lanc1]]
 
 
Vencimento alterado, sistema insere o Comando "05" no campo "Comando de Remessa" e ao salvar o registro é emitido a mensagem: "Confirma o envio da alteração do título ao banco?"
 
<center>'''Vencimento alterado e registro salvo'''
[[Arquivo:Vencimento Alterado Msn.png|750x500px|nenhum|Vencimento_Alterado_Msn]]
 
'''Sim:''' é enviado o registro de alteração do Open Banking e se registrado com sucesso, sistema retira então o Comando de Remessa.
 
<center>'''Processo Concluído com Sucesso'''
[[Arquivo:Processo_Concluido_Sucesso_Lanc.png|750x500px|nenhum|Processo_Concluido_Sucesso_Lanc]]
 
Há possibilidades do tempo de comunicação com API do Banco não retornar imediatamente a confirmação do recebimento da Alteração do Vencimento. Quando ocorrer essa situação, sistema emite uma mensagem, solicitando aguardar, para tentar novamente o envio da alteração do vencimento.
Quando ocorrer essa situação, será necessário aguardar e após realizar o envio novamente ou através do próprio Lançamento ou através da rotina de Remessa de Cobrança - Open Banking, que remeterá as alterações para o Banco.
<center>'''Processo Pendente Alteração - Aguardar'''
[[Arquivo:Alteração Vencimento Processo Pendente Envio Aguardar.png|750x500px|nenhum|Alteração_Vencimento_Processo_Pendente_Envio_Aguardar]]
 
Já quando selecionado a opção '''Não''':
 
'''Não:''' não faz a comunicação do envio da alteração do vencimento via Open Banking. Este registro não foi notificado, logo será necessário realiza-lo através do próprio Lançamento ou através da rotina de Remessa de Cobrança Open Banking.
 
No Lançamento Financeiro é habilitado o botão "Reenviar Registro" no Item de Categoria "Open Banking".
Quando selecionado o botão '''Registrar Alteração''', sistema faz a comunicação via Open Banking e registra alteração de vencimento realizada.
 
<center>'''Lançamento Não Registrado a alteração de Vencimento com o Comando de Remessa'''
[[Arquivo:Botao Registrar Alteracao Habilitado.png|750x500px|nenhum|Botao_Registrar_Alteracao_Habilitado]]
 
Ao selecionar o botão "Registrar Alteração" sistema emite a mensagem para confirmar o envio.
 
<center>'''Botão Registrar Alteração'''
[[Arquivo:Registrar Alteracao Selecionado.png|750x500px|nenhum|Registrar_Alteracao_Selecionado]]
 
Após a confirmação o sistema registra alteração
 
<center>'''Processo Concluído com Sucesso'''
[[Arquivo:Processo_Concluido_Sucesso_Lanc.png|750x500px|nenhum|Processo_Concluido_Sucesso_Lanc]]
 
 
<center>'''Lançamento alterado e registrado'''
[[Arquivo:Lançamento alterado registrado.png|750x500px|nenhum|Lançamento_alterado_registrado]]
 

='''Quais são as novidades após atualização para Versão 2 do Open Banking?'''=

Disponibilizado a Versão 2 para Open Banking que traz algumas novidades para o processo de Registro no Banco.
 
'''Para começar o que devo fazer para atualizar para Versão 2 do Open Banking?'''
 
Simples, basta atualizar com a versão que contempla a'''OS 664835/1'''.
 
Nela terá um componente que quando atualizado a Base através do Assistente de Atualização (Atualiza CIGAM) será adicionado nos Parâmetros Open Banking da Configuração de Bancos, especificamente nas Credenciais, o registro '''Versão API''' = v2.
 
'''Finanças > Gestão Financeira > Parâmetros > Configurações de Bancos'''
 
<center>'''Parâmetros Open Banking'''
[[Arquivo:Parametros OP V2 Credenciais.png|750x500px|nenhum|Parametros_OP_V2_Credenciais]]
 
A partir desta Versão o Sistema passa a realizar a busca para localizar os títulos da seguinte forma:
 
1- O sistema tenta localizar os títulos pelo Número do Lançamento;
 
2- Caso os títulos tenham sido gerados pelo CIGAM irá localizar pelo '''Nosso Número''', avaliando então a tabela '''GFBOLETOS''' pela coluna '''NOSSO_NRO'''.
 
3- Caso os títulos tenham sido gerados por outro sistema irá localizar pelo '''Nosso Número''', avaliando então a tabela '''GFLAUXIL''' pela coluna '''CODIGO_BARRAS'''.
 
Também nesta versão estão disponíveis as tags para Envio da Série/NF, sendo utilizado a Tag na API '''NumeroTituloBeneficiario'''. A regra é '''Serie''' '''NF''' '''Complemento Duplicata''', bem como descrito com espaços em Branco entre eles. Para verificar esse registro, basta acessar após o Registro no Banco o Histórico Open Banking na guia '''Envio''' e localizar para Tag '''NumeroTituloBeneficiario'''.
 
<center>'''Quais são as mudanças ocorridas no Assistente de Parâmetros de Convênio Open Banking?'''
 
Para o Scope foi adicionado um novo complemento para atender ao PIX, logo o Scope passa a ficar desta forma por padrão:
 
'''cobrancas.boletos-requisicao cobrancas.boletos-info payments.transfer-batch-request payments.transfers-info payments.batch-slips payments.batch-barcode-collection-form-request cob.write cob.read pix.read pix.write'''
 
Copie e cole no campo Scope esse dado.
 
<center>'''Parâmetros de Convênio Open Banking'''
[[Arquivo:Wizard passo 3 de 4 Direto PIX.png|750x500px|nenhum|Wizard_passo_3_de_4_Direto_PIX]]
 
Atualizado Wizard para Versão 2 do Open Banking, disponibilizando duas opções:
 
'''- Direto''': esta opção tem como finalidade registrar o Boleto no momento da sua geração, ou seja, quando selecionado ativa propriedade ao qual ao gerar o Boleto Bancário o sistema automaticamente envia o registro Open Banking, sem a necessidade de fazer o processo de envio da Remessa Open Banking do título.
 
'''- PIX''': esta opção fica habilitada somente quando selecionado a opção '''Direto''', ela tem como finalidade registrar uma operação PIX para os Boletos emitido de forma Direta (opção '''Direto''' marcado).
 
Esta opção é válida '''SOMENTE''' para o Banco do Brasil.
 
Ao emitir o Boleto do Lançamento o sistema marca as 3 opções:
 
- Boleto Impresso;
 
- Remessa Enviada;
 
- Código de Barras Lido;
 
Outra mudança é no '''Histórico''' Open Banking, ao qual passa criar o registro com '''Status Open Banking''' já '''Registrado'''.
 
Também ao acessar os '''Dados API''' é enviado a tag: "indicadorPix": "S", pois a opção PIX esta selecionada.
 
Disponibilizado o Modelo de Relatório para o Boleto Banco do Brasil já com o QRCode:
 
'''I:\CIGAM\DOC\Modelos_relatorios\Gestão Financeira\Bloquetos Merge\0098_brasil_PIX.rtf'''

='''Como realizar a Baixa de um Lançamento Financeiro Registrado Open Banking e enviar o Registro de Baixa?'''=

'''IMPORTANTE:''' O processo de Cancelamento de Notas Fiscais, não atende a baixa automatica dos Boletos, logo deve ser baixado manualmente os registros dos Lançamentos Financeiros.
 
 
Para realizar o processo de '''Baixa''' de um Lançamento Financeiro que foi registrado via Open Banking, basta acessar o Lançamento Financeiro.
 
'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 
Selecionar a opção de Menu Lateral do Lançamento Financeiro '''Open Banking''' e a opção de '''Baixar'''.
 
<center>'''Lançamento Financeiro Registrado/Baixar'''
[[Arquivo:Opção Baixar Lancto.png|750x500px|nenhum|Opção_Baixar_Lancto]]
 
<center>'''Lançamento Financeiro Confirmando Operação'''
[[Arquivo:Deseja Baixar.png|750x500px|nenhum|Deseja_Baixar]]
 
<center>'''Lançamento Financeiro Baixado com Sucesso'''
[[Arquivo:Baixado Sucesso.png|750x500px|nenhum|Baixado_Sucesso]]
 
Agora basta acessar a rotina de Retorno de Cobrança Open Banking através do Menu:
 
'''Menu > Finanças > Gestão Financeira > Rotinas > Operacionais > Open Banking > Retorno de Cobrança Open Banking '''
 
Modelo de Relatório utilizado:
 
%CIGAM_INSTAL%\Modelos_relatorios\Gestão Financeira\RF00071_remessas.RTF
 
<center>'''Retorno de Cobrança Open Banking'''
[[Arquivo:Retorno OP Baixado.png|750x500px|nenhum|Retorno_OP_Baixado]]
 
<center>'''Retorno de Cobrança Open Banking'''
[[Arquivo:Retorno OP Baixado Verso.png|750x500px|nenhum|Retorno_OP_Baixado_Verso]]
 
Após confirmado a rotina emite a Listage de Retorno com o título baixado registrado.
 
<center>'''Listagem_Retorno_Bancario_Online'''
[[Arquivo:Listagem Retorno Bancario Online.png|750x500px|nenhum|Listagem_Retorno_Bancario_Online]]
 
Com isso para validar o Retorno da API do Banco é gravado no Histórico Open Banking do Lançamento Financeiro.
 
Acessando Lançamento Financeiro:
 
<center>'''Listagem_Retorno_Bancario_Online'''
[[Arquivo:Lancamento Financeiro Historico.png|750x500px|nenhum|Lancamento_Financeiro_Historico]]
 
<center>'''Acessando Dados API do Lançamento Financeiro'''
[[Arquivo:Dados API Lancto.png|750x500px|nenhum|Dados_API_Lancto]]
 
O sistema grava para '''Envio''' seguinte mensagem:
 
'''BAIXADO PELO PROCESSO DE RETORNO, CÓDIGO DE BAIXA: BAIXADO POR SOLICITACAO'''
 
<center>'''Acessando Dados API do Lançamento Financeiro'''
[[Arquivo:Dados API Envio Baixado.png|750x500px|nenhum|Dados_API_Envio_Baixado]]
 

='''Como realizar a Variação do Tipo de Cobrança de Simples para Vinculada?'''=

Conforme layout do Banco para Open Banking para diferenciar o Tipo de Cobrança:
 
'''1- Cobrança Simples'''
 
'''4- Cobrança Vinculada'''
 
Para realizar este processo no Sistema deve ser parametrizado no Cadastro do Portador com a seguinte regra de sistema:
 
Tudo que for diferente de 4 (Cobrança Vinculada) será considerado 1 (Cobrança Simples), ou seja, caso seja deixado em Branco ou informado qualquer número diferente de 4 o sistema irá considerar sempre 1.
 
'''Menu > Finanças > Gestão Financeira > Parâmetros > Portadores'''
 
O Campo considerado para esta informação é o '''Identificação do serviço''' na guia '''CNAB'''.
 
<center>'''1- Cobrança Simples'''
[[Arquivo:Cadastro Portador Cobranca Simples.png|750x500px|nenhum|Cadastro_Portador_Cobranca_Simples]]
 

<center>'''4- Cobrança Vinculada'''
[[Arquivo:Cadastro Portador Cobranca Vinculada 4.png|750x500px|nenhum|Conbranca_Vinculada]]
 

='''Como parametrizar para envio Open Banking a Negativação ou Protesto?'''=

Para enviar um '''PROTESTO''':
 
Basta acessar o Cadastro do Portador e inserir os dias no campo '''Protestar após''' na guia '''Configurações.
 

'''Menu > Finanças > Gestão Financeira > Parâmetros > Portadores'''

 
<center>'''Dias de Protesto Cadastro do Portador'''
[[Arquivo:Cadastro Portador Negativacao BB5.png|750x500px|nenhum|Cadastro_Portador_Negativacao_BB5]]
 

Quando se tratar de '''Protesto''' o sistema deve enviar as tags para API do Banco da seguinte forma:
 
Setar os dias conforme parametrização no Cadastro do Portador na tag '''"quantidadeDiasProtesto": "1",''' e na tag '''"quantidadeDiasNegativacao": "0",'''.
 
Exemplo de envio da API:
 
'''"quantidadeDiasProtesto": "1",'''
 
'''"quantidadeDiasNegativacao": "0",'''
 

Já para enviar uma '''NEGATIVAÇÃO''':
 
Basta acessar o Cadastro do Portador e inserir os dias no campo '''Negativar após''' na guia '''Configurações.
 

'''Menu > Finanças > Gestão Financeira > Parâmetros > Portadores'''

 
<center>'''Dias de Protesto Cadastro do Portador'''
[[Arquivo:Cadastro Portador Negativacao BB.png|750x500px|nenhum|Cadastro_Portador_Negativacao_BB]]
 

Quando se tratar de '''Negativação''' o sistema deve enviar as tags para API do Banco da seguinte forma:
 
Setar os dias conforme parametrização no Cadastro do Portador e nas tags deve ser zerado '''"quantidadeDiasProtesto": "0",''' e na tag '''"quantidadeDiasNegativacao": "7",''' e deve conter o órgão negativador na tag '''"orgaoNegativador": "10",''', sendo SERASA = 10 .
 
Exemplo de envio da API:
 
'''"quantidadeDiasProtesto": "0",'''
 
'''"quantidadeDiasNegativacao": "7",'''
 
'''"orgaoNegativador": "10",'''

='''Como cadastrar as Mensagens de Retorno API Financeira Sugestão Usuário?'''=

As Mensagens de Retorno API Financeira é uma funcionalidade para facilitar a identificar e de orientação para com as mensagens provindas das APIs que o Sistema tem conexão.
 
Elas foram implementadas para Open banking.
 
Para acessar o cadastro basta acessar através do Menu:
 
'''Menu: Finanças > Gestão Financeira > Parâmetros > Mensagens de Retorno API Financeiro'''
 

<center>'''Mensagens de Retorno API Financeiro'''
[[Arquivo:Mensagens Retorno API Financeiro.png|750x500px|nenhum|Mensagens_Retorno_API_Financeiro]]
 

'''Banco:''' código do Banco conforme codificação no orgão que rege os Bancos Febraban.
 
'''Código Erro:''' código do erro conforme layout das APIS dos Bancos.
 
'''Status:''' é o código de Status de erro do Servidor retornado da API dos Bancos. (Código HTTP)
 
'''Descrição do Erro (Banco):''' essa descrição é oriunda do Banco retornada pela API deles.
 
'''Sugestão CIGAM:''' esta mensagem é interna do Sistema, ou seja, quando internamente identificarmos uma situação a qual a Mensagem retornada pelo Banco não é clara, vamos alimentar com Mensagens de sugestão, para orientar as possíveis causas, dando um norte para situação.
 
'''Sugestão Cliente:''' este campo é reservado para o próprio usuário, possibilitando cadastrar Mensagens que ele identificar para facilitar no processo de entendimento das Mensagens de Retorno das APIs.
 
Agora através desta aplicação, quando ocorrer um Erro de Open Banking é possível verificar através dos links dispostos na tela de Lançamento Financeiro no campo Situação Open Banking, terá um link para tabela do erro ocorrido.
 
<center>'''Lançamento Financeiro Mensagens de Retorno API Financeiro'''
[[Arquivo:Mensagens Retorno API Financeiro BB OP.png|750x500px|nenhum|Mensagens_Retorno_API_Financeiro_BB_OP]]
 
Ou também através do Histórico Open Banking:
 
<center>'''Lançamento Financeiro Mensagens de Retorno API Financeiro Histórico Open Banking'''
[[Arquivo:Historico OP Mensagens Retorno API Financeiro BB OP.png|750x500px|nenhum|Historico_OP_Mensagens_Retorno_API_Financeiro_BB_OP]]

='''Não Escopo Retorno Open Banking Cartório?'''=

Referente ao retorno para liquidação em Cartório, o Banco tem uma limitação e não foi desenvolvido ainda por parte do Banco na API, as custas e tarifas de Cartório, impossibilitando o Sistema realizar essa liquidação.
 
A sugestão para registros de Cartório é realizar via Remessa de CNAB de Retorno manual, até o Banco do Brasil liberar essa funcionalidade na API.

GF - Como Fazer - Open Banking para Banco do Brasil

2022-04-25T18:11:49Z

Alan.campos: /* Como realizar a Baixa de um Lançamento Financeiro Registrado Open Banking e enviar o Registro de Baixa? */

[[categoria:Como_Fazer_Finanças]]

=='''O que significa Open Banking?'''==

Open Banking é um conceito relativamente novo na realidade do mercado financeiro brasileiro. Porém, ele tem ganhado cada vez mais atenção em todo o mundo.
Traduzido, o termo significa “banco aberto”, mas uma tradução mais precisa seria “sistema financeiro aberto”.
O conceito em si trata de algo de simples compreensão. Basicamente, Open Banking é a defesa de que o sistema financeiro adote a tecnologia de forma mais ampla e padronizada, como forma de incentivar e ampliar a oferta e a qualidade dos produtos e serviços financeiros.
A base do Open Banking está na premissa de que os dados pertencem aos consumidores. Logo, caso eles autorizem, esses dados devem ser disponibilizados para que eles possam ter acesso a produtos e serviços que forem mais convenientes.
Na prática, há um pedido para que as instituições abram suas API’s (sigla em inglês para Interface de Programação de Aplicativos) para que terceiros desenvolvam e aprimorem os sistemas e suas funcionalidades.
O objetivo do Open Banking é desenvolver sistemas integrados, que facilitem o controle e transferência de informações de dados, histórico, contas, empréstimos etc. Todo o tipo de produto e serviço oferecido pelos bancos seria integrado de maneira a evitar processos complicados e dispendiosos.
À primeira vista, pode parecer que com o Open Banking as informações dos clientes ficarão soltas e desprotegidas. No entanto, os bancos e instituições financeiras ainda serão responsáveis pela proteção de dados sigilosos.

 

=='''Serviços Disponíveis pela API do Banco nesta Versão?'''==

'''Menu > Utilidades/Diversos > Genéricos > Parâmetros > Configurações'''
 
<center>
{| class="wikitable"
|-
! SERVIÇO !! COBRANÇA
|-
| Registro de Boleto via API || SIM
|-
| Open Banking PIX no Boleto || SIM
|-
| Retorno de Cobrança via API || SIM
|-
| Alteração de Juros via API || SIM
|-
| Alteração de Multa via API || SIM
|-
| Alteração de Vencimento via API || SIM
|-
| Alteração de Baixa via API || SIM
|-
| Retorno de Cobrança com Registro em Cartório via API || NÃO
|-
|}
</center>
 

=='''Como obter as Credenciais para utilizar a Funcionalidade Open Banking?'''==
 
As credenciais do Banco do Brasil devem ser obtidas através do acesso ao Portal Developers (pdf caminho citado).
 
'''I:\CIGAM\Implementa\Documentos\Apoio a implementação\Open Banking Manual Banco\02 Portal Developers - Credenciais de produção.pdf'''
 
Este acesso deve ser feito pelo '''responsável da conta corrente na empresa'''. No momento da geração das credenciais devem ser incluídos os “Escopos” (Funcionalidades da API) tais como Cobrança, Pagamento e PIX.
 
Qualquer geração de credenciais com um contexto diferente deste, seja porque a pessoa a gerar as credenciais '''não é o responsável da conta''' ou por algum dos serviços tenha ficado de fora do escopo, irá resultar em erro no momento do uso da API.
 
'''Ex: {"statusCode":403,"error":"Forbidden","message":"Application key is not allowed to call this resource method"};”'''
 

=='''Quais os Módulos necessários para utilizar a Funcionalidade Open Banking do Banco do Brasil”?'''==

• Módulo Gestão Financeira;

=='''Quais são as parametrizações necessárias para utilizar a funcionalidade do Open Banking?'''==

Para utilizar esta funcionalidade é necessário possuir o Cadastro do Portador para o Banco do Brasil.
O cadastro quando preenchido corretamente garante que não ocorrerá inconsistências no momento do registro do Open Banking.
 
Como boa prática de implementação é mais coerente criar um novo Portador para Open Banking evitando assim de alterar o Portador utilizado para CNAB caso necessite realizar algum processo via remessa ou retorno, quando a API do Banco estiver com instabilidade.
 
Essa parametrização deverá validar os últimos Sequenciais da numeração de Boletos do Portador utilizado para as Remessas, pois assim garante que não ocorrerá conflito enviar uma numeração de Título já registrado.
 
 
'''Itens Importantes na Parametrização:'''
 
'''- Processar retornos pelo número do Boleto:''' esta opção deve estar marcada, pois caso contrário ocorrerá problemas na gravação das informações e envio para Banco.
 
Caso tenha sido realizado movimentações com esta opção desmarcada, não será possível realizar a Baixa, pois sistema não consegue localizar devido não possuir o '''Nosso Número''' gravado nas tabelas envolvidas.
 
Para solucionar essa questão será necessário:
 
'''1-''' Identificar o '''Nosso Número''' do registro a ser baixado (Lançamento Financeiro);
 
'''2-''' Gravar o '''Nosso Número''' nas seguintes tabelas:
 
'''GFBOLETOS:''' campo a ser atualizado '''NOSSO_NRO''' com a informação do Nosso Número.
 
'''GFLAUXIL:''' campo a ser atualizado '''CODIGO_BARRAS''' com a informação do Nosso Número.
 
- A variação da Carteira do Banco do Brasil;
 
- Quando se tratar do Portador Open Banking do BB, o campo "Identificação do serviço" deve ser em Branco.
 
Para o correto funcionamento da rotina é necessário que os dados do Portador esteja com todas informações necessárias, inclusive o '''Convênio'''.
 
'''Menu > Finanças > Gestão Financeira > Parâmetros > Portadores'''
 
Este cadastro é apenas uma demonstração de parametrização:
 
<center>'''Cadastro de Portador'''
[[Arquivo:Cadastro Portador OpenBanking.png|750x500px|semmoldura|nenhum|Cadastro_Portador_OpenBanking]]
 
Quando se tratar do Portador Open Banking do BB, o campo "Identificação do serviço" deve ser em Branco.
 
'''Conta:''' o preenchimento da Conta deve ser sem caracteres especiais, somente números.
 
 
'''Convênio:'''
 
"Cada Conta Corrente é um Convênio" - (7 posições).
"Uma Conta Corrente pode ter vários Convênios".
"Quando tenho mais de um Convênio, muda o Código do Convênio e a variação da Carteira conforme a tabela abaixo:"
Variação da Carteira (caso tenha mais de um Convênio):
 
'''019 (Código de 2 + DV)'''
 
'''027'''
 
'''035'''
 
'''043...'''
 
'''Carteira (Serviço):'''
 
'''011 -''' (Cobrança simples Boleto por correio)
 
'''031 -''' (Cobrança simples Vinculada)
 
'''017 -''' (Cobrança simples Imprime Boleto - considerado como Única)
 
'''051 -''' (Carteira Descontada), modalidade utilizada é 04.
 
Demais são considerados atributos.
 
'''Modalidades de Serviço do Banco do Brasil consideradas:'''
 
01 - Simples
 
04 - Vinculada (esta Modalidade esta atrelada somente a '''Carteira 051''', logo não deve ser utilizada para outras Carteiras)
 
'''Regra do Sistema para Banco do Brasil Open Banking:'''
 
'''Identificador do Serviço:''' as opções para este campo são:
 
'''01 -''' Simples
 
'''04 -''' Vinculado
 
Valores diferentes destes serão tratados = '''01 -''' Simples
 

 
'''Espécie:''' este campo para Open Banking é considerado para identificar o Tipo de Boleto de Cobrança. Quando este campo estiver em Branco o Sistema irá considerar sempre '''04 -''' DUPLICATA SERVICO.
 
'''01 -''' CHEQUE
 
'''02 -''' DUPLICATA MERCANTIL
 
'''03 -''' DUPLICATA MTIL POR INDICACAO
 
'''04 -''' DUPLICATA SERVICO
 
'''05 -''' DUPLICATA SRVC P/INDICAO
 
'''06 -''' DUPLICATA RURAL
 
'''07 -''' LETRA DE CAMBIO
 
'''08 -''' NOTA DE CRÉDITO COMERCIAL
 
'''9-''' NOTA DE CREDITO A EXPORTACAO
 
'''10-''' NOTA DE CREDITO INDULTRIAL
 
'''11-''' NOTA DE CREDITO RURAL
 
'''12-''' NOTA PROMISSORIA
 
'''13-''' NOTA PROMISSORIA RURAL
 
'''14-''' TRIPLICATA MERCANTIL
 
'''15-''' TRIPLICATA DE SERVICO
 
'''16-''' NOTA DE SEGURO
 
'''17-''' RECIBO
 
'''18-''' FATURA
 
'''19-''' NOTA DE DEBITO
 
'''20-''' APOLICE DE SEGURO
 
'''21-''' MENSALIDADE ESCOLAR
 
'''22-''' PARCELA DE CONSORCIO
 
'''23-''' DIVIDA ATIVA DA UNIAO
 
'''24-''' DIVIDA ATIVA DE ESTADO
 
'''25-''' DIVIDA ATIVA DE MUNICIPIO
 
'''31-''' CARTAO DE CREDITO
 
'''32-''' BOLETO PROPOSTA
 
'''33-''' BOLETO APORTE
 
'''99-''' OUTROS
 
<center>'''Guia CNAB'''
[[Arquivo:Portador_Guia_CNAB3.png|700x500px|semmoldura|nenhum|Portador_Guia_CNAB3]]
 
<center>'''Guia Configurações'''
[[Arquivo:Cadastro Portador Config.png|700x500px|semmoldura|nenhum|Cadastro_Portador_Config]]
 
 
'''Irá surgir a necessidade de realizar a alteração de Vencimento, Multa ou Juros do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?'''
 
Regra Sistema para Vencimento, Multa ou Juros:
 
Cadastro do Portador deve possuir Comando de Remessa com as novas opções:
 
'''Tipo de Comando =''' Alteração de Vencimento (para alteração de Vencimento).
 
'''Tipo de Comando =''' Alteração de Multa para Multa (para alteração de Multa).
 
'''Tipo de Comando =''' Alteração de Juros para Juros (para alteração de Juros).
 
Caso não seja parametrizado neste primeiro momento as opções de Multa e Juros o sistema cria automaticamente (Somente Juros e Multa).
 
Ao acessar o Lançamento Financeiro em modo Modificar e alterar o campo Multa de ou Juros de, automaticamente após alteração da Multa, o Sistema irá criar essa parametrização do Comando de Remessa com sugestão, sendo passível de alteração, no Cadastro do Portador no botão Remessas e depois no botão Comandos.
 
'''Comando sugestão para Multa:'''
 
'''Código Operação''' = ATM
 
'''Comando''' = ATM
 
'''Descrição''' = ALTERAÇÃO DE MULTA PARA OPEN BANKING
 
'''Tipo de Comando''' = Alteração de Multa
 
'''Comando sugestão para Juros:'''
 
'''Código Operação''' = ATJ
 
'''Comando''' = ATK
 
'''Descrição''' = ALTERAÇÃO DE JUROS PARA OPEN BANKING
 
'''Tipo de Comando''' = Alteração de Juros
 
<center>'''Botão Remessas > Comandos'''
[[image:bt_Comando_Remessa_cop.png.png|center|semmoldura|750px|Comando Remessa]]
 
 
<center>'''Botão Retornos > Códigos de Retorno'''
[[image:bt_Codigo_Ret.png|center|semmoldura|750px|Código de Retorno]]
 
 
Para iniciar a configuração através do “Assistente de Parâmetros do Open Banking”, basta selecionar o botão “Open Banking”:
 
'''Menu > Finanças > Gestão Financeira > Parâmetros > Configuração de Bancos'''
 
 
<center>'''Configurações de Banco'''
[[Arquivo:Configuracoes Banco.png|750x550px|semmoldura|nenhum|Configuracoes_Banco]]
 
 
Para dar início ao processo de parametrização, basta selecionar o botão “Avançar”:
 
 

=='''Tela Inicial Configuração do Assistente Open Banking:'''==
 
'''IMPORTANTE:''' Devido a uma especificação do Banco do Brasil, as Credenciais do Banco geradas são válidas para o escopo de serviços (APIs) do Cliente no momento da sua criação.
 
Caso haja adição de novos serviços ao escopo do Cliente, por exemplo, Credenciais para a API de Cobrança e posteriormente adicione a API do '''PIX''' ao seu escopo, será necessário excluir as Credenciais Antigas no Portal Developers e criar novas, contendo as duas APIs.
 
Depois disso, ele deverá inseri-las no Sistema novamente, substituindo as antigas.
 
Para iniciar a configuração é necessário ter em mãos os seguintes dados: (Cliente, Chave de Autorização e Gw-app-Key).
Sem essas informações não será possível dar continuidade na parametrização do Open Banking para o Banco do Brasil.
 
<center>'''Tela Inicial Assistente de Parâmetros Open Banking'''
[[Arquivo:Tela Inicial Wizard2.png|750x500px|nenhum|Tela_Inicial_Wizard2.png]]
 


=='''Etapa 1 (Parâmetros: Passo 1 de 4):'''==


Uma das etapas mais importantes e que requer um cuidado maior e sigilo das informações nesta parametrização.
 
Essas informações são disponibilizadas pelo Banco a qual deve ser restrita somente a pessoa responsável pelo setor Financeiro da Empresa.
 
O assistente tem como objetivo proporcionar que o próprio usuário tenha autonomia para executar esse passo a passo sem necessidade de passar essas informações restritas da Empresa para qualquer pessoa que não seja ele mesmo.
 
Reforçando, mesmo que tenha dificuldades para executar esta etapa, não repasse nenhuma informação relacionado aos acessos dos tokens.
 
Dados em mãos para informar os respectivos campos, basta copiar e colar as informações.
 
Developer Application Key, Client Id, Cliente Secret, e o Scope que passa vir preenchido automaticamente por padrão.
 
Os campos:
 
Client ID e Client Secret possuem uma tecnologia de criptografia, ou seja, após informar os dados nos campos o sistema irá criptografar as informações garantindo e mantendo a segurança das informações.
 
Caso haja necessidade de alterações, basta clicar no ícone do "Cadeado", será aberta a tela de Criptografia e após colar ou digitar as informações em tela e selecionar o botão "Confirmar".
 
Também tenha alguma dúvida no dado informado e necessitar validar o dado seguindo os mesmos passos da alteração será aberta a tela de Criptografia e após colar ou digitar as informações em tela e selecionar o botão "Validar", sistema confirma se os dados são os mesmos.
 
Observamos que esta tela possui duas guias, uma de Homologação e Produção. Preencher conforme a necessidade do processo, caso precise realizar testes, parametrize em homologação e posteriormente parametrize o de Produção ou se preferir, pode preencher os dois se possuir os dados.
 
Lembrando que esses dados são confidenciais de uso e exclusivo de cada usuário.
 
Através dessas informações o sistema irá se comunicar com API do Banco para poder realizar os registros dos Lançamentos.
 
Após informado os dados, basta selecionar o botão "Avançar", para seguir os próximos passos.
 
'''Developer Application Key:''' conforme orientação do Banco esses dados são de cunho da própria Desenvolvedora de Software, ou seja, elas serão fixas do Sistema CIGAM, sendo setadas por padrão.
 
'''Client ID:''' Identificação da Aplicação, é necessário informar a codificação passada pelo Banco. Este dado é criptografado.
 
'''Client Secret:''' Credencial do banco, é necessário informar a codificação passada pelo Banco. Este dado é criptografado.

 
 
<center>'''Parâmetros: Passo 1 de 4'''
[[Arquivo:Parametros Passo 1de4.png|750x500px|nenhum|Parametros_Passo_1de4]]
 
Atualizado o Scope para Versão 2 do Open Banking sendo setado por padrão, para maiores informações acessar o título do Manual:
 
'''Quais são as novidades após atualização para Versão 2 do Open Banking?'''

=='''Etapa 2 (Portador de Remessa e Retorno - Pagamento: Passo 2 de 4):'''==

Nesta etapa deve ser selecionado o Portador que será considerado para o envio da Remessa de Pagamento (onde estarão os boletos em aberto) e nesta mesma tela informar o qual Portador será considerado para o Retorno de Pagamento (onde serão liquidados os retornos de Pagamentos).
 
Nesta etapa, é possível pular, caso não utilize ainda o Envio de Pagamentos do Open Banking.
 
'''Pular:''' caso deseja pular essa etapa e prosseguir com o processo de parametrização do Open Banking.
 
'''Avançar:''' dá continuidade ao processo de parametrização, após selecionado uma opção.
 
Para continuar a parametrização selecione o botão "Pular" e siga para os próximos passos.
 
<center>'''Portador de Remessa e Retorno: Passo: 2 de 4'''
[[Arquivo:Passo 2 Portador Pagamentos 2.png|750x500px|nenhum|Passo_2_Portador_Pagamentos_2]]
 

=='''Etapa 3 (Convênios de Cobrança: Passo 3 de 4):'''==
 
Nesta etapa o sistema avalia sua base de dados, e localiza os Convênios parametrizados para o Banco do Brasil, onde serão listados.
O sistema possibilita a parametrização de Convênios específicos bem como caso seja optado, selecionando o botão "Pular" o sistema criará automaticamente o Convênio "Geral", ao qual utiliza dados do Portador registrado.
 
'''Pular:''' caso deseja pular essa etapa e prosseguir com o processo de parametrização do Open Banking.
 
'''Avançar:''' dá continuidade ao processo de parametrização, após selecionado uma opção.
 
<center>'''Convênios de Cobrança: Passo 3 de 4'''
[[Arquivo:Passo 3 Convenios Cobranca 2.png|750x500px|nenhum|Passo_3_Convenios_Cobranca_2]]
 

=='''Etapa 3 (Portador de Remessa e Retorno - Cobrança: Passo 3 de 4):'''==
 
Nesta etapa deve ser selecionado o Portador que será considerado para o envio da Remessa de Cobrança (onde estarão os boletos em aberto) e nesta mesma tela informar o qual Portador será considerado para o Retorno de Cobrança (onde serão liquidados os retornos de Cobranças).
 
'''Avançar:''' dá continuidade ao processo de parametrização, após selecionado uma opção.
 
<center>'''Portador de Remessa e Retorno - Cobrança: Passo 3 de 4'''
[[Arquivo:Passo 3 Convenios Cobranca Portador.png|750x500px|nenhum|Passo_3_Convenios_Cobranca_Portador]]
 
Atualizado Wizard para Versão 2 do Open Banking, disponibilizando duas opções:
 
'''- Direto''': esta opção tem como finalidade registrar o Boleto no momento da sua geração, ou seja, quando selecionado ativa propriedade ao qual ao gerar o Boleto Bancário o sistema automaticamente envia o registro Open Banking, sem a necessidade de fazer o processo de envio da Remessa Open Banking do título.
 
'''- PIX''': esta opção tem como finalidade registrar uma operação PIX para os Boletos emitido de forma Direta (opção '''Direto''' marcado).
 
Esta opção é válida '''SOMENTE''' para o Banco do Brasil.
 
Para maiores informações acessar o título do Manual:
 
'''Quais são as novidades após atualização para Versão 2 do Open Banking?'''

=='''Etapa 4 (Relatório: Passo 4 de 4):'''==

 
Nesta etapa o sistema irá buscar automaticamente o Modelo de Relatório Padrão, caso exista no ambiente, facilitando assim todo processo de parametrização e implementação para usuário.
 
A busca é realizado '''(%CIGAM_INSTAL%RF00071_remessas.RTF)''', com isso é importante que o Modelo de Relatório (RF00071_remessas.RTF) esteja devidamente localizado na pasta padrão do Cigam_Instal, como por exemplo:
 
'''%CIGAM_INSTAL%''' = P:\Cigam11\Projects\Controle\MACIEL\Financeiro_Open_Banking
 
"P:\Cigam11\Projects\Controle\MACIEL\Financeiro_Open_Banking\Modelos\Relatorios\Gestao Financeira\RF00071_remessas.RTF"
 
Clicar em "Avançar" para dar seguimento.
 
<center>'''Assistente de Parâmetros Open Banking: Passo 4 de 4'''
[[Arquivo:Assistente Passo 4.png|750x500px|semmoldura|nenhum|Assistente_Passo_4]]
 
 

=='''Etapa Conclusão (Parâmetros de Convênio Open Banking - Conclusão):'''==

 
Esta etapa o sistema faz validação da comunicação com o Banco através da API verificando o ambiente se esta tudo ok, listando em tela.
 
Após a consulta estar "OK", basta clicar no botão "Concluir" e seu ambiente estará apto para utilizar a funcionalidade Open Banking.
 
<center>'''Parâmetros de Convênio Open Banking: Passo Final - Conclusão'''
[[Arquivo:Etapa Final Conclusao.png|750x500px|nenhum|Etapa_Final_Conclusao]]
 
'''Homologação:''' Conexão realizada com sucesso.
 
'''Produção:''' O servidor remoto retornou um erro: (401) Não Autorizado. Isso ocorre quando não houve a parametrização dos dados em Produção como foi realizado no ambiente de Homologação conforme o passo a passo, ou possa ter ocorrido algum erro na comunicação com o Banco.
 
<center>'''Convênio Cadastrado com Sucesso - Cobrança'''
[[Arquivo:Convenio Cobranca Homolog.png|750x500px|nenhum|Convenio_Cobranca_Homolog]]
 
'''Ambiente:''' lista qual é o ambiente cadastrado, sendo apenas duas opções: Homologação e Produção.
 
'''Convênios:''' neste grupo serão listados todos os convênios cadastrados, bem como todas informações pertinentes como:
 
- Portador;
 
- Agência;
 
- Número Conta;
 
- Portador de retorno;
 
'''- Direto:''' esta opção tem como finalidade registrar o Boleto no momento da sua geração, ou seja, quando selecionado ativa propriedade ao qual ao gerar o Boleto Bancário o sistema automaticamente envia o registro Open Banking, sem a necessidade de fazer o processo de envio da Remessa Open Banking do título.
 
Também quando selecionada, terá uma particularidade na questão da Emissão de Boletos em lote pela Rotina de Emissão de Boletos Personalizados. A rotina na guia '''Opções''' tem a opção '''Enviar somente Lançamentos não marcados e marca-los''', caso esteja desmarcada o Registro Open Banking ocorrerá da mesma forma que o sistema irá marcar a opção '''Boleto Impresso''' do Lançamento Financeiro, registrando a Operação Open Banking.
Isso ocorre para manter a integridade, já que esta operação é considerada única no registro, sendo então necessário marcar a '''Boleto Impresso''', para poder conseguir realizar alterações como Alteração de Vencimento ou mesmo a Baixa, sendo uma condição de Sistema.
 
'''- PIX:''' esta opção fica habilitada somente quando selecionado a opção Direto, ela tem como finalidade registrar uma operação PIX para os Boletos emitido de forma Direta (opção Direto marcado).
 
Esta opção é válida SOMENTE para o Banco do Brasil.
 
Ao emitir o Boleto do Lançamento o sistema marca as 3 opções:
 
- Boleto Impresso;
 
- Remessa Enviada;
 
- Código de Barras Lido;
 
'''U.N Ced.:''' esta opção tem como finalidade possibilitar o envio e registro de Boletos de outras Unidades de Negócio.
 
Basta informar a Unidade desejada no campo e o sistema entenderá quando realizado o processo de registro de um título que não seja da Unidade Matriz, então sistema identifica e realiza o processo de envio e registro.
Se deixar em Branco a Unidade Cedente irá considerar para todas Unidades de Negócio.
 
 
<center>'''Convênio Cadastrado com Sucesso - Pagamento'''
[[Arquivo:Convenio Pagamento Homolog.png|750x500px|nenhum|Convenio_Pagamento_Homolog]]
 
'''Ambiente:''' lista qual é o ambiente cadastrado, sendo apenas duas opções: Homologação e Produção.
 
'''Convênios:''' neste grupo serão listados todos os convênios cadastrados, bem como todas informações pertinentes como:
 
- Portador;
 
- Agência;
 
- Número Conta;
 
- Portador de retorno;
 
<center>'''Ícone Credenciais'''
[[Arquivo:Icone Credenciais API.png|750x500px|nenhum|Icone_Credenciais_API]]
 
Através deste ícone é possível verificar os Parâmetros API parametrizados, tanto em homologação quanto em produção.
 
 
<center>'''Ícone Endereços'''
[[Arquivo:Icone Endereços.png|750x500px|nenhum|Icone_Endereços]]
 
Através deste ícone é possível verificar todos endereços de URLs parametrizados.

=='''O que significa a Categoria Open Banking de acesso?'''==
 
 A Categoria Open Banking é uma Categoria que é habilitada mediante a utilização de um Portador parametrizado com as Configurações de Banco Open Banking. A mesma tem como objetivo proporcionar maior agilidade e gerenciamento das atividades relacionadas a Remessa de Cobrança Online.
 
'''Categoria Open Banking'''
 
 
<center>'''Categoria Open Banking'''
[[Arquivo:Categoria Open Banking.png|750x500px|semmoldura|nenhum|Categoria_Open_Banking]]
 
 

'''Registrar:''' item de categoria tem como funcionalidade registrar o Boleto Bancário Online. Substitui todo o processo de geração do arquivo de Remessa de Cobrança, acessar o site e remeter ao Banco esse arquivo, com apenas um clique na opção.
 
'''Reenviar:''' item de categoria tem como funcionalidade possibilitar o reenvio de registros que estão com alguma pendência ou algum erro de parametrização. Será habilitado somente quando já possuir movimento de "Registro" enviado, cuja Situação estiver com pendência ou erro.
 
'''Baixar:''' item de categoria tem como funcionalidade comunicar o Banco referente a Baixa do movimento em questão do Boleto Bancário. Utilizado para eventuais falhas operacionais, como registrado um movimento por engano, ou negociações diretamente com cliente a parte. Eliminando então também todo processo de geração do arquivo de Remessa Bancária com Comando de Remessa de Baixa e o processo de remeter ao Banco o arquivo, sendo realizado tudo online através desta opção.
 
'''Registrar Alteração:''' item de categoria tem como funcionalidade registrar uma alteração ocorrida referente ao "Vencimento" do Lançamento Financeiro.
Ao realizar alteração da Data de Vencimento do Lançamento Financeiro que está com "Situação Open Banking" igual "Registrado" e ocorrer alteração no Vencimento, o sistema emite uma mensagem possibilitando já o envio da alteração no momento ou mais tarde através desta opção de "Registrar Alteração".
 
'''Histórico:''' item de categoria tem como funcionalidade gravar todas movimentações realizadas relativo ao Open Banking. Registros, Baixas, Erros...


='''Layout e Detalhamento de Campos API'''=

==Registro de Boletos==
<center>

{| class="wikitable sortable"
|-
! Nº!!Campo JSON!!Descriçao do Banco!!Campo CIGAM!!Tabela!!Obrigatório!!Ex.Homolog!!Observações
|-
| 1 ||numeroConvenio||Número do convênio de Cobrança do Cliente||Número Controle||Portador||Obrigatório|| 3128557 || Em produção, informar o número do convênio de cobrança, com 7 dígitos.
|-
| 2 || numeroCarteira || Características do serviço de boleto bancário e como ele deve ser tratado pelo banco. || Carteira || Portador || Obrigatório || 17 || Em produção, informar o número da carteira de cobrança.
|-
| 3 || numero Variacao Carteira || Número da variação da carteira do convênio de cobrança. || Variação || Portador || Obrigatório || 35 || Em produção, informar o número da variação da carteira de cobrança.
|-
| 4 || codigoModalidade || Identifica a característica dos boletos dentro das modalidades de cobrança existentes no banco.
'''Domínios:'''
 
01 - SIMPLES
 
04 - VINCULADA
|| Tipo Serviço || Portador || Obrigatório || 1 ou 4 ||
|-
| 5 || dataEmissao || Data de emissão do boleto (formato "dd.mm.aaaaa"). || Data Documento || Boletos || Obrigatório || “15.12.2020” || Qualquer data, a partir da data atual, no formato “dd.mm.aaaa”.
|-
| 6 || dataVencimento || Data de vencimento do boleto. || Vencimento || Boletos || Obrigatório || “31.03.2021” || Qualquer data maior ou igual que a data de emissão, no formato “dd.mm.aaaa”.
|-
| 7 || valorOriginal || Valor do boleto no registro. || Saldo || LANCAM || Obrigatório || 123.45 || Valor do boleto no registro, em reais. Deve ser maior que a soma dos campos “valorDesconto” e “valorAbatimento”, se informados. Deve ser maior do que zero. No caso de emissão com valor equivocado, sugerimos cancelar o boleto e emitir um novo.
|-
| 8 || valorAbatimento || Valor do abatimento (reduz valor do boleto) expresso em moeda corrente. || 0 || 0 || Opcional || 12.34 || Valor de dedução do boleto. Se informado, deve ser maior que zero.
|-
| 9 || quantidade DiasProtesto || Quantos dias após a data de vencimento do boleto para iniciar o processo de cobrança através de protesto. (valor inteiro >= 0). || Protesto || Portador || Opcional || 0 ou maior que zero || Quantidade de dias após a data de vencimento do boleto para iniciar o processo de cobrança através de protesto. (3 a 5 dias úteis ou 6 a 29, 35, 40 ou 45 dias corridos)
|-
|10||indicador Aceite Titulo Vencido||Indicador de que o boleto pode ou não ser recebido após o vencimento. Se não informado, será assumida a informação de limite de recebimento parametrizada no convênio.|| X || X || Obrigatório || S ou N || Quando informado “S”, em conjunto com o campo “numeroDias LimiteRecebimento”, será definida a quantidade de dias corridos após o vencimento que este boleto ficará disponível para pagamento. Atenção: neste caso, se o campo “numeroDias LimiteRecebimento” ficar com valor zero, também será assumida a informação de limite de recebimento parametrizada no convênio.

Quando informado “N”, está definindo que o boleto NÃO permite pagamento em atraso.

Quando informado “N”, está definindo que o boleto NÃO permite pagamento em atraso.
|-
| 11 || numeroDias LimiteRecebimento || Número de dias limite para recebimento. Informar valor inteiro > 0. || X || X || Opcional || 0 ou maior que zero ||
|-
| 12 || codigoAceite || Código para identificar se o boleto de cobrança foi aceito (reconhecimento da dívida pelo Pagador).
'''Domínios:'''
 
A - ACEITE
 
N - NAO ACEITE
|| Aceite || Portador || Obrigatório || A ou N ||
|-
| 13 || codigoTipoTitulo || Código para identificar o tipo de boleto de cobrança. [[#Domínios: codigoTipoTitulo|Clique aqui]] para visualizar os Domínios. || Especie || Portador || Obrigatório || 2 ||
|-
| 14 || descricao TipoTitulo || Descrição do tipo de boleto. || 0 || 0 || Opcional || “DM” || Descrição do tipo de boleto. Se houver dúvidas com relação ao tipo, consultar as regras da Febraban.
|-
| 15 ||indicador Permissao RecebimentoParcial|| Código para identificação da autorização de pagamento parcial do boleto.
'''Domínios:'''
 
S - SIM
 
N - NÃO
|| X || X || Obrigatório || S ou N ||
|-
| 16 || numeroTitulo Beneficiario || Número de identificação do boleto (correspondente ao SEU NÚMERO), no formato STRING (Limitado a 15 caracteres - Letras Maiúsculas). || Serie || LANCAM || Opcional || “123456” ||
|-
| 17 || campo Utilizacao Beneficiario || Informações adicionais sobre o beneficiário. || Lançamento || LANCAM || Opcional || “UM TEXTO” || Pode ter até 30 caracteres, em maiúsculas.
|-
| 18 || numero TituloCliente || Número de identificação do boleto (correspondente ao NOSSO NÚMERO). || Nosso Número || Boletos || Obrigatório || “00031285570000030000” || Formato STRING, com 20 dígitos, que deverá ser formatado da seguinte forma: “000” + (número do convênio com 7 dígitos) + (10 algarismos - se necessário, completar com zeros à esquerda).
|-
| 19 || mensagem Bloqueto Ocorrencia || Mensagem definida pelo beneficiário para ser impressa no boleto (Limitado a 30 caracteres) || Texto 4 || Boletos || Opcional || “Outro texto” || Mensagem definida pelo beneficiário para ser impressa no boleto. Pode ter até 165 caracteres, sendo que cada 55 caracteres equivalem a uma linha de mensagem. Atenção: não são permitidos caracteres de escape ( \r ou \n ).
|-
| 20 || desconto || Define a ausência ou a forma como será concedido o desconto para o Título de Cobrança. || X || X || Opcional || ||
|-
| 20.1 || tipo || Define como o desconto será concedido.
'''Domínio:'''
0 - Sem desconto
 
1 - Valor fixo até a data informada
 
2 - percentual até a data informada.
|| Valor Desconto || LANCAM || Opcional || 0 ou 1 ou 2 ||
|-
| 20.2 || dataExpiracao || Define a data de expiração do desconto (somente se tipo > 0), no formato “dd.mm.aaaa”. || Vencimento* || LANCAM || Opcional || “30.01.2021” ||
|-
| 20.3 || porcentagem || Define a porcentagem do desconto (somente se tipo = 2). || X || X || Opcional || 5.00 ||
|-
| 20.4 || valor || Define o valor do desconto (somente se tipo = 1). || Valor Desconto* || LANCAM || Opcional || 12.34 ||
|-
| 21 || segundoDesconto || Define a forma como será concedido um segundo desconto para o boleto. Só pode ser usado se for definido um primeiro desconto. O tipo do segundo desconto será igual ao do primeiro desconto. || X || X || Opcional || ||
|-
| 21.1 || dataExpiracao || Define a data de expiração do desconto, no formato “dd.mm.aaaa”. Deve ser posterior a data de expiração do primeiro desconto. || X || X || Opcional || “10.02.2021” ||
|-
| 21.2 || porcentagem || Define a porcentagem do desconto (somente se o tipo = 2). || X || X || Opcional || 5.00 ||
|-
| 21.3 || valor || Define o valor do desconto (somente se o tipo = 1). || X || X || Opcional || 12.34 ||
|-
| 22 || terceiroDesconto || Define a forma como será concedido um terceiro desconto para o boleto. Só pode ser usado se for definido um segundo desconto. O tipo do terceiro desconto será igual ao do primeiro desconto. || X || X || Opcional || ||
|-
| 22.1 || dataExpiracao || Define a data de expiração do desconto, no formato “dd.mm.aaaa”. Deve ser posterior a data de expiração do segundo desconto. || X || X || Opcional || 20.02.2021” ||
|-
| 22.2 || porcentagem || Define a porcentagem do desconto (somente se o tipo = 2). || X || X || Opcional || 5.00 ||
|-
| 22.3 || valor || Define o valor do desconto (somente se o tipo = 1). || X || X || Opcional || 12.34 ||
|-
| 23 || jurosMora || Código utilizado pela FEBRABAN para identificar o tipo de taxa de juros. [[#Domínios: jurosMora|Clique aqui]] para visualizar os Domínios.
|| X || X || Opcional || || Se informado ‘0’ (zero) ou ‘3’ (três), os campos “PERCENTUAL DE JUROS DO TÍTULO” e “VALOR DO JUROS DO TÍTULO” não devem ser informados ou ser informados igual a ‘0’ (zero).
O valor de juros e multa incidem sobre o valor atual do boleto (valor do boleto - valor de abatimento).
|-
| 23.1 || tipo || Código utilizado pela FEBRABAN para identificar o tipo da taxa de juros. [[#Domínios: tipo (jurosMora)|Clique aqui]] para visualizar os Domínios.
|| Juros Dia || LANCAN || Opcional || 0 ou 1 ou 2 ou 3 ||
|-
| 23.2 || porcentagem || Define a taxa mensal de juros (somente informar se tipo = 2). A taxa incide sobre o valor atual do boleto (valorOriginal - valorAbatimento) || X || X || Opcional || 1.00 ||
|-
| 23.3 || valor || Define o valor fixo por dia de atraso (somente informar se tipo = 1). || Juros Dia || LANCAM || Opcional || 0.33 ||
|-
| 24 || multa || Define a forma que será cobrada (ou não) a multa por atraso no pagamento. || X || X || Opcional || ||
|-
| 24.1 || tipo || Código utilizado pela FEBRABAN para identificar o tipo da multa. [[#Domínios: tipo (multa)|Clique aqui]] para visualizar os Domínios.
|| Valor Multa || LANCAM || Opcional || 0 ou 1 ou 2 ||
|-
| 24.2 || data || Define a data a partir da qual será cobrada a multa (somente informar se tipo = 1 ou 2). Deve ser posterior a data de vencimento do boleto. || Tolerância Multa || LANCAM || Opcional || “01.04.2021” ||
|-
| 24.3 || porcentagem || Define a porcentagem da multa (somente informar se tipo = 2). A porcentagem incide sobre o valor atual do boleto (valorOriginal - valorAbatimento). || Valor || LANCAM || Opcional || 2.00 ||
|-
| 24.4 || valor || Define o valor da multa (somente informar se tipo = 1). || Valor Multa || LANCAM || Opcional || 10.00 ||
|-
| 25 || pagador || Identifica o pagador do boleto. || X || X || Obrigatório || ||
|-
| 25.1 || tipoInscricao || Define o tipo do inscrição do pagador.
'''Domínio:'''
 
1 - Pessoa física
 
2 - Pessoa Jurídica.
|| X || X || Obrigatório || 1 ou 2 ||
|-
| 25.2 || numeroInscricao || Define o número de inscrição do pagador; se pessoa física, CPF; se pessoa jurídica, CNPJ. Numérico, deve ser preenchido sem ponto, hífen, barra, e sem zeros à esquerda. || X || X || Obrigatório || 97965940132 (PF) ou 74910037000193 (PJ) ||
|-
| 25.3 || nome || Identifica o nome do pagador. Pode ter até 30 caracteres. || Pessoa || Empresa || Obrigatório || “Odorico Paraguassu” ||
|-
| 25.4 || endereco || Identifica o endereço do pagador. Pode ter até 30 caracteres. || X || X || Obrigatório || “Avenida Dias Gomes 1970” ||
|-
| 25.5 || cep || Identifica o CEP do pagador. Numérico, deve ser preenchido sem ponto ou hífen, e sem zeros à esquerda. || CEP || Empresa || Obrigatório || 77458000 ||
|-
| 25.6 || cidade || Identifica a cidade do pagador. Pode ter até 30 caracteres. || Municipio || Empresa || Obrigatório || “Sucupira” ||
|-
| 25.7 || bairro || Identifica o bairro do pagador. Pode ter até 30 caracteres. || Bairro || Empresa || Obrigatório || “Centro” ||
|-
| 25.8 || uf || Identifica o estado (UF) do pagador. Deve ter 2 caracteres e ser um estado válido. || UF || Empresa || Obrigatório || “TO” ||
|-
| 25.9 || telefone || Define o número de telefone do pagador. Pode ter até 30 caracteres. || Fone || Empresa || Opcional || “63987654321” ||
|-
| 26 || beneficiarioFinal || Identifica o beneficiário final (antigo avalista) do boleto, se houver. || X || X || Opcional || ||
|-
| 26.1 || tipoInscricao || Define o tipo do inscrição do beneficiário final (antigo avalista).
'''Domínio:'''
 
1 - Pessoa física
 
2 - Pessoa Jurídica.
|| X || X || Opcional || 1 ou 2 ||
|-
| 26.2 || numeroInscricao || Define o número de inscrição do beneficiário final (antigo avalista); se pessoa física, CPF; se pessoa jurídica, CNPJ. Numérico, deve ser preenchido sem ponto, hífen, barra, e sem zeros à esquerda. || X || X || Opcional || 66779051870 (PF) ou 98959112000179 (PJ) ||
|-
| 26.3 || nome || Identifica o nome do beneficiário final (antigo avalista). Pode ter até 30 caracteres. || X || X || Opcional || “Dirceu Borboleta” ||
|-
| 27 || quantidadeDiasNegativacao || Quantidade de dias, após o vencimento do Boleto, que o Boleto será Negativado || Protesto || Portador || Opcional || 0 ou maior que zero ||
|-
| 28 || orgaoNegativador || Código do órgão negativador selecionado.
'''Domínio:'''
 
10 - SERASA
 
11 - QUOD.
|| X || X || Opcional || 10 ou 11 ||
|-
| 29 || indicadorPix || Código para informar se o boleto terá um QRCode Pix atrelado. Se não informado, ou utilizado caractere inválido, o sistema assumirá ‘N’.
'''Domínio:'''
 
S - QRCode dinâmico
 
N - sem Pix.
|| X || X || Opcional || S ou N || Atenção: conforme regulamentação do Bacen, é permitido somente para modalidade de cobrança simples (ver codigoModalidade).
|-
|}

</center>

==='''Domínios: codigoTipoTitulo'''===

• 1 - CHEQUE
 
• 2 - DUPLICATA MERCANTIL
 
• 3- DUPLICATA MTIL POR INDICACAO
 
• 4 - DUPLICATA DE SERVICO
 
• 5 - DUPLICATA DE SRVC P/INDICACAO
 
• 6 - DUPLICATA RURAL
 
• 7 - LETRA DE CAMBIO
 
• 8 - NOTA DE CREDITO COMERCIAL
 
• 9 - NOTA DE CREDITO A EXPORTACAO
 
• 10 - NOTA DE CREDITO INDULTRIAL
 
• 11 - NOTA DE CREDITO RURAL
 
• 12 - NOTA PROMISSORIA
 
• 13 - NOTA PROMISSORIA RURAL
 
• 14 - TRIPLICATA MERCANTIL
 
• 15 - TRIPLICATA DE SERVICO
 
• 16 - NOTA DE SEGURO
 
• 17 - RECIBO
 
• 18 - FATURA
 
• 19 - NOTA DE DEBITO
 
• 20 - APOLICE DE SEGURO
 
• 21- MENSALIDADE ESCOLAR
 
• 22 - PARCELA DE CONSORCIO
 
• 23 - DIVIDA ATIVA DA UNIAO
 
• 24- DIVIDA ATIVA DE ESTADO
 
• 25 - DIVIDA ATIVA DE MUNICIPIO
 
• 31 - CARTAO DE CREDITO
 
• 32 - BOLETO PROPOSTA
 
• 33 - BOLETO APORTE
 
• 99 - OUTROS.
 

==='''Domínios: jurosMora'''===

• 0 - DISPENSAR
 
• 1 - VALOR DIA ATRASO
 
• 2 - TAXA MENSAL
 
• 3 - ISENTO
 

==='''Domínios: tipo (jurosMora)'''===

• 0 - Dispensar
 
• 1 - Valor fixo por dia de atraso
 
• 2 - Taxa mensal
 
• 3 - Isento
 

==='''Domínios: tipo (multa)'''===

• 0 - Dispensar
 
• 1 - Valor fixo (a partir da data estipulada no registro)
 
• 2 - Percentual (a partir da data estipulada no registro).
 

==Retorno de Boletos==

<center>

{| class="wikitable"
|-
! Nº !! Campo JSON !! Descriçao do Banco !! Campo CIGAM !! Tabela !! Obrigatório !! Exemplo para HOMOLOGAÇÃO !! Observações
|-
| 1 || gw-app-key || É a chave de acesso do aplicativo do desenvolvedor utilizada em produção, obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo. || 0 || 0 || Obrigatório || 0021239456d80136 bebf005056891bed || >>REVISAR<<
|-
| 2 || indicadorSituacao || Situação do boleto.
'''Domínios:'''
 
A - Em ser
 
B - Baixados/ Protestados/ Liquidados
|| X || X || Obrigatório || A ou B || Campo obrigatoriamente MAIÚSCULO.
|-
| 3 || agenciaBeneficiario || Indica o número da agência cadastrada como beneficiária do convênio, sem o dígito verificador e sem zeros a esquerda. || Agência || Portador || Obrigatório || 452 ||
|-
| 4 || contaBeneficiario || Indica o número da conta cadastrada como beneficiária do convênio, sem o dígito verificador e sem zeros a esquerda. || Conta Número || Portador || Obrigatório || 123873 ||
|-
| 5 || carteiraConvenio || Indica o número da carteira do convênio de cobrança. || Carteira || Portador || Obrigatório || 17 ||
|-
| 6 || variacaoCarteiraConvenio || Indica o número da variação do convênio de cobrança. || Variação || Portador || Opcional || 35 ||
|-
| 7 || modalidadeCobranca || Indica a modalidade de cobrança na qual o boleto está cadastrado no BB.
'''Domínio''':
 
1 - Simples
 
4 - Vinculada.
|| Tipo Serviço || Portador || Opcional || 1 ou 4 ||
|-
| 8 || cnpjPagador || Indica o CNPJ do pagador a ser pesquisado, sem o dígito e sem zeros a esquerda. || CNPJ/CPF || Cobrança || Opcional || 543483490001 || Informar em conjunto com digitoCnpjPagador.
|-
| 9 || digitoCNPJPagador || Indica o dígito do CNPJ do pagador a ser pesquisado, sem zeros a esquerda.
|| X || X || Opcional || 48 || Informar em conjunto com cnpjPagador.
|-
| 10 || cpfPagador || Indica o CPF do pagador a ser pesquisado, sem o dígito e sem zeros a esquerda.
|| CNPJ/CPF || Cobrança || Opcional || 979659401 || Informar em conjunto com digitoCpfPagador.
|-
| 11 || digitoCPFPagador || Indica o dígito do CPF do pagador a ser pesquisado, sem zeros a esquerda.
|| X || X || Opcional || 32 || Informar em conjunto com cpfPagador.
|-
| 12 || dataInicioVencimento || Data inicial de vencimento que delimita o período da consulta, formato dd.mm.aaaa. Se informada data posterior a atual, o campo dataFimVencimento deve ser preenchido com data posterior ou igual a dataInicioVencimento. Se informada data anterior ou igual a data atual e o campo dataFimVencimento não for informado, o sistema assume a data atual como dataFimVencimento.|| X || X || Opcional || 01.01.2021 ||
|-
| 13 || dataFimVencimento || Data final de vencimento que delimita o período da consulta, formato dd.mm.aaaa. Se informada, deve ser uma data posterior ou igual a dataInicioVencimento. || X || X || Opcional || 30.01.2021 ||
|-
| 14 || dataInicioRegistro || Data inicial de registro que delimita o período da consulta, formato dd.mm.aaaa. Deve ser anterior ou igual a data atual. || X || X || Opcional || 01.11.2020 ||
|-
| 15 || dataFimRegistro || Data fim de registro que delimita o período da consulta, formato dd.mm.aaaa.
|| X || X || Opcional || 30.11.2020 || Se informada, deve ser posterior ou igual a dataInicioRegistro, e igual ou anterior à data atual. Se não informada, o sistema assume a data atual.
|-
| 16 || dataInicioMovimento || Data início de movimento que delimita o período de consulta de boletos baixados, liquidados ou protestados, formato dd.mm.aaaa. || X || X || Opcional || 01.12.2020 || Deve ser anterior ou igual à data atual.
|-
| 17 || dataFimMovimento || Data fim de movimento que delimita o período de consulta de boletos baixados, liquidados ou protestados, formato dd.mm.aaaa. || X || X || Opcional || 15.12.2020 || Se informada, deve ser posterior ou igual a dataInicioMovimento, e igual ou anterior à data atual. Se não informada, o sistema assume a data atual.
|-
| 18 || codigoEstadoTituloCobranca || Código da situação atual do boleto. [[#Domínios: codigoEstadoTituloCobranca|Clique aqui]] para visualizar os Domínios. || X || X || Opcional || entre 1 e 21 ||
|-
| 19 || boletoVencido || Define se a pesquisa trará apenas boletos vencidos ou não. || X || X || Opcional || S ou N || Sempre MAIÚSCULA.
|-
| 20 || indice || Representa o índice da listagem pelo qual sua pesquisa se iniciará, podendo retornar até 300 registros por chamada. O default é 0, o que trará os resultados de 0 a 299 (se houver). || X || X || Opcional || qualquer inteiro || Quando o resultado da pesquisa tiver mais que 300 registros, na resposta, o campo indicadorContinuidade retornará com “S”. Recomendamos utilizar o valor do campo proximoIndice (informado na resposta), no campo indice da próxima chamada, para retornar com os próximos registros.
|-
|}
</center>


==='''Domínios: codigoEstadoTituloCobranca'''===

1 - NORMAL
 
2 - MOVIMENTO CARTORIO
 
3 - EM CARTORIO
 
4 - TITULO COM OCORRENCIA DE CARTORIO
 
5 - PROTESTADO ELETRONICO
 
6 - LIQUIDADO
 
7 - BAIXADO
 
8 - TITULO COM PENDENCIA DE CARTORIO
 
9 - TITULO PROTESTADO MANUAL
 
10 - TITULO BAIXADO/PAGO EM CARTORIO
 
11 - TITULO LIQUIDADO/PROTESTADO
 
12 - TITULO LIQUID/PGCRTO
 
13 - TITULO PROTESTADO AGUARDANDO BAIXA
 
14 - TITULO EM LIQUIDACAO
 
15 - TITULO AGENDADO BB
 
16 - TITULO CREDITADO
 
17 - PAGO EM CHEQUE - AGUARD.LIQUIDACAO
 
18 - PAGO PARCIALMENTE
 
19 - PAGO PARCIALMENTE CREDITADO
 
21 - TITULO AGENDADO OUTROS BANCOS

==Alteração de Boletos==

<center>

{| class="wikitable"
|-
! Nº !! Campo JSON !! Descriçao do Banco !! Campo CIGAM !! Tabela !! Obrigatório !! Exemplo para HOMOLOGAÇÃO !! Observações
|-
| 1 || numeroConvenio || Identifica o número do convênio de cobrança. || Número Controle || Portador || Obrigatório || 3128557 ||
|-
| 2 || indicador Cancelar Abatimento || Indica a intenção (ou não) de cancelar o abatimento concedido a um boleto. || X || X || Obrigatório || S ou N ||
|-
| 3 || alteracaoAbatimento || X || X || X || Parcial || ||
|-
| 3.1 || novoValorAbatimento || Novo valor do abatimento (reduz valor do boleto) expresso em moeda corrente. || X || X || Parcial || 2.00 ||
|-
| 4 || indicador Alterar DataDesconto || Indica a intenção (ou não) de alterar a data de desconto(s) concedido(s) em um boleto. || X || X || Obrigatório || S ou N || Se sim, deve ser usado em conjunto com o campo alteracaoDataDesconto.
|-
| 5 || alteracao DataDesconto || Nova data limite do Primeiro Desconto || X || X || Parcial || || Observar as regras para datas de desconto no campo desconto da Geração de Boletos.
|-
| 5.1 || novaData LimitePrimeiro Desconto || Nova data limite do Primeiro Desconto || X || X || Parcial || “01.01.2021” ||
|-
| 5.2 || novaData Limite SegundoDesconto || Nova data limite do Segundo Desconto || X || X || Parcial || “10.01.2021” ||
|-
| 5.3 || novaData LimiteTerceiro Desconto || Nova data limite do Terceiro Desconto || X || X || Parcial || “20.01.2021” ||
|-
| 6 || indicador Alterar Desconto || Indica a intenção (ou não) de alterar o desconto concedido em um boleto. || X || X || Obrigatório || S ou N || Se sim, deve ser usado em conjunto com o campo alteracaoDesconto.
|-
| 7 || alteracaoDesconto || || X || X || Parcial || || Observar as instruções sobre o campo desconto na Geração de Boletos.
|-
| 8 || indicador Alterar EnderecoPagador || Indica a intenção (ou não) de alterar o endereço do pagador no boleto. Se sim, deve ser usado em conjunto com o campo alteracaoEndereco. || X || X || Obrigatório || S ou N || '''Atenção:''' a alteração do endereço não implica em nova geração ou envio de boleto. Isso é responsabilidade do beneficiário.
|-
| 9 || alteracaoEndereco || || X || X || Parcial || || Observar as instruções sobre o campo pagador na Geração de Boletos.
|-
| 10 || indicador AlterarPrazo BoletoVencido || Indica a intenção (ou não) de alterar o prazo para recebimento de boleto vencido. || X || X || Obrigatório || S ou N || Se sim, deve ser usado em conjunto com o campo alteracaoPrazo.
|-
| 11 || alteracaoPrazo || || X || X || Parcial || ||
|-
| 11.1 || quantidade DiasAceite || Define a quantidade e dias corridos após o vencimento em que o boleto poderá ser recebido. Equivalente ao campo numeroDiasLimiteRecebimento na Geração de Boletos. || X || X || Parcial || 0 ou maior que zero ||
|-
| 12 || indicador AlterarSeuNumero || Indica a intenção (ou não) de alterar o campo numeroTituloBeneficiario (equivalente ao SEU NÚMERO) no boleto. || X || X || Obrigatório || S ou N || Se sim, deve ser usado em conjunto com o campo alteracaoSeuNumero.
|-
| 13 || alteracaoSeuNumero || || X || X || Parcial || || Observar as instruções sobre o campo numeroTituloBeneficiario na Geração de Boletos.
|-
| 14 || indicador AtribuirDesconto || Indica a intenção (ou não) de atribuir desconto ao boleto. || X || X || Obrigatório || S ou N || Se sim, deve ser usado em conjunto com o campo desconto.
|-
| 15 || desconto || || X || X || Parcial || || Observar as instruções sobre o campo desconto na Geração de Boletos. Lembrete: o tipo definido para o primeiro desconto será replicado no segundo e no terceiro desconto (se informados).
|-
| 16 || indicador Cancelar Protesto || Indica a intenção (ou não) de cancelar uma instrução de protesto enviada ao BB na mesma data ou que ainda não tenha sido processada pelo BB.
'''Domínios:'''
 
S - Sim, desejo alterar
 
N - Não, não desejo alterar
|| X || X || Obrigatório || S ou N ||
|-
| 17 || indicadorCobrarJuros || Indica a intenção (ou não) de cobrar juros no boleto.
'''Domínios:'''
 
S - Sim, desejo alterar
 
N - Não, não desejo alterar
|| X || X || Obrigatório || S ou N || Se sim, deve ser usado em conjunto com o campo juros.
|-
| 18 || juros || || || || Parcial || || Observar as instruções sobre o campo juros na Geração de Boletos.
|-
| 19 || indicadorCobrarMulta || Indica a intenção (ou não) de cobrar multa no boleto.
'''Domínios:'''
 
S - Sim, desejo alterar
 
N - Não, não desejo alterar
|| X || X || Obrigatório || S ou N || Se sim, deve ser usado em conjunto com o campo multa.
|-
| 20 || multa || || X || X || Parcial || || Observar as instruções sobre o campo multa na Geração de Boletos.
|-
| 21 || indicador Dispensar Juros || Indica a intenção (ou não) de dispensar os juros sobre o boleto.
'''Domínios:'''
 
S - Sim, desejo alterar
 
N - Não, não desejo alterar
|| X || X || Obrigatório || S ou N ||
|-
| 22 || indicador Dispensar Multa || Indica a intenção (ou não) de dispensar a multa sobre o boleto.
'''Domínios:'''
 
S - Sim, desejo alterar
 
N - Não, não desejo alterar
|| X || X || Obrigatório || S ou N ||
|-
| 23 || indicadorIncluirAbatimento || Indica a intenção (ou não) de incluir abatimento em um boleto.
'''Domínios:'''
 
S - Sim, desejo alterar
 
N - Não, não desejo alterar
|| X || X || Obrigatório || S ou N || Se sim, deve ser usado em conjunto com o campo abatimento.
|-
| 24 || abatimento || || X || X || Parcial || ||
|-
| 24.1 || valorAbatimento || Define o valor a ser concedido como abatimento. || X || X || Parcial || 10.00 ||
|-
| 25 || indicadorNegativar || Indica a intenção (ou não) de negativar ou cancelar a negativação do boleto.
'''Domínios:'''
 
S - Sim, desejo alterar
 
N - Não, não desejo alterar
|| X || X || Obrigatório || S ou N || Se sim, deve ser usado em conjunto com o campo negativacao. Não confundir com protesto.
|-
| 26 || negativacao || || X || X || Parcial || ||
|-
| 26.1 || quantidade DiasNegativacao* || Quantidade de dias, após o vencimento do boleto, em que o boleto será negativado. || Protesto || Portador || Parcial || qualquer inteiro ||
|-
| 26.2 || tipoNegativacao || Código para identificação do tipo de negativação que deverá ser aplicada ao boleto.
'''Domínio:'''
 
1 - incluir
 
2 - alterar prazo
 
3 - cancelar
 
4 - excluir
|| X || X || Parcial || 1 ou 2 ou 3 ou 4 ||
|-
| 26.3 || indicador Nova DataVencimento || Indica a intenção (ou não) de atribuir nova data de vencimento ao boleto. || X || X || Obrigatório || S ou N || Se sim, deve ser usado em conjunto com o campo alteracaoData.
|-
| 27 || alteracaoData || || X || X || Parcial || ||
|-
| 27.1 || novaDataVencimento || Define a nova data de vencimento, formato “dd.mm.aaaa”. || Vencimento || LANCAM || Parcial || “30.04.2021" ||
|-
| 28 || indicadorProtestar || Indica a intenção (ou não) de protestar o boleto. || X || X || Obrigatório || S ou N || Não confundir com negativação.
|-
| 28.1 || indicador SustacaoProtesto || Indica a intenção (ou não) de sustar/cancelar um comando de protesto que já tenha sido processado pelo BB. || X || X || Obrigatório || S ou N ||
|-
| 29 || indicador SustacaoProtesto || Indica a intenção (ou não) de sustar/cancelar um comando de protesto que já tenha sido processado pelo BB. || X || X || Obrigatório || S ou N ||
|}
</center>


='''Como realizar a criação de Lançamentos utilizando a funcionalidade Open Banking?'''=
 
Para a criação de Lançamentos Financeiros acessar o caminho de Menu:
 

'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 

Acessar o botão “Criar” e informar os dados necessários para a criação do Lançamento Financeiro a Receber utilizando o Portador parametrizado para Open Banking.
 
 
'''1- Etapa criação do Lançamento:'''
 
 
<center>'''Criação do Lançamento Financeiro a Receber'''
[[Arquivo:Create Lanc Open Banking.png|750x500px|semmoldura|nenhum|Criação do Lançamento Financeiro]]
 
 

'''2- Etapa Impressão do Boleto Bancário do Lançamento Financeiro:'''
 
Nesta etapa pode ser realizado a impressão do Boleto Bancário diretamente pelo próprio Lançamento Financeiro ou através da rotina de Emissão em lote "Emissão de Boletos Personalizados":
 
 
<center>'''Impressão do Boleto Bancário do Lançamento Financeiro'''
[[Arquivo:Imprimir Boleto Lanc.png|750x500px|semmoldura|nenhum|Impressão Boleto Bancário]]
 
 

'''3- Etapa do Registro do Boleto Open Banking:'''
 
Nesta etapa pode ser realizado o "Registro" do Boleto diretamente pelo próprio Lançamento Financeiro ou através da rotina de Emissão em lote "Emissão de Boletos Personalizados":
Basta acessar a Categoria "Open Banking" e selecionar o Item de Categoria "Registrar".
Sistema irá realizar a comunicação através das parametrizações realizadas das Urls e Tokens de acesso e listará a situação do Registro do Boleto Bancário através do Relatório.
 
 
<center>'''Registrar Boleto Open Banking através Lançamento Financeiro'''
[[Arquivo:Boleto Impresso Registrar OP.png|750x500px|semmoldura|nenhum|Registro Boleto Open Banking]]
 
 
<center>'''Relatório Remessa Bancária OnLine'''
[[Arquivo:Relat Registro Open Banking.png|750x500px|semmoldura|nenhum|Relatório Remessa Bancária Online]]
 
 
Após o registro automaticamente o sistema marca as opções de:
 
- Remessa Enviada
 
- Códigos de Barras Lido
 
 
<center>'''Boleto Bancário Registrado'''
[[Arquivo:Lanc Registrado Validar Historico.png|750x500px|semmoldura|nenhum|Lanc_Registrado_Validar_Historico]]
 
 
Para verificar todas as movimentações realizada sobre Open Banking, elas estão sendo gravadas no Item de Categoria "Histórico" que fica na Categoria "Open Banking".
Ao selecionar o Item de Categoria "Histórico" deve listar o Registro do Boleto Bancário.
 
 
<center>'''Item de Categoria Histórico de Movimentos Open Banking'''
[[Arquivo:Item Categoria Historico.png|750x500px|semmoldura|nenhum|Item_Categoria_Histórico]]
 
 

='''Como realizar o Envio em Lote Open Banking através da rotina Remessa de Cobrança Open Banking?'''=

Assim como é possível realizar o Envio do Registro do Boleto Bancário através do próprio Lançamento Financeiro, existe a possibilidade de realizar esse processo em Lote, quando se tratar de vários registros a serem enviados.
Através do Menu:
 
 
'''Menu: Finanças > Gestão Financeira > Rotinas > EDI> Transmite > Remessa Cobranças Bancárias > Remessa de Cobrança Open Banking'''
 
 
<center>'''Remessa de Cobrança Open Banking'''
[[Arquivo:Remessa_de_Cobranca_Open_Banking_BB3.png|750x500px|semmoldura|nenhum|Remessa_de_Cobranca_Open_Banking]]
 
 
Esta rotina tem um conceito muito simples em relação aos filtros, foram disponibilizados campos essências que permitem ter uma rastreabilidade dos movimentos.

'''Unidade de Negócio:''' informe a Unidade de Negócio desejada para realizar o filtro para busca dos movimentos.
 
'''Data:''' informe a Data desejada para realizar o filtro para busca dos movimentos.
 
'''Vencimento:''' informe o período de Vencimento desejado para realizar o filtro para busca dos movimentos.
 
'''Lançamento:''' informe a faixa de Lançamentos desejada para realizar o filtro para busca dos movimentos.
 
'''Tipo de Pagamento:''' informe o Tipo de Pagamento desejado para realizar o filtro para busca dos movimentos.
 
'''Série:''' informe a Série desejada para realizar o filtro para busca dos movimentos.
 
'''Nota Fiscal:''' informe a faixa de Nota Fiscal desejada para realizar o filtro para busca dos movimentos.
 
'''Conta Financeira:''' informe a Conta Financeira desejada para realizar o filtro para busca dos movimentos.
 
'''Empresa:''' informe a faixa de Empresa desejada para realizar o filtro para busca dos movimentos.
 
'''Cobrança:''' informe a faixa de Empresa de Cobrança desejada para realizar o filtro para busca dos movimentos.
 
 
Após informado os filtros e confirmado a operação da rotina o sistema gera um relatório com a listagem dos movimentos.
Na coluna "Registro", será listado se houve a confirmação ou ocorreu algum erro.
 
 
<center>'''Relatório Remessa de Cobrança Open Banking'''
[[Arquivo:Relat Remessa Bancaria Open Banking.png|750x500px|semmoldura|nenhum|Relat_Remessa_Bancaria_Open_Banking]]
 
 

='''Como realizar o Retorno de Cobrança Open Banking?'''=

Esta rotina tem como funcionalidade realizar a consulta dos registros enviados para o Banco não só através do Open Banking como também títulos enviados pela rotina de Remessa Bancárias e efetuar as liquidações dos registros que já foram pagos ou baixados. Porém as buscas para títulos não gerados pelo CIGAM e o retorno do registro de baixa estão disponíveis apenas para Versão 2 da API do Open Banking.
 
'''IMPORTANTE:''' caso o retorno apresente o erro:(500) Erro Interno do Servidor é possível que o Cadastro do Portador esteja com algum parâmetro incorreto, como por exemplo um caractere especial na Conta ou na Agência.
 
'''Regras de Busca do Sistema para localizar os títulos a partir da Versão API = v2'''
 
1- O sistema tenta localizar os títulos pelo Número do Lançamento;
 
2- Caso os títulos tenham sido gerados pelo CIGAM irá localizar pelo '''Nosso Número''', avaliando então a tabela '''GFBOLETOS''' pela coluna '''NOSSO_NRO'''.
 
3- Caso os títulos tenham sido gerados por outro sistema irá localizar pelo '''Nosso Número''', avaliando então a tabela '''GFLAUXIL''' pela coluna '''CODIGO_BARRAS'''.
 
'''Como faço para atualizar com a nova Versão API = v2?'''
 
Simples acesse a opção do índice do Manual:
 
'''Quais são as novidades após atualização para Versão 2 do Open Banking?'''
 
 
'''Menu: Finanças > Gestão Financeira > Rotinas > EDI> Recebe > Retorno Cobranças Bancárias > Retorno de Cobrança Open Banking'''
 
<center>'''Rotina Retorno de Cobrança Open Banking'''
[[Arquivo:Retorno_Boletos_Open_Banking_V.png|750x500px|semmoldura|nenhum|Retorno_Boletos_Open_Banking]]
 
 

'''Empresa:''' possibilita realizar o filtro por Empresa, consultando todos os registros da Empresa informada.
 
'''Unidade de Negócio:''' possibilita realizar o filtro por Unidade de Negócio.
 
'''Lançamento:''' possibilita realizar filtro por faixa de Lançamento.
 
'''Vencimento:''' possibilita realizar filtro por faixa de Vencimento.
 
'''Movimento/Registro:''' possibilita realizar filtro por faixa do período do Movimento ou do Registro. Data que delimita o período da Consulta de Boletos liquidados, Baixados ou Protestados.
 
'''Situação do Boleto:''' filtro com duas opções:
 
'''A - Em ser (abertos):''' listam os registros que se encontram com Status "Abertos" no Banco.
 
'''B - Baixadas/Protestados/Liquidados:''' listam os registros que se encontram com Status "Baixados/Protestados/Liquidados".
 
'''Cód. Situação Atual Boleto:''' listagem para realizar filtro através do Código da Situação do Boleto no Banco conforme layout.
 
<center>'''Rotina Rotina Retorno de Cobrança Open Banking guia Parâmetros'''
[[Arquivo:Retorno_Boletos_Open_Banking_V3.png|750x500px|semmoldura|nenhum|Retorno_Boletos_Open_Banking_2]]
 
 

'''Tipo de Retorno:''' há 3 opções para o retorno.
 
'''* Listagem:''' quando selecionado essa opção, ao executar a rotina, apenas listará o status do registro do Boleto Bancário junto ao Banco.
 
'''* Retorno:''' quando selecionado essa opção, ao executar a rotina, o sistema irá executar o retorno dos registros confirmados e já irá realizar a liquidação caso haja registros pagos, sem executar a listagem.
 
'''* Ambos:''' quando selecionado essa opção irá executar tanto a opção de "Listagem" quanto a opção de "Retorno".
 
'''Portador para Liquidação:''' este campo tem como finalidade informar qual será o Portador utilizado para os registros que serão liquidados. Caso não seja informado nenhum Portador neste campo, será utilizado o Portador de Retorno parametrizado para Open Banking.
 
'''Portador Carteira de Desconto:''' este campo é para informar o Portador de Carteira de Desconto, para Contratos Bancários, para os registros que possuem Duplicatas negociadas com o Banco.
 
'''Histórico de Liquidação:''' campo para informar o Histórico que será utilizado para os registros que serão liquidados.
 
'''Não contabilizar Juros e Descontos nas liquidações da Carteira Descontada:''' esta opção tem como finalidade não contabilizar os Juros e Descontos para as liquidações de Carteira Descontada, ou seja, caso possua duplicatas com o Banco negociada e o registro possuir Juros, Desconto, possibilita o usuário não contabiliza-los marcando esta opção.
 
'''Não gerar lançamentos de tarifa de cobrança:''' esta opção tem como finalidade quando selecionada não gerar a liquidação do valor da tarifa de cobrança.
 
'''Data para Liquidação:''' quando zerado a Data será habilitado para selecionar as opções. Esta opção tem como finalidade realizar a busca para liquidação de duas formas:
 
- '''Ocorrência:''' os títulos serão liquidados com a Data de Ocorrência do Título (Data Recebimento do Título) ao qual foi processado no Banco.
 
- '''Crédito:''' os títulos serão liquidados com a Data de Crédito (Data de Crédito Liquidação) em que foi processado no Banco.
Ou seja, se o título foi pago por exemplo na Data 31/08/2020 o banco irá processar esse pagamento e o retorno será creditado na conta no dia 01/09/2020, porém o pagamento foi realizado no dia anterior e creditado no dia posterior.
 
A Data para Liquidação é trazida por padrão a Data atual como sugestão, sendo possível altera-lá ou quando zerada habilita para buscar automaticamente a Data de Ocorrência ou Crédito.
 
 
'''Modelo de Relatório:''' o modelo de relatório utilizado pode ser obtido através do caminho padrão.
Nome do Modelo: (RF00071_remessas).
<center>'''Relatório Retorno Bancário Online'''
[[Arquivo:Relat Retorno Bancario Online.png|750x500px|semmoldura|nenhum|Relat_Retorno_Bancario_Online]]
 
 
Ao acessar o Lançamento Financeiro após o Retorno de Cobrança Open Banking, realizando as liquidações o sistema altera o status do Lançamento Financeiro.
 
'''Menu: Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 
<center>'''Lançamento Financeiro Liquidado através da Rotina de Cobrança Open Banking'''
[[Arquivo:Lançamento Liquidado Retorno.png|750x500px|nenhum|Lançamento_Liquidado_Retorno.png]]
 

='''Como realizar a Alteração de Vencimento do Lançamento já Registrado Open Banking e reenviá-lo novamente?'''=

Irá surgir a necessidade de realizar a alteração do Vencimento do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?
 
'''Dado que''' já temos um Lançamento Financeiro já Registrado Open Banking, basta acessar o Lançamento Financeiro desejado através do caminho do Menu:
 
'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 
Acessar o Lançamento Financeiro em modo Modificar e alterar o campo "Venc.Original", automaticamente após alteração do Vencimento, o sistema insere o Comando "05" no campo "Comando de Remessa" e diante disso já emite uma mensagem:
 
'''Confirma o envio da alteração do título ao banco?'''
 
'''Importante:''' para o envio da alteração do Vencimento o sistema já considera o campo '''Vencimento''', caso seja utilizado a '''Modalidade''' como '''Seguinte''' por exemplo, onde é possível ter um Vencimento Original diferente do Vencimento.
 
<center>'''Lançamento Financeiro a Receber já Registrado'''
[[Arquivo:AlterarVenc Lanc1.png|750x500px|nenhum|AlterarVenc_Lanc1]]
 
 
Vencimento alterado, sistema insere o Comando "05" no campo "Comando de Remessa" e ao salvar o registro é emitido a mensagem: "Confirma o envio da alteração do título ao banco?"
 
<center>'''Vencimento alterado e registro salvo'''
[[Arquivo:Vencimento Alterado Msn.png|750x500px|nenhum|Vencimento_Alterado_Msn]]
 
'''Sim:''' é enviado o registro de alteração do Open Banking e se registrado com sucesso, sistema retira então o Comando de Remessa.
 
<center>'''Processo Concluído com Sucesso'''
[[Arquivo:Processo_Concluido_Sucesso_Lanc.png|750x500px|nenhum|Processo_Concluido_Sucesso_Lanc]]
 
Há possibilidades do tempo de comunicação com API do Banco não retornar imediatamente a confirmação do recebimento da Alteração do Vencimento. Quando ocorrer essa situação, sistema emite uma mensagem, solicitando aguardar, para tentar novamente o envio da alteração do vencimento.
Quando ocorrer essa situação, será necessário aguardar e após realizar o envio novamente ou através do próprio Lançamento ou através da rotina de Remessa de Cobrança - Open Banking, que remeterá as alterações para o Banco.
<center>'''Processo Pendente Alteração - Aguardar'''
[[Arquivo:Alteração Vencimento Processo Pendente Envio Aguardar.png|750x500px|nenhum|Alteração_Vencimento_Processo_Pendente_Envio_Aguardar]]
 
Já quando selecionado a opção '''Não''':
 
'''Não:''' não faz a comunicação do envio da alteração do vencimento via Open Banking. Este registro não foi notificado, logo será necessário realiza-lo através do próprio Lançamento ou através da rotina de Remessa de Cobrança Open Banking.
 
No Lançamento Financeiro é habilitado o botão "Reenviar Registro" no Item de Categoria "Open Banking".
Quando selecionado o botão '''Registrar Alteração''', sistema faz a comunicação via Open Banking e registra alteração de vencimento realizada.
 
<center>'''Lançamento Não Registrado a alteração de Vencimento com o Comando de Remessa'''
[[Arquivo:Botao Registrar Alteracao Habilitado.png|750x500px|nenhum|Botao_Registrar_Alteracao_Habilitado]]
 
Ao selecionar o botão "Registrar Alteração" sistema emite a mensagem para confirmar o envio.
 
<center>'''Botão Registrar Alteração'''
[[Arquivo:Registrar Alteracao Selecionado.png|750x500px|nenhum|Registrar_Alteracao_Selecionado]]
 
Após a confirmação o sistema registra alteração
 
<center>'''Processo Concluído com Sucesso'''
[[Arquivo:Processo_Concluido_Sucesso_Lanc.png|750x500px|nenhum|Processo_Concluido_Sucesso_Lanc]]
 
 
<center>'''Lançamento alterado e registrado'''
[[Arquivo:Lançamento alterado registrado.png|750x500px|nenhum|Lançamento_alterado_registrado]]
 

='''Como realizar a Alteração de Multa do Lançamento já Registrado Open Banking e reenviá-lo novamente?'''=

'''Irá surgir a necessidade de realizar a alteração da Multa do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?'''
 
Dado que já temos um Lançamento Financeiro já Registrado Open Banking, basta acessar o Lançamento Financeiro desejado através do caminho do Menu:
 
'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 
'''Regra Sistema para Multa ou Juros:'''
 
Se no cadastro do Portador não possuir Comando de Remessa com as novas opções:
 
'''Tipo de Comando =''' Alteração de Multa para Multa
 
'''Tipo de Comando =''' Alteração de Juros para Juros
 
Ao acessar o Lançamento Financeiro em modo Modificar e alterar o campo '''Multa de''', automaticamente após alteração da Multa, o Sistema irá criar essa parametrização do Comando de Remessa com '''sugestão''', sendo passível de alteração, no Cadastro do Portador no botão '''Remessas''' e depois no botão '''Comandos'''.
 
'''Comando sugestão para Multa:'''
 
'''Código Operação =''' ATM
 
'''Comando =''' ATM
 
'''Descrição =''' ALTERAÇÃO DE MULTA PARA OPEN BANKING
 
'''Tipo de Comando =''' Alteração de Multa
 
 
<center>'''Cadastro do Portador Comando de Remessa Multa'''
[[Arquivo:Cadastro Portador Comando Remessa ATM.png|750x500px|nenhum|Cadastro_Portador_Comando_Remessa_ATM]]
 
 

'''Como é identificado a alteração da Multa para Banco?'''
 
Através das tags enviadas para API gravadas no Histórico do Open Banking Dados API:
 
'''indicadorCobrarMulta''':'''S''' – indica que há multa no registro.
 
'''indicadorDispensarMulta''': '''S''' – indica que a multa foi zerada e não há mais ocorrência de multa para o registro enviado.
 
'''tipoMulta''': 1, - indica que a Multa é maior que 0,01 centavo.
 
'''tipoMulta''': 0, - indica que a Multa é menor que 0,01 centavo não registrando a operação de multa.
 
'''valorMulta''': 0.44, - indica o valor da multa.
 
'''dataInicioMulta''': "23.09.2021", - indica a data do movimento da alteração da multa enviado.
 
 
<center>'''Lançamento Financeiro a Receber já Registrado alterando a Multa'''
[[Arquivo:Alteração Multa Lancto.png|750x500px|nenhum|Alteração_Multa_Lancto]]
 
 

Tags enviadas para API Banco:
 
 
<center>'''Dados API Tags referente a Multa'''
[[Arquivo:Lancto Registrado Alteração Multa Lancto.png|750x500px|nenhum|Lancto_Registrado_Alteração_Multa_Lancto]]
 
 

='''Como realizar a Alteração de Juros do Lançamento já Registrado Open Banking e reenviá-lo novamente?'''=

'''Irá surgir a necessidade de realizar a alteração de Juros do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?'''
 
Dado que já temos um Lançamento Financeiro já Registrado Open Banking, basta acessar o Lançamento Financeiro desejado através do caminho do Menu:
 
'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 
'''Regra Sistema para Multa ou Juros:'''
 
Se no cadastro do Portador não possuir Comando de Remessa com as novas opções:
 
'''Tipo de Comando =''' Alteração de Multa para Multa
 
'''Tipo de Comando =''' Alteração de Juros para Juros
 
Ao acessar o Lançamento Financeiro em modo Modificar e alterar o campo '''Juros Dias de''' ou '''Juros Mês de''', automaticamente após alteração dos Juros, o Sistema irá criar essa parametrização do Comando de Remessa com '''sugestão''', sendo passível de alteração, no Cadastro do Portador no botão '''Remessas''' e depois no botão '''Comandos'''.
 
'''Comando sugestão para Juros:'''
 
'''Código Operação =''' ATJ
 
'''Comando =''' ATJ
 
'''Descrição =''' ALTERAÇÃO DE JUROS PARA OPEN BANKING
 
'''Tipo de Comando =''' Alteração de Juros
 
 
<center>'''Cadastro do Portador Comando de Remessa Juros'''
[[Arquivo:Cadastro Portador Comando Remessa ATJ.png|750x500px|nenhum|Cadastro_Portador_Comando_Remessa_ATJ]]
 
 

'''Como é identificado a alteração de Juros para Banco?'''
 
Através das tags enviadas para API gravadas no Histórico do Open Banking Dados API:
 
'''indicadorCobrarJuros''':'''S''' – indica que há Juros no registro.
 
'''indicadorDispensarJuros''': '''S''' – indica que o Juros foi zerado e não há mais ocorrência de Juros para o registro enviado.
 
'''tipoJuros''': 1, - indica que os Juros é maior que 0,01 centavo.
 
'''tipoMulta''': 0, - indica que os Juros é menor que 0,01 centavo não registrando a operação de Juros.
 
'''valorJuros''': 0.46, - indica o valor dos Juros.
 
 
<center>'''Lançamento Financeiro a Receber já Registrado alterando os Juros'''
[[Arquivo:Lancto Registrado Alteração Juros Dia.png|750x500px|nenhum|Lancto_Registrado_Alteração_Juros_Dia]]
 
 

Tags enviadas para API Banco:
 
 
<center>'''Dados API Tags referente aos Juros''
[[Arquivo:Dados API Juros.png|750x500px|nenhum|Dados_API_Juros]]
 
 

='''Como realizar a Alteração dos 3 juntos (Vencimento/Juros/Multa) do Lançamento já Registrado Open Banking e reenviá-lo novamente?'''=

Irá surgir a necessidade de realizar a alteração do Vencimento do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?
 
'''Dado que''' já temos um Lançamento Financeiro já Registrado Open Banking, basta acessar o Lançamento Financeiro desejado através do caminho do Menu:
 
'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 
Acessar o Lançamento Financeiro em modo Modificar e alterar o campo "Venc.Original", automaticamente após alteração do Vencimento, o sistema insere o Comando "05" no campo "Comando de Remessa" e diante disso já emite uma mensagem:
 
'''Confirma o envio da alteração do título ao banco?'''
 
'''Importante:''' para o envio da alteração do Vencimento o sistema já considera o campo '''Vencimento''', caso seja utilizado a '''Modalidade''' como '''Seguinte''' por exemplo, onde é possível ter um Vencimento Original diferente do Vencimento.
 
<center>'''Lançamento Financeiro a Receber já Registrado'''
[[Arquivo:AlterarVenc Lanc1.png|750x500px|nenhum|AlterarVenc_Lanc1]]
 
 
Vencimento alterado, sistema insere o Comando "05" no campo "Comando de Remessa" e ao salvar o registro é emitido a mensagem: "Confirma o envio da alteração do título ao banco?"
 
<center>'''Vencimento alterado e registro salvo'''
[[Arquivo:Vencimento Alterado Msn.png|750x500px|nenhum|Vencimento_Alterado_Msn]]
 
'''Sim:''' é enviado o registro de alteração do Open Banking e se registrado com sucesso, sistema retira então o Comando de Remessa.
 
<center>'''Processo Concluído com Sucesso'''
[[Arquivo:Processo_Concluido_Sucesso_Lanc.png|750x500px|nenhum|Processo_Concluido_Sucesso_Lanc]]
 
Há possibilidades do tempo de comunicação com API do Banco não retornar imediatamente a confirmação do recebimento da Alteração do Vencimento. Quando ocorrer essa situação, sistema emite uma mensagem, solicitando aguardar, para tentar novamente o envio da alteração do vencimento.
Quando ocorrer essa situação, será necessário aguardar e após realizar o envio novamente ou através do próprio Lançamento ou através da rotina de Remessa de Cobrança - Open Banking, que remeterá as alterações para o Banco.
<center>'''Processo Pendente Alteração - Aguardar'''
[[Arquivo:Alteração Vencimento Processo Pendente Envio Aguardar.png|750x500px|nenhum|Alteração_Vencimento_Processo_Pendente_Envio_Aguardar]]
 
Já quando selecionado a opção '''Não''':
 
'''Não:''' não faz a comunicação do envio da alteração do vencimento via Open Banking. Este registro não foi notificado, logo será necessário realiza-lo através do próprio Lançamento ou através da rotina de Remessa de Cobrança Open Banking.
 
No Lançamento Financeiro é habilitado o botão "Reenviar Registro" no Item de Categoria "Open Banking".
Quando selecionado o botão '''Registrar Alteração''', sistema faz a comunicação via Open Banking e registra alteração de vencimento realizada.
 
<center>'''Lançamento Não Registrado a alteração de Vencimento com o Comando de Remessa'''
[[Arquivo:Botao Registrar Alteracao Habilitado.png|750x500px|nenhum|Botao_Registrar_Alteracao_Habilitado]]
 
Ao selecionar o botão "Registrar Alteração" sistema emite a mensagem para confirmar o envio.
 
<center>'''Botão Registrar Alteração'''
[[Arquivo:Registrar Alteracao Selecionado.png|750x500px|nenhum|Registrar_Alteracao_Selecionado]]
 
Após a confirmação o sistema registra alteração
 
<center>'''Processo Concluído com Sucesso'''
[[Arquivo:Processo_Concluido_Sucesso_Lanc.png|750x500px|nenhum|Processo_Concluido_Sucesso_Lanc]]
 
 
<center>'''Lançamento alterado e registrado'''
[[Arquivo:Lançamento alterado registrado.png|750x500px|nenhum|Lançamento_alterado_registrado]]
 

='''Quais são as novidades após atualização para Versão 2 do Open Banking?'''=

Disponibilizado a Versão 2 para Open Banking que traz algumas novidades para o processo de Registro no Banco.
 
'''Para começar o que devo fazer para atualizar para Versão 2 do Open Banking?'''
 
Simples, basta atualizar com a versão que contempla a'''OS 664835/1'''.
 
Nela terá um componente que quando atualizado a Base através do Assistente de Atualização (Atualiza CIGAM) será adicionado nos Parâmetros Open Banking da Configuração de Bancos, especificamente nas Credenciais, o registro '''Versão API''' = v2.
 
'''Finanças > Gestão Financeira > Parâmetros > Configurações de Bancos'''
 
<center>'''Parâmetros Open Banking'''
[[Arquivo:Parametros OP V2 Credenciais.png|750x500px|nenhum|Parametros_OP_V2_Credenciais]]
 
A partir desta Versão o Sistema passa a realizar a busca para localizar os títulos da seguinte forma:
 
1- O sistema tenta localizar os títulos pelo Número do Lançamento;
 
2- Caso os títulos tenham sido gerados pelo CIGAM irá localizar pelo '''Nosso Número''', avaliando então a tabela '''GFBOLETOS''' pela coluna '''NOSSO_NRO'''.
 
3- Caso os títulos tenham sido gerados por outro sistema irá localizar pelo '''Nosso Número''', avaliando então a tabela '''GFLAUXIL''' pela coluna '''CODIGO_BARRAS'''.
 
Também nesta versão estão disponíveis as tags para Envio da Série/NF, sendo utilizado a Tag na API '''NumeroTituloBeneficiario'''. A regra é '''Serie''' '''NF''' '''Complemento Duplicata''', bem como descrito com espaços em Branco entre eles. Para verificar esse registro, basta acessar após o Registro no Banco o Histórico Open Banking na guia '''Envio''' e localizar para Tag '''NumeroTituloBeneficiario'''.
 
<center>'''Quais são as mudanças ocorridas no Assistente de Parâmetros de Convênio Open Banking?'''
 
Para o Scope foi adicionado um novo complemento para atender ao PIX, logo o Scope passa a ficar desta forma por padrão:
 
'''cobrancas.boletos-requisicao cobrancas.boletos-info payments.transfer-batch-request payments.transfers-info payments.batch-slips payments.batch-barcode-collection-form-request cob.write cob.read pix.read pix.write'''
 
Copie e cole no campo Scope esse dado.
 
<center>'''Parâmetros de Convênio Open Banking'''
[[Arquivo:Wizard passo 3 de 4 Direto PIX.png|750x500px|nenhum|Wizard_passo_3_de_4_Direto_PIX]]
 
Atualizado Wizard para Versão 2 do Open Banking, disponibilizando duas opções:
 
'''- Direto''': esta opção tem como finalidade registrar o Boleto no momento da sua geração, ou seja, quando selecionado ativa propriedade ao qual ao gerar o Boleto Bancário o sistema automaticamente envia o registro Open Banking, sem a necessidade de fazer o processo de envio da Remessa Open Banking do título.
 
'''- PIX''': esta opção fica habilitada somente quando selecionado a opção '''Direto''', ela tem como finalidade registrar uma operação PIX para os Boletos emitido de forma Direta (opção '''Direto''' marcado).
 
Esta opção é válida '''SOMENTE''' para o Banco do Brasil.
 
Ao emitir o Boleto do Lançamento o sistema marca as 3 opções:
 
- Boleto Impresso;
 
- Remessa Enviada;
 
- Código de Barras Lido;
 
Outra mudança é no '''Histórico''' Open Banking, ao qual passa criar o registro com '''Status Open Banking''' já '''Registrado'''.
 
Também ao acessar os '''Dados API''' é enviado a tag: "indicadorPix": "S", pois a opção PIX esta selecionada.
 
Disponibilizado o Modelo de Relatório para o Boleto Banco do Brasil já com o QRCode:
 
'''I:\CIGAM\DOC\Modelos_relatorios\Gestão Financeira\Bloquetos Merge\0098_brasil_PIX.rtf'''

='''Como realizar a Baixa de um Lançamento Financeiro Registrado Open Banking e enviar o Registro de Baixa?'''=

'''IMPORTANTE:''' O processo de Cancelamento de Notas Fiscais, não atende a baixa automatica dos Boletos, logo deve ser baixado manualmente os registros dos Lançamentos Financeiros.
 
Para realizar o processo de '''Baixa''' de um Lançamento Financeiro que foi registrado via Open Banking, basta acessar o Lançamento Financeiro.
 
'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 
Selecionar a opção de Menu Lateral do Lançamento Financeiro '''Open Banking''' e a opção de '''Baixar'''.
 
<center>'''Lançamento Financeiro Registrado/Baixar'''
[[Arquivo:Opção Baixar Lancto.png|750x500px|nenhum|Opção_Baixar_Lancto]]
 
<center>'''Lançamento Financeiro Confirmando Operação'''
[[Arquivo:Deseja Baixar.png|750x500px|nenhum|Deseja_Baixar]]
 
<center>'''Lançamento Financeiro Baixado com Sucesso'''
[[Arquivo:Baixado Sucesso.png|750x500px|nenhum|Baixado_Sucesso]]
 
Agora basta acessar a rotina de Retorno de Cobrança Open Banking através do Menu:
 
'''Menu > Finanças > Gestão Financeira > Rotinas > Operacionais > Open Banking > Retorno de Cobrança Open Banking '''
 
Modelo de Relatório utilizado:
 
%CIGAM_INSTAL%\Modelos_relatorios\Gestão Financeira\RF00071_remessas.RTF
 
<center>'''Retorno de Cobrança Open Banking'''
[[Arquivo:Retorno OP Baixado.png|750x500px|nenhum|Retorno_OP_Baixado]]
 
<center>'''Retorno de Cobrança Open Banking'''
[[Arquivo:Retorno OP Baixado Verso.png|750x500px|nenhum|Retorno_OP_Baixado_Verso]]
 
Após confirmado a rotina emite a Listage de Retorno com o título baixado registrado.
 
<center>'''Listagem_Retorno_Bancario_Online'''
[[Arquivo:Listagem Retorno Bancario Online.png|750x500px|nenhum|Listagem_Retorno_Bancario_Online]]
 
Com isso para validar o Retorno da API do Banco é gravado no Histórico Open Banking do Lançamento Financeiro.
 
Acessando Lançamento Financeiro:
 
<center>'''Listagem_Retorno_Bancario_Online'''
[[Arquivo:Lancamento Financeiro Historico.png|750x500px|nenhum|Lancamento_Financeiro_Historico]]
 
<center>'''Acessando Dados API do Lançamento Financeiro'''
[[Arquivo:Dados API Lancto.png|750x500px|nenhum|Dados_API_Lancto]]
 
O sistema grava para '''Envio''' seguinte mensagem:
 
'''BAIXADO PELO PROCESSO DE RETORNO, CÓDIGO DE BAIXA: BAIXADO POR SOLICITACAO'''
 
<center>'''Acessando Dados API do Lançamento Financeiro'''
[[Arquivo:Dados API Envio Baixado.png|750x500px|nenhum|Dados_API_Envio_Baixado]]
 

='''Como realizar a Variação do Tipo de Cobrança de Simples para Vinculada?'''=

Conforme layout do Banco para Open Banking para diferenciar o Tipo de Cobrança:
 
'''1- Cobrança Simples'''
 
'''4- Cobrança Vinculada'''
 
Para realizar este processo no Sistema deve ser parametrizado no Cadastro do Portador com a seguinte regra de sistema:
 
Tudo que for diferente de 4 (Cobrança Vinculada) será considerado 1 (Cobrança Simples), ou seja, caso seja deixado em Branco ou informado qualquer número diferente de 4 o sistema irá considerar sempre 1.
 
'''Menu > Finanças > Gestão Financeira > Parâmetros > Portadores'''
 
O Campo considerado para esta informação é o '''Identificação do serviço''' na guia '''CNAB'''.
 
<center>'''1- Cobrança Simples'''
[[Arquivo:Cadastro Portador Cobranca Simples.png|750x500px|nenhum|Cadastro_Portador_Cobranca_Simples]]
 

<center>'''4- Cobrança Vinculada'''
[[Arquivo:Cadastro Portador Cobranca Vinculada 4.png|750x500px|nenhum|Conbranca_Vinculada]]
 

='''Como parametrizar para envio Open Banking a Negativação ou Protesto?'''=

Para enviar um '''PROTESTO''':
 
Basta acessar o Cadastro do Portador e inserir os dias no campo '''Protestar após''' na guia '''Configurações.
 

'''Menu > Finanças > Gestão Financeira > Parâmetros > Portadores'''

 
<center>'''Dias de Protesto Cadastro do Portador'''
[[Arquivo:Cadastro Portador Negativacao BB5.png|750x500px|nenhum|Cadastro_Portador_Negativacao_BB5]]
 

Quando se tratar de '''Protesto''' o sistema deve enviar as tags para API do Banco da seguinte forma:
 
Setar os dias conforme parametrização no Cadastro do Portador na tag '''"quantidadeDiasProtesto": "1",''' e na tag '''"quantidadeDiasNegativacao": "0",'''.
 
Exemplo de envio da API:
 
'''"quantidadeDiasProtesto": "1",'''
 
'''"quantidadeDiasNegativacao": "0",'''
 

Já para enviar uma '''NEGATIVAÇÃO''':
 
Basta acessar o Cadastro do Portador e inserir os dias no campo '''Negativar após''' na guia '''Configurações.
 

'''Menu > Finanças > Gestão Financeira > Parâmetros > Portadores'''

 
<center>'''Dias de Protesto Cadastro do Portador'''
[[Arquivo:Cadastro Portador Negativacao BB.png|750x500px|nenhum|Cadastro_Portador_Negativacao_BB]]
 

Quando se tratar de '''Negativação''' o sistema deve enviar as tags para API do Banco da seguinte forma:
 
Setar os dias conforme parametrização no Cadastro do Portador e nas tags deve ser zerado '''"quantidadeDiasProtesto": "0",''' e na tag '''"quantidadeDiasNegativacao": "7",''' e deve conter o órgão negativador na tag '''"orgaoNegativador": "10",''', sendo SERASA = 10 .
 
Exemplo de envio da API:
 
'''"quantidadeDiasProtesto": "0",'''
 
'''"quantidadeDiasNegativacao": "7",'''
 
'''"orgaoNegativador": "10",'''

='''Como cadastrar as Mensagens de Retorno API Financeira Sugestão Usuário?'''=

As Mensagens de Retorno API Financeira é uma funcionalidade para facilitar a identificar e de orientação para com as mensagens provindas das APIs que o Sistema tem conexão.
 
Elas foram implementadas para Open banking.
 
Para acessar o cadastro basta acessar através do Menu:
 
'''Menu: Finanças > Gestão Financeira > Parâmetros > Mensagens de Retorno API Financeiro'''
 

<center>'''Mensagens de Retorno API Financeiro'''
[[Arquivo:Mensagens Retorno API Financeiro.png|750x500px|nenhum|Mensagens_Retorno_API_Financeiro]]
 

'''Banco:''' código do Banco conforme codificação no orgão que rege os Bancos Febraban.
 
'''Código Erro:''' código do erro conforme layout das APIS dos Bancos.
 
'''Status:''' é o código de Status de erro do Servidor retornado da API dos Bancos. (Código HTTP)
 
'''Descrição do Erro (Banco):''' essa descrição é oriunda do Banco retornada pela API deles.
 
'''Sugestão CIGAM:''' esta mensagem é interna do Sistema, ou seja, quando internamente identificarmos uma situação a qual a Mensagem retornada pelo Banco não é clara, vamos alimentar com Mensagens de sugestão, para orientar as possíveis causas, dando um norte para situação.
 
'''Sugestão Cliente:''' este campo é reservado para o próprio usuário, possibilitando cadastrar Mensagens que ele identificar para facilitar no processo de entendimento das Mensagens de Retorno das APIs.
 
Agora através desta aplicação, quando ocorrer um Erro de Open Banking é possível verificar através dos links dispostos na tela de Lançamento Financeiro no campo Situação Open Banking, terá um link para tabela do erro ocorrido.
 
<center>'''Lançamento Financeiro Mensagens de Retorno API Financeiro'''
[[Arquivo:Mensagens Retorno API Financeiro BB OP.png|750x500px|nenhum|Mensagens_Retorno_API_Financeiro_BB_OP]]
 
Ou também através do Histórico Open Banking:
 
<center>'''Lançamento Financeiro Mensagens de Retorno API Financeiro Histórico Open Banking'''
[[Arquivo:Historico OP Mensagens Retorno API Financeiro BB OP.png|750x500px|nenhum|Historico_OP_Mensagens_Retorno_API_Financeiro_BB_OP]]

='''Não Escopo Retorno Open Banking Cartório?'''=

Referente ao retorno para liquidação em Cartório, o Banco tem uma limitação e não foi desenvolvido ainda por parte do Banco na API, as custas e tarifas de Cartório, impossibilitando o Sistema realizar essa liquidação.
 
A sugestão para registros de Cartório é realizar via Remessa de CNAB de Retorno manual, até o Banco do Brasil liberar essa funcionalidade na API.

Como Fazer Finanças

2022-04-25T17:49:29Z

Alan.campos:

2022-04-25T16:24:09Z

Alan.campos: /* Como Gerar os Procedimentos do CRM Cobrança? */

[[categoria:Como_Fazer_Finanças]]

='''O que é CRM Cobranças?'''=

Para proporcionar mais flexibilidade em relação a funcionalidade CRM Cobrança, o sistema possibilita através de prévias
parametrizações efetuar a renegociação de títulos de clientes que estão em atraso, proporcionando maior efetividade, otimizando o processo do usuário para efetuar as cobranças.

='''Quais os Módulos necessários para utilizar a Funcionalidade Open Banking”?'''=

• Módulo Gestão Financeira;
='''Quais são as Configurações envolvidas na rotina CRM Cobranças?'''=
 
Para o correto funcionamento da rotina, são necessárias as seguintes parametrizações:
 
O Tipo de Pagamento informado na Configuração ‘CL – GE – 300009 – Tipo de Pagamento lançamento reparcelamento’, deverá estar vinculado a uma Condição de Pagamento, caso não ocorrá compromete o processo da funcionalidade.
 
 
'''Menu > Utilidades/Diversos > Genéricos > Parâmetros > Configurações'''
 
{| class="wikitable"
|-
! Módulo !! Divisão !! Sequência !! Descrição !! Dado
|-
| CL || GE || 300008 || Histórico Lançamento Reparcelamento || Informar o código do Histórico para Reparcelamento
|-
| CL || GE || 300009 || Tipo de Pagamento Lançamento Reparcelamento || Informar o Código do Tipo de Pagamento para Reparcelamento
|-
| CL || GE || 300082 || Permite reparcelamento clientes || Marcar/Desmarcar
|-
| CL || GE || 300459 || Iniciar Atividade CRM somente se não tiver outra iniciada || Marcar/Desmarcar
|-
| CL || GE || 300461 || Série Padrão Reparcelamento || Informar a Série Padrão para Reparcelamento
|-
| CL || GE || 300487 || Previsão Início pesquisa Atividades CRM || 0-Liberado 1-Mês Corrente 2-30 Dias 3-Hoje
|-
| CL || GE || 300587 || Ordenar ações de conclusão CRM por || Código Descrição
|-
| CL || GE || 300588 || Permite excluir Procedimento CRM || Sim Não Com Senha
|-
| CL || GE || 300589 || Permite excluir Atividade CRM || Sim Não Com Senha
|-
| CL || GE || 300590 || Senha para excluir Procedimento/Atividade CRM || Informar Senha
|-
| CL || GE || 300594 || Versão do Reparcelamento no Extrato do Cliente || Original CRM Cobrança (Setar para CRM Cobrança)
|-
| CL || GE || 300601 || Permitir incluir atividades tela Processos CRM || Marcar
|-
| CL || GE || 300609 || Permitir encerrar Atividade CRM de outro usuário || Marcar/Desmarcar (Quando necessário exclusão de Atividades de outros usuários)
|-
| CL || GE || 300641 || Bloquear inclusão de procedimentos CRM manual || Marcar/Desmarcar
|-
| CL || GE || 300652 || Situação Entrada Reparcelamento CRM e Juros de Cond.Pagto. || Unificadi Liquidado
|-
|}

='''Quais são as parametrizações necessárias para utilizar a funcionalidade CRM Cobranças?'''=
 
'''Parametrização do Histórico Financeiro:'''
 
O Histórico deve ser informado na Configuração - CL - GE - 300008 - Histórico Lançamento Reparcelamento.
 
 
'''Menu: Finanças > Gestão Financeira > Parâmetros > Histórico Financeiro'''
 
 
<center>'''Cadastro do Histórico'''
[[Arquivo:Historicos CRM Cobranca.png|750x500px|nenhum|Historicos]]
 

'''Parametrização do Tipo de Pagamento:'''
 
O Tipo de Pagamento deve ser informado na Configuração - CL - GE - 300009 - Tipo de Pagamento Lançamento Reparcelamento.
 
 
'''Menu: Comercial > Faturamento/Pedidos > Parâmetros > Tipo de Pagamento'''
 
 
<center>'''Cadastro do Tipo de Pagamento'''
[[Arquivo:Tipo Pagamento CRM Cobrancas.png|750x500px|nenhum|Tipo_Pagamento_CRM_Cobrancas]]
 
 
'''Parametrização do Condição de Pagamento:'''
 
Após a parametrização do '''Tipo de Pagamento''' é necessário vincular o '''Tipo de Pagamento''' cadastrado anteriormente com na '''Condição de Pagamento'''.
 
Essa Condição de Pagamento será usada na hora de reparcelar os Lançamentos. No momento do reparcelamento aparecerão somente as Condições de Pagamentos que possuírem o Tipo de Pagamento vinculado na Configuração - CL - GE - 300009 - Tipo de Pagamento lançamento reparcelamento.
 
'''Menu: Comercial > Faturamento/Pedidos > Parâmetros > Condições de Pagamento'''
 
 
<center>'''Cadastro Condição de Pagamento'''
[[Arquivo:Condicao Pagamento CRM Cobrancas.png|750x500px|nenhum|Condicao_Pagamento_CRM_Cobrancas]]
 

='''1- Etapa como parametrizar os Cadastros de Regras de Cobranças?'''=
 

No cadastro de Regras de Cobrança são definidos os parâmetros fixos como percentual (%) mínimo de juros e multa para renegociação definindo as regras por dias de atraso, para cadastrar uma regra serão utilizados os campos:
 
'''Atraso De:''' Informar neste campo o número de dias inicial de antecipação ou de atraso, por exemplo, preenchendo com ‘-100’,será aplicada esta regra para títulos que vencerão daqui a 100 dias, preenchendo com ‘100’, será aplicada esta regra para títulos que já venceram a 100 dias;
 
'''Mínimo Multa:''' informar neste campo o percentual de multa dia;
 
'''Mínimo Juros:''' informar neste campo o percentual de juros dia;
 
'''Mínimo Entrada:''' informar o percentual para cálculo do valor mínimo de entrada e refere-se ao total dos lançamentos selecionados para aquela regra.
 
'''Menu: Finanças > CRM Cobrança > Parâmetros > Regras de Cobranças
 

'''Regras de Cobranças'''
 
 
<center>'''Regras Cobrancas CRM Cobranca'''
[[Arquivo:Regras Cobrancas CRM Cobranca.png|750x500px|nenhum|Regras_Cobrancas_CRM_Cobranca]]

='''2- Etapa como parametrizar o Cadastro Tipo de Atividade CRM Cobranças?'''=
 

O cadastro de Tipo de Atividade definirá as etapas que existirão no processo de renegociação. Para cadastrar uma atividade basta pressionar '''Ctrl + M''' e após '''F4''' que será uma nova linha será inserida permitindo o cadastro.
 
Neste cadastro é necessário o preenchimento de dois campos, o '''Código''' e o '''Tipo de Atividade'''.
 
'''Código:''' Neste campo deve ser informado o código da atividade, onde o mesmo é preenchido manualmente.
 
'''Tipo de Atividade:''' Informar neste campo a descrição da atividade.
 
'''Menu: Finanças > CRM Cobrança > Parâmetros > Regras de Cobranças
 
<center>'''Cadastro Tipo de Atividade'''
[[Arquivo:Cadastro Tipo Atividade CRM Cobranca.png|750x500px|nenhum|Cadastro_Tipo_Atividade_CRM_Cobranca]]

='''3- Etapa como parametrizar Cadastro Tipo de Ação Conclusão de Atividade no CRM Cobrança?'''=
 

As ações devem ser previamente cadastradas sendo opções de ações de conclusões as quais serão utilizadas para finalizar o reparcelamento. Sendo divididas em cinco status, '''Falha''', '''Sucesso''', '''Cancelar''', '''Pausa''' e '''Erro anterior'''.
 
Para cadastrar uma ação de conclusão é necessário:
 
'''Código:''' neste campo deve ser informado o código da ação de conclusão, onde o mesmo é preenchido manualmente sem busca sequencial do sistema;
 
● '''Tipo de Ação Conclusão de Atividade:''' Preencher neste campo a descrição da ação de conclusão;
 
● '''Ação Conclusão:''' Neste campo serão utilizadas uma das 5 opções disponíveis:
 
● '''Falha:''' Utilizar esta opção para os contatos que não obtiveram sucesso, encerrando a atividade com falha e recriando a atividade de cobrança para uma nova tentativa. EX.: Cliente não atende, Número não existe...;
 
● '''Sucesso:''' Não será necessário criar outras ações de conclusão com esta opção, pois haverá uma única ação de sucesso para finalizar e concluir o reparcelamento. Caso houverem duas atividades no processo, será concluída a etapa “001 CONTATO” e criar outro procedimento de conclusão “002 FINALIZAR COBRANÇA” para que um supervisor possa avaliar o que foi negociado e efetuar a conclusão do reparcelamento. Atualmente está sendo utilizado apenas uma atividade, sendo assim a mesma pessoa que efetua o contato, já conclui a cobrança;
 
● '''Cancelar:''' Não será necessário criar outras ações de conclusão com esta opção, sendo que ao selecionar a ação de cancelamento do procedimento de cobrança, o mesmo será cancelado e não gerará nova atividade para efetuar novo contato, somente quando executada a rotina para criar uma lista de cobrança.
 
● '''Pausa:''' Ao utilizar essa Ação Conclusão a atividade atual será encerrada e será inserida uma nova atividade na sequência com as mesmas características da anterior para ser dado continuidade ao procedimento.
 
● '''Erro anterior:''' Quando essa opção for utilizada, no momento de encerrar uma atividade será habilitado o campo ‘Atividade de Erro’. Teclando F5 no campo será possível visualizar as ações de conclusão das atividades anteriores e selecionar uma. A atividade receberá o tipo de ação conclusão referente à ação de conclusão ‘Erro Anterior’, porém a ação tomada será de acordo com o status selecionado no ‘Atividade de Erro’.
 
 
'''Menu: Finanças > CRM Cobrança > Parâmetros > Tipo de Ação Conclusão de Atividade'''
 
 
<center>'''Cadastro Tipo de Ação Conclusão de Atividade'''
[[Arquivo:Tipo Acao Conclusao Atividade CRM Cobranca.png|750x500px|nenhum|Tipo_Acao_Conclusao_Atividade_CRM_Cobranca]]
 
 

='''4- Etapa como parametrizar Cadastro Tipo de Processo no CRM Cobrança?'''=
 

No cadastro de processo ocorre o vínculo das atividades cadastradas e as ações de conclusão que serão utilizadas em cada atividade.
 
Há a necessidade de apenas um cadastro de Processo, em que nele são efetuados os devidos vínculos e manutenção dos mesmos.
 
Para efetuar os vínculos são necessários efetuar os seguintes procedimentos:
 
 
'''Menu: Finanças > Gestão Financeira > Parâmetros > CRM Cobranças > Tipo de Processo'''
 
<center>'''Cadastro Tipo de Processo'''
[[Arquivo:Tipo Processo CRM Cobranca.png|750x500px|nenhum|Tipo_Processo_CRM_Cobranca]]
 
 
<center>'''Atividades do Processo'''
[[Arquivo:Atividades do Processo CRM Cobrancas.png|750x500px|nenhum|Atividades do Processo CRM Cobranças]]
 
 
'''Atividade:''' Neste campo serão vinculadas as atividades previamente cadastradas clicando F5 para efetuar a busca delas;
 
'''Sugestão de Ação de Conclusão:''' Vincular neste campo a Ação de Conclusão cuja a situação da mesma seja “Sucesso”, podendo efetuar a busca da mesma clicando F5 sobre o campo. Esse campo será a sugestão que será trazida pelo sistema no momento de finalizar uma atividade.
 
'''Situação Inicial:''' No caso de possuir uma atividade, a situação será “Pendente”, caso houver uma segunda atividade, a primeira será “Pendente” e a segunda “Aguardando”;
 
'''Altera data/Hora previsão de início:''' Esta opção é definida por ação de conclusão, onde se a opção estiver como “Sim” o usuário poderá alterar a data e hora de previsão para um novo contato. Se estiver como “Diminui”, a previsão de início da atividade não poderá ultrapassar a quantidade de dias informada no campo “Dias de previsão de início”.
 
'''Função do Software:''' Selecionar nesse campo a função do Software para a atividade selecionada.
 
No botão ‘Tipo de Ação Conclusão’ poderão ser vinculadas outras Ações de conclusão que a atividade poderá assumir. Quando o usuário estiver encerrando uma atividade, ao teclar F5 no campo ‘Ação Conclusão’ aparecerão as atividades vinculadas nesse botão.
 
 
<center>'''Botão Tipo Acao Conclusao CRM Cobrancas'''
[[Arquivo:Botao Tipo Acao Conclusao CRM Cobrancas.png|750x500px|nenhum|Botao_Tipo_Acao_Conclusao_CRM_Cobrancas]]
 
 
<center>'''TipoAcaoConclusaoAtivProcesso_CRM_Cobrancas'''
[[Arquivo:TipoAcaoConclusaoAtivProcesso CRM Cobrancas.png|750x500px|nenhum|TipoAcaoConclusaoAtivProcesso_CRM_Cobrancas]]
 
 
'''OBSEVERÇÃO IMPORTANTE:''' É necessário ter, pelo menos, uma ação conclusão cadastrada nessa tela, podendo ser a mesma da '''Ação conclusão Sugestão''' informada na tela anterior, caso esse cadastro seja deixado em branco o Sistema automaticamente incluirá a '''Sugestão de Ação de Conclusão'''.
 
 
<center>'''
Mensagem_Automaticamente_Sugestao_Acao_Conclusao_CRM_Cobranças'''
[[Arquivo:Mensagem Automaticamente Sugestao Acao Conclusao CRM Cobranças.png|750x500px|nenhum| Mensagem_Automaticamente_Sugestao_Acao_Conclusao_CRM_Cobranças]]
 
 
='''5- Etapa como parametrizar Cadastro Tipo de Equipe no CRM Cobrança?'''=
 

O cadastro de equipes é utilizado para efetuar o vínculo dos usuários que efetuarão as determinadas atividades, sendo possível efetuar o cadastro de equipes para cobrança de determinada unidade de negócio.
 
Caso houver mais de uma atividade cadastrada, poderá ser vinculado a determinados colaboradores apenas uma atividade ou mais atividades, dependendo da sua função.
 
 
'''Menu: Finanças > CRM Cobrança > Parâmetros > Tipo de Equipe'''
 
 
<center>'''Tipo Equipe CRM Cobrancas'''
[[Arquivo:Tipo Equipe CRM Cobrancas.png|750x500px|nenhum|Tipo_Equipe_CRM_Cobrancas]]
 
 
'''Código:''' Neste campo deve ser informado o código da equipe, onde o mesmo é preenchido manualmente sem busca sequencial de ID;
 
'''Tipo de Equipe:''' Preencher neste campo a descrição da Equipe;
 
No botão '''Colaboradores''' é possível vincular os colaboradores com suas atividades.
 
 
<center>'''Colaboradores_Equipe_CRM_Cobrancas'''
[[Arquivo:Colaboradores Equipe CRM Cobrancas.png|750x500px|nenhum|Colaboradores_Equipe_CRM_Cobrancas]]
 
 
'''Colaboradores da Equipe:''' Vincular neste campo os Colaboradores respectivos a Equipe que está sendo cadastrada utilizando o ‘F5’ para buscar os devidos colaboradores;
 
'''Atividades do Colaborador:''' Após vincular o colaborador deve-se estabelecer quais atividades o mesmo pode executar, podendo utilizar o '''F5''' para efetuar a busca das atividades;
 
No botão '''Categorias''' é possível vincular as Categorias das Equipes.
 
 
<center>'''Catergorias_Equipes_CRM_Cobrancas'''
[[Arquivo:Categorias Equipe CRM Cobrancas.png|750x500px|nenhum|Catergorias_Equipes_CRM_Cobrancas]]
 
 
'''Categorias da Equipe:''' Informar neste campo a categoria pré cadastrada.
 
EX:. '''1 - COBRANÇA''';
 
'''Processos da Categoria:''' Informar neste campo o processo pré cadastrada.
 
EX:. '''1 - COBRANÇA'''.
 
Com todos os parâmetros efetuados e equipes cadastradas, é possível efetuar a geração da lista de cobrança a partir da rotina '''Gerar Procedimentos de CRM'''.
 
 
='''Como Gerar os Procedimentos do CRM Cobrança?'''=
 

Após realizadas todas as parametrizações, nesta rotina é possível criar as listas de cobranças.
 
Caso houver mais de uma atividade cadastrada, poderá ser vinculado a determinados colaboradores apenas uma atividade ou mais atividades, dependendo da sua função.
 
 
'''Menu: Finanças > Gestão Financeira > Rotinas > Gerar Procedimentos CRM'''
 
 
<center>'''Gerar Procedimentos CRM Cobrancas'''
[[Arquivo:Gerar Procedimentos CRM Cobrancas.png|750x500px|nenhum|Gerar_Procedimentos_CRM_Cobrancas]]
 
 
<center>'''Gerar Procedimentos Parâmetros CRM Cobrancas'''
[[Arquivo:Gerar Procedimentos Parametros CRM Cobrancas.png|750x500px|nenhum|Gerar Procedimentos Parâmetros CRM Cobrancas]]
 
 
'''Nível de Crédito:''' Selecionar o nível de crédito inicial e nível de crédito final;
 
'''Filtrar Contas a Receber:''' Com essa opção marcada serão listadas somente as empresas que possuem lançamentos atrasados.
 
Com ela desmarcada serão listadas todas as empresas, tendo elas lançamentos em atraso ou não. É aconselhável que esta opção esteja sempre marcada;
 
'''Unidade de Negócio:''' Informar neste campo a Unidade de Negócio a ser utilizada para gerar a lista de cobrança;
 
'''Atrasos em dias:''' Informar neste campo o número de dias em atraso a pesquisar;
 
'''Equipe:''' Informar nesse campo a equipe que ficará responsável pelos procedimentos gerados.
 
'''Categoria:''' Informar neste campo a categoria para a geração dos procedimentos;
 
'''Processo:''' Informar neste campo o processo para a geração dos procedimentos;
 
 
<center>'''Gerar Procedimentos Parâmetros CRM Cobrancas'''
[[Arquivo:Selecao Procedimento Gerar CRM-Cobrancas.png|750x500px|nenhum|Selecao_Procedimento_Gerar_CRM-Cobrancas]]
 
 
Na barra lateral é possível consultar várias informações do cliente tal como Ficha Cliente, Autorizados, Referências, Limite, Extrato, Ocorrências e Detalhes do Cliente.
 
'''Barra Lateral:''' Ainda na barra lateral na parte inferior é possível visualizar o saldo total a receber das empresas selecionadas e a quantidade de registros selecionados.
 
 
'''Barra Topo:''' A barra superior possui os botões Voltar, Marcar Todos, Desmarcar Todos, Inverter Seleção e Editar Processo, respectivamente.
 
'''Voltar:''' Sai da página de seleção e volta para os filtros e parâmetros;
 
'''Marcar Todos:''' Seleciona todos os registros da tela;
 
'''Desmarcar Todos:''' Desmarca todos os registros da tela;
 
'''Inverter Seleção:''' Inverte a seleção dos registro, os que estão marcados são desmarcados e os que estão desmarcados são marcados;
 
'''Editar Processo:''' Esse botão serve para fazer modificações específicas no processo gerado. Para editar o processo selecione o processo no Browse de processos e clique no botão '''Editar Processo'''. Só é possível editar um processo após a geração da dele, onde não estará mais o check box para seleção. Abrirá a seguinte tela:
 
 
<center>'''Botao_Editar_Processo_Selecao_Procedimentos_Gerar'''
[[Arquivo:Botao Editar Processo Selecao Procedimentos Gerar.png|750x500px|nenhum|Botao_Editar_Processo_Selecao_Procedimentos_Gerar]]
 
 
<center>'''Editar_Cadastro_Procedimentos'''
[[Arquivo:Cadastro Procedimentos CRM Cobrancas.png|750x500px|nenhum|Cadastro_Procedimentos_CRM_Cobrancas]]
 
 
<center>'''Mensagem_Gerados_1_Procedimentos_CRM_Cobrancas'''
[[Arquivo:Mensagem Gerados 1 Procedimentos CRM Cobrancas.png|750x500px|nenhum|Mensagem_Gerados_1_Procedimentos_CRM_Cobrancas]]

='''Layout e Detalhamento de Campos API'''=
==Registro de Boletos==
<center>

{| class="wikitable"
|-
! Nº !! Campo JSON !! Descriçao do Banco !! Campo CIGAM !! Tabela !! Obrigatório !! Observações
|-
| 1 || token || Chave Transacional gerada pelo recurso /autenticacao || || || Obrigatório ||
|-
| 2 || Content-Type || Estabelece o tipo de conteúdo da requisição || || || Obrigatório ||
|-
| 3 || agencia || Código da Cooperativa do beneficiário || Agência || Portador || Obrigatório ||
|-
| 4 || posto || Código do Posto do beneficiário || Dígito Agência || Portador || Obrigatório ||
|-
| 5 || cedente || Código do Convênio de Cobrança do beneficiário || Código Cedente || Portador || Obrigatório ||
|-
| 6 || nossoNumero* || Nosso Número || Nosso Número || Boletos || Opcional ||
|-
| 7 || codigoPagador || Código Pagador || Não Tratado || Não Tratado || Opcional ||
|-
| 8 || tipoPessoa* || Tipo de pessoa do pagador.
'''Domínio:'''
 
1 - PESSOA FÍSICA
 
2 - PESSOA JURÍDICA
|| Pessoa || Empresa || Obrigatório ||
|-
| 9 || cpfCnpj* || CPF ou CNPJ do pagador || CNPJ/CPF || Empresa || Obrigatório ||
|-
| 10 || nome || Nome do pagador || Nome Completo || Empresa || Obrigatório ||
|-
| 11 || endereco || Endereço do pagador || Endereço || Empresa || Opcional || Será obrigatório se o código do pagador '''não''' for informado.
|-
| 12 || cidade || cidade || Município || Empresa || Opcional || Será obrigatório se o código do pagador '''não''' for informado.
|-
| 13 || uf || Estado do pagador || UF || Empresa || Opcional || Será obrigatório se o código do pagador '''não''' for informado.
|-
| 14 || cep || CEP do pagador || CEP || Empresa || Obrigatório ||
|-
| 15 || telefone || Telefone mais DDD do pagador || Fone || Empresa || Opcional || Será obrigatório se o código do pagador '''não''' for informado.
|-
| 16 || email || Endereço de email do pagador || Email || Contato || Opcional ||
|-
| 17 || especieDocumento || Espécie de documento do título.(*) || Espécie || Portador || Obrigatório ||
|-
| 18 || codigoSacadorAvalista || Código do sacador avalista. || Não Tradado || Não Tradado || Opcional ||
|-
| 19 || seuNumero || Número de controle interno do beneficiário que referencia o pagador. || Lançamento || LANCAM || Obrigatório ||
|-
| 20 || dataVencimento || Data de vencimento do boleto || Vencimento || Boletos || Obrigatório ||
|-
| 21 || valor || Valor do boleto || Saldo || LANCAM || Obrigatório ||
|-
| 22 || tipoDesconto || Tipo de desconto.
'''Domínios:'''
 
A - VALOR
 
B - PERCENTUAL
|| Não Tratado || Não Tratado || Obrigatório ||
|-
| 23 || valorDesconto1 || Valor de desconto 1 || Valor Desconto || LANCAM || Opcional || Será obrigatório se o dataDesconto1 for informado.
|-
| 24 || dataDesconto1 || Data limite para concessão de desconto1 || Vencimento || LANCAM || Opcional || Será obrigatório se o valorDesconto1 for informado. Não pode ser igual a outras dataDescontos e nem maior que vencimento.
|-
| 25 || valorDesconto2 || Valor de desconto 2 || Não Tratado || Não Tratado || Opcional || Será obrigatório se o dataDesconto2 for informado.
|-
| 26 || dataDesconto2 || Data limite para a concessão de desconto 2 || Não Tratado || Não Tratado || Opcional || Será obrigatório se o valorDesconto2 for informado. Não pode ser igual a outras dataDescontos e nem maior que vencimento.
|-
| 27 || valorDesconto3 || Valor de desconto 3 || Não Tratado || Não Tratado || Opcional || Será obrigatório se o dataDesconto3 for informado.
|-
| 28 || dataDesconto3 || Data limite para a concessão de desconto 3 || Não Tratado || Não Tratado || Opcional || Será obrigatório se o valorDesconto3 for informado. Não pode ser igual a outras dataDescontos e nem maior que vencimento.
|-
| 29 || tipoJuros || Tipo de Juros.
'''Domínios:'''
 
A - VALOR
 
B - PERCENTUAL
|| || || Obrigatório ||
|-
| 30 || juros || Valor de juros a cobrar por dia. || Juros Dia || LANCAM || Opcional ||
|-
| 31 || multas || Percentual de multa a cobrar || Valor Multa || LANCAM || Opcional ||
|-
| 32 || desconto Antecipado || Valor de desconto antecipado a cobrar || Não Tratado || Não Tratado || Opcional || Deve ser menor que o valor.
|-
| 33 || informativo || Texto do Informativo || Não Tratado || Não Tratado || Opcional ||
|-
| 34 || mensagem* || Texto da linha da mensagem || Não Tratado || Não Tratado || Opcional ||
|-
| 35 || codigoMensagem || Código da mensagem || Não Tratado || Não Tratado || Opcional ||
|-
| 36 || numDiasNegativacaoAuto || Número de dias para Negativação Automática. 0 (Zero) para não negativar automaticamente. Quando preenchido com 3 ou 4 dias o sistema comandará negativação em dias úteis após o vencimento. Quando preenchido acima de 4 dias, o sistema comandará negativação em dias corridos após o vencimento. || Protesto || Portador || Opcional ||
|-
| 37 || NomeBeneficiarioFinal || NomeBeneficiarioFinal || Não Tratado || Não Tratado || Obrigatório caso informado TipoPessoaBeneficiarioFinal e CpfCnpjBeneficiarioFinal ||
|-
| 38 || TipoPessoaBeneficiarioFinal || Tipo de pessoa.
'''Domínios:'''
 
1 - Física
 
2 - Jurídica
|| Não Tratado || Não Tratado || Obrigatório caso informado NomeBeneficiarioFinal e CpfCnpjBeneficiarioFinal ||
|-
| 39 || CpfCnpjBeneficiarioFinal || CPF/CNPJ do beneficiário final || Não Tratado || Não Tratado || Obrigatório caso informado NomeBeneficiarioFinal e TipoPessoaBeneficiarioFinal ||
|-
| 40 || FoneBeneficiarioFinal || Fone do beneficiário final || Não Tratado || Não Tratado || Opcional ||
|-
| 41 || EnderecoBeneficiarioFinal || Endereço do beneficiário final || Não Tratado || Não Tratado || Opcional ||
|-
| 42 || CepBeneficiarioFinal || CEP do beneficiário final || Não Tratado || Não Tratado || Opcional ||
|-
| 43 || CidadeBeneficiarioFinal || CidadeBeneficiarioFinal || Não Tratado || Não Tratado || Opcional ||
|-
| 44 || UfBeneficiarioFinal || UF do beneficiário final || Não Tratado || Não Tratado || Opcional ||
|-
|}

</center>

'''(*) Domínios:'''
 
A - DUPLICATA MERCANTIL (DM)
 
B - DUPLICATA RURAL (DR)
 
C - NOTA PROMISSORIA (NP)
 
D - NOTA PROMISSORIA RURAL (NR)
 
E - NOTA DE SEGURO (NS)
 
G - RECIBO (RC)
 
H - LETRA DE CAMBIO (LC)
 
I - NOTA DE DEBITO (ND)
 
J - DUPLICATA DE SERVICO (DS)
 
K - OUTROS (OS)
 
O - BOLETO OFERTA (OFE)

==Alteração de Boletos==
<center>

{| class="wikitable"
|-
! Nº !! Campo JSON !! Descriçao do Banco !! Campo CIGAM !! Tabela !! Obrigatório !! Observações
|-
| 1 || agencia || Agência do Beneficiário || Agência || Portador || Obrigatório ||
|-
| 2 || posto || Posto do Beneficiário || Dígito Agência || Portador || Obrigatório ||
|-
| 3 || cedente || Código do Beneficiário || Código Cedente || Portador || Obrigatório ||
|-
| 4 || nossoNumero* || Nosso Número do Título || Nosso Número || Boletos || Obrigatório ||
|-
| 5 || instrucaoComando || Comando que será realizado na alteração do boleto. || || || Obrigatório || Caso seja informado ALTERACAO_OUTROS_DADOS será '''obrigatória''' a inclusão do campo complementoInstrucao.
|-
| 5.1 || PEDIDO_BAIXA || || || || Obrigatório || Consultar o Termo de Adesão com sua Unidade de Atendimento Sicredi p/ ver se está com Baixa Automática de boletos vencidos. Caso esteja, o boleto vencido terá sua baixa efetuada automaticamente.
|-
| 5.2 || CONCESSAO_ABATIMENTO || || || || Obrigatório ||
|-
| 5.3 || CANCELAMENTO_ABATIMENTO_CONCEDIDO || || || || Obrigatório ||
|-
| 5.4 || ALTERACAO_VENCIMENTO || || || || Obrigatório ||
|-
| 5.5 || ALTERACAO_SEU_NUMERO || || || || Obrigatório ||
|-
| 5.6 || PEDIDO_PROTESTO || || || || Obrigatório || Somente em título vencido. Por padrão, todos os boletos emitidos pelo EComm-API, não são protestados.
|-
| 5.7 || SUSTAR_PROTESTO_BAIXAR _TITULO || || || || Obrigatório ||
|-
| 5.8 || SUSTAR_PROTESTO_MANTER_CARTEIRA || || || || Obrigatório ||
|-
| 5.9 || ALTERACAO_OUTROS_DADOS || || || || Obrigatório ||
|-
| 6 || complementoInstrucao || Complemento do comando que será realizado na alteração do boleto || || || Condicional ||
|-
| 6.1 || DESCONTO || || || || Condicional ||
|-
| 6.2 || JUROS_DIA || || || || Condicional ||
|-
| 6.3 || DESCONTO_DIA_ANTECIPACAO || || || || Condicional ||
|-
| 6.4 || DATA_LIMITE_CONCESSAO_DESCONTO || || || || Condicional ||
|-
| 6.5 || CANCELAMENTO_PROTESTO _AUTOMATICO || || || || Condicional ||
|-
| 6.6 || CANCELAMENTO_NEGATIVACAO_AUTOMATICA || || || || Condicional ||
|-
| 7 || ''Campo de Alteração'' || Nome do campo que deseja mudar || || || Obrigatório ||
|-
|}

</center>

='''Como realizar a criação de Lançamentos utilizando a funcionalidade Open Banking?'''=
 
Para a criação de Lançamentos Financeiros acessar o caminho de Menu:
 

'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 

Acessar o botão “Criar” e informar os dados necessários para a criação do Lançamento Financeiro a Receber utilizando o Portador parametrizado para Open Banking.
 
 
'''1- Etapa criação do Lançamento:'''
 
 
<center>'''Criação do Lançamento Financeiro a Receber'''
[[Arquivo:Create Lanc Open Banking.png|750x500px|semmoldura|nenhum|Criação do Lançamento Financeiro]]
 
 

'''2- Etapa Impressão do Boleto Bancário do Lançamento Financeiro:'''
 
Nesta etapa pode ser realizado a impressão do Boleto Bancário diretamente pelo próprio Lançamento Financeiro ou através da rotina de Emissão em lote "Emissão de Boletos Personalizados":
 
 
<center>'''Impressão do Boleto Bancário do Lançamento Financeiro'''
[[Arquivo:Imprimir Boleto Lanc.png|750x500px|semmoldura|nenhum|Impressão Boleto Bancário]]
 
 

'''3- Etapa do Registro do Boleto Open Banking:'''
 
Nesta etapa pode ser realizado o "Registro" do Boleto diretamente pelo próprio Lançamento Financeiro ou através da rotina de Emissão em lote "Emissão de Boletos Personalizados":
Basta acessar a Categoria "Open Banking" e selecionar o Item de Categoria "Registrar".
Sistema irá realizar a comunicação através das parametrizações realizadas das Urls e Tokens de acesso e listará a situação do Registro do Boleto Bancário através do Relatório.
 
 
<center>'''Registrar Boleto Open Banking através Lançamento Financeiro'''
[[Arquivo:Boleto Impresso Registrar OP.png|750x500px|semmoldura|nenhum|Registro Boleto Open Banking]]
 
 
<center>'''Relatório Remessa Bancária OnLine'''
[[Arquivo:Relat Registro Open Banking.png|750x500px|semmoldura|nenhum|Relatório Remessa Bancária Online]]
 
 
Após o registro automaticamente o sistema marca as opções de:
 
- Remessa Enviada
 
- Códigos de Barras Lido
 
 
<center>'''Boleto Bancário Registrado'''
[[Arquivo:Lanc Registrado Validar Historico.png|750x500px|semmoldura|nenhum|Lanc_Registrado_Validar_Historico]]
 
 
Para verificar todas as movimentações realizada sobre Open Banking, elas estão sendo gravadas no Item de Categoria "Histórico" que fica na Categoria "Open Banking".
Ao selecionar o Item de Categoria "Histórico" deve listar o Registro do Boleto Bancário.
 
 
<center>'''Item de Categoria Histórico de Movimentos Open Banking'''
[[Arquivo:Item Categoria Historico.png|750x500px|semmoldura|nenhum|Item_Categoria_Histórico]]
 
 

='''Como realizar o Envio em Lote Open Banking através da rotina Remessa de Cobrança Open Banking?'''=

Assim como é possível realizar o Envio do Registro do Boleto Bancário através do próprio Lançamento Financeiro, existe a possibilidade de realizar esse processo em Lote, quando se tratar de vários registros a serem enviados.
Através do Menu:
 
 
'''Menu: Finanças > Gestão Financeira > Rotinas > EDI> Transmite > Remessa Cobranças Bancárias > Remessa de Cobrança Open Banking'''
 
 
<center>'''Remessa de Cobrança Open Banking'''
[[Arquivo:Remessa_de_Cobranca_Open_Banking_BB3.png|750x500px|semmoldura|nenhum|Remessa_de_Cobranca_Open_Banking]]
 
 
Esta rotina tem um conceito muito simples em relação aos filtros, foram disponibilizados campos essências que permitem ter uma rastreabilidade dos movimentos.

'''Unidade de Negócio:''' informe a Unidade de Negócio desejada para realizar o filtro para busca dos movimentos.
 
'''Data:''' informe a Data desejada para realizar o filtro para busca dos movimentos.
 
'''Vencimento:''' informe o período de Vencimento desejado para realizar o filtro para busca dos movimentos.
 
'''Lançamento:''' informe a faixa de Lançamentos desejada para realizar o filtro para busca dos movimentos.
 
'''Tipo de Pagamento:''' informe o Tipo de Pagamento desejado para realizar o filtro para busca dos movimentos.
 
'''Série:''' informe a Série desejada para realizar o filtro para busca dos movimentos.
 
'''Nota Fiscal:''' informe a faixa de Nota Fiscal desejada para realizar o filtro para busca dos movimentos.
 
'''Conta Financeira:''' informe a Conta Financeira desejada para realizar o filtro para busca dos movimentos.
 
'''Empresa:''' informe a faixa de Empresa desejada para realizar o filtro para busca dos movimentos.
 
'''Cobrança:''' informe a faixa de Empresa de Cobrança desejada para realizar o filtro para busca dos movimentos.
 
 
Após informado os filtros e confirmado a operação da rotina o sistema gera um relatório com a listagem dos movimentos.
Na coluna "Registro", será listado se houve a confirmação ou ocorreu algum erro.
 
 
<center>'''Relatório Remessa de Cobrança Open Banking'''
[[Arquivo:Relat Remessa Bancaria Open Banking.png|750x500px|semmoldura|nenhum|Relat_Remessa_Bancaria_Open_Banking]]
 
 

='''Como realizar a alteração de Vencimento do Lançamento já Registrado Open Banking e reenviá-lo novamente?'''=
 

Irá surgir a necessidade de realizar a alteração do Vencimento do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?
 
'''Dado que''' já temos um Lançamento Financeiro já Registrado Open Banking, basta acessar o Lançamento Financeiro desejado através do caminho do Menu:
 
'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 
Acessar o Lançamento Financeiro em modo Modificar e alterar o campo "Venc.Original", automaticamente após alteração do Vencimento, o sistema insere o Comando "05" no campo "Comando de Remessa" e diante disso já emite uma mensagem:
 
'''Confirma o envio da alteração do título ao banco?'''
 
'''Importante:''' para o envio da alteração do Vencimento o sistema já considera o campo '''Vencimento''', caso seja utilizado a '''Modalidade''' como '''Seguinte''' por exemplo, onde é possível ter um Vencimento Original diferente do Vencimento.
 
<center>'''Lançamento Financeiro a Receber já Registrado'''
[[Arquivo:AlterarVenc Lanc1.png|750x500px|nenhum|AlterarVenc_Lanc1]]
 
 
Vencimento alterado, sistema insere o Comando "05" no campo "Comando de Remessa" e ao salvar o registro é emitido a mensagem: "Confirma o envio da alteração do título ao banco?"
 
<center>'''Vencimento alterado e registro salvo'''
[[Arquivo:Vencimento Alterado Msn.png|750x500px|nenhum|Vencimento_Alterado_Msn]]
 
'''Sim:''' é enviado o registro de alteração do Open Banking e se registrado com sucesso, sistema retira então o Comando de Remessa.
 
<center>'''Processo Concluído com Sucesso'''
[[Arquivo:Processo_Concluido_Sucesso_Lanc.png|750x500px|nenhum|Processo_Concluido_Sucesso_Lanc]]
 
Há possibilidades do tempo de comunicação com API do Banco não retornar imediatamente a confirmação do recebimento da Alteração do Vencimento. Quando ocorrer essa situação, sistema emite uma mensagem, solicitando aguardar, para tentar novamente o envio da alteração do vencimento.
Quando ocorrer essa situação, será necessário aguardar e após realizar o envio novamente ou através do próprio Lançamento ou através da rotina de Remessa de Cobrança - Open Banking, que remeterá as alterações para o Banco.
<center>'''Processo Pendente Alteração - Aguardar'''
[[Arquivo:Alteração Vencimento Processo Pendente Envio Aguardar.png|750x500px|nenhum|Alteração_Vencimento_Processo_Pendente_Envio_Aguardar]]
 
Já quando selecionado a opção '''Não''':
 
'''Não:''' não faz a comunicação do envio da alteração do vencimento via Open Banking. Este registro não foi notificado, logo será necessário realiza-lo através do próprio Lançamento ou através da rotina de Remessa de Cobrança Open Banking.
 
No Lançamento Financeiro é habilitado o botão "Reenviar Registro" no Item de Categoria "Open Banking".
Quando selecionado o botão '''Registrar Alteração''', sistema faz a comunicação via Open Banking e registra alteração de vencimento realizada.
 
<center>'''Lançamento Não Registrado a alteração de Vencimento com o Comando de Remessa'''
[[Arquivo:Botao Registrar Alteracao Habilitado.png|750x500px|nenhum|Botao_Registrar_Alteracao_Habilitado]]
 
Ao selecionar o botão "Registrar Alteração" sistema emite a mensagem para confirmar o envio.
 
<center>'''Botão Registrar Alteração'''
[[Arquivo:Registrar Alteracao Selecionado.png|750x500px|nenhum|Registrar_Alteracao_Selecionado]]
 
Após a confirmação o sistema registra alteração
 
<center>'''Processo Concluído com Sucesso'''
[[Arquivo:Processo_Concluido_Sucesso_Lanc.png|750x500px|nenhum|Processo_Concluido_Sucesso_Lanc]]
 
 
<center>'''Lançamento alterado e registrado'''
[[Arquivo:Lançamento alterado registrado.png|750x500px|nenhum|Lançamento_alterado_registrado]]
 

='''Como realizar a Alteração de Juros do Lançamento já Registrado Open Banking e reenviá-lo novamente?'''=
 

'''Irá surgir a necessidade de realizar a alteração de Juros do Lançamento Financeiro já registrado pelo Open Banking, qual é o passo a passo para proceder diante dessa modificação?'''
 
Dado que já temos um Lançamento Financeiro já Registrado Open Banking, basta acessar o Lançamento Financeiro desejado através do caminho do Menu:
 
'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 
'''Regra Sistema para os Juros:'''
 
Se no cadastro do Portador não possuir Comando de Remessa com as novas opções:
 
'''Tipo de Comando =''' Alteração de Juros para Juros
 
'''BANCO SICREDI:''' para este Banco por enquanto atende '''somente''' alteração de Juros para registro Open Banking, não registrando então caso alterado Multas.
 
Ao acessar o Lançamento Financeiro em modo Modificar e alterar o campo '''Juros Dias de''' ou '''Juros Mês de''', automaticamente após alteração dos Juros, o Sistema irá criar essa parametrização do Comando de Remessa com '''sugestão''', sendo passível de alteração, no Cadastro do Portador no botão '''Remessas''' e depois no botão '''Comandos'''.
 
'''Comando sugestão para Juros:'''
 
'''Código Operação =''' ATJ
 
'''Comando =''' ATJ
 
'''Descrição =''' ALTERAÇÃO DE JUROS PARA OPEN BANKING
 
'''Tipo de Comando =''' Alteração de Juros
 
 
<center>'''Cadastro do Portador Comando de Remessa Juros'''
[[Arquivo:Lancto Registrado Alteração Juros Dia 748.png|750x500px|nenhum|Lancto_Registrado_Alteração_Juros_Dia_748]]
 
 

'''Como é identificado a alteração de Juros para Banco?'''
 
Através das tags enviadas para API gravadas no Histórico do Open Banking Dados API:
 
'''instruçãoComando''':'''ALTERACAO_OUTROS_DADOS''' – indica que ocorreu uma alteração de registro no Lançamento.
 
'''complementoInstrucao''': '''JUROS_DIA''' – indica que há Juros no registro.
 
'''valor1''': 0.12, - indica o valor dos Juros.
 
 
<center>'''Lançamento Financeiro a Receber já Registrado alterando os Juros'''
[[Arquivo:Lancto Registrado Alteração Juros Dia.png|750x500px|nenhum|Lancto_Registrado_Alteração_Juros_Dia]]
 
 

Tags enviadas para API Banco:
 
 
<center>'''Dados API Tags referente aos Juros'''
[[Arquivo:Dados API Juros 748.png|750x500px|nenhum|Dados_API_Juros_748]]
 
 

='''Quais são as novidades após atualização para Versão 2 do Open Banking?'''=
 
Disponibilizado a Versão 2 para Open Banking que traz algumas novidades para o processo de Registro no Banco.
 
Nela terá um componente que quando atualizado a Base através do Assistente de Atualização (Atualiza CIGAM) será adicionado nos Parâmetros Open Banking da Configuração de Bancos, especificamente nas Credenciais, o registro '''Versão API''' = v2.
 
'''Finanças > Gestão Financeira > Parâmetros > Configurações de Bancos'''
 
<center>'''Parâmetros Open Banking'''
[[Arquivo:Parametros OP Sicredi Credenciais.png|750x500px|nenhum|Parametros_OP_Sicredi_Credenciais]]
 
A partir desta Versão o Sistema passa a realizar a busca para localizar os títulos da seguinte forma:
 
1- O sistema tenta localizar os títulos pelo Número do Lançamento;
 
2- Caso os títulos tenham sido gerados pelo CIGAM irá localizar pelo '''Nosso Número''', avaliando então a tabela '''GFBOLETOS''' pela coluna '''NOSSO_NRO'''.
 
3- Caso os títulos tenham sido gerados por outro sistema irá localizar pelo '''Nosso Número''', avaliando então a tabela '''GFLAUXIL''' pela coluna '''CODIGO_BARRAS'''.
 
Também nesta versão estão disponíveis as tags para Envio da Série/NF, sendo utilizado a Tag na API '''NumeroTituloBeneficiario'''. A regra é '''Serie''' '''NF''' '''Complemento Duplicata''', bem como descrito com espaços em Branco entre eles. Para verificar esse registro, basta acessar após o Registro no Banco o Histórico Open Banking na guia '''Envio''' e localizar para Tag '''NumeroTituloBeneficiario'''.
 
<center>'''Parâmetros de Convênio Open Banking'''
[[Arquivo:Wizard Passo 3-4 Final Sicredi.png|750x500px|nenhum|Wizard_Passo_3-4_Final_Sicredi]]
 
Atualizado Wizard para Versão 2 do Open Banking, disponibilizando duas opções:
 
'''- Direto''': esta opção tem como finalidade registrar o Boleto no momento da sua geração, ou seja, quando selecionado ativa propriedade ao qual ao gerar o Boleto Bancário o sistema automaticamente envia o registro Open Banking, sem a necessidade de fazer o processo de envio da Remessa Open Banking do título.
 
'''- PIX''': esta opção fica habilitada somente quando selecionado a opção '''Direto''', ela tem como finalidade registrar uma operação PIX para os Boletos emitido de forma Direta (opção '''Direto''' marcado).
 
Esta opção é válida '''SOMENTE''' para o Banco do Brasil.
 
Ao emitir o Boleto do Lançamento o sistema marca as 3 opções:
 
- Boleto Impresso;
 
- Remessa Enviada;
 
- Código de Barras Lido;
 
Outra mudança é no '''Histórico''' Open Banking, ao qual passa criar o registro com '''Status Open Banking''' já '''Registrado'''.
 
Também ao acessar os '''Dados API''' é enviado a tag: "indicadorPix": "S", pois a opção PIX esta selecionada.
 
Disponibilizado o Modelo de Relatório para o Boleto Banco do Brasil já com o QRCode:
 
'''I:\CIGAM\DOC\Modelos_relatorios\Gestão Financeira\Bloquetos Merge\0098_brasil_PIX.rtf'''

='''Como realizar a Baixa de um Lançamento Financeiro Registrado Open Banking e enviar o Registro de Baixa?'''=
 
Para realizar o processo de '''Baixa''' de um Lançamento Financeiro que foi registrado via Open Banking, basta acessar o Lançamento Financeiro.
 
'''Menu > Finanças > Gestão Financeira > Movimentos > Lançamentos'''
 
Selecionar a opção de Menu Lateral do Lançamento Financeiro '''Open Banking''' e a opção de '''Baixar'''.
 
<center>'''Lançamento Financeiro Registrado/Baixar'''
[[Arquivo:Opção Baixar Lancto.png|750x500px|nenhum|Opção_Baixar_Lancto]]
 
<center>'''Lançamento Financeiro Confirmando Operação'''
[[Arquivo:Deseja Baixar.png|750x500px|nenhum|Deseja_Baixar]]
 
<center>'''Lançamento Financeiro Baixado com Sucesso'''
[[Arquivo:Baixado Sucesso.png|750x500px|nenhum|Baixado_Sucesso]]
 

='''Como parametrizar para envio Open Banking a Negativação ou Protesto?'''=
 
Basta acessar o Cadastro do Portador e inserir os dias no campo '''Protestar após''' na guia '''Configurações.
 

'''Menu > Finanças > Gestão Financeira > Parâmetros > Portadores'''

 
<center>'''Dias de Protesto Cadastro do Portador'''
[[Arquivo:Cadastro Portador Negativacao Sicredi.png|750x500px|nenhum|Cadastro_Portador_Negativacao_Sicredi]]
 

Banco do Sicredi:
 
Para este Banco a negativação é parametrizada no Cadastro do Portador na guia “Configurações” no campo “Protestar após”, é através deste campo que o sistema reconhece e passa considerar o envio das tags para os dados da API do Banco.
 
'''"numDiasNegativacaoAuto": "07",'''

 

='''Como cadastrar as Mensagens de Retorno API Financeira Sugestão Usuário?'''=
 
As Mensagens de Retorno API Financeira é uma funcionalidade para facilitar a identificar e de orientação para com as mensagens provindas das APIs que o Sistema tem conexão.
 
Elas foram implementadas para Open banking.
 
Para acessar o cadastro basta acessar através do Menu:
 
'''Menu: Finanças > Gestão Financeira > Parâmetros > Mensagens de Retorno API Financeiro'''
 

<center>'''Mensagens de Retorno API Financeiro'''
[[Arquivo:Mensagens Retorno API Financeiro.png|750x500px|nenhum|Mensagens_Retorno_API_Financeiro]]
 

'''Banco:''' código do Banco conforme codificação no orgão que rege os Bancos Febraban.
 
'''Código Erro:''' código do erro conforme layout das APIS dos Bancos.
 
'''Status:''' é o código de Status de erro do Servidor retornado da API dos Bancos. (Código HTTP)
 
'''Descrição do Erro (Banco):''' essa descrição é oriunda do Banco retornada pela API deles.
 
'''Sugestão CIGAM:''' esta mensagem é interna do Sistema, ou seja, quando internamente identificarmos uma situação a qual a Mensagem retornada pelo Banco não é clara, vamos alimentar com Mensagens de sugestão, para orientar as possíveis causas, dando um norte para situação.
 
'''Sugestão Cliente:''' este campo é reservado para o próprio usuário, possibilitando cadastrar Mensagens que ele identificar para facilitar no processo de entendimento das Mensagens de Retorno das APIs.
 
Agora através desta aplicação, quando ocorrer um Erro de Open Banking é possível verificar através dos links dispostos na tela de Lançamento Financeiro no campo Situação Open Banking, terá um link para tabela do erro ocorrido.
 
<center>'''Lançamento Financeiro Mensagens de Retorno API Financeiro'''
[[Arquivo:Mensagens Retorno API Financeiro BB OP.png|750x500px|nenhum|Mensagens_Retorno_API_Financeiro_BB_OP]]
 
Ou também através do Histórico Open Banking:
 
<center>'''Lançamento Financeiro Mensagens de Retorno API Financeiro Histórico Open Banking'''
[[Arquivo:Historico OP Mensagens Retorno API Financeiro BB OP.png|750x500px|nenhum|Historico_OP_Mensagens_Retorno_API_Financeiro_BB_OP]]