@robosystems/client 2.15.0 → 2.17.0
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.
- package/artifacts/LedgerClient.d.ts +8 -1
- package/artifacts/LedgerClient.js +10 -0
- package/artifacts/LedgerClient.ts +19 -0
- package/artifacts/graphql/generated/graphql.d.ts +8 -0
- package/artifacts/graphql/generated/graphql.js +8 -0
- package/artifacts/graphql/generated/graphql.ts +16 -0
- package/artifacts/graphql/queries/ledger/entities.js +4 -0
- package/artifacts/graphql/queries/ledger/entities.ts +4 -0
- package/artifacts/graphql/queries/ledger/entity.js +4 -0
- package/artifacts/graphql/queries/ledger/entity.ts +4 -0
- package/index.ts +2 -2
- package/package.json +1 -1
- package/sdk/index.d.ts +2 -2
- package/sdk/index.js +6 -5
- package/sdk/index.ts +2 -2
- package/sdk/sdk.gen.d.ts +13 -5
- package/sdk/sdk.gen.js +22 -5
- package/sdk/sdk.gen.ts +22 -5
- package/sdk/types.gen.d.ts +406 -8
- package/sdk/types.gen.ts +416 -8
- package/sdk.gen.d.ts +13 -5
- package/sdk.gen.js +22 -5
- package/sdk.gen.ts +22 -5
- package/types.gen.d.ts +406 -8
- package/types.gen.ts +416 -8
package/sdk/types.gen.d.ts
CHANGED
|
@@ -2532,6 +2532,112 @@ export type ConnectionResponse = {
|
|
|
2532
2532
|
[key: string]: unknown;
|
|
2533
2533
|
};
|
|
2534
2534
|
};
|
|
2535
|
+
/**
|
|
2536
|
+
* ConsolidationWorksheetRequest
|
|
2537
|
+
*
|
|
2538
|
+
* Request for consolidation-worksheet (OLTP, entity graphs only).
|
|
2539
|
+
*/
|
|
2540
|
+
export type ConsolidationWorksheetRequest = {
|
|
2541
|
+
/**
|
|
2542
|
+
* Statement Type
|
|
2543
|
+
*
|
|
2544
|
+
* income_statement | balance_sheet | cash_flow_statement | equity_statement.
|
|
2545
|
+
*/
|
|
2546
|
+
statement_type: string;
|
|
2547
|
+
/**
|
|
2548
|
+
* Period Start
|
|
2549
|
+
*
|
|
2550
|
+
* Explicit window start. Overrides period_type/fiscal_year.
|
|
2551
|
+
*/
|
|
2552
|
+
period_start?: string | null;
|
|
2553
|
+
/**
|
|
2554
|
+
* Period End
|
|
2555
|
+
*
|
|
2556
|
+
* Explicit window end. Overrides period_type/fiscal_year.
|
|
2557
|
+
*/
|
|
2558
|
+
period_end?: string | null;
|
|
2559
|
+
/**
|
|
2560
|
+
* Period Type
|
|
2561
|
+
*
|
|
2562
|
+
* annual | quarterly | instant (ignored when dates supplied)
|
|
2563
|
+
*/
|
|
2564
|
+
period_type?: string | null;
|
|
2565
|
+
/**
|
|
2566
|
+
* Fiscal Year
|
|
2567
|
+
*
|
|
2568
|
+
* Fiscal year for annual window (anchored on FiscalCalendar)
|
|
2569
|
+
*/
|
|
2570
|
+
fiscal_year?: number | null;
|
|
2571
|
+
/**
|
|
2572
|
+
* Limit
|
|
2573
|
+
*
|
|
2574
|
+
* Max rows returned. Defaults to the ceiling: the whole statement.
|
|
2575
|
+
*/
|
|
2576
|
+
limit?: number;
|
|
2577
|
+
};
|
|
2578
|
+
/**
|
|
2579
|
+
* ConsolidationWorksheetResponse
|
|
2580
|
+
*
|
|
2581
|
+
* The group's statement with the entity as the column.
|
|
2582
|
+
*/
|
|
2583
|
+
export type ConsolidationWorksheetResponse = {
|
|
2584
|
+
/**
|
|
2585
|
+
* Graph Id
|
|
2586
|
+
*
|
|
2587
|
+
* The graph read.
|
|
2588
|
+
*/
|
|
2589
|
+
graph_id: string;
|
|
2590
|
+
/**
|
|
2591
|
+
* Entity Id
|
|
2592
|
+
*
|
|
2593
|
+
* The group parent.
|
|
2594
|
+
*/
|
|
2595
|
+
entity_id: string;
|
|
2596
|
+
/**
|
|
2597
|
+
* Statement Type
|
|
2598
|
+
*
|
|
2599
|
+
* The statement rendered.
|
|
2600
|
+
*/
|
|
2601
|
+
statement_type: string;
|
|
2602
|
+
/**
|
|
2603
|
+
* The window every column reads. The cash flow also pivots the prior window of equal length as its delta basis; it is not rendered.
|
|
2604
|
+
*/
|
|
2605
|
+
period: PeriodSpec;
|
|
2606
|
+
/**
|
|
2607
|
+
* Columns
|
|
2608
|
+
*
|
|
2609
|
+
* The parent, each member consolidated in full, `combined`, the consolidation entity's adjustments (when the group has one), `consolidated`, then the equity-method and cost members outside the sum. A member outside its membership interval for the period has no column.
|
|
2610
|
+
*/
|
|
2611
|
+
columns: Array<WorksheetColumn>;
|
|
2612
|
+
/**
|
|
2613
|
+
* Rows
|
|
2614
|
+
*
|
|
2615
|
+
* The union of every column's lines in the parent's Style order; a line zero in every column is left out.
|
|
2616
|
+
*/
|
|
2617
|
+
rows: Array<WorksheetRow>;
|
|
2618
|
+
/**
|
|
2619
|
+
* The guard-rail outcome for the consolidated column, the same checks live-financial-statement runs.
|
|
2620
|
+
*/
|
|
2621
|
+
validation?: ValidationCheckResponse | null;
|
|
2622
|
+
/**
|
|
2623
|
+
* Unmapped Entity Ids
|
|
2624
|
+
*
|
|
2625
|
+
* Entities with no CoA mapping yet, so with no column.
|
|
2626
|
+
*/
|
|
2627
|
+
unmapped_entity_ids?: Array<string>;
|
|
2628
|
+
/**
|
|
2629
|
+
* Unmapped Count
|
|
2630
|
+
*
|
|
2631
|
+
* Unmapped accounts across the summed columns.
|
|
2632
|
+
*/
|
|
2633
|
+
unmapped_count?: number;
|
|
2634
|
+
/**
|
|
2635
|
+
* Truncated
|
|
2636
|
+
*
|
|
2637
|
+
* Whether `limit` cut rows.
|
|
2638
|
+
*/
|
|
2639
|
+
truncated?: boolean;
|
|
2640
|
+
};
|
|
2535
2641
|
/**
|
|
2536
2642
|
* ContentLimits
|
|
2537
2643
|
*
|
|
@@ -2874,6 +2980,24 @@ export type CreateEntityRequest = {
|
|
|
2874
2980
|
* The parent's share of this entity, as a percent (100 = wholly owned). Omit when not recorded. Refused on a graph's first entity, which becomes the group parent.
|
|
2875
2981
|
*/
|
|
2876
2982
|
ownership_pct?: number | null;
|
|
2983
|
+
/**
|
|
2984
|
+
* Consolidation Method
|
|
2985
|
+
*
|
|
2986
|
+
* 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. Omit to derive it; a graph's first entity and a `consolidation` entity take `none`.
|
|
2987
|
+
*/
|
|
2988
|
+
consolidation_method?: 'full' | 'equity' | 'cost' | 'none' | null;
|
|
2989
|
+
/**
|
|
2990
|
+
* Entity Role
|
|
2991
|
+
*
|
|
2992
|
+
* `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`; a graph's first entity, its group parent, is always operating. Start a consolidation entity's chart from the `consolidation` template.
|
|
2993
|
+
*/
|
|
2994
|
+
entity_role?: 'operating' | 'consolidation' | null;
|
|
2995
|
+
/**
|
|
2996
|
+
* Joined On
|
|
2997
|
+
*
|
|
2998
|
+
* 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. Omit for a subsidiary formed by the parent; give the acquisition month for one acquired, whose books in this graph then hold only what follows it.
|
|
2999
|
+
*/
|
|
3000
|
+
joined_on?: string | null;
|
|
2877
3001
|
/**
|
|
2878
3002
|
* Ticker
|
|
2879
3003
|
*
|
|
@@ -8342,9 +8466,9 @@ export type InitializeChartOfAccountsRequest = {
|
|
|
8342
8466
|
/**
|
|
8343
8467
|
* Template
|
|
8344
8468
|
*
|
|
8345
|
-
* Template key: `saas` (subscription software — deferred revenue, cost of revenue, R&D / S&M / G&A), `services` (professional services — no inventory, no COGS), `product` (inventory and cost of goods sold, direct + wholesale + subscription revenue).
|
|
8469
|
+
* Template key: `saas` (subscription software — deferred revenue, cost of revenue, R&D / S&M / G&A), `services` (professional services — no inventory, no COGS), `product` (inventory and cost of goods sold, direct + wholesale + subscription revenue), `consolidation` (a group's consolidation entity: the eliminated investment, intercompany and subsidiary-equity rows, noncontrolling interest and its share of income — the adjustments column, never an operating company's chart).
|
|
8346
8470
|
*/
|
|
8347
|
-
template: 'saas' | 'services' | 'product';
|
|
8471
|
+
template: 'saas' | 'services' | 'product' | 'consolidation';
|
|
8348
8472
|
/**
|
|
8349
8473
|
* Entity Type
|
|
8350
8474
|
*
|
|
@@ -8375,7 +8499,7 @@ export type InitializeChartOfAccountsResponse = {
|
|
|
8375
8499
|
/**
|
|
8376
8500
|
* Template
|
|
8377
8501
|
*/
|
|
8378
|
-
template: 'saas' | 'services' | 'product';
|
|
8502
|
+
template: 'saas' | 'services' | 'product' | 'consolidation';
|
|
8379
8503
|
/**
|
|
8380
8504
|
* Entity Type
|
|
8381
8505
|
*
|
|
@@ -8750,7 +8874,7 @@ export type JournalEntryLineItemInput = {
|
|
|
8750
8874
|
/**
|
|
8751
8875
|
* Flow Qname
|
|
8752
8876
|
*
|
|
8753
|
-
* The cash flow row this line's cash belongs to, an rs-gaap flow qname (`flowCandidates(entityId)` lists the rows this company's statement offers). Only for a loan drawn or repaid, capital put in or taken out, an asset bought or sold; omitted, the account's default flow applies. A flow set on one side of the entry tags the untagged lines on the other: the cash flow statement reads the cash line and the roll-forwards read the account line. Refused when it is not a row of the entity's cash flow statement.
|
|
8877
|
+
* The cash flow row this line's cash belongs to, an rs-gaap flow qname (`flowCandidates(entityId)` lists the rows this company's statement offers). Only for a loan drawn or repaid, capital put in or taken out, an asset bought or sold; omitted, the account's default flow applies. A flow set on one side of the entry tags the untagged lines on the other: the cash flow statement reads the cash line and the roll-forwards read the account line. On the group's consolidation entity, which moves no cash, every tagged line counts on its own, cash-effect signed (a credit is an inflow), so an elimination offsets the flow a member's line produced. Refused when it is not a row of the entity's cash flow statement.
|
|
8754
8878
|
*/
|
|
8755
8879
|
flow_qname?: string | null;
|
|
8756
8880
|
/**
|
|
@@ -9131,6 +9255,30 @@ export type LedgerEntityResponse = {
|
|
|
9131
9255
|
* The parent's share of this entity, as a percent (100 = wholly owned). Null on the group parent, and where it was never recorded.
|
|
9132
9256
|
*/
|
|
9133
9257
|
ownership_pct?: number | null;
|
|
9258
|
+
/**
|
|
9259
|
+
* Consolidation Method
|
|
9260
|
+
*
|
|
9261
|
+
* 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.
|
|
9262
|
+
*/
|
|
9263
|
+
consolidation_method?: string;
|
|
9264
|
+
/**
|
|
9265
|
+
* Entity Role
|
|
9266
|
+
*
|
|
9267
|
+
* `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`.
|
|
9268
|
+
*/
|
|
9269
|
+
entity_role?: string;
|
|
9270
|
+
/**
|
|
9271
|
+
* Joined On
|
|
9272
|
+
*
|
|
9273
|
+
* 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.
|
|
9274
|
+
*/
|
|
9275
|
+
joined_on?: string | null;
|
|
9276
|
+
/**
|
|
9277
|
+
* Left On
|
|
9278
|
+
*
|
|
9279
|
+
* 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.
|
|
9280
|
+
*/
|
|
9281
|
+
left_on?: string | null;
|
|
9134
9282
|
/**
|
|
9135
9283
|
* Source
|
|
9136
9284
|
*
|
|
@@ -9784,10 +9932,16 @@ export type LiveFinancialStatementRequest = {
|
|
|
9784
9932
|
* Fiscal year for annual window (anchored on FiscalCalendar)
|
|
9785
9933
|
*/
|
|
9786
9934
|
fiscal_year?: number | null;
|
|
9935
|
+
/**
|
|
9936
|
+
* Scope
|
|
9937
|
+
*
|
|
9938
|
+
* `entity` (the default): one entity's own books. `combined`: on the group parent, every member consolidated in full rendered under the parent's Reporting Style and summed per rs-gaap concept, each for the months it was a member — the pre-adjustment total, nothing eliminated. `consolidated`: the same sum plus the consolidation entity, whose eliminations and noncontrolling interest are the adjustments column, so a group that posts its consolidating entries there reads its consolidated statement. An equity-method or cost member is never summed (its `consolidation_method` says so). Both group scopes are read on the group parent only (422 on a subsidiary). An entity with no CoA mapping yet contributes nothing and is left out of `combined_entity_ids`.
|
|
9939
|
+
*/
|
|
9940
|
+
scope?: 'entity' | 'combined' | 'consolidated' | null;
|
|
9787
9941
|
/**
|
|
9788
9942
|
* Consolidated
|
|
9789
9943
|
*
|
|
9790
|
-
*
|
|
9944
|
+
* The older spelling of `scope: consolidated`, kept for callers that pass it; `scope` wins when both are given.
|
|
9791
9945
|
*/
|
|
9792
9946
|
consolidated?: boolean;
|
|
9793
9947
|
/**
|
|
@@ -9813,16 +9967,22 @@ export type LiveFinancialStatementResponse = {
|
|
|
9813
9967
|
* The entity whose books were rendered.
|
|
9814
9968
|
*/
|
|
9815
9969
|
entity_id?: string | null;
|
|
9970
|
+
/**
|
|
9971
|
+
* Scope
|
|
9972
|
+
*
|
|
9973
|
+
* What was rendered: `entity`, `combined` (the members summed, nothing eliminated) or `consolidated` (the members plus the consolidation entity's adjustments).
|
|
9974
|
+
*/
|
|
9975
|
+
scope?: string;
|
|
9816
9976
|
/**
|
|
9817
9977
|
* Consolidated
|
|
9818
9978
|
*
|
|
9819
|
-
* Whether the group's entities were summed into this
|
|
9979
|
+
* Whether the group's entities were summed into this — true for the `combined` and `consolidated` scopes.
|
|
9820
9980
|
*/
|
|
9821
9981
|
consolidated?: boolean;
|
|
9822
9982
|
/**
|
|
9823
9983
|
* Combined Entity Ids
|
|
9824
9984
|
*
|
|
9825
|
-
* The entities summed
|
|
9985
|
+
* The entities summed, parent first; on `consolidated` the consolidation entity comes last.
|
|
9826
9986
|
*/
|
|
9827
9987
|
combined_entity_ids?: Array<string>;
|
|
9828
9988
|
/**
|
|
@@ -9886,6 +10046,12 @@ export type LiveStatementFactRow = {
|
|
|
9886
10046
|
* Is Subtotal
|
|
9887
10047
|
*/
|
|
9888
10048
|
is_subtotal?: boolean;
|
|
10049
|
+
/**
|
|
10050
|
+
* Period Role
|
|
10051
|
+
*
|
|
10052
|
+
* On the equity roll-forward, `start` for the beginning-balance row and `end` for the ending-balance row. Null elsewhere.
|
|
10053
|
+
*/
|
|
10054
|
+
period_role?: string | null;
|
|
9889
10055
|
};
|
|
9890
10056
|
/**
|
|
9891
10057
|
* LoginRequest
|
|
@@ -11253,6 +11419,51 @@ export type OperationEnvelopeComputeMetricsResponse = {
|
|
|
11253
11419
|
*/
|
|
11254
11420
|
idempotentReplay?: boolean;
|
|
11255
11421
|
};
|
|
11422
|
+
/**
|
|
11423
|
+
* OperationEnvelope[ConsolidationWorksheetResponse]
|
|
11424
|
+
*/
|
|
11425
|
+
export type OperationEnvelopeConsolidationWorksheetResponse = {
|
|
11426
|
+
/**
|
|
11427
|
+
* Operation
|
|
11428
|
+
*
|
|
11429
|
+
* Kebab-case operation name
|
|
11430
|
+
*/
|
|
11431
|
+
operation: string;
|
|
11432
|
+
/**
|
|
11433
|
+
* Operationid
|
|
11434
|
+
*
|
|
11435
|
+
* op_-prefixed ULID for audit and SSE correlation
|
|
11436
|
+
*/
|
|
11437
|
+
operationId: string;
|
|
11438
|
+
/**
|
|
11439
|
+
* Status
|
|
11440
|
+
*
|
|
11441
|
+
* Operation lifecycle state
|
|
11442
|
+
*/
|
|
11443
|
+
status: 'completed' | 'pending' | 'failed';
|
|
11444
|
+
/**
|
|
11445
|
+
* Command-specific result payload
|
|
11446
|
+
*/
|
|
11447
|
+
result?: ConsolidationWorksheetResponse | null;
|
|
11448
|
+
/**
|
|
11449
|
+
* At
|
|
11450
|
+
*
|
|
11451
|
+
* ISO-8601 UTC timestamp
|
|
11452
|
+
*/
|
|
11453
|
+
at: string;
|
|
11454
|
+
/**
|
|
11455
|
+
* Createdby
|
|
11456
|
+
*
|
|
11457
|
+
* User ID that initiated the operation
|
|
11458
|
+
*/
|
|
11459
|
+
createdBy?: string | null;
|
|
11460
|
+
/**
|
|
11461
|
+
* Idempotentreplay
|
|
11462
|
+
*
|
|
11463
|
+
* True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
|
|
11464
|
+
*/
|
|
11465
|
+
idempotentReplay?: boolean;
|
|
11466
|
+
};
|
|
11256
11467
|
/**
|
|
11257
11468
|
* OperationEnvelope[DeleteInformationBlockResponse]
|
|
11258
11469
|
*/
|
|
@@ -19269,6 +19480,12 @@ export type TaxonomyBlockStructureRequest = {
|
|
|
19269
19480
|
* `coa_mapping` only: the framework this mapping maps the chart into, e.g. `rs-gaap`. Omitted means the graph's book framework. A chart holds one mapping per framework.
|
|
19270
19481
|
*/
|
|
19271
19482
|
target_framework?: string | null;
|
|
19483
|
+
/**
|
|
19484
|
+
* Extends Network
|
|
19485
|
+
*
|
|
19486
|
+
* `reporting_extension` only: the role URI of the Reporting Style network this structure extends (e.g. `https://robosystems.ai/seattle/cm-roles/roles/rs-gaap-presentation/CashFlow-indirect`). Its arcs then render as rows of that statement for every entity whose Style composes it. `block_type` must be that network's statement type. A row's parent must be on the network, a balance sheet, income statement or cash flow row needs a calculation arc from its section subtotal, an equity movement hangs from the roll-forward's root, and a tenant concept placed as a row must set `parent_ref` to the rs-gaap concept it refines — prefer the rs-gaap concept itself (any library concept may be named, including ones not yet in this graph).
|
|
19487
|
+
*/
|
|
19488
|
+
extends_network?: string | null;
|
|
19272
19489
|
/**
|
|
19273
19490
|
* Metadata
|
|
19274
19491
|
*/
|
|
@@ -19811,9 +20028,33 @@ export type UpdateEntityRequest = {
|
|
|
19811
20028
|
/**
|
|
19812
20029
|
* Ownership Pct
|
|
19813
20030
|
*
|
|
19814
|
-
* The parent's share of this entity, as a percent. Refused on the group parent, which has no owner in the graph.
|
|
20031
|
+
* 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.
|
|
19815
20032
|
*/
|
|
19816
20033
|
ownership_pct?: number | null;
|
|
20034
|
+
/**
|
|
20035
|
+
* Consolidation Method
|
|
20036
|
+
*
|
|
20037
|
+
* 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.
|
|
20038
|
+
*/
|
|
20039
|
+
consolidation_method?: 'full' | 'equity' | 'cost' | 'none' | null;
|
|
20040
|
+
/**
|
|
20041
|
+
* Entity Role
|
|
20042
|
+
*
|
|
20043
|
+
* `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`.
|
|
20044
|
+
*/
|
|
20045
|
+
entity_role?: 'operating' | 'consolidation' | null;
|
|
20046
|
+
/**
|
|
20047
|
+
* Joined On
|
|
20048
|
+
*
|
|
20049
|
+
* 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.
|
|
20050
|
+
*/
|
|
20051
|
+
joined_on?: string | null;
|
|
20052
|
+
/**
|
|
20053
|
+
* Left On
|
|
20054
|
+
*
|
|
20055
|
+
* 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.
|
|
20056
|
+
*/
|
|
20057
|
+
left_on?: string | null;
|
|
19817
20058
|
};
|
|
19818
20059
|
/**
|
|
19819
20060
|
* UpdateEventBlockRequest
|
|
@@ -20989,6 +21230,104 @@ export type ViewResponse = {
|
|
|
20989
21230
|
[key: string]: ElementSummary;
|
|
20990
21231
|
} | null;
|
|
20991
21232
|
};
|
|
21233
|
+
/**
|
|
21234
|
+
* WorksheetColumn
|
|
21235
|
+
*
|
|
21236
|
+
* One column of the consolidation worksheet.
|
|
21237
|
+
*/
|
|
21238
|
+
export type WorksheetColumn = {
|
|
21239
|
+
/**
|
|
21240
|
+
* Key
|
|
21241
|
+
*
|
|
21242
|
+
* The entity id for an entity's column; `combined` and `consolidated` for the two totals.
|
|
21243
|
+
*/
|
|
21244
|
+
key: string;
|
|
21245
|
+
/**
|
|
21246
|
+
* Label
|
|
21247
|
+
*
|
|
21248
|
+
* The entity's name, or the total's.
|
|
21249
|
+
*/
|
|
21250
|
+
label: string;
|
|
21251
|
+
/**
|
|
21252
|
+
* Kind
|
|
21253
|
+
*
|
|
21254
|
+
* `member`: the parent or a member consolidated in full. `combined`: the members' sum, nothing eliminated. `adjustments`: the consolidation entity's entries. `consolidated`: combined plus the adjustments. `not_summed`: an equity-method or cost member, shown beside the sum and never in it.
|
|
21255
|
+
*/
|
|
21256
|
+
kind: 'member' | 'combined' | 'adjustments' | 'consolidated' | 'not_summed';
|
|
21257
|
+
/**
|
|
21258
|
+
* Entity Id
|
|
21259
|
+
*
|
|
21260
|
+
* The entity the column reads; null on a total.
|
|
21261
|
+
*/
|
|
21262
|
+
entity_id?: string | null;
|
|
21263
|
+
/**
|
|
21264
|
+
* Consolidation Method
|
|
21265
|
+
*
|
|
21266
|
+
* The entity's `consolidation_method`; null on a total.
|
|
21267
|
+
*/
|
|
21268
|
+
consolidation_method?: string | null;
|
|
21269
|
+
/**
|
|
21270
|
+
* Ownership Pct
|
|
21271
|
+
*
|
|
21272
|
+
* The parent's share of the entity, where it has one.
|
|
21273
|
+
*/
|
|
21274
|
+
ownership_pct?: number | null;
|
|
21275
|
+
/**
|
|
21276
|
+
* In Sum
|
|
21277
|
+
*
|
|
21278
|
+
* Whether the column is part of the consolidated total.
|
|
21279
|
+
*/
|
|
21280
|
+
in_sum: boolean;
|
|
21281
|
+
};
|
|
21282
|
+
/**
|
|
21283
|
+
* WorksheetRow
|
|
21284
|
+
*
|
|
21285
|
+
* One line of the consolidation worksheet, a value per column.
|
|
21286
|
+
*/
|
|
21287
|
+
export type WorksheetRow = {
|
|
21288
|
+
/**
|
|
21289
|
+
* Qname
|
|
21290
|
+
*
|
|
21291
|
+
* The rs-gaap concept of the line.
|
|
21292
|
+
*/
|
|
21293
|
+
qname: string;
|
|
21294
|
+
/**
|
|
21295
|
+
* Name
|
|
21296
|
+
*
|
|
21297
|
+
* The line's label.
|
|
21298
|
+
*/
|
|
21299
|
+
name: string;
|
|
21300
|
+
/**
|
|
21301
|
+
* Trait
|
|
21302
|
+
*
|
|
21303
|
+
* The concept's classification.
|
|
21304
|
+
*/
|
|
21305
|
+
trait?: string | null;
|
|
21306
|
+
/**
|
|
21307
|
+
* Values
|
|
21308
|
+
*
|
|
21309
|
+
* One value per column, aligned with `columns`.
|
|
21310
|
+
*/
|
|
21311
|
+
values: Array<number | null>;
|
|
21312
|
+
/**
|
|
21313
|
+
* Depth
|
|
21314
|
+
*
|
|
21315
|
+
* Indentation in the statement.
|
|
21316
|
+
*/
|
|
21317
|
+
depth?: number;
|
|
21318
|
+
/**
|
|
21319
|
+
* Is Subtotal
|
|
21320
|
+
*
|
|
21321
|
+
* Whether the line is a total.
|
|
21322
|
+
*/
|
|
21323
|
+
is_subtotal?: boolean;
|
|
21324
|
+
/**
|
|
21325
|
+
* Period Role
|
|
21326
|
+
*
|
|
21327
|
+
* On the equity roll-forward, `start` for the beginning-balance row and `end` for the ending-balance row. Null elsewhere.
|
|
21328
|
+
*/
|
|
21329
|
+
period_role?: string | null;
|
|
21330
|
+
};
|
|
20992
21331
|
/**
|
|
20993
21332
|
* _CreateForecastArm
|
|
20994
21333
|
*
|
|
@@ -32363,6 +32702,65 @@ export type LiveFinancialStatementResponses = {
|
|
|
32363
32702
|
200: OperationEnvelopeLiveFinancialStatementResponse;
|
|
32364
32703
|
};
|
|
32365
32704
|
export type LiveFinancialStatementResponse2 = LiveFinancialStatementResponses[keyof LiveFinancialStatementResponses];
|
|
32705
|
+
export type ConsolidationWorksheetData = {
|
|
32706
|
+
body: ConsolidationWorksheetRequest;
|
|
32707
|
+
headers?: {
|
|
32708
|
+
/**
|
|
32709
|
+
* Idempotency-Key
|
|
32710
|
+
*/
|
|
32711
|
+
'Idempotency-Key'?: string | null;
|
|
32712
|
+
};
|
|
32713
|
+
path: {
|
|
32714
|
+
/**
|
|
32715
|
+
* Graph Id
|
|
32716
|
+
*/
|
|
32717
|
+
graph_id: string;
|
|
32718
|
+
};
|
|
32719
|
+
query?: never;
|
|
32720
|
+
url: '/extensions/roboledger/{graph_id}/operations/consolidation-worksheet';
|
|
32721
|
+
};
|
|
32722
|
+
export type ConsolidationWorksheetErrors = {
|
|
32723
|
+
/**
|
|
32724
|
+
* Invalid request
|
|
32725
|
+
*/
|
|
32726
|
+
400: ErrorResponse;
|
|
32727
|
+
/**
|
|
32728
|
+
* Authentication required
|
|
32729
|
+
*/
|
|
32730
|
+
401: ErrorResponse;
|
|
32731
|
+
/**
|
|
32732
|
+
* Access denied
|
|
32733
|
+
*/
|
|
32734
|
+
403: ErrorResponse;
|
|
32735
|
+
/**
|
|
32736
|
+
* Resource not found
|
|
32737
|
+
*/
|
|
32738
|
+
404: ErrorResponse;
|
|
32739
|
+
/**
|
|
32740
|
+
* Idempotency-Key conflict — key reused with different body
|
|
32741
|
+
*/
|
|
32742
|
+
409: ErrorResponse;
|
|
32743
|
+
/**
|
|
32744
|
+
* Validation error
|
|
32745
|
+
*/
|
|
32746
|
+
422: ErrorResponse;
|
|
32747
|
+
/**
|
|
32748
|
+
* Rate limit exceeded
|
|
32749
|
+
*/
|
|
32750
|
+
429: ErrorResponse;
|
|
32751
|
+
/**
|
|
32752
|
+
* Internal server error
|
|
32753
|
+
*/
|
|
32754
|
+
500: ErrorResponse;
|
|
32755
|
+
};
|
|
32756
|
+
export type ConsolidationWorksheetError = ConsolidationWorksheetErrors[keyof ConsolidationWorksheetErrors];
|
|
32757
|
+
export type ConsolidationWorksheetResponses = {
|
|
32758
|
+
/**
|
|
32759
|
+
* Successful Response
|
|
32760
|
+
*/
|
|
32761
|
+
200: OperationEnvelopeConsolidationWorksheetResponse;
|
|
32762
|
+
};
|
|
32763
|
+
export type ConsolidationWorksheetResponse2 = ConsolidationWorksheetResponses[keyof ConsolidationWorksheetResponses];
|
|
32366
32764
|
export type CreatePortfolioBlockData = {
|
|
32367
32765
|
body: CreatePortfolioBlockRequest;
|
|
32368
32766
|
headers?: {
|