PATCH/api/finances/discounts/{id}

Atualizar Desconto

Atualiza um desconto existente

Access Token

Para realizar requisições GET, POST, PUT, DELETE e PATCH nos endpoints da API você precisa de uma chave de autorização. Chamamos essa chave de accessToken.

Para ter acesso ao accessToken, é necessário que o usuário master da licença efetue a liberação deste pela interface do ImageMais Clinic. O accessToken tem validade de 1 hora.

Headers

AuthorizationOBRIGATÓRIO
Tipo:string
Token de autenticação no formato Bearer {accessToken}
Content-TypeOBRIGATÓRIO
Tipo:application/json
Tipo de conteúdo (application/json)

Parâmetros

idOBRIGATÓRIO
Tipo:number
ID do desconto

Este parâmetro representa o ID do desconto que será atualizado. O ID é um número único que identifica cada desconto no sistema e deve ser passado na URL da requisição.

Atenção: Caso o parâmetro id seja inválido ou não exista, a API retornará um erro 500 Internal Server Error.

Observação: Para encontrar o ID do desconto, para acessar a página de listar finanças.

nameOPCIONAL
Tipo:string
Nome do desconto
descriptionOPCIONAL
Tipo:string
Descrição do desconto
percentageOPCIONAL
Tipo:number
Percentual do desconto
fixedOPCIONAL
Tipo:number
Valor fixo do desconto
isEveryoneOPCIONAL
Tipo:boolean
Filtro para procedimentos ou orçamentos

Este parâmetro é um filtro booleano que permite buscar descontos filtrados por meio de orçamentos ou procedimentos. Quando definido como true, retorna apenas descontos relacionados a orçamentos. Quando definido como false, retorna apenas descontos relacionados a procedimentos.

Exemplo:

?isEveryone=true

Observação: Este filtro pode ser combinado com outros parâmetros como limit, offset e search para filtrar e paginar os resultados. Por exemplo: ?isEveryone=true&limit=10&offset=0.

expirationDateOPCIONAL
Tipo:string
Data de expiração do desconto
proceduresIdsOPCIONAL
Tipo:array
Procedimentos do desconto

Request URL

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

Respostas

{
  "data": {
    "id": 6,
  ...
{
  "data": {
    "id": 6,
    "name": "Desconto de 16%",
    "description": "Desconto de 10% para clientes VIP",
    "percentage": 10,
    "fixed": "10",
    "isActive": true,
    "isEveryone": true,
    "accountId": 1,
    "createdAt": "2025-12-10T18:26:06.276Z",
    "updatedAt": "2025-12-10T18:51:18.902Z",
    "expirationDate": "2025-01-01T00:00:00.000Z",
    "deletedAt": null
  }
}
{
  "message": [
    "Desconto já existe"
  ...
{
  "message": [
    "Desconto já existe"
  ],
  "error": "Bad Request"
}
{
  "message": [
    "id should not be empty",
  ...
{
  "message": [
    "id should not be empty",
    "id must be a number conforming to the specified constraints"
  ],
  "error": "Bad Request"
}
{
  "statusCode": 401,
  "message": "invalid token"
  ...
{
  "statusCode": 401,
  "message": "invalid token"
}
{
  "statusCode": 401,
  "message": "jwt expired"
  ...
{
  "statusCode": 401,
  "message": "jwt expired"
}
{
  "statusCode": 500,
  "message": "Internal server error"
  ...
{
  "statusCode": 500,
  "message": "Internal server error"
}