🌐 API Reference/Management
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.OBS. Disponível para uso com chave de acesso de filial e também com chave de acesso de ADM Geral.
🔑 Parâmetros de Consulta (Query Param)#
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
| dtStart | string(date-time) | Sim | Data inicial do período a ser consultado. |
| dtEnd | string(date-time) | Sim | Data 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.🚧 O retorno desse endpoint é em em XML. Ou seja, você não receberá um json comum.
| Campo | Tipo | Descrição |
|---|
| idFilial | int32 | Identificador da filial. |
| nomeFilial | string | Nome da filial. |
| idCliente | int32 | Identificador do cliente. |
| status | string | Status do contrato ou cliente. |
| contratoAtivo | string | Indica se o contrato estava ativo antes do término. |
| nome | string | Nome do cliente. |
| sobrenome | string | Sobrenome do cliente. |
| contratoVencido | string | Indica se o contrato venceu no período informado. |
| dataInicio | string(date-time) | Data de início do contrato. |
| dataFim | string(date-time) | Data de término do contrato. |
| mesesPermanencia | int32 | Quantidade de meses de permanência do contrato. |
| valor | decimal | Valor do contrato. |
| flCancelado | boolean | Indica se o contrato foi cancelado. |
| dtCancelamento | string(date-time) | Data de cancelamento do contrato (se aplicável). |
| contratoCancelado | string | Descrição do contrato cancelado. |
| motivoCancelamento | string | Motivo do cancelamento informado. |
| nomeConsultor | string | Nome do consultor responsável pelo cliente. |
| celular | string | Telefone do cliente. |
| email | string | Email do cliente. |
Request
Send your HTTP requests with an Authorization
header that contains the word Basic followed by a space and a base64-encoded string username:password Example:Authorization: Basic *****************
or
Responses
This response does not have a body.
curl --location 'https://evo-integracao-api.w12app.com.br/api/v2/management/not-renewed?dtStart=undefined&dtEnd=undefined' \
--header 'Authorization: Basic <encoded-value>'
Response Response Example
{
"mensagens": [
"string"
]
}
Modified at 2026-05-15 04:38:45