@get-asset/react
Cashflow Report
Styled multi-period cashflow table over the reporting range — the provider's DatePicker-driven range unless dateFrom / dateTodetach it. 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 the range covers. 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
Loading preview…
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 |
|---|---|---|---|
dateFrom | CalendarDateString | — | Inclusive start (YYYY-MM-DD) of a fixed reporting range. Detaches the report from the provider's shared range entirely; must be paired with dateTo (passing one without the other throws). Use periodDateRange to derive the pair from a month/quarter/year. Omit both to follow the provider's DatePicker-driven range. |
dateTo | CalendarDateString | — | Inclusive end (YYYY-MM-DD) of the fixed reporting range. Must be paired with dateFrom. |
defaultBreakdown | "month" | "quarter" | "year" | — | Initial value of the Select. Defaults to "year". The table renders one column per year, quarter, or month the range covers. Ignored when the range is exactly one calendar month or quarter — the Select is then locked to the matching option. |
records | ReportLine[] | — | Override fetched data with a single snapshot. |
state | "loading" | "error" | "empty" | — | Force a specific state for testing. |
basis | "accrual" | "modified_cash" | — | Report on a specific accounting basis. Omit to inherit the AssetProvider's basis (the Business's country default). |
basisToggle | boolean | — | Show the Cash/Accrual control in the header. Off by default; flipping it moves every basis-aware component under the provider. |
onLedgerSelect | (ledgerId: string) => void | — | Called with a row's ledger id when the viewer picks it (click or keyboard). When set, ledger rows render as interactive links; group headings and calculated rows stay inert. |
className | string | — | Forwarded to the outer card element. |
States
Loading preview…
Loading preview…
Loading preview…
Loading preview…