@get-asset/react
AssetCashflowCard
Styled card showing starting and ending bank balances for two periods with the net change in cash for each. Periods are derived from the AssetProvider's year/month — with a month set, the prior month and the selected month; with no month, the prior year and the selected year.
Built on the headless CashflowCard compound from @get-asset/sdk.
Preview
Cashflow
2025
2026
Starting Balance
$42,000.00
$55,000.00
Ending Balance
$55,000.00
$61,500.00
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. |
month | number | null | — | Override the AssetProvider's month (1-12). When set, the card shows that month vs. the previous month; null forces a year-vs-prior-year comparison. Omit to inherit from the provider. |
periods | CashflowPeriodOverride[] | — | Override fetched data (always two entries: previous, current). Each entry: { start, startingBalance, endingBalance, changeInCash? }. |
state | "loading" | "error" | — | Force a specific state for testing. |
locked | boolean | — | Gate the report for a viewer who isn't entitled to it. Activates the SDK's Locked state: the period table renders blurred and inert as a teaser behind a lock and the upgrade CTA. No live fetch runs while locked — the teaser shows built-in placeholder data (a `periods` override still wins). |
upsell | { title?, description?, ctaLabel?, onUpgrade? } | — | Customize the locked state's copy and action. `ctaLabel` and `onUpgrade` are the tenant's upgrade wording and handler; `title` / `description` default per report. |
className | string | — | Forwarded to the outer card element. |
States
Loading
Cashflow
2025
2026
Starting Balance
Ending Balance
Success
Cashflow
2025
2026
Starting Balance
$42,000.00
$55,000.00
Ending Balance
$55,000.00
$61,500.00
EmptyNo periods returned.
Cashflow
No data for this period.
Error
Cashflow
We couldn't load your Cashflow. Refresh the page or click try again.
LockedViewer isn't entitled to the report — a built-in placeholder teaser renders blurred behind the upgrade prompt. Pass `upsell` to customize the copy and wire `onUpgrade`.