APIs de Cobrança - Histórico de revisão

LucasLp: Adicionada legenda Imagem 6 - Painel Retorno

2026-01-27T20:24:42Z

Adicionada legenda Imagem 6 - Painel Retorno

← Edição anterior		Edição das 20h24min de 27 de janeiro de 2026
Linha 192:		Linha 192:
	== Retorno Boletos ==		== Retorno Boletos ==
	No painel de retorno é possível realizar consulta à API da Sicredi para obter atualizações do boletos.		No painel de retorno é possível realizar consulta à API da Sicredi para obter atualizações do boletos.
	[[Arquivo:2026-01-27 17-22.png\|nenhum\|miniaturadaimagem\|851x851px]]		[[Arquivo:2026-01-27 17-22.png\|nenhum\|miniaturadaimagem\|851x851px\|Imagem 6 - Painel Retorno]]
	Para isso:		Para isso:

LucasLp: Adicionada seção sobre Retorno Boletos

2026-01-27T20:23:20Z

Adicionada seção sobre Retorno Boletos

@@ Linha 187: / Linha 187: @@
 # Cria os boletos de todas as vendas/serviços do período
-# Você escolhe se quer imprimir
+# Imprime automaticamente e envia para a API do Sicredi.
 O mesmo ocorre para o faturamento de cliente em Financeiro > Faturamento > Faturar - Geral.

LucasLp: Adicionado seção para No Faturamento de Clientes

2026-01-27T20:00:55Z

Adicionado seção para No Faturamento de Clientes

← Edição anterior		Edição das 20h00min de 27 de janeiro de 2026
Linha 172:		Linha 172:
	# Envia para a API do Sicredi		# Envia para a API do Sicredi
	# Imprime o boleto		# Imprime o boleto
	# Cliente já pode ~~pagarComo~~ usar:		# Cliente já pode pagar
			Como usar:
	# Faça a venda normalmente no PDV		# Faça a venda normalmente no PDV
	# Na hora de finalizar, escolha a forma de pagamento "Boleto"		# Na hora de finalizar, escolha a forma de pagamento "Boleto"
Linha 181:		Linha 181:
	=== No Faturamento de Clientes ===		=== No Faturamento de Clientes ===

	* Caminho no ~~meu~~: Financeiro > Faturamento > Faturar - ~~Cliente~~		* Caminho no menu: Financeiro > Faturamento > Faturar - Geral
	* Ao gerar o faturamento mensal de clientes		* Ao gerar o faturamento mensal de clientes

Linha 188:		Linha 188:
	# Cria os boletos de todas as vendas/serviços do período		# Cria os boletos de todas as vendas/serviços do período
	# Você escolhe se quer imprimir		# Você escolhe se quer imprimir
	# Ao imprimir, o sistema envia para a API do Sicredi		# Ao imprimir, o sistema envia para a API do Sicredi.
			O mesmo ocorre para o faturamento de cliente em Financeiro > Faturamento > Faturar - Geral.

LucasLp: Adicionada seção sobre Envio de Boleto para a API

2026-01-27T19:37:43Z

Adicionada seção sobre Envio de Boleto para a API

← Edição anterior		Edição das 19h37min de 27 de janeiro de 2026
Linha 160:		Linha 160:
	Na I'''magem 5''' abaixo é exibido o caminho para geração do código de acesso para utilizar no campo Client Secret.		Na I'''magem 5''' abaixo é exibido o caminho para geração do código de acesso para utilizar no campo Client Secret.
	[[Arquivo:2026-01-27 15-55.png\|nenhum\|miniaturadaimagem\|Imagem 5 - Internet Banking]]		[[Arquivo:2026-01-27 15-55.png\|nenhum\|miniaturadaimagem\|Imagem 5 - Internet Banking]]

			== Envio de Boleto para a API ==

			=== No PDV (Ponto de Venda) ===

			* Ao fechar uma venda escolhendo "'''Boleto'''" como forma de pagamento.

			* O sistema automaticamente:

			# Cria o boleto
			# Envia para a API do Sicredi
			# Imprime o boleto
			# Cliente já pode pagarComo usar:

			# Faça a venda normalmente no PDV
			# Na hora de finalizar, escolha a forma de pagamento "Boleto"
			# Confirme a venda
			# O sistema envia automaticamente para o banco e imprime

			=== No Faturamento de Clientes ===

			* Caminho no meu: Financeiro > Faturamento > Faturar - Cliente
			* Ao gerar o faturamento mensal de clientes

			* O sistema:

			# Cria os boletos de todas as vendas/serviços do período
			# Você escolhe se quer imprimir
			# Ao imprimir, o sistema envia para a API do Sicredi

