Emissão Automática de Boletos - API: mudanças entre as edições

Edição das 14h46min de 21 de outubro de 2024

Banco

Solicitar ao banco para habilitar a emissão de boletos pela API.

Como configurar no sistema

Passo a passo de como configurar a emissão de boletos pela API, no sistema.

As instruções a seguir têm como objetivo orientar a configuração da emissão, abordando os requisitos técnicos necessários. Este guia não fornecerá explicações sobre como acessar as configurações nem sobre conceitos como portador e conta. É importante ter um bom entendimento do processo para evitar possíveis problemas.

Portador

Cadastrar um novo portador no contas a receber.

Ind.Tipo deve ser 2 - Banco.

Ind.Cob.Banco: Escolher o banco.

Configurações

Cod.Módulo 1005 - Projeto Bco

Chave Tipo Boleto: Escolher o formato que será impresso.

Chave ID Portador Boletos: Escolher o portador (padrão) de emissão, manter "0" e configurar com a origem do portador criado. OU, avaliar e manter somente no padrão caso seja único.

Chave Versão: Alterar para 1 - Modelo Novo.


Chave	Valor	Observação
Tipo Boleto	Escolher opção	Escolher o formato que será impresso
ID Portador Boletos	0 (padrão)	Portador padrão do sistema
Versão	1 - Modelo Novo

Configuração ID.Origem do Portador

Entrar na configuração com ID.Origem do portador (pode ser acessado pelas configurações no cadastro do portador).

Considerar que cada banco tenha as suas configurações específicas.

SICREDI

Grupo API

Será necessário solicitar as credenciais para o banco.


Chave	Valor	Observação
Ambiente	1- Produção
Usuário	******	Fornecido pelo banco
Senha	******	Fornecido pelo banco ou internet banking
X-API-KEY	******	Access token gerado pelo portal do desenvolvedor

Grupo Banco

Preencher conforme o cadastro do cliente com o banco e suas necessidades de emissão.

Grupo Geral

Essas são as configurações padrões, podem haver mais chaves no sistema de situações específicas.


Chave	Valor	Observação
Tipo de Envio	API
Tipo de Registro	0 - Obrigar registro
Tipo de Cobrança	0 - Normal: somente boleto 1 - Híbrido: boleto e pix.	verificar no contrato cliente/banco.
IDEmpresa		Define a empresa responsável pelo boleto
Gerar Dados	Habilitar todas	Opção que o sistema irá gerar para o boleto. Verificar no contrato cliente/banco.
Prefixo	3 até 9	Valor fixo na máscara do boleto. É necessário verificar os boletos já emitidos e sua máscara para evitar duplicidade
Sequencial		Sequencial dos boleto.
Data Consulta	Deixar em branco	Sistema armazena a data do dia anterior para o uso do retorno.

Tipo de pagamento

Cadastrar Ind.Boleto API no cadastro de Tipo de pagamento.

Cadastrar as empresas a partir do tipo de pagamento.

Cadastrar o boleto e vincular o portador para a empresa.

@@ Linha 2: / Linha 2: @@
 Solicitar ao banco para habilitar a emissão de boletos pela API.
 Como configurar no sistema
-Passo a passo de como configurar no sistema.
+Passo a passo de como configurar a emissão de boletos pela API, no sistema.
-<nowiki>***</nowiki>Ver para habilitar o ID.Origem
-# Cod.Módulo 1005 - Projeto Bco
-Chave Tipo Boleto: Escolher o formato que será impresso.
-Chave ID Portador Boletos: Escolher o portador de emissão.
-Chave Versão: Alterar para 1 - Modelo Novo.
+As instruções a seguir têm como objetivo orientar a configuração da emissão, abordando os requisitos técnicos necessários. Este guia não fornecerá explicações sobre como acessar as configurações nem sobre conceitos como portador e conta. É importante ter um bom entendimento do processo para evitar possíveis problemas.
 Portador
-Cadastrar um portador novo no contas a receber.
+Cadastrar um novo portador no contas a receber.
 Ind.Tipo deve ser 2 - Banco.
