Quyta
Quyta
Esta documentação detalha os endpoints disponíveis na API REST da Quyta. Pelo playground é possível gerar o código das requisições em diversas linguagens (PHP, Java, Ruby, entre muitas outras).
A comunicação parte sempre do endereço base https://app.quyta.com.br/api/v1, sob HTTPS.
Atenção: antes de continuar, confira as configurações de autenticação. Em caso de dúvida, veja Autenticação.
Tags
Clientes
Devedores (pessoa física ou jurídica) cadastrados na sua conta. Um cliente precisa existir antes de qualquer dívida ser criada para ele.
Grupos de Dívidas
Carteiras que agrupam dívidas com a mesma régua de cobrança. São criados no painel da Quyta e apenas consultados pela API.
Dívidas
Os títulos em aberto que a Quyta cobra. É o recurso central da API: toda a régua de cobrança e os acordos são construídos a partir das dívidas enviadas aqui.
Acordos
As negociações fechadas com o devedor, com as parcelas geradas e as dívidas que cada acordo quita. São criados pela Quyta — no painel ou pelo portal do cliente — e apenas consultados pela API.
Metas
Alvos de recuperação da equipe ou de um coletor, em valor negociado ou quantidade de acordos. A situação (SCHEDULED, ACTIVE, CLOSED) é derivada das datas e do encerramento — não há coluna de status.
Webhooks
debt.created
Dívida Criada
POST
debt.held
Cobrança Pausada
POST
debt.reactivated
Cobrança Reativada
POST
debt.archived
Dívida Arquivada
POST
debt.unarchived
Dívida Desarquivada
POST
customer.created
Cliente Criado
POST
contract.created
Acordo Criado
POST
contract.terminated
Acordo Quebrado
POST
contract.settled
Acordo Liquidado
POST
contract.installment.paid
Parcela Paga
POST