Skip to main content

GET Relatório de Produtividade

Relatório de produtividade calculado. Calcula totais, despesas, comissão e lucro por período e consolidado do dia.

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​

GET https://api-dev.imagemais.com.br/api/productivity/report

Parâmetros de Query​

NomeTipoObrigatórioValores válidosDescrição
datestring✅formato /^\d{4}-\d{2}-\d{2}$/Data do relatório no formato YYYY-MM-DD
doctorIdstring❌—ID do médico. Omitir ou "all" para todos os médicos
timezonestring❌—Fuso horário usado para agrupar os atendimentos por período

Requisição​

curl -X 'GET' \
'https://api-dev.imagemais.com.br/api/productivity/report?date=2026-09-01' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}'

Respostas​

200 Sucesso​

{
"data": {
"date": "2026-09-30",
"timezone": "America/Sao_Paulo",
"doctorId": null,
"doctorName": null,
"percentage": 0,
"showCommission": false,
"config": {
"taxPercentage": 17,
"operationalPercentage": 10,
"minimumPaymentValue": 0,
"morningEndHour": 13,
"nightStartHour": 18
},
"periods": [],
"consolidatedProfit": 0,
"doctorTotalProfit": 0
}
}

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": [
"date deve estar no formato YYYY-MM-DD",
"date must be a string"
],
"error": "Bad Request",
"statusCode": 400
}

Também retornado com a mensagem:

{
"message": "date deve estar no formato YYYY-MM-DD",
"error": "Bad Request",
"statusCode": 400
}

500 Erro interno​

Mensagens possíveis:

  • Erro ao buscar configuração de produtividade
  • Erro ao gerar relatório de produtividade
{
"message": "Erro ao buscar configuração de produtividade",
"error": "Internal Server Error",
"statusCode": 500
}