activity_claims

Read priced-right receivables, payables and funding claims, with their evidence, component identities and outstanding amounts. Use this to check what remains owed before allocating a payment.

What it shows

For priced-rights contracts, returns model=priced-rights-v1 and component-qualified economic claims (commercial or noncommercial), origin evidence, original amounts, outstanding balances and status. Original components and denomination remain stable through currency/legal succession; outstanding uses the actual holder currency. Omit contract_id to include every claim, including contractless unapplied money and recoverable owner/card funds. For legacy contracts, returns billing occurrence identities and native receivable/payable balances, including partial settlement.

Amounts derive from postings, never a second remaining-balance store. billed is in the invoice’s currency (unitCode); outstanding is in the currency of the ledger that holds the claim (ledgerUnitCode), with ledgerBilled translated at each functional-currency change’s rate. party_id keeps one party’s claims; with open=true, only its priced-rights claims still open now (what the party owes, or is owed), at most 50, with truncated=true when there were more; without as_of. open=false is the same as omitting it.

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_claims",
  "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": "activity_claims"
    },
    "contract_id": {
      "description": "Resolved activity-contract subject ID.",
      "type": "string",
      "minLength": 1
    },
    "party_id": {
      "description": "Party subject ID.",
      "type": "string",
      "minLength": 1
    },
    "open": {
      "description": "true returns only the party's claims still open now (needs party_id; no as_of).",
      "type": "boolean"
    },
    "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"
  ]
}