Integração Corporativa

Relatório de uso

Recupere o consumo mensal do seu contrato com totais agregados e detalhamento por segurado. Ideal para conciliação com a fatura B2B.

GET/api/v1/insurer-portal/usage

X-API-Key

Parâmetros (query string)

Campo	Tipo	Descrição
`month`opcional	`string (YYYY-MM)` default: `mês atual`	Mês de referência. Se omitido, usa o mês atual.
`includeBreakdown`opcional	`boolean` default: `true`	Quando true, inclui detalhamento por segurado.

Exemplo

cURL

curl 'https://api.netguincho.com.br/api/v1/insurer-portal/usage?month=2026-04' \
  -H 'X-API-Key: live_sk_...'

Resposta (200)

JSON

{
  "month": "2026-04",
  "summary": {
    "total_requests": 47,
    "total_users_activated": 23,
    "total_users_at_limit": 4,
    "total_amount": 5640.00,
    "currency": "BRL"
  },
  "breakdown": [
    {
      "insurer_customer_id": "2a1c4f67-...",
      "name": "João da Silva",
      "cpf": "12345678900",
      "monthly_limit": 3,
      "usage": 2,
      "remaining": 1
    },
    {
      "insurer_customer_id": "5d8e2a1b-...",
      "name": "Maria Souza",
      "cpf": "98765432100",
      "monthly_limit": 5,
      "usage": 5,
      "remaining": 0
    }
  ]
}

Casos de uso

Dashboard interno: exiba o consumo do mês corrente para gestores do plano.
Conciliação financeira: compare summary.total_amount com o valor da fatura recebida.
Antecipação de bloqueios: identifique segurados próximos do limite e ajuste monthlyLimit proativamente.
Relatórios: gere CSV/Excel a partir do array breakdown.