recognition

Read actual deferred revenue, releases and refunds. Legacy planned releases are conditional forecasts; priced-right forecasts are unsupported.

What it shows

Actual deferred revenue, releases and refunds by activity. Priced-right actuals are included; their forecasts are listed as unsupported. Optional planned releases use current accepted schedules; missing facts remain contingent. The preview is bounded to 36 months past as_of and 1000 entries per report; plannedThrough and truncated say what was planned.

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.

Field	Type	Required	Meaning and accepted values
`as_of`	string	Yes	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. A calendar date includes the whole UTC day (exclusive cutoff); an explicit timestamp keeps the stated instant. Format: moment. Example: `"2026-09-01"`.
`contract_id`	string	No	Resolved activity-contract subject ID.
`through`	string	No	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. A calendar date includes the whole UTC day (inclusive cutoff); an explicit timestamp keeps the stated instant. Format: moment.
`party_id`	string	No	Party subject ID.
`document_id`	string	No	An invoice or bill document. Priced rights follow its obligation through recognition; right-scoped refunds without document attribution refuse this filter.

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": "recognition",
  "as_of": "2026-09-01"
}

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": "recognition"
    },
    "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
    },
    "contract_id": {
      "description": "Resolved activity-contract subject ID.",
      "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
    },
    "party_id": {
      "description": "Party subject ID.",
      "type": "string",
      "minLength": 1
    },
    "document_id": {
      "description": "An invoice or bill document. Priced rights follow its obligation through recognition; right-scoped refunds without document attribution refuse this filter.",
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "kind",
    "as_of"
  ]
}