Get summary of MemberMemberships (active, canceled, or specific types).
GET
https://evo-integracao-api.w12app.com.br/api/v3/membermembership
🌐 API Reference/MemberMembership
Obter Contratos de Membros
Descrição
🔑 Parâmetros de Consulta (Query Params)
| 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. |
statusMemberMembership | int32 | Não | Filtra pelos status dos contratos. 1 - Ativo, 2 - Cancelado. |
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. |
🔷 Enum de contractType
| 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 |
📤 Estrutura da Resposta
| Campo | Tipo | Descrição |
|---|---|---|
| idMember | int32 | ID do membro. |
| name | string | Nome do membro. |
| idMembership | int32 | ID do membership associado. |
| idMemberMemberShip | int32 | ID do vínculo do membro com o membership. |
| idBranch | int32 | ID da filial associada ao membership. |
| numMembers | int32 | Total de membros vinculados (titular + dependentes). |
| idSale | int32 | ID da venda referente ao membership. |
| saleValue | number | Valor total da venda. |
| nameMembership | string | Nome do plano/membership. |
| membershipStart | date-time | Data de início do membership. |
| membershipEnd | date-time | Data de término do membership. |
| registerCancelDate | date-time | Data de registro do cancelamento. |
| cancelDate | date-time | Data efetiva do cancelamento. |
| reasonCancellation | string | Motivo do cancelamento. |
| saleDate | date-time | Data da venda. |
| cancellationFine | number | Valor da multa de cancelamento (se aplicável). |
| remainingValue | number | Valor restante a ser pago. |
| receivables | array | Lista de recebíveis relacionados ao membership. Ver objeto receivables[]. |
| minPeriodStayMembership | int32 | Período mínimo de permanência do membership (em dias). |
| membershipTrasnferData | object | Dados sobre transferência do membership. Ver objeto membershipTrasnferData. |
| membershipSwapData | object | Dados sobre troca (swap) do membership. Ver objeto membershipSwapData. |
| idMemberMigration | string | ID do membro após migração (se aplicável). |
| idSaleMigration | string | ID da venda gerada pela migração. |
| idMembershipCategory | int32 | ID da categoria do membership. |
| memberDocument | string | Documento do membro relacionado ao plano. |
| statusMemberMembership | int32 | Status do contrato. 1 - Ativo, 2 - Cancelado. |
🧩 Estrutura do array de objetos receivables
| Campo | Tipo | Descrição |
|---|---|---|
| idReceivable | int32 | ID do recebível. |
| description | string | Descrição do recebível. |
| ammount | number | Valor total a receber. |
| ammountPaid | number | Valor já pago. |
| currentInstallment | int32 | Parcela atual. |
| totalInstallments | int32 | Número total de parcelas. |
| tid | string | TID da transação. |
| nsu | string | NSU da transação. |
| authorization | string | Código de autorização da transação. |
| canceled | boolean | Indica se o recebível foi cancelado. |
| cancellationDate | date-time | Data do cancelamento do recebível. |
| cancellationDescription | string | Motivo/descrição do cancelamento. |
| registrationDate | date-time | Data de registro do recebível. |
| dueDate | date-time | Data de vencimento da parcela. |
| receivingDate | date-time | Data de recebimento/pagamento. |
| paymentType | object | Tipo de pagamento utilizado. Ver objeto receivables[].paymentType. |
🧩 Estrutura do objeto receivables[].paymentType
| Campo | Tipo | Descrição |
|---|---|---|
| id | int32 | ID do tipo de pagamento. |
| name | string | Nome do tipo de pagamento (ex.: Crédito, Débito, PIX). |
🧩 Estrutura do objeto membershipTrasnferData
| Campo | Tipo | Descrição |
|---|---|---|
| flTransfer | boolean | Indica se houve transferência do membership. |
| idMemberTransfer | int32 | ID do membro para o qual o membership foi transferido. |
| idMemberMembershipTransfer | int32 | ID do vínculo transferido. |
🧩 Estrutura do objeto membershipSwapData
| Campo | Tipo | Descrição |
|---|---|---|
| flMembershipSwapped | boolean | Indica se o membership foi trocado (swapped). |
| idMemberMembershipSource | int32 | ID do membership original antes da troca. |
Request
Query Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://evo-integracao-api.w12app.com.br/api/v3/membermembership?idMember=undefined&idMembership=undefined&memberName=undefined®isterDateStart=undefined®isterDateEnd=undefined&cancelDateStart=undefined&cancelDateEnd=undefined&showTransfers=undefined&showAggregators=undefined&showVips=undefined&contractType=undefined&statusMemberMembership=undefined&take=undefined&skip=undefined' \
--header 'Authorization: Basic <encoded-value>'Response Response Example
200 - Example 1
[
{
"idMember": 0,
"name": "string",
"idMembership": 0,
"idMemberMemberShip": 0,
"idBranch": 0,
"numMembers": 0,
"idSale": 0,
"saleValue": 0,
"nameMembership": "string",
"membershipStart": "2019-08-24T14:15:22.123Z",
"membershipEnd": "2019-08-24T14:15:22.123Z",
"registerCancelDate": "2019-08-24T14:15:22.123Z",
"cancelDate": "2019-08-24T14:15:22.123Z",
"reasonCancellation": "string",
"saleDate": "2019-08-24T14:15:22.123Z",
"cancellationFine": 0,
"remainingValue": 0,
"receivables": [
{
"idReceivable": 0,
"description": "string",
"ammount": 0,
"ammountPaid": 0,
"currentInstallment": 0,
"totalInstallments": 0,
"tid": "string",
"nsu": "string",
"authorization": "string",
"canceled": true,
"cancellationDate": "2019-08-24T14:15:22.123Z",
"cancellationDescription": "string",
"registrationDate": "2019-08-24T14:15:22.123Z",
"dueDate": "2019-08-24T14:15:22.123Z",
"receivingDate": "2019-08-24T14:15:22.123Z",
"paymentType": {
"id": 0,
"name": "string"
}
}
],
"minPeriodStayMembership": 0,
"membershipTrasnferData": {
"flTransfer": true,
"idMemberTransfer": 0,
"idMemberMembershipTransfer": 0
},
"membershipSwapData": {
"flMembershipSwapped": true,
"idMemberMembershipSource": 0
},
"idMemberMigration": "string",
"idSaleMigration": "string",
"idMembershipCategory": 0,
"memberDocument": "string",
"statusMemberMembership": 0
}
]Modified at 2026-05-15 04:38:45