Merito Wiki - Contribuições do usuário [pt-br]

APIs de Cobrança

2026-01-27T20:24:42Z

LucasLp: Adicionada legenda Imagem 6 - Painel Retorno

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'''

[[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.).

* Para configurar o Sicredi, você pode:
** Incluir um novo tipo de cobrança; ou
** Alterar um tipo existente para usar o Sicredi.

== Configuração API - Sicredi ==

=== 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 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 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) ===
[[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 ====

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

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

==== Protesto ====

* Tipo de Protesto:
** 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.

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

=== Aba Dados Bancários ===
[[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'''
** 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 “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.

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

* '''Convênio de cobrança'''
** 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).

* '''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).

* '''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”).
=== Aba Conexões Externas - Credenciais de Acesso ===
Esta aba contém as informações de acesso à API do banco.
[[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 1''' abaixo são explicados os campos da '''Imagem 4''' acima:
{| class="wikitable"
|+Tabela 1
!'''Campo'''
!Descrição
!'''Precisa para Sicredi?'''
|-
|URL Produção
|Ambiente real (boletos oficiais)
|❌ Não é obrigatório pois é definido internamente
|-
|URL Homologação
|Ambiente de teste
|❌ 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
|Código do beneficiário + Código da Cooperativa
|✅ SIM - Obrigatório
|-
|Client Secret
|Código de Acesso gerado no Internet Banking
|✅ 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 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]]

== 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 pagar
Como 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 menu: Financeiro > Faturamento > Faturar - Geral
* Ao gerar o faturamento mensal de clientes

* O sistema:

# Cria os boletos de todas as vendas/serviços do período
# Imprime automaticamente e envia para a API do Sicredi.
O mesmo ocorre para o faturamento de cliente em Financeiro > Faturamento > Faturar - Geral.

== Retorno 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|Imagem 6 - Painel Retorno]]
Para isso:

* Abrir programa do Painel Retorno
** No menu: Financeiro > Documentos de Cobrança > Transferência de Arquivos > Retorno > Painel Retorno Boletos
* Selecionar a aba API
* Informar o tipo de cobrança criado ou alterado para utilizar a API da Sicredi.
* Informar o período de consulta à API.

* Clicar em "Processar Retorno"

'''OBS''': Em princípio, a consulta ainda não foi automatizada pois há limites de requisições para a API. O status do documento pode ser verificado em Financeiro > Documentos de Cobrança > Consulta Doc Cob após o "Processar Retorno", e caso necessário terá opção exclusiva para administradores para atualizar o status do documento de cobrança buscando na API da Sicredi. No passado, a própria Sicredi já comunicou sobre a existência dos limites para as requisições e recomendação para manter no mínimo de requisições, no entanto, futuramente pode ser revisada a possibilidade de realizar a automatização.

APIs de Cobrança

2026-01-27T20:23:20Z

LucasLp: Adicionada seção sobre Retorno Boletos

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'''

[[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.).

* Para configurar o Sicredi, você pode:
** Incluir um novo tipo de cobrança; ou
** Alterar um tipo existente para usar o Sicredi.

== Configuração API - Sicredi ==

=== 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 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 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) ===
[[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 ====

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

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

==== Protesto ====

* Tipo de Protesto:
** 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.

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

=== Aba Dados Bancários ===
[[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'''
** 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 “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.

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

* '''Convênio de cobrança'''
** 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).

* '''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).

* '''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”).
=== Aba Conexões Externas - Credenciais de Acesso ===
Esta aba contém as informações de acesso à API do banco.
[[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 1''' abaixo são explicados os campos da '''Imagem 4''' acima:
{| class="wikitable"
|+Tabela 1
!'''Campo'''
!Descrição
!'''Precisa para Sicredi?'''
|-
|URL Produção
|Ambiente real (boletos oficiais)
|❌ Não é obrigatório pois é definido internamente
|-
|URL Homologação
|Ambiente de teste
|❌ 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
|Código do beneficiário + Código da Cooperativa
|✅ SIM - Obrigatório
|-
|Client Secret
|Código de Acesso gerado no Internet Banking
|✅ 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 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]]

== 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 pagar
Como 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 menu: Financeiro > Faturamento > Faturar - Geral
* Ao gerar o faturamento mensal de clientes

* O sistema:

# Cria os boletos de todas as vendas/serviços do período
# Imprime automaticamente e envia para a API do Sicredi.
O mesmo ocorre para o faturamento de cliente em Financeiro > Faturamento > Faturar - Geral.

== Retorno 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]]
Para isso:

* Abrir programa do Painel Retorno
** No menu: Financeiro > Documentos de Cobrança > Transferência de Arquivos > Retorno > Painel Retorno Boletos
* Selecionar a aba API
* Informar o tipo de cobrança criado ou alterado para utilizar a API da Sicredi.
* Informar o período de consulta à API.

* Clicar em "Processar Retorno"

'''OBS''': Em princípio, a consulta ainda não foi automatizada pois há limites de requisições para a API. O status do documento pode ser verificado em Financeiro > Documentos de Cobrança > Consulta Doc Cob após o "Processar Retorno", e caso necessário terá opção exclusiva para administradores para atualizar o status do documento de cobrança buscando na API da Sicredi. No passado, a própria Sicredi já comunicou sobre a existência dos limites para as requisições e recomendação para manter no mínimo de requisições, no entanto, futuramente pode ser revisada a possibilidade de realizar a automatização.

Arquivo:2026-01-27 17-22.png

2026-01-27T20:22:50Z

LucasLp:

Painel Retorno

APIs de Cobrança

2026-01-27T20:00:55Z

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

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'''

[[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.).

* Para configurar o Sicredi, você pode:
** Incluir um novo tipo de cobrança; ou
** Alterar um tipo existente para usar o Sicredi.

== Configuração API - Sicredi ==

=== 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 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 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) ===
[[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 ====

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

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

==== Protesto ====

* Tipo de Protesto:
** 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.

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

=== Aba Dados Bancários ===
[[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'''
** 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 “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.

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

* '''Convênio de cobrança'''
** 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).

* '''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).

* '''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”).
=== Aba Conexões Externas - Credenciais de Acesso ===
Esta aba contém as informações de acesso à API do banco.
[[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 1''' abaixo são explicados os campos da '''Imagem 4''' acima:
{| class="wikitable"
|+Tabela 1
!'''Campo'''
!Descrição
!'''Precisa para Sicredi?'''
|-
|URL Produção
|Ambiente real (boletos oficiais)
|❌ Não é obrigatório pois é definido internamente
|-
|URL Homologação
|Ambiente de teste
|❌ 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
|Código do beneficiário + Código da Cooperativa
|✅ SIM - Obrigatório
|-
|Client Secret
|Código de Acesso gerado no Internet Banking
|✅ 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 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]]

== 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 pagar
Como 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 menu: Financeiro > Faturamento > Faturar - Geral
* 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.
O mesmo ocorre para o faturamento de cliente em Financeiro > Faturamento > Faturar - Geral.

Rotinas Novas

2026-01-27T19:41:23Z

LucasLp: Removida página duplicada

* [[GNRE, DARE e DUA]]
* [[Regra de Seleção de CST]]
* [[Inativação em massa de produtos|Inativação em Massa de Produtos]]
* [[Padronização de Cadastro de Produtos]]
* [[Opções Suporte GLPI]]
* [[Relatórios]]
* [[Boletos Centralizados]]
* [[APIs de Cobrança]]

APIs de Cobrança

2026-01-27T19:37:43Z

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

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'''

[[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.).

* Para configurar o Sicredi, você pode:
** Incluir um novo tipo de cobrança; ou
** Alterar um tipo existente para usar o Sicredi.

== Configuração API - Sicredi ==

=== 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 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 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) ===
[[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 ====

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

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

==== Protesto ====

* Tipo de Protesto:
** 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.

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

=== Aba Dados Bancários ===
[[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'''
** 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 “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.

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

* '''Convênio de cobrança'''
** 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).

* '''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).

* '''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”).
=== Aba Conexões Externas - Credenciais de Acesso ===
Esta aba contém as informações de acesso à API do banco.
[[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 1''' abaixo são explicados os campos da '''Imagem 4''' acima:
{| class="wikitable"
|+Tabela 1
!'''Campo'''
!Descrição
!'''Precisa para Sicredi?'''
|-
|URL Produção
|Ambiente real (boletos oficiais)
|❌ Não é obrigatório pois é definido internamente
|-
|URL Homologação
|Ambiente de teste
|❌ 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
|Código do beneficiário + Código da Cooperativa
|✅ SIM - Obrigatório
|-
|Client Secret
|Código de Acesso gerado no Internet Banking
|✅ 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 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]]

== 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

APIs de Cobrança

2026-01-27T19:05:40Z

LucasLp: Informações extras

APIs de Cobrança

2026-01-27T18:59:45Z

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

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'''

[[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.).

* Para configurar o Sicredi, você pode:
** Incluir um novo tipo de cobrança; ou
** Alterar um tipo existente para usar o Sicredi.

== Configuração API - Sicredi ==

=== 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 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 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) ===
[[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 ====

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

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

==== 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 ===
[[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'''
** 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 “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.

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

* '''Convênio de cobrança'''
** 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).

* '''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).

* '''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”).
=== Aba Conexões Externas - Credenciais de Acesso ===
Esta aba contém as informações de acesso à API do banco.
[[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 1''' abaixo são explicados os campos da '''Imagem 4''' acima:
{| class="wikitable"
|+Tabela 1
!'''Campo'''
!Descrição
!'''Precisa para Sicredi?'''
|-
|URL Produção
|Ambiente real (boletos oficiais)
|❌ Não é obrigatório pois é definido internamente
|-
|URL Homologação
|Ambiente de teste
|❌ 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
|Código do beneficiário + Código da Cooperativa
|✅ SIM - Obrigatório
|-
|Client Secret
|Código de Acesso gerado no Internet Banking
|✅ 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 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]]

Arquivo:2026-01-27 15-55.png

2026-01-27T18:58:17Z

LucasLp:

Transfência de arquivos Sicredi

Arquivo:2026-01-12 15-30.png

2026-01-27T18:49:20Z

LucasLp:

Geração do Código de Acesso

APIs de Cobrança

2026-01-27T18:00:51Z

LucasLp:

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'''

[[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.).

* Para configurar o Sicredi, você pode:
** Incluir um novo tipo de cobrança; ou
** Alterar um tipo existente para usar o Sicredi.

== Configuração API - Sicredi ==

=== 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 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 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) ===
[[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 ====

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

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

==== 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 ===
[[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'''
** 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 “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.

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

* '''Convênio de cobrança'''
** 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).

* '''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).

* '''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”).
=== Aba Conexões Externas - Credenciais de Acesso ===
Esta aba contém as informações de acesso à API do banco.
[[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 1''' abaixo são explicados os campos da '''Imagem 4''' acima:
{| class="wikitable"
|+Tabela 1
!'''Campo'''
!Descrição
!'''Precisa para Sicredi?'''
|-
|URL Produção
|Ambiente real (boletos oficiais)
|❌ Não é obrigatório pois é definido internamente
|-
|URL Homologação
|Ambiente de teste
|❌ 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
|Código do beneficiário + Código da Cooperativa
|✅ SIM - Obrigatório
|-
|Client Secret
|Código de Acesso gerado no Internet Banking
|✅ 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.

APIs de Cobrança

2026-01-27T17:02:11Z

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

Arquivo:2026-01-27 13-53.png

2026-01-27T16:58:14Z

LucasLp:

Aba Conexões Externas

Arquivo:2026-01-27 13-49.png

2026-01-27T16:51:20Z

LucasLp:

Aba dados bancários

APIs de Cobrança

2026-01-27T16:46:49Z

LucasLp:

Arquivo:2026-01-27 13-33 1.png

2026-01-27T16:34:24Z

LucasLp:

Aba Dados do cadastro de tipo de cobrança

APIs de Cobrança

2026-01-27T16:26:52Z

LucasLp: Removidas numerações tópicos

APIs de Cobrança

2026-01-27T16:25:46Z

LucasLp: Criação página APIs de Cobrança

Rotinas Novas

2026-01-27T14:19:50Z

LucasLp:

Rotinas Novas

2026-01-27T14:19:39Z

LucasLp:

Arquivo:2026-01-27 11-13.png

2026-01-27T14:14:09Z

LucasLp:

Aba Dados

Arquivo:2026-01-27 11-10.png

2026-01-27T14:11:09Z

LucasLp:

Aba Dados Bancários

Arquivo:2026-01-27 09-25.png

2026-01-27T12:27:44Z

LucasLp:

Caminho

Rotinas Novas

2026-01-27T11:34:19Z

LucasLp: Criado tópido de API's de cobrança

Boletos Centralizados

2026-01-06T17:09:18Z

LucasLp: Pequenos ajustes

== Configurações e Cadastros ==
Para utilização da rotina de boletos centralizados é pertinente seguir as seguintes orientações:

=== Cadastro de tipo de cobrança ===
'''Tela''': Financeiro > Cadastro > Cobrança Bancária > Tipo Cobrança Bancária

No cadastro de Tipo de Cobrança, configure:

* Seletor "Gerar boletos com dados da matriz" na tela de cadastro

* Quando marcado permite que filiais usem este tipo de cobrança, mas os dados bancários/cadastrais do cedente serão da matriz

'''Importante''': Este tipo de cobrança deve existir na matriz com o mesmo banco. O sistema busca automaticamente o tipo correspondente na matriz quando necessário.
[[Arquivo:2026-01-06 13-47.png|nenhum|miniaturadaimagem|695x695px]]

=== Cadastro de cliente ===
'''Tela''': Financeiro > Cadastro > Clientes > Clientes

No cadastro do cliente, aba Cliente > Dados, configure:

* Seletor de faturamento centralizado (Matriz);

* Por padrão já é marcado;

* Quando marcado os boletos/documentos de cobrança são gerados na matriz conforme cadastro de tipo de cobrança.

* Localização: Seletor "Faturamento Centralizado (Matriz)" na tela de cadastro
'''Importante''': Esta opção foi criada para caso o tipo de cobrança seja centralizado e o cliente não deseja que o boleto seja gerado com dados da matriz, ou seja, se cliente optou por não utilizar faturamento centralizado quando "Gerar boletos com dados da matriz" estiver marcado no cadastro de tipo de cobrança, os boletos para este cliente não serão considerados como centralizados.
[[Arquivo:2026-01-06 13-51.png|nenhum|miniaturadaimagem|832x832px]]

=== Cadastro de forma de pagamento ===
'''Tela''': Financeiro > Cadastro > Formas de Pagamento

Acessar cadastro de Forma de Pagamento, para criar forma de pagamento boleto:

* Tipo de numerário: selecione BOLETO (código 22)

* Tipo de parcelamento: automaticamente definido como BOLETO

* Tipo de cobrança: obrigatório — selecione um tipo de cobrança configurado
[[Arquivo:2026-01-06 13-55.png|nenhum|miniaturadaimagem|887x887px]]

== Venda no PDV ==

=== Antes de iniciar a venda ===

* Verificar se o cliente está cadastrado (não pode ser cliente eventual)
* Selecione Forma de Pagamento "à prazo" na seleção;
* Confirmar que o cliente tem "Faturamento Centralizado" ativado (configurado no cadastro);

=== Durante a venda no PDV ===

* Adicionar os produtos normalmente;
* Selecionar a forma de pagamento criada com tipo de numerário "BOLETO";
** O sistema valida automaticamente:
*** Se o cliente está cadastrado
*** Se a forma de pagamento tem tipo de cobrança configurado
*** Se o tipo de cobrança pode ser usado (da unidade ou compartilhado da matriz)
* Preencha os dados normalmente, como dia do vencimento, parcelamento, data de vencimento e valor da parcela.
* Fecha a venda.

=== Ao finalizar venda ===

* É impresso o boleto, portanto idealmente deve haver uma impressora.

=== Como funciona na prática ===

# Cliente com faturamento centralizado faz uma compra na filial

# A filial escolhe a forma de pagamento "BOLETO"
# O sistema gera o boleto usando os dados bancários da matriz
# O boleto sai com dados da matriz, mesmo sendo vendido pela filial

Boletos Centralizados

2026-01-06T17:05:57Z

LucasLp:

== Configurações e Cadastros ==
Para utilização da rotina de boletos centralizados é pertinente seguir as seguintes configurações:

=== Cadastro de tipo de cobrança ===
'''Tela''': Financeiro > Cadastro > Cobrança Bancária > Tipo Cobrança Bancária

No cadastro de Tipo de Cobrança, configure:

* Seletor "Gerar boletos com dados da matriz" na tela de cadastro

* Quando marcado permite que filiais usem este tipo de cobrança, mas os dados bancários/cadastrais do cedente serão da matriz

'''Importante''': Este tipo de cobrança deve existir na matriz com o mesmo banco. O sistema busca automaticamente o tipo correspondente na matriz quando necessário.
[[Arquivo:2026-01-06 13-47.png|nenhum|miniaturadaimagem|695x695px]]

=== Cadastro de cliente ===
'''Tela''': Financeiro > Cadastro > Clientes > Clientes

No cadastro do cliente, aba Cliente > Dados, configure:

* Seletor de faturamento centralizado (Matriz);

* Por padrão já é marcado;

* Quando marcado os boletos/documentos de cobrança são gerados na matriz conforme cadastro de tipo de cobrança.

* Localização: Seletor "Faturamento Centralizado (Matriz)" na tela de cadastro
'''Importante''': Esta opção foi criada para caso o tipo de cobrança seja centralizado e o cliente não deseja que o boleto seja gerado com dados da matriz, ou seja, se cliente optou por não utilizar faturamento centralizado quando "Gerar boletos com dados da matriz" estiver marcado no cadastro de tipo de cobrança, os boletos para este cliente não serão considerados como centralizados.
[[Arquivo:2026-01-06 13-51.png|nenhum|miniaturadaimagem|832x832px]]

=== Cadastro de forma de pagamento ===
'''Tela''': Financeiro > Cadastro > Formas de Pagamento

Acessar cadastro de Forma de Pagamento, para criar forma de pagamento boleto:

* Tipo de numerário: selecione BOLETO (código 22)

* Tipo de parcelamento: automaticamente definido como BOLETO

* Tipo de cobrança: obrigatório — selecione um tipo de cobrança configurado
[[Arquivo:2026-01-06 13-55.png|nenhum|miniaturadaimagem|887x887px]]

== Venda no PDV ==

=== Antes de iniciar a venda ===

* Verificar se o cliente está cadastrado (não pode ser cliente eventual)
* Selecione Forma de Pagamento "à prazo" na seleção;
* Confirmar que o cliente tem "Faturamento Centralizado" ativado (configurado no cadastro);

=== Durante a venda no PDV ===

* Adicionar os produtos normalmente;
* Selecionar a forma de pagamento criada com tipo de numerário "BOLETO";
** O sistema valida automaticamente:
*** Se o cliente está cadastrado
*** Se a forma de pagamento tem tipo de cobrança configurado
*** Se o tipo de cobrança pode ser usado (da unidade ou compartilhado da matriz)
* Preencha os dados normalmente, como dia do vencimento, parcelamento, data de vencimento e valor da parcela.
* Fecha a venda.

=== Ao finalizar venda ===

* É impresso o boleto, portanto idealmente deve haver uma impressora.

=== Como funciona na prática ===

# Cliente com faturamento centralizado faz uma compra na filial

# A filial escolhe a forma de pagamento "BOLETO"
# O sistema gera o boleto usando os dados bancários da matriz
# O boleto sai com dados da matriz, mesmo sendo vendido pela filial

Boletos Centralizados

2026-01-06T16:56:02Z

LucasLp: Adicionada imagem Cadastro de forma de pagamento

== Configurações e Cadastros ==
Para utilização da rotina de boletos centralizados é pertinente seguir as seguintes configurações:

=== Cadastro de tipo de cobrança ===
'''Tela''': Financeiro > Cadastro > Cobrança Bancária > Tipo Cobrança Bancária

No cadastro de Tipo de Cobrança, configure:

* Seletor "Gerar boletos com dados da matriz" na tela de cadastro

* Quando marcado permite que filiais usem este tipo de cobrança, mas os dados bancários/cadastrais do cedente serão da matriz

'''Importante''': Este tipo de cobrança deve existir na matriz com o mesmo banco. O sistema busca automaticamente o tipo correspondente na matriz quando necessário.
[[Arquivo:2026-01-06 13-47.png|nenhum|miniaturadaimagem|695x695px]]

=== Cadastro de cliente ===
'''Tela''': Financeiro > Cadastro > Clientes > Clientes

No cadastro do cliente, aba Cliente > Dados, configure:

* Seletor de faturamento centralizado (Matriz);

* Por padrão já é marcado;

* Quando marcado os boletos/documentos de cobrança são gerados na matriz conforme cadastro de tipo de cobrança.

* Localização: Seletor "Faturamento Centralizado (Matriz)" na tela de cadastro
'''Importante''': Esta opção foi criada para caso o tipo de cobrança seja centralizado e o cliente não deseja que o boleto seja gerado com dados da matriz, ou seja, se cliente optou por não utilizar faturamento centralizado quando "Gerar boletos com dados da matriz" estiver marcado no cadastro de tipo de cobrança, os boletos para este cliente não serão considerados como centralizados.
[[Arquivo:2026-01-06 13-51.png|nenhum|miniaturadaimagem|832x832px]]

=== Cadastro de forma de pagamento ===
'''Tela''': Financeiro > Cadastro > Formas de Pagamento

Acessar cadastro de Forma de Pagamento, para criar forma de pagamento boleto:

* Tipo de numerário: selecione BOLETO (código 22)

* Tipo de parcelamento: automaticamente definido como BOLETO

* Tipo de cobrança: obrigatório — selecione um tipo de cobrança configurado
[[Arquivo:2026-01-06 13-55.png|nenhum|miniaturadaimagem|887x887px]]

=== Como funciona na prática ===

# Cliente com faturamento centralizado faz uma compra na filial

# A filial escolhe a forma de pagamento "BOLETO"
# O sistema gera o boleto usando os dados bancários da matriz
# O boleto sai com dados da matriz, mesmo sendo vendido pela filial

Arquivo:2026-01-06 13-55.png

2026-01-06T16:55:35Z

LucasLp:

Cadastro de forma de pagamento

Boletos Centralizados

2026-01-06T16:53:10Z

LucasLp: Detalhes adicionais cadastro de clientes

== Configurações e Cadastros ==
Para utilização da rotina de boletos centralizados é pertinente seguir as seguintes configurações:

=== Cadastro de tipo de cobrança ===
'''Tela''': Financeiro > Cadastro > Cobrança Bancária > Tipo Cobrança Bancária

No cadastro de Tipo de Cobrança, configure:

* Seletor "Gerar boletos com dados da matriz" na tela de cadastro

* Quando marcado permite que filiais usem este tipo de cobrança, mas os dados bancários/cadastrais do cedente serão da matriz

'''Importante''': Este tipo de cobrança deve existir na matriz com o mesmo banco. O sistema busca automaticamente o tipo correspondente na matriz quando necessário.
[[Arquivo:2026-01-06 13-47.png|nenhum|miniaturadaimagem|695x695px]]

=== Cadastro de cliente ===
'''Tela''': Financeiro > Cadastro > Clientes > Clientes

No cadastro do cliente, aba Cliente > Dados, configure:

* Seletor de faturamento centralizado (Matriz);

* Por padrão já é marcado;

* Quando marcado os boletos/documentos de cobrança são gerados na matriz conforme cadastro de tipo de cobrança.

* Localização: Seletor "Faturamento Centralizado (Matriz)" na tela de cadastro
'''Importante''': Esta opção foi criada para caso o tipo de cobrança seja centralizado e o cliente não deseja que o boleto seja gerado com dados da matriz, ou seja, se cliente optou por não utilizar faturamento centralizado quando "Gerar boletos com dados da matriz" estiver marcado no cadastro de tipo de cobrança, os boletos para este cliente não serão considerados como centralizados.
[[Arquivo:2026-01-06 13-51.png|nenhum|miniaturadaimagem|832x832px]]

=== Cadastro de forma de pagamento ===
'''Tela''': Financeiro > Cadastro > Formas de Pagamento

Acessar cadastro de Forma de Pagamento, para criar forma de pagamento boleto:

* Tipo de numerário: selecione BOLETO (código 22)

* Tipo de parcelamento: automaticamente definido como BOLETO

* Tipo de cobrança: obrigatório — selecione um tipo de cobrança configurado

=== Como funciona na prática ===

# Cliente com faturamento centralizado faz uma compra na filial

# A filial escolhe a forma de pagamento "BOLETO"
# O sistema gera o boleto usando os dados bancários da matriz
# O boleto sai com dados da matriz, mesmo sendo vendido pela filial

Boletos Centralizados

2026-01-06T16:52:20Z

LucasLp: Adicionada imagem Cadastro de cliente

== Configurações e Cadastros ==
Para utilização da rotina de boletos centralizados é pertinente seguir as seguintes configurações:

=== Cadastro de tipo de cobrança ===
'''Tela''': Financeiro > Cadastro > Cobrança Bancária > Tipo Cobrança Bancária

No cadastro de Tipo de Cobrança, configure:

* Seletor "Gerar boletos com dados da matriz" na tela de cadastro

* Quando marcado permite que filiais usem este tipo de cobrança, mas os dados bancários/cadastrais do cedente serão da matriz

'''Importante''': Este tipo de cobrança deve existir na matriz com o mesmo banco. O sistema busca automaticamente o tipo correspondente na matriz quando necessário.
[[Arquivo:2026-01-06 13-47.png|nenhum|miniaturadaimagem|695x695px]]

=== Cadastro de cliente ===
'''Tela''': Financeiro > Cadastro > Clientes > Clientes

No cadastro do cliente, configure:

* Seletor de faturamento centralizado (Matriz);

* Por padrão já é marcado;

* Quando marcado os boletos/documentos de cobrança são gerados na matriz conforme cadastro de tipo de cobrança.

* Localização: Seletor "Faturamento Centralizado (Matriz)" na tela de cadastro
'''Importante''': Esta opção foi criada para caso o tipo de cobrança seja centralizado e o cliente não deseja que o boleto seja gerado com dados da matriz, ou seja, se cliente optou por não utilizar faturamento centralizado quando "Gerar boletos com dados da matriz" estiver marcado no cadastro de tipo de cobrança, os boletos para este cliente não serão considerados como centralizados.
[[Arquivo:2026-01-06 13-51.png|nenhum|miniaturadaimagem|832x832px]]

=== Cadastro de forma de pagamento ===
'''Tela''': Financeiro > Cadastro > Formas de Pagamento

Acessar cadastro de Forma de Pagamento, para criar forma de pagamento boleto:

* Tipo de numerário: selecione BOLETO (código 22)

* Tipo de parcelamento: automaticamente definido como BOLETO

* Tipo de cobrança: obrigatório — selecione um tipo de cobrança configurado

=== Como funciona na prática ===

# Cliente com faturamento centralizado faz uma compra na filial

# A filial escolhe a forma de pagamento "BOLETO"
# O sistema gera o boleto usando os dados bancários da matriz
# O boleto sai com dados da matriz, mesmo sendo vendido pela filial

Arquivo:2026-01-06 13-51.png

2026-01-06T16:51:46Z

LucasLp:

Cadastro de Cliente

Boletos Centralizados

2026-01-06T16:48:53Z

LucasLp: Adicionada imagem Cadastro de tipo de cobrança

Arquivo:2026-01-06 13-47.png

2026-01-06T16:48:09Z

LucasLp:

Cadastro de tipo de cobrança

Boletos Centralizados

2026-01-06T16:45:53Z

LucasLp: Adicionados caminhos no menu

Boletos Centralizados

2026-01-06T16:42:18Z

LucasLp: Ajustes cadastro cliente

== Configurações e Cadastros ==
Para utilização da rotina de boletos centralizados é pertinente seguir as seguintes configurações:

=== Cadastro de tipo de cobrança ===
No cadastro de Tipo de Cobrança, configure:

* Seletor "Gerar boletos com dados da matriz" na tela de cadastro

* Quando marcado permite que filiais usem este tipo de cobrança, mas os dados bancários/cadastrais do cedente serão da matriz

'''Importante''': Este tipo de cobrança deve existir na matriz com o mesmo banco. O sistema busca automaticamente o tipo correspondente na matriz quando necessário.

=== Cadastro de cliente ===
No cadastro do cliente, configure:

* Seletor de faturamento centralizado (Matriz);

* Por padrão já é marcado;

* Quando marcado os boletos/documentos de cobrança são gerados na matriz conforme cadastro de tipo de cobrança.

* Localização: Seletor "Faturamento Centralizado (Matriz)" na tela de cadastro
'''Importante''': Esta opção foi criada para caso o tipo de cobrança seja centralizado e o cliente não deseja que o boleto seja gerado com dados da matriz, ou seja, se cliente optou por não utilizar faturamento centralizado quando "Gerar boletos com dados da matriz" estiver marcado no cadastro de tipo de cobrança, os boletos para este cliente não serão considerados como centralizados.

=== Cadastro de forma de pagamento ===
Acessar cadastro de Forma de Pagamento, para criar forma de pagamento boleto:

* Tipo de numerário: selecione BOLETO (código 22)

* Tipo de parcelamento: automaticamente definido como BOLETO

* Tipo de cobrança: obrigatório — selecione um tipo de cobrança configurado

=== Como funciona na prática ===

# Cliente com faturamento centralizado faz uma compra na filial

# A filial escolhe a forma de pagamento "BOLETO"
# O sistema gera o boleto usando os dados bancários da matriz
# O boleto sai com dados da matriz, mesmo sendo vendido pela filial

Boletos Centralizados

2026-01-06T16:40:12Z

LucasLp: Criada página Boletos Centralizados

== Configurações e Cadastros ==
Para utilização da rotina de boletos centralizados é pertinente seguir as seguintes configurações:

=== Cadastro de tipo de cobrança ===
No cadastro de Tipo de Cobrança, configure:

* Seletor "Gerar boletos com dados da matriz" na tela de cadastro

* Quando marcado permite que filiais usem este tipo de cobrança, mas os dados bancários/cadastrais do cedente serão da matriz

'''Importante''': Este tipo de cobrança deve existir na matriz com o mesmo banco. O sistema busca automaticamente o tipo correspondente na matriz quando necessário.

=== Cadastro de cliente ===
No cadastro do cliente, configure:

* Seletor de faturamento centralizado (Matriz);

* Por padrão já é marcado;

* Quando marcado os boletos/documentos de cobrança são gerados na matriz conforme cadastro de tipo de cobrança.
* Esta é uma opção para caso o o tipo de cobrança seja centralizado e o cliente não deseja que o boleto seja gerado com dados da matriz, ou seja, se cliente optou por não utilizar faturamento centralizado quando "Gerar boletos com dados da matriz" estiver marcado no cadastro de tipo de cobrança, os boletos para este cliente não serão considerados como centralizados.

* Localização: Seletor "Faturamento Centralizado (Matriz)" na tela de cadastro

=== Cadastro de forma de pagamento ===
Acessar cadastro de Forma de Pagamento, para criar forma de pagamento boleto:

* Tipo de numerário: selecione BOLETO (código 22)

* Tipo de parcelamento: automaticamente definido como BOLETO

* Tipo de cobrança: obrigatório — selecione um tipo de cobrança configurado

=== Como funciona na prática ===

# Cliente com faturamento centralizado faz uma compra na filial

# A filial escolhe a forma de pagamento "BOLETO"
# O sistema gera o boleto usando os dados bancários da matriz
# O boleto sai com dados da matriz, mesmo sendo vendido pela filial

Rotinas Novas

2026-01-06T16:28:47Z

LucasLp: Criado link boletos centralizados

Rotinas Novas

2026-01-06T16:28:28Z

LucasLp:

Flex

2025-12-12T12:45:17Z

LucasLp:

* [[Baixar o Sistema pelo Atualizador]]
* [[Manual Rotinas|Manual Rotinas]]

Flex

2025-12-12T12:44:57Z

LucasLp:

* [[Baixar o Sistema pelo Atualizador]]
* [[Manual Rotinas|Manual Rotinas]]
* [[Topico]]

Relatórios

2025-11-21T17:38:51Z

LucasLp: Criou página com '* Saldos Unidades - Consignados'

* Saldos Unidades - Consignados

Rotinas Novas

2025-11-21T17:38:28Z

LucasLp: Adicionado link para relatórios

Rotinas Novas

2025-11-21T16:49:53Z

LucasLp: Adicionado marcador para relatórios

DIFAL

2025-11-21T14:15:35Z

LucasLp: Correções

== Introdução ==

=== Definição ===
'''DIFAL''' significa '''Diferencial de Alíquota do ICMS'''. Ele existe para equilibrar a arrecadação de ICMS entre os estados quando ocorre uma '''venda interestadual para consumidor final'''.

=== Por que existe? ===
Imagine uma empresa de SP vendendo para um consumidor final na BA.
Sem o DIFAL, todo o ICMS ficaria apenas para SP (estado de origem), deixando a BA (destino) sem arrecadação, mesmo sendo ela quem recebe o produto.

O DIFAL foi criado para '''dividir esse imposto''':

* O estado '''de origem''' fica com a '''alíquota interestadual'''.
* O estado '''de destino''' recebe a '''diferença''' entre a sua alíquota interna e a interestadual.

=== Quando é aplicado? ===
Sempre que houver:

# '''Venda interestadual''', e
# '''O destinatário for consumidor final''', seja:
#* '''Contribuinte''' do ICMS
#* '''Não contribuinte''' do ICMS (caso mais comum, principalmente em e-commerce)

=== Quem recolhe? ===
Depende do tipo de consumidor:

==== Consumidor final '''contribuinte''' ====
O '''destinatário''' (comprador) recolhe o DIFAL.

==== Consumidor final '''não contribuinte''' ====
O '''remetente''' (vendedor) recolhe o DIFAL e envia ao estado de destino.

== Cálculo no Sistema ==
'''DiferençaDeAliquota''' = AliquotaInternaDestino - AliquotaInterestadual

'''ValorDiferenca''' = BaseICMS × DiferençaDeAliquota ÷ 100

Se '''PercentualPartilha''' é 100%:

ICMSDestino = ValorDiferenca

ICMSRemetente = 0

Senão:

ICMSDestino = ValorDiferenca × PercentualPartilha ÷ 100

ICMSRemetente = ValorDiferenca - ICMSDestino

'''Exemplo''':

BaseICMS = R$ 1.000,00

AliquotaInternaDestino = 18% (0,18)

AliquotaInterestadual = 12% (0,12)

PercentualPartilha = 100% (ano 2019 ou posterior)

DiferençaDeAliquota = 18% - 12% = 6% (0,06)

ValorDiferenca = R$ 1.000,00 × 6% = R$ 60,00

ICMSDestino = R$ 60,00

ICMSRemetente = R$ 0,00

DIFAL

2025-11-21T14:14:51Z

LucasLp: Criada página sobre DIFAL

== Introdução ==

=== Definição ===
'''DIFAL''' significa '''Diferencial de Alíquota do ICMS'''. Ele existe para equilibrar a arrecadação de ICMS entre os estados quando ocorre uma '''venda interestadual para consumidor final'''.

=== Por que existe? ===
Imagine uma empresa de SP vendendo para um consumidor final na BA.
Sem o DIFAL, todo o ICMS ficaria apenas para SP (estado de origem), deixando a BA (destino) sem arrecadação, mesmo sendo ela quem recebe o produto.

O DIFAL foi criado para '''dividir esse imposto''':

* O estado '''de origem''' fica com a '''alíquota interestadual'''.
* O estado '''de destino''' recebe a '''diferença''' entre a sua alíquota interna e a interestadual.

=== Quando é aplicado? ===
Sempre que houver:

# '''Venda interestadual''', e
# '''O destinatário for consumidor final''', seja:
#* '''Contribuinte''' do ICMS
#* '''Não contribuinte''' do ICMS (caso mais comum, principalmente em e-commerce)

=== Quem recolhe? ===
Depende do tipo de consumidor:

=== ✔ Consumidor final '''contribuinte''' ===
O '''destinatário''' (comprador) recolhe o DIFAL.

=== ✔ Consumidor final '''não contribuinte''' ===
O '''remetente''' (vendedor) recolhe o DIFAL e envia ao estado de destino.

== Cálculo no Sistema ==
'''DiferençaDeAliquota''' = AliquotaInternaDestino - AliquotaInterestadual

'''ValorDiferenca''' = BaseICMS × DiferençaDeAliquota ÷ 100

Se '''PercentualPartilha''' é 100%:

ICMSDestino = ValorDiferenca

ICMSRemetente = 0

Senão:

ICMSDestino = ValorDiferenca × PercentualPartilha ÷ 100

ICMSRemetente = ValorDiferenca - ICMSDestino

'''Exemplo''':

BaseICMS = R$ 1.000,00

AliquotaInternaDestino = 18% (0,18)

AliquotaInterestadual = 12% (0,12)

PercentualPartilha = 100% (ano 2019 ou posterior)

DiferençaDeAliquota = 18% - 12% = 6% (0,06)

ValorDiferenca = R$ 1.000,00 × 6% = R$ 60,00

ICMSDestino = R$ 60,00

ICMSRemetente = R$ 0,00

Notas Fiscais

2025-11-21T14:02:30Z

LucasLp: Adição do Difal

* [[Importações de notas fiscais]]
* [[DIFAL]]

Notas Fiscais

2025-11-21T14:01:45Z

LucasLp: Criou página com '* Importações de notas fiscais'

* [[Importações de notas fiscais]]

Rotinas já Existentes

2025-11-21T14:01:38Z

LucasLp:

* [[Notas Fiscais]]

Nota Fiscal de Saída x Nota Fiscal de Entrada

2025-11-18T18:26:41Z

LucasLp:

== Importação NFS para NFE ==
A seguir serão apresentados os passos para realizar a importação de uma NFS para uma NFE, normalmente utilizada em compras.

1° - Deve ser acessado o bloco de notas, conforme a imagem:
[[Arquivo:Acessando bloco notas.png|nenhum|miniaturadaimagem|647x647px|Fig. 1 - Retaguarda]]
2° - Marcar o seletor de nota de "Entrada".
[[Arquivo:TipoNota.png|nenhum|miniaturadaimagem|419x419px|Fig. 2 - Bloco de notas]]
3° - Informar o tipo de NFE:
[[Arquivo:Tiponfe.png|nenhum|miniaturadaimagem|345x345px|Fig. 3 - Escolha Tipo Nota de entrada]]
4° - Clicar em "Importar de XML NFe (F10)":
[[Arquivo:Botao importar xml nfe.png|nenhum|miniaturadaimagem|742x742px|Fig. 4 - Botão Importar de XML NFe (F10)]]
5° - Escolher o arquivo xml para importar e clicar em "Abrir".
[[Arquivo:Selecao arquivo.png|nenhum|miniaturadaimagem|521x521px|Fig. 5 - Abrindo arquivo xml da nota]]
6° - Verificar todos os itens, principalmente o CFOP, CST ou CSOSN, e se o produto foi localizado. Na imagem abaixo, todos os produtos mostrados estão pré-cadastrados e foram localizados pelo sistema.
[[Arquivo:Produtos importacao.png|nenhum|miniaturadaimagem|716x716px|Fig. 6 - Verificação Dados Nota]]
7° - Se o produto não for localizado pelo sistema, ele fica marcado em vermelho e precisa realizar seu cadastro clicando no botão "Cadastrar", conforme a imagem a seguir. Vários dados que são possível obter do xml da nota já são obtidos ao abrir a tela de cadastro de produto através do botão "Cadastrar", tal como seu nome, nome reduzido, ncm, etc.
[[Arquivo:Produto nao localizado importacao.png|nenhum|miniaturadaimagem|769x769px|Fig. 7 - Verificação Dados Nota]]
8° - Por último deve ser finalizado clicando no botão "OK".

Para a automatização de preenchimento de CFOP e CST é possível cadastrar uma única vez nas seguintes rotinas:

* CFOP de/para: [[De/Para de CFOP]]
** Na imagem da figura 7 acima, tem um botão "CFOP De Para" que permite chamar diretamente a tela de cadastro da rotina.
* Regra de Seleção de CST: [[Regra de Seleção de CST]]
** A regra de seleção irá considerar o tipo de nota selecionado no passo 3 (fig. 3) e o CFOP da nota importada (Campo "CFOP NF-e").

Regra de Seleção de CST

2025-11-18T18:25:57Z

LucasLp: Correções

* A rotina atual foi desenvolvida para que seja realizada a atualização ou preenchimento do CST de forma automática através de alguns critérios.
** Para isso foi criado um cadastro de regras de seleção de CST
*** '''Tela''': Tabelas Fiscais > Regra de Seleção de CST
** Os critérios para seleção são:
*** Nenhum, um ou mais '''tipos de nota'''
*** Um ou mais '''CFOP'''
** Dessa forma, onde necessitar dessa rotina pode ser determinado o CST através do tipo de nota e CFOP.
*** Atualmente a rotina está sendo aplicada para notas de saída na rotina de cálculo de impostos, no qual, onde movimentar estoque será aplicado o cálculo e consequentemente utilizado a regra de seleção de CST.
*** Foi aplicada também no bloco de notas ao selecionar o CFOP para notas de saída.
*** Aplicado para importação de notas de entrada, como de compra.
*** Futuramente vide necessidade, pode ser aplicada para outros locais do sistema e tipos de nota.