Skip to main content

PATCH Atualizar Desconto

Atualiza os dados de um desconto existente.

Autenticação necessária

Envie o header Authorization: Bearer {accessToken} (token de usuário) ou x-api-key: {apiKey} (integrações). Veja Autenticação.

Permissão necessária

Exige a permissão update_discounts.

O id usado vem do corpo

O {id} da URL não é lido pelo servidor — o desconto atualizado é o do id enviado no corpo. Envie o mesmo valor nos dois lugares.

Campos omitidos podem ser sobrescritos

name é obrigatório. Se isEveryone não for enviado, ele passa a false; se expirationDate não for enviado, a validade é removida (null). Envie sempre o estado completo do desconto.

ID do desconto

O id pode ser obtido na rota de Listar Descontos, no campo id de cada desconto.


Endpoint​

PATCH https://api-dev.imagemais.com.br/api/finances/discounts/{id}

Parâmetros​

Path​

CampoTipoObrigatórioDescrição
idnumber✅ID do desconto (ignorado — ver aviso acima)

Body​

CampoTipoObrigatórioDescrição
idnumber✅ID do desconto
namestring✅Nome do desconto
descriptionstring❌Descrição do desconto
percentagenumber❌Percentual de desconto (maior que 0, até 100)
fixednumber❌Valor fixo de desconto
isEveryoneboolean❌true = aplica a todos os orçamentos
expirationDatestring❌Formato YYYY-MM-DD
proceduresIdsnumber[]❌IDs dos procedimentos específicos — substitui a lista atual. Ignorado quando isEveryone é true

Requisição​

curl -X 'PATCH' \
'https://api-dev.imagemais.com.br/api/finances/discounts/8' \
-H 'accept: */*' \
-H 'Authorization: Bearer {accessToken}' \
-H 'Content-Type: application/json' \
-d '{
"id": 8,
"name": "Desconto VIP 10%",
"description": "Desconto de 10% para clientes VIP",
"percentage": 10,
"fixed": 10,
"isEveryone": true,
"expirationDate": "2025-01-01",
"proceduresIds": [1, 2, 3]
}'

Respostas​

200 Atualizado com sucesso​

{
"data": {
"id": 8,
"name": "Desconto VIP 10%",
"description": "Desconto de 10% para clientes VIP",
"percentage": 10,
"fixed": "10",
"isActive": true,
"isEveryone": true,
"accountId": 1,
"createdAt": "2026-05-19T17:24:38.745Z",
"updatedAt": "2026-05-19T17:28:15.039Z",
"expirationDate": "2025-01-01T00:00:00.000Z",
"deletedAt": null
}
}

400 Nome já utilizado​

Retornado quando já existe outro desconto da conta com o mesmo name.

{
"message": "Desconto já existe",
"error": "Bad Request",
"statusCode": 400
}

500 Erro Interno​

Retornado quando o id do corpo não existe (ou pertence a outra conta) — o serviço não trata esse caso e a falha do banco vira erro genérico.

{
"statusCode": 500,
"message": "Internal server error"
}