@robosystems/client 2.27.0 → 2.29.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 +51 -4
- package/artifacts/LedgerClient.js +47 -2
- package/artifacts/LedgerClient.ts +129 -2
- package/artifacts/graphql/generated/graphql.d.ts +144 -0
- package/artifacts/graphql/generated/graphql.js +445 -2
- package/artifacts/graphql/generated/graphql.ts +589 -0
- package/artifacts/graphql/queries/ledger/allocationShare.d.ts +10 -0
- package/artifacts/graphql/queries/ledger/allocationShare.js +51 -0
- package/artifacts/graphql/queries/ledger/allocationShare.ts +51 -0
- package/artifacts/graphql/queries/ledger/eventHandlers.d.ts +11 -0
- package/artifacts/graphql/queries/ledger/eventHandlers.js +73 -0
- package/artifacts/graphql/queries/ledger/eventHandlers.ts +73 -0
- package/index.ts +2 -2
- package/package.json +1 -1
- package/sdk/index.d.ts +2 -2
- package/sdk/index.js +3 -2
- package/sdk/index.ts +2 -2
- package/sdk/sdk.gen.d.ts +11 -3
- package/sdk/sdk.gen.js +21 -4
- package/sdk/sdk.gen.ts +20 -3
- package/sdk/types.gen.d.ts +296 -308
- package/sdk/types.gen.ts +305 -317
- package/sdk.gen.d.ts +11 -3
- package/sdk.gen.js +21 -4
- package/sdk.gen.ts +20 -3
- package/types.gen.d.ts +296 -308
- package/types.gen.ts +305 -317
package/types.gen.ts
CHANGED
|
@@ -268,6 +268,100 @@ export type AccountInfo = {
|
|
|
268
268
|
provider_account_id: string;
|
|
269
269
|
};
|
|
270
270
|
|
|
271
|
+
/**
|
|
272
|
+
* AcquisitionAllocation
|
|
273
|
+
*
|
|
274
|
+
* Part of an acquisition's excess assigned to an identifiable asset or
|
|
275
|
+
* liability at fair value instead of goodwill: a step-up.
|
|
276
|
+
*/
|
|
277
|
+
export type AcquisitionAllocation = {
|
|
278
|
+
/**
|
|
279
|
+
* Concept
|
|
280
|
+
*
|
|
281
|
+
* The rs-gaap concept stepped up, e.g. `rs-gaap:PropertyPlantAndEquipmentNet`; the consolidation entity needs an account mapped to it.
|
|
282
|
+
*/
|
|
283
|
+
concept: string;
|
|
284
|
+
/**
|
|
285
|
+
* Amount
|
|
286
|
+
*
|
|
287
|
+
* Cents, debit-positive: fair value less book value at acquisition. Positive raises an asset; negative raises a liability.
|
|
288
|
+
*/
|
|
289
|
+
amount: number;
|
|
290
|
+
};
|
|
291
|
+
|
|
292
|
+
/**
|
|
293
|
+
* AcquisitionResponse
|
|
294
|
+
*
|
|
295
|
+
* A member's acquisition as recorded: the draft in the consolidation
|
|
296
|
+
* entity its close posts.
|
|
297
|
+
*/
|
|
298
|
+
export type AcquisitionResponse = {
|
|
299
|
+
/**
|
|
300
|
+
* Entity Id
|
|
301
|
+
*
|
|
302
|
+
* The member.
|
|
303
|
+
*/
|
|
304
|
+
entity_id: string;
|
|
305
|
+
/**
|
|
306
|
+
* Entity Name
|
|
307
|
+
*
|
|
308
|
+
* The member's name.
|
|
309
|
+
*/
|
|
310
|
+
entity_name: string;
|
|
311
|
+
/**
|
|
312
|
+
* Joined On
|
|
313
|
+
*
|
|
314
|
+
* When it joined the group.
|
|
315
|
+
*/
|
|
316
|
+
joined_on: string;
|
|
317
|
+
/**
|
|
318
|
+
* Equity At Acquisition
|
|
319
|
+
*
|
|
320
|
+
* Cents: the member's equity in its opening balance.
|
|
321
|
+
*/
|
|
322
|
+
equity_at_acquisition: number;
|
|
323
|
+
/**
|
|
324
|
+
* Parent Share
|
|
325
|
+
*
|
|
326
|
+
* Cents: the parent's share of that equity.
|
|
327
|
+
*/
|
|
328
|
+
parent_share: number;
|
|
329
|
+
/**
|
|
330
|
+
* Consideration
|
|
331
|
+
*
|
|
332
|
+
* Cents paid to the sellers.
|
|
333
|
+
*/
|
|
334
|
+
consideration: number;
|
|
335
|
+
/**
|
|
336
|
+
* Excess
|
|
337
|
+
*
|
|
338
|
+
* Cents: consideration less the parent's share of the equity.
|
|
339
|
+
*/
|
|
340
|
+
excess: number;
|
|
341
|
+
/**
|
|
342
|
+
* Goodwill
|
|
343
|
+
*
|
|
344
|
+
* Cents of goodwill; negative for a bargain purchase gain.
|
|
345
|
+
*/
|
|
346
|
+
goodwill: number;
|
|
347
|
+
/**
|
|
348
|
+
* Noncontrolling Interest
|
|
349
|
+
*
|
|
350
|
+
* Cents added to the outside owners' interest beyond their share of the member's book equity.
|
|
351
|
+
*/
|
|
352
|
+
noncontrolling_interest?: number;
|
|
353
|
+
/**
|
|
354
|
+
* The acquisition entry, a draft the close posts.
|
|
355
|
+
*/
|
|
356
|
+
entry: JournalEntryResponse;
|
|
357
|
+
/**
|
|
358
|
+
* Replaced
|
|
359
|
+
*
|
|
360
|
+
* True when it replaced an earlier draft of the acquisition.
|
|
361
|
+
*/
|
|
362
|
+
replaced?: boolean;
|
|
363
|
+
};
|
|
364
|
+
|
|
271
365
|
/**
|
|
272
366
|
* AddGraphMemberRequest
|
|
273
367
|
*
|
|
@@ -501,8 +595,6 @@ export type ArtifactResponse = {
|
|
|
501
595
|
} & StatementMechanics) | ({
|
|
502
596
|
kind: 'metric';
|
|
503
597
|
} & MetricMechanics) | ({
|
|
504
|
-
kind: 'rollforward';
|
|
505
|
-
} & RollforwardMechanics) | ({
|
|
506
598
|
kind: 'forecast';
|
|
507
599
|
} & ForecastMechanics) | ({
|
|
508
600
|
kind: 'reconciliation';
|
|
@@ -740,41 +832,6 @@ export type AssociationResponse = {
|
|
|
740
832
|
reclassified_periods?: Array<string>;
|
|
741
833
|
};
|
|
742
834
|
|
|
743
|
-
/**
|
|
744
|
-
* AttributionFilter
|
|
745
|
-
*
|
|
746
|
-
* One flow-concept attribution rule on a rollforward IB.
|
|
747
|
-
*
|
|
748
|
-
* Pairs a target concept (the flow leaf the matched amount counts
|
|
749
|
-
* toward) with a predicate (which LineItems match). The rollforward's
|
|
750
|
-
* `attribution_filters: list[AttributionFilter]` declares every flow
|
|
751
|
-
* the BS source decomposes into; the renderer evaluates them all per
|
|
752
|
-
* period.
|
|
753
|
-
*
|
|
754
|
-
* `target_element_id` is resolved at create time from `target_qname`
|
|
755
|
-
* via the rs-gaap library + tenant taxonomy lookup. Authors only need
|
|
756
|
-
* to provide the qname; the element_id is filled in by the create
|
|
757
|
-
* handler and the resolved value is what the envelope round-trips.
|
|
758
|
-
*/
|
|
759
|
-
export type AttributionFilter = {
|
|
760
|
-
/**
|
|
761
|
-
* Target Qname
|
|
762
|
-
*
|
|
763
|
-
* QName of the flow concept this filter produces facts for — e.g. `rs-gaap:ProceedsFromIssuanceOfCommonStock`. Resolved to `target_element_id` at create time.
|
|
764
|
-
*/
|
|
765
|
-
target_qname: string;
|
|
766
|
-
/**
|
|
767
|
-
* Target Element Id
|
|
768
|
-
*
|
|
769
|
-
* Resolved element id for `target_qname`. Null at create time; populated by the handler before persistence. Round-tripped in the envelope.
|
|
770
|
-
*/
|
|
771
|
-
target_element_id?: string | null;
|
|
772
|
-
/**
|
|
773
|
-
* Predicate that determines which LineItems match this filter.
|
|
774
|
-
*/
|
|
775
|
-
predicate: LineItemMetadataPredicate;
|
|
776
|
-
};
|
|
777
|
-
|
|
778
835
|
/**
|
|
779
836
|
* AuthProvidersResponse
|
|
780
837
|
*
|
|
@@ -2756,6 +2813,12 @@ export type ConsolidationResidual = {
|
|
|
2756
2813
|
* What the two figures are.
|
|
2757
2814
|
*/
|
|
2758
2815
|
explanation: string;
|
|
2816
|
+
/**
|
|
2817
|
+
* Cause
|
|
2818
|
+
*
|
|
2819
|
+
* `pre_acquisition` when the member joined the group mid-life and its acquisition is not recorded: the parent paid its sellers, not the member, so `record-acquisition` explains the difference — the consideration, with the excess over the parent's share of the member's equity at acquisition as goodwill or fair-value step-ups.
|
|
2820
|
+
*/
|
|
2821
|
+
cause?: 'unexplained' | 'pre_acquisition';
|
|
2759
2822
|
};
|
|
2760
2823
|
|
|
2761
2824
|
/**
|
|
@@ -3698,8 +3761,6 @@ export type CreateGraphRequest = {
|
|
|
3698
3761
|
export type CreateInformationBlockRequest = ({
|
|
3699
3762
|
block_type: 'schedule';
|
|
3700
3763
|
} & CreateScheduleArm) | ({
|
|
3701
|
-
block_type: 'rollforward';
|
|
3702
|
-
} & CreateRollforwardArm) | ({
|
|
3703
3764
|
block_type: 'forecast';
|
|
3704
3765
|
} & CreateForecastArm) | ({
|
|
3705
3766
|
block_type: 'balance_sheet' | 'cash_flow_statement' | 'comprehensive_income' | 'equity_statement' | 'income_statement' | 'metric' | 'reconciliation' | 'regulatory_disclosure';
|
|
@@ -3929,56 +3990,6 @@ export type CreateRepositorySubscriptionRequest = {
|
|
|
3929
3990
|
user_id?: string | null;
|
|
3930
3991
|
};
|
|
3931
3992
|
|
|
3932
|
-
/**
|
|
3933
|
-
* CreateRollforwardRequest
|
|
3934
|
-
*
|
|
3935
|
-
* Create a rollforward Information Block.
|
|
3936
|
-
*
|
|
3937
|
-
* Mirrors :class:`CreateScheduleRequest` in shape. The block decomposes
|
|
3938
|
-
* the period change in `bs_source_qname` across the declared
|
|
3939
|
-
* attribution filters. Residual (Δ BS - Σ filter matches) falls back to
|
|
3940
|
-
* the default change tag — or, if no default is declared, surfaces as
|
|
3941
|
-
* an unattributed fact tagged with a synthetic residual concept.
|
|
3942
|
-
*/
|
|
3943
|
-
export type CreateRollforwardRequest = {
|
|
3944
|
-
/**
|
|
3945
|
-
* Name
|
|
3946
|
-
*
|
|
3947
|
-
* Human-readable block name.
|
|
3948
|
-
*/
|
|
3949
|
-
name: string;
|
|
3950
|
-
/**
|
|
3951
|
-
* Bs Source Qname
|
|
3952
|
-
*
|
|
3953
|
-
* QName of the balance-sheet element whose period delta this block decomposes. Resolved to `bs_source_element_id` at create time.
|
|
3954
|
-
*/
|
|
3955
|
-
bs_source_qname: string;
|
|
3956
|
-
/**
|
|
3957
|
-
* Default Change Tag Qname
|
|
3958
|
-
*
|
|
3959
|
-
* QName of the fallback flow concept (Tier 1 default change tag). Residual amount — Δ BS minus the sum of filter-matched amounts — is attributed to this concept. When omitted, residual surfaces unattributed; the validation_mode setting governs whether that's a hard error.
|
|
3960
|
-
*/
|
|
3961
|
-
default_change_tag_qname?: string | null;
|
|
3962
|
-
/**
|
|
3963
|
-
* Attribution Filters
|
|
3964
|
-
*
|
|
3965
|
-
* Filter predicates routing LineItems to flow concepts.
|
|
3966
|
-
*/
|
|
3967
|
-
attribution_filters?: Array<AttributionFilter>;
|
|
3968
|
-
/**
|
|
3969
|
-
* Validation Mode
|
|
3970
|
-
*
|
|
3971
|
-
* How the renderer arbitrates when Σ filter matches != Δ BS. `strict` raises; `residual_as_default` emits the residual as a default-tag fact (the common case); `warn_only` logs and lets the imbalance pass.
|
|
3972
|
-
*/
|
|
3973
|
-
validation_mode?: 'strict' | 'residual_as_default' | 'warn_only';
|
|
3974
|
-
/**
|
|
3975
|
-
* Taxonomy Id
|
|
3976
|
-
*
|
|
3977
|
-
* Owning taxonomy id (auto-resolved from `bs_source_qname` when omitted).
|
|
3978
|
-
*/
|
|
3979
|
-
taxonomy_id?: string | null;
|
|
3980
|
-
};
|
|
3981
|
-
|
|
3982
3993
|
/**
|
|
3983
3994
|
* CreateScheduleRequest
|
|
3984
3995
|
*/
|
|
@@ -4844,8 +4855,6 @@ export type DeleteGraphOp = {
|
|
|
4844
4855
|
export type DeleteInformationBlockRequest = ({
|
|
4845
4856
|
block_type: 'schedule';
|
|
4846
4857
|
} & DeleteScheduleArm) | ({
|
|
4847
|
-
block_type: 'rollforward';
|
|
4848
|
-
} & DeleteRollforwardArm) | ({
|
|
4849
4858
|
block_type: 'forecast';
|
|
4850
4859
|
} & DeleteForecastArm) | ({
|
|
4851
4860
|
block_type: 'balance_sheet' | 'cash_flow_statement' | 'comprehensive_income' | 'equity_statement' | 'income_statement' | 'metric' | 'reconciliation' | 'regulatory_disclosure';
|
|
@@ -5017,24 +5026,6 @@ export type DeleteResult = {
|
|
|
5017
5026
|
deleted: boolean;
|
|
5018
5027
|
};
|
|
5019
5028
|
|
|
5020
|
-
/**
|
|
5021
|
-
* DeleteRollforwardRequest
|
|
5022
|
-
*
|
|
5023
|
-
* Delete a rollforward block.
|
|
5024
|
-
*
|
|
5025
|
-
* Cascades through any synthetic facts produced by this block's filter
|
|
5026
|
-
* evaluations. The underlying ledger LineItems are not touched — only
|
|
5027
|
-
* the rollforward IB's projection of them.
|
|
5028
|
-
*/
|
|
5029
|
-
export type DeleteRollforwardRequest = {
|
|
5030
|
-
/**
|
|
5031
|
-
* Structure Id
|
|
5032
|
-
*
|
|
5033
|
-
* Structure ID of the rollforward block.
|
|
5034
|
-
*/
|
|
5035
|
-
structure_id: string;
|
|
5036
|
-
};
|
|
5037
|
-
|
|
5038
5029
|
/**
|
|
5039
5030
|
* DeleteScheduleRequest
|
|
5040
5031
|
*
|
|
@@ -6502,90 +6493,138 @@ export type EventBlockEnvelope = {
|
|
|
6502
6493
|
|
|
6503
6494
|
/**
|
|
6504
6495
|
* EventHandlerResponse
|
|
6496
|
+
*
|
|
6497
|
+
* A rule that turns a matching event into GL rows.
|
|
6505
6498
|
*/
|
|
6506
6499
|
export type EventHandlerResponse = {
|
|
6507
6500
|
/**
|
|
6508
6501
|
* Id
|
|
6502
|
+
*
|
|
6503
|
+
* Handler id (`hdl_`-prefixed).
|
|
6509
6504
|
*/
|
|
6510
6505
|
id: string;
|
|
6511
6506
|
/**
|
|
6512
6507
|
* Name
|
|
6508
|
+
*
|
|
6509
|
+
* Human-readable handler name.
|
|
6513
6510
|
*/
|
|
6514
6511
|
name: string;
|
|
6515
6512
|
/**
|
|
6516
6513
|
* Description
|
|
6514
|
+
*
|
|
6515
|
+
* What the handler is for.
|
|
6517
6516
|
*/
|
|
6518
6517
|
description?: string | null;
|
|
6519
6518
|
/**
|
|
6520
6519
|
* Event Type
|
|
6520
|
+
*
|
|
6521
|
+
* The event type the handler matches.
|
|
6521
6522
|
*/
|
|
6522
6523
|
event_type: string;
|
|
6523
6524
|
/**
|
|
6524
6525
|
* Event Category
|
|
6526
|
+
*
|
|
6527
|
+
* Match on the event's category; null matches any.
|
|
6525
6528
|
*/
|
|
6526
6529
|
event_category?: string | null;
|
|
6527
6530
|
/**
|
|
6528
6531
|
* Match Source
|
|
6532
|
+
*
|
|
6533
|
+
* Match on the event's source system; null matches any.
|
|
6529
6534
|
*/
|
|
6530
6535
|
match_source?: string | null;
|
|
6531
6536
|
/**
|
|
6532
6537
|
* Match Agent Type
|
|
6538
|
+
*
|
|
6539
|
+
* Match on the counterparty's role; null matches any.
|
|
6533
6540
|
*/
|
|
6534
6541
|
match_agent_type?: string | null;
|
|
6535
6542
|
/**
|
|
6536
6543
|
* Match Resource Type
|
|
6544
|
+
*
|
|
6545
|
+
* Match on the resource type; null matches any.
|
|
6537
6546
|
*/
|
|
6538
6547
|
match_resource_type?: string | null;
|
|
6539
6548
|
/**
|
|
6540
6549
|
* Match Metadata Expression
|
|
6550
|
+
*
|
|
6551
|
+
* Equality matches against the event's metadata.
|
|
6541
6552
|
*/
|
|
6542
6553
|
match_metadata_expression?: {
|
|
6543
6554
|
[key: string]: unknown;
|
|
6544
6555
|
} | null;
|
|
6545
6556
|
/**
|
|
6546
6557
|
* Transaction Template
|
|
6558
|
+
*
|
|
6559
|
+
* The GL rows the handler books: its DSL template, as JSON.
|
|
6547
6560
|
*/
|
|
6548
6561
|
transaction_template: {
|
|
6549
6562
|
[key: string]: unknown;
|
|
6550
6563
|
};
|
|
6551
6564
|
/**
|
|
6552
6565
|
* Priority
|
|
6566
|
+
*
|
|
6567
|
+
* Among handlers that match, the highest priority wins.
|
|
6553
6568
|
*/
|
|
6554
6569
|
priority: number;
|
|
6555
6570
|
/**
|
|
6556
6571
|
* Is Active
|
|
6572
|
+
*
|
|
6573
|
+
* Whether the handler takes part in matching at all.
|
|
6557
6574
|
*/
|
|
6558
6575
|
is_active: boolean;
|
|
6559
6576
|
/**
|
|
6560
6577
|
* Origin
|
|
6578
|
+
*
|
|
6579
|
+
* `hub` for a platform-shipped handler, `tenant` otherwise.
|
|
6561
6580
|
*/
|
|
6562
6581
|
origin: string;
|
|
6563
6582
|
/**
|
|
6564
6583
|
* Suggested By
|
|
6584
|
+
*
|
|
6585
|
+
* `ai` when an AI client created the handler or last changed what it matches or books; null when a person did.
|
|
6565
6586
|
*/
|
|
6566
6587
|
suggested_by?: string | null;
|
|
6567
6588
|
/**
|
|
6568
6589
|
* Confidence
|
|
6590
|
+
*
|
|
6591
|
+
* The suggesting AI's confidence, when it gave one.
|
|
6569
6592
|
*/
|
|
6570
6593
|
confidence?: number | null;
|
|
6571
6594
|
/**
|
|
6572
6595
|
* Approved By
|
|
6596
|
+
*
|
|
6597
|
+
* The user who approved an AI-suggested handler.
|
|
6573
6598
|
*/
|
|
6574
6599
|
approved_by?: string | null;
|
|
6575
6600
|
/**
|
|
6576
6601
|
* Approved At
|
|
6602
|
+
*
|
|
6603
|
+
* When it was approved.
|
|
6577
6604
|
*/
|
|
6578
6605
|
approved_at?: string | null;
|
|
6606
|
+
/**
|
|
6607
|
+
* Awaiting Approval
|
|
6608
|
+
*
|
|
6609
|
+
* True for an AI-suggested handler no one has approved: it takes no part in matching until a person approves it.
|
|
6610
|
+
*/
|
|
6611
|
+
awaiting_approval?: boolean;
|
|
6579
6612
|
/**
|
|
6580
6613
|
* Created At
|
|
6614
|
+
*
|
|
6615
|
+
* When it was created.
|
|
6581
6616
|
*/
|
|
6582
6617
|
created_at?: string | null;
|
|
6583
6618
|
/**
|
|
6584
6619
|
* Updated At
|
|
6620
|
+
*
|
|
6621
|
+
* When it last changed.
|
|
6585
6622
|
*/
|
|
6586
6623
|
updated_at?: string | null;
|
|
6587
6624
|
/**
|
|
6588
6625
|
* Created By
|
|
6626
|
+
*
|
|
6627
|
+
* The user who created it.
|
|
6589
6628
|
*/
|
|
6590
6629
|
created_by?: string | null;
|
|
6591
6630
|
};
|
|
@@ -10188,44 +10227,6 @@ export type LineGrowthRequest = {
|
|
|
10188
10227
|
} | null;
|
|
10189
10228
|
};
|
|
10190
10229
|
|
|
10191
|
-
/**
|
|
10192
|
-
* LineItemMetadataPredicate
|
|
10193
|
-
*
|
|
10194
|
-
* Filter ledger LineItems by flow concept.
|
|
10195
|
-
*
|
|
10196
|
-
* The single predicate kind shipped to date. `values` are flow-concept
|
|
10197
|
-
* qnames — mini's `TransactionDescriptionCode` values, rs-gaap flow
|
|
10198
|
-
* concepts (what the enrichment classifier emits for QuickBooks data),
|
|
10199
|
-
* future XBRL GL `GenericFlowCategory` codes. The engine resolves them
|
|
10200
|
-
* to element_ids and matches the first-class `LineItem.flow_element_id`
|
|
10201
|
-
* FK; matched lines aggregate signed into the attributed fact for the
|
|
10202
|
-
* period.
|
|
10203
|
-
*
|
|
10204
|
-
* `field` is accepted but ignored: the flow tag lives in the typed
|
|
10205
|
-
* `flow_element_id` FK, not in JSONB metadata. It stays on the wire so
|
|
10206
|
-
* existing request bodies keep validating.
|
|
10207
|
-
*/
|
|
10208
|
-
export type LineItemMetadataPredicate = {
|
|
10209
|
-
/**
|
|
10210
|
-
* Kind
|
|
10211
|
-
*
|
|
10212
|
-
* Discriminator value selecting this predicate shape.
|
|
10213
|
-
*/
|
|
10214
|
-
kind?: 'line_item_metadata_field';
|
|
10215
|
-
/**
|
|
10216
|
-
* Field
|
|
10217
|
-
*
|
|
10218
|
-
* Accepted but ignored. The flow tag lives in the typed `flow_element_id` FK, not JSONB metadata. Retained for wire-compatibility.
|
|
10219
|
-
*/
|
|
10220
|
-
field?: string;
|
|
10221
|
-
/**
|
|
10222
|
-
* Values
|
|
10223
|
-
*
|
|
10224
|
-
* Flow-concept qnames that route to this filter's target concept. A LineItem matches when its `flow_element_id` is one of the elements named here AND the line falls within the rollforward's period.
|
|
10225
|
-
*/
|
|
10226
|
-
values: Array<string>;
|
|
10227
|
-
};
|
|
10228
|
-
|
|
10229
10230
|
/**
|
|
10230
10231
|
* LinkBankAccountRequest
|
|
10231
10232
|
*
|
|
@@ -11600,6 +11601,52 @@ export type OperationEnvelopeAcceptSuggestionsResponse = {
|
|
|
11600
11601
|
idempotentReplay?: boolean;
|
|
11601
11602
|
};
|
|
11602
11603
|
|
|
11604
|
+
/**
|
|
11605
|
+
* OperationEnvelope[AcquisitionResponse]
|
|
11606
|
+
*/
|
|
11607
|
+
export type OperationEnvelopeAcquisitionResponse = {
|
|
11608
|
+
/**
|
|
11609
|
+
* Operation
|
|
11610
|
+
*
|
|
11611
|
+
* Kebab-case operation name
|
|
11612
|
+
*/
|
|
11613
|
+
operation: string;
|
|
11614
|
+
/**
|
|
11615
|
+
* Operationid
|
|
11616
|
+
*
|
|
11617
|
+
* op_-prefixed ULID for audit and SSE correlation
|
|
11618
|
+
*/
|
|
11619
|
+
operationId: string;
|
|
11620
|
+
/**
|
|
11621
|
+
* Status
|
|
11622
|
+
*
|
|
11623
|
+
* Operation lifecycle state
|
|
11624
|
+
*/
|
|
11625
|
+
status: 'completed' | 'pending' | 'failed';
|
|
11626
|
+
/**
|
|
11627
|
+
* Command-specific result payload
|
|
11628
|
+
*/
|
|
11629
|
+
result?: AcquisitionResponse | null;
|
|
11630
|
+
/**
|
|
11631
|
+
* At
|
|
11632
|
+
*
|
|
11633
|
+
* ISO-8601 UTC timestamp
|
|
11634
|
+
*/
|
|
11635
|
+
at: string;
|
|
11636
|
+
/**
|
|
11637
|
+
* Createdby
|
|
11638
|
+
*
|
|
11639
|
+
* User ID that initiated the operation
|
|
11640
|
+
*/
|
|
11641
|
+
createdBy?: string | null;
|
|
11642
|
+
/**
|
|
11643
|
+
* Idempotentreplay
|
|
11644
|
+
*
|
|
11645
|
+
* True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
|
|
11646
|
+
*/
|
|
11647
|
+
idempotentReplay?: boolean;
|
|
11648
|
+
};
|
|
11649
|
+
|
|
11603
11650
|
/**
|
|
11604
11651
|
* OperationEnvelope[AllocationOverrideResponse]
|
|
11605
11652
|
*/
|
|
@@ -17312,6 +17359,53 @@ export type ReconcilingItemRegenerated = {
|
|
|
17312
17359
|
entry_ids?: Array<string>;
|
|
17313
17360
|
};
|
|
17314
17361
|
|
|
17362
|
+
/**
|
|
17363
|
+
* RecordAcquisitionRequest
|
|
17364
|
+
*
|
|
17365
|
+
* A member bought from its outside owners: what the parent paid them,
|
|
17366
|
+
* and how the excess over its share of the member's equity at acquisition is
|
|
17367
|
+
* allocated. The engine never invents a fair value; each comes from the
|
|
17368
|
+
* person, with the basis.
|
|
17369
|
+
*/
|
|
17370
|
+
export type RecordAcquisitionRequest = {
|
|
17371
|
+
/**
|
|
17372
|
+
* Entity Id
|
|
17373
|
+
*
|
|
17374
|
+
* The member acquired, consolidated in full, with `joined_on` set and its opening balance recorded at acquisition.
|
|
17375
|
+
*/
|
|
17376
|
+
entity_id: string;
|
|
17377
|
+
/**
|
|
17378
|
+
* Consideration
|
|
17379
|
+
*
|
|
17380
|
+
* Cents the parent paid the sellers for its interest. Its investment line names the seller, not the member, which is why it is given here.
|
|
17381
|
+
*/
|
|
17382
|
+
consideration: number;
|
|
17383
|
+
/**
|
|
17384
|
+
* Nci Fair Value
|
|
17385
|
+
*
|
|
17386
|
+
* Cents: the fair value of the outside owners' interest at acquisition, for goodwill on the whole business (ASC 805). Omitted, the outside owners carry their share of the identifiable net assets and goodwill is the parent's alone.
|
|
17387
|
+
*/
|
|
17388
|
+
nci_fair_value?: number | null;
|
|
17389
|
+
/**
|
|
17390
|
+
* Allocations
|
|
17391
|
+
*
|
|
17392
|
+
* Fair-value step-ups; what is left of the excess is goodwill.
|
|
17393
|
+
*/
|
|
17394
|
+
allocations?: Array<AcquisitionAllocation>;
|
|
17395
|
+
/**
|
|
17396
|
+
* Basis
|
|
17397
|
+
*
|
|
17398
|
+
* Where the consideration and fair values come from: the purchase agreement, a valuation.
|
|
17399
|
+
*/
|
|
17400
|
+
basis: string;
|
|
17401
|
+
/**
|
|
17402
|
+
* Confirm Bargain Purchase
|
|
17403
|
+
*
|
|
17404
|
+
* Required when the parent paid less than its share of the fair value of what it acquired. ASC 805 has the acquirer reassess before recognizing the gain; set it only after that review.
|
|
17405
|
+
*/
|
|
17406
|
+
confirm_bargain_purchase?: boolean;
|
|
17407
|
+
};
|
|
17408
|
+
|
|
17315
17409
|
/**
|
|
17316
17410
|
* RecordOpeningBalanceRequest
|
|
17317
17411
|
*
|
|
@@ -18212,66 +18306,6 @@ export type RevokeReportShareResponse = {
|
|
|
18212
18306
|
copy_deleted: boolean;
|
|
18213
18307
|
};
|
|
18214
18308
|
|
|
18215
|
-
/**
|
|
18216
|
-
* RollforwardMechanics
|
|
18217
|
-
*
|
|
18218
|
-
* Filter-based attribution mechanics for `block_type='rollforward'`.
|
|
18219
|
-
*
|
|
18220
|
-
* Filter-based attribution: each block decomposes one BS source
|
|
18221
|
-
* element's period delta into a list of flow concepts via declared
|
|
18222
|
-
* :class:`AttributionFilter` predicates. The renderer evaluates the
|
|
18223
|
-
* filters against ledger LineItems at envelope-build time, emits one
|
|
18224
|
-
* attributed fact per filter per period, and arbitrates any residual
|
|
18225
|
-
* against the default change tag fallback.
|
|
18226
|
-
*
|
|
18227
|
-
* Reads directly from the typed `structures.artifact_mechanics` JSONB
|
|
18228
|
-
* column. `attribution_filters` rides as nested JSON; the predicate
|
|
18229
|
-
* union widens as new predicate shapes are added — currently only
|
|
18230
|
-
* `line_item_metadata_field` is carried.
|
|
18231
|
-
*/
|
|
18232
|
-
export type RollforwardMechanics = {
|
|
18233
|
-
/**
|
|
18234
|
-
* Kind
|
|
18235
|
-
*/
|
|
18236
|
-
kind?: 'rollforward';
|
|
18237
|
-
/**
|
|
18238
|
-
* Bs Source Element Id
|
|
18239
|
-
*
|
|
18240
|
-
* Element id of the balance-sheet source whose period delta this block decomposes. Resolved from `bs_source_qname` at create time.
|
|
18241
|
-
*/
|
|
18242
|
-
bs_source_element_id: string;
|
|
18243
|
-
/**
|
|
18244
|
-
* Bs Source Qname
|
|
18245
|
-
*
|
|
18246
|
-
* QName of the BS source element (e.g. `mini:CashAndCashEquivalents`). Round-tripped for caller convenience; `bs_source_element_id` is authoritative.
|
|
18247
|
-
*/
|
|
18248
|
-
bs_source_qname: string;
|
|
18249
|
-
/**
|
|
18250
|
-
* Default Change Tag Element Id
|
|
18251
|
-
*
|
|
18252
|
-
* Element id of the default change tag — the fallback flow concept that receives any residual (Δ BS − Σ filter matches). Null when no default is declared; behavior on residual then follows `validation_mode`.
|
|
18253
|
-
*/
|
|
18254
|
-
default_change_tag_element_id?: string | null;
|
|
18255
|
-
/**
|
|
18256
|
-
* Default Change Tag Qname
|
|
18257
|
-
*
|
|
18258
|
-
* QName of the default change tag (e.g. `rs-gaap:IncreaseDecreaseInCashAndCashEquivalents`). Round-tripped for caller convenience and operator-readable envelopes; `default_change_tag_element_id` is authoritative. Null iff `default_change_tag_element_id` is null.
|
|
18259
|
-
*/
|
|
18260
|
-
default_change_tag_qname?: string | null;
|
|
18261
|
-
/**
|
|
18262
|
-
* Attribution Filters
|
|
18263
|
-
*
|
|
18264
|
-
* Filter predicates routing LineItems to flow concepts. The renderer evaluates each filter against the period's LineItems, aggregates signed amounts, and emits one fact per filter per period.
|
|
18265
|
-
*/
|
|
18266
|
-
attribution_filters?: Array<AttributionFilter>;
|
|
18267
|
-
/**
|
|
18268
|
-
* Validation Mode
|
|
18269
|
-
*
|
|
18270
|
-
* Renderer arbitration policy when Σ filter matches != Δ BS. `strict` raises; `residual_as_default` emits the residual as a default-tag fact (the common case); `warn_only` logs and lets the imbalance pass.
|
|
18271
|
-
*/
|
|
18272
|
-
validation_mode?: 'strict' | 'residual_as_default' | 'warn_only';
|
|
18273
|
-
};
|
|
18274
|
-
|
|
18275
18309
|
/**
|
|
18276
18310
|
* RuleLite
|
|
18277
18311
|
*
|
|
@@ -21779,8 +21813,6 @@ export type UpdateGraphMetadataOp = {
|
|
|
21779
21813
|
export type UpdateInformationBlockRequest = ({
|
|
21780
21814
|
block_type: 'schedule';
|
|
21781
21815
|
} & UpdateScheduleArm) | ({
|
|
21782
|
-
block_type: 'rollforward';
|
|
21783
|
-
} & UpdateRollforwardArm) | ({
|
|
21784
21816
|
block_type: 'forecast';
|
|
21785
21817
|
} & UpdateForecastArm) | ({
|
|
21786
21818
|
block_type: 'balance_sheet' | 'cash_flow_statement' | 'comprehensive_income' | 'equity_statement' | 'income_statement' | 'metric' | 'reconciliation' | 'regulatory_disclosure';
|
|
@@ -21994,50 +22026,6 @@ export type UpdatePublishListOperation = {
|
|
|
21994
22026
|
list_id: string;
|
|
21995
22027
|
};
|
|
21996
22028
|
|
|
21997
|
-
/**
|
|
21998
|
-
* UpdateRollforwardRequest
|
|
21999
|
-
*
|
|
22000
|
-
* Update mutable fields on a rollforward block.
|
|
22001
|
-
*
|
|
22002
|
-
* Editable: name, default_change_tag_qname, attribution_filters,
|
|
22003
|
-
* validation_mode. The BS source is fixed at creation — changing it would
|
|
22004
|
-
* invalidate every period already rendered — so switching BS source means
|
|
22005
|
-
* delete and re-create.
|
|
22006
|
-
*
|
|
22007
|
-
* **Partial-update semantics**: an omitted (`None`) field means "leave
|
|
22008
|
-
* unchanged". There is no wire-level way to *clear* the default change tag or
|
|
22009
|
-
* empty the attribution_filters list; delete and re-create the block instead.
|
|
22010
|
-
* The asymmetry is deliberate — a clear-sentinel costs wire-shape complexity
|
|
22011
|
-
* for a case that rarely arises, since default tags get swapped rather than
|
|
22012
|
-
* removed.
|
|
22013
|
-
*/
|
|
22014
|
-
export type UpdateRollforwardRequest = {
|
|
22015
|
-
/**
|
|
22016
|
-
* Structure Id
|
|
22017
|
-
*
|
|
22018
|
-
* Structure ID of the rollforward block.
|
|
22019
|
-
*/
|
|
22020
|
-
structure_id: string;
|
|
22021
|
-
/**
|
|
22022
|
-
* Name
|
|
22023
|
-
*/
|
|
22024
|
-
name?: string | null;
|
|
22025
|
-
/**
|
|
22026
|
-
* Default Change Tag Qname
|
|
22027
|
-
*
|
|
22028
|
-
* New default change tag qname. Pass a value to *change* the default; omit (`None`) to leave unchanged. There is no wire-level way to clear the default — see the class docstring.
|
|
22029
|
-
*/
|
|
22030
|
-
default_change_tag_qname?: string | null;
|
|
22031
|
-
/**
|
|
22032
|
-
* Attribution Filters
|
|
22033
|
-
*/
|
|
22034
|
-
attribution_filters?: Array<AttributionFilter> | null;
|
|
22035
|
-
/**
|
|
22036
|
-
* Validation Mode
|
|
22037
|
-
*/
|
|
22038
|
-
validation_mode?: 'strict' | 'residual_as_default' | 'warn_only' | null;
|
|
22039
|
-
};
|
|
22040
|
-
|
|
22041
22029
|
/**
|
|
22042
22030
|
* UpdateScheduleRequest
|
|
22043
22031
|
*
|
|
@@ -22873,28 +22861,6 @@ export type CreateLegacyArm = {
|
|
|
22873
22861
|
};
|
|
22874
22862
|
};
|
|
22875
22863
|
|
|
22876
|
-
/**
|
|
22877
|
-
* _CreateRollforwardArm
|
|
22878
|
-
*
|
|
22879
|
-
* Create-information-block body for `block_type="rollforward"`.
|
|
22880
|
-
*
|
|
22881
|
-
* Carries a typed rollforward payload. The block decomposes the period
|
|
22882
|
-
* change in a BS source element across the declared attribution
|
|
22883
|
-
* filters.
|
|
22884
|
-
*/
|
|
22885
|
-
export type CreateRollforwardArm = {
|
|
22886
|
-
/**
|
|
22887
|
-
* Block Type
|
|
22888
|
-
*
|
|
22889
|
-
* Discriminator value selecting this arm.
|
|
22890
|
-
*/
|
|
22891
|
-
block_type: 'rollforward';
|
|
22892
|
-
/**
|
|
22893
|
-
* Rollforward creation payload.
|
|
22894
|
-
*/
|
|
22895
|
-
payload: CreateRollforwardRequest;
|
|
22896
|
-
};
|
|
22897
|
-
|
|
22898
22864
|
/**
|
|
22899
22865
|
* _CreateScheduleArm
|
|
22900
22866
|
*
|
|
@@ -22964,27 +22930,6 @@ export type DeleteLegacyArm = {
|
|
|
22964
22930
|
};
|
|
22965
22931
|
};
|
|
22966
22932
|
|
|
22967
|
-
/**
|
|
22968
|
-
* _DeleteRollforwardArm
|
|
22969
|
-
*
|
|
22970
|
-
* Delete-information-block body for `block_type="rollforward"`.
|
|
22971
|
-
*
|
|
22972
|
-
* Cascades through any synthetic facts produced by this block's filter
|
|
22973
|
-
* evaluations. The underlying ledger LineItems are not touched.
|
|
22974
|
-
*/
|
|
22975
|
-
export type DeleteRollforwardArm = {
|
|
22976
|
-
/**
|
|
22977
|
-
* Block Type
|
|
22978
|
-
*
|
|
22979
|
-
* Discriminator value selecting this arm.
|
|
22980
|
-
*/
|
|
22981
|
-
block_type: 'rollforward';
|
|
22982
|
-
/**
|
|
22983
|
-
* Rollforward delete payload.
|
|
22984
|
-
*/
|
|
22985
|
-
payload: DeleteRollforwardRequest;
|
|
22986
|
-
};
|
|
22987
|
-
|
|
22988
22933
|
/**
|
|
22989
22934
|
* _DeleteScheduleArm
|
|
22990
22935
|
*
|
|
@@ -23054,27 +22999,6 @@ export type UpdateLegacyArm = {
|
|
|
23054
22999
|
};
|
|
23055
23000
|
};
|
|
23056
23001
|
|
|
23057
|
-
/**
|
|
23058
|
-
* _UpdateRollforwardArm
|
|
23059
|
-
*
|
|
23060
|
-
* Update-information-block body for `block_type="rollforward"`.
|
|
23061
|
-
*
|
|
23062
|
-
* Carries a typed rollforward update payload. Mutable fields: name,
|
|
23063
|
-
* default_change_tag_qname, attribution_filters, validation_mode.
|
|
23064
|
-
*/
|
|
23065
|
-
export type UpdateRollforwardArm = {
|
|
23066
|
-
/**
|
|
23067
|
-
* Block Type
|
|
23068
|
-
*
|
|
23069
|
-
* Discriminator value selecting this arm.
|
|
23070
|
-
*/
|
|
23071
|
-
block_type: 'rollforward';
|
|
23072
|
-
/**
|
|
23073
|
-
* Rollforward update payload.
|
|
23074
|
-
*/
|
|
23075
|
-
payload: UpdateRollforwardRequest;
|
|
23076
|
-
};
|
|
23077
|
-
|
|
23078
23002
|
/**
|
|
23079
23003
|
* _UpdateScheduleArm
|
|
23080
23004
|
*
|
|
@@ -33588,6 +33512,70 @@ export type SetAllocationOverrideResponses = {
|
|
|
33588
33512
|
|
|
33589
33513
|
export type SetAllocationOverrideResponse = SetAllocationOverrideResponses[keyof SetAllocationOverrideResponses];
|
|
33590
33514
|
|
|
33515
|
+
export type RecordAcquisitionData = {
|
|
33516
|
+
body: RecordAcquisitionRequest;
|
|
33517
|
+
headers?: {
|
|
33518
|
+
/**
|
|
33519
|
+
* Idempotency-Key
|
|
33520
|
+
*/
|
|
33521
|
+
'Idempotency-Key'?: string | null;
|
|
33522
|
+
};
|
|
33523
|
+
path: {
|
|
33524
|
+
/**
|
|
33525
|
+
* Graph Id
|
|
33526
|
+
*/
|
|
33527
|
+
graph_id: string;
|
|
33528
|
+
};
|
|
33529
|
+
query?: never;
|
|
33530
|
+
url: '/extensions/roboledger/{graph_id}/operations/record-acquisition';
|
|
33531
|
+
};
|
|
33532
|
+
|
|
33533
|
+
export type RecordAcquisitionErrors = {
|
|
33534
|
+
/**
|
|
33535
|
+
* Invalid request
|
|
33536
|
+
*/
|
|
33537
|
+
400: ErrorResponse;
|
|
33538
|
+
/**
|
|
33539
|
+
* Authentication required
|
|
33540
|
+
*/
|
|
33541
|
+
401: ErrorResponse;
|
|
33542
|
+
/**
|
|
33543
|
+
* Access denied
|
|
33544
|
+
*/
|
|
33545
|
+
403: ErrorResponse;
|
|
33546
|
+
/**
|
|
33547
|
+
* Resource not found
|
|
33548
|
+
*/
|
|
33549
|
+
404: ErrorResponse;
|
|
33550
|
+
/**
|
|
33551
|
+
* Idempotency-Key conflict — key reused with different body
|
|
33552
|
+
*/
|
|
33553
|
+
409: ErrorResponse;
|
|
33554
|
+
/**
|
|
33555
|
+
* Validation error
|
|
33556
|
+
*/
|
|
33557
|
+
422: ErrorResponse;
|
|
33558
|
+
/**
|
|
33559
|
+
* Rate limit exceeded
|
|
33560
|
+
*/
|
|
33561
|
+
429: ErrorResponse;
|
|
33562
|
+
/**
|
|
33563
|
+
* Internal server error
|
|
33564
|
+
*/
|
|
33565
|
+
500: ErrorResponse;
|
|
33566
|
+
};
|
|
33567
|
+
|
|
33568
|
+
export type RecordAcquisitionError = RecordAcquisitionErrors[keyof RecordAcquisitionErrors];
|
|
33569
|
+
|
|
33570
|
+
export type RecordAcquisitionResponses = {
|
|
33571
|
+
/**
|
|
33572
|
+
* Successful Response
|
|
33573
|
+
*/
|
|
33574
|
+
200: OperationEnvelopeAcquisitionResponse;
|
|
33575
|
+
};
|
|
33576
|
+
|
|
33577
|
+
export type RecordAcquisitionResponse = RecordAcquisitionResponses[keyof RecordAcquisitionResponses];
|
|
33578
|
+
|
|
33591
33579
|
export type UpdateJournalEntryData = {
|
|
33592
33580
|
body: UpdateJournalEntryRequest;
|
|
33593
33581
|
headers?: {
|