Retornar Vouchers

Descrição

Retorna a lista de vouchers cadastrados, podendo ser filtrados por diferentes critérios, como ID, nome, filial e tipo. A consulta também pode incluir paginação e filtragem por validade, permitindo obter apenas os vouchers ativos e disponíveis no sistema.

🔑 Parâmetros de Consulta (Query Params)

Parâmetro	Tipo	Obrigatoriedade	Descrição
idVoucher	int32	Não	Filtrar pelo ID específico do voucher.
name	string	Não	Filtrar pelo nome do voucher.
idBranch	int32	Recomendável	Filtrar pelo número da filial (somente aplicável para chaves multilocal; ignorado caso contrário).
take	int32	Não	Quantidade de registros a serem retornados (máximo 50). Padrão: 25.
skip	int32	Não	Quantidade de registros a serem ignorados na listagem (paginação). Padrão: 0.
valid	boolean	Não	Filtrar para retornar apenas vouchers válidos (true) ou inválidos (false).
type	int32	Não	Filtrar pelo tipo de voucher, conforme tipos definidos no sistema.

📤 Estrutura de Resposta

A resposta retorna a lista de vouchers encontrados com base nos filtros informados. Cada objeto de voucher inclui informações como nome, tipo, disponibilidade, descontos aplicáveis e data de expiração.

Campo	Tipo	Descrição
idVoucher	int32	ID único do voucher.
nameVoucher	string	Nome do voucher.
typeVoucher	string	Tipo do voucher (ex.: promocional, desconto de matrícula, desconto de serviço).
limited	boolean	Indica se o voucher possui uso limitado.
available	int32	Quantidade disponível para uso.
used	int32	Quantidade já utilizada.
expirationDate	string (date-time)	Data e hora de expiração do voucher.
overdue	boolean	Indica se o voucher está vencido (`true`) ou ainda válido (`false`).
siteAvailable	boolean	Indica se o voucher está disponível para uso no site/aplicativo.
idMemberships	array<int32>	Lista de IDs de matrículas às quais o voucher se aplica.
monthyDiscount	objeto	Informações sobre desconto mensal aplicável.
yearlyDiscount	objeto	Informações sobre desconto anual aplicável.
serviceDiscount	objeto	Informações sobre desconto em serviços aplicável.

Estrutura do Objeto `monthyDiscount`

Campo	Tipo	Descrição
typeDiscountMembership	string	Tipo de desconto na matrícula (ex.: percentual, valor fixo).
value	number	Valor do desconto.
numberMounths	int32	Número de meses em que o desconto será aplicado

Estrutura do Objeto `yearlyDiscount`

Campo	Tipo	Descrição
typeDisocuntYearly	string	Tipo de desconto anual (ex.: percentual, valor fixo).
value	number	Valor do desconto.

Estrutura do Objeto `serviceDiscount`

Campo	Tipo	Descrição
typeDiscountService	string	Tipo de desconto em serviço (ex.: percentual, valor fixo).
value	number	Valor do desconto.

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

[
    {
        "idVoucher": 0,
        "nameVoucher": "string",
        "typeVoucher": "string",
        "limited": true,
        "available": 0,
        "used": 0,
        "expirationDate": "2019-08-24T14:15:22.123Z",
        "overdue": true,
        "siteAvailable": true,
        "idMemberships": [
            0
        ],
        "monthyDiscount": {
            "typeDiscountMembership": "string",
            "value": 0,
            "numberMounths": 0
        },
        "yearlyDiscount": {
            "typeDisocuntYearly": "string",
            "value": 0
        },
        "serviceDiscount": {
            "typeDiscountService": "string",
            "value": 0
        }
    }
]

🟠400Bad Request

Get vouchers

Retornar Vouchers#

Descrição#

🔑 Parâmetros de Consulta (Query Params)#

📤 Estrutura de Resposta#

Estrutura do Objeto monthyDiscount#

Estrutura do Objeto yearlyDiscount#

Estrutura do Objeto serviceDiscount#

Requisição