Get financial summary with trends

Retrieve financial summary with revenue, expenses, and profit trends.

Returns:

• Overall summary: Total revenue, expenses, and profit for the entire period
• Trends: Period-by-period breakdown (monthly, quarterly, or yearly)

Granularity options:

• monthly (default): Show data per month
• quarterly: Show data per quarter (Q1, Q2, Q3, Q4)
• yearly: Show data per year

All values are in cents. Currency is the business’s base currency.

GET /v1/platform/businesses/{business_id}/insights/financial-summary

Get financial summary with trends

cURL

curl --request GET \
  --url https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/insights/financial-summary/ \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "start_date": "2023-12-25",
    "end_date": "2023-12-25",
    "currency": "<string>",
    "summary": {
      "total_revenue_cents": 123,
      "total_expenses_cents": 123,
      "net_profit_cents": 123
    },
    "trends": [
      {
        "period_start": "2023-12-25",
        "period_end": "2023-12-25",
        "revenue_cents": 123,
        "expenses_cents": 123,
        "net_profit_cents": 123
      }
    ]
  }
]

Authorizations

PartnerJWTBusinessScopedJWTBasicAuthBearerUnscopedBearerBusinessScoped

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

200

application/json

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

Show child attributes

trends · object[] · required

Period-by-period breakdown

Show child attributes