activity_plan

Preview scheduled but unrecorded contract activity. Missing usage or evidence remains conditional; nothing is recorded or settled.

What it shows

Preview unrecorded scheduled activities in due-time and binding order. Fixed flows include expected postings; missing usage or evidence stays contingent. No write, settlement or cash is inferred from a due date.

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.

Open the full example view.

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.

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

{
  "kind": "activity_plan",
  "contract_id": "ctr_example",
  "from": "2026-09-01T00:00:00Z",
  "through": "2026-12-01T00:00:00Z"
}

All reports · Operation and errors · Reusable schemas

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

Exact request schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "kind": {
      "const": "activity_plan"
    },
    "contract_id": {
      "description": "Resolved activity-contract subject ID.",
      "type": "string",
      "minLength": 1
    },
    "from": {
      "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
    },
    "through": {
      "description": "End date (YYYY-MM-DD) or UTC timestamp (RFC 3339). A date is a UTC day and includes that whole day; a timestamp includes everything up to and including that moment.",
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "kind",
    "contract_id",
    "from",
    "through"
  ]
}