activity_capacity

Read available, reserved, consumed and expired native-unit capacity at a cutoff. Does not expire lots or change balances.

What it shows

Native lot quantities with posted balances and effective free/reserved/consumed/expired capacity. Derives expiry at as_of even when alarms have not run; never posts or chooses monetary breakage policy. A vendor contract with credit pools adds pools: each pool’s balance (compare it with the vendor’s console), accrued overflow and open lots with face, drawn, remaining, cost released and expiry.

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_capacity",
  "contract_id": "ctr_example",
  "as_of": "2026-09-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_capacity"
    },
    "contract_id": {
      "description": "Resolved activity-contract subject ID.",
      "type": "string",
      "minLength": 1
    },
    "as_of": {
      "description": "The date (YYYY-MM-DD) or UTC timestamp (RFC 3339) the report is taken at. A date is a UTC day and includes everything on it; a timestamp includes everything before that moment.",
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "kind",
    "contract_id",
    "as_of"
  ]
}