RoboLedger: Setup

Update Entity

Update an entity of the graph's reporting group. Only provided (non-null) fields are updated. Omit entity_id to target the group parent; name a subsidiary's id to edit it. ownership_pct is refused on the group parent (422), and ticker must stay unique in the graph (409). consolidation_method overrides the treatment the share implies (a new share re-derives it unless both are given), entity_role: consolidation marks the group's entity for consolidating entries, and joined_on / left_on bound its membership by month — set left_on when a subsidiary leaves the group and its history stays readable under 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/update-entity

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/update-entity
  • 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 to update. Omit to target the group parent — the single-entity default.

namestring nullable
legal_namestring nullable
uristring nullable
cikstring nullable
tickerstring nullable
exchangestring nullable
sicstring nullable
sic_descriptionstring nullable
categorystring nullable
state_of_incorporationstring nullable
fiscal_year_endstring nullable

Fiscal year-end as MM-DD (e.g. '12-31', '06-30').

tax_idstring nullable
leistring nullable
industrystring nullable
entity_typestring nullable
phonestring nullable
websitestring nullable
address_line1string nullable
address_citystring nullable
address_statestring nullable
address_postal_codestring nullable
address_countrystring nullable
ownership_pctnumber nullable

The parent's share of this entity, as a percent. Refused on the group parent, which has no owner in the graph. A new share re-derives consolidation_method unless that is given too.

consolidation_method'full' | 'equity' | 'cost' | 'none' nullable

How the group's consolidated statements treat this entity: full (its books are summed and an outside owner's share is carried as noncontrolling interest), equity (one investment line and one income line), cost (an investment at cost) or none (the group parent, the consolidation entity, a linked counterparty). Derived from ownership_pct when not given — 50 and above full, 20 to 50 equity, below 20 cost, unrecorded full — and set by a person where control is not the percentage: a managing member with a minority stake consolidates in full, a majority without control takes the equity method. On the group parent and the consolidation entity only none holds.

entity_role'operating' | 'consolidation' nullable

operating keeps a company's books. consolidation is the group's one entity for the consolidating entries — eliminations, noncontrolling interest, the equity-method pick-up — the adjustments column of a consolidation worksheet, which only the consolidated statements read and no operating company's statements ever include. Its method is none. Refused on the group parent. Marking an entity consolidation sets its method to none.

joined_onstring date nullable

The month this entity became a member of the group, as any date in it; null is a member since the beginning. The consolidated statements include it from that month. Membership is by month: a period column wider than a month that overlaps the interval is summed whole, so a member's books in this graph should hold only the months it belonged. Pass null to clear it. Refused on the consolidation entity.

left_onstring date nullable

The month this entity left the group, as any date in it; null is a member still. The consolidated statements include it through that month and leave it out after. Membership is by month: a period column wider than a month that overlaps the interval is summed whole, so a member's books in this graph should hold only the months it belonged. Must not precede joined_on. Set it when a subsidiary is sold, dissolved or deconsolidated; its closed months and stamped statements stay readable under the group. Pass null to reopen membership. Refused on the consolidation entity.

Example request

{
  "entity_type": "corporation",
  "fiscal_year_end": "12-31",
  "legal_name": "Acme Corporation, Inc.",
  "name": "Acme Corp",
  "state_of_incorporation": "DE",
  "tax_id": "12-3456789"
}

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.