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

Edição atual tal como às 15h07min de 21 de outubro de 2024

O que é necessário saber antes de configurar ?

Contratar o pacote de emissão boleto API da POST Sistemas, de acordo com a quantidade de boletos mensal.
Solicitar ao banco a emissão de boletos pela API. Pode haver interpretações por parte do banco, explique que é para emitir o boleto usando a API e não o arquivo de remessa.

Este serviço deve ser contratado junto ao banco. Se desejar emitir com PIX, solicite essa opção.

Importante estar atento para não afetar o que o cliente já tenha contratado.

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	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	0 - 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.

PRONTO! Agora realize o teste de emitir o boleto, verificar se registrou e efetuar o pagamento.

@@ Linha 1: / Linha 1: @@
-Banco
+O que é necessário saber antes de configurar ?
-Solicitar ao banco para habilitar a emissão de boletos pela API.
+# Contratar o pacote de emissão boleto API da POST Sistemas, de acordo com a quantidade de boletos mensal.
+# Solicitar ao banco a emissão de boletos pela API. Pode haver interpretações por parte do banco, explique que é para emitir o boleto usando a API e não o arquivo de remessa.
+<blockquote>Este serviço deve ser contratado junto ao banco. Se desejar emitir com PIX, solicite essa opção.</blockquote>Importante estar atento para não afetar o que o cliente já tenha contratado.
+=== Como configurar no sistema ===
+Passo a passo de como configurar a emissão de boletos pela API, no sistema.
-Como configurar 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.
-Passo a passo de como configurar no sistema.
+==== Portador ====
+Cadastrar um novo portador no contas a receber.
-<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.
-Portador
-Cadastrar um portador novo 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.
+==== Configurações ====
+{| class="wikitable"
+|+Cod.Módulo 1005 - Projeto Bco
+!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
+|
+|}
-Gravar
+==== 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).
-Entrar na configuração do portador que vai habilitar após estar gravado para abrir a tela de configurações da parametrização.
+Considerar que cada banco tenha as suas configurações específicas.
+=== SICREDI ===
-Configuração Portador API
+===== 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
+|}
-Consiste em 3 grupos, API, Banco e Geral.
+===== Grupo Banco =====
+Preencher conforme o cadastro do cliente com o banco e suas necessidades de emissão.
-API
-Será necessário ter as credenciais do banco.
-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.
-Banco
-Nesse grupo é necessário preencher conforme o cadastro do cliente com o banco e suas predefinições.
-Geral
-Tipo de Envio: API
-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
+|0 - 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.
+'''PRONTO! Agora realize o teste de emitir o boleto, verificar se registrou e efetuar o pagamento.'''