RoboLedger: Ledger & Events

Record Opening Balance

Record the balance sheet an entity's books start from, when its history does not come with them: one balance per balance-sheet account (assets, liabilities, equity), in cents, debit or credit in the account's normal direction. It posts as one opening entry dated the day before the entity's first fiscal month, so every month's opening balances include it and no month's activity does: the cash flow and the equity statement start from it rather than counting it. Name the equity account that takes any difference between debits and credits (equity_element_id, usually Opening Balance Equity); unbalanced balances without one are refused, and an income or expense account is refused, since income before the books begin is in retained earnings. One per entity: recording it again replaces it, until the entity's first close, after which a correction is an adjusting entry in an open month. Set up the fiscal calendar first; moving its start (change-calendar-start) moves the opening with it.

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.

post/extensions/roboledger/{graph_id}/operations/record-opening-balance

Request

  • Base URL: https://api.robosystems.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.robosystems.ai/extensions/roboledger/{graph_id}/operations/record-opening-balance
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

graph_idstring required

Headers

Idempotency-Keystring nullable

Request body

entity_idstring nullable

The entity whose books start here; omit for the group parent.

equity_element_idstring nullable

The equity account that takes any difference between debits and credits, usually Opening Balance Equity. Required when the balances do not balance; a non-zero balance left there is a review item.

memostring nullable

The entry's memo; defaults to 'Opening balances'.

Response

Successful Response

operationstring required

Kebab-case operation name

operationIdstring required

op_-prefixed ULID for audit and SSE correlation

status'completed' | 'pending' | 'failed' required

Operation lifecycle state

atstring required

ISO-8601 UTC timestamp

createdBystring nullable

User ID that initiated the operation

idempotentReplayboolean

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

Changes

No recorded changes to this operation across all 1 revision of this API.