Summary

Financial summary

Get an aggregated financial summary including revenue, expenses, profit, entity counts, and invoice status breakdown. Supports optional date range filtering.

get/v1/summary

Request

Base URL: https://api.frihet.io
URL: https://api.frihet.io/v1/summary
Auth: API key in header X-API-Key

Query parameters

fromstring date

Example:2026-01-01

Start date filter in ISO format (YYYY-MM-DD)

tostring date

Example:2026-12-31

End date filter in ISO format (YYYY-MM-DD)

Response

Financial summary

profitnumber

Net profit (paid revenue minus expenses)

invoicesByStatusobject

Example response

{
  "revenue": {
    "invoiced": 25000,
    "paid": 18500,
    "pending": 4500,
    "overdue": 2000
  },
  "expenses": {
    "total": 8200
  },
  "profit": 10300,
  "counts": {
    "invoices": 42,
    "quotes": 15,
    "expenses": 87,
    "clients": 23,
    "products": 12
  },
  "invoicesByStatus": {
    "draft": 3,
    "sent": 8,
    "paid": 28,
    "overdue": 3
  },
  "overdue": {
    "count": 3,
    "amount": 2000
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.