Propose Consolidation Entries

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

Draft a month's consolidating entries in the group's consolidation entity: what preview-consolidation-entries computes, written as drafts that the consolidation entity's close posts. Proposing the month again replaces the drafts it wrote before, so it can be run after any member's books change; a person's own entries are never touched. Lines that eliminate a cash flow carry the row they offset. A residual or a disagreement is returned beside the drafts, never plugged; a month the consolidation entity has closed is left as posted.

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/propose-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

ProposeConsolidationEntriesResponse

Command-specific result payload

ProposeConsolidationEntriesResponse fields

Field Type Description

periodrequired

string

The month, as YYYY-MM.

consolidation_entity_idrequired

string

The entity the drafts are in.

closedoptional

boolean

True when the month is closed and nothing was drafted.

Default: false

entriesoptional

JournalEntryResponse[]

The drafts written; the consolidation entity's close posts them.

JournalEntryResponse fields

Field	Type	Description
`id`required	string
`transaction_id`optional	string
`type`required	string
`status`required	string
`posting_date`required	string (date)
`memo`optional	string
`provenance`optional	string
`reversal_of`optional	string
`posted_at`optional	string (date-time)
`line_items`required	JournalEntryLineItemResponse[]	One line in a journal entry response.
`total_debit`required	integer
`total_credit`required	integer
`adjustment_kind`optional	string
`adjusts_entity_id`optional	string

replacedoptional

integer

Earlier drafts of this month's entries, replaced by these.

Default: 0

residualsoptional

ConsolidationResidual[]

Differences withheld from the drafts 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.

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