Create 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.

Description

Creates a new promotional voucher that can be used in plans, services, or contracts of the configured branch(es).

🔑 Query Parameter

Parameter	Type	Required	Description
`idBranch`	`int32`	No	ID of the branch where the voucher will be created. If not informed, the current branch of the authenticated user will be used. Only applicable for keys with multi-location permission.

📨 Request Body

Parameter	Type	Required	Description
`name`	`string`	No	Name of the voucher.
`qtde`	`int32`	Conditional	Quantity of available uses. Required if `flIlimitado = false`.
`flUtilizarSite`	`boolean`	Yes	If `true`, the voucher can be used on the site.
`validade`	`date-time`	Yes	Expiration date of the voucher.
`inicio`	`date-time`	Yes	Date from which the voucher is valid.
`flCodigoUnico`	`boolean`	Yes	If `true`, a unique code will be generated for each use.
`tipoDesconto`	`int32`	Yes	Type of general discount applied: `1` = percentage `2` = fixed amount
`valor`	`double`	Yes	Value of the discount (percentage or fixed, according to `tipoDesconto`).
`flContrato`	`boolean`	Yes	If `true`, the voucher is linked to contracts.
`idsContratos`	`array<int32>`	No	List of contract IDs that accept this voucher.
`idsServicos`	`array<int32>`	No	List of service IDs that accept this voucher.
`idsFiliais`	`array<int32>`	No	List of branch IDs where the voucher can be used.
`tipoDescontoAnuidade`	`int32`	No	Type of discount for annual fee: `1` = percentage `2` = fixed amount
`tipoDescontoServicoUnico`	`int32`	No	Type of discount for single service: `1` = percentage `2` = fixed amount
`valorDescontoAnuidade`	`double`	No	Value of the discount for annual fee.
`valorDescontoServicoUnico`	`double`	No	Value of the discount for single service.
`flDescontoAnuidade`	`boolean`	No	If `true`, applies discount on annual fee.
`flDescontoServicoUnico`	`boolean`	No	If `true`, applies discount on single service.
`mesesDescontoRecorrente`	`int32`	No	Number of months with recurring discount.
`flDebitoRecorrente`	`boolean`	No	If `true`, applies to recurring debts.
`flNaoPermiteConvenio`	`boolean`	No	If `true`, the voucher cannot be used together with agreements.

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

Example

{
    "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
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Creates a new voucher

Create a New Voucher

Description

🔑 Query Parameter

📨 Request Body

Request

Request Code Samples

Responses

Creates a new voucher

Create a New Voucher#

Description#

🔑 Query Parameter#

📨 Request Body#

Request

Request Code Samples

Responses

Create a New Voucher

Description

🔑 Query Parameter

📨 Request Body