> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Boletos

> Emita boletos avulsos, parcelados ou em lote (tradicionais ou híbridos com QR Pix) pelo Lerian Console, acompanhe os estados do ciclo de vida e resolva erros de pagamento.

A página **Boletos** no [Lerian Console](/pt/platform/console/about-lerian-console) permite emitir boletos e acompanhar o ciclo de vida deles. Ela lista os campos obrigatórios, os estados do boleto e como tratar erros.

## Acessando a página Boletos

***

Para abrir a página **Boletos**, clique em **Payments** → **Boletos** no menu lateral esquerdo.

A página mostra todos os boletos da organização em uma tabela de dados, com as seguintes colunas:

* **Boleto**: o identificador do boleto, mais o código de barras e a linha digitável após a emissão.
* **Payer**: a parte que você cobra.
* **Amount**: o valor do boleto.
* **Due Date**: a data de vencimento do boleto.
* **Status**: o estado atual do ciclo de vida (veja [Estados](#boleto-states)).
* **Created At**: a data em que você emitiu o boleto.
* **Actions**: menu de ações.

Você pode filtrar boletos por status, pagador ou intervalo de datas. Use os campos de filtro acima da tabela.

## Emitindo um boleto

***

Para emitir um boleto, clique no botão **+ Issue new boleto** no canto superior direito da página **Boletos**. Um painel lateral abre com três abas. Escolha o tipo de emissão que serve ao seu caso de uso:

### Tipos de boleto

| Tipo             | Descrição                                                                                                         |
| ---------------- | ----------------------------------------------------------------------------------------------------------------- |
| **Single**       | Emite um boleto para um único pagador, com valor e vencimento fixos.                                              |
| **Installments** | Emite uma série de boletos para o mesmo pagador, distribuídos em vários vencimentos com um intervalo configurado. |
| **Batch**        | Emite até 10 boletos para pagadores diferentes em uma operação. Cada entrada vai ao provedor individualmente.     |

### Tipo de registro

Todos os três tipos de emissão têm um campo **Type**:

* **Traditional**: um boleto padrão que o provedor bancário registra.
* **Hybrid**: um boleto com um QR code Pix embutido. O pagador pode pagar pelo código de barras ou pelo QR code.

### Boleto avulso

<Steps>
  <Step>
    Na página **Boletos**, clique em **+ Issue new boleto**.
  </Step>

  <Step>
    Selecione a aba **Single**.
  </Step>

  <Step>
    Preencha os campos obrigatórios:

    **Boleto details**

    * **Amount** *(obrigatório)*: o valor do boleto (R\$).
    * **Due date** *(obrigatório)*: a data em que o pagador deve pagar o boleto.
    * **Account ID** *(obrigatório)*: a conta do Midaz a associar ao boleto.
    * **Type** *(obrigatório)*: **Traditional** ou **Hybrid**.

    **Payer details**

    * **CPF / CNPJ** *(obrigatório)*: o documento fiscal do pagador.
    * **Full name** *(obrigatório)*: o nome completo do pagador.
    * **Street** *(obrigatório)*: o logradouro do pagador.
    * **Number** *(obrigatório)*: o número do endereço.
    * **Complement** *(opcional)*: apartamento, sala ou informação adicional do endereço.
    * **Neighborhood** *(obrigatório)*: o bairro do pagador.
    * **City** *(obrigatório)*: a cidade do pagador.

    **Additional**

    * **Instructions** *(opcional)*: o texto a imprimir no boleto (por exemplo, juros ou multa após o vencimento).
  </Step>

  <Step>
    Clique em **Issue boleto**.
  </Step>

  <Step>
    Depois que o provedor processa o pedido, o boleto aparece na lista. Ele mostra o **código de barras** e a **linha digitável** gerados, prontos para compartilhar com o pagador.
  </Step>
</Steps>

### Série de parcelas

Os mesmos campos do Single, com as seguintes diferenças:

* **Total amount** *(obrigatório)*: o valor total a dividir entre todas as parcelas.
* **First due date** *(obrigatório)*: o vencimento da primeira parcela. A Lerian gera os boletos seguintes automaticamente.
* **Installments** *(obrigatório)*: número de boletos a gerar (mínimo 2).
* **Interval (days)** *(obrigatório)*: número de dias entre cada vencimento (padrão 30).

Clique em **Issue installment series** para confirmar.

### Lote

A aba **Batch** permite emitir até 10 boletos de uma vez. A Lerian envia cada entrada ao provedor individualmente.

Para cada entrada, preencha: **Amount**, **Due date**, **Account ID**, **CPF / CNPJ** e **Full name**. Use **+ Add entry** para adicionar mais entradas. O contador mostra quantas entradas você enfileirou (por exemplo, `1 / 10 entries`).

Clique em **Issue batch** para enviar todas as entradas.

<Tip>
  Depois de emitir um boleto, copie a **linha digitável** ou baixe o documento do boleto. Compartilhe com o pagador.
</Tip>

<h2 id="boleto-states">
  Estados do boleto
</h2>

***

Um boleto passa pelos seguintes estados:

* **Registering**: o provedor registra o boleto depois que você envia a requisição.
* **Registered**: o provedor registrou o boleto e o pagador pode pagá-lo.
* **Paid**: o pagador pagou o boleto.
* **Expired**: o boleto passou do vencimento sem pagamento.
* **Cancelled**: um usuário cancelou o boleto antes do pagamento.
* **Failed**: a emissão do boleto não foi concluída (veja [Tratamento de erros](#error-handling)).

## Menu de ações disponíveis

***

O menu de ações (<Icon icon="ellipsis-vertical" />) mostra ações diferentes para cada boleto. As ações disponíveis dependem do estado do boleto:

* **View details**: abre os detalhes do boleto: código de barras, linha digitável e histórico de status.
* **Download**: baixa o documento do boleto.
* **Cancel**: cancela um boleto antes de o pagador pagá-lo.

<h2 id="error-handling">
  Tratamento de erros
</h2>

***

Se a emissão de um boleto falha, ele aparece com o status **Failed** e um motivo de erro no painel de detalhes. As causas comuns incluem:

* **Documento do pagador inválido**: o CPF/CNPJ está malformado ou não passa na validação. Corrija o documento e emita um novo boleto.
* **Valor ou vencimento inválido**: o valor é zero ou negativo, ou o vencimento está no passado. Ajuste os valores e tente de novo.
* **Erro do provedor ou do registro**: o provedor bancário não conseguiu concluir o registro. Emita o boleto de novo. Se o erro continuar, fale com o suporte.

<Warning>
  Para emitir boletos, você precisa das permissões adequadas do Payments. Se você não vê o botão **+ Issue new boleto**, peça ao seu administrador para verificar as permissões do seu papel.
</Warning>

## Páginas relacionadas

***

<Columns cols={2}>
  <Card title="Introdução ao Payments" icon="money-bill-wave" horizontal href="/pt/interfaces/payments-btg/console/payments-introduction" />

  <Card title="Pagamento de contas" icon="file-invoice-dollar" horizontal href="/pt/interfaces/payments-btg/console/payments-bill-payments" />
</Columns>