@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/sdk/types.gen.d.ts
CHANGED
|
@@ -259,6 +259,98 @@ export type AccountInfo = {
|
|
|
259
259
|
*/
|
|
260
260
|
provider_account_id: string;
|
|
261
261
|
};
|
|
262
|
+
/**
|
|
263
|
+
* AcquisitionAllocation
|
|
264
|
+
*
|
|
265
|
+
* Part of an acquisition's excess assigned to an identifiable asset or
|
|
266
|
+
* liability at fair value instead of goodwill: a step-up.
|
|
267
|
+
*/
|
|
268
|
+
export type AcquisitionAllocation = {
|
|
269
|
+
/**
|
|
270
|
+
* Concept
|
|
271
|
+
*
|
|
272
|
+
* The rs-gaap concept stepped up, e.g. `rs-gaap:PropertyPlantAndEquipmentNet`; the consolidation entity needs an account mapped to it.
|
|
273
|
+
*/
|
|
274
|
+
concept: string;
|
|
275
|
+
/**
|
|
276
|
+
* Amount
|
|
277
|
+
*
|
|
278
|
+
* Cents, debit-positive: fair value less book value at acquisition. Positive raises an asset; negative raises a liability.
|
|
279
|
+
*/
|
|
280
|
+
amount: number;
|
|
281
|
+
};
|
|
282
|
+
/**
|
|
283
|
+
* AcquisitionResponse
|
|
284
|
+
*
|
|
285
|
+
* A member's acquisition as recorded: the draft in the consolidation
|
|
286
|
+
* entity its close posts.
|
|
287
|
+
*/
|
|
288
|
+
export type AcquisitionResponse = {
|
|
289
|
+
/**
|
|
290
|
+
* Entity Id
|
|
291
|
+
*
|
|
292
|
+
* The member.
|
|
293
|
+
*/
|
|
294
|
+
entity_id: string;
|
|
295
|
+
/**
|
|
296
|
+
* Entity Name
|
|
297
|
+
*
|
|
298
|
+
* The member's name.
|
|
299
|
+
*/
|
|
300
|
+
entity_name: string;
|
|
301
|
+
/**
|
|
302
|
+
* Joined On
|
|
303
|
+
*
|
|
304
|
+
* When it joined the group.
|
|
305
|
+
*/
|
|
306
|
+
joined_on: string;
|
|
307
|
+
/**
|
|
308
|
+
* Equity At Acquisition
|
|
309
|
+
*
|
|
310
|
+
* Cents: the member's equity in its opening balance.
|
|
311
|
+
*/
|
|
312
|
+
equity_at_acquisition: number;
|
|
313
|
+
/**
|
|
314
|
+
* Parent Share
|
|
315
|
+
*
|
|
316
|
+
* Cents: the parent's share of that equity.
|
|
317
|
+
*/
|
|
318
|
+
parent_share: number;
|
|
319
|
+
/**
|
|
320
|
+
* Consideration
|
|
321
|
+
*
|
|
322
|
+
* Cents paid to the sellers.
|
|
323
|
+
*/
|
|
324
|
+
consideration: number;
|
|
325
|
+
/**
|
|
326
|
+
* Excess
|
|
327
|
+
*
|
|
328
|
+
* Cents: consideration less the parent's share of the equity.
|
|
329
|
+
*/
|
|
330
|
+
excess: number;
|
|
331
|
+
/**
|
|
332
|
+
* Goodwill
|
|
333
|
+
*
|
|
334
|
+
* Cents of goodwill; negative for a bargain purchase gain.
|
|
335
|
+
*/
|
|
336
|
+
goodwill: number;
|
|
337
|
+
/**
|
|
338
|
+
* Noncontrolling Interest
|
|
339
|
+
*
|
|
340
|
+
* Cents added to the outside owners' interest beyond their share of the member's book equity.
|
|
341
|
+
*/
|
|
342
|
+
noncontrolling_interest?: number;
|
|
343
|
+
/**
|
|
344
|
+
* The acquisition entry, a draft the close posts.
|
|
345
|
+
*/
|
|
346
|
+
entry: JournalEntryResponse;
|
|
347
|
+
/**
|
|
348
|
+
* Replaced
|
|
349
|
+
*
|
|
350
|
+
* True when it replaced an earlier draft of the acquisition.
|
|
351
|
+
*/
|
|
352
|
+
replaced?: boolean;
|
|
353
|
+
};
|
|
262
354
|
/**
|
|
263
355
|
* AddGraphMemberRequest
|
|
264
356
|
*
|
|
@@ -487,8 +579,6 @@ export type ArtifactResponse = {
|
|
|
487
579
|
} & StatementMechanics) | ({
|
|
488
580
|
kind: 'metric';
|
|
489
581
|
} & MetricMechanics) | ({
|
|
490
|
-
kind: 'rollforward';
|
|
491
|
-
} & RollforwardMechanics) | ({
|
|
492
582
|
kind: 'forecast';
|
|
493
583
|
} & ForecastMechanics) | ({
|
|
494
584
|
kind: 'reconciliation';
|
|
@@ -721,40 +811,6 @@ export type AssociationResponse = {
|
|
|
721
811
|
*/
|
|
722
812
|
reclassified_periods?: Array<string>;
|
|
723
813
|
};
|
|
724
|
-
/**
|
|
725
|
-
* AttributionFilter
|
|
726
|
-
*
|
|
727
|
-
* One flow-concept attribution rule on a rollforward IB.
|
|
728
|
-
*
|
|
729
|
-
* Pairs a target concept (the flow leaf the matched amount counts
|
|
730
|
-
* toward) with a predicate (which LineItems match). The rollforward's
|
|
731
|
-
* `attribution_filters: list[AttributionFilter]` declares every flow
|
|
732
|
-
* the BS source decomposes into; the renderer evaluates them all per
|
|
733
|
-
* period.
|
|
734
|
-
*
|
|
735
|
-
* `target_element_id` is resolved at create time from `target_qname`
|
|
736
|
-
* via the rs-gaap library + tenant taxonomy lookup. Authors only need
|
|
737
|
-
* to provide the qname; the element_id is filled in by the create
|
|
738
|
-
* handler and the resolved value is what the envelope round-trips.
|
|
739
|
-
*/
|
|
740
|
-
export type AttributionFilter = {
|
|
741
|
-
/**
|
|
742
|
-
* Target Qname
|
|
743
|
-
*
|
|
744
|
-
* QName of the flow concept this filter produces facts for — e.g. `rs-gaap:ProceedsFromIssuanceOfCommonStock`. Resolved to `target_element_id` at create time.
|
|
745
|
-
*/
|
|
746
|
-
target_qname: string;
|
|
747
|
-
/**
|
|
748
|
-
* Target Element Id
|
|
749
|
-
*
|
|
750
|
-
* Resolved element id for `target_qname`. Null at create time; populated by the handler before persistence. Round-tripped in the envelope.
|
|
751
|
-
*/
|
|
752
|
-
target_element_id?: string | null;
|
|
753
|
-
/**
|
|
754
|
-
* Predicate that determines which LineItems match this filter.
|
|
755
|
-
*/
|
|
756
|
-
predicate: LineItemMetadataPredicate;
|
|
757
|
-
};
|
|
758
814
|
/**
|
|
759
815
|
* AuthProvidersResponse
|
|
760
816
|
*
|
|
@@ -2689,6 +2745,12 @@ export type ConsolidationResidual = {
|
|
|
2689
2745
|
* What the two figures are.
|
|
2690
2746
|
*/
|
|
2691
2747
|
explanation: string;
|
|
2748
|
+
/**
|
|
2749
|
+
* Cause
|
|
2750
|
+
*
|
|
2751
|
+
* `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.
|
|
2752
|
+
*/
|
|
2753
|
+
cause?: 'unexplained' | 'pre_acquisition';
|
|
2692
2754
|
};
|
|
2693
2755
|
/**
|
|
2694
2756
|
* ConsolidationWorksheetRequest
|
|
@@ -3614,8 +3676,6 @@ export type CreateGraphRequest = {
|
|
|
3614
3676
|
export type CreateInformationBlockRequest = ({
|
|
3615
3677
|
block_type: 'schedule';
|
|
3616
3678
|
} & CreateScheduleArm) | ({
|
|
3617
|
-
block_type: 'rollforward';
|
|
3618
|
-
} & CreateRollforwardArm) | ({
|
|
3619
3679
|
block_type: 'forecast';
|
|
3620
3680
|
} & CreateForecastArm) | ({
|
|
3621
3681
|
block_type: 'balance_sheet' | 'cash_flow_statement' | 'comprehensive_income' | 'equity_statement' | 'income_statement' | 'metric' | 'reconciliation' | 'regulatory_disclosure';
|
|
@@ -3838,55 +3898,6 @@ export type CreateRepositorySubscriptionRequest = {
|
|
|
3838
3898
|
*/
|
|
3839
3899
|
user_id?: string | null;
|
|
3840
3900
|
};
|
|
3841
|
-
/**
|
|
3842
|
-
* CreateRollforwardRequest
|
|
3843
|
-
*
|
|
3844
|
-
* Create a rollforward Information Block.
|
|
3845
|
-
*
|
|
3846
|
-
* Mirrors :class:`CreateScheduleRequest` in shape. The block decomposes
|
|
3847
|
-
* the period change in `bs_source_qname` across the declared
|
|
3848
|
-
* attribution filters. Residual (Δ BS - Σ filter matches) falls back to
|
|
3849
|
-
* the default change tag — or, if no default is declared, surfaces as
|
|
3850
|
-
* an unattributed fact tagged with a synthetic residual concept.
|
|
3851
|
-
*/
|
|
3852
|
-
export type CreateRollforwardRequest = {
|
|
3853
|
-
/**
|
|
3854
|
-
* Name
|
|
3855
|
-
*
|
|
3856
|
-
* Human-readable block name.
|
|
3857
|
-
*/
|
|
3858
|
-
name: string;
|
|
3859
|
-
/**
|
|
3860
|
-
* Bs Source Qname
|
|
3861
|
-
*
|
|
3862
|
-
* QName of the balance-sheet element whose period delta this block decomposes. Resolved to `bs_source_element_id` at create time.
|
|
3863
|
-
*/
|
|
3864
|
-
bs_source_qname: string;
|
|
3865
|
-
/**
|
|
3866
|
-
* Default Change Tag Qname
|
|
3867
|
-
*
|
|
3868
|
-
* 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.
|
|
3869
|
-
*/
|
|
3870
|
-
default_change_tag_qname?: string | null;
|
|
3871
|
-
/**
|
|
3872
|
-
* Attribution Filters
|
|
3873
|
-
*
|
|
3874
|
-
* Filter predicates routing LineItems to flow concepts.
|
|
3875
|
-
*/
|
|
3876
|
-
attribution_filters?: Array<AttributionFilter>;
|
|
3877
|
-
/**
|
|
3878
|
-
* Validation Mode
|
|
3879
|
-
*
|
|
3880
|
-
* 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.
|
|
3881
|
-
*/
|
|
3882
|
-
validation_mode?: 'strict' | 'residual_as_default' | 'warn_only';
|
|
3883
|
-
/**
|
|
3884
|
-
* Taxonomy Id
|
|
3885
|
-
*
|
|
3886
|
-
* Owning taxonomy id (auto-resolved from `bs_source_qname` when omitted).
|
|
3887
|
-
*/
|
|
3888
|
-
taxonomy_id?: string | null;
|
|
3889
|
-
};
|
|
3890
3901
|
/**
|
|
3891
3902
|
* CreateScheduleRequest
|
|
3892
3903
|
*/
|
|
@@ -4735,8 +4746,6 @@ export type DeleteGraphOp = {
|
|
|
4735
4746
|
export type DeleteInformationBlockRequest = ({
|
|
4736
4747
|
block_type: 'schedule';
|
|
4737
4748
|
} & DeleteScheduleArm) | ({
|
|
4738
|
-
block_type: 'rollforward';
|
|
4739
|
-
} & DeleteRollforwardArm) | ({
|
|
4740
4749
|
block_type: 'forecast';
|
|
4741
4750
|
} & DeleteForecastArm) | ({
|
|
4742
4751
|
block_type: 'balance_sheet' | 'cash_flow_statement' | 'comprehensive_income' | 'equity_statement' | 'income_statement' | 'metric' | 'reconciliation' | 'regulatory_disclosure';
|
|
@@ -4899,23 +4908,6 @@ export type DeleteResult = {
|
|
|
4899
4908
|
*/
|
|
4900
4909
|
deleted: boolean;
|
|
4901
4910
|
};
|
|
4902
|
-
/**
|
|
4903
|
-
* DeleteRollforwardRequest
|
|
4904
|
-
*
|
|
4905
|
-
* Delete a rollforward block.
|
|
4906
|
-
*
|
|
4907
|
-
* Cascades through any synthetic facts produced by this block's filter
|
|
4908
|
-
* evaluations. The underlying ledger LineItems are not touched — only
|
|
4909
|
-
* the rollforward IB's projection of them.
|
|
4910
|
-
*/
|
|
4911
|
-
export type DeleteRollforwardRequest = {
|
|
4912
|
-
/**
|
|
4913
|
-
* Structure Id
|
|
4914
|
-
*
|
|
4915
|
-
* Structure ID of the rollforward block.
|
|
4916
|
-
*/
|
|
4917
|
-
structure_id: string;
|
|
4918
|
-
};
|
|
4919
4911
|
/**
|
|
4920
4912
|
* DeleteScheduleRequest
|
|
4921
4913
|
*
|
|
@@ -6347,90 +6339,138 @@ export type EventBlockEnvelope = {
|
|
|
6347
6339
|
};
|
|
6348
6340
|
/**
|
|
6349
6341
|
* EventHandlerResponse
|
|
6342
|
+
*
|
|
6343
|
+
* A rule that turns a matching event into GL rows.
|
|
6350
6344
|
*/
|
|
6351
6345
|
export type EventHandlerResponse = {
|
|
6352
6346
|
/**
|
|
6353
6347
|
* Id
|
|
6348
|
+
*
|
|
6349
|
+
* Handler id (`hdl_`-prefixed).
|
|
6354
6350
|
*/
|
|
6355
6351
|
id: string;
|
|
6356
6352
|
/**
|
|
6357
6353
|
* Name
|
|
6354
|
+
*
|
|
6355
|
+
* Human-readable handler name.
|
|
6358
6356
|
*/
|
|
6359
6357
|
name: string;
|
|
6360
6358
|
/**
|
|
6361
6359
|
* Description
|
|
6360
|
+
*
|
|
6361
|
+
* What the handler is for.
|
|
6362
6362
|
*/
|
|
6363
6363
|
description?: string | null;
|
|
6364
6364
|
/**
|
|
6365
6365
|
* Event Type
|
|
6366
|
+
*
|
|
6367
|
+
* The event type the handler matches.
|
|
6366
6368
|
*/
|
|
6367
6369
|
event_type: string;
|
|
6368
6370
|
/**
|
|
6369
6371
|
* Event Category
|
|
6372
|
+
*
|
|
6373
|
+
* Match on the event's category; null matches any.
|
|
6370
6374
|
*/
|
|
6371
6375
|
event_category?: string | null;
|
|
6372
6376
|
/**
|
|
6373
6377
|
* Match Source
|
|
6378
|
+
*
|
|
6379
|
+
* Match on the event's source system; null matches any.
|
|
6374
6380
|
*/
|
|
6375
6381
|
match_source?: string | null;
|
|
6376
6382
|
/**
|
|
6377
6383
|
* Match Agent Type
|
|
6384
|
+
*
|
|
6385
|
+
* Match on the counterparty's role; null matches any.
|
|
6378
6386
|
*/
|
|
6379
6387
|
match_agent_type?: string | null;
|
|
6380
6388
|
/**
|
|
6381
6389
|
* Match Resource Type
|
|
6390
|
+
*
|
|
6391
|
+
* Match on the resource type; null matches any.
|
|
6382
6392
|
*/
|
|
6383
6393
|
match_resource_type?: string | null;
|
|
6384
6394
|
/**
|
|
6385
6395
|
* Match Metadata Expression
|
|
6396
|
+
*
|
|
6397
|
+
* Equality matches against the event's metadata.
|
|
6386
6398
|
*/
|
|
6387
6399
|
match_metadata_expression?: {
|
|
6388
6400
|
[key: string]: unknown;
|
|
6389
6401
|
} | null;
|
|
6390
6402
|
/**
|
|
6391
6403
|
* Transaction Template
|
|
6404
|
+
*
|
|
6405
|
+
* The GL rows the handler books: its DSL template, as JSON.
|
|
6392
6406
|
*/
|
|
6393
6407
|
transaction_template: {
|
|
6394
6408
|
[key: string]: unknown;
|
|
6395
6409
|
};
|
|
6396
6410
|
/**
|
|
6397
6411
|
* Priority
|
|
6412
|
+
*
|
|
6413
|
+
* Among handlers that match, the highest priority wins.
|
|
6398
6414
|
*/
|
|
6399
6415
|
priority: number;
|
|
6400
6416
|
/**
|
|
6401
6417
|
* Is Active
|
|
6418
|
+
*
|
|
6419
|
+
* Whether the handler takes part in matching at all.
|
|
6402
6420
|
*/
|
|
6403
6421
|
is_active: boolean;
|
|
6404
6422
|
/**
|
|
6405
6423
|
* Origin
|
|
6424
|
+
*
|
|
6425
|
+
* `hub` for a platform-shipped handler, `tenant` otherwise.
|
|
6406
6426
|
*/
|
|
6407
6427
|
origin: string;
|
|
6408
6428
|
/**
|
|
6409
6429
|
* Suggested By
|
|
6430
|
+
*
|
|
6431
|
+
* `ai` when an AI client created the handler or last changed what it matches or books; null when a person did.
|
|
6410
6432
|
*/
|
|
6411
6433
|
suggested_by?: string | null;
|
|
6412
6434
|
/**
|
|
6413
6435
|
* Confidence
|
|
6436
|
+
*
|
|
6437
|
+
* The suggesting AI's confidence, when it gave one.
|
|
6414
6438
|
*/
|
|
6415
6439
|
confidence?: number | null;
|
|
6416
6440
|
/**
|
|
6417
6441
|
* Approved By
|
|
6442
|
+
*
|
|
6443
|
+
* The user who approved an AI-suggested handler.
|
|
6418
6444
|
*/
|
|
6419
6445
|
approved_by?: string | null;
|
|
6420
6446
|
/**
|
|
6421
6447
|
* Approved At
|
|
6448
|
+
*
|
|
6449
|
+
* When it was approved.
|
|
6422
6450
|
*/
|
|
6423
6451
|
approved_at?: string | null;
|
|
6452
|
+
/**
|
|
6453
|
+
* Awaiting Approval
|
|
6454
|
+
*
|
|
6455
|
+
* True for an AI-suggested handler no one has approved: it takes no part in matching until a person approves it.
|
|
6456
|
+
*/
|
|
6457
|
+
awaiting_approval?: boolean;
|
|
6424
6458
|
/**
|
|
6425
6459
|
* Created At
|
|
6460
|
+
*
|
|
6461
|
+
* When it was created.
|
|
6426
6462
|
*/
|
|
6427
6463
|
created_at?: string | null;
|
|
6428
6464
|
/**
|
|
6429
6465
|
* Updated At
|
|
6466
|
+
*
|
|
6467
|
+
* When it last changed.
|
|
6430
6468
|
*/
|
|
6431
6469
|
updated_at?: string | null;
|
|
6432
6470
|
/**
|
|
6433
6471
|
* Created By
|
|
6472
|
+
*
|
|
6473
|
+
* The user who created it.
|
|
6434
6474
|
*/
|
|
6435
6475
|
created_by?: string | null;
|
|
6436
6476
|
};
|
|
@@ -9961,43 +10001,6 @@ export type LineGrowthRequest = {
|
|
|
9961
10001
|
[key: string]: number;
|
|
9962
10002
|
} | null;
|
|
9963
10003
|
};
|
|
9964
|
-
/**
|
|
9965
|
-
* LineItemMetadataPredicate
|
|
9966
|
-
*
|
|
9967
|
-
* Filter ledger LineItems by flow concept.
|
|
9968
|
-
*
|
|
9969
|
-
* The single predicate kind shipped to date. `values` are flow-concept
|
|
9970
|
-
* qnames — mini's `TransactionDescriptionCode` values, rs-gaap flow
|
|
9971
|
-
* concepts (what the enrichment classifier emits for QuickBooks data),
|
|
9972
|
-
* future XBRL GL `GenericFlowCategory` codes. The engine resolves them
|
|
9973
|
-
* to element_ids and matches the first-class `LineItem.flow_element_id`
|
|
9974
|
-
* FK; matched lines aggregate signed into the attributed fact for the
|
|
9975
|
-
* period.
|
|
9976
|
-
*
|
|
9977
|
-
* `field` is accepted but ignored: the flow tag lives in the typed
|
|
9978
|
-
* `flow_element_id` FK, not in JSONB metadata. It stays on the wire so
|
|
9979
|
-
* existing request bodies keep validating.
|
|
9980
|
-
*/
|
|
9981
|
-
export type LineItemMetadataPredicate = {
|
|
9982
|
-
/**
|
|
9983
|
-
* Kind
|
|
9984
|
-
*
|
|
9985
|
-
* Discriminator value selecting this predicate shape.
|
|
9986
|
-
*/
|
|
9987
|
-
kind?: 'line_item_metadata_field';
|
|
9988
|
-
/**
|
|
9989
|
-
* Field
|
|
9990
|
-
*
|
|
9991
|
-
* Accepted but ignored. The flow tag lives in the typed `flow_element_id` FK, not JSONB metadata. Retained for wire-compatibility.
|
|
9992
|
-
*/
|
|
9993
|
-
field?: string;
|
|
9994
|
-
/**
|
|
9995
|
-
* Values
|
|
9996
|
-
*
|
|
9997
|
-
* 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.
|
|
9998
|
-
*/
|
|
9999
|
-
values: Array<string>;
|
|
10000
|
-
};
|
|
10001
10004
|
/**
|
|
10002
10005
|
* LinkBankAccountRequest
|
|
10003
10006
|
*
|
|
@@ -11339,6 +11342,51 @@ export type OperationEnvelopeAcceptSuggestionsResponse = {
|
|
|
11339
11342
|
*/
|
|
11340
11343
|
idempotentReplay?: boolean;
|
|
11341
11344
|
};
|
|
11345
|
+
/**
|
|
11346
|
+
* OperationEnvelope[AcquisitionResponse]
|
|
11347
|
+
*/
|
|
11348
|
+
export type OperationEnvelopeAcquisitionResponse = {
|
|
11349
|
+
/**
|
|
11350
|
+
* Operation
|
|
11351
|
+
*
|
|
11352
|
+
* Kebab-case operation name
|
|
11353
|
+
*/
|
|
11354
|
+
operation: string;
|
|
11355
|
+
/**
|
|
11356
|
+
* Operationid
|
|
11357
|
+
*
|
|
11358
|
+
* op_-prefixed ULID for audit and SSE correlation
|
|
11359
|
+
*/
|
|
11360
|
+
operationId: string;
|
|
11361
|
+
/**
|
|
11362
|
+
* Status
|
|
11363
|
+
*
|
|
11364
|
+
* Operation lifecycle state
|
|
11365
|
+
*/
|
|
11366
|
+
status: 'completed' | 'pending' | 'failed';
|
|
11367
|
+
/**
|
|
11368
|
+
* Command-specific result payload
|
|
11369
|
+
*/
|
|
11370
|
+
result?: AcquisitionResponse | null;
|
|
11371
|
+
/**
|
|
11372
|
+
* At
|
|
11373
|
+
*
|
|
11374
|
+
* ISO-8601 UTC timestamp
|
|
11375
|
+
*/
|
|
11376
|
+
at: string;
|
|
11377
|
+
/**
|
|
11378
|
+
* Createdby
|
|
11379
|
+
*
|
|
11380
|
+
* User ID that initiated the operation
|
|
11381
|
+
*/
|
|
11382
|
+
createdBy?: string | null;
|
|
11383
|
+
/**
|
|
11384
|
+
* Idempotentreplay
|
|
11385
|
+
*
|
|
11386
|
+
* True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
|
|
11387
|
+
*/
|
|
11388
|
+
idempotentReplay?: boolean;
|
|
11389
|
+
};
|
|
11342
11390
|
/**
|
|
11343
11391
|
* OperationEnvelope[AllocationOverrideResponse]
|
|
11344
11392
|
*/
|
|
@@ -16918,6 +16966,52 @@ export type ReconcilingItemRegenerated = {
|
|
|
16918
16966
|
*/
|
|
16919
16967
|
entry_ids?: Array<string>;
|
|
16920
16968
|
};
|
|
16969
|
+
/**
|
|
16970
|
+
* RecordAcquisitionRequest
|
|
16971
|
+
*
|
|
16972
|
+
* A member bought from its outside owners: what the parent paid them,
|
|
16973
|
+
* and how the excess over its share of the member's equity at acquisition is
|
|
16974
|
+
* allocated. The engine never invents a fair value; each comes from the
|
|
16975
|
+
* person, with the basis.
|
|
16976
|
+
*/
|
|
16977
|
+
export type RecordAcquisitionRequest = {
|
|
16978
|
+
/**
|
|
16979
|
+
* Entity Id
|
|
16980
|
+
*
|
|
16981
|
+
* The member acquired, consolidated in full, with `joined_on` set and its opening balance recorded at acquisition.
|
|
16982
|
+
*/
|
|
16983
|
+
entity_id: string;
|
|
16984
|
+
/**
|
|
16985
|
+
* Consideration
|
|
16986
|
+
*
|
|
16987
|
+
* 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.
|
|
16988
|
+
*/
|
|
16989
|
+
consideration: number;
|
|
16990
|
+
/**
|
|
16991
|
+
* Nci Fair Value
|
|
16992
|
+
*
|
|
16993
|
+
* 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.
|
|
16994
|
+
*/
|
|
16995
|
+
nci_fair_value?: number | null;
|
|
16996
|
+
/**
|
|
16997
|
+
* Allocations
|
|
16998
|
+
*
|
|
16999
|
+
* Fair-value step-ups; what is left of the excess is goodwill.
|
|
17000
|
+
*/
|
|
17001
|
+
allocations?: Array<AcquisitionAllocation>;
|
|
17002
|
+
/**
|
|
17003
|
+
* Basis
|
|
17004
|
+
*
|
|
17005
|
+
* Where the consideration and fair values come from: the purchase agreement, a valuation.
|
|
17006
|
+
*/
|
|
17007
|
+
basis: string;
|
|
17008
|
+
/**
|
|
17009
|
+
* Confirm Bargain Purchase
|
|
17010
|
+
*
|
|
17011
|
+
* 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.
|
|
17012
|
+
*/
|
|
17013
|
+
confirm_bargain_purchase?: boolean;
|
|
17014
|
+
};
|
|
16921
17015
|
/**
|
|
16922
17016
|
* RecordOpeningBalanceRequest
|
|
16923
17017
|
*
|
|
@@ -17794,65 +17888,6 @@ export type RevokeReportShareResponse = {
|
|
|
17794
17888
|
*/
|
|
17795
17889
|
copy_deleted: boolean;
|
|
17796
17890
|
};
|
|
17797
|
-
/**
|
|
17798
|
-
* RollforwardMechanics
|
|
17799
|
-
*
|
|
17800
|
-
* Filter-based attribution mechanics for `block_type='rollforward'`.
|
|
17801
|
-
*
|
|
17802
|
-
* Filter-based attribution: each block decomposes one BS source
|
|
17803
|
-
* element's period delta into a list of flow concepts via declared
|
|
17804
|
-
* :class:`AttributionFilter` predicates. The renderer evaluates the
|
|
17805
|
-
* filters against ledger LineItems at envelope-build time, emits one
|
|
17806
|
-
* attributed fact per filter per period, and arbitrates any residual
|
|
17807
|
-
* against the default change tag fallback.
|
|
17808
|
-
*
|
|
17809
|
-
* Reads directly from the typed `structures.artifact_mechanics` JSONB
|
|
17810
|
-
* column. `attribution_filters` rides as nested JSON; the predicate
|
|
17811
|
-
* union widens as new predicate shapes are added — currently only
|
|
17812
|
-
* `line_item_metadata_field` is carried.
|
|
17813
|
-
*/
|
|
17814
|
-
export type RollforwardMechanics = {
|
|
17815
|
-
/**
|
|
17816
|
-
* Kind
|
|
17817
|
-
*/
|
|
17818
|
-
kind?: 'rollforward';
|
|
17819
|
-
/**
|
|
17820
|
-
* Bs Source Element Id
|
|
17821
|
-
*
|
|
17822
|
-
* Element id of the balance-sheet source whose period delta this block decomposes. Resolved from `bs_source_qname` at create time.
|
|
17823
|
-
*/
|
|
17824
|
-
bs_source_element_id: string;
|
|
17825
|
-
/**
|
|
17826
|
-
* Bs Source Qname
|
|
17827
|
-
*
|
|
17828
|
-
* QName of the BS source element (e.g. `mini:CashAndCashEquivalents`). Round-tripped for caller convenience; `bs_source_element_id` is authoritative.
|
|
17829
|
-
*/
|
|
17830
|
-
bs_source_qname: string;
|
|
17831
|
-
/**
|
|
17832
|
-
* Default Change Tag Element Id
|
|
17833
|
-
*
|
|
17834
|
-
* 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`.
|
|
17835
|
-
*/
|
|
17836
|
-
default_change_tag_element_id?: string | null;
|
|
17837
|
-
/**
|
|
17838
|
-
* Default Change Tag Qname
|
|
17839
|
-
*
|
|
17840
|
-
* 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.
|
|
17841
|
-
*/
|
|
17842
|
-
default_change_tag_qname?: string | null;
|
|
17843
|
-
/**
|
|
17844
|
-
* Attribution Filters
|
|
17845
|
-
*
|
|
17846
|
-
* 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.
|
|
17847
|
-
*/
|
|
17848
|
-
attribution_filters?: Array<AttributionFilter>;
|
|
17849
|
-
/**
|
|
17850
|
-
* Validation Mode
|
|
17851
|
-
*
|
|
17852
|
-
* 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.
|
|
17853
|
-
*/
|
|
17854
|
-
validation_mode?: 'strict' | 'residual_as_default' | 'warn_only';
|
|
17855
|
-
};
|
|
17856
17891
|
/**
|
|
17857
17892
|
* RuleLite
|
|
17858
17893
|
*
|
|
@@ -21274,8 +21309,6 @@ export type UpdateGraphMetadataOp = {
|
|
|
21274
21309
|
export type UpdateInformationBlockRequest = ({
|
|
21275
21310
|
block_type: 'schedule';
|
|
21276
21311
|
} & UpdateScheduleArm) | ({
|
|
21277
|
-
block_type: 'rollforward';
|
|
21278
|
-
} & UpdateRollforwardArm) | ({
|
|
21279
21312
|
block_type: 'forecast';
|
|
21280
21313
|
} & UpdateForecastArm) | ({
|
|
21281
21314
|
block_type: 'balance_sheet' | 'cash_flow_statement' | 'comprehensive_income' | 'equity_statement' | 'income_statement' | 'metric' | 'reconciliation' | 'regulatory_disclosure';
|
|
@@ -21481,49 +21514,6 @@ export type UpdatePublishListOperation = {
|
|
|
21481
21514
|
*/
|
|
21482
21515
|
list_id: string;
|
|
21483
21516
|
};
|
|
21484
|
-
/**
|
|
21485
|
-
* UpdateRollforwardRequest
|
|
21486
|
-
*
|
|
21487
|
-
* Update mutable fields on a rollforward block.
|
|
21488
|
-
*
|
|
21489
|
-
* Editable: name, default_change_tag_qname, attribution_filters,
|
|
21490
|
-
* validation_mode. The BS source is fixed at creation — changing it would
|
|
21491
|
-
* invalidate every period already rendered — so switching BS source means
|
|
21492
|
-
* delete and re-create.
|
|
21493
|
-
*
|
|
21494
|
-
* **Partial-update semantics**: an omitted (`None`) field means "leave
|
|
21495
|
-
* unchanged". There is no wire-level way to *clear* the default change tag or
|
|
21496
|
-
* empty the attribution_filters list; delete and re-create the block instead.
|
|
21497
|
-
* The asymmetry is deliberate — a clear-sentinel costs wire-shape complexity
|
|
21498
|
-
* for a case that rarely arises, since default tags get swapped rather than
|
|
21499
|
-
* removed.
|
|
21500
|
-
*/
|
|
21501
|
-
export type UpdateRollforwardRequest = {
|
|
21502
|
-
/**
|
|
21503
|
-
* Structure Id
|
|
21504
|
-
*
|
|
21505
|
-
* Structure ID of the rollforward block.
|
|
21506
|
-
*/
|
|
21507
|
-
structure_id: string;
|
|
21508
|
-
/**
|
|
21509
|
-
* Name
|
|
21510
|
-
*/
|
|
21511
|
-
name?: string | null;
|
|
21512
|
-
/**
|
|
21513
|
-
* Default Change Tag Qname
|
|
21514
|
-
*
|
|
21515
|
-
* 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.
|
|
21516
|
-
*/
|
|
21517
|
-
default_change_tag_qname?: string | null;
|
|
21518
|
-
/**
|
|
21519
|
-
* Attribution Filters
|
|
21520
|
-
*/
|
|
21521
|
-
attribution_filters?: Array<AttributionFilter> | null;
|
|
21522
|
-
/**
|
|
21523
|
-
* Validation Mode
|
|
21524
|
-
*/
|
|
21525
|
-
validation_mode?: 'strict' | 'residual_as_default' | 'warn_only' | null;
|
|
21526
|
-
};
|
|
21527
21517
|
/**
|
|
21528
21518
|
* UpdateScheduleRequest
|
|
21529
21519
|
*
|
|
@@ -22337,27 +22327,6 @@ export type CreateLegacyArm = {
|
|
|
22337
22327
|
[key: string]: unknown;
|
|
22338
22328
|
};
|
|
22339
22329
|
};
|
|
22340
|
-
/**
|
|
22341
|
-
* _CreateRollforwardArm
|
|
22342
|
-
*
|
|
22343
|
-
* Create-information-block body for `block_type="rollforward"`.
|
|
22344
|
-
*
|
|
22345
|
-
* Carries a typed rollforward payload. The block decomposes the period
|
|
22346
|
-
* change in a BS source element across the declared attribution
|
|
22347
|
-
* filters.
|
|
22348
|
-
*/
|
|
22349
|
-
export type CreateRollforwardArm = {
|
|
22350
|
-
/**
|
|
22351
|
-
* Block Type
|
|
22352
|
-
*
|
|
22353
|
-
* Discriminator value selecting this arm.
|
|
22354
|
-
*/
|
|
22355
|
-
block_type: 'rollforward';
|
|
22356
|
-
/**
|
|
22357
|
-
* Rollforward creation payload.
|
|
22358
|
-
*/
|
|
22359
|
-
payload: CreateRollforwardRequest;
|
|
22360
|
-
};
|
|
22361
22330
|
/**
|
|
22362
22331
|
* _CreateScheduleArm
|
|
22363
22332
|
*
|
|
@@ -22424,26 +22393,6 @@ export type DeleteLegacyArm = {
|
|
|
22424
22393
|
[key: string]: unknown;
|
|
22425
22394
|
};
|
|
22426
22395
|
};
|
|
22427
|
-
/**
|
|
22428
|
-
* _DeleteRollforwardArm
|
|
22429
|
-
*
|
|
22430
|
-
* Delete-information-block body for `block_type="rollforward"`.
|
|
22431
|
-
*
|
|
22432
|
-
* Cascades through any synthetic facts produced by this block's filter
|
|
22433
|
-
* evaluations. The underlying ledger LineItems are not touched.
|
|
22434
|
-
*/
|
|
22435
|
-
export type DeleteRollforwardArm = {
|
|
22436
|
-
/**
|
|
22437
|
-
* Block Type
|
|
22438
|
-
*
|
|
22439
|
-
* Discriminator value selecting this arm.
|
|
22440
|
-
*/
|
|
22441
|
-
block_type: 'rollforward';
|
|
22442
|
-
/**
|
|
22443
|
-
* Rollforward delete payload.
|
|
22444
|
-
*/
|
|
22445
|
-
payload: DeleteRollforwardRequest;
|
|
22446
|
-
};
|
|
22447
22396
|
/**
|
|
22448
22397
|
* _DeleteScheduleArm
|
|
22449
22398
|
*
|
|
@@ -22510,26 +22459,6 @@ export type UpdateLegacyArm = {
|
|
|
22510
22459
|
[key: string]: unknown;
|
|
22511
22460
|
};
|
|
22512
22461
|
};
|
|
22513
|
-
/**
|
|
22514
|
-
* _UpdateRollforwardArm
|
|
22515
|
-
*
|
|
22516
|
-
* Update-information-block body for `block_type="rollforward"`.
|
|
22517
|
-
*
|
|
22518
|
-
* Carries a typed rollforward update payload. Mutable fields: name,
|
|
22519
|
-
* default_change_tag_qname, attribution_filters, validation_mode.
|
|
22520
|
-
*/
|
|
22521
|
-
export type UpdateRollforwardArm = {
|
|
22522
|
-
/**
|
|
22523
|
-
* Block Type
|
|
22524
|
-
*
|
|
22525
|
-
* Discriminator value selecting this arm.
|
|
22526
|
-
*/
|
|
22527
|
-
block_type: 'rollforward';
|
|
22528
|
-
/**
|
|
22529
|
-
* Rollforward update payload.
|
|
22530
|
-
*/
|
|
22531
|
-
payload: UpdateRollforwardRequest;
|
|
22532
|
-
};
|
|
22533
22462
|
/**
|
|
22534
22463
|
* _UpdateScheduleArm
|
|
22535
22464
|
*
|
|
@@ -32123,6 +32052,65 @@ export type SetAllocationOverrideResponses = {
|
|
|
32123
32052
|
200: OperationEnvelopeAllocationOverrideResponse;
|
|
32124
32053
|
};
|
|
32125
32054
|
export type SetAllocationOverrideResponse = SetAllocationOverrideResponses[keyof SetAllocationOverrideResponses];
|
|
32055
|
+
export type RecordAcquisitionData = {
|
|
32056
|
+
body: RecordAcquisitionRequest;
|
|
32057
|
+
headers?: {
|
|
32058
|
+
/**
|
|
32059
|
+
* Idempotency-Key
|
|
32060
|
+
*/
|
|
32061
|
+
'Idempotency-Key'?: string | null;
|
|
32062
|
+
};
|
|
32063
|
+
path: {
|
|
32064
|
+
/**
|
|
32065
|
+
* Graph Id
|
|
32066
|
+
*/
|
|
32067
|
+
graph_id: string;
|
|
32068
|
+
};
|
|
32069
|
+
query?: never;
|
|
32070
|
+
url: '/extensions/roboledger/{graph_id}/operations/record-acquisition';
|
|
32071
|
+
};
|
|
32072
|
+
export type RecordAcquisitionErrors = {
|
|
32073
|
+
/**
|
|
32074
|
+
* Invalid request
|
|
32075
|
+
*/
|
|
32076
|
+
400: ErrorResponse;
|
|
32077
|
+
/**
|
|
32078
|
+
* Authentication required
|
|
32079
|
+
*/
|
|
32080
|
+
401: ErrorResponse;
|
|
32081
|
+
/**
|
|
32082
|
+
* Access denied
|
|
32083
|
+
*/
|
|
32084
|
+
403: ErrorResponse;
|
|
32085
|
+
/**
|
|
32086
|
+
* Resource not found
|
|
32087
|
+
*/
|
|
32088
|
+
404: ErrorResponse;
|
|
32089
|
+
/**
|
|
32090
|
+
* Idempotency-Key conflict — key reused with different body
|
|
32091
|
+
*/
|
|
32092
|
+
409: ErrorResponse;
|
|
32093
|
+
/**
|
|
32094
|
+
* Validation error
|
|
32095
|
+
*/
|
|
32096
|
+
422: ErrorResponse;
|
|
32097
|
+
/**
|
|
32098
|
+
* Rate limit exceeded
|
|
32099
|
+
*/
|
|
32100
|
+
429: ErrorResponse;
|
|
32101
|
+
/**
|
|
32102
|
+
* Internal server error
|
|
32103
|
+
*/
|
|
32104
|
+
500: ErrorResponse;
|
|
32105
|
+
};
|
|
32106
|
+
export type RecordAcquisitionError = RecordAcquisitionErrors[keyof RecordAcquisitionErrors];
|
|
32107
|
+
export type RecordAcquisitionResponses = {
|
|
32108
|
+
/**
|
|
32109
|
+
* Successful Response
|
|
32110
|
+
*/
|
|
32111
|
+
200: OperationEnvelopeAcquisitionResponse;
|
|
32112
|
+
};
|
|
32113
|
+
export type RecordAcquisitionResponse = RecordAcquisitionResponses[keyof RecordAcquisitionResponses];
|
|
32126
32114
|
export type UpdateJournalEntryData = {
|
|
32127
32115
|
body: UpdateJournalEntryRequest;
|
|
32128
32116
|
headers?: {
|