Browse the extensions 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

NameTypeDescription
entityIdStringA 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.

FieldTypeDescription
idString!Entity identifier (ULID).
nameString!Display name shown in UI.
legalNameStringFull registered legal name (when different from name).
uriStringCanonical URL / external identifier.
cikStringSEC CIK (Central Index Key).
tickerStringStock ticker symbol.
exchangeStringListing exchange (e.g. 'NASDAQ', 'NYSE').
sicStringSIC industry code.
sicDescriptionStringSIC code description.
categoryStringFiler category (e.g. 'Large Accelerated Filer').
stateOfIncorporationStringUS state or country of incorporation.
fiscalYearEndStringFiscal year-end as MM-DD (e.g. '12-31', '06-30').
taxIdStringTax ID (EIN / SSN).
leiStringLegal Entity Identifier (ISO 17442).
industryStringFree-form industry label.
entityTypeStringLegal form (e.g. 'corporation', 'llc', 'lp').
reportingStyleIdStringActive Reporting Style (Structure id) governing this entity's statement layout. Change it via the change-reporting-style operation.
phoneString—
websiteString—
statusString!Operational status: 'active' | 'inactive' | 'dissolved'.
isParentBoolean!True for top-level entities; False for subsidiaries.
parentEntityIdStringParent entity ID for subsidiaries; null for top-level.
ownershipPctFloatThe parent's share of this entity, as a percent (100 = wholly owned). Null on the group parent, and where it was never recorded.
sourceString!Provenance: 'native' | 'sec' | 'quickbooks' | 'xero' | 'plaid'.
sourceIdStringSource-system primary key for sync reconciliation.
sourceGraphIdStringOrigin graph for received entities (cross-graph linking, e.g. RoboInvestor portfolio holdings).
connectionIdStringSource connection that ingested this row.
addressLine1String—
addressCityString—
addressStateString—
addressPostalCodeString—
addressCountryString—
createdAtString—
updatedAtString—

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 } }"}'