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

# Régua de cobrança

> Configure a sequência de e-mails que comunica e cobra cada fatura, do aviso de emissão aos lembretes de vencimento.

> A régua de cobrança é a sequência de e-mails que a Aira envia sobre uma fatura, do aviso de emissão aos lembretes de vencimento. Você monta a régua com as etapas que quiser, cada uma com o seu momento de disparo e o seu conteúdo.

<Note>
  A régua de cobrança é habilitada por workspace. Se você não vê **Réguas de cobrança** no seu ambiente, [fale com a equipe da Aira](mailto:contato@useaira.com).
</Note>

<h2 id="o-que-e">
  O que é uma régua de cobrança
</h2>

Uma régua é uma lista de **etapas**, e cada etapa é um e-mail enviado em um momento do ciclo de vida da fatura. É o que o mercado chama de *dunning*: acompanhar uma fatura em aberto com uma cadência de lembretes.

Você monta as suas próprias réguas. Uma régua atende a vários clientes, e cada cliente segue uma única régua. Todas as faturas de um cliente seguem a régua desse cliente.

<Warning>
  Um cliente sem régua atribuída não recebe nenhum e-mail de cobrança sobre as suas faturas. Atribuir uma régua ao cliente é o que ativa a comunicação por e-mail.
</Warning>

<br />

<h2 id="etapas">
  Etapas e disparo
</h2>

Cada etapa é ancorada em um momento da fatura:

| Disparo (no editor)         | Quando o e-mail é enviado                                      | Uso típico                                                    |
| --------------------------- | -------------------------------------------------------------- | ------------------------------------------------------------- |
| **Na emissão da fatura**    | No dia em que a fatura é emitida                               | Aviso de "fatura disponível"                                  |
| **No vencimento da fatura** | Na data de vencimento (`D0`)                                   | Lembrete no dia do vencimento                                 |
| **Relativo ao vencimento**  | `N` dias **antes** (`D-N`) ou **depois** (`D+N`) do vencimento | `D-3` como lembrete preventivo, `D+5` como cobrança de atraso |

Ao escolher **Relativo ao vencimento**, informe a quantidade de dias e a direção (**Antes** ou **Depois**). Por exemplo, três dias antes do vencimento aparece como `D-3`.

Regras que valem para todas as etapas:

* **As etapas ancoradas no vencimento só disparam quando a fatura tem data de vencimento.** Uma etapa ancorada na emissão não depende disso.
* **Fins de semana são adiados para o próximo dia útil.** Uma etapa que cairia em um sábado ou domingo é enviada na segunda-feira.
* **Uma etapa só é enviada se ainda fizer sentido para aquela fatura.** Se a fatura entra na régua depois do momento de uma etapa, essa etapa não é enviada com atraso.
* **A régua para quando a fatura chega a um estado final** (Paga, Cancelada ou Falha). Enquanto a fatura está apenas **Atrasada**, a régua continua, porque atrasado não é um estado final: é justamente o que a régua existe para cobrar.

<Note>
  Uma régua precisa de **pelo menos uma etapa**. Ao criar uma régua nova, você começa sem nenhuma etapa e adiciona as que quiser. A Aira as organiza na ordem em que são enviadas ao longo da vida da fatura.
</Note>

<br />

<h2 id="conteudo">
  O conteúdo do e-mail
</h2>

Cada etapa tem três campos de texto: **Assunto**, **Título** e **Mensagem**. Os três aceitam **variáveis**, trechos entre chaves duplas que a Aira substitui pelos dados reais da fatura no momento do envio. A sintaxe é `{{ nomeDaVariável }}`.

No editor, cada campo tem um seletor de variáveis, e uma **pré-visualização ao vivo** mostra como o e-mail vai ficar enquanto você escreve.

| Variável                           | Descrição                |
| ---------------------------------- | ------------------------ |
| `{{ billingAccountBusinessName }}` | Nome do cliente          |
| `{{ customerTradeName }}`          | Nome fantasia do cliente |
| `{{ customerDocument }}`           | CNPJ/CPF do cliente      |
| `{{ tenantName }}`                 | Nome da sua empresa      |
| `{{ invoiceNumber }}`              | Número da fatura         |
| `{{ invoiceAmount }}`              | Valor da fatura          |
| `{{ invoiceDate }}`                | Data de emissão          |
| `{{ dueDate }}`                    | Data de vencimento       |
| `{{ invoiceDateMonthYear }}`       | Mês e ano da fatura      |
| `{{ contractStartDate }}`          | Início do contrato       |
| `{{ contractEndDate }}`            | Fim do contrato          |
| `{{ products }}`                   | Produtos da fatura       |

