Emissão de Boletos - SIEM

Analistas Responsável: Gustavo Henrique Braga Fernandes Este processo visa exemplificar as configurações necessárias e protótipos de tela para emissão de boletos via API, Banco Sicoob no SoftenSIEM

PROC001 Configurações
PROC002 Preenchimento da Carteira
PROC003 Eventos do Boleto
PROC004 Registro Automático de Boletos

PROC001 Configurações

Projeto/Sistema:

Emissão de Boletos - SIEM

Versão do Template:
1.1

Processo:
PROC001 Configurações

Versão do Documento:
1.0

Responsável(eis):
Gustavo Fernandes

Data:

10/02/2025

1. Introdução

Este processo visa exemplificar as configurações 2 necessárias para utilização do banco Sicoob via API.

Processos Relacionados

PROC002 Preenchimento da Carteira

Especificação Funcional

PROC001 Configurações:

Protótipo de Tela:

Imagem 1 - Tela Configurações 2

Regras de Negócio:

1. FINANCEIRO: AMBIENTE DE ENVIO BANCO SICOOB (0=HOMOLOGACAO(PADRAO)/1=PRODUCAO):
Identifica se o valor será enviado para ambiente de testes nos ENDEREÇOS DE SANDBOX ou diretamente para ambiente de PRODUÇÃO, a diferença será nos endereços que ele vai acessar em cada ambiente.

Método HTTP	URL
GET	/boletos/{codigoBarras}

2. FINANÇA: COBRANÇA SICOOB: QUEM NUMERA O BOLETO (0=O SISTEMA / 1= O BANCO):
Será utilizada para definição de quem vai numerar o boleto.

Obs: Os Headers seguirão um padrão para todas as APIs.
Headers e requisição de exemplo

Questões Técnicas:

1. Configurações ficaram salvar na tabela do banco de dados CD_CONFIG_CAMPO

2. Configurações salvar pelo uusário, salvar na tabela CD_CONFIG_DEFINE

3. SQL exemplo para alimentação da tabela no banco de dados
(SUBSTITUIR OS CÓDIGO 700, 701, CONFORME O NECESSÁRIO, FORAM APENAS EXEMPLOS!!)

INSERT INTO CD_CONFIG_CAMPO ( CODIGO, DESCRICAO )
SELECT 700 AS Expr1, 'FINANCEIRO: AMBIENTE DE ENVIO BANCO SICOOB (0=HOMOLOGACAO(PADRAO)/1=PRODUCAO):' AS Expr2;

INSERT INTO CD_CONFIG_CAMPO ( CODIGO, DESCRICAO )
SELECT 701 AS Expr1, 'FINANÇA: COBRANÇA SICOOB: QUEM NUMERA O BOLETO (0=O SISTEMA / 1= O BANCO):' AS Expr2;

4. Além das configurações criadas, ainda se utilizarão de config já existentes, como:

FINANÇA: INSTRUÇÃO DO BOLETO DE COB. LINHA 1
FINANÇA: INSTRUÇÃO DO BOLETO DE COB. LINHA 2

Entre outras que existem.

©SOFTEN SISTEMAS 2025

PROC002 Preenchimento da Carteira

Projeto/Sistema:

Emissão de Boletos - SIEM

Versão do Template:
1.1

Processo:
PROC002 Preenchimento da Carteira

Versão do Documento:
1.0

Responsável(eis):
Gustavo Fernandes

Data:

11/02/2025

1. Introdução

Este processo visa exemplificar as configurações da carteira necessárias para utilização do banco Sicoob via API.

Processos Relacionados

PROC001 Configurações

Endpoints Produção (Exemplos JSON)

Especificação Funcional

PROC002 Preenchimento da Carteira:

Protótipo de Tela:

A configuração da carteira para a emissão também será preenchida junto com as os demais bancos (em Configurações > Financeiro > Carteira / Conta Mov.)

Imagem 1 - Configurações da Carteira

Descrição dos Campos:

*Campos seguem os mesmos padrões já estabelecidos no SIEM*

Campo	Tipo	Tamanho	Obrig. ?	Máscara	Observações
Banco	Texto		Sim	-	-
Chave da Aplicação	Texto		Sim	-	Seria referente ao Client ID
Token da Aplicação	Texto		Sim	-	Seria referente ao Acess Token (Bearer)

Sandbox - (homologação) - Credenciais de teste

Regras de Interface:

1. Regras do campo:
Seguir o mesmo padrão já estabelecido no SIEM quando se trata da integração BB2.

Regras de Negócio:

1. Regras de negócio:
Seguir o mesmo padrão já estabelecido no SIEM quando se trata da integração BB2..

Questões Técnicas:

1. Descrição de mudanças na base de dados, ou integração de API.
Seguir o mesmo padrão já estabelecido no SIEM quando se trata da integração BB2.

©SOFTEN SISTEMAS 2025

PROC003 Eventos do Boleto

Projeto/Sistema:
Emissão de Boletos - SIEM

Versão do Template:
1.1

Processo:
PROC003 Eventos do Boleto

Versão do Documento:
1.0

Responsável(eis):
Gustavo Fernandes

Data:

11/02/2025

1. Introdução

Este processo visa exemplificar a tela de integração com banco Sicoob, para consultar, registros, etc.

Processos Relacionados

PROC001 Configurações

PROC002 Preenchimento da Carteira

Especificação Funcional

PROC003 Eventos do Boleto:

Protótipo de Tela:

Imagem 1 - Caminho para gerar arquivos de cobrança via API.

Imagem 2 - Tela de eventos

Regras de Interface:

