Recuperar Contratos

Descripción

Este endpoint permite consultar los contratos/planes disponibles, con opciones de filtro 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, sucursales con acceso, contratos adicionales y más.

OBS. Disponible para su 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. Se ignora si la clave de API no es multisucursal.
`take`	int	No	Número total de registros que se devolverán (máximo: 200). Predeterminado: 25.
`skip`	int	No	Cantidad de registros que se omitirán (para paginación). Predeterminado: 0.
`active`	boolean	No	Filtra por contratos activos o inactivos.
`showAccessBranches`	boolean	No	Muestra las sucursales en las que el contrato permite acceso. Predeterminado: `false`.
`showOnlineSalesObservation`	boolean	No	Muestra las observaciones relacionadas con la venta online. Predeterminado: `false`.
`updateDate`	string (ISO)	No	Filtra los contratos actualizados a partir de esta fecha (`yyyy-mm-dd`).
`showActivitiesGroups`	boolean	No	Muestra los grupos de actividades vinculados al plan/contrato. Predeterminado: `false`.
`externalSaleAvailable`	boolean	No	Permite la venta externa. Predeterminado: `false`.
`showSuspensionRules`	boolean	No	Muestra las reglas de suspensión en la respuesta. Predeterminado: `false`.
`showCancellationRules`	boolean	No	Muestra las reglas de cancelación en la respuesta. Predeterminado: `false`.
`showContract`	boolean	No	Muestra la estructura del contrato en la respuesta. Predeterminado: `false`.
`showTurnstiles`	boolean	No	Muestra los molinetes vinculados al plan/contrato, directamente o a través de un grupo de molinetes, en la respuesta. Predeterminado: `false`.
`showAdditionalMemberships`	boolean	No	Cuando es `true`, devuelve los contratos adicionales vinculados y la configuración `additionalValueProportionalToDuration` del contrato principal. Predeterminado: `false`.

📤 Estructura de la Respuesta

La respuesta devuelve 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. Ver más abajo.
`durationType`	string	Tipo de duración del plan (ej.: Días o Meses).
`duration`	int32	Duración del plan según el tipo definido.
`updateDate`	date-time	Fecha de la última actualización del plan.
`value`	number (double)	Valor del plan. Incluye la suma de los adicionales vinculados al plan, fijos y opcionales.
`maxAmountInstallments`	int32	Cantidad máxima de cuotas permitidas.
`description`	string	Descripción detallada del plan.
`urlSale`	string (read-only)	URL pública para la venta del plan.
`onlineSalesObservations`	string	Observaciones mostradas en el flujo de ventas online.
`diferentials`	arrayobject	Lista de diferenciales asociados al plan. Ver más abajo.
`accessBranches`	arrayobject	Lista de sucursales donde el plan es válido. Ver más abajo.
`additionalService`	arrayobject	Servicio adicional vinculado al plan. Ver más abajo.
`serviceYearly`	arrayobject	Servicio anual asociado al plan. Ver más abajo.
`typePromotionalPeriod`	int32	Tipo de período promocional aplicado al plan o servicio, definiendo la regla de duración de la promoción.
`valuePromotionalPeriod`	number	Valor aplicado durante el período promocional. Incluye la suma de los adicionales vinculados al plan, fijos y opcionales.
`monthsPromotionalPeriod`	int32	Cantidad de meses de duración del período promocional, cuando corresponda.
`daysPromotionalPeriod`	int32	Cantidad de días de duración del período promocional, cuando corresponda.
`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. Ver más abajo.
`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. Ver más abajo.
`salesPage`	arrayobject	Páginas de venta asociadas al plan. Ver más abajo.
`allowsCancellationByApp`	boolean	Indica si el plan puede cancelarse a través de la aplicación.
`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.
`contractSuspension`	arrayobject	Reglas de suspensión vinculadas al plan. Ver más abajo.
`contractCancellation`	arrayobject	Reglas de cancelación vinculadas al plan. Ver más abajo.
`htmlContract`	string	Estructura del contrato vinculado al plan.
`turnstiles`	array	Lista de molinetes asociados al plan/contrato.
`additionalValueProportionalToDuration`	boolean	Indica si el valor de los contratos adicionales debe ser proporcional a la vigencia del contrato principal.
`additionalMemberships`	arrayobject	Contratos adicionales vinculados al contrato principal. Ver más abajo.

🧩 Valores de `membershipType`

El campo membershipType representa la modalidad del contrato configurada en Administrativo > Contratos.

Contrato común

Contrato mensual con renovación automática

Extensión de plan

Extensión de congelamiento

Débito recurrente mensual

Débito recurrente con vigencia

Dependientes adicionales

Contrato anual con fecha de finalización determinada

Contrato adicional

Pix programado recurrente con vigencia

Pix automático mensual

OBS. El campo membershipType no indica si un contrato adicional posee un vínculo fijo u opcional. Para los contratos adicionales, esta información está representada por el campo additionalType dentro de additionalMemberships.

🧩 Estructura de `diferentials`

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

🧩 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 cobro.
`billingDay`	int32	Día de cobro.
`billingAfterMonths`	int32	Meses después de la contratación para realizar el cobro.
`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 durante 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.

🧩 Estructura de `contractSuspension`

Campo	Tipo	Descripción
`maxSuspensionsAllowed`	int32	Cantidad máxima de suspensiones permitidas para el contrato.
`totalSuspensionDays`	int32	Cantidad total de días de suspensión permitidos para el contrato.
`minimumPeriodBeforeSuspensionDays`	int32	Período mínimo, en días, antes de permitir la suspensión del contrato.
`firstSuspensionGracePeriodMonths`	int32	Período de carencia, en meses, para la primera suspensión del contrato.
`nextSuspensionsGracePeriodMonths`	int32	Período de carencia, en meses, para las próximas suspensiones del contrato.

