entity | GraphQL reference

entity

returns LedgerEntity

One entity of the graph's reporting group: the named one, else the group parent. Null on a graph with no entity yet.

Arguments

Name	Type	Description
entityId	String	A subsidiary's id. Omit for the group parent.

Returns LedgerEntity

Entity details from the extensions OLTP database. Returned by entity reads and update-entity. Identifiers (CIK / ticker / SIC / LEI / tax_id) are present when sourced from SEC or registry data; many are null for private companies. The address fields are flattened (no nested object) to make them easy to project into reporting forms.

Field	Type	Description
id	String!	Entity identifier (ULID).
name	String!	Display name shown in UI.
legalName	String	Full registered legal name (when different from `name`).
uri	String	Canonical URL / external identifier.
cik	String	SEC CIK (Central Index Key).
ticker	String	Stock ticker symbol.
exchange	String	Listing exchange (e.g. 'NASDAQ', 'NYSE').
sic	String	SIC industry code.
sicDescription	String	SIC code description.
category	String	Filer category (e.g. 'Large Accelerated Filer').
stateOfIncorporation	String	US state or country of incorporation.
fiscalYearEnd	String	Fiscal year-end as MM-DD (e.g. '12-31', '06-30').
taxId	String	Tax ID (EIN / SSN).
lei	String	Legal Entity Identifier (ISO 17442).
industry	String	Free-form industry label.
entityType	String	Legal form (e.g. 'corporation', 'llc', 'lp').
reportingStyleId	String	Active Reporting Style (Structure id) governing this entity's statement layout. Change it via the change-reporting-style operation.
phone	String	—
website	String	—
status	String!	Operational status: 'active' \| 'inactive' \| 'dissolved'.
isParent	Boolean!	True for top-level entities; False for subsidiaries.
parentEntityId	String	Parent entity ID for subsidiaries; null for top-level.
ownershipPct	Float	The parent's share of this entity, as a percent (100 = wholly owned). Null on the group parent, and where it was never recorded.
consolidationMethod	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 `ownershipPct` 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.
entityRole	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`.
joinedOn	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.
leftOn	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.
isFormer	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.
source	String!	Provenance: 'native' \| 'sec' \| 'quickbooks' \| 'xero' \| 'plaid'.
sourceId	String	Source-system primary key for sync reconciliation.
sourceGraphId	String	Origin graph for received entities (cross-graph linking, e.g. RoboInvestor portfolio holdings).
connectionId	String	Source connection that ingested this row.
addressLine1	String	—
addressCity	String	—
addressState	String	—
addressPostalCode	String	—
addressCountry	String	—
createdAt	String	—
updatedAt	String	—

Example

query

{ entity { id name legalName uri } }

curl

curl -X POST "https://api.robosystems.ai/extensions/$GRAPH_ID/graphql" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "{ entity { id name legalName uri } }"}'