Creates a new voucher

Descrição

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

Permissão necessária

Escopo da chave/token: Voucher - Edição

Apenas usuários com este escopo de permissão podem criar vouchers. Requisições sem essa permissão receberão código 401 Unauthorized.

Query Params

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.

Body Parameters

Objeto JSON contendo os dados do novo voucher:

Parâmetro	Tipo	Obrigatório	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.

Exemplo de requisição

{
  "nome": "PROMO2025",
  "qtde": 100,
  "flUtilizarSite": true,
  "validade": "2025-12-31T23:59:59",
  "inicio": "2025-06-01T00:00:00",
  "flCodigoUnico": false,
  "flIlimitado": false,
  "tipoDesconto": 1,
  "valor": 20,
  "flContrato": true,
  "idsContratos": [1, 2],
  "idsServicos": [10],
  "idsFiliais": [1, 3],
  "tipoDescontoAnuidade": 1,
  "tipoDescontoServicoUnico": 2,
  "valorDescontoAnuidade": 15,
  "valorDescontoServicoUnico": 30,
  "flDescontoAnuidade": true,
  "flDescontoServicoUnico": true,
  "mesesDescontoRecorrente": 3,
  "flDebitoRecorrente": true,
  "flNaoPermiteConvenio": false
}