facade

Get Revenue

Read provider revenue and explicitly attested project finance.

Views:

  • connection: provider connection and freshness state.
  • metrics: current gross MRR/ARR, net charge volume, collections and health.
  • evidence: recent immutable ingestion evidence for calculation drilldown.
  • bindings: suggested, confirmed, or rejected commercial-object bindings.
  • account: confirmed USD account revenue, invoices and latest recorded charge.
  • service_margin: finance-attested project margin for an exact closed period.
  • finance_workspace: current statement, finance documents and account-period labor for guided review; offset pages documents and source_ids retain selected records.
post/api/facade/get_revenue

Request

  • Base URL: https://api.vruum.ai
  • URL: https://api.vruum.ai/api/facade/get_revenue
  • Auth: HTTPBearer (a scheme the document does not define)

Request body

view'connection' | 'metrics' | 'evidence' | 'bindings' | 'account' | 'service_margin' | 'finance_workspace' required
source_idsstring[]
journey_idstring uuid nullable
period_startstring date nullable
period_endstring date nullable
knowledge_cutoffstring date-time nullable
company_idstring uuid nullable

Required for the account view.

offsetinteger

Account records pagination offset.

currencystring nullable
limitinteger
cursorstring nullable

Opaque evidence pagination cursor from the previous next_cursor.

metric'current_gross_mrr_minor' | 'current_gross_arr_minor' | 'net_successful_charge_volume_mtd_minor' nullable
binding_status'suggested' | 'confirmed' | 'rejected'

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.