🧩 Estructura de `contractCancellation`

Campo	Tipo	Descripción
`considerClosedCompetencyOnCancellation`	boolean	Indica si la competencia cerrada debe considerarse en la cancelación.
`priorNoticeDays`	int32	Cantidad de días de aviso previo requeridos para la cancelación.
`applyPenaltyAutomatically`	boolean	Indica si la penalización debe aplicarse automáticamente en la cancelación.
`penaltyOverRemainingContractValue`	boolean	Indica si la penalización debe calcularse sobre el valor restante del contrato.
`minimumGracePeriodMonths`	int32	Período mínimo de carencia, en meses, para la aplicación de las reglas de cancelación.
`penaltyPercentage`	number	Porcentaje de penalización aplicado en la cancelación del contrato.

🧩 Estructura de `additionalMemberships`

Campo	Tipo	Descripción
`idMembership`	int32	Identificador del contrato adicional.
`nameMembership`	string	Nombre del contrato adicional.
`membershipType`	string	Modalidad del contrato adicional.
`value`	number (double)	Valor configurado en el registro del contrato adicional.
`inactive`	boolean	Indica si el contrato adicional está inactivo.
`additionalType`	string	Tipo de vínculo entre el contrato principal y el adicional. Puede asumir los valores `Fixed` u `Optional`.
`defaultSaleValue`	number (double)	Valor predeterminado que será utilizado por los flujos de Sales y Carts cuando no se informe `membershipValue` para el adicional. Puede variar según el indicador `additionalValueProportionalToDuration`.

🚧 Reglas de los contratos adicionales
Fixed: identifica un adicional obligatorio, incluido automáticamente cuando se vende el contrato principal y que no puede venderse de forma aislada.
Optional: identifica un adicional que puede ser seleccionado por la integración, vendido junto con el contrato principal o por separado cuando el miembro ya posee un contrato principal elegible.
El tipo de vínculo pertenece a la combinación entre contrato principal + contrato adicional. Por este motivo, un mismo contrato adicional puede ser Fixed para un contrato principal y Optional para otro.
Cuando additionalValueProportionalToDuration sea false, defaultSaleValue corresponde al valor configurado en el contrato adicional.
Cuando additionalValueProportionalToDuration sea true, defaultSaleValue corresponde al valor configurado del adicional multiplicado por la cantidad de meses de vigencia del contrato principal. Para contratos principales con una vigencia de 1 mes, el valor no se modifica.
Cuando la integración informe membershipValue durante la venta, el valor informado será considerado el valor final del adicional y no se multiplicará nuevamente por la vigencia.

Envía tus solicitudes HTTP con un encabezado

Authorization

que contenga la palabra Basic seguida de un espacio y una cadena codificada en base64 username:password

Ejemplo:

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

application/json

Success

Body

Ejemplo

[
    {
        "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,
        "contractSuspension": {
            "maxSuspensionsAllowed": 0,
            "totalSuspensionDays": 0,
            "minimumPeriodBeforeSuspensionDays": 0,
            "firstSuspensionGracePeriodMonths": 0,
            "nextSuspensionsGracePeriodMonths": 0
        },
        "contractCancellation": {
            "considerClosedCompetencyOnCancellation": true,
            "priorNoticeDays": 0,
            "applyPenaltyAutomatically": true,
            "penaltyOverRemainingContractValue": true,
            "minimumGracePeriodMonths": 0,
            "penaltyPercentage": 0
        },
        "htmlContract": "string",
        "turnstiles": [
            0
        ],
        "additionalValueProportionalToDuration": true,
        "additionalMemberships": [
            {
                "idMembership": 0,
                "nameMembership": "string",
                "membershipType": "string",
                "value": 0,
                "inactive": true,
                "additionalType": "string",
                "defaultSaleValue": 0
            }
        ]
    }
]

Get memberships

Recuperar Contratos

Descripción

🔑 Parámetros de Consulta

📤 Estructura de la Respuesta

🧩 Valores de `membershipType`

🧩 Estructura de `diferentials`

🧩 Estructura de `accessBranches`

🧩 Estructura de `additionalService`

🧩 Estructura de `serviceYearly`

🧩 Estructura de `activitiesGroups`

🧩 Estructura de `entries`

🧩 Estructura de `salesPage`

🧩 Estructura de `contractSuspension`

🧩 Estructura de `contractCancellation`

🧩 Estructura de `additionalMemberships`

Solicitud

Ejemplos de solicitud

Respuestas

Get memberships

Recuperar Contratos#

Descripción#

🔑 Parámetros de Consulta#

📤 Estructura de la Respuesta#

🧩 Valores de membershipType#

🧩 Estructura de diferentials#

🧩 Estructura de accessBranches#

🧩 Estructura de additionalService#

🧩 Estructura de serviceYearly#

🧩 Estructura de activitiesGroups#

🧩 Estructura de entries#

🧩 Estructura de salesPage#

🧩 Estructura de contractSuspension#

🧩 Estructura de contractCancellation#

🧩 Estructura de additionalMemberships#

Solicitud

Ejemplos de solicitud

Respuestas

Recuperar Contratos

Descripción

🔑 Parámetros de Consulta

📤 Estructura de la Respuesta

🧩 Valores de `membershipType`

🧩 Estructura de `diferentials`

🧩 Estructura de `accessBranches`

🧩 Estructura de `additionalService`

🧩 Estructura de `serviceYearly`

🧩 Estructura de `activitiesGroups`

🧩 Estructura de `entries`

🧩 Estructura de `salesPage`

🧩 Estructura de `contractSuspension`

🧩 Estructura de `contractCancellation`

🧩 Estructura de `additionalMemberships`