Saltar al contenido principal

Emissão de boleto

A emissão cria um boleto de cobrança contra um pagador, numa das suas carteiras de cobrança ativas. Ao salvar, a Kobana gera o boleto (nosso número, linha digitável e código de barras) e pede o registro no banco.

Onde fica no painel​

Você pode abrir o formulário de três formas:

  • menu Cadastrar > Boleto e escolha a carteira (Carteira seguida do nome da carteira);
  • em Recebimentos > Boletos > Gerenciar, clique no ícone de adição ao lado do título Boletos e escolha a carteira;
  • na tela de uma carteira ativa, menu Ações > Novo Boleto.

Só aparecem carteiras com situação Ativa. Se a carteira não estiver ativa, o painel mostra "Carteira não encontrada ou não homologada!".

Ao terminar, clique em Gerar um Novo Boleto. Para desistir, Cancelar e Voltar.

Campos do formulário​

Carteira, valor e vencimento​

CampoObrigatórioDescrição
CarteiraSimCarteira de cobrança que vai registrar o boleto. Só aparece quando a conta tem mais de uma carteira ativa; com uma só, ela é usada automaticamente.
ModeloNãoModelo visual do boleto. Só aparece quando a conta tem modelos cadastrados. Sem modelo, o boleto usa o modelo associado à carteira, se houver. Veja Modelos de boleto.
QuantiaSimValor do boleto em reais, até R$ 99.999.999,99.
VencimentoSimData de vencimento. Não pode ser no passado.
AceiteNãoSim quando você tem um comprovante, assinado pelo pagador, de aceitação do boleto e reconhecimento da dívida. Em caso de protesto, o cartório pede esse comprovante.

:::info Vencimento em fim de semana ou feriado Se o vencimento cair em fim de semana ou feriado, a Kobana muda a data para o próximo dia útil. Para manter a data informada, ative Permitir vencimento em fim de semana e feriado na carteira (veja Configurações da carteira). :::

Dados do Cliente​

CampoObrigatórioDescrição
CNPJ/CPFSimDocumento do pagador. Ao digitar um CNPJ, o painel busca e preenche razão social e endereço. Se o documento já pertence a um cliente cadastrado, os dados dele são sugeridos.
Nome/Razão SocialSimNome do pagador.
Apelido/Nome FantasiaNãoNome alternativo do pagador.
ContatoNãoPessoa de contato.
Este boleto não será enviado por e-mailNãoImpede o envio automático deste boleto por e-mail.
E-mail do clienteNãoE-mail do pagador.
E-mail opcionalNãoSegundo e-mail do pagador.
Este boleto não será enviado por SMSNãoImpede o envio automático deste boleto por SMS.
Telefone (com DDD, DDI é opcional)NãoTelefone do pagador.
Celular (DDD) e CelularNãoCelular do pagador, usado no envio por SMS e WhatsApp.

Depois que o boleto é criado, a Kobana o associa ao cliente com o mesmo CNPJ/CPF na sua conta. Se o cliente não existir, ele é cadastrado com os dados do boleto.

Endereço do cliente​

CampoObrigatórioDescrição
CEPSimAo informar o CEP, o painel sugere endereço, bairro, cidade e estado.
EndereçoSimLogradouro.
NºNãoNúmero.
BairroSimBairro.
ComplementoNãoComplemento.
EstadoSimUF.
CidadeSimCidade.

Demonstrativo e instruções​

CampoObrigatórioDescrição
DemonstrativoNãoTexto que descreve a cobrança (por exemplo, "Serviços prestados conforme contrato.").
Instruções para o CaixaNãoTexto impresso no campo de instruções do boleto (por exemplo, "Não receber após o vencimento.").

Os dois campos aceitam variáveis, inseridas pelo seletor de variáveis acima de cada campo.

Multa​

CampoObrigatórioDescrição
Tipo de MultaNãoSem multa, Por valor ou Por porcentagem.
Porcentagem da multaQuando o tipo é por porcentagemPercentual aplicado sobre o valor do boleto em caso de atraso. Exemplo: 2% de R$ 250,00 = R$ 5,00.
Valor da multaQuando o tipo é por valorValor fixo da multa, em reais.
Dias para multaNãoQuantos dias após o vencimento a multa começa a incidir. O padrão é 1 dia (o dia seguinte ao vencimento).

Juros​

CampoObrigatórioDescrição
Tipo de JuroNãoSem juros, Porcentagem diária, Porcentagem mensal ou Valor diário.
Porcentagem de jurosQuando o tipo é por porcentagemPercentual de juros (diário ou mensal, conforme o tipo).
Valor de jurosQuando o tipo é valor diárioValor de juros por dia, em reais.
Dias para jurosNãoQuantos dias após o vencimento os juros começam a incidir. O padrão é 1 dia.
Tipo de Dias para jurosNãoCorridos ou Úteis: como os dias para juros são contados.

