@get-asset/sdk

Revenue Card

Headless compound that fetches a period's revenue and the prior-period baseline, exposing the value, percent change, and tone as composable parts. The reporting range defaults to the AssetProvider's shared range (driven by the DatePicker), and the baseline mirrors it — the previous month, quarter, or year for a period-shaped range, or the same number of days immediately before a custom one.

Anatomy

Import the primitive and compose the parts you need.

<RevenueCard.Root
  dateFrom="2026-01-01"
  dateTo="2026-12-31"
  onViewDetails={({ period, basis }) => router.push(`/reports?year=${period?.year}&basis=${basis}`)}
>
  <RevenueCard.ViewDetails>View details</RevenueCard.ViewDetails>
  <RevenueCard.Loading>…</RevenueCard.Loading>
  <RevenueCard.Error>
    <RevenueCard.ErrorMessage />
    <RevenueCard.Retry />
  </RevenueCard.Error>
  <RevenueCard.Success>
    <RevenueCard.Period />
    <RevenueCard.Revenue />
    <RevenueCard.Change />
    <RevenueCard.Tone>{/* data-tone="positive" */}</RevenueCard.Tone>
  </RevenueCard.Success>
</RevenueCard.Root>

Required scopes

The access token used by AssetProvider must include these scopes for this primitive to fetch data successfully:

report:read
business:read

API reference

Root props

Prop	Type	Default	Description
`dateFrom`	`CalendarDateString`	—	Inclusive start (YYYY-MM-DD) of a fixed reporting range. Detaches the card from the AssetProvider's shared range entirely — pass it together with dateTo; one without the other throws. Use periodDateRange to derive the pair from a month, quarter, or year. Omit both and the card follows the provider's range, which the DatePicker drives.
`dateTo`	`CalendarDateString`	—	Inclusive end (YYYY-MM-DD) of the fixed reporting range. Must be paired with dateFrom. The prior-period baseline mirrors whatever range resolves — the previous month, quarter, or year for a period-shaped range, or the same number of days immediately before a custom one.
`revenue`	`number`	—	Override fetched revenue. Skips the API call.
`previousRevenue`	`number`	—	Override fetched prior-period revenue.
`state`	`"loading" \| "error"`	—	Force a specific state for testing.
`locked`	`boolean`	—	Gate the report for an unentitled viewer. Activates the Locked state and skips the API fetch. See /docs/sdk/locked-upsell.
`upsell`	`{ title?, description?, ctaLabel?, onUpgrade? }`	—	Locked-state copy + upgrade handler; merged field-by-field over the card's default copy, then the generic fallback.
`onViewDetails`	`(ctx: { range, period, basis }) => void`	—	Callback fired when the viewer asks to see more details (e.g. to navigate to the full report). Makes RevenueCard.ViewDetails render. Receives the card's resolved range, the exact period it represents (or null for a custom range) and the accounting basis, so the destination can open on the same window the card shows.
`basis`	`"accrual" \| "modified_cash"`	—	Report on a specific accounting basis. Omit to inherit the AssetProvider's basis, which itself falls back to the Business's country — Canadian Businesses report on Accrual, everyone else on Cash (see Accounting basis).
`basisToggle`	`boolean`	—	Let the end user flip between Cash and Accrual. Off by default — BasisSelect renders nothing until it's set. Flipping the control moves every component that inherits the provider's basis, so it can't leave a screen half cash and half accrual (see Accounting basis).
`children`required	`ReactNode`	—	Compound parts.

Parts

Container

Always rendered. Provides data and context to its children.

Part	Description
`RevenueCard.Root`	Fetches the current and previous period P&L and provides context.
`RevenueCard.Basis` `asChild?`	Renders the active basis as text ("Accrual" / "Cash") and sets data-basis. Rendered whether or not the toggle is enabled.
`RevenueCard.BasisSelect`	Wires basis state to a Select-Root-shaped child (injects value + onValueChange). Renders nothing unless basisToggle is enabled.
`RevenueCard.BasisItems`	Iterates the Accrual / Cash options, providing per-option context.
`RevenueCard.BasisItem` `asChild?`	Renders one basis option. Injects value and the option label.
`RevenueCard.ViewDetails` `asChild?`	Button that fires Root's onViewDetails callback with the card's resolved { range, period, basis } — the viewer's way to ask for more details (e.g. the full report). Renders nothing unless onViewDetails is set. Use asChild to slot a router Link or anchor instead; the handler still fires.

Success

Renders children when revenue is available.

Part	Description
`RevenueCard.Success`	State wrapper. Compose the value UI inside.
`RevenueCard.Period` `asChild?`	Renders the resolved period — defaults to MMM YYYY, Q<N> YYYY, or YYYY, falling back to the range label (e.g. 7 – 14 Jan 26) for a custom range. Pass format(range, period) to override.
`RevenueCard.Revenue` `asChild?`	Renders the revenue value for the resolved range.
`RevenueCard.Change` `asChild?`	Renders the period-over-period percent change.
`RevenueCard.Tone` `asChild?`	Wrapper that adds data-tone="positive" \| "negative" \| "neutral" to its child for styling.

Loading

Renders children only while the fetch is in flight.

Part	Description
`RevenueCard.Loading`	State wrapper. Render any skeleton or placeholder UI inside.

Error

Renders children when the fetch fails.

Part	Description
`RevenueCard.Error`	State wrapper. Compose the error UI inside.
`RevenueCard.ErrorMessage` `asChild?`	Renders the error's message string.
`RevenueCard.Retry` `asChild?`	Button that re-runs the fetch on click.

Locked

Renders when `locked` is set — the viewer isn't entitled to the report. Mutually exclusive with the other states, and no data is fetched. See the Locked / upsell guide for composing the teaser + upgrade UI.

Part	Description
`RevenueCard.Locked`	State wrapper. Compose the upgrade / upsell UI inside — see LockedUpsell.

Unlocked

Renders whenever the card is NOT locked — the inverse of Locked.

Part	Description
`RevenueCard.Unlocked`	State wrapper. Renders children whenever the card isn't locked.

Hooks

Part	Description
`useRevenueCard()`	Hook returning the full context value (range, period, previousRange, previousPeriod, revenue, change, tone, basis, setBasis, onViewDetails, loading, error, locked, retry).

Accounting basis

RevenueCard reports on one of two accounting bases: Accrual (accrual on the wire), which counts invoices and bills when they are issued, or Cash (modified_cash), which counts them when the money moves. Cashflow components take no basis — cashflow is a cash concept.

The basis is resolved per component, first match winning:

the card's own basis prop;
the provider's basis — defaultBasis on AssetProvider, or whatever the toggle was last flipped to;
the Business's country — Canadian Businesses report on Accrual, everyone else on Cash.

Only the last step costs a request — a Business read, which is why every basis-aware component's scopes includes business:read — and it is serial: the card holds its own fetch until the Business answers. One request is shared across every basis-aware component on the screen, but pass defaultBasis on AssetProvider when you already know the basis and skip it entirely. If the lookup fails the card falls back to Cash and stays there — retry() re-runs the report query, not the basis lookup.

basisToggle is off by default: RevenueCard.BasisSelect renders nothing and the card reports on its resolved basis. Turn it on and flipping the control moves every basis-aware component under the provider with it, so the toggle can never leave a screen half cash and half accrual. A component pinned with its own basis prop is the exception — it keeps the basis you gave it and renders no toggle of its own, which is how you show both bases side by side on purpose.

RevenueCard.Basisrenders the active basis as text ("Accrual" / "Cash") and sets data-basis, whether or not the toggle is enabled — use it to label the figures even on a screen that offers no control.