Retornar Vouchers

Descripción

Retorna la lista de vouchers registrados, que pueden filtrarse por diferentes criterios, como ID, nombre, sucursal y tipo. La consulta también puede incluir paginación y filtrado por validez, permitiendo obtener solo los vouchers activos y disponibles en el sistema.

🔑 Parámetros de Consulta (Query Params)

Parámetro	Tipo	Obligatorio	Descripción
idVoucher	int32	No	Filtrar por el ID específico del voucher.
name	string	No	Filtrar por el nombre del voucher.
idBranch	int32	Recomendable	Filtrar por el número de sucursal (solo aplicable para claves multilocal; ignorado de otro modo).
take	int32	No	Cantidad de registros a retornar (máximo 50). Por defecto: 25.
skip	int32	No	Cantidad de registros a ignorar en la lista (paginación). Por defecto: 0.
valid	boolean	No	Filtrar para retornar solo vouchers válidos (true) o inválidos (false).
type	int32	No	Filtrar por el tipo de voucher, según los tipos definidos en el sistema.

📤 Estructura de la Respuesta

La respuesta retorna la lista de vouchers encontrados según los filtros aplicados. Cada objeto de voucher incluye información como nombre, tipo, disponibilidad, descuentos aplicables y fecha de expiración.

Campo	Tipo	Descripción
idVoucher	int32	ID único del voucher.
nameVoucher	string	Nombre del voucher.
typeVoucher	string	Tipo de voucher (ej.: promocional, descuento de matrícula, descuento de servicio).
limited	boolean	Indica si el voucher tiene uso limitado.
available	int32	Cantidad disponible para uso.
used	int32	Cantidad ya utilizada.
expirationDate	string (date-time)	Fecha y hora de expiración del voucher.
overdue	boolean	Indica si el voucher ha vencido (true) o todavía es válido (false).
siteAvailable	boolean	Indica si el voucher está disponible para uso en el sitio/aplicación.
idMemberships	array<int32>	Lista de IDs de matrículas a las cuales aplica el voucher.
monthyDiscount	object	Información sobre descuento mensual aplicable.
yearlyDiscount	object	Información sobre descuento anual aplicable.
serviceDiscount	object	Información sobre descuento en servicios aplicable.

🧩 Estructura del Objeto `monthyDiscount`

Campo	Tipo	Descripción
typeDiscountMembership	string	Tipo de descuento en la matrícula (ej.: porcentaje, valor fijo).
value	number	Valor del descuento.
numberMounths	int32	Número de meses en los que se aplicará el descuento.

🧩 Estructura del Objeto `yearlyDiscount`

Campo	Tipo	Descripción
typeDisocuntYearly	string	Tipo de descuento anual (ej.: porcentaje, valor fijo).
value	number	Valor del descuento.

🧩 Estructura del Objeto `serviceDiscount`

Campo	Tipo	Descripción
typeDiscountService	string	Tipo de descuento en servicio (ej.: porcentaje, valor fijo).
value	number	Valor del descuento.

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#

Descripción#

🔑 Parámetros de Consulta (Query Params)#

📤 Estructura de la Respuesta#

🧩 Estructura del Objeto monthyDiscount#

🧩 Estructura del Objeto yearlyDiscount#

🧩 Estructura del Objeto serviceDiscount#

Requisição