Recupera Contratos

Descrição

Esse endpoint permite consultar os contratos disponíveis, com opções de filtro por nome, filial, data de atualização, entre outros. Também é possível incluir informações adicionais, como grupos de atividades, observações de venda online e filiais com acesso.

🔑 Parâmetros de Consulta

Parâmetro	Tipo	Obrigatório	Descrição
idMembership	int	Não	Filtra pelo ID do membership específico.
name	string	Não	Filtra pelo nome do contrato.
idBranch	int	Não	Filtra pelo ID da filial. Ignorado se a chave de API não for multifilial.
take	int	Não	Número total de registros a serem retornados (máximo: 50). Padrão: 25.
skip	int	Não	Quantidade de registros a serem ignorados (para paginação). Padrão: 0.
active	boolean	Não	Filtra por contratos ativos ou inativos.
updateDate	string (ISO)	Não	Filtra contratos atualizados a partir desta data (`yyyy-mm-dd`).
showAccessBranches	boolean	Não	Exibe as filiais em que o contrato garante acesso. Padrão: `false`.
showOnlineSalesObservation	boolean	Não	Exibe observações referentes à venda online. Padrão: `false`.
showActivitiesGroups	boolean	Não	Exibe os grupos de atividades vinculados ao contrato. Padrão: `false`.

📤 Estrutura da Resposta

A resposta retorna os dados completos de um plano de matrícula, incluindo informações comerciais, regras de cobrança, serviços adicionais, grupos de atividades, filiais associadas, entradas, páginas de venda e configurações de elegibilidade.

Campo	Tipo	Descrição
`idMembership`	int32	Identificador único da matrícula.
`idBranch`	int32	ID da filial associada à matrícula.
`nameMembership`	string	Nome da matrícula.
`membershipType`	string	Tipo da matrícula.
`durationType`	string	Tipo de duração da matrícula (ex.: mensal, anual).
`duration`	int32	Duração da matrícula conforme o tipo definido.
`updateDate`	date-time	Data da última atualização da matrícula.
`value`	number (double)	Valor da matrícula.
`maxAmountInstallments`	int32	Quantidade máxima de parcelas permitidas.
`description`	string	Descrição detalhada da matrícula.
`urlSale`	string (read-only)	URL pública para venda da matrícula.
`onlineSalesObservations`	string	Observações exibidas no fluxo de vendas online.
`diferentials`	arrayobject	Lista de diferenciais associados à matrícula. Ver mais abaixo.
`accessBranches`	arrayobject	Lista de unidades onde a matrícula é válida. Ver mais abaixo.
`additionalService`	arrayobject	Serviço adicional vinculado à matrícula. Ver mais abaixo.
`serviceYearly`	arrayobject	Serviço anual associado à matrícula. Ver mais abaixo.
`typePromotionalPeriod`	int32	Tipo de período promocional aplicado à matrícula ou serviço, definindo a regra de duração da promoção.
`valuePromotionalPeriod`	number	Valor aplicado durante o período promocional.
`monthsPromotionalPeriod`	int32	Quantidade de meses de duração do período promocional, quando aplicável.
`daysPromotionalPeriod`	int32	Quantidade de dias de duração do período promocional, quando aplicável.
`minPeriodStayMembership`	int32	Período mínimo de permanência na matrícula.
`installmentsPromotionalPeriod`	int32	Quantidade de parcelas permitidas durante o período promocional.
`activitiesGroups`	arrayobject	Grupos de atividades vinculados à matrícula. Ver mais abaixo.
`inactive`	boolean	Indica se a matrícula está inativa.
`displayName`	string	Nome de exibição formatado da matrícula.
`entries`	arrayobject	Configuração de entradas permitidas pela matrícula. Ver mais abaixo.
`salesPage`	arrayobject	Páginas de venda associadas à matrícula. Ver mais abaixo.
`allowsCancellationByApp`	boolean	Indica se a matrícula pode ser cancelada pelo aplicativo.
`externalSaleAvailable`	boolean	Indica se a matrícula pode ser vendida externamente.
`acceptEnrollment`	boolean	Indica se aceita matrícula direta.
`enrollmentRequired`	boolean	Indica se exige matrícula obrigatória.

🧩 Estrutura de `diferentials`

Campo	Tipo	Descrição
`title`	string
`order`	int32

🧩 Estrutura de `accessBranches`

Campo	Tipo	Descrição
`idBranch`	int32	Identificador da unidade à qual o membro possui acesso.
`name`	string	Nome da unidade à qual o membro possui acesso.

🧩 Estrutura de `additionalService`

Campo	Tipo	Descrição
`idService`	int32	Identificador do serviço adicional.
`name`	string	Nome do serviço adicional.
`value`	number	Valor do serviço adicional.

🧩 Estrutura de `serviceYearly`

Campo	Tipo	Descrição
`idService`	int32	ID do serviço anual.
`name`	string	Nome do serviço anual.
`value`	number (double)	Valor do serviço anual.
`type`	int32	Tipo de cobrança do serviço.
`billingMonth`	int32	Mês de cobrança.
`billingDay`	int32	Dia de cobrança.
`billingAfterMonths`	int32	Meses após a contratação para cobrança.
`installments`	int32	Quantidade de parcelas.
`typePromotionalPeriod`	int32	Tipo de período promocional.
`valuePromotionalPeriod`	number (double)	Valor promocional.
`monthsPromotionalPeriod`	int32	Quantidade de meses promocionais.
`daysPromotionalPeriod`	int32	Quantidade de dias promocionais.
`installmentsPromotionalPeriod`	int32	Parcelas no período promocional.

🧩 Estrutura de `activitiesGroups`

Campo	Tipo	Descrição
`idGroupActivity`	int32	ID do grupo de atividade.
`name`	string	Nome do grupo de atividade.
`idBranch`	int32	ID da filial associada ao grupo.

🧩 Estrutura de `entries`

Campo	Tipo	Descrição
`entriesQuantity`	int32	Quantidade de entradas permitidas.
`idEntriesType`	int32	Tipo de entrada configurada.
`entriesTypeDescription`	string	Descrição do tipo de entrada.

🧩 Estrutura de `salesPage`

Campo	Tipo	Descrição
`idSalesPage`	int32	ID da página de vendas.
`order`	int32	Ordem de exibição da matrícula na página.
`salesPageDescription`	string	Descrição da página de vendas.

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

Recupera Contratos#

Descrição#

🔑 Parâmetros de Consulta#

📤 Estrutura da Resposta#

🧩 Estrutura de diferentials#

🧩 Estrutura de accessBranches#

🧩 Estrutura de additionalService#

🧩 Estrutura de serviceYearly#

🧩 Estrutura de activitiesGroups#

🧩 Estrutura de entries#

🧩 Estrutura de salesPage#

Requisição