LucasLp: Informações extras

2026-01-27T19:05:40Z

Informações extras

← Edição anterior		Edição das 19h05min de 27 de janeiro de 2026
Linha 83:		Linha 83:

	* Tipo de Protesto:		* Tipo de Protesto:
	** ATENÇÃO: Para Sicredi, NÃO selecione "Dias Úteis"		** ATENÇÃO: Para Sicredi, NÃO selecione "Dias Úteis" para o módulo cobrança Sicredi Com Registro ou Sem Registro.
	** Use "Dias Corridos" ou outra opção		** Use "Dias Corridos" ou outra opção.

	* Dias para Protesto: Ex: 5 (protestar após 5 dias)		* Dias para Protesto: Ex: 5 (protestar após 5 dias)

LucasLp: Adicionado trecho de geração do código de acesso.

2026-01-27T18:59:45Z

Adicionado trecho de geração do código de acesso.

← Edição anterior		Edição das 18h59min de 27 de janeiro de 2026
Linha 154:		Linha 154:
	\|✅ SIM - Obrigatório (é como uma senha)		\|✅ SIM - Obrigatório (é como uma senha)
	\|}		\|}
	Para preencher o '''Cliente ID / User''', deve ser concatenados o código do beneficiário e o código da cooperativa, ou seja, o convênio e a agência. Seguindo o exemplo da '''imagem 4''', o campo "Client ID /User" é a junção do convênio 12345 da '''imagem 3''', ~~com~~ a ~~agência 6789~~.		Para preencher o '''Cliente ID / User''', deve ser concatenados o código do beneficiário e o código da cooperativa, ou seja, o '''convênio''' e a '''agência'''. Seguindo o exemplo da '''imagem 4''', o campo "Client ID /User" é a junção do convênio 12345 com a agência 6789 da '''imagem 3''', que resulta em 123456789 no campo de "Cliente ID / User". O campo de '''Authorization / Api Key''' é fornecida pela Mérito através do portal do desenvolvedor. O '''Client Secret''' é o código de acesso que pode ser gerado conforme descrito abaixo.

			'''Geração do código de acesso''' (password / Client Secret): A empresa ou pessoa associada deve acessar o Internet Banking, pela conta vinculada ao seu convênio de Cobrança, e selecionar a opção de menu no: '''Cobrança >> Código de Acesso >> Gerar''' - Esse menu é apresentado exclusivamente para os beneficiários que possuem a modalidade API (Cobrança Online) habilitada no convênio. A chave será gerada após informado o dispositivo de segurança.

			Na I'''magem 5''' abaixo é exibido o caminho para geração do código de acesso para utilizar no campo Client Secret.
			[[Arquivo:2026-01-27 15-55.png\|nenhum\|miniaturadaimagem\|Imagem 5 - Internet Banking]]

LucasLp em 18h00min de 27 de janeiro de 2026

2026-01-27T18:00:51Z

← Edição anterior		Edição das 18h00min de 27 de janeiro de 2026
Linha 9:		Linha 9:
	# Abra a tela '''Tipo de Cobrança Bancária'''		# Abra a tela '''Tipo de Cobrança Bancária'''

	[[Arquivo:2026-01-27_09-25.png\|nenhum\|miniaturadaimagem\|307x307px]]		[[Arquivo:2026-01-27_09-25.png\|nenhum\|miniaturadaimagem\|307x307px\|Imagem 1 - Caminho Tipo Cobrança Bancária]]

	* Nessa tela, você vê a lista de “tipos de cobrança” já cadastrados (ex.: Banco do Brasil, Sicredi, Sicoob, etc.).		* Nessa tela, você vê a lista de “tipos de cobrança” já cadastrados (ex.: Banco do Brasil, Sicredi, Sicoob, etc.).
