Pular para o conteúdo principal

Documentos gerados (PDF)

A plataforma gera dois documentos jurídicos em PDF a partir dos dados da própria operação, sem retrabalho de digitação: o termo de acordo e a carta de quitação. Ambos saem prontos com o cabeçalho do credor (nome, documento e logo da organização), a identificação das partes e um texto padrão. Além deles, há um documento operacional — o extrato do devedor — com a posição de todas as cobranças de uma pessoa.

Termo de acordo​

O termo formaliza um acordo de parcelamento. Ele reúne:

  • Partes: credor (a organização) e devedor, com nome e documento.
  • Resumo do acordo: valor original, desconto concedido, valor final, número e valor das parcelas e o primeiro vencimento.
  • Tabela de parcelas: número, vencimento, valor e status de cada parcela.
  • Cobranças renegociadas: quando o acordo nasce de uma oferta de negociação, o título de origem aparece listado.
  • Texto jurídico: reconhecimento da dívida, compromisso de pagamento nas datas ajustadas e as consequências do inadimplemento, além da data de proposta ou de aceite.

O termo pode ser gerado em qualquer estado do acordo (proposto, aceito, ativo etc.); o cabeçalho reflete o status atual.

Carta de quitação​

A carta declara, para os devidos fins de direito, que o devedor quitou integralmente um débito. Ela traz as partes, a referência do débito (número do documento e descrição), o valor pago e a data do pagamento, com a cláusula de quitação ampla, geral e irrevogável.

:::warning Só para débito pago A carta de quitação só é emitida quando a cobrança está paga (status paid). Para uma cobrança em aberto, a geração é recusada com erro 409 (CHARGE_NOT_SETTLED): não se declara quitação de um débito que ainda não foi liquidado. :::

Extrato do devedor​

O extrato reúne, num único PDF, a posição de todas as cobranças de uma pessoa — útil para enviar ao devedor um retrato completo do que ele deve. Ele traz as partes (credor e devedor) e uma tabela com cada cobrança (documento, vencimento, status, valor original e valor atual), com os vencidos destacados, fechando com os totais: em aberto, vencido e já pago.

Diferente da carta de quitação, o extrato pode ser gerado a qualquer momento, independentemente do status das cobranças.

Como obter os PDFs​

Hoje os documentos são gerados pela API (não há botão de download nas telas do dashboard):

  • Termo de acordo (operador): GET /api/v1/agreements/{id}/pdf. Exige permissão de leitura de acordos e é escopado pela organização da sessão.
  • Termo de acordo (devedor): GET /api/portal-account/agreements/{id}/pdf, para o devedor autenticado na conta do portal, limitado aos próprios acordos.
  • Carta de quitação (operador): GET /api/v1/charges/{id}/settlement-pdf. Exige permissão de leitura de cobranças e retorna 409 se o débito não estiver quitado.
  • Extrato do devedor (operador): GET /api/v1/people/{id}/statement-pdf. Exige permissão de leitura de pessoas e é escopado pela organização. Também disponível pelo botão Extrato na tela de detalhe do cliente.

Cada rota responde com o PDF como anexo binário (Content-Type: application/pdf), pronto para download ou para anexar em um e-mail ao devedor.