Browse the extensions reference

informationBlock

returns InformationBlock

Fetch a single Information Block envelope by id.

scenarioId selects the FactSet slice: omitted = actuals; a forecast block's structure id = that scenario's parallel universe (statement envelopes bind its latest computed month, metric envelopes extend the series with its forward columns, labeled "(forecast)").

series renders a statement block as its whole report-set time series — one column per period, actuals-preferred at the seam when combined with scenarioId; forecast columns carry periods[].forecast = true. Non-statement block types ignore it.

seriesHistory / seriesForecast window the series to its seam-adjacent columns — the last N actual columns and the first N forecast columns; omitted = unbounded. Pass the visible window so the envelope scales with the screen, not the ledger's age.

entityId picks whose books a block shared by the group reads (statements, metrics, disclosures); omitted = the scenario's entity, else the group parent. A schedule, reconciliation or forecast is one entity's own and always reads its owner's. entityId on the envelope names the entity it read.

Arguments

NameTypeDescription
idID!The block's structure id.
scenarioIdStringA forecast block's structure id. Omit for actuals.
seriesBooleanRender a statement block as its whole report-set time series, one column per period. Ignored by non-statement block types.
seriesHistoryIntCap the series at the last N actual columns. Omit for unbounded.
seriesForecastIntCap the series at the first N forecast columns. Omit for unbounded.
entityIdStringThe entity whose books a shared block reads. Omit for the group parent.

Returns InformationBlock

FieldTypeDescription
idID!—
blockTypeString!—
nameString!—
displayNameString!—
categoryString!—
taxonomyIdString—
taxonomyNameString—
disclosureIdString—
entityIdStringThe entity whose books the envelope reads: a schedule, reconciliation or forecast reads its owner's; a shared block (statements, metrics) the entity asked for, else the group parent.
informationModelInformationModel!—
artifactArtifact!—
elements[InformationBlockElement!]!—
connections[InformationBlockConnection!]!—
facts[InformationBlockFact!]!—
rules[InformationBlockRule!]!—
dimensions[JSON!]!—
factSetInformationBlockFactSet—
verificationResults[InformationBlockVerificationResult!]!—
verificationSummaryInformationBlockVerificationSummary—
viewInformationBlockViewProjections!—

Example

query
{ informationBlock(id: "rec_...") { id blockType name displayName } }
curl
curl -X POST "https://api.robosystems.ai/extensions/$GRAPH_ID/graphql" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "{ informationBlock(id: \"rec_...\") { id blockType name displayName } }"}'