Get financial report

GET

/api/v1/reports/financial

curl --request GET \
  --url 'https://api.ultimateteam.ai/api/v1/reports/financial?type=pnl&period=monthly' \
  --header 'X-API-Key: <X-API-Key>'

• Production
• Local development

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

Authorizations

• ApiKeyAuth

Parameters

Query Parameters

type

required

FinancialReportType

Type of financial report to generate

string

Allowed values: pnl cashflow unit_economics

Type of financial report to generate

period

required

FinancialPeriod

Reporting period

string

Allowed values: monthly quarterly

Reporting period

Responses

200

Successful Response

Media typeapplication/json

FinancialReportResponse

Envelope response for the financial report endpoint.

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

object

data

required

FinancialReportData

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

required

FinancialReportEvidence

object

cash_source

Any of:

string

string

Allowed value: GeneralLedger

null

null

closing_balance_cents

Any of:

integer

integer

null

null

currency

Any of:

string

string

Allowed value: USD

null

null

data_status

required

Data Status

string

Allowed values: ready unavailable

inflows_cents

Any of:

integer

integer

null

null

ledger_end_date

Any of:

string

string format: date

null

null

ledger_start_date

Any of:

string

string format: date

null

null

net_cash_flow_cents

Any of:

integer

integer

null

null

observed_at

Any of:

string

string format: date-time

null

null

opening_balance_cents

Any of:

integer

integer

null

null

outflows_cents

Any of:

integer

integer

null

null

period_basis

required

Period Basis

string

Allowed values: month_to_date quarter_to_date

period_end

required

Period End

string format: date

period_start

required

Period Start

string format: date

reason

Any of:

string

string

null

null

source_connection_id

Any of:

string

string format: uuid

null

null

generated_at

required

Generated At

string format: date-time

period

required

FinancialPeriod

Allowed financial report periods.

string

Allowed values: monthly quarterly

report_type

required

FinancialReportType

Allowed financial report types.

string

Allowed values: pnl cashflow unit_economics

meta

ResponseMeta

Standard metadata included in every API response.

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

object

request_id

Request Id

Unique identifier for this request

string

timestamp

Timestamp

When the response was generated

string format: date-time

Example

{
  "data": {
    "data": {
      "cash_source": "GeneralLedger",
      "currency": "USD",
      "data_status": "ready",
      "period_basis": "month_to_date"
    },
    "period": "monthly",
    "report_type": "pnl"
  }
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

ctx

Context

object

input

Input

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}