@get-asset/react
AssetCashflowReport
Styled multi-period cashflow table. The card header carries a period Select (Month / Quarter / Year) wired to the SDK's internal breakdown state — switching it re-fetches the report and the table re-renders with one column per period. Subtotal rows render bold; nested ledger rows are indented by depth. The download button next to the period selector exports the same view as an XLSX file, using whatever query parameters the table is currently displaying. Below the responsive breakpoint the table collapses to a single column with an arrow-picker period strip; above it, the period header sticks to the top of the page when scrolling.
Built on the headless CashflowReport compound from @get-asset/sdk.
Preview
Cashflow Report
Required scopes
The access token used by AssetProvider must include this scope for this primitive to fetch data successfully:
report:read
API reference
Root props
| Prop | Type | Default | Description |
|---|---|---|---|
year | number | — | Override the AssetProvider's year. The report is always scoped to the selected fiscal year; breakdown controls how that year is broken down. |
month | number | null | — | Override the AssetProvider's month (1-12). When set, the report locks to that single month — only one column is rendered and the header Select disables Quarter / Year. |
defaultBreakdown | "month" | "quarter" | "year" | — | Initial value of the Select. Defaults to "year". year → 1 column, quarter → 4 columns (Q1-Q4), month → 12 columns (Jan-Dec). Ignored when month is locked. |
records | ReportLine[] | — | Override fetched data with a single snapshot. |
state | "loading" | "error" | "empty" | — | Force a specific state for testing. |
className | string | — | Forwarded to the outer card element. |