Skip to main content

PATCH Registrar Observação da Cobrança

Registra a observação da ligação de cobrança. Observação/objeção do paciente, registrada após o contato pela recepção.

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


Endpoint​

PATCH https://api-dev.imagemais.com.br/api/budgets/note

Corpo da Requisição​

CampoTipoObrigatórioValores válidosDescrição
idnumber✅inteiro; positivoID do orçamento
notestring❌até 2000 caracteresObservação/objeção registrada após contato com o paciente

Requisição​

curl -X 'PATCH' \
'https://api-dev.imagemais.com.br/api/budgets/note' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}' \
-H 'Content-Type: application/json' \
-d '{
"id": 1,
"note": "Disse que vai pagar até sexta-feira."
}'

Respostas​

200 Sucesso​

{
"data": {
"id": 100,
"createUserId": 1,
"patientId": 53,
"statusId": 2,
"createdAt": "2026-09-04T14:28:27.894Z",
"updatedAt": "2026-09-30T18:48:37.730Z",
"deletedAt": null,
"discountId": null,
"requestingDoctorId": null,
"observationId": null,
"reason": "Testando",
"note": "Observação de teste da documentação",
"contacted": true,
"contactedAt": "2026-09-22T10:51:05.301Z",
"contactedById": 1,
"netValue": "12"
}
}

400 Requisição inválida​

Retornado quando o corpo ou a query não passam na validação. A lista message traz um item por regra violada, por exemplo:

{
"message": [
"id must be a positive number",
"id must be an integer number"
],
"error": "Bad Request",
"statusCode": 400
}

403 Sem permissão​

{
"message": "Permissões insuficientes",
"error": "Forbidden",
"statusCode": 403
}

404 Não encontrado​

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