@get-asset/sdk

Cashflow Summary Card

Headless compound that fetches the cash-flow report for the range on screen, broken down by month, and exposes per-month money in and money out. It sums each month's gross inflows (positive movements) and outflows (negative movements) across the report's flow sections — excluding the starting / ending balances and the net-change line. Each value is also available as a 0–1 ratio against a shared scale, so a diverging bar chart can render inflows upward and outflows downward from a common $0 axis. It also exposes the range's net cashflow, money in and money outtotals for the header. The series covers every calendar month the range overlaps — a whole year gives the familiar twelve — and follows the AssetProvider's shared range (driven by the DatePicker) unless dateFrom / dateTo pin it.

Anatomy

Import the primitive and compose the parts you need.

<CashflowSummaryCard.Root dateFrom="2026-01-01" dateTo="2026-12-31">
  <CashflowSummaryCard.Net />
  <CashflowSummaryCard.TotalIn />
  <CashflowSummaryCard.TotalOut />
  <CashflowSummaryCard.Success>
    <CashflowSummaryCard.Months>
      <CashflowSummaryCard.Month />
      <CashflowSummaryCard.MoneyIn />
      <CashflowSummaryCard.MoneyInBar />
      <CashflowSummaryCard.MoneyOut />
      <CashflowSummaryCard.MoneyOutBar />
    </CashflowSummaryCard.Months>
  </CashflowSummaryCard.Success>
  <CashflowSummaryCard.Loading>…</CashflowSummaryCard.Loading>
  <CashflowSummaryCard.Empty>No data yet.</CashflowSummaryCard.Empty>
</CashflowSummaryCard.Root>

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

Parts