-Ind.Cob.Banco: Escolher a instituição bancária.
+Ind.Cob.Banco: Escolher o banco.
-ID.Conta: Escolher a conta do banco no plano de contas.
-Gravar
+Configurações
+# Cod.Módulo 1005 - Projeto Bco
-Entrar na configuração do portador que vai habilitar após estar gravado para abrir a tela de configurações da parametrização.
+Chave Tipo Boleto: Escolher o formato que será impresso.
+Chave ID Portador Boletos: Escolher o portador (padrão) de emissão, manter "0" e configurar com a origem do portador criado. OU, avaliar e manter somente no padrão caso seja único.
-Configuração Portador API
+Chave Versão: Alterar para 1 - Modelo Novo.
+{| class="wikitable"
-Consiste em 3 grupos, API, Banco e Geral.
+|+
+!Chave
-API
+!Valor
+!Observação
-Será necessário ter as credenciais do banco.
+|-
+|Tipo Boleto
-Ambiente: 1 - Produção
+|Escolher opção
+|Escolher o formato que será impresso
-Usuário: Fornecido pelo banco.
+|-
+|ID Portador Boletos
-Senha: Fornecido pelo banco ou internet banking.
+|0 (padrão)
+|Portador padrão do sistema
+|-
+|Versão
+|1 - Modelo Novo
+|
+|}
-X-API-KEY: Access token gerado pelo portal do desenvolvedor.
+Configuração ID.Origem do Portador
-Banco
+Entrar na configuração com ID.Origem do portador (pode ser acessado pelas configurações no cadastro do portador).
-Nesse grupo é necessário preencher conforme o cadastro do cliente com o banco e suas predefinições.
+Considerar que cada banco tenha as suas configurações específicas.
+===== SICREDI =====
-Geral
+====== Grupo API ======
+Será necessário solicitar as credenciais para o banco.
+{| class="wikitable"
+|+
+!Chave
+!Valor
+!Observação
+|-
+|Ambiente
+|1- Produção
+|
+|-
+|Usuário
+|******
+|Fornecido pelo banco
+|-
+|Senha
+|******
+|Fornecido pelo banco ou internet banking
+|-
+|X-API-KEY
+|******
+|Access token gerado pelo portal do desenvolvedor
+|}
-Tipo de Envio: API
+====== Grupo Banco ======
+Preencher conforme o cadastro do cliente com o banco e suas necessidades de emissão.
-Tipo de Registro: 0 - Obrigar registro.
-Tipo de Cobrança:
-- Normal: somente boleto
+====== Grupo Geral ======
+Essas são as configurações padrões, podem haver mais chaves no sistema de situações específicas.
+{| class="wikitable"
+|+
+!Chave
+!Valor
+!Observação
+|-
+|Tipo de Envio
+|API
+|
+|-
+|Tipo de Registro
+|0 - Obrigar registro
+|
+|-
+|Tipo de Cobrança
+|0 - Normal: somente boleto
 - Híbrido: boleto e pix.
+|verificar no contrato cliente/banco.
+|-
+|IDEmpresa
+|
+|Define a empresa responsável pelo boleto
+|-
+|Gerar Dados
+|Habilitar todas
+|Opção que o sistema irá gerar para o boleto. Verificar no contrato cliente/banco.
+|-
+|Prefixo
+|3 até 9
+|Valor fixo na máscara do boleto. É necessário verificar os boletos já emitidos e sua máscara para evitar duplicidade
+|-
+|Sequencial
+|
+|Sequencial dos boleto.
+|-
+|Data Consulta
+|Deixar em branco
+|Sistema armazena a data do dia anterior para o uso do retorno.
+|}
-IDEmpresa: Define a empresa responsável pelo boleto.
+====== Tipo de pagamento ======
-Gerar Dados: Opção que o sistema irá gerar para o boleto. Habilitar ambos.
-Prefixo: Valor fixo na máscara do boleto. É necessário verificar os boletos já emitidos e sua máscara para evitar duplicidade. Colocar um número de 3 até 9.
-Sequencial: sequencia dos boletos.
-Data Consulta: armazena a data do dia anterior para o uso do retorno.
-Emitente Razão: Razão do emitente fixo para impressão dos boletos. Vai substituir a razão, na impressão, configurado no boleto.
-CNPJ do emitente fixo para impressão dos boletos. Vai substituir o CNPJ, na impressão, configurado no boleto.
-Emitente endereço 1: Parte do endereço fixo para a emissão do boleto. Formato de exemplo:
-"Título logradouro" "Logradouro", "número" - "complemento"
-Emitente endereço 2: Parte do endereço fixo para a emissão do boleto. Formato de exemplo:
-"Bairro" - "Cidade"/"UF" - CEP:"CEP"
-Fechar e abrir o sistema para carregar as novas configurações.
 Cadastrar Ind.Boleto API no cadastro de Tipo de pagamento.
-Clicar em "Empresas" para abrir o cadastro de tipo de pagamento por empresa.
+Cadastrar as empresas a partir do tipo de pagamento.
 Cadastrar o boleto e vincular o portador para a empresa.