Pular para o conteúdo principal
Docs vAtual•API —
Versão: Atual

Rotas de faturamento do hospital

GET /api/v1/billing/summary​

Resumo financeiro agregado por organização.

Scope exigido: billing:read

GET /api/v1/billing/transactions​

Extrato de transações faturáveis.

Scope exigido: billing:read

Query params:

  • limit (default 100)
  • offset (default 0)
  • invoice_id (opcional)

GET /api/v1/billing/estimate​

Projeção de custo por período.

Scope exigido: billing:read

Query params:

  • period_days (1 a 365, default 30)

GET /api/v1/billing/invoices​

Lista faturas da organização.

Scope exigido: invoices:read

GET /api/v1/billing/invoices/{invoice_id}​

Detalha uma fatura específica.

Scope exigido: invoices:read

Resposta 200 (exemplo real — GET /api/v1/billing/summary)​

{
  "total_transactions": 233,
  "pending_transactions": 233,
  "total_billed_brl": 273.5,
  "total_open_invoices_brl": 0.0,
  "total_paid_invoices_brl": 0.0
}

Respostas de erro​

HTTPdetail
401API key required
403Scope insuficiente para esta API key (requer billing:read / invoices:read)
404Fatura não encontrada (em /billing/invoices/{invoice_id})
{ "detail": "Scope insuficiente para esta API key" }

Catálogo completo: Respostas e Códigos de Erro.