Linha 17:		Linha 17:
	** Alterar um tipo existente para usar o Sicredi.		** Alterar um tipo existente para usar o Sicredi.

	== ~~Sicredi -~~ Configuração API ==		== Configuração API - Sicredi ==

	=== Visão Geral da Tela ===		=== Visão Geral da Tela ===
Linha 28:		Linha 28:

	=== Aba Dados (Configuração Básica) ===		=== Aba Dados (Configuração Básica) ===
	[[Arquivo:2026-01-27 13-33 1.png\|nenhum\|miniaturadaimagem\|688x688px]]		[[Arquivo:2026-01-27 13-33 1.png\|nenhum\|miniaturadaimagem\|688x688px\|Imagem 2 - Aba dados do cadastro do tipo de cobrança bancária]]

	==== Dados Principais ====		==== Dados Principais ====
Linha 89:		Linha 89:

	=== Aba Dados Bancários ===		=== Aba Dados Bancários ===
	Na tela de cadastro de tipo de cobrança, primeiro ajuste os dados básicos do banco. Eles são usados tanto na impressão do boleto quanto na comunicação com o Sicredi.		[[Arquivo:2026-01-27 13-49.png\|nenhum\|miniaturadaimagem\|568x568px\|Imagem 3 - Aba Dados bancários do cadastro do tipo de cobrança bancária]]Na tela de cadastro de tipo de cobrança, primeiro ajuste os dados básicos do banco. Eles são usados tanto na impressão do boleto quanto na comunicação com o Sicredi.

	* '''Banco'''		* '''Banco'''
Linha 96:		Linha 96:

	* '''Agência e dígito da agência'''		* '''Agência e dígito da agência'''
	** Campos como “Agência” e ~~“Agência DV”~~ (~~ou “Dígito”~~).		** Campos como “Agência” e “Dígito” (Mais à esquerda).
			** '''Importante''': A Sicredi identifica o campo de "'''Agência'''" como '''Código da Cooperativa'''.
	** O que fazer: preencher com a agência do Sicredi e o dígito, exatamente como informado pelo banco.		** O que fazer: preencher com a agência do Sicredi e o dígito, exatamente como informado pelo banco.

	* '''Conta corrente e dígito da conta'''		* '''Conta corrente e dígito da conta'''
	** Campos como “Conta” e ~~“Conta DV”~~.		** Campos como “Conta” e “Dígito” (Mais à direita).
	** O que fazer: informar a conta corrente e seu dígito, conforme cadastro no Sicredi.		** O que fazer: informar a conta corrente e seu dígito, conforme cadastro no Sicredi.

	* '''Convênio de cobrança'''		* '''Convênio de cobrança'''
	** Campo ~~normalmente chamado de “Convênio”~~.		** Campo "'''Convêncio'''" desta aba.
			** '''Importante''': A Sicredi identifica este campo como '''Código do beneficiário'''.
	** O que fazer: informar o código de convênio fornecido pelo Sicredi, somente com números (sem pontos ou traços).		** O que fazer: informar o código de convênio fornecido pelo Sicredi, somente com números (sem pontos ou traços).

