Recuperar Contratos / Planes

Descripción

Este endpoint permite consultar los contratos/planes disponibles, con opciones de filtrado por nombre, sucursal, fecha de actualización, entre otros. También es posible incluir información adicional, como grupos de actividades, observaciones de venta online y sucursales con acceso.

OBS. Disponible para uso con clave de acceso de sucursal y también con clave de acceso de ADM General.

🔑 Parámetros de Consulta

Parámetro	Tipo	Obligatorio	Descripción
idMembership	int	No	Filtra por el ID del membership específico.
name	string	No	Filtra por el nombre del contrato.
idBranch	int	No	Filtra por el ID de la sucursal. Ignorado si la clave de API no es multifilial.
take	int	No	Número total de registros a retornar (máximo: 50). Predeterminado: 25.
skip	int	No	Cantidad de registros a ignorar (para paginación). Predeterminado: 0.
active	boolean	No	Filtra por contratos activos o inactivos.
updateDate	string (ISO)	No	Filtra contratos actualizados a partir de esta fecha (`yyyy-mm-dd`).
showAccessBranches	boolean	No	Muestra las sucursales en las que el contrato garantiza acceso. Predeterminado: `false`.
showOnlineSalesObservation	boolean	No	Muestra observaciones relacionadas con la venta online. Predeterminado: `false`.
showActivitiesGroups	boolean	No	Muestra los grupos de actividades vinculados al plan/contrato. Predeterminado: `false`.

📤 Estructura de la Respuesta

La respuesta retorna los datos completos de un plan, incluyendo información comercial, reglas de cobro, servicios adicionales, grupos de actividades, sucursales asociadas, entradas, páginas de venta y configuraciones de elegibilidad.

Campo	Tipo	Descripción
`idMembership`	int32	Identificador único del plan.
`idBranch`	int32	ID de la sucursal asociada al plan.
`nameMembership`	string	Nombre del plan.
`membershipType`	string	Tipo de plan.
`durationType`	string	Tipo de duración del plan (ej.: mensual, anual).
`duration`	int32	Duración del plan según el tipo definido.
`updateDate`	date-time	Fecha de última actualización del plan.
`value`	number (double)	Valor del plan.
`maxAmountInstallments`	int32	Cantidad máxima de cuotas permitidas.
`description`	string	Descripción detallada del plan.
`urlSale`	string (read-only)	URL pública para venta del plan.
`onlineSalesObservations`	string	Observaciones mostradas en la venta online.
`diferentials`	arrayobject	Lista de diferenciales asociados al plan.
`accessBranches`	arrayobject	Sucursales donde el plan es válido.
`additionalService`	arrayobject	Servicios adicionales vinculados al plan.
`serviceYearly`	arrayobject	Servicios anuales asociados al plan.
`typePromotionalPeriod`	int32	Tipo de período promocional aplicado al plan o servicio.
`valuePromotionalPeriod`	number	Valor aplicado durante el período promocional.
`monthsPromotionalPeriod`	int32	Cantidad de meses de duración del período promocional.
`daysPromotionalPeriod`	int32	Cantidad de días de duración del período promocional.
`minPeriodStayMembership`	int32	Período mínimo de permanencia en el plan.
`installmentsPromotionalPeriod`	int32	Cantidad de cuotas permitidas durante el período promocional.
`activitiesGroups`	arrayobject	Grupos de actividades vinculados al plan.
`inactive`	boolean	Indica si el plan está inactivo.
`displayName`	string	Nombre de visualización formateado del plan.
`entries`	arrayobject	Configuración de entradas permitidas por el plan.
`salesPage`	arrayobject	Páginas de venta asociadas al plan.
`allowsCancellationByApp`	boolean	Indica si el plan puede cancelarse desde la app.
`externalSaleAvailable`	boolean	Indica si el plan puede venderse externamente.
`acceptEnrollment`	boolean	Indica si acepta inscripción directa.
`enrollmentRequired`	boolean	Indica si requiere inscripción obligatoria.

🧩 Estructura de `diferentials`

Campo	Tipo	Descripción
`title`	string	Título del diferencial.
`order`	int32	Orden de visualización.

🧩 Estructura de `accessBranches`

