Browse the extensions reference

Record Deconsolidation

post/extensions/roboledger/{graph_id}/operations/record-deconsolidation

Part of RoboLedger: Ledger & Events.

Record a member's leaving the group, once left_on is set on it: what the parent received for its shares in cents (0 for a dissolution) and the basis. It writes a draft in the consolidation entity, dated the first day of the month after the member's last, that its close posts: what the consolidation entity still holds for the member on its balance-sheet accounts and as the outside owners' interest is taken off (goodwill, step-ups, the price above book of the investment, the outside owners' accumulated share), a member in full has the results it earned in the group put back into the group's equity as they leave with its books, and the difference is the gain or loss on its leaving: the group's adjustment to the gain the parent's own books took, so the consolidated gain is the consideration less the carrying amount of what left (ASC 810). The investment and intercompany eliminations go back on their own in that month's proposals. The parent's own sale entry stays on its books. Recording again replaces the draft; a posted deconsolidation is reversed first. A retained interest is not supported yet.

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

NameTypeDescription
graph_idrequiredstringGraph Id

Constraints: matches ^(kg[a-f0-9]{16,}(?:_[a-zA-Z0-9]{1,20})?|sec(?:_[a-zA-Z0-9]{1,20})?|library)$

Header parameters

NameTypeDescription
Idempotency-KeyoptionalstringIdempotency-Key

Request body

Required, application/json.

FieldTypeDescription
entity_idrequiredstring

The member that left: its left_on is set.

considerationrequiredinteger

Cents the parent received for its shares; 0 for a dissolution or an abandonment. Recorded with the entry for the record: the parent's own books hold the sale, cash against its investment and its own gain or loss, which this entry adjusts to the group's.

Constraints: at least 0

basisrequiredstring

The sale agreement, the dissolution, or what sets the price.

Constraints: at least 1 character

Example request

curl
curl -X POST "https://api.robosystems.ai/extensions/roboledger/{graph_id}/operations/record-deconsolidation" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Idempotency-Key: <Idempotency-Key>" \
  -H "Content-Type: application/json" \
  -d '{
  "entity_id": "string",
  "consideration": 0,
  "basis": "string"
}'

Responses

200 Successful Response

FieldTypeDescription
operationrequiredstring

Kebab-case operation name

operationIdrequiredstring

op_-prefixed ULID for audit and SSE correlation

statusrequiredstring

Operation lifecycle state

One of: completed, pending, failed

resultoptionalDeconsolidationResponse

Command-specific result payload

DeconsolidationResponse fields
FieldTypeDescription
entity_idrequiredstring

The member that left.

entity_namerequiredstring

The member's name.

left_onrequiredstring (date)

The day it left, as the entity records.

periodrequiredstring

The month the entry is dated in, as YYYY-MM: the first the group reads without the member.

considerationrequiredinteger

Cents the parent received.

derecognizedoptionalDerecognizedBalance[]

What the consolidation entity held for the member beyond the eliminations its leaving reverses on their own, each taken off.

DerecognizedBalance fields
FieldTypeDescription
conceptrequiredstring

The rs-gaap concept.

amountrequiredinteger

Cents as held: positive a debit (goodwill, a step-up), negative a credit (the outside owners' interest, the price above book of the parent's investment).

earnings_restoredoptionalinteger

Cents: the member's results since it joined, credited to the group's equity as they leave with its books; they were the group's income. Zero for an equity-method member, whose books were never summed.

Default: 0

gain_lossrequiredinteger

Cents, a gain positive: the group's adjustment to the parent's own gain or loss on the sale, so the consolidated gain is the consideration less the carrying amount of what left (ASC 810).

entryrequiredJournalEntryResponse

The deconsolidation entry, a draft the close posts.

JournalEntryResponse fields
FieldTypeDescription
idrequiredstring
transaction_idoptionalstring
typerequiredstring
statusrequiredstring
posting_daterequiredstring (date)
memooptionalstring
provenanceoptionalstring
reversal_ofoptionalstring
posted_atoptionalstring (date-time)
line_itemsrequiredJournalEntryLineItemResponse[]

One line in a journal entry response.

total_debitrequiredinteger
total_creditrequiredinteger
adjustment_kindoptionalstring
adjusts_entity_idoptionalstring
replacedoptionalboolean

True when it replaced an earlier draft of the deconsolidation.

Default: false

atrequiredstring

ISO-8601 UTC timestamp

createdByoptionalstring

User ID that initiated the operation

idempotentReplayoptionalboolean

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

Default: false

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