Update Entity

post/extensions/roboledger/{graph_id}/operations/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.

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
`entity_id`optional	string	The entity to update. Omit to target the group parent — the single-entity default.
`name`optional	string
`legal_name`optional	string
`uri`optional	string
`cik`optional	string
`ticker`optional	string
`exchange`optional	string
`sic`optional	string
`sic_description`optional	string
`category`optional	string
`state_of_incorporation`optional	string
`fiscal_year_end`optional	string	Fiscal year-end as MM-DD (e.g. '12-31', '06-30').
`tax_id`optional	string
`lei`optional	string
`industry`optional	string
`entity_type`optional	string
`phone`optional	string
`website`optional	string
`address_line1`optional	string
`address_city`optional	string
`address_state`optional	string
`address_postal_code`optional	string
`address_country`optional	string
`ownership_pct`optional	number	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. Constraints: at most 100; greater than 0
`consolidation_method`optional	string	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. One of: `full`, `equity`, `cost`, `none`
`entity_role`optional	string	`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`. One of: `operating`, `consolidation`
`joined_on`optional	string (date)	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_on`optional	string (date)	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

curl · example 1 of 6

curl -X POST "https://api.robosystems.ai/extensions/roboledger/{graph_id}/operations/update-entity" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Idempotency-Key: <Idempotency-Key>" \
  -H "Content-Type: application/json" \
  -d '{
  "entity_type": "corporation",
  "fiscal_year_end": "12-31",
  "legal_name": "Acme Corporation, Inc.",
  "name": "Acme Corp",
  "state_of_incorporation": "DE",
  "tax_id": "12-3456789"
}'

curl · example 2 of 6

curl -X POST "https://api.robosystems.ai/extensions/roboledger/{graph_id}/operations/update-entity" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Idempotency-Key: <Idempotency-Key>" \
  -H "Content-Type: application/json" \
  -d '{
  "address_city": "Seattle",
  "address_country": "US",
  "address_line1": "100 Main St",
  "address_postal_code": "98101",
  "address_state": "WA"
}'

curl · example 3 of 6

curl -X POST "https://api.robosystems.ai/extensions/roboledger/{graph_id}/operations/update-entity" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Idempotency-Key: <Idempotency-Key>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Acme Holdings, LLC"
}'

curl · example 4 of 6

curl -X POST "https://api.robosystems.ai/extensions/roboledger/{graph_id}/operations/update-entity" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Idempotency-Key: <Idempotency-Key>" \
  -H "Content-Type: application/json" \
  -d '{
  "entity_id": "ent_01J9ZK3M4N5P6Q7R8S9T0V1W2X",
  "ownership_pct": 80
}'

curl · example 5 of 6

curl -X POST "https://api.robosystems.ai/extensions/roboledger/{graph_id}/operations/update-entity" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Idempotency-Key: <Idempotency-Key>" \
  -H "Content-Type: application/json" \
  -d '{
  "consolidation_method": "full",
  "entity_id": "ent_01J9ZK3M4N5P6Q7R8S9T0V1W2X",
  "ownership_pct": 45
}'

curl · example 6 of 6

curl -X POST "https://api.robosystems.ai/extensions/roboledger/{graph_id}/operations/update-entity" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Idempotency-Key: <Idempotency-Key>" \
  -H "Content-Type: application/json" \
  -d '{
  "entity_id": "ent_01J9ZK3M4N5P6Q7R8S9T0V1W2X",
  "left_on": "2026-12-31"
}'

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

LedgerEntityResponse

Command-specific result payload

LedgerEntityResponse fields

Field	Type	Description
`id`required	string	Entity identifier (ULID).
`name`required	string	Display name shown in UI.
`legal_name`optional	string	Full registered legal name (when different from `name`).
`uri`optional	string	Canonical URL / external identifier.
`cik`optional	string	SEC CIK (Central Index Key).
`ticker`optional	string	Stock ticker symbol.
`exchange`optional	string	Listing exchange (e.g. 'NASDAQ', 'NYSE').
`sic`optional	string	SIC industry code.
`sic_description`optional	string	SIC code description.
`category`optional	string	Filer category (e.g. 'Large Accelerated Filer').
`state_of_incorporation`optional	string	US state or country of incorporation.
`fiscal_year_end`optional	string	Fiscal year-end as MM-DD (e.g. '12-31', '06-30').
`tax_id`optional	string	Tax ID (EIN / SSN).
`lei`optional	string	Legal Entity Identifier (ISO 17442).
`industry`optional	string	Free-form industry label.
`entity_type`optional	string	Legal form (e.g. 'corporation', 'llc', 'lp').
`reporting_style_id`optional	string	Active Reporting Style (Structure id) governing this entity's statement layout. Change it via the change-reporting-style operation.
`phone`optional	string
`website`optional	string
`status`optional	string	Operational status: 'active' \| 'inactive' \| 'dissolved'. Default: `active`
`is_parent`optional	boolean	True for top-level entities; False for subsidiaries. Default: `true`
`parent_entity_id`optional	string	Parent entity ID for subsidiaries; null for top-level.
`ownership_pct`optional	number	The parent's share of this entity, as a percent (100 = wholly owned). Null on the group parent, and where it was never recorded.
`consolidation_method`optional	string	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. Default: `none`
`entity_role`optional	string	`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`. Default: `operating`
`joined_on`optional	string (date)	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.
`left_on`optional	string (date)	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.
`is_former`optional	boolean	True once the month this entity left the group is over: its months in the group are history, readable under it, and it is no longer current. False for a member still in, and through the month it leaves. Default: `false`
`source`optional	string	Provenance: 'native' \| 'sec' \| 'quickbooks' \| 'xero' \| 'plaid'. Default: `native`
`source_id`optional	string	Source-system primary key for sync reconciliation.
`source_graph_id`optional	string	Origin graph for received entities (cross-graph linking, e.g. RoboInvestor portfolio holdings).
`connection_id`optional	string	Source connection that ingested this row.
`address_line1`optional	string
`address_city`optional	string
`address_state`optional	string
`address_postal_code`optional	string
`address_country`optional	string
`created_at`optional	string
`updated_at`optional	string

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