Skip to main content

POST Criar Regra de Pagamento

Criar regra de pagamento do médico. Cria uma regra de mínimo por conjunto de dias (rejeita dias já cobertos)

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.


Endpoint​

POST https://api-dev.imagemais.com.br/api/doctors/{doctorId}/payment-rules

Parâmetros de Rota​

NomeTipoObrigatórioDescrição
doctorIdstring✅ID do médico

Corpo da Requisição​

CampoTipoObrigatórioValores válidosDescrição
daysOfWeekstring[]✅DOM, SEG, TER, QUA, QUI, SEX, SAB; ao menos 1 itemDias da semana cobertos pela regra (mesmo enum de DoctorScheduleDays.dayOfWeek)
minimumPaymentValuenumber✅mín. 0Valor do pagamento mínimo garantido nesses dias
excludedProcedureIdsnumber[]❌inteiroProcedimentos com produtividade calculada à parte, fora da regra do mínimo

Requisição​

curl -X 'POST' \
'https://api-dev.imagemais.com.br/api/doctors/abc123/payment-rules' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}' \
-H 'Content-Type: application/json' \
-d '{
"daysOfWeek": [
"DOM"
],
"minimumPaymentValue": 700,
"excludedProcedureIds": [
12,
34
]
}'

Respostas​

201 Sucesso​

{
"data": {
"id": 3,
"doctorId": 4,
"accountId": 1,
"daysOfWeek": [
"DOM"
],
"minimumPaymentValue": "1",
"excludedProcedureIds": [],
"createdAt": "2026-09-30T18:48:36.230Z",
"updatedAt": "2026-09-30T18:48:36.230Z",
"deletedAt": null
}
}

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": [
"each value in daysOfWeek must be one of the following values: DOM, SEG, TER, QUA, QUI, SEX, SAB",
"daysOfWeek should not be empty",
"daysOfWeek must be an array",
"minimumPaymentValue must not be less than 0",
"minimumPaymentValue must be a number conforming to the specified constraints"
],
"error": "Bad Request",
"statusCode": 400
}

Outras mensagens possíveis:

  • Os seguintes dias já possuem uma regra de pagamento para este médico: {join}
  • Um ou mais procedimentos informados não foram encontrados
{
"message": "Os seguintes dias já possuem uma regra de pagamento para este médico: {join}",
"error": "Bad Request",
"statusCode": 400
}

404 Não encontrado​

{
"message": "Médico não encontrado",
"error": "Not Found",
"statusCode": 404
}

500 Erro interno​

{
"message": "Erro ao criar regra de pagamento",
"error": "Internal Server Error",
"statusCode": 500
}