@robosystems/client 0.3.19 → 0.3.21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -55,6 +55,15 @@ export type Scalars = {
55
55
  output: any;
56
56
  };
57
57
  };
58
+ /**
59
+ * One CoA account (Element) — the basic chart-of-accounts row.
60
+ *
61
+ * ``trait`` carries the FASB classification (asset/liability/equity/
62
+ * revenue/expense/etc.); ``balance_type`` is the natural side
63
+ * ('debit' or 'credit'). ``account_type`` is a free-form sub-grouping
64
+ * (e.g. 'cash', 'inventory') used by some integrations. Hierarchy is
65
+ * expressed via ``parent_id`` + ``depth``.
66
+ */
58
67
  export type Account = {
59
68
  accountType: Maybe<Scalars['String']['output']>;
60
69
  balanceType: Scalars['String']['output'];
@@ -72,10 +81,18 @@ export type Account = {
72
81
  subClassification: Maybe<Scalars['String']['output']>;
73
82
  trait: Maybe<Scalars['String']['output']>;
74
83
  };
84
+ /**
85
+ * Paginated chart-of-accounts listing — flat (use the tree endpoint
86
+ * for parent/child structure).
87
+ */
75
88
  export type AccountList = {
76
89
  accounts: Array<Account>;
77
90
  pagination: PaginationInfo;
78
91
  };
92
+ /**
93
+ * All CoA accounts that roll up into a single reporting concept,
94
+ * with the group total and per-account contributions.
95
+ */
79
96
  export type AccountRollupGroup = {
80
97
  accounts: Array<AccountRollupRow>;
81
98
  balanceType: Scalars['String']['output'];
@@ -85,6 +102,7 @@ export type AccountRollupGroup = {
85
102
  total: Scalars['Float']['output'];
86
103
  trait: Scalars['String']['output'];
87
104
  };
105
+ /** One CoA account contributing to a reporting concept's rollup. */
88
106
  export type AccountRollupRow = {
89
107
  accountCode: Maybe<Scalars['String']['output']>;
90
108
  accountName: Scalars['String']['output'];
@@ -93,6 +111,11 @@ export type AccountRollupRow = {
93
111
  totalCredits: Scalars['Float']['output'];
94
112
  totalDebits: Scalars['Float']['output'];
95
113
  };
114
+ /**
115
+ * Mapping rendered as account rollups — every reporting concept the
116
+ * mapping defines, with the CoA accounts that contribute to it and the
117
+ * current balance for each. ``total_unmapped`` tracks gaps for UI.
118
+ */
96
119
  export type AccountRollups = {
97
120
  groups: Array<AccountRollupGroup>;
98
121
  mappingId: Scalars['String']['output'];
@@ -141,6 +164,16 @@ export type Artifact = {
141
164
  template: Maybe<Scalars['JSON']['output']>;
142
165
  topic: Maybe<Scalars['String']['output']>;
143
166
  };
167
+ /**
168
+ * One edge between two elements within a structure (parent/child
169
+ * presentation, calculation rollup, mapping, equivalence).
170
+ *
171
+ * ``association_type`` discriminates the edge semantics. Mapping edges
172
+ * are the user-facing path (CoA → reporting concept); presentation /
173
+ * calculation edges express structure layout and roll-ups.
174
+ * ``confidence`` is set on AI-suggested mappings (≥0.90 auto-approved,
175
+ * 0.70-0.89 flagged for review).
176
+ */
144
177
  export type Association = {
145
178
  approvedBy: Maybe<Scalars['String']['output']>;
146
179
  associationType: Scalars['String']['output'];
@@ -157,10 +190,23 @@ export type Association = {
157
190
  toElementQname: Maybe<Scalars['String']['output']>;
158
191
  weight: Maybe<Scalars['Float']['output']>;
159
192
  };
193
+ /**
194
+ * A grouping of closing-book items shown as a sidebar section
195
+ * (e.g. Statements, Account Rollups, Schedules, Period Close).
196
+ */
160
197
  export type ClosingBookCategory = {
161
198
  items: Array<ClosingBookItem>;
162
199
  label: Scalars['String']['output'];
163
200
  };
201
+ /**
202
+ * One row in the closing book — a navigable artifact for the
203
+ * period (statement, schedule, rollup, etc.).
204
+ *
205
+ * ``item_type`` discriminates: 'statement', 'schedule',
206
+ * 'account_rollups', 'period_close', 'trial_balance'. Statement items
207
+ * carry ``report_id`` to fetch the rendered facts; schedule items
208
+ * carry ``status`` ('complete' | 'draft' | 'pending').
209
+ */
164
210
  export type ClosingBookItem = {
165
211
  id: Scalars['String']['output'];
166
212
  itemType: Scalars['String']['output'];
@@ -169,10 +215,16 @@ export type ClosingBookItem = {
169
215
  status: Maybe<Scalars['String']['output']>;
170
216
  structureType: Maybe<Scalars['String']['output']>;
171
217
  };
218
+ /**
219
+ * The closing book navigation tree — categories + items the UI
220
+ * uses to render the period-close workspace. ``has_data=False`` when
221
+ * the graph has no posted entries yet.
222
+ */
172
223
  export type ClosingBookStructures = {
173
224
  categories: Array<ClosingBookCategory>;
174
225
  hasData: Scalars['Boolean']['output'];
175
226
  };
227
+ /** A single draft entry with full line item detail for review. */
176
228
  export type DraftEntry = {
177
229
  /** True if total_debit == total_credit */
178
230
  balanced: Scalars['Boolean']['output'];
@@ -193,6 +245,7 @@ export type DraftEntry = {
193
245
  /** Entry type (e.g., 'closing', 'adjusting') */
194
246
  type: Scalars['String']['output'];
195
247
  };
248
+ /** A single line item within a draft entry. */
196
249
  export type DraftLineItem = {
197
250
  /** Credit amount in cents */
198
251
  creditAmount: Scalars['Int']['output'];
@@ -204,6 +257,7 @@ export type DraftLineItem = {
204
257
  elementName: Scalars['String']['output'];
205
258
  lineItemId: Scalars['String']['output'];
206
259
  };
260
+ /** Element with taxonomy context — extends AccountResponse. */
207
261
  export type Element = {
208
262
  balanceType: Scalars['String']['output'];
209
263
  code: Maybe<Scalars['String']['output']>;
@@ -225,13 +279,22 @@ export type Element = {
225
279
  taxonomyId: Maybe<Scalars['String']['output']>;
226
280
  trait: Maybe<Scalars['String']['output']>;
227
281
  };
282
+ /** Paginated element listing with taxonomy context. */
228
283
  export type ElementList = {
229
284
  elements: Array<Element>;
230
285
  pagination: PaginationInfo;
231
286
  };
287
+ /**
288
+ * Lightweight entity projection for embedding in portfolio-block /
289
+ * position envelopes. Carries identity-only fields; full entity data
290
+ * lives behind the Master Data entity APIs.
291
+ */
232
292
  export type EntityLite = {
293
+ /** Entity ID (`ent_*` ULID). */
233
294
  id: Scalars['ID']['output'];
295
+ /** Display name of the entity. */
234
296
  name: Scalars['String']['output'];
297
+ /** Tenant graph this entity is anchored to, when known. `null` for entities not yet linked to a graph. */
235
298
  sourceGraphId: Maybe<Scalars['String']['output']>;
236
299
  };
237
300
  export type EventBlock = {
@@ -260,15 +323,29 @@ export type EventBlock = {
260
323
  source: Scalars['String']['output'];
261
324
  status: Scalars['String']['output'];
262
325
  };
326
+ /**
327
+ * A single fact row inside a rendered statement.
328
+ *
329
+ * One row per concept, with one value per period column. Subtotals and
330
+ * hierarchy depth come from the structure being projected.
331
+ */
263
332
  export type FactRow = {
333
+ /** Indentation depth in the structure hierarchy (0 = root). */
264
334
  depth: Scalars['Int']['output'];
335
+ /** Internal element identifier. */
265
336
  elementId: Scalars['String']['output'];
337
+ /** Human-readable concept label. */
266
338
  elementName: Scalars['String']['output'];
339
+ /** QName of the reporting concept (e.g. 'us-gaap:Revenues'). */
267
340
  elementQname: Scalars['String']['output'];
341
+ /** True when the row should render as a subtotal line. */
268
342
  isSubtotal: Scalars['Boolean']['output'];
343
+ /** Concept trait flag from the structure (e.g. 'total', 'subtotal', 'header'). Drives presentation. */
269
344
  trait: Maybe<Scalars['String']['output']>;
345
+ /** One value per period column, in the same order as `periods`. Null when the concept had no facts in that window. */
270
346
  values: Array<Maybe<Scalars['Float']['output']>>;
271
347
  };
348
+ /** Current fiscal calendar state for a graph. */
272
349
  export type FiscalCalendar = {
273
350
  /** Structured blocker codes when closeable_now is False: 'sequence_violation', 'period_incomplete', 'sync_stale', 'calendar_not_initialized', 'period_already_closed' */
274
351
  blockers: Array<Scalars['String']['output']>;
@@ -291,6 +368,13 @@ export type FiscalCalendar = {
291
368
  /** Fiscal period rows for this graph */
292
369
  periods: Array<FiscalPeriodSummary>;
293
370
  };
371
+ /**
372
+ * One fiscal period row — header view used in calendar listings.
373
+ *
374
+ * Status lifecycle: ``open`` → ``closing`` → ``closed``. ``closing``
375
+ * is the transient state during a close run; ``closed_at`` stamps when
376
+ * the lock landed.
377
+ */
294
378
  export type FiscalPeriodSummary = {
295
379
  closedAt: Maybe<Scalars['DateTime']['output']>;
296
380
  endDate: Scalars['Date']['output'];
@@ -300,27 +384,50 @@ export type FiscalPeriodSummary = {
300
384
  /** 'open' | 'closing' | 'closed' */
301
385
  status: Scalars['String']['output'];
302
386
  };
387
+ /**
388
+ * All securities held in a single entity, rolled up across the
389
+ * caller's portfolios.
390
+ */
303
391
  export type Holding = {
392
+ /** Issuing entity ID. */
304
393
  entityId: Scalars['String']['output'];
394
+ /** Display name of the entity. */
305
395
  entityName: Scalars['String']['output'];
396
+ /** Number of distinct active positions backing these holdings. */
306
397
  positionCount: Scalars['Int']['output'];
398
+ /** One row per security held in this entity. */
307
399
  securities: Array<HoldingSecuritySummary>;
400
+ /** Pre-association tenant graph, when set on the securities. */
308
401
  sourceGraphId: Maybe<Scalars['String']['output']>;
402
+ /** Sum of cost basis across all securities, in dollars. */
309
403
  totalCostBasisDollars: Scalars['Float']['output'];
404
+ /** Sum of current value across all securities, in dollars. `null` if any security lacks a mark. */
310
405
  totalCurrentValueDollars: Maybe<Scalars['Float']['output']>;
311
406
  };
407
+ /** One security held by an entity, rolled up across portfolios. */
312
408
  export type HoldingSecuritySummary = {
409
+ /** Aggregate cost basis in dollars, summed across all positions. */
313
410
  costBasisDollars: Scalars['Float']['output'];
411
+ /** Aggregate current value in dollars, or `null` if any underlying position lacks a mark. */
314
412
  currentValueDollars: Maybe<Scalars['Float']['output']>;
413
+ /** Total quantity held in `quantity_type` units. */
315
414
  quantity: Scalars['Float']['output'];
415
+ /** Unit basis (`shares`, `units`, `principal`). */
316
416
  quantityType: Scalars['String']['output'];
417
+ /** Security ID. */
317
418
  securityId: Scalars['String']['output'];
419
+ /** Display name of the security. */
318
420
  securityName: Scalars['String']['output'];
421
+ /** Instrument family (e.g. `common_stock`, `warrant`). */
319
422
  securityType: Scalars['String']['output'];
320
423
  };
424
+ /** Aggregated holdings across all of the caller's portfolios. */
321
425
  export type HoldingsList = {
426
+ /** One row per issuing entity. */
322
427
  holdings: Array<Holding>;
428
+ /** Count of entities represented. */
323
429
  totalEntities: Scalars['Int']['output'];
430
+ /** Total active positions backing these holdings. */
324
431
  totalPositions: Scalars['Int']['output'];
325
432
  };
326
433
  export type InformationBlock = {
@@ -342,6 +449,19 @@ export type InformationBlock = {
342
449
  verificationResults: Array<InformationBlockVerificationResult>;
343
450
  view: InformationBlockViewProjections;
344
451
  };
452
+ /**
453
+ * Classification projection — one row per `association_classifications`
454
+ * junction entry.
455
+ *
456
+ * Association-side only: concept_arrangement, member_arrangement,
457
+ * named_disclosure. Element-side FASB metamodel traits (asset, current,
458
+ * operating, …) live in `TraitLite` via `element_traits`.
459
+ *
460
+ * Carries enough for the envelope caller to render / filter by category +
461
+ * identifier without a follow-up lookup. The full `public.classifications`
462
+ * vocabulary catalog (name / description / metadata) is available via the
463
+ * library GraphQL surface when callers need the details.
464
+ */
345
465
  export type InformationBlockClassification = {
346
466
  /** One of the 3 association-level categories in the `public.classifications` CHECK constraint: 'concept_arrangement', 'member_arrangement', or 'named_disclosure'. */
347
467
  category: Scalars['String']['output'];
@@ -356,6 +476,12 @@ export type InformationBlockClassification = {
356
476
  /** Provenance — 'arcrole_analysis', 'disclosure_mechanics', 'us-gaap-metamodel', adapter name, etc. */
357
477
  source: Maybe<Scalars['String']['output']>;
358
478
  };
479
+ /**
480
+ * Connection (= Association) projection.
481
+ *
482
+ * Renamed at the API boundary to match Charlie's ontology vocabulary.
483
+ * The underlying storage table is still ``associations``.
484
+ */
359
485
  export type InformationBlockConnection = {
360
486
  arcrole: Maybe<Scalars['String']['output']>;
361
487
  /** presentation | calculation | mapping | equivalence | general-special | essence-alias */
@@ -368,6 +494,14 @@ export type InformationBlockConnection = {
368
494
  toElementId: Scalars['String']['output'];
369
495
  weight: Maybe<Scalars['Float']['output']>;
370
496
  };
497
+ /**
498
+ * Element projection for bundling inside an Information Block envelope.
499
+ *
500
+ * Narrower than :class:`LibraryElementResponse` — excludes the heavy fields
501
+ * (labels, references, classifications) that library browsing needs but
502
+ * block consumers don't. Agents + frontends ask for those on demand via
503
+ * the full library GraphQL fields when they need them.
504
+ */
371
505
  export type InformationBlockElement = {
372
506
  balanceType: Maybe<Scalars['String']['output']>;
373
507
  code: Maybe<Scalars['String']['output']>;
@@ -380,6 +514,7 @@ export type InformationBlockElement = {
380
514
  periodType: Maybe<Scalars['String']['output']>;
381
515
  qname: Maybe<Scalars['String']['output']>;
382
516
  };
517
+ /** Fact projection — just the values the envelope caller cares about. */
383
518
  export type InformationBlockFact = {
384
519
  elementId: Scalars['String']['output'];
385
520
  /** historical | in_scope */
@@ -392,6 +527,14 @@ export type InformationBlockFact = {
392
527
  unit: Scalars['String']['output'];
393
528
  value: Scalars['Float']['output'];
394
529
  };
530
+ /**
531
+ * FactSet projection — period-specific instantiation of the Structure.
532
+ *
533
+ * The envelope carries one ``FactSetLite`` per block when a FactSet row
534
+ * exists for the requested period; legacy writes that pre-date FactSet
535
+ * stamping leave ``fact_set`` null until the expand pass starts
536
+ * populating those rows.
537
+ */
395
538
  export type InformationBlockFactSet = {
396
539
  entityId: Scalars['String']['output'];
397
540
  /** 'report' | 'schedule' | 'custom'. Enum closure enforced by the ``public.fact_sets`` CHECK constraint. */
@@ -403,17 +546,36 @@ export type InformationBlockFactSet = {
403
546
  reportId: Maybe<Scalars['String']['output']>;
404
547
  structureId: Maybe<Scalars['String']['output']>;
405
548
  };
549
+ /**
550
+ * Pre-computed rendering projection of an Information Block.
551
+ *
552
+ * Computed server-side at envelope-build time for blocks where rendering
553
+ * is deterministic (the statement family today; future block types add
554
+ * their own rendering builders). The frontend's ``BlockView``
555
+ * ``Rendering`` projection consumes this directly — no client-side
556
+ * rollup, depth computation, or calculation walk needed.
557
+ */
406
558
  export type InformationBlockRendering = {
407
559
  periods: Array<InformationBlockRenderingPeriod>;
408
560
  rows: Array<InformationBlockRenderingRow>;
409
561
  unmappedCount: Scalars['Int']['output'];
410
562
  validation: Maybe<InformationBlockValidation>;
411
563
  };
564
+ /** One period column in a rendered statement. */
412
565
  export type InformationBlockRenderingPeriod = {
413
566
  end: Scalars['Date']['output'];
414
567
  label: Maybe<Scalars['String']['output']>;
415
568
  start: Scalars['Date']['output'];
416
569
  };
570
+ /**
571
+ * One row of a server-side rendered statement.
572
+ *
573
+ * Mirrors :class:`FactRow` from the legacy
574
+ * :mod:`robosystems.operations.roboledger.reports.fact_grid` but lives at
575
+ * the API boundary so envelope consumers don't depend on the
576
+ * fact-grid module. ``values`` is one entry per period column in
577
+ * :class:`RenderingLite.periods`.
578
+ */
417
579
  export type InformationBlockRenderingRow = {
418
580
  balanceType: Maybe<Scalars['String']['output']>;
419
581
  /** FASB elementsOfFinancialStatements trait identifier — 'asset', 'liability', 'equity', 'revenue', 'expense'. Surfaced so the viewer can color-code or group rows without a follow-up trait lookup. */
@@ -425,6 +587,15 @@ export type InformationBlockRenderingRow = {
425
587
  isSubtotal: Scalars['Boolean']['output'];
426
588
  values: Array<Maybe<Scalars['Float']['output']>>;
427
589
  };
590
+ /**
591
+ * Rule projection for the Information Block envelope.
592
+ *
593
+ * One row per ``public.rules`` entry scoped to this block. The rule
594
+ * engine consumes ``rule_expression`` + ``rule_variables`` to evaluate
595
+ * against the in-scope fact set; the envelope surfaces the rules so
596
+ * the UI can render them as a checklist alongside any persisted
597
+ * verification results.
598
+ */
428
599
  export type InformationBlockRule = {
429
600
  id: Scalars['String']['output'];
430
601
  /** One of 8 cm:VerificationRule subclasses — AutomatedAccountingAndReportingChecks, FundamentalAccountingConceptRelation, PeerConsistencyRule, PriorPeriodConsistencyRule, ReportLevelModelStructureRule, ReportingSystemSpecificRule, ToDoManualTask, XBRLTechnicalSyntaxRule. */
@@ -440,24 +611,42 @@ export type InformationBlockRule = {
440
611
  ruleTarget: Maybe<InformationBlockRuleTarget>;
441
612
  ruleVariables: Array<InformationBlockRuleVariable>;
442
613
  };
614
+ /** Polymorphic rule target — points at the atom the rule is scoped to. */
443
615
  export type InformationBlockRuleTarget = {
444
616
  /** Which atom type the rule targets — 'structure' | 'element' | 'association' | 'taxonomy'. Enum closure enforced by the ``public.rules`` CHECK constraint. */
445
617
  targetKind: Scalars['String']['output'];
446
618
  /** UUID of the target atom — structure_id, element_id, association_id, or taxonomy_id depending on ``target_kind``. */
447
619
  targetRefId: Scalars['String']['output'];
448
620
  };
621
+ /** `$Variable` → concept qname binding for a rule expression. */
449
622
  export type InformationBlockRuleVariable = {
450
623
  /** Local name in the rule expression, e.g. 'Assets'. */
451
624
  variableName: Scalars['String']['output'];
452
625
  /** Concept qname the variable resolves to, e.g. 'fac:Assets'. */
453
626
  variableQname: Scalars['String']['output'];
454
627
  };
628
+ /**
629
+ * Outcome of guard-rail validation on a rendered statement.
630
+ *
631
+ * Distinct from :class:`VerificationResultLite` (which surfaces the
632
+ * rule-engine outcomes from ``public.verification_results``). This lite
633
+ * type carries the synchronous guard-rail checks computed at
634
+ * envelope-build time — accounting equation, totals foot, etc.
635
+ */
455
636
  export type InformationBlockValidation = {
456
637
  checks: Array<Scalars['String']['output']>;
457
638
  failures: Array<Scalars['String']['output']>;
458
639
  passed: Scalars['Boolean']['output'];
459
640
  warnings: Array<Scalars['String']['output']>;
460
641
  };
642
+ /**
643
+ * Persisted outcome of one Rule evaluation.
644
+ *
645
+ * One row per ``public.verification_results`` entry the rule engine
646
+ * writes. The envelope surfaces them so the block viewer's
647
+ * "Verification Results" tab and MCP ``list-verification-failures``
648
+ * tool can render + aggregate without a second round-trip.
649
+ */
461
650
  export type InformationBlockVerificationResult = {
462
651
  evaluatedAt: Maybe<Scalars['DateTime']['output']>;
463
652
  factSetId: Maybe<Scalars['String']['output']>;
@@ -470,49 +659,106 @@ export type InformationBlockVerificationResult = {
470
659
  status: Scalars['String']['output'];
471
660
  structureId: Maybe<Scalars['String']['output']>;
472
661
  };
662
+ /**
663
+ * Charlie's six ``type-of View`` arms, surfaced at the envelope boundary.
664
+ *
665
+ * Each projection is computed server-side at envelope-build time when
666
+ * its source data is available. The frontend's ``BlockView`` dispatcher
667
+ * routes to the projection component matching the user's selected view
668
+ * mode; missing projections (those still in backlog) render as empty
669
+ * states without breaking the dispatcher.
670
+ *
671
+ * Today: ``rendering`` is computed for the statement family.
672
+ * Other arms (``fact_table``, ``model_structure``, ``verification_results``,
673
+ * ``report_elements``, ``business_rules``) come online as their backend
674
+ * support lands; ``fact_table`` is trivially derivable from
675
+ * ``InformationBlockEnvelope.facts`` and may stay as a frontend-only
676
+ * projection.
677
+ */
473
678
  export type InformationBlockViewProjections = {
474
679
  rendering: Maybe<InformationBlockRendering>;
475
680
  };
681
+ /** The block's intrinsic shape — concept + member arrangement patterns. */
476
682
  export type InformationModel = {
477
683
  /** roll_up | roll_forward | variance | adjustment | set | arithmetic | textblock. Null for block types where the concept arrangement is implicit in their mechanics. */
478
684
  conceptArrangement: Maybe<Scalars['String']['output']>;
479
685
  /** aggregation | nonaggregation, or null if non-hypercube. */
480
686
  memberArrangement: Maybe<Scalars['String']['output']>;
481
687
  };
688
+ /**
689
+ * Entity details from the extensions OLTP database.
690
+ *
691
+ * Returned by entity reads and `update-entity`. Identifiers
692
+ * (CIK / ticker / SIC / LEI / tax_id) are present when sourced from
693
+ * SEC or registry data; many are null for private companies. The
694
+ * address fields are flattened (no nested object) to make them easy
695
+ * to project into reporting forms.
696
+ */
482
697
  export type LedgerEntity = {
483
698
  addressCity: Maybe<Scalars['String']['output']>;
484
699
  addressCountry: Maybe<Scalars['String']['output']>;
485
700
  addressLine1: Maybe<Scalars['String']['output']>;
486
701
  addressPostalCode: Maybe<Scalars['String']['output']>;
487
702
  addressState: Maybe<Scalars['String']['output']>;
703
+ /** Filer category (e.g. 'Large Accelerated Filer'). */
488
704
  category: Maybe<Scalars['String']['output']>;
705
+ /** SEC CIK (Central Index Key). */
489
706
  cik: Maybe<Scalars['String']['output']>;
707
+ /** Source connection that ingested this row. */
490
708
  connectionId: Maybe<Scalars['String']['output']>;
491
709
  createdAt: Maybe<Scalars['String']['output']>;
710
+ /** Legal form (e.g. 'corporation', 'llc', 'lp'). */
492
711
  entityType: Maybe<Scalars['String']['output']>;
712
+ /** Listing exchange (e.g. 'NASDAQ', 'NYSE'). */
493
713
  exchange: Maybe<Scalars['String']['output']>;
714
+ /** Fiscal year-end as MM-DD (e.g. '12-31', '06-30'). */
494
715
  fiscalYearEnd: Maybe<Scalars['String']['output']>;
716
+ /** Entity identifier (ULID). */
495
717
  id: Scalars['String']['output'];
718
+ /** Free-form industry label. */
496
719
  industry: Maybe<Scalars['String']['output']>;
720
+ /** True for top-level entities; False for subsidiaries. */
497
721
  isParent: Scalars['Boolean']['output'];
722
+ /** Full registered legal name (when different from `name`). */
498
723
  legalName: Maybe<Scalars['String']['output']>;
724
+ /** Legal Entity Identifier (ISO 17442). */
499
725
  lei: Maybe<Scalars['String']['output']>;
726
+ /** Display name shown in UI. */
500
727
  name: Scalars['String']['output'];
728
+ /** Parent entity ID for subsidiaries; null for top-level. */
501
729
  parentEntityId: Maybe<Scalars['String']['output']>;
502
730
  phone: Maybe<Scalars['String']['output']>;
731
+ /** SIC industry code. */
503
732
  sic: Maybe<Scalars['String']['output']>;
733
+ /** SIC code description. */
504
734
  sicDescription: Maybe<Scalars['String']['output']>;
735
+ /** Provenance: 'native' | 'sec' | 'quickbooks' | 'xero' | 'plaid'. */
505
736
  source: Scalars['String']['output'];
737
+ /** Origin graph for received entities (cross-graph linking, e.g. RoboInvestor portfolio holdings). */
506
738
  sourceGraphId: Maybe<Scalars['String']['output']>;
739
+ /** Source-system primary key for sync reconciliation. */
507
740
  sourceId: Maybe<Scalars['String']['output']>;
741
+ /** US state or country of incorporation. */
508
742
  stateOfIncorporation: Maybe<Scalars['String']['output']>;
743
+ /** Operational status: 'active' | 'inactive' | 'dissolved'. */
509
744
  status: Scalars['String']['output'];
745
+ /** Tax ID (EIN / SSN). */
510
746
  taxId: Maybe<Scalars['String']['output']>;
747
+ /** Stock ticker symbol. */
511
748
  ticker: Maybe<Scalars['String']['output']>;
512
749
  updatedAt: Maybe<Scalars['String']['output']>;
750
+ /** Canonical URL / external identifier. */
513
751
  uri: Maybe<Scalars['String']['output']>;
514
752
  website: Maybe<Scalars['String']['output']>;
515
753
  };
754
+ /**
755
+ * A journal entry — accounting interpretation of a transaction.
756
+ *
757
+ * Each transaction has 1+ entries; each entry has 2+ line items that
758
+ * must balance. ``status`` is the draft/posted/reversed lifecycle;
759
+ * ``type`` is the entry classification ('standard' | 'adjusting' |
760
+ * 'closing' | 'reversing').
761
+ */
516
762
  export type LedgerEntry = {
517
763
  id: Scalars['String']['output'];
518
764
  lineItems: Array<LedgerLineItem>;
@@ -523,6 +769,10 @@ export type LedgerEntry = {
523
769
  status: Scalars['String']['output'];
524
770
  type: Scalars['String']['output'];
525
771
  };
772
+ /**
773
+ * One debit/credit line within a journal entry. Always exactly one
774
+ * side has a non-zero amount.
775
+ */
526
776
  export type LedgerLineItem = {
527
777
  accountCode: Maybe<Scalars['String']['output']>;
528
778
  accountId: Scalars['String']['output'];
@@ -533,6 +783,15 @@ export type LedgerLineItem = {
533
783
  id: Scalars['String']['output'];
534
784
  lineOrder: Scalars['Int']['output'];
535
785
  };
786
+ /**
787
+ * High-level rollup of a graph's ledger state — counts plus the
788
+ * date-range bookends and integration sync timestamp.
789
+ *
790
+ * Used by dashboards and the onboarding wizard to answer "is this
791
+ * graph populated yet?" without walking every transaction. ``connection_count``
792
+ * reflects active integrations (QuickBooks / Plaid / etc.); a non-null
793
+ * ``last_sync_at`` means at least one connection has run.
794
+ */
536
795
  export type LedgerSummary = {
537
796
  accountCount: Scalars['Int']['output'];
538
797
  connectionCount: Scalars['Int']['output'];
@@ -544,6 +803,10 @@ export type LedgerSummary = {
544
803
  lineItemCount: Scalars['Int']['output'];
545
804
  transactionCount: Scalars['Int']['output'];
546
805
  };
806
+ /**
807
+ * Full transaction detail — header + every journal entry + every
808
+ * line item underneath. Used by the transaction detail page.
809
+ */
547
810
  export type LedgerTransactionDetail = {
548
811
  amount: Scalars['Float']['output'];
549
812
  category: Maybe<Scalars['String']['output']>;
@@ -562,10 +825,19 @@ export type LedgerTransactionDetail = {
562
825
  status: Scalars['String']['output'];
563
826
  type: Scalars['String']['output'];
564
827
  };
828
+ /** Paginated transaction listing — header view. */
565
829
  export type LedgerTransactionList = {
566
830
  pagination: PaginationInfo;
567
831
  transactions: Array<LedgerTransactionSummary>;
568
832
  };
833
+ /**
834
+ * Transaction header — list/grid view without entries.
835
+ *
836
+ * Transaction is the business-event level (what happened in the real
837
+ * world). Entries (journal entries) live one level down and are loaded
838
+ * in the detail view. ``source`` distinguishes integration-imported
839
+ * rows (quickbooks / xero / plaid) from native-created ones.
840
+ */
569
841
  export type LedgerTransactionSummary = {
570
842
  amount: Scalars['Float']['output'];
571
843
  category: Maybe<Scalars['String']['output']>;
@@ -581,6 +853,7 @@ export type LedgerTransactionSummary = {
581
853
  status: Scalars['String']['output'];
582
854
  type: Scalars['String']['output'];
583
855
  };
856
+ /** An arc between two library elements (parent-child, equivalence, etc). */
584
857
  export type LibraryAssociation = {
585
858
  arcrole: Maybe<Scalars['String']['output']>;
586
859
  /** presentation | calculation | mapping | equivalence | general-special | essence-alias */
@@ -597,6 +870,7 @@ export type LibraryAssociation = {
597
870
  toElementQname: Maybe<Scalars['String']['output']>;
598
871
  weight: Maybe<Scalars['Float']['output']>;
599
872
  };
873
+ /** A library element (concept, abstract, axis, member, or hypercube). */
600
874
  export type LibraryElement = {
601
875
  /** debit | credit */
602
876
  balanceType: Scalars['String']['output'];
@@ -620,6 +894,18 @@ export type LibraryElement = {
620
894
  /** FASB elementsOfFinancialStatements axis: asset | contraAsset | liability | contraLiability | equity | contraEquity | temporaryEquity | revenue | expense | expenseReversal | gain | loss | comprehensiveIncome | investmentByOwners | distributionToOwners | metric (derived subtotals, not SFAC 6 primary elements). Null for structural rows. */
621
895
  trait: Maybe<Scalars['String']['output']>;
622
896
  };
897
+ /**
898
+ * A mapping arc involving a specific element.
899
+ *
900
+ * Flat row view: one arc, oriented from the perspective of the element
901
+ * being inspected. `peer` is the other end; `direction` says whether
902
+ * this element is the source ('outgoing') or the target ('incoming').
903
+ *
904
+ * Scoped to arcs whose structure belongs to a `taxonomy_type='mapping'`
905
+ * taxonomy — the cross-taxonomy bridges (equivalence, general-special,
906
+ * type-subtype). Hierarchical arcs inside a single reporting taxonomy
907
+ * are out of scope.
908
+ */
623
909
  export type LibraryElementArc = {
624
910
  arcrole: Maybe<Scalars['String']['output']>;
625
911
  associationType: Scalars['String']['output'];
@@ -633,6 +919,13 @@ export type LibraryElementArc = {
633
919
  taxonomyName: Maybe<Scalars['String']['output']>;
634
920
  taxonomyStandard: Maybe<Scalars['String']['output']>;
635
921
  };
922
+ /**
923
+ * One FASB metamodel trait assigned to a library element.
924
+ *
925
+ * A single element can carry multiple traits across multiple categories
926
+ * (e.g. elementsOfFinancialStatements=expense AND
927
+ * operatingNonoperating=operating AND liquidity=current).
928
+ */
636
929
  export type LibraryElementClassification = {
637
930
  /** Trait axis (e.g. elementsOfFinancialStatements) */
638
931
  category: Scalars['String']['output'];
@@ -647,10 +940,17 @@ export type LibraryElementTreeNode = {
647
940
  children: Array<LibraryElementTreeNode>;
648
941
  element: LibraryElement;
649
942
  };
943
+ /**
944
+ * An element and its equivalence peers.
945
+ *
946
+ * Answers "what other concepts mean the same thing as this one" — the
947
+ * FAC→us-gaap collapse pattern rendered as an API shape.
948
+ */
650
949
  export type LibraryEquivalence = {
651
950
  element: LibraryElement;
652
951
  equivalents: Array<LibraryElement>;
653
952
  };
953
+ /** A label on a library element. */
654
954
  export type LibraryLabel = {
655
955
  /** Language code */
656
956
  language: Scalars['String']['output'];
@@ -659,6 +959,7 @@ export type LibraryLabel = {
659
959
  /** Label text */
660
960
  text: Scalars['String']['output'];
661
961
  };
962
+ /** A cross-reference on a library element (FASB ASC, SEC, etc). */
662
963
  export type LibraryReference = {
663
964
  /** Full citation text */
664
965
  citation: Scalars['String']['output'];
@@ -667,6 +968,7 @@ export type LibraryReference = {
667
968
  /** Dereferenceable URL if available */
668
969
  uri: Maybe<Scalars['String']['output']>;
669
970
  };
971
+ /** A named structure (extended link role) within a library taxonomy. */
670
972
  export type LibraryStructure = {
671
973
  id: Scalars['String']['output'];
672
974
  isActive: Scalars['Boolean']['output'];
@@ -677,6 +979,7 @@ export type LibraryStructure = {
677
979
  structureType: Scalars['String']['output'];
678
980
  taxonomyId: Scalars['String']['output'];
679
981
  };
982
+ /** A library taxonomy (fac, us-gaap, rs-gaap, …). */
680
983
  export type LibraryTaxonomy = {
681
984
  description: Maybe<Scalars['String']['output']>;
682
985
  /** Total elements in this taxonomy (computed on demand) */
@@ -693,10 +996,12 @@ export type LibraryTaxonomy = {
693
996
  taxonomyType: Scalars['String']['output'];
694
997
  version: Maybe<Scalars['String']['output']>;
695
998
  };
999
+ /** Trial balance rolled up to reporting concepts via mapping associations. */
696
1000
  export type MappedTrialBalance = {
697
1001
  mappingId: Scalars['String']['output'];
698
1002
  rows: Array<MappedTrialBalanceRow>;
699
1003
  };
1004
+ /** One reporting-concept row in the mapped trial balance. */
700
1005
  export type MappedTrialBalanceRow = {
701
1006
  balanceType: Maybe<Scalars['String']['output']>;
702
1007
  netBalance: Scalars['Float']['output'];
@@ -707,6 +1012,7 @@ export type MappedTrialBalanceRow = {
707
1012
  totalDebits: Scalars['Float']['output'];
708
1013
  trait: Maybe<Scalars['String']['output']>;
709
1014
  };
1015
+ /** Coverage stats for a mapping. */
710
1016
  export type MappingCoverage = {
711
1017
  coveragePercent: Scalars['Float']['output'];
712
1018
  highConfidence: Scalars['Int']['output'];
@@ -717,6 +1023,7 @@ export type MappingCoverage = {
717
1023
  totalCoaElements: Scalars['Int']['output'];
718
1024
  unmappedCount: Scalars['Int']['output'];
719
1025
  };
1026
+ /** A mapping structure with all its associations. */
720
1027
  export type MappingDetail = {
721
1028
  associations: Array<Association>;
722
1029
  id: Scalars['String']['output'];
@@ -725,6 +1032,7 @@ export type MappingDetail = {
725
1032
  taxonomyId: Scalars['String']['output'];
726
1033
  totalAssociations: Scalars['Int']['output'];
727
1034
  };
1035
+ /** Pagination information for list responses. */
728
1036
  export type PaginationInfo = {
729
1037
  /** Whether more items are available */
730
1038
  hasMore: Scalars['Boolean']['output'];
@@ -735,6 +1043,13 @@ export type PaginationInfo = {
735
1043
  /** Total number of items available */
736
1044
  total: Scalars['Int']['output'];
737
1045
  };
1046
+ /**
1047
+ * One schedule's contribution to a period close — drafted closing
1048
+ * entry plus its reversal (when ``auto_reverse=True``).
1049
+ *
1050
+ * ``status`` is the closing entry's draft/posted lifecycle. The
1051
+ * reversal mirrors the same shape with ``reversal_*`` fields.
1052
+ */
738
1053
  export type PeriodCloseItem = {
739
1054
  amount: Scalars['Float']['output'];
740
1055
  entryId: Maybe<Scalars['String']['output']>;
@@ -744,6 +1059,14 @@ export type PeriodCloseItem = {
744
1059
  structureId: Scalars['String']['output'];
745
1060
  structureName: Scalars['String']['output'];
746
1061
  };
1062
+ /**
1063
+ * Period-close dashboard view — every schedule in scope for the
1064
+ * period plus drafted/posted entry totals.
1065
+ *
1066
+ * Use to drive the close-period UI: schedules with ``status='draft'``
1067
+ * are pending close; ``period_status`` reflects the calendar's lock
1068
+ * state for the period.
1069
+ */
747
1070
  export type PeriodCloseStatus = {
748
1071
  fiscalPeriodEnd: Scalars['Date']['output'];
749
1072
  fiscalPeriodStart: Scalars['Date']['output'];
@@ -752,6 +1075,7 @@ export type PeriodCloseStatus = {
752
1075
  totalDraft: Scalars['Int']['output'];
753
1076
  totalPosted: Scalars['Int']['output'];
754
1077
  };
1078
+ /** All draft entries for a fiscal period, ready for review before close. */
755
1079
  export type PeriodDrafts = {
756
1080
  /** True if every draft entry has debit == credit */
757
1081
  allBalanced: Scalars['Boolean']['output'];
@@ -766,108 +1090,234 @@ export type PeriodDrafts = {
766
1090
  /** Sum across all drafts, in cents */
767
1091
  totalDebit: Scalars['Int']['output'];
768
1092
  };
1093
+ /**
1094
+ * A single reporting period column.
1095
+ *
1096
+ * Reports render facts in N period columns side-by-side. Each
1097
+ * ``PeriodSpec`` is one column — its ``start``/``end`` define the
1098
+ * window the report's facts roll up into; ``label`` is what the renderer
1099
+ * prints in the column header. For year-over-year statements, supply two
1100
+ * PeriodSpecs (current + comparative); for YTD by quarter, supply four.
1101
+ */
769
1102
  export type PeriodSpec = {
1103
+ /** Period end date (inclusive). Window the column rolls up. */
770
1104
  end: Scalars['Date']['output'];
1105
+ /** Column header label (e.g. 'FY2025 Q3', '2024', 'YTD'). */
771
1106
  label: Scalars['String']['output'];
1107
+ /** Period start date (inclusive). Window the column rolls up. */
772
1108
  start: Scalars['Date']['output'];
773
1109
  };
1110
+ /**
1111
+ * Read projection for a single portfolio — core fields only.
1112
+ *
1113
+ * Position-level holdings live on the dedicated portfolio-block envelope
1114
+ * (`PortfolioBlockEnvelope`) returned by molecular operations.
1115
+ */
774
1116
  export type Portfolio = {
1117
+ /** ISO 4217 currency code used for portfolio-level aggregates. */
775
1118
  baseCurrency: Scalars['String']['output'];
1119
+ /** Row creation timestamp (UTC). */
776
1120
  createdAt: Scalars['DateTime']['output'];
1121
+ /** Free-text description. */
777
1122
  description: Maybe<Scalars['String']['output']>;
1123
+ /** Portfolio ID (`port_*` ULID). */
778
1124
  id: Scalars['String']['output'];
1125
+ /** Date the portfolio was established (YYYY-MM-DD). */
779
1126
  inceptionDate: Maybe<Scalars['Date']['output']>;
1127
+ /** Display name. */
780
1128
  name: Scalars['String']['output'];
1129
+ /** Free-text strategy classification (e.g. `value`, `growth`, `income`). Open vocabulary. */
781
1130
  strategy: Maybe<Scalars['String']['output']>;
1131
+ /** Last-modified timestamp (UTC). */
782
1132
  updatedAt: Scalars['DateTime']['output'];
783
1133
  };
1134
+ /**
1135
+ * Molecular response shape for portfolio-block operations.
1136
+ *
1137
+ * Bundles the portfolio core, its embedded positions, and pre-computed
1138
+ * totals into a single payload — the contract for `create-portfolio-block`,
1139
+ * `update-portfolio-block`, and the read-side `get-portfolio-block`.
1140
+ * Cents-precision values aren't surfaced here; use `PositionResponse`
1141
+ * / `PortfolioResponse` for those.
1142
+ */
784
1143
  export type PortfolioBlock = {
1144
+ /** Count of positions with `status='active'`. */
785
1145
  activePositionCount: Scalars['Int']['output'];
1146
+ /** ISO 4217 currency code for portfolio aggregates. */
786
1147
  baseCurrency: Scalars['String']['output'];
1148
+ /** Row creation timestamp (UTC). */
787
1149
  createdAt: Scalars['DateTime']['output'];
1150
+ /** Free-text description. */
788
1151
  description: Maybe<Scalars['String']['output']>;
1152
+ /** Portfolio ID (`port_*` ULID). */
789
1153
  id: Scalars['ID']['output'];
1154
+ /** Date the portfolio was established. */
790
1155
  inceptionDate: Maybe<Scalars['Date']['output']>;
1156
+ /** Display name. */
791
1157
  name: Scalars['String']['output'];
1158
+ /** Embedded owning entity, when set. `null` for unattributed portfolios. */
792
1159
  owner: Maybe<EntityLite>;
1160
+ /** All positions in this portfolio, including disposed ones (filter by `status` for active-only display). */
793
1161
  positions: Array<PositionBlock>;
1162
+ /** Free-text strategy classification. */
794
1163
  strategy: Maybe<Scalars['String']['output']>;
1164
+ /** Sum of `cost_basis_dollars` across every position. */
795
1165
  totalCostBasisDollars: Scalars['Float']['output'];
1166
+ /** Sum of `current_value_dollars` across every position. `null` when any active position lacks a mark. */
796
1167
  totalCurrentValueDollars: Maybe<Scalars['Float']['output']>;
1168
+ /** Last-modified timestamp (UTC). */
797
1169
  updatedAt: Scalars['DateTime']['output'];
798
1170
  };
1171
+ /** Paginated list of portfolios. */
799
1172
  export type PortfolioList = {
1173
+ /** Pagination cursor and totals. */
800
1174
  pagination: PaginationInfo;
1175
+ /** Portfolios on this page. */
801
1176
  portfolios: Array<Portfolio>;
802
1177
  };
1178
+ /**
1179
+ * Read projection for a single position.
1180
+ *
1181
+ * Pairs cents-precision fields (`cost_basis`, `current_value`) with
1182
+ * pre-computed dollar floats (`*_dollars`) to spare clients the
1183
+ * conversion. The cents fields are authoritative.
1184
+ */
803
1185
  export type Position = {
1186
+ /** Date the position was acquired (YYYY-MM-DD). */
804
1187
  acquisitionDate: Maybe<Scalars['Date']['output']>;
1188
+ /** Cost basis in **cents** of `currency`. Authoritative. */
805
1189
  costBasis: Scalars['Int']['output'];
1190
+ /** Cost basis pre-converted to dollars (`cost_basis / 100`). Convenience for display; `cost_basis` is the source of truth. */
806
1191
  costBasisDollars: Scalars['Float']['output'];
1192
+ /** Row creation timestamp (UTC). */
807
1193
  createdAt: Scalars['DateTime']['output'];
1194
+ /** ISO 4217 currency code for `cost_basis` and `current_value`. */
808
1195
  currency: Scalars['String']['output'];
1196
+ /** Latest mark-to-market value in **cents**, or `null` if unmarked. */
809
1197
  currentValue: Maybe<Scalars['Int']['output']>;
1198
+ /** Current value in dollars (`current_value / 100`). `null` when `current_value` is null. */
810
1199
  currentValueDollars: Maybe<Scalars['Float']['output']>;
1200
+ /** Date the position was disposed, if `status='disposed'`. `null` for active positions. */
811
1201
  dispositionDate: Maybe<Scalars['Date']['output']>;
1202
+ /** Cached display name of the security's issuing entity. */
812
1203
  entityName: Maybe<Scalars['String']['output']>;
1204
+ /** Position ID (`pos_*` ULID). */
813
1205
  id: Scalars['String']['output'];
1206
+ /** Free-text notes attached to the position. */
814
1207
  notes: Maybe<Scalars['String']['output']>;
1208
+ /** Owning portfolio ID. */
815
1209
  portfolioId: Scalars['String']['output'];
1210
+ /** Quantity held in units defined by `quantity_type`. */
816
1211
  quantity: Scalars['Float']['output'];
1212
+ /** Unit basis (`shares`, `units`, `principal`). */
817
1213
  quantityType: Scalars['String']['output'];
1214
+ /** Held security ID. */
818
1215
  securityId: Scalars['String']['output'];
1216
+ /** Cached display name of the held security, denormalized for list rendering. May lag the security row's current name briefly. */
819
1217
  securityName: Maybe<Scalars['String']['output']>;
1218
+ /** Lifecycle state. One of: `active` (currently held), `disposed` (soft-deleted via `update-portfolio-block` dispose), `archived` (historical record only). */
820
1219
  status: Scalars['String']['output'];
1220
+ /** Last-modified timestamp (UTC). */
821
1221
  updatedAt: Scalars['DateTime']['output'];
1222
+ /** Date `current_value` was sourced (YYYY-MM-DD). */
822
1223
  valuationDate: Maybe<Scalars['Date']['output']>;
1224
+ /** Free-text source attribution for the current valuation. */
823
1225
  valuationSource: Maybe<Scalars['String']['output']>;
824
1226
  };
1227
+ /**
1228
+ * Position projection embedded inside a `PortfolioBlockEnvelope`.
1229
+ *
1230
+ * Pre-converts cents fields to dollars (`cost_basis_dollars`,
1231
+ * `current_value_dollars`) for display; the cents-precision fields
1232
+ * live on the standalone `PositionResponse`. Embeds a `SecurityLite`
1233
+ * so callers can render the security name without a follow-up fetch.
1234
+ */
825
1235
  export type PositionBlock = {
1236
+ /** Date the position was acquired. */
826
1237
  acquisitionDate: Maybe<Scalars['Date']['output']>;
1238
+ /** Cost basis in dollars (pre-converted from cents). */
827
1239
  costBasisDollars: Scalars['Float']['output'];
1240
+ /** Latest mark-to-market value in dollars. `null` when the position has not been marked. */
828
1241
  currentValueDollars: Maybe<Scalars['Float']['output']>;
1242
+ /** Position ID (`pos_*` ULID). */
829
1243
  id: Scalars['ID']['output'];
1244
+ /** Free-text notes attached to the position. */
830
1245
  notes: Maybe<Scalars['String']['output']>;
1246
+ /** Quantity held in `quantity_type` units. */
831
1247
  quantity: Scalars['Float']['output'];
1248
+ /** Unit basis (`shares`, `units`, `principal`). */
832
1249
  quantityType: Scalars['String']['output'];
1250
+ /** Embedded security details — name, type, issuer. */
833
1251
  security: SecurityLite;
1252
+ /** Lifecycle state (`active`, `disposed`, `archived`). See `PositionResponse.status` for the full vocabulary. */
834
1253
  status: Scalars['String']['output'];
1254
+ /** Date the current value was sourced. */
835
1255
  valuationDate: Maybe<Scalars['Date']['output']>;
1256
+ /** Free-text source attribution for the valuation. */
836
1257
  valuationSource: Maybe<Scalars['String']['output']>;
837
1258
  };
1259
+ /** Paginated list of positions. */
838
1260
  export type PositionList = {
1261
+ /** Pagination cursor and totals. */
839
1262
  pagination: PaginationInfo;
1263
+ /** Positions on this page. */
840
1264
  positions: Array<Position>;
841
1265
  };
1266
+ /** Publish list summary — header metadata, no members. */
842
1267
  export type PublishList = {
1268
+ /** When the list was created. */
843
1269
  createdAt: Scalars['DateTime']['output'];
1270
+ /** User ID that created the list. */
844
1271
  createdBy: Scalars['String']['output'];
1272
+ /** Free-form description. */
845
1273
  description: Maybe<Scalars['String']['output']>;
1274
+ /** List identifier (ULID). */
846
1275
  id: Scalars['String']['output'];
1276
+ /** Number of recipient graphs currently on the list. */
847
1277
  memberCount: Scalars['Int']['output'];
1278
+ /** Human-readable list name. */
848
1279
  name: Scalars['String']['output'];
1280
+ /** Last metadata update (name/description). */
849
1281
  updatedAt: Scalars['DateTime']['output'];
850
1282
  };
1283
+ /** Full detail including members. */
851
1284
  export type PublishListDetail = {
1285
+ /** When the list was created. */
852
1286
  createdAt: Scalars['DateTime']['output'];
1287
+ /** User ID that created the list. */
853
1288
  createdBy: Scalars['String']['output'];
1289
+ /** Free-form description. */
854
1290
  description: Maybe<Scalars['String']['output']>;
1291
+ /** List identifier (ULID). */
855
1292
  id: Scalars['String']['output'];
1293
+ /** Number of recipient graphs currently on the list. */
856
1294
  memberCount: Scalars['Int']['output'];
1295
+ /** All recipient graphs on the list. */
857
1296
  members: Array<PublishListMember>;
1297
+ /** Human-readable list name. */
858
1298
  name: Scalars['String']['output'];
1299
+ /** Last metadata update (name/description). */
859
1300
  updatedAt: Scalars['DateTime']['output'];
860
1301
  };
1302
+ /** Paginated list of publish lists owned by the current graph. */
861
1303
  export type PublishListList = {
862
1304
  pagination: PaginationInfo;
1305
+ /** Publish list summaries, newest first. */
863
1306
  publishLists: Array<PublishList>;
864
1307
  };
1308
+ /** One recipient graph in a publish list. */
865
1309
  export type PublishListMember = {
1310
+ /** When the member was added. */
866
1311
  addedAt: Scalars['DateTime']['output'];
1312
+ /** User ID that added this member. */
867
1313
  addedBy: Scalars['String']['output'];
1314
+ /** Membership row identifier (ULID). */
868
1315
  id: Scalars['String']['output'];
1316
+ /** Recipient graph ID. */
869
1317
  targetGraphId: Scalars['String']['output'];
1318
+ /** Display name of the recipient graph (if known). */
870
1319
  targetGraphName: Maybe<Scalars['String']['output']>;
1320
+ /** Display name of the org that owns the recipient graph. */
871
1321
  targetOrgName: Maybe<Scalars['String']['output']>;
872
1322
  };
873
1323
  export type Query = {
@@ -1142,33 +1592,67 @@ export type QueryTrialBalanceArgs = {
1142
1592
  export type QueryUnmappedElementsArgs = {
1143
1593
  mappingId?: InputMaybe<Scalars['String']['input']>;
1144
1594
  };
1595
+ /**
1596
+ * Report definition summary — header metadata, no facts.
1597
+ *
1598
+ * Returned by ``create-report``, ``regenerate-report``,
1599
+ * ``file-report``, and ``transition-filing-status``. Use the package
1600
+ * read endpoint to retrieve a Report rehydrated with its rendered
1601
+ * ``InformationBlockEnvelope`` items.
1602
+ */
1145
1603
  export type Report = {
1604
+ /** True when the report was created by an AI agent rather than a user. */
1146
1605
  aiGenerated: Scalars['Boolean']['output'];
1606
+ /** True when an auto-generated prior-period column is included. */
1147
1607
  comparative: Scalars['Boolean']['output'];
1608
+ /** When the report row was created. */
1148
1609
  createdAt: Scalars['DateTime']['output'];
1610
+ /** Display name of the primary entity the report is tagged to. */
1149
1611
  entityName: Maybe<Scalars['String']['output']>;
1612
+ /** When the report was transitioned to `filed`. */
1150
1613
  filedAt: Maybe<Scalars['DateTime']['output']>;
1614
+ /** User ID that transitioned the report to `filed`. */
1151
1615
  filedBy: Maybe<Scalars['String']['output']>;
1616
+ /** Filing lifecycle (orthogonal to `generation_status`): `draft`, `under_review`, `filed`, `archived`. */
1152
1617
  filingStatus: Scalars['String']['output'];
1618
+ /** Computation lifecycle: `generating`, `published`, `failed`. Orthogonal to `filing_status`. */
1153
1619
  generationStatus: Scalars['String']['output'];
1620
+ /** Report identifier (ULID). */
1154
1621
  id: Scalars['String']['output'];
1622
+ /** When the facts were last (re)generated. */
1155
1623
  lastGenerated: Maybe<Scalars['DateTime']['output']>;
1624
+ /** CoA → taxonomy mapping the facts were rolled up through. */
1156
1625
  mappingId: Maybe<Scalars['String']['output']>;
1626
+ /** Human-readable report name. */
1157
1627
  name: Scalars['String']['output'];
1628
+ /** Current-period end. */
1158
1629
  periodEnd: Maybe<Scalars['Date']['output']>;
1630
+ /** Current-period start. */
1159
1631
  periodStart: Maybe<Scalars['Date']['output']>;
1632
+ /** Period cadence: `monthly`, `quarterly`, `annual`. */
1160
1633
  periodType: Scalars['String']['output'];
1634
+ /** Explicit period columns when the report was created with a multi-period layout. */
1161
1635
  periods: Maybe<Array<PeriodSpec>>;
1636
+ /** Counts by rule outcome (e.g. `{'passed': 12, 'failed': 1}`) from the most recent evaluation. Null until rules run. */
1162
1637
  ruleSummary: Maybe<Scalars['JSON']['output']>;
1638
+ /** When the report was shared into this graph (recipient side). */
1163
1639
  sharedAt: Maybe<Scalars['DateTime']['output']>;
1640
+ /** Origin graph for received (shared) reports — populated only on the recipient's copy. */
1164
1641
  sourceGraphId: Maybe<Scalars['String']['output']>;
1642
+ /** Origin report ID for received (shared) reports — populated only on the recipient's copy. */
1165
1643
  sourceReportId: Maybe<Scalars['String']['output']>;
1644
+ /** Structures available for this report's taxonomy — renderable sections (BS / IS / CF / Equity / Schedules). */
1166
1645
  structures: Array<StructureSummary>;
1646
+ /** When this report has been restated, the successor's report ID. */
1167
1647
  supersededById: Maybe<Scalars['String']['output']>;
1648
+ /** When this report restates an earlier filing, the predecessor's report ID. */
1168
1649
  supersedesId: Maybe<Scalars['String']['output']>;
1650
+ /** Taxonomy this report renders against. */
1169
1651
  taxonomyId: Scalars['String']['output'];
1170
1652
  };
1653
+ /** List of report header summaries (used by report list reads). */
1171
1654
  export type ReportList = {
1655
+ /** Report definitions, newest first. */
1172
1656
  reports: Array<Report>;
1173
1657
  };
1174
1658
  export type ReportPackage = {
@@ -1220,25 +1704,60 @@ export type SecurityList = {
1220
1704
  pagination: PaginationInfo;
1221
1705
  securities: Array<Security>;
1222
1706
  };
1707
+ /**
1708
+ * Lightweight security projection for embedding in position
1709
+ * envelopes. Skips `terms`, `outstanding_shares`, etc. — fetch the
1710
+ * full `SecurityResponse` when those are needed.
1711
+ */
1223
1712
  export type SecurityLite = {
1713
+ /** Security ID (`sec_*` ULID). */
1224
1714
  id: Scalars['ID']['output'];
1715
+ /** `true` when the security is in active status. */
1225
1716
  isActive: Scalars['Boolean']['output'];
1717
+ /** Embedded issuer entity, when one is linked. `null` for pre-issuer securities. */
1226
1718
  issuer: Maybe<EntityLite>;
1719
+ /** Display name of the security. */
1227
1720
  name: Scalars['String']['output'];
1721
+ /** Optional subtype refinement (e.g. `class_a`). */
1228
1722
  securitySubtype: Maybe<Scalars['String']['output']>;
1723
+ /** Instrument family (e.g. `common_stock`, `preferred_stock`, `warrant`). */
1229
1724
  securityType: Scalars['String']['output'];
1725
+ /** Tenant graph the security is pre-associated to, if any. */
1230
1726
  sourceGraphId: Maybe<Scalars['String']['output']>;
1231
1727
  };
1728
+ /**
1729
+ * Rendered financial statement — facts viewed through a structure.
1730
+ *
1731
+ * Returned by report read endpoints when a single statement is
1732
+ * requested. The package mode endpoint returns a list of these
1733
+ * rehydrated as ``InformationBlockEnvelope`` items instead.
1734
+ */
1232
1735
  export type Statement = {
1736
+ /** Period columns rendered in this statement, in display order. */
1233
1737
  periods: Array<PeriodSpec>;
1738
+ /** The Report this statement was rendered from. */
1234
1739
  reportId: Scalars['String']['output'];
1740
+ /** One row per concept in the structure, in tree order. */
1235
1741
  rows: Array<FactRow>;
1742
+ /** Structure projected for this statement. */
1236
1743
  structureId: Scalars['String']['output'];
1744
+ /** Human-readable structure name. */
1237
1745
  structureName: Scalars['String']['output'];
1746
+ /** Structure category: `balance_sheet`, `income_statement`, `cash_flow_statement`, `equity_statement`, `schedule`. */
1238
1747
  structureType: Scalars['String']['output'];
1748
+ /** Number of GL elements that fell through the mapping with no destination concept. Indicates mapping gaps. */
1239
1749
  unmappedCount: Scalars['Int']['output'];
1750
+ /** Outcome of running reporting rules over this structure. Null when the structure has no rules attached. */
1240
1751
  validation: Maybe<ValidationCheck>;
1241
1752
  };
1753
+ /**
1754
+ * One structure header — a renderable section within a taxonomy
1755
+ * (balance sheet, income statement, schedule, etc.).
1756
+ *
1757
+ * ``structure_type`` drives presentation: 'balance_sheet',
1758
+ * 'income_statement', 'cash_flow_statement', 'equity_statement',
1759
+ * 'schedule', 'chart_of_accounts', 'coa_mapping', 'rollforward', etc.
1760
+ */
1242
1761
  export type Structure = {
1243
1762
  description: Maybe<Scalars['String']['output']>;
1244
1763
  id: Scalars['String']['output'];
@@ -1247,20 +1766,43 @@ export type Structure = {
1247
1766
  structureType: Scalars['String']['output'];
1248
1767
  taxonomyId: Scalars['String']['output'];
1249
1768
  };
1769
+ /** Flat list of structures within a taxonomy. */
1250
1770
  export type StructureList = {
1251
1771
  structures: Array<Structure>;
1252
1772
  };
1773
+ /**
1774
+ * A structure available within this report's taxonomy.
1775
+ *
1776
+ * Each structure is a renderable section (Balance Sheet, Income
1777
+ * Statement, Cash Flow Statement, Equity, or a Schedule). The Report
1778
+ * row owns the facts; structures are the lenses that project them.
1779
+ */
1253
1780
  export type StructureSummary = {
1781
+ /** Structure identifier. */
1254
1782
  id: Scalars['String']['output'];
1783
+ /** Human-readable structure name. */
1255
1784
  name: Scalars['String']['output'];
1785
+ /** Structure category: `balance_sheet`, `income_statement`, `cash_flow_statement`, `equity_statement`, `schedule`. */
1256
1786
  structureType: Scalars['String']['output'];
1257
1787
  };
1788
+ /** A suggested mapping target from the reporting taxonomy. */
1258
1789
  export type SuggestedTarget = {
1259
1790
  confidence: Maybe<Scalars['Float']['output']>;
1260
1791
  elementId: Scalars['String']['output'];
1261
1792
  name: Scalars['String']['output'];
1262
1793
  qname: Scalars['String']['output'];
1263
1794
  };
1795
+ /**
1796
+ * One taxonomy header — identity + lifecycle flags. Atoms
1797
+ * (elements, structures, associations, rules) are exposed via the
1798
+ * Taxonomy Block envelope.
1799
+ *
1800
+ * ``taxonomy_type`` discriminates: ``chart_of_accounts``,
1801
+ * ``reporting_standard``, ``reporting_extension``, ``custom_ontology``,
1802
+ * ``mapping``, ``schedule``. ``is_locked=True`` means library-origin
1803
+ * (immutable for tenants); ``is_shared=True`` means visible to multiple
1804
+ * graphs from a shared registry.
1805
+ */
1264
1806
  export type Taxonomy = {
1265
1807
  description: Maybe<Scalars['String']['output']>;
1266
1808
  id: Scalars['String']['output'];
@@ -1337,14 +1879,24 @@ export type TaxonomyBlockStructure = {
1337
1879
  roleUri: Maybe<Scalars['String']['output']>;
1338
1880
  structureType: Scalars['String']['output'];
1339
1881
  };
1882
+ /** Flat list of taxonomy headers. Used by the catalog/picker UIs. */
1340
1883
  export type TaxonomyList = {
1341
1884
  taxonomies: Array<Taxonomy>;
1342
1885
  };
1886
+ /**
1887
+ * Trial balance for posted entries in a date range — every CoA
1888
+ * account that had activity, plus aggregate totals.
1889
+ *
1890
+ * Ledger is balanced when ``total_debits == total_credits``. Used as
1891
+ * a sanity check before close-period; failure means an unposted /
1892
+ * malformed entry slipped through.
1893
+ */
1343
1894
  export type TrialBalance = {
1344
1895
  rows: Array<TrialBalanceRow>;
1345
1896
  totalCredits: Scalars['Float']['output'];
1346
1897
  totalDebits: Scalars['Float']['output'];
1347
1898
  };
1899
+ /** One CoA account's debit/credit totals over the trial-balance window. */
1348
1900
  export type TrialBalanceRow = {
1349
1901
  accountCode: Scalars['String']['output'];
1350
1902
  accountId: Scalars['String']['output'];
@@ -1355,6 +1907,7 @@ export type TrialBalanceRow = {
1355
1907
  totalDebits: Scalars['Float']['output'];
1356
1908
  trait: Maybe<Scalars['String']['output']>;
1357
1909
  };
1910
+ /** An element not yet mapped to the reporting taxonomy. */
1358
1911
  export type UnmappedElement = {
1359
1912
  balanceType: Scalars['String']['output'];
1360
1913
  code: Maybe<Scalars['String']['output']>;
@@ -1364,10 +1917,15 @@ export type UnmappedElement = {
1364
1917
  suggestedTargets: Array<SuggestedTarget>;
1365
1918
  trait: Maybe<Scalars['String']['output']>;
1366
1919
  };
1920
+ /** Aggregate result of running reporting rules over a structure. */
1367
1921
  export type ValidationCheck = {
1922
+ /** Names of rules that were evaluated. */
1368
1923
  checks: Array<Scalars['String']['output']>;
1924
+ /** Human-readable descriptions of rule failures. */
1369
1925
  failures: Array<Scalars['String']['output']>;
1926
+ /** True iff every rule produced zero failures. */
1370
1927
  passed: Scalars['Boolean']['output'];
1928
+ /** Non-blocking advisories from rule evaluation. */
1371
1929
  warnings: Array<Scalars['String']['output']>;
1372
1930
  };
1373
1931
  export type GetInvestorHoldingsQueryVariables = Exact<{