Get non-renewed clients

Buscar Clientes Não-Renovados

Descrição

Este endpoint retorna a lista de clientes que não renovaram seus contratos em um período específico. É útil para acompanhamento de inadimplência, cancelamentos ou análise de retenção de clientes.

🔑 Estrutura de Requisição (Query Param)

ParâmetroTipoObrigatórioDescrição
dtStartstring(date-time)SimData inicial do período a ser consultado.
dtEndstring(date-time)SimData final do período a ser consultado.

📤 Estrutura de Resposta

A resposta retorna uma lista de clientes com contratos não renovados e informações detalhadas sobre cada registro.

CampoTipoDescrição
idFilialint32Identificador da filial.
nomeFilialstringNome da filial.
idClienteint32Identificador do cliente.
statusstringStatus do contrato ou cliente.
contratoAtivostringIndica se o contrato estava ativo antes do término.
nomestringNome do cliente.
sobrenomestringSobrenome do cliente.
contratoVencidostringIndica se o contrato venceu no período informado.
dataIniciostring(date-time)Data de início do contrato.
dataFimstring(date-time)Data de término do contrato.
mesesPermanenciaint32Quantidade de meses de permanência do contrato.
valordecimalValor do contrato.
flCanceladobooleanIndica se o contrato foi cancelado.
dtCancelamentostring(date-time)Data de cancelamento do contrato (se aplicável).
contratoCanceladostringDescrição do contrato cancelado.
motivoCancelamentostringMotivo do cancelamento informado.
nomeConsultorstringNome do consultor responsável pelo cliente.
celularstringTelefone do cliente.
emailstringEmail do cliente.

✅ Exemplo de Resposta

[
  {
    "idFilial": 10,
    "nomeFilial": "Filial Centro",
    "idCliente": 12345,
    "status": "Contrato Vencido",
    "contratoAtivo": "Não",
    "nome": "João",
    "sobrenome": "Silva",
    "contratoVencido": "Sim",
    "dataInicio": "2024-10-01T00:00:00Z",
    "dataFim": "2025-09-30T23:59:59Z",
    "mesesPermanencia": 12,
    "valor": 1200.00,
    "flCancelado": true,
    "dtCancelamento": "2025-09-30T15:30:00Z",
    "contratoCancelado": "Contrato Anual",
    "motivoCancelamento": "Mudança de cidade",
    "nomeConsultor": "Maria Oliveira",
    "celular": "+5511999999999",
    "email": "[email protected]"
  }
]
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!