1. Alteração no caminho para gerar arquivos de cobrança via API:
Na imagem 1, seguir as mesmas regras já estebelecidas para integração via API BB, contudo, agora o nome ficará diferente, mais abrangente para outros bancos Arquivo de Remessa Cobrança (Integração API).

2. Opção de selecionar carteira que são integradas via API:
Na imagem 2, seguir as mesmas regras já estabelecidas para integração via API BB, contudo, agora ele deve permitir selecionar, as carteiras que são integrações via API, no exemplo teria BB e SCB2 - SICOOB.

Regras de Negócio:

1. Botão Cancelar Boletos:
Deve realizar a requisição na API conforme especificado no 2.1.7 Serviço para comandar a baixa de boletos informados
A requisição será realizada apenas para boletos que esteja com o status "Registrado".

2. Alterar Boleto:
Deve realizar a requisição na API, conforme especificado no 2.1.6 Serviço para alteração de dados de boleto já registrado.
A requisição será realizada apenas para boletos que esteja com o status "Registrado".

3. Imprimir Boletos:
Deve realizar a requisição na API, conforme especificado no 2.1.4 Serviço para emissão da segunda via de boleto já registrado.
A requisição será realizada apenas para boletos que esteja com o status "Registrado".

4. Atualizar Status:
Deve realizar a requisição na API, conforme especificado no 2.1.2 Serviço para consulta de um boleto bancário.
A requisição será realizada apenas para boletos que esteja com o status "A enviar".

5. Registrar Boletos:
Deve realizar a requisição na API, conforme especificado no 2.1.1 Serviço para a inclusão de boletos.
A requisição será realizada apenas para boletos "A enviar" ou "A registrar",

Questões Técnicas:

1. Seguir o mesmo padrão existente hoje no SIEM para integração via API BB, nas tabelas do banco de dados.

2. Dados a serem usados para teste em abiente de homologação, conforme:
Docs - Sandbox (Homologação)

3. Detalhes de cada enpoint relacionado a boletos:
Endppoints Produção (Exemplo JSON retornos)

PROC004 Registro Automático de Boletos

Projeto/Sistema:

Emissão de Boletos - SIEM

Versão do Template:
1.1

Processo:
PROC004 Registro Automático de Boletos

Versão do Documento:
1.0

Responsável(eis):
Gustavo Fernandes

Data:

11/02/2025

1. Introdução

Este processo visa exemplificar as formas em que podemos gerar os boletos via API Sicoob no sistema de forma automática, assim como é feito com remessa.

Processos Relacionados

PROC003 Eventos do Boleto

Especificação Funcional

PROC004 Registro Automático de Boletos:

Protótipo de Tela:

Imagem 1 - Emissão de Boleto no Pedido de Venda

Imagem 2 - Emissão de Boleto na Nota Fiscal (config. 2)

Imagem 3 - Emissão de Boleto pela tela de Duplicata a Receber

Imagem 4 - Opção Reemitir Boleto

Regras de Interface:

1. Regras do campo:
Seguir o mesmo padrão já estabelecido no SIEM para remessas de boleto.

Regras de Negócio:

1. Pedido de venda (Imagem 1):
Será realizado o envio do boleto para registro quando o usuário marcar "Boleto" na opção Emitir ao Finalizar e selecionar uma carteira configurada com a opção SCB2 para emissão.

Ao clicar em confirmar, deve ser realizada a requisição de Registro dos boletos para cada parcela gerada.
Caso sejam registrados com sucesso, deve ser gerado o PDF de cada boleto.
Se não registrar alguma parcela, deve retornar o status e uma mensagem ao usuário:
"Erro: uma das parecelas não foi registrada, retorno: Retorno do banco"

2. Nota Fiscal (Imagem 2):
Deve realizar o envio dos boletos para envio quando estiver habilitada a configuração:
"FATURAMENTO: GERAR BOLETO (A RECEBER) AO FINALIZAR NFE (0=NÃO/1=SIM):".

O usuário deve fazer o preenchimento das parcelas na NFe, finaliza-la, clicar em "Sim" na mensagem de confirmação (conforme o exemplo abaixo) e selecionar uma carteira configurada com a opção SCB2 para emissão.

Ao clicar em confirmar, deve ser realizada a requisição de Registro dos boletos, para cada parcela preenchida.
Caso sejam registrados com sucesso, deve ser gerado o PDF de cada boleto.
Caso contrário, deve-se retornar uma mensagem ao usuário:
"Erro: uma das parecelas não foi registrada, retorno: Retorno do banco"

3. Duplicata a Receber (Imagem 3):
Quando for selecionada uma carteira configurada com a opção SCB2 para emissão e o usuário marcar a opção
"Emitir Boleto", deve ser realizada a requisição de Registro dos boletos.

Se estiver preenchido para repetir lançamentos para mais parcelas, deve ser realizado um envio para cada uma.
Após serem registrados, deve ser gerado o PDF de cada boleto.
Se não forem registradas, retornar mensagem ao usuário:
"Erro: uma das parecelas não foi registrada, retorno: Retorno do banco"

4. Tela de Consulta Duplicatas a Receber (Imagem 4):
Quando o usuário clicar na opção "Reemitir Boleto" e selecionar uma carteira que esteja configurada com a opção SCB2 para emissão, deve ser realizada a requisição para registro dos boletos selecionados.

5. Para que as requisições de registro sejam realizadas, o status de cada Conta a Receber deve ser "A enviar".

6. Para que as requisições de geração do PDF sejam realizadas, os status devem estar como "Registrado".

7. Quando se tratar de edição de alguma das formas mencionadas e o boleto já estiver registrado, deve ser realizada apenas a requisição de Geração do PDF novamente para o usuário.

Questões Técnicas:

1. Descrição de mudanças na base de dados, ou integração de API, ou arquivo que deva ser gerado.