Skip to main content
Docs vCurrent•API —
Version: Current

Hospital billing routes

GET /api/v1/billing/summary​

Aggregated financial summary per organization. Required scope: billing:read.

GET /api/v1/billing/transactions​

Statement of billable transactions. Required scope: billing:read. Query params: limit (default 100), offset (default 0), invoice_id (optional).

GET /api/v1/billing/estimate​

Cost projection over a period. Required scope: billing:read. Query params: period_days (1 to 365, default 30).

GET /api/v1/billing/invoices​

Lists the organization's invoices. Required scope: invoices:read.

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

Details a specific invoice. Required scope: invoices:read.

Response 200 (real example — 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
}

Error responses​

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

Full catalog: Responses & Error Codes.