Get vouchers
GET
https://evo-integracao-api.w12app.com.br/api/v1/voucher
🌐 API Reference/Voucher
Retornar Vouchers
Descrição
🔑 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
| 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. |
Request
Query Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://evo-integracao-api.w12app.com.br/api/v1/voucher?idVoucher=undefined&name=undefined&idBranch=undefined&take=undefined&skip=undefined&valid=undefined&type=undefined' \
--header 'Authorization: Basic <encoded-value>'Response Response Example
200 - Example 1
[
{
"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
}
}
]Modified at 2026-05-15 04:38:45