Skip to main content

O que é a régua de cobrança?

A régua de cobrança define quais avisos os seus clientes recebem sobre as cobranças e parcelas de assinatura da sua empresa, por quais canais eles saem e em quais momentos.

É a mesma configuração da tela Cobranças > Régua de cobrança do painel. Você pode alterá-la pela tela ou pela API, e as duas formas mudam a mesma régua.

Os avisos​

Cada aviso é identificado por um notificationType:

notificationTypeQuando saiO que o cliente recebeCanaisMomentos
NOTIFY_CUSTOMER_ON_CHARGE_CREATEDQuando a cobrança é criadaA cobrança, com o link de pagamento e o Pix Copia e ColaWHATSAPP, EMAIL—
NOTIFY_CUSTOMER_BEFORE_CHARGE_DUE_DATEAntes do vencimento, de 24 horas até 30 dias antesUm lembrete de que a cobrança vai vencerWHATSAPP, EMAILAté 5
NOTIFY_CUSTOMER_ON_CHARGE_DUE_DATENo dia do vencimento, menos de 24 horas antes de vencerUm aviso de que a cobrança vence hojeWHATSAPP, EMAILAté 5
NOTIFY_CUSTOMER_AFTER_CHARGE_DUE_DATEDepois do vencimento, até 30 dias depois, enquanto a cobrança ainda pode ser pagaUm aviso de que a cobrança está vencida e ainda em abertoWHATSAPP, EMAILAté 5
NOTIFY_CUSTOMER_ON_CHARGE_PAIDQuando a cobrança é pagaO comprovante de pagamentoWHATSAPP, EMAIL—
NOTIFY_CUSTOMER_ON_INSTALLMENT_CHARGE_CREATEDQuando a parcela de uma assinatura é geradaA cobrança da parcelaEMAIL—
NOTIFY_CUSTOMER_ON_INSTALLMENT_EXPIREDQuando a parcela de uma assinatura expira sem pagamentoUm aviso de que a parcela expirouEMAIL—

Cada aviso tem:

  • active: se o aviso é enviado. Desligar um aviso mantém os canais e os momentos dele, para quando você religar.
  • channels: por onde o aviso sai. Um aviso ligado precisa de pelo menos um canal, e cada canal aparece uma vez só.
  • offsets: os momentos dos avisos de vencimento. Só existem nos três avisos de vencimento (BEFORE, ON e AFTER).
  • attachments: os arquivos que vão junto do e-mail. Só existem na cobrança criada e na parcela criada.

Momentos (offsets)​

Os três avisos de vencimento saem uma vez para cada momento configurado. Um momento é a distância até o vencimento, ou a partir dele:

{ "value": 3, "unit": "DAY" }
  • value é um número inteiro positivo, e unit é MINUTE, HOUR ou DAY.
  • Um aviso aceita até 5 momentos, e dois momentos do mesmo aviso não podem cair no mesmo instante, como 1 DAY e 24 HOUR.
  • Nenhum momento pode estar a mais de 30 dias do vencimento.
  • Antes do vencimento (BEFORE): cada momento precisa estar a pelo menos 24 horas do vencimento.
  • No dia do vencimento (ON): cada momento precisa estar a menos de 24 horas do vencimento, por exemplo 3 HOUR ou 30 MINUTE.
  • Depois do vencimento (AFTER): conta a partir do vencimento.

Exemplos com uma cobrança que vence em 10/12 às 18:00:

AvisoMomentosEnvios
BEFORE5 DAY, 1 DAY05/12 às 18:00 e 09/12 às 18:00
ON3 HOUR10/12 às 15:00
AFTER1 DAY, 3 DAY11/12 às 18:00 e 13/12 às 18:00

Quando um momento não é enviado​

  • Antes e no dia do vencimento: um momento que já passou quando a cobrança é criada não é enviado. Uma cobrança criada 2 dias antes de vencer não recebe o lembrete de 5 dias antes.
  • Depois do vencimento: só a cobrança com data de vencimento (Pix com vencimento) recebe esse aviso, porque é ela que continua podendo ser paga depois de vencer. O Pix imediato não pode mais ser pago quando expira e não recebe aviso depois do vencimento. Um momento depois do último dia de pagamento da cobrança não é enviado.
  • Para o Pix imediato, o vencimento é a data em que a cobrança expira.

Anexos (attachments)​

Os avisos de cobrança criada e de parcela criada podem levar arquivos no e-mail:

  • CHARGE_PDF: o PDF do boleto da cobrança, para cobranças com boleto.
  • INVOICE: a nota fiscal da cobrança, quando a sua empresa emite a nota fiscal na criação da cobrança.

Enquanto a sua empresa não escolher os anexos, o campo não aparece na resposta da API. Os outros avisos não aceitam anexos.

Quem recebe​

O aviso vai para o cliente da cobrança, nos canais da régua para os quais o cliente tem contato:

  • WHATSAPP precisa do telefone do cliente.
  • EMAIL precisa do e-mail do cliente.

Um cliente sem telefone não recebe o aviso por WhatsApp, mesmo com o canal ligado na régua.

Quando uma mudança vale​

  • Desligar um aviso, ou tirar um canal, vale na hora, inclusive para as cobranças que já existem.
  • Remover um momento também vale para as cobranças que já existem. Momentos novos valem para as cobranças criadas depois da mudança.
  • Os avisos de vencimento só saem enquanto a cobrança está em aberto. Depois que ela é paga, não sai mais nenhum.

Próximos passos​