Creates a new voucher

Endpoint to create a new voucher. The voucher will be created for the specified branch or, if not informed, for the current branch of the authenticated user.

Descripción

Crea un nuevo voucher promocional que podrá ser utilizado en planes, servicios o contratos de la(s) unidad(es) configurada(s).

🔑 Parámetro de Requisición (Query Param)

Parámetro	Tipo	Obligatorio	Descripción
idBranch	int32	No	ID de la sucursal donde se creará el voucher. Si no se indica, se utilizará la sucursal actual del usuario autenticado. Aplicable solo para claves con permiso multilocal.

📨 Cuerpo de la Requisición (Request Body)

Parámetro	Tipo	Obligatorio	Descripción
nome	string	No	Nombre del voucher.
qtde	int32	Condicional	Cantidad de usos disponibles. Obligatorio si `flIlimitado = false`.
flUtilizarSite	boolean	Sí	Si es `true`, el voucher puede ser utilizado en el sitio web.
validade	date-time	Sí	Fecha de expiración del voucher.
inicio	date-time	Sí	Fecha a partir de la cual el voucher es válido.
flCodigoUnico	boolean	Sí	Si es `true`, se generará un código único por uso.
tipoDesconto	int32	Sí	Tipo de descuento general aplicado: `1` = porcentaje `2` = valor fijo
valor	double	Sí	Valor del descuento (porcentaje o fijo, según `tipoDesconto`).
flContrato	boolean	Sí	Si es `true`, el voucher está vinculado a contratos.
idsContratos	array	No	Lista de IDs de contratos que aceptan este voucher.
idsServicos	array	No	Lista de IDs de servicios que aceptan este voucher.
idsFiliais	array	No	Lista de IDs de sucursales donde el voucher puede ser utilizado.
tipoDescontoAnuidade	int32	No	Tipo de descuento para anualidad: `1` = porcentaje `2` = valor fijo
tipoDescontoServicoUnico	int32	No	Tipo de descuento para servicio único: `1` = porcentaje `2` = valor fijo
valorDescontoAnuidade	double	No	Valor del descuento para anualidad.
valorDescontoServicoUnico	double	No	Valor del descuento para servicio único.
flDescontoAnuidade	boolean	No	Si es `true`, aplica descuento sobre la anualidad.
flDescontoServicoUnico	boolean	No	Si es `true`, aplica descuento sobre el servicio único.
mesesDescontoRecorrente	int32	No	Cantidad de meses con descuento recurrente.
flDebitoRecorrente	boolean	No	Si es `true`, se aplica a débitos recurrentes.
flNaoPermiteConvenio	boolean	No	Si es `true`, el voucher no puede usarse junto con convenios.

Requisição

Authorization

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 *****************

Parâmetros de Consulta

Parâmetros Bodyapplication/json-patch+json

Exemplo

{
    "nome": "string",
    "qtde": 0,
    "flUtilizarSite": true,
    "validade": "2019-08-24T14:15:22.123Z",
    "inicio": "2019-08-24T14:15:22.123Z",
    "flCodigoUnico": true,
    "flIlimitado": true,
    "tipoDesconto": 0,
    "valor": 0,
    "flContrato": true,
    "idsContratos": [
        0
    ],
    "idsServicos": [
        0
    ],
    "idsFiliais": [
        0
    ],
    "tipoDescontoAnuidade": 0,
    "tipoDescontoServicoUnico": 0,
    "valorDescontoAnuidade": 0,
    "valorDescontoServicoUnico": 0,
    "flDescontoAnuidade": true,
    "flDescontoServicoUnico": true,
    "mesesDescontoRecorrente": 0,
    "flDebitoRecorrente": true,
    "flNaoPermiteConvenio": true
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml