# revenue_summary

Read customer invoicing, matched collections, outstanding claims and recognized revenue, separately by currency.

## What it shows

Customer invoicing, attributed collections, outstanding claims and recognized revenue per currency. Independent receipts are included once matched by the period end, at their original cash date; financing and vendor payments are excluded.

## Example MCP App view

The read-only example below uses illustrative demo data and the same report component as the MCP App. These are not your books or the result of the request example.

<iframe class="docs-report-preview" src="/docs/report-previews/revenue_summary.html" title="revenue_summary report view with demo data" loading="lazy" sandbox referrerpolicy="no-referrer"></iframe>

[Open the full example view](/docs/report-previews/revenue_summary.html).

## Inputs

Send the fixed `kind` and these parameters at the top level of the report request, not inside `input`.

Required means required within its containing object; an optional parent can be omitted.

| Field | Type | Required | Meaning and accepted values |
|---|---|---|---|
| `period_start` | string | Yes | Start date (YYYY-MM-DD) or UTC timestamp (RFC 3339). A date is a UTC day and includes that whole day. A calendar date means midnight UTC at its start; an explicit timestamp keeps the stated instant. Format: moment. Example: `"2026-09-01"`. |
| `period_end` | string | Yes | End date (YYYY-MM-DD) or UTC timestamp (RFC 3339). A date is a UTC day and includes that whole day, so September ends at 2026-09-30; a timestamp includes everything before that moment. A calendar date includes the whole UTC day (exclusive cutoff); an explicit timestamp keeps the stated instant. Format: moment. Example: `"2026-09-30"`. |

## Reading the result

Running this report does not change the books. Its description above distinguishes recorded-book summaries from previews based on supplied facts or assumptions. Interpret its totals, grouping, missing-data indicators and pagination using that description. Monetary amounts are integer strings in the reported unit; ratios and assumptions can be fractional numbers. An empty result is not evidence that the business had no activity.

The public OpenAPI contract does not enumerate this report's result fields. Fetch `GET /v1/reports` for its live description and parameters, and inspect the returned JSON rather than assuming an output shape.

## Example request


```json
{
  "kind": "revenue_summary",
  "period_start": "2026-09-01",
  "period_end": "2026-09-30"
}
```


[All reports](/docs/report-reference/) · [Operation and errors](/docs/api-reference/operations/reports-run/) · [Reusable schemas](/docs/api-reference/components/)

Keep credentials out of prompts; rehearse writes only in a disposable sandbox.

## Exact request schema


```json
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "kind": {
      "const": "revenue_summary"
    },
    "period_start": {
      "description": "Start date (YYYY-MM-DD) or UTC timestamp (RFC 3339). A date is a UTC day and includes that whole day.",
      "type": "string",
      "minLength": 1
    },
    "period_end": {
      "description": "End date (YYYY-MM-DD) or UTC timestamp (RFC 3339). A date is a UTC day and includes that whole day, so September ends at 2026-09-30; a timestamp includes everything before that moment.",
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "kind",
    "period_start",
    "period_end"
  ]
}
```