Linha 118:		Linha 120:
	** Campos como “Instrução 1” e “Instrução 2”.		** Campos como “Instrução 1” e “Instrução 2”.
	** O que fazer: colocar observações que devem aparecer no boleto (ex.: “Após o vencimento, cobrar multa de X% e juros de Y% ao dia”).		** O que fazer: colocar observações que devem aparecer no boleto (ex.: “Após o vencimento, cobrar multa de X% e juros de Y% ao dia”).
	~~[[Arquivo:2026-01-27 13-49.png\|nenhum\|miniaturadaimagem\|568x568px]]~~		=== Aba Conexões Externas - Credenciais de Acesso ===

	=== Aba Conexões ~~Externa~~ - Credenciais de Acesso ===
	Esta aba contém as informações de acesso à API do banco.		Esta aba contém as informações de acesso à API do banco.
	[[Arquivo:2026-01-27 13-53.png\|nenhum\|miniaturadaimagem\|690x690px]]		[[Arquivo:2026-01-27 13-53.png\|nenhum\|miniaturadaimagem\|690x690px\|Imagem 4 - Aba Conexões Externas do cadastro do tipo de cobrança bancária]]
	Na ~~tabela~~ abaixo são explicados os campos da ~~imagem~~ acima:		Na '''Tabela 1''' abaixo são explicados os campos da '''Imagem 4''' acima:
	{\| class="wikitable"		{\| class="wikitable"
	\|+		\|+Tabela 1
	!'''Campo'''		!'''Campo'''
	!Descrição		!Descrição
Linha 137:		Linha 137:
	\|Ambiente de teste		\|Ambiente de teste
	\|❌ Não é obrigatório pois é definido internamente		\|❌ Não é obrigatório pois é definido internamente
			\|-
			\|Dev Key (BB)
			\|Chave do desenvolvedor para o Banco do Brasil
			\|❌ NÃO - Deixe em branco
			\|-
			\|Authorization / Api Key
			\|Access token gerado no portal do desenvolvedor
			\|✅ SIM - Obrigatório
	\|-		\|-
	\|Client ID / User		\|Client ID / User
Linha 145:		Linha 153:
	\|Código de Acesso gerado no Internet Banking		\|Código de Acesso gerado no Internet Banking
	\|✅ SIM - Obrigatório (é como uma senha)		\|✅ SIM - Obrigatório (é como uma senha)
	\|-
	~~\|Dev Key (BB)~~
	~~\|Chave para homologação do Banco do Brasil~~
	~~\|❌ NÃO - Deixe em branco~~
	\|-
	~~\|Authorization / Api Key~~
	~~\|Access token gerado no portal do desenvolvedor~~
	~~\|✅ SIM - Obrigatório~~
	\|}		\|}
			Para preencher o '''Cliente ID / User''', deve ser concatenados o código do beneficiário e o código da cooperativa, ou seja, o convênio e a agência. Seguindo o exemplo da '''imagem 4''', o campo "Client ID /User" é a junção do convênio 12345 da '''imagem 3''', com a agência 6789.

LucasLp: Adicionada tabela para Aba Conexões Externa - Credenciais de Acesso

2026-01-27T17:02:11Z

Adicionada tabela para Aba Conexões Externa - Credenciais de Acesso

@@ Linha 20: / Linha 20: @@
 === Visão Geral da Tela ===
-A tela de configuração do Tipo de Cobrança é dividida em abas. Para configurar a API do Sicredi, você precisará preencher principalmente duas abas:
+A tela de configuração do Tipo de Cobrança é dividida em abas. Para configurar a API do Sicredi, você precisará preencher as três abas:
-* Aba Dados: Dados bancários e configurações gerais. Nesta aba temos o '''Layout Arquivo''', que será essencial configurar para utilizar a API'''.'''
+* '''Aba Dados''': Dados bancários e configurações gerais. Nesta aba temos o '''Layout Arquivo''', que será essencial configurar para utilizar a API'''.'''
-* Aba Dados Bancários: Configuração de dados como agência, conta, convênio, necessárias para o funcionamento das rotinas.
+* '''Aba Dados Bancários''': Configuração de dados como agência, conta, convênio, necessárias para o funcionamento das rotinas.
-* Aba Conexões Externas: Credenciais e URLs de acesso à API
+* '''Aba Conexões Externas''': Credenciais e URLs de acesso à API
 === Aba Dados (Configuração Básica) ===
@@ Linha 118: / Linha 118: @@
 ** Campos como “Instrução 1” e “Instrução 2”.
 ** O que fazer: colocar observações que devem aparecer no boleto (ex.: “Após o vencimento, cobrar multa de X% e juros de Y% ao dia”).
