Skip to main content

POST Fechar Orçamento como Cortesia

Fecha como cortesia um orçamento de valor líquido zero (bruto maior que zero, totalmente coberto por descontos). Não cria movimento financeiro. Dispara os webhooks budget.released e budget.paid e os mesmos jobs do pagamento (agendamento e laboratório). Não tem permissão própria, como o pagamento: basta estar autenticado.

Autenticação necessária

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

Sem permissão específica

Não exige @CheckPermissions — basta estar autenticado.

Irreversível pela API

Não há rota para desfazer o fechamento por cortesia. Um segundo fechamento do mesmo orçamento responde 409.


Endpoint​

POST https://api-dev.imagemais.com.br/api/movements/budgets/{budgetId}/close-courtesy

Parâmetros de Rota​

NomeTipoObrigatórioDescrição
budgetIdnumber✅ID do orçamento

Corpo da Requisição​

CampoTipoObrigatórioValores válidosDescrição
reasonstring✅até 255 caracteres; não vazio (espaços nas pontas são removidos)Motivo do fechamento por cortesia

Requisição​

curl -X 'POST' \
'https://api-dev.imagemais.com.br/api/movements/budgets/1/close-courtesy' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}' \
-H 'Content-Type: application/json' \
-d '{
"reason": "Cortesia da direção"
}'

Respostas​

201 Sucesso​

{
"data": {
"id": 5501,
"courtesyClosedAt": "2026-11-18T14:00:00.000Z",
"courtesyReason": "Cortesia da direção"
}
}

400 Requisição inválida​

Mensagens possíveis:

  • Motivo é obrigatório, Motivo deve ser um texto e Motivo deve ter no máximo 255 caracteres
  • O orçamento já tem pagamento: siga o fluxo normal de pagamento
  • Orçamento sem valor não fecha como cortesia: envie-o à fila
  • Só é possível fechar como cortesia um orçamento com valor líquido zero
  • Validation failed (numeric string is expected) (budgetId inválido)
{
"message": "Só é possível fechar como cortesia um orçamento com valor líquido zero",
"error": "Bad Request",
"statusCode": 400
}

404 Não encontrado​

{
"message": "Orçamento não encontrado",
"error": "Not Found",
"statusCode": 404
}

409 Conflito​

{
"message": "Orçamento já fechado como cortesia",
"error": "Conflict",
"statusCode": 409
}

500 Erro interno​

{
"message": "Erro ao fechar orçamento como cortesia",
"error": "Internal Server Error",
"statusCode": 500
}