Campo	Tipo	Descripción
`idBranch`	int32	Identificador de la sucursal a la que el miembro tiene acceso.
`name`	string	Nombre de la sucursal a la que el miembro tiene acceso.

🧩 Estructura de `additionalService`

Campo	Tipo	Descripción
`idService`	int32	Identificador del servicio adicional.
`name`	string	Nombre del servicio adicional.
`value`	number	Valor del servicio adicional.

🧩 Estructura de `serviceYearly`

Campo	Tipo	Descripción
`idService`	int32	ID del servicio anual.
`name`	string	Nombre del servicio anual.
`value`	number (double)	Valor del servicio anual.
`type`	int32	Tipo de cobro del servicio.
`billingMonth`	int32	Mes de facturación.
`billingDay`	int32	Día de facturación.
`billingAfterMonths`	int32	Meses después de la contratación para facturación.
`installments`	int32	Cantidad de cuotas.
`typePromotionalPeriod`	int32	Tipo de período promocional.
`valuePromotionalPeriod`	number (double)	Valor promocional.
`monthsPromotionalPeriod`	int32	Cantidad de meses promocionales.
`daysPromotionalPeriod`	int32	Cantidad de días promocionales.
`installmentsPromotionalPeriod`	int32	Cuotas en el período promocional.

🧩 Estructura de `activitiesGroups`

Campo	Tipo	Descripción
`idGroupActivity`	int32	ID del grupo de actividad.
`name`	string	Nombre del grupo de actividad.
`idBranch`	int32	ID de la sucursal asociada al grupo.

🧩 Estructura de `entries`

Campo	Tipo	Descripción
`entriesQuantity`	int32	Cantidad de entradas permitidas.
`idEntriesType`	int32	Tipo de entrada configurada.
`entriesTypeDescription`	string	Descripción del tipo de entrada.

🧩 Estructura de `salesPage`

Campo	Tipo	Descripción
`idSalesPage`	int32	ID de la página de ventas.
`order`	int32	Orden de visualización del plan en la página.
`salesPageDescription`	string	Descripción de la página de ventas.

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

[
    {
        "idMembership": 0,
        "idBranch": 0,
        "nameMembership": "string",
        "membershipType": "string",
        "durationType": "string",
        "duration": 0,
        "updateDate": "2019-08-24T14:15:22.123Z",
        "value": 0,
        "maxAmountInstallments": 0,
        "description": "string",
        "urlSale": "string",
        "onlineSalesObservations": "string",
        "differentials": [
            {
                "title": "string",
                "order": 0
            }
        ],
        "accessBranches": [
            {
                "idBranch": 0,
                "name": "string"
            }
        ],
        "additionalService": {
            "idService": 0,
            "name": "string",
            "value": 0
        },
        "serviceYearly": {
            "idService": 0,
            "name": "string",
            "value": 0,
            "type": 0,
            "billingMonth": 0,
            "billingDay": 0,
            "billingAfterMonths": 0,
            "installments": 0
        },
        "typePromotionalPeriod": 0,
        "valuePromotionalPeriod": 0,
        "monthsPromotionalPeriod": 0,
        "daysPromotionalPeriod": 0,
        "minPeriodStayMembership": 0,
        "installmentsPromotionalPeriod": 0,
        "activitiesGroups": [
            {
                "idGroupActivity": 0,
                "name": "string",
                "idBranch": 0
            }
        ],
        "inactive": true,
        "displayName": "string",
        "entries": {
            "entriesQuantity": 0,
            "idEntriesType": 0,
            "entriesTypeDescription": "string"
        },
        "salesPage": [
            {
                "idSalesPage": 0,
                "order": 0,
                "salesPageDescription": "string"
            }
        ],
        "allowsCancellationByApp": true,
        "externalSaleAvailable": true,
        "acceptEnrollment": true,
        "enrollmentRequired": true
    }
]

🟠400Bad Request

Get memberships

Recuperar Contratos / Planes#

Descripción#

🔑 Parámetros de Consulta#

📤 Estructura de la Respuesta#

🧩 Estructura de diferentials#

🧩 Estructura de accessBranches#

🧩 Estructura de additionalService#

🧩 Estructura de serviceYearly#

🧩 Estructura de activitiesGroups#

🧩 Estructura de entries#

🧩 Estructura de salesPage#

Requisição