APIs de Cobrança: mudanças entre as edições
(Criação página APIs de Cobrança) |
(Removidas numerações tópicos) |
||
| Linha 27: | Linha 27: | ||
* 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) === | ||
==== | ==== 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]] | ||
==== | ==== 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. | ||
Edição das 16h26min de 27 de janeiro de 2026
Este manual irá guiá-lo através das configurações necessárias para utilizar as APIs de cobrança dos bancos integrados ao sistema. Cada banco possui particularidades em sua configuração, mas o processo geral é semelhante.
Acesso à tela de configuração
A configuração é feita na tela de "Tipo de Cobrança Bancária".
Para acessar:
- No menu principal, vá até o menu Financeiro > Cadastro > Cobrança Bancária
- Abra a tela Tipo de Cobrança Bancária

- Nessa tela, você vê a lista de “tipos de cobrança” já cadastrados (ex.: Banco do Brasil, Sicredi, Sicoob, etc.).
- Para configurar o Sicredi, você pode:
- Incluir um novo tipo de cobrança; ou
- Alterar um tipo existente para usar o Sicredi.
Sicredi - Configuração API
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:
- 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 Conexões Externas: Credenciais e URLs de acesso à API
Aba Dados (Configuração Básica)
Dados Principais
Preencha os seguintes campos:
- Código: Número que identificará este tipo de cobrança
- Exemplo: 401, 501, etc.
- Nome: Nome descritivo para identificar esta configuração
- Exemplo: Sicredi API, Sicredi Cobrança Web
- Banco: Selecione o banco Sicredi (748)
- Use o botão de busca ao lado do campo para localizar
- Módulo Cobrança: Escolha uma das opções do Sicredi:
- Sicredi Com Registro: Para boletos com registro
- Sicredi Sem Registro: Para boletos sem registro
- Sicredi Débito em Conta: Para débitos automáticos em conta
- Modelo Boleto: Escolha o modelo de boleto que será utilizado. Por padrão é código 2 - Boleto.
- Tipo Emissão: Geralmente utiliza-se a emissão própria.
- Espécie: Geralmente é configurado com DM (Duplicata Mercantil).
- Layout Arquivo: Forma de comunicação do sistema com o banco.
- Arquivos de remessa/retorno CNAB:
- Código 1 - 240 Posições
- Código 2 - 400 Posições
- Api Cobrança: Deve estar selecionada para utilizar a integração da API.
- Arquivos de remessa/retorno CNAB:

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.
- Juros ao dia
- Campo de percentual, como “% Juros ao Dia”.
- O que fazer: informar o percentual de juros que será cobrado por dia de atraso.
- Observação: o sistema não aceita esse campo zerado.
- Tipo de juros
- Campo com código e descrição do tipo de juros (por exemplo, “percentual ao dia”).
- O que fazer: escolher o tipo que corresponde à forma de cobrança combinada com o banco.
- Multa
- Campos de tipo de multa, percentual de multa e quantidade de dias para início da multa (N° Dias para Multa).
- O que fazer:
- Definir se haverá multa;
- Informar o percentual de multa (ex.: 2%);
- Definir a partir de quantos dias após o vencimento a multa passa a ser cobrada.
- Desconto por antecipação
- Campos de tipo de desconto, valor/percentual de desconto e dias de desconto.
- O que fazer: preencher caso ofereça desconto para pagamento antes do vencimento.
2. 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.
- Banco
- Campos normalmente chamados de “Cód. Banco” e “Nome Banco”.
- O que fazer: escolher o Sicredi na pesquisa.
- Agência e dígito da agência
- Campos como “Agência” e “Agência DV” (ou “Dígito”).
- 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
- Campos como “Conta” e “Conta DV”.
- O que fazer: informar a conta corrente e seu dígito, conforme cadastro no Sicredi.
- Convênio de cobrança
- Campo normalmente chamado de “Convênio”.
- O que fazer: informar o código de convênio fornecido pelo Sicredi, somente com números (sem pontos ou traços).
- Carteira de cobrança
- Campo chamado de “Carteira”.
- O que fazer: informar a carteira usada pelo Sicredi para seus boletos. Esse campo é obrigatório.
- Nome da empresa (beneficiário)
- Campo como “Nome Empresa”.
- O que fazer: informar o nome que aparecerá como beneficiário no boleto (normalmente o nome da sua empresa, conforme registro no banco).
- Campo como “Nome Empresa”.
- Instruções do boleto
- 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”).
