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.

Descrição

Cria um novo voucher promocional que poderá ser utilizado em planos, serviços ou contratos da(s) unidade(s) configurada(s).

🔑 Parâmetro de Requisição (Query Param)

Parâmetro	Tipo	Obrigatório	Descrição
`idBranch`	`int32`	Não	ID da filial onde o voucher será criado. Se não informado, será utilizada a filial atual do usuário autenticado. Utilizado apenas para chaves com permissão multilocal.

📨 Corpo da Requisição (Request Body)

Parâmetro	Tipo	Obrigatoriedade	Descrição
`nome`	`string`	Não	Nome do voucher.
`qtde`	`int32`	Condicional	Quantidade de usos disponíveis. Obrigatório se `flIlimitado = false`.
`flUtilizarSite`	`boolean`	Sim	Se `true`, o voucher pode ser utilizado no site.
`validade`	`date-time`	Sim	Data de expiração do voucher.
`inicio`	`date-time`	Sim	Data a partir da qual o voucher é válido.
`flCodigoUnico`	`boolean`	Sim	Se `true`, será gerado um código único por uso.
`tipoDesconto`	`int32`	Sim	Tipo de desconto geral aplicado: `1` = porcentagem `2` = valor fixo
`valor`	`double`	Sim	Valor do desconto (percentual ou fixo, conforme `tipoDesconto`).
`flContrato`	`boolean`	Sim	Se `true`, o voucher está vinculado a contratos.
`idsContratos`	`array<int32>`	Não	Lista de IDs de contratos que aceitam este voucher.
`idsServicos`	`array<int32>`	Não	Lista de IDs de serviços que aceitam este voucher.
`idsFiliais`	`array<int32>`	Não	Lista de IDs de filiais nas quais o voucher pode ser utilizado.
`tipoDescontoAnuidade`	`int32`	Não	Tipo de desconto para anuidade: `1` = porcentagem `2` = valor fixo
`tipoDescontoServicoUnico`	`int32`	Não	Tipo de desconto para serviço único: `1` = porcentagem `2` = valor fixo
`valorDescontoAnuidade`	`double`	Não	Valor do desconto para anuidade.
`valorDescontoServicoUnico`	`double`	Não	Valor do desconto para serviço único.
`flDescontoAnuidade`	`boolean`	Não	Se `true`, aplica desconto sobre anuidade.
`flDescontoServicoUnico`	`boolean`	Não	Se `true`, aplica desconto sobre serviço único.
`mesesDescontoRecorrente`	`int32`	Não	Quantidade de meses com desconto recorrente.
`flDebitoRecorrente`	`boolean`	Não	Se `true`, aplica-se a débitos recorrentes.
`flNaoPermiteConvenio`	`boolean`	Não	Se `true`, o voucher não pode ser usado junto com convênios.

Request

Authorization

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Query Params

Body Params

application/json-patch+json

Examples

curl --location 'https://evo-integracao-api.w12app.com.br/api/v2/voucher?idBranch=undefined' \ --header 'Authorization: Basic <encoded-value>' \ --header 'Content-Type: application/json-patch+json' \ --data '{ "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 }'

Creates a new voucher

Descrição#

🔑 Parâmetro de Requisição (Query Param)#

📨 Corpo da Requisição (Request Body)#

Request

Responses

Descrição

🔑 Parâmetro de Requisição (Query Param)

📨 Corpo da Requisição (Request Body)