Skip to main content
GET
Get financial summary with trends

Authorizations

Authorization
string
header
required

Partner-level JWT token (unscoped). Token payload includes partner_id. Business access is validated via partner ownership. Format: Bearer <your-jwt-token>

Use this for: Multi-business operations where the business_id is specified in the URL and partner has access to multiple businesses.

Path Parameters

business_id
string<uuid>
required

Business UUID

Query Parameters

end_date
string<date>
required

Report period end date (YYYY-MM-DD)

granularity
enum<string>
default:monthly

Period granularity: 'monthly', 'quarterly', or 'yearly'

Available options:
monthly,
quarterly,
yearly
start_date
string<date>
required

Report period start date (YYYY-MM-DD)

Response

business_id
string<uuid>
required

Business UUID

start_date
string<date>
required

Report period start

end_date
string<date>
required

Report period end

currency
string
required

Business base currency (e.g., EUR, GBP, USD)

granularity
enum<string>
required

Period granularity: 'monthly', 'quarterly', or 'yearly'

  • monthly - monthly
  • quarterly - quarterly
  • yearly - yearly
Available options:
monthly,
quarterly,
yearly
summary
object
required

Overall totals for entire date range

Period-by-period breakdown