# activity_effects

Inspect or preview a legacy activity's effects without recording it. Priced-right previews are unsupported.

## What it shows

Describe code-owned activity effects, or evaluate one frozen contract activity without writes. Supply contract_id, activity_key, effective_at and required facts to preview. Eligibility and amounts remain separate from recorded fulfillment.

## 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/activity_effects.html" title="activity_effects report view with demo data" loading="lazy" sandbox referrerpolicy="no-referrer"></iframe>

[Open the full example view](/docs/report-previews/activity_effects.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 |
|---|---|---|---|
| `contract_id` | string | No | Resolved activity-contract subject ID.  |
| `activity_key` | string | No | Activity binding key within the contract.  |
| `occurrence_key` | string | No | Stable occurrence key for exact billing claim identities; omitted previews use an unrecorded preview identity.  |
| `effective_at` | string | No | Effective date (YYYY-MM-DD) or RFC 3339 instant for activity evaluation and balances. A calendar date means midnight UTC at its start; an explicit timestamp keeps the stated instant. Format: moment. |
| `facts` | facts | No | Named observed facts: integer amounts as decimal strings, dates and text. Required names and units come from the bound activity.  |

## 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": "activity_effects"
}
```


[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": "activity_effects"
    },
    "contract_id": {
      "description": "Resolved activity-contract subject ID.",
      "type": "string",
      "minLength": 1
    },
    "activity_key": {
      "description": "Activity binding key within the contract.",
      "type": "string",
      "minLength": 1
    },
    "occurrence_key": {
      "description": "Stable occurrence key for exact billing claim identities; omitted previews use an unrecorded preview identity.",
      "type": "string",
      "minLength": 1
    },
    "effective_at": {
      "description": "Effective date (YYYY-MM-DD) or RFC 3339 instant for activity evaluation and balances.",
      "type": "string",
      "minLength": 1
    },
    "facts": {
      "description": "Named observed facts: integer amounts as decimal strings, dates and text. Required names and units come from the bound activity.",
      "type": "object",
      "maxProperties": 100,
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "kind"
  ]
}
```