Preview Consolidation Entries

post/extensions/roboledger/{graph_id}/operations/preview-consolidation-entries

The consolidating entries a group's month needs, computed from the books and posting nothing. For each member consolidated in full: the parent's investment eliminated against the member's capital (its contributions net of distributions), the outside owners' share of that capital as noncontrolling interest, the intercompany balances, the month's intercompany income against the matching expense, and the outside owners' share of the month's result; for each member on the equity method, the parent's share of its result. Accounts are found by the rs-gaap concept they map to, and an intercompany line by the group entity its event names as counterparty. Each entry is the difference between the balance its kind should hold for the member at the month end and what the consolidation entity already holds, so the entries a person posted with the same kind count. A difference between the parent's investment and its share of a member's capital is returned as a residual and its entry withheld, never plugged; intercompany figures the two sides do not agree on are returned as reconciling items. Rejected on shared-repository graphs.

Idempotency: supply an Idempotency-Key header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.

Authentication

Authenticate in any one of these ways — not all of them:

API key in the X-API-Key header.
Bearer token in the Authorization header.

Path parameters

Name	Type	Description
`graph_id`required	string	Graph Id Constraints: matches `^(kg[a-f0-9]{16,}(?:_[a-zA-Z0-9]{1,20})?\|sec(?:_[a-zA-Z0-9]{1,20})?\|library)$`

Header parameters

Name	Type	Description
`Idempotency-Key`optional	string	Idempotency-Key

Request body

Required, application/json.

Field Type Description

Field	Type	Description
`period`required	string	The month, as YYYY-MM. Constraints: matches `^\d{4}-(0[1-9]\|1[0-2])$`

periodrequired

string

The month, as YYYY-MM.

Constraints: matches ^\d{4}-(0[1-9]|1[0-2])$

Example request

curl

curl -X POST "https://api.robosystems.ai/extensions/roboledger/{graph_id}/operations/preview-consolidation-entries" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Idempotency-Key: <Idempotency-Key>" \
  -H "Content-Type: application/json" \
  -d '{
  "period": "string"
}'

Responses

200 Successful Response

Field Type Description

operationrequired

string

Kebab-case operation name

operationIdrequired

string

op_-prefixed ULID for audit and SSE correlation

statusrequired

string

Operation lifecycle state

One of: completed, pending, failed

resultoptional

PreviewConsolidationEntriesResponse

Command-specific result payload

PreviewConsolidationEntriesResponse fields

Field Type Description

periodrequired

string

The month, as YYYY-MM.

period_startrequired

string (date)

The month's first day.

period_endrequired

string (date)

The month's last day.

consolidation_entity_idrequired

string

The entity the entries post in.

proposalsoptional

ConsolidationProposal[]

The entries to post; empty when the month is up to date.

ConsolidationProposal fields

Field	Type	Description
`adjustment_kind`required	string	What the entry adjusts. One of: `elimination_investment`, `elimination_intercompany`, `elimination_unrealized_profit`, `nci_allocation`, `nci_distribution`, `equity_method_pickup`, `equity_method_distribution`, `acquisition`, `deconsolidation`, `translation`, `manual`
`adjusts_entity_id`required	string	The entity whose figures the entry adjusts.
`adjusts_entity_name`required	string	That entity's name.
`posting_date`required	string (date)	The month's last day.
`memo`required	string	The entry's memo.
`basis`required	string	How the amounts were computed.
`lines`required	ConsolidationProposalLine[]	The entry's lines; they balance.

residualsoptional

ConsolidationResidual[]

Differences withheld from the proposals until explained.

ConsolidationResidual fields

Field	Type	Description
`entity_id`required	string	The member.
`entity_name`required	string	The member's name.
`amount`required	integer	Cents: the parent's investment balance less its share of the member's capital. Positive when the parent carries more than its share.
`explanation`required	string	What the two figures are.

reconciling_itemsoptional

ConsolidationReconcilingItem[]

Intercompany figures the two sides do not agree on.

ConsolidationReconcilingItem fields

Field	Type	Description
`entity_ids`required	string[]	The two entities.
`concept`required	string	The rs-gaap concept left uneliminated.
`entity_id`required	string	The entity whose figure is left.
`amount`required	integer	Cents left uneliminated, debit-positive.
`description`required	string	What does not agree.

notesoptional

string[]

Anything the engine left out, and why.

up_to_daterequired

boolean

True when nothing is proposed, withheld or left out: the consolidation entity already holds what the month needs. A closed month is up to date as posted; read closed first.

closedoptional

boolean

True when the consolidation entity has closed the month: its entries are as posted, and nothing is recomputed.

Default: false

drafted_entry_idsoptional

string[]

The month's drafts propose-consolidation-entries wrote, waiting for the consolidation entity's close to post them.

atrequired

string

ISO-8601 UTC timestamp

createdByoptional

string

User ID that initiated the operation

idempotentReplayoptional

boolean

True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.

Default: false

Status	Meaning
400	Invalid request
401	Authentication required
403	Access denied
404	Resource not found
409	Idempotency-Key conflict — key reused with different body
422	Validation error
429	Rate limit exceeded
500	Internal server error