Desconto​

CampoObrigatórioDescrição
Tipo de DescontoNãoSem desconto, Por valor ou Por porcentagem.
Valor do descontoQuando o tipo é por valorValor do desconto, em reais.
Porcentagem do descontoQuando o tipo é por porcentagemPercentual de desconto.
Dias para descontoQuando há descontoO desconto vale até esse número de dias antes do vencimento. Com zero, o limite é a própria data de vencimento.

O formulário tem um só desconto. Segundo e terceiro descontos podem vir dos valores padrão da carteira ou do modelo, ou ser enviados pela API.

Documento (opcional)​

CampoObrigatórioDescrição
Tipo de DocumentoNãoEspécie do título. As opções dependem do banco da carteira; quando disponível, o padrão é Duplicata Mercantil.
Número do DocumentoNãoNúmero do documento de origem (nota, fatura, contrato).
Data do DocumentoNãoData do documento de origem.

Beneficiário final (opcional)​

CampoObrigatórioDescrição
CNPJ/CPF do Beneficiário final (Sacador/Avalista)NãoDocumento do sacador/avalista, quando o crédito é de outra pessoa.
Beneficiário final (Sacador/Avalista)NãoNome do sacador/avalista.

Informações para remessa (opcional)​

CampoObrigatórioDescrição
Dias para ProtestoNãoEm quantos dias, em caso de não pagamento, o banco deve protestar o boleto.
Dias corridos para BaixaNãoEm quantos dias, em caso de não pagamento, o banco deve dar baixa no boleto.
Dias corridos para NegativaçãoNãoEm quantos dias, em caso de não pagamento, o banco deve negativar o boleto.
Quantidade de pagamentos parciaisNãoQuantos pagamentos parciais o boleto aceita.

Com pagamentos parciais, o boleto passa a Pago quando atinge a quantidade de pagamentos informada ou quando a soma paga alcança o valor do boleto.

Pagamento Divergente (opcional)​

CampoObrigatórioDescrição
Tipo de pagamento divergenteNãoNão configurado, Aceita qualquer valor, Aceita faixa de valores, Não aceita divergência ou Aceita acima do mínimo.
Tipo de valor de pagamento divergenteQuando há faixa ou mínimoPor valor (R$) ou Por percentual (%).
Percentual mínimo / máximo, Valor mínimo / máximoConforme o tipoLimites aceitos para o valor pago. Exemplo: percentual mínimo 50 aceita pagamentos a partir de 50% do valor.

Etiquetas e notificações​

CampoObrigatórioDescrição
Etiquetas (Tags)NãoEtiquetas separadas por vírgula. As notificações configuradas com etiquetas só disparam para boletos que tenham uma delas.
Nome do arquivo anexoNãoNome do arquivo do boleto enviado ao pagador nas notificações. Aceita variáveis. Vazio, o nome é a palavra boleto seguida do ID.

Valores preenchidos automaticamente​

Ao escolher a carteira e o modelo, o formulário preenche multa, juros e desconto com os valores padrão configurados neles. Ao salvar, os campos deixados em branco recebem os valores padrão nesta ordem de prioridade: modelo, depois carteira, depois as configurações gerais da conta. Os valores padrão ficam em Ações > Alterar Configuração, na carteira e no modelo.

O que acontece depois​

  1. O painel abre a tela do boleto. Enquanto a geração não termina, ela mostra "Aguarde, seu boleto estará pronto em alguns instantes" e a situação Gerando.
  2. A Kobana gera o boleto e pede o registro no banco pela carteira: online, quando a carteira tem conexão ativa por API, ou na próxima remessa CNAB. Veja Registro no banco.
  3. O boleto passa a Aberto e fica disponível para envio ao pagador.

Quando a carteira está configurada para que o banco gere o nosso número, o boleto fica em Rascunho ("Boleto aguardando confirmação bancária") até o banco confirmar o registro.

Quando a validação em segundo plano está ativa (opção Validação em Segundo Plano nos valores padrão), os dados são conferidos depois de salvar. Se houver erro, o boleto fica Inválido, não é gerado, e a conta recebe o alerta "Boleto inválido no momento da geração".

Se a carteira tem boleto híbrido Gerenciado pela Kobana, a Kobana cria também um Pix ligado ao boleto, na conta Pix escolhida na carteira. Veja Boleto híbrido.

Permissões​

Emitir boletos exige a permissão Criar no módulo Boletos.

Eventos de webhook​

  • bank_billet.created: o boleto foi criado.
  • bank_billet.registered: o banco confirmou o registro.

A lista completa está em Eventos de webhook.

Pela API​

Para emitir boletos por integração, use a API v1 ou a API v2.