contract_books

Read what one priced-rights contract comes to on the books: who paid each claim and through which account, what reached the income statement, units and capital issued, and the latest period each right billed.

What it shows

Totals for one priced-rights contract, summed in the ledger from its own events and the payments that posted to its claims. paid lists each claim’s net payment per financial account (allocations less unallocations; a reversed payment counts nothing; only positive nets). reached is delivery, recognition and usage posted per currency, counting an obligation’s recognition where it has one. issued is the units and capital its live steps issued, with issued.byRight splitting the units per right (activityKey). billedThrough is each right’s latest billed period end (YYYY-MM-DD).

Reversed steps count nothing; a voided contract’s figures are for the caller to disregard. Amounts are exact integer strings in minor units; billed and outstanding amounts are in activity_claims.

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": "contract_books",
  "contract_id": "ctr_example"
}

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": "contract_books"
    },
    "contract_id": {
      "description": "Resolved activity-contract subject ID.",
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "kind",
    "contract_id"
  ]
}