THthredfi
Insights

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/

Request

  • Base URL
    https://docs.thredfi.com (the document declares no server; this is the origin it was published from)
  • Auth
    • HTTP bearer
    • or HTTP bearer
    • or HTTP basic
    • or HTTP bearer
    • or HTTP bearer

Path parameters

business_idstring uuid required

Business UUID

Query parameters

end_datestring date required

Report period end date (YYYY-MM-DD)

granularity'monthly' | 'quarterly' | 'yearly'

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

start_datestring date required

Report period start date (YYYY-MM-DD)

Response

business_idstring uuid required

Business UUID

start_datestring date required

Report period start

end_datestring date required

Report period end

currencystring required

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

granularity'monthly' | 'quarterly' | 'yearly' required

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

  • monthly - monthly
  • quarterly - quarterly
  • yearly - yearly

Changes

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