# Régua de Cobrança — Kobana > Documentação completa: carteira de clientes, régua de cobrança multicanal, compliance de contato, acordos, disputas, webhooks e API. ## pt Régua de Cobrança: régua de cobrança multicanal para recuperar recebíveis em atraso com compliance de contato, acordos, disputas e auditoria probatória. - [Régua de Cobrança](https://docs.dunning.com.br/pt/index.md): Régua de Cobrança: régua de cobrança multicanal para recuperar recebíveis em atraso com compliance de contato, acordos, disputas e auditoria probatória. ### search - [Search the documentation](https://docs.dunning.com.br/pt/search.md) ### acordos - [Acordos](https://docs.dunning.com.br/pt/acordos.md) #### documentos Documentos gerados em PDF: o termo de acordo e a carta de quitação, montados a partir dos dados da operação e obtidos pela API. - [Documentos gerados (PDF)](https://docs.dunning.com.br/pt/acordos/documentos.md): Documentos gerados em PDF: o termo de acordo e a carta de quitação, montados a partir dos dados da operação e obtidos pela API. #### negociacao Negociação e acordos: como um acordo consolida dívidas em parcelas, o ciclo de vida do acordo e a validação server-side do portal. - [Negociação e acordos](https://docs.dunning.com.br/pt/acordos/negociacao.md): Negociação e acordos: como um acordo consolida dívidas em parcelas, o ciclo de vida do acordo e a validação server-side do portal. #### parcelas-e-quebra Parcelas e quebra do acordo: como as parcelas são geradas, o registro de pagamentos e o que acontece quando o acordo é quebrado. - [Parcelas e quebra](https://docs.dunning.com.br/pt/acordos/parcelas-e-quebra.md): Parcelas e quebra do acordo: como as parcelas são geradas, o registro de pagamentos e o que acontece quando o acordo é quebrado. ### api Referência da API da Régua de Cobrança: contratos completos dos endpoints v1, gerados a partir do OpenAPI. - [Referência da API](https://docs.dunning.com.br/pt/api.md): Referência da API da Régua de Cobrança: contratos completos dos endpoints v1, gerados a partir do OpenAPI. ### carteira - [Carteira](https://docs.dunning.com.br/pt/carteira.md) #### classificacoes Classificações segmentam a carteira pelo comportamento de pagamento: Novo, Bom, Regular, Mau pagador — ou qualquer outra divisão que faça sentido para a sua operação. A página Classificações do menu lateral lista cada uma com nome, prioridade, se é auto-atribuída, quantas pessoas estão nela e quantas réguas a usam. - [Classificações](https://docs.dunning.com.br/pt/carteira/classificacoes.md): Classificações segmentam a carteira pelo comportamento de pagamento: Novo, Bom, Regular, Mau pagador — ou qualquer outra divisão que faça sentido para a sua operação. A página Classificações do menu lateral lista cada uma com nome, prioridade, se é auto-atribuída, quantas pessoas estão nela e quantas réguas a usam. #### clientes Clientes são as pessoas (físicas ou jurídicas) da sua carteira — na interface, a página Clientes do menu lateral. Todo o resto do sistema gira em torno deles: cobranças, acordos, notificações e o portal do devedor sempre apontam para um cliente. - [Clientes](https://docs.dunning.com.br/pt/carteira/clientes.md): Clientes são as pessoas (físicas ou jurídicas) da sua carteira — na interface, a página Clientes do menu lateral. Todo o resto do sistema gira em torno deles: cobranças, acordos, notificações e o portal do devedor sempre apontam para um cliente. #### exportacao O Dunning exporta clientes e cobranças em CSV de duas formas: download imediato (síncrono), para recortes de até 10 mil linhas, e exportação em segundo plano (página Exportações), para bases grandes. - [Exportação](https://docs.dunning.com.br/pt/carteira/exportacao.md): O Dunning exporta clientes e cobranças em CSV de duas formas: download imediato (síncrono), para recortes de até 10 mil linhas, e exportação em segundo plano (página Exportações), para bases grandes. #### importacao A página Importações sobe a sua carteira por arquivo CSV: primeiro os clientes, depois as cobranças. O processamento roda em segundo plano, linha a linha — linhas com erro não derrubam o restante da planilha. - [Importação por planilha](https://docs.dunning.com.br/pt/carteira/importacao.md): A página Importações sobe a sua carteira por arquivo CSV: primeiro os clientes, depois as cobranças. O processamento roda em segundo plano, linha a linha — linhas com erro não derrubam o restante da planilha. ### cobrancas - [Cobranças](https://docs.dunning.com.br/pt/cobrancas.md) #### ciclo-de-vida O ciclo de vida da cobrança: os status, a máquina de estados e as transições do dia a dia, do pendente à baixa e à recuperação. - [Ciclo de vida](https://docs.dunning.com.br/pt/cobrancas/ciclo-de-vida.md): O ciclo de vida da cobrança: os status, a máquina de estados e as transições do dia a dia, do pendente à baixa e à recuperação. #### encargos Encargos da cobrança: multa, juros de mora, correção e desconto, calculados de forma idempotente em centavos e no fuso da organização. - [Encargos](https://docs.dunning.com.br/pt/cobrancas/encargos.md): Encargos da cobrança: multa, juros de mora, correção e desconto, calculados de forma idempotente em centavos e no fuso da organização. #### origens Origens da cobrança: o campo que registra a procedência de cada título — manual, planilha, API ou integração — para filtrar e diagnosticar. - [Origens da cobrança](https://docs.dunning.com.br/pt/cobrancas/origens.md): Origens da cobrança: o campo que registra a procedência de cada título — manual, planilha, API ou integração — para filtrar e diagnosticar. #### pagamento-e-baixa Pagamento e baixa: como o pagamento entra, o que acontece na baixa, a verificação de já paguei e a trava jurídica. - [Pagamento e baixa](https://docs.dunning.com.br/pt/cobrancas/pagamento-e-baixa.md): Pagamento e baixa: como o pagamento entra, o que acontece na baixa, a verificação de já paguei e a trava jurídica. #### valores-e-vencimento Os valores de uma cobrança: valor original, atual, pago e saldo, e como o vencimento define quando a régua entra em ação. - [Valores e vencimento](https://docs.dunning.com.br/pt/cobrancas/valores-e-vencimento.md): Os valores de uma cobrança: valor original, atual, pago e saldo, e como o vencimento define quando a régua entra em ação. ### configuracoes - [Configurações](https://docs.dunning.com.br/pt/configuracoes.md) #### chaves-de-api Chaves de API autenticam integrações com a API v1. Elas são criadas em Configurações → Segurança, apenas por administradores. - [Chaves de API](https://docs.dunning.com.br/pt/configuracoes/chaves-de-api.md): Chaves de API autenticam integrações com a API v1. Elas são criadas em Configurações → Segurança, apenas por administradores. #### conta-e-marca A tela Configurações concentra a administração da conta em cinco abas: Empresa, Usuários, Notificações, Integrações e Segurança. - [Conta e marca](https://docs.dunning.com.br/pt/configuracoes/conta-e-marca.md): A tela Configurações concentra a administração da conta em cinco abas: Empresa, Usuários, Notificações, Integrações e Segurança. #### layouts-de-email O layout de e-mail é o envelope HTML que embrulha toda mensagem de cobrança enviada por e-mail: cabeçalho com a sua marca, rodapé com os seus dados, e no meio o conteúdo do template da etapa. Template diz o que a mensagem fala; layout diz como ela se veste. - [Layouts de e-mail](https://docs.dunning.com.br/pt/configuracoes/layouts-de-email.md): O layout de e-mail é o envelope HTML que embrulha toda mensagem de cobrança enviada por e-mail: cabeçalho com a sua marca, rodapé com os seus dados, e no meio o conteúdo do template da etapa. Template diz o que a mensagem fala; layout diz como ela se veste. #### preferencias-de-notificacao As preferências de notificação são o interruptor por tipo × canal das mensagens que o sistema envia ao devedor. Elas respondem a perguntas como "quero lembretes por e-mail, mas não por SMS" sem tocar em nenhuma régua. - [Preferências de notificação](https://docs.dunning.com.br/pt/configuracoes/preferencias-de-notificacao.md): As preferências de notificação são o interruptor por tipo × canal das mensagens que o sistema envia ao devedor. Elas respondem a perguntas como "quero lembretes por e-mail, mas não por SMS" sem tocar em nenhuma régua. ### desenvolvedores - [Desenvolvedores](https://docs.dunning.com.br/pt/desenvolvedores.md) #### comece-aqui Tudo que o dashboard faz na operação de cobrança existe na API v1: clientes, cobranças, réguas, acordos, disputas, tarefas, importações, webhooks. Esta seção traz o caminho prático; os contratos completos estão na Referência da API, gerada do OpenAPI (nunca escrita à mão). - [Comece aqui](https://docs.dunning.com.br/pt/desenvolvedores/comece-aqui.md): Tudo que o dashboard faz na operação de cobrança existe na API v1: clientes, cobranças, réguas, acordos, disputas, tarefas, importações, webhooks. Esta seção traz o caminho prático; os contratos completos estão na Referência da API, gerada do OpenAPI (nunca escrita à mão). #### erros Todo erro da API v1 volta no mesmo envelope: - [Erros e códigos](https://docs.dunning.com.br/pt/desenvolvedores/erros.md): Todo erro da API v1 volta no mesmo envelope: #### exemplos O fluxo essencial de uma integração, ponta a ponta, em curl - [Exemplos práticos](https://docs.dunning.com.br/pt/desenvolvedores/exemplos.md): O fluxo essencial de uma integração, ponta a ponta, em curl #### postman-e-sdks Você não precisa montar requisições do zero: a coleção Postman e o spec OpenAPI são gerados da mesma fonte da Referência da API e ficam sempre em sincronia com ela. - [Postman e SDKs](https://docs.dunning.com.br/pt/desenvolvedores/postman-e-sdks.md): Você não precisa montar requisições do zero: a coleção Postman e o spec OpenAPI são gerados da mesma fonte da Referência da API e ficam sempre em sincronia com ela. ### disputas - [Disputas](https://docs.dunning.com.br/pt/disputas.md) #### contestacoes Quando o devedor contesta uma cobrança — "já paguei", "não reconheço", "o valor está errado" — continuar cobrando é o pior movimento possível abrir uma disputa pausa a régua na hora e congela todo envio pendente, antes de qualquer análise. - [Contestações](https://docs.dunning.com.br/pt/disputas/contestacoes.md): Quando o devedor contesta uma cobrança — "já paguei", "não reconheço", "o valor está errado" — continuar cobrando é o pior movimento possível abrir uma disputa pausa a régua na hora e congela todo envio pendente, antes de qualquer análise. #### resolucao Resolver uma disputa é responder duas perguntas: o devedor tem razão? (decisão) e o que fazer com a cobrança? (efeito). A tela da disputa pede as duas, mais uma decisão fundamentada por escrito — obrigatória, porque ela vai para a trilha de auditoria. - [Resolução](https://docs.dunning.com.br/pt/disputas/resolucao.md): Resolver uma disputa é responder duas perguntas: o devedor tem razão? (decisão) e o que fazer com a cobrança? (efeito). A tela da disputa pede as duas, mais uma decisão fundamentada por escrito — obrigatória, porque ela vai para a trilha de auditoria. ### guia - [Guias](https://docs.dunning.com.br/pt/guia.md) #### go-live-checklist Checklist de go-live: a conferência final de carteira, régua, canais, compliance e integrações antes de cobrar devedores reais. - [Checklist de go-live](https://docs.dunning.com.br/pt/guia/go-live-checklist.md): Checklist de go-live: a conferência final de carteira, régua, canais, compliance e integrações antes de cobrar devedores reais. #### guia-do-integrador Guia do integrador: chave de API, primeira chamada, primeiro cliente e cobrança, webhooks e retries seguros para ligar ERP ou gateway ao Dunning. - [Guia do integrador](https://docs.dunning.com.br/pt/guia/guia-do-integrador.md): Guia do integrador: chave de API, primeira chamada, primeiro cliente e cobrança, webhooks e retries seguros para ligar ERP ou gateway ao Dunning. #### implantacao-conta-e-carteira Implantação, parte 1: estruturar a conta, aplicar a sua marca e carregar a carteira de clientes antes de desenhar a régua. - [Implantação: conta e carteira](https://docs.dunning.com.br/pt/guia/implantacao-conta-e-carteira.md): Implantação, parte 1: estruturar a conta, aplicar a sua marca e carregar a carteira de clientes antes de desenhar a régua. #### implantacao-regua-e-canais Implantação, parte 2: desenhar a régua, publicá-la e ligar os canais de envio para transformar a conta em operação de cobrança. - [Implantação: régua e canais](https://docs.dunning.com.br/pt/guia/implantacao-regua-e-canais.md): Implantação, parte 2: desenhar a régua, publicá-la e ligar os canais de envio para transformar a conta em operação de cobrança. #### o-produto-em-5-minutos O produto em 5 minutos: o que o Dunning faz, com quais peças e sob qual promessa, para decidir bem nos guias de implantação. - [O produto em 5 minutos](https://docs.dunning.com.br/pt/guia/o-produto-em-5-minutos.md): O produto em 5 minutos: o que o Dunning faz, com quais peças e sob qual promessa, para decidir bem nos guias de implantação. #### operacao-dia-a-dia A rotina do operador com a régua no ar: cuidar das exceções que o sistema separa e ler os números para ajustar a máquina. - [Operação no dia a dia](https://docs.dunning.com.br/pt/guia/operacao-dia-a-dia.md): A rotina do operador com a régua no ar: cuidar das exceções que o sistema separa e ler os números para ajustar a máquina. ### integracoes #### bling Integração nativa · Somente leitura (pull) · Sincroniza automaticamente a cada 60 min (configurável) + sob demanda · Conexão via OAuth - [Bling](https://docs.dunning.com.br/pt/integracoes/bling.md): Integração nativa · Somente leitura (pull) · Sincroniza automaticamente a cada 60 min (configurável) + sob demanda · Conexão via OAuth #### conta-azul Integração nativa · Somente leitura (pull) · Sincroniza automaticamente a cada 60 min (configurável) + sob demanda · Conexão via OAuth - [Conta Azul](https://docs.dunning.com.br/pt/integracoes/conta-azul.md): Integração nativa · Somente leitura (pull) · Sincroniza automaticamente a cada 60 min (configurável) + sob demanda · Conexão via OAuth #### faturamento-automatico Integração nativa · Somente leitura (pull) · Sincroniza automaticamente a cada 60 min (configurável) + sob demanda · Baixa em tempo real por webhook - [Faturamento Automático](https://docs.dunning.com.br/pt/integracoes/faturamento-automatico.md): Integração nativa · Somente leitura (pull) · Sincroniza automaticamente a cada 60 min (configurável) + sob demanda · Baixa em tempo real por webhook #### financeiro-inteligente Integração nativa · Somente leitura (pull) · Sincroniza automaticamente a cada 60 min (configurável) + sob demanda - [Financeiro Inteligente](https://docs.dunning.com.br/pt/integracoes/financeiro-inteligente.md): Integração nativa · Somente leitura (pull) · Sincroniza automaticamente a cada 60 min (configurável) + sob demanda #### gateway-kobana Integração nativa · Somente leitura (pull) · Sincroniza automaticamente a cada 60 min (configurável) + sob demanda · Baixa em tempo real por webhook - [Gateway da Kobana](https://docs.dunning.com.br/pt/integracoes/gateway-kobana.md): Integração nativa · Somente leitura (pull) · Sincroniza automaticamente a cada 60 min (configurável) + sob demanda · Baixa em tempo real por webhook #### olist Integração nativa · Somente leitura (pull) · Sincroniza automaticamente a cada 60 min (configurável) + sob demanda · Conexão via OAuth - [Olist (Tiny)](https://docs.dunning.com.br/pt/integracoes/olist.md): Integração nativa · Somente leitura (pull) · Sincroniza automaticamente a cada 60 min (configurável) + sob demanda · Conexão via OAuth #### omie Integração nativa · Somente leitura (pull) · Sincroniza automaticamente a cada 60 min (configurável) + sob demanda · Conexão por chave estática - [Omie](https://docs.dunning.com.br/pt/integracoes/omie.md): Integração nativa · Somente leitura (pull) · Sincroniza automaticamente a cada 60 min (configurável) + sob demanda · Conexão por chave estática #### visao-geral As integrações conectam o Dunning aos sistemas onde as suas cobranças já nascem — o Gateway da Kobana, os produtos irmãos de Faturamento e Financeiro, e ERPs de mercado como Bling, Conta Azul, Omie e Olist/Tiny. Em vez de recadastrar títulos à mão, você conecta a origem uma vez e o Dunning passa a puxar as cobranças e os clientes de lá para cobrar por eles com a régua, o portal e os acordos. - [Integrações](https://docs.dunning.com.br/pt/integracoes/visao-geral.md): As integrações conectam o Dunning aos sistemas onde as suas cobranças já nascem — o Gateway da Kobana, os produtos irmãos de Faturamento e Financeiro, e ERPs de mercado como Bling, Conta Azul, Omie e Olist/Tiny. Em vez de recadastrar títulos à mão, você conecta a origem uma vez e o Dunning passa a puxar as cobranças e os clientes de lá para cobrar por eles com a régua, o portal e os acordos. ### metricas - [Métricas](https://docs.dunning.com.br/pt/metricas.md) #### dashboard O dashboard é a home do Dunning: a foto da carteira em cima, a linha operacional no meio e os detalhes embaixo. Todos os cards são clicáveis e levam à tela filtrada correspondente. - [Dashboard](https://docs.dunning.com.br/pt/metricas/dashboard.md): O dashboard é a home do Dunning: a foto da carteira em cima, a linha operacional no meio e os detalhes embaixo. Todos os cards são clicáveis e levam à tela filtrada correspondente. #### recuperacao As métricas de recuperação respondem à pergunta que justifica o produto: o que a régua fez por você? A resposta é construída com atribuição honesta — o sistema só chama de "recuperado" o que estava de fato em recuperação, e diz qual etapa e canal tocaram o devedor por último antes do dinheiro entrar. - [Recuperação](https://docs.dunning.com.br/pt/metricas/recuperacao.md): As métricas de recuperação respondem à pergunta que justifica o produto: o que a régua fez por você? A resposta é construída com atribuição honesta — o sistema só chama de "recuperado" o que estava de fato em recuperação, e diz qual etapa e canal tocaram o devedor por último antes do dinheiro entrar. ### negativacao-e-protesto - [Negativação e Protesto](https://docs.dunning.com.br/pt/negativacao-e-protesto.md) #### remocao-e-cancelamento Registrar no birô ou protestar é metade do trabalho; a outra metade é tirar o registro do ar na hora certa. Devedor que pagou e continua negativado é passivo jurídico — a baixa tempestiva é obrigação do credor, não cortesia. - [Remoção e cancelamento](https://docs.dunning.com.br/pt/negativacao-e-protesto/remocao-e-cancelamento.md): Registrar no birô ou protestar é metade do trabalho; a outra metade é tirar o registro do ar na hora certa. Devedor que pagou e continua negativado é passivo jurídico — a baixa tempestiva é obrigação do credor, não cortesia. #### workflow Negativação (SPC/Serasa/Boa Vista) e protesto em cartório não são "canais da régua" — mandar um CPF para o birô não é como mandar um e-mail. São atos jurídicos com consequências sérias para o devedor e responsabilidade real para a sua empresa a régua pode iniciar, mas nada é registrado no birô ou no cartório sem um humano aprovar. - [Workflow jurídico](https://docs.dunning.com.br/pt/negativacao-e-protesto/workflow.md): Negativação (SPC/Serasa/Boa Vista) e protesto em cartório não são "canais da régua" — mandar um CPF para o birô não é como mandar um e-mail. São atos jurídicos com consequências sérias para o devedor e responsabilidade real para a sua empresa a régua pode iniciar, mas nada é registrado no birô ou no cartório sem um humano aprovar. ### operacao - [Operação](https://docs.dunning.com.br/pt/operacao.md) #### auditoria A tela Auditoria é a trilha imutável de tudo que aconteceu na conta o registro que você apresenta quando um devedor, um advogado ou um juiz pergunta "por que vocês fizeram isso?". - [Auditoria](https://docs.dunning.com.br/pt/operacao/auditoria.md): A tela Auditoria é a trilha imutável de tudo que aconteceu na conta o registro que você apresenta quando um devedor, um advogado ou um juiz pergunta "por que vocês fizeram isso?". #### estrutura-organizacional A tela Estrutura organiza a conta em três níveis: workspaces, empresas e filiais. É essa hierarquia que separa carteiras, escopa relatórios e define em nome de quem as comunicações saem. - [Estrutura organizacional](https://docs.dunning.com.br/pt/operacao/estrutura-organizacional.md): A tela Estrutura organiza a conta em três níveis: workspaces, empresas e filiais. É essa hierarquia que separa carteiras, escopa relatórios e define em nome de quem as comunicações saem. #### membros-e-permissoes A tela Membros responde "quem acessa a conta e o que cada um pode fazer". Cada membro tem um ou mais roles; cada role é um conjunto de permissões do catálogo do produto. - [Membros e permissões](https://docs.dunning.com.br/pt/operacao/membros-e-permissoes.md): A tela Membros responde "quem acessa a conta e o que cada um pode fazer". Cada membro tem um ou mais roles; cada role é um conjunto de permissões do catálogo do produto. #### tarefas-e-equipe A tela Tarefas é a fila de trabalho dos operadores: tudo que a régua não resolve sozinha (ou que você decidiu tratar manualmente) vira uma tarefa com tipo, prioridade e vencimento. - [Tarefas e equipe](https://docs.dunning.com.br/pt/operacao/tarefas-e-equipe.md): A tela Tarefas é a fila de trabalho dos operadores: tudo que a régua não resolve sozinha (ou que você decidiu tratar manualmente) vira uma tarefa com tipo, prioridade e vencimento. ### portal-do-devedor - [Portal do Devedor](https://docs.dunning.com.br/pt/portal-do-devedor.md) #### autoatendimento O portal do devedor é onde o cliente resolve a própria pendência: consulta as dívidas, paga por boleto ou PIX, simula um parcelamento e fecha acordo — sem falar com ninguém da sua equipe, a qualquer hora. - [Autoatendimento](https://docs.dunning.com.br/pt/portal-do-devedor/autoatendimento.md): O portal do devedor é onde o cliente resolve a própria pendência: consulta as dívidas, paga por boleto ou PIX, simula um parcelamento e fecha acordo — sem falar com ninguém da sua equipe, a qualquer hora. #### conta-do-devedor Além do acesso rápido por link, o portal oferece uma conta persistente: o devedor cria um login com e-mail e senha e volta quando quiser — em /conta — para acompanhar as dívidas, os acordos, o histórico e o perfil ao longo do tempo, sem depender de um link novo a cada vez. - [Conta do devedor](https://docs.dunning.com.br/pt/portal-do-devedor/conta-do-devedor.md): Além do acesso rápido por link, o portal oferece uma conta persistente: o devedor cria um login com e-mail e senha e volta quando quiser — em /conta — para acompanhar as dívidas, os acordos, o histórico e o perfil ao longo do tempo, sem depender de um link novo a cada vez. #### seguranca O portal expõe dados de dívida na internet aberta — no acesso por link, sem sequer um login — então cada camada de proteção importa. Esta página documenta o modelo de segurança do acesso por link para você responder com precisão a auditorias e questionamentos de clientes. A conta persistente (e-mail e senha) tem as suas próprias proteções, descritas na página dela. - [Segurança](https://docs.dunning.com.br/pt/portal-do-devedor/seguranca.md): O portal expõe dados de dívida na internet aberta — no acesso por link, sem sequer um login — então cada camada de proteção importa. Esta página documenta o modelo de segurança do acesso por link para você responder com precisão a auditorias e questionamentos de clientes. A conta persistente (e-mail e senha) tem as suas próprias proteções, descritas na página dela. #### white-label O devedor deve negociar com a sua marca — não com um sistema de cobrança genérico. Uma cobrança que chega com a identidade do credor tem mais legitimidade, gera menos desconfiança ("isso é golpe?") e converte mais. - [White-label](https://docs.dunning.com.br/pt/portal-do-devedor/white-label.md): O devedor deve negociar com a sua marca — não com um sistema de cobrança genérico. Uma cobrança que chega com a identidade do credor tem mais legitimidade, gera menos desconfiança ("isso é golpe?") e converte mais. ### primeiros-passos #### checklist-de-onboarding O card Primeiros passos: os quatro passos, marcados a partir dos seus dados reais, que levam uma conta vazia a uma régua cobrando. - [Checklist de onboarding](https://docs.dunning.com.br/pt/primeiros-passos/checklist-de-onboarding.md): O card Primeiros passos: os quatro passos, marcados a partir dos seus dados reais, que levam uma conta vazia a uma régua cobrando. #### conceitos Glossário do Dunning em uma página: cliente, cobrança, régua, etapa, acordo, disputa e demais termos como aparecem na interface. - [Conceitos](https://docs.dunning.com.br/pt/primeiros-passos/conceitos.md): Glossário do Dunning em uma página: cliente, cobrança, régua, etapa, acordo, disputa e demais termos como aparecem na interface. #### primeira-cobranca Passo a passo para criar o primeiro cliente, registrar uma cobrança e ver a régua de cobrança assumir o trabalho, em cinco minutos. - [Sua primeira cobrança](https://docs.dunning.com.br/pt/primeiros-passos/primeira-cobranca.md): Passo a passo para criar o primeiro cliente, registrar uma cobrança e ver a régua de cobrança assumir o trabalho, em cinco minutos. #### visao-geral Visão geral do Dunning: como a régua acompanha cada cobrança do vencimento ao pagamento e o que fica sob responsabilidade do operador. - [Visão geral](https://docs.dunning.com.br/pt/primeiros-passos/visao-geral.md): Visão geral do Dunning: como a régua acompanha cada cobrança do vencimento ao pagamento e o que fica sob responsabilidade do operador. ### regua-de-cobranca - [Régua de Cobrança](https://docs.dunning.com.br/pt/regua-de-cobranca.md) #### campanhas-de-negociacao Uma campanha de negociação é um desconto reutilizável que o portal do devedor oferece automaticamente — sem o operador precisar criar proposta por proposta. Você define o desconto, o parcelamento máximo e, opcionalmente, a faixa de atraso em que a campanha vale; o portal faz o resto. - [Campanhas de negociação](https://docs.dunning.com.br/pt/regua-de-cobranca/campanhas-de-negociacao.md): Uma campanha de negociação é um desconto reutilizável que o portal do devedor oferece automaticamente — sem o operador precisar criar proposta por proposta. Você define o desconto, o parcelamento máximo e, opcionalmente, a faixa de atraso em que a campanha vale; o portal faz o resto. #### como-funciona Uma régua de cobrança é uma sequência de etapas ancoradas no vencimento da cobrança: um lembrete 3 dias antes, um aviso no dia, um e-mail firme 5 dias depois, uma oferta de acordo aos 15, e assim por diante. Você desenha a sequência uma vez e o motor executa para cada cobrança, todos os dias, sem ninguém precisar lembrar de nada. - [Como funciona](https://docs.dunning.com.br/pt/regua-de-cobranca/como-funciona.md): Uma régua de cobrança é uma sequência de etapas ancoradas no vencimento da cobrança: um lembrete 3 dias antes, um aviso no dia, um e-mail firme 5 dias depois, uma oferta de acordo aos 15, e assim por diante. Você desenha a sequência uma vez e o motor executa para cada cobrança, todos os dias, sem ninguém precisar lembrar de nada. #### compliance-de-contato Esta é a garantia central do produto dependendo da UF, é infração legal. - [Compliance de contato](https://docs.dunning.com.br/pt/regua-de-cobranca/compliance-de-contato.md): Esta é a garantia central do produto dependendo da UF, é infração legal. #### etapas-e-canais Cada etapa da régua responde três perguntas: quando disparar (gatilho), o que fazer (ação) e por onde falar (canais). Esta página detalha as opções de cada uma. - [Etapas e canais](https://docs.dunning.com.br/pt/regua-de-cobranca/etapas-e-canais.md): Cada etapa da régua responde três perguntas: quando disparar (gatilho), o que fazer (ação) e por onde falar (canais). Esta página detalha as opções de cada uma. #### templates-e-variaveis Templates são as mensagens que as etapas da régua enviam. Cada template pertence a um canal (e-mail, SMS, WhatsApp, voz), tem uma categoria, um tom e um corpo com variáveis que o motor substitui pelos dados reais da cobrança na hora do envio. - [Templates e variáveis](https://docs.dunning.com.br/pt/regua-de-cobranca/templates-e-variaveis.md): Templates são as mensagens que as etapas da régua enviam. Cada template pertence a um canal (e-mail, SMS, WhatsApp, voz), tem uma categoria, um tom e um corpo com variáveis que o motor substitui pelos dados reais da cobrança na hora do envio. #### versoes-e-publicacao Régua de cobrança muda: você ajusta um texto, adiciona uma etapa, muda um offset. O que não pode mudar é o plano de quem já está no meio do fluxo — nem a sua capacidade de provar, meses depois, exatamente qual sequência valia quando aquele devedor foi cobrado. É para isso que existem versões. - [Versões e publicação](https://docs.dunning.com.br/pt/regua-de-cobranca/versoes-e-publicacao.md): Régua de cobrança muda: você ajusta um texto, adiciona uma etapa, muda um offset. O que não pode mudar é o plano de quem já está no meio do fluxo — nem a sua capacidade de provar, meses depois, exatamente qual sequência valia quando aquele devedor foi cobrado. É para isso que existem versões. ### webhooks #### entregas-e-retry Nenhuma entrega é "dispara e esquece". Cada evento × endpoint vira um registro de entrega com status, tentativas e a captura completa de request e response — o que transforma "o webhook não chegou" de mistério em consulta. - [Entregas e retry](https://docs.dunning.com.br/pt/webhooks/entregas-e-retry.md): Nenhuma entrega é "dispara e esquece". Cada evento × endpoint vira um registro de entrega com status, tentativas e a captura completa de request e response — o que transforma "o webhook não chegou" de mistério em consulta. #### eventos Catálogo completo dos eventos emitidos. O nome segue o padrão .; o campo data do payload traz o recurso serializado no formato da API v1 ou um objeto de referência enxuto (documentado por evento). Um endpoint com a lista de eventos vazia recebe todos, inclusive eventos futuros. - [Eventos](https://docs.dunning.com.br/pt/webhooks/eventos.md): Catálogo completo dos eventos emitidos. O nome segue o padrão .; o campo data do payload traz o recurso serializado no formato da API v1 ou um objeto de referência enxuto (documentado por evento). Um endpoint com a lista de eventos vazia recebe todos, inclusive eventos futuros. - [Eventos de acordo (agreement.*)](https://docs.dunning.com.br/pt/webhooks/eventos/agreement.md): Fatos do ciclo de vida dos acordos de negociação. Nos eventos de entidade, data é o acordo com o cliente resumido (person) e, quando já geradas, as parcelas (installments). - [Eventos de cobrança (charge.*)](https://docs.dunning.com.br/pt/webhooks/eventos/charge.md): Fatos do ciclo de vida das cobranças. Nos eventos de entidade, data é a cobrança serializada no formato da API v1, com person e collectionRule completos embutidos. Nos eventos de fato (paid, overdue), data é um objeto de referência enxuto. - [Eventos de classificação (classification.*)](https://docs.dunning.com.br/pt/webhooks/eventos/classification.md): Categorias de cliente (ex.: bom pagador, atraso recorrente) que direcionam as réguas. Nos eventos de entidade, data é a classificação completa com contadores de uso (_count). - [Eventos de régua de cobrança (collection_rule.*)](https://docs.dunning.com.br/pt/webhooks/eventos/collection-rule.md): Configuração das réguas. Nos eventos de entidade, data é a régua com a classification vinculada e os steps ordenados por posição. - [Eventos de disputa (dispute.*)](https://docs.dunning.com.br/pt/webhooks/eventos/dispute.md): Contestações abertas pelo devedor (ou registradas pelo operador). Abrir uma disputa pausa a régua da cobrança na hora. Em todos os eventos, data é a disputa completa. - [Eventos de interação (interaction.*)](https://docs.dunning.com.br/pt/webhooks/eventos/interaction.md): Registros da timeline de contato com o cliente (ligações, e-mails, notas). data é a interação completa com person, user (quem registrou) e charge resumidos. - [Eventos de negativação (negativation.*)](https://docs.dunning.com.br/pt/webhooks/eventos/negativation.md): Registro do devedor nos bureaus de crédito. Toda negativação disparada pela régua passa por revisão humana obrigatória antes de ser efetivada. data é sempre um objeto de referência enxuto. - [Eventos de notificação (notification.*)](https://docs.dunning.com.br/pt/webhooks/eventos/notification.md): Ciclo de vida das mensagens enviadas ao devedor pela régua (e-mail, SMS, WhatsApp...). O data é sempre um objeto de referência enxuto — o recurso completo está em GET /api/v1/notifications/. - [Eventos de cliente (person.*)](https://docs.dunning.com.br/pt/webhooks/eventos/person.md): Fatos do cadastro de clientes (devedores). Nos eventos de entidade, data é o cliente serializado no formato da API v1 de clientes, com a classificação resumida embutida. - [Eventos de protesto (protest.*)](https://docs.dunning.com.br/pt/webhooks/eventos/protest.md): Protesto de títulos em cartório. Como na negativação, todo protesto disparado pela régua passa por revisão humana obrigatória antes de ser enviado. data é sempre um objeto de referência enxuto. - [Eventos de tarefa (task.*)](https://docs.dunning.com.br/pt/webhooks/eventos/task.md): Tarefas manuais da operação (criadas por operadores ou pela régua — ex.: revisão de negativação/protesto). Nos eventos de entidade, data é a tarefa com person, assignedTo e charge resumidos. - [Eventos de template (template.*)](https://docs.dunning.com.br/pt/webhooks/eventos/template.md): Templates de mensagem usados pelos passos da régua. Nos eventos de entidade, data é o template completo (sem relações). - [Evento de teste (webhook.test)](https://docs.dunning.com.br/pt/webhooks/eventos/webhook-test.md): Disparado sob demanda via POST /api/v1/webhook-endpoints//test — não é assinável e não aparece no catálogo de assinatura. A entrega percorre o pipeline real (fila, assinatura HMAC, captura de request/response, retry) e é enviada somente ao endpoint alvo, independente da lista de eventos assinados. #### seguranca Duas camadas protegem a comunicação: a assinatura HMAC (prova que o payload veio do Dunning e não foi adulterado) e a autenticação do request (credenciais que o Dunning apresenta ao seu endpoint). A primeira vai sempre; a segunda é opcional. - [Segurança](https://docs.dunning.com.br/pt/webhooks/seguranca.md): Duas camadas protegem a comunicação: a assinatura HMAC (prova que o payload veio do Dunning e não foi adulterado) e a autenticação do request (credenciais que o Dunning apresenta ao seu endpoint). A primeira vai sempre; a segunda é opcional. #### visao-geral Visão geral dos webhooks: receba os fatos de negócio do Dunning como POST JSON, com assinatura HMAC, entrega persistida e retry automático. - [Visão geral](https://docs.dunning.com.br/pt/webhooks/visao-geral.md): Visão geral dos webhooks: receba os fatos de negócio do Dunning como POST JSON, com assinatura HMAC, entrega persistida e retry automático.