Skip to content
BusinessRevenueTimelineObject

Per-day gross revenue for a contiguous date range in the business's local timezone. Shape mirrors BusinessSessionUtilizationHeatmap so homepage charts can render past activity alongside the utilization heatmap. See Business.revenueTimeline.

Fields

startString!

Inclusive start of the window as YYYY-MM-DD (business-local). Echoed back from the input verbatim.

endString!

Inclusive end of the window as YYYY-MM-DD (business-local).

todayString!

Business-local "today" as YYYY-MM-DD. Lets clients dim or otherwise distinguish the current (still-accumulating) bucket.

currencyString!

ISO 4217 currency code, lowercase (e.g. cad). Matches the dominant currency on this business's payments — or the platform default when the business has no payments yet.

totalAmountInt!

Sum of amount across all succeeded payments in the window, in subunits of currency. Equal to sum(daily[].amount).

One entry per calendar day from start through end (inclusive), zero-filled.

filtersIgnoredBoolean!

True when the caller supplied an entity dimension on the analytics filter (activity / staff / location / activity-type) that this timeline could not apply. Revenue is derived from payments, which aren't linked to those entities, so only the start/end window is honored. Lets the UI flag that the revenue card reflects the whole business for the window, not the filtered slice.

Used in

BusinessRevenueTimeline