@robosystems/client 2.18.0 → 2.20.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 +30 -1
- package/artifacts/LedgerClient.js +36 -0
- package/artifacts/LedgerClient.ts +72 -0
- package/artifacts/graphql/generated/graphql.d.ts +4 -0
- package/artifacts/graphql/generated/graphql.js +4 -0
- package/artifacts/graphql/generated/graphql.ts +8 -0
- package/artifacts/graphql/queries/ledger/fiscalCalendar.js +4 -0
- package/artifacts/graphql/queries/ledger/fiscalCalendar.ts +4 -0
- package/index.ts +2 -2
- package/package.json +1 -1
- package/sdk/index.d.ts +2 -2
- package/sdk/index.js +5 -2
- package/sdk/index.ts +2 -2
- package/sdk/sdk.gen.d.ts +25 -1
- package/sdk/sdk.gen.js +53 -2
- package/sdk/sdk.gen.ts +52 -1
- package/sdk/types.gen.d.ts +779 -7
- package/sdk/types.gen.ts +802 -2
- package/sdk.gen.d.ts +25 -1
- package/sdk.gen.js +53 -2
- package/sdk.gen.ts +52 -1
- package/types.gen.d.ts +779 -7
- package/types.gen.ts +802 -2
package/types.gen.ts
CHANGED
|
@@ -363,6 +363,56 @@ export type AgentClassification = {
|
|
|
363
363
|
learned_from?: string | null;
|
|
364
364
|
};
|
|
365
365
|
|
|
366
|
+
/**
|
|
367
|
+
* AllocationOverrideResponse
|
|
368
|
+
*
|
|
369
|
+
* A member's allocation override for one month.
|
|
370
|
+
*/
|
|
371
|
+
export type AllocationOverrideResponse = {
|
|
372
|
+
/**
|
|
373
|
+
* Entity Id
|
|
374
|
+
*
|
|
375
|
+
* The member.
|
|
376
|
+
*/
|
|
377
|
+
entity_id: string;
|
|
378
|
+
/**
|
|
379
|
+
* Period
|
|
380
|
+
*
|
|
381
|
+
* The month, as YYYY-MM.
|
|
382
|
+
*/
|
|
383
|
+
period: string;
|
|
384
|
+
/**
|
|
385
|
+
* Amount
|
|
386
|
+
*
|
|
387
|
+
* The share, in cents, when set so.
|
|
388
|
+
*/
|
|
389
|
+
amount?: number | null;
|
|
390
|
+
/**
|
|
391
|
+
* Percentage
|
|
392
|
+
*
|
|
393
|
+
* The share as a percentage, when set so.
|
|
394
|
+
*/
|
|
395
|
+
percentage?: number | null;
|
|
396
|
+
/**
|
|
397
|
+
* Basis
|
|
398
|
+
*
|
|
399
|
+
* Why it differs from pro rata.
|
|
400
|
+
*/
|
|
401
|
+
basis?: string | null;
|
|
402
|
+
/**
|
|
403
|
+
* Set By
|
|
404
|
+
*
|
|
405
|
+
* Who set it.
|
|
406
|
+
*/
|
|
407
|
+
set_by?: string | null;
|
|
408
|
+
/**
|
|
409
|
+
* Cleared
|
|
410
|
+
*
|
|
411
|
+
* True when the override was removed.
|
|
412
|
+
*/
|
|
413
|
+
cleared?: boolean;
|
|
414
|
+
};
|
|
415
|
+
|
|
366
416
|
/**
|
|
367
417
|
* AnalyticalStatementFactRow
|
|
368
418
|
*
|
|
@@ -979,6 +1029,12 @@ export type BackfillPlanHistoryOperation = {
|
|
|
979
1029
|
* Override the reconciliation gate on each reclose. Needed when a month inside the backfill window has a reconciliation the close waits on that was never compared for it, which is every month closed before the reconciliation existed.
|
|
980
1030
|
*/
|
|
981
1031
|
allow_unreconciled_accounts?: boolean;
|
|
1032
|
+
/**
|
|
1033
|
+
* Allow Unexplained Residuals
|
|
1034
|
+
*
|
|
1035
|
+
* Override the group close's residual gate on each reclose of the consolidation entity's months.
|
|
1036
|
+
*/
|
|
1037
|
+
allow_unexplained_residuals?: boolean;
|
|
982
1038
|
/**
|
|
983
1039
|
* Restamp
|
|
984
1040
|
*
|
|
@@ -2005,6 +2061,12 @@ export type ClosePeriodOperation = {
|
|
|
2005
2061
|
* Override the reconciliation gate — close even though a reconciliation the close waits on is not reconciled for the period, or was never compared for it. The books are then closed without that check. Prefer refresh-reconciliations and clearing what it reports first. The override is recorded in the close audit note.
|
|
2006
2062
|
*/
|
|
2007
2063
|
allow_unreconciled_accounts?: boolean;
|
|
2064
|
+
/**
|
|
2065
|
+
* Allow Unexplained Residuals
|
|
2066
|
+
*
|
|
2067
|
+
* On the consolidation entity, the group close: close even though a residual or an intercompany disagreement is left unexplained. Its difference stays in the consolidated statements. Prefer correcting the books or posting the explaining entry with its basis. The override, and each item it closed over, is recorded in the close audit note.
|
|
2068
|
+
*/
|
|
2069
|
+
allow_unexplained_residuals?: boolean;
|
|
2008
2070
|
/**
|
|
2009
2071
|
* Period
|
|
2010
2072
|
*
|
|
@@ -2597,6 +2659,178 @@ export type ConnectionResponse = {
|
|
|
2597
2659
|
};
|
|
2598
2660
|
};
|
|
2599
2661
|
|
|
2662
|
+
/**
|
|
2663
|
+
* ConsolidationProposal
|
|
2664
|
+
*
|
|
2665
|
+
* One consolidating entry the month needs: the difference between the
|
|
2666
|
+
* balance this kind of adjustment should hold for the member at the month
|
|
2667
|
+
* end and what the consolidation entity already holds for it.
|
|
2668
|
+
*/
|
|
2669
|
+
export type ConsolidationProposal = {
|
|
2670
|
+
/**
|
|
2671
|
+
* Adjustment Kind
|
|
2672
|
+
*
|
|
2673
|
+
* What the entry adjusts.
|
|
2674
|
+
*/
|
|
2675
|
+
adjustment_kind: 'elimination_investment' | 'elimination_intercompany' | 'elimination_unrealized_profit' | 'nci_allocation' | 'nci_distribution' | 'equity_method_pickup' | 'equity_method_distribution' | 'acquisition' | 'deconsolidation' | 'translation' | 'manual';
|
|
2676
|
+
/**
|
|
2677
|
+
* Adjusts Entity Id
|
|
2678
|
+
*
|
|
2679
|
+
* The entity whose figures the entry adjusts.
|
|
2680
|
+
*/
|
|
2681
|
+
adjusts_entity_id: string;
|
|
2682
|
+
/**
|
|
2683
|
+
* Adjusts Entity Name
|
|
2684
|
+
*
|
|
2685
|
+
* That entity's name.
|
|
2686
|
+
*/
|
|
2687
|
+
adjusts_entity_name: string;
|
|
2688
|
+
/**
|
|
2689
|
+
* Posting Date
|
|
2690
|
+
*
|
|
2691
|
+
* The month's last day.
|
|
2692
|
+
*/
|
|
2693
|
+
posting_date: string;
|
|
2694
|
+
/**
|
|
2695
|
+
* Memo
|
|
2696
|
+
*
|
|
2697
|
+
* The entry's memo.
|
|
2698
|
+
*/
|
|
2699
|
+
memo: string;
|
|
2700
|
+
/**
|
|
2701
|
+
* Basis
|
|
2702
|
+
*
|
|
2703
|
+
* How the amounts were computed.
|
|
2704
|
+
*/
|
|
2705
|
+
basis: string;
|
|
2706
|
+
/**
|
|
2707
|
+
* Lines
|
|
2708
|
+
*
|
|
2709
|
+
* The entry's lines; they balance.
|
|
2710
|
+
*/
|
|
2711
|
+
lines: Array<ConsolidationProposalLine>;
|
|
2712
|
+
};
|
|
2713
|
+
|
|
2714
|
+
/**
|
|
2715
|
+
* ConsolidationProposalLine
|
|
2716
|
+
*
|
|
2717
|
+
* One line of a proposed consolidating entry, in the consolidation
|
|
2718
|
+
* entity's chart.
|
|
2719
|
+
*/
|
|
2720
|
+
export type ConsolidationProposalLine = {
|
|
2721
|
+
/**
|
|
2722
|
+
* Element Id
|
|
2723
|
+
*
|
|
2724
|
+
* The consolidation entity's account.
|
|
2725
|
+
*/
|
|
2726
|
+
element_id: string;
|
|
2727
|
+
/**
|
|
2728
|
+
* Account Name
|
|
2729
|
+
*
|
|
2730
|
+
* The account's name.
|
|
2731
|
+
*/
|
|
2732
|
+
account_name: string;
|
|
2733
|
+
/**
|
|
2734
|
+
* Concept
|
|
2735
|
+
*
|
|
2736
|
+
* The rs-gaap concept the account maps to.
|
|
2737
|
+
*/
|
|
2738
|
+
concept: string;
|
|
2739
|
+
/**
|
|
2740
|
+
* Debit Amount
|
|
2741
|
+
*
|
|
2742
|
+
* Debit, in cents.
|
|
2743
|
+
*/
|
|
2744
|
+
debit_amount?: number;
|
|
2745
|
+
/**
|
|
2746
|
+
* Credit Amount
|
|
2747
|
+
*
|
|
2748
|
+
* Credit, in cents.
|
|
2749
|
+
*/
|
|
2750
|
+
credit_amount?: number;
|
|
2751
|
+
/**
|
|
2752
|
+
* Flow Qname
|
|
2753
|
+
*
|
|
2754
|
+
* The cash flow row the line offsets, when it eliminates one: the row the member's own line produced, so the consolidated cash flow nets it.
|
|
2755
|
+
*/
|
|
2756
|
+
flow_qname?: string | null;
|
|
2757
|
+
};
|
|
2758
|
+
|
|
2759
|
+
/**
|
|
2760
|
+
* ConsolidationReconcilingItem
|
|
2761
|
+
*
|
|
2762
|
+
* Two of the group's entities whose intercompany figures do not agree.
|
|
2763
|
+
* The lower amount is eliminated where one side matches the other; what is
|
|
2764
|
+
* left stays in the consolidated statements until the books agree.
|
|
2765
|
+
*/
|
|
2766
|
+
export type ConsolidationReconcilingItem = {
|
|
2767
|
+
/**
|
|
2768
|
+
* Entity Ids
|
|
2769
|
+
*
|
|
2770
|
+
* The two entities.
|
|
2771
|
+
*/
|
|
2772
|
+
entity_ids: Array<string>;
|
|
2773
|
+
/**
|
|
2774
|
+
* Concept
|
|
2775
|
+
*
|
|
2776
|
+
* The rs-gaap concept left uneliminated.
|
|
2777
|
+
*/
|
|
2778
|
+
concept: string;
|
|
2779
|
+
/**
|
|
2780
|
+
* Entity Id
|
|
2781
|
+
*
|
|
2782
|
+
* The entity whose figure is left.
|
|
2783
|
+
*/
|
|
2784
|
+
entity_id: string;
|
|
2785
|
+
/**
|
|
2786
|
+
* Amount
|
|
2787
|
+
*
|
|
2788
|
+
* Cents left uneliminated, debit-positive.
|
|
2789
|
+
*/
|
|
2790
|
+
amount: number;
|
|
2791
|
+
/**
|
|
2792
|
+
* Description
|
|
2793
|
+
*
|
|
2794
|
+
* What does not agree.
|
|
2795
|
+
*/
|
|
2796
|
+
description: string;
|
|
2797
|
+
};
|
|
2798
|
+
|
|
2799
|
+
/**
|
|
2800
|
+
* ConsolidationResidual
|
|
2801
|
+
*
|
|
2802
|
+
* A difference the engine cannot eliminate on its own: the parent's
|
|
2803
|
+
* investment in a member against the parent's share of that member's
|
|
2804
|
+
* capital. Its entry is withheld until the difference is explained or
|
|
2805
|
+
* posted by hand with a basis; it is never plugged.
|
|
2806
|
+
*/
|
|
2807
|
+
export type ConsolidationResidual = {
|
|
2808
|
+
/**
|
|
2809
|
+
* Entity Id
|
|
2810
|
+
*
|
|
2811
|
+
* The member.
|
|
2812
|
+
*/
|
|
2813
|
+
entity_id: string;
|
|
2814
|
+
/**
|
|
2815
|
+
* Entity Name
|
|
2816
|
+
*
|
|
2817
|
+
* The member's name.
|
|
2818
|
+
*/
|
|
2819
|
+
entity_name: string;
|
|
2820
|
+
/**
|
|
2821
|
+
* Amount
|
|
2822
|
+
*
|
|
2823
|
+
* Cents: the parent's investment balance less its share of the member's capital. Positive when the parent carries more than its share.
|
|
2824
|
+
*/
|
|
2825
|
+
amount: number;
|
|
2826
|
+
/**
|
|
2827
|
+
* Explanation
|
|
2828
|
+
*
|
|
2829
|
+
* What the two figures are.
|
|
2830
|
+
*/
|
|
2831
|
+
explanation: string;
|
|
2832
|
+
};
|
|
2833
|
+
|
|
2600
2834
|
/**
|
|
2601
2835
|
* ConsolidationWorksheetRequest
|
|
2602
2836
|
*
|
|
@@ -6929,7 +7163,7 @@ export type FiscalCalendarResponse = {
|
|
|
6929
7163
|
/**
|
|
6930
7164
|
* Blockers
|
|
6931
7165
|
*
|
|
6932
|
-
* Structured blocker codes when closeable_now is False: 'sequence_violation', 'period_incomplete', 'sync_stale', 'calendar_not_initialized', 'period_already_closed', 'pending_obligations', 'stranded_obligations', 'reconciling_items', 'unposted_source_events', 'unreconciled_accounts'
|
|
7166
|
+
* Structured blocker codes when closeable_now is False: 'sequence_violation', 'period_incomplete', 'sync_stale', 'calendar_not_initialized', 'period_already_closed', 'pending_obligations', 'stranded_obligations', 'reconciling_items', 'unposted_source_events', 'unreconciled_accounts'; on the consolidation entity, whose close is the group's, also 'entity_open', 'adjustments_unposted', 'residual_unexplained', 'consolidated_does_not_foot'
|
|
6933
7167
|
*/
|
|
6934
7168
|
blockers?: Array<string>;
|
|
6935
7169
|
/**
|
|
@@ -7004,6 +7238,30 @@ export type FiscalCalendarResponse = {
|
|
|
7004
7238
|
* Name and status of up to 5 of those reconciliations, so the blocker names what is holding the close.
|
|
7005
7239
|
*/
|
|
7006
7240
|
unreconciled_account_sample?: Array<string>;
|
|
7241
|
+
/**
|
|
7242
|
+
* Group Open Entities
|
|
7243
|
+
*
|
|
7244
|
+
* The group close: the entities the month consolidates, the parent and its equity-method members included, that have not closed it. Close each first.
|
|
7245
|
+
*/
|
|
7246
|
+
group_open_entities?: Array<string>;
|
|
7247
|
+
/**
|
|
7248
|
+
* Group Pending Adjustments
|
|
7249
|
+
*
|
|
7250
|
+
* The group close: the consolidating entries the consolidation entity neither holds nor has drafted, by kind and member, or what the engine left out and why. Run propose-consolidation-entries.
|
|
7251
|
+
*/
|
|
7252
|
+
group_pending_adjustments?: Array<string>;
|
|
7253
|
+
/**
|
|
7254
|
+
* Group Unexplained
|
|
7255
|
+
*
|
|
7256
|
+
* The group close: residuals and intercompany disagreements left unexplained. Correct the books or post the explaining entry, or close over them knowingly with allow_unexplained_residuals.
|
|
7257
|
+
*/
|
|
7258
|
+
group_unexplained?: Array<string>;
|
|
7259
|
+
/**
|
|
7260
|
+
* Group Not Footing
|
|
7261
|
+
*
|
|
7262
|
+
* The group close: the consolidated balance sheet's and equity statement's validation failures for the month.
|
|
7263
|
+
*/
|
|
7264
|
+
group_not_footing?: Array<string>;
|
|
7007
7265
|
/**
|
|
7008
7266
|
* Last Close At
|
|
7009
7267
|
*/
|
|
@@ -9081,7 +9339,7 @@ export type JournalEntryLineItemInput = {
|
|
|
9081
9339
|
/**
|
|
9082
9340
|
* Flow Qname
|
|
9083
9341
|
*
|
|
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.
|
|
9342
|
+
* 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, and a tag does not spread to the other side. Refused when it is not a row of the entity's cash flow statement.
|
|
9085
9343
|
*/
|
|
9086
9344
|
flow_qname?: string | null;
|
|
9087
9345
|
/**
|
|
@@ -9186,6 +9444,14 @@ export type JournalEntryResponse = {
|
|
|
9186
9444
|
* Total Credit
|
|
9187
9445
|
*/
|
|
9188
9446
|
total_credit: number;
|
|
9447
|
+
/**
|
|
9448
|
+
* Adjustment Kind
|
|
9449
|
+
*/
|
|
9450
|
+
adjustment_kind?: string | null;
|
|
9451
|
+
/**
|
|
9452
|
+
* Adjusts Entity Id
|
|
9453
|
+
*/
|
|
9454
|
+
adjusts_entity_id?: string | null;
|
|
9189
9455
|
};
|
|
9190
9456
|
|
|
9191
9457
|
/**
|
|
@@ -11211,6 +11477,52 @@ export type OperationEnvelopeAcceptSuggestionsResponse = {
|
|
|
11211
11477
|
idempotentReplay?: boolean;
|
|
11212
11478
|
};
|
|
11213
11479
|
|
|
11480
|
+
/**
|
|
11481
|
+
* OperationEnvelope[AllocationOverrideResponse]
|
|
11482
|
+
*/
|
|
11483
|
+
export type OperationEnvelopeAllocationOverrideResponse = {
|
|
11484
|
+
/**
|
|
11485
|
+
* Operation
|
|
11486
|
+
*
|
|
11487
|
+
* Kebab-case operation name
|
|
11488
|
+
*/
|
|
11489
|
+
operation: string;
|
|
11490
|
+
/**
|
|
11491
|
+
* Operationid
|
|
11492
|
+
*
|
|
11493
|
+
* op_-prefixed ULID for audit and SSE correlation
|
|
11494
|
+
*/
|
|
11495
|
+
operationId: string;
|
|
11496
|
+
/**
|
|
11497
|
+
* Status
|
|
11498
|
+
*
|
|
11499
|
+
* Operation lifecycle state
|
|
11500
|
+
*/
|
|
11501
|
+
status: 'completed' | 'pending' | 'failed';
|
|
11502
|
+
/**
|
|
11503
|
+
* Command-specific result payload
|
|
11504
|
+
*/
|
|
11505
|
+
result?: AllocationOverrideResponse | null;
|
|
11506
|
+
/**
|
|
11507
|
+
* At
|
|
11508
|
+
*
|
|
11509
|
+
* ISO-8601 UTC timestamp
|
|
11510
|
+
*/
|
|
11511
|
+
at: string;
|
|
11512
|
+
/**
|
|
11513
|
+
* Createdby
|
|
11514
|
+
*
|
|
11515
|
+
* User ID that initiated the operation
|
|
11516
|
+
*/
|
|
11517
|
+
createdBy?: string | null;
|
|
11518
|
+
/**
|
|
11519
|
+
* Idempotentreplay
|
|
11520
|
+
*
|
|
11521
|
+
* True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
|
|
11522
|
+
*/
|
|
11523
|
+
idempotentReplay?: boolean;
|
|
11524
|
+
};
|
|
11525
|
+
|
|
11214
11526
|
/**
|
|
11215
11527
|
* OperationEnvelope[AssertMetricsResponse]
|
|
11216
11528
|
*/
|
|
@@ -12913,6 +13225,52 @@ export type OperationEnvelopePortfolioBlockEnvelope = {
|
|
|
12913
13225
|
idempotentReplay?: boolean;
|
|
12914
13226
|
};
|
|
12915
13227
|
|
|
13228
|
+
/**
|
|
13229
|
+
* OperationEnvelope[PreviewConsolidationEntriesResponse]
|
|
13230
|
+
*/
|
|
13231
|
+
export type OperationEnvelopePreviewConsolidationEntriesResponse = {
|
|
13232
|
+
/**
|
|
13233
|
+
* Operation
|
|
13234
|
+
*
|
|
13235
|
+
* Kebab-case operation name
|
|
13236
|
+
*/
|
|
13237
|
+
operation: string;
|
|
13238
|
+
/**
|
|
13239
|
+
* Operationid
|
|
13240
|
+
*
|
|
13241
|
+
* op_-prefixed ULID for audit and SSE correlation
|
|
13242
|
+
*/
|
|
13243
|
+
operationId: string;
|
|
13244
|
+
/**
|
|
13245
|
+
* Status
|
|
13246
|
+
*
|
|
13247
|
+
* Operation lifecycle state
|
|
13248
|
+
*/
|
|
13249
|
+
status: 'completed' | 'pending' | 'failed';
|
|
13250
|
+
/**
|
|
13251
|
+
* Command-specific result payload
|
|
13252
|
+
*/
|
|
13253
|
+
result?: PreviewConsolidationEntriesResponse | null;
|
|
13254
|
+
/**
|
|
13255
|
+
* At
|
|
13256
|
+
*
|
|
13257
|
+
* ISO-8601 UTC timestamp
|
|
13258
|
+
*/
|
|
13259
|
+
at: string;
|
|
13260
|
+
/**
|
|
13261
|
+
* Createdby
|
|
13262
|
+
*
|
|
13263
|
+
* User ID that initiated the operation
|
|
13264
|
+
*/
|
|
13265
|
+
createdBy?: string | null;
|
|
13266
|
+
/**
|
|
13267
|
+
* Idempotentreplay
|
|
13268
|
+
*
|
|
13269
|
+
* True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
|
|
13270
|
+
*/
|
|
13271
|
+
idempotentReplay?: boolean;
|
|
13272
|
+
};
|
|
13273
|
+
|
|
12916
13274
|
/**
|
|
12917
13275
|
* OperationEnvelope[PreviewEventBlockResponse]
|
|
12918
13276
|
*/
|
|
@@ -13005,6 +13363,52 @@ export type OperationEnvelopePromoteObligationsResponse = {
|
|
|
13005
13363
|
idempotentReplay?: boolean;
|
|
13006
13364
|
};
|
|
13007
13365
|
|
|
13366
|
+
/**
|
|
13367
|
+
* OperationEnvelope[ProposeConsolidationEntriesResponse]
|
|
13368
|
+
*/
|
|
13369
|
+
export type OperationEnvelopeProposeConsolidationEntriesResponse = {
|
|
13370
|
+
/**
|
|
13371
|
+
* Operation
|
|
13372
|
+
*
|
|
13373
|
+
* Kebab-case operation name
|
|
13374
|
+
*/
|
|
13375
|
+
operation: string;
|
|
13376
|
+
/**
|
|
13377
|
+
* Operationid
|
|
13378
|
+
*
|
|
13379
|
+
* op_-prefixed ULID for audit and SSE correlation
|
|
13380
|
+
*/
|
|
13381
|
+
operationId: string;
|
|
13382
|
+
/**
|
|
13383
|
+
* Status
|
|
13384
|
+
*
|
|
13385
|
+
* Operation lifecycle state
|
|
13386
|
+
*/
|
|
13387
|
+
status: 'completed' | 'pending' | 'failed';
|
|
13388
|
+
/**
|
|
13389
|
+
* Command-specific result payload
|
|
13390
|
+
*/
|
|
13391
|
+
result?: ProposeConsolidationEntriesResponse | null;
|
|
13392
|
+
/**
|
|
13393
|
+
* At
|
|
13394
|
+
*
|
|
13395
|
+
* ISO-8601 UTC timestamp
|
|
13396
|
+
*/
|
|
13397
|
+
at: string;
|
|
13398
|
+
/**
|
|
13399
|
+
* Createdby
|
|
13400
|
+
*
|
|
13401
|
+
* User ID that initiated the operation
|
|
13402
|
+
*/
|
|
13403
|
+
createdBy?: string | null;
|
|
13404
|
+
/**
|
|
13405
|
+
* Idempotentreplay
|
|
13406
|
+
*
|
|
13407
|
+
* True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
|
|
13408
|
+
*/
|
|
13409
|
+
idempotentReplay?: boolean;
|
|
13410
|
+
};
|
|
13411
|
+
|
|
13008
13412
|
/**
|
|
13009
13413
|
* OperationEnvelope[PublishListResponse]
|
|
13010
13414
|
*/
|
|
@@ -15339,6 +15743,94 @@ export type PositionBlock = {
|
|
|
15339
15743
|
security: SecurityLite;
|
|
15340
15744
|
};
|
|
15341
15745
|
|
|
15746
|
+
/**
|
|
15747
|
+
* PreviewConsolidationEntriesRequest
|
|
15748
|
+
*
|
|
15749
|
+
* The month to compute the consolidating entries for.
|
|
15750
|
+
*/
|
|
15751
|
+
export type PreviewConsolidationEntriesRequest = {
|
|
15752
|
+
/**
|
|
15753
|
+
* Period
|
|
15754
|
+
*
|
|
15755
|
+
* The month, as YYYY-MM.
|
|
15756
|
+
*/
|
|
15757
|
+
period: string;
|
|
15758
|
+
};
|
|
15759
|
+
|
|
15760
|
+
/**
|
|
15761
|
+
* PreviewConsolidationEntriesResponse
|
|
15762
|
+
*
|
|
15763
|
+
* The consolidating entries a month needs, computed from the books.
|
|
15764
|
+
*/
|
|
15765
|
+
export type PreviewConsolidationEntriesResponse = {
|
|
15766
|
+
/**
|
|
15767
|
+
* Period
|
|
15768
|
+
*
|
|
15769
|
+
* The month, as YYYY-MM.
|
|
15770
|
+
*/
|
|
15771
|
+
period: string;
|
|
15772
|
+
/**
|
|
15773
|
+
* Period Start
|
|
15774
|
+
*
|
|
15775
|
+
* The month's first day.
|
|
15776
|
+
*/
|
|
15777
|
+
period_start: string;
|
|
15778
|
+
/**
|
|
15779
|
+
* Period End
|
|
15780
|
+
*
|
|
15781
|
+
* The month's last day.
|
|
15782
|
+
*/
|
|
15783
|
+
period_end: string;
|
|
15784
|
+
/**
|
|
15785
|
+
* Consolidation Entity Id
|
|
15786
|
+
*
|
|
15787
|
+
* The entity the entries post in.
|
|
15788
|
+
*/
|
|
15789
|
+
consolidation_entity_id: string;
|
|
15790
|
+
/**
|
|
15791
|
+
* Proposals
|
|
15792
|
+
*
|
|
15793
|
+
* The entries to post; empty when the month is up to date.
|
|
15794
|
+
*/
|
|
15795
|
+
proposals?: Array<ConsolidationProposal>;
|
|
15796
|
+
/**
|
|
15797
|
+
* Residuals
|
|
15798
|
+
*
|
|
15799
|
+
* Differences withheld from the proposals until explained.
|
|
15800
|
+
*/
|
|
15801
|
+
residuals?: Array<ConsolidationResidual>;
|
|
15802
|
+
/**
|
|
15803
|
+
* Reconciling Items
|
|
15804
|
+
*
|
|
15805
|
+
* Intercompany figures the two sides do not agree on.
|
|
15806
|
+
*/
|
|
15807
|
+
reconciling_items?: Array<ConsolidationReconcilingItem>;
|
|
15808
|
+
/**
|
|
15809
|
+
* Notes
|
|
15810
|
+
*
|
|
15811
|
+
* Anything the engine left out, and why.
|
|
15812
|
+
*/
|
|
15813
|
+
notes?: Array<string>;
|
|
15814
|
+
/**
|
|
15815
|
+
* Up To Date
|
|
15816
|
+
*
|
|
15817
|
+
* True when nothing is withheld or left out and the consolidation entity holds what the month needs, posted or in the month's drafts (then `proposals` lists what the drafts hold). A closed month is up to date as posted; read `closed` first.
|
|
15818
|
+
*/
|
|
15819
|
+
up_to_date: boolean;
|
|
15820
|
+
/**
|
|
15821
|
+
* Closed
|
|
15822
|
+
*
|
|
15823
|
+
* True when the consolidation entity has closed the month: its entries are as posted, and nothing is recomputed.
|
|
15824
|
+
*/
|
|
15825
|
+
closed?: boolean;
|
|
15826
|
+
/**
|
|
15827
|
+
* Drafted Entry Ids
|
|
15828
|
+
*
|
|
15829
|
+
* The month's drafts propose-consolidation-entries wrote, waiting for the consolidation entity's close to post them.
|
|
15830
|
+
*/
|
|
15831
|
+
drafted_entry_ids?: Array<string>;
|
|
15832
|
+
};
|
|
15833
|
+
|
|
15342
15834
|
/**
|
|
15343
15835
|
* PreviewEventBlockResponse
|
|
15344
15836
|
*
|
|
@@ -15489,6 +15981,76 @@ export type PromoteObligationsResponse = {
|
|
|
15489
15981
|
}>;
|
|
15490
15982
|
};
|
|
15491
15983
|
|
|
15984
|
+
/**
|
|
15985
|
+
* ProposeConsolidationEntriesRequest
|
|
15986
|
+
*
|
|
15987
|
+
* The month to draft the consolidating entries for.
|
|
15988
|
+
*/
|
|
15989
|
+
export type ProposeConsolidationEntriesRequest = {
|
|
15990
|
+
/**
|
|
15991
|
+
* Period
|
|
15992
|
+
*
|
|
15993
|
+
* The month, as YYYY-MM.
|
|
15994
|
+
*/
|
|
15995
|
+
period: string;
|
|
15996
|
+
};
|
|
15997
|
+
|
|
15998
|
+
/**
|
|
15999
|
+
* ProposeConsolidationEntriesResponse
|
|
16000
|
+
*
|
|
16001
|
+
* The consolidating entries drafted for a month.
|
|
16002
|
+
*/
|
|
16003
|
+
export type ProposeConsolidationEntriesResponse = {
|
|
16004
|
+
/**
|
|
16005
|
+
* Period
|
|
16006
|
+
*
|
|
16007
|
+
* The month, as YYYY-MM.
|
|
16008
|
+
*/
|
|
16009
|
+
period: string;
|
|
16010
|
+
/**
|
|
16011
|
+
* Consolidation Entity Id
|
|
16012
|
+
*
|
|
16013
|
+
* The entity the drafts are in.
|
|
16014
|
+
*/
|
|
16015
|
+
consolidation_entity_id: string;
|
|
16016
|
+
/**
|
|
16017
|
+
* Closed
|
|
16018
|
+
*
|
|
16019
|
+
* True when the month is closed and nothing was drafted.
|
|
16020
|
+
*/
|
|
16021
|
+
closed?: boolean;
|
|
16022
|
+
/**
|
|
16023
|
+
* Entries
|
|
16024
|
+
*
|
|
16025
|
+
* The drafts written; the consolidation entity's close posts them.
|
|
16026
|
+
*/
|
|
16027
|
+
entries?: Array<JournalEntryResponse>;
|
|
16028
|
+
/**
|
|
16029
|
+
* Replaced
|
|
16030
|
+
*
|
|
16031
|
+
* Earlier drafts of this month's entries, replaced by these.
|
|
16032
|
+
*/
|
|
16033
|
+
replaced?: number;
|
|
16034
|
+
/**
|
|
16035
|
+
* Residuals
|
|
16036
|
+
*
|
|
16037
|
+
* Differences withheld from the drafts until explained.
|
|
16038
|
+
*/
|
|
16039
|
+
residuals?: Array<ConsolidationResidual>;
|
|
16040
|
+
/**
|
|
16041
|
+
* Reconciling Items
|
|
16042
|
+
*
|
|
16043
|
+
* Intercompany figures the two sides do not agree on.
|
|
16044
|
+
*/
|
|
16045
|
+
reconciling_items?: Array<ConsolidationReconcilingItem>;
|
|
16046
|
+
/**
|
|
16047
|
+
* Notes
|
|
16048
|
+
*
|
|
16049
|
+
* Anything the engine left out, and why.
|
|
16050
|
+
*/
|
|
16051
|
+
notes?: Array<string>;
|
|
16052
|
+
};
|
|
16053
|
+
|
|
15492
16054
|
/**
|
|
15493
16055
|
* PublishListMemberResponse
|
|
15494
16056
|
*
|
|
@@ -18633,6 +19195,52 @@ export type ServiceOfferingsResponse = {
|
|
|
18633
19195
|
summary: ServiceOfferingSummary;
|
|
18634
19196
|
};
|
|
18635
19197
|
|
|
19198
|
+
/**
|
|
19199
|
+
* SetAllocationOverrideRequest
|
|
19200
|
+
*
|
|
19201
|
+
* The outside owners' share of a member's result for one month, set by a
|
|
19202
|
+
* person in place of the pro-rata share: a preferred return, a waterfall, a
|
|
19203
|
+
* special allocation.
|
|
19204
|
+
*/
|
|
19205
|
+
export type SetAllocationOverrideRequest = {
|
|
19206
|
+
/**
|
|
19207
|
+
* Entity Id
|
|
19208
|
+
*
|
|
19209
|
+
* The member, consolidated in full.
|
|
19210
|
+
*/
|
|
19211
|
+
entity_id: string;
|
|
19212
|
+
/**
|
|
19213
|
+
* Period
|
|
19214
|
+
*
|
|
19215
|
+
* The month, as YYYY-MM.
|
|
19216
|
+
*/
|
|
19217
|
+
period: string;
|
|
19218
|
+
/**
|
|
19219
|
+
* Amount
|
|
19220
|
+
*
|
|
19221
|
+
* The outside owners' share of the month's result, in cents; negative for a share of a loss.
|
|
19222
|
+
*/
|
|
19223
|
+
amount?: number | null;
|
|
19224
|
+
/**
|
|
19225
|
+
* Percentage
|
|
19226
|
+
*
|
|
19227
|
+
* The outside owners' share as a percentage of the month's result.
|
|
19228
|
+
*/
|
|
19229
|
+
percentage?: number | null;
|
|
19230
|
+
/**
|
|
19231
|
+
* Basis
|
|
19232
|
+
*
|
|
19233
|
+
* Why the share differs from the ownership percentage; required to set one.
|
|
19234
|
+
*/
|
|
19235
|
+
basis?: string | null;
|
|
19236
|
+
/**
|
|
19237
|
+
* Clear
|
|
19238
|
+
*
|
|
19239
|
+
* Remove the month's override, back to the pro-rata share.
|
|
19240
|
+
*/
|
|
19241
|
+
clear?: boolean;
|
|
19242
|
+
};
|
|
19243
|
+
|
|
18636
19244
|
/**
|
|
18637
19245
|
* SetCloseTargetOperation
|
|
18638
19246
|
*/
|
|
@@ -32421,6 +33029,134 @@ export type RecordOpeningBalanceResponses = {
|
|
|
32421
33029
|
|
|
32422
33030
|
export type RecordOpeningBalanceResponse = RecordOpeningBalanceResponses[keyof RecordOpeningBalanceResponses];
|
|
32423
33031
|
|
|
33032
|
+
export type ProposeConsolidationEntriesData = {
|
|
33033
|
+
body: ProposeConsolidationEntriesRequest;
|
|
33034
|
+
headers?: {
|
|
33035
|
+
/**
|
|
33036
|
+
* Idempotency-Key
|
|
33037
|
+
*/
|
|
33038
|
+
'Idempotency-Key'?: string | null;
|
|
33039
|
+
};
|
|
33040
|
+
path: {
|
|
33041
|
+
/**
|
|
33042
|
+
* Graph Id
|
|
33043
|
+
*/
|
|
33044
|
+
graph_id: string;
|
|
33045
|
+
};
|
|
33046
|
+
query?: never;
|
|
33047
|
+
url: '/extensions/roboledger/{graph_id}/operations/propose-consolidation-entries';
|
|
33048
|
+
};
|
|
33049
|
+
|
|
33050
|
+
export type ProposeConsolidationEntriesErrors = {
|
|
33051
|
+
/**
|
|
33052
|
+
* Invalid request
|
|
33053
|
+
*/
|
|
33054
|
+
400: ErrorResponse;
|
|
33055
|
+
/**
|
|
33056
|
+
* Authentication required
|
|
33057
|
+
*/
|
|
33058
|
+
401: ErrorResponse;
|
|
33059
|
+
/**
|
|
33060
|
+
* Access denied
|
|
33061
|
+
*/
|
|
33062
|
+
403: ErrorResponse;
|
|
33063
|
+
/**
|
|
33064
|
+
* Resource not found
|
|
33065
|
+
*/
|
|
33066
|
+
404: ErrorResponse;
|
|
33067
|
+
/**
|
|
33068
|
+
* Idempotency-Key conflict — key reused with different body
|
|
33069
|
+
*/
|
|
33070
|
+
409: ErrorResponse;
|
|
33071
|
+
/**
|
|
33072
|
+
* Validation error
|
|
33073
|
+
*/
|
|
33074
|
+
422: ErrorResponse;
|
|
33075
|
+
/**
|
|
33076
|
+
* Rate limit exceeded
|
|
33077
|
+
*/
|
|
33078
|
+
429: ErrorResponse;
|
|
33079
|
+
/**
|
|
33080
|
+
* Internal server error
|
|
33081
|
+
*/
|
|
33082
|
+
500: ErrorResponse;
|
|
33083
|
+
};
|
|
33084
|
+
|
|
33085
|
+
export type ProposeConsolidationEntriesError = ProposeConsolidationEntriesErrors[keyof ProposeConsolidationEntriesErrors];
|
|
33086
|
+
|
|
33087
|
+
export type ProposeConsolidationEntriesResponses = {
|
|
33088
|
+
/**
|
|
33089
|
+
* Successful Response
|
|
33090
|
+
*/
|
|
33091
|
+
200: OperationEnvelopeProposeConsolidationEntriesResponse;
|
|
33092
|
+
};
|
|
33093
|
+
|
|
33094
|
+
export type ProposeConsolidationEntriesResponse2 = ProposeConsolidationEntriesResponses[keyof ProposeConsolidationEntriesResponses];
|
|
33095
|
+
|
|
33096
|
+
export type SetAllocationOverrideData = {
|
|
33097
|
+
body: SetAllocationOverrideRequest;
|
|
33098
|
+
headers?: {
|
|
33099
|
+
/**
|
|
33100
|
+
* Idempotency-Key
|
|
33101
|
+
*/
|
|
33102
|
+
'Idempotency-Key'?: string | null;
|
|
33103
|
+
};
|
|
33104
|
+
path: {
|
|
33105
|
+
/**
|
|
33106
|
+
* Graph Id
|
|
33107
|
+
*/
|
|
33108
|
+
graph_id: string;
|
|
33109
|
+
};
|
|
33110
|
+
query?: never;
|
|
33111
|
+
url: '/extensions/roboledger/{graph_id}/operations/set-allocation-override';
|
|
33112
|
+
};
|
|
33113
|
+
|
|
33114
|
+
export type SetAllocationOverrideErrors = {
|
|
33115
|
+
/**
|
|
33116
|
+
* Invalid request
|
|
33117
|
+
*/
|
|
33118
|
+
400: ErrorResponse;
|
|
33119
|
+
/**
|
|
33120
|
+
* Authentication required
|
|
33121
|
+
*/
|
|
33122
|
+
401: ErrorResponse;
|
|
33123
|
+
/**
|
|
33124
|
+
* Access denied
|
|
33125
|
+
*/
|
|
33126
|
+
403: ErrorResponse;
|
|
33127
|
+
/**
|
|
33128
|
+
* Resource not found
|
|
33129
|
+
*/
|
|
33130
|
+
404: ErrorResponse;
|
|
33131
|
+
/**
|
|
33132
|
+
* Idempotency-Key conflict — key reused with different body
|
|
33133
|
+
*/
|
|
33134
|
+
409: ErrorResponse;
|
|
33135
|
+
/**
|
|
33136
|
+
* Validation error
|
|
33137
|
+
*/
|
|
33138
|
+
422: ErrorResponse;
|
|
33139
|
+
/**
|
|
33140
|
+
* Rate limit exceeded
|
|
33141
|
+
*/
|
|
33142
|
+
429: ErrorResponse;
|
|
33143
|
+
/**
|
|
33144
|
+
* Internal server error
|
|
33145
|
+
*/
|
|
33146
|
+
500: ErrorResponse;
|
|
33147
|
+
};
|
|
33148
|
+
|
|
33149
|
+
export type SetAllocationOverrideError = SetAllocationOverrideErrors[keyof SetAllocationOverrideErrors];
|
|
33150
|
+
|
|
33151
|
+
export type SetAllocationOverrideResponses = {
|
|
33152
|
+
/**
|
|
33153
|
+
* Successful Response
|
|
33154
|
+
*/
|
|
33155
|
+
200: OperationEnvelopeAllocationOverrideResponse;
|
|
33156
|
+
};
|
|
33157
|
+
|
|
33158
|
+
export type SetAllocationOverrideResponse = SetAllocationOverrideResponses[keyof SetAllocationOverrideResponses];
|
|
33159
|
+
|
|
32424
33160
|
export type UpdateJournalEntryData = {
|
|
32425
33161
|
body: UpdateJournalEntryRequest;
|
|
32426
33162
|
headers?: {
|
|
@@ -34469,6 +35205,70 @@ export type ConsolidationWorksheetResponses = {
|
|
|
34469
35205
|
|
|
34470
35206
|
export type ConsolidationWorksheetResponse2 = ConsolidationWorksheetResponses[keyof ConsolidationWorksheetResponses];
|
|
34471
35207
|
|
|
35208
|
+
export type PreviewConsolidationEntriesData = {
|
|
35209
|
+
body: PreviewConsolidationEntriesRequest;
|
|
35210
|
+
headers?: {
|
|
35211
|
+
/**
|
|
35212
|
+
* Idempotency-Key
|
|
35213
|
+
*/
|
|
35214
|
+
'Idempotency-Key'?: string | null;
|
|
35215
|
+
};
|
|
35216
|
+
path: {
|
|
35217
|
+
/**
|
|
35218
|
+
* Graph Id
|
|
35219
|
+
*/
|
|
35220
|
+
graph_id: string;
|
|
35221
|
+
};
|
|
35222
|
+
query?: never;
|
|
35223
|
+
url: '/extensions/roboledger/{graph_id}/operations/preview-consolidation-entries';
|
|
35224
|
+
};
|
|
35225
|
+
|
|
35226
|
+
export type PreviewConsolidationEntriesErrors = {
|
|
35227
|
+
/**
|
|
35228
|
+
* Invalid request
|
|
35229
|
+
*/
|
|
35230
|
+
400: ErrorResponse;
|
|
35231
|
+
/**
|
|
35232
|
+
* Authentication required
|
|
35233
|
+
*/
|
|
35234
|
+
401: ErrorResponse;
|
|
35235
|
+
/**
|
|
35236
|
+
* Access denied
|
|
35237
|
+
*/
|
|
35238
|
+
403: ErrorResponse;
|
|
35239
|
+
/**
|
|
35240
|
+
* Resource not found
|
|
35241
|
+
*/
|
|
35242
|
+
404: ErrorResponse;
|
|
35243
|
+
/**
|
|
35244
|
+
* Idempotency-Key conflict — key reused with different body
|
|
35245
|
+
*/
|
|
35246
|
+
409: ErrorResponse;
|
|
35247
|
+
/**
|
|
35248
|
+
* Validation error
|
|
35249
|
+
*/
|
|
35250
|
+
422: ErrorResponse;
|
|
35251
|
+
/**
|
|
35252
|
+
* Rate limit exceeded
|
|
35253
|
+
*/
|
|
35254
|
+
429: ErrorResponse;
|
|
35255
|
+
/**
|
|
35256
|
+
* Internal server error
|
|
35257
|
+
*/
|
|
35258
|
+
500: ErrorResponse;
|
|
35259
|
+
};
|
|
35260
|
+
|
|
35261
|
+
export type PreviewConsolidationEntriesError = PreviewConsolidationEntriesErrors[keyof PreviewConsolidationEntriesErrors];
|
|
35262
|
+
|
|
35263
|
+
export type PreviewConsolidationEntriesResponses = {
|
|
35264
|
+
/**
|
|
35265
|
+
* Successful Response
|
|
35266
|
+
*/
|
|
35267
|
+
200: OperationEnvelopePreviewConsolidationEntriesResponse;
|
|
35268
|
+
};
|
|
35269
|
+
|
|
35270
|
+
export type PreviewConsolidationEntriesResponse2 = PreviewConsolidationEntriesResponses[keyof PreviewConsolidationEntriesResponses];
|
|
35271
|
+
|
|
34472
35272
|
export type CreatePortfolioBlockData = {
|
|
34473
35273
|
body: CreatePortfolioBlockRequest;
|
|
34474
35274
|
headers?: {
|