Reports

Cash flow statement (indirect method)

Cash flow computed via the indirect method. Starts from net income and reconciles by adjusting for non-cash balance sheet movements. The sum of operating + investing + financing always equals the actual cash movement for the period; any unclassified drift is surfaced as "Other net adjustments" in operating. Accepts a date range; comparePeriod returns a side-by-side comparison column.

get/companies/{companyId}/reports/cash-flow

Request

  • Base URL: https://api.medianfi.com/api/v1
  • URL: https://api.medianfi.com/api/v1/companies/{companyId}/reports/cash-flow
  • Auth: HTTP bearer

Query parameters

entityIdstring uuid

Concrete legal entity to read. Mutually exclusive with reportingScopeId/scopeAsOf. Omission is accepted only when the actor is authorized to exactly one concrete entity.

reportingScopeIdstring uuid

Immutable within-company consolidated reporting-scope identity. Must be supplied with scopeAsOf and cannot be combined with entityId.

scopeAsOfstring date

ISO date used to pin the effective sealed reporting-scope hierarchy version. Must be supplied with reportingScopeId.

startDatestring date

Inclusive period start (YYYY-MM-DD). Must be supplied together with endDate.

endDatestring date

Inclusive period end (YYYY-MM-DD). Must be supplied together with startDate.

allTime'true'

true reports from the first through the last posted month on the P&L and cash flow, where omitting startDate/endDate still returns only the latest posted month, so "all time" must be requested by name. The general ledger reads an omitted range as the whole ledger either way. Cannot be combined with startDate/endDate, month or a comparePeriod other than none (400).

comparePeriod'none' | 'prior-period' | 'prior-year'

Comparison mode. prior-period shifts back by the range length (snapped to full calendar months when the range is month-aligned). prior-year shifts both dates back 12 months. none (default) returns no comparison.

granularity'month' | 'quarter' | 'year'

Override inferred granularity. Advisory; the service still validates the actual range.

classIdstring

Optional class filter for class-aware report endpoints. Pass a company-scoped accounting class UUID, or unassigned for journal lines with no class. Customer-facing use returns data only for active approved company classes.

monthstring

Legacy month param (YYYY-MM). Prefer startDate/endDate.

Response

Cash flow payload. checks independently evaluates exact beginning-plus-statement-movement-equals-ending identity and the one-cent-tolerance ending-cash versus monthly-balance cross-check. Legacy differenceFromBalanceSheetCents remains an integer (zero when skipped); legacy isConsistent is false for any executed failure and true otherwise, including skipped checks. Optional comparison object on the payload when a comparison was requested.

successboolean

Changes

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