@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/types.gen.ts
CHANGED
|
@@ -2597,6 +2597,114 @@ export type ConnectionResponse = {
|
|
|
2597
2597
|
};
|
|
2598
2598
|
};
|
|
2599
2599
|
|
|
2600
|
+
/**
|
|
2601
|
+
* ConsolidationWorksheetRequest
|
|
2602
|
+
*
|
|
2603
|
+
* Request for consolidation-worksheet (OLTP, entity graphs only).
|
|
2604
|
+
*/
|
|
2605
|
+
export type ConsolidationWorksheetRequest = {
|
|
2606
|
+
/**
|
|
2607
|
+
* Statement Type
|
|
2608
|
+
*
|
|
2609
|
+
* income_statement | balance_sheet | cash_flow_statement | equity_statement.
|
|
2610
|
+
*/
|
|
2611
|
+
statement_type: string;
|
|
2612
|
+
/**
|
|
2613
|
+
* Period Start
|
|
2614
|
+
*
|
|
2615
|
+
* Explicit window start. Overrides period_type/fiscal_year.
|
|
2616
|
+
*/
|
|
2617
|
+
period_start?: string | null;
|
|
2618
|
+
/**
|
|
2619
|
+
* Period End
|
|
2620
|
+
*
|
|
2621
|
+
* Explicit window end. Overrides period_type/fiscal_year.
|
|
2622
|
+
*/
|
|
2623
|
+
period_end?: string | null;
|
|
2624
|
+
/**
|
|
2625
|
+
* Period Type
|
|
2626
|
+
*
|
|
2627
|
+
* annual | quarterly | instant (ignored when dates supplied)
|
|
2628
|
+
*/
|
|
2629
|
+
period_type?: string | null;
|
|
2630
|
+
/**
|
|
2631
|
+
* Fiscal Year
|
|
2632
|
+
*
|
|
2633
|
+
* Fiscal year for annual window (anchored on FiscalCalendar)
|
|
2634
|
+
*/
|
|
2635
|
+
fiscal_year?: number | null;
|
|
2636
|
+
/**
|
|
2637
|
+
* Limit
|
|
2638
|
+
*
|
|
2639
|
+
* Max rows returned. Defaults to the ceiling: the whole statement.
|
|
2640
|
+
*/
|
|
2641
|
+
limit?: number;
|
|
2642
|
+
};
|
|
2643
|
+
|
|
2644
|
+
/**
|
|
2645
|
+
* ConsolidationWorksheetResponse
|
|
2646
|
+
*
|
|
2647
|
+
* The group's statement with the entity as the column.
|
|
2648
|
+
*/
|
|
2649
|
+
export type ConsolidationWorksheetResponse = {
|
|
2650
|
+
/**
|
|
2651
|
+
* Graph Id
|
|
2652
|
+
*
|
|
2653
|
+
* The graph read.
|
|
2654
|
+
*/
|
|
2655
|
+
graph_id: string;
|
|
2656
|
+
/**
|
|
2657
|
+
* Entity Id
|
|
2658
|
+
*
|
|
2659
|
+
* The group parent.
|
|
2660
|
+
*/
|
|
2661
|
+
entity_id: string;
|
|
2662
|
+
/**
|
|
2663
|
+
* Statement Type
|
|
2664
|
+
*
|
|
2665
|
+
* The statement rendered.
|
|
2666
|
+
*/
|
|
2667
|
+
statement_type: string;
|
|
2668
|
+
/**
|
|
2669
|
+
* The window every column reads. The cash flow also pivots the prior window of equal length as its delta basis; it is not rendered.
|
|
2670
|
+
*/
|
|
2671
|
+
period: PeriodSpec;
|
|
2672
|
+
/**
|
|
2673
|
+
* Columns
|
|
2674
|
+
*
|
|
2675
|
+
* 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.
|
|
2676
|
+
*/
|
|
2677
|
+
columns: Array<WorksheetColumn>;
|
|
2678
|
+
/**
|
|
2679
|
+
* Rows
|
|
2680
|
+
*
|
|
2681
|
+
* The union of every column's lines in the parent's Style order; a line zero in every column is left out.
|
|
2682
|
+
*/
|
|
2683
|
+
rows: Array<WorksheetRow>;
|
|
2684
|
+
/**
|
|
2685
|
+
* The guard-rail outcome for the consolidated column, the same checks live-financial-statement runs.
|
|
2686
|
+
*/
|
|
2687
|
+
validation?: ValidationCheckResponse | null;
|
|
2688
|
+
/**
|
|
2689
|
+
* Unmapped Entity Ids
|
|
2690
|
+
*
|
|
2691
|
+
* Entities with no CoA mapping yet, so with no column.
|
|
2692
|
+
*/
|
|
2693
|
+
unmapped_entity_ids?: Array<string>;
|
|
2694
|
+
/**
|
|
2695
|
+
* Unmapped Count
|
|
2696
|
+
*
|
|
2697
|
+
* Unmapped accounts across the summed columns.
|
|
2698
|
+
*/
|
|
2699
|
+
unmapped_count?: number;
|
|
2700
|
+
/**
|
|
2701
|
+
* Truncated
|
|
2702
|
+
*
|
|
2703
|
+
* Whether `limit` cut rows.
|
|
2704
|
+
*/
|
|
2705
|
+
truncated?: boolean;
|
|
2706
|
+
};
|
|
2707
|
+
|
|
2600
2708
|
/**
|
|
2601
2709
|
* ContentLimits
|
|
2602
2710
|
*
|
|
@@ -2947,6 +3055,24 @@ export type CreateEntityRequest = {
|
|
|
2947
3055
|
* 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.
|
|
2948
3056
|
*/
|
|
2949
3057
|
ownership_pct?: number | null;
|
|
3058
|
+
/**
|
|
3059
|
+
* Consolidation Method
|
|
3060
|
+
*
|
|
3061
|
+
* 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`.
|
|
3062
|
+
*/
|
|
3063
|
+
consolidation_method?: 'full' | 'equity' | 'cost' | 'none' | null;
|
|
3064
|
+
/**
|
|
3065
|
+
* Entity Role
|
|
3066
|
+
*
|
|
3067
|
+
* `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.
|
|
3068
|
+
*/
|
|
3069
|
+
entity_role?: 'operating' | 'consolidation' | null;
|
|
3070
|
+
/**
|
|
3071
|
+
* Joined On
|
|
3072
|
+
*
|
|
3073
|
+
* 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.
|
|
3074
|
+
*/
|
|
3075
|
+
joined_on?: string | null;
|
|
2950
3076
|
/**
|
|
2951
3077
|
* Ticker
|
|
2952
3078
|
*
|
|
@@ -8537,9 +8663,9 @@ export type InitializeChartOfAccountsRequest = {
|
|
|
8537
8663
|
/**
|
|
8538
8664
|
* Template
|
|
8539
8665
|
*
|
|
8540
|
-
* 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).
|
|
8666
|
+
* 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).
|
|
8541
8667
|
*/
|
|
8542
|
-
template: 'saas' | 'services' | 'product';
|
|
8668
|
+
template: 'saas' | 'services' | 'product' | 'consolidation';
|
|
8543
8669
|
/**
|
|
8544
8670
|
* Entity Type
|
|
8545
8671
|
*
|
|
@@ -8571,7 +8697,7 @@ export type InitializeChartOfAccountsResponse = {
|
|
|
8571
8697
|
/**
|
|
8572
8698
|
* Template
|
|
8573
8699
|
*/
|
|
8574
|
-
template: 'saas' | 'services' | 'product';
|
|
8700
|
+
template: 'saas' | 'services' | 'product' | 'consolidation';
|
|
8575
8701
|
/**
|
|
8576
8702
|
* Entity Type
|
|
8577
8703
|
*
|
|
@@ -8955,7 +9081,7 @@ export type JournalEntryLineItemInput = {
|
|
|
8955
9081
|
/**
|
|
8956
9082
|
* Flow Qname
|
|
8957
9083
|
*
|
|
8958
|
-
* 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.
|
|
9084
|
+
* 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.
|
|
8959
9085
|
*/
|
|
8960
9086
|
flow_qname?: string | null;
|
|
8961
9087
|
/**
|
|
@@ -9342,6 +9468,30 @@ export type LedgerEntityResponse = {
|
|
|
9342
9468
|
* The parent's share of this entity, as a percent (100 = wholly owned). Null on the group parent, and where it was never recorded.
|
|
9343
9469
|
*/
|
|
9344
9470
|
ownership_pct?: number | null;
|
|
9471
|
+
/**
|
|
9472
|
+
* Consolidation Method
|
|
9473
|
+
*
|
|
9474
|
+
* 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.
|
|
9475
|
+
*/
|
|
9476
|
+
consolidation_method?: string;
|
|
9477
|
+
/**
|
|
9478
|
+
* Entity Role
|
|
9479
|
+
*
|
|
9480
|
+
* `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`.
|
|
9481
|
+
*/
|
|
9482
|
+
entity_role?: string;
|
|
9483
|
+
/**
|
|
9484
|
+
* Joined On
|
|
9485
|
+
*
|
|
9486
|
+
* 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.
|
|
9487
|
+
*/
|
|
9488
|
+
joined_on?: string | null;
|
|
9489
|
+
/**
|
|
9490
|
+
* Left On
|
|
9491
|
+
*
|
|
9492
|
+
* 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.
|
|
9493
|
+
*/
|
|
9494
|
+
left_on?: string | null;
|
|
9345
9495
|
/**
|
|
9346
9496
|
* Source
|
|
9347
9497
|
*
|
|
@@ -10008,10 +10158,16 @@ export type LiveFinancialStatementRequest = {
|
|
|
10008
10158
|
* Fiscal year for annual window (anchored on FiscalCalendar)
|
|
10009
10159
|
*/
|
|
10010
10160
|
fiscal_year?: number | null;
|
|
10161
|
+
/**
|
|
10162
|
+
* Scope
|
|
10163
|
+
*
|
|
10164
|
+
* `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`.
|
|
10165
|
+
*/
|
|
10166
|
+
scope?: 'entity' | 'combined' | 'consolidated' | null;
|
|
10011
10167
|
/**
|
|
10012
10168
|
* Consolidated
|
|
10013
10169
|
*
|
|
10014
|
-
*
|
|
10170
|
+
* The older spelling of `scope: consolidated`, kept for callers that pass it; `scope` wins when both are given.
|
|
10015
10171
|
*/
|
|
10016
10172
|
consolidated?: boolean;
|
|
10017
10173
|
/**
|
|
@@ -10038,16 +10194,22 @@ export type LiveFinancialStatementResponse = {
|
|
|
10038
10194
|
* The entity whose books were rendered.
|
|
10039
10195
|
*/
|
|
10040
10196
|
entity_id?: string | null;
|
|
10197
|
+
/**
|
|
10198
|
+
* Scope
|
|
10199
|
+
*
|
|
10200
|
+
* What was rendered: `entity`, `combined` (the members summed, nothing eliminated) or `consolidated` (the members plus the consolidation entity's adjustments).
|
|
10201
|
+
*/
|
|
10202
|
+
scope?: string;
|
|
10041
10203
|
/**
|
|
10042
10204
|
* Consolidated
|
|
10043
10205
|
*
|
|
10044
|
-
* Whether the group's entities were summed into this
|
|
10206
|
+
* Whether the group's entities were summed into this — true for the `combined` and `consolidated` scopes.
|
|
10045
10207
|
*/
|
|
10046
10208
|
consolidated?: boolean;
|
|
10047
10209
|
/**
|
|
10048
10210
|
* Combined Entity Ids
|
|
10049
10211
|
*
|
|
10050
|
-
* The entities summed
|
|
10212
|
+
* The entities summed, parent first; on `consolidated` the consolidation entity comes last.
|
|
10051
10213
|
*/
|
|
10052
10214
|
combined_entity_ids?: Array<string>;
|
|
10053
10215
|
/**
|
|
@@ -10112,6 +10274,12 @@ export type LiveStatementFactRow = {
|
|
|
10112
10274
|
* Is Subtotal
|
|
10113
10275
|
*/
|
|
10114
10276
|
is_subtotal?: boolean;
|
|
10277
|
+
/**
|
|
10278
|
+
* Period Role
|
|
10279
|
+
*
|
|
10280
|
+
* On the equity roll-forward, `start` for the beginning-balance row and `end` for the ending-balance row. Null elsewhere.
|
|
10281
|
+
*/
|
|
10282
|
+
period_role?: string | null;
|
|
10115
10283
|
};
|
|
10116
10284
|
|
|
10117
10285
|
/**
|
|
@@ -11515,6 +11683,52 @@ export type OperationEnvelopeComputeMetricsResponse = {
|
|
|
11515
11683
|
idempotentReplay?: boolean;
|
|
11516
11684
|
};
|
|
11517
11685
|
|
|
11686
|
+
/**
|
|
11687
|
+
* OperationEnvelope[ConsolidationWorksheetResponse]
|
|
11688
|
+
*/
|
|
11689
|
+
export type OperationEnvelopeConsolidationWorksheetResponse = {
|
|
11690
|
+
/**
|
|
11691
|
+
* Operation
|
|
11692
|
+
*
|
|
11693
|
+
* Kebab-case operation name
|
|
11694
|
+
*/
|
|
11695
|
+
operation: string;
|
|
11696
|
+
/**
|
|
11697
|
+
* Operationid
|
|
11698
|
+
*
|
|
11699
|
+
* op_-prefixed ULID for audit and SSE correlation
|
|
11700
|
+
*/
|
|
11701
|
+
operationId: string;
|
|
11702
|
+
/**
|
|
11703
|
+
* Status
|
|
11704
|
+
*
|
|
11705
|
+
* Operation lifecycle state
|
|
11706
|
+
*/
|
|
11707
|
+
status: 'completed' | 'pending' | 'failed';
|
|
11708
|
+
/**
|
|
11709
|
+
* Command-specific result payload
|
|
11710
|
+
*/
|
|
11711
|
+
result?: ConsolidationWorksheetResponse | null;
|
|
11712
|
+
/**
|
|
11713
|
+
* At
|
|
11714
|
+
*
|
|
11715
|
+
* ISO-8601 UTC timestamp
|
|
11716
|
+
*/
|
|
11717
|
+
at: string;
|
|
11718
|
+
/**
|
|
11719
|
+
* Createdby
|
|
11720
|
+
*
|
|
11721
|
+
* User ID that initiated the operation
|
|
11722
|
+
*/
|
|
11723
|
+
createdBy?: string | null;
|
|
11724
|
+
/**
|
|
11725
|
+
* Idempotentreplay
|
|
11726
|
+
*
|
|
11727
|
+
* True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
|
|
11728
|
+
*/
|
|
11729
|
+
idempotentReplay?: boolean;
|
|
11730
|
+
};
|
|
11731
|
+
|
|
11518
11732
|
/**
|
|
11519
11733
|
* OperationEnvelope[DeleteInformationBlockResponse]
|
|
11520
11734
|
*/
|
|
@@ -19727,6 +19941,12 @@ export type TaxonomyBlockStructureRequest = {
|
|
|
19727
19941
|
* `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.
|
|
19728
19942
|
*/
|
|
19729
19943
|
target_framework?: string | null;
|
|
19944
|
+
/**
|
|
19945
|
+
* Extends Network
|
|
19946
|
+
*
|
|
19947
|
+
* `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).
|
|
19948
|
+
*/
|
|
19949
|
+
extends_network?: string | null;
|
|
19730
19950
|
/**
|
|
19731
19951
|
* Metadata
|
|
19732
19952
|
*/
|
|
@@ -20285,9 +20505,33 @@ export type UpdateEntityRequest = {
|
|
|
20285
20505
|
/**
|
|
20286
20506
|
* Ownership Pct
|
|
20287
20507
|
*
|
|
20288
|
-
* The parent's share of this entity, as a percent. Refused on the group parent, which has no owner in the graph.
|
|
20508
|
+
* 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.
|
|
20289
20509
|
*/
|
|
20290
20510
|
ownership_pct?: number | null;
|
|
20511
|
+
/**
|
|
20512
|
+
* Consolidation Method
|
|
20513
|
+
*
|
|
20514
|
+
* 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.
|
|
20515
|
+
*/
|
|
20516
|
+
consolidation_method?: 'full' | 'equity' | 'cost' | 'none' | null;
|
|
20517
|
+
/**
|
|
20518
|
+
* Entity Role
|
|
20519
|
+
*
|
|
20520
|
+
* `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`.
|
|
20521
|
+
*/
|
|
20522
|
+
entity_role?: 'operating' | 'consolidation' | null;
|
|
20523
|
+
/**
|
|
20524
|
+
* Joined On
|
|
20525
|
+
*
|
|
20526
|
+
* 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.
|
|
20527
|
+
*/
|
|
20528
|
+
joined_on?: string | null;
|
|
20529
|
+
/**
|
|
20530
|
+
* Left On
|
|
20531
|
+
*
|
|
20532
|
+
* 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.
|
|
20533
|
+
*/
|
|
20534
|
+
left_on?: string | null;
|
|
20291
20535
|
};
|
|
20292
20536
|
|
|
20293
20537
|
/**
|
|
@@ -21496,6 +21740,106 @@ export type ViewResponse = {
|
|
|
21496
21740
|
} | null;
|
|
21497
21741
|
};
|
|
21498
21742
|
|
|
21743
|
+
/**
|
|
21744
|
+
* WorksheetColumn
|
|
21745
|
+
*
|
|
21746
|
+
* One column of the consolidation worksheet.
|
|
21747
|
+
*/
|
|
21748
|
+
export type WorksheetColumn = {
|
|
21749
|
+
/**
|
|
21750
|
+
* Key
|
|
21751
|
+
*
|
|
21752
|
+
* The entity id for an entity's column; `combined` and `consolidated` for the two totals.
|
|
21753
|
+
*/
|
|
21754
|
+
key: string;
|
|
21755
|
+
/**
|
|
21756
|
+
* Label
|
|
21757
|
+
*
|
|
21758
|
+
* The entity's name, or the total's.
|
|
21759
|
+
*/
|
|
21760
|
+
label: string;
|
|
21761
|
+
/**
|
|
21762
|
+
* Kind
|
|
21763
|
+
*
|
|
21764
|
+
* `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.
|
|
21765
|
+
*/
|
|
21766
|
+
kind: 'member' | 'combined' | 'adjustments' | 'consolidated' | 'not_summed';
|
|
21767
|
+
/**
|
|
21768
|
+
* Entity Id
|
|
21769
|
+
*
|
|
21770
|
+
* The entity the column reads; null on a total.
|
|
21771
|
+
*/
|
|
21772
|
+
entity_id?: string | null;
|
|
21773
|
+
/**
|
|
21774
|
+
* Consolidation Method
|
|
21775
|
+
*
|
|
21776
|
+
* The entity's `consolidation_method`; null on a total.
|
|
21777
|
+
*/
|
|
21778
|
+
consolidation_method?: string | null;
|
|
21779
|
+
/**
|
|
21780
|
+
* Ownership Pct
|
|
21781
|
+
*
|
|
21782
|
+
* The parent's share of the entity, where it has one.
|
|
21783
|
+
*/
|
|
21784
|
+
ownership_pct?: number | null;
|
|
21785
|
+
/**
|
|
21786
|
+
* In Sum
|
|
21787
|
+
*
|
|
21788
|
+
* Whether the column is part of the consolidated total.
|
|
21789
|
+
*/
|
|
21790
|
+
in_sum: boolean;
|
|
21791
|
+
};
|
|
21792
|
+
|
|
21793
|
+
/**
|
|
21794
|
+
* WorksheetRow
|
|
21795
|
+
*
|
|
21796
|
+
* One line of the consolidation worksheet, a value per column.
|
|
21797
|
+
*/
|
|
21798
|
+
export type WorksheetRow = {
|
|
21799
|
+
/**
|
|
21800
|
+
* Qname
|
|
21801
|
+
*
|
|
21802
|
+
* The rs-gaap concept of the line.
|
|
21803
|
+
*/
|
|
21804
|
+
qname: string;
|
|
21805
|
+
/**
|
|
21806
|
+
* Name
|
|
21807
|
+
*
|
|
21808
|
+
* The line's label.
|
|
21809
|
+
*/
|
|
21810
|
+
name: string;
|
|
21811
|
+
/**
|
|
21812
|
+
* Trait
|
|
21813
|
+
*
|
|
21814
|
+
* The concept's classification.
|
|
21815
|
+
*/
|
|
21816
|
+
trait?: string | null;
|
|
21817
|
+
/**
|
|
21818
|
+
* Values
|
|
21819
|
+
*
|
|
21820
|
+
* One value per column, aligned with `columns`.
|
|
21821
|
+
*/
|
|
21822
|
+
values: Array<number | null>;
|
|
21823
|
+
/**
|
|
21824
|
+
* Depth
|
|
21825
|
+
*
|
|
21826
|
+
* Indentation in the statement.
|
|
21827
|
+
*/
|
|
21828
|
+
depth?: number;
|
|
21829
|
+
/**
|
|
21830
|
+
* Is Subtotal
|
|
21831
|
+
*
|
|
21832
|
+
* Whether the line is a total.
|
|
21833
|
+
*/
|
|
21834
|
+
is_subtotal?: boolean;
|
|
21835
|
+
/**
|
|
21836
|
+
* Period Role
|
|
21837
|
+
*
|
|
21838
|
+
* On the equity roll-forward, `start` for the beginning-balance row and `end` for the ending-balance row. Null elsewhere.
|
|
21839
|
+
*/
|
|
21840
|
+
period_role?: string | null;
|
|
21841
|
+
};
|
|
21842
|
+
|
|
21499
21843
|
/**
|
|
21500
21844
|
* _CreateForecastArm
|
|
21501
21845
|
*
|
|
@@ -33931,6 +34275,70 @@ export type LiveFinancialStatementResponses = {
|
|
|
33931
34275
|
|
|
33932
34276
|
export type LiveFinancialStatementResponse2 = LiveFinancialStatementResponses[keyof LiveFinancialStatementResponses];
|
|
33933
34277
|
|
|
34278
|
+
export type ConsolidationWorksheetData = {
|
|
34279
|
+
body: ConsolidationWorksheetRequest;
|
|
34280
|
+
headers?: {
|
|
34281
|
+
/**
|
|
34282
|
+
* Idempotency-Key
|
|
34283
|
+
*/
|
|
34284
|
+
'Idempotency-Key'?: string | null;
|
|
34285
|
+
};
|
|
34286
|
+
path: {
|
|
34287
|
+
/**
|
|
34288
|
+
* Graph Id
|
|
34289
|
+
*/
|
|
34290
|
+
graph_id: string;
|
|
34291
|
+
};
|
|
34292
|
+
query?: never;
|
|
34293
|
+
url: '/extensions/roboledger/{graph_id}/operations/consolidation-worksheet';
|
|
34294
|
+
};
|
|
34295
|
+
|
|
34296
|
+
export type ConsolidationWorksheetErrors = {
|
|
34297
|
+
/**
|
|
34298
|
+
* Invalid request
|
|
34299
|
+
*/
|
|
34300
|
+
400: ErrorResponse;
|
|
34301
|
+
/**
|
|
34302
|
+
* Authentication required
|
|
34303
|
+
*/
|
|
34304
|
+
401: ErrorResponse;
|
|
34305
|
+
/**
|
|
34306
|
+
* Access denied
|
|
34307
|
+
*/
|
|
34308
|
+
403: ErrorResponse;
|
|
34309
|
+
/**
|
|
34310
|
+
* Resource not found
|
|
34311
|
+
*/
|
|
34312
|
+
404: ErrorResponse;
|
|
34313
|
+
/**
|
|
34314
|
+
* Idempotency-Key conflict — key reused with different body
|
|
34315
|
+
*/
|
|
34316
|
+
409: ErrorResponse;
|
|
34317
|
+
/**
|
|
34318
|
+
* Validation error
|
|
34319
|
+
*/
|
|
34320
|
+
422: ErrorResponse;
|
|
34321
|
+
/**
|
|
34322
|
+
* Rate limit exceeded
|
|
34323
|
+
*/
|
|
34324
|
+
429: ErrorResponse;
|
|
34325
|
+
/**
|
|
34326
|
+
* Internal server error
|
|
34327
|
+
*/
|
|
34328
|
+
500: ErrorResponse;
|
|
34329
|
+
};
|
|
34330
|
+
|
|
34331
|
+
export type ConsolidationWorksheetError = ConsolidationWorksheetErrors[keyof ConsolidationWorksheetErrors];
|
|
34332
|
+
|
|
34333
|
+
export type ConsolidationWorksheetResponses = {
|
|
34334
|
+
/**
|
|
34335
|
+
* Successful Response
|
|
34336
|
+
*/
|
|
34337
|
+
200: OperationEnvelopeConsolidationWorksheetResponse;
|
|
34338
|
+
};
|
|
34339
|
+
|
|
34340
|
+
export type ConsolidationWorksheetResponse2 = ConsolidationWorksheetResponses[keyof ConsolidationWorksheetResponses];
|
|
34341
|
+
|
|
33934
34342
|
export type CreatePortfolioBlockData = {
|
|
33935
34343
|
body: CreatePortfolioBlockRequest;
|
|
33936
34344
|
headers?: {
|