<br />

<h2 id="padrao-atribuicao">
  Régua padrão e atribuição ao cliente
</h2>

A Aira já vem com uma régua padrão, que inclui uma etapa na emissão da fatura para reproduzir o aviso de "fatura disponível". Você pode ajustá-la ou criar novas réguas do zero, com as etapas que fizerem sentido para a sua operação.

Nas **Configurações de cobrança** (ícone de engrenagem na tela de réguas) você define qual régua é a padrão. Todo cliente novo recebe essa régua automaticamente.

Você também pode escolher **"Não atribuir automaticamente"**. Nesse caso, os clientes novos são criados sem régua e não são comunicados por e-mail até que uma régua seja atribuída a eles.

<Note>
  Trocar a régua padrão não reatribui os clientes que já existem: a régua padrão vale apenas no momento em que um cliente é criado. Para mudar a régua de um cliente existente, edite o cliente.
</Note>

As mesmas configurações guardam o **e-mail de resposta** das cobranças. A identidade do remetente, o logo, a cor e os anexos obrigatórios de cada cobrança também fazem parte dessa configuração, e hoje são ajustados junto à [equipe da Aira](mailto:contato@useaira.com).

<br />

<h2 id="envio">
  O envio
</h2>

Quando uma etapa dispara, a Aira envia o e-mail para **todos os e-mails da conta de pagamento** da fatura, em um único envio. O e-mail leva os anexos que a sua empresa definiu como obrigatórios para a cobrança, como o descritivo de cálculo (o PDF da fatura), a nota fiscal, o boleto ou o código Pix.

<h3 id="em-espera">
  Envios "em espera"
</h3>

Um envio nem sempre sai na hora. Ele fica **em espera** quando falta algo:

* um anexo obrigatório ainda sendo gerado (**arquivos da fatura**, **nota fiscal**, **boleto** ou **código Pix**);
* a fatura em uma situação que não permite envio;
* a conta de pagamento **sem nenhum e-mail** cadastrado.

A Aira mostra o motivo da espera e tenta enviar de novo sozinha, sempre em horário comercial (dias úteis, das 8h às 18h, horário de Brasília). Assim que o que faltava fica pronto, por exemplo quando a nota fiscal é emitida ou o boleto é gerado, o envio é liberado em seguida.

<br />

<h2 id="historico">
  Histórico e ações na fatura
</h2>

Cada fatura mostra o **histórico dos e-mails** da régua. Cada envio aparece com o seu desfecho:

<Tabs>
  <Tab title="Enviado">
    O e-mail saiu. É possível abrir um espelho do e-mail enviado, com destinatários, remetente, data, anexos e o corpo exato que foi entregue.
  </Tab>

  <Tab title="Em espera">
    O envio está aguardando. O motivo aparece como etiqueta, por exemplo *nota fiscal*, *boleto* ou *conta de cobrança sem e-mail de destinatário*.
  </Tab>

  <Tab title="Falha">
    O envio não foi concluído.
  </Tab>
</Tabs>

Da fatura você também pode:

* **Reenviar a cobrança** manualmente, sob demanda.
* **Cancelar a fatura**, o que descarta os envios ainda pendentes ou em espera. Uma fatura cancelada não continua sendo cobrada.

<br />

<h2 id="gerir">
  Gerir réguas
</h2>

Uma régua pode ser **duplicada** (para criar uma variação sem começar do zero), **arquivada** e **desarquivada**.

| Ação            | O que acontece                                                                                                                                                                     |
| --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Duplicar**    | Cria uma cópia da régua com as mesmas etapas                                                                                                                                       |
| **Arquivar**    | Tira a régua das listas ativas, impede novas atribuições e preserva o histórico. Só é permitido quando a régua não está atribuída a nenhum cliente e não tem cobrança em andamento |
| **Desarquivar** | Devolve a régua para as listas ativas                                                                                                                                              |
| **Excluir**     | Só é permitido para uma régua que nunca foi usada (nunca foi atribuída e nunca enviou e-mail)                                                                                      |

<br />

<h2 id="proximos-passos">
  Próximos passos
</h2>

* [Ciclo de vida da fatura](/faturas/ciclo-de-vida) — os status pelos quais a fatura passa
* [Criar clientes](/clientes/criar-clientes) — onde a régua é atribuída ao cliente
* [Documentos fiscais](/faturas/documentos-fiscais) — a NFSe que pode ir anexa à cobrança
* [Métodos de pagamento](/pagamentos/metodos-de-pagamento) — boleto e Pix que entram como anexos