+[[Arquivo:2026-01-27 13-49.png|nenhum|miniaturadaimagem|568x568px]]
 === Aba Conexões Externa - Credenciais de Acesso ===
 Esta aba contém as informações de acesso à API do banco.

LucasLp em 16h46min de 27 de janeiro de 2026

2026-01-27T16:46:49Z

← Edição anterior		Edição das 16h46min de 27 de janeiro de 2026
Linha 28:		Linha 28:

	=== Aba Dados (Configuração Básica) ===		=== Aba Dados (Configuração Básica) ===
			[[Arquivo:2026-01-27 13-33 1.png\|nenhum\|miniaturadaimagem\|688x688px]]

	==== Dados Principais ====		==== Dados Principais ====
Linha 55:		Linha 56:
	*** Código 2 - 400 Posições		*** Código 2 - 400 Posições
	** '''Api Cobrança''': Deve estar selecionada para utilizar a integração da API.		** '''Api Cobrança''': Deve estar selecionada para utilizar a integração da API.

	~~[[Arquivo:2026-01-27_11-13.png\|nenhum\|miniaturadaimagem\|692x692px]]~~

	==== Juros e Multa ====		==== Juros e Multa ====
Linha 81:		Linha 80:
	** O que fazer: preencher caso ofereça desconto para pagamento antes do vencimento.		** O que fazer: preencher caso ofereça desconto para pagamento antes do vencimento.

	=== 2. Aba Dados Bancários ===		==== Protesto ====

			* Tipo de Protesto:
			** ATENÇÃO: Para Sicredi, NÃO selecione "Dias Úteis"
			** Use "Dias Corridos" ou outra opção

			* Dias para Protesto: Ex: 5 (protestar após 5 dias)

			=== Aba Dados Bancários ===
	Na tela de cadastro de tipo de cobrança, primeiro ajuste os dados básicos do banco. Eles são usados tanto na impressão do boleto quanto na comunicação com o Sicredi.		Na tela de cadastro de tipo de cobrança, primeiro ajuste os dados básicos do banco. Eles são usados tanto na impressão do boleto quanto na comunicação com o Sicredi.

Linha 113:		Linha 120:

	[[Arquivo:2026-01-27_11-10.png\|nenhum\|miniaturadaimagem\|690x690px]]		[[Arquivo:2026-01-27_11-10.png\|nenhum\|miniaturadaimagem\|690x690px]]

			=== Aba Conexões Externa - Credenciais de Acesso ===
			Esta aba contém as informações de acesso à API do banco.

LucasLp: Removidas numerações tópicos

2026-01-27T16:26:52Z

Removidas numerações tópicos

← Edição anterior		Edição das 16h26min de 27 de janeiro de 2026
Linha 27:		Linha 27:
	* Aba Conexões Externas: Credenciais e URLs de acesso à API		* Aba Conexões Externas: Credenciais e URLs de acesso à API

	=== 1. Aba Dados (Configuração Básica) ===		=== Aba Dados (Configuração Básica) ===

	==== ~~1.1.~~ Dados Principais ====		==== Dados Principais ====

	==== Preencha os seguintes campos: ====		==== Preencha os seguintes campos: ====
Linha 58:		Linha 58:
	[[Arquivo:2026-01-27_11-13.png\|nenhum\|miniaturadaimagem\|692x692px]]		[[Arquivo:2026-01-27_11-13.png\|nenhum\|miniaturadaimagem\|692x692px]]

	==== ~~1.2.~~ Juros e Multa ====		==== Juros e Multa ====
	Esses campos definem como o boleto vai se comportar em caso de atraso ou desconto, e essas informações são enviadas para o Sicredi. Juros, multa e desconto influenciam na cobrança via API.		Esses campos definem como o boleto vai se comportar em caso de atraso ou desconto, e essas informações são enviadas para o Sicredi. Juros, multa e desconto influenciam na cobrança via API.