Obtener Contratos de Miembros

Descripción

Permite obtener una lista de contratos de miembros basados en varios criterios de filtrado, incluyendo períodos de registro y cancelación, tipos de contratos y categorías.

🔑 Parámetros de Consulta (Query Params)

Parámetro	Tipo	Obligatorio	Descripción
`idMember`	int32	No	ID del miembro para filtrar los contratos.
`idMembership`	int32	No	ID del tipo de contrato para filtrar los resultados.
`memberName`	string	No	Nombre del miembro para filtrar los contratos.
`registerDateStart`	date-time	No	Fecha inicial del registro en formato ISO 8601 (`YYYY-MM-DDTHH:mm:ssZ`).
`registerDateEnd`	date-time	No	Fecha final del registro en formato ISO 8601 (`YYYY-MM-DDTHH:mm:ssZ`).
`cancelDateStart`	date-time	No	Fecha inicial de cancelación en formato ISO 8601 (`YYYY-MM-DDTHH:mm:ssZ`).
`cancelDateEnd`	date-time	No	Fecha final de cancelación en formato ISO 8601 (`YYYY-MM-DDTHH:mm:ssZ`).
`showTransfers`	boolean	No	Filtra para mostrar contratos transferidos. Valor por defecto: `false`.
`showAggregators`	boolean	No	Filtra para mostrar contratos agregadores. Valor por defecto: `false`.
`showVips`	boolean	No	Filtra para mostrar contratos de categoría VIP. Valor por defecto: `false`.
`contractType`	string	No	Filtra por tipos de contrato, separados por coma. Consulte la tabla de tipos abajo.
`statusMemberMembership`	int32	No	Filtra por el estado de los contratos. `1` - Activo, `2` - Cancelado.
`take`	int32	No	Número total de registros a devolver. Valor por defecto: `25`. Máximo: `25`.
`skip`	int32	No	Número total de registros a ignorar (paginación). Valor por defecto: `0`.

🔷 Enum de `contractType`

Código	Descripción
1	Común
3	Extensión de Plan
4	Extensión de Bloqueo
5	Mensual Recurrente
6	Recurrente Mensual con Validez
7	Mensual Recurrente con Renovación Automática
8	Dependiente Adicional
9	Anual con Fecha de Finalización Específica
10	Contrato Adicional

📤 Estructura de la Respuesta

Campo	Tipo	Descripción
idMember	int32	ID del miembro.
name	string	Nombre del miembro.
idMembership	int32	ID del membership asociado.
idMemberMemberShip	int32	ID del vínculo del miembro con el membership.
idBranch	int32	ID de la filial asociada al membership.
numMembers	int32	Total de miembros vinculados (titular + dependientes).
idSale	int32	ID de la venta correspondiente al membership.
saleValue	number	Valor total de la venta.
nameMembership	string	Nombre del plan/membership.
membershipStart	date-time	Fecha de inicio del membership.
membershipEnd	date-time	Fecha de finalización del membership.
registerCancelDate	date-time	Fecha de registro de cancelación.
cancelDate	date-time	Fecha efectiva de cancelación.
reasonCancellation	string	Motivo de la cancelación.
saleDate	date-time	Fecha de la venta.
cancellationFine	number	Valor de la multa de cancelación (si aplica).
remainingValue	number	Valor restante a pagar.
receivables	array	Lista de recibos relacionados al membership. Ver objeto `receivables[]`.
minPeriodStayMembership	int32	Período mínimo de permanencia del membership (en días).
membershipTrasnferData	object	Datos sobre transferencia del membership. Ver objeto `membershipTrasnferData`.
membershipSwapData	object	Datos sobre intercambio (swap) del membership. Ver objeto `membershipSwapData`.
idMemberMigration	string	ID del miembro tras migración (si aplica).
idSaleMigration	string	ID de la venta generada por la migración.
idMembershipCategory	int32	ID de la categoría del membership.
memberDocument	string	Documento del miembro relacionado al plan.
statusMemberMembership	int32	Estado del contrato. `1` - Activo, `2` - Cancelado.

🧩 Estructura del array de objetos `receivables`

Campo	Tipo	Descripción
idReceivable	int32	ID del recibo.
description	string	Descripción del recibo.
ammount	number	Valor total a recibir.
ammountPaid	number	Valor ya pagado.
currentInstallment	int32	Cuota actual.
totalInstallments	int32	Número total de cuotas.
tid	string	TID de la transacción.
nsu	string	NSU de la transacción.
authorization	string	Código de autorización de la transacción.
canceled	boolean	Indica si el recibo fue cancelado.
cancellationDate	date-time	Fecha de cancelación del recibo.
cancellationDescription	string	Motivo/descripción de la cancelación.
registrationDate	date-time	Fecha de registro del recibo.
dueDate	date-time	Fecha de vencimiento de la cuota.
receivingDate	date-time	Fecha de recepción/pago.
paymentType	object	Tipo de pago utilizado. Ver objeto `receivables[].paymentType`.

🧩 Estructura del objeto `receivables[].paymentType`

Campo	Tipo	Descripción
id	int32	ID del tipo de pago.
name	string	Nombre del tipo de pago (ej.: Crédito, Débito, PIX).

🧩 Estructura del objeto `membershipTrasnferData`

Campo	Tipo	Descripción
flTransfer	boolean	Indica si hubo transferencia del membership.
idMemberTransfer	int32	ID del miembro al que se transfirió el membership.
idMemberMembershipTransfer	int32	ID del vínculo transferido.

🧩 Estructura del objeto `membershipSwapData`

Campo	Tipo	Descripción
flMembershipSwapped	boolean	Indica si el membership fue intercambiado (swapped).
idMemberMembershipSource	int32	ID del membership original antes del intercambio.

Basic Auth

Envie suas requisições HTTP com um cabeçalho

Authorization

que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:password

Exemplo:

Authorization: Basic *****************

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200OK

application/json

Success

Body

Exemplo

[
    {
        "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
    }
]

🟠400Bad Request

Get summary of MemberMemberships (active, canceled, or specific types).

Obtener Contratos de Miembros#

Descripción#

🔑 Parámetros de Consulta (Query Params)#

🔷 Enum de contractType#

📤 Estructura de la Respuesta#

🧩 Estructura del array de objetos receivables#

🧩 Estructura del objeto receivables[].paymentType#

🧩 Estructura del objeto membershipTrasnferData#

🧩 Estructura del objeto membershipSwapData#

Requisição