---
title: "Get Revenue"
method: POST
path: "/api/facade/get_revenue"
tags: ["facade"]
---

# Get Revenue

`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)

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.

## Request body

- GetRevenueRequest
  - `view` 'connection' | 'metrics' | 'evidence' | 'bindings' | 'account' | 'service_margin' | 'finance_workspace', required
  - `source_ids` string[]
  - `journey_id` string, uuid, nullable
  - `period_start` string, date, nullable
  - `period_end` string, date, nullable
  - `knowledge_cutoff` string, date-time, nullable
  - `company_id` string, uuid, nullable: Required for the account view.
  - `offset` integer: Account records pagination offset.
  - `currency` string, nullable
  - `limit` integer
  - `cursor` string, 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 `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/vruum/apis/vruum-public-api.md) · [All operations](https://skmtc.dev/vruum/apis/vruum-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/vruum/apis/vruum-public-api/revisions/b8ada111c30a?raw)