get https://evo-integracao-api.w12app.com.br/api/v2/membermembership
Permite obter resumo de contratos de alunos cancelados.
Obter Contratos de Membros
Descrição
Permite obter uma lista de contratos de membros com base em vários critérios de filtragem, incluindo períodos de registro e cancelamento, tipos de contratos e categorias.
Parâmetros de Consulta (Query Parameters)
Parâmetro | Tipo | Obrigatório | Descrição |
---|---|---|---|
idMember | int32 | Não | ID do membro para filtrar os contratos. |
idMembership | int32 | Não | ID do tipo de contrato para filtrar os resultados. |
memberName | string | Não | Nome do membro para filtrar os contratos. |
registerDateStart | date-time | Não | Data inicial do registro no formato ISO 8601 (YYYY-MM-DDTHH:mm:ssZ ). |
registerDateEnd | date-time | Não | Data final do registro no formato ISO 8601 (YYYY-MM-DDTHH:mm:ssZ ). |
cancelDateStart | date-time | Não | Data inicial de cancelamento no formato ISO 8601 (YYYY-MM-DDTHH:mm:ssZ ). |
cancelDateEnd | date-time | Não | Data final de cancelamento no formato ISO 8601 (YYYY-MM-DDTHH:mm:ssZ ). |
showTransfers | boolean | Não | Filtra para mostrar contratos transferidos. Valor padrão é false . |
showAggregators | boolean | Não | Filtra para mostrar contratos agregadores. Valor padrão é false . |
showVips | boolean | Não | Filtra para mostrar contratos de categoria VIP. Valor padrão é false . |
contractType | string | Não | Filtra pelos tipos de contrato, separados por vírgula. Consulte a tabela de tipos abaixo. |
take | int32 | Não | Número total de registros a serem retornados. Valor padrão é 25 . Máximo permitido: 25 . |
skip | int32 | Não | Número total de registros a serem ignorados (para paginação). Valor padrão é 0 . |
Tipos de Contrato
Código | Descrição |
---|---|
1 | Comum |
3 | Extensão de Plano |
4 | Extensão de Bloqueio |
5 | Mensal Recorrente |
6 | Recorrente Mensal com Validade |
7 | Mensal Recorrente com Renovação Automática |
8 | Dependente Adicional |
9 | Anual com Data de Término Específica |
10 | Contrato Adicional |