Skip to content
UltimateTeam.ai Docs

Get financial report

GET
/api/v1/reports/financial

Returns a financial report filtered by type (P&L, cash flow, or unit economics) and period.

Authorizations

Parameters

Query Parameters

type
required

Type of financial report to generate

string
Allowed values: pnl cashflow unit_economics

Type of financial report to generate

period
required

Reporting period

string
Allowed values: monthly quarterly

Reporting period

Responses

200

Successful Response

Envelope response for the financial report endpoint.

Attributes: data: The financial report payload. meta: Standard response metadata.

object
data
required

Inner data payload for financial report responses.

Attributes: report_type: The type of financial report. period: The reporting period. generated_at: When the report was generated. data: The report content (structure varies by report type).

object
data
object
key
additional properties
any
generated_at
required
string format: date-time
period
required

Allowed financial report periods.

string
Allowed values: monthly quarterly
report_type
required

Allowed financial report types.

string
Allowed values: pnl cashflow unit_economics
meta

Standard metadata included in every API response.

Attributes: request_id: Unique identifier for this request. timestamp: When the response was generated.

object
request_id

Unique identifier for this request

string
timestamp

When the response was generated

string format: date-time

422